@codesoul-co/hypha-core / modules/runtime/orchestration-projection

• Package index: @codesoul-co/hypha-core
• Source: packages/core/src/modules/runtime/orchestration-projection.ts
• Exports: 4

Using this module

Use the Orchestration projection module for executing runtime behavior at this boundary. It exports 2 constants, 2 functions.

Import from the package entrypoint

import {
  RUNTIME_ORCHESTRATION_PROJECTION_ID,
  RUNTIME_ORCHESTRATION_PROJECTION_VERSION,
  createRuntimeOrchestrationProjectionDefinition,
  reduceRuntimeOrchestrationProjection,
} from '@codesoul-co/hypha-core';

Usage patterns

• The module exposes 2 functions as direct operation entrypoints. Every overload, required/optional parameter, and return type is documented below.
• The 2 constant/enum exports provide stable values, schemas, definitions, or defaults. Reuse these exports instead of copying internal values into an application.

Public exports

Symbol	Kind	Signature	Description
RUNTIME_ORCHESTRATION_PROJECTION_ID	constant	const RUNTIME_ORCHESTRATION_PROJECTION_ID: "runtime.orchestration"	RUNTIME ORCHESTRATION PROJECTION ID constant exported by the modules/runtime/orchestration-projection module.
RUNTIME_ORCHESTRATION_PROJECTION_VERSION	constant	const RUNTIME_ORCHESTRATION_PROJECTION_VERSION: "1.5.0"	RUNTIME ORCHESTRATION PROJECTION VERSION constant exported by the modules/runtime/orchestration-projection module.
createRuntimeOrchestrationProjectionDefinition	function	createRuntimeOrchestrationProjectionDefinition(runId: string): ProjectionDefinition<RuntimeOrchestrationProjection>	Create Runtime Orchestration Projection Definition function with 1 public call signature; parameters and return types are listed below.
reduceRuntimeOrchestrationProjection	function	reduceRuntimeOrchestrationProjection(state: RuntimeOrchestrationProjection, event: PersistedFrameworkEvent): RuntimeOrchestrationProjection	Reduce Runtime Orchestration Projection function with 1 public call signature; parameters and return types are listed below.

RUNTIME_ORCHESTRATION_PROJECTION_ID

RUNTIME ORCHESTRATION PROJECTION ID constant exported by the modules/runtime/orchestration-projection module.

• Kind: constant
• Import: import { RUNTIME_ORCHESTRATION_PROJECTION_ID } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/orchestration-projection

Declaration

export declare const RUNTIME_ORCHESTRATION_PROJECTION_ID: "runtime.orchestration";

RUNTIME_ORCHESTRATION_PROJECTION_VERSION

RUNTIME ORCHESTRATION PROJECTION VERSION constant exported by the modules/runtime/orchestration-projection module.

• Kind: constant
• Import: import { RUNTIME_ORCHESTRATION_PROJECTION_VERSION } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/orchestration-projection

Declaration

export declare const RUNTIME_ORCHESTRATION_PROJECTION_VERSION: "1.5.0";

createRuntimeOrchestrationProjectionDefinition

Create Runtime Orchestration Projection Definition function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { createRuntimeOrchestrationProjectionDefinition } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/orchestration-projection

Declaration

export declare function createRuntimeOrchestrationProjectionDefinition(runId: string): ProjectionDefinition<RuntimeOrchestrationProjection>;

Call signature

createRuntimeOrchestrationProjectionDefinition(runId: string): ProjectionDefinition<RuntimeOrchestrationProjection>

Parameters

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

Returns

• Type: ProjectionDefinition<RuntimeOrchestrationProjection>
• Description: The return contract is defined by the type shown above.

reduceRuntimeOrchestrationProjection

Reduce Runtime Orchestration Projection function with 1 public call signature; parameters and return types are listed below.

• Kind: function
• Import: import { reduceRuntimeOrchestrationProjection } from '@codesoul-co/hypha-core';
• Source module: modules/runtime/orchestration-projection

Declaration

export declare function reduceRuntimeOrchestrationProjection(state: RuntimeOrchestrationProjection, event: PersistedFrameworkEvent): RuntimeOrchestrationProjection;

Call signature

reduceRuntimeOrchestrationProjection(state: RuntimeOrchestrationProjection, event: PersistedFrameworkEvent): RuntimeOrchestrationProjection

Parameters

Parameter	Type	Required	Description
state	RuntimeOrchestrationProjection	Yes	Required parameter; accepted values are defined by the type column.
event	PersistedFrameworkEvent<unknown>	Yes	Required parameter; accepted values are defined by the type column.

Returns

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