arvo-core 1.0.13 → 1.0.16

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/OpenTelemetry/index.d.ts

@@ -64,8 +64,8 @@ export declare const exceptionToSpan: (span: Span, level: TelemetryLogLevel, err
  *   telemetryContext,
  *   'ProcessOrder',
  *   { attributes: { orderId: '12345' } },
- *   (span, orderId) => {
- *     span.addEvent('Processing order');
+ *   (telemetryContext, orderId) => {
+ *     telemetryContext.span.addEvent('Processing order');
  *     return processOrder(orderId);
  *   },
  *   null,
@@ -78,8 +78,8 @@ export declare const exceptionToSpan: (span: Span, level: TelemetryLogLevel, err
  *   'OrderService',
  *   'FetchOrderDetails',
  *   undefined,
- *   (span, orderId) => {
- *     span.setAttribute('orderId', orderId);
+ *   (telemetryContext, orderId) => {
+ *     telemetryContext.span.setAttribute('orderId', orderId);
  *     return fetchOrderDetails(orderId);
  *   },
  *   null,

package/dist/OpenTelemetry/index.js

@@ -115,8 +115,8 @@ exports.exceptionToSpan = exceptionToSpan;
  *   telemetryContext,
  *   'ProcessOrder',
  *   { attributes: { orderId: '12345' } },
- *   (span, orderId) => {
- *     span.addEvent('Processing order');
+ *   (telemetryContext, orderId) => {
+ *     telemetryContext.span.addEvent('Processing order');
  *     return processOrder(orderId);
  *   },
  *   null,
@@ -129,8 +129,8 @@ exports.exceptionToSpan = exceptionToSpan;
  *   'OrderService',
  *   'FetchOrderDetails',
  *   undefined,
- *   (span, orderId) => {
- *     span.setAttribute('orderId', orderId);
+ *   (telemetryContext, orderId) => {
+ *     telemetryContext.span.setAttribute('orderId', orderId);
  *     return fetchOrderDetails(orderId);
  *   },
  *   null,
@@ -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.13",
+  "version": "1.0.16",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {