Skip to content

@codesoul-co/hypha-core / contracts/execution-cache

Using this module

Use the Execution cache module for declaring and runtime-validating contracts. It exports 15 interfaces, 6 types.

Import from the package entrypoint

ts
import type {
  ExecutionCacheArtifactReference,
  ExecutionCacheArtifactVerifier,
  ExecutionCacheEntryProjection,
  ExecutionCacheEvent,
  ExecutionCacheLookupInput,
  ExecutionCacheRecord,
  ExecutionCacheResultMetadata,
  ExecutionCacheReuseAssessmentInput,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

  • Use the 21 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.

Public exports

SymbolKindSignatureDescription
ExecutionCacheArtifactReferenceinterfaceinterface ExecutionCacheArtifactReferenceExecution Cache Artifact Reference interface with 2 public fields or methods.
ExecutionCacheArtifactVerifierinterfaceinterface ExecutionCacheArtifactVerifierExecution Cache Artifact Verifier interface with 1 public fields or methods.
ExecutionCacheEntryProjectioninterfaceinterface ExecutionCacheEntryProjectionExecution's projection for a generic CacheEntry value. It contains metadata, references, and hashes only; Artifact bytes and stdout/stderr are out of scope.
ExecutionCacheEventinterfaceinterface ExecutionCacheEventExecution Cache Event interface with 5 public fields or methods.
ExecutionCacheLookupInputinterfaceinterface ExecutionCacheLookupInputExecution Cache Lookup Input interface with 5 public fields or methods.
ExecutionCacheRecordinterfaceinterface ExecutionCacheRecordVersioned envelope persisted by an Execution Result Cache store.
ExecutionCacheResultMetadatainterfaceinterface ExecutionCacheResultMetadataBounded result fields allowed in a Cache entry.
ExecutionCacheReuseAssessmentInputinterfaceinterface ExecutionCacheReuseAssessmentInputExecution Cache Reuse Assessment Input interface with 2 public fields or methods.
ExecutionCacheScopeinterfaceinterface ExecutionCacheScopeMandatory ownership boundary for persisted Execution Cache records.
ExecutionCacheStoreinterfaceinterface ExecutionCacheStoreExecution Cache Store interface with 5 public fields or methods.
ExecutionCacheValidityInputinterfaceinterface ExecutionCacheValidityInputExact Execution-owned validity input consumed by Cache integrations.
ExecutionCacheWriteInputinterfaceinterface ExecutionCacheWriteInput extends ExecutionCacheLookupInputExecution Cache Write Input interface with 7 public fields or methods.
ExecutionCommandFingerprintInputinterfaceinterface ExecutionCommandFingerprintInputCanonical, bounded material for a Command fingerprint. Raw environment values, Secret values, stdin, and command output are deliberately excluded.
ExecutionEnvironmentFingerprintinterfaceinterface ExecutionEnvironmentFingerprintResolved environment facts used to prove that a cache key is stable.
ExecutionFingerprintHasherinterfaceinterface ExecutionFingerprintHasherPlatform-neutral SHA-256 port; adapters hash the canonical UTF-8 string.
ExecutionCacheFailureModetypetype ExecutionCacheFailureMode = 'bypass' | 'strict'Public type alias for Execution Cache Failure Mode; the declaration contains its complete type expression.
ExecutionCacheLookupResulttypetype ExecutionCacheLookupResult = { hit: true; key: string; projection: ExecutionCacheEntryProjection; ageMs: number; } | { hit: false; reason: ExecutionCacheMissReason; key?: string; }Public type alias for Execution Cache Lookup Result; the declaration contains its complete type expression.
ExecutionCacheMissReasontypetype ExecutionCacheMissReason = 'not_found' | 'expired' | 'scope_mismatch' | 'key_mismatch' | 'validity_changed' | 'artifact_verification_unavailable' | 'artifact_verification_failed' | 'environment_fingerprint_unavailable' | 'workspace_write' | 'external_side_effect' | 'irreversible_side_effect' | 'not_cacheable_status' | 'store_unavailable' | 'entry_oversized' | 'corrupt'Public type alias for Execution Cache Miss Reason; the declaration contains its complete type expression.
ExecutionCacheReuseAssessmenttypetype ExecutionCacheReuseAssessment = { reusable: true; } | { reusable: false; reason: ExecutionCacheReuseBlockReason; }Public type alias for Execution Cache Reuse Assessment; the declaration contains its complete type expression.
ExecutionCacheReuseBlockReasontypetype ExecutionCacheReuseBlockReason = 'environment_fingerprint_unavailable' | 'workspace_write' | 'external_side_effect' | 'irreversible_side_effect'Public type alias for Execution Cache Reuse Block Reason; the declaration contains its complete type expression.
ExecutionEnvironmentFingerprintResolutiontypetype ExecutionEnvironmentFingerprintResolution = { status: 'resolved'; fingerprint: ExecutionEnvironmentFingerprint; } | { status: 'unavailable'; reason: string; }Public type alias for Execution Environment Fingerprint Resolution; the declaration contains its complete type expression.

ExecutionCacheArtifactReference

Execution Cache Artifact Reference interface with 2 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheArtifactReference } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheArtifactReference {
    artifactRef: string;
    contentHash: string;
}

Contract members

MemberKindSignatureDescription
artifactRefpropertyartifactRef: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
contentHashpropertycontentHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheArtifactVerifier

Execution Cache Artifact Verifier interface with 1 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheArtifactVerifier } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheArtifactVerifier {
    verify(scope: ExecutionCacheScope, artifacts: ExecutionCacheArtifactReference[]): Promise<boolean>;
}

Contract members

MemberKindSignatureDescription
verifymethodverify(scope: ExecutionCacheScope, artifacts: ExecutionCacheArtifactReference[]): Promise<boolean>Public method; parameters and return type are shown in the signature.

ExecutionCacheEntryProjection

Execution's projection for a generic CacheEntry value. It contains metadata, references, and hashes only; Artifact bytes and stdout/stderr are out of scope.

  • Kind: interface
  • Import: import type { ExecutionCacheEntryProjection } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheEntryProjection {
    commandHash: string;
    validityHash: string;
    validity: ExecutionCacheValidityInput;
    resultMetadata: ExecutionCacheResultMetadata;
    artifacts: ExecutionCacheArtifactReference[];
}

Contract members

MemberKindSignatureDescription
artifactspropertyartifacts: ExecutionCacheArtifactReference[]Public property; its type, readonly modifier and optionality are shown in the signature.
commandHashpropertycommandHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
resultMetadatapropertyresultMetadata: ExecutionCacheResultMetadataPublic property; its type, readonly modifier and optionality are shown in the signature.
validitypropertyvalidity: ExecutionCacheValidityInputPublic property; its type, readonly modifier and optionality are shown in the signature.
validityHashpropertyvalidityHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheEvent

Execution Cache Event interface with 5 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheEvent } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheEvent {
    type: 'execution.cache.lookup' | 'execution.cache.hit' | 'execution.cache.miss' | 'execution.cache.write' | 'execution.cache.invalidate' | 'execution.cache.bypass';
    key?: string;
    scope: ExecutionCacheScope;
    reason?: ExecutionCacheMissReason;
    ageMs?: number;
}

Contract members

MemberKindSignatureDescription
ageMspropertyageMs?: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
keypropertykey?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
reasonpropertyreason?: ExecutionCacheMissReasonPublic property; its type, readonly modifier and optionality are shown in the signature.
scopepropertyscope: ExecutionCacheScopePublic property; its type, readonly modifier and optionality are shown in the signature.
typepropertytype: "execution.cache.lookup" | "execution.cache.hit" | "execution.cache.miss" | "execution.cache.write" | "execution.cache.invalidate" | "execution.cache.bypass"Public property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheLookupInput

Execution Cache Lookup Input interface with 5 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheLookupInput } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheLookupInput {
    scope: ExecutionCacheScope;
    command: ExecutionCommandFingerprintInput;
    validity: ExecutionCacheValidityInput;
    sideEffectLevel: SideEffectLevel;
    environmentFingerprintStatus: ExecutionEnvironmentFingerprintResolution['status'];
}

Contract members

MemberKindSignatureDescription
commandpropertycommand: ExecutionCommandFingerprintInputPublic property; its type, readonly modifier and optionality are shown in the signature.
environmentFingerprintStatuspropertyenvironmentFingerprintStatus: "resolved" | "unavailable"Public property; its type, readonly modifier and optionality are shown in the signature.
scopepropertyscope: ExecutionCacheScopePublic property; its type, readonly modifier and optionality are shown in the signature.
sideEffectLevelpropertysideEffectLevel: SideEffectLevelPublic property; its type, readonly modifier and optionality are shown in the signature.
validitypropertyvalidity: ExecutionCacheValidityInputPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheRecord

Versioned envelope persisted by an Execution Result Cache store.

  • Kind: interface
  • Import: import type { ExecutionCacheRecord } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheRecord {
    schemaVersion: '1.0';
    keyVersion: '1';
    key: string;
    scope: ExecutionCacheScope;
    projection: ExecutionCacheEntryProjection;
    createdAt: number;
    expiresAt?: number;
    sizeBytes?: number;
}

Contract members

MemberKindSignatureDescription
createdAtpropertycreatedAt: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
expiresAtpropertyexpiresAt?: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
keypropertykey: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
keyVersionpropertykeyVersion: "1"Public property; its type, readonly modifier and optionality are shown in the signature.
projectionpropertyprojection: ExecutionCacheEntryProjectionPublic property; its type, readonly modifier and optionality are shown in the signature.
schemaVersionpropertyschemaVersion: "1.0"Public property; its type, readonly modifier and optionality are shown in the signature.
scopepropertyscope: ExecutionCacheScopePublic property; its type, readonly modifier and optionality are shown in the signature.
sizeBytespropertysizeBytes?: numberPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheResultMetadata

Bounded result fields allowed in a Cache entry.

  • Kind: interface
  • Import: import type { ExecutionCacheResultMetadata } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheResultMetadata {
    executionId: string;
    status: CommandExecutionStatus;
    exitCode: number | null;
    signal?: string;
    resourceUsage?: ExecutionResourceUsage;
    providerReceiptHash?: string;
    startedAt: string;
    completedAt?: string;
    latencyMs?: number;
}

Contract members

MemberKindSignatureDescription
completedAtpropertycompletedAt?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
executionIdpropertyexecutionId: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
exitCodepropertyexitCode: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
latencyMspropertylatencyMs?: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
providerReceiptHashpropertyproviderReceiptHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
resourceUsagepropertyresourceUsage?: ExecutionResourceUsagePublic property; its type, readonly modifier and optionality are shown in the signature.
signalpropertysignal?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
startedAtpropertystartedAt: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
statuspropertystatus: CommandExecutionStatusPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheReuseAssessmentInput

Execution Cache Reuse Assessment Input interface with 2 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheReuseAssessmentInput } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheReuseAssessmentInput {
    sideEffectLevel: SideEffectLevel;
    environmentFingerprintStatus: ExecutionEnvironmentFingerprintResolution['status'];
}

Contract members

MemberKindSignatureDescription
environmentFingerprintStatuspropertyenvironmentFingerprintStatus: "resolved" | "unavailable"Public property; its type, readonly modifier and optionality are shown in the signature.
sideEffectLevelpropertysideEffectLevel: SideEffectLevelPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheScope

Mandatory ownership boundary for persisted Execution Cache records.

  • Kind: interface
  • Import: import type { ExecutionCacheScope } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheScope {
    tenantId?: string;
    userId: string;
    workspaceId: string;
}

Contract members

MemberKindSignatureDescription
tenantIdpropertytenantId?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
userIdpropertyuserId: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
workspaceIdpropertyworkspaceId: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheStore

Execution Cache Store interface with 5 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheStore } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheStore {
    get(key: string): Promise<ExecutionCacheRecord | null>;
    set(key: string, record: ExecutionCacheRecord): Promise<void>;
    delete(key: string): Promise<void>;
    clear?(): Promise<void>;
    close?(): Promise<void>;
}

Contract members

MemberKindSignatureDescription
clearmethodclear?(): Promise<void>Public method; parameters and return type are shown in the signature.
closemethodclose?(): Promise<void>Public method; parameters and return type are shown in the signature.
deletemethoddelete(key: string): Promise<void>Public method; parameters and return type are shown in the signature.
getmethodget(key: string): Promise<ExecutionCacheRecord | null>Public method; parameters and return type are shown in the signature.
setmethodset(key: string, record: ExecutionCacheRecord): Promise<void>Public method; parameters and return type are shown in the signature.

ExecutionCacheValidityInput

Exact Execution-owned validity input consumed by Cache integrations.

  • Kind: interface
  • Import: import type { ExecutionCacheValidityInput } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheValidityInput {
    executable: string;
    argsHash: string;
    sourceTreeHash: string;
    workspaceSnapshotHash?: string;
    environmentHash: string;
    imageDigest?: string;
    dependencyLockHash?: string;
    networkPolicyHash: string;
    secretVersionSetHash?: string;
    commandPolicyRevision?: string;
}

Contract members

MemberKindSignatureDescription
argsHashpropertyargsHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
commandPolicyRevisionpropertycommandPolicyRevision?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
dependencyLockHashpropertydependencyLockHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
environmentHashpropertyenvironmentHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
executablepropertyexecutable: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
imageDigestpropertyimageDigest?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
networkPolicyHashpropertynetworkPolicyHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
secretVersionSetHashpropertysecretVersionSetHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
sourceTreeHashpropertysourceTreeHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
workspaceSnapshotHashpropertyworkspaceSnapshotHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCacheWriteInput

Execution Cache Write Input interface with 7 public fields or methods.

  • Kind: interface
  • Import: import type { ExecutionCacheWriteInput } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCacheWriteInput extends ExecutionCacheLookupInput {
    projection: ExecutionCacheEntryProjection;
    ttlMs?: number;
}

Contract members

MemberKindSignatureDescription
commandpropertycommand: ExecutionCommandFingerprintInputPublic property; its type, readonly modifier and optionality are shown in the signature.
environmentFingerprintStatuspropertyenvironmentFingerprintStatus: "resolved" | "unavailable"Public property; its type, readonly modifier and optionality are shown in the signature.
projectionpropertyprojection: ExecutionCacheEntryProjectionPublic property; its type, readonly modifier and optionality are shown in the signature.
scopepropertyscope: ExecutionCacheScopePublic property; its type, readonly modifier and optionality are shown in the signature.
sideEffectLevelpropertysideEffectLevel: SideEffectLevelPublic property; its type, readonly modifier and optionality are shown in the signature.
ttlMspropertyttlMs?: numberPublic property; its type, readonly modifier and optionality are shown in the signature.
validitypropertyvalidity: ExecutionCacheValidityInputPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionCommandFingerprintInput

Canonical, bounded material for a Command fingerprint. Raw environment values, Secret values, stdin, and command output are deliberately excluded.

  • Kind: interface
  • Import: import type { ExecutionCommandFingerprintInput } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionCommandFingerprintInput {
    executable: string;
    argsHash: string;
    cwd?: string;
    relevantEnvHash: string;
    sourceTreeHash: string;
    environmentHash: string;
    networkPolicyHash: string;
    secretVersionSetHash?: string;
    idempotencyKey: string;
}

Contract members

MemberKindSignatureDescription
argsHashpropertyargsHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
cwdpropertycwd?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
environmentHashpropertyenvironmentHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
executablepropertyexecutable: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKeypropertyidempotencyKey: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
networkPolicyHashpropertynetworkPolicyHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
relevantEnvHashpropertyrelevantEnvHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
secretVersionSetHashpropertysecretVersionSetHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
sourceTreeHashpropertysourceTreeHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionEnvironmentFingerprint

Resolved environment facts used to prove that a cache key is stable.

  • Kind: interface
  • Import: import type { ExecutionEnvironmentFingerprint } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionEnvironmentFingerprint {
    environmentRef: SpecRef;
    environmentRevision: string;
    providerId: string;
    imageDigest?: string;
    platform?: string;
    executableVersions?: Record<string, string>;
    dependencyLockHash?: string;
    resourcePolicyHash: string;
    networkPolicyHash: string;
    mountPolicyHash: string;
    secretVersionSetHash?: string;
    fingerprintHash: string;
}

Contract members

MemberKindSignatureDescription
dependencyLockHashpropertydependencyLockHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
environmentRefpropertyenvironmentRef: SpecRefPublic property; its type, readonly modifier and optionality are shown in the signature.
environmentRevisionpropertyenvironmentRevision: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
executableVersionspropertyexecutableVersions?: Record<string, string>Public property; its type, readonly modifier and optionality are shown in the signature.
fingerprintHashpropertyfingerprintHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
imageDigestpropertyimageDigest?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
mountPolicyHashpropertymountPolicyHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
networkPolicyHashpropertynetworkPolicyHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
platformpropertyplatform?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
providerIdpropertyproviderId: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
resourcePolicyHashpropertyresourcePolicyHash: stringPublic property; its type, readonly modifier and optionality are shown in the signature.
secretVersionSetHashpropertysecretVersionSetHash?: stringPublic property; its type, readonly modifier and optionality are shown in the signature.

ExecutionFingerprintHasher

Platform-neutral SHA-256 port; adapters hash the canonical UTF-8 string.

  • Kind: interface
  • Import: import type { ExecutionFingerprintHasher } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export interface ExecutionFingerprintHasher {
    readonly algorithm: 'sha256';
    hashUtf8(canonicalValue: string): Promise<string>;
}

Contract members

MemberKindSignatureDescription
algorithmpropertyreadonly algorithm: "sha256"Public property; its type, readonly modifier and optionality are shown in the signature.
hashUtf8methodhashUtf8(canonicalValue: string): Promise<string>Public method; parameters and return type are shown in the signature.

ExecutionCacheFailureMode

Public type alias for Execution Cache Failure Mode; the declaration contains its complete type expression.

  • Kind: type
  • Import: import type { ExecutionCacheFailureMode } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export type ExecutionCacheFailureMode = 'bypass' | 'strict';

ExecutionCacheLookupResult

Public type alias for Execution Cache Lookup Result; the declaration contains its complete type expression.

  • Kind: type
  • Import: import type { ExecutionCacheLookupResult } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export type ExecutionCacheLookupResult = {
    hit: true;
    key: string;
    projection: ExecutionCacheEntryProjection;
    ageMs: number;
} | {
    hit: false;
    reason: ExecutionCacheMissReason;
    key?: string;
};

ExecutionCacheMissReason

Public type alias for Execution Cache Miss Reason; the declaration contains its complete type expression.

  • Kind: type
  • Import: import type { ExecutionCacheMissReason } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export type ExecutionCacheMissReason = 'not_found' | 'expired' | 'scope_mismatch' | 'key_mismatch' | 'validity_changed' | 'artifact_verification_unavailable' | 'artifact_verification_failed' | 'environment_fingerprint_unavailable' | 'workspace_write' | 'external_side_effect' | 'irreversible_side_effect' | 'not_cacheable_status' | 'store_unavailable' | 'entry_oversized' | 'corrupt';

ExecutionCacheReuseAssessment

Public type alias for Execution Cache Reuse Assessment; the declaration contains its complete type expression.

  • Kind: type
  • Import: import type { ExecutionCacheReuseAssessment } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export type ExecutionCacheReuseAssessment = {
    reusable: true;
} | {
    reusable: false;
    reason: ExecutionCacheReuseBlockReason;
};

ExecutionCacheReuseBlockReason

Public type alias for Execution Cache Reuse Block Reason; the declaration contains its complete type expression.

  • Kind: type
  • Import: import type { ExecutionCacheReuseBlockReason } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export type ExecutionCacheReuseBlockReason = 'environment_fingerprint_unavailable' | 'workspace_write' | 'external_side_effect' | 'irreversible_side_effect';

ExecutionEnvironmentFingerprintResolution

Public type alias for Execution Environment Fingerprint Resolution; the declaration contains its complete type expression.

  • Kind: type
  • Import: import type { ExecutionEnvironmentFingerprintResolution } from '@codesoul-co/hypha-core';
  • Source module: contracts/execution-cache

Declaration

text
export type ExecutionEnvironmentFingerprintResolution = {
    status: 'resolved';
    fingerprint: ExecutionEnvironmentFingerprint;
} | {
    status: 'unavailable';
    reason: string;
};