arvo-core 1.1.16 → 1.1.17

package/dist/ArvoEvent/helpers.d.ts

@@ -1,5 +1,6 @@
 import ArvoEvent from '.';
 import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
+import { ExecutionOpenTelemetryConfiguration } from '../types';
 /**
  * Creates an ArvoEvent with the provided data and extensions.
  *
@@ -35,4 +36,4 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  *   { customextension: 'value' },
  * );
  */
-export declare const createArvoEvent: <TData extends ArvoEventData, TExtension extends CloudEventExtension, TType extends string>(event: CreateArvoEvent<TData, TType>, extensions?: TExtension) => ArvoEvent<TData, TExtension, TType>;
+export declare const createArvoEvent: <TData extends ArvoEventData, TExtension extends CloudEventExtension, TType extends string>(event: CreateArvoEvent<TData, TType>, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration) => ArvoEvent<TData, TExtension, TType>;

package/dist/ArvoEvent/helpers.js

@@ -45,8 +45,11 @@ var uuid_1 = require("uuid");
  *   { customextension: 'value' },
  * );
  */
-var createArvoEvent = function (event, extensions) {
-    var span = OpenTelemetry_1.ArvoCoreTracer.startSpan("createArvoEvent<".concat(event.type, ">"), {});
+var createArvoEvent = function (event, extensions, opentelemetry) {
+    if (opentelemetry === void 0) { opentelemetry = {
+        tracer: OpenTelemetry_1.ArvoCoreTracer,
+    }; }
+    var span = opentelemetry.tracer.startSpan("createArvoEvent<".concat(event.type, ">"), {});
     return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
         span.setStatus({ code: api_1.SpanStatusCode.OK });

package/dist/ArvoEventFactory/index.d.ts

@@ -1,6 +1,7 @@
 import ArvoContract from '../ArvoContract';
 import { z } from 'zod';
 import { CreateArvoEvent } from '../ArvoEvent/types';
+import { ExecutionOpenTelemetryConfiguration } from '../types';
 /**
  * A factory class for creating contractual ArvoEvents based on a given ArvoContract.
  *
@@ -26,7 +27,7 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
      * @returns The created ArvoEvent as per the accept record of the contract.
      * @throws If the event data fails validation against the contract.
      */
-    accepts<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TAcceptSchema>, TType>, 'type' | 'datacontenttype' | 'dataschema'>, extensions?: TExtension): import("..").ArvoEvent<z.TypeOf<TAcceptSchema>, TExtension, TType>;
+    accepts<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TAcceptSchema>, TType>, 'type' | 'datacontenttype' | 'dataschema'>, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration): import("..").ArvoEvent<z.TypeOf<TAcceptSchema>, TExtension, TType>;
     /**
      * Creates an ArvoEvent as per one of the emits record in the contract.
      *
@@ -37,7 +38,7 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
      * @returns The created ArvoEvent as per one of the emits records of the contract.
      * @throws If the event data fails validation against the contract.
      */
-    emits<U extends keyof TEmits & string, TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TEmits[U]>, U>, 'datacontenttype' | 'dataschema'>, extensions?: TExtension): import("..").ArvoEvent<z.TypeOf<TEmits[U]>, TExtension, U>;
+    emits<U extends keyof TEmits & string, TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TEmits[U]>, U>, 'datacontenttype' | 'dataschema'>, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration): import("..").ArvoEvent<z.TypeOf<TEmits[U]>, TExtension, U>;
     /**
      * Creates a system error ArvoEvent.
      *
@@ -48,7 +49,7 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
      */
     systemError<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<any, any>, 'data' | 'type' | 'datacontenttype' | 'dataschema'> & {
         error: Error;
-    }, extensions?: TExtension): import("..").ArvoEvent<{
+    }, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration): import("..").ArvoEvent<{
         errorMessage: string;
         errorName: string;
         errorStack: string | null;

package/dist/ArvoEventFactory/index.js

@@ -52,9 +52,12 @@ var ArvoEventFactory = /** @class */ (function () {
      * @returns The created ArvoEvent as per the accept record of the contract.
      * @throws If the event data fails validation against the contract.
      */
-    ArvoEventFactory.prototype.accepts = function (event, extensions) {
+    ArvoEventFactory.prototype.accepts = function (event, extensions, opentelemetry) {
         var _this = this;
-        var span = OpenTelemetry_1.ArvoCoreTracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.accepts<").concat(this.contract.accepts.type, ">.create"));
+        if (opentelemetry === void 0) { opentelemetry = {
+            tracer: OpenTelemetry_1.ArvoCoreTracer,
+        }; }
+        var span = opentelemetry.tracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.accepts<").concat(this.contract.accepts.type, ">.create"));
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
             var _a, _b, _c, _d;
             span.setStatus({ code: api_1.SpanStatusCode.OK });
@@ -64,7 +67,7 @@ var ArvoEventFactory = /** @class */ (function () {
                 if (!validationResult.success) {
                     throw new Error("Accept Event data validation failed: ".concat(validationResult.error.message));
                 }
-                return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { traceparent: (_b = (_a = event.traceparent) !== null && _a !== void 0 ? _a : otelHeaders.traceparent) !== null && _b !== void 0 ? _b : undefined, tracestate: (_d = (_c = event.tracestate) !== null && _c !== void 0 ? _c : otelHeaders.tracestate) !== null && _d !== void 0 ? _d : undefined, type: _this.contract.accepts.type, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions);
+                return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { traceparent: (_b = (_a = event.traceparent) !== null && _a !== void 0 ? _a : otelHeaders.traceparent) !== null && _b !== void 0 ? _b : undefined, tracestate: (_d = (_c = event.tracestate) !== null && _c !== void 0 ? _c : otelHeaders.tracestate) !== null && _d !== void 0 ? _d : undefined, type: _this.contract.accepts.type, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, opentelemetry);
             }
             catch (error) {
                 (0, OpenTelemetry_1.exceptionToSpan)(error);
@@ -89,9 +92,12 @@ var ArvoEventFactory = /** @class */ (function () {
      * @returns The created ArvoEvent as per one of the emits records of the contract.
      * @throws If the event data fails validation against the contract.
      */
-    ArvoEventFactory.prototype.emits = function (event, extensions) {
+    ArvoEventFactory.prototype.emits = function (event, extensions, opentelemetry) {
         var _this = this;
-        var span = OpenTelemetry_1.ArvoCoreTracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.emits<").concat(event.type, ">.create"));
+        if (opentelemetry === void 0) { opentelemetry = {
+            tracer: OpenTelemetry_1.ArvoCoreTracer,
+        }; }
+        var span = opentelemetry.tracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.emits<").concat(event.type, ">.create"));
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
             var _a, _b, _c, _d;
             span.setStatus({ code: api_1.SpanStatusCode.OK });
@@ -101,7 +107,7 @@ var ArvoEventFactory = /** @class */ (function () {
                 if (!validationResult.success) {
                     throw new Error("Emit Event data validation failed: ".concat(validationResult.error.message));
                 }
-                return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { traceparent: (_b = (_a = event.traceparent) !== null && _a !== void 0 ? _a : otelHeaders.traceparent) !== null && _b !== void 0 ? _b : undefined, tracestate: (_d = (_c = event.tracestate) !== null && _c !== void 0 ? _c : otelHeaders.tracestate) !== null && _d !== void 0 ? _d : undefined, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions);
+                return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { traceparent: (_b = (_a = event.traceparent) !== null && _a !== void 0 ? _a : otelHeaders.traceparent) !== null && _b !== void 0 ? _b : undefined, tracestate: (_d = (_c = event.tracestate) !== null && _c !== void 0 ? _c : otelHeaders.tracestate) !== null && _d !== void 0 ? _d : undefined, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, opentelemetry);
             }
             catch (error) {
                 (0, OpenTelemetry_1.exceptionToSpan)(error);
@@ -124,9 +130,12 @@ var ArvoEventFactory = /** @class */ (function () {
      * @param [extensions] - Optional extensions to add to the event.
      * @returns The created system error ArvoEvent.
      */
-    ArvoEventFactory.prototype.systemError = function (event, extensions) {
+    ArvoEventFactory.prototype.systemError = function (event, extensions, opentelemetry) {
         var _this = this;
-        var span = OpenTelemetry_1.ArvoCoreTracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.systemError<sys.").concat(this.contract.accepts.type, ".error>.create"));
+        if (opentelemetry === void 0) { opentelemetry = {
+            tracer: OpenTelemetry_1.ArvoCoreTracer,
+        }; }
+        var span = opentelemetry.tracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.systemError<sys.").concat(this.contract.accepts.type, ".error>.create"));
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
             var _a, _b, _c, _d, _e;
             span.setStatus({ code: api_1.SpanStatusCode.OK });
@@ -137,7 +146,7 @@ var ArvoEventFactory = /** @class */ (function () {
                         errorName: error.name,
                         errorMessage: error.message,
                         errorStack: (_e = error.stack) !== null && _e !== void 0 ? _e : null,
-                    }, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri }), extensions);
+                    }, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri }), extensions, opentelemetry);
             }
             catch (error) {
                 (0, OpenTelemetry_1.exceptionToSpan)(error);

package/dist/ArvoOrchestratorContract/schema.js

@@ -8,8 +8,7 @@ var utils_1 = require("../utils");
  * This schema is used to validate and type-check the minimal required fields
  * for an orchestrator to accept a task or event.
  */
-exports.OrchestrationInitEventBaseSchema = zod_1.z
-    .object({
+exports.OrchestrationInitEventBaseSchema = zod_1.z.object({
     parentSubject$$: zod_1.z
         .string()
         .min(1, 'The parent subject must not be an empty string')

package/dist/index.d.ts

@@ -28,6 +28,7 @@ import { createArvoOrchestratorContract } from './ArvoOrchestratorContract/helpe
 import ArvoOrchestratorContract from './ArvoOrchestratorContract';
 import { ICreateArvoOrchestratorContract, IArvoOrchestratorContract } from './ArvoOrchestratorContract/types';
 import { ArvoOrchestratorEventTypeGen } from './ArvoOrchestratorContract/typegen';
+import { ExecutionOpenTelemetryConfiguration } from './types';
 /**
  * Collection of Zod schemas for validating various aspects of Arvo events.
  * @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
@@ -102,4 +103,4 @@ declare const ArvoEventSchemas: {
         parentSubject$$: string | null;
     }>;
 };
-export { ArvoEventHttpConfig, ArvoEventHttp, ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContentSchema, ArvoOrchestratorVersionSchema, ArvoOrchestrationSubjectContent, ArvoOrchestratorVersion, InferArvoEvent, InferArvoContract, InferArvoContractType, createArvoOrchestratorContract, ArvoOrchestratorContract, ICreateArvoOrchestratorContract, IArvoOrchestratorContract, InferArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, };
+export { ArvoEventHttpConfig, ArvoEventHttp, ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContentSchema, ArvoOrchestratorVersionSchema, ArvoOrchestrationSubjectContent, ArvoOrchestratorVersion, InferArvoEvent, InferArvoContract, InferArvoContractType, createArvoOrchestratorContract, ArvoOrchestratorContract, ICreateArvoOrchestratorContract, IArvoOrchestratorContract, InferArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, ExecutionOpenTelemetryConfiguration, };

package/dist/types.d.ts

@@ -3,6 +3,20 @@ import ArvoContract from './ArvoContract';
 import ArvoEvent from './ArvoEvent';
 import { ArvoExtension, OpenTelemetryExtension } from './ArvoEvent/types';
 import ArvoOrchestratorContract from './ArvoOrchestratorContract';
+import { Tracer } from '@opentelemetry/api';
+/**
+ * Configuration options for OpenTelemetry integration in execution context.
+ *
+ * This type defines how tracing should be configured and inherited within
+ * the execution pipeline.
+ */
+export type ExecutionOpenTelemetryConfiguration = {
+    /**
+     * Optional OpenTelemetry tracer instance to use for creating spans.
+     * If not provided, a default tracer may be used depending on the implementation.
+     */
+    tracer: Tracer;
+};
 /**
  * A type utility that infers the structure of an ArvoEvent.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-core",
-  "version": "1.1.16",
+  "version": "1.1.17",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {