@izara_project/izara-core-library-asynchronous-flow 1.0.34 → 1.0.35

package/package.json

@@ -3,7 +3,7 @@
   "author": "Sven Mason <thebarbariansven@gmail.com>",
   "license": "AGPL-3.0-or-later",
   "homepage": "https://bitbucket.org/izara-core-libraries/izara-core-library-asynchronous-flow#readme",
-  "version": "1.0.34",
+  "version": "1.0.35",
   "description": "Shared asynchronous flow logic",
   "type": "module",
   "main": "index.js",

package/src/awaitingMultipleSteps.js

@@ -455,6 +455,17 @@ export async function findAwaitingMultipleStepByPending(
   return listAwaitingSteps.Items;
 }
 
+/**
+ * Updates the completion status of a specific awaiting step within a multiple-step pending process.
+ * Marks the given awaiting step as complete and stores any encountered errors or additional attributes.
+ *
+ * @param {Object} _izContext - The execution context object containing logger and other utilities.
+ * @param {string} pendingStepId - The unique identifier of the parent pending step.
+ * @param {string|null} [currentAwaitingStepId=null] - The unique identifier of the specific awaiting step being processed. If null, no update is performed.
+ * @param {Array<Object|string>} [errorsFound=[]] - An array of errors encountered during the step's execution.
+ * @param {Object} [additionalAttributes={}] - Any extra data to save along with the completion status.
+ * @returns {Promise<void>} Resolves when the update operation is complete.
+ */
 export async function checkAllAwaitingStepsFinishedShared(
   _izContext,
   pendingStepId,
@@ -482,7 +493,7 @@ export async function checkAllAwaitingStepsFinishedShared(
       {
         complete: true,
         errorsFound: errorsFound,
-        ...additionalAttributes
+        additionalAttributes: additionalAttributes
       }
     );
   }
@@ -790,6 +801,21 @@ export async function removeAwaitingMultipleStep(
   await Promise.all(promiseArray);
 }
 
+/**
+ * Creates multiple awaiting steps with additional attributes and publishes corresponding messages to an SNS topic.
+ * Each message is augmented with a new `parentFlowId` representing its awaiting step before being published.
+ *
+ * @param {Object} _izContext - The execution context object containing logger and other utilities.
+ * @param {Array<Object>} messages - An array of messages to be augmented and published.
+ * @param {string} [prefix=''] - An optional prefix used when generating new awaiting step IDs.
+ * @param {Object} [flowType={}] - Defines the target SNS topic. Must contain `flowTag` and `serviceTag`.
+ * @param {string} flowType.flowTag - The flow tag identifier.
+ * @param {string} flowType.serviceTag - The service tag identifier.
+ * @param {Object} [additionalAttributes={}] - Additional attributes to save with each new awaiting step.
+ * @param {string} pendingStepId - The unique identifier of the parent pending step that waits for these new steps.
+ * @returns {Promise<void>} Resolves when all awaiting steps are created and messages are published.
+ * @throws {Error} Throws a NoRetryError if `messages` is not an array, or if `flowType` is missing `flowTag` or `serviceTag`.
+ */
 export async function createAwaitingMultipleStepsWithAdditionalAttributesAndPublish(
   _izContext,
   messages,