arvo-core 1.0.26 → 1.0.28

package/CHANGELOG.md

@@ -48,3 +48,7 @@
 
 - Added OpenTelemetry attributes for Arvo and OpenInference
 
+## [1.0.28] - 2024-09-10
+
+- Added SonarCloud integration for code scanning
+

package/README.md

@@ -73,6 +73,7 @@ import {
   createArvoEvent,
   createArvoContract,
   createArvoContractLibrary,
+  createArvoEventFactory,
 } from 'arvo-core';
 ```
 

package/dist/ArvoContract/index.d.ts

@@ -1,5 +1,5 @@
 import { z } from 'zod';
-import { ArvoContractRecord, IArvoContract } from './types';
+import { ArvoContractJSONSchema, ArvoContractRecord, IArvoContract } from './types';
 import { ArvoErrorSchema } from '../schema';
 /**
  * ArvoContract class represents a contract with defined input and output schemas.
@@ -39,7 +39,7 @@ export default class ArvoContract<TUri extends string = string, TType extends st
     get emits(): TEmits;
     get systemError(): ArvoContractRecord<`sys.${TType}.error`, typeof ArvoErrorSchema>;
     /**
-     * Validates the contract bound handler's input against the
+     * Validates the contract bound handler's input/ accept event against the
      * contract's accept schema.
      * @template U - The type of the input to validate.
      * @param type - The type of the input event.
@@ -47,9 +47,9 @@ export default class ArvoContract<TUri extends string = string, TType extends st
      * @returns The validation result.
      * @throws If the accept type is not found in the contract.
      */
-    validateInput<U>(type: TType, input: U): z.SafeParseReturnType<any, any>;
+    validateAccepts<U>(type: TType, input: U): z.SafeParseReturnType<any, any>;
     /**
-     * Validates the contract bound handler's output against the
+     * Validates the contract bound handler's output/ emits against the
      * contract's emit schema.
      * @template U - The type of the output to validate.
      * @param type - The type of the output event.
@@ -57,21 +57,21 @@ export default class ArvoContract<TUri extends string = string, TType extends st
      * @returns The validation result.
      * @throws If the emit type is not found in the contract.
      */
-    validateOutput<U extends keyof TEmits>(type: U, output: unknown): z.SafeParseReturnType<any, any>;
+    validateEmits<U extends keyof TEmits>(type: U, output: unknown): z.SafeParseReturnType<any, any>;
     /**
      * Validates the accepts record.
      * @param accepts - The accepts record to validate.
      * @returns The validated accepts record.
      * @private
      */
-    private validateAccepts;
+    private _validateAccepts;
     /**
      * Validates the emits records.
      * @param emits - The emits records to validate.
      * @returns The validated emits records.
      * @private
      */
-    private validateEmits;
+    private _validateEmits;
     /**
      * Exports the ArvoContract instance as a plain object conforming to the IArvoContract interface.
      * This method can be used to serialize the contract or to create a new instance with the same parameters.
@@ -90,5 +90,5 @@ export default class ArvoContract<TUri extends string = string, TType extends st
      *   - accepts: An object containing the accepted input type and its JSON Schema representation
      *   - emits: An array of objects, each containing an emitted event type and its JSON Schema representation
      */
-    toJsonSchema(): Record<string, any>;
+    toJsonSchema(): ArvoContractJSONSchema;
 }

package/dist/ArvoContract/index.js

@@ -32,8 +32,8 @@ var ArvoContract = /** @class */ (function () {
      */
     function ArvoContract(params) {
         this._uri = validators_1.ArvoContractValidators.contract.uri.parse(params.uri);
-        this._accepts = this.validateAccepts(params.accepts);
-        this._emits = this.validateEmits(params.emits);
+        this._accepts = this._validateAccepts(params.accepts);
+        this._emits = this._validateEmits(params.emits);
         this.description = params.description || null;
     }
     Object.defineProperty(ArvoContract.prototype, "uri", {
@@ -79,7 +79,7 @@ var ArvoContract = /** @class */ (function () {
         configurable: true
     });
     /**
-     * Validates the contract bound handler's input against the
+     * Validates the contract bound handler's input/ accept event against the
      * contract's accept schema.
      * @template U - The type of the input to validate.
      * @param type - The type of the input event.
@@ -87,14 +87,14 @@ var ArvoContract = /** @class */ (function () {
      * @returns The validation result.
      * @throws If the accept type is not found in the contract.
      */
-    ArvoContract.prototype.validateInput = function (type, input) {
+    ArvoContract.prototype.validateAccepts = function (type, input) {
         if (type !== this._accepts.type) {
             throw new Error("Accept type \"".concat(type, "\" not found in contract"));
         }
         return this._accepts.schema.safeParse(input);
     };
     /**
-     * Validates the contract bound handler's output against the
+     * Validates the contract bound handler's output/ emits against the
      * contract's emit schema.
      * @template U - The type of the output to validate.
      * @param type - The type of the output event.
@@ -102,7 +102,7 @@ var ArvoContract = /** @class */ (function () {
      * @returns The validation result.
      * @throws If the emit type is not found in the contract.
      */
-    ArvoContract.prototype.validateOutput = function (type, output) {
+    ArvoContract.prototype.validateEmits = function (type, output) {
         var emit = this.emits[type];
         if (!emit) {
             throw new Error("Emit type \"".concat(type.toString(), "\" not found in contract"));
@@ -115,7 +115,7 @@ var ArvoContract = /** @class */ (function () {
      * @returns The validated accepts record.
      * @private
      */
-    ArvoContract.prototype.validateAccepts = function (accepts) {
+    ArvoContract.prototype._validateAccepts = function (accepts) {
         return {
             type: validators_1.ArvoContractValidators.record.type.parse(accepts.type),
             schema: accepts.schema,
@@ -127,7 +127,7 @@ var ArvoContract = /** @class */ (function () {
      * @returns The validated emits records.
      * @private
      */
-    ArvoContract.prototype.validateEmits = function (emits) {
+    ArvoContract.prototype._validateEmits = function (emits) {
         Object.entries(emits).forEach(function (_a) {
             var key = _a[0];
             return validators_1.ArvoContractValidators.record.type.parse(key);

package/dist/ArvoContract/types.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import zodToJsonSchema from 'zod-to-json-schema';
 /**
  * Represents a record in an Arvo contract.
  * @template TType - The type of the record, defaults to string.
@@ -33,3 +34,26 @@ export interface IArvoContract<TUri extends string = string, TType extends strin
  * @template T - The ArvoContractRecord to resolve.
  */
 export type ResolveArvoContractRecord<T extends ArvoContractRecord> = z.infer<T['schema']>;
+/**
+ * Represents the JSON Schema representation of an ArvoContract.
+ */
+export type ArvoContractJSONSchema = {
+    /** The unique identifier (URI) of the contract */
+    uri: string;
+    /** The description of the contract (null if not provided) */
+    description: string | null;
+    /** The accepted input schema for the contract */
+    accepts: {
+        /** The type identifier for the accepted input */
+        type: string;
+        /** The JSON Schema representation of the accepted input schema */
+        schema: ReturnType<typeof zodToJsonSchema>;
+    };
+    /** An array of emitted event schemas for the contract */
+    emits: {
+        /** The type identifier for the emitted event */
+        type: string;
+        /** The JSON Schema representation of the emitted event schema */
+        schema: ReturnType<typeof zodToJsonSchema>;
+    }[];
+};

package/dist/ArvoEvent/index.d.ts

@@ -137,7 +137,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      *
      * @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
+     * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
      */
     get traceparent(): string | null;
@@ -148,7 +148,7 @@ export default class ArvoEvent<TData extends ArvoEventData = ArvoEventData, TExt
      *
      * @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
+     * is an ArvoEvent object which natively defines this extension on the CloudEvent
      * spec.
      */
     get tracestate(): string | null;

package/dist/ArvoEvent/index.js

@@ -198,7 +198,7 @@ var ArvoEvent = /** @class */ (function () {
          *
          * @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
+         * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
          */
         get: function () {
@@ -215,7 +215,7 @@ var ArvoEvent = /** @class */ (function () {
          *
          * @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
+         * is an ArvoEvent object which natively defines this extension on the CloudEvent
          * spec.
          */
         get: function () {

package/dist/ArvoEventFactory/index.d.ts

@@ -54,8 +54,8 @@ export default class ArvoEventFactory<TUri extends string = string, TType extend
         error: Error;
         to: string;
     }, extensions?: TExtension): import("..").ArvoEvent<{
-        errorName: string;
         errorMessage: string;
+        errorName: string;
         errorStack: string | null;
     }, TExtension, `sys.${TType}.error`>;
 }

package/dist/ArvoEventFactory/index.js

@@ -58,7 +58,7 @@ var ArvoEventFactory = /** @class */ (function () {
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
             span.setStatus({ code: api_1.SpanStatusCode.OK });
             try {
-                var validationResult = _this.contract.validateInput(_this.contract.accepts.type, event.data);
+                var validationResult = _this.contract.validateAccepts(_this.contract.accepts.type, event.data);
                 if (!validationResult.success) {
                     throw new Error("Accept Event data validation failed: ".concat(validationResult.error.message));
                 }
@@ -93,7 +93,7 @@ var ArvoEventFactory = /** @class */ (function () {
         return api_1.context.with(api_1.trace.setSpan(api_1.context.active(), span), function () {
             span.setStatus({ code: api_1.SpanStatusCode.OK });
             try {
-                var validationResult = _this.contract.validateOutput(event.type, event.data);
+                var validationResult = _this.contract.validateEmits(event.type, event.data);
                 if (!validationResult.success) {
                     throw new Error("Emit Event data validation failed: ".concat(validationResult.error.message));
                 }

package/dist/index.d.ts

@@ -8,7 +8,7 @@ import { validateURI, cleanString } from './utils';
 import ArvoContract from './ArvoContract';
 import { createArvoContract, InferArvoContract } from './ArvoContract/helpers';
 import { ArvoContractValidators } from './ArvoContract/validators';
-import { ArvoContractRecord, IArvoContract, ResolveArvoContractRecord } from './ArvoContract/types';
+import { ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoContractJSONSchema } from './ArvoContract/types';
 import ArvoContractLibrary from './ArvoContractLibrary';
 import { createArvoContractLibrary } from './ArvoContractLibrary/helpers';
 import ArvoEventFactory from './ArvoEventFactory';
@@ -84,4 +84,4 @@ declare const ArvoEventSchemas: {
         tracestate: string | null;
     }>;
 };
-export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, InferArvoContract, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, };
+export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchemas, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, InferArvoContract, IArvoContract, ResolveArvoContractRecord, ArvoContractLibrary, createArvoContractLibrary, ArvoEventFactory, createArvoEventFactory, ArvoErrorSchema, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, };

package/dist/schema.d.ts

@@ -10,11 +10,11 @@ export declare const ArvoErrorSchema: z.ZodObject<{
     errorMessage: z.ZodString;
     errorStack: z.ZodNullable<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
-    errorName: string;
     errorMessage: string;
+    errorName: string;
     errorStack: string | null;
 }, {
-    errorName: string;
     errorMessage: string;
+    errorName: string;
     errorStack: string | null;
 }>;

package/package.json

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