`@codesoul-co/hypha-domain` / `index`

Package index: @codesoul-co/hypha-domain
Source: packages/domain/src/index.ts
Exports: 80

Using this module

Aggregates the public entrypoint exports for @codesoul-co/hypha-domain; applications import these symbols from the package entrypoint instead of internal file paths.

Import from the package entrypoint

import {
  DomainCompiler,
  DomainPackRegistry,
  LocalDomainPackLoader,
  WorkflowCompiler,
  businessRuleEffectSchema,
  businessRuleScopeSchema,
  businessRuleSpecDefinition,
  businessRuleSpecExample,
} from '@codesoul-co/hypha-domain';

import type {
  BusinessRuleSpec,
  DomainAgentPatch,
  DomainAgentPatchTarget,
  DomainBindingResolution,
  DomainCompilationAudit,
  DomainCompilationResult,
  DomainCompileOptions,
  DomainPackRegistryEntry,
} from '@codesoul-co/hypha-domain';

// The complete export list is documented below.

Usage patterns

Use the 33 type/interface exports as static contracts in application code, adapters, or tests. Import them with import type; they do not exist at runtime.
The module exposes 4 classes as constructable runtime implementations. Each symbol entry lists its constructor and public methods.
The module exposes 12 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
The 31 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Runtime validation example

import { businessRuleEffectSchema } from '@codesoul-co/hypha-domain';

declare function loadExternalInput(): unknown;
const input: unknown = loadExternalInput();
const parsed = businessRuleEffectSchema.parse(input);

Parse untrusted configuration, network, or persisted input with the runtime schema before passing it to functions or classes that expect a validated contract.

Public exports

Symbol	Kind	Signature	Description
`DomainCompiler`	class	`new DomainCompiler(): DomainCompiler`	Domain Compiler class with 2 public constructor or member entries; its exact declarations are listed below.
`DomainPackRegistry`	class	`new DomainPackRegistry(): DomainPackRegistry`	Domain Pack Registry class with 6 public constructor or member entries; its exact declarations are listed below.
`LocalDomainPackLoader`	class	`new LocalDomainPackLoader(options: LocalDomainPackLoaderOptions): LocalDomainPackLoader`	Local Domain Pack Loader class with 3 public constructor or member entries; its exact declarations are listed below.
`WorkflowCompiler`	class	`new WorkflowCompiler(): WorkflowCompiler`	Workflow Compiler class with 2 public constructor or member entries; its exact declarations are listed below.
`businessRuleEffectSchema`	constant	`const businessRuleEffectSchema: z.ZodEnum<["constraint", "precondition", "postcondition", "guidance"]>`	Runtime schema for Business Rule Effect.
`businessRuleScopeSchema`	constant	`const businessRuleScopeSchema: z.ZodEnum<["domain", "task", "workflow", "state", "tool", "memory", "output"]>`	Runtime schema for Business Rule Scope.
`businessRuleSpecDefinition`	constant	`const businessRuleSpecDefinition: SpecSchemaDefinition<BusinessRuleSpec>`	Runtime validation entrypoint for the Business Rule spec, combining its parser, example and JSON Schema.
`businessRuleSpecExample`	constant	`const businessRuleSpecExample: BusinessRuleSpec`	Valid example value for Business Rule Spec.
`businessRuleSpecJsonSchema`	constant	`const businessRuleSpecJsonSchema: JsonSchema`	JSON Schema for Business Rule Spec.
`businessRuleSpecSchema`	constant	`const businessRuleSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { scope: z.ZodEnum<["domain", "task", "workflow", "state", "tool", "memory", "outp...`	Runtime schema for Business Rule Spec.
`DOMAIN_COMPILER_VERSION`	constant	`const DOMAIN_COMPILER_VERSION: "1.0.0"`	DOMAIN COMPILER VERSION constant exported by the `index` module.
`domainAgenticReasoningModeSchema`	constant	`const domainAgenticReasoningModeSchema: z.ZodEnum<["react", "fsm_react", "tot", "critique"]>`	Runtime schema for Domain Agentic Reasoning Mode.
`domainPackSpecDefinition`	constant	`const domainPackSpecDefinition: SpecSchemaDefinition<DomainPackSpec>`	Runtime validation entrypoint for the Domain Pack spec, combining its parser, example and JSON Schema.
`domainPackSpecExample`	constant	`const domainPackSpecExample: DomainPackSpec`	Valid example value for Domain Pack Spec.
`domainPackSpecJsonSchema`	constant	`const domainPackSpecJsonSchema: JsonSchema`	JSON Schema for Domain Pack Spec.
`domainPackSpecSchema`	constant	`const domainPackSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { name: z.ZodString; taskSchemas: z.ZodArray<z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<...`	Runtime schema for Domain Pack Spec.
`domainPromptRefSchema`	constant	`const domainPromptRefSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; } & { required: z.ZodOptional<z.ZodBoolean>; priority: z.ZodOptional<z.ZodNumber>; }, "strip", z.ZodTypeAny, { id: string; version?: string \| undefined; revision?: string \| undefined; required?: boolean \| undefined; priority?: number \| undefined; }, { id: string; version?: string \|...`	Runtime schema for Domain Prompt Ref.
`domainReasoningPersistenceSchema`	constant	`const domainReasoningPersistenceSchema: z.ZodEnum<["summary_only", "events_only"]>`	Runtime schema for Domain Reasoning Persistence.
`domainSpecDefinitions`	constant	`const domainSpecDefinitions: readonly [SpecSchemaDefinition<WorkflowSpec>, SpecSchemaDefinition<ReasoningSpec>, SpecSchemaDefinition<BusinessRuleSpec>, SpecSchemaDefinition<DomainPackSpec>]`	Domain Spec Definitions constant exported by the `index` module.
`domainSpecJsonSchemas`	constant	`const domainSpecJsonSchemas: Record<string, JsonSchema>`	Domain Spec JSON Schemas constant exported by the `index` module.
`domainThinkingModeSchema`	constant	`const domainThinkingModeSchema: z.ZodEnum<["none", "summary", "structured"]>`	Runtime schema for Domain Thinking Mode.
`reasoningSpecDefinition`	constant	`const reasoningSpecDefinition: SpecSchemaDefinition<ReasoningSpec>`	Runtime validation entrypoint for the Reasoning spec, combining its parser, example and JSON Schema.
`reasoningSpecExample`	constant	`const reasoningSpecExample: ReasoningSpec`	Valid example value for Reasoning Spec.
`reasoningSpecJsonSchema`	constant	`const reasoningSpecJsonSchema: JsonSchema`	JSON Schema for Reasoning Spec.
`reasoningSpecSchema`	constant	`const reasoningSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { thinkingMode: z.ZodEnum<["none", "summary", "structured"]>; agenticMode: z.ZodEnum<...`	Runtime schema for Reasoning Spec.
`riskProfileSpecSchema`	constant	`const riskProfileSpecSchema: z.ZodObject<{ defaultRiskLevel: z.ZodEnum<["low", "medium", "high", "critical"]>; escalationPolicyRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { defaultRiskLevel: "low" \| "medium" \| "high" \| "critical"; escalationPolicyRef?: string \| undefined; }, { defaultRiskLevel: "low" \| "medium" \| "high" \| "critical"; escalationPolicyRef?: string \| undefined; }>`	Runtime schema for Risk Profile Spec.
`sessionProfileSpecSchema`	constant	`const sessionProfileSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { metadataSchema: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>...`	Runtime schema for Session Profile Spec.
`skillPolicyBindingSchema`	constant	`const skillPolicyBindingSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { skillRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; ...`	Runtime schema for Skill Policy Binding.
`taskSchemaSpecSchema`	constant	`const taskSchemaSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { taskType: z.ZodString; inputSchema: z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema...`	Runtime schema for Task Schema Spec.
`workflowSpecDefinition`	constant	`const workflowSpecDefinition: SpecSchemaDefinition<WorkflowSpec>`	Runtime validation entrypoint for the Workflow spec, combining its parser, example and JSON Schema.
`workflowSpecExample`	constant	`const workflowSpecExample: WorkflowSpec`	Valid example value for Workflow Spec.
`workflowSpecJsonSchema`	constant	`const workflowSpecJsonSchema: JsonSchema`	JSON Schema for Workflow Spec.
`workflowSpecSchema`	constant	`const workflowSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { initialState: z.ZodString; terminalStates: z.ZodArray<z.ZodString, "many">; states: ...`	Runtime schema for Workflow Spec.
`workflowStateSpecSchema`	constant	`const workflowStateSpecSchema: z.ZodObject<{ name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { id: z.ZodString; goal: z.ZodString; inputContract: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>; outputCon...`	Runtime schema for Workflow State Spec.
`workflowTransitionSpecSchema`	constant	`const workflowTransitionSpecSchema: z.ZodObject<{ from: z.ZodString; to: z.ZodString; guard: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { from: string; to: string; description?: string \| undefined; guard?: string \| undefined; }, { from: string; to: string; description?: string \| undefined; guard?: string \| undefined; }>`	Runtime schema for Workflow Transition Spec.
`applyDomainAgentPatch`	function	`applyDomainAgentPatch<TAgent extends DomainAgentPatchTarget>(agent: TAgent, patch: DomainAgentPatch): TAgent`	Apply Domain Agent Patch function with 1 public call signature; parameters and return types are listed below.
`compileDomainPackToHarnessedSystem`	function	`compileDomainPackToHarnessedSystem(input: DomainPackSpec, options: DomainCompileOptions): DomainCompilationResult`	Compile Domain Pack To Harnessed System function with 1 public call signature; parameters and return types are listed below.
`compileWorkflowToFSM`	function	`compileWorkflowToFSM(domainPack: DomainPackSpec, options?: WorkflowCompileOptions): FSMProcessSpec`	Compile Workflow To FSM function with 1 public call signature; parameters and return types are listed below.
`createWorkflowDependencySnapshot`	function	`createWorkflowDependencySnapshot(input: Omit<WorkflowDependencySnapshot, "dependencyHash">): WorkflowDependencySnapshot`	Create Workflow Dependency Snapshot function with 1 public call signature; parameters and return types are listed below.
`extendDomainPack`	function	`extendDomainPack(base: DomainPackSpec, overlay: DomainPackOverlay): DomainPackSpec`	Extend Domain Pack function with 1 public call signature; parameters and return types are listed below.
`initializeDomainSession`	function	`initializeDomainSession(domainPack: DomainPackSpec, options?: DomainSessionInitOptions): DomainSessionInitialization`	Initialize Domain Session function with 1 public call signature; parameters and return types are listed below.
`listLocalDomainPackFiles`	function	`listLocalDomainPackFiles(directory: string, recursive?: boolean, extensions?: string[]): Promise<string[]>`	List Local Domain Pack Files function with 1 public call signature; parameters and return types are listed below.
`loadDomainPackFile`	function	`loadDomainPackFile(filePath: string): Promise<DomainPackSpec>`	Load Domain Pack File function with 1 public call signature; parameters and return types are listed below.
`parseDomainPackDocument`	function	`parseDomainPackDocument(raw: string, filePath?: string): DomainPackSpec`	Parse Domain Pack Document function with 1 public call signature; parameters and return types are listed below.
`resolveWorkflowToolExecutionScope`	function	`resolveWorkflowToolExecutionScope(workflowStates: WorkflowStateBinding[], stateId: string): ToolExecutionScope`	Resolve Workflow Tool Execution Scope function with 1 public call signature; parameters and return types are listed below.
`validateDomainPackSpec`	function	`validateDomainPackSpec(input: unknown): DomainPackSpec`	Validate Domain Pack Spec function with 1 public call signature; parameters and return types are listed below.
`validateWorkflowSpec`	function	`validateWorkflowSpec(input: unknown): WorkflowSpec`	Validate Workflow Spec function with 1 public call signature; parameters and return types are listed below.
`BusinessRuleSpec`	interface	`interface BusinessRuleSpec extends VersionedSpec, SpecMetadata`	Business Rule Spec interface with 17 public fields or methods.
`DomainAgentPatch`	interface	`interface DomainAgentPatch`	Domain Agent Patch interface with 9 public fields or methods.
`DomainAgentPatchTarget`	interface	`interface DomainAgentPatchTarget`	Domain Agent Patch Target interface with 12 public fields or methods.
`DomainBindingResolution`	interface	`interface DomainBindingResolution`	Domain Binding Resolution interface with 23 public fields or methods.
`DomainCompilationAudit`	interface	`interface DomainCompilationAudit`	Domain Compilation Audit interface with 9 public fields or methods.
`DomainCompilationResult`	interface	`interface DomainCompilationResult`	Domain Compilation Result interface with 11 public fields or methods.
`DomainCompileOptions`	interface	`interface DomainCompileOptions`	Domain Compile Options interface with 20 public fields or methods.
`DomainPackRegistryEntry`	interface	`interface DomainPackRegistryEntry`	Domain Pack Registry Entry interface with 2 public fields or methods.
`DomainPackSpec`	interface	`interface DomainPackSpec extends VersionedSpec, SpecMetadata`	Domain Pack Spec interface with 31 public fields or methods.
`DomainPromptRef`	interface	`interface DomainPromptRef extends SpecRef`	Domain Prompt Ref interface with 5 public fields or methods.
`DomainSessionInitialization`	interface	`interface DomainSessionInitialization`	Domain Session Initialization interface with 10 public fields or methods.
`DomainSessionInitOptions`	interface	`interface DomainSessionInitOptions`	Domain Session Init Options interface with 2 public fields or methods.
`LocalDomainPackLoaderOptions`	interface	`interface LocalDomainPackLoaderOptions`	Local Domain Pack Loader Options interface with 3 public fields or methods.
`ReasoningSpec`	interface	`interface ReasoningSpec extends VersionedSpec, SpecMetadata`	Reasoning Spec interface with 16 public fields or methods.
`RiskProfileSpec`	interface	`interface RiskProfileSpec`	Risk Profile Spec interface with 2 public fields or methods.
`SessionProfileSpec`	interface	`interface SessionProfileSpec extends VersionedSpec, SpecMetadata`	Session Profile Spec interface with 17 public fields or methods.
`SkillPolicyBinding`	interface	`interface SkillPolicyBinding extends VersionedSpec, SpecMetadata`	Skill Policy Binding interface with 14 public fields or methods.
`TaskInstance`	interface	`interface TaskInstance`	Task Instance interface with 8 public fields or methods.
`TaskSchemaSpec`	interface	`interface TaskSchemaSpec extends VersionedSpec, SpecMetadata`	Task Schema Spec interface with 16 public fields or methods.
`WorkflowCompileOptions`	interface	`interface WorkflowCompileOptions`	Workflow Compile Options interface with 3 public fields or methods.
`WorkflowDependencySnapshot`	interface	`interface WorkflowDependencySnapshot`	Workflow Dependency Snapshot interface with 23 public fields or methods.
`WorkflowSpec`	interface	`interface WorkflowSpec extends VersionedSpec, SpecMetadata`	Workflow Spec interface with 12 public fields or methods.
`WorkflowStateBinding`	interface	`interface WorkflowStateBinding`	Workflow State Binding interface with 18 public fields or methods.
`WorkflowStateSpec`	interface	`interface WorkflowStateSpec extends SpecMetadata`	Workflow State Spec interface with 33 public fields or methods.
`WorkflowTransitionSpec`	interface	`interface WorkflowTransitionSpec`	Workflow Transition Spec interface with 4 public fields or methods.
`BusinessRuleEffect`	type	`type BusinessRuleEffect = 'constraint' \| 'precondition' \| 'postcondition' \| 'guidance'`	Public type alias for Business Rule Effect; the declaration contains its complete type expression.
`BusinessRuleScope`	type	`type BusinessRuleScope = 'domain' \| 'task' \| 'workflow' \| 'state' \| 'tool' \| 'memory' \| 'output'`	Public type alias for Business Rule Scope; the declaration contains its complete type expression.
`DomainAgenticReasoningMode`	type	`type DomainAgenticReasoningMode = 'react' \| 'fsm_react' \| 'tot' \| 'critique'`	Public type alias for Domain Agentic Reasoning Mode; the declaration contains its complete type expression.
`DomainPackOverlay`	type	`type DomainPackOverlay = Partial<Omit<DomainPackSpec, 'id' \| 'version' \| 'name' \| 'taskSchemas' \| 'workflows'>> & { id?: string; version?: string; name?: string; taskSchemas?: TaskSchemaSpec[]; workflows?: WorkflowSpec[]; remove?: DomainPackOverlayRemovals; }`	Public type alias for Domain Pack Overlay; the declaration contains its complete type expression.
`DomainPackOverlayCollection`	type	`type DomainPackOverlayCollection = 'taskSchemas' \| 'outputContracts' \| 'sessionProfiles' \| 'workflows' \| 'allowedSkills' \| 'defaultSkills' \| 'skillPolicies' \| 'allowedPromptRefs' \| 'defaultPromptRefs' \| 'tools' \| 'toolProfiles' \| 'mcpProfiles' \| 'memoryProfiles' \| 'contextProfiles' \| 'reasoningProfiles' \| 'businessRules' \| 'policies' \| 'evaluationProfiles' \| 'regressionCases'`	Public type alias for Domain Pack Overlay Collection; the declaration contains its complete type expression.
`DomainPackOverlayRemovals`	type	`type DomainPackOverlayRemovals = Partial<Record<DomainPackOverlayCollection, string[]>>`	Public type alias for Domain Pack Overlay Removals; the declaration contains its complete type expression.
`DomainReasoningPersistence`	type	`type DomainReasoningPersistence = 'summary_only' \| 'events_only'`	Public type alias for Domain Reasoning Persistence; the declaration contains its complete type expression.
`DomainThinkingMode`	type	`type DomainThinkingMode = 'none' \| 'summary' \| 'structured'`	Public type alias for Domain Thinking Mode; the declaration contains its complete type expression.

`DomainCompiler`

Domain Compiler class with 2 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { DomainCompiler } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare class DomainCompiler {
    compile(domainPack: DomainPackSpec, options: DomainCompileOptions): DomainCompilationResult;
}

Public members

Member	Kind	Signature	Description
`compile`	method	`compile(domainPack: DomainPackSpec, options: DomainCompileOptions): DomainCompilationResult`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(): DomainCompiler`	Creates an instance of this class.

`DomainPackRegistry`

Domain Pack Registry class with 6 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { DomainPackRegistry } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare class DomainPackRegistry {
    register(spec: DomainPackSpec, source?: string): DomainPackSpec;
    registerMany(entries: DomainPackRegistryEntry[]): DomainPackSpec[];
    resolve(id: string, version?: string): DomainPackRegistryEntry | undefined;
    get(id: string, version?: string): DomainPackSpec | null;
    list(): DomainPackRegistryEntry[];
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(): DomainPackRegistry`	Creates an instance of this class.
`get`	method	`get(id: string, version?: string): DomainPackSpec \| null`	Public method; parameters and return type are shown in the signature.
`list`	method	`list(): DomainPackRegistryEntry[]`	Public method; parameters and return type are shown in the signature.
`register`	method	`register(spec: DomainPackSpec, source?: string): DomainPackSpec`	Public method; parameters and return type are shown in the signature.
`registerMany`	method	`registerMany(entries: DomainPackRegistryEntry[]): DomainPackSpec[]`	Public method; parameters and return type are shown in the signature.
`resolve`	method	`resolve(id: string, version?: string): DomainPackRegistryEntry \| undefined`	Public method; parameters and return type are shown in the signature.

`LocalDomainPackLoader`

Local Domain Pack Loader class with 3 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { LocalDomainPackLoader } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare class LocalDomainPackLoader {
    constructor(options: LocalDomainPackLoaderOptions);
    load(): Promise<DomainPackRegistryEntry[]>;
    loadInto(registry: DomainPackRegistry): Promise<DomainPackSpec[]>;
}

Public members

Member	Kind	Signature	Description
`constructor`	constructor	`(options: LocalDomainPackLoaderOptions): LocalDomainPackLoader`	Creates an instance of this class.
`load`	method	`load(): Promise<DomainPackRegistryEntry[]>`	Public method; parameters and return type are shown in the signature.
`loadInto`	method	`loadInto(registry: DomainPackRegistry): Promise<DomainPackSpec[]>`	Public method; parameters and return type are shown in the signature.

`WorkflowCompiler`

Workflow Compiler class with 2 public constructor or member entries; its exact declarations are listed below.

Kind: class
Import: import { WorkflowCompiler } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare class WorkflowCompiler {
    compile(domainPack: DomainPackSpec, options?: WorkflowCompileOptions): FSMProcessSpec;
}

Public members

Member	Kind	Signature	Description
`compile`	method	`compile(domainPack: DomainPackSpec, options?: WorkflowCompileOptions): FSMProcessSpec`	Public method; parameters and return type are shown in the signature.
`constructor`	constructor	`(): WorkflowCompiler`	Creates an instance of this class.

`businessRuleEffectSchema`

Runtime schema for Business Rule Effect.

Kind: constant
Import: import { businessRuleEffectSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const businessRuleEffectSchema: z.ZodEnum<["constraint", "precondition", "postcondition", "guidance"]>;

`businessRuleScopeSchema`

Runtime schema for Business Rule Scope.

Kind: constant
Import: import { businessRuleScopeSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const businessRuleScopeSchema: z.ZodEnum<["domain", "task", "workflow", "state", "tool", "memory", "output"]>;

`businessRuleSpecDefinition`

Runtime validation entrypoint for the Business Rule spec, combining its parser, example and JSON Schema.

Kind: constant
Import: import { businessRuleSpecDefinition } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const businessRuleSpecDefinition: SpecSchemaDefinition<BusinessRuleSpec>;

`businessRuleSpecExample`

Valid example value for Business Rule Spec.

Kind: constant
Import: import { businessRuleSpecExample } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const businessRuleSpecExample: BusinessRuleSpec;

`businessRuleSpecJsonSchema`

JSON Schema for Business Rule Spec.

Kind: constant
Import: import { businessRuleSpecJsonSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const businessRuleSpecJsonSchema: JsonSchema;

`businessRuleSpecSchema`

Runtime schema for Business Rule Spec.

Kind: constant
Import: import { businessRuleSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const businessRuleSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { scope: z.ZodEnum<["domain", "task", "workflow", "state", "tool", "memory", "output"]>; effect: z.ZodEnum<["constraint", "precondition", "postcondition", "guidance"]>; expression: z.ZodOptional<z.ZodString>; inputSchema: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>; outputContractRef: z.ZodOptional<z.ZodString>; policyRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; evaluationRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; severity: z.ZodOptional<z.ZodEnum<["low", "medium", "high", "critical"]>>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { id: string; version: string; scope: "domain" | "task" | "workflow" | "state" | "tool" | "memory" | "output"; effect: "constraint" | "precondition" | "postcondition" | "guidance"; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; metadata?: Record<string, unknown> | undefined; expression?: string | undefined; inputSchema?: JsonSchema | undefined; outputContractRef?: string | undefined; policyRefs?: string[] | undefined; evaluationRefs?: string[] | undefined; severity?: "low" | "medium" | "high" | "critical" | undefined; }, { id: string; version: string; scope: "domain" | "task" | "workflow" | "state" | "tool" | "memory" | "output"; effect: "constraint" | "precondition" | "postcondition" | "guidance"; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; metadata?: Record<string, unknown> | undefined; expression?: string | undefined; inputSchema?: JsonSchema | undefined; outputContractRef?: string | undefined; policyRefs?: string[] | undefined; evaluationRefs?: string[] | undefined; severity?: "low" | "medium" | "high" | "critical" | undefined; }>;

`DOMAIN_COMPILER_VERSION`

DOMAIN COMPILER VERSION constant exported by the index module.

Kind: constant
Import: import { DOMAIN_COMPILER_VERSION } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const DOMAIN_COMPILER_VERSION: "1.0.0";

`domainAgenticReasoningModeSchema`

Runtime schema for Domain Agentic Reasoning Mode.

Kind: constant
Import: import { domainAgenticReasoningModeSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainAgenticReasoningModeSchema: z.ZodEnum<["react", "fsm_react", "tot", "critique"]>;

`domainPackSpecDefinition`

Runtime validation entrypoint for the Domain Pack spec, combining its parser, example and JSON Schema.

Kind: constant
Import: import { domainPackSpecDefinition } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainPackSpecDefinition: SpecSchemaDefinition<DomainPackSpec>;

`domainPackSpecExample`

Valid example value for Domain Pack Spec.

Kind: constant
Import: import { domainPackSpecExample } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainPackSpecExample: DomainPackSpec;

`domainPackSpecJsonSchema`

JSON Schema for Domain Pack Spec.

Kind: constant
Import: import { domainPackSpecJsonSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainPackSpecJsonSchema: JsonSchema;

`domainPackSpecSchema`

Runtime schema for Domain Pack Spec.

Kind: constant
Import: import { domainPackSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const domainPackSpecSchema: (typeof import('@codesoul-co/hypha-domain'))['domainPackSpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

`domainPromptRefSchema`

Runtime schema for Domain Prompt Ref.

Kind: constant
Import: import { domainPromptRefSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainPromptRefSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; } & { required: z.ZodOptional<z.ZodBoolean>; priority: z.ZodOptional<z.ZodNumber>; }, "strip", z.ZodTypeAny, { id: string; version?: string | undefined; revision?: string | undefined; required?: boolean | undefined; priority?: number | undefined; }, { id: string; version?: string | undefined; revision?: string | undefined; required?: boolean | undefined; priority?: number | undefined; }>;

`domainReasoningPersistenceSchema`

Runtime schema for Domain Reasoning Persistence.

Kind: constant
Import: import { domainReasoningPersistenceSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainReasoningPersistenceSchema: z.ZodEnum<["summary_only", "events_only"]>;

`domainSpecDefinitions`

Domain Spec Definitions constant exported by the index module.

Kind: constant
Import: import { domainSpecDefinitions } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainSpecDefinitions: readonly [SpecSchemaDefinition<WorkflowSpec>, SpecSchemaDefinition<ReasoningSpec>, SpecSchemaDefinition<BusinessRuleSpec>, SpecSchemaDefinition<DomainPackSpec>];

`domainSpecJsonSchemas`

Domain Spec JSON Schemas constant exported by the index module.

Kind: constant
Import: import { domainSpecJsonSchemas } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainSpecJsonSchemas: Record<string, JsonSchema>;

`domainThinkingModeSchema`

Runtime schema for Domain Thinking Mode.

Kind: constant
Import: import { domainThinkingModeSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const domainThinkingModeSchema: z.ZodEnum<["none", "summary", "structured"]>;

`reasoningSpecDefinition`

Runtime validation entrypoint for the Reasoning spec, combining its parser, example and JSON Schema.

Kind: constant
Import: import { reasoningSpecDefinition } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const reasoningSpecDefinition: SpecSchemaDefinition<ReasoningSpec>;

`reasoningSpecExample`

Valid example value for Reasoning Spec.

Kind: constant
Import: import { reasoningSpecExample } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const reasoningSpecExample: ReasoningSpec;

`reasoningSpecJsonSchema`

JSON Schema for Reasoning Spec.

Kind: constant
Import: import { reasoningSpecJsonSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const reasoningSpecJsonSchema: JsonSchema;

`reasoningSpecSchema`

Runtime schema for Reasoning Spec.

Kind: constant
Import: import { reasoningSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const reasoningSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { thinkingMode: z.ZodEnum<["none", "summary", "structured"]>; agenticMode: z.ZodEnum<["react", "fsm_react", "tot", "critique"]>; maxSteps: z.ZodOptional<z.ZodNumber>; persist: z.ZodOptional<z.ZodEnum<["summary_only", "events_only"]>>; plannerRef: z.ZodOptional<z.ZodString>; reasonerRef: z.ZodOptional<z.ZodString>; metadataSchema: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { id: string; version: string; thinkingMode: "none" | "summary" | "structured"; agenticMode: "react" | "fsm_react" | "tot" | "critique"; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; maxSteps?: number | undefined; persist?: "summary_only" | "events_only" | undefined; plannerRef?: string | undefined; reasonerRef?: string | undefined; metadataSchema?: JsonSchema | undefined; metadata?: Record<string, unknown> | undefined; }, { id: string; version: string; thinkingMode: "none" | "summary" | "structured"; agenticMode: "react" | "fsm_react" | "tot" | "critique"; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; maxSteps?: number | undefined; persist?: "summary_only" | "events_only" | undefined; plannerRef?: string | undefined; reasonerRef?: string | undefined; metadataSchema?: JsonSchema | undefined; metadata?: Record<string, unknown> | undefined; }>;

`riskProfileSpecSchema`

Runtime schema for Risk Profile Spec.

Kind: constant
Import: import { riskProfileSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const riskProfileSpecSchema: z.ZodObject<{ defaultRiskLevel: z.ZodEnum<["low", "medium", "high", "critical"]>; escalationPolicyRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { defaultRiskLevel: "low" | "medium" | "high" | "critical"; escalationPolicyRef?: string | undefined; }, { defaultRiskLevel: "low" | "medium" | "high" | "critical"; escalationPolicyRef?: string | undefined; }>;

`sessionProfileSpecSchema`

Runtime schema for Session Profile Spec.

Kind: constant
Import: import { sessionProfileSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const sessionProfileSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { metadataSchema: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>; defaultMetadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; defaultMemoryProfileRef: z.ZodOptional<z.ZodString>; defaultContextProfileRef: z.ZodOptional<z.ZodString>; defaultReasoningProfileRef: z.ZodOptional<z.ZodString>; defaultToolProfileRef: z.ZodOptional<z.ZodString>; defaultMCPProfileRef: z.ZodOptional<z.ZodString>; defaultSkillPolicyRef: z.ZodOptional<z.ZodString>; defaultPolicyRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; }, "strip", z.ZodTypeAny, { id: string; version: string; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; metadataSchema?: JsonSchema | undefined; defaultMetadata?: Record<string, unknown> | undefined; defaultMemoryProfileRef?: string | undefined; defaultContextProfileRef?: string | undefined; defaultReasoningProfileRef?: string | undefined; defaultToolProfileRef?: string | undefined; defaultMCPProfileRef?: string | undefined; defaultSkillPolicyRef?: string | undefined; defaultPolicyRefs?: string[] | undefined; }, { id: string; version: string; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; metadataSchema?: JsonSchema | undefined; defaultMetadata?: Record<string, unknown> | undefined; defaultMemoryProfileRef?: string | undefined; defaultContextProfileRef?: string | undefined; defaultReasoningProfileRef?: string | undefined; defaultToolProfileRef?: string | undefined; defaultMCPProfileRef?: string | undefined; defaultSkillPolicyRef?: string | undefined; defaultPolicyRefs?: string[] | undefined; }>;

`skillPolicyBindingSchema`

Runtime schema for Skill Policy Binding.

Kind: constant
Import: import { skillPolicyBindingSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const skillPolicyBindingSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { skillRef: z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revision?: string | undefined; version?: string | undefined; }>; policyRefs: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; allowedTools: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; requiredTools: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; trustLevel: z.ZodOptional<z.ZodEnum<["trusted", "reviewed", "untrusted"]>>; metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>; }, "strip", z.ZodTypeAny, { id: string; version: string; skillRef: { id: string; revision?: string | undefined; version?: string | undefined; }; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; metadata?: Record<string, unknown> | undefined; policyRefs?: string[] | undefined; allowedTools?: string[] | undefined; requiredTools?: string[] | undefined; trustLevel?: "trusted" | "reviewed" | "untrusted" | undefined; }, { id: string; version: string; skillRef: { id: string; revision?: string | undefined; version?: string | undefined; }; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; metadata?: Record<string, unknown> | undefined; policyRefs?: string[] | undefined; allowedTools?: string[] | undefined; requiredTools?: string[] | undefined; trustLevel?: "trusted" | "reviewed" | "untrusted" | undefined; }>;

`taskSchemaSpecSchema`

Runtime schema for Task Schema Spec.

Kind: constant
Import: import { taskSchemaSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const taskSchemaSpecSchema: z.ZodObject<{ id: z.ZodString; version: z.ZodString; } & { name: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; owner: z.ZodOptional<z.ZodString>; tags: z.ZodOptional<z.ZodArray<z.ZodString, "many">>; createdAt: z.ZodOptional<z.ZodString>; updatedAt: z.ZodOptional<z.ZodString>; } & { taskType: z.ZodString; inputSchema: z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>; constraintsSchema: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>; acceptanceCriteriaSchema: z.ZodOptional<z.ZodType<JsonSchema, z.ZodTypeDef, JsonSchema>>; outputContractRef: z.ZodString; riskProfile: z.ZodOptional<z.ZodObject<{ defaultRiskLevel: z.ZodEnum<["low", "medium", "high", "critical"]>; escalationPolicyRef: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { defaultRiskLevel: "low" | "medium" | "high" | "critical"; escalationPolicyRef?: string | undefined; }, { defaultRiskLevel: "low" | "medium" | "high" | "critical"; escalationPolicyRef?: string | undefined; }>>; defaultWorkflowRef: z.ZodOptional<z.ZodString>; defaultSkillRefs: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; version: z.ZodOptional<z.ZodString>; revision: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { id: string; revision?: string | undefined; version?: string | undefined; }, { id: string; revision?: string | undefined; version?: string | undefined; }>, "many">>; }, "strip", z.ZodTypeAny, { id: string; version: string; inputSchema: JsonSchema; outputContractRef: string; taskType: string; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; constraintsSchema?: JsonSchema | undefined; acceptanceCriteriaSchema?: JsonSchema | undefined; riskProfile?: { defaultRiskLevel: "low" | "medium" | "high" | "critical"; escalationPolicyRef?: string | undefined; } | undefined; defaultWorkflowRef?: string | undefined; defaultSkillRefs?: { id: string; revision?: string | undefined; version?: string | undefined; }[] | undefined; }, { id: string; version: string; inputSchema: JsonSchema; outputContractRef: string; taskType: string; name?: string | undefined; description?: string | undefined; owner?: string | undefined; tags?: string[] | undefined; createdAt?: string | undefined; updatedAt?: string | undefined; constraintsSchema?: JsonSchema | undefined; acceptanceCriteriaSchema?: JsonSchema | undefined; riskProfile?: { defaultRiskLevel: "low" | "medium" | "high" | "critical"; escalationPolicyRef?: string | undefined; } | undefined; defaultWorkflowRef?: string | undefined; defaultSkillRefs?: { id: string; revision?: string | undefined; version?: string | undefined; }[] | undefined; }>;

`workflowSpecDefinition`

Runtime validation entrypoint for the Workflow spec, combining its parser, example and JSON Schema.

Kind: constant
Import: import { workflowSpecDefinition } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const workflowSpecDefinition: SpecSchemaDefinition<WorkflowSpec>;

`workflowSpecExample`

Valid example value for Workflow Spec.

Kind: constant
Import: import { workflowSpecExample } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const workflowSpecExample: WorkflowSpec;

`workflowSpecJsonSchema`

JSON Schema for Workflow Spec.

Kind: constant
Import: import { workflowSpecJsonSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const workflowSpecJsonSchema: JsonSchema;

`workflowSpecSchema`

Runtime schema for Workflow Spec.

Kind: constant
Import: import { workflowSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const workflowSpecSchema: (typeof import('@codesoul-co/hypha-domain'))['workflowSpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

`workflowStateSpecSchema`

Runtime schema for Workflow State Spec.

Kind: constant
Import: import { workflowStateSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

// Exact type resolved from the package entrypoint; see source for the compiler expansion.
export declare const workflowStateSpecSchema: (typeof import('@codesoul-co/hypha-domain'))['workflowStateSpecSchema'];

This compiler-expanded constant type is compacted. Its public name, top-level type, and source location remain here; use the module’s exported interfaces, types, or runtime schema for input/output fields.

`workflowTransitionSpecSchema`

Runtime schema for Workflow Transition Spec.

Kind: constant
Import: import { workflowTransitionSpecSchema } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare const workflowTransitionSpecSchema: z.ZodObject<{ from: z.ZodString; to: z.ZodString; guard: z.ZodOptional<z.ZodString>; description: z.ZodOptional<z.ZodString>; }, "strip", z.ZodTypeAny, { from: string; to: string; description?: string | undefined; guard?: string | undefined; }, { from: string; to: string; description?: string | undefined; guard?: string | undefined; }>;

`applyDomainAgentPatch`

Apply Domain Agent Patch function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { applyDomainAgentPatch } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function applyDomainAgentPatch<TAgent extends DomainAgentPatchTarget>(agent: TAgent, patch: DomainAgentPatch): TAgent;

Call signature

text

applyDomainAgentPatch<TAgent extends DomainAgentPatchTarget>(agent: TAgent, patch: DomainAgentPatch): TAgent

Parameters

Parameter	Type	Required	Description
`agent`	`TAgent`	Yes	Required parameter; accepted values are defined by the type column.
`patch`	`DomainAgentPatch`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: TAgent
Description: The return contract is defined by the type shown above.

`compileDomainPackToHarnessedSystem`

Compile Domain Pack To Harnessed System function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { compileDomainPackToHarnessedSystem } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function compileDomainPackToHarnessedSystem(input: DomainPackSpec, options: DomainCompileOptions): DomainCompilationResult;

Call signature

text

compileDomainPackToHarnessedSystem(input: DomainPackSpec, options: DomainCompileOptions): DomainCompilationResult

Parameters

Parameter	Type	Required	Description
`input`	`DomainPackSpec`	Yes	Required parameter; accepted values are defined by the type column.
`options`	`DomainCompileOptions`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: DomainCompilationResult
Description: The return contract is defined by the type shown above.

`compileWorkflowToFSM`

Compile Workflow To FSM function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { compileWorkflowToFSM } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function compileWorkflowToFSM(domainPack: DomainPackSpec, options?: WorkflowCompileOptions): FSMProcessSpec;

Call signature

text

compileWorkflowToFSM(domainPack: DomainPackSpec, options?: WorkflowCompileOptions): FSMProcessSpec

Parameters

Parameter	Type	Required	Description
`domainPack`	`DomainPackSpec`	Yes	Required parameter; accepted values are defined by the type column.
`options`	`WorkflowCompileOptions`	No	Optional parameter; accepted values are defined by the type column.

Returns

Type: FSMProcessSpec
Description: The return contract is defined by the type shown above.

`createWorkflowDependencySnapshot`

Create Workflow Dependency Snapshot function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { createWorkflowDependencySnapshot } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function createWorkflowDependencySnapshot(input: Omit<WorkflowDependencySnapshot, 'dependencyHash'>): WorkflowDependencySnapshot;

Call signature

text

createWorkflowDependencySnapshot(input: Omit<WorkflowDependencySnapshot, "dependencyHash">): WorkflowDependencySnapshot

Parameters

Parameter	Type	Required	Description
`input`	`Omit<WorkflowDependencySnapshot, "dependencyHash">`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: WorkflowDependencySnapshot
Description: The return contract is defined by the type shown above.

`extendDomainPack`

Extend Domain Pack function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { extendDomainPack } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function extendDomainPack(base: DomainPackSpec, overlay: DomainPackOverlay): DomainPackSpec;

Call signature

text

extendDomainPack(base: DomainPackSpec, overlay: DomainPackOverlay): DomainPackSpec

Parameters

Parameter	Type	Required	Description
`base`	`DomainPackSpec`	Yes	Required parameter; accepted values are defined by the type column.
`overlay`	`DomainPackOverlay`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: DomainPackSpec
Description: The return contract is defined by the type shown above.

`initializeDomainSession`

Initialize Domain Session function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { initializeDomainSession } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function initializeDomainSession(domainPack: DomainPackSpec, options?: DomainSessionInitOptions): DomainSessionInitialization;

Call signature

text

initializeDomainSession(domainPack: DomainPackSpec, options?: DomainSessionInitOptions): DomainSessionInitialization

Parameters

Parameter	Type	Required	Description
`domainPack`	`DomainPackSpec`	Yes	Required parameter; accepted values are defined by the type column.
`options`	`DomainSessionInitOptions`	No	Optional parameter; accepted values are defined by the type column.

Returns

Type: DomainSessionInitialization
Description: The return contract is defined by the type shown above.

`listLocalDomainPackFiles`

List Local Domain Pack Files function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { listLocalDomainPackFiles } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function listLocalDomainPackFiles(directory: string, recursive?: boolean, extensions?: string[]): Promise<string[]>;

Call signature

text

listLocalDomainPackFiles(directory: string, recursive?: boolean, extensions?: string[]): Promise<string[]>

Parameters

Parameter	Type	Required	Description
`directory`	`string`	Yes	Required parameter; accepted values are defined by the type column.
`recursive`	`boolean`	No	Optional parameter; accepted values are defined by the type column.
`extensions`	`string[]`	No	Optional parameter; accepted values are defined by the type column.

Returns

Type: Promise<string[]>
Description: The return contract is defined by the type shown above.

`loadDomainPackFile`

Load Domain Pack File function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { loadDomainPackFile } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function loadDomainPackFile(filePath: string): Promise<DomainPackSpec>;

Call signature

text

loadDomainPackFile(filePath: string): Promise<DomainPackSpec>

Parameters

Parameter	Type	Required	Description
`filePath`	`string`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: Promise<DomainPackSpec>
Description: The return contract is defined by the type shown above.

`parseDomainPackDocument`

Parse Domain Pack Document function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { parseDomainPackDocument } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function parseDomainPackDocument(raw: string, filePath?: string): DomainPackSpec;

Call signature

text

parseDomainPackDocument(raw: string, filePath?: string): DomainPackSpec

Parameters

Parameter	Type	Required	Description
`raw`	`string`	Yes	Required parameter; accepted values are defined by the type column.
`filePath`	`string`	No	Optional parameter; accepted values are defined by the type column.

Returns

Type: DomainPackSpec
Description: The return contract is defined by the type shown above.

`resolveWorkflowToolExecutionScope`

Resolve Workflow Tool Execution Scope function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { resolveWorkflowToolExecutionScope } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function resolveWorkflowToolExecutionScope(workflowStates: WorkflowStateBinding[], stateId: string): ToolExecutionScope;

Call signature

text

resolveWorkflowToolExecutionScope(workflowStates: WorkflowStateBinding[], stateId: string): ToolExecutionScope

Parameters

Parameter	Type	Required	Description
`workflowStates`	`WorkflowStateBinding[]`	Yes	Required parameter; accepted values are defined by the type column.
`stateId`	`string`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: ToolExecutionScope
Description: The return contract is defined by the type shown above.

`validateDomainPackSpec`

Validate Domain Pack Spec function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { validateDomainPackSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function validateDomainPackSpec(input: unknown): DomainPackSpec;

Call signature

text

validateDomainPackSpec(input: unknown): DomainPackSpec

Parameters

Parameter	Type	Required	Description
`input`	`unknown`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: DomainPackSpec
Description: The return contract is defined by the type shown above.

`validateWorkflowSpec`

Validate Workflow Spec function with 1 public call signature; parameters and return types are listed below.

Kind: function
Import: import { validateWorkflowSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export declare function validateWorkflowSpec(input: unknown): WorkflowSpec;

Call signature

text

validateWorkflowSpec(input: unknown): WorkflowSpec

Parameters

Parameter	Type	Required	Description
`input`	`unknown`	Yes	Required parameter; accepted values are defined by the type column.

Returns

Type: WorkflowSpec
Description: The return contract is defined by the type shown above.

`BusinessRuleSpec`

Business Rule Spec interface with 17 public fields or methods.

Kind: interface
Import: import type { BusinessRuleSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface BusinessRuleSpec extends VersionedSpec, SpecMetadata {
    scope: BusinessRuleScope;
    effect: BusinessRuleEffect;
    expression?: string;
    inputSchema?: JsonSchema;
    outputContractRef?: string;
    policyRefs?: string[];
    evaluationRefs?: string[];
    severity?: RiskLevel;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`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.
`effect`	property	`effect: BusinessRuleEffect`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evaluationRefs`	property	`evaluationRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`expression`	property	`expression?: 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.
`inputSchema`	property	`inputSchema?: JsonSchema`	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.
`name`	property	`name?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`outputContractRef`	property	`outputContractRef?: 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.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`scope`	property	`scope: BusinessRuleScope`	Public property; its type, readonly modifier and optionality are shown in the signature.
`severity`	property	`severity?: RiskLevel`	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.

`DomainAgentPatch`

Domain Agent Patch interface with 9 public fields or methods.

Kind: interface
Import: import type { DomainAgentPatch } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainAgentPatch {
    promptRefs: DomainPromptRef[];
    skillRefs: SkillRef[];
    toolRefs: string[];
    memoryProfileRef?: string;
    mcpProfileRef?: string;
    contextSpecRef?: SpecRef;
    reasoningProfileRef?: string;
    policyRefs?: string[];
    metadata: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`contextSpecRef`	property	`contextSpecRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpProfileRef`	property	`mcpProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryProfileRef`	property	`memoryProfileRef?: 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.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`promptRefs`	property	`promptRefs: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfileRef`	property	`reasoningProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillRefs`	property	`skillRefs: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRefs`	property	`toolRefs: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainAgentPatchTarget`

Domain Agent Patch Target interface with 12 public fields or methods.

Kind: interface
Import: import type { DomainAgentPatchTarget } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainAgentPatchTarget {
    [key: string]: unknown;
    id?: string;
    version?: string;
    name?: string;
    modelAlias?: string;
    systemInstructions?: string;
    promptRefs?: DomainPromptRef[];
    skillRefs?: SkillRef[];
    toolRefs?: string[];
    memoryProfileRef?: string;
    contextSpecRef?: SpecRef;
    policyRefs?: string[];
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`contextSpecRef`	property	`contextSpecRef?: 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.
`memoryProfileRef`	property	`memoryProfileRef?: 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.
`modelAlias`	property	`modelAlias?: string`	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.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`promptRefs`	property	`promptRefs?: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillRefs`	property	`skillRefs?: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`systemInstructions`	property	`systemInstructions?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRefs`	property	`toolRefs?: 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.

`DomainBindingResolution`

Domain Binding Resolution interface with 23 public fields or methods.

Kind: interface
Import: import type { DomainBindingResolution } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainBindingResolution {
    domainPackRef: SpecRef;
    taskSchema?: TaskSchemaSpec;
    outputContract?: OutputContractSpec;
    sessionProfile?: SessionProfileSpec;
    workflow: WorkflowSpec;
    memoryProfile?: MemorySpec;
    mcpProfile?: MCPIntegrationSpec;
    contextProfile?: ContextSpec;
    reasoningProfile?: ReasoningSpec;
    mcpProfiles: MCPIntegrationSpec[];
    reasoningProfiles: ReasoningSpec[];
    policies: PolicySpec[];
    evaluations: EvaluationSpec[];
    regressionCases: RegressionSpec[];
    businessRules: BusinessRuleSpec[];
    tools: ToolSpec[];
    toolProfiles: ToolProfileSpec[];
    allowedSkills: SkillRef[];
    defaultSkills: SkillRef[];
    skillPolicies: SkillPolicyBinding[];
    allowedPromptRefs: DomainPromptRef[];
    defaultPromptRefs: DomainPromptRef[];
    workflowStates: WorkflowStateBinding[];
}

Contract members

Member	Kind	Signature	Description
`allowedPromptRefs`	property	`allowedPromptRefs: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedSkills`	property	`allowedSkills: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`businessRules`	property	`businessRules: BusinessRuleSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contextProfile`	property	`contextProfile?: ContextSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultPromptRefs`	property	`defaultPromptRefs: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultSkills`	property	`defaultSkills: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evaluations`	property	`evaluations: EvaluationSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpProfile`	property	`mcpProfile?: MCPIntegrationSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpProfiles`	property	`mcpProfiles: MCPIntegrationSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryProfile`	property	`memoryProfile?: MemorySpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`outputContract`	property	`outputContract?: OutputContractSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policies`	property	`policies: PolicySpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfile`	property	`reasoningProfile?: ReasoningSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfiles`	property	`reasoningProfiles: ReasoningSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`regressionCases`	property	`regressionCases: RegressionSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionProfile`	property	`sessionProfile?: SessionProfileSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillPolicies`	property	`skillPolicies: SkillPolicyBinding[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`taskSchema`	property	`taskSchema?: TaskSchemaSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolProfiles`	property	`toolProfiles: ToolProfileSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tools`	property	`tools: ToolSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflow`	property	`workflow: WorkflowSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowStates`	property	`workflowStates: WorkflowStateBinding[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainCompilationAudit`

Domain Compilation Audit interface with 9 public fields or methods.

Kind: interface
Import: import type { DomainCompilationAudit } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainCompilationAudit {
    compilationHash: string;
    domainPackRef: SpecRef;
    workflowRef: SpecRef;
    agentRef: SpecRef;
    promptRefs: DomainPromptRef[];
    skillRefs: SkillRef[];
    toolRefs: SpecRef[];
    mcpRefs: SpecRef[];
    workflowStateBindingsHash: string;
}

Contract members

Member	Kind	Signature	Description
`agentRef`	property	`agentRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`compilationHash`	property	`compilationHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpRefs`	property	`mcpRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`promptRefs`	property	`promptRefs: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillRefs`	property	`skillRefs: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRefs`	property	`toolRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowRef`	property	`workflowRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowStateBindingsHash`	property	`workflowStateBindingsHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainCompilationResult`

Domain Compilation Result interface with 11 public fields or methods.

Kind: interface
Import: import type { DomainCompilationResult } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainCompilationResult {
    domainPack: DomainPackSpec;
    bindings: DomainBindingResolution;
    fsmProcess: FSMProcessSpec;
    workflowRef: SpecRef;
    compilerVersion: string;
    processHash: string;
    dependencySnapshot: WorkflowDependencySnapshot;
    harnessedSystem: HarnessedAgentSystemSpec;
    agentPatch: DomainAgentPatch;
    sessionInitialization: DomainSessionInitialization;
    audit: DomainCompilationAudit;
}

Contract members

Member	Kind	Signature	Description
`agentPatch`	property	`agentPatch: DomainAgentPatch`	Public property; its type, readonly modifier and optionality are shown in the signature.
`audit`	property	`audit: DomainCompilationAudit`	Public property; its type, readonly modifier and optionality are shown in the signature.
`bindings`	property	`bindings: DomainBindingResolution`	Public property; its type, readonly modifier and optionality are shown in the signature.
`compilerVersion`	property	`compilerVersion: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`dependencySnapshot`	property	`dependencySnapshot: WorkflowDependencySnapshot`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPack`	property	`domainPack: DomainPackSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fsmProcess`	property	`fsmProcess: FSMProcessSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`harnessedSystem`	property	`harnessedSystem: HarnessedAgentSystemSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`processHash`	property	`processHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionInitialization`	property	`sessionInitialization: DomainSessionInitialization`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowRef`	property	`workflowRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainCompileOptions`

Domain Compile Options interface with 20 public fields or methods.

Kind: interface
Import: import type { DomainCompileOptions } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainCompileOptions {
    systemId?: string;
    systemVersion?: string;
    agentRef: SpecRef;
    agentSkillRefs?: SkillRef[];
    agentToolRefs?: string[];
    taskSchemaId?: string;
    workflowId?: string;
    sessionProfileId?: string;
    memoryProfileId?: string;
    mcpProfileId?: string;
    contextProfileId?: string;
    reasoningProfileId?: string;
    policyRefs?: string[];
    evaluationRefs?: string[];
    traceRef?: SpecRef;
    modelProfileRef?: SpecRef;
    replayRef?: SpecRef;
    regressionRef?: SpecRef;
    deploymentRef?: SpecRef;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`agentRef`	property	`agentRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`agentSkillRefs`	property	`agentSkillRefs?: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`agentToolRefs`	property	`agentToolRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contextProfileId`	property	`contextProfileId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`deploymentRef`	property	`deploymentRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evaluationRefs`	property	`evaluationRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpProfileId`	property	`mcpProfileId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryProfileId`	property	`memoryProfileId?: 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.
`modelProfileRef`	property	`modelProfileRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfileId`	property	`reasoningProfileId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`regressionRef`	property	`regressionRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`replayRef`	property	`replayRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionProfileId`	property	`sessionProfileId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`systemId`	property	`systemId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`systemVersion`	property	`systemVersion?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`taskSchemaId`	property	`taskSchemaId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`traceRef`	property	`traceRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowId`	property	`workflowId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainPackRegistryEntry`

Domain Pack Registry Entry interface with 2 public fields or methods.

Kind: interface
Import: import type { DomainPackRegistryEntry } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainPackRegistryEntry {
    spec: DomainPackSpec;
    source?: string;
}

Contract members

Member	Kind	Signature	Description
`source`	property	`source?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`spec`	property	`spec: DomainPackSpec`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainPackSpec`

Domain Pack Spec interface with 31 public fields or methods.

Kind: interface
Import: import type { DomainPackSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainPackSpec extends VersionedSpec, SpecMetadata {
    name: string;
    taskSchemas: TaskSchemaSpec[];
    outputContracts: OutputContractSpec[];
    sessionProfiles?: SessionProfileSpec[];
    workflows: WorkflowSpec[];
    defaultWorkflow?: string;
    allowedSkills?: SkillRef[];
    defaultSkills?: SkillRef[];
    skillPolicies?: SkillPolicyBinding[];
    allowedPromptRefs?: DomainPromptRef[];
    defaultPromptRefs?: DomainPromptRef[];
    tools?: ToolSpec[];
    toolProfiles?: ToolProfileSpec[];
    mcpProfiles?: MCPIntegrationSpec[];
    memoryProfiles?: MemorySpec[];
    contextProfiles?: ContextSpec[];
    reasoningProfiles?: ReasoningSpec[];
    defaultReasoningProfile?: string;
    businessRules?: BusinessRuleSpec[];
    policies?: PolicySpec[];
    evaluationProfiles?: EvaluationSpec[];
    regressionCases?: RegressionSpec[];
    deploymentProfile?: DeploymentSpec;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`allowedPromptRefs`	property	`allowedPromptRefs?: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedSkills`	property	`allowedSkills?: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`businessRules`	property	`businessRules?: BusinessRuleSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contextProfiles`	property	`contextProfiles?: ContextSpec[]`	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.
`defaultPromptRefs`	property	`defaultPromptRefs?: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultReasoningProfile`	property	`defaultReasoningProfile?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultSkills`	property	`defaultSkills?: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultWorkflow`	property	`defaultWorkflow?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`deploymentProfile`	property	`deploymentProfile?: DeploymentSpec`	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.
`evaluationProfiles`	property	`evaluationProfiles?: EvaluationSpec[]`	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.
`mcpProfiles`	property	`mcpProfiles?: MCPIntegrationSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryProfiles`	property	`memoryProfiles?: MemorySpec[]`	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.
`name`	property	`name: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`outputContracts`	property	`outputContracts: OutputContractSpec[]`	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.
`policies`	property	`policies?: PolicySpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfiles`	property	`reasoningProfiles?: ReasoningSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`regressionCases`	property	`regressionCases?: RegressionSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionProfiles`	property	`sessionProfiles?: SessionProfileSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillPolicies`	property	`skillPolicies?: SkillPolicyBinding[]`	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.
`taskSchemas`	property	`taskSchemas: TaskSchemaSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolProfiles`	property	`toolProfiles?: ToolProfileSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`tools`	property	`tools?: ToolSpec[]`	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.
`workflows`	property	`workflows: WorkflowSpec[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainPromptRef`

Domain Prompt Ref interface with 5 public fields or methods.

Kind: interface
Import: import type { DomainPromptRef } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainPromptRef extends SpecRef {
    required?: boolean;
    priority?: number;
}

Contract members

Member	Kind	Signature	Description
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`priority`	property	`priority?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`required`	property	`required?: boolean`	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.
`version`	property	`version?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainSessionInitialization`

Domain Session Initialization interface with 10 public fields or methods.

Kind: interface
Import: import type { DomainSessionInitialization } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainSessionInitialization {
    domainPackRef: SpecRef;
    sessionProfileRef?: SpecRef;
    metadata: Record<string, unknown>;
    memoryProfileRef?: string;
    contextProfileRef?: string;
    reasoningProfileRef?: string;
    toolProfileRef?: string;
    mcpProfileRef?: string;
    skillPolicyRef?: string;
    policyRefs?: string[];
}

Contract members

Member	Kind	Signature	Description
`contextProfileRef`	property	`contextProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRef`	property	`domainPackRef: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpProfileRef`	property	`mcpProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryProfileRef`	property	`memoryProfileRef?: 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.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfileRef`	property	`reasoningProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionProfileRef`	property	`sessionProfileRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillPolicyRef`	property	`skillPolicyRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolProfileRef`	property	`toolProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`DomainSessionInitOptions`

Domain Session Init Options interface with 2 public fields or methods.

Kind: interface
Import: import type { DomainSessionInitOptions } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface DomainSessionInitOptions {
    profileId?: string;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`metadata`	property	`metadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`profileId`	property	`profileId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`LocalDomainPackLoaderOptions`

Local Domain Pack Loader Options interface with 3 public fields or methods.

Kind: interface
Import: import type { LocalDomainPackLoaderOptions } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface LocalDomainPackLoaderOptions {
    directories: string[];
    recursive?: boolean;
    extensions?: string[];
}

Contract members

Member	Kind	Signature	Description
`directories`	property	`directories: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`extensions`	property	`extensions?: string[]`	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.

`ReasoningSpec`

Reasoning Spec interface with 16 public fields or methods.

Kind: interface
Import: import type { ReasoningSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface ReasoningSpec extends VersionedSpec, SpecMetadata {
    thinkingMode: DomainThinkingMode;
    agenticMode: DomainAgenticReasoningMode;
    maxSteps?: number;
    persist?: DomainReasoningPersistence;
    plannerRef?: string;
    reasonerRef?: string;
    metadataSchema?: JsonSchema;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`agenticMode`	property	`agenticMode: DomainAgenticReasoningMode`	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.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`maxSteps`	property	`maxSteps?: 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.
`metadataSchema`	property	`metadataSchema?: JsonSchema`	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.
`persist`	property	`persist?: DomainReasoningPersistence`	Public property; its type, readonly modifier and optionality are shown in the signature.
`plannerRef`	property	`plannerRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasonerRef`	property	`reasonerRef?: string`	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.
`thinkingMode`	property	`thinkingMode: DomainThinkingMode`	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.

`RiskProfileSpec`

Risk Profile Spec interface with 2 public fields or methods.

Kind: interface
Import: import type { RiskProfileSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface RiskProfileSpec {
    defaultRiskLevel: RiskLevel;
    escalationPolicyRef?: string;
}

Contract members

Member	Kind	Signature	Description
`defaultRiskLevel`	property	`defaultRiskLevel: RiskLevel`	Public property; its type, readonly modifier and optionality are shown in the signature.
`escalationPolicyRef`	property	`escalationPolicyRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`SessionProfileSpec`

Session Profile Spec interface with 17 public fields or methods.

Kind: interface
Import: import type { SessionProfileSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface SessionProfileSpec extends VersionedSpec, SpecMetadata {
    metadataSchema?: JsonSchema;
    defaultMetadata?: Record<string, unknown>;
    defaultMemoryProfileRef?: string;
    defaultContextProfileRef?: string;
    defaultReasoningProfileRef?: string;
    defaultToolProfileRef?: string;
    defaultMCPProfileRef?: string;
    defaultSkillPolicyRef?: string;
    defaultPolicyRefs?: string[];
}

Contract members

Member	Kind	Signature	Description
`createdAt`	property	`createdAt?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultContextProfileRef`	property	`defaultContextProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultMCPProfileRef`	property	`defaultMCPProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultMemoryProfileRef`	property	`defaultMemoryProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultMetadata`	property	`defaultMetadata?: Record<string, unknown>`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultPolicyRefs`	property	`defaultPolicyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultReasoningProfileRef`	property	`defaultReasoningProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultSkillPolicyRef`	property	`defaultSkillPolicyRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultToolProfileRef`	property	`defaultToolProfileRef?: 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.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`metadataSchema`	property	`metadataSchema?: JsonSchema`	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.
`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.

`SkillPolicyBinding`

Skill Policy Binding interface with 14 public fields or methods.

Kind: interface
Import: import type { SkillPolicyBinding } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface SkillPolicyBinding extends VersionedSpec, SpecMetadata {
    skillRef: SkillRef;
    policyRefs?: string[];
    allowedTools?: string[];
    requiredTools?: string[];
    trustLevel?: 'trusted' | 'reviewed' | 'untrusted';
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`allowedTools`	property	`allowedTools?: 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.
`description`	property	`description?: 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.
`metadata`	property	`metadata?: Record<string, unknown>`	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.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requiredTools`	property	`requiredTools?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillRef`	property	`skillRef: SkillRef`	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.
`trustLevel`	property	`trustLevel?: "trusted" \| "reviewed" \| "untrusted"`	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.

`TaskInstance`

Task Instance interface with 8 public fields or methods.

Kind: interface
Import: import type { TaskInstance } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface TaskInstance<TInput = unknown, TConstraints = unknown> {
    id: string;
    domainId: string;
    taskSchemaId: string;
    input: TInput;
    constraints?: TConstraints;
    acceptanceCriteria?: unknown;
    riskLevel?: RiskLevel;
    metadata?: Record<string, unknown>;
}

Contract members

Member	Kind	Signature	Description
`acceptanceCriteria`	property	`acceptanceCriteria?: unknown`	Public property; its type, readonly modifier and optionality are shown in the signature.
`constraints`	property	`constraints?: TConstraints`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainId`	property	`domainId: 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.
`input`	property	`input: TInput`	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.
`riskLevel`	property	`riskLevel?: RiskLevel`	Public property; its type, readonly modifier and optionality are shown in the signature.
`taskSchemaId`	property	`taskSchemaId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`TaskSchemaSpec`

Task Schema Spec interface with 16 public fields or methods.

Kind: interface
Import: import type { TaskSchemaSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface TaskSchemaSpec extends VersionedSpec, SpecMetadata {
    taskType: string;
    inputSchema: JsonSchema;
    constraintsSchema?: JsonSchema;
    acceptanceCriteriaSchema?: JsonSchema;
    outputContractRef: string;
    riskProfile?: RiskProfileSpec;
    defaultWorkflowRef?: string;
    defaultSkillRefs?: SkillRef[];
}

Contract members

Member	Kind	Signature	Description
`acceptanceCriteriaSchema`	property	`acceptanceCriteriaSchema?: JsonSchema`	Public property; its type, readonly modifier and optionality are shown in the signature.
`constraintsSchema`	property	`constraintsSchema?: JsonSchema`	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.
`defaultSkillRefs`	property	`defaultSkillRefs?: SkillRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`defaultWorkflowRef`	property	`defaultWorkflowRef?: 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.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`inputSchema`	property	`inputSchema: JsonSchema`	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.
`outputContractRef`	property	`outputContractRef: 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.
`riskProfile`	property	`riskProfile?: RiskProfileSpec`	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.
`taskType`	property	`taskType: 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.

`WorkflowCompileOptions`

Workflow Compile Options interface with 3 public fields or methods.

Kind: interface
Import: import type { WorkflowCompileOptions } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface WorkflowCompileOptions {
    workflowId?: string;
    /** @deprecated Harness FSM identity is framework-owned and cannot be overridden. */
    fsmProcessId?: string;
    agentRef?: SpecRef;
}

Contract members

Member	Kind	Signature	Description
`agentRef`	property	`agentRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`fsmProcessId`	property	`fsmProcessId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workflowId`	property	`workflowId?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`WorkflowDependencySnapshot`

Workflow Dependency Snapshot interface with 23 public fields or methods.

Kind: interface
Import: import type { WorkflowDependencySnapshot } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface WorkflowDependencySnapshot {
    domainPackRefs: SpecRef[];
    taskSchemaRefs: SpecRef[];
    outputContractRefs: SpecRef[];
    sessionProfileRefs: SpecRef[];
    agentRefs: SpecRef[];
    skillRefs: SpecRef[];
    skillPolicyRefs: SpecRef[];
    toolRefs: SpecRef[];
    toolProfileRefs: SpecRef[];
    mcpProfileRefs: SpecRef[];
    memoryProfileRefs: SpecRef[];
    contextProfileRefs: SpecRef[];
    reasoningProfileRefs: SpecRef[];
    workspaceProfileRefs: SpecRef[];
    businessRuleRefs: SpecRef[];
    policyRefs: SpecRef[];
    evaluationRefs: SpecRef[];
    traceRefs: SpecRef[];
    modelProfileRefs: SpecRef[];
    replayRefs: SpecRef[];
    regressionRefs: SpecRef[];
    deploymentRefs: SpecRef[];
    dependencyHash: string;
}

Contract members

Member	Kind	Signature	Description
`agentRefs`	property	`agentRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`businessRuleRefs`	property	`businessRuleRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`contextProfileRefs`	property	`contextProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`dependencyHash`	property	`dependencyHash: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`deploymentRefs`	property	`deploymentRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`domainPackRefs`	property	`domainPackRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evaluationRefs`	property	`evaluationRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`mcpProfileRefs`	property	`mcpProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryProfileRefs`	property	`memoryProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`modelProfileRefs`	property	`modelProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`outputContractRefs`	property	`outputContractRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyRefs`	property	`policyRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfileRefs`	property	`reasoningProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`regressionRefs`	property	`regressionRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`replayRefs`	property	`replayRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`sessionProfileRefs`	property	`sessionProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillPolicyRefs`	property	`skillPolicyRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`skillRefs`	property	`skillRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`taskSchemaRefs`	property	`taskSchemaRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolProfileRefs`	property	`toolProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolRefs`	property	`toolRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`traceRefs`	property	`traceRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`workspaceProfileRefs`	property	`workspaceProfileRefs: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`WorkflowSpec`

Workflow Spec interface with 12 public fields or methods.

Kind: interface
Import: import type { WorkflowSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface WorkflowSpec extends VersionedSpec, SpecMetadata {
    initialState: string;
    terminalStates: string[];
    states: WorkflowStateSpec[];
    transitions: WorkflowTransitionSpec[];
}

Contract members

Member	Kind	Signature	Description
`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.
`id`	property	`id: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`initialState`	property	`initialState: string`	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.
`states`	property	`states: WorkflowStateSpec[]`	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.
`terminalStates`	property	`terminalStates: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`transitions`	property	`transitions: WorkflowTransitionSpec[]`	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.

`WorkflowStateBinding`

Workflow State Binding interface with 18 public fields or methods.

Kind: interface
Import: import type { WorkflowStateBinding } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface WorkflowStateBinding {
    stateId: string;
    allowedTools: string[];
    allowedSkills: string[];
    requiredSkills: string[];
    allowedPromptRefs: DomainPromptRef[];
    requiredPromptRefs: DomainPromptRef[];
    allowedMCPProfiles: string[];
    memoryPolicyRef?: string;
    reasoningProfileRef?: string;
    policyRefs: string[];
    evaluationRefs: string[];
    toolProfileRefs?: SpecRef[];
    allowedToolRefs?: SpecRef[];
    deniedToolRefs?: SpecRef[];
    allowedMCPProfileRefs?: SpecRef[];
    humanApprovalPolicyRef?: SpecRef;
    permissionScopes?: string[];
    capabilityLoadPolicy?: 'eager' | 'lazy' | 'model_selected';
}

Contract members

Member	Kind	Signature	Description
`allowedMCPProfileRefs`	property	`allowedMCPProfileRefs?: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedMCPProfiles`	property	`allowedMCPProfiles: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedPromptRefs`	property	`allowedPromptRefs: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedSkills`	property	`allowedSkills: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedToolRefs`	property	`allowedToolRefs?: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedTools`	property	`allowedTools: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityLoadPolicy`	property	`capabilityLoadPolicy?: "eager" \| "lazy" \| "model_selected"`	Public property; its type, readonly modifier and optionality are shown in the signature.
`deniedToolRefs`	property	`deniedToolRefs?: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`evaluationRefs`	property	`evaluationRefs: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`humanApprovalPolicyRef`	property	`humanApprovalPolicyRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryPolicyRef`	property	`memoryPolicyRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`permissionScopes`	property	`permissionScopes?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyRefs`	property	`policyRefs: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfileRef`	property	`reasoningProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requiredPromptRefs`	property	`requiredPromptRefs: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requiredSkills`	property	`requiredSkills: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`stateId`	property	`stateId: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolProfileRefs`	property	`toolProfileRefs?: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.

`WorkflowStateSpec`

Workflow State Spec interface with 33 public fields or methods.

Kind: interface
Import: import type { WorkflowStateSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface WorkflowStateSpec extends SpecMetadata {
    id: string;
    goal: string;
    inputContract?: JsonSchema;
    outputContract?: JsonSchema;
    allowedTools?: string[];
    allowedSkills?: string[];
    requiredSkills?: string[];
    allowedPromptRefs?: DomainPromptRef[];
    requiredPromptRefs?: DomainPromptRef[];
    allowedMCPProfiles?: string[];
    toolProfileRefs?: SpecRef[];
    allowedToolRefs?: SpecRef[];
    deniedToolRefs?: SpecRef[];
    allowedMCPProfileRefs?: SpecRef[];
    humanApprovalPolicyRef?: SpecRef;
    permissionScopes?: string[];
    capabilityLoadPolicy?: 'eager' | 'lazy' | 'model_selected';
    memoryPolicyRef?: string;
    reasoningProfileRef?: string;
    policyRefs?: string[];
    evaluationRefs?: string[];
    humanReviewRef?: string;
    humanReviewPolicy?: HumanReviewPolicySpec;
    timeoutMs?: number;
    timeoutPolicy?: TimeoutPolicySpec;
    retryPolicyRef?: string;
    retryPolicy?: RetryPolicySpec;
}

Contract members

Member	Kind	Signature	Description
`allowedMCPProfileRefs`	property	`allowedMCPProfileRefs?: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedMCPProfiles`	property	`allowedMCPProfiles?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedPromptRefs`	property	`allowedPromptRefs?: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedSkills`	property	`allowedSkills?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedToolRefs`	property	`allowedToolRefs?: SpecRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`allowedTools`	property	`allowedTools?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`capabilityLoadPolicy`	property	`capabilityLoadPolicy?: "eager" \| "lazy" \| "model_selected"`	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.
`deniedToolRefs`	property	`deniedToolRefs?: SpecRef[]`	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.
`evaluationRefs`	property	`evaluationRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`goal`	property	`goal: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`humanApprovalPolicyRef`	property	`humanApprovalPolicyRef?: SpecRef`	Public property; its type, readonly modifier and optionality are shown in the signature.
`humanReviewPolicy`	property	`humanReviewPolicy?: HumanReviewPolicySpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`humanReviewRef`	property	`humanReviewRef?: 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.
`inputContract`	property	`inputContract?: JsonSchema`	Public property; its type, readonly modifier and optionality are shown in the signature.
`memoryPolicyRef`	property	`memoryPolicyRef?: string`	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.
`outputContract`	property	`outputContract?: JsonSchema`	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.
`permissionScopes`	property	`permissionScopes?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`policyRefs`	property	`policyRefs?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`reasoningProfileRef`	property	`reasoningProfileRef?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requiredPromptRefs`	property	`requiredPromptRefs?: DomainPromptRef[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`requiredSkills`	property	`requiredSkills?: string[]`	Public property; its type, readonly modifier and optionality are shown in the signature.
`retryPolicy`	property	`retryPolicy?: RetryPolicySpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`retryPolicyRef`	property	`retryPolicyRef?: string`	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.
`timeoutMs`	property	`timeoutMs?: number`	Public property; its type, readonly modifier and optionality are shown in the signature.
`timeoutPolicy`	property	`timeoutPolicy?: TimeoutPolicySpec`	Public property; its type, readonly modifier and optionality are shown in the signature.
`toolProfileRefs`	property	`toolProfileRefs?: SpecRef[]`	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.

`WorkflowTransitionSpec`

Workflow Transition Spec interface with 4 public fields or methods.

Kind: interface
Import: import type { WorkflowTransitionSpec } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export interface WorkflowTransitionSpec {
    from: string;
    to: string;
    guard?: string;
    description?: string;
}

Contract members

Member	Kind	Signature	Description
`description`	property	`description?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`from`	property	`from: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`guard`	property	`guard?: string`	Public property; its type, readonly modifier and optionality are shown in the signature.
`to`	property	`to: string`	Public property; its type, readonly modifier and optionality are shown in the signature.

`BusinessRuleEffect`

Public type alias for Business Rule Effect; the declaration contains its complete type expression.

Kind: type
Import: import type { BusinessRuleEffect } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type BusinessRuleEffect = 'constraint' | 'precondition' | 'postcondition' | 'guidance';

`BusinessRuleScope`

Public type alias for Business Rule Scope; the declaration contains its complete type expression.

Kind: type
Import: import type { BusinessRuleScope } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type BusinessRuleScope = 'domain' | 'task' | 'workflow' | 'state' | 'tool' | 'memory' | 'output';

`DomainAgenticReasoningMode`

Public type alias for Domain Agentic Reasoning Mode; the declaration contains its complete type expression.

Kind: type
Import: import type { DomainAgenticReasoningMode } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type DomainAgenticReasoningMode = 'react' | 'fsm_react' | 'tot' | 'critique';

`DomainPackOverlay`

Public type alias for Domain Pack Overlay; the declaration contains its complete type expression.

Kind: type
Import: import type { DomainPackOverlay } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type DomainPackOverlay = Partial<Omit<DomainPackSpec, 'id' | 'version' | 'name' | 'taskSchemas' | 'workflows'>> & {
    id?: string;
    version?: string;
    name?: string;
    taskSchemas?: TaskSchemaSpec[];
    workflows?: WorkflowSpec[];
    remove?: DomainPackOverlayRemovals;
};

`DomainPackOverlayCollection`

Public type alias for Domain Pack Overlay Collection; the declaration contains its complete type expression.

Kind: type
Import: import type { DomainPackOverlayCollection } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type DomainPackOverlayCollection = 'taskSchemas' | 'outputContracts' | 'sessionProfiles' | 'workflows' | 'allowedSkills' | 'defaultSkills' | 'skillPolicies' | 'allowedPromptRefs' | 'defaultPromptRefs' | 'tools' | 'toolProfiles' | 'mcpProfiles' | 'memoryProfiles' | 'contextProfiles' | 'reasoningProfiles' | 'businessRules' | 'policies' | 'evaluationProfiles' | 'regressionCases';

`DomainPackOverlayRemovals`

Public type alias for Domain Pack Overlay Removals; the declaration contains its complete type expression.

Kind: type
Import: import type { DomainPackOverlayRemovals } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type DomainPackOverlayRemovals = Partial<Record<DomainPackOverlayCollection, string[]>>;

`DomainReasoningPersistence`

Public type alias for Domain Reasoning Persistence; the declaration contains its complete type expression.

Kind: type
Import: import type { DomainReasoningPersistence } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type DomainReasoningPersistence = 'summary_only' | 'events_only';

`DomainThinkingMode`

Public type alias for Domain Thinking Mode; the declaration contains its complete type expression.

Kind: type
Import: import type { DomainThinkingMode } from '@codesoul-co/hypha-domain';
Source module: index

Declaration

text

export type DomainThinkingMode = 'none' | 'summary' | 'structured';

@codesoul-co/hypha-domain / index ​

Using this module ​

Import from the package entrypoint ​

Usage patterns ​

Runtime validation example ​

Public exports ​

DomainCompiler ​

Declaration ​

Public members ​

DomainPackRegistry ​

Declaration ​

Public members ​

LocalDomainPackLoader ​

Declaration ​

Public members ​

WorkflowCompiler ​

Declaration ​

Public members ​

businessRuleEffectSchema ​

Declaration ​

businessRuleScopeSchema ​

Declaration ​

businessRuleSpecDefinition ​

Declaration ​

businessRuleSpecExample ​

Declaration ​

businessRuleSpecJsonSchema ​

Declaration ​

businessRuleSpecSchema ​

Declaration ​

DOMAIN_COMPILER_VERSION ​

Declaration ​

domainAgenticReasoningModeSchema ​

Declaration ​

domainPackSpecDefinition ​

Declaration ​

domainPackSpecExample ​

Declaration ​

domainPackSpecJsonSchema ​

Declaration ​

domainPackSpecSchema ​

Declaration ​

domainPromptRefSchema ​

Declaration ​

domainReasoningPersistenceSchema ​

Declaration ​

domainSpecDefinitions ​

Declaration ​

domainSpecJsonSchemas ​

Declaration ​

domainThinkingModeSchema ​

Declaration ​

reasoningSpecDefinition ​

Declaration ​

reasoningSpecExample ​

Declaration ​

reasoningSpecJsonSchema ​

Declaration ​

reasoningSpecSchema ​

Declaration ​

riskProfileSpecSchema ​

Declaration ​

sessionProfileSpecSchema ​

Declaration ​

skillPolicyBindingSchema ​

Declaration ​

taskSchemaSpecSchema ​

Declaration ​

workflowSpecDefinition ​

Declaration ​

workflowSpecExample ​

Declaration ​

workflowSpecJsonSchema ​

Declaration ​

workflowSpecSchema ​

Declaration ​

workflowStateSpecSchema ​

Declaration ​

workflowTransitionSpecSchema ​

Declaration ​

`@codesoul-co/hypha-domain` / `index`

Using this module

Import from the package entrypoint

Usage patterns

Runtime validation example

Public exports

`DomainCompiler`

Declaration

Public members

`DomainPackRegistry`

Declaration

Public members

`LocalDomainPackLoader`

Declaration

Public members

`WorkflowCompiler`

Declaration

Public members

`businessRuleEffectSchema`

Declaration

`businessRuleScopeSchema`

Declaration

`businessRuleSpecDefinition`

Declaration

`businessRuleSpecExample`

Declaration

`businessRuleSpecJsonSchema`

Declaration

`businessRuleSpecSchema`

Declaration

`DOMAIN_COMPILER_VERSION`

Declaration

`domainAgenticReasoningModeSchema`

Declaration

`domainPackSpecDefinition`

Declaration

`domainPackSpecExample`

Declaration

`domainPackSpecJsonSchema`

Declaration

`domainPackSpecSchema`

Declaration

`domainPromptRefSchema`

Declaration

`domainReasoningPersistenceSchema`

Declaration

`domainSpecDefinitions`

Declaration

`domainSpecJsonSchemas`

Declaration

`domainThinkingModeSchema`

Declaration

`reasoningSpecDefinition`

Declaration

`reasoningSpecExample`

Declaration

`reasoningSpecJsonSchema`

Declaration

`reasoningSpecSchema`

Declaration

`riskProfileSpecSchema`

Declaration

`sessionProfileSpecSchema`

Declaration

`skillPolicyBindingSchema`

Declaration

`taskSchemaSpecSchema`

Declaration

`workflowSpecDefinition`

Declaration

`workflowSpecExample`

Declaration

`workflowSpecJsonSchema`

Declaration

`workflowSpecSchema`

Declaration

`workflowStateSpecSchema`

Declaration

`workflowTransitionSpecSchema`

Declaration