@codesoul-co/hypha-core API
Shared contracts, schemas, Events, policy and runtime ports.
- Install:
npm install @codesoul-co/hypha-core@1.0.1 - Entrypoint import:
import { ... } from '@codesoul-co/hypha-core'; - Public exports: 1895
- Source modules: 139
Export overview
| Kind | Count |
|---|---|
| interface | 535 |
| type | 133 |
| class | 67 |
| constant | 869 |
| function | 291 |
Source modules
| Module | Use when | Exports | Source |
|---|---|---|---|
contracts/artifact | Use the Artifact module for declaring and runtime-validating contracts. It exports 15 interfaces, 3 types. | 18 | source |
contracts/artifact-events | Use the Artifact events module for declaring and runtime-validating contracts. It exports 2 interfaces, 5 types. | 7 | source |
contracts/artifact-gc | Use the Artifact gc module for declaring and runtime-validating contracts. It exports 8 interfaces. | 8 | source |
contracts/artifact-manager | Use the Artifact manager module for declaring and runtime-validating contracts. It exports 17 interfaces, 4 types. | 21 | source |
contracts/artifact-record-repository | Use the Artifact record repository module for declaring and runtime-validating contracts. It exports 2 classes, 5 interfaces. | 7 | source |
contracts/artifact-retention | Use the Artifact retention module for declaring and runtime-validating contracts. It exports 7 interfaces, 2 types. | 9 | source |
contracts/artifact-store | Use the Artifact store module for declaring and runtime-validating contracts. It exports 12 interfaces, 1 type. | 13 | source |
contracts/command-execution | Use the Command execution module for declaring and runtime-validating contracts. It exports 6 interfaces, 1 type. | 7 | source |
contracts/execution | Use the Execution module for declaring and runtime-validating contracts. It exports 3 interfaces. | 3 | source |
contracts/execution-activities | Use the Execution activities module for declaring and runtime-validating contracts. It exports 1 constant, 2 interfaces, 2 types. | 5 | source |
contracts/execution-cache | Use the Execution cache module for declaring and runtime-validating contracts. It exports 15 interfaces, 6 types. | 21 | source |
contracts/execution-events | Use the Execution events module for declaring and runtime-validating contracts. It exports 4 interfaces, 7 types. | 11 | source |
contracts/execution-governance | Use the Execution governance module for declaring and runtime-validating contracts. It exports 2 constants, 4 interfaces, 3 types. | 9 | source |
contracts/execution-human-task | Use the Execution human task module for declaring and runtime-validating contracts. It exports 1 constant, 9 interfaces. | 10 | source |
contracts/execution-output | Use the Execution output module for declaring and runtime-validating contracts. It exports 9 interfaces, 2 types. | 11 | source |
contracts/execution-port | Use the Execution port module for declaring and runtime-validating contracts. It exports 6 interfaces. | 6 | source |
contracts/execution-store | Use the Execution store module for declaring and runtime-validating contracts. It exports 14 interfaces, 2 types. | 16 | source |
contracts/react-continuation | Use the React continuation module for declaring and runtime-validating contracts. It exports 2 constants, 5 interfaces, 2 types. | 9 | source |
contracts/react-continuation-schemas | Use the React continuation schemas module for declaring and runtime-validating contracts. It exports 10 constants, 2 functions. | 12 | source |
contracts/recovery | Use the Recovery module for declaring and runtime-validating contracts. It exports 4 constants, 5 functions, 9 interfaces, 5 types. | 23 | source |
contracts/recovery-knowledge-schemas | Use the Recovery knowledge schemas module for declaring and runtime-validating contracts. It exports 10 constants, 2 functions. | 12 | source |
contracts/remote-sandbox-provider | Use the Remote sandbox provider module for declaring and runtime-validating contracts. It exports 10 interfaces, 1 type. | 11 | source |
contracts/runtime | Use the Runtime module for declaring and runtime-validating contracts. It exports 6 constants, 8 interfaces, 6 types. | 20 | source |
contracts/runtime-activities | Use the Runtime activities module for declaring and runtime-validating contracts. It exports 3 constants, 9 interfaces, 8 types. | 20 | source |
contracts/runtime-activity | Use the Runtime activity module for declaring and runtime-validating contracts. It exports 2 constants, 1 interface, 1 type. | 4 | source |
contracts/runtime-activity-schemas | Use the Runtime activity schemas module for declaring and runtime-validating contracts. It exports 13 constants, 4 functions. | 17 | source |
contracts/runtime-cancellation | Use the Runtime cancellation module for declaring and runtime-validating contracts. It exports 4 constants, 10 interfaces, 4 types. | 18 | source |
contracts/runtime-cancellation-schemas | Use the Runtime cancellation schemas module for declaring and runtime-validating contracts. It exports 12 constants, 3 functions. | 15 | source |
contracts/runtime-capacity | Use the Runtime capacity module for declaring and runtime-validating contracts. It exports 1 constant, 12 interfaces, 1 type. | 14 | source |
contracts/runtime-capacity-schemas | Use the Runtime capacity schemas module for declaring and runtime-validating contracts. It exports 22 constants. | 22 | source |
contracts/runtime-checkpoint | Use the Runtime checkpoint module for declaring and runtime-validating contracts. It exports 4 constants, 8 interfaces, 4 types. | 16 | source |
contracts/runtime-checkpoint-schemas | Use the Runtime checkpoint schemas module for declaring and runtime-validating contracts. It exports 26 constants, 6 functions. | 32 | source |
contracts/runtime-control | Use the Runtime control module for declaring and runtime-validating contracts. It exports 2 constants, 4 interfaces, 3 types. | 9 | source |
contracts/runtime-control-schemas | Use the Runtime control schemas module for declaring and runtime-validating contracts. It exports 13 constants, 2 functions. | 15 | source |
contracts/runtime-coordination | Use the Runtime coordination module for declaring and runtime-validating contracts. It exports 3 constants, 28 interfaces, 3 types. | 34 | source |
contracts/runtime-coordination-schemas | Use the Runtime coordination schemas module for declaring and runtime-validating contracts. It exports 38 constants, 18 functions. | 56 | source |
contracts/runtime-helper-schemas | Use the Runtime helper schemas module for declaring and runtime-validating contracts. It exports 24 constants, 6 functions. | 30 | source |
contracts/runtime-helpers | Use the Runtime helpers module for declaring and runtime-validating contracts. It exports 2 constants, 27 interfaces, 4 types. | 33 | source |
contracts/runtime-human-task | Use the Runtime human task module for declaring and runtime-validating contracts. It exports 3 constants, 3 interfaces, 3 types. | 9 | source |
contracts/runtime-human-task-schemas | Use the Runtime human task schemas module for declaring and runtime-validating contracts. It exports 12 constants, 3 functions. | 15 | source |
contracts/runtime-integrity-audit | Use the Runtime integrity audit module for declaring and runtime-validating contracts. It exports 9 interfaces. | 9 | source |
contracts/runtime-message-schemas | Use the Runtime message schemas module for declaring and runtime-validating contracts. It exports 8 constants, 2 functions. | 10 | source |
contracts/runtime-messages | Use the Runtime messages module for declaring and runtime-validating contracts. It exports 3 constants, 4 interfaces, 3 types. | 10 | source |
contracts/runtime-projection | Use the Runtime projection module for declaring and runtime-validating contracts. It exports 5 interfaces, 1 type. | 6 | source |
contracts/runtime-projection-schemas | Use the Runtime projection schemas module for declaring and runtime-validating contracts. It exports 7 constants, 1 function. | 8 | source |
contracts/runtime-query | Use the Runtime query module for declaring and runtime-validating contracts. It exports 6 interfaces. | 6 | source |
contracts/runtime-query-schemas | Use the Runtime query schemas module for declaring and runtime-validating contracts. It exports 18 constants, 4 functions. | 22 | source |
contracts/runtime-recovery | Use the Runtime recovery module for declaring and runtime-validating contracts. It exports 5 constants, 15 interfaces, 5 types. | 25 | source |
contracts/runtime-recovery-schemas | Use the Runtime recovery schemas module for declaring and runtime-validating contracts. It exports 29 constants, 7 functions. | 36 | source |
contracts/runtime-replay | Use the Runtime replay module for declaring and runtime-validating contracts. It exports 1 constant, 6 interfaces, 1 type. | 8 | source |
contracts/runtime-replay-schemas | Use the Runtime replay schemas module for declaring and runtime-validating contracts. It exports 18 constants, 4 functions. | 22 | source |
contracts/runtime-schemas | Use the Runtime schemas module for declaring and runtime-validating contracts. It exports 40 constants, 8 functions. | 48 | source |
contracts/runtime-timer | Use the Runtime timer module for declaring and runtime-validating contracts. It exports 1 constant, 4 interfaces, 1 type. | 6 | source |
contracts/runtime-timer-schemas | Use the Runtime timer schemas module for declaring and runtime-validating contracts. It exports 10 constants, 2 functions. | 12 | source |
contracts/sandbox | Use the Sandbox module for declaring and runtime-validating contracts. It exports 19 interfaces, 1 type. | 20 | source |
contracts/sandbox-provider | Use the Sandbox provider module for declaring and runtime-validating contracts. It exports 6 interfaces, 3 types. | 9 | source |
contracts/session-queue | Use the Session queue module for declaring and runtime-validating contracts. It exports 5 constants, 20 interfaces, 2 types. | 27 | source |
contracts/session-queue-schemas | Use the Session queue schemas module for declaring and runtime-validating contracts. It exports 24 constants, 8 functions. | 32 | source |
contracts/workspace | Use the Workspace module for declaring and runtime-validating contracts. It exports 30 interfaces, 9 types. | 39 | source |
errors | Use the Errors module for normalizing, classifying, or exposing error contracts. It exports 1 class, 1 function, 1 interface. | 3 | source |
events | Use the Events module for creating, recording, or reading Event contracts. It exports 1 class, 1 function, 6 interfaces, 3 types. | 11 | source |
ids | Use the Ids module for using the public contracts and operations for this capability boundary. It exports 1 function, 1 interface, 1 type. | 3 | source |
modules/artifact/eventing | Use the Eventing module for creating, recording, or reading Event contracts. It exports 3 classes, 3 interfaces. | 6 | source |
modules/artifact/events | Use the Events module for creating, recording, or reading Event contracts. It exports 11 constants, 4 functions, 1 interface. | 16 | source |
modules/artifact/gc | Use the Gc module for using the public contracts and operations for this capability boundary. It exports 1 class, 1 function. | 2 | source |
modules/artifact/index | Use the Index module for using the public contracts and operations for this capability boundary. It exports 40 constants, 6 functions. | 46 | source |
modules/artifact/manager | Use the Manager module for using the public contracts and operations for this capability boundary. It exports 31 constants, 12 functions. | 43 | source |
modules/artifact/manager-content | Use the Manager content module for using the public contracts and operations for this capability boundary. It exports 1 function, 2 interfaces. | 3 | source |
modules/artifact/manager-error | Use the Manager error module for normalizing, classifying, or exposing error contracts. It exports 1 class, 5 functions. | 6 | source |
modules/artifact/manager-policy | Use the Manager policy module for applying policy and governance checks. It exports 6 functions, 1 type. | 7 | source |
modules/artifact/retention | Use the Retention module for using the public contracts and operations for this capability boundary. It exports 2 classes, 9 constants, 3 functions. | 14 | source |
modules/artifact/runtime | Use the Runtime module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/artifact/store | Use the Store module for persisting and reading data at this boundary. It exports 26 constants, 10 functions. | 36 | source |
modules/artifact/store-registry | Use the Store registry module for persisting and reading data at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/command-execution/index | Use the Index module for executing runtime behavior at this boundary. It exports 19 constants, 5 functions. | 24 | source |
modules/execution-activities/index | Use the Index module for executing runtime behavior at this boundary. It exports 11 constants, 3 functions. | 14 | source |
modules/execution-cache/index | Use the Index module for executing runtime behavior at this boundary. It exports 23 constants, 9 functions. | 32 | source |
modules/execution-cache/runtime | Use the Runtime module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/execution-environment/index | Use the Index module for executing runtime behavior at this boundary. It exports 17 constants, 1 function. | 18 | source |
modules/execution-events/index | Use the Index module for creating, recording, or reading Event contracts. It exports 19 constants, 3 functions. | 22 | source |
modules/execution-governance/contracts | Use the Contracts module for declaring and runtime-validating contracts. It exports 10 constants, 2 functions. | 12 | source |
modules/execution-governance/risk-evaluator | Use the Risk evaluator module for executing runtime behavior at this boundary. It exports 1 class, 1 constant. | 2 | source |
modules/execution-human-task/index | Use the Index module for executing runtime behavior at this boundary. It exports 7 constants, 3 functions, 1 interface. | 11 | source |
modules/execution-output/collector | Use the Collector module for executing runtime behavior at this boundary. It exports 1 class. | 1 | source |
modules/execution-output/completion | Use the Completion module for executing runtime behavior at this boundary. It exports 2 classes, 1 function, 7 interfaces. | 10 | source |
modules/execution-output/contracts | Use the Contracts module for declaring and runtime-validating contracts. It exports 17 constants, 4 functions. | 21 | source |
modules/execution-output/planner | Use the Planner module for executing runtime behavior at this boundary. It exports 1 class, 1 function. | 2 | source |
modules/execution-port/contracts | Use the Contracts module for declaring and runtime-validating contracts. It exports 10 constants, 3 functions. | 13 | source |
modules/execution-port/governed-execution-port | Use the Governed execution port module for defining or implementing provider-neutral ports. It exports 1 class. | 1 | source |
modules/execution-store/durable-execution-worker | Use the Durable execution worker module for persisting and reading data at this boundary. It exports 3 classes, 2 interfaces. | 5 | source |
modules/execution-store/index | Use the Index module for persisting and reading data at this boundary. It exports 37 constants, 11 functions. | 48 | source |
modules/execution-store/registry | Use the Registry module for persisting and reading data at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/execution/index | Use the Index module for executing runtime behavior at this boundary. It exports 5 constants, 2 functions. | 7 | source |
modules/execution/recovery | Use the Recovery module for executing runtime behavior at this boundary. It exports 2 functions, 2 interfaces, 1 type. | 5 | source |
modules/remote-sandbox-provider/index | Use the Index module for binding external or local providers to Hypha ports. It exports 1 class, 28 constants, 9 functions, 1 interface. | 39 | source |
modules/runtime/canonical-json | Use the Canonical JSON module for executing runtime behavior at this boundary. It exports 2 functions, 1 type. | 3 | source |
modules/runtime/event-runtime | Use the Event runtime module for creating, recording, or reading Event contracts. It exports 1 class, 1 function, 6 interfaces, 1 type. | 9 | source |
modules/runtime/event-schema-registry | Use the Event schema registry module for declaring and runtime-validating contracts. It exports 1 class, 5 interfaces. | 6 | source |
modules/runtime/event-store | Use the Event store module for creating, recording, or reading Event contracts. It exports 1 class, 8 functions, 8 interfaces. | 17 | source |
modules/runtime/legacy-wait-migration | Use the Legacy wait migration module for executing runtime behavior at this boundary. It exports 1 constant, 2 functions, 3 interfaces, 1 type. | 7 | source |
modules/runtime/message-bus | Use the Message bus module for executing runtime behavior at this boundary. It exports 1 class, 7 functions, 6 interfaces. | 14 | source |
modules/runtime/message-inbox-outbox | Use the Message inbox outbox module for executing runtime behavior at this boundary. It exports 4 classes, 8 interfaces. | 12 | source |
modules/runtime/orchestration-event-schemas | Use the Orchestration event schemas module for declaring and runtime-validating contracts. It exports 8 constants, 2 functions, 4 types. | 14 | source |
modules/runtime/orchestration-projection | Use the Orchestration projection module for executing runtime behavior at this boundary. It exports 2 constants, 2 functions. | 4 | source |
modules/runtime/projection | Use the Projection module for executing runtime behavior at this boundary. It exports 2 classes, 1 function, 4 interfaces. | 7 | source |
modules/runtime/resource-coordinator | Use the Resource coordinator module for executing runtime behavior at this boundary. It exports 1 class, 1 function, 1 interface. | 3 | source |
modules/runtime/run-control | Use the Run control module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/run-lease-store | Use the Run lease store module for persisting and reading data at this boundary. It exports 1 class, 2 functions, 1 interface. | 4 | source |
modules/runtime/runtime-activity-descriptor-store | Use the Runtime activity descriptor store module for persisting and reading data at this boundary. It exports 1 class, 3 interfaces. | 4 | source |
modules/runtime/runtime-activity-helper | Use the Runtime activity helper module for executing runtime behavior at this boundary. It exports 2 classes, 1 interface. | 3 | source |
modules/runtime/runtime-activity-redispatch-service | Use the Runtime activity redispatch service module for executing runtime behavior at this boundary. It exports 1 class, 1 function, 6 interfaces, 1 type. | 9 | source |
modules/runtime/runtime-cancellation-service | Use the Runtime cancellation service module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/runtime-capacity-semaphore | Use the Runtime capacity semaphore module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/runtime-checkpoint-service | Use the Runtime checkpoint service module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/runtime-checkpoint-store | Use the Runtime checkpoint store module for persisting and reading data at this boundary. It exports 1 class, 2 functions. | 3 | source |
modules/runtime/runtime-helper-sdk | Use the Runtime helper sdk module for executing runtime behavior at this boundary. It exports 5 classes, 2 functions, 1 interface. | 8 | source |
modules/runtime/runtime-human-task | Use the Runtime human task module for executing runtime behavior at this boundary. It exports 5 functions. | 5 | source |
modules/runtime/runtime-human-wait-service | Use the Runtime human wait service module for executing runtime behavior at this boundary. It exports 1 class, 5 interfaces. | 6 | source |
modules/runtime/runtime-io-helpers | Use the Runtime io helpers module for executing runtime behavior at this boundary. It exports 3 classes, 1 function, 1 interface. | 5 | source |
modules/runtime/runtime-operational-telemetry | Use the Runtime operational telemetry module for executing runtime behavior at this boundary. It exports 1 class, 1 constant, 1 interface, 3 types. | 6 | source |
modules/runtime/runtime-query-service | Use the Runtime query service module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/runtime-recovery-service | Use the Runtime recovery service module for executing runtime behavior at this boundary. It exports 1 class, 2 interfaces. | 3 | source |
modules/runtime/runtime-replay-service | Use the Runtime replay service module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/runtime-timer-worker | Use the Runtime timer worker module for executing runtime behavior at this boundary. It exports 1 class, 1 interface. | 2 | source |
modules/runtime/session-command-payload-store | Use the Session command payload store module for persisting and reading data at this boundary. It exports 1 class, 3 interfaces, 1 type. | 5 | source |
modules/runtime/session-command-scheduler | Use the Session command scheduler module for executing runtime behavior at this boundary. It exports 1 class, 4 interfaces. | 5 | source |
modules/runtime/session-command-worker | Use the Session command worker module for executing runtime behavior at this boundary. It exports 1 class, 3 interfaces, 3 types. | 7 | source |
modules/runtime/session-queue | Use the Session queue module for executing runtime behavior at this boundary. It exports 1 class, 1 function, 2 interfaces. | 4 | source |
modules/runtime/state-execution-claim-store | Use the State execution claim store module for persisting and reading data at this boundary. It exports 1 class, 2 functions, 1 interface. | 4 | source |
modules/sandbox-provider/index | Use the Index module for binding external or local providers to Hypha ports. It exports 13 constants, 4 functions. | 17 | source |
modules/sandbox-provider/registry | Use the Registry module for binding external or local providers to Hypha ports. It exports 1 class, 1 interface. | 2 | source |
modules/sandbox/index | Use the Index module for using the public contracts and operations for this capability boundary. It exports 15 constants, 8 functions. | 23 | source |
modules/workspace/events | Use the Events module for declaring and enforcing workspace scope boundaries. It exports 6 constants, 3 functions. | 9 | source |
modules/workspace/index | Use the Index module for declaring and enforcing workspace scope boundaries. It exports 25 constants, 3 functions. | 28 | source |
modules/workspace/operations | Use the Operations module for declaring and enforcing workspace scope boundaries. It exports 18 constants, 10 functions. | 28 | source |
modules/workspace/snapshots | Use the Snapshots module for declaring and enforcing workspace scope boundaries. It exports 16 constants, 10 functions. | 26 | source |
schemas | Use the Schemas module for declaring and runtime-validating contracts. It exports 52 constants, 12 functions, 1 interface. | 65 | source |
specs | Use the Specs module for declaring and runtime-validating contracts. It exports 2 constants, 2 functions, 22 interfaces, 2 types. | 28 | source |
telemetry | Use the Telemetry module for using the public contracts and operations for this capability boundary. It exports 1 class, 2 interfaces, 1 type. | 4 | source |
Import boundary
This page documents only the public API exported by the @codesoul-co/hypha-core package entrypoint. Implementations under packages/core/src that are not exported from that entrypoint are not part of the npm package contract.