`@codesoul-co/hypha-core` / `contracts/artifact-record-repository`

包索引: @codesoul-co/hypha-core
源码: packages/core/src/contracts/artifact-record-repository.ts
导出数: 7

模块用法

用于声明并运行时校验契约。Artifact record repository 模块公开 2 类、5 接口。

从包入口导入

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

import type {
  ArtifactIdempotencyRecord,
  ArtifactRecordCommitRequest,
  ArtifactRecordRepository,
  ArtifactRevisionFence,
  StoredArtifactRecord,
} from '@codesoul-co/hypha-core';

使用要点

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

公共导出

Symbol	种类	签名	说明
`ArtifactRecordRepositoryConflictError`	类	`new ArtifactRecordRepositoryConflictError(message: string, details?: Record<string, unknown> \| undefined): ArtifactRecordRepositoryConflictError`	Artifact Record Repository Conflict Error 类，共公开 9 个构造函数或成员；精确签名见本条目的声明与成员表。
`ArtifactRecordRepositoryError`	类	`new ArtifactRecordRepositoryError(code: "ARTIFACT_RECORD_REPOSITORY_UNAVAILABLE" \| "ARTIFACT_RECORD_REPOSITORY_CORRUPT", message: string, cause?: unknown \| undefined): ArtifactRecordRepositoryError`	Artifact Record Repository Error 类，共公开 9 个构造函数或成员；精确签名见本条目的声明与成员表。
`ArtifactIdempotencyRecord`	接口	`interface ArtifactIdempotencyRecord`	Artifact Idempotency Record 接口，共包含 4 个公开字段或方法。
`ArtifactRecordCommitRequest`	接口	`interface ArtifactRecordCommitRequest`	Artifact Record Commit Request 接口，共包含 3 个公开字段或方法。
`ArtifactRecordRepository`	接口	`interface ArtifactRecordRepository`	Metadata persistence port for ArtifactManager. Implementations persist records, version/lineage links, and idempotency results, but never Artifact content bytes.
`ArtifactRevisionFence`	接口	`interface ArtifactRevisionFence`	Artifact Revision Fence 接口，共包含 3 个公开字段或方法。
`StoredArtifactRecord`	接口	`interface StoredArtifactRecord`	Stored Artifact Record 接口，共包含 2 个公开字段或方法。

`ArtifactRecordRepositoryConflictError`

Artifact Record Repository Conflict Error 类，共公开 9 个构造函数或成员；精确签名见本条目的声明与成员表。

种类: 类
导入: import { ArtifactRecordRepositoryConflictError } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export declare class ArtifactRecordRepositoryConflictError extends Error {
    readonly details?: Record<string, unknown> | undefined;
    constructor(message: string, details?: Record<string, unknown> | undefined);
}

公开成员

成员	种类	签名	说明
`cause`	属性	`cause?: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`constructor`	构造函数	`(message: string, details?: Record<string, unknown> \| undefined): ArtifactRecordRepositoryConflictError`	创建该类的实例。
`details`	属性	`readonly details?: Record<string, unknown>`	公开属性；类型、只读和可选状态以签名列为准。
`message`	属性	`message: string`	公开属性；类型、只读和可选状态以签名列为准。
`name`	属性	`name: string`	公开属性；类型、只读和可选状态以签名列为准。
`stack`	属性	`stack?: string`	公开属性；类型、只读和可选状态以签名列为准。
`static captureStackTrace`	方法	`static captureStackTrace(targetObject: object, constructorOpt?: Function): void`	Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: `js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a();`
`static prepareStackTrace`	方法	`static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any`	公开方法；参数与返回类型以签名列为准。
`static stackTraceLimit`	属性	`static stackTraceLimit: number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

`ArtifactRecordRepositoryError`

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

种类: 类
导入: import { ArtifactRecordRepositoryError } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export declare class ArtifactRecordRepositoryError extends Error {
    readonly code: 'ARTIFACT_RECORD_REPOSITORY_UNAVAILABLE' | 'ARTIFACT_RECORD_REPOSITORY_CORRUPT';
    readonly cause?: unknown | undefined;
    constructor(code: 'ARTIFACT_RECORD_REPOSITORY_UNAVAILABLE' | 'ARTIFACT_RECORD_REPOSITORY_CORRUPT', message: string, cause?: unknown | undefined);
}

公开成员

成员	种类	签名	说明
`cause`	属性	`readonly cause?: unknown`	公开属性；类型、只读和可选状态以签名列为准。
`code`	属性	`readonly code: "ARTIFACT_RECORD_REPOSITORY_UNAVAILABLE" \| "ARTIFACT_RECORD_REPOSITORY_CORRUPT"`	公开属性；类型、只读和可选状态以签名列为准。
`constructor`	构造函数	`(code: "ARTIFACT_RECORD_REPOSITORY_UNAVAILABLE" \| "ARTIFACT_RECORD_REPOSITORY_CORRUPT", message: string, cause?: unknown \| undefined): ArtifactRecordRepositoryError`	创建该类的实例。
`message`	属性	`message: string`	公开属性；类型、只读和可选状态以签名列为准。
`name`	属性	`name: string`	公开属性；类型、只读和可选状态以签名列为准。
`stack`	属性	`stack?: string`	公开属性；类型、只读和可选状态以签名列为准。
`static captureStackTrace`	方法	`static captureStackTrace(targetObject: object, constructorOpt?: Function): void`	Creates a `.stack` property on `targetObject`, which when accessed returns a string representing the location in the code at which `Error.captureStackTrace()` was called. js const myObject = {}; Error.captureStackTrace(myObject); myObject.stack; // Similar to `new Error().stack` The first line of the trace will be prefixed with `${myObject.name}: ${myObject.message}`. The optional `constructorOpt` argument accepts a function. If given, all frames above `constructorOpt`, including `constructorOpt`, will be omitted from the generated stack trace. The `constructorOpt` argument is useful for hiding implementation details of error generation from the user. For instance: `js function a() { b(); } function b() { c(); } function c() { // Create an error without stack trace to avoid calculating the stack trace twice. const { stackTraceLimit } = Error; Error.stackTraceLimit = 0; const error = new Error(); Error.stackTraceLimit = stackTraceLimit; // Capture the stack trace above function b Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace throw error; } a();`
`static prepareStackTrace`	方法	`static prepareStackTrace(err: Error, stackTraces: NodeJS.CallSite[]): any`	公开方法；参数与返回类型以签名列为准。
`static stackTraceLimit`	属性	`static stackTraceLimit: number`	The `Error.stackTraceLimit` property specifies the number of stack frames collected by a stack trace (whether generated by `new Error().stack` or `Error.captureStackTrace(obj)`). The default value is `10` but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed. If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

`ArtifactIdempotencyRecord`

Artifact Idempotency Record 接口，共包含 4 个公开字段或方法。

种类: 接口
导入: import type { ArtifactIdempotencyRecord } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export interface ArtifactIdempotencyRecord {
    operationId: string;
    idempotencyKey: string;
    artifactId: string;
    versionId: string;
}

契约成员

成员	种类	签名	说明
`artifactId`	属性	`artifactId: string`	公开属性；类型、只读和可选状态以签名列为准。
`idempotencyKey`	属性	`idempotencyKey: string`	公开属性；类型、只读和可选状态以签名列为准。
`operationId`	属性	`operationId: string`	公开属性；类型、只读和可选状态以签名列为准。
`versionId`	属性	`versionId: string`	公开属性；类型、只读和可选状态以签名列为准。

`ArtifactRecordCommitRequest`

Artifact Record Commit Request 接口，共包含 3 个公开字段或方法。

种类: 接口
导入: import type { ArtifactRecordCommitRequest } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export interface ArtifactRecordCommitRequest {
    records: StoredArtifactRecord[];
    expectedLatest?: ArtifactRevisionFence;
    idempotency?: ArtifactIdempotencyRecord;
}

契约成员

成员	种类	签名	说明
`expectedLatest`	属性	`expectedLatest?: ArtifactRevisionFence`	公开属性；类型、只读和可选状态以签名列为准。
`idempotency`	属性	`idempotency?: ArtifactIdempotencyRecord`	公开属性；类型、只读和可选状态以签名列为准。
`records`	属性	`records: StoredArtifactRecord[]`	公开属性；类型、只读和可选状态以签名列为准。

`ArtifactRecordRepository`

Metadata persistence port for ArtifactManager. Implementations persist records, version/lineage links, and idempotency results, but never Artifact content bytes.

种类: 接口
导入: import type { ArtifactRecordRepository } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export interface ArtifactRecordRepository {
    get(artifactId: string, versionId?: string): Promise<StoredArtifactRecord | null>;
    getByVersionId(versionId: string): Promise<StoredArtifactRecord | null>;
    list(): Promise<StoredArtifactRecord[]>;
    findIdempotency(operationId: string, idempotencyKey: string): Promise<StoredArtifactRecord | null>;
    commit(request: ArtifactRecordCommitRequest): Promise<void>;
    listGarbageCollectionCandidates(request: ArtifactGarbageCollectionScanRequest): Promise<ArtifactGarbageCollectionCandidate[]>;
    claimGarbageCollection(request: ArtifactGarbageCollectionClaimRequest): Promise<boolean>;
    completeGarbageCollection(claimId: string, completedAt: string): Promise<void>;
    releaseGarbageCollection(claimId: string): Promise<void>;
    health(): Promise<ProviderHealth>;
    close?(): Promise<void>;
}

契约成员

成员	种类	签名	说明
`claimGarbageCollection`	方法	`claimGarbageCollection(request: ArtifactGarbageCollectionClaimRequest): Promise<boolean>`	公开方法；参数与返回类型以签名列为准。
`close`	方法	`close?(): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`commit`	方法	`commit(request: ArtifactRecordCommitRequest): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`completeGarbageCollection`	方法	`completeGarbageCollection(claimId: string, completedAt: string): Promise<void>`	公开方法；参数与返回类型以签名列为准。
`findIdempotency`	方法	`findIdempotency(operationId: string, idempotencyKey: string): Promise<StoredArtifactRecord \| null>`	公开方法；参数与返回类型以签名列为准。
`get`	方法	`get(artifactId: string, versionId?: string): Promise<StoredArtifactRecord \| null>`	公开方法；参数与返回类型以签名列为准。
`getByVersionId`	方法	`getByVersionId(versionId: string): Promise<StoredArtifactRecord \| null>`	公开方法；参数与返回类型以签名列为准。
`health`	方法	`health(): Promise<ProviderHealth>`	公开方法；参数与返回类型以签名列为准。
`list`	方法	`list(): Promise<StoredArtifactRecord[]>`	公开方法；参数与返回类型以签名列为准。
`listGarbageCollectionCandidates`	方法	`listGarbageCollectionCandidates(request: ArtifactGarbageCollectionScanRequest): Promise<ArtifactGarbageCollectionCandidate[]>`	公开方法；参数与返回类型以签名列为准。
`releaseGarbageCollection`	方法	`releaseGarbageCollection(claimId: string): Promise<void>`	公开方法；参数与返回类型以签名列为准。

`ArtifactRevisionFence`

Artifact Revision Fence 接口，共包含 3 个公开字段或方法。

种类: 接口
导入: import type { ArtifactRevisionFence } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export interface ArtifactRevisionFence {
    artifactId: string;
    versionId: string;
    revision: number;
}

契约成员

成员	种类	签名	说明
`artifactId`	属性	`artifactId: string`	公开属性；类型、只读和可选状态以签名列为准。
`revision`	属性	`revision: number`	公开属性；类型、只读和可选状态以签名列为准。
`versionId`	属性	`versionId: string`	公开属性；类型、只读和可选状态以签名列为准。

`StoredArtifactRecord`

Stored Artifact Record 接口，共包含 2 个公开字段或方法。

种类: 接口
导入: import type { StoredArtifactRecord } from '@codesoul-co/hypha-core';
源码模块: contracts/artifact-record-repository

声明

text

export interface StoredArtifactRecord {
    record: ArtifactRecord;
    profileRef: SpecRef;
}

契约成员

成员	种类	签名	说明
`profileRef`	属性	`profileRef: SpecRef`	公开属性；类型、只读和可选状态以签名列为准。
`record`	属性	`record: ArtifactRecord`	公开属性；类型、只读和可选状态以签名列为准。

@codesoul-co/hypha-core / contracts/artifact-record-repository ​

模块用法 ​

从包入口导入 ​

使用要点 ​

公共导出 ​

ArtifactRecordRepositoryConflictError ​

声明 ​

公开成员 ​

ArtifactRecordRepositoryError ​

声明 ​

公开成员 ​

ArtifactIdempotencyRecord ​

声明 ​

契约成员 ​

ArtifactRecordCommitRequest ​

声明 ​

契约成员 ​

ArtifactRecordRepository ​

声明 ​

契约成员 ​

ArtifactRevisionFence ​

声明 ​

契约成员 ​

StoredArtifactRecord ​

声明 ​

契约成员 ​

`@codesoul-co/hypha-core` / `contracts/artifact-record-repository`

模块用法

从包入口导入

使用要点

公共导出

`ArtifactRecordRepositoryConflictError`

声明

公开成员

`ArtifactRecordRepositoryError`

声明

公开成员

`ArtifactIdempotencyRecord`

声明

契约成员

`ArtifactRecordCommitRequest`

声明

契约成员

`ArtifactRecordRepository`

声明

契约成员

`ArtifactRevisionFence`

声明

契约成员

`StoredArtifactRecord`

声明

契约成员