@hotmeshio/hotmesh 0.8.0 → 0.9.0

package/build/services/engine/index.js

@@ -183,7 +183,7 @@ class EngineService {
      * @private
      */
     async processWebHooks() {
-        this.taskService.processWebHooks(this.hook.bind(this));
+        this.taskService.processWebHooks(this.signal.bind(this));
     }
     /**
      * @private
@@ -457,11 +457,17 @@ class EngineService {
         //todo: do not allow scrubbing of non-existent or actively running job
         await this.store.scrub(jobId);
     }
-    // ****************** `HOOK` ACTIVITY RE-ENTRY POINT *****************
+    // ****************** `SIGNAL` ACTIVITY RE-ENTRY POINT ****************
     /**
+     * Delivers a signal (data payload) to a paused hook activity,
+     * resuming its Leg 2 execution. The `topic` must match a hook rule
+     * defined in the YAML graph's `hooks` section. The engine locates
+     * the target activity and dimension for reentry based on the hook
+     * rule's match conditions.
+     *
      * @private
      */
-    async hook(topic, data, status = stream_1.StreamStatus.SUCCESS, code = 200, transaction) {
+    async signal(topic, data, status = stream_1.StreamStatus.SUCCESS, code = 200, transaction) {
         const hookRule = await this.taskService.getHookRule(topic);
         const [aid] = await this.getSchema(`.${hookRule.to}`);
         const streamData = {
@@ -503,9 +509,13 @@ class EngineService {
         await this.router?.publishMessage(null, streamData);
     }
     /**
+     * Fan-out variant of `signal()` that delivers data to **all**
+     * paused workflows matching a search query. Useful for resuming
+     * a batch of workflows waiting on the same external event.
+     *
      * @private
      */
-    async hookAll(hookTopic, data, keyResolver, queryFacets = []) {
+    async signalAll(hookTopic, data, keyResolver, queryFacets = []) {
         const config = await this.getVID();
         const hookRule = await this.taskService.getHookRule(hookTopic);
         if (hookRule) {

package/build/services/exporter/index.d.ts

@@ -10,8 +10,10 @@ import { StringStringType, Symbols } from '../../types/serializer';
 declare class ExporterService {
     appId: string;
     logger: ILogger;
+    /** @hidden */
     store: StoreService<ProviderClient, ProviderTransaction>;
     symbols: Promise<Symbols> | Symbols;
+    /** @hidden */
     constructor(appId: string, store: StoreService<ProviderClient, ProviderTransaction>, logger: ILogger);
     /**
      * Convert the job hash into a JobExport object.

package/build/services/exporter/index.js

@@ -9,6 +9,7 @@ const serializer_1 = require("../serializer");
  * includes dependency list
  */
 class ExporterService {
+    /** @hidden */
     constructor(appId, store, logger) {
         this.appId = appId;
         this.logger = logger;