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

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

Using this module

Use the Artifact module for declaring and runtime-validating contracts. It exports 15 interfaces, 3 types.

Import from the package entrypoint

import type {
  ArtifactAccessPolicySpec,
  ArtifactAccessRecord,
  ArtifactContentAddressingSpec,
  ArtifactLineage,
  ArtifactLineageNode,
  ArtifactPreviewPolicySpec,
  ArtifactProfileSpec,
  ArtifactProvenance,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

• Use the 18 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
ArtifactAccessPolicySpec	interface	interface ArtifactAccessPolicySpec	Artifact Access Policy Spec interface with 8 public fields or methods.
ArtifactAccessRecord	interface	interface ArtifactAccessRecord	Artifact Access Record interface with 5 public fields or methods.
ArtifactContentAddressingSpec	interface	interface ArtifactContentAddressingSpec	Artifact Content Addressing Spec interface with 3 public fields or methods.
ArtifactLineage	interface	interface ArtifactLineage	Artifact Lineage interface with 4 public fields or methods.
ArtifactLineageNode	interface	interface ArtifactLineageNode	Artifact Lineage Node interface with 6 public fields or methods.
ArtifactPreviewPolicySpec	interface	interface ArtifactPreviewPolicySpec	Artifact Preview Policy Spec interface with 3 public fields or methods.
ArtifactProfileSpec	interface	interface ArtifactProfileSpec extends VersionedSpec	Artifact Profile Spec interface with 15 public fields or methods.
ArtifactProvenance	interface	interface ArtifactProvenance	Artifact Provenance interface with 11 public fields or methods.
ArtifactRecord	interface	interface ArtifactRecord	Artifact Record interface with 41 public fields or methods.
ArtifactRef	interface	interface ArtifactRef	Artifact Ref interface with 7 public fields or methods.
ArtifactRetentionPolicySpec	interface	interface ArtifactRetentionPolicySpec	Artifact Retention Policy Spec interface with 7 public fields or methods.
ArtifactRetentionRecord	interface	interface ArtifactRetentionRecord	Artifact Retention Record interface with 5 public fields or methods.
ArtifactStorageRef	interface	interface ArtifactStorageRef	Artifact Storage Ref interface with 7 public fields or methods.
ArtifactValidationPolicySpec	interface	interface ArtifactValidationPolicySpec	Artifact Validation Policy Spec interface with 7 public fields or methods.
ArtifactVersioningPolicySpec	interface	interface ArtifactVersioningPolicySpec	Artifact Versioning Policy Spec interface with 3 public fields or methods.
ArtifactHashAlgorithm	type	type ArtifactHashAlgorithm = 'sha256' | 'blake3'	Public type alias for Artifact Hash Algorithm; the declaration contains its complete type expression.
ArtifactKind	type	type ArtifactKind = 'document' | 'code' | 'dataset' | 'image' | 'audio' | 'video' | 'table' | 'report' | 'archive' | 'patch' | 'snapshot' | 'test_report' | 'build_output' | 'log' | 'tool_output' | 'execution_receipt' | 'other'	Public type alias for Artifact Kind; the declaration contains its complete type expression.
ArtifactStatus	type	type ArtifactStatus = 'creating' | 'draft' | 'final' | 'archived' | 'invalidated' | 'deletion_pending' | 'deleted' | 'failed'	Public type alias for Artifact Status; the declaration contains its complete type expression.

ArtifactAccessPolicySpec

Artifact Access Policy Spec interface with 8 public fields or methods.

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

Declaration

export interface ArtifactAccessPolicySpec {
    defaultVisibility: 'private' | 'session' | 'workspace' | 'tenant' | 'shared';
    allowedPrincipalTypes?: ExecutionPrincipal['type'][];
    requiredReadScopes?: string[];
    requiredWriteScopes?: string[];
    requiredDeleteScopes?: string[];
    signedUrlTtlSeconds?: number;
    allowRangeRead?: boolean;
    allowCrossWorkspaceCopy?: boolean;
}

Contract members

Member	Kind	Signature	Description
allowCrossWorkspaceCopy	property	allowCrossWorkspaceCopy?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedPrincipalTypes	property	allowedPrincipalTypes?: ("system" | "agent" | "user" | "service")[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowRangeRead	property	allowRangeRead?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
defaultVisibility	property	defaultVisibility: "workspace" | "session" | "private" | "shared" | "tenant"	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredDeleteScopes	property	requiredDeleteScopes?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredReadScopes	property	requiredReadScopes?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
requiredWriteScopes	property	requiredWriteScopes?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
signedUrlTtlSeconds	property	signedUrlTtlSeconds?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactAccessRecord

Artifact Access Record interface with 5 public fields or methods.

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

Declaration

export interface ArtifactAccessRecord {
    visibility: ArtifactAccessPolicySpec['defaultVisibility'];
    ownerPrincipalId: string;
    workspaceId: string;
    allowedPrincipalIds?: string[];
    allowedRoles?: string[];
}

Contract members

Member	Kind	Signature	Description
allowedPrincipalIds	property	allowedPrincipalIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedRoles	property	allowedRoles?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
ownerPrincipalId	property	ownerPrincipalId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
visibility	property	visibility: "workspace" | "session" | "private" | "shared" | "tenant"	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.

ArtifactContentAddressingSpec

Artifact Content Addressing Spec interface with 3 public fields or methods.

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

Declaration

export interface ArtifactContentAddressingSpec {
    hashAlgorithm: ArtifactHashAlgorithm;
    verifyOnRead: boolean;
    deduplicate: boolean;
}

Contract members

Member	Kind	Signature	Description
deduplicate	property	deduplicate: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
hashAlgorithm	property	hashAlgorithm: ArtifactHashAlgorithm	Public property; its type, readonly modifier and optionality are shown in the signature.
verifyOnRead	property	verifyOnRead: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactLineage

Artifact Lineage interface with 4 public fields or methods.

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

Declaration

export interface ArtifactLineage {
    artifactId: string;
    ancestors: ArtifactLineageNode[];
    descendants: ArtifactLineageNode[];
    versions: ArtifactRecord[];
}

Contract members

Member	Kind	Signature	Description
ancestors	property	ancestors: ArtifactLineageNode[]	Public property; its type, readonly modifier and optionality are shown in the signature.
artifactId	property	artifactId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
descendants	property	descendants: ArtifactLineageNode[]	Public property; its type, readonly modifier and optionality are shown in the signature.
versions	property	versions: ArtifactRecord[]	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactLineageNode

Artifact Lineage Node interface with 6 public fields or methods.

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

Declaration

export interface ArtifactLineageNode {
    artifactId: string;
    versionId: string;
    logicalArtifactId: string;
    contentHash: string;
    kind?: ArtifactKind;
    transformation?: string;
}

Contract members

Member	Kind	Signature	Description
artifactId	property	artifactId: string	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.
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.
transformation	property	transformation?: 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.

ArtifactPreviewPolicySpec

Artifact Preview Policy Spec interface with 3 public fields or methods.

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

Declaration

export interface ArtifactPreviewPolicySpec {
    enabled: boolean;
    maxPreviewBytes?: number;
    allowedMimeTypes?: string[];
}

Contract members

Member	Kind	Signature	Description
allowedMimeTypes	property	allowedMimeTypes?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
enabled	property	enabled: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
maxPreviewBytes	property	maxPreviewBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactProfileSpec

Artifact Profile Spec interface with 15 public fields or methods.

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

Declaration

export interface ArtifactProfileSpec extends VersionedSpec {
    revision?: string;
    name?: string;
    storeRef: SpecRef;
    contentAddressing: ArtifactContentAddressingSpec;
    versioning: ArtifactVersioningPolicySpec;
    access: ArtifactAccessPolicySpec;
    retention: ArtifactRetentionPolicySpec;
    validation?: ArtifactValidationPolicySpec;
    preview?: ArtifactPreviewPolicySpec;
    allowedKinds?: ArtifactKind[];
    allowedMimeTypes?: string[];
    maxArtifactBytes?: number;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
access	property	access: ArtifactAccessPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedKinds	property	allowedKinds?: ArtifactKind[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowedMimeTypes	property	allowedMimeTypes?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
contentAddressing	property	contentAddressing: ArtifactContentAddressingSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
maxArtifactBytes	property	maxArtifactBytes?: number	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.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
preview	property	preview?: ArtifactPreviewPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
retention	property	retention: ArtifactRetentionPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
revision	property	revision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
storeRef	property	storeRef: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
validation	property	validation?: ArtifactValidationPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.
versioning	property	versioning: ArtifactVersioningPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactProvenance

Artifact Provenance interface with 11 public fields or methods.

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

Declaration

export interface ArtifactProvenance {
    sourceType: 'user_upload' | 'agent_generated' | 'tool_generated' | 'command_generated' | 'derived' | 'imported' | 'snapshot' | 'patch';
    createdBy: string;
    sourceEventId?: string;
    toolInvocationId?: string;
    executionId?: string;
    workflowState?: string;
    sourceArtifactIds?: string[];
    transformation?: string;
    environmentHash?: string;
    commandHash?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
commandHash	property	commandHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdBy	property	createdBy: string	Public property; its type, readonly modifier and optionality are shown in the signature.
environmentHash	property	environmentHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
executionId	property	executionId?: 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.
sourceArtifactIds	property	sourceArtifactIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceEventId	property	sourceEventId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceType	property	sourceType: "patch" | "snapshot" | "user_upload" | "agent_generated" | "tool_generated" | "command_generated" | "derived" | "imported"	Public property; its type, readonly modifier and optionality are shown in the signature.
toolInvocationId	property	toolInvocationId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
transformation	property	transformation?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
workflowState	property	workflowState?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactRecord

Artifact Record interface with 41 public fields or methods.

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

Declaration

export interface ArtifactRecord {
    id: string;
    versionId: string;
    versionNumber: number;
    revision: number;
    tenantId?: string;
    userId: string;
    workspaceId: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
    name: string;
    description?: string;
    relativePath?: string;
    kind: ArtifactKind;
    mimeType?: string;
    encoding?: string;
    sizeBytes: number;
    contentHash: string;
    hashAlgorithm: ArtifactHashAlgorithm;
    storageRef: ArtifactStorageRef;
    /** True when this version reused an already committed content-addressed Blob. */
    deduplicated?: boolean;
    logicalArtifactId: string;
    parentVersionId?: string;
    previousVersionId?: string;
    nextVersionId?: string;
    sourceArtifactIds?: string[];
    derivedArtifactIds?: string[];
    provenance: ArtifactProvenance;
    access: ArtifactAccessRecord;
    retention: ArtifactRetentionRecord;
    status: ArtifactStatus;
    immutable?: boolean;
    sensitive?: boolean;
    tags?: string[];
    createdAt: string;
    updatedAt: string;
    finalizedAt?: string;
    archivedAt?: string;
    expiresAt?: string;
    deletedAt?: 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.
archivedAt	property	archivedAt?: string	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.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
deduplicated	property	deduplicated?: boolean	True when this version reused an already committed content-addressed Blob.
deletedAt	property	deletedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
derivedArtifactIds	property	derivedArtifactIds?: string[]	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.
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
finalizedAt	property	finalizedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
hashAlgorithm	property	hashAlgorithm: ArtifactHashAlgorithm	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
immutable	property	immutable?: boolean	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.
nextVersionId	property	nextVersionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
parentVersionId	property	parentVersionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
previousVersionId	property	previousVersionId?: string	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.
revision	property	revision: number	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.
sizeBytes	property	sizeBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceArtifactIds	property	sourceArtifactIds?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status: ArtifactStatus	Public property; its type, readonly modifier and optionality are shown in the signature.
storageRef	property	storageRef: ArtifactStorageRef	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.
updatedAt	property	updatedAt: 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.
versionId	property	versionId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
versionNumber	property	versionNumber: number	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.

ArtifactRef

Artifact Ref interface with 7 public fields or methods.

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

Declaration

export interface ArtifactRef {
    artifactId: string;
    versionId?: string;
    contentHash: string;
    kind?: ArtifactKind;
    mimeType?: string;
    sizeBytes?: number;
    accessTokenRef?: string;
}

Contract members

Member	Kind	Signature	Description
accessTokenRef	property	accessTokenRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
artifactId	property	artifactId: string	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.
kind	property	kind?: ArtifactKind	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.
versionId	property	versionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactRetentionPolicySpec

Artifact Retention Policy Spec interface with 7 public fields or methods.

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

Declaration

export interface ArtifactRetentionPolicySpec {
    defaultTtlSeconds?: number;
    archiveAfterSeconds?: number;
    deleteAfterSeconds?: number;
    retainFinal?: boolean;
    retainOnFailure?: boolean;
    legalHoldSupported?: boolean;
    garbageCollectUnreferenced?: boolean;
}

Contract members

Member	Kind	Signature	Description
archiveAfterSeconds	property	archiveAfterSeconds?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
defaultTtlSeconds	property	defaultTtlSeconds?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
deleteAfterSeconds	property	deleteAfterSeconds?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
garbageCollectUnreferenced	property	garbageCollectUnreferenced?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
legalHoldSupported	property	legalHoldSupported?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
retainFinal	property	retainFinal?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
retainOnFailure	property	retainOnFailure?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactRetentionRecord

Artifact Retention Record interface with 5 public fields or methods.

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

Declaration

export interface ArtifactRetentionRecord {
    policyRef?: SpecRef;
    expiresAt?: string;
    archivedAt?: string;
    legalHold?: boolean;
    referencedByCount?: number;
}

Contract members

Member	Kind	Signature	Description
archivedAt	property	archivedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
legalHold	property	legalHold?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
policyRef	property	policyRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
referencedByCount	property	referencedByCount?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactStorageRef

Artifact Storage Ref interface with 7 public fields or methods.

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

Declaration

export interface ArtifactStorageRef {
    storeId: string;
    bucketOrNamespace?: string;
    objectKey: string;
    versionId?: string;
    etag?: string;
    region?: string;
    encrypted?: boolean;
}

Contract members

Member	Kind	Signature	Description
bucketOrNamespace	property	bucketOrNamespace?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
encrypted	property	encrypted?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
etag	property	etag?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
objectKey	property	objectKey: string	Public property; its type, readonly modifier and optionality are shown in the signature.
region	property	region?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
storeId	property	storeId: 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.

ArtifactValidationPolicySpec

Artifact Validation Policy Spec interface with 7 public fields or methods.

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

Declaration

export interface ArtifactValidationPolicySpec {
    verifyMimeType?: boolean;
    verifyExtension?: boolean;
    malwareScanRef?: SpecRef;
    archiveBombProtection?: boolean;
    maxExpandedBytes?: number;
    checksumRequired?: boolean;
    rejectExecutableUploads?: boolean;
}

Contract members

Member	Kind	Signature	Description
archiveBombProtection	property	archiveBombProtection?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
checksumRequired	property	checksumRequired?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
malwareScanRef	property	malwareScanRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
maxExpandedBytes	property	maxExpandedBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
rejectExecutableUploads	property	rejectExecutableUploads?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
verifyExtension	property	verifyExtension?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
verifyMimeType	property	verifyMimeType?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

ArtifactVersioningPolicySpec

Artifact Versioning Policy Spec interface with 3 public fields or methods.

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

Declaration

export interface ArtifactVersioningPolicySpec {
    /** E4 guarantees immutable history; replacement semantics are deliberately unsupported. */
    strategy: 'append_only';
    retainPreviousVersions: true;
    maxVersions?: number;
}

Contract members

Member	Kind	Signature	Description
maxVersions	property	maxVersions?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
retainPreviousVersions	property	retainPreviousVersions: true	Public property; its type, readonly modifier and optionality are shown in the signature.
strategy	property	strategy: "append_only"	E4 guarantees immutable history; replacement semantics are deliberately unsupported.

ArtifactHashAlgorithm

Public type alias for Artifact Hash Algorithm; the declaration contains its complete type expression.

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

Declaration

export type ArtifactHashAlgorithm = 'sha256' | 'blake3';

ArtifactKind

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

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

Declaration

export type ArtifactKind = 'document' | 'code' | 'dataset' | 'image' | 'audio' | 'video' | 'table' | 'report' | 'archive' | 'patch' | 'snapshot' | 'test_report' | 'build_output' | 'log' | 'tool_output' | 'execution_receipt' | 'other';

ArtifactStatus

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

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

Declaration

export type ArtifactStatus = 'creating' | 'draft' | 'final' | 'archived' | 'invalidated' | 'deletion_pending' | 'deleted' | 'failed';