@cadenza.io/core 3.16.3 → 3.17.0

package/dist/index.d.mts

@@ -817,6 +817,7 @@ declare class Task extends SignalEmitter implements Graph {
     signalsToEmitAfter: Set<string>;
     signalsToEmitOnFail: Set<string>;
     observedSignals: Set<string>;
+    intents: Set<string>;
     readonly taskFunction: TaskFunction;
     /**
      * Constructs an instance of the task with the specified properties and configuration options.
@@ -1052,6 +1053,7 @@ declare class Task extends SignalEmitter implements Graph {
      * @return {this} Returns the current instance to allow method chaining.
      */
     detachAllSignals(): this;
+    handlesIntent(intent: string): this;
     /**
      * Maps over the signals in the `signalsToEmitAfter` set and applies a callback function to each signal.
      *
@@ -1401,11 +1403,14 @@ declare class GraphRunner extends SignalEmitter {
 interface EmitOptions {
     squash?: boolean;
     squashId?: string | null;
+    groupId?: string | null;
     mergeFunction?: ((oldContext: AnyObject, newContext: AnyObject) => AnyObject) | null;
     debounce?: boolean;
+    throttle?: boolean;
     delayMs?: number;
     schedule?: boolean;
     exactDateTime?: Date | null;
+    throttleBatch?: number;
 }
 /**
  * This class manages signals and observers, enabling communication across different parts of an application.
@@ -1433,6 +1438,8 @@ declare class SignalBroker {
     debouncedEmitters: Map<string, any>;
     squashedEmitters: Map<string, any>;
     squashedContexts: Map<string, any>;
+    throttleEmitters: Map<string, any>;
+    throttleQueues: Map<string, any>;
     getSignalsTask: Task | undefined;
     registerSignalTask: Task | undefined;
     signalObservers: Map<string, {
@@ -1492,6 +1499,7 @@ declare class SignalBroker {
     debounce(signal: string, context: any, options?: {
         delayMs: number;
     }): void;
+    throttle(signal: string, context: any, options?: EmitOptions): void;
     /**
      * Aggregates and debounces multiple events with the same identifier to minimize redundant operations.
      *

package/dist/index.d.ts

@@ -817,6 +817,7 @@ declare class Task extends SignalEmitter implements Graph {
     signalsToEmitAfter: Set<string>;
     signalsToEmitOnFail: Set<string>;
     observedSignals: Set<string>;
+    intents: Set<string>;
     readonly taskFunction: TaskFunction;
     /**
      * Constructs an instance of the task with the specified properties and configuration options.
@@ -1052,6 +1053,7 @@ declare class Task extends SignalEmitter implements Graph {
      * @return {this} Returns the current instance to allow method chaining.
      */
     detachAllSignals(): this;
+    handlesIntent(intent: string): this;
     /**
      * Maps over the signals in the `signalsToEmitAfter` set and applies a callback function to each signal.
      *
@@ -1401,11 +1403,14 @@ declare class GraphRunner extends SignalEmitter {
 interface EmitOptions {
     squash?: boolean;
     squashId?: string | null;
+    groupId?: string | null;
     mergeFunction?: ((oldContext: AnyObject, newContext: AnyObject) => AnyObject) | null;
     debounce?: boolean;
+    throttle?: boolean;
     delayMs?: number;
     schedule?: boolean;
     exactDateTime?: Date | null;
+    throttleBatch?: number;
 }
 /**
  * This class manages signals and observers, enabling communication across different parts of an application.
@@ -1433,6 +1438,8 @@ declare class SignalBroker {
     debouncedEmitters: Map<string, any>;
     squashedEmitters: Map<string, any>;
     squashedContexts: Map<string, any>;
+    throttleEmitters: Map<string, any>;
+    throttleQueues: Map<string, any>;
     getSignalsTask: Task | undefined;
     registerSignalTask: Task | undefined;
     signalObservers: Map<string, {
@@ -1492,6 +1499,7 @@ declare class SignalBroker {
     debounce(signal: string, context: any, options?: {
         delayMs: number;
     }): void;
+    throttle(signal: string, context: any, options?: EmitOptions): void;
     /**
      * Aggregates and debounces multiple events with the same identifier to minimize redundant operations.
      *

package/dist/index.js

@@ -1262,6 +1262,11 @@ var merge = createAssigner_default(function(object, source, srcIndex) {
 });
 var merge_default = merge;
 
+// src/utils/promise.ts
+function sleep(ms) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}
+
 // src/engine/SignalBroker.ts
 var SignalBroker = class _SignalBroker {
   constructor() {
@@ -1270,6 +1275,8 @@ var SignalBroker = class _SignalBroker {
     this.debouncedEmitters = /* @__PURE__ */ new Map();
     this.squashedEmitters = /* @__PURE__ */ new Map();
     this.squashedContexts = /* @__PURE__ */ new Map();
+    this.throttleEmitters = /* @__PURE__ */ new Map();
+    this.throttleQueues = /* @__PURE__ */ new Map();
     // TODO: Signals should be a class with a the observers, registered flag and other data.
     this.signalObservers = /* @__PURE__ */ new Map();
     this.emittedSignalsRegistry = /* @__PURE__ */ new Set();
@@ -1470,6 +1477,35 @@ var SignalBroker = class _SignalBroker {
     }
     debouncedEmitter(context);
   }
+  throttle(signal, context, options = { delayMs: 1e3 }) {
+    let { groupId, delayMs = 300 } = options;
+    if (!groupId) {
+      groupId = signal;
+    }
+    if (!this.throttleQueues.has(groupId)) {
+      this.throttleQueues.set(groupId, []);
+    }
+    const queue = this.throttleQueues.get(groupId);
+    queue.push([signal, context]);
+    if (!this.throttleEmitters.has(groupId)) {
+      this.throttleEmitters.set(groupId, async () => {
+        while (queue.length > 0) {
+          let batchSize = options.throttleBatch ?? 1;
+          if (batchSize > queue.length) {
+            batchSize = queue.length;
+          }
+          for (let i = 0; i < batchSize; i++) {
+            const [nextSignal, nextContext] = queue.shift();
+            this.emit(nextSignal, nextContext);
+          }
+          await sleep(delayMs);
+        }
+        this.throttleEmitters.delete(groupId);
+        this.throttleQueues.delete(groupId);
+      });
+      this.throttleEmitters.get(groupId)();
+    }
+  }
   /**
    * Aggregates and debounces multiple events with the same identifier to minimize redundant operations.
    *
@@ -1482,7 +1518,7 @@ var SignalBroker = class _SignalBroker {
    * @return {void} Does not return a value.
    */
   squash(signal, context, options = { squash: true }) {
-    let { squashId, delayMs = 500 } = options;
+    let { squashId, delayMs = 300 } = options;
     if (!squashId) {
       squashId = signal;
     }
@@ -1490,10 +1526,11 @@ var SignalBroker = class _SignalBroker {
       this.squashedEmitters.set(
         squashId,
         debounce_default(() => {
-          this.emit(signal, this.squashedContexts.get(squashId));
+          options.squash = false;
+          this.emit(signal, this.squashedContexts.get(squashId), options);
           this.squashedEmitters.delete(squashId);
           this.squashedContexts.delete(squashId);
-        }, delayMs ?? 500)
+        }, delayMs ?? 300)
       );
       this.squashedContexts.set(squashId, context);
     } else {
@@ -2078,7 +2115,7 @@ var SignalEmitter = class {
    * @param options
    */
   emit(signal, data = {}, options = {}) {
-    Cadenza.broker.emit(signal, data);
+    Cadenza.broker.emit(signal, data, options);
   }
   /**
    * Emits a signal via the broker if not silent.
@@ -2090,15 +2127,10 @@ var SignalEmitter = class {
     if (this.silent) {
       return;
     }
-    Cadenza.broker.emit(signal, data);
+    Cadenza.broker.emit(signal, data, options);
   }
 };
 
-// src/utils/promise.ts
-function sleep(ms) {
-  return new Promise((resolve) => setTimeout(resolve, ms));
-}
-
 // src/graph/execution/GraphNode.ts
 var GraphNode = class _GraphNode extends SignalEmitter {
   constructor(task, context, routineExecId, prevNodes = [], debug = false, verbose = false) {
@@ -2342,7 +2374,7 @@ var GraphNode = class _GraphNode extends SignalEmitter {
           },
           filter: { uuid: this.routineExecId }
         },
-        { squash: true, squashId: this.routineExecId }
+        { squash: true, squashId: this.routineExecId, delayMs: 200 }
       );
     }
     if (this.debug && !this.task.isSubMeta && !this.context.getMetadata().__isSubMeta || this.verbose) {
@@ -2403,7 +2435,7 @@ var GraphNode = class _GraphNode extends SignalEmitter {
         },
         filter: { uuid: this.id }
       },
-      { squash: true, squashId: this.id }
+      { squash: true, squashId: this.id, delayMs: 0 }
     );
     if (this.graphDone()) {
       const context2 = this.context.getFullContext();
@@ -2425,7 +2457,7 @@ var GraphNode = class _GraphNode extends SignalEmitter {
           },
           filter: { uuid: this.routineExecId }
         },
-        { squash: true, squashId: this.routineExecId }
+        { squash: true, squashId: this.routineExecId, delayMs: 0 }
       );
     }
     return end;
@@ -3306,7 +3338,7 @@ var GraphRunner = class extends SignalEmitter {
             __executionTraceId: executionTraceId
           }
         },
-        { squash: true, squashId: routineExecId }
+        { squash: true, squashId: routineExecId, delayMs: 200 }
       );
     }
     allTasks.forEach(
@@ -3481,6 +3513,7 @@ var Task = class _Task extends SignalEmitter {
     this.signalsToEmitAfter = /* @__PURE__ */ new Set();
     this.signalsToEmitOnFail = /* @__PURE__ */ new Set();
     this.observedSignals = /* @__PURE__ */ new Set();
+    this.intents = /* @__PURE__ */ new Set();
     this.name = name;
     this.taskFunction = task;
     this.description = description;
@@ -3557,6 +3590,9 @@ var Task = class _Task extends SignalEmitter {
             signalsToEmitAfter: Array.from(this.signalsToEmitAfter),
             signalsToEmitOnFail: Array.from(this.signalsToEmitOnFail),
             observed: Array.from(this.observedSignals)
+          },
+          intents: {
+            handles: Array.from(this.intents)
           }
         },
         taskInstance: this,
@@ -4211,6 +4247,10 @@ var Task = class _Task extends SignalEmitter {
     this.signalsToEmitAfter.clear();
     return this;
   }
+  handlesIntent(intent) {
+    this.intents.add(intent);
+    return this;
+  }
   /**
    * Maps over the signals in the `signalsToEmitAfter` set and applies a callback function to each signal.
    *