@codesoul-co/hypha-core / modules/artifact/index

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

Using this module

Use the Index module for using the public contracts and operations for this capability boundary. It exports 40 constants, 6 functions.

Import from the package entrypoint

import {
  artifactAccessPolicySpecJsonSchema,
  artifactAccessPolicySpecSchema,
  artifactAccessRecordJsonSchema,
  artifactAccessRecordSchema,
  artifactContentAddressingSpecJsonSchema,
  artifactContentAddressingSpecSchema,
  artifactContentHashSchema,
  artifactContractJsonSchemas,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

• The module exposes 6 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 40 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { artifactAccessPolicySpecSchema } from '@codesoul-co/hypha-core';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = artifactAccessPolicySpecSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
artifactAccessPolicySpecJsonSchema	constant	const artifactAccessPolicySpecJsonSchema: JsonSchema	JSON Schema for Artifact Access Policy Spec.
artifactAccessPolicySpecSchema	constant	const artifactAccessPolicySpecSchema: z.ZodEffects<z.ZodObject<{ defaultVisibility: z.ZodEnum<["private", "session", "workspace", "tenant", "shared"]>; allowedPrincipalTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<["user", "agent", "service", "system"]>, "many">>; requiredReadScopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; requiredWriteScopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; requiredDeleteScope...	Runtime schema for Artifact Access Policy Spec.
artifactAccessRecordJsonSchema	constant	const artifactAccessRecordJsonSchema: JsonSchema	JSON Schema for Artifact Access Record.
artifactAccessRecordSchema	constant	const artifactAccessRecordSchema: z.ZodEffects<z.ZodObject<{ visibility: z.ZodEnum<["private", "session", "workspace", "tenant", "shared"]>; ownerPrincipalId: z.ZodString; workspaceId: z.ZodString; allowedPrincipalIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; allowedRoles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strict", z.ZodTypeAny, { workspaceId: string; visibility: "private" | "session" | "w...	Runtime schema for Artifact Access Record.
artifactContentAddressingSpecJsonSchema	constant	const artifactContentAddressingSpecJsonSchema: JsonSchema	JSON Schema for Artifact Content Addressing Spec.
artifactContentAddressingSpecSchema	constant	const artifactContentAddressingSpecSchema: z.ZodObject<{ hashAlgorithm: z.ZodEnum<["sha256", "blake3"]>; verifyOnRead: z.ZodBoolean; deduplicate: z.ZodBoolean; }, "strict", z.ZodTypeAny, { hashAlgorithm: "sha256" | "blake3"; verifyOnRead: boolean; deduplicate: boolean; }, { hashAlgorithm: "sha256" | "blake3"; verifyOnRead: boolean; deduplicate: boolean; }>	Runtime schema for Artifact Content Addressing Spec.
artifactContentHashSchema	constant	const artifactContentHashSchema: z.ZodString	Runtime schema for Artifact Content Hash.
artifactContractJsonSchemas	constant	const artifactContractJsonSchemas: Record<string, JsonSchema>	Artifact Contract JSON Schemas constant exported by the modules/artifact/index module.
artifactHashAlgorithmSchema	constant	const artifactHashAlgorithmSchema: z.ZodEnum<["sha256", "blake3"]>	Runtime schema for Artifact Hash Algorithm.
artifactKindSchema	constant	const artifactKindSchema: z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", "execution_receipt", "other"]>	Runtime schema for Artifact Kind.
artifactLineageExample	constant	const artifactLineageExample: ArtifactLineage	Valid example value for Artifact Lineage.
artifactLineageJsonSchema	constant	const artifactLineageJsonSchema: JsonSchema	JSON Schema for Artifact Lineage.
artifactLineageNodeJsonSchema	constant	const artifactLineageNodeJsonSchema: JsonSchema	JSON Schema for Artifact Lineage Node.
artifactLineageNodeSchema	constant	const artifactLineageNodeSchema: z.ZodObject<{ artifactId: z.ZodString; versionId: z.ZodString; logicalArtifactId: z.ZodString; contentHash: z.ZodString; kind: z.ZodOptional<z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", "execution_receipt", "other"]>>; transformation: z.ZodOptional<z.ZodSt...	Runtime schema for Artifact Lineage Node.
artifactLineageSchema	constant	const artifactLineageSchema: z.ZodEffects<z.ZodObject<{ artifactId: z.ZodString; ancestors: z.ZodArray<z.ZodObject<{ artifactId: z.ZodString; versionId: z.ZodString; logicalArtifactId: z.ZodString; contentHash: z.ZodString; kind: z.ZodOptional<z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", ...	Runtime schema for Artifact Lineage.
artifactPreviewPolicySpecJsonSchema	constant	const artifactPreviewPolicySpecJsonSchema: JsonSchema	JSON Schema for Artifact Preview Policy Spec.
artifactPreviewPolicySpecSchema	constant	const artifactPreviewPolicySpecSchema: z.ZodEffects<z.ZodObject<{ enabled: z.ZodBoolean; maxPreviewBytes: z.ZodOptional<z.ZodNumber>; allowedMimeTypes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strict", z.ZodTypeAny, { enabled: boolean; maxPreviewBytes?: number | undefined; allowedMimeTypes?: string[] | undefined; }, { enabled: boolean; maxPreviewBytes?: number | undefined; allowedMimeTypes?: string[] | ...	Runtime schema for Artifact Preview Policy Spec.
artifactProfileSpecExample	constant	const artifactProfileSpecExample: ArtifactProfileSpec	Valid example value for Artifact Profile Spec.
artifactProfileSpecJsonSchema	constant	const artifactProfileSpecJsonSchema: JsonSchema	JSON Schema for Artifact Profile Spec.
artifactProfileSpecSchema	constant	const artifactProfileSpecSchema: z.ZodEffects<z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { revision: z.ZodOptional<z.ZodString>; name: z.ZodOptional<z.ZodString>; storeRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revisi...	Runtime schema for Artifact Profile Spec.
artifactProvenanceJsonSchema	constant	const artifactProvenanceJsonSchema: JsonSchema	JSON Schema for Artifact Provenance.
artifactProvenanceSchema	constant	const artifactProvenanceSchema: z.ZodEffects<z.ZodObject<{ sourceType: z.ZodEnum<["user_upload", "agent_generated", "tool_generated", "command_generated", "derived", "imported", "snapshot", "patch"]>; createdBy: z.ZodString; sourceEventId: z.ZodOptional<z.ZodString>; toolInvocationId: z.ZodOptional<z.ZodString>; executionId: z.ZodOptional<z.ZodString>; workflowState: z.ZodOptional<z.ZodString>; sourceArtifactIds: ...	Runtime schema for Artifact Provenance.
artifactRecordExample	constant	const artifactRecordExample: ArtifactRecord	Valid example value for Artifact Record.
artifactRecordJsonSchema	constant	const artifactRecordJsonSchema: JsonSchema	JSON Schema for Artifact Record.
artifactRecordSchema	constant	const artifactRecordSchema: z.ZodEffects<z.ZodObject<{ id: z.ZodString; versionId: z.ZodString; versionNumber: z.ZodNumber; revision: z.ZodNumber; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; sessionId: z.ZodOptional<z.ZodString>; runId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; name: z.ZodString; description: z.ZodOptional<z.ZodString>; relativePath: ...	Runtime schema for Artifact Record.
artifactRefExample	constant	const artifactRefExample: ArtifactRef	Valid example value for Artifact Ref.
artifactRefJsonSchema	constant	const artifactRefJsonSchema: JsonSchema	JSON Schema for Artifact Ref.
artifactRefSchema	constant	const artifactRefSchema: z.ZodObject<{ artifactId: z.ZodString; versionId: z.ZodOptional<z.ZodString>; contentHash: z.ZodString; kind: z.ZodOptional<z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", "execution_receipt", "other"]>>; mimeType: z.ZodOptional<z.ZodString>; sizeBytes: z.ZodOptional...	Runtime schema for Artifact Ref.
artifactRetentionPolicySpecJsonSchema	constant	const artifactRetentionPolicySpecJsonSchema: JsonSchema	JSON Schema for Artifact Retention Policy Spec.
artifactRetentionPolicySpecSchema	constant	const artifactRetentionPolicySpecSchema: z.ZodEffects<z.ZodObject<{ defaultTtlSeconds: z.ZodOptional<z.ZodNumber>; archiveAfterSeconds: z.ZodOptional<z.ZodNumber>; deleteAfterSeconds: z.ZodOptional<z.ZodNumber>; retainFinal: z.ZodOptional<z.ZodBoolean>; retainOnFailure: z.ZodOptional<z.ZodBoolean>; legalHoldSupported: z.ZodOptional<z.ZodBoolean>; garbageCollectUnreferenced: z.ZodOptional<z.ZodBoolean>; }, "strict"...	Runtime schema for Artifact Retention Policy Spec.
artifactRetentionRecordJsonSchema	constant	const artifactRetentionRecordJsonSchema: JsonSchema	JSON Schema for Artifact Retention Record.
artifactRetentionRecordSchema	constant	const artifactRetentionRecordSchema: z.ZodObject<{ policyRef: z.ZodOptional<z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revision?: string | undefined; version?: string | undefined; }>>; expiresAt: z.ZodOptional<z.ZodString>; archivedAt: ...	Runtime schema for Artifact Retention Record.
artifactStatusSchema	constant	const artifactStatusSchema: z.ZodEnum<["creating", "draft", "final", "archived", "invalidated", "deletion_pending", "deleted", "failed"]>	Runtime schema for Artifact Status.
artifactStorageRefJsonSchema	constant	const artifactStorageRefJsonSchema: JsonSchema	JSON Schema for Artifact Storage Ref.
artifactStorageRefSchema	constant	const artifactStorageRefSchema: z.ZodObject<{ storeId: z.ZodString; bucketOrNamespace: z.ZodOptional<z.ZodString>; objectKey: z.ZodString; versionId: z.ZodOptional<z.ZodString>; etag: z.ZodOptional<z.ZodString>; region: z.ZodOptional<z.ZodString>; encrypted: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | und...	Runtime schema for Artifact Storage Ref.
artifactValidationPolicySpecJsonSchema	constant	const artifactValidationPolicySpecJsonSchema: JsonSchema	JSON Schema for Artifact Validation Policy Spec.
artifactValidationPolicySpecSchema	constant	const artifactValidationPolicySpecSchema: z.ZodObject<{ verifyMimeType: z.ZodOptional<z.ZodBoolean>; verifyExtension: z.ZodOptional<z.ZodBoolean>; malwareScanRef: z.ZodOptional<z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revision?: strin...	Runtime schema for Artifact Validation Policy Spec.
artifactVersioningPolicySpecJsonSchema	constant	const artifactVersioningPolicySpecJsonSchema: JsonSchema	JSON Schema for Artifact Versioning Policy Spec.
artifactVersioningPolicySpecSchema	constant	const artifactVersioningPolicySpecSchema: z.ZodObject<{ strategy: z.ZodLiteral<"append_only">; retainPreviousVersions: z.ZodLiteral<true>; maxVersions: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { strategy: "append_only"; retainPreviousVersions: true; maxVersions?: number | undefined; }, { strategy: "append_only"; retainPreviousVersions: true; maxVersions?: number | undefined; }>	Runtime schema for Artifact Versioning Policy Spec.
storedArtifactRecordSchema	constant	const storedArtifactRecordSchema: z.ZodObject<{ record: z.ZodEffects<z.ZodObject<{ id: z.ZodString; versionId: z.ZodString; versionNumber: z.ZodNumber; revision: z.ZodNumber; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodString; workspaceId: z.ZodString; sessionId: z.ZodOptional<z.ZodString>; runId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; name: z.ZodString; description: z.ZodOptional<...	Runtime schema for Stored Artifact Record.
validateArtifactLineage	function	validateArtifactLineage(input: unknown): ArtifactLineage	Validate Artifact Lineage function with 1 public call signature; parameters and return types are listed below.
validateArtifactProfileSpec	function	validateArtifactProfileSpec(input: unknown): ArtifactProfileSpec	Validate Artifact Profile Spec function with 1 public call signature; parameters and return types are listed below.
validateArtifactRecord	function	validateArtifactRecord(input: unknown): ArtifactRecord	Validate Artifact Record function with 1 public call signature; parameters and return types are listed below.
validateArtifactRef	function	validateArtifactRef(input: unknown): ArtifactRef	Validate Artifact Ref function with 1 public call signature; parameters and return types are listed below.
validateStoredArtifactRecord	function	validateStoredArtifactRecord(input: unknown): StoredArtifactRecord	Validate Stored Artifact Record function with 1 public call signature; parameters and return types are listed below.
validateStoredArtifactRecords	function	validateStoredArtifactRecords(input: unknown): StoredArtifactRecord[]	Validate Stored Artifact Records function with 1 public call signature; parameters and return types are listed below.

artifactAccessPolicySpecJsonSchema

JSON Schema for Artifact Access Policy Spec.

• Kind: constant
• Import: import { artifactAccessPolicySpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactAccessPolicySpecJsonSchema: JsonSchema;

artifactAccessPolicySpecSchema

Runtime schema for Artifact Access Policy Spec.

• Kind: constant
• Import: import { artifactAccessPolicySpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactAccessPolicySpecSchema: z.ZodEffects<z.ZodObject<{ defaultVisibility: z.ZodEnum<["private", "session", "workspace", "tenant", "shared"]>; allowedPrincipalTypes: z.ZodOptional<z.ZodArray<z.ZodEnum<["user", "agent", "service", "system"]>, "many">>; requiredReadScopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; requiredWriteScopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; requiredDeleteScopes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; signedUrlTtlSeconds: z.ZodOptional<z.ZodNumber>; allowRangeRead: z.ZodOptional<z.ZodBoolean>; allowCrossWorkspaceCopy: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { defaultVisibility: "private" | "session" | "workspace" | "tenant" | "shared"; allowedPrincipalTypes?: ("user" | "agent" | "service" | "system")[] | undefined; requiredReadScopes?: string[] | undefined; requiredWriteScopes?: string[] | undefined; requiredDeleteScopes?: string[] | undefined; signedUrlTtlSeconds?: number | undefined; allowRangeRead?: boolean | undefined; allowCrossWorkspaceCopy?: boolean | undefined; }, { defaultVisibility: "private" | "session" | "workspace" | "tenant" | "shared"; allowedPrincipalTypes?: ("user" | "agent" | "service" | "system")[] | undefined; requiredReadScopes?: string[] | undefined; requiredWriteScopes?: string[] | undefined; requiredDeleteScopes?: string[] | undefined; signedUrlTtlSeconds?: number | undefined; allowRangeRead?: boolean | undefined; allowCrossWorkspaceCopy?: boolean | undefined; }>, { defaultVisibility: "private" | "session" | "workspace" | "tenant" | "shared"; allowedPrincipalTypes?: ("user" | "agent" | "service" | "system")[] | undefined; requiredReadScopes?: string[] | undefined; requiredWriteScopes?: string[] | undefined; requiredDeleteScopes?: string[] | undefined; signedUrlTtlSeconds?: number | undefined; allowRangeRead?: boolean | undefined; allowCrossWorkspaceCopy?: boolean | undefined; }, { defaultVisibility: "private" | "session" | "workspace" | "tenant" | "shared"; allowedPrincipalTypes?: ("user" | "agent" | "service" | "system")[] | undefined; requiredReadScopes?: string[] | undefined; requiredWriteScopes?: string[] | undefined; requiredDeleteScopes?: string[] | undefined; signedUrlTtlSeconds?: number | undefined; allowRangeRead?: boolean | undefined; allowCrossWorkspaceCopy?: boolean | undefined; }>;

artifactAccessRecordJsonSchema

JSON Schema for Artifact Access Record.

• Kind: constant
• Import: import { artifactAccessRecordJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactAccessRecordJsonSchema: JsonSchema;

artifactAccessRecordSchema

Runtime schema for Artifact Access Record.

• Kind: constant
• Import: import { artifactAccessRecordSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactAccessRecordSchema: z.ZodEffects<z.ZodObject<{ visibility: z.ZodEnum<["private", "session", "workspace", "tenant", "shared"]>; ownerPrincipalId: z.ZodString; workspaceId: z.ZodString; allowedPrincipalIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; allowedRoles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strict", z.ZodTypeAny, { workspaceId: string; visibility: "private" | "session" | "workspace" | "tenant" | "shared"; ownerPrincipalId: string; allowedPrincipalIds?: string[] | undefined; allowedRoles?: string[] | undefined; }, { workspaceId: string; visibility: "private" | "session" | "workspace" | "tenant" | "shared"; ownerPrincipalId: string; allowedPrincipalIds?: string[] | undefined; allowedRoles?: string[] | undefined; }>, { workspaceId: string; visibility: "private" | "session" | "workspace" | "tenant" | "shared"; ownerPrincipalId: string; allowedPrincipalIds?: string[] | undefined; allowedRoles?: string[] | undefined; }, { workspaceId: string; visibility: "private" | "session" | "workspace" | "tenant" | "shared"; ownerPrincipalId: string; allowedPrincipalIds?: string[] | undefined; allowedRoles?: string[] | undefined; }>;

artifactContentAddressingSpecJsonSchema

JSON Schema for Artifact Content Addressing Spec.

• Kind: constant
• Import: import { artifactContentAddressingSpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactContentAddressingSpecJsonSchema: JsonSchema;

artifactContentAddressingSpecSchema

Runtime schema for Artifact Content Addressing Spec.

• Kind: constant
• Import: import { artifactContentAddressingSpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactContentAddressingSpecSchema: z.ZodObject<{ hashAlgorithm: z.ZodEnum<["sha256", "blake3"]>; verifyOnRead: z.ZodBoolean; deduplicate: z.ZodBoolean; }, "strict", z.ZodTypeAny, { hashAlgorithm: "sha256" | "blake3"; verifyOnRead: boolean; deduplicate: boolean; }, { hashAlgorithm: "sha256" | "blake3"; verifyOnRead: boolean; deduplicate: boolean; }>;

artifactContentHashSchema

Runtime schema for Artifact Content Hash.

• Kind: constant
• Import: import { artifactContentHashSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactContentHashSchema: z.ZodString;

artifactContractJsonSchemas

Artifact Contract JSON Schemas constant exported by the modules/artifact/index module.

• Kind: constant
• Import: import { artifactContractJsonSchemas } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactContractJsonSchemas: Record<string, JsonSchema>;

artifactHashAlgorithmSchema

Runtime schema for Artifact Hash Algorithm.

• Kind: constant
• Import: import { artifactHashAlgorithmSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactHashAlgorithmSchema: z.ZodEnum<["sha256", "blake3"]>;

artifactKindSchema

Runtime schema for Artifact Kind.

• Kind: constant
• Import: import { artifactKindSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactKindSchema: z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", "execution_receipt", "other"]>;

artifactLineageExample

Valid example value for Artifact Lineage.

• Kind: constant
• Import: import { artifactLineageExample } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactLineageExample: ArtifactLineage;

artifactLineageJsonSchema

JSON Schema for Artifact Lineage.

• Kind: constant
• Import: import { artifactLineageJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactLineageJsonSchema: JsonSchema;

artifactLineageNodeJsonSchema

JSON Schema for Artifact Lineage Node.

• Kind: constant
• Import: import { artifactLineageNodeJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactLineageNodeJsonSchema: JsonSchema;

artifactLineageNodeSchema

Runtime schema for Artifact Lineage Node.

• Kind: constant
• Import: import { artifactLineageNodeSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactLineageNodeSchema: z.ZodObject<{ artifactId: z.ZodString; versionId: z.ZodString; logicalArtifactId: z.ZodString; contentHash: z.ZodString; kind: z.ZodOptional<z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", "execution_receipt", "other"]>>; transformation: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { versionId: string; contentHash: string; logicalArtifactId: string; artifactId: string; kind?: "document" | "code" | "dataset" | "image" | "audio" | "video" | "table" | "report" | "archive" | "patch" | "snapshot" | "test_report" | "build_output" | "log" | "tool_output" | "execution_receipt" | "other" | undefined; transformation?: string | undefined; }, { versionId: string; contentHash: string; logicalArtifactId: string; artifactId: string; kind?: "document" | "code" | "dataset" | "image" | "audio" | "video" | "table" | "report" | "archive" | "patch" | "snapshot" | "test_report" | "build_output" | "log" | "tool_output" | "execution_receipt" | "other" | undefined; transformation?: string | undefined; }>;

artifactLineageSchema

Runtime schema for Artifact Lineage.

• Kind: constant
• Import: import { artifactLineageSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const artifactLineageSchema: (typeof import('@codesoul-co/hypha-core'))['artifactLineageSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

artifactPreviewPolicySpecJsonSchema

JSON Schema for Artifact Preview Policy Spec.

• Kind: constant
• Import: import { artifactPreviewPolicySpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactPreviewPolicySpecJsonSchema: JsonSchema;

artifactPreviewPolicySpecSchema

Runtime schema for Artifact Preview Policy Spec.

• Kind: constant
• Import: import { artifactPreviewPolicySpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactPreviewPolicySpecSchema: z.ZodEffects<z.ZodObject<{ enabled: z.ZodBoolean; maxPreviewBytes: z.ZodOptional<z.ZodNumber>; allowedMimeTypes: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strict", z.ZodTypeAny, { enabled: boolean; maxPreviewBytes?: number | undefined; allowedMimeTypes?: string[] | undefined; }, { enabled: boolean; maxPreviewBytes?: number | undefined; allowedMimeTypes?: string[] | undefined; }>, { enabled: boolean; maxPreviewBytes?: number | undefined; allowedMimeTypes?: string[] | undefined; }, { enabled: boolean; maxPreviewBytes?: number | undefined; allowedMimeTypes?: string[] | undefined; }>;

artifactProfileSpecExample

Valid example value for Artifact Profile Spec.

• Kind: constant
• Import: import { artifactProfileSpecExample } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactProfileSpecExample: ArtifactProfileSpec;

artifactProfileSpecJsonSchema

JSON Schema for Artifact Profile Spec.

• Kind: constant
• Import: import { artifactProfileSpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactProfileSpecJsonSchema: JsonSchema;

artifactProfileSpecSchema

Runtime schema for Artifact Profile Spec.

• Kind: constant
• Import: import { artifactProfileSpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const artifactProfileSpecSchema: (typeof import('@codesoul-co/hypha-core'))['artifactProfileSpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

artifactProvenanceJsonSchema

JSON Schema for Artifact Provenance.

• Kind: constant
• Import: import { artifactProvenanceJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactProvenanceJsonSchema: JsonSchema;

artifactProvenanceSchema

Runtime schema for Artifact Provenance.

• Kind: constant
• Import: import { artifactProvenanceSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactProvenanceSchema: z.ZodEffects<z.ZodObject<{ sourceType: z.ZodEnum<["user_upload", "agent_generated", "tool_generated", "command_generated", "derived", "imported", "snapshot", "patch"]>; createdBy: z.ZodString; sourceEventId: z.ZodOptional<z.ZodString>; toolInvocationId: z.ZodOptional<z.ZodString>; executionId: z.ZodOptional<z.ZodString>; workflowState: z.ZodOptional<z.ZodString>; sourceArtifactIds: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; transformation: z.ZodOptional<z.ZodString>; environmentHash: z.ZodOptional<z.ZodString>; commandHash: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { sourceType: "patch" | "snapshot" | "user_upload" | "agent_generated" | "tool_generated" | "command_generated" | "derived" | "imported"; createdBy: string; sourceArtifactIds?: string[] | undefined; sourceEventId?: string | undefined; toolInvocationId?: string | undefined; executionId?: string | undefined; workflowState?: string | undefined; transformation?: string | undefined; environmentHash?: string | undefined; commandHash?: string | undefined; metadata?: Record<string, unknown> | undefined; }, { sourceType: "patch" | "snapshot" | "user_upload" | "agent_generated" | "tool_generated" | "command_generated" | "derived" | "imported"; createdBy: string; sourceArtifactIds?: string[] | undefined; sourceEventId?: string | undefined; toolInvocationId?: string | undefined; executionId?: string | undefined; workflowState?: string | undefined; transformation?: string | undefined; environmentHash?: string | undefined; commandHash?: string | undefined; metadata?: Record<string, unknown> | undefined; }>, { sourceType: "patch" | "snapshot" | "user_upload" | "agent_generated" | "tool_generated" | "command_generated" | "derived" | "imported"; createdBy: string; sourceArtifactIds?: string[] | undefined; sourceEventId?: string | undefined; toolInvocationId?: string | undefined; executionId?: string | undefined; workflowState?: string | undefined; transformation?: string | undefined; environmentHash?: string | undefined; commandHash?: string | undefined; metadata?: Record<string, unknown> | undefined; }, { sourceType: "patch" | "snapshot" | "user_upload" | "agent_generated" | "tool_generated" | "command_generated" | "derived" | "imported"; createdBy: string; sourceArtifactIds?: string[] | undefined; sourceEventId?: string | undefined; toolInvocationId?: string | undefined; executionId?: string | undefined; workflowState?: string | undefined; transformation?: string | undefined; environmentHash?: string | undefined; commandHash?: string | undefined; metadata?: Record<string, unknown> | undefined; }>;

artifactRecordExample

Valid example value for Artifact Record.

• Kind: constant
• Import: import { artifactRecordExample } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRecordExample: ArtifactRecord;

artifactRecordJsonSchema

JSON Schema for Artifact Record.

• Kind: constant
• Import: import { artifactRecordJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRecordJsonSchema: JsonSchema;

artifactRecordSchema

Runtime schema for Artifact Record.

• Kind: constant
• Import: import { artifactRecordSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const artifactRecordSchema: (typeof import('@codesoul-co/hypha-core'))['artifactRecordSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

artifactRefExample

Valid example value for Artifact Ref.

• Kind: constant
• Import: import { artifactRefExample } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRefExample: ArtifactRef;

artifactRefJsonSchema

JSON Schema for Artifact Ref.

• Kind: constant
• Import: import { artifactRefJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRefJsonSchema: JsonSchema;

artifactRefSchema

Runtime schema for Artifact Ref.

• Kind: constant
• Import: import { artifactRefSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRefSchema: z.ZodObject<{ artifactId: z.ZodString; versionId: z.ZodOptional<z.ZodString>; contentHash: z.ZodString; kind: z.ZodOptional<z.ZodEnum<["document", "code", "dataset", "image", "audio", "video", "table", "report", "archive", "patch", "snapshot", "test_report", "build_output", "log", "tool_output", "execution_receipt", "other"]>>; mimeType: z.ZodOptional<z.ZodString>; sizeBytes: z.ZodOptional<z.ZodNumber>; accessTokenRef: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { contentHash: string; artifactId: string; versionId?: string | undefined; kind?: "document" | "code" | "dataset" | "image" | "audio" | "video" | "table" | "report" | "archive" | "patch" | "snapshot" | "test_report" | "build_output" | "log" | "tool_output" | "execution_receipt" | "other" | undefined; mimeType?: string | undefined; sizeBytes?: number | undefined; accessTokenRef?: string | undefined; }, { contentHash: string; artifactId: string; versionId?: string | undefined; kind?: "document" | "code" | "dataset" | "image" | "audio" | "video" | "table" | "report" | "archive" | "patch" | "snapshot" | "test_report" | "build_output" | "log" | "tool_output" | "execution_receipt" | "other" | undefined; mimeType?: string | undefined; sizeBytes?: number | undefined; accessTokenRef?: string | undefined; }>;

artifactRetentionPolicySpecJsonSchema

JSON Schema for Artifact Retention Policy Spec.

• Kind: constant
• Import: import { artifactRetentionPolicySpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRetentionPolicySpecJsonSchema: JsonSchema;

artifactRetentionPolicySpecSchema

Runtime schema for Artifact Retention Policy Spec.

• Kind: constant
• Import: import { artifactRetentionPolicySpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRetentionPolicySpecSchema: z.ZodEffects<z.ZodObject<{ defaultTtlSeconds: z.ZodOptional<z.ZodNumber>; archiveAfterSeconds: z.ZodOptional<z.ZodNumber>; deleteAfterSeconds: z.ZodOptional<z.ZodNumber>; retainFinal: z.ZodOptional<z.ZodBoolean>; retainOnFailure: z.ZodOptional<z.ZodBoolean>; legalHoldSupported: z.ZodOptional<z.ZodBoolean>; garbageCollectUnreferenced: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { defaultTtlSeconds?: number | undefined; archiveAfterSeconds?: number | undefined; deleteAfterSeconds?: number | undefined; retainFinal?: boolean | undefined; retainOnFailure?: boolean | undefined; legalHoldSupported?: boolean | undefined; garbageCollectUnreferenced?: boolean | undefined; }, { defaultTtlSeconds?: number | undefined; archiveAfterSeconds?: number | undefined; deleteAfterSeconds?: number | undefined; retainFinal?: boolean | undefined; retainOnFailure?: boolean | undefined; legalHoldSupported?: boolean | undefined; garbageCollectUnreferenced?: boolean | undefined; }>, { defaultTtlSeconds?: number | undefined; archiveAfterSeconds?: number | undefined; deleteAfterSeconds?: number | undefined; retainFinal?: boolean | undefined; retainOnFailure?: boolean | undefined; legalHoldSupported?: boolean | undefined; garbageCollectUnreferenced?: boolean | undefined; }, { defaultTtlSeconds?: number | undefined; archiveAfterSeconds?: number | undefined; deleteAfterSeconds?: number | undefined; retainFinal?: boolean | undefined; retainOnFailure?: boolean | undefined; legalHoldSupported?: boolean | undefined; garbageCollectUnreferenced?: boolean | undefined; }>;

artifactRetentionRecordJsonSchema

JSON Schema for Artifact Retention Record.

• Kind: constant
• Import: import { artifactRetentionRecordJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRetentionRecordJsonSchema: JsonSchema;

artifactRetentionRecordSchema

Runtime schema for Artifact Retention Record.

• Kind: constant
• Import: import { artifactRetentionRecordSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactRetentionRecordSchema: z.ZodObject<{ policyRef: z.ZodOptional<z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revision?: string | undefined; version?: string | undefined; }>>; expiresAt: z.ZodOptional<z.ZodString>; archivedAt: z.ZodOptional<z.ZodString>; legalHold: z.ZodOptional<z.ZodBoolean>; referencedByCount: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { policyRef?: { id: string; revision?: string | undefined; version?: string | undefined; } | undefined; expiresAt?: string | undefined; archivedAt?: string | undefined; legalHold?: boolean | undefined; referencedByCount?: number | undefined; }, { policyRef?: { id: string; revision?: string | undefined; version?: string | undefined; } | undefined; expiresAt?: string | undefined; archivedAt?: string | undefined; legalHold?: boolean | undefined; referencedByCount?: number | undefined; }>;

artifactStatusSchema

Runtime schema for Artifact Status.

• Kind: constant
• Import: import { artifactStatusSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactStatusSchema: z.ZodEnum<["creating", "draft", "final", "archived", "invalidated", "deletion_pending", "deleted", "failed"]>;

artifactStorageRefJsonSchema

JSON Schema for Artifact Storage Ref.

• Kind: constant
• Import: import { artifactStorageRefJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactStorageRefJsonSchema: JsonSchema;

artifactStorageRefSchema

Runtime schema for Artifact Storage Ref.

• Kind: constant
• Import: import { artifactStorageRefSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactStorageRefSchema: z.ZodObject<{ storeId: z.ZodString; bucketOrNamespace: z.ZodOptional<z.ZodString>; objectKey: z.ZodString; versionId: z.ZodOptional<z.ZodString>; etag: z.ZodOptional<z.ZodString>; region: z.ZodOptional<z.ZodString>; encrypted: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }, { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }>;

artifactValidationPolicySpecJsonSchema

JSON Schema for Artifact Validation Policy Spec.

• Kind: constant
• Import: import { artifactValidationPolicySpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactValidationPolicySpecJsonSchema: JsonSchema;

artifactValidationPolicySpecSchema

Runtime schema for Artifact Validation Policy Spec.

• Kind: constant
• Import: import { artifactValidationPolicySpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactValidationPolicySpecSchema: z.ZodObject<{ verifyMimeType: z.ZodOptional<z.ZodBoolean>; verifyExtension: z.ZodOptional<z.ZodBoolean>; malwareScanRef: z.ZodOptional<z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revision?: string | undefined; version?: string | undefined; }>>; archiveBombProtection: z.ZodOptional<z.ZodBoolean>; maxExpandedBytes: z.ZodOptional<z.ZodNumber>; checksumRequired: z.ZodOptional<z.ZodBoolean>; rejectExecutableUploads: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { verifyMimeType?: boolean | undefined; verifyExtension?: boolean | undefined; malwareScanRef?: { id: string; revision?: string | undefined; version?: string | undefined; } | undefined; archiveBombProtection?: boolean | undefined; maxExpandedBytes?: number | undefined; checksumRequired?: boolean | undefined; rejectExecutableUploads?: boolean | undefined; }, { verifyMimeType?: boolean | undefined; verifyExtension?: boolean | undefined; malwareScanRef?: { id: string; revision?: string | undefined; version?: string | undefined; } | undefined; archiveBombProtection?: boolean | undefined; maxExpandedBytes?: number | undefined; checksumRequired?: boolean | undefined; rejectExecutableUploads?: boolean | undefined; }>;

artifactVersioningPolicySpecJsonSchema

JSON Schema for Artifact Versioning Policy Spec.

• Kind: constant
• Import: import { artifactVersioningPolicySpecJsonSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactVersioningPolicySpecJsonSchema: JsonSchema;

artifactVersioningPolicySpecSchema

Runtime schema for Artifact Versioning Policy Spec.

• Kind: constant
• Import: import { artifactVersioningPolicySpecSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare const artifactVersioningPolicySpecSchema: z.ZodObject<{ strategy: z.ZodLiteral<"append_only">; retainPreviousVersions: z.ZodLiteral<true>; maxVersions: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { strategy: "append_only"; retainPreviousVersions: true; maxVersions?: number | undefined; }, { strategy: "append_only"; retainPreviousVersions: true; maxVersions?: number | undefined; }>;

storedArtifactRecordSchema

Runtime schema for Stored Artifact Record.

• Kind: constant
• Import: import { storedArtifactRecordSchema } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const storedArtifactRecordSchema: (typeof import('@codesoul-co/hypha-core'))['storedArtifactRecordSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

validateArtifactLineage

Validate Artifact Lineage function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateArtifactLineage } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare function validateArtifactLineage(input: unknown): ArtifactLineage;

Call signature

validateArtifactLineage(input: unknown): ArtifactLineage

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ArtifactLineage
• Description: The return contract is defined by the type shown above.

validateArtifactProfileSpec

Validate Artifact Profile Spec function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateArtifactProfileSpec } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare function validateArtifactProfileSpec(input: unknown): ArtifactProfileSpec;

Call signature

validateArtifactProfileSpec(input: unknown): ArtifactProfileSpec

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ArtifactProfileSpec
• Description: The return contract is defined by the type shown above.

validateArtifactRecord

Validate Artifact Record function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateArtifactRecord } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare function validateArtifactRecord(input: unknown): ArtifactRecord;

Call signature

validateArtifactRecord(input: unknown): ArtifactRecord

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ArtifactRecord
• Description: The return contract is defined by the type shown above.

validateArtifactRef

Validate Artifact Ref function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateArtifactRef } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare function validateArtifactRef(input: unknown): ArtifactRef;

Call signature

validateArtifactRef(input: unknown): ArtifactRef

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: ArtifactRef
• Description: The return contract is defined by the type shown above.

validateStoredArtifactRecord

Validate Stored Artifact Record function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateStoredArtifactRecord } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare function validateStoredArtifactRecord(input: unknown): StoredArtifactRecord;

Call signature

validateStoredArtifactRecord(input: unknown): StoredArtifactRecord

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: StoredArtifactRecord
• Description: The return contract is defined by the type shown above.

validateStoredArtifactRecords

Validate Stored Artifact Records function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { validateStoredArtifactRecords } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/index

Declaration

export declare function validateStoredArtifactRecords(input: unknown): StoredArtifactRecord[];

Call signature

validateStoredArtifactRecords(input: unknown): StoredArtifactRecord[]

Parameters

Parameter	Type	Required	Description
input	unknown	Yes	Required parameter; accepted values are defined by the type column.

Returns

• Type: StoredArtifactRecord[]
• Description: The return contract is defined by the type shown above.