arvo-core 1.0.12 → 1.0.15

package/CHANGELOG.md

@@ -32,3 +32,7 @@
 
 - Added support for system error in ArvoContract
 
+## [1.0.15] - 2024-09-07
+
+- Added ArvoEvent spec-ed extension getter for a more ergonomic experience
+

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;
-    extensions: TExtension & ArvoExtension & OpenTelemetryExtension;
+    readonly extensions: TExtension & ArvoExtension & OpenTelemetryExtension;
     /**
      * Creates an instance of ArvoEvent.
      * @param context - The CloudEvent context along with Arvo and OpenTelemetry extensions.
@@ -86,4 +86,70 @@ 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.
+     *
+     * @remark
+     * 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.
+     *
+     * @remark
+     * 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.
+     *
+     * @remark
+     * 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.
+     *
+     * @remark
+     * 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.
+     *
+     * @remark
+     * This is a convenience getter for the data in `this.extensions.traceparent` as this
+     * is an ArvoEvent object which natively defined 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.
+     *
+     * @remark
+     * This is a convenience getter for the data in `this.extensions.tracestate` as this
+     * is an ArvoEvent object which natively defined this extension on the CloudEvent
+     * spec.
+     */
+    get tracestate(): string | null;
 }

package/dist/ArvoEvent/index.js

@@ -122,6 +122,108 @@ var ArvoEvent = /** @class */ (function () {
         enumerable: false,
         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.
+         *
+         * @remark
+         * 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;
+        },
+        enumerable: false,
+        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.
+         *
+         * @remark
+         * 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;
+        },
+        enumerable: false,
+        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.
+         *
+         * @remark
+         * 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;
+        },
+        enumerable: false,
+        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.
+         *
+         * @remark
+         * 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;
+        },
+        enumerable: false,
+        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.
+         *
+         * @remark
+         * This is a convenience getter for the data in `this.extensions.traceparent` as this
+         * is an ArvoEvent object which natively defined this extension on the CloudEvent
+         * spec.
+         */
+        get: function () {
+            return this.extensions.traceparent;
+        },
+        enumerable: false,
+        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.
+         *
+         * @remark
+         * This is a convenience getter for the data in `this.extensions.tracestate` as this
+         * is an ArvoEvent object which natively defined this extension on the CloudEvent
+         * spec.
+         */
+        get: function () {
+            return this.extensions.tracestate;
+        },
+        enumerable: false,
+        configurable: true
+    });
     return ArvoEvent;
 }());
 exports.default = ArvoEvent;

package/dist/ArvoEventFactory/index.d.ts

@@ -22,13 +22,15 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
      * Creates an ArvoEvent as per the accept record of the contract.
      *
      * @template TExtension - The type of extensions to add to the event.
-     * @param event - The event to create.
+     * @param event - The event to create. The field 'type' is automatically infered
      * @param [extensions] - Optional extensions to add to the event.
      * @param [telemetry] - Optional telemetry context for tracing.
      * @returns The created ArvoEvent as per the accept record of the contract.
      * @throws If the event data fails validation against the contract.
      */
-    accepts<TExtension extends Record<string, any>>(event: CreateArvoEvent<z.infer<TAcceptSchema>, TType>, extensions?: TExtension, telemetry?: TelemetryContext): import("..").ArvoEvent<z.TypeOf<TAcceptSchema>, TExtension, string>;
+    accepts<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<z.infer<TAcceptSchema>, TType>, 'type'> & {
+        to: string;
+    }, extensions?: TExtension, telemetry?: TelemetryContext): import("..").ArvoEvent<z.TypeOf<TAcceptSchema>, TExtension, string>;
     /**
      * Creates an ArvoEvent as per one of the emits record in the contract.
      *
@@ -40,7 +42,9 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
      * @returns The created ArvoEvent as per one of the emits records of the contract.
      * @throws If the event data fails validation against the contract.
      */
-    emits<U extends keyof TEmits & string, TExtension extends Record<string, any>>(event: CreateArvoEvent<z.infer<TEmits[U]>, U>, extensions?: TExtension, telemetry?: TelemetryContext): import("..").ArvoEvent<z.TypeOf<z.TypeOf<TEmits[U]>>, TExtension, string>;
+    emits<U extends keyof TEmits & string, TExtension extends Record<string, any>>(event: CreateArvoEvent<z.infer<TEmits[U]>, U> & {
+        to: string;
+    }, extensions?: TExtension, telemetry?: TelemetryContext): import("..").ArvoEvent<z.TypeOf<z.TypeOf<TEmits[U]>>, TExtension, string>;
     /**
      * Creates a system error ArvoEvent.
      *
@@ -52,6 +56,7 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
      */
     systemError<TExtension extends Record<string, any>>(event: Omit<CreateArvoEvent<any, any>, 'data' | 'type'> & {
         error: Error;
+        to: string;
     }, extensions?: TExtension, telemetry?: TelemetryContext): import("..").ArvoEvent<{
         errorName: string;
         errorMessage: string;

package/dist/ArvoEventFactory/index.js

@@ -46,7 +46,7 @@ var ArvoEventFactory = /** @class */ (function () {
      * Creates an ArvoEvent as per the accept record of the contract.
      *
      * @template TExtension - The type of extensions to add to the event.
-     * @param event - The event to create.
+     * @param event - The event to create. The field 'type' is automatically infered
      * @param [extensions] - Optional extensions to add to the event.
      * @param [telemetry] - Optional telemetry context for tracing.
      * @returns The created ArvoEvent as per the accept record of the contract.
@@ -55,11 +55,11 @@ var ArvoEventFactory = /** @class */ (function () {
     ArvoEventFactory.prototype.accepts = function (event, extensions, telemetry) {
         var _this = this;
         return (0, OpenTelemetry_1.createOtelSpan)(telemetry || 'ArvoEvent Creation Tracer', 'ContractualArvoEventFactory.accepts', {}, function () {
-            var validationResult = _this.contract.validateInput(event.type, event.data);
+            var validationResult = _this.contract.validateInput(_this.contract.accepts.type, event.data);
             if (!validationResult.success) {
                 throw new Error("Accept Event data validation failed: ".concat(validationResult.error.message));
             }
-            return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, telemetry);
+            return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { type: _this.contract.accepts.type, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri, data: validationResult.data }), extensions, telemetry);
         });
     };
     /**

package/dist/OpenTelemetry/index.js

@@ -152,6 +152,9 @@ var createOtelSpan = function (telemetryContext, spanName, spanOptions, wrappedF
         activeTracer = telemetryContext.tracer;
     }
     var newSpan = activeTracer.startSpan(spanName, spanOptions, activeContext);
+    newSpan.setStatus({
+        code: api_1.SpanStatusCode.OK,
+    });
     try {
         var result = api_1.context.with(api_1.trace.setSpan(activeContext, newSpan), function () {
             return wrappedFunction.call.apply(wrappedFunction, __spreadArray([thisArg,
@@ -161,9 +164,6 @@ var createOtelSpan = function (telemetryContext, spanName, spanOptions, wrappedF
                     carrier: (0, exports.getTelemetryCarrier)(newSpan, activeContext),
                 }], args, false));
         });
-        newSpan.setStatus({
-            code: api_1.SpanStatusCode.OK,
-        });
         newSpan.end();
         return result;
     }

package/package.json

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