arvo-core 3.0.6 → 3.0.8

package/dist/ArvoEvent/helpers.js

@@ -4,16 +4,16 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createArvoEvent = void 0;
-var uuid_1 = require("uuid");
 var _1 = __importDefault(require("."));
 var OpenTelemetry_1 = require("../OpenTelemetry");
 var utils_1 = require("../utils");
+var id_1 = require("./id");
 var schema_1 = require("./schema");
 /**
  * Internal generator function for creating  instances.
  */
 var generator = function (event, extensions, otelHeaders) {
-    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l;
+    var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k;
     if (event.datacontenttype && event.datacontenttype !== schema_1.ArvoDataContentType) {
         var warning = (0, utils_1.cleanString)("\n    Warning! The provided datacontenttype(=".concat(event.datacontenttype, ")\n    is not ArvoEvent compatible (=").concat(schema_1.ArvoDataContentType, "). There may \n    be some limited functionality.\n  "));
         (0, OpenTelemetry_1.logToSpan)({
@@ -22,22 +22,22 @@ var generator = function (event, extensions, otelHeaders) {
         });
     }
     return new _1.default({
-        id: (_a = event.id) !== null && _a !== void 0 ? _a : (0, uuid_1.v4)(),
+        id: (0, id_1.createArvoEventId)(event.id),
         type: event.type,
-        accesscontrol: (_b = event.accesscontrol) !== null && _b !== void 0 ? _b : null,
-        executionunits: (_c = event.executionunits) !== null && _c !== void 0 ? _c : null,
-        traceparent: (_e = (_d = event.traceparent) !== null && _d !== void 0 ? _d : otelHeaders.traceparent) !== null && _e !== void 0 ? _e : null,
-        tracestate: (_g = (_f = event.tracestate) !== null && _f !== void 0 ? _f : otelHeaders.tracestate) !== null && _g !== void 0 ? _g : null,
-        datacontenttype: (_h = event.datacontenttype) !== null && _h !== void 0 ? _h : schema_1.ArvoDataContentType,
-        specversion: (_j = event.specversion) !== null && _j !== void 0 ? _j : '1.0',
-        time: (_k = event.time) !== null && _k !== void 0 ? _k : (0, utils_1.createTimestamp)(),
+        accesscontrol: (_a = event.accesscontrol) !== null && _a !== void 0 ? _a : null,
+        executionunits: (_b = event.executionunits) !== null && _b !== void 0 ? _b : null,
+        traceparent: (_d = (_c = event.traceparent) !== null && _c !== void 0 ? _c : otelHeaders.traceparent) !== null && _d !== void 0 ? _d : null,
+        tracestate: (_f = (_e = event.tracestate) !== null && _e !== void 0 ? _e : otelHeaders.tracestate) !== null && _f !== void 0 ? _f : null,
+        datacontenttype: (_g = event.datacontenttype) !== null && _g !== void 0 ? _g : schema_1.ArvoDataContentType,
+        specversion: (_h = event.specversion) !== null && _h !== void 0 ? _h : '1.0',
+        time: (_j = event.time) !== null && _j !== void 0 ? _j : (0, utils_1.createTimestamp)(),
         source: encodeURI(event.source),
         subject: encodeURI(event.subject),
         to: event.to ? encodeURI(event.to) : encodeURI(event.type),
         redirectto: event.redirectto ? encodeURI(event.redirectto) : null,
         dataschema: event.dataschema ? encodeURI(event.dataschema) : null,
         parentid: event.parentid ? encodeURI(event.parentid) : null,
-        domain: (_l = event.domain) !== null && _l !== void 0 ? _l : null,
+        domain: (_k = event.domain) !== null && _k !== void 0 ? _k : null,
     }, event.data, extensions);
 };
 /**

package/dist/ArvoEvent/id.d.ts

@@ -0,0 +1,18 @@
+import { z } from 'zod';
+import type { CreateArvoEvent } from './types';
+export declare const ArvoEventIdObjectSchema: z.ZodObject<{
+    uuid: z.ZodString;
+    value: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    value: string;
+    uuid: string;
+}, {
+    value: string;
+    uuid: string;
+}>;
+export type ArvoEventIdObject = z.infer<typeof ArvoEventIdObjectSchema>;
+export declare const createArvoEventId: (id?: CreateArvoEvent<Record<string, unknown>, string>["id"]) => string;
+export declare const parseArvoEventId: (id: string) => readonly [{
+    value: string;
+    uuid: string;
+}, null] | readonly [string, Error];

package/dist/ArvoEvent/id.js

@@ -0,0 +1,39 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseArvoEventId = exports.createArvoEventId = exports.ArvoEventIdObjectSchema = void 0;
+var pako_1 = __importDefault(require("pako"));
+var uuid_1 = require("uuid");
+var zod_1 = require("zod");
+exports.ArvoEventIdObjectSchema = zod_1.z.object({
+    uuid: zod_1.z.string(),
+    value: zod_1.z.string(),
+});
+var createArvoEventId = function (id) {
+    if ((id === null || id === void 0 ? void 0 : id.deduplication) === 'ARVO_MANAGED' && id.value.trim()) {
+        var data = exports.ArvoEventIdObjectSchema.parse({ uuid: (0, uuid_1.v4)(), value: id.value.trim() });
+        var jsonString = JSON.stringify(data);
+        var compressed = pako_1.default.deflate(new TextEncoder().encode(jsonString));
+        return Buffer.from(compressed).toString('base64');
+    }
+    if ((id === null || id === void 0 ? void 0 : id.deduplication) === 'DEVELOPER_MANAGED' && id.value.trim()) {
+        return id.value.trim();
+    }
+    return (0, uuid_1.v4)();
+};
+exports.createArvoEventId = createArvoEventId;
+var parseArvoEventId = function (id) {
+    try {
+        var compressed = Buffer.from(id, 'base64');
+        var decompressed = pako_1.default.inflate(compressed);
+        var jsonString = new TextDecoder().decode(decompressed);
+        var parsed = JSON.parse(jsonString);
+        return [exports.ArvoEventIdObjectSchema.parse(parsed), null];
+    }
+    catch (e) {
+        return [id, e];
+    }
+};
+exports.parseArvoEventId = parseArvoEventId;

package/dist/ArvoEvent/types.d.ts

@@ -26,8 +26,28 @@ export type OpenTelemetryExtension = z.infer<typeof OpenTelemetryExtensionSchema
  * @template TType - The type name of the event
  */
 export type CreateArvoEvent<TData extends ArvoEventData, TType extends string> = {
-    /** Unique identifier of the event. Must be a non-empty string. If not provided, a UUID will be generated. */
-    id?: string;
+    /**
+     * The event id serves as the primary deduplication key within the Arvo system,
+     * ensuring idempotent event processing. If not provided, a UUID v4 will be automatically generated.
+     */
+    id?: {
+        /**
+         * Deduplication identifier management strategy.
+         *
+         * - `DEVELOPER_MANAGED`: You, the developer, guarantee uniqueness of the identifier value.
+         *   The provided value is used directly as the deduplication key without modification.
+         *
+         * - `ARVO_MANAGED`: Arvo manages identifier uniqueness by generating a composite key.
+         *   The final identifier follows the format `base64({uuid: uuid4(), value: value})`,
+         *   where a UUID v4 prefix ensures global uniqueness while preserving the developer's
+         *   value for reference.
+         */
+        deduplication: 'DEVELOPER_MANAGED' | 'ARVO_MANAGED';
+        /**
+         * The id value
+         */
+        value: string;
+    };
     /** Timestamp of when the occurrence happened. Must be in ISO 8601 format with timezone offset. */
     time?: string;
     /** Identifies the context in which an event happened. Must be a valid URI representing the event producer. */

package/dist/ArvoOrchestrationSubject/schema.d.ts

@@ -4,11 +4,11 @@ export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
         name: z.ZodEffects<z.ZodString, string, string>;
         version: z.ZodString;
     }, "strip", z.ZodTypeAny, {
-        version: string;
         name: string;
-    }, {
         version: string;
+    }, {
         name: string;
+        version: string;
     }>;
     execution: z.ZodObject<{
         id: z.ZodEffects<z.ZodString, string, string>;
@@ -26,8 +26,8 @@ export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
     meta: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     orchestrator: {
-        version: string;
         name: string;
+        version: string;
     };
     execution: {
         id: string;
@@ -37,8 +37,8 @@ export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
     meta: Record<string, string>;
 }, {
     orchestrator: {
-        version: string;
         name: string;
+        version: string;
     };
     execution: {
         id: string;

package/dist/errors.d.ts

@@ -26,6 +26,8 @@ export declare class ViolationError<T extends string = string> extends Error {
     readonly type: T;
     /** Additional structured data about the violation */
     readonly metadata: Record<string, any> | null;
+    /** An additional flag to determine if it is an Arvo specific violation error */
+    readonly isArvoViolationError = true;
     /**
      * The error name, formatted as ViolationError<TYPE>
      * This helps with error identification in logs and stack traces
@@ -33,3 +35,22 @@ export declare class ViolationError<T extends string = string> extends Error {
     readonly name: `ViolationError<${T}>`;
     constructor({ type, message, metadata }: ViolationErrorParam<T>);
 }
+/**
+ * Type guard to determine if an unknown value is a ViolationError, an instance
+ * of a class that inherits from ViolationError.
+ *
+ * @param e - The value to check, typically an unknown error or exception
+ * @returns `true` if the value is a ViolationError, inherits from it, or has the isArvoViolationError flag, `false` otherwise
+ *
+ * ```typescript
+ * const error = new ViolationError({
+ *   type: 'RATE_LIMIT',
+ *   message: 'API rate limit exceeded'
+ * });
+ *
+ * console.log(isViolationError(error)); // true
+ * console.log(isViolationError(new Error())); // false
+ * console.log(isViolationError(null)); // false
+ * ```
+ */
+export declare const isViolationError: (e: unknown) => boolean;

package/dist/errors.js

@@ -14,8 +14,12 @@ var __extends = (this && this.__extends) || (function () {
         d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());
     };
 })();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ViolationError = void 0;
+exports.isViolationError = exports.ViolationError = void 0;
+var zod_1 = __importDefault(require("zod"));
 /**
  * ViolationError represents errors that require explicit handling in the system.
  * These are distinct from recoverable errors that can be automatically handled
@@ -33,6 +37,8 @@ var ViolationError = /** @class */ (function (_super) {
     function ViolationError(_a) {
         var type = _a.type, message = _a.message, metadata = _a.metadata;
         var _this = _super.call(this, "ViolationError<".concat(type, "> ").concat(message)) || this;
+        /** An additional flag to determine if it is an Arvo specific violation error */
+        _this.isArvoViolationError = true;
         _this.type = type;
         _this.name = "ViolationError<".concat(_this.type, ">");
         _this.metadata = metadata !== null && metadata !== void 0 ? metadata : null;
@@ -41,3 +47,31 @@ var ViolationError = /** @class */ (function (_super) {
     return ViolationError;
 }(Error));
 exports.ViolationError = ViolationError;
+/**
+ * Type guard to determine if an unknown value is a ViolationError, an instance
+ * of a class that inherits from ViolationError.
+ *
+ * @param e - The value to check, typically an unknown error or exception
+ * @returns `true` if the value is a ViolationError, inherits from it, or has the isArvoViolationError flag, `false` otherwise
+ *
+ * ```typescript
+ * const error = new ViolationError({
+ *   type: 'RATE_LIMIT',
+ *   message: 'API rate limit exceeded'
+ * });
+ *
+ * console.log(isViolationError(error)); // true
+ * console.log(isViolationError(new Error())); // false
+ * console.log(isViolationError(null)); // false
+ * ```
+ */
+var isViolationError = function (e) {
+    var ViolationErrorSchema = zod_1.default.object({
+        isArvoViolationError: zod_1.default.literal(true),
+        type: zod_1.default.string().min(1),
+        name: zod_1.default.string().min(1),
+        message: zod_1.default.string().min(1),
+    });
+    return e instanceof Error && ViolationErrorSchema.safeParse(e).success;
+};
+exports.isViolationError = isViolationError;

package/dist/index.d.ts

@@ -13,6 +13,7 @@ import { VersionedArvoContract } from './ArvoContract/VersionedArvoContract';
 import { WildCardArvoSemanticVersion, isWildCardArvoSematicVersion } from './ArvoContract/WildCardArvoSemanticVersion';
 import { ArvoContractJSONSchema, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord } from './ArvoContract/types';
 import { ArvoContractValidators } from './ArvoContract/validators';
+import { ArvoEventIdObject, ArvoEventIdObjectSchema, createArvoEventId, parseArvoEventId } from './ArvoEvent/id';
 import ArvoEventFactory from './ArvoEventFactory';
 import { ArvoOrchestratorEventFactory } from './ArvoEventFactory/Orchestrator';
 import { createArvoEventFactory, createArvoOrchestratorEventFactory } from './ArvoEventFactory/helpers';
@@ -26,7 +27,7 @@ import ArvoExecution from './OpenTelemetry/ArvoExecution';
 import { ArvoExecutionSpanKind } from './OpenTelemetry/ArvoExecution/types';
 import OpenInference from './OpenTelemetry/OpenInference';
 import { OpenInferenceSpanKind } from './OpenTelemetry/OpenInference/types';
-import { ViolationError, ViolationErrorParam } from './errors';
+import { ViolationError, ViolationErrorParam, isViolationError } from './errors';
 import { ArvoErrorSchema, ArvoSemanticVersionSchema, isValidArvoSemanticVersion } from './schema';
 import { ArvoErrorType, ArvoSemanticVersion, InferArvoEvent, InferVersionedArvoContract } from './types';
 /**
@@ -109,4 +110,4 @@ declare const ArvoEventSchema: {
         parentSubject$$: string | null;
     }>;
 };
-export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchema, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoEventFactory, createArvoEventFactory, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContent, ArvoSemanticVersion, InferArvoEvent, createArvoOrchestratorContract, ICreateArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, EventDataschemaUtil, ArvoOrchestrationSubjectContentSchema, ArvoSemanticVersionSchema, ArvoErrorSchema, ArvoErrorType, compareSemanticVersions, parseSemanticVersion, createSimpleArvoContract, ArvoOrchestratorContract, VersionedArvoContract, InferVersionedArvoContract, isWildCardArvoSematicVersion, WildCardArvoSemanticVersion, isValidArvoSemanticVersion, SimpleArvoContract, ArvoOrchestratorEventFactory, createArvoOrchestratorEventFactory, ArvoOpenTelemetry, ViolationError, ViolationErrorParam, createArvoError, };
+export { ArvoEvent, createArvoEvent, ArvoDataContentType, ArvoEventData, CloudEventExtension, ArvoEventSchema, CloudEventContext, ArvoExtension, OpenTelemetryExtension, CreateArvoEvent, exceptionToSpan, logToSpan, OpenTelemetryHeaders, TelemetryLogLevel, OTelNull, validateURI, cleanString, ArvoContract, createArvoContract, ArvoContractValidators, ArvoContractRecord, IArvoContract, ResolveArvoContractRecord, ArvoEventFactory, createArvoEventFactory, currentOpenTelemetryHeaders, OpenInference, OpenInferenceSpanKind, ArvoExecution, ArvoExecutionSpanKind, ArvoContractJSONSchema, ArvoOrchestrationSubject, ArvoOrchestrationSubjectContent, ArvoSemanticVersion, InferArvoEvent, createArvoOrchestratorContract, ICreateArvoOrchestratorContract, ArvoOrchestratorEventTypeGen, EventDataschemaUtil, ArvoOrchestrationSubjectContentSchema, ArvoSemanticVersionSchema, ArvoErrorSchema, ArvoErrorType, compareSemanticVersions, parseSemanticVersion, createSimpleArvoContract, ArvoOrchestratorContract, VersionedArvoContract, InferVersionedArvoContract, isWildCardArvoSematicVersion, WildCardArvoSemanticVersion, isValidArvoSemanticVersion, SimpleArvoContract, ArvoOrchestratorEventFactory, createArvoOrchestratorEventFactory, ArvoOpenTelemetry, ViolationError, ViolationErrorParam, createArvoError, createArvoEventId, parseArvoEventId, ArvoEventIdObjectSchema, ArvoEventIdObject, isViolationError, };

package/dist/index.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.createArvoError = exports.ViolationError = exports.ArvoOpenTelemetry = exports.createArvoOrchestratorEventFactory = exports.ArvoOrchestratorEventFactory = exports.isValidArvoSemanticVersion = exports.WildCardArvoSemanticVersion = exports.isWildCardArvoSematicVersion = exports.VersionedArvoContract = exports.createSimpleArvoContract = exports.parseSemanticVersion = exports.compareSemanticVersions = exports.ArvoErrorSchema = exports.ArvoSemanticVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.EventDataschemaUtil = exports.ArvoOrchestratorEventTypeGen = exports.createArvoOrchestratorContract = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchema = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
+exports.isViolationError = exports.ArvoEventIdObjectSchema = exports.parseArvoEventId = exports.createArvoEventId = exports.createArvoError = exports.ViolationError = exports.ArvoOpenTelemetry = exports.createArvoOrchestratorEventFactory = exports.ArvoOrchestratorEventFactory = exports.isValidArvoSemanticVersion = exports.WildCardArvoSemanticVersion = exports.isWildCardArvoSematicVersion = exports.VersionedArvoContract = exports.createSimpleArvoContract = exports.parseSemanticVersion = exports.compareSemanticVersions = exports.ArvoErrorSchema = exports.ArvoSemanticVersionSchema = exports.ArvoOrchestrationSubjectContentSchema = exports.EventDataschemaUtil = exports.ArvoOrchestratorEventTypeGen = exports.createArvoOrchestratorContract = exports.ArvoOrchestrationSubject = exports.ArvoExecutionSpanKind = exports.ArvoExecution = exports.OpenInferenceSpanKind = exports.OpenInference = exports.currentOpenTelemetryHeaders = exports.createArvoEventFactory = exports.ArvoEventFactory = exports.ArvoContractValidators = exports.createArvoContract = exports.ArvoContract = exports.cleanString = exports.validateURI = exports.OTelNull = exports.logToSpan = exports.exceptionToSpan = exports.ArvoEventSchema = exports.ArvoDataContentType = exports.createArvoEvent = exports.ArvoEvent = void 0;
 var ArvoContract_1 = __importDefault(require("./ArvoContract"));
 exports.ArvoContract = ArvoContract_1.default;
 var helpers_1 = require("./ArvoContract/helpers");
@@ -36,6 +36,10 @@ Object.defineProperty(exports, "WildCardArvoSemanticVersion", { enumerable: true
 Object.defineProperty(exports, "isWildCardArvoSematicVersion", { enumerable: true, get: function () { return WildCardArvoSemanticVersion_1.isWildCardArvoSematicVersion; } });
 var validators_1 = require("./ArvoContract/validators");
 Object.defineProperty(exports, "ArvoContractValidators", { enumerable: true, get: function () { return validators_1.ArvoContractValidators; } });
+var id_1 = require("./ArvoEvent/id");
+Object.defineProperty(exports, "ArvoEventIdObjectSchema", { enumerable: true, get: function () { return id_1.ArvoEventIdObjectSchema; } });
+Object.defineProperty(exports, "createArvoEventId", { enumerable: true, get: function () { return id_1.createArvoEventId; } });
+Object.defineProperty(exports, "parseArvoEventId", { enumerable: true, get: function () { return id_1.parseArvoEventId; } });
 var ArvoEventFactory_1 = __importDefault(require("./ArvoEventFactory"));
 exports.ArvoEventFactory = ArvoEventFactory_1.default;
 var Orchestrator_1 = require("./ArvoEventFactory/Orchestrator");
@@ -62,6 +66,7 @@ var types_2 = require("./OpenTelemetry/OpenInference/types");
 Object.defineProperty(exports, "OpenInferenceSpanKind", { enumerable: true, get: function () { return types_2.OpenInferenceSpanKind; } });
 var errors_1 = require("./errors");
 Object.defineProperty(exports, "ViolationError", { enumerable: true, get: function () { return errors_1.ViolationError; } });
+Object.defineProperty(exports, "isViolationError", { enumerable: true, get: function () { return errors_1.isViolationError; } });
 var schema_4 = require("./schema");
 Object.defineProperty(exports, "ArvoErrorSchema", { enumerable: true, get: function () { return schema_4.ArvoErrorSchema; } });
 Object.defineProperty(exports, "ArvoSemanticVersionSchema", { enumerable: true, get: function () { return schema_4.ArvoSemanticVersionSchema; } });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "arvo-core",
-  "version": "3.0.6",
+  "version": "3.0.8",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {
@@ -44,8 +44,8 @@
     "@opentelemetry/core": "^1.30.1",
     "pako": "^2.1.0",
     "uuid": "^11.1.0",
-    "zod": "^3.25.67",
-    "zod-to-json-schema": "^3.24.5"
+    "zod": "^3.25.74",
+    "zod-to-json-schema": "^3.24.6"
   },
   "engines": {
     "node": ">=18.0.0"