@gesslar/actioneer 2.0.2 → 2.2.0

package/src/types/browser/lib/ActionWrapper.d.ts

@@ -8,7 +8,7 @@
  * @property {(message: string, level?: number, ...args: Array<unknown>) => void} [debug] Optional logger reference.
  */
 /**
- * @typedef {Generator<Activity, void, unknown>} ActivityIterator
+ * @typedef {import("@gesslar/toolkit").Generator<Activity, void, unknown>} ActivityIterator
  */
 /**
  * Thin wrapper that materialises {@link Activity} instances on demand.
@@ -19,16 +19,35 @@ export default class ActionWrapper {
      *
      * @param {{activities: Map<string|symbol, WrappedActivityConfig>, debug: (message: string, level?: number, ...args: Array<unknown>) => void}} init Builder payload containing activities + logger.
      */
-    constructor({ activities, hooks, debug }: {
+    constructor({ activities, hooks, debug, done: doneCallback, action }: {
         activities: Map<string | symbol, WrappedActivityConfig>;
         debug: (message: string, level?: number, ...args: Array<unknown>) => void;
     });
+    /**
+     * Unique identifier for this wrapper instance.
+     * Used by BREAK/CONTINUE to match events to the correct loop.
+     *
+     * @returns {symbol} Unique symbol identifier
+     */
+    get id(): symbol;
     /**
      * Iterator over the registered activities.
      *
-     * @returns {ActivityIterator} Lazy iterator yielding Activity instances.
+     * @returns {Iterator<Activity>} Iterator yielding Activity instances.
+     */
+    get activities(): Iterator<Activity>;
+    /**
+     * Get the done callback if registered.
+     *
+     * @returns {((context: unknown) => unknown|Promise<unknown>)|null} Done callback or null.
+     */
+    get done(): ((context: unknown) => unknown | Promise<unknown>) | null;
+    /**
+     * Get the action instance.
+     *
+     * @returns {unknown|null} Action instance or null.
      */
-    get activities(): ActivityIterator;
+    get action(): unknown | null;
     #private;
 }
 export type WrappedActivityConfig = {
@@ -57,6 +76,6 @@ export type WrappedActivityConfig = {
      */
     debug?: ((message: string, level?: number, ...args: Array<unknown>) => void) | undefined;
 };
-export type ActivityIterator = Generator<Activity, void, unknown>;
+export type ActivityIterator = import("@gesslar/toolkit").Generator<Activity, void, unknown>;
 import Activity from "./Activity.js";
 //# sourceMappingURL=ActionWrapper.d.ts.map

package/src/types/browser/lib/ActionWrapper.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActionWrapper.d.ts","sourceRoot":"","sources":["../../../browser/lib/ActionWrapper.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AAEH;;GAEG;AAEH;;GAEG;AACH;IAgBE;;;;OAIG;IACH,0CAFW;QAAC,UAAU,EAAE,GAAG,CAAC,MAAM,GAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAAC,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;KAAC,EAW5I;IAOD;;;;OAIG;IACH,kBAFa,gBAAgB,CAI5B;;CACF;;;;;UA5Da,MAAM,GAAC,MAAM;;;;QACb,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,aAAa;;;;;;;;sBAElD,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC;;;;aAC9C,OAAO;;;;uBACG,MAAM,UAAU,MAAM,WAAW,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI;;+BAInE,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC;qBAb1B,eAAe"}
+{"version":3,"file":"ActionWrapper.d.ts","sourceRoot":"","sources":["../../../browser/lib/ActionWrapper.js"],"names":[],"mappings":"AAEA;;;;;;;;GAQG;AAEH;;GAEG;AAEH;;GAEG;AACH;IAwBE;;;;OAIG;IACH,sEAFW;QAAC,UAAU,EAAE,GAAG,CAAC,MAAM,GAAC,MAAM,EAAE,qBAAqB,CAAC,CAAC;QAAC,KAAK,EAAE,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI,CAAA;KAAC,EAwB5I;IAED;;;;;OAKG;IACH,UAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,kBAFa,QAAQ,CAAC,QAAQ,CAAC,CAI9B;IAED;;;;OAIG;IACH,YAFa,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,CAAC,GAAC,IAAI,CAIjE;IAED;;;;OAIG;IACH,cAFa,OAAO,GAAC,IAAI,CAIxB;;CACF;;;;;UAxGa,MAAM,GAAC,MAAM;;;;QACb,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,aAAa;;;;;;;;sBAElD,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC;;;;aAC9C,OAAO;;;;uBACG,MAAM,UAAU,MAAM,WAAW,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI;;+BAInE,OAAO,kBAAkB,EAAE,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,OAAO,CAAC;qBAbrD,eAAe"}

package/src/types/browser/lib/Activity.d.ts

@@ -9,14 +9,20 @@ export type ACTIVITY = number;
  *
  * @readonly
  * @enum {number}
- * @property {number} WHILE - Execute activity while predicate returns true (2)
- * @property {number} UNTIL - Execute activity until predicate returns true (4)
- * @property {number} SPLIT - Execute activity with split/rejoin pattern for parallel execution (8)
+ * @property {number} WHILE - Execute activity while predicate returns true 1
+ * @property {number} UNTIL - Execute activity until predicate returns true 2
+ * @property {number} SPLIT - Execute activity with split/rejoin pattern for parallel execution 3
+ * @property {number} IF - Execute activity if predicate returns true 4
+ * @property {number} BREAK - Break out of a WHILE/UNTIL if predicate returns true 5
+ * @property {number} CONTINUE - Returns to the top of a WHILE/UNTIL if predicate returns true 6
  */
 export const ACTIVITY: Readonly<{
-    WHILE: number;
-    UNTIL: number;
-    SPLIT: number;
+    WHILE: 1;
+    UNTIL: 2;
+    SPLIT: 3;
+    IF: 4;
+    BREAK: 5;
+    CONTINUE: 6;
 }>;
 export default class Activity {
     /**
@@ -31,8 +37,9 @@ export default class Activity {
      * @param {ActionHooks} [init.hooks] - Optional hooks instance
      * @param {(context: unknown) => unknown} [init.splitter] - Optional splitter function for SPLIT activities
      * @param {(originalContext: unknown, splitResults: unknown) => unknown} [init.rejoiner] - Optional rejoiner function for SPLIT activities
+     * @param {import("./ActionWrapper.js").default} [init.wrapper] - Optional wrapper containing this activity
      */
-    constructor({ action, name, op, kind, pred, hooks, splitter, rejoiner }: {
+    constructor({ action, name, op, kind, pred, hooks, splitter, rejoiner, wrapper }: {
         action: unknown;
         name: string | symbol;
         op: (context: unknown) => unknown | Promise<unknown> | import("./ActionBuilder.js").default;
@@ -41,7 +48,14 @@ export default class Activity {
         hooks?: import("./ActionHooks.js").default | undefined;
         splitter?: ((context: unknown) => unknown) | undefined;
         rejoiner?: ((originalContext: unknown, splitResults: unknown) => unknown) | undefined;
+        wrapper?: import("./ActionWrapper.js").default | undefined;
     });
+    /**
+     * Unique identifier for this activity instance.
+     *
+     * @returns {symbol} Unique symbol identifier
+     */
+    get id(): symbol;
     /**
      * The activity name.
      *
@@ -55,7 +69,7 @@ export default class Activity {
      */
     get kind(): number | null;
     /**
-     * The predicate function for WHILE/UNTIL flows.
+     * The predicate function for WHILE/UNTIL/IF flows.
      *
      * @returns {(context: unknown) => boolean|Promise<boolean>|undefined} - Predicate used to continue/stop loops
      */
@@ -96,6 +110,13 @@ export default class Activity {
      * @returns {unknown} - Bound action instance
      */
     get action(): unknown;
+    /**
+     * Get the ActionWrapper containing this activity.
+     * Used by BREAK/CONTINUE to signal the parent loop.
+     *
+     * @returns {import("./ActionWrapper.js").default|null} The wrapper or null
+     */
+    get wrapper(): import("./ActionWrapper.js").default | null;
     /**
      * Execute the activity with before/after hooks.
      *

package/src/types/browser/lib/Activity.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Activity.d.ts","sourceRoot":"","sources":["../../../browser/lib/Activity.js"],"names":[],"mappings":";;;uBASU,MAAM;AAPhB,gEAAgE;AAEhE;;;;;;;;;GASG;AACH;;;;GAIE;AAEF;IAoBE;;;;;;;;;;;;OAYG;IACH,yEATG;QAAsB,MAAM,EAApB,OAAO;QACa,IAAI,EAAxB,MAAM,GAAC,MAAM;QAC6E,EAAE,EAA5F,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,OAAO,oBAAoB,EAAE,OAAO;QACrE,IAAI;QACoC,IAAI,cAAhD,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC;QAC3B,KAAK;QACa,QAAQ,cAAnC,OAAO,KAAK,OAAO;QACuC,QAAQ,sBAA1D,OAAO,gBAAgB,OAAO,KAAK,OAAO;KACtE,EAUA;IAED;;;;OAIG;IACH,YAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,YAFa,MAAM,GAAC,IAAI,CAIvB;IAED;;;;OAIG;IACH,YAFa,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,SAAS,CAIpE;IAED;;;;OAIG;IACH,eAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,cAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,UAFa,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,OAAO,oBAAoB,EAAE,OAAO,CAI/F;IAED;;;;OAIG;IACH,gBAFa,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,GAAC,IAAI,CAIhD;IAED;;;;OAIG;IACH,gBAFa,CAAC,CAAC,eAAe,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,KAAK,OAAO,CAAC,GAAC,IAAI,CAI/E;IAED;;;;OAIG;IACH,cAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,aAHW,OAAO,GACL,OAAO,CAAC,OAAO,CAAC,CAa5B;IAED;;;;;OAKG;IACH,sBAHW,WAAW,GACT,IAAI,CAOhB;IAED;;;;OAIG;IACH,aAFa,WAAW,GAAC,IAAI,CAI5B;;CACF;0BAvLa,OAAO,kBAAkB,EAAE,OAAO"}
+{"version":3,"file":"Activity.d.ts","sourceRoot":"","sources":["../../../browser/lib/Activity.js"],"names":[],"mappings":";;;uBASU,MAAM;AAPhB,gEAAgE;AAEhE;;;;;;;;;;;;GAYG;AACH;;;;;;;GAOE;AAEF;IAwBE;;;;;;;;;;;;;OAaG;IACH,kFAVG;QAAsB,MAAM,EAApB,OAAO;QACa,IAAI,EAAxB,MAAM,GAAC,MAAM;QAC6E,EAAE,EAA5F,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,OAAO,oBAAoB,EAAE,OAAO;QACrE,IAAI;QACoC,IAAI,cAAhD,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC;QAC3B,KAAK;QACa,QAAQ,cAAnC,OAAO,KAAK,OAAO;QACuC,QAAQ,sBAA1D,OAAO,gBAAgB,OAAO,KAAK,OAAO;QAChB,OAAO;KAC7D,EAWA;IAED;;;;OAIG;IACH,UAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,YAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,YAFa,MAAM,GAAC,IAAI,CAIvB;IAED;;;;OAIG;IACH,YAFa,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,SAAS,CAIpE;IAED;;;;OAIG;IACH,eAFa,OAAO,CAInB;IAED;;;;OAIG;IACH,cAFa,MAAM,CAIlB;IAED;;;;OAIG;IACH,UAFa,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,GAAC,OAAO,CAAC,OAAO,CAAC,GAAC,OAAO,oBAAoB,EAAE,OAAO,CAI/F;IAED;;;;OAIG;IACH,gBAFa,CAAC,CAAC,OAAO,EAAE,OAAO,KAAK,OAAO,CAAC,GAAC,IAAI,CAIhD;IAED;;;;OAIG;IACH,gBAFa,CAAC,CAAC,eAAe,EAAE,OAAO,EAAE,YAAY,EAAE,OAAO,KAAK,OAAO,CAAC,GAAC,IAAI,CAI/E;IAED;;;;OAIG;IACH,cAFa,OAAO,CAInB;IAED;;;;;OAKG;IACH,eAFa,OAAO,oBAAoB,EAAE,OAAO,GAAC,IAAI,CAIrD;IAED;;;;;OAKG;IACH,aAHW,OAAO,GACL,OAAO,CAAC,OAAO,CAAC,CAa5B;IAED;;;;;OAKG;IACH,sBAHW,WAAW,GACT,IAAI,CAOhB;IAED;;;;OAIG;IACH,aAFa,WAAW,GAAC,IAAI,CAI5B;;CACF;0BAtNa,OAAO,kBAAkB,EAAE,OAAO"}

package/src/types/lib/ActionBuilder.d.ts

@@ -112,6 +112,13 @@ export default class ActionBuilder {
    * @returns {ActionBuilder} The builder instance for chaining.
    */
   withAction(action: ActionBuilderAction): ActionBuilder
+  /**
+   * Register a callback to be executed after all activities complete.
+   *
+   * @param {ActionFunction} callback Function to execute at the end of the pipeline.
+   * @returns {ActionBuilder} The builder instance for chaining.
+   */
+  done(callback: ActionFunction): ActionBuilder
   /**
    * Finalises the builder and returns a payload that can be consumed by the
    * runner.

package/src/types/lib/ActionHooks.d.ts

@@ -14,6 +14,13 @@
  * Inherits all browser functionality and adds FileObject-based hook import capability.
  */
 export default class ActionHooks extends BrowserActionHooks {
+    /**
+     * @typedef {object} ActionHooksConfig
+     * @property {string} [hooksFile] Path to the hooks file
+     * @property {string} [hooksKind] Name of the hooks class to instantiate
+     * @property {object} [hooks] Pre-instantiated hooks object
+     * @property {number} [timeout] Timeout for hook execution
+     */
     /**
      * Static factory method to create and initialize a hook manager.
      * Loads hooks from the specified file and returns an initialized instance.
@@ -23,7 +30,24 @@ export default class ActionHooks extends BrowserActionHooks {
      * @param {DebugFn} debug The debug function.
      * @returns {Promise<ActionHooks|null>} Initialized hook manager or null if no hooks found
      */
-    static "new"(config: ActionHooksConfig, debug: DebugFn): Promise<ActionHooks | null>;
+    static "new"(config: {
+        /**
+         * Path to the hooks file
+         */
+        hooksFile?: string | undefined;
+        /**
+         * Name of the hooks class to instantiate
+         */
+        hooksKind?: string | undefined;
+        /**
+         * Pre-instantiated hooks object
+         */
+        hooks?: object | undefined;
+        /**
+         * Timeout for hook execution
+         */
+        timeout?: number | undefined;
+    }, debug: DebugFn): Promise<ActionHooks | null>;
     /**
      * Creates a new ActionHook instance.
      *

package/src/types/lib/ActionHooks.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ActionHooks.d.ts","sourceRoot":"","sources":["../../lib/ActionHooks.js"],"names":[],"mappings":"AAGA;;GAEG;AAEH;;;;;;;GAOG;AAEH;;;GAGG;AACH;IAuBE;;;;;;;;OAQG;IACH,qBAJW,iBAAiB,SACjB,OAAO,GACL,OAAO,CAAC,WAAW,GAAC,IAAI,CAAC,CAgDrC;IA1ED;;;;OAIG;IACH,kEAFW,qBAAqB,EAK/B;IAED;;;;OAIG;IACH,iBAFa,UAAU,CAItB;;CA2DF;sBAhGY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI;;;;;gBAKjE,MAAM;;;;;;;;YAEN,OAAO;;;;;;;;WAEP,OAAO;;kDAZ2B,qBAAqB;2BADtC,kBAAkB"}
+{"version":3,"file":"ActionHooks.d.ts","sourceRoot":"","sources":["../../lib/ActionHooks.js"],"names":[],"mappings":"AAGA;;GAEG;AAEH;;;;;;;GAOG;AAEH;;;GAGG;AACH;IAuBE;;;;;;OAMG;IAEH;;;;;;;;OAQG;IACH;;;;;;;;;;;;;;;;;cAHW,OAAO,GACL,OAAO,CAAC,WAAW,GAAC,IAAI,CAAC,CAgDrC;IAlFD;;;;OAIG;IACH,kEAFW,qBAAqB,EAK/B;IAED;;;;OAIG;IACH,iBAFa,UAAU,CAItB;;CAmEF;sBAxGY,CAAC,OAAO,EAAE,MAAM,EAAE,KAAK,CAAC,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,KAAK,CAAC,OAAO,CAAC,KAAK,IAAI;;;;;gBAKjE,MAAM;;;;;;;;YAEN,OAAO;;;;;;;;WAEP,OAAO;;kDAZ2B,qBAAqB;2BADtC,kBAAkB"}

package/src/types/lib/ActionWrapper.d.ts

@@ -19,7 +19,7 @@ export default class ActionWrapper {
    *
    * @param {{activities: Map<string|symbol, WrappedActivityConfig>, debug: (message: string, level?: number, ...args: Array<unknown>) => void}} init Builder payload containing activities + logger.
    */
-  constructor({ activities, hooks, debug }: {
+  constructor({ activities, hooks, debug, done: doneCallback }: {
     activities: Map<string | symbol, WrappedActivityConfig>;
     debug: (message: string, level?: number, ...args: Array<unknown>) => void;
   })
@@ -29,6 +29,12 @@ export default class ActionWrapper {
    * @returns {ActivityIterator} Lazy iterator yielding Activity instances.
    */
   get activities(): ActivityIterator
+  /**
+   * Get the done callback if registered.
+   *
+   * @returns {((context: unknown) => unknown|Promise<unknown>)|null} Done callback or null.
+   */
+  get done(): ((context: unknown) => unknown | Promise<unknown>) | null
   #private
 }
 export type WrappedActivityConfig = {