arvo-core 2.0.10 → 2.1.0

package/dist/ArvoEvent/helpers.d.ts

@@ -4,17 +4,15 @@ import { ExecutionOpenTelemetryConfiguration } from '../OpenTelemetry/types';
 /**
  * Creates a strongly-typed ArvoEvent with configurable telemetry options.
  *
- * @template TData - Event data type extending ArvoEventData
- * @template TExtension - Cloud event extension type
- * @template TType - String literal type for event type
- *
  * @param event - Event configuration and data
  * @param [extensions] - Optional cloud event extensions
  * @param [opentelemetry] - OpenTelemetry configuration with options:
  *   - disable - Completely disables telemetry if true
  *   - tracer - Custom OpenTelemetry tracer instance
  *
- * @returns ArvoEvent instance
+ * @throw {Error} In case any validation in {@link ArvoEvent} fails.
+ *
+ * @returns ArvoEvent with type-safety
  *
  * @example
  * ```typescript
@@ -50,37 +48,6 @@ import { ExecutionOpenTelemetryConfiguration } from '../OpenTelemetry/types';
  *   { tracer: customTracer }
  * );
  * ```
- *
- * @remarks
- * This function provides several key features:
- *
- * 1. **Type Safety**:
- *    - Ensures event data matches specified type
- *    - Validates extension structure
- *    - Provides type-safe event type strings
- *
- * 2. **Default Handling**:
- *    - Generates UUID if no ID provided
- *    - Sets current timestamp if no time provided
- *    - Uses default ArvoDataContentType if none specified
- *
- * 3. **URI Handling**:
- *    - Automatically encodes URI components (source, subject, to, redirectto, dataschema)
- *    - Validates URI format
- *
- * 4. **OpenTelemetry Integration**:
- *    - Creates spans for event creation
- *    - Tracks errors and warnings
- *    - Propagates trace context
- *
- * 5. **Validation**:
- *    - Checks data content type compatibility
- *    - Validates required fields
- *    - Ensures URI format correctness
- *
- * @see {@link ArvoEvent} For the structure of the created event
- * @see {@link ArvoDataContentType} For supported content types
- * @see {@link CloudEventExtension} For extension structure
  */
 export declare const createArvoEvent: <TData extends ArvoEventData, TExtension extends CloudEventExtension, TType extends string>(event: CreateArvoEvent<TData, TType>, extensions?: TExtension, opentelemetry?: Partial<ExecutionOpenTelemetryConfiguration & {
     disable: boolean;

package/dist/ArvoEvent/helpers.js

@@ -11,22 +11,7 @@ var utils_1 = require("../utils");
 var schema_1 = require("./schema");
 var uuid_1 = require("uuid");
 /**
- * Internal generator function for creating ArvoEvent instances.
- *
- * @template TData - Type of the event data
- * @template TExtension - Type of cloud event extensions
- * @param {CreateArvoEvent<any, any>} event - The event configuration and data
- * @param {any} extensions - Cloud event extensions
- * @param {ReturnType<typeof currentOpenTelemetryHeaders>} otelHeaders - OpenTelemetry headers
- * @returns {ArvoEvent<any, any, any>} A new ArvoEvent instance
- *
- * @remarks
- * This function handles the actual creation of the ArvoEvent instance, including:
- * - Generation of default values for optional fields
- * - URI encoding of relevant fields
- * - Validation of data content type
- * - Integration with OpenTelemetry headers
- * ```
+ * Internal generator function for creating  instances.
  */
 var generator = function (event, extensions, otelHeaders) {
     var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
@@ -57,17 +42,15 @@ var generator = function (event, extensions, otelHeaders) {
 /**
  * Creates a strongly-typed ArvoEvent with configurable telemetry options.
  *
- * @template TData - Event data type extending ArvoEventData
- * @template TExtension - Cloud event extension type
- * @template TType - String literal type for event type
- *
  * @param event - Event configuration and data
  * @param [extensions] - Optional cloud event extensions
  * @param [opentelemetry] - OpenTelemetry configuration with options:
  *   - disable - Completely disables telemetry if true
  *   - tracer - Custom OpenTelemetry tracer instance
  *
- * @returns ArvoEvent instance
+ * @throw {Error} In case any validation in {@link ArvoEvent} fails.
+ *
+ * @returns ArvoEvent with type-safety
  *
  * @example
  * ```typescript
@@ -103,37 +86,6 @@ var generator = function (event, extensions, otelHeaders) {
  *   { tracer: customTracer }
  * );
  * ```
- *
- * @remarks
- * This function provides several key features:
- *
- * 1. **Type Safety**:
- *    - Ensures event data matches specified type
- *    - Validates extension structure
- *    - Provides type-safe event type strings
- *
- * 2. **Default Handling**:
- *    - Generates UUID if no ID provided
- *    - Sets current timestamp if no time provided
- *    - Uses default ArvoDataContentType if none specified
- *
- * 3. **URI Handling**:
- *    - Automatically encodes URI components (source, subject, to, redirectto, dataschema)
- *    - Validates URI format
- *
- * 4. **OpenTelemetry Integration**:
- *    - Creates spans for event creation
- *    - Tracks errors and warnings
- *    - Propagates trace context
- *
- * 5. **Validation**:
- *    - Checks data content type compatibility
- *    - Validates required fields
- *    - Ensures URI format correctness
- *
- * @see {@link ArvoEvent} For the structure of the created event
- * @see {@link ArvoDataContentType} For supported content types
- * @see {@link CloudEventExtension} For extension structure
  */
 var createArvoEvent = function (event, extensions, opentelemetry) {
     var _a;

package/dist/ArvoEvent/index.d.ts

@@ -2,9 +2,6 @@ import { ArvoEventData, ArvoExtension, CloudEventContext, CloudEventExtension, O
 import { InferArvoEvent } from '../types';
 /**
  * Represents an ArvoEvent, which extends the CloudEvent specification.
- * @template TData - The type of the event data, extending ArvoEventData.
- * @template TExtension - The type of additional extensions, extending CloudEventExtension.
- * @template TType - The type name of the event
  */
 export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExtension extends CloudEventExtension = CloudEventExtension, TType extends string = string> {
     readonly id: string;
@@ -22,6 +19,9 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * @param context - The CloudEvent context along with Arvo and OpenTelemetry extensions.
      * @param data - The event data.
      * @param extensions - Optional additional extensions.
+     *
+     * @throws {Error} If the datacontenttype is {@link ArvoDataContentType} but the `to` field
+     *                 is not defined
      */
     constructor(context: CloudEventContext & ArvoExtension & OpenTelemetryExtension, data: TData, extensions?: TExtension);
     /**
@@ -65,8 +65,6 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * (including Arvo and OpenTelemetry extensions) into a single object.
      * If you need to access the CloudEvent fields and extensions separately,
      * use the `cloudevent` getter instead.
-     *
-     * @returns A plain object representation of the ArvoEvent, including all fields and extensions.
      */
     toJSON(): InferArvoEvent<typeof this>;
     /**
@@ -79,9 +77,9 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * Gets OpenTelemetry attributes derived from the ArvoEvent.
      * @returns An object containing OpenTelemetry attributes.
      * The OpenTelemetry attributes for CloudEvents is as per
-     * the spec provided [here](https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloudevents/)
+     * the spec provided [in the official documentation](https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloudevents/).
      * Additionally, the Arvo extension attributed are also returned
-     * as `cloudevents.arvo.event_*` fields
+     * as `cloudevents.arvo.event_*` fields.
      */
     get otelAttributes(): {
         'cloudevents.event_id': string;
@@ -96,41 +94,11 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
         'cloudevents.arvo.event_to': string;
         'cloudevents.arvo.event_executionunits': string | number;
     };
-    /**
-     * Gets the 'to' field from the ArvoExtension.
-     * This field represents the intended recipient or destination of the event.
-     * @returns The value of the 'to' field.
-     */
     get to(): string | null;
-    /**
-     * Gets the 'accesscontrol' field from the ArvoExtension.
-     * This field contains access control information for the event.
-     * @returns The value of the 'accesscontrol' field.
-     */
     get accesscontrol(): string | null;
-    /**
-     * Gets the 'redirectto' field from the ArvoExtension.
-     * This field indicate an alternative destination for the event.
-     * @returns The value of the 'redirectto' field.
-     */
     get redirectto(): string | null;
-    /**
-     * Gets the 'executionunits' field from the ArvoExtension.
-     * This field contains information about the execution units associated with the event.
-     * @returns The value of the 'executionunits' field.
-     */
     get executionunits(): number | null;
-    /**
-     * Gets the 'traceparent' field from the OpenTelemetryExtension.
-     * This field contains the W3C Trace Context traceparent header.
-     * @returns The value of the 'traceparent' field.
-     */
     get traceparent(): string | null;
-    /**
-     * Gets the 'tracestate' field from the OpenTelemetryExtension.
-     * This field contains the W3C Trace Context tracestate header.
-     * @returns The value of the 'tracestate' field, or undefined if not set.
-     */
     get tracestate(): string | null;
     /**
      * Gets the custom extensions of the ArvoEvent.
@@ -141,8 +109,6 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * For accessing all extensions including Arvo and OpenTelemetry,
      * use `<ArvoEvent>.cloudevent.extensions`.
      * For accessing the basic CloudEvent fields, use `<ArvoEvent>.cloudevent.default`.
-     *
-     * @returns An object containing only the custom extensions (TExtension) of the ArvoEvent.
      */
     get extensions(): TExtension;
 }

package/dist/ArvoEvent/index.js

@@ -26,9 +26,6 @@ var schema_1 = require("./schema");
 var OpenTelemetry_1 = require("../OpenTelemetry");
 /**
  * Represents an ArvoEvent, which extends the CloudEvent specification.
- * @template TData - The type of the event data, extending ArvoEventData.
- * @template TExtension - The type of additional extensions, extending CloudEventExtension.
- * @template TType - The type name of the event
  */
 var ArvoEvent = /** @class */ (function () {
     /**
@@ -36,6 +33,9 @@ var ArvoEvent = /** @class */ (function () {
      * @param context - The CloudEvent context along with Arvo and OpenTelemetry extensions.
      * @param data - The event data.
      * @param extensions - Optional additional extensions.
+     *
+     * @throws {Error} If the datacontenttype is {@link ArvoDataContentType} but the `to` field
+     *                 is not defined
      */
     function ArvoEvent(context, data, extensions) {
         var cloudEventContext = schema_1.CloudEventContextSchema.parse(context);
@@ -100,8 +100,6 @@ var ArvoEvent = /** @class */ (function () {
      * (including Arvo and OpenTelemetry extensions) into a single object.
      * If you need to access the CloudEvent fields and extensions separately,
      * use the `cloudevent` getter instead.
-     *
-     * @returns A plain object representation of the ArvoEvent, including all fields and extensions.
      */
     ArvoEvent.prototype.toJSON = function () {
         return __assign(__assign({}, this.cloudevent.default), this._extensions);
@@ -120,9 +118,9 @@ var ArvoEvent = /** @class */ (function () {
          * Gets OpenTelemetry attributes derived from the ArvoEvent.
          * @returns An object containing OpenTelemetry attributes.
          * The OpenTelemetry attributes for CloudEvents is as per
-         * the spec provided [here](https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloudevents/)
+         * the spec provided [in the official documentation](https://opentelemetry.io/docs/specs/semconv/attributes-registry/cloudevents/).
          * Additionally, the Arvo extension attributed are also returned
-         * as `cloudevents.arvo.event_*` fields
+         * as `cloudevents.arvo.event_*` fields.
          */
         get: function () {
             var _a, _b, _c, _d;
@@ -144,11 +142,6 @@ var ArvoEvent = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoEvent.prototype, "to", {
-        /**
-         * Gets the 'to' field from the ArvoExtension.
-         * This field represents the intended recipient or destination of the event.
-         * @returns The value of the 'to' field.
-         */
         get: function () {
             return this._extensions.to;
         },
@@ -156,11 +149,6 @@ var ArvoEvent = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoEvent.prototype, "accesscontrol", {
-        /**
-         * Gets the 'accesscontrol' field from the ArvoExtension.
-         * This field contains access control information for the event.
-         * @returns The value of the 'accesscontrol' field.
-         */
         get: function () {
             return this._extensions.accesscontrol;
         },
@@ -168,11 +156,6 @@ var ArvoEvent = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoEvent.prototype, "redirectto", {
-        /**
-         * Gets the 'redirectto' field from the ArvoExtension.
-         * This field indicate an alternative destination for the event.
-         * @returns The value of the 'redirectto' field.
-         */
         get: function () {
             return this._extensions.redirectto;
         },
@@ -180,11 +163,6 @@ var ArvoEvent = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoEvent.prototype, "executionunits", {
-        /**
-         * Gets the 'executionunits' field from the ArvoExtension.
-         * This field contains information about the execution units associated with the event.
-         * @returns The value of the 'executionunits' field.
-         */
         get: function () {
             return this._extensions.executionunits;
         },
@@ -192,11 +170,6 @@ var ArvoEvent = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoEvent.prototype, "traceparent", {
-        /**
-         * Gets the 'traceparent' field from the OpenTelemetryExtension.
-         * This field contains the W3C Trace Context traceparent header.
-         * @returns The value of the 'traceparent' field.
-         */
         get: function () {
             return this._extensions.traceparent;
         },
@@ -204,11 +177,6 @@ var ArvoEvent = /** @class */ (function () {
         configurable: true
     });
     Object.defineProperty(ArvoEvent.prototype, "tracestate", {
-        /**
-         * Gets the 'tracestate' field from the OpenTelemetryExtension.
-         * This field contains the W3C Trace Context tracestate header.
-         * @returns The value of the 'tracestate' field, or undefined if not set.
-         */
         get: function () {
             return this._extensions.tracestate;
         },
@@ -225,8 +193,6 @@ var ArvoEvent = /** @class */ (function () {
          * For accessing all extensions including Arvo and OpenTelemetry,
          * use `<ArvoEvent>.cloudevent.extensions`.
          * For accessing the basic CloudEvent fields, use `<ArvoEvent>.cloudevent.default`.
-         *
-         * @returns An object containing only the custom extensions (TExtension) of the ArvoEvent.
          */
         get: function () {
             var _a = this._extensions, traceparent = _a.traceparent, tracestate = _a.tracestate, to = _a.to, redirectto = _a.redirectto, accesscontrol = _a.accesscontrol, executionunits = _a.executionunits, rest = __rest(_a, ["traceparent", "tracestate", "to", "redirectto", "accesscontrol", "executionunits"]);

package/dist/ArvoEvent/schema.d.ts

@@ -21,20 +21,20 @@ export declare const CloudEventContextSchema: z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     type: string;
     id: string;
-    time: string;
     source: string;
     specversion: "1.0";
     subject: string;
     datacontenttype: string;
     dataschema: string | null;
+    time: string;
 }, {
     type: string;
     id: string;
-    time: string;
     source: string;
     specversion: string;
     subject: string;
     dataschema: string | null;
+    time: string;
     datacontenttype?: string | undefined;
 }>;
 /**

package/dist/ArvoEventFactory/helpers.d.ts

@@ -1,13 +1,10 @@
 import ArvoEventFactory from '.';
 import ArvoContract from '../ArvoContract';
 import { ArvoSemanticVersion } from '../types';
-import ArvoEvent from '../ArvoEvent';
 import { VersionedArvoContract } from '../ArvoContract/VersionedArvoContract';
 /**
  * Creates an ArvoEventFactory for a specific version of a contract.
  *
- * @template TContract - The versioned contract type
- *
  * @param contract - The versioned contract to create a factory for
  * @returns An ArvoEventFactory instance for the specified contract version
  *
@@ -18,29 +15,4 @@ import { VersionedArvoContract } from '../ArvoContract/VersionedArvoContract';
  * const factory = createArvoEventFactory(v1Contract);
  * ```
  */
-export declare const createArvoEventFactory: <TContract extends VersionedArvoContract<ArvoContract, ArvoSemanticVersion>>(contract: TContract) => ArvoEventFactory<TContract>;
-/**
- * Parses an event data schema string or ArvoEvent object to extract the URI and version.
- * The schema is expected to be in the format "uri/version" where version follows semantic versioning.
- *
- * @param data - The input to parse, either a string containing the schema or an ArvoEvent object
- *               If an ArvoEvent is provided, its dataschema property will be used
- *
- * @returns An object containing the parsed URI and semantic version, or null if parsing fails
- *          The URI is everything before the last "/" and the version is everything after
- *
- * @example
- * // String input
- * parseEventDataSchema("com.example/schema/1.0.0")
- * // Returns: { uri: "com.example/schema", version: "1.0.0" }
- *
- * // ArvoEvent input
- * parseEventDataSchema({ dataschema: "com.example/schema/1.0.0" })
- * // Returns: { uri: "com.example/schema", version: "1.0.0" }
- *
- * @throws Will not throw errors directly, but converts any parsing errors to spans
- */
-export declare const parseEventDataSchema: (data: string | ArvoEvent) => {
-    uri: string;
-    version: ArvoSemanticVersion;
-} | null;
+export declare const createArvoEventFactory: <TContract extends VersionedArvoContract<ArvoContract<any, any, any, any>, ArvoSemanticVersion, Record<string, any>>>(contract: TContract) => ArvoEventFactory<TContract>;

package/dist/ArvoEventFactory/helpers.js

@@ -3,15 +3,11 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.parseEventDataSchema = exports.createArvoEventFactory = void 0;
+exports.createArvoEventFactory = void 0;
 var _1 = __importDefault(require("."));
-var OpenTelemetry_1 = require("../OpenTelemetry");
-var schema_1 = require("../schema");
 /**
  * Creates an ArvoEventFactory for a specific version of a contract.
  *
- * @template TContract - The versioned contract type
- *
  * @param contract - The versioned contract to create a factory for
  * @returns An ArvoEventFactory instance for the specified contract version
  *
@@ -24,39 +20,3 @@ var schema_1 = require("../schema");
  */
 var createArvoEventFactory = function (contract) { return new _1.default(contract); };
 exports.createArvoEventFactory = createArvoEventFactory;
-/**
- * Parses an event data schema string or ArvoEvent object to extract the URI and version.
- * The schema is expected to be in the format "uri/version" where version follows semantic versioning.
- *
- * @param data - The input to parse, either a string containing the schema or an ArvoEvent object
- *               If an ArvoEvent is provided, its dataschema property will be used
- *
- * @returns An object containing the parsed URI and semantic version, or null if parsing fails
- *          The URI is everything before the last "/" and the version is everything after
- *
- * @example
- * // String input
- * parseEventDataSchema("com.example/schema/1.0.0")
- * // Returns: { uri: "com.example/schema", version: "1.0.0" }
- *
- * // ArvoEvent input
- * parseEventDataSchema({ dataschema: "com.example/schema/1.0.0" })
- * // Returns: { uri: "com.example/schema", version: "1.0.0" }
- *
- * @throws Will not throw errors directly, but converts any parsing errors to spans
- */
-var parseEventDataSchema = function (data) {
-    var _a;
-    try {
-        var dataschema = typeof data === 'string' ? data : ((_a = data.dataschema) !== null && _a !== void 0 ? _a : '');
-        var items = dataschema.split('/');
-        var version = schema_1.ArvoSemanticVersionSchema.parse(items.pop());
-        var uri = items.join('/');
-        return { uri: uri, version: version };
-    }
-    catch (e) {
-        (0, OpenTelemetry_1.exceptionToSpan)(e);
-        return null;
-    }
-};
-exports.parseEventDataSchema = parseEventDataSchema;

package/dist/ArvoEventFactory/index.d.ts

@@ -1,16 +1,12 @@
-import ArvoContract from '../ArvoContract';
 import { z } from 'zod';
 import { CreateArvoEvent } from '../ArvoEvent/types';
 import { ExecutionOpenTelemetryConfiguration } from '../OpenTelemetry/types';
-import { ArvoSemanticVersion } from '../types';
 import { VersionedArvoContract } from '../ArvoContract/VersionedArvoContract';
 /**
  * Factory class for creating and validating events based on a versioned Arvo contract.
  * Handles event creation, validation, and OpenTelemetry integration for a specific
  * contract version.
  *
- * @template TContract - The versioned contract type this factory is bound to
- *
  * @example
  * ```typescript
  * const contract = createArvoContract({
@@ -22,7 +18,7 @@ import { VersionedArvoContract } from '../ArvoContract/VersionedArvoContract';
  * const factory = createArvoEventFactory(contract.version('1.0.0'));
  * ```
  */
-export default class ArvoEventFactory<TContract extends VersionedArvoContract<ArvoContract, ArvoSemanticVersion>> {
+export default class ArvoEventFactory<TContract extends VersionedArvoContract<any, any, any>> {
     private readonly contract;
     /**
      * Creates an ArvoEventFactory instance for a specific version of a contract.
@@ -33,8 +29,6 @@ export default class ArvoEventFactory<TContract extends VersionedArvoContract<Ar
     /**
      * Creates and validates an event matching the contract's accept specification.
      *
-     * @template TExtension - Additional properties to include in the event
-     *
      * @param event - The event configuration object
      * @param [extensions] - Optional additional properties for the event
      * @param [opentelemetry] - Optional OpenTelemetry configuration
@@ -55,9 +49,6 @@ export default class ArvoEventFactory<TContract extends VersionedArvoContract<Ar
     /**
      * Creates and validates an event matching one of the contract's emit specifications.
      *
-     * @template U - The specific emit event type from the contract
-     * @template TExtension - Additional properties to include in the event
-     *
      * @param event - The event configuration object
      * @param [extensions] - Optional additional properties for the event
      * @param [opentelemetry] - Optional OpenTelemetry configuration
@@ -75,12 +66,10 @@ export default class ArvoEventFactory<TContract extends VersionedArvoContract<Ar
      * });
      * ```
      */
-    emits<U extends string & keyof TContract['emits'], TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TContract['emits'][U]>, U>, 'datacontenttype' | 'dataschema'>, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration): import("..").ArvoEvent<z.TypeOf<TContract["emits"][U]>, TExtension, U>;
+    emits<U extends string & keyof TContract['emitMap'], TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.input<TContract['emitMap'][U]>, U>, 'datacontenttype' | 'dataschema'>, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration): import("..").ArvoEvent<z.TypeOf<TContract["emitMap"][U]>, TExtension, U>;
     /**
      * Creates a system error event for error reporting and handling.
      *
-     * @template TExtension - Additional properties to include in the error event
-     *
      * @param event - The error event configuration
      * @param event.error - The Error instance to convert to an event
      * @param [extensions] - Optional additional properties for the event
@@ -101,8 +90,8 @@ export default class ArvoEventFactory<TContract extends VersionedArvoContract<Ar
     systemError<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<any, any>, 'data' | 'type' | 'datacontenttype' | 'dataschema'> & {
         error: Error;
     }, extensions?: TExtension, opentelemetry?: ExecutionOpenTelemetryConfiguration): import("..").ArvoEvent<{
-        errorMessage: string;
         errorName: string;
+        errorMessage: string;
         errorStack: string | null;
     }, TExtension, TContract["systemError"]["type"]>;
 }

package/dist/ArvoEventFactory/index.js

@@ -21,22 +21,17 @@ var __rest = (this && this.__rest) || function (s, e) {
         }
     return t;
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 var helpers_1 = require("../ArvoEvent/helpers");
 var schema_1 = require("../ArvoEvent/schema");
 var OpenTelemetry_1 = require("../OpenTelemetry");
 var api_1 = require("@opentelemetry/api");
-var ArvoOrchestrationSubject_1 = __importDefault(require("../ArvoOrchestrationSubject"));
+var utils_1 = require("../utils");
 /**
  * Factory class for creating and validating events based on a versioned Arvo contract.
  * Handles event creation, validation, and OpenTelemetry integration for a specific
  * contract version.
  *
- * @template TContract - The versioned contract type this factory is bound to
- *
  * @example
  * ```typescript
  * const contract = createArvoContract({
@@ -60,8 +55,6 @@ var ArvoEventFactory = /** @class */ (function () {
     /**
      * Creates and validates an event matching the contract's accept specification.
      *
-     * @template TExtension - Additional properties to include in the event
-     *
      * @param event - The event configuration object
      * @param [extensions] - Optional additional properties for the event
      * @param [opentelemetry] - Optional OpenTelemetry configuration
@@ -93,7 +86,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: "".concat(_this.contract.uri, "/").concat(_this.contract.version), data: validationResult.data }), extensions, { disable: true });
+                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: utils_1.EventDataschemaUtil.create(_this.contract), data: validationResult.data }), extensions, { disable: true });
             }
             catch (error) {
                 (0, OpenTelemetry_1.exceptionToSpan)(error);
@@ -111,9 +104,6 @@ var ArvoEventFactory = /** @class */ (function () {
     /**
      * Creates and validates an event matching one of the contract's emit specifications.
      *
-     * @template U - The specific emit event type from the contract
-     * @template TExtension - Additional properties to include in the event
-     *
      * @param event - The event configuration object
      * @param [extensions] - Optional additional properties for the event
      * @param [opentelemetry] - Optional OpenTelemetry configuration
@@ -142,12 +132,12 @@ var ArvoEventFactory = /** @class */ (function () {
             span.setStatus({ code: api_1.SpanStatusCode.OK });
             var otelHeaders = (0, OpenTelemetry_1.currentOpenTelemetryHeaders)();
             try {
-                var validationResult = (_b = (_a = _this.contract.emits) === null || _a === void 0 ? void 0 : _a[event.type]) === null || _b === void 0 ? void 0 : _b.safeParse(event.data);
+                var validationResult = (_b = (_a = _this.contract.emitMap) === null || _a === void 0 ? void 0 : _a[event.type]) === null || _b === void 0 ? void 0 : _b.safeParse(event.data);
                 if (!(validationResult === null || validationResult === void 0 ? void 0 : validationResult.success)) {
                     var msg = (_d = (_c = validationResult === null || validationResult === void 0 ? void 0 : validationResult.error) === null || _c === void 0 ? void 0 : _c.message) !== null && _d !== void 0 ? _d : "No contract available for ".concat(event.type);
                     throw new Error("Emit Event data validation failed: ".concat(msg));
                 }
-                return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { traceparent: (_f = (_e = event.traceparent) !== null && _e !== void 0 ? _e : otelHeaders.traceparent) !== null && _f !== void 0 ? _f : undefined, tracestate: (_h = (_g = event.tracestate) !== null && _g !== void 0 ? _g : otelHeaders.tracestate) !== null && _h !== void 0 ? _h : undefined, datacontenttype: schema_1.ArvoDataContentType, dataschema: "".concat(_this.contract.uri, "/").concat(_this.contract.version), data: validationResult.data }), extensions, { disable: true });
+                return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { traceparent: (_f = (_e = event.traceparent) !== null && _e !== void 0 ? _e : otelHeaders.traceparent) !== null && _f !== void 0 ? _f : undefined, tracestate: (_h = (_g = event.tracestate) !== null && _g !== void 0 ? _g : otelHeaders.tracestate) !== null && _h !== void 0 ? _h : undefined, datacontenttype: schema_1.ArvoDataContentType, dataschema: utils_1.EventDataschemaUtil.create(_this.contract), data: validationResult.data }), extensions, { disable: true });
             }
             catch (error) {
                 (0, OpenTelemetry_1.exceptionToSpan)(error);
@@ -165,8 +155,6 @@ var ArvoEventFactory = /** @class */ (function () {
     /**
      * Creates a system error event for error reporting and handling.
      *
-     * @template TExtension - Additional properties to include in the error event
-     *
      * @param event - The error event configuration
      * @param event.error - The Error instance to convert to an event
      * @param [extensions] - Optional additional properties for the event
@@ -200,7 +188,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: "".concat(_this.contract.uri, "/").concat(ArvoOrchestrationSubject_1.default.WildCardMachineVersion) }), extensions, { disable: true });
+                    }, datacontenttype: schema_1.ArvoDataContentType, dataschema: utils_1.EventDataschemaUtil.createWithWildCardVersion(_this.contract) }), extensions, { disable: true });
             }
             catch (error) {
                 (0, OpenTelemetry_1.exceptionToSpan)(error);

package/dist/ArvoOrchestrationSubject/index.d.ts

@@ -4,18 +4,13 @@ import { ArvoSemanticVersion } from '../types';
  * Handles the creation and parsing of Arvo orchestration subjects.
  */
 export default class ArvoOrchestrationSubject {
-    /**
-     * Represents a wildcard version number used when version matching is not required.
-     * Format follows semantic versioning pattern.
-     */
-    static readonly WildCardMachineVersion: ArvoSemanticVersion;
     /**
      * Creates a new Arvo orchestration subject with basic required parameters.
      * This is a convenience method that wraps the more detailed {@link create} method.
      *
      * @param param - Configuration object for the orchestration subject
      * @param param.orchestator - Name identifier of the orchestrator
-     * @param param.version - Version of the orchestrator. If null, defaults to {@link WildCardMachineVersion}
+     * @param param.version - Version of the orchestrator. If null, defaults to {@link WildCardArvoSemanticVersion}
      * @param param.initiator - Identifier of the entity initiating the orchestration
      * @param param.meta - Optional metadata key-value pairs for additional orchestration context
      * @returns A base64 encoded string containing the compressed orchestration subject data
@@ -55,7 +50,7 @@ export default class ArvoOrchestrationSubject {
      *
      * @param param - Configuration object for creating a new subject from a parent
      * @param param.orchestator - Name identifier of the new orchestrator
-     * @param param.version - Version of the new orchestrator. If null, defaults to {@link WildCardMachineVersion}
+     * @param param.version - Version of the new orchestrator. If null, defaults to {@link WildCardArvoSemanticVersion}
      * @param param.subject - Base64 encoded string of the parent orchestration subject
      * @param param.meta - Optional additional metadata to merge with the parent's metadata
      * @returns A new base64 encoded string containing the compressed orchestration subject data