arvo-core 1.0.28 → 1.0.30

package/README.md

@@ -1,3 +1,7 @@
+[![SonarCloud](https://sonarcloud.io/images/project_badges/sonarcloud-white.svg)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+
+
 # Arvo
 
 ## What is Arvo
@@ -86,3 +90,18 @@ This package is available under the MIT License. For more details, refer to the
 ## Change Logs
 
 For a detailed list of changes and updates, please refer to the [document](CHANGELOG.md) file.
+
+### SonarCloud Metrics
+
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Bugs](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=bugs)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Code Smells](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=code_smells)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=coverage)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Duplicated Lines (%)](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=duplicated_lines_density)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Lines of Code](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=ncloc)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Reliability Rating](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=reliability_rating)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Security Rating](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=security_rating)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Technical Debt](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=sqale_index)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Maintainability Rating](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=sqale_rating)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+[![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=SaadAhmad123_arvo-core&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=SaadAhmad123_arvo-core)
+

package/dist/ArvoContract/helpers.d.ts

@@ -12,7 +12,7 @@ export type InferArvoContract<T> = T extends IArvoContract<infer S, infer U, inf
  *
  * @template TContract - The type of the contract specification.
  *
- * @param contractSpec - The contract specification object.
+ * @param contract - The contract specification object.
  *   This should include the URI, accepts, and emits properties as defined in IArvoContract.
  *
  * @returns The created ArvoContract instance.

package/dist/ArvoContract/helpers.js

@@ -13,7 +13,7 @@ var _1 = __importDefault(require("."));
  *
  * @template TContract - The type of the contract specification.
  *
- * @param contractSpec - The contract specification object.
+ * @param contract - The contract specification object.
  *   This should include the URI, accepts, and emits properties as defined in IArvoContract.
  *
  * @returns The created ArvoContract instance.

package/dist/ArvoContract/index.js

@@ -31,10 +31,11 @@ var ArvoContract = /** @class */ (function () {
      * @param params - The contract parameters.
      */
     function ArvoContract(params) {
+        var _a;
         this._uri = validators_1.ArvoContractValidators.contract.uri.parse(params.uri);
         this._accepts = this._validateAccepts(params.accepts);
         this._emits = this._validateEmits(params.emits);
-        this.description = params.description || null;
+        this.description = (_a = params.description) !== null && _a !== void 0 ? _a : null;
     }
     Object.defineProperty(ArvoContract.prototype, "uri", {
         /**

package/dist/ArvoEvent/helpers.js

@@ -47,6 +47,7 @@ var uuid_1 = require("uuid");
 var createArvoEvent = function (event, extensions) {
     var span = OpenTelemetry_1.ArvoCoreTracer.startSpan("createArvoEvent<".concat(event.type, ">"), {});
     return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
+        var _a, _b, _c, _d, _e, _f, _g, _h;
         span.setStatus({ code: api_1.SpanStatusCode.OK });
         try {
             if (event.datacontenttype &&
@@ -58,15 +59,15 @@ var createArvoEvent = function (event, extensions) {
                 });
             }
             return new _1.default({
-                id: event.id || (0, uuid_1.v4)(),
+                id: (_a = event.id) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)(),
                 type: event.type,
-                accesscontrol: event.accesscontrol || null,
-                executionunits: event.executionunits || null,
-                traceparent: event.traceparent || null,
-                tracestate: event.tracestate || null,
-                datacontenttype: event.datacontenttype || schema_1.ArvoDataContentType,
-                specversion: event.specversion || '1.0',
-                time: event.time || (0, utils_1.createTimestamp)(),
+                accesscontrol: (_b = event.accesscontrol) !== null && _b !== void 0 ? _b : null,
+                executionunits: (_c = event.executionunits) !== null && _c !== void 0 ? _c : null,
+                traceparent: (_d = event.traceparent) !== null && _d !== void 0 ? _d : null,
+                tracestate: (_e = event.tracestate) !== null && _e !== void 0 ? _e : null,
+                datacontenttype: (_f = event.datacontenttype) !== null && _f !== void 0 ? _f : schema_1.ArvoDataContentType,
+                specversion: (_g = event.specversion) !== null && _g !== void 0 ? _g : '1.0',
+                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,

package/dist/ArvoEvent/index.d.ts

@@ -91,7 +91,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field represents the intended recipient or destination of the event.
      * @returns The value of the 'to' field.
      *
-     * @remark
+     * @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.
@@ -102,7 +102,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains access control information for the event.
      * @returns The value of the 'accesscontrol' field.
      *
-     * @remark
+     * @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.
@@ -113,7 +113,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field indicate an alternative destination for the event.
      * @returns The value of the 'redirectto' field.
      *
-     * @remark
+     * @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.
@@ -124,7 +124,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains information about the execution units associated with the event.
      * @returns The value of the 'executionunits' field.
      *
-     * @remark
+     * @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.
@@ -135,7 +135,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains the W3C Trace Context traceparent header.
      * @returns The value of the 'traceparent' field.
      *
-     * @remark
+     * @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.
@@ -146,7 +146,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      * This field contains the W3C Trace Context tracestate header.
      * @returns The value of the 'tracestate' field, or undefined if not set.
      *
-     * @remark
+     * @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.

package/dist/ArvoEvent/index.js

@@ -105,6 +105,7 @@ var ArvoEvent = /** @class */ (function () {
          * as `cloudevents.arvo.event_*` fields
          */
         get: function () {
+            var _a, _b, _c, _d;
             return {
                 'cloudevents.event_id': this.id || OpenTelemetry_1.OTelNull,
                 'cloudevents.event_source': this.source || OpenTelemetry_1.OTelNull,
@@ -113,10 +114,10 @@ var ArvoEvent = /** @class */ (function () {
                 'cloudevents.event_type': this.type || OpenTelemetry_1.OTelNull,
                 'cloudevents.event_time': this.time || OpenTelemetry_1.OTelNull,
                 'cloudevents.event_datacontenttype': this.datacontenttype || OpenTelemetry_1.OTelNull,
-                'cloudevents.event_dataschema': this.dataschema || OpenTelemetry_1.OTelNull,
-                'cloudevents.arvo.event_redirectto': this.extensions.redirectto || OpenTelemetry_1.OTelNull,
-                'cloudevents.arvo.event_to': this.extensions.to || OpenTelemetry_1.OTelNull,
-                'cloudevents.arvo.event_executionunits': this.extensions.executionunits || 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,
             };
         },
         enumerable: false,
@@ -128,7 +129,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field represents the intended recipient or destination of the event.
          * @returns The value of the 'to' field.
          *
-         * @remark
+         * @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.
@@ -145,7 +146,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains access control information for the event.
          * @returns The value of the 'accesscontrol' field.
          *
-         * @remark
+         * @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.
@@ -162,7 +163,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field indicate an alternative destination for the event.
          * @returns The value of the 'redirectto' field.
          *
-         * @remark
+         * @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.
@@ -179,7 +180,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains information about the execution units associated with the event.
          * @returns The value of the 'executionunits' field.
          *
-         * @remark
+         * @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.
@@ -196,7 +197,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains the W3C Trace Context traceparent header.
          * @returns The value of the 'traceparent' field.
          *
-         * @remark
+         * @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.
@@ -213,7 +214,7 @@ var ArvoEvent = /** @class */ (function () {
          * This field contains the W3C Trace Context tracestate header.
          * @returns The value of the 'tracestate' field, or undefined if not set.
          *
-         * @remark
+         * @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.

package/dist/ArvoEventFactory/index.js

@@ -124,13 +124,14 @@ var ArvoEventFactory = /** @class */ (function () {
         var _this = this;
         var span = OpenTelemetry_1.ArvoCoreTracer.startSpan("ArvoEventFactory<".concat(this.contract.uri, ">.systemError<sys.").concat(this.contract.accepts.type, ".error>.create"));
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
+            var _a;
             span.setStatus({ code: api_1.SpanStatusCode.OK });
             try {
                 var error = event.error, _events = __rest(event, ["error"]);
                 return (0, helpers_1.createArvoEvent)(__assign(__assign({}, event), { type: "sys.".concat(_this.contract.accepts.type, ".error"), data: {
                         errorName: error.name,
                         errorMessage: error.message,
-                        errorStack: error.stack || null,
+                        errorStack: (_a = error.stack) !== null && _a !== void 0 ? _a : null,
                     }, datacontenttype: schema_1.ArvoDataContentType, dataschema: _this.contract.uri }), extensions);
             }
             catch (error) {

package/dist/OpenTelemetry/index.d.ts

@@ -7,8 +7,6 @@ export declare const ArvoCoreTracer: import("@opentelemetry/api").Tracer;
 /**
  * Logs a message to a span with additional parameters.
  * @param params - The parameters for the log message.
- * @param params.level - The log level of the message.
- * @param params.message - The main content of the log message.
  * @param span - The span to log the message to. If not provided, the active span is used.
  *               If no active span is available, the message is logged to the console.
  */

package/dist/OpenTelemetry/index.js

@@ -24,8 +24,6 @@ exports.ArvoCoreTracer = api_1.trace.getTracer(pkg.name, pkg.version);
 /**
  * Logs a message to a span with additional parameters.
  * @param params - The parameters for the log message.
- * @param params.level - The log level of the message.
- * @param params.message - The main content of the log message.
  * @param span - The span to log the message to. If not provided, the active span is used.
  *               If no active span is available, the message is logged to the console.
  */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-core",
-  "version": "1.0.28",
+  "version": "1.0.30",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {
@@ -42,7 +42,8 @@
     "ts-node": "^10.9.2",
     "typedoc": "^0.26.6",
     "typedoc-plugin-zod": "^1.2.1",
-    "typescript": "^5.5.4"
+    "typescript": "^5.5.4",
+    "typedoc-github-theme": "^0.1.2"
   },
   "dependencies": {
     "@opentelemetry/api": "^1.9.0",