arvo-core 1.1.22 → 1.2.0

package/dist/ArvoOrchestrationSubject/index.d.ts

@@ -16,6 +16,7 @@ export default class ArvoOrchestrationSubject {
      * @param param.orchestator - Name identifier of the orchestrator
      * @param param.version - Version of the orchestrator. If null, defaults to {@link WildCardMachineVersion}
      * @param param.initiator - Identifier of the entity initiating the orchestration
+     * @param param.meta - Optional metadata key-value pairs for additional orchestration context
      * @returns A base64 encoded string containing the compressed orchestration subject data
      * @throws Error if the provided parameters result in invalid subject content
      *
@@ -26,12 +27,24 @@ export default class ArvoOrchestrationSubject {
      *   version: "1.0.0",
      *   initiator: "systemA"
      * });
+     *
+     * // With metadata
+     * const subjectWithMeta = ArvoOrchestrationSubject.new({
+     *   orchestator: "com.company.mainProcess",
+     *   version: "1.0.0",
+     *   initiator: "com.company.systemA",
+     *   meta: {
+     *     priority: "high",
+     *     environment: "production"
+     *   }
+     * });
      * ```
      */
     static new(param: {
         orchestator: string;
         version: ArvoOrchestratorVersion | null;
         initiator: string;
+        meta?: Record<string, string>;
     }): string;
     /**
      * Creates an Arvo orchestration subject from detailed content parameters.

package/dist/ArvoOrchestrationSubject/index.js

@@ -41,6 +41,7 @@ var ArvoOrchestrationSubject = /** @class */ (function () {
      * @param param.orchestator - Name identifier of the orchestrator
      * @param param.version - Version of the orchestrator. If null, defaults to {@link WildCardMachineVersion}
      * @param param.initiator - Identifier of the entity initiating the orchestration
+     * @param param.meta - Optional metadata key-value pairs for additional orchestration context
      * @returns A base64 encoded string containing the compressed orchestration subject data
      * @throws Error if the provided parameters result in invalid subject content
      *
@@ -51,10 +52,21 @@ var ArvoOrchestrationSubject = /** @class */ (function () {
      *   version: "1.0.0",
      *   initiator: "systemA"
      * });
+     *
+     * // With metadata
+     * const subjectWithMeta = ArvoOrchestrationSubject.new({
+     *   orchestator: "com.company.mainProcess",
+     *   version: "1.0.0",
+     *   initiator: "com.company.systemA",
+     *   meta: {
+     *     priority: "high",
+     *     environment: "production"
+     *   }
+     * });
      * ```
      */
     ArvoOrchestrationSubject.new = function (param) {
-        var _a;
+        var _a, _b;
         return ArvoOrchestrationSubject.create({
             orchestrator: {
                 name: param.orchestator,
@@ -64,6 +76,7 @@ var ArvoOrchestrationSubject = /** @class */ (function () {
                 id: (0, uuid_1.v4)(),
                 initiator: param.initiator,
             },
+            meta: (_b = param.meta) !== null && _b !== void 0 ? _b : {}
         });
     };
     /**

package/dist/ArvoOrchestrationSubject/schema.d.ts

@@ -21,6 +21,7 @@ export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
         id: string;
         initiator: string;
     }>;
+    meta: z.ZodRecord<z.ZodString, z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     orchestrator: {
         name: string;
@@ -30,6 +31,7 @@ export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
         id: string;
         initiator: string;
     };
+    meta: Record<string, string>;
 }, {
     orchestrator: {
         name: string;
@@ -39,4 +41,5 @@ export declare const ArvoOrchestrationSubjectContentSchema: z.ZodObject<{
         id: string;
         initiator: string;
     };
+    meta: Record<string, string>;
 }>;

package/dist/ArvoOrchestrationSubject/schema.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ArvoOrchestrationSubjectContentSchema = exports.ArvoOrchestratorVersionSchema = void 0;
 var zod_1 = require("zod");
+var utils_1 = require("../utils");
 // Zod schema for ArvoOchestratorVersion
 exports.ArvoOrchestratorVersionSchema = zod_1.z
     .string()
@@ -35,5 +36,8 @@ exports.ArvoOrchestrationSubjectContentSchema = zod_1.z
             .describe('Entity or process that initiated the execution'),
     })
         .describe('Details about the current execution'),
+    meta: zod_1.z
+        .record(zod_1.z.string(), zod_1.z.string())
+        .describe((0, utils_1.cleanString)("\n        Additional metadata for the orchestration process. Store essential key-value pairs \n        that provide context or configuration details necessary for the orchestration. \n        Use selectively to maintain clarity and avoid storing unnecessary information.  \n      "))
 })
     .describe('Context information for Arvo orchestration');

package/dist/ArvoOrchestrationSubject/type.d.ts

@@ -62,4 +62,10 @@ export type ArvoOrchestrationSubjectContent = {
          */
         initiator: string;
     };
+    /**
+     * Additional metadata for the orchestration process. Store essential key-value pairs
+     * that provide context or configuration details necessary for the orchestration.
+     * Use selectively to maintain clarity and avoid storing unnecessary information.
+     */
+    meta: Record<string, string>;
 };

package/package.json

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