@codesoul-co/hypha-core / contracts/workspace

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/contracts/workspace.ts
• Exports: 39

Using this module

Use the Workspace module for declaring and runtime-validating contracts. It exports 30 interfaces, 9 types.

Import from the package entrypoint

import type {
  FileMutation,
  ResolvedWorkspacePath,
  WorkspaceCleanupPolicySpec,
  WorkspaceDeleteRequest,
  WorkspaceDiffRequest,
  WorkspaceDiffResult,
  WorkspaceDiffSummary,
  WorkspaceDirectorySpec,
} from '@codesoul-co/hypha-core';

// The complete export list is documented below.

Usage patterns

• Use the 39 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

Symbol	Kind	Signature	Description
FileMutation	interface	interface FileMutation	File Mutation interface with 9 public fields or methods.
ResolvedWorkspacePath	interface	interface ResolvedWorkspacePath	Resolved Workspace Path interface with 8 public fields or methods.
WorkspaceCleanupPolicySpec	interface	interface WorkspaceCleanupPolicySpec	Workspace Cleanup Policy Spec interface with 6 public fields or methods.
WorkspaceDeleteRequest	interface	interface WorkspaceDeleteRequest	Workspace Delete Request interface with 7 public fields or methods.
WorkspaceDiffRequest	interface	interface WorkspaceDiffRequest	Workspace Diff Request interface with 6 public fields or methods.
WorkspaceDiffResult	interface	interface WorkspaceDiffResult	Workspace Diff Result interface with 5 public fields or methods.
WorkspaceDiffSummary	interface	interface WorkspaceDiffSummary	Workspace Diff Summary interface with 7 public fields or methods.
WorkspaceDirectorySpec	interface	interface WorkspaceDirectorySpec	Workspace Directory Spec interface with 9 public fields or methods.
WorkspaceEventPayload	interface	interface WorkspaceEventPayload	Workspace Event Payload interface with 12 public fields or methods.
WorkspaceFileEntry	interface	interface WorkspaceFileEntry	Workspace File Entry interface with 6 public fields or methods.
WorkspaceListRequest	interface	interface WorkspaceListRequest	Workspace List Request interface with 7 public fields or methods.
WorkspaceMutationPolicySpec	interface	interface WorkspaceMutationPolicySpec	Workspace Mutation Policy Spec interface with 7 public fields or methods.
WorkspacePatchConflict	interface	interface WorkspacePatchConflict	Workspace Patch Conflict interface with 4 public fields or methods.
WorkspacePatchRequest	interface	interface WorkspacePatchRequest	Workspace Patch Request interface with 8 public fields or methods.
WorkspacePatchResult	interface	interface WorkspacePatchResult	Workspace Patch Result interface with 5 public fields or methods.
WorkspacePathPolicySpec	interface	interface WorkspacePathPolicySpec	Workspace Path Policy Spec interface with 12 public fields or methods.
WorkspacePathRequest	interface	interface WorkspacePathRequest	Workspace Path Request interface with 5 public fields or methods.
WorkspaceQuotaSpec	interface	interface WorkspaceQuotaSpec	Workspace Quota Spec interface with 6 public fields or methods.
WorkspaceReadRequest	interface	interface WorkspaceReadRequest	Workspace Read Request interface with 7 public fields or methods.
WorkspaceReadResult	interface	interface WorkspaceReadResult	Workspace Read Result interface with 7 public fields or methods.
WorkspaceRecord	interface	interface WorkspaceRecord	Workspace Record interface with 22 public fields or methods.
WorkspaceRestoreRequest	interface	interface WorkspaceRestoreRequest	Workspace Restore Request interface with 6 public fields or methods.
WorkspaceSnapshotEntry	interface	interface WorkspaceSnapshotEntry	Workspace Snapshot Entry interface with 7 public fields or methods.
WorkspaceSnapshotManifest	interface	interface WorkspaceSnapshotManifest	Workspace Snapshot Manifest interface with 12 public fields or methods.
WorkspaceSnapshotPolicySpec	interface	interface WorkspaceSnapshotPolicySpec	Workspace Snapshot Policy Spec interface with 6 public fields or methods.
WorkspaceSnapshotRequest	interface	interface WorkspaceSnapshotRequest	Workspace Snapshot Request interface with 10 public fields or methods.
WorkspaceSpec	interface	interface WorkspaceSpec extends VersionedSpec, SpecMetadata	Workspace Spec interface with 21 public fields or methods.
WorkspaceUsage	interface	interface WorkspaceUsage	Workspace Usage interface with 4 public fields or methods.
WorkspaceWriteRequest	interface	interface WorkspaceWriteRequest	Workspace Write Request interface with 10 public fields or methods.
WorkspaceWriteResult	interface	interface WorkspaceWriteResult	Workspace Write Result interface with 6 public fields or methods.
WorkspaceEntryKind	type	type WorkspaceEntryKind = 'file' | 'directory' | 'symlink' | 'other'	Public type alias for Workspace Entry Kind; the declaration contains its complete type expression.
WorkspaceEventCreateInput	type	type WorkspaceEventCreateInput = Omit<EventCreateInput<WorkspaceEventPayloadMap[TType]>, 'type' | 'workspaceId'> & { type: TType; workspaceId: string; }	Public type alias for Workspace Event Create Input; the declaration contains its complete type expression.
WorkspaceEventPayloadMap	type	type WorkspaceEventPayloadMap = { 'workspace.create.requested': WorkspaceEventPayloadWithRequired<'operationId' | 'profileRef'>; 'workspace.created': WorkspaceEventPayloadWithRequired<'operationId' | 'profileRef' | 'status'>; 'workspace.ready': WorkspaceStatusEventPayload<'ready'>; 'workspace.busy': WorkspaceStatusEventPayload<'busy'>; 'workspace.path.resolved': WorkspaceEventPayloadWithRequired<'operationId'>; 'w...	Public type alias for Workspace Event Payload Map; the declaration contains its complete type expression.
WorkspaceFrameworkEvent	type	type WorkspaceFrameworkEvent = Omit<FrameworkEvent<WorkspaceEventPayloadMap[TType]>, 'type' | 'workspaceId'> & { type: TType; workspaceId: string; }	Public type alias for Workspace Framework Event; the declaration contains its complete type expression.
WorkspaceFrameworkEventType	type	type WorkspaceFrameworkEventType = 'workspace.create.requested' | 'workspace.created' | 'workspace.ready' | 'workspace.busy' | 'workspace.path.resolved' | 'workspace.path.denied' | 'workspace.quota.exceeded' | 'workspace.snapshot.requested' | 'workspace.snapshot.created' | 'workspace.snapshot.failed' | 'workspace.restore.requested' | 'workspace.restored' | 'workspace.restore.failed' | 'workspace.patch.checked' | '...	Public type alias for Workspace Framework Event Type; the declaration contains its complete type expression.
WorkspacePathOperation	type	type WorkspacePathOperation = 'read' | 'write' | 'execute' | 'delete' | 'list'	Public type alias for Workspace Path Operation; the declaration contains its complete type expression.
WorkspacePermission	type	type WorkspacePermission = 'read' | 'write' | 'execute' | 'delete'	Public type alias for Workspace Permission; the declaration contains its complete type expression.
WorkspaceSnapshotType	type	type WorkspaceSnapshotType = 'full' | 'incremental' | 'manifest_only' | 'failure_snapshot'	Public type alias for Workspace Snapshot Type; the declaration contains its complete type expression.
WorkspaceStatus	type	type WorkspaceStatus = 'creating' | 'ready' | 'busy' | 'snapshotting' | 'archiving' | 'archived' | 'cleaning' | 'cleaned' | 'failed'	Public type alias for Workspace Status; the declaration contains its complete type expression.

FileMutation

File Mutation interface with 9 public fields or methods.

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

Declaration

export interface FileMutation {
    path: string;
    operation: 'created' | 'modified' | 'deleted' | 'renamed' | 'permission_changed';
    beforeHash?: string;
    afterHash?: string;
    beforeSizeBytes?: number;
    afterSizeBytes?: number;
    artifactRef?: string;
    oldPath?: string;
    detectedAt: string;
}

Contract members

Member	Kind	Signature	Description
afterHash	property	afterHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
afterSizeBytes	property	afterSizeBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
artifactRef	property	artifactRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
beforeHash	property	beforeHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
beforeSizeBytes	property	beforeSizeBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
detectedAt	property	detectedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
oldPath	property	oldPath?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operation	property	operation: "created" | "deleted" | "modified" | "renamed" | "permission_changed"	Public property; its type, readonly modifier and optionality are shown in the signature.
path	property	path: string	Public property; its type, readonly modifier and optionality are shown in the signature.

ResolvedWorkspacePath

Resolved Workspace Path interface with 8 public fields or methods.

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

Declaration

export interface ResolvedWorkspacePath {
    workspaceId: string;
    relativePath: string;
    canonicalRelativePath: string;
    pathRef: string;
    exists: boolean;
    kind?: WorkspaceEntryKind;
    permissions: WorkspacePermission[];
    contentHash?: string;
}

Contract members

Member	Kind	Signature	Description
canonicalRelativePath	property	canonicalRelativePath: string	Public property; its type, readonly modifier and optionality are shown in the signature.
contentHash	property	contentHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
exists	property	exists: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
kind	property	kind?: WorkspaceEntryKind	Public property; its type, readonly modifier and optionality are shown in the signature.
pathRef	property	pathRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
permissions	property	permissions: WorkspacePermission[]	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: 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.

WorkspaceCleanupPolicySpec

Workspace Cleanup Policy Spec interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceCleanupPolicySpec {
    mode: 'on_run_end' | 'on_success' | 'after_ttl' | 'retain' | 'manual';
    ttlSeconds?: number;
    retainOnFailure?: boolean;
    retainSnapshots?: boolean;
    secureDelete?: boolean;
    archiveBeforeDelete?: boolean;
}

Contract members

Member	Kind	Signature	Description
archiveBeforeDelete	property	archiveBeforeDelete?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "on_run_end" | "on_success" | "after_ttl" | "retain" | "manual"	Public property; its type, readonly modifier and optionality are shown in the signature.
retainOnFailure	property	retainOnFailure?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
retainSnapshots	property	retainSnapshots?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
secureDelete	property	secureDelete?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
ttlSeconds	property	ttlSeconds?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceDeleteRequest

Workspace Delete Request interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceDeleteRequest {
    operationId: string;
    workspaceId: string;
    principal: ExecutionPrincipal;
    relativePath: string;
    recursive?: boolean;
    expectedContentHash?: string;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
expectedContentHash	property	expectedContentHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
recursive	property	recursive?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: 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.

WorkspaceDiffRequest

Workspace Diff Request interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceDiffRequest {
    operationId: string;
    workspaceId: string;
    principal: ExecutionPrincipal;
    fromSnapshotRef: string;
    toSnapshotRef?: string;
    createPatchArtifact?: boolean;
}

Contract members

Member	Kind	Signature	Description
createPatchArtifact	property	createPatchArtifact?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
fromSnapshotRef	property	fromSnapshotRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
toSnapshotRef	property	toSnapshotRef?: 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.

WorkspaceDiffResult

Workspace Diff Result interface with 5 public fields or methods.

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

Declaration

export interface WorkspaceDiffResult {
    fromSnapshotRef: string;
    toSnapshotRef?: string;
    mutations: FileMutation[];
    patchArtifactRef?: string;
    summary: WorkspaceDiffSummary;
}

Contract members

Member	Kind	Signature	Description
fromSnapshotRef	property	fromSnapshotRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
mutations	property	mutations: FileMutation[]	Public property; its type, readonly modifier and optionality are shown in the signature.
patchArtifactRef	property	patchArtifactRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
summary	property	summary: WorkspaceDiffSummary	Public property; its type, readonly modifier and optionality are shown in the signature.
toSnapshotRef	property	toSnapshotRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceDiffSummary

Workspace Diff Summary interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceDiffSummary {
    created: number;
    modified: number;
    deleted: number;
    renamed: number;
    permissionChanged: number;
    bytesAdded: number;
    bytesRemoved: number;
}

Contract members

Member	Kind	Signature	Description
bytesAdded	property	bytesAdded: number	Public property; its type, readonly modifier and optionality are shown in the signature.
bytesRemoved	property	bytesRemoved: number	Public property; its type, readonly modifier and optionality are shown in the signature.
created	property	created: number	Public property; its type, readonly modifier and optionality are shown in the signature.
deleted	property	deleted: number	Public property; its type, readonly modifier and optionality are shown in the signature.
modified	property	modified: number	Public property; its type, readonly modifier and optionality are shown in the signature.
permissionChanged	property	permissionChanged: number	Public property; its type, readonly modifier and optionality are shown in the signature.
renamed	property	renamed: number	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceDirectorySpec

Workspace Directory Spec interface with 9 public fields or methods.

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

Declaration

export interface WorkspaceDirectorySpec {
    inputs: string;
    source: string;
    working: string;
    outputs: string;
    logs: string;
    temp: string;
    snapshots: string;
    artifacts?: string;
    cache?: string;
}

Contract members

Member	Kind	Signature	Description
artifacts	property	artifacts?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
cache	property	cache?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
inputs	property	inputs: string	Public property; its type, readonly modifier and optionality are shown in the signature.
logs	property	logs: string	Public property; its type, readonly modifier and optionality are shown in the signature.
outputs	property	outputs: string	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshots	property	snapshots: string	Public property; its type, readonly modifier and optionality are shown in the signature.
source	property	source: string	Public property; its type, readonly modifier and optionality are shown in the signature.
temp	property	temp: string	Public property; its type, readonly modifier and optionality are shown in the signature.
working	property	working: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceEventPayload

Workspace Event Payload interface with 12 public fields or methods.

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

Declaration

export interface WorkspaceEventPayload {
    operationId?: string;
    workspaceId: string;
    profileRef?: SpecRef;
    status?: WorkspaceStatus;
    sourceTreeHash?: string;
    workspaceSnapshotHash?: string;
    snapshotManifestHash?: string;
    artifactRefs?: string[];
    bytes?: number;
    files?: number;
    error?: NormalizedExecutionError;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
artifactRefs	property	artifactRefs?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
bytes	property	bytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
error	property	error?: NormalizedExecutionError	Public property; its type, readonly modifier and optionality are shown in the signature.
files	property	files?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshotManifestHash	property	snapshotManifestHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceTreeHash	property	sourceTreeHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
status	property	status?: WorkspaceStatus	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.
workspaceSnapshotHash	property	workspaceSnapshotHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceFileEntry

Workspace File Entry interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceFileEntry {
    relativePath: string;
    kind: WorkspaceEntryKind;
    sizeBytes?: number;
    contentHash?: string;
    modifiedAt?: string;
    permissions?: WorkspacePermission[];
}

Contract members

Member	Kind	Signature	Description
contentHash	property	contentHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
kind	property	kind: WorkspaceEntryKind	Public property; its type, readonly modifier and optionality are shown in the signature.
modifiedAt	property	modifiedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
permissions	property	permissions?: WorkspacePermission[]	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sizeBytes	property	sizeBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceListRequest

Workspace List Request interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceListRequest {
    workspaceId: string;
    principal: ExecutionPrincipal;
    relativePath?: string;
    recursive?: boolean;
    includeHidden?: boolean;
    maxEntries?: number;
    cursor?: string;
}

Contract members

Member	Kind	Signature	Description
cursor	property	cursor?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
includeHidden	property	includeHidden?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
maxEntries	property	maxEntries?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
recursive	property	recursive?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath?: 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.

WorkspaceMutationPolicySpec

Workspace Mutation Policy Spec interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceMutationPolicySpec {
    requireSnapshotBeforeWrite?: boolean;
    trackFileMutations?: boolean;
    maxPatchBytes?: number;
    allowDelete?: boolean;
    requireApprovalForDelete?: boolean;
    preserveInputFiles?: boolean;
    atomicWrite?: boolean;
}

Contract members

Member	Kind	Signature	Description
allowDelete	property	allowDelete?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
atomicWrite	property	atomicWrite?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
maxPatchBytes	property	maxPatchBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
preserveInputFiles	property	preserveInputFiles?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
requireApprovalForDelete	property	requireApprovalForDelete?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
requireSnapshotBeforeWrite	property	requireSnapshotBeforeWrite?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
trackFileMutations	property	trackFileMutations?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspacePatchConflict

Workspace Patch Conflict interface with 4 public fields or methods.

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

Declaration

export interface WorkspacePatchConflict {
    path: string;
    reason: string;
    expectedHash?: string;
    actualHash?: string;
}

Contract members

Member	Kind	Signature	Description
actualHash	property	actualHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
expectedHash	property	expectedHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
path	property	path: string	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspacePatchRequest

Workspace Patch Request interface with 8 public fields or methods.

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

Declaration

export interface WorkspacePatchRequest {
    operationId: string;
    workspaceId: string;
    principal: ExecutionPrincipal;
    patchArtifactRef: string;
    expectedBaseSnapshotHash?: string;
    mode: 'check' | 'apply';
    conflictPolicy: 'fail' | 'three_way' | 'mark_conflicts';
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
conflictPolicy	property	conflictPolicy: "fail" | "three_way" | "mark_conflicts"	Public property; its type, readonly modifier and optionality are shown in the signature.
expectedBaseSnapshotHash	property	expectedBaseSnapshotHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "check" | "apply"	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
patchArtifactRef	property	patchArtifactRef: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	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.

WorkspacePatchResult

Workspace Patch Result interface with 5 public fields or methods.

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

Declaration

export interface WorkspacePatchResult {
    checked: boolean;
    applied: boolean;
    conflicts: WorkspacePatchConflict[];
    mutations: FileMutation[];
    resultingWorkspaceSnapshotHash?: string;
}

Contract members

Member	Kind	Signature	Description
applied	property	applied: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
checked	property	checked: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
conflicts	property	conflicts: WorkspacePatchConflict[]	Public property; its type, readonly modifier and optionality are shown in the signature.
mutations	property	mutations: FileMutation[]	Public property; its type, readonly modifier and optionality are shown in the signature.
resultingWorkspaceSnapshotHash	property	resultingWorkspaceSnapshotHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspacePathPolicySpec

Workspace Path Policy Spec interface with 12 public fields or methods.

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

Declaration

export interface WorkspacePathPolicySpec {
    /** Read permission only. Exact or descendant deny rules always take precedence. */
    readOnlyPaths?: string[];
    /** Write permission only. Exact or descendant deny rules always take precedence. */
    writablePaths?: string[];
    /** Execute permission only. Exact or descendant deny rules always take precedence. */
    executablePaths?: string[];
    /** Final deny boundary; it cannot be widened by any allow list. */
    deniedPaths?: string[];
    allowSymlinks?: boolean;
    allowHardLinks?: boolean;
    followSymlinksForRead?: boolean;
    allowHiddenFiles?: boolean;
    maxPathLength?: number;
    allowedExtensions?: string[];
    deniedExtensions?: string[];
    caseSensitivity?: 'platform' | 'sensitive' | 'insensitive';
}

Contract members

Member	Kind	Signature	Description
allowedExtensions	property	allowedExtensions?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
allowHardLinks	property	allowHardLinks?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
allowHiddenFiles	property	allowHiddenFiles?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
allowSymlinks	property	allowSymlinks?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
caseSensitivity	property	caseSensitivity?: "platform" | "sensitive" | "insensitive"	Public property; its type, readonly modifier and optionality are shown in the signature.
deniedExtensions	property	deniedExtensions?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
deniedPaths	property	deniedPaths?: string[]	Final deny boundary; it cannot be widened by any allow list.
executablePaths	property	executablePaths?: string[]	Execute permission only. Exact or descendant deny rules always take precedence.
followSymlinksForRead	property	followSymlinksForRead?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
maxPathLength	property	maxPathLength?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
readOnlyPaths	property	readOnlyPaths?: string[]	Read permission only. Exact or descendant deny rules always take precedence.
writablePaths	property	writablePaths?: string[]	Write permission only. Exact or descendant deny rules always take precedence.

WorkspacePathRequest

Workspace Path Request interface with 5 public fields or methods.

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

Declaration

export interface WorkspacePathRequest {
    workspaceId: string;
    principal: ExecutionPrincipal;
    relativePath: string;
    operation: WorkspacePathOperation;
    allowMissing?: boolean;
}

Contract members

Member	Kind	Signature	Description
allowMissing	property	allowMissing?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
operation	property	operation: WorkspacePathOperation	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: 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.

WorkspaceQuotaSpec

Workspace Quota Spec interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceQuotaSpec {
    maxBytes?: number;
    maxFiles?: number;
    maxSingleFileBytes?: number;
    maxDirectoryDepth?: number;
    maxOpenFiles?: number;
    maxMutationCountPerExecution?: number;
}

Contract members

Member	Kind	Signature	Description
maxBytes	property	maxBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxDirectoryDepth	property	maxDirectoryDepth?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxFiles	property	maxFiles?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxMutationCountPerExecution	property	maxMutationCountPerExecution?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxOpenFiles	property	maxOpenFiles?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxSingleFileBytes	property	maxSingleFileBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceReadRequest

Workspace Read Request interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceReadRequest {
    workspaceId: string;
    principal: ExecutionPrincipal;
    relativePath: string;
    encoding?: 'utf8' | 'base64';
    offset?: number;
    length?: number;
    maxBytes?: number;
}

Contract members

Member	Kind	Signature	Description
encoding	property	encoding?: "utf8" | "base64"	Public property; its type, readonly modifier and optionality are shown in the signature.
length	property	length?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
maxBytes	property	maxBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
offset	property	offset?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: 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.

WorkspaceReadResult

Workspace Read Result interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceReadResult {
    relativePath: string;
    encoding: 'utf8' | 'base64';
    content: string;
    contentHash: string;
    sizeBytes: number;
    truncated?: boolean;
    nextOffset?: number;
}

Contract members

Member	Kind	Signature	Description
content	property	content: string	Public property; its type, readonly modifier and optionality are shown in the signature.
contentHash	property	contentHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
encoding	property	encoding: "utf8" | "base64"	Public property; its type, readonly modifier and optionality are shown in the signature.
nextOffset	property	nextOffset?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sizeBytes	property	sizeBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
truncated	property	truncated?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceRecord

Workspace Record interface with 22 public fields or methods.

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

Declaration

export interface WorkspaceRecord {
    id: string;
    revision: number;
    tenantId?: string;
    userId: string;
    sessionId?: string;
    runId?: string;
    agentId?: string;
    profileRef: SpecRef;
    profileRevision: string;
    rootPathRef: string;
    status: WorkspaceStatus;
    quota: WorkspaceQuotaSpec;
    usage: WorkspaceUsage;
    activeExecutionIds: string[];
    latestSnapshotRef?: string;
    createdAt: string;
    readyAt?: string;
    updatedAt: string;
    expiresAt?: string;
    cleanedAt?: string;
    error?: NormalizedExecutionError;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
activeExecutionIds	property	activeExecutionIds: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
agentId	property	agentId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
cleanedAt	property	cleanedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
error	property	error?: NormalizedExecutionError	Public property; its type, readonly modifier and optionality are shown in the signature.
expiresAt	property	expiresAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
latestSnapshotRef	property	latestSnapshotRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRef	property	profileRef: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
profileRevision	property	profileRevision: string	Public property; its type, readonly modifier and optionality are shown in the signature.
quota	property	quota: WorkspaceQuotaSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
readyAt	property	readyAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
revision	property	revision: number	Public property; its type, readonly modifier and optionality are shown in the signature.
rootPathRef	property	rootPathRef: string	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.
status	property	status: WorkspaceStatus	Public property; its type, readonly modifier and optionality are shown in the signature.
tenantId	property	tenantId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
usage	property	usage: WorkspaceUsage	Public property; its type, readonly modifier and optionality are shown in the signature.
userId	property	userId: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceRestoreRequest

Workspace Restore Request interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceRestoreRequest {
    operationId: string;
    workspaceId: string;
    principal: ExecutionPrincipal;
    snapshotRef: string;
    expectedWorkspaceSnapshotHash?: string;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
expectedWorkspaceSnapshotHash	property	expectedWorkspaceSnapshotHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshotRef	property	snapshotRef: 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.

WorkspaceSnapshotEntry

Workspace Snapshot Entry interface with 7 public fields or methods.

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

Declaration

export interface WorkspaceSnapshotEntry {
    path: string;
    kind: 'file' | 'directory' | 'symlink';
    sizeBytes?: number;
    contentHash?: string;
    mode?: number;
    /** Required only for symlink entries; always Workspace-relative. */
    symlinkTarget?: string;
    artifactRef?: string;
}

Contract members

Member	Kind	Signature	Description
artifactRef	property	artifactRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
contentHash	property	contentHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
kind	property	kind: "file" | "directory" | "symlink"	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
path	property	path: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sizeBytes	property	sizeBytes?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
symlinkTarget	property	symlinkTarget?: string	Required only for symlink entries; always Workspace-relative.

WorkspaceSnapshotManifest

Workspace Snapshot Manifest interface with 12 public fields or methods.

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

Declaration

export interface WorkspaceSnapshotManifest {
    id: string;
    workspaceId: string;
    baseSnapshotId?: string;
    entries: WorkspaceSnapshotEntry[];
    ignoredPatterns?: string[];
    sourceTreeHash: string;
    manifestHash: string;
    totalBytes: number;
    fileCount: number;
    createdAt: string;
    createdBy: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
baseSnapshotId	property	baseSnapshotId?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.
createdBy	property	createdBy: string	Public property; its type, readonly modifier and optionality are shown in the signature.
entries	property	entries: WorkspaceSnapshotEntry[]	Public property; its type, readonly modifier and optionality are shown in the signature.
fileCount	property	fileCount: number	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
ignoredPatterns	property	ignoredPatterns?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
manifestHash	property	manifestHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
sourceTreeHash	property	sourceTreeHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
totalBytes	property	totalBytes: number	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.

WorkspaceSnapshotPolicySpec

Workspace Snapshot Policy Spec interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceSnapshotPolicySpec {
    enabled: boolean;
    mode: 'full' | 'incremental' | 'manifest_only';
    snapshotBeforeWrite?: boolean;
    snapshotAfterExecution?: boolean;
    snapshotOnFailure?: boolean;
    maxSnapshots?: number;
}

Contract members

Member	Kind	Signature	Description
enabled	property	enabled: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
maxSnapshots	property	maxSnapshots?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "full" | "incremental" | "manifest_only"	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshotAfterExecution	property	snapshotAfterExecution?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshotBeforeWrite	property	snapshotBeforeWrite?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshotOnFailure	property	snapshotOnFailure?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceSnapshotRequest

Workspace Snapshot Request interface with 10 public fields or methods.

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

Declaration

export interface WorkspaceSnapshotRequest {
    operationId: string;
    workspaceId: string;
    principal: ExecutionPrincipal;
    type: WorkspaceSnapshotType;
    baseSnapshotRef?: string;
    includePaths?: string[];
    excludePatterns?: string[];
    reason?: string;
    idempotencyKey?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
baseSnapshotRef	property	baseSnapshotRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
excludePatterns	property	excludePatterns?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
includePaths	property	includePaths?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
reason	property	reason?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
type	property	type: WorkspaceSnapshotType	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.

WorkspaceSpec

Workspace Spec interface with 21 public fields or methods.

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

Declaration

export interface WorkspaceSpec extends VersionedSpec, SpecMetadata {
    revision?: string;
    rootPolicy: 'managed' | 'provided_ref';
    rootRef?: string;
    directories: WorkspaceDirectorySpec;
    pathPolicy: WorkspacePathPolicySpec;
    quota: WorkspaceQuotaSpec;
    cleanup: WorkspaceCleanupPolicySpec;
    snapshot: WorkspaceSnapshotPolicySpec;
    mutation: WorkspaceMutationPolicySpec;
    executionEnvironmentRef?: SpecRef;
    artifactProfileRef?: SpecRef;
    secretPolicyRef?: SpecRef;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
artifactProfileRef	property	artifactProfileRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
cleanup	property	cleanup: WorkspaceCleanupPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
createdAt	property	createdAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
description	property	description?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
directories	property	directories: WorkspaceDirectorySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
executionEnvironmentRef	property	executionEnvironmentRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
id	property	id: string	Public property; its type, readonly modifier and optionality are shown in the signature.
metadata	property	metadata?: Record<string, unknown>	Public property; its type, readonly modifier and optionality are shown in the signature.
mutation	property	mutation: WorkspaceMutationPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
name	property	name?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
owner	property	owner?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
pathPolicy	property	pathPolicy: WorkspacePathPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
quota	property	quota: WorkspaceQuotaSpec	Public property; its type, readonly modifier and optionality are shown in the signature.
revision	property	revision?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
rootPolicy	property	rootPolicy: "managed" | "provided_ref"	Public property; its type, readonly modifier and optionality are shown in the signature.
rootRef	property	rootRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
secretPolicyRef	property	secretPolicyRef?: SpecRef	Public property; its type, readonly modifier and optionality are shown in the signature.
snapshot	property	snapshot: WorkspaceSnapshotPolicySpec	Public property; its type, readonly modifier and optionality are shown in the signature.
tags	property	tags?: string[]	Public property; its type, readonly modifier and optionality are shown in the signature.
updatedAt	property	updatedAt?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
version	property	version: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceUsage

Workspace Usage interface with 4 public fields or methods.

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

Declaration

export interface WorkspaceUsage {
    bytes: number;
    files: number;
    directories?: number;
    lastCalculatedAt: string;
}

Contract members

Member	Kind	Signature	Description
bytes	property	bytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.
directories	property	directories?: number	Public property; its type, readonly modifier and optionality are shown in the signature.
files	property	files: number	Public property; its type, readonly modifier and optionality are shown in the signature.
lastCalculatedAt	property	lastCalculatedAt: string	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceWriteRequest

Workspace Write Request interface with 10 public fields or methods.

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

Declaration

export interface WorkspaceWriteRequest {
    operationId: string;
    workspaceId: string;
    principal: ExecutionPrincipal;
    relativePath: string;
    content?: string | Uint8Array;
    artifactRef?: string;
    mode: 'create' | 'overwrite' | 'append' | 'atomic_replace';
    expectedContentHash?: string;
    createParents?: boolean;
    idempotencyKey?: string;
}

Contract members

Member	Kind	Signature	Description
artifactRef	property	artifactRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
content	property	content?: string | Uint8Array<ArrayBufferLike>	Public property; its type, readonly modifier and optionality are shown in the signature.
createParents	property	createParents?: boolean	Public property; its type, readonly modifier and optionality are shown in the signature.
expectedContentHash	property	expectedContentHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
idempotencyKey	property	idempotencyKey?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
mode	property	mode: "create" | "overwrite" | "append" | "atomic_replace"	Public property; its type, readonly modifier and optionality are shown in the signature.
operationId	property	operationId: string	Public property; its type, readonly modifier and optionality are shown in the signature.
principal	property	principal: ExecutionPrincipal	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: 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.

WorkspaceWriteResult

Workspace Write Result interface with 6 public fields or methods.

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

Declaration

export interface WorkspaceWriteResult {
    relativePath: string;
    beforeHash?: string;
    afterHash: string;
    sizeBytes: number;
    mutation: FileMutation;
    artifactRef?: string;
}

Contract members

Member	Kind	Signature	Description
afterHash	property	afterHash: string	Public property; its type, readonly modifier and optionality are shown in the signature.
artifactRef	property	artifactRef?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
beforeHash	property	beforeHash?: string	Public property; its type, readonly modifier and optionality are shown in the signature.
mutation	property	mutation: FileMutation	Public property; its type, readonly modifier and optionality are shown in the signature.
relativePath	property	relativePath: string	Public property; its type, readonly modifier and optionality are shown in the signature.
sizeBytes	property	sizeBytes: number	Public property; its type, readonly modifier and optionality are shown in the signature.

WorkspaceEntryKind

Public type alias for Workspace Entry Kind; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceEntryKind = 'file' | 'directory' | 'symlink' | 'other';

WorkspaceEventCreateInput

Public type alias for Workspace Event Create Input; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceEventCreateInput<TType extends WorkspaceFrameworkEventType = WorkspaceFrameworkEventType> = Omit<EventCreateInput<WorkspaceEventPayloadMap[TType]>, 'type' | 'workspaceId'> & {
    type: TType;
    workspaceId: string;
};

WorkspaceEventPayloadMap

Public type alias for Workspace Event Payload Map; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceEventPayloadMap = {
    'workspace.create.requested': WorkspaceEventPayloadWithRequired<'operationId' | 'profileRef'>;
    'workspace.created': WorkspaceEventPayloadWithRequired<'operationId' | 'profileRef' | 'status'>;
    'workspace.ready': WorkspaceStatusEventPayload<'ready'>;
    'workspace.busy': WorkspaceStatusEventPayload<'busy'>;
    'workspace.path.resolved': WorkspaceEventPayloadWithRequired<'operationId'>;
    'workspace.path.denied': WorkspaceEventPayloadWithRequired<'operationId' | 'error'>;
    'workspace.quota.exceeded': WorkspaceQuotaExceededEventPayload;
    'workspace.snapshot.requested': WorkspaceEventPayloadWithRequired<'operationId'>;
    'workspace.snapshot.created': WorkspaceEventPayloadWithRequired<'operationId' | 'snapshotManifestHash' | 'artifactRefs'>;
    'workspace.snapshot.failed': WorkspaceEventPayloadWithRequired<'operationId' | 'error'>;
    'workspace.restore.requested': WorkspaceEventPayloadWithRequired<'operationId' | 'artifactRefs'>;
    'workspace.restored': WorkspaceEventPayloadWithRequired<'operationId' | 'workspaceSnapshotHash'>;
    'workspace.restore.failed': WorkspaceEventPayloadWithRequired<'operationId' | 'error'>;
    'workspace.patch.checked': WorkspaceEventPayloadWithRequired<'operationId'>;
    'workspace.patch.applied': WorkspaceEventPayloadWithRequired<'operationId' | 'workspaceSnapshotHash'>;
    'workspace.patch.conflict': WorkspaceEventPayloadWithRequired<'operationId'>;
    'workspace.cleanup.started': WorkspaceEventPayloadWithRequired<'operationId'>;
    'workspace.cleanup.completed': WorkspaceEventPayloadWithRequired<'operationId'>;
    'workspace.cleanup.failed': WorkspaceEventPayloadWithRequired<'operationId' | 'error'>;
};

WorkspaceFrameworkEvent

Public type alias for Workspace Framework Event; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceFrameworkEvent<TType extends WorkspaceFrameworkEventType = WorkspaceFrameworkEventType> = Omit<FrameworkEvent<WorkspaceEventPayloadMap[TType]>, 'type' | 'workspaceId'> & {
    type: TType;
    workspaceId: string;
};

WorkspaceFrameworkEventType

Public type alias for Workspace Framework Event Type; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceFrameworkEventType = 'workspace.create.requested' | 'workspace.created' | 'workspace.ready' | 'workspace.busy' | 'workspace.path.resolved' | 'workspace.path.denied' | 'workspace.quota.exceeded' | 'workspace.snapshot.requested' | 'workspace.snapshot.created' | 'workspace.snapshot.failed' | 'workspace.restore.requested' | 'workspace.restored' | 'workspace.restore.failed' | 'workspace.patch.checked' | 'workspace.patch.applied' | 'workspace.patch.conflict' | 'workspace.cleanup.started' | 'workspace.cleanup.completed' | 'workspace.cleanup.failed';

WorkspacePathOperation

Public type alias for Workspace Path Operation; the declaration contains its complete type expression.

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

Declaration

export type WorkspacePathOperation = 'read' | 'write' | 'execute' | 'delete' | 'list';

WorkspacePermission

Public type alias for Workspace Permission; the declaration contains its complete type expression.

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

Declaration

export type WorkspacePermission = 'read' | 'write' | 'execute' | 'delete';

WorkspaceSnapshotType

Public type alias for Workspace Snapshot Type; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceSnapshotType = 'full' | 'incremental' | 'manifest_only' | 'failure_snapshot';

WorkspaceStatus

Public type alias for Workspace Status; the declaration contains its complete type expression.

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

Declaration

export type WorkspaceStatus = 'creating' | 'ready' | 'busy' | 'snapshotting' | 'archiving' | 'archived' | 'cleaning' | 'cleaned' | 'failed';