HYPHA / DOCS

English

简体中文

English

简体中文

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

Using this module ​

Use the Manager module for using the public contracts and operations for this capability boundary. It exports 31 constants, 12 functions.

Import from the package entrypoint ​

ts
import {
  artifactCreateDownloadAccessRequestExample,
  artifactCreateDownloadAccessRequestJsonSchema,
  artifactCreateDownloadAccessRequestSchema,
  artifactCreateRequestExample,
  artifactCreateRequestJsonSchema,
  artifactCreateRequestSchema,
  artifactFromWorkspaceRequestExample,
  artifactFromWorkspaceRequestJsonSchema,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns ​

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

Runtime validation example ​

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

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = artifactCreateDownloadAccessRequestSchema.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 ​

SymbolKindSignatureDescription
artifactCreateDownloadAccessRequestExampleconstantconst artifactCreateDownloadAccessRequestExample: ArtifactCreateDownloadAccessRequestValid example value for Artifact Create Download Access Request.
artifactCreateDownloadAccessRequestJsonSchemaconstantconst artifactCreateDownloadAccessRequestJsonSchema: JsonSchemaJSON Schema for Artifact Create Download Access Request.
artifactCreateDownloadAccessRequestSchemaconstantconst artifactCreateDownloadAccessRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.Zod...Runtime schema for Artifact Create Download Access Request.
artifactCreateRequestExampleconstantconst artifactCreateRequestExample: ArtifactCreateRequestValid example value for Artifact Create Request.
artifactCreateRequestJsonSchemaconstantconst artifactCreateRequestJsonSchema: JsonSchemaJSON Schema for Artifact Create Request.
artifactCreateRequestSchemaconstantconst artifactCreateRequestSchema: z.ZodEffects<z.ZodObject<{ operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; meta...Runtime schema for Artifact Create Request.
artifactFromWorkspaceRequestExampleconstantconst artifactFromWorkspaceRequestExample: ArtifactFromWorkspaceRequestValid example value for Artifact From Workspace Request.
artifactFromWorkspaceRequestJsonSchemaconstantconst artifactFromWorkspaceRequestJsonSchema: JsonSchemaJSON Schema for Artifact From Workspace Request.
artifactFromWorkspaceRequestSchemaconstantconst artifactFromWorkspaceRequestSchema: z.ZodEffects<z.ZodObject<{ operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many"...Runtime schema for Artifact From Workspace Request.
artifactGetRecordRequestJsonSchemaconstantconst artifactGetRecordRequestJsonSchema: JsonSchemaJSON Schema for Artifact Get Record Request.
artifactGetRecordRequestSchemaconstantconst artifactGetRecordRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.Zo...Runtime schema for Artifact Get Record Request.
artifactLatestRequestJsonSchemaconstantconst artifactLatestRequestJsonSchema: JsonSchemaJSON Schema for Artifact Latest Request.
artifactLatestRequestSchemaconstantconst artifactLatestRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodSt...Runtime schema for Artifact Latest Request.
artifactListRequestJsonSchemaconstantconst artifactListRequestJsonSchema: JsonSchemaJSON Schema for Artifact List Request.
artifactListRequestSchemaconstantconst artifactListRequestSchema: z.ZodEffects<z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRec...Runtime schema for Artifact List Request.
artifactManagerContractJsonSchemasconstantconst artifactManagerContractJsonSchemas: Record<string, JsonSchema>Artifact Manager Contract JSON Schemas constant exported by the modules/artifact/manager module.
artifactMutationRequestJsonSchemaconstantconst artifactMutationRequestJsonSchema: JsonSchemaJSON Schema for Artifact Mutation Request.
artifactMutationRequestSchemaconstantconst artifactMutationRequestSchema: z.ZodObject<{ operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.Zod...Runtime schema for Artifact Mutation Request.
artifactPreviousRequestJsonSchemaconstantconst artifactPreviousRequestJsonSchema: JsonSchemaJSON Schema for Artifact Previous Request.
artifactPreviousRequestSchemaconstantconst artifactPreviousRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.Zod...Runtime schema for Artifact Previous Request.
artifactReadRequestJsonSchemaconstantconst artifactReadRequestJsonSchema: JsonSchemaJSON Schema for Artifact Read Request.
artifactReadRequestSchemaconstantconst artifactReadRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodStri...Runtime schema for Artifact Read Request.
artifactReadResultJsonSchemaconstantconst artifactReadResultJsonSchema: JsonSchemaJSON Schema for Artifact Read Result.
artifactReadResultSchemaconstantconst artifactReadResultSchema: 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<z....Runtime schema for Artifact Read Result.
artifactTraceLineageRequestJsonSchemaconstantconst artifactTraceLineageRequestJsonSchema: JsonSchemaJSON Schema for Artifact Trace Lineage Request.
artifactTraceLineageRequestSchemaconstantconst artifactTraceLineageRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z...Runtime schema for Artifact Trace Lineage Request.
artifactVersionRequestExampleconstantconst artifactVersionRequestExample: ArtifactVersionRequestValid example value for Artifact Version Request.
artifactVersionRequestJsonSchemaconstantconst artifactVersionRequestJsonSchema: JsonSchemaJSON Schema for Artifact Version Request.
artifactVersionRequestSchemaconstantconst artifactVersionRequestSchema: z.ZodObject<{ operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodO...Runtime schema for Artifact Version Request.
normalizedArtifactErrorJsonSchemaconstantconst normalizedArtifactErrorJsonSchema: JsonSchemaJSON Schema for Normalized Artifact Error.
normalizedArtifactErrorSchemaconstantconst normalizedArtifactErrorSchema: z.ZodObject<{ code: z.ZodEnum<["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", "A...Runtime schema for Normalized Artifact Error.
validateArtifactCreateDownloadAccessRequestfunctionvalidateArtifactCreateDownloadAccessRequest(input: unknown): ArtifactCreateDownloadAccessRequestValidate Artifact Create Download Access Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactCreateRequestfunctionvalidateArtifactCreateRequest(input: unknown): ArtifactCreateRequestValidate Artifact Create Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactFromWorkspaceRequestfunctionvalidateArtifactFromWorkspaceRequest(input: unknown): ArtifactFromWorkspaceRequestValidate Artifact From Workspace Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactGetRecordRequestfunctionvalidateArtifactGetRecordRequest(input: unknown): ArtifactGetRecordRequestValidate Artifact Get Record Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactLatestRequestfunctionvalidateArtifactLatestRequest(input: unknown): ArtifactLatestRequestValidate Artifact Latest Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactListRequestfunctionvalidateArtifactListRequest(input: unknown): ArtifactListRequestValidate Artifact List Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactMutationRequestfunctionvalidateArtifactMutationRequest(input: unknown): ArtifactMutationRequestValidate Artifact Mutation Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactPreviousRequestfunctionvalidateArtifactPreviousRequest(input: unknown): ArtifactPreviousRequestValidate Artifact Previous Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactReadRequestfunctionvalidateArtifactReadRequest(input: unknown): ArtifactReadRequestValidate Artifact Read Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactTraceLineageRequestfunctionvalidateArtifactTraceLineageRequest(input: unknown): ArtifactTraceLineageRequestValidate Artifact Trace Lineage Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactVersionRequestfunctionvalidateArtifactVersionRequest(input: unknown): ArtifactVersionRequestValidate Artifact Version Request function with 1 public call signature; parameters and return types are listed below.
validateNormalizedArtifactErrorfunctionvalidateNormalizedArtifactError(input: unknown): NormalizedArtifactErrorValidate Normalized Artifact Error function with 1 public call signature; parameters and return types are listed below.

artifactCreateDownloadAccessRequestExample ​

Valid example value for Artifact Create Download Access Request.

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

Declaration ​

text
export declare const artifactCreateDownloadAccessRequestExample: ArtifactCreateDownloadAccessRequest;

artifactCreateDownloadAccessRequestJsonSchema ​

JSON Schema for Artifact Create Download Access Request.

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

Declaration ​

text
export declare const artifactCreateDownloadAccessRequestJsonSchema: JsonSchema;

artifactCreateDownloadAccessRequestSchema ​

Runtime schema for Artifact Create Download Access Request.

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

Declaration ​

text
export declare const artifactCreateDownloadAccessRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; artifactId: z.ZodString; versionId: z.ZodOptional<z.ZodString>; } & { operationId: z.ZodString; expiresInSeconds: z.ZodOptional<z.ZodNumber>; responseMimeType: z.ZodOptional<z.ZodEffects<z.ZodString, string, string>>; responseFilename: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { operationId: string; artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; versionId?: string | undefined; expiresInSeconds?: number | undefined; responseMimeType?: string | undefined; responseFilename?: string | undefined; }, { operationId: string; artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; versionId?: string | undefined; expiresInSeconds?: number | undefined; responseMimeType?: string | undefined; responseFilename?: string | undefined; }>;

artifactCreateRequestExample ​

Valid example value for Artifact Create Request.

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

Declaration ​

text
export declare const artifactCreateRequestExample: ArtifactCreateRequest;

artifactCreateRequestJsonSchema ​

JSON Schema for Artifact Create Request.

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

Declaration ​

text
export declare const artifactCreateRequestJsonSchema: JsonSchema;

artifactCreateRequestSchema ​

Runtime schema for Artifact Create Request.

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

Declaration ​

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

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.

artifactFromWorkspaceRequestExample ​

Valid example value for Artifact From Workspace Request.

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

Declaration ​

text
export declare const artifactFromWorkspaceRequestExample: ArtifactFromWorkspaceRequest;

artifactFromWorkspaceRequestJsonSchema ​

JSON Schema for Artifact From Workspace Request.

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

Declaration ​

text
export declare const artifactFromWorkspaceRequestJsonSchema: JsonSchema;

artifactFromWorkspaceRequestSchema ​

Runtime schema for Artifact From Workspace Request.

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

Declaration ​

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

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.

artifactGetRecordRequestJsonSchema ​

JSON Schema for Artifact Get Record Request.

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

Declaration ​

text
export declare const artifactGetRecordRequestJsonSchema: JsonSchema;

artifactGetRecordRequestSchema ​

Runtime schema for Artifact Get Record Request.

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

Declaration ​

text
export declare const artifactGetRecordRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; artifactId: z.ZodString; versionId: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; versionId?: string | undefined; }, { artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; versionId?: string | undefined; }>;

artifactLatestRequestJsonSchema ​

JSON Schema for Artifact Latest Request.

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

Declaration ​

text
export declare const artifactLatestRequestJsonSchema: JsonSchema;

artifactLatestRequestSchema ​

Runtime schema for Artifact Latest Request.

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

Declaration ​

text
export declare const artifactLatestRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; logicalArtifactId: z.ZodString; }, "strict", z.ZodTypeAny, { logicalArtifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; }, { logicalArtifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; }>;

artifactListRequestJsonSchema ​

JSON Schema for Artifact List Request.

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

Declaration ​

text
export declare const artifactListRequestJsonSchema: JsonSchema;

artifactListRequestSchema ​

Runtime schema for Artifact List Request.

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

Declaration ​

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

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.

artifactManagerContractJsonSchemas ​

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

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

Declaration ​

text
export declare const artifactManagerContractJsonSchemas: Record<string, JsonSchema>;

artifactMutationRequestJsonSchema ​

JSON Schema for Artifact Mutation Request.

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

Declaration ​

text
export declare const artifactMutationRequestJsonSchema: JsonSchema;

artifactMutationRequestSchema ​

Runtime schema for Artifact Mutation Request.

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

Declaration ​

text
export declare const artifactMutationRequestSchema: z.ZodObject<{ operationId: z.ZodString; principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; artifactId: z.ZodString; expectedRevision: z.ZodNumber; reason: z.ZodOptional<z.ZodString>; idempotencyKey: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { operationId: string; artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; expectedRevision: number; reason?: string | undefined; idempotencyKey?: string | undefined; }, { operationId: string; artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; expectedRevision: number; reason?: string | undefined; idempotencyKey?: string | undefined; }>;

artifactPreviousRequestJsonSchema ​

JSON Schema for Artifact Previous Request.

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

Declaration ​

text
export declare const artifactPreviousRequestJsonSchema: JsonSchema;

artifactPreviousRequestSchema ​

Runtime schema for Artifact Previous Request.

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

Declaration ​

text
export declare const artifactPreviousRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; versionId: z.ZodString; }, "strict", z.ZodTypeAny, { versionId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; }, { versionId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; }>;

artifactReadRequestJsonSchema ​

JSON Schema for Artifact Read Request.

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

Declaration ​

text
export declare const artifactReadRequestJsonSchema: JsonSchema;

artifactReadRequestSchema ​

Runtime schema for Artifact Read Request.

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

Declaration ​

text
export declare const artifactReadRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; artifactId: z.ZodString; versionId: z.ZodOptional<z.ZodString>; } & { range: z.ZodOptional<z.ZodEffects<z.ZodObject<{ start: z.ZodNumber; endInclusive: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTypeAny, { start: number; endInclusive?: number | undefined; }, { start: number; endInclusive?: number | undefined; }>, { start: number; endInclusive?: number | undefined; }, { start: number; endInclusive?: number | undefined; }>>; expectedContentHash: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; versionId?: string | undefined; expectedContentHash?: string | undefined; range?: { start: number; endInclusive?: number | undefined; } | undefined; }, { artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; versionId?: string | undefined; expectedContentHash?: string | undefined; range?: { start: number; endInclusive?: number | undefined; } | undefined; }>;

artifactReadResultJsonSchema ​

JSON Schema for Artifact Read Result.

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

Declaration ​

text
export declare const artifactReadResultJsonSchema: JsonSchema;

artifactReadResultSchema ​

Runtime schema for Artifact Read Result.

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

Declaration ​

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

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.

artifactTraceLineageRequestJsonSchema ​

JSON Schema for Artifact Trace Lineage Request.

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

Declaration ​

text
export declare const artifactTraceLineageRequestJsonSchema: JsonSchema;

artifactTraceLineageRequestSchema ​

Runtime schema for Artifact Trace Lineage Request.

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

Declaration ​

text
export declare const artifactTraceLineageRequestSchema: z.ZodObject<{ principal: z.ZodObject<{ principalId: z.ZodString; type: z.ZodEnum<["user", "agent", "service", "system"]>; tenantId: z.ZodOptional<z.ZodString>; userId: z.ZodOptional<z.ZodString>; agentId: z.ZodOptional<z.ZodString>; roles: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; permissionScopes: z.ZodArray<z.ZodString, "many">; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strict", z.ZodTypeAny, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }, { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }>; artifactId: z.ZodString; }, "strict", z.ZodTypeAny, { artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; }, { artifactId: string; principal: { type: "user" | "agent" | "service" | "system"; principalId: string; permissionScopes: string[]; metadata?: Record<string, unknown> | undefined; agentId?: string | undefined; tenantId?: string | undefined; userId?: string | undefined; roles?: string[] | undefined; }; }>;

artifactVersionRequestExample ​

Valid example value for Artifact Version Request.

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

Declaration ​

text
export declare const artifactVersionRequestExample: ArtifactVersionRequest;

artifactVersionRequestJsonSchema ​

JSON Schema for Artifact Version Request.

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

Declaration ​

text
export declare const artifactVersionRequestJsonSchema: JsonSchema;

artifactVersionRequestSchema ​

Runtime schema for Artifact Version Request.

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

Declaration ​

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

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.

normalizedArtifactErrorJsonSchema ​

JSON Schema for Normalized Artifact Error.

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

Declaration ​

text
export declare const normalizedArtifactErrorJsonSchema: JsonSchema;

normalizedArtifactErrorSchema ​

Runtime schema for Normalized Artifact Error.

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

Declaration ​

text
export declare const normalizedArtifactErrorSchema: z.ZodObject<{ code: z.ZodEnum<["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: z.ZodString; retryable: z.ZodBoolean; details: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; causeRef: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { 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> | undefined; causeRef?: string | undefined; }, { 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> | undefined; causeRef?: string | undefined; }>;

validateArtifactCreateDownloadAccessRequest ​

Validate Artifact Create Download Access Request function with 1 public call signature; parameters and return types are listed below.

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

Declaration ​

text
export declare function validateArtifactCreateDownloadAccessRequest(input: unknown): ArtifactCreateDownloadAccessRequest;

Call signature ​

text
validateArtifactCreateDownloadAccessRequest(input: unknown): ArtifactCreateDownloadAccessRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactCreateRequest ​

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

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

Declaration ​

text
export declare function validateArtifactCreateRequest(input: unknown): ArtifactCreateRequest;

Call signature ​

text
validateArtifactCreateRequest(input: unknown): ArtifactCreateRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactFromWorkspaceRequest ​

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

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

Declaration ​

text
export declare function validateArtifactFromWorkspaceRequest(input: unknown): ArtifactFromWorkspaceRequest;

Call signature ​

text
validateArtifactFromWorkspaceRequest(input: unknown): ArtifactFromWorkspaceRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactGetRecordRequest ​

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

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

Declaration ​

text
export declare function validateArtifactGetRecordRequest(input: unknown): ArtifactGetRecordRequest;

Call signature ​

text
validateArtifactGetRecordRequest(input: unknown): ArtifactGetRecordRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactLatestRequest ​

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

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

Declaration ​

text
export declare function validateArtifactLatestRequest(input: unknown): ArtifactLatestRequest;

Call signature ​

text
validateArtifactLatestRequest(input: unknown): ArtifactLatestRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactListRequest ​

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

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

Declaration ​

text
export declare function validateArtifactListRequest(input: unknown): ArtifactListRequest;

Call signature ​

text
validateArtifactListRequest(input: unknown): ArtifactListRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactMutationRequest ​

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

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

Declaration ​

text
export declare function validateArtifactMutationRequest(input: unknown): ArtifactMutationRequest;

Call signature ​

text
validateArtifactMutationRequest(input: unknown): ArtifactMutationRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactPreviousRequest ​

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

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

Declaration ​

text
export declare function validateArtifactPreviousRequest(input: unknown): ArtifactPreviousRequest;

Call signature ​

text
validateArtifactPreviousRequest(input: unknown): ArtifactPreviousRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactReadRequest ​

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

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

Declaration ​

text
export declare function validateArtifactReadRequest(input: unknown): ArtifactReadRequest;

Call signature ​

text
validateArtifactReadRequest(input: unknown): ArtifactReadRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactTraceLineageRequest ​

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

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

Declaration ​

text
export declare function validateArtifactTraceLineageRequest(input: unknown): ArtifactTraceLineageRequest;

Call signature ​

text
validateArtifactTraceLineageRequest(input: unknown): ArtifactTraceLineageRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateArtifactVersionRequest ​

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

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

Declaration ​

text
export declare function validateArtifactVersionRequest(input: unknown): ArtifactVersionRequest;

Call signature ​

text
validateArtifactVersionRequest(input: unknown): ArtifactVersionRequest

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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

validateNormalizedArtifactError ​

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

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

Declaration ​

text
export declare function validateNormalizedArtifactError(input: unknown): NormalizedArtifactError;

Call signature ​

text
validateNormalizedArtifactError(input: unknown): NormalizedArtifactError

Parameters ​

ParameterTypeRequiredDescription
inputunknownYesRequired parameter; accepted values are defined by the type column.

Returns ​

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