arvo-event-handler 3.0.7 → 3.0.10

package/dist/ArvoOrchestrator/types.d.ts

@@ -1,9 +1,11 @@
 import type { ArvoEvent, InferArvoEvent } from 'arvo-core';
 import type { Snapshot } from 'xstate';
 import type ArvoMachine from '../ArvoMachine';
+import type { OrchestrationExecutionMemoryRecord } from '../ArvoOrchestrationUtils/orchestrationExecutionState';
 import type { IMachineExectionEngine } from '../MachineExecutionEngine/interface';
 import type { IMachineMemory } from '../MachineMemory/interface';
 import type { IMachineRegistry } from '../MachineRegistry/interface';
+import type { ArvoEventHandlerOtelSpanOptions } from '../types';
 export type TryFunctionOutput<TData, TError extends Error> = {
     type: 'success';
     data: TData;
@@ -14,7 +16,7 @@ export type TryFunctionOutput<TData, TError extends Error> = {
 /**
  * Represents the state record stored in machine memory.
  */
-export type MachineMemoryRecord = {
+export type MachineMemoryRecord = OrchestrationExecutionMemoryRecord<{
     /** Unique identifier for the machine instance */
     subject: string;
     /**
@@ -67,7 +69,7 @@ export type MachineMemoryRecord = {
     };
     /** Machine definition string */
     machineDefinition: string | null;
-};
+}>;
 /**
  * Interface defining the core components of an Arvo orchestrator.
  */
@@ -81,24 +83,6 @@ export type ArvoOrchestratorParam = {
     /** Engine responsible for machine execution */
     executionEngine: IMachineExectionEngine;
     requiresResourceLocking: boolean;
-    /**
-     * Optional configuration to customize where system error events are emitted.
-     */
-    systemErrorDomain?: (string | null)[];
-};
-/**
- * Configuration interface for creating an Arvo orchestrator instance.
- */
-export interface ICreateArvoOrchestrator {
-    /** Memory interface for storing and retrieving machine state */
-    memory: IMachineMemory<MachineMemoryRecord>;
-    /** The cost of the execution of the orchestrator */
-    executionunits: number;
-    /**
-     * Collection of state machines to be managed by the orchestrator.
-     * All machines must have the same source identifier.
-     */
-    machines: ArvoMachine<any, any, any, any, any>[];
     /**
      * Optional configuration to customize where system error events are emitted.
      *
@@ -113,4 +97,18 @@ export interface ICreateArvoOrchestrator {
      * @default undefined — uses standard fallback broadcast domains
      */
     systemErrorDomain?: (string | null)[];
-}
+    /**
+     * The OpenTelemetry span options
+     */
+    spanOptions?: ArvoEventHandlerOtelSpanOptions;
+};
+/**
+ * Configuration interface for creating an Arvo orchestrator instance.
+ */
+export type CreateArvoOrchestratorParam = Pick<ArvoOrchestratorParam, 'memory' | 'executionunits' | 'spanOptions' | 'systemErrorDomain'> & {
+    /**
+     * Collection of state machines to be managed by the orchestrator.
+     * All machines must have the same source identifier.
+     */
+    machines: ArvoMachine<any, any, any, any, any>[];
+};

package/dist/ArvoResumable/factory.d.ts

@@ -1,7 +1,8 @@
 import type { ArvoOrchestratorContract, VersionedArvoContract } from 'arvo-core';
-import type { ArvoResumableHandler, ArvoResumableState } from './types';
-import type { IMachineMemory } from '../MachineMemory/interface';
 import { ArvoResumable } from '.';
+import type { IMachineMemory } from '../MachineMemory/interface';
+import type { ArvoEventHandlerOtelSpanOptions } from '../types';
+import type { ArvoResumableHandler, ArvoResumableState } from './types';
 /**
  * Factory function for creating ArvoResumable orchestrator instances
  *
@@ -39,4 +40,5 @@ export declare const createArvoResumable: <TMemory extends Record<string, any>,
     executionunits?: number;
     requiresResourceLocking?: boolean;
     systemErrorDomain?: (string | null)[];
+    spanOptions?: ArvoEventHandlerOtelSpanOptions;
 }) => ArvoResumable<TMemory, TSelfContract, TServiceContract>;

package/dist/ArvoResumable/factory.js

@@ -1,20 +1,8 @@
 "use strict";
-var __assign = (this && this.__assign) || function () {
-    __assign = Object.assign || function(t) {
-        for (var s, i = 1, n = arguments.length; i < n; i++) {
-            s = arguments[i];
-            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
-                t[p] = s[p];
-        }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createArvoResumable = void 0;
 var _1 = require(".");
-var utils_1 = require("../ArvoMachine/utils");
-var uuid_1 = require("uuid");
+var servicesValidation_1 = require("../ArvoOrchestrationUtils/servicesValidation");
 /**
  * Factory function for creating ArvoResumable orchestrator instances
  *
@@ -40,23 +28,16 @@ var uuid_1 = require("uuid");
  * @throws {Error} Circular dependency detected - Self contract is registered as a service, creating execution loops
  */
 var createArvoResumable = function (param) {
-    var _a;
-    var _b, _c;
-    var __areServiceContractsUnique = (0, utils_1.areServiceContractsUnique)(param.contracts.services);
-    if (!__areServiceContractsUnique.result) {
-        throw new Error("The service contracts must have unique URIs. Multiple versions of the same contract are not allow. The contracts '".concat(__areServiceContractsUnique.keys[0], "' and '").concat(__areServiceContractsUnique.keys[1], "' have the same URI '").concat(__areServiceContractsUnique.contractUri, "'"));
-    }
-    var __checkIfSelfIsAService = (0, utils_1.areServiceContractsUnique)(__assign(__assign({}, param.contracts.services), (_a = {}, _a[(0, uuid_1.v4)()] = param.contracts.self, _a)));
-    if (!__checkIfSelfIsAService.result) {
-        throw new Error("Circular dependency detected: Machine with URI '".concat(param.contracts.self.uri, "' is registered as service '").concat(__checkIfSelfIsAService.keys[1], "'. Self-referential services create execution loops and are prohibited."));
-    }
+    var _a, _b;
+    (0, servicesValidation_1.servicesValidation)(param.contracts, 'resumable');
     return new _1.ArvoResumable({
         contracts: param.contracts,
         memory: param.memory,
         handler: param.handler,
-        executionunits: (_b = param.executionunits) !== null && _b !== void 0 ? _b : 0,
-        requiresResourceLocking: (_c = param.requiresResourceLocking) !== null && _c !== void 0 ? _c : Object.keys(param.contracts.services).length > 1,
+        executionunits: (_a = param.executionunits) !== null && _a !== void 0 ? _a : 0,
+        requiresResourceLocking: (_b = param.requiresResourceLocking) !== null && _b !== void 0 ? _b : Object.keys(param.contracts.services).length > 1,
         systemErrorDomain: param.systemErrorDomain,
+        spanOptions: param.spanOptions,
     });
 };
 exports.createArvoResumable = createArvoResumable;

package/dist/ArvoResumable/index.d.ts

@@ -1,11 +1,11 @@
-import { type ArvoEvent, type ArvoOrchestratorContract, type VersionedArvoContract, type OpenTelemetryHeaders, type ArvoSemanticVersion } from 'arvo-core';
+import { type Span } from '@opentelemetry/api';
+import { type ArvoEvent, type ArvoOrchestratorContract, type VersionedArvoContract } from 'arvo-core';
 import type { z } from 'zod';
-import type { ArvoResumableHandler, ArvoResumableState } from './types';
+import type IArvoEventHandler from '../IArvoEventHandler';
 import type { IMachineMemory } from '../MachineMemory/interface';
 import { SyncEventResource } from '../SyncEventResource/index';
-import type { EnqueueArvoEventActionParam } from '../ArvoMachine/types';
-import IArvoEventHandler from '../IArvoEventHandler';
-import type { ArvoEventHandlerOpenTelemetryOptions } from '../types';
+import type { ArvoEventHandlerOpenTelemetryOptions, ArvoEventHandlerOtelSpanOptions } from '../types';
+import type { ArvoResumableHandler, ArvoResumableState } from './types';
 /**
  * ArvoResumable - A stateful orchestration handler for managing distributed workflows
  *
@@ -43,6 +43,7 @@ export declare class ArvoResumable<TMemory extends Record<string, any> = Record<
     readonly source: string;
     readonly handler: ArvoResumableHandler<ArvoResumableState<TMemory>, TSelfContract, TServiceContract>;
     readonly systemErrorDomain?: (string | null)[];
+    private readonly spanOptions;
     readonly contracts: {
         self: TSelfContract;
         services: TServiceContract;
@@ -60,24 +61,11 @@ export declare class ArvoResumable<TMemory extends Record<string, any> = Record<
         requiresResourceLocking?: boolean;
         handler: ArvoResumableHandler<ArvoResumableState<TMemory>, TSelfContract, TServiceContract>;
         systemErrorDomain?: (string | null)[];
+        spanOptions?: ArvoEventHandlerOtelSpanOptions;
     });
-    protected validateInput(event: ArvoEvent): {
+    protected validateInput(event: ArvoEvent, span: Span): {
         contractType: 'self' | 'service';
     };
-    /**
-     * Creates emittable event from execution result
-     * @param event - Source event to emit
-     * @param otelHeaders - OpenTelemetry headers
-     * @param orchestrationParentSubject - Parent orchestration subject
-     * @param sourceEvent - Original triggering event
-     * @param selfVersionedContract - The self versioned contract
-     * @param initEventId - The id of the event which initiated the orchestration in the first place
-     * @param _domain - The domain of the event.
-     *
-     * @throws {ContractViolation} On schema/contract mismatch
-     * @throws {ExecutionViolation} On invalid parentSubject$$ format
-     */
-    protected createEmittableEvent(event: EnqueueArvoEventActionParam, otelHeaders: OpenTelemetryHeaders, orchestrationParentSubject: string | null, sourceEvent: ArvoEvent, selfVersionedContract: VersionedArvoContract<TSelfContract, ArvoSemanticVersion>, initEventId: string, _domain: string | null): ArvoEvent;
     /**
      * Executes the orchestration workflow for an incoming event
      *
@@ -91,7 +79,7 @@ export declare class ArvoResumable<TMemory extends Record<string, any> = Record<
      * @throws {ContractViolation} When event schema validation fails
      * @throws {ExecutionViolation} When workflow execution encounters critical errors
      */
-    execute(event: ArvoEvent, opentelemetry: ArvoEventHandlerOpenTelemetryOptions): Promise<{
+    execute(event: ArvoEvent, opentelemetry?: ArvoEventHandlerOpenTelemetryOptions): Promise<{
         events: ArvoEvent[];
     }>;
     get systemErrorSchema(): import("arvo-core").ArvoContractRecord<`sys.arvo.orc.${string}.error`, z.ZodObject<{