arvo-core 1.1.17 → 1.1.19

package/dist/ArvoContract/helpers.js

@@ -35,10 +35,10 @@ var utils_1 = require("../utils");
  */
 var createArvoContract = function (contract) {
     var createErrorMessage = function (source, type) {
-        return (0, utils_1.cleanString)("\n    In contract (uri=".concat(contract.uri, "), the '").concat(source, "' event (type=").concat(type, ") must not start \n    with '").concat(typegen_1.ArvoOrchestratorEventTypeGen.__prefix, "' becuase this a reserved pattern \n    for Arvo orchestrators.\n  "));
+        return (0, utils_1.cleanString)("\n    In contract (uri=".concat(contract.uri, "), the '").concat(source, "' event (type=").concat(type, ") must not start \n    with '").concat(typegen_1.ArvoOrchestratorEventTypeGen.prefix, "' becuase this a reserved pattern \n    for Arvo orchestrators.\n  "));
     };
     var validator = function (value) {
-        return value.startsWith(typegen_1.ArvoOrchestratorEventTypeGen.__prefix);
+        return value.startsWith(typegen_1.ArvoOrchestratorEventTypeGen.prefix);
     };
     if (validator(contract.accepts.type)) {
         throw new Error(createErrorMessage('accepts', contract.accepts.type));

package/dist/ArvoEvent/helpers.js

@@ -47,7 +47,7 @@ var uuid_1 = require("uuid");
  */
 var createArvoEvent = function (event, extensions, opentelemetry) {
     if (opentelemetry === void 0) { opentelemetry = {
-        tracer: OpenTelemetry_1.ArvoCoreTracer,
+        tracer: (0, OpenTelemetry_1.fetchOpenTelemetryTracer)(),
     }; }
     var span = opentelemetry.tracer.startSpan("createArvoEvent<".concat(event.type, ">"), {});
     return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {

package/dist/ArvoEventFactory/index.d.ts

@@ -11,7 +11,7 @@ import { ExecutionOpenTelemetryConfiguration } from '../types';
  * @template TEmits - The type of records the contract bound handler emits.
  */
 export default class ArvoEventFactory<TUri extends string = string, TType extends string = string, TAcceptSchema extends z.ZodTypeAny = z.ZodTypeAny, TEmits extends Record<string, z.ZodTypeAny> = Record<string, z.ZodTypeAny>> {
-    private contract;
+    private readonly contract;
     /**
      * Creates an instance of ArvoEventFactory.
      *

package/dist/ArvoEventFactory/index.js

@@ -55,7 +55,7 @@ var ArvoEventFactory = /** @class */ (function () {
     ArvoEventFactory.prototype.accepts = function (event, extensions, opentelemetry) {
         var _this = this;
         if (opentelemetry === void 0) { opentelemetry = {
-            tracer: OpenTelemetry_1.ArvoCoreTracer,
+            tracer: (0, OpenTelemetry_1.fetchOpenTelemetryTracer)(),
         }; }
         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 () {
@@ -95,7 +95,7 @@ var ArvoEventFactory = /** @class */ (function () {
     ArvoEventFactory.prototype.emits = function (event, extensions, opentelemetry) {
         var _this = this;
         if (opentelemetry === void 0) { opentelemetry = {
-            tracer: OpenTelemetry_1.ArvoCoreTracer,
+            tracer: (0, OpenTelemetry_1.fetchOpenTelemetryTracer)(),
         }; }
         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 () {
@@ -133,7 +133,7 @@ var ArvoEventFactory = /** @class */ (function () {
     ArvoEventFactory.prototype.systemError = function (event, extensions, opentelemetry) {
         var _this = this;
         if (opentelemetry === void 0) { opentelemetry = {
-            tracer: OpenTelemetry_1.ArvoCoreTracer,
+            tracer: (0, OpenTelemetry_1.fetchOpenTelemetryTracer)(),
         }; }
         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 () {

package/dist/ArvoOrchestratorContract/typegen.d.ts

@@ -1,6 +1,61 @@
-export declare const ArvoOrchestratorEventTypeGen: {
-    __prefix: `arvo.orc`;
-    init: <T extends string>(name: T) => `${typeof ArvoOrchestratorEventTypeGen.__prefix}.${T}`;
-    complete: <T extends string>(name: T) => `${ReturnType<typeof ArvoOrchestratorEventTypeGen.init<T>>}.done`;
-    systemError: <T extends string>(name: T) => `sys.${ReturnType<typeof ArvoOrchestratorEventTypeGen.init<T>>}.error`;
-};
+/**
+ * Utility class for generating standardized event type strings for the Arvo orchestrator.
+ * This class provides methods to create consistent event type identifiers with predefined prefixes
+ * and suffixes for different event states (init, complete, error).
+ *
+ * @example
+ * ```typescript
+ * // Generate event types for a 'payment' event
+ * const initEvent = ArvoOrchestratorEventTypeGen.init('payment')      // 'arvo.orc.payment'
+ * const doneEvent = ArvoOrchestratorEventTypeGen.complete('payment')  // 'arvo.orc.payment.done'
+ * const errorEvent = ArvoOrchestratorEventTypeGen.systemError('payment') // 'sys.arvo.orc.payment.error'
+ * ```
+ */
+export declare class ArvoOrchestratorEventTypeGen {
+    /**
+     * The standard prefix used for all Arvo orchestrator events.
+     * This prefix helps identify events that belong to the Arvo orchestrator system.
+     */
+    static readonly prefix: 'arvo.orc';
+    /**
+     * Generates an initialization event type string for a given event name.
+     *
+     * @param name - The base name of the event
+     * @returns A type-safe string combining the standard prefix with the provided name
+     * @typeParam T - String literal type for the event name
+     *
+     * @example
+     * ```typescript
+     * ArvoOrchestratorEventTypeGen.init('userRegistration') // Returns: 'arvo.orc.userRegistration'
+     * ```
+     */
+    static init<T extends string>(name: T): `${typeof ArvoOrchestratorEventTypeGen.prefix}.${T}`;
+    /**
+     * Generates a completion event type string for a given event name.
+     * Appends '.done' to the initialization event type.
+     *
+     * @param name - The base name of the event
+     * @returns A type-safe string for the completion event
+     * @typeParam T - String literal type for the event name
+     *
+     * @example
+     * ```typescript
+     * ArvoOrchestratorEventTypeGen.complete('userRegistration') // Returns: 'arvo.orc.userRegistration.done'
+     * ```
+     */
+    static complete<T extends string>(name: T): `${ReturnType<typeof ArvoOrchestratorEventTypeGen.init<T>>}.done`;
+    /**
+     * Generates a system error event type string for a given event name.
+     * Prepends 'sys.' and appends '.error' to the initialization event type.
+     *
+     * @param name - The base name of the event
+     * @returns A type-safe string for the system error event
+     * @typeParam T - String literal type for the event name
+     *
+     * @example
+     * ```typescript
+     * ArvoOrchestratorEventTypeGen.systemError('userRegistration') // Returns: 'sys.arvo.orc.userRegistration.error'
+     * ```
+     */
+    static systemError<T extends string>(name: T): `sys.${ReturnType<typeof ArvoOrchestratorEventTypeGen.init<T>>}.error`;
+}

package/dist/ArvoOrchestratorContract/typegen.js

@@ -1,15 +1,74 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArvoOrchestratorEventTypeGen = void 0;
-exports.ArvoOrchestratorEventTypeGen = {
-    __prefix: "arvo.orc",
-    init: function (name) {
-        return "".concat(exports.ArvoOrchestratorEventTypeGen.__prefix, ".").concat(name);
-    },
-    complete: function (name) {
-        return "".concat(exports.ArvoOrchestratorEventTypeGen.init(name), ".done");
-    },
-    systemError: function (name) {
-        return "sys.".concat(exports.ArvoOrchestratorEventTypeGen.init(name), ".error");
-    },
-};
+/**
+ * Utility class for generating standardized event type strings for the Arvo orchestrator.
+ * This class provides methods to create consistent event type identifiers with predefined prefixes
+ * and suffixes for different event states (init, complete, error).
+ *
+ * @example
+ * ```typescript
+ * // Generate event types for a 'payment' event
+ * const initEvent = ArvoOrchestratorEventTypeGen.init('payment')      // 'arvo.orc.payment'
+ * const doneEvent = ArvoOrchestratorEventTypeGen.complete('payment')  // 'arvo.orc.payment.done'
+ * const errorEvent = ArvoOrchestratorEventTypeGen.systemError('payment') // 'sys.arvo.orc.payment.error'
+ * ```
+ */
+var ArvoOrchestratorEventTypeGen = /** @class */ (function () {
+    function ArvoOrchestratorEventTypeGen() {
+    }
+    /**
+     * Generates an initialization event type string for a given event name.
+     *
+     * @param name - The base name of the event
+     * @returns A type-safe string combining the standard prefix with the provided name
+     * @typeParam T - String literal type for the event name
+     *
+     * @example
+     * ```typescript
+     * ArvoOrchestratorEventTypeGen.init('userRegistration') // Returns: 'arvo.orc.userRegistration'
+     * ```
+     */
+    ArvoOrchestratorEventTypeGen.init = function (name) {
+        return "".concat(ArvoOrchestratorEventTypeGen.prefix, ".").concat(name);
+    };
+    /**
+     * Generates a completion event type string for a given event name.
+     * Appends '.done' to the initialization event type.
+     *
+     * @param name - The base name of the event
+     * @returns A type-safe string for the completion event
+     * @typeParam T - String literal type for the event name
+     *
+     * @example
+     * ```typescript
+     * ArvoOrchestratorEventTypeGen.complete('userRegistration') // Returns: 'arvo.orc.userRegistration.done'
+     * ```
+     */
+    ArvoOrchestratorEventTypeGen.complete = function (name) {
+        return "".concat(ArvoOrchestratorEventTypeGen.init(name), ".done");
+    };
+    /**
+     * Generates a system error event type string for a given event name.
+     * Prepends 'sys.' and appends '.error' to the initialization event type.
+     *
+     * @param name - The base name of the event
+     * @returns A type-safe string for the system error event
+     * @typeParam T - String literal type for the event name
+     *
+     * @example
+     * ```typescript
+     * ArvoOrchestratorEventTypeGen.systemError('userRegistration') // Returns: 'sys.arvo.orc.userRegistration.error'
+     * ```
+     */
+    ArvoOrchestratorEventTypeGen.systemError = function (name) {
+        return "sys.".concat(ArvoOrchestratorEventTypeGen.init(name), ".error");
+    };
+    /**
+     * The standard prefix used for all Arvo orchestrator events.
+     * This prefix helps identify events that belong to the Arvo orchestrator system.
+     */
+    ArvoOrchestratorEventTypeGen.prefix = 'arvo.orc';
+    return ArvoOrchestratorEventTypeGen;
+}());
+exports.ArvoOrchestratorEventTypeGen = ArvoOrchestratorEventTypeGen;

package/dist/OpenTelemetry/index.d.ts

@@ -3,7 +3,7 @@ import { TelemetryLogLevel, OpenTelemetryHeaders } from './types';
 /**
  * A tracer instance for the ArvoCore package.
  */
-export declare const ArvoCoreTracer: import("@opentelemetry/api").Tracer;
+export declare const fetchOpenTelemetryTracer: () => import("@opentelemetry/api").Tracer;
 /**
  * Logs a message to a span with additional parameters.
  * @param params - The parameters for the log message.

package/dist/OpenTelemetry/index.js

@@ -11,16 +11,19 @@ var __assign = (this && this.__assign) || function () {
     return __assign.apply(this, arguments);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OTelNull = exports.exceptionToSpan = exports.logToSpan = exports.ArvoCoreTracer = void 0;
+exports.OTelNull = exports.exceptionToSpan = exports.logToSpan = exports.fetchOpenTelemetryTracer = void 0;
 exports.currentOpenTelemetryHeaders = currentOpenTelemetryHeaders;
 var api_1 = require("@opentelemetry/api");
 var utils_1 = require("./utils");
 var core_1 = require("@opentelemetry/core");
-var pkg = (0, utils_1.getPackageInfo)();
 /**
  * A tracer instance for the ArvoCore package.
  */
-exports.ArvoCoreTracer = api_1.trace.getTracer(pkg.name, pkg.version);
+var fetchOpenTelemetryTracer = function () {
+    var pkg = (0, utils_1.getPackageInfo)('arvo-core');
+    return api_1.trace.getTracer(pkg.name, pkg.version);
+};
+exports.fetchOpenTelemetryTracer = fetchOpenTelemetryTracer;
 /**
  * Logs a message to a span with additional parameters.
  * @param params - The parameters for the log message.

package/dist/OpenTelemetry/utils.d.ts

@@ -1,4 +1,4 @@
-export declare function getPackageInfo(): {
+export declare function getPackageInfo(defaultName: string): {
     name: string;
     version: string;
 };

package/dist/OpenTelemetry/utils.js

@@ -26,7 +26,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getPackageInfo = getPackageInfo;
 var fs = __importStar(require("fs"));
 var path = __importStar(require("path"));
-function getPackageInfo() {
+function getPackageInfo(defaultName) {
     try {
         // Read the package.json file
         var packageJsonPath = path.resolve(__dirname, '../../package.json');
@@ -39,6 +39,6 @@ function getPackageInfo() {
     }
     catch (error) {
         console.error('Error reading package.json:', error);
-        return { name: 'Unknown', version: 'Unknown' };
+        return { name: defaultName, version: 'Unknown' };
     }
 }

package/dist/index.d.ts

@@ -23,12 +23,11 @@ import { ArvoOrchestrationSubjectContentSchema, ArvoOrchestratorVersionSchema }
 import { ArvoOrchestrationSubjectContent, ArvoOrchestratorVersion } from './ArvoOrchestrationSubject/type';
 import ArvoEventHttp from './ArvoEventHttp';
 import { ArvoEventHttpConfig } from './ArvoEventHttp/types';
-import { InferArvoContract, InferArvoEvent, InferArvoOrchestratorContract } from './types';
+import { InferArvoContract, InferArvoEvent, InferArvoOrchestratorContract, ExecutionOpenTelemetryConfiguration } from './types';
 import { createArvoOrchestratorContract } from './ArvoOrchestratorContract/helpers';
 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.

package/dist/types.d.ts

@@ -12,7 +12,7 @@ import { Tracer } from '@opentelemetry/api';
  */
 export type ExecutionOpenTelemetryConfiguration = {
     /**
-     * Optional OpenTelemetry tracer instance to use for creating spans.
+     * OpenTelemetry tracer instance to use for creating spans.
      * If not provided, a default tracer may be used depending on the implementation.
      */
     tracer: Tracer;

package/package.json

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