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

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

Using this module

Use the Runtime module for executing runtime behavior at this boundary. It exports 1 class, 1 interface.

Import from the package entrypoint

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

import type {
  DefaultArtifactManagerOptions,
} from '@codesoul-co/hypha-core';

Usage patterns

• Use the 1 type/interface export as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
• The module exposes 1 class as constructable runtime implementations. Each symbol entry lists its constructor and public methods.

Public exports

Symbol	Kind	Signature	Description
DefaultArtifactManager	class	new DefaultArtifactManager(options: DefaultArtifactManagerOptions): DefaultArtifactManager	Default Artifact Manager class with 17 public constructor or member entries; its exact declarations are listed below.
DefaultArtifactManagerOptions	interface	interface DefaultArtifactManagerOptions	Default Artifact Manager Options interface with 6 public fields or methods.

DefaultArtifactManager

Default Artifact Manager class with 17 public constructor or member entries; its exact declarations are listed below.

• Kind: class
• Import: import { DefaultArtifactManager } from '@codesoul-co/hypha-core';
• Source module: modules/artifact/runtime

Declaration

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

Public members

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

DefaultArtifactManagerOptions

Default Artifact Manager Options interface with 6 public fields or methods.

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

Declaration

export interface DefaultArtifactManagerOptions {
    profiles: ArtifactProfileSpec[];
    stores: ArtifactStoreProvider[];
    repository: ArtifactRecordRepository;
    workspaceReader?: ArtifactWorkspaceContentReader;
    idGenerator: () => string;
    now?: () => string;
}

Contract members

Member	Kind	Signature	Description
idGenerator	method	idGenerator(): string	Public method; parameters and return type are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
profiles	property	profiles: ArtifactProfileSpec[]	Public property; its type, readonly modifier and optionality are shown in the signature.
repository	property	repository: ArtifactRecordRepository	Public property; its type, readonly modifier and optionality are shown in the signature.
stores	property	stores: ArtifactStoreProvider[]	Public property; its type, readonly modifier and optionality are shown in the signature.
workspaceReader	property	workspaceReader?: ArtifactWorkspaceContentReader	Public property; its type, readonly modifier and optionality are shown in the signature.