arvo-core 1.1.0 → 1.1.2

package/CHANGELOG.md

@@ -56,3 +56,7 @@
 
 - Added support for Arvo orchestration subject management
 
+## [1.1.1] - 2024-09-21
+
+- Added support for ArvoEvent http formats and made ArvoEvent extensions more specific
+

package/dist/ArvoEvent/helpers.d.ts

@@ -22,6 +22,7 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  * - If no `datacontenttype` is provided, it defaults to `application/cloudevents+json;charset=UTF-8;profile=arvo`.
  * - If a non-compatible `datacontenttype` is provided, a warning will be logged to the span.
  * - The `source`, `subject`, `to`, `redirectto`, and `dataschema` fields are URI-encoded.
+ * - If no `to` (null, undefined or empty string) is provided, then the `type` value is used by default
  *
  * @example
  * const event = createArvoEvent(
@@ -31,7 +32,7 @@ import { ArvoEventData, CloudEventExtension, CreateArvoEvent } from './types';
  *     subject: 'example-subject',
  *     data: { key: 'value' }
  *   },
- *   { customExtension: 'value' },
+ *   { 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>;

package/dist/ArvoEvent/helpers.js

@@ -32,6 +32,7 @@ var uuid_1 = require("uuid");
  * - If no `datacontenttype` is provided, it defaults to `application/cloudevents+json;charset=UTF-8;profile=arvo`.
  * - If a non-compatible `datacontenttype` is provided, a warning will be logged to the span.
  * - The `source`, `subject`, `to`, `redirectto`, and `dataschema` fields are URI-encoded.
+ * - If no `to` (null, undefined or empty string) is provided, then the `type` value is used by default
  *
  * @example
  * const event = createArvoEvent(
@@ -41,7 +42,7 @@ var uuid_1 = require("uuid");
  *     subject: 'example-subject',
  *     data: { key: 'value' }
  *   },
- *   { customExtension: 'value' },
+ *   { customextension: 'value' },
  * );
  */
 var createArvoEvent = function (event, extensions) {
@@ -70,7 +71,7 @@ var createArvoEvent = function (event, extensions) {
                 time: (_h = event.time) !== null && _h !== void 0 ? _h : (0, utils_1.createTimestamp)(),
                 source: encodeURI(event.source),
                 subject: encodeURI(event.subject),
-                to: event.to ? encodeURI(event.to) : null,
+                to: event.to ? encodeURI(event.to) : encodeURI(event.type),
                 redirectto: event.redirectto ? encodeURI(event.redirectto) : null,
                 dataschema: event.dataschema ? encodeURI(event.dataschema) : null,
             }, event.data, extensions);

package/dist/ArvoEvent/index.d.ts

@@ -15,7 +15,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
     readonly dataschema: string | null;
     readonly data: TData;
     readonly time: string;
-    readonly extensions: TExtension & ArvoExtension & OpenTelemetryExtension;
+    private readonly _extensions;
     /**
      * Creates an instance of ArvoEvent.
      * @param context - The CloudEvent context along with Arvo and OpenTelemetry extensions.
@@ -56,7 +56,16 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
     };
     /**
      * Converts the ArvoEvent to a JSON-serializable object.
-     * @returns A plain object representation of the ArvoEvent.
+     * It bundles the extensions and the cloudevent fields into
+     * one object.
+     *
+     * @remarks
+     * This method combines the default CloudEvent fields and all extensions
+     * (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(): Record<string, any>;
     /**
@@ -90,66 +99,49 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * 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.
-     *
-     * @remarks
-     * This is a convenience getter for the data in `this.extensions.to` as this
-     * is an ArvoEvent object which natively defines this extension on the CloudEvent
-     * spec.
      */
     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.
-     *
-     * @remarks
-     * This is a convenience getter for the data in `this.extensions.accesscontrol` as this
-     * is an ArvoEvent object which natively defines this extension on the CloudEvent
-     * spec.
      */
     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.
-     *
-     * @remarks
-     * This is a convenience getter for the data in `this.extensions.redirectto` as this
-     * is an ArvoEvent object which natively defines this extension on the CloudEvent
-     * spec.
      */
     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.
-     *
-     * @remarks
-     * This is a convenience getter for the data in `this.extensions.executionunits` as this
-     * is an ArvoEvent object which natively defines this extension on the CloudEvent
-     * spec.
      */
     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.
-     *
-     * @remarks
-     * This is a convenience getter for the data in `this.extensions.traceparent` as this
-     * is an ArvoEvent object which natively defines this extension on the CloudEvent
-     * spec.
      */
     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.
      *
      * @remarks
-     * This is a convenience getter for the data in `this.extensions.tracestate` as this
-     * is an ArvoEvent object which natively defines this extension on the CloudEvent
-     * spec.
+     * This getter returns only the custom extensions (TExtension) added to the ArvoEvent,
+     * excluding the standard Arvo and OpenTelemetry extensions.
+     * 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 tracestate(): string | null;
+    get extensions(): TExtension;
 }

package/dist/ArvoEvent/index.js

@@ -10,6 +10,17 @@ var __assign = (this && this.__assign) || function () {
     };
     return __assign.apply(this, arguments);
 };
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 var schema_1 = require("./schema");
 var OpenTelemetry_1 = require("../OpenTelemetry");
@@ -39,16 +50,16 @@ var ArvoEvent = /** @class */ (function () {
         this.data = schema_1.ArvoDataSchema.parse(data);
         var arvoExtension = schema_1.ArvoExtensionSchema.parse(context);
         var otelExtension = schema_1.OpenTelemetryExtensionSchema.parse(context);
-        this.extensions = __assign(__assign({}, (extensions
+        this._extensions = __assign(__assign({}, (extensions
             ? schema_1.CloudEventExtensionSchema.parse(extensions)
             : {})), { to: arvoExtension.to, accesscontrol: arvoExtension.accesscontrol, redirectto: arvoExtension.redirectto, executionunits: arvoExtension.executionunits, traceparent: otelExtension.traceparent, tracestate: otelExtension.tracestate });
         if (this.datacontenttype === schema_1.ArvoDataContentType) {
-            if (!this.extensions.to) {
+            if (!this._extensions.to) {
                 throw new Error("The ArvoEvent must have a non-empty 'to' field");
             }
         }
         Object.freeze(this);
-        Object.freeze(this.extensions);
+        Object.freeze(this._extensions);
     }
     Object.defineProperty(ArvoEvent.prototype, "cloudevent", {
         /**
@@ -73,7 +84,7 @@ var ArvoEvent = /** @class */ (function () {
                     data: this.data,
                     time: this.time,
                 },
-                extensions: this.extensions,
+                extensions: __assign({}, this._extensions),
             };
         },
         enumerable: false,
@@ -81,10 +92,19 @@ var ArvoEvent = /** @class */ (function () {
     });
     /**
      * Converts the ArvoEvent to a JSON-serializable object.
-     * @returns A plain object representation of the ArvoEvent.
+     * It bundles the extensions and the cloudevent fields into
+     * one object.
+     *
+     * @remarks
+     * This method combines the default CloudEvent fields and all extensions
+     * (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);
+        return __assign(__assign({}, this.cloudevent.default), this._extensions);
     };
     /**
      * Converts the ArvoEvent to a JSON string.
@@ -115,9 +135,9 @@ var ArvoEvent = /** @class */ (function () {
                 'cloudevents.event_time': this.time || OpenTelemetry_1.OTelNull,
                 'cloudevents.event_datacontenttype': this.datacontenttype || OpenTelemetry_1.OTelNull,
                 'cloudevents.event_dataschema': (_a = this.dataschema) !== null && _a !== void 0 ? _a : OpenTelemetry_1.OTelNull,
-                'cloudevents.arvo.event_redirectto': (_b = this.extensions.redirectto) !== null && _b !== void 0 ? _b : OpenTelemetry_1.OTelNull,
-                'cloudevents.arvo.event_to': (_c = this.extensions.to) !== null && _c !== void 0 ? _c : OpenTelemetry_1.OTelNull,
-                'cloudevents.arvo.event_executionunits': (_d = this.extensions.executionunits) !== null && _d !== void 0 ? _d : OpenTelemetry_1.OTelNull,
+                'cloudevents.arvo.event_redirectto': (_b = this._extensions.redirectto) !== null && _b !== void 0 ? _b : OpenTelemetry_1.OTelNull,
+                'cloudevents.arvo.event_to': (_c = this._extensions.to) !== null && _c !== void 0 ? _c : OpenTelemetry_1.OTelNull,
+                'cloudevents.arvo.event_executionunits': (_d = this._extensions.executionunits) !== null && _d !== void 0 ? _d : OpenTelemetry_1.OTelNull,
             };
         },
         enumerable: false,
@@ -128,14 +148,9 @@ var ArvoEvent = /** @class */ (function () {
          * 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.
-         *
-         * @remarks
-         * This is a convenience getter for the data in `this.extensions.to` as this
-         * is an ArvoEvent object which natively defines this extension on the CloudEvent
-         * spec.
          */
         get: function () {
-            return this.extensions.to;
+            return this._extensions.to;
         },
         enumerable: false,
         configurable: true
@@ -145,14 +160,9 @@ var ArvoEvent = /** @class */ (function () {
          * Gets the 'accesscontrol' field from the ArvoExtension.
          * This field contains access control information for the event.
          * @returns The value of the 'accesscontrol' field.
-         *
-         * @remarks
-         * This is a convenience getter for the data in `this.extensions.accesscontrol` as this
-         * is an ArvoEvent object which natively defines this extension on the CloudEvent
-         * spec.
          */
         get: function () {
-            return this.extensions.accesscontrol;
+            return this._extensions.accesscontrol;
         },
         enumerable: false,
         configurable: true
@@ -162,14 +172,9 @@ var ArvoEvent = /** @class */ (function () {
          * Gets the 'redirectto' field from the ArvoExtension.
          * This field indicate an alternative destination for the event.
          * @returns The value of the 'redirectto' field.
-         *
-         * @remarks
-         * This is a convenience getter for the data in `this.extensions.redirectto` as this
-         * is an ArvoEvent object which natively defines this extension on the CloudEvent
-         * spec.
          */
         get: function () {
-            return this.extensions.redirectto;
+            return this._extensions.redirectto;
         },
         enumerable: false,
         configurable: true
@@ -179,14 +184,9 @@ var ArvoEvent = /** @class */ (function () {
          * 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.
-         *
-         * @remarks
-         * This is a convenience getter for the data in `this.extensions.executionunits` as this
-         * is an ArvoEvent object which natively defines this extension on the CloudEvent
-         * spec.
          */
         get: function () {
-            return this.extensions.executionunits;
+            return this._extensions.executionunits;
         },
         enumerable: false,
         configurable: true
@@ -196,14 +196,9 @@ var ArvoEvent = /** @class */ (function () {
          * Gets the 'traceparent' field from the OpenTelemetryExtension.
          * This field contains the W3C Trace Context traceparent header.
          * @returns The value of the 'traceparent' field.
-         *
-         * @remarks
-         * This is a convenience getter for the data in `this.extensions.traceparent` as this
-         * is an ArvoEvent object which natively defines this extension on the CloudEvent
-         * spec.
          */
         get: function () {
-            return this.extensions.traceparent;
+            return this._extensions.traceparent;
         },
         enumerable: false,
         configurable: true
@@ -213,14 +208,29 @@ var ArvoEvent = /** @class */ (function () {
          * 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;
+        },
+        enumerable: false,
+        configurable: true
+    });
+    Object.defineProperty(ArvoEvent.prototype, "extensions", {
+        /**
+         * Gets the custom extensions of the ArvoEvent.
          *
          * @remarks
-         * This is a convenience getter for the data in `this.extensions.tracestate` as this
-         * is an ArvoEvent object which natively defines this extension on the CloudEvent
-         * spec.
+         * This getter returns only the custom extensions (TExtension) added to the ArvoEvent,
+         * excluding the standard Arvo and OpenTelemetry extensions.
+         * 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 () {
-            return this.extensions.tracestate;
+            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"]);
+            return rest;
         },
         enumerable: false,
         configurable: true

package/dist/ArvoEventHttp/index.d.ts

@@ -0,0 +1,33 @@
+import ArvoEvent from '../ArvoEvent';
+import { ArvoEventHttpConfig } from './types';
+/**
+ * A utility class for converting ArvoEvents to and from HTTP configurations.
+ */
+export default class ArvoEventHttp {
+    /**
+     * Exports an ArvoEvent to a cloudevent binary-mode HTTP configuration.
+     * @param event - The ArvoEvent to export.
+     * @returns An ArvoEventHttpConfig object with headers and data.
+     */
+    static exportToBinary(event: ArvoEvent): ArvoEventHttpConfig;
+    /**
+     * Exports an ArvoEvent to a cloudevent structured-mode HTTP representation.
+     * @param event - The ArvoEvent to export.
+     * @returns An ArvoEventHttpConfig object with headers and data.
+     */
+    static exportToStructured(event: ArvoEvent): ArvoEventHttpConfig;
+    /**
+     * Imports an ArvoEvent from a binary-mode HTTP representation.
+     * @param config - The ArvoEventHttpConfig object to import from.
+     * @returns A new ArvoEvent instance.
+     * @throws {Error} If required fields are missing or if there's an error parsing the input.
+     */
+    static importFromBinary(config: ArvoEventHttpConfig): ArvoEvent;
+    /**
+     * Imports an ArvoEvent from a structured-mode HTTP representation.
+     * @param config - The ArvoEventHttpConfig object to import from.
+     * @returns A new ArvoEvent instance.
+     * @throws {Error} If required fields are missing or if there's an error parsing the input.
+     */
+    static importFromStructured(config: ArvoEventHttpConfig): ArvoEvent;
+}

package/dist/ArvoEventHttp/index.js

@@ -0,0 +1,199 @@
+"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);
+};
+var __rest = (this && this.__rest) || function (s, e) {
+    var t = {};
+    for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)
+        t[p] = s[p];
+    if (s != null && typeof Object.getOwnPropertySymbols === "function")
+        for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {
+            if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))
+                t[p[i]] = s[p[i]];
+        }
+    return t;
+};
+var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
+    if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
+        if (ar || !(i in from)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var ArvoEvent_1 = __importDefault(require("../ArvoEvent"));
+var schema_1 = require("../ArvoEvent/schema");
+var utils_1 = require("../utils");
+var uuid_1 = require("uuid");
+/**
+ * A utility class for converting ArvoEvents to and from HTTP configurations.
+ */
+var ArvoEventHttp = /** @class */ (function () {
+    function ArvoEventHttp() {
+    }
+    /**
+     * Exports an ArvoEvent to a cloudevent binary-mode HTTP configuration.
+     * @param event - The ArvoEvent to export.
+     * @returns An ArvoEventHttpConfig object with headers and data.
+     */
+    ArvoEventHttp.exportToBinary = function (event) {
+        var headers = Object.assign.apply(Object, __spreadArray([{}], Object.entries(event.toJSON())
+            .filter(function (_a) {
+            var key = _a[0];
+            return key !== 'data';
+        })
+            .map(function (_a) {
+            var _b;
+            var key = _a[0], value = _a[1];
+            return (_b = {},
+                _b["ce-".concat(key)] = value,
+                _b);
+        }), false));
+        return {
+            headers: __assign(__assign({}, headers), { 'content-type': 'application/json' }),
+            data: __assign({}, event.data),
+        };
+    };
+    /**
+     * Exports an ArvoEvent to a cloudevent structured-mode HTTP representation.
+     * @param event - The ArvoEvent to export.
+     * @returns An ArvoEventHttpConfig object with headers and data.
+     */
+    ArvoEventHttp.exportToStructured = function (event) {
+        return {
+            headers: {
+                'content-type': event.datacontenttype,
+            },
+            data: event.toJSON(),
+        };
+    };
+    /**
+     * Imports an ArvoEvent from a binary-mode HTTP representation.
+     * @param config - The ArvoEventHttpConfig object to import from.
+     * @returns A new ArvoEvent instance.
+     * @throws {Error} If required fields are missing or if there's an error parsing the input.
+     */
+    ArvoEventHttp.importFromBinary = function (config) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        try {
+            if (config.headers['content-type'] !== 'application/json') {
+                throw new Error("Invalid content-type: ".concat(config.headers['content-type'], ". Expected: application/json"));
+            }
+            var eventFields = [
+                'id',
+                'type',
+                'accesscontrol',
+                'executionunits',
+                'traceparent',
+                'tracestate',
+                'datacontenttype',
+                'specversion',
+                'time',
+                'source',
+                'subject',
+                'to',
+                'redirectto',
+                'dataschema',
+            ];
+            var event_1 = {};
+            // Extract event fields from headers
+            for (var _i = 0, eventFields_1 = eventFields; _i < eventFields_1.length; _i++) {
+                var field = eventFields_1[_i];
+                var headerKey = "ce-".concat(field);
+                if (headerKey in config.headers) {
+                    event_1[field] = config.headers[headerKey];
+                }
+            }
+            // Validate required fields
+            if (!event_1.type || !event_1.source || !event_1.subject) {
+                throw new Error('Missing required header fields: ce-type, ce-source, or ce-subject');
+            }
+            // Extract extensions
+            var prefixedEventFields_1 = eventFields.map(function (item) { return "ce-".concat(item); });
+            var extensions = Object.entries(config.headers)
+                .filter(function (_a) {
+                var key = _a[0];
+                return key.startsWith('ce-') && !prefixedEventFields_1.includes(key);
+            })
+                .reduce(function (acc, _a) {
+                var key = _a[0], value = _a[1];
+                acc[key.slice(3)] = value;
+                return acc;
+            }, {});
+            // Create and return ArvoEvent
+            return new ArvoEvent_1.default({
+                id: (_a = event_1.id) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)(),
+                type: event_1.type,
+                accesscontrol: (_b = event_1.accesscontrol) !== null && _b !== void 0 ? _b : null,
+                executionunits: event_1.executionunits
+                    ? Number(event_1.executionunits)
+                    : null,
+                traceparent: (_c = event_1.traceparent) !== null && _c !== void 0 ? _c : null,
+                tracestate: (_d = event_1.tracestate) !== null && _d !== void 0 ? _d : null,
+                datacontenttype: (_e = event_1.datacontenttype) !== null && _e !== void 0 ? _e : schema_1.ArvoDataContentType,
+                specversion: (_f = event_1.specversion) !== null && _f !== void 0 ? _f : '1.0',
+                time: (_g = event_1.time) !== null && _g !== void 0 ? _g : (0, utils_1.createTimestamp)(),
+                source: event_1.source,
+                subject: event_1.subject,
+                to: (_h = event_1.to) !== null && _h !== void 0 ? _h : null,
+                redirectto: (_j = event_1.redirectto) !== null && _j !== void 0 ? _j : null,
+                dataschema: (_k = event_1.dataschema) !== null && _k !== void 0 ? _k : null,
+            }, config.data, extensions);
+        }
+        catch (error) {
+            throw new Error("Failed to import ArvoEvent from binary: ".concat(error.message));
+        }
+    };
+    /**
+     * Imports an ArvoEvent from a structured-mode HTTP representation.
+     * @param config - The ArvoEventHttpConfig object to import from.
+     * @returns A new ArvoEvent instance.
+     * @throws {Error} If required fields are missing or if there's an error parsing the input.
+     */
+    ArvoEventHttp.importFromStructured = function (config) {
+        try {
+            if (config.headers['content-type'] !== schema_1.ArvoDataContentType) {
+                throw new Error("Invalid content-type: ".concat(config.headers['content-type'], ". Expected: ").concat(schema_1.ArvoDataContentType));
+            }
+            var eventData = config.data;
+            if (!eventData.type || !eventData.source || !eventData.subject) {
+                throw new Error('Missing required fields: type, source, or subject');
+            }
+            var id = eventData.id, type = eventData.type, source = eventData.source, subject = eventData.subject, time = eventData.time, datacontenttype = eventData.datacontenttype, specversion = eventData.specversion, dataschema = eventData.dataschema, data = eventData.data, to = eventData.to, accesscontrol = eventData.accesscontrol, redirectto = eventData.redirectto, executionunits = eventData.executionunits, traceparent = eventData.traceparent, tracestate = eventData.tracestate, extensions = __rest(eventData, ["id", "type", "source", "subject", "time", "datacontenttype", "specversion", "dataschema", "data", "to", "accesscontrol", "redirectto", "executionunits", "traceparent", "tracestate"]);
+            return new ArvoEvent_1.default({
+                id: id !== null && id !== void 0 ? id : (0, uuid_1.v4)(),
+                type: type,
+                source: source,
+                subject: subject,
+                time: time !== null && time !== void 0 ? time : (0, utils_1.createTimestamp)(),
+                datacontenttype: datacontenttype !== null && datacontenttype !== void 0 ? datacontenttype : schema_1.ArvoDataContentType,
+                specversion: specversion !== null && specversion !== void 0 ? specversion : '1.0',
+                dataschema: dataschema !== null && dataschema !== void 0 ? dataschema : null,
+                to: to !== null && to !== void 0 ? to : null,
+                accesscontrol: accesscontrol !== null && accesscontrol !== void 0 ? accesscontrol : null,
+                redirectto: redirectto !== null && redirectto !== void 0 ? redirectto : null,
+                executionunits: executionunits ? Number(executionunits) : null,
+                traceparent: traceparent !== null && traceparent !== void 0 ? traceparent : null,
+                tracestate: tracestate !== null && tracestate !== void 0 ? tracestate : null,
+            }, data !== null && data !== void 0 ? data : {}, extensions);
+        }
+        catch (error) {
+            throw new Error("Failed to import ArvoEvent from structured: ".concat(error.message));
+        }
+    };
+    return ArvoEventHttp;
+}());
+exports.default = ArvoEventHttp;

package/dist/ArvoEventHttp/types.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Configuration object for ArvoEventHttp operations.
+ */
+export type ArvoEventHttpConfig = {
+    /** HTTP headers */
+    headers: Record<string, string | number | boolean | null>;
+    /** Event data */
+    data: Record<string, any>;
+};

package/dist/ArvoEventHttp/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/ArvoOrchestrationSubject/index.d.ts

@@ -1,4 +1,4 @@
-import { ArvoOchestratorVersion, ArvoOrchestrationSubjectContent } from "./type";
+import { ArvoOchestratorVersion, ArvoOrchestrationSubjectContent } from './type';
 /**
  * Handles the creation and parsing of Arvo orchestration subjects.
  */

package/dist/ArvoOrchestrationSubject/index.js

@@ -50,8 +50,8 @@ var ArvoOrchestrationSubject = /** @class */ (function () {
             },
             execution: {
                 id: (0, uuid_1.v4)(),
-                initiator: param.initiator
-            }
+                initiator: param.initiator,
+            },
         });
     };
     /**

package/dist/ArvoOrchestrationSubject/schema.d.ts

@@ -1,4 +1,4 @@
-import { z } from "zod";
+import { z } from 'zod';
 export declare const ArvoOchestratorVersionSchema: z.ZodEffects<z.ZodString, string, string>;
 export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
     orchestrator: z.ZodObject<{

package/dist/ArvoOrchestrationSubject/schema.js

@@ -9,8 +9,10 @@ exports.ArvoOchestratorVersionSchema = zod_1.z
     .refine(function (value) { return !value.includes(';'); }, 'Version must not contain semicolon')
     .describe('Semantic version of the Arvo Orchestrator in the format X.Y.Z');
 // Zod schema for ArvoOrchestrationSubjectContent
-exports.ArvoOrchestrationSubjectContentSchema = zod_1.z.object({
-    orchestrator: zod_1.z.object({
+exports.ArvoOrchestrationSubjectContentSchema = zod_1.z
+    .object({
+    orchestrator: zod_1.z
+        .object({
         name: zod_1.z
             .string()
             .regex(/^[a-z0-9]+(\.[a-z0-9]+)+\.[a-z0-9]+$/, 'Orchestrator name should be prefixed with a reverse-DNS name')
@@ -19,7 +21,8 @@ exports.ArvoOrchestrationSubjectContentSchema = zod_1.z.object({
         version: exports.ArvoOchestratorVersionSchema,
     })
         .describe('Information about the orchestrator'),
-    execution: zod_1.z.object({
+    execution: zod_1.z
+        .object({
         id: zod_1.z
             .string()
             .min(1, 'ID must be a non-empty string')
@@ -30,5 +33,7 @@ exports.ArvoOrchestrationSubjectContentSchema = zod_1.z.object({
             .regex(/^[a-z0-9]+(\.[a-z0-9]+)+\.[a-z0-9]+$/, 'Orchestration initiator should be prefixed with a reverse-DNS name')
             .refine(function (value) { return !value.includes(';'); }, 'Initiator must not contain semicolon')
             .describe('Entity or process that initiated the execution'),
-    }).describe('Details about the current execution'),
-}).describe('Context information for Arvo orchestration');
+    })
+        .describe('Details about the current execution'),
+})
+    .describe('Context information for Arvo orchestration');

package/dist/OpenTelemetry/ArvoExecution/index.js

@@ -6,7 +6,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var ArvoExecution = /** @class */ (function () {
     function ArvoExecution() {
     }
-    ArvoExecution.ATTR_SPAN_KIND = "arvo.span.kind";
+    ArvoExecution.ATTR_SPAN_KIND = 'arvo.span.kind';
     return ArvoExecution;
 }());
 exports.default = ArvoExecution;

package/dist/OpenTelemetry/OpenInference/index.js

@@ -8,78 +8,78 @@ Object.defineProperty(exports, "__esModule", { value: true });
 var OpenInference = /** @class */ (function () {
     function OpenInference() {
     }
-    OpenInference.ATTR_SPAN_KIND = "openinference.span.kind";
+    OpenInference.ATTR_SPAN_KIND = 'openinference.span.kind';
     // Document attributes
-    OpenInference.ATTR_DOCUMENT_CONTENT = "document.content";
-    OpenInference.ATTR_DOCUMENT_ID = "document.id";
-    OpenInference.ATTR_DOCUMENT_METADATA = "document.metadata";
-    OpenInference.ATTR_DOCUMENT_SCORE = "document.score";
+    OpenInference.ATTR_DOCUMENT_CONTENT = 'document.content';
+    OpenInference.ATTR_DOCUMENT_ID = 'document.id';
+    OpenInference.ATTR_DOCUMENT_METADATA = 'document.metadata';
+    OpenInference.ATTR_DOCUMENT_SCORE = 'document.score';
     // Embedding attributes
-    OpenInference.ATTR_EMBEDDING_EMBEDDINGS = "embedding.embeddings";
-    OpenInference.ATTR_EMBEDDING_MODEL_NAME = "embedding.model_name";
-    OpenInference.ATTR_EMBEDDING_TEXT = "embedding.text";
-    OpenInference.ATTR_EMBEDDING_VECTOR = "embedding.vector";
+    OpenInference.ATTR_EMBEDDING_EMBEDDINGS = 'embedding.embeddings';
+    OpenInference.ATTR_EMBEDDING_MODEL_NAME = 'embedding.model_name';
+    OpenInference.ATTR_EMBEDDING_TEXT = 'embedding.text';
+    OpenInference.ATTR_EMBEDDING_VECTOR = 'embedding.vector';
     // Exception attributes
-    OpenInference.ATTR_EXCEPTION_ESCAPED = "exception.escaped";
-    OpenInference.ATTR_EXCEPTION_MESSAGE = "exception.message";
-    OpenInference.ATTR_EXCEPTION_STACKTRACE = "exception.stacktrace";
-    OpenInference.ATTR_EXCEPTION_TYPE = "exception.type";
+    OpenInference.ATTR_EXCEPTION_ESCAPED = 'exception.escaped';
+    OpenInference.ATTR_EXCEPTION_MESSAGE = 'exception.message';
+    OpenInference.ATTR_EXCEPTION_STACKTRACE = 'exception.stacktrace';
+    OpenInference.ATTR_EXCEPTION_TYPE = 'exception.type';
     // Image attribute
-    OpenInference.ATTR_IMAGE_URL = "image.url";
+    OpenInference.ATTR_IMAGE_URL = 'image.url';
     // Input attributes
-    OpenInference.ATTR_INPUT_MIME_TYPE = "input.mime_type";
-    OpenInference.ATTR_INPUT_VALUE = "input.value";
+    OpenInference.ATTR_INPUT_MIME_TYPE = 'input.mime_type';
+    OpenInference.ATTR_INPUT_VALUE = 'input.value';
     // LLM attributes
-    OpenInference.ATTR_LLM_FUNCTION_CALL = "llm.function_call";
-    OpenInference.ATTR_LLM_INPUT_MESSAGES = "llm.input_messages";
-    OpenInference.ATTR_LLM_INVOCATION_PARAMETERS = "llm.invocation_parameters";
-    OpenInference.ATTR_LLM_MODEL_NAME = "llm.model_name";
-    OpenInference.ATTR_LLM_OUTPUT_MESSAGES = "llm.output_messages";
-    OpenInference.ATTR_LLM_PROMPT_TEMPLATE_TEMPLATE = "llm.prompt_template.template";
-    OpenInference.ATTR_LLM_PROMPT_TEMPLATE_VARIABLES = "llm.prompt_template.variables";
-    OpenInference.ATTR_LLM_PROMPT_TEMPLATE_VERSION = "llm.prompt_template.version";
-    OpenInference.ATTR_LLM_TOKEN_COUNT_COMPLETION = "llm.token_count.completion";
-    OpenInference.ATTR_LLM_TOKEN_COUNT_PROMPT = "llm.token_count.prompt";
-    OpenInference.ATTR_LLM_TOKEN_COUNT_TOTAL = "llm.token_count.total";
-    OpenInference.ATTR_LLM_TOOLS = "llm.tools";
+    OpenInference.ATTR_LLM_FUNCTION_CALL = 'llm.function_call';
+    OpenInference.ATTR_LLM_INPUT_MESSAGES = 'llm.input_messages';
+    OpenInference.ATTR_LLM_INVOCATION_PARAMETERS = 'llm.invocation_parameters';
+    OpenInference.ATTR_LLM_MODEL_NAME = 'llm.model_name';
+    OpenInference.ATTR_LLM_OUTPUT_MESSAGES = 'llm.output_messages';
+    OpenInference.ATTR_LLM_PROMPT_TEMPLATE_TEMPLATE = 'llm.prompt_template.template';
+    OpenInference.ATTR_LLM_PROMPT_TEMPLATE_VARIABLES = 'llm.prompt_template.variables';
+    OpenInference.ATTR_LLM_PROMPT_TEMPLATE_VERSION = 'llm.prompt_template.version';
+    OpenInference.ATTR_LLM_TOKEN_COUNT_COMPLETION = 'llm.token_count.completion';
+    OpenInference.ATTR_LLM_TOKEN_COUNT_PROMPT = 'llm.token_count.prompt';
+    OpenInference.ATTR_LLM_TOKEN_COUNT_TOTAL = 'llm.token_count.total';
+    OpenInference.ATTR_LLM_TOOLS = 'llm.tools';
     // Message attributes
-    OpenInference.ATTR_MESSAGE_CONTENT = "message.content";
-    OpenInference.ATTR_MESSAGE_CONTENTS = "message.contents";
-    OpenInference.ATTR_MESSAGE_FUNCTION_CALL_ARGUMENTS_JSON = "message.function_call_arguments_json";
-    OpenInference.ATTR_MESSAGE_FUNCTION_CALL_NAME = "message.function_call_name";
-    OpenInference.ATTR_MESSAGE_ROLE = "message.role";
-    OpenInference.ATTR_MESSAGE_TOOL_CALLS = "message.tool_calls";
+    OpenInference.ATTR_MESSAGE_CONTENT = 'message.content';
+    OpenInference.ATTR_MESSAGE_CONTENTS = 'message.contents';
+    OpenInference.ATTR_MESSAGE_FUNCTION_CALL_ARGUMENTS_JSON = 'message.function_call_arguments_json';
+    OpenInference.ATTR_MESSAGE_FUNCTION_CALL_NAME = 'message.function_call_name';
+    OpenInference.ATTR_MESSAGE_ROLE = 'message.role';
+    OpenInference.ATTR_MESSAGE_TOOL_CALLS = 'message.tool_calls';
     // Message content attributes
-    OpenInference.ATTR_MESSAGE_CONTENT_TYPE = "messagecontent.type";
-    OpenInference.ATTR_MESSAGE_CONTENT_TEXT = "messagecontent.text";
-    OpenInference.ATTR_MESSAGE_CONTENT_IMAGE = "messagecontent.image";
+    OpenInference.ATTR_MESSAGE_CONTENT_TYPE = 'messagecontent.type';
+    OpenInference.ATTR_MESSAGE_CONTENT_TEXT = 'messagecontent.text';
+    OpenInference.ATTR_MESSAGE_CONTENT_IMAGE = 'messagecontent.image';
     // Metadata attribute
-    OpenInference.ATTR_METADATA = "metadata";
+    OpenInference.ATTR_METADATA = 'metadata';
     // Output attributes
-    OpenInference.ATTR_OUTPUT_MIME_TYPE = "output.mime_type";
-    OpenInference.ATTR_OUTPUT_VALUE = "output.value";
+    OpenInference.ATTR_OUTPUT_MIME_TYPE = 'output.mime_type';
+    OpenInference.ATTR_OUTPUT_VALUE = 'output.value';
     // Reranker attributes
-    OpenInference.ATTR_RERANKER_INPUT_DOCUMENTS = "reranker.input_documents";
-    OpenInference.ATTR_RERANKER_MODEL_NAME = "reranker.model_name";
-    OpenInference.ATTR_RERANKER_OUTPUT_DOCUMENTS = "reranker.output_documents";
-    OpenInference.ATTR_RERANKER_QUERY = "reranker.query";
-    OpenInference.ATTR_RERANKER_TOP_K = "reranker.top_k";
+    OpenInference.ATTR_RERANKER_INPUT_DOCUMENTS = 'reranker.input_documents';
+    OpenInference.ATTR_RERANKER_MODEL_NAME = 'reranker.model_name';
+    OpenInference.ATTR_RERANKER_OUTPUT_DOCUMENTS = 'reranker.output_documents';
+    OpenInference.ATTR_RERANKER_QUERY = 'reranker.query';
+    OpenInference.ATTR_RERANKER_TOP_K = 'reranker.top_k';
     // Retrieval attribute
-    OpenInference.ATTR_RETRIEVAL_DOCUMENTS = "retrieval.documents";
+    OpenInference.ATTR_RETRIEVAL_DOCUMENTS = 'retrieval.documents';
     // Session attribute
-    OpenInference.ATTR_SESSION_ID = "session.id";
+    OpenInference.ATTR_SESSION_ID = 'session.id';
     // Tag attribute
-    OpenInference.ATTR_TAG_TAGS = "tag.tags";
+    OpenInference.ATTR_TAG_TAGS = 'tag.tags';
     // Tool attributes
-    OpenInference.ATTR_TOOL_DESCRIPTION = "tool.description";
-    OpenInference.ATTR_TOOL_JSON_SCHEMA = "tool.json_schema";
-    OpenInference.ATTR_TOOL_NAME = "tool.name";
-    OpenInference.ATTR_TOOL_PARAMETERS = "tool.parameters";
+    OpenInference.ATTR_TOOL_DESCRIPTION = 'tool.description';
+    OpenInference.ATTR_TOOL_JSON_SCHEMA = 'tool.json_schema';
+    OpenInference.ATTR_TOOL_NAME = 'tool.name';
+    OpenInference.ATTR_TOOL_PARAMETERS = 'tool.parameters';
     // Tool call attributes
-    OpenInference.ATTR_TOOL_CALL_FUNCTION_ARGUMENTS = "tool_call.function.arguments";
-    OpenInference.ATTR_TOOL_CALL_FUNCTION_NAME = "tool_call.function.name";
+    OpenInference.ATTR_TOOL_CALL_FUNCTION_ARGUMENTS = 'tool_call.function.arguments';
+    OpenInference.ATTR_TOOL_CALL_FUNCTION_NAME = 'tool_call.function.name';
     // User attribute
-    OpenInference.ATTR_USER_ID = "user.id";
+    OpenInference.ATTR_USER_ID = 'user.id';
     return OpenInference;
 }());
 exports.default = OpenInference;

package/dist/OpenTelemetry/index.js

@@ -70,7 +70,7 @@ function currentOpenTelemetryHeaders() {
     var propagator = new core_1.W3CTraceContextPropagator();
     var carrier = {
         traceparent: null,
-        tracestate: null
+        tracestate: null,
     };
     var setter = {
         set: function (carrier, key, value) {
@@ -82,6 +82,6 @@ function currentOpenTelemetryHeaders() {
     propagator.inject(api_1.context.active(), carrier, setter);
     return {
         traceparent: carrier.traceparent,
-        tracestate: carrier.tracestate
+        tracestate: carrier.tracestate,
     };
 }

package/dist/index.d.ts

@@ -21,6 +21,8 @@ import { OpenInferenceSpanKind } from './OpenTelemetry/OpenInference/types';
 import ArvoOrchestrationSubject from './ArvoOrchestrationSubject';
 import { ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema } from './ArvoOrchestrationSubject/schema';
 import { ArvoOrchestrationSubjectContent, ArvoOchestratorVersion } from './ArvoOrchestrationSubject/type';
+import ArvoEventHttp from './ArvoEventHttp';
+import { ArvoEventHttpConfig } from './ArvoEventHttp/types';
 /**
  * Collection of Zod schemas for validating various aspects of Arvo events.
  * @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.
@@ -87,4 +89,4 @@ declare const ArvoEventSchemas: {
         tracestate: string | null;
     }>;
 };
-export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, InferArvoContract, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema, ArvoOrchestrationSubjectContent, ArvoOchestratorVersion, };
+export { ArvoEventHttpConfig, ArvoEventHttp, ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, InferArvoContract, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContentSchema, ArvoOchestratorVersionSchema, ArvoOrchestrationSubjectContent, ArvoOchestratorVersion, };

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ArvoOchestratorVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.ArvoErrorSchema = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.createArvoContractLibrary = exports.ArvoContractLibrary = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchemas = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
+exports.ArvoOchestratorVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.ArvoErrorSchema = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.createArvoContractLibrary = exports.ArvoContractLibrary = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchemas = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = exports.ArvoEventHttp = void 0;
 var ArvoEvent_1 = __importDefault(require("./ArvoEvent"));
 exports.ArvoEvent = ArvoEvent_1.default;
 var schema_1 = require("./ArvoEvent/schema");
@@ -47,6 +47,8 @@ exports.ArvoOrchestrationSubject = ArvoOrchestrationSubject_1.default;
 var schema_3 = require("./ArvoOrchestrationSubject/schema");
 Object.defineProperty(exports, "ArvoOrchestrationSubjectContentSchema", { enumerable: true, get: function () { return schema_3.ArvoOrchestrationSubjectContentSchema; } });
 Object.defineProperty(exports, "ArvoOchestratorVersionSchema", { enumerable: true, get: function () { return schema_3.ArvoOchestratorVersionSchema; } });
+var ArvoEventHttp_1 = __importDefault(require("./ArvoEventHttp"));
+exports.ArvoEventHttp = ArvoEventHttp_1.default;
 /**
  * Collection of Zod schemas for validating various aspects of Arvo events.
  * @property {z.ZodObject} CloudEventContextSchema - Schema for core CloudEvent properties.

package/package.json

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