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

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

Using this module

Use the Eventing module for creating, recording, or reading Event contracts. It exports 3 classes, 3 interfaces.

Import from the package entrypoint

import {
  EventingArtifactGarbageCollector,
  EventingArtifactManager,
  EventingArtifactRetentionProcessor,
} from '@codesoul-co/hypha-core';

import type {
  EventingArtifactGarbageCollectorOptions,
  EventingArtifactManagerOptions,
  EventingArtifactRetentionProcessorOptions,
} from '@codesoul-co/hypha-core';

Usage patterns

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

Public exports

Symbol	Kind	Signature	Description
EventingArtifactGarbageCollector	class	new EventingArtifactGarbageCollector(options: EventingArtifactGarbageCollectorOptions): EventingArtifactGarbageCollector	Eventing Artifact Garbage Collector class with 2 public constructor or member entries; its exact declarations are listed below.
EventingArtifactManager	class	new EventingArtifactManager(options: EventingArtifactManagerOptions): EventingArtifactManager	Eventing Artifact Manager class with 17 public constructor or member entries; its exact declarations are listed below.
EventingArtifactRetentionProcessor	class	new EventingArtifactRetentionProcessor(options: EventingArtifactRetentionProcessorOptions): EventingArtifactRetentionProcessor	Eventing Artifact Retention Processor class with 2 public constructor or member entries; its exact declarations are listed below.
EventingArtifactGarbageCollectorOptions	interface	interface EventingArtifactGarbageCollectorOptions	Eventing Artifact Garbage Collector Options interface with 8 public fields or methods.
EventingArtifactManagerOptions	interface	interface EventingArtifactManagerOptions	Eventing Artifact Manager Options interface with 4 public fields or methods.
EventingArtifactRetentionProcessorOptions	interface	interface EventingArtifactRetentionProcessorOptions	Eventing Artifact Retention Processor Options interface with 8 public fields or methods.

EventingArtifactGarbageCollector

Eventing Artifact Garbage Collector class with 2 public constructor or member entries; its exact declarations are listed below.

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

Declaration

export declare class EventingArtifactGarbageCollector implements ArtifactGarbageCollector {
    constructor(options: EventingArtifactGarbageCollectorOptions);
    collect(input: ArtifactGarbageCollectionRequest): Promise<ArtifactGarbageCollectionResult>;
}

Public members

Member	Kind	Signature	Description
collect	method	collect(input: ArtifactGarbageCollectionRequest): Promise<ArtifactGarbageCollectionResult>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: EventingArtifactGarbageCollectorOptions): EventingArtifactGarbageCollector	Creates an instance of this class.

EventingArtifactManager

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

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

Declaration

export declare class EventingArtifactManager implements ArtifactManager {
    constructor(options: EventingArtifactManagerOptions);
    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(request: ArtifactCreateDownloadAccessRequest): Promise<ArtifactDownloadAccess>;
    list(request: ArtifactListRequest): Promise<ArtifactRecord[]>;
    finalize(input: ArtifactFinalizeRequest): Promise<ArtifactRecord>;
    archive(input: ArtifactArchiveRequest): Promise<ArtifactRecord>;
    invalidate(input: ArtifactInvalidateRequest): Promise<ArtifactRecord>;
    delete(input: ArtifactDeleteRequest): Promise<void>;
    traceLineage(request: ArtifactTraceLineageRequest): Promise<ArtifactLineage>;
    latest(request: ArtifactLatestRequest): Promise<ArtifactRecord | null>;
    previous(request: ArtifactPreviousRequest): Promise<ArtifactRecord | null>;
    profile(ref: SpecRef): Promise<ArtifactProfileSpec | null>;
    health(): Promise<Record<string, ProviderHealth>>;
}

Public members

Member	Kind	Signature	Description
archive	method	archive(input: ArtifactArchiveRequest): Promise<ArtifactRecord>	Public method; parameters and return type are shown in the signature.
constructor	constructor	(options: EventingArtifactManagerOptions): EventingArtifactManager	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(request: 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(input: 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(input: ArtifactInvalidateRequest): Promise<ArtifactRecord>	Public method; parameters and return type are shown in the signature.
latest	method	latest(request: ArtifactLatestRequest): Promise<ArtifactRecord | null>	Public method; parameters and return type are shown in the signature.
list	method	list(request: ArtifactListRequest): Promise<ArtifactRecord[]>	Public method; parameters and return type are shown in the signature.
previous	method	previous(request: 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(request: ArtifactTraceLineageRequest): Promise<ArtifactLineage>	Public method; parameters and return type are shown in the signature.

EventingArtifactRetentionProcessor

Eventing Artifact Retention Processor class with 2 public constructor or member entries; its exact declarations are listed below.

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

Declaration

export declare class EventingArtifactRetentionProcessor implements ArtifactRetentionProcessor {
    constructor(options: EventingArtifactRetentionProcessorOptions);
    process(request: ArtifactRetentionProcessRequest): Promise<ArtifactRetentionProcessResult>;
}

Public members

Member	Kind	Signature	Description
constructor	constructor	(options: EventingArtifactRetentionProcessorOptions): EventingArtifactRetentionProcessor	Creates an instance of this class.
process	method	process(request: ArtifactRetentionProcessRequest): Promise<ArtifactRetentionProcessResult>	Public method; parameters and return type are shown in the signature.

EventingArtifactGarbageCollectorOptions

Eventing Artifact Garbage Collector Options interface with 8 public fields or methods.

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

Declaration

export interface EventingArtifactGarbageCollectorOptions {
    collector: ArtifactGarbageCollector;
    publisher: ArtifactEventPublisher;
    idGenerator: () => string;
    now?: () => string;
    workspaceId?: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
collector	property	collector: ArtifactGarbageCollector	Public property; its type, readonly modifier and optionality are shown in the signature.
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.
publisher	property	publisher: ArtifactEventPublisher	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
workspaceId	property	workspaceId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

EventingArtifactManagerOptions

Eventing Artifact Manager Options interface with 4 public fields or methods.

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

Declaration

export interface EventingArtifactManagerOptions {
    manager: ArtifactManager;
    publisher: ArtifactEventPublisher;
    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.
manager	property	manager: ArtifactManager	Public property; its type, readonly modifier and optionality are shown in the signature.
now	method	now?(): string	Public method; parameters and return type are shown in the signature.
publisher	property	publisher: ArtifactEventPublisher	Public property; its type, readonly modifier and optionality are shown in the signature.

EventingArtifactRetentionProcessorOptions

Eventing Artifact Retention Processor Options interface with 8 public fields or methods.

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

Declaration

export interface EventingArtifactRetentionProcessorOptions {
    processor: ArtifactRetentionProcessor;
    publisher: ArtifactEventPublisher;
    idGenerator: () => string;
    now?: () => string;
    workspaceId?: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
}

Contract members

Member	Kind	Signature	Description
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
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.
processor	property	processor: ArtifactRetentionProcessor	Public property; its type, readonly modifier and optionality are shown in the signature.
publisher	property	publisher: ArtifactEventPublisher	Public property; its type, readonly modifier and optionality are shown in the signature.
runId	property	runId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sessionId	property	sessionId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
workspaceId	property	workspaceId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.