@codesoul-co/hypha-core / contracts/artifact
- 包索引:
@codesoul-co/hypha-core - 源码:
packages/core/src/contracts/artifact.ts - 导出数: 18
模块用法
用于声明并运行时校验契约。Artifact 模块公开 15 接口、3 类型。
从包入口导入
import type {
ArtifactAccessPolicySpec,
ArtifactAccessRecord,
ArtifactContentAddressingSpec,
ArtifactLineage,
ArtifactLineageNode,
ArtifactPreviewPolicySpec,
ArtifactProfileSpec,
ArtifactProvenance,
} from '@codesoul-co/hypha-core';
// 完整导出列表见下方。使用要点
- 18 个类型/接口用于应用代码、Adapter 或测试中的静态契约;请使用
import type,运行时不应依赖它们。
公共导出
| Symbol | 种类 | 签名 | 说明 |
|---|---|---|---|
ArtifactAccessPolicySpec | 接口 | interface ArtifactAccessPolicySpec | Artifact Access Policy Spec 接口,共包含 8 个公开字段或方法。 |
ArtifactAccessRecord | 接口 | interface ArtifactAccessRecord | Artifact Access Record 接口,共包含 5 个公开字段或方法。 |
ArtifactContentAddressingSpec | 接口 | interface ArtifactContentAddressingSpec | Artifact Content Addressing Spec 接口,共包含 3 个公开字段或方法。 |
ArtifactLineage | 接口 | interface ArtifactLineage | Artifact Lineage 接口,共包含 4 个公开字段或方法。 |
ArtifactLineageNode | 接口 | interface ArtifactLineageNode | Artifact Lineage Node 接口,共包含 6 个公开字段或方法。 |
ArtifactPreviewPolicySpec | 接口 | interface ArtifactPreviewPolicySpec | Artifact Preview Policy Spec 接口,共包含 3 个公开字段或方法。 |
ArtifactProfileSpec | 接口 | interface ArtifactProfileSpec extends VersionedSpec | Artifact Profile Spec 接口,共包含 15 个公开字段或方法。 |
ArtifactProvenance | 接口 | interface ArtifactProvenance | Artifact Provenance 接口,共包含 11 个公开字段或方法。 |
ArtifactRecord | 接口 | interface ArtifactRecord | Artifact Record 接口,共包含 41 个公开字段或方法。 |
ArtifactRef | 接口 | interface ArtifactRef | Artifact Ref 接口,共包含 7 个公开字段或方法。 |
ArtifactRetentionPolicySpec | 接口 | interface ArtifactRetentionPolicySpec | Artifact Retention Policy Spec 接口,共包含 7 个公开字段或方法。 |
ArtifactRetentionRecord | 接口 | interface ArtifactRetentionRecord | Artifact Retention Record 接口,共包含 5 个公开字段或方法。 |
ArtifactStorageRef | 接口 | interface ArtifactStorageRef | Artifact Storage Ref 接口,共包含 7 个公开字段或方法。 |
ArtifactValidationPolicySpec | 接口 | interface ArtifactValidationPolicySpec | Artifact Validation Policy Spec 接口,共包含 7 个公开字段或方法。 |
ArtifactVersioningPolicySpec | 接口 | interface ArtifactVersioningPolicySpec | Artifact Versioning Policy Spec 接口,共包含 3 个公开字段或方法。 |
ArtifactHashAlgorithm | 类型 | type ArtifactHashAlgorithm = 'sha256' | 'blake3' | Artifact Hash Algorithm 公共类型别名;完整类型表达式见声明。 |
ArtifactKind | 类型 | type ArtifactKind = 'document' | 'code' | 'dataset' | 'image' | 'audio' | 'video' | 'table' | 'report' | 'archive' | 'patch' | 'snapshot' | 'test_report' | 'build_output' | 'log' | 'tool_output' | 'execution_receipt' | 'other' | Artifact Kind 公共类型别名;完整类型表达式见声明。 |
ArtifactStatus | 类型 | type ArtifactStatus = 'creating' | 'draft' | 'final' | 'archived' | 'invalidated' | 'deletion_pending' | 'deleted' | 'failed' | Artifact Status 公共类型别名;完整类型表达式见声明。 |
ArtifactAccessPolicySpec
Artifact Access Policy Spec 接口,共包含 8 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactAccessPolicySpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactAccessPolicySpec {
defaultVisibility: 'private' | 'session' | 'workspace' | 'tenant' | 'shared';
allowedPrincipalTypes?: ExecutionPrincipal['type'][];
requiredReadScopes?: string[];
requiredWriteScopes?: string[];
requiredDeleteScopes?: string[];
signedUrlTtlSeconds?: number;
allowRangeRead?: boolean;
allowCrossWorkspaceCopy?: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
allowCrossWorkspaceCopy | 属性 | allowCrossWorkspaceCopy?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
allowedPrincipalTypes | 属性 | allowedPrincipalTypes?: ("system" | "agent" | "user" | "service")[] | 公开属性;类型、只读和可选状态以签名列为准。 |
allowRangeRead | 属性 | allowRangeRead?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
defaultVisibility | 属性 | defaultVisibility: "workspace" | "session" | "private" | "shared" | "tenant" | 公开属性;类型、只读和可选状态以签名列为准。 |
requiredDeleteScopes | 属性 | requiredDeleteScopes?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
requiredReadScopes | 属性 | requiredReadScopes?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
requiredWriteScopes | 属性 | requiredWriteScopes?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
signedUrlTtlSeconds | 属性 | signedUrlTtlSeconds?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactAccessRecord
Artifact Access Record 接口,共包含 5 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactAccessRecord } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactAccessRecord {
visibility: ArtifactAccessPolicySpec['defaultVisibility'];
ownerPrincipalId: string;
workspaceId: string;
allowedPrincipalIds?: string[];
allowedRoles?: string[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
allowedPrincipalIds | 属性 | allowedPrincipalIds?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
allowedRoles | 属性 | allowedRoles?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
ownerPrincipalId | 属性 | ownerPrincipalId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
visibility | 属性 | visibility: "workspace" | "session" | "private" | "shared" | "tenant" | 公开属性;类型、只读和可选状态以签名列为准。 |
workspaceId | 属性 | workspaceId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactContentAddressingSpec
Artifact Content Addressing Spec 接口,共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactContentAddressingSpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactContentAddressingSpec {
hashAlgorithm: ArtifactHashAlgorithm;
verifyOnRead: boolean;
deduplicate: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
deduplicate | 属性 | deduplicate: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
hashAlgorithm | 属性 | hashAlgorithm: ArtifactHashAlgorithm | 公开属性;类型、只读和可选状态以签名列为准。 |
verifyOnRead | 属性 | verifyOnRead: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactLineage
Artifact Lineage 接口,共包含 4 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactLineage } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactLineage {
artifactId: string;
ancestors: ArtifactLineageNode[];
descendants: ArtifactLineageNode[];
versions: ArtifactRecord[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
ancestors | 属性 | ancestors: ArtifactLineageNode[] | 公开属性;类型、只读和可选状态以签名列为准。 |
artifactId | 属性 | artifactId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
descendants | 属性 | descendants: ArtifactLineageNode[] | 公开属性;类型、只读和可选状态以签名列为准。 |
versions | 属性 | versions: ArtifactRecord[] | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactLineageNode
Artifact Lineage Node 接口,共包含 6 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactLineageNode } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactLineageNode {
artifactId: string;
versionId: string;
logicalArtifactId: string;
contentHash: string;
kind?: ArtifactKind;
transformation?: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
artifactId | 属性 | artifactId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
contentHash | 属性 | contentHash: string | 公开属性;类型、只读和可选状态以签名列为准。 |
kind | 属性 | kind?: ArtifactKind | 公开属性;类型、只读和可选状态以签名列为准。 |
logicalArtifactId | 属性 | logicalArtifactId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
transformation | 属性 | transformation?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
versionId | 属性 | versionId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactPreviewPolicySpec
Artifact Preview Policy Spec 接口,共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactPreviewPolicySpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactPreviewPolicySpec {
enabled: boolean;
maxPreviewBytes?: number;
allowedMimeTypes?: string[];
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
allowedMimeTypes | 属性 | allowedMimeTypes?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
enabled | 属性 | enabled: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
maxPreviewBytes | 属性 | maxPreviewBytes?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactProfileSpec
Artifact Profile Spec 接口,共包含 15 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactProfileSpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactProfileSpec extends VersionedSpec {
revision?: string;
name?: string;
storeRef: SpecRef;
contentAddressing: ArtifactContentAddressingSpec;
versioning: ArtifactVersioningPolicySpec;
access: ArtifactAccessPolicySpec;
retention: ArtifactRetentionPolicySpec;
validation?: ArtifactValidationPolicySpec;
preview?: ArtifactPreviewPolicySpec;
allowedKinds?: ArtifactKind[];
allowedMimeTypes?: string[];
maxArtifactBytes?: number;
metadata?: Record<string, unknown>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
access | 属性 | access: ArtifactAccessPolicySpec | 公开属性;类型、只读和可选状态以签名列为准。 |
allowedKinds | 属性 | allowedKinds?: ArtifactKind[] | 公开属性;类型、只读和可选状态以签名列为准。 |
allowedMimeTypes | 属性 | allowedMimeTypes?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
contentAddressing | 属性 | contentAddressing: ArtifactContentAddressingSpec | 公开属性;类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性;类型、只读和可选状态以签名列为准。 |
maxArtifactBytes | 属性 | maxArtifactBytes?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
metadata | 属性 | metadata?: Record<string, unknown> | 公开属性;类型、只读和可选状态以签名列为准。 |
name | 属性 | name?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
preview | 属性 | preview?: ArtifactPreviewPolicySpec | 公开属性;类型、只读和可选状态以签名列为准。 |
retention | 属性 | retention: ArtifactRetentionPolicySpec | 公开属性;类型、只读和可选状态以签名列为准。 |
revision | 属性 | revision?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
storeRef | 属性 | storeRef: SpecRef | 公开属性;类型、只读和可选状态以签名列为准。 |
validation | 属性 | validation?: ArtifactValidationPolicySpec | 公开属性;类型、只读和可选状态以签名列为准。 |
version | 属性 | version: string | 公开属性;类型、只读和可选状态以签名列为准。 |
versioning | 属性 | versioning: ArtifactVersioningPolicySpec | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactProvenance
Artifact Provenance 接口,共包含 11 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactProvenance } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactProvenance {
sourceType: 'user_upload' | 'agent_generated' | 'tool_generated' | 'command_generated' | 'derived' | 'imported' | 'snapshot' | 'patch';
createdBy: string;
sourceEventId?: string;
toolInvocationId?: string;
executionId?: string;
workflowState?: string;
sourceArtifactIds?: string[];
transformation?: string;
environmentHash?: string;
commandHash?: string;
metadata?: Record<string, unknown>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
commandHash | 属性 | commandHash?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
createdBy | 属性 | createdBy: string | 公开属性;类型、只读和可选状态以签名列为准。 |
environmentHash | 属性 | environmentHash?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
executionId | 属性 | executionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
metadata | 属性 | metadata?: Record<string, unknown> | 公开属性;类型、只读和可选状态以签名列为准。 |
sourceArtifactIds | 属性 | sourceArtifactIds?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
sourceEventId | 属性 | sourceEventId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
sourceType | 属性 | sourceType: "patch" | "snapshot" | "user_upload" | "agent_generated" | "tool_generated" | "command_generated" | "derived" | "imported" | 公开属性;类型、只读和可选状态以签名列为准。 |
toolInvocationId | 属性 | toolInvocationId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
transformation | 属性 | transformation?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
workflowState | 属性 | workflowState?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactRecord
Artifact Record 接口,共包含 41 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactRecord } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactRecord {
id: string;
versionId: string;
versionNumber: number;
revision: number;
tenantId?: string;
userId: string;
workspaceId: string;
sessionId?: string;
runId?: string;
agentId?: string;
name: string;
description?: string;
relativePath?: string;
kind: ArtifactKind;
mimeType?: string;
encoding?: string;
sizeBytes: number;
contentHash: string;
hashAlgorithm: ArtifactHashAlgorithm;
storageRef: ArtifactStorageRef;
/** True when this version reused an already committed content-addressed Blob. */
deduplicated?: boolean;
logicalArtifactId: string;
parentVersionId?: string;
previousVersionId?: string;
nextVersionId?: string;
sourceArtifactIds?: string[];
derivedArtifactIds?: string[];
provenance: ArtifactProvenance;
access: ArtifactAccessRecord;
retention: ArtifactRetentionRecord;
status: ArtifactStatus;
immutable?: boolean;
sensitive?: boolean;
tags?: string[];
createdAt: string;
updatedAt: string;
finalizedAt?: string;
archivedAt?: string;
expiresAt?: string;
deletedAt?: string;
metadata?: Record<string, unknown>;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
access | 属性 | access: ArtifactAccessRecord | 公开属性;类型、只读和可选状态以签名列为准。 |
agentId | 属性 | agentId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
archivedAt | 属性 | archivedAt?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
contentHash | 属性 | contentHash: string | 公开属性;类型、只读和可选状态以签名列为准。 |
createdAt | 属性 | createdAt: string | 公开属性;类型、只读和可选状态以签名列为准。 |
deduplicated | 属性 | deduplicated?: boolean | True when this version reused an already committed content-addressed Blob. |
deletedAt | 属性 | deletedAt?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
derivedArtifactIds | 属性 | derivedArtifactIds?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
description | 属性 | description?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
encoding | 属性 | encoding?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
expiresAt | 属性 | expiresAt?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
finalizedAt | 属性 | finalizedAt?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
hashAlgorithm | 属性 | hashAlgorithm: ArtifactHashAlgorithm | 公开属性;类型、只读和可选状态以签名列为准。 |
id | 属性 | id: string | 公开属性;类型、只读和可选状态以签名列为准。 |
immutable | 属性 | immutable?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
kind | 属性 | kind: ArtifactKind | 公开属性;类型、只读和可选状态以签名列为准。 |
logicalArtifactId | 属性 | logicalArtifactId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
metadata | 属性 | metadata?: Record<string, unknown> | 公开属性;类型、只读和可选状态以签名列为准。 |
mimeType | 属性 | mimeType?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
name | 属性 | name: string | 公开属性;类型、只读和可选状态以签名列为准。 |
nextVersionId | 属性 | nextVersionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
parentVersionId | 属性 | parentVersionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
previousVersionId | 属性 | previousVersionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
provenance | 属性 | provenance: ArtifactProvenance | 公开属性;类型、只读和可选状态以签名列为准。 |
relativePath | 属性 | relativePath?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
retention | 属性 | retention: ArtifactRetentionRecord | 公开属性;类型、只读和可选状态以签名列为准。 |
revision | 属性 | revision: number | 公开属性;类型、只读和可选状态以签名列为准。 |
runId | 属性 | runId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
sensitive | 属性 | sensitive?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
sessionId | 属性 | sessionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
sizeBytes | 属性 | sizeBytes: number | 公开属性;类型、只读和可选状态以签名列为准。 |
sourceArtifactIds | 属性 | sourceArtifactIds?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
status | 属性 | status: ArtifactStatus | 公开属性;类型、只读和可选状态以签名列为准。 |
storageRef | 属性 | storageRef: ArtifactStorageRef | 公开属性;类型、只读和可选状态以签名列为准。 |
tags | 属性 | tags?: string[] | 公开属性;类型、只读和可选状态以签名列为准。 |
tenantId | 属性 | tenantId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
updatedAt | 属性 | updatedAt: string | 公开属性;类型、只读和可选状态以签名列为准。 |
userId | 属性 | userId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
versionId | 属性 | versionId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
versionNumber | 属性 | versionNumber: number | 公开属性;类型、只读和可选状态以签名列为准。 |
workspaceId | 属性 | workspaceId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactRef
Artifact Ref 接口,共包含 7 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactRef } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactRef {
artifactId: string;
versionId?: string;
contentHash: string;
kind?: ArtifactKind;
mimeType?: string;
sizeBytes?: number;
accessTokenRef?: string;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
accessTokenRef | 属性 | accessTokenRef?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
artifactId | 属性 | artifactId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
contentHash | 属性 | contentHash: string | 公开属性;类型、只读和可选状态以签名列为准。 |
kind | 属性 | kind?: ArtifactKind | 公开属性;类型、只读和可选状态以签名列为准。 |
mimeType | 属性 | mimeType?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
sizeBytes | 属性 | sizeBytes?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
versionId | 属性 | versionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactRetentionPolicySpec
Artifact Retention Policy Spec 接口,共包含 7 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactRetentionPolicySpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactRetentionPolicySpec {
defaultTtlSeconds?: number;
archiveAfterSeconds?: number;
deleteAfterSeconds?: number;
retainFinal?: boolean;
retainOnFailure?: boolean;
legalHoldSupported?: boolean;
garbageCollectUnreferenced?: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
archiveAfterSeconds | 属性 | archiveAfterSeconds?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
defaultTtlSeconds | 属性 | defaultTtlSeconds?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
deleteAfterSeconds | 属性 | deleteAfterSeconds?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
garbageCollectUnreferenced | 属性 | garbageCollectUnreferenced?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
legalHoldSupported | 属性 | legalHoldSupported?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
retainFinal | 属性 | retainFinal?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
retainOnFailure | 属性 | retainOnFailure?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactRetentionRecord
Artifact Retention Record 接口,共包含 5 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactRetentionRecord } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactRetentionRecord {
policyRef?: SpecRef;
expiresAt?: string;
archivedAt?: string;
legalHold?: boolean;
referencedByCount?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
archivedAt | 属性 | archivedAt?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
expiresAt | 属性 | expiresAt?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
legalHold | 属性 | legalHold?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
policyRef | 属性 | policyRef?: SpecRef | 公开属性;类型、只读和可选状态以签名列为准。 |
referencedByCount | 属性 | referencedByCount?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactStorageRef
Artifact Storage Ref 接口,共包含 7 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactStorageRef } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactStorageRef {
storeId: string;
bucketOrNamespace?: string;
objectKey: string;
versionId?: string;
etag?: string;
region?: string;
encrypted?: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
bucketOrNamespace | 属性 | bucketOrNamespace?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
encrypted | 属性 | encrypted?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
etag | 属性 | etag?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
objectKey | 属性 | objectKey: string | 公开属性;类型、只读和可选状态以签名列为准。 |
region | 属性 | region?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
storeId | 属性 | storeId: string | 公开属性;类型、只读和可选状态以签名列为准。 |
versionId | 属性 | versionId?: string | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactValidationPolicySpec
Artifact Validation Policy Spec 接口,共包含 7 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactValidationPolicySpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactValidationPolicySpec {
verifyMimeType?: boolean;
verifyExtension?: boolean;
malwareScanRef?: SpecRef;
archiveBombProtection?: boolean;
maxExpandedBytes?: number;
checksumRequired?: boolean;
rejectExecutableUploads?: boolean;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
archiveBombProtection | 属性 | archiveBombProtection?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
checksumRequired | 属性 | checksumRequired?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
malwareScanRef | 属性 | malwareScanRef?: SpecRef | 公开属性;类型、只读和可选状态以签名列为准。 |
maxExpandedBytes | 属性 | maxExpandedBytes?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
rejectExecutableUploads | 属性 | rejectExecutableUploads?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
verifyExtension | 属性 | verifyExtension?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
verifyMimeType | 属性 | verifyMimeType?: boolean | 公开属性;类型、只读和可选状态以签名列为准。 |
ArtifactVersioningPolicySpec
Artifact Versioning Policy Spec 接口,共包含 3 个公开字段或方法。
- 种类: 接口
- 导入:
import type { ArtifactVersioningPolicySpec } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export interface ArtifactVersioningPolicySpec {
/** E4 guarantees immutable history; replacement semantics are deliberately unsupported. */
strategy: 'append_only';
retainPreviousVersions: true;
maxVersions?: number;
}契约成员
| 成员 | 种类 | 签名 | 说明 |
|---|---|---|---|
maxVersions | 属性 | maxVersions?: number | 公开属性;类型、只读和可选状态以签名列为准。 |
retainPreviousVersions | 属性 | retainPreviousVersions: true | 公开属性;类型、只读和可选状态以签名列为准。 |
strategy | 属性 | strategy: "append_only" | E4 guarantees immutable history; replacement semantics are deliberately unsupported. |
ArtifactHashAlgorithm
Artifact Hash Algorithm 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ArtifactHashAlgorithm } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export type ArtifactHashAlgorithm = 'sha256' | 'blake3';ArtifactKind
Artifact Kind 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ArtifactKind } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export type ArtifactKind = 'document' | 'code' | 'dataset' | 'image' | 'audio' | 'video' | 'table' | 'report' | 'archive' | 'patch' | 'snapshot' | 'test_report' | 'build_output' | 'log' | 'tool_output' | 'execution_receipt' | 'other';ArtifactStatus
Artifact Status 公共类型别名;完整类型表达式见声明。
- 种类: 类型
- 导入:
import type { ArtifactStatus } from '@codesoul-co/hypha-core'; - 源码模块:
contracts/artifact
声明
export type ArtifactStatus = 'creating' | 'draft' | 'final' | 'archived' | 'invalidated' | 'deletion_pending' | 'deleted' | 'failed';