HYPHA / DOCS

English

简体中文

English

简体中文

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

Using this module ​

Use the Store module for persisting and reading data at this boundary. It exports 26 constants, 10 functions.

Import from the package entrypoint ​

ts
import {
  artifactByteRangeJsonSchema,
  artifactByteRangeSchema,
  artifactByteSourceSchema,
  artifactContentJsonSchema,
  artifactContentSchema,
  artifactCopyRequestJsonSchema,
  artifactCopyRequestSchema,
  artifactDownloadAccessJsonSchema,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns ​

  • The module exposes 10 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
  • The 26 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 { artifactByteRangeSchema } from '@codesoul-co/hypha-core';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = artifactByteRangeSchema.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
artifactByteRangeJsonSchemaconstantconst artifactByteRangeJsonSchema: JsonSchemaJSON Schema for Artifact Byte Range.
artifactByteRangeSchemaconstantconst artifactByteRangeSchema: 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; }>Runtime schema for Artifact Byte Range.
artifactByteSourceSchemaconstantconst artifactByteSourceSchema: z.ZodType<ArtifactByteSource, z.ZodTypeDef, ArtifactByteSource>Runtime schema for Artifact Byte Source.
artifactContentJsonSchemaconstantconst artifactContentJsonSchema: JsonSchemaJSON Schema for Artifact Content.
artifactContentSchemaconstantconst artifactContentSchema: z.ZodObject<{ stream: z.ZodType<AsyncIterable<Uint8Array<ArrayBufferLike>>, z.ZodTypeDef, AsyncIterable<Uint8Array<ArrayBufferLike>>>; contentHash: z.ZodString; sizeBytes: z.ZodNumber; mimeType: z.ZodOptional<z.ZodString>; etag: z.ZodOptional<z.ZodString>; range: z.ZodOptional<z.ZodEffects<z.ZodObject<{ start: z.ZodNumber; endInclusive: z.ZodOptional<z.ZodNumber>; }, "strict", z.ZodTyp...Runtime schema for Artifact Content.
artifactCopyRequestJsonSchemaconstantconst artifactCopyRequestJsonSchema: JsonSchemaJSON Schema for Artifact Copy Request.
artifactCopyRequestSchemaconstantconst artifactCopyRequestSchema: z.ZodObject<{ operationId: z.ZodString; source: 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?: str...Runtime schema for Artifact Copy Request.
artifactDownloadAccessJsonSchemaconstantconst artifactDownloadAccessJsonSchema: JsonSchemaJSON Schema for Artifact Download Access.
artifactDownloadAccessRequestExampleconstantconst artifactDownloadAccessRequestExample: ArtifactDownloadAccessRequestValid example value for Artifact Download Access Request.
artifactDownloadAccessRequestJsonSchemaconstantconst artifactDownloadAccessRequestJsonSchema: JsonSchemaJSON Schema for Artifact Download Access Request.
artifactDownloadAccessRequestSchemaconstantconst artifactDownloadAccessRequestSchema: z.ZodObject<{ ref: 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; bu...Runtime schema for Artifact Download Access Request.
artifactDownloadAccessSchemaconstantconst artifactDownloadAccessSchema: z.ZodObject<{ method: z.ZodLiteral<"GET">; url: z.ZodString; expiresAt: z.ZodString; headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; }, "strict", z.ZodTypeAny, { expiresAt: string; method: "GET"; url: string; headers?: Record<string, string> | undefined; }, { expiresAt: string; method: "GET"; url: string; headers?: Record<string, string> | undefined; }>Runtime schema for Artifact Download Access.
artifactGetRequestExampleconstantconst artifactGetRequestExample: ArtifactGetRequestValid example value for Artifact Get Request.
artifactGetRequestJsonSchemaconstantconst artifactGetRequestJsonSchema: JsonSchemaJSON Schema for Artifact Get Request.
artifactGetRequestSchemaconstantconst artifactGetRequestSchema: z.ZodObject<{ ref: 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; bucketOrNames...Runtime schema for Artifact Get Request.
artifactObjectKeySchemaconstantconst artifactObjectKeySchema: z.ZodEffects<z.ZodString, string, string>Runtime schema for Artifact Object Key.
artifactObjectMetadataJsonSchemaconstantconst artifactObjectMetadataJsonSchema: JsonSchemaJSON Schema for Artifact Object Metadata.
artifactObjectMetadataSchemaconstantconst artifactObjectMetadataSchema: z.ZodObject<{ contentHash: z.ZodString; sizeBytes: z.ZodNumber; mimeType: z.ZodOptional<z.ZodString>; etag: z.ZodOptional<z.ZodString>; lastModifiedAt: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; }, "strict", z.ZodTypeAny, { sizeBytes: number; contentHash: string; mimeType?: string | undefined; etag?: string | undefined; metadata?:...Runtime schema for Artifact Object Metadata.
artifactPutRequestExampleconstantconst artifactPutRequestExample: ArtifactPutRequestValid example value for Artifact Put Request.
artifactPutRequestJsonSchemaconstantconst artifactPutRequestJsonSchema: JsonSchemaJSON Schema for Artifact Put Request.
artifactPutRequestSchemaconstantconst artifactPutRequestSchema: z.ZodObject<{ operationId: z.ZodString; objectKey: z.ZodEffects<z.ZodString, string, string>; content: z.ZodType<ArtifactByteSource, z.ZodTypeDef, ArtifactByteSource>; expectedContentHash: z.ZodOptional<z.ZodString>; sizeBytes: z.ZodOptional<z.ZodNumber>; mimeType: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; ifAbsent: z.ZodOptional<z.Z...Runtime schema for Artifact Put Request.
artifactStoreCapabilitiesExampleconstantconst artifactStoreCapabilitiesExample: ArtifactStoreCapabilitiesValid example value for Artifact Store Capabilities.
artifactStoreCapabilitiesJsonSchemaconstantconst artifactStoreCapabilitiesJsonSchema: JsonSchemaJSON Schema for Artifact Store Capabilities.
artifactStoreCapabilitiesSchemaconstantconst artifactStoreCapabilitiesSchema: z.ZodObject<{ versioning: z.ZodBoolean; rangeRead: z.ZodBoolean; signedAccess: z.ZodBoolean; serverSideCopy: z.ZodBoolean; encryption: z.ZodBoolean; multipartUpload: z.ZodBoolean; contentAddressing: z.ZodBoolean; }, "strict", z.ZodTypeAny, { contentAddressing: boolean; versioning: boolean; rangeRead: boolean; signedAccess: boolean; serverSideCopy: boolean; encryption: boolean...Runtime schema for Artifact Store Capabilities.
artifactStoreContractJsonSchemasconstantconst artifactStoreContractJsonSchemas: Record<string, JsonSchema>Artifact Store Contract JSON Schemas constant exported by the modules/artifact/store module.
artifactStreamSchemaconstantconst artifactStreamSchema: z.ZodType<AsyncIterable<Uint8Array<ArrayBufferLike>>, z.ZodTypeDef, AsyncIterable<Uint8Array<ArrayBufferLike>>>Runtime schema for Artifact Stream.
isArtifactByteSourcefunctionisArtifactByteSource(value: unknown): value is ArtifactByteSourceIs Artifact Byte Source function with 1 public call signature; parameters and return types are listed below.
isArtifactStreamfunctionisArtifactStream(value: unknown): value is AsyncIterable<Uint8Array>Is Artifact Stream function with 1 public call signature; parameters and return types are listed below.
validateArtifactContentfunctionvalidateArtifactContent(input: unknown): ArtifactContentValidate Artifact Content function with 1 public call signature; parameters and return types are listed below.
validateArtifactDownloadAccessfunctionvalidateArtifactDownloadAccess(input: unknown): ArtifactDownloadAccessValidate Artifact Download Access function with 1 public call signature; parameters and return types are listed below.
validateArtifactDownloadAccessRequestfunctionvalidateArtifactDownloadAccessRequest(input: unknown): ArtifactDownloadAccessRequestValidate Artifact Download Access Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactGetRequestfunctionvalidateArtifactGetRequest(input: unknown): ArtifactGetRequestValidate Artifact Get Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactObjectMetadatafunctionvalidateArtifactObjectMetadata(input: unknown): ArtifactObjectMetadataValidate Artifact Object Metadata function with 1 public call signature; parameters and return types are listed below.
validateArtifactPutRequestfunctionvalidateArtifactPutRequest(input: unknown): ArtifactPutRequestValidate Artifact Put Request function with 1 public call signature; parameters and return types are listed below.
validateArtifactStorageReffunctionvalidateArtifactStorageRef(input: unknown): { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }Validate Artifact Storage Ref function with 1 public call signature; parameters and return types are listed below.
validateArtifactStoreCapabilitiesfunctionvalidateArtifactStoreCapabilities(input: unknown): ArtifactStoreCapabilitiesValidate Artifact Store Capabilities function with 1 public call signature; parameters and return types are listed below.

artifactByteRangeJsonSchema ​

JSON Schema for Artifact Byte Range.

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

Declaration ​

text
export declare const artifactByteRangeJsonSchema: JsonSchema;

artifactByteRangeSchema ​

Runtime schema for Artifact Byte Range.

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

Declaration ​

text
export declare const artifactByteRangeSchema: 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; }>;

artifactByteSourceSchema ​

Runtime schema for Artifact Byte Source.

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

Declaration ​

text
export declare const artifactByteSourceSchema: z.ZodType<ArtifactByteSource, z.ZodTypeDef, ArtifactByteSource>;

artifactContentJsonSchema ​

JSON Schema for Artifact Content.

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

Declaration ​

text
export declare const artifactContentJsonSchema: JsonSchema;

artifactContentSchema ​

Runtime schema for Artifact Content.

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

Declaration ​

text
export declare const artifactContentSchema: z.ZodObject<{ stream: z.ZodType<AsyncIterable<Uint8Array<ArrayBufferLike>>, z.ZodTypeDef, AsyncIterable<Uint8Array<ArrayBufferLike>>>; contentHash: z.ZodString; sizeBytes: z.ZodNumber; mimeType: z.ZodOptional<z.ZodString>; etag: 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; }>>; }, "strict", z.ZodTypeAny, { sizeBytes: number; contentHash: string; stream: AsyncIterable<Uint8Array<ArrayBufferLike>>; mimeType?: string | undefined; etag?: string | undefined; range?: { start: number; endInclusive?: number | undefined; } | undefined; }, { sizeBytes: number; contentHash: string; stream: AsyncIterable<Uint8Array<ArrayBufferLike>>; mimeType?: string | undefined; etag?: string | undefined; range?: { start: number; endInclusive?: number | undefined; } | undefined; }>;

artifactCopyRequestJsonSchema ​

JSON Schema for Artifact Copy Request.

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

Declaration ​

text
export declare const artifactCopyRequestJsonSchema: JsonSchema;

artifactCopyRequestSchema ​

Runtime schema for Artifact Copy Request.

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

Declaration ​

text
export declare const artifactCopyRequestSchema: z.ZodObject<{ operationId: z.ZodString; source: 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; }>; targetObjectKey: z.ZodEffects<z.ZodString, string, string>; ifAbsent: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { operationId: string; source: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }; targetObjectKey: string; ifAbsent?: boolean | undefined; }, { operationId: string; source: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }; targetObjectKey: string; ifAbsent?: boolean | undefined; }>;

artifactDownloadAccessJsonSchema ​

JSON Schema for Artifact Download Access.

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

Declaration ​

text
export declare const artifactDownloadAccessJsonSchema: JsonSchema;

artifactDownloadAccessRequestExample ​

Valid example value for Artifact Download Access Request.

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

Declaration ​

text
export declare const artifactDownloadAccessRequestExample: ArtifactDownloadAccessRequest;

artifactDownloadAccessRequestJsonSchema ​

JSON Schema for Artifact Download Access Request.

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

Declaration ​

text
export declare const artifactDownloadAccessRequestJsonSchema: JsonSchema;

artifactDownloadAccessRequestSchema ​

Runtime schema for Artifact Download Access Request.

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

Declaration ​

text
export declare const artifactDownloadAccessRequestSchema: z.ZodObject<{ ref: 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; }>; expiresInSeconds: z.ZodNumber; responseMimeType: z.ZodOptional<z.ZodString>; responseFilename: z.ZodOptional<z.ZodString>; }, "strict", z.ZodTypeAny, { ref: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }; expiresInSeconds: number; responseMimeType?: string | undefined; responseFilename?: string | undefined; }, { ref: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }; expiresInSeconds: number; responseMimeType?: string | undefined; responseFilename?: string | undefined; }>;

artifactDownloadAccessSchema ​

Runtime schema for Artifact Download Access.

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

Declaration ​

text
export declare const artifactDownloadAccessSchema: z.ZodObject<{ method: z.ZodLiteral<"GET">; url: z.ZodString; expiresAt: z.ZodString; headers: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; }, "strict", z.ZodTypeAny, { expiresAt: string; method: "GET"; url: string; headers?: Record<string, string> | undefined; }, { expiresAt: string; method: "GET"; url: string; headers?: Record<string, string> | undefined; }>;

artifactGetRequestExample ​

Valid example value for Artifact Get Request.

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

Declaration ​

text
export declare const artifactGetRequestExample: ArtifactGetRequest;

artifactGetRequestJsonSchema ​

JSON Schema for Artifact Get Request.

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

Declaration ​

text
export declare const artifactGetRequestJsonSchema: JsonSchema;

artifactGetRequestSchema ​

Runtime schema for Artifact Get Request.

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

Declaration ​

text
export declare const artifactGetRequestSchema: z.ZodObject<{ ref: 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; }>; 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, { ref: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }; expectedContentHash?: string | undefined; range?: { start: number; endInclusive?: number | undefined; } | undefined; }, { ref: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }; expectedContentHash?: string | undefined; range?: { start: number; endInclusive?: number | undefined; } | undefined; }>;

artifactObjectKeySchema ​

Runtime schema for Artifact Object Key.

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

Declaration ​

text
export declare const artifactObjectKeySchema: z.ZodEffects<z.ZodString, string, string>;

artifactObjectMetadataJsonSchema ​

JSON Schema for Artifact Object Metadata.

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

Declaration ​

text
export declare const artifactObjectMetadataJsonSchema: JsonSchema;

artifactObjectMetadataSchema ​

Runtime schema for Artifact Object Metadata.

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

Declaration ​

text
export declare const artifactObjectMetadataSchema: z.ZodObject<{ contentHash: z.ZodString; sizeBytes: z.ZodNumber; mimeType: z.ZodOptional<z.ZodString>; etag: z.ZodOptional<z.ZodString>; lastModifiedAt: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; }, "strict", z.ZodTypeAny, { sizeBytes: number; contentHash: string; mimeType?: string | undefined; etag?: string | undefined; metadata?: Record<string, string> | undefined; lastModifiedAt?: string | undefined; }, { sizeBytes: number; contentHash: string; mimeType?: string | undefined; etag?: string | undefined; metadata?: Record<string, string> | undefined; lastModifiedAt?: string | undefined; }>;

artifactPutRequestExample ​

Valid example value for Artifact Put Request.

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

Declaration ​

text
export declare const artifactPutRequestExample: ArtifactPutRequest;

artifactPutRequestJsonSchema ​

JSON Schema for Artifact Put Request.

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

Declaration ​

text
export declare const artifactPutRequestJsonSchema: JsonSchema;

artifactPutRequestSchema ​

Runtime schema for Artifact Put Request.

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

Declaration ​

text
export declare const artifactPutRequestSchema: z.ZodObject<{ operationId: z.ZodString; objectKey: z.ZodEffects<z.ZodString, string, string>; content: z.ZodType<ArtifactByteSource, z.ZodTypeDef, ArtifactByteSource>; expectedContentHash: z.ZodOptional<z.ZodString>; sizeBytes: z.ZodOptional<z.ZodNumber>; mimeType: z.ZodOptional<z.ZodString>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>; ifAbsent: z.ZodOptional<z.ZodBoolean>; }, "strict", z.ZodTypeAny, { objectKey: string; operationId: string; content: ArtifactByteSource; mimeType?: string | undefined; sizeBytes?: number | undefined; metadata?: Record<string, string> | undefined; expectedContentHash?: string | undefined; ifAbsent?: boolean | undefined; }, { objectKey: string; operationId: string; content: ArtifactByteSource; mimeType?: string | undefined; sizeBytes?: number | undefined; metadata?: Record<string, string> | undefined; expectedContentHash?: string | undefined; ifAbsent?: boolean | undefined; }>;

artifactStoreCapabilitiesExample ​

Valid example value for Artifact Store Capabilities.

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

Declaration ​

text
export declare const artifactStoreCapabilitiesExample: ArtifactStoreCapabilities;

artifactStoreCapabilitiesJsonSchema ​

JSON Schema for Artifact Store Capabilities.

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

Declaration ​

text
export declare const artifactStoreCapabilitiesJsonSchema: JsonSchema;

artifactStoreCapabilitiesSchema ​

Runtime schema for Artifact Store Capabilities.

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

Declaration ​

text
export declare const artifactStoreCapabilitiesSchema: z.ZodObject<{ versioning: z.ZodBoolean; rangeRead: z.ZodBoolean; signedAccess: z.ZodBoolean; serverSideCopy: z.ZodBoolean; encryption: z.ZodBoolean; multipartUpload: z.ZodBoolean; contentAddressing: z.ZodBoolean; }, "strict", z.ZodTypeAny, { contentAddressing: boolean; versioning: boolean; rangeRead: boolean; signedAccess: boolean; serverSideCopy: boolean; encryption: boolean; multipartUpload: boolean; }, { contentAddressing: boolean; versioning: boolean; rangeRead: boolean; signedAccess: boolean; serverSideCopy: boolean; encryption: boolean; multipartUpload: boolean; }>;

artifactStoreContractJsonSchemas ​

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

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

Declaration ​

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

artifactStreamSchema ​

Runtime schema for Artifact Stream.

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

Declaration ​

text
export declare const artifactStreamSchema: z.ZodType<AsyncIterable<Uint8Array<ArrayBufferLike>>, z.ZodTypeDef, AsyncIterable<Uint8Array<ArrayBufferLike>>>;

isArtifactByteSource ​

Is Artifact Byte Source function with 1 public call signature; parameters and return types are listed below.

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

Declaration ​

text
export declare function isArtifactByteSource(value: unknown): value is ArtifactByteSource;

Call signature ​

text
isArtifactByteSource(value: unknown): value is ArtifactByteSource

Parameters ​

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

Returns ​

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

isArtifactStream ​

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

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

Declaration ​

text
export declare function isArtifactStream(value: unknown): value is AsyncIterable<Uint8Array>;

Call signature ​

text
isArtifactStream(value: unknown): value is AsyncIterable<Uint8Array>

Parameters ​

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

Returns ​

  • Type: value is AsyncIterable<Uint8Array<ArrayBufferLike>>
  • Description: The return contract is defined by the type shown above.

validateArtifactContent ​

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

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

Declaration ​

text
export declare function validateArtifactContent(input: unknown): ArtifactContent;

Call signature ​

text
validateArtifactContent(input: unknown): ArtifactContent

Parameters ​

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

Returns ​

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

validateArtifactDownloadAccess ​

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

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

Declaration ​

text
export declare function validateArtifactDownloadAccess(input: unknown): ArtifactDownloadAccess;

Call signature ​

text
validateArtifactDownloadAccess(input: unknown): ArtifactDownloadAccess

Parameters ​

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

Returns ​

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

validateArtifactDownloadAccessRequest ​

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

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

Declaration ​

text
export declare function validateArtifactDownloadAccessRequest(input: unknown): ArtifactDownloadAccessRequest;

Call signature ​

text
validateArtifactDownloadAccessRequest(input: unknown): ArtifactDownloadAccessRequest

Parameters ​

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

Returns ​

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

validateArtifactGetRequest ​

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

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

Declaration ​

text
export declare function validateArtifactGetRequest(input: unknown): ArtifactGetRequest;

Call signature ​

text
validateArtifactGetRequest(input: unknown): ArtifactGetRequest

Parameters ​

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

Returns ​

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

validateArtifactObjectMetadata ​

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

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

Declaration ​

text
export declare function validateArtifactObjectMetadata(input: unknown): ArtifactObjectMetadata;

Call signature ​

text
validateArtifactObjectMetadata(input: unknown): ArtifactObjectMetadata

Parameters ​

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

Returns ​

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

validateArtifactPutRequest ​

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

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

Declaration ​

text
export declare function validateArtifactPutRequest(input: unknown): ArtifactPutRequest;

Call signature ​

text
validateArtifactPutRequest(input: unknown): ArtifactPutRequest

Parameters ​

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

Returns ​

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

validateArtifactStorageRef ​

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

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

Declaration ​

text
export declare function validateArtifactStorageRef(input: unknown): {
    storeId: string;
    objectKey: string;
    versionId?: string | undefined;
    bucketOrNamespace?: string | undefined;
    etag?: string | undefined;
    region?: string | undefined;
    encrypted?: boolean | undefined;
};

Call signature ​

text
validateArtifactStorageRef(input: unknown): { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }

Parameters ​

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

Returns ​

  • Type: { storeId: string; objectKey: string; versionId?: string | undefined; bucketOrNamespace?: string | undefined; etag?: string | undefined; region?: string | undefined; encrypted?: boolean | undefined; }
  • Description: The return contract is defined by the type shown above.

validateArtifactStoreCapabilities ​

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

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

Declaration ​

text
export declare function validateArtifactStoreCapabilities(input: unknown): ArtifactStoreCapabilities;

Call signature ​

text
validateArtifactStoreCapabilities(input: unknown): ArtifactStoreCapabilities

Parameters ​

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

Returns ​

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