arvo-core 2.2.4 → 2.2.6

package/dist/ArvoContract/VersionedArvoContract/index.d.ts

@@ -3,6 +3,8 @@ import { ArvoSemanticVersion } from '../../types';
 import { ArvoContractRecord } from '../types';
 import { IVersionedArvoContract, VersionedArvoContractJSONSchema } from './types';
 import { transformEmitsToArray } from './utils';
+import { EventDataschemaUtil } from '../../utils';
+import { WildCardArvoSemanticVersion } from '../WildCardArvoSemanticVersion';
 /**
  * Implements a version-specific view of an ArvoContract with type-safe schema validation
  * and JSON Schema generation capabilities.
@@ -17,10 +19,13 @@ export declare class VersionedArvoContract<TContract extends ArvoContract, TVers
     get version(): TVersion;
     get description(): TContract['description'];
     get metadata(): TContract['metadata'];
-    get systemError(): TContract['systemError'];
+    get systemError(): TContract['systemError'] & {
+        dataschema: ReturnType<typeof EventDataschemaUtil.build<TContract['uri'], typeof WildCardArvoSemanticVersion>>;
+    };
     get accepts(): ArvoContractRecord<TContract["type"], TContract["versions"][TVersion]["accepts"]>;
     get emits(): TContract["versions"][TVersion]["emits"];
     get emitList(): { [K in keyof TContract["versions"][TVersion]["emits"] & string]: ArvoContractRecord<K, TContract["versions"][TVersion]["emits"][K]>; }[keyof TContract["versions"][TVersion]["emits"] & string][];
+    get dataschema(): `${TContract["uri"]}/${TVersion}`;
     constructor(param: IVersionedArvoContract<TContract, TVersion>);
     /**
      * Converts the contract to JSON Schema format

package/dist/ArvoContract/VersionedArvoContract/index.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -7,6 +18,8 @@ exports.VersionedArvoContract = void 0;
 var zod_to_json_schema_1 = __importDefault(require("zod-to-json-schema"));
 var utils_1 = require("./utils");
 var OpenTelemetry_1 = require("../../OpenTelemetry");
+var utils_2 = require("../../utils");
+var WildCardArvoSemanticVersion_1 = require("../WildCardArvoSemanticVersion");
 /**
  * Implements a version-specific view of an ArvoContract with type-safe schema validation
  * and JSON Schema generation capabilities.
@@ -52,7 +65,7 @@ var VersionedArvoContract = /** @class */ (function () {
     });
     Object.defineProperty(VersionedArvoContract.prototype, "systemError", {
         get: function () {
-            return this._contract.systemError;
+            return __assign(__assign({}, this._contract.systemError), { dataschema: utils_2.EventDataschemaUtil.build(this.uri, WildCardArvoSemanticVersion_1.WildCardArvoSemanticVersion) });
         },
         enumerable: false,
         configurable: true
@@ -78,6 +91,13 @@ var VersionedArvoContract = /** @class */ (function () {
         enumerable: false,
         configurable: true
     });
+    Object.defineProperty(VersionedArvoContract.prototype, "dataschema", {
+        get: function () {
+            return utils_2.EventDataschemaUtil.build(this.uri, this.version);
+        },
+        enumerable: false,
+        configurable: true
+    });
     /**
      * Converts the contract to JSON Schema format
      * @returns Contract specification in JSON Schema format for documentation/serialization

package/dist/errors.d.ts

@@ -1,11 +1,35 @@
+/**
+ * Parameters for constructing a ViolationError
+ */
 export type ViolationErrorParam<T extends string = string> = {
+    /** The specific type/category of the violation */
     type: T;
+    /** A human-readable description of what went wrong */
     message: string;
+    /** Optional structured data providing additional context about the error */
     metadata?: Record<string, any>;
 };
+/**
+ * ViolationError represents errors that require explicit handling in the system.
+ * These are distinct from recoverable errors that can be automatically handled
+ * by workflow logic. The explicit handling may be required for severe
+ * violation of service contracts or explict retry handling
+ *
+ * Common violation scenarios include:
+ * - Execution error like rate limit exceeded on external API calls
+ * - Contract violations (invalid input/output)
+ * - Configuration errors
+ * - Permission/authorization failures
+ */
 export declare class ViolationError<T extends string = string> extends Error {
+    /** The specific type/category of the violation */
     readonly type: T;
+    /** Additional structured data about the violation */
     readonly metadata: Record<string, any> | null;
+    /**
+     * The error name, formatted as ViolationError<TYPE>
+     * This helps with error identification in logs and stack traces
+     */
     readonly name: `ViolationError<${T}>`;
     constructor({ type, message, metadata }: ViolationErrorParam<T>);
 }

package/dist/errors.js

@@ -16,6 +16,18 @@ var __extends = (this && this.__extends) || (function () {
 })();
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ViolationError = void 0;
+/**
+ * ViolationError represents errors that require explicit handling in the system.
+ * These are distinct from recoverable errors that can be automatically handled
+ * by workflow logic. The explicit handling may be required for severe
+ * violation of service contracts or explict retry handling
+ *
+ * Common violation scenarios include:
+ * - Execution error like rate limit exceeded on external API calls
+ * - Contract violations (invalid input/output)
+ * - Configuration errors
+ * - Permission/authorization failures
+ */
 var ViolationError = /** @class */ (function (_super) {
     __extends(ViolationError, _super);
     function ViolationError(_a) {

package/dist/utils.d.ts

@@ -1,5 +1,4 @@
 import { VersionedArvoContract } from './ArvoContract/VersionedArvoContract';
-import { WildCardArvoSemanticVersion } from './ArvoContract/WildCardArvoSemanticVersion';
 import ArvoEvent from './ArvoEvent';
 import { ArvoSemanticVersion } from './types';
 /**
@@ -76,6 +75,7 @@ export declare function compareSemanticVersions(version1: ArvoSemanticVersion, v
  * Handles creation and parsing of dataschema identifiers.
  */
 export declare class EventDataschemaUtil {
+    static build<TUri extends string, TVersion extends ArvoSemanticVersion>(uri: TUri, version: TVersion): `${TUri}/${TVersion}`;
     /**
      * Creates a dataschema string from a versioned contract.
      * Format: `{contract.uri}/{contract.version}`
@@ -89,13 +89,13 @@ export declare class EventDataschemaUtil {
      * // Returns: "my-contract/1.0.0"
      * ```
      */
-    static create<T extends VersionedArvoContract<any, any>>(contract: T): `${T['uri']}/${T['version']}`;
+    static create<T extends VersionedArvoContract<any, any>>(contract: T): `${T["uri"]}/${T["version"]}`;
     /**
      * Creates dataschema string with wildcard version.
      * @param contract Versioned contract
      * @returns `{contract.uri}/{WildCardArvoSemanticVersion}`
      */
-    static createWithWildCardVersion<T extends VersionedArvoContract<any, any>>(contract: T): `${T['uri']}/${typeof WildCardArvoSemanticVersion}`;
+    static createWithWildCardVersion<T extends VersionedArvoContract<any, any>>(contract: T): `${T["uri"]}/0.0.0`;
     /**
      * Extracts URI and version from dataschema string.
      *

package/dist/utils.js

@@ -120,6 +120,9 @@ function compareSemanticVersions(version1, version2) {
 var EventDataschemaUtil = /** @class */ (function () {
     function EventDataschemaUtil() {
     }
+    EventDataschemaUtil.build = function (uri, version) {
+        return "".concat(uri, "/").concat(version);
+    };
     /**
      * Creates a dataschema string from a versioned contract.
      * Format: `{contract.uri}/{contract.version}`
@@ -134,7 +137,7 @@ var EventDataschemaUtil = /** @class */ (function () {
      * ```
      */
     EventDataschemaUtil.create = function (contract) {
-        return "".concat(contract.uri, "/").concat(contract.version);
+        return EventDataschemaUtil.build(contract.uri, contract.version);
     };
     /**
      * Creates dataschema string with wildcard version.
@@ -142,7 +145,7 @@ var EventDataschemaUtil = /** @class */ (function () {
      * @returns `{contract.uri}/{WildCardArvoSemanticVersion}`
      */
     EventDataschemaUtil.createWithWildCardVersion = function (contract) {
-        return "".concat(contract.uri, "/").concat(WildCardArvoSemanticVersion_1.WildCardArvoSemanticVersion);
+        return EventDataschemaUtil.build(contract.uri, WildCardArvoSemanticVersion_1.WildCardArvoSemanticVersion);
     };
     /**
      * Extracts URI and version from dataschema string.

package/package.json

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