arvo-core 1.1.4 → 1.1.6

package/dist/ArvoEventHttp/index.d.ts

@@ -30,4 +30,51 @@ export default class ArvoEventHttp {
      * @throws {Error} If required fields are missing or if there's an error parsing the input.
      */
     static importFromStructured(config: ArvoEventHttpConfig): ArvoEvent;
+    /**
+     * Validates the content type of the HTTP request.
+     * @param actual - The actual content type from the request.
+     * @param expected - The expected content type.
+     * @throws {Error} If the actual content type doesn't match the expected one.
+     */
+    private static validateContentType;
+    /**
+     * Extracts event fields from the HTTP headers.
+     * @param headers - The HTTP headers containing event information.
+     * @returns An object with extracted event fields.
+     */
+    private static extractEventFieldsFromHeaders;
+    /**
+     * Creates an error message for a missing required field.
+     * @param type - The type of the missing field.
+     * @param isHeader - A flag to distinguish between headers and structured payload
+     * @returns A formatted error message string.
+     */
+    private static createErrorMessageForMissingField;
+    /**
+     * Validates that all required fields are present in the event data.
+     * @param event - The event data to validate.
+     * @param isHeader - A flag to distinguish between headers and structured payload
+     * @throws {Error} If any required field is missing.
+     */
+    private static validateRequiredFields;
+    /**
+     * Extracts extension fields from the HTTP headers.
+     * @param headers - The HTTP headers containing event information.
+     * @returns An object with extracted extension fields.
+     */
+    private static extractExtensions;
+    /**
+     * Creates an ArvoEvent instance from extracted event data, payload, and extensions.
+     * @param event - The extracted event data.
+     * @param data - The event payload.
+     * @param extensions - The extracted extension fields.
+     * @returns A new ArvoEvent instance.
+     */
+    private static createArvoEvent;
+    /**
+     * Creates an ArvoEvent instance from structured event data.
+     * @param eventData - The structured event data.
+     * @returns A new ArvoEvent instance.
+     */
+    private static createArvoEventFromStructured;
 }

package/dist/ArvoEventHttp/index.js

@@ -87,75 +87,12 @@ var ArvoEventHttp = /** @class */ (function () {
      * @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));
-        }
+        var _a, _b;
+        this.validateContentType((_b = (_a = config.headers['content-type']) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "", 'application/json');
+        var event = this.extractEventFieldsFromHeaders(config.headers);
+        this.validateRequiredFields(event, true);
+        var extensions = this.extractExtensions(config.headers);
+        return this.createArvoEvent(event, config.data, extensions);
     };
     /**
      * Imports an ArvoEvent from a structured-mode HTTP representation.
@@ -164,35 +101,132 @@ var ArvoEventHttp = /** @class */ (function () {
      * @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);
+        var _a, _b;
+        this.validateContentType((_b = (_a = config.headers['content-type']) === null || _a === void 0 ? void 0 : _a.toString()) !== null && _b !== void 0 ? _b : "", schema_1.ArvoDataContentType);
+        var eventData = config.data;
+        this.validateRequiredFields(eventData, false);
+        return this.createArvoEventFromStructured(eventData);
+    };
+    /**
+     * Validates the content type of the HTTP request.
+     * @param actual - The actual content type from the request.
+     * @param expected - The expected content type.
+     * @throws {Error} If the actual content type doesn't match the expected one.
+     */
+    ArvoEventHttp.validateContentType = function (actual, expected) {
+        if (actual !== expected) {
+            throw new Error("Invalid content-type: ".concat(actual, ". Expected: ").concat(expected));
         }
-        catch (error) {
-            throw new Error("Failed to import ArvoEvent from structured: ".concat(error.message));
+    };
+    /**
+     * Extracts event fields from the HTTP headers.
+     * @param headers - The HTTP headers containing event information.
+     * @returns An object with extracted event fields.
+     */
+    ArvoEventHttp.extractEventFieldsFromHeaders = function (headers) {
+        var eventFields = ['id', 'type', 'accesscontrol', 'executionunits', 'traceparent', 'tracestate', 'datacontenttype', 'specversion', 'time', 'source', 'subject', 'to', 'redirectto', 'dataschema'];
+        return Object.fromEntries(eventFields
+            .map(function (field) { return ["ce-".concat(field), headers["ce-".concat(field)]]; })
+            .filter(function (_a) {
+            var value = _a[1];
+            return value !== undefined;
+        })
+            .map(function (_a) {
+            var key = _a[0], value = _a[1];
+            return [key.slice(3), value];
+        }));
+    };
+    /**
+     * Creates an error message for a missing required field.
+     * @param type - The type of the missing field.
+     * @param isHeader - A flag to distinguish between headers and structured payload
+     * @returns A formatted error message string.
+     */
+    ArvoEventHttp.createErrorMessageForMissingField = function (type, isHeader) {
+        if (isHeader) {
+            return "Missing required header field(s): ".concat(type);
         }
+        return "Missing required field(s): ".concat(type);
+    };
+    /**
+     * Validates that all required fields are present in the event data.
+     * @param event - The event data to validate.
+     * @param isHeader - A flag to distinguish between headers and structured payload
+     * @throws {Error} If any required field is missing.
+     */
+    ArvoEventHttp.validateRequiredFields = function (event, isHeader) {
+        ['type', 'source', 'subject'].forEach(function (field) {
+            if (!event[field]) {
+                throw new Error(ArvoEventHttp.createErrorMessageForMissingField(isHeader ? "ce-".concat(field) : field, isHeader));
+            }
+        });
+    };
+    /**
+     * Extracts extension fields from the HTTP headers.
+     * @param headers - The HTTP headers containing event information.
+     * @returns An object with extracted extension fields.
+     */
+    ArvoEventHttp.extractExtensions = function (headers) {
+        var eventFields = ['id', 'type', 'accesscontrol', 'executionunits', 'traceparent', 'tracestate', 'datacontenttype', 'specversion', 'time', 'source', 'subject', 'to', 'redirectto', 'dataschema'];
+        return Object.fromEntries(Object.entries(headers)
+            .filter(function (_a) {
+            var key = _a[0];
+            return key.startsWith('ce-') && !eventFields.includes(key.slice(3));
+        })
+            .map(function (_a) {
+            var key = _a[0], value = _a[1];
+            return [key.slice(3), value];
+        }));
+    };
+    /**
+     * Creates an ArvoEvent instance from extracted event data, payload, and extensions.
+     * @param event - The extracted event data.
+     * @param data - The event payload.
+     * @param extensions - The extracted extension fields.
+     * @returns A new ArvoEvent instance.
+     */
+    ArvoEventHttp.createArvoEvent = function (event, data, extensions) {
+        var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
+        return new ArvoEvent_1.default({
+            id: (_a = event.id) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)(),
+            type: event.type,
+            accesscontrol: (_b = event.accesscontrol) !== null && _b !== void 0 ? _b : null,
+            executionunits: event.executionunits ? Number(event.executionunits) : null,
+            traceparent: (_c = event.traceparent) !== null && _c !== void 0 ? _c : null,
+            tracestate: (_d = event.tracestate) !== null && _d !== void 0 ? _d : null,
+            datacontenttype: (_e = event.datacontenttype) !== null && _e !== void 0 ? _e : schema_1.ArvoDataContentType,
+            specversion: (_f = event.specversion) !== null && _f !== void 0 ? _f : '1.0',
+            time: (_g = event.time) !== null && _g !== void 0 ? _g : (0, utils_1.createTimestamp)(),
+            source: event.source,
+            subject: event.subject,
+            to: (_h = event.to) !== null && _h !== void 0 ? _h : null,
+            redirectto: (_j = event.redirectto) !== null && _j !== void 0 ? _j : null,
+            dataschema: (_k = event.dataschema) !== null && _k !== void 0 ? _k : null,
+        }, data, extensions);
+    };
+    /**
+     * Creates an ArvoEvent instance from structured event data.
+     * @param eventData - The structured event data.
+     * @returns A new ArvoEvent instance.
+     */
+    ArvoEventHttp.createArvoEventFromStructured = function (eventData) {
+        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 ArvoEventHttp.createArvoEvent({
+            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);
     };
     return ArvoEventHttp;
 }());

package/dist/types.d.ts

@@ -62,13 +62,21 @@ type InferZodSchema<T> = T extends z.ZodTypeAny ? z.infer<T> : never;
  * // MyContractType will have properties uri, accepts, and emits
  */
 export type InferArvoContract<T extends ArvoContract<string, string, z.ZodTypeAny, Record<string, z.ZodTypeAny>>> = T extends ArvoContract<infer TUri, infer TType, infer TAcceptSchema, infer TEmits> ? {
+    /** The URI of the contract */
     uri: TUri;
+    /** The event type that this contract accepts */
     accepts: InferArvoEvent<ArvoEvent<InferZodSchema<TAcceptSchema>, {}, TType>>;
+    /** The event types that this contract can emit */
     emits: {
         [K in keyof TEmits]: InferArvoEvent<ArvoEvent<InferZodSchema<TEmits[K]>, {}, K & string>>;
-    } & {
-        [K in `sys.${TType}.error`]: InferArvoEvent<ArvoEvent<InferZodSchema<T['systemError']['schema']>, {}, T['systemError']['type']>>;
     };
+    /** The system error event type for this contract */
     systemError: InferArvoEvent<ArvoEvent<InferZodSchema<T['systemError']['schema']>, {}, T['systemError']['type']>>;
+    /** Union type of all emittable events, including regular events and system error */
+    emittableEvents: ({
+        [K in keyof TEmits]: InferArvoEvent<ArvoEvent<InferZodSchema<TEmits[K]>, {}, K & string>>;
+    } & {
+        [K in `sys.${TType}.error`]: InferArvoEvent<ArvoEvent<InferZodSchema<T['systemError']['schema']>, {}, T['systemError']['type']>>;
+    })[keyof TEmits | `sys.${TType}.error`];
 } : never;
 export {};

package/package.json

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