arvo-core 1.0.29 → 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/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

@@ -129,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.
@@ -146,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.
@@ -163,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.
@@ -180,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.
@@ -197,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.
@@ -214,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/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.29",
+  "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",