arvo-core 1.1.22 → 1.2.1

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,63 @@ 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 a new orchestration subject string from an existing parent subject.
+     * This method parses the parent subject, merges its metadata with new metadata (if available),
+     * and creates a new subject with updated orchestrator information while maintaining
+     * the relationship to the parent context.
+     *
+     * @param param - Configuration object for creating a new subject from a parent
+     * @param param.orchestator - Name identifier of the new orchestrator
+     * @param param.version - Version of the new orchestrator. If null, defaults to {@link WildCardMachineVersion}
+     * @param param.subject - Base64 encoded string of the parent orchestration subject
+     * @param param.meta - Optional additional metadata to merge with the parent's metadata
+     * @returns A new base64 encoded string containing the compressed orchestration subject data
+     * @throws Error if the parent subject is invalid or if the new parameters result in invalid subject content
+     *
+     * @example
+     * ```typescript
+     * // Create a parent subject
+     * const parentSubject = ArvoOrchestrationSubject.new({
+     *   orchestator: "parentProcess",
+     *   version: "1.0.0",
+     *   initiator: "systemA",
+     *   meta: { environment: "production" }
+     * });
+     *
+     * // Create a new subject from the parent
+     * const childSubject = ArvoOrchestrationSubject.from({
+     *   orchestator: "childProcess",
+     *   version: "2.0.0",
+     *   subject: parentSubject,
+     *   meta: { step: "processing" }  // Will be merged with parent's metadata
+     * });
+     * ```
+     */
+    static from(param: {
+        orchestator: string;
+        version: ArvoOrchestratorVersion | null;
+        subject: string;
+        meta?: Record<string, string>;
     }): string;
     /**
      * Creates an Arvo orchestration subject from detailed content parameters.

package/dist/ArvoOrchestrationSubject/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 __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     var desc = Object.getOwnPropertyDescriptor(m, k);
@@ -41,6 +52,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 +63,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 +87,50 @@ var ArvoOrchestrationSubject = /** @class */ (function () {
                 id: (0, uuid_1.v4)(),
                 initiator: param.initiator,
             },
+            meta: (_b = param.meta) !== null && _b !== void 0 ? _b : {}
+        });
+    };
+    /**
+     * Creates a new orchestration subject string from an existing parent subject.
+     * This method parses the parent subject, merges its metadata with new metadata (if available),
+     * and creates a new subject with updated orchestrator information while maintaining
+     * the relationship to the parent context.
+     *
+     * @param param - Configuration object for creating a new subject from a parent
+     * @param param.orchestator - Name identifier of the new orchestrator
+     * @param param.version - Version of the new orchestrator. If null, defaults to {@link WildCardMachineVersion}
+     * @param param.subject - Base64 encoded string of the parent orchestration subject
+     * @param param.meta - Optional additional metadata to merge with the parent's metadata
+     * @returns A new base64 encoded string containing the compressed orchestration subject data
+     * @throws Error if the parent subject is invalid or if the new parameters result in invalid subject content
+     *
+     * @example
+     * ```typescript
+     * // Create a parent subject
+     * const parentSubject = ArvoOrchestrationSubject.new({
+     *   orchestator: "parentProcess",
+     *   version: "1.0.0",
+     *   initiator: "systemA",
+     *   meta: { environment: "production" }
+     * });
+     *
+     * // Create a new subject from the parent
+     * const childSubject = ArvoOrchestrationSubject.from({
+     *   orchestator: "childProcess",
+     *   version: "2.0.0",
+     *   subject: parentSubject,
+     *   meta: { step: "processing" }  // Will be merged with parent's metadata
+     * });
+     * ```
+     */
+    ArvoOrchestrationSubject.from = function (param) {
+        var _a, _b, _c;
+        var parsedSubject = ArvoOrchestrationSubject.parse(param.subject);
+        return ArvoOrchestrationSubject.new({
+            initiator: parsedSubject.orchestrator.name,
+            version: (_a = param.version) !== null && _a !== void 0 ? _a : ArvoOrchestrationSubject.WildCardMachineVersion,
+            orchestator: param.orchestator,
+            meta: __assign(__assign({}, ((_b = parsedSubject.meta) !== null && _b !== void 0 ? _b : {})), ((_c = param.meta) !== null && _c !== void 0 ? _c : {}))
         });
     };
     /**

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.1",
   "description": "This core package contains all the core classes and components of the Arvo Event Driven System",
   "main": "dist/index.js",
   "scripts": {