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

• 包索引: @codesoul-co/hypha-core
• 源码: packages/core/src/modules/artifact/eventing.ts
• 导出数: 6

模块用法

用于创建、记录或读取 Event 契约。Eventing 模块公开 3 类、3 接口。

从包入口导入

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

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

使用要点

• 3 个类型/接口用于应用代码、Adapter 或测试中的静态契约；请使用 import type，运行时不应依赖它们。
• 3 个类提供可实例化的运行时实现；构造参数与公开方法在各自条目中完整列出。

公共导出

Symbol	种类	签名	说明
EventingArtifactGarbageCollector	类	new EventingArtifactGarbageCollector(options: EventingArtifactGarbageCollectorOptions): EventingArtifactGarbageCollector	Eventing Artifact Garbage Collector 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。
EventingArtifactManager	类	new EventingArtifactManager(options: EventingArtifactManagerOptions): EventingArtifactManager	Eventing Artifact Manager 类，共公开 17 个构造函数或成员；精确签名见本条目的声明与成员表。
EventingArtifactRetentionProcessor	类	new EventingArtifactRetentionProcessor(options: EventingArtifactRetentionProcessorOptions): EventingArtifactRetentionProcessor	Eventing Artifact Retention Processor 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。
EventingArtifactGarbageCollectorOptions	接口	interface EventingArtifactGarbageCollectorOptions	Eventing Artifact Garbage Collector Options 接口，共包含 8 个公开字段或方法。
EventingArtifactManagerOptions	接口	interface EventingArtifactManagerOptions	Eventing Artifact Manager Options 接口，共包含 4 个公开字段或方法。
EventingArtifactRetentionProcessorOptions	接口	interface EventingArtifactRetentionProcessorOptions	Eventing Artifact Retention Processor Options 接口，共包含 8 个公开字段或方法。

EventingArtifactGarbageCollector

Eventing Artifact Garbage Collector 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { EventingArtifactGarbageCollector } from '@codesoul-co/hypha-core';
• 源码模块: modules/artifact/eventing

声明

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

公开成员

成员	种类	签名	说明
collect	方法	collect(input: ArtifactGarbageCollectionRequest): Promise<ArtifactGarbageCollectionResult>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: EventingArtifactGarbageCollectorOptions): EventingArtifactGarbageCollector	创建该类的实例。

EventingArtifactManager

Eventing Artifact Manager 类，共公开 17 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { EventingArtifactManager } from '@codesoul-co/hypha-core';
• 源码模块: modules/artifact/eventing

声明

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>>;
}

公开成员

成员	种类	签名	说明
archive	方法	archive(input: ArtifactArchiveRequest): Promise<ArtifactRecord>	公开方法；参数与返回类型以签名列为准。
constructor	构造函数	(options: EventingArtifactManagerOptions): EventingArtifactManager	创建该类的实例。
create	方法	create(input: ArtifactCreateRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>	公开方法；参数与返回类型以签名列为准。
createDownloadAccess	方法	createDownloadAccess(request: ArtifactCreateDownloadAccessRequest): Promise<ArtifactDownloadAccess>	公开方法；参数与返回类型以签名列为准。
createFromWorkspace	方法	createFromWorkspace(input: ArtifactFromWorkspaceRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>	公开方法；参数与返回类型以签名列为准。
createVersion	方法	createVersion(input: ArtifactVersionRequest, options?: ArtifactOperationOptions): Promise<ArtifactRecord>	公开方法；参数与返回类型以签名列为准。
delete	方法	delete(input: ArtifactDeleteRequest): Promise<void>	公开方法；参数与返回类型以签名列为准。
finalize	方法	finalize(input: ArtifactFinalizeRequest): Promise<ArtifactRecord>	公开方法；参数与返回类型以签名列为准。
get	方法	get(request: ArtifactGetRecordRequest): Promise<ArtifactRecord | null>	公开方法；参数与返回类型以签名列为准。
health	方法	health(): Promise<Record<string, ProviderHealth>>	公开方法；参数与返回类型以签名列为准。
invalidate	方法	invalidate(input: ArtifactInvalidateRequest): Promise<ArtifactRecord>	公开方法；参数与返回类型以签名列为准。
latest	方法	latest(request: ArtifactLatestRequest): Promise<ArtifactRecord | null>	公开方法；参数与返回类型以签名列为准。
list	方法	list(request: ArtifactListRequest): Promise<ArtifactRecord[]>	公开方法；参数与返回类型以签名列为准。
previous	方法	previous(request: ArtifactPreviousRequest): Promise<ArtifactRecord | null>	公开方法；参数与返回类型以签名列为准。
profile	方法	profile(ref: SpecRef): Promise<ArtifactProfileSpec | null>	公开方法；参数与返回类型以签名列为准。
read	方法	read(input: ArtifactReadRequest, options?: ArtifactOperationOptions): Promise<ArtifactReadResult>	公开方法；参数与返回类型以签名列为准。
traceLineage	方法	traceLineage(request: ArtifactTraceLineageRequest): Promise<ArtifactLineage>	公开方法；参数与返回类型以签名列为准。

EventingArtifactRetentionProcessor

Eventing Artifact Retention Processor 类，共公开 2 个构造函数或成员；精确签名见本条目的声明与成员表。

• 种类: 类
• 导入: import { EventingArtifactRetentionProcessor } from '@codesoul-co/hypha-core';
• 源码模块: modules/artifact/eventing

声明

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

公开成员

成员	种类	签名	说明
constructor	构造函数	(options: EventingArtifactRetentionProcessorOptions): EventingArtifactRetentionProcessor	创建该类的实例。
process	方法	process(request: ArtifactRetentionProcessRequest): Promise<ArtifactRetentionProcessResult>	公开方法；参数与返回类型以签名列为准。

EventingArtifactGarbageCollectorOptions

Eventing Artifact Garbage Collector Options 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { EventingArtifactGarbageCollectorOptions } from '@codesoul-co/hypha-core';
• 源码模块: modules/artifact/eventing

声明

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

契约成员

成员	种类	签名	说明
agentId	属性	agentId?: string	公开属性；类型、只读和可选状态以签名列为准。
collector	属性	collector: ArtifactGarbageCollector	公开属性；类型、只读和可选状态以签名列为准。
idGenerator	方法	idGenerator(): string	公开方法；参数与返回类型以签名列为准。
now	方法	now?(): string	公开方法；参数与返回类型以签名列为准。
publisher	属性	publisher: ArtifactEventPublisher	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId?: string	公开属性；类型、只读和可选状态以签名列为准。
sessionId	属性	sessionId?: string	公开属性；类型、只读和可选状态以签名列为准。
workspaceId	属性	workspaceId?: string	公开属性；类型、只读和可选状态以签名列为准。

EventingArtifactManagerOptions

Eventing Artifact Manager Options 接口，共包含 4 个公开字段或方法。

• 种类: 接口
• 导入: import type { EventingArtifactManagerOptions } from '@codesoul-co/hypha-core';
• 源码模块: modules/artifact/eventing

声明

export interface EventingArtifactManagerOptions {
    manager: ArtifactManager;
    publisher: ArtifactEventPublisher;
    idGenerator: () => string;
    now?: () => string;
}

契约成员

成员	种类	签名	说明
idGenerator	方法	idGenerator(): string	公开方法；参数与返回类型以签名列为准。
manager	属性	manager: ArtifactManager	公开属性；类型、只读和可选状态以签名列为准。
now	方法	now?(): string	公开方法；参数与返回类型以签名列为准。
publisher	属性	publisher: ArtifactEventPublisher	公开属性；类型、只读和可选状态以签名列为准。

EventingArtifactRetentionProcessorOptions

Eventing Artifact Retention Processor Options 接口，共包含 8 个公开字段或方法。

• 种类: 接口
• 导入: import type { EventingArtifactRetentionProcessorOptions } from '@codesoul-co/hypha-core';
• 源码模块: modules/artifact/eventing

声明

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

契约成员

成员	种类	签名	说明
agentId	属性	agentId?: string	公开属性；类型、只读和可选状态以签名列为准。
idGenerator	方法	idGenerator(): string	公开方法；参数与返回类型以签名列为准。
now	方法	now?(): string	公开方法；参数与返回类型以签名列为准。
processor	属性	processor: ArtifactRetentionProcessor	公开属性；类型、只读和可选状态以签名列为准。
publisher	属性	publisher: ArtifactEventPublisher	公开属性；类型、只读和可选状态以签名列为准。
runId	属性	runId?: string	公开属性；类型、只读和可选状态以签名列为准。
sessionId	属性	sessionId?: string	公开属性；类型、只读和可选状态以签名列为准。
workspaceId	属性	workspaceId?: string	公开属性；类型、只读和可选状态以签名列为准。