`@codesoul-co/hypha-core` / `contracts/artifact-manager`

Package index: @codesoul-co/hypha-core
Source: packages/core/src/contracts/artifact-manager.ts
Exports: 21

Using this module

Use the Artifact manager module for declaring and runtime-validating contracts. It exports 17 interfaces, 4 types.

Import from the package entrypoint

import type {
  ArtifactCreateDownloadAccessRequest,
  ArtifactCreateRequest,
  ArtifactFromWorkspaceRequest,
  ArtifactGetRecordRequest,
  ArtifactLatestRequest,
  ArtifactListRequest,
  ArtifactManager,
  ArtifactMutationRequest,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

Use the 21 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.

Public exports

Symbol	Kind	Signature	Description
`ArtifactCreateDownloadAccessRequest`	interface	`interface ArtifactCreateDownloadAccessRequest extends ArtifactGetRecordRequest`	Artifact Create Download Access Request interface with 7 public fields or methods.
`ArtifactCreateRequest`	interface	`interface ArtifactCreateRequest`	Artifact Create Request interface with 26 public fields or methods.
`ArtifactFromWorkspaceRequest`	interface	`interface ArtifactFromWorkspaceRequest`	Artifact From Workspace Request interface with 22 public fields or methods.
`ArtifactGetRecordRequest`	interface	`interface ArtifactGetRecordRequest`	Artifact Get Record Request interface with 3 public fields or methods.
`ArtifactLatestRequest`	interface	`interface ArtifactLatestRequest`	Artifact Latest Request interface with 2 public fields or methods.
`ArtifactListRequest`	interface	`interface ArtifactListRequest`	Artifact List Request interface with 8 public fields or methods.
`ArtifactManager`	interface	`interface ArtifactManager`	Artifact Manager interface with 16 public fields or methods.
`ArtifactMutationRequest`	interface	`interface ArtifactMutationRequest`	Artifact Mutation Request interface with 6 public fields or methods.
`ArtifactPreviousRequest`	interface	`interface ArtifactPreviousRequest`	Artifact Previous Request interface with 2 public fields or methods.
`ArtifactReadRequest`	interface	`interface ArtifactReadRequest extends ArtifactGetRecordRequest`	Artifact Read Request interface with 5 public fields or methods.
`ArtifactReadResult`	interface	`interface ArtifactReadResult`	Artifact Read Result interface with 2 public fields or methods.
`ArtifactTraceLineageRequest`	interface	`interface ArtifactTraceLineageRequest`	Artifact Trace Lineage Request interface with 2 public fields or methods.
`ArtifactVersionRequest`	interface	`interface ArtifactVersionRequest`	Artifact Version Request interface with 10 public fields or methods.
`ArtifactWorkspaceContent`	interface	`interface ArtifactWorkspaceContent`	Artifact Workspace Content interface with 4 public fields or methods.
`ArtifactWorkspaceContentReader`	interface	`interface ArtifactWorkspaceContentReader`	Governed Workspace port used by ArtifactManager; it never accepts a host path.
`ArtifactWorkspaceContentRequest`	interface	`interface ArtifactWorkspaceContentRequest`	Artifact Workspace Content Request interface with 4 public fields or methods.
`NormalizedArtifactError`	interface	`interface NormalizedArtifactError`	Normalized Artifact Error interface with 5 public fields or methods.
`ArtifactArchiveRequest`	type	`type ArtifactArchiveRequest = ArtifactMutationRequest`	Public type alias for Artifact Archive Request; the declaration contains its complete type expression.
`ArtifactDeleteRequest`	type	`type ArtifactDeleteRequest = ArtifactMutationRequest`	Public type alias for Artifact Delete Request; the declaration contains its complete type expression.
`ArtifactFinalizeRequest`	type	`type ArtifactFinalizeRequest = ArtifactMutationRequest`	Public type alias for Artifact Finalize Request; the declaration contains its complete type expression.
`ArtifactInvalidateRequest`	type	`type ArtifactInvalidateRequest = ArtifactMutationRequest`	Public type alias for Artifact Invalidate Request; the declaration contains its complete type expression.

`ArtifactCreateDownloadAccessRequest`

Artifact Create Download Access Request interface with 7 public fields or methods.

Kind: interface
Import: import type { ArtifactCreateDownloadAccessRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactCreateDownloadAccessRequest extends ArtifactGetRecordRequest {
    operationId: string;
    expiresInSeconds?: number;
    responseMimeType?: string;
    responseFilename?: string;
}

Contract members

Member	Kind	Signature	Description
`artifactId`	property	`artifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expiresInSeconds`	property	`expiresInSeconds?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`responseFilename`	property	`responseFilename?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`responseMimeType`	property	`responseMimeType?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`versionId`	property	`versionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactCreateRequest`

Artifact Create Request interface with 26 public fields or methods.

Kind: interface
Import: import type { ArtifactCreateRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactCreateRequest {
    operationId: string;
    principal: ExecutionPrincipal;
    profileRef: SpecRef;
    userId: string;
    tenantId?: string;
    workspaceId: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
    name: string;
    description?: string;
    relativePath?: string;
    kind: ArtifactKind;
    mimeType?: string;
    encoding?: string;
    content: ArtifactByteSource;
    expectedContentHash?: string;
    expectedSizeBytes?: number;
    logicalArtifactId?: string;
    provenance: ArtifactProvenance;
    access?: ArtifactAccessRecord;
    retention?: ArtifactRetentionRecord;
    sensitive?: boolean;
    tags?: string[];
    idempotencyKey?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`access`	property	`access?: ArtifactAccessRecord`	Public property; its type, readonly modifier and optionality are shown in the signature.
`agentId`	property	`agentId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`content`	property	`content: ArtifactByteSource`	Public property; its type, readonly modifier and optionality are shown in the signature.
`description`	property	`description?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`encoding`	property	`encoding?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedContentHash`	property	`expectedContentHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedSizeBytes`	property	`expectedSizeBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`idempotencyKey`	property	`idempotencyKey?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind: ArtifactKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`logicalArtifactId`	property	`logicalArtifactId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mimeType`	property	`mimeType?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`name`	property	`name: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`profileRef`	property	`profileRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`provenance`	property	`provenance: ArtifactProvenance`	Public property; its type, readonly modifier and optionality are shown in the signature.
`relativePath`	property	`relativePath?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`retention`	property	`retention?: ArtifactRetentionRecord`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runId`	property	`runId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sensitive`	property	`sensitive?: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionId`	property	`sessionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tags`	property	`tags?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactFromWorkspaceRequest`

Artifact From Workspace Request interface with 22 public fields or methods.

Kind: interface
Import: import type { ArtifactFromWorkspaceRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactFromWorkspaceRequest {
    operationId: string;
    principal: ExecutionPrincipal;
    profileRef: SpecRef;
    userId: string;
    tenantId?: string;
    workspaceId: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
    relativePath: string;
    name?: string;
    kind: ArtifactKind;
    mimeType?: string;
    expectedContentHash?: string;
    expectedSizeBytes?: number;
    logicalArtifactId?: string;
    provenance: ArtifactProvenance;
    retention?: ArtifactRetentionRecord;
    sensitive?: boolean;
    tags?: string[];
    idempotencyKey?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`agentId`	property	`agentId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedContentHash`	property	`expectedContentHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedSizeBytes`	property	`expectedSizeBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`idempotencyKey`	property	`idempotencyKey?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kind`	property	`kind: ArtifactKind`	Public property; its type, readonly modifier and optionality are shown in the signature.
`logicalArtifactId`	property	`logicalArtifactId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mimeType`	property	`mimeType?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`name`	property	`name?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`profileRef`	property	`profileRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`provenance`	property	`provenance: ArtifactProvenance`	Public property; its type, readonly modifier and optionality are shown in the signature.
`relativePath`	property	`relativePath: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`retention`	property	`retention?: ArtifactRetentionRecord`	Public property; its type, readonly modifier and optionality are shown in the signature.
`runId`	property	`runId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sensitive`	property	`sensitive?: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionId`	property	`sessionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tags`	property	`tags?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tenantId`	property	`tenantId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`userId`	property	`userId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactGetRecordRequest`

Artifact Get Record Request interface with 3 public fields or methods.

Kind: interface
Import: import type { ArtifactGetRecordRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactGetRecordRequest {
    principal: ExecutionPrincipal;
    artifactId: string;
    versionId?: string;
}

Contract members

Member	Kind	Signature	Description
`artifactId`	property	`artifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`versionId`	property	`versionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactLatestRequest`

Artifact Latest Request interface with 2 public fields or methods.

Kind: interface
Import: import type { ArtifactLatestRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactLatestRequest {
    principal: ExecutionPrincipal;
    logicalArtifactId: string;
}

Contract members

Member	Kind	Signature	Description
`logicalArtifactId`	property	`logicalArtifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactListRequest`

Artifact List Request interface with 8 public fields or methods.

Kind: interface
Import: import type { ArtifactListRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactListRequest {
    principal: ExecutionPrincipal;
    workspaceId: string;
    logicalArtifactId?: string;
    kinds?: ArtifactKind[];
    statuses?: ArtifactRecord['status'][];
    tags?: string[];
    includeDeleted?: boolean;
    limit?: number;
}

Contract members

Member	Kind	Signature	Description
`includeDeleted`	property	`includeDeleted?: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.
`kinds`	property	`kinds?: ArtifactKind[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`limit`	property	`limit?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`logicalArtifactId`	property	`logicalArtifactId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`statuses`	property	`statuses?: import("/Users/erwin/Downloads/codespace/Hypha/packages/core/dist/contracts/artifact").ArtifactStatus[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tags`	property	`tags?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactManager`

Artifact Manager interface with 16 public fields or methods.

Kind: interface
Import: import type { ArtifactManager } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactManager {
    create(request: ArtifactCreateRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>;
    createFromWorkspace(request: ArtifactFromWorkspaceRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>;
    createVersion(request: ArtifactVersionRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>;
    get(request: ArtifactGetRecordRequest): Promise<ArtifactRecord | null>;
    read(request: ArtifactReadRequest, options?: ArtifactOperationOptions): Promise<ArtifactReadResult>;
    createDownloadAccess(request: ArtifactCreateDownloadAccessRequest): Promise<ArtifactDownloadAccess>;
    list(request: ArtifactListRequest): Promise<ArtifactRecord[]>;
    finalize(request: ArtifactFinalizeRequest): Promise<ArtifactRecord>;
    archive(request: ArtifactArchiveRequest): Promise<ArtifactRecord>;
    invalidate(request: ArtifactInvalidateRequest): Promise<ArtifactRecord>;
    delete(request: ArtifactDeleteRequest): Promise<void>;
    traceLineage(request: ArtifactTraceLineageRequest): Promise<ArtifactLineage>;
    latest(request: ArtifactLatestRequest): Promise<ArtifactRecord | null>;
    previous(request: ArtifactPreviousRequest): Promise<ArtifactRecord | null>;
    profile(ref: SpecRef): Promise<ArtifactProfileSpec | null>;
    health(): Promise<Record<string, ProviderHealth>>;
}

Contract members

Member	Kind	Signature	Description
`archive`	method	`archive(request: ArtifactArchiveRequest): Promise<ArtifactRecord>`	Public method; parameters and return type are shown in the signature.
`create`	method	`create(request: ArtifactCreateRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>`	Public method; parameters and return type are shown in the signature.
`createDownloadAccess`	method	`createDownloadAccess(request: ArtifactCreateDownloadAccessRequest): Promise<ArtifactDownloadAccess>`	Public method; parameters and return type are shown in the signature.
`createFromWorkspace`	method	`createFromWorkspace(request: ArtifactFromWorkspaceRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>`	Public method; parameters and return type are shown in the signature.
`createVersion`	method	`createVersion(request: ArtifactVersionRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>`	Public method; parameters and return type are shown in the signature.
`delete`	method	`delete(request: ArtifactDeleteRequest): Promise<void>`	Public method; parameters and return type are shown in the signature.
`finalize`	method	`finalize(request: ArtifactFinalizeRequest): Promise<ArtifactRecord>`	Public method; parameters and return type are shown in the signature.
`get`	method	`get(request: ArtifactGetRecordRequest): Promise<ArtifactRecord \| null>`	Public method; parameters and return type are shown in the signature.
`health`	method	`health(): Promise<Record<string, ProviderHealth>>`	Public method; parameters and return type are shown in the signature.
`invalidate`	method	`invalidate(request: ArtifactInvalidateRequest): Promise<ArtifactRecord>`	Public method; parameters and return type are shown in the signature.
`latest`	method	`latest(request: ArtifactLatestRequest): Promise<ArtifactRecord \| null>`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(request: ArtifactListRequest): Promise<ArtifactRecord[]>`	Public method; parameters and return type are shown in the signature.
`previous`	method	`previous(request: ArtifactPreviousRequest): Promise<ArtifactRecord \| null>`	Public method; parameters and return type are shown in the signature.
`profile`	method	`profile(ref: SpecRef): Promise<ArtifactProfileSpec \| null>`	Public method; parameters and return type are shown in the signature.
`read`	method	`read(request: ArtifactReadRequest, options?: ArtifactOperationOptions): Promise<ArtifactReadResult>`	Public method; parameters and return type are shown in the signature.
`traceLineage`	method	`traceLineage(request: ArtifactTraceLineageRequest): Promise<ArtifactLineage>`	Public method; parameters and return type are shown in the signature.

`ArtifactMutationRequest`

Artifact Mutation Request interface with 6 public fields or methods.

Kind: interface
Import: import type { ArtifactMutationRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactMutationRequest {
    operationId: string;
    principal: ExecutionPrincipal;
    artifactId: string;
    expectedRevision: number;
    reason?: string;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
`artifactId`	property	`artifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedRevision`	property	`expectedRevision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`idempotencyKey`	property	`idempotencyKey?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reason`	property	`reason?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactPreviousRequest`

Artifact Previous Request interface with 2 public fields or methods.

Kind: interface
Import: import type { ArtifactPreviousRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactPreviousRequest {
    principal: ExecutionPrincipal;
    versionId: string;
}

Contract members

Member	Kind	Signature	Description
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`versionId`	property	`versionId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactReadRequest`

Artifact Read Request interface with 5 public fields or methods.

Kind: interface
Import: import type { ArtifactReadRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactReadRequest extends ArtifactGetRecordRequest {
    range?: ArtifactByteRange;
    expectedContentHash?: string;
}

Contract members

Member	Kind	Signature	Description
`artifactId`	property	`artifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedContentHash`	property	`expectedContentHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`range`	property	`range?: ArtifactByteRange`	Public property; its type, readonly modifier and optionality are shown in the signature.
`versionId`	property	`versionId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactReadResult`

Artifact Read Result interface with 2 public fields or methods.

Kind: interface
Import: import type { ArtifactReadResult } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactReadResult {
    record: ArtifactRecord;
    content: ArtifactContent;
}

Contract members

Member	Kind	Signature	Description
`content`	property	`content: ArtifactContent`	Public property; its type, readonly modifier and optionality are shown in the signature.
`record`	property	`record: ArtifactRecord`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactTraceLineageRequest`

Artifact Trace Lineage Request interface with 2 public fields or methods.

Kind: interface
Import: import type { ArtifactTraceLineageRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactTraceLineageRequest {
    principal: ExecutionPrincipal;
    artifactId: string;
}

Contract members

Member	Kind	Signature	Description
`artifactId`	property	`artifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactVersionRequest`

Artifact Version Request interface with 10 public fields or methods.

Kind: interface
Import: import type { ArtifactVersionRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactVersionRequest {
    operationId: string;
    principal: ExecutionPrincipal;
    artifactId: string;
    expectedRevision: number;
    content: ArtifactByteSource;
    expectedContentHash?: string;
    expectedSizeBytes?: number;
    provenance: ArtifactProvenance;
    idempotencyKey?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`artifactId`	property	`artifactId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`content`	property	`content: ArtifactByteSource`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedContentHash`	property	`expectedContentHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedRevision`	property	`expectedRevision: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expectedSizeBytes`	property	`expectedSizeBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`idempotencyKey`	property	`idempotencyKey?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`operationId`	property	`operationId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`provenance`	property	`provenance: ArtifactProvenance`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactWorkspaceContent`

Artifact Workspace Content interface with 4 public fields or methods.

Kind: interface
Import: import type { ArtifactWorkspaceContent } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactWorkspaceContent {
    content: ArtifactByteSource;
    contentHash?: string;
    sizeBytes?: number;
    mimeType?: string;
}

Contract members

Member	Kind	Signature	Description
`content`	property	`content: ArtifactByteSource`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contentHash`	property	`contentHash?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mimeType`	property	`mimeType?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sizeBytes`	property	`sizeBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactWorkspaceContentReader`

Governed Workspace port used by ArtifactManager; it never accepts a host path.

Kind: interface
Import: import type { ArtifactWorkspaceContentReader } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactWorkspaceContentReader {
    read(request: ArtifactWorkspaceContentRequest): Promise<ArtifactWorkspaceContent>;
}

Contract members

Member	Kind	Signature	Description
`read`	method	`read(request: ArtifactWorkspaceContentRequest): Promise<ArtifactWorkspaceContent>`	Public method; parameters and return type are shown in the signature.

`ArtifactWorkspaceContentRequest`

Artifact Workspace Content Request interface with 4 public fields or methods.

Kind: interface
Import: import type { ArtifactWorkspaceContentRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface ArtifactWorkspaceContentRequest {
    principal: ExecutionPrincipal;
    workspaceId: string;
    relativePath: string;
    maxBytes?: number;
}

Contract members

Member	Kind	Signature	Description
`maxBytes`	property	`maxBytes?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`principal`	property	`principal: ExecutionPrincipal`	Public property; its type, readonly modifier and optionality are shown in the signature.
`relativePath`	property	`relativePath: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceId`	property	`workspaceId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`NormalizedArtifactError`

Normalized Artifact Error interface with 5 public fields or methods.

Kind: interface
Import: import type { NormalizedArtifactError } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export interface NormalizedArtifactError {
    code: 'ARTIFACT_INVALID_INPUT' | 'ARTIFACT_NOT_FOUND' | 'ARTIFACT_PERMISSION_DENIED' | 'ARTIFACT_TOO_LARGE' | 'ARTIFACT_TYPE_DENIED' | 'ARTIFACT_HASH_MISMATCH' | 'ARTIFACT_VERSION_CONFLICT' | 'ARTIFACT_STORE_UNAVAILABLE' | 'ARTIFACT_UPLOAD_FAILED' | 'ARTIFACT_DOWNLOAD_FAILED' | 'ARTIFACT_DELETE_BLOCKED' | 'ARTIFACT_DELETE_PARTIAL' | 'ARTIFACT_VALIDATION_FAILED' | 'ARTIFACT_INTERNAL_ERROR';
    message: string;
    retryable: boolean;
    details?: Record<string, unknown>;
    causeRef?: string;
}

Contract members

Member	Kind	Signature	Description
`causeRef`	property	`causeRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`code`	property	`code: "ARTIFACT_INVALID_INPUT" \| "ARTIFACT_NOT_FOUND" \| "ARTIFACT_PERMISSION_DENIED" \| "ARTIFACT_TOO_LARGE" \| "ARTIFACT_TYPE_DENIED" \| "ARTIFACT_HASH_MISMATCH" \| "ARTIFACT_VERSION_CONFLICT" \| "ARTIFACT_STORE_UNAVAILABLE" \| "ARTIFACT_UPLOAD_FAILED" \| "ARTIFACT_DOWNLOAD_FAILED" \| "ARTIFACT_DELETE_BLOCKED" \| "ARTIFACT_DELETE_PARTIAL" \| "ARTIFACT_VALIDATION_FAILED" \| "ARTIFACT_INTERNAL_ERROR"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`details`	property	`details?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`message`	property	`message: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`retryable`	property	`retryable: boolean`	Public property; its type, readonly modifier and optionality are shown in the signature.

`ArtifactArchiveRequest`

Public type alias for Artifact Archive Request; the declaration contains its complete type expression.

Kind: type
Import: import type { ArtifactArchiveRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export type ArtifactArchiveRequest = ArtifactMutationRequest;

`ArtifactDeleteRequest`

Public type alias for Artifact Delete Request; the declaration contains its complete type expression.

Kind: type
Import: import type { ArtifactDeleteRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export type ArtifactDeleteRequest = ArtifactMutationRequest;

`ArtifactFinalizeRequest`

Public type alias for Artifact Finalize Request; the declaration contains its complete type expression.

Kind: type
Import: import type { ArtifactFinalizeRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export type ArtifactFinalizeRequest = ArtifactMutationRequest;

`ArtifactInvalidateRequest`

Public type alias for Artifact Invalidate Request; the declaration contains its complete type expression.

Kind: type
Import: import type { ArtifactInvalidateRequest } from '@codesoul-co/hypha-core';
Source module: contracts/artifact-manager

Declaration

text

export type ArtifactInvalidateRequest = ArtifactMutationRequest;

@codesoul-co/hypha-core / contracts/artifact-manager ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Public exports ​

ArtifactCreateDownloadAccessRequest ​

Declaration ​

Contract members ​

ArtifactCreateRequest ​

Declaration ​

Contract members ​

ArtifactFromWorkspaceRequest ​

Declaration ​

Contract members ​

ArtifactGetRecordRequest ​

Declaration ​

Contract members ​

ArtifactLatestRequest ​

Declaration ​

Contract members ​

ArtifactListRequest ​

Declaration ​

Contract members ​

ArtifactManager ​

Declaration ​

Contract members ​

ArtifactMutationRequest ​

Declaration ​

Contract members ​

ArtifactPreviousRequest ​

Declaration ​

Contract members ​

ArtifactReadRequest ​

Declaration ​

Contract members ​

ArtifactReadResult ​

Declaration ​

Contract members ​

ArtifactTraceLineageRequest ​

Declaration ​

Contract members ​

ArtifactVersionRequest ​

Declaration ​

Contract members ​

ArtifactWorkspaceContent ​

Declaration ​

Contract members ​

ArtifactWorkspaceContentReader ​

Declaration ​

Contract members ​

ArtifactWorkspaceContentRequest ​

Declaration ​

Contract members ​

NormalizedArtifactError ​

Declaration ​

Contract members ​

ArtifactArchiveRequest ​

Declaration ​

ArtifactDeleteRequest ​

Declaration ​

ArtifactFinalizeRequest ​

Declaration ​

ArtifactInvalidateRequest ​

Declaration ​

`@codesoul-co/hypha-core` / `contracts/artifact-manager`

Using this module

Import from the package entrypoint

Usage patterns

Public exports

`ArtifactCreateDownloadAccessRequest`

Declaration

Contract members

`ArtifactCreateRequest`

Declaration

Contract members

`ArtifactFromWorkspaceRequest`

Declaration

Contract members

`ArtifactGetRecordRequest`

Declaration

Contract members

`ArtifactLatestRequest`

Declaration

Contract members

`ArtifactListRequest`

Declaration

Contract members

`ArtifactManager`

Declaration

Contract members

`ArtifactMutationRequest`

Declaration

Contract members

`ArtifactPreviousRequest`

Declaration

Contract members

`ArtifactReadRequest`

Declaration

Contract members

`ArtifactReadResult`

Declaration

Contract members

`ArtifactTraceLineageRequest`

Declaration

Contract members

`ArtifactVersionRequest`

Declaration

Contract members

`ArtifactWorkspaceContent`

Declaration

Contract members

`ArtifactWorkspaceContentReader`

Declaration

Contract members

`ArtifactWorkspaceContentRequest`

Declaration

Contract members

`NormalizedArtifactError`

Declaration

Contract members

`ArtifactArchiveRequest`

Declaration

`ArtifactDeleteRequest`

Declaration

`ArtifactFinalizeRequest`

Declaration

`ArtifactInvalidateRequest`

Declaration