@hotmeshio/hotmesh 0.8.0 → 0.10.0

package/build/services/memflow/workflow/signal.d.ts

@@ -1,29 +0,0 @@
-/**
- * Sends a signal payload to any paused workflow thread awaiting this signal.
- * This method is commonly used to coordinate between workflows, hook functions,
- * and external events.
- *
- * @example
- * // Basic usage - send a simple signal with data
- * await MemFlow.workflow.signal('signal-id', { name: 'WarmMash' });
- *
- * @example
- * // Hook function signaling completion
- * export async function exampleHook(name: string): Promise<void> {
- *   const result = await processData(name);
- *   await MemFlow.workflow.signal('hook-complete', { data: result });
- * }
- *
- * @example
- * // Signal with complex data structure
- * await MemFlow.workflow.signal('process-complete', {
- *   status: 'success',
- *   data: { id: 123, name: 'test' },
- *   timestamp: new Date().toISOString()
- * });
- *
- * @param {string} signalId - Unique signal identifier that matches a waitFor() call.
- * @param {Record<any, any>} data - The payload to send with the signal.
- * @returns {Promise<string>} The resulting hook/stream ID.
- */
-export declare function signal(signalId: string, data: Record<any, any>): Promise<string>;

package/build/services/memflow/workflow/signal.js

@@ -1,50 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.signal = void 0;
-const common_1 = require("./common");
-const isSideEffectAllowed_1 = require("./isSideEffectAllowed");
-/**
- * Sends a signal payload to any paused workflow thread awaiting this signal.
- * This method is commonly used to coordinate between workflows, hook functions,
- * and external events.
- *
- * @example
- * // Basic usage - send a simple signal with data
- * await MemFlow.workflow.signal('signal-id', { name: 'WarmMash' });
- *
- * @example
- * // Hook function signaling completion
- * export async function exampleHook(name: string): Promise<void> {
- *   const result = await processData(name);
- *   await MemFlow.workflow.signal('hook-complete', { data: result });
- * }
- *
- * @example
- * // Signal with complex data structure
- * await MemFlow.workflow.signal('process-complete', {
- *   status: 'success',
- *   data: { id: 123, name: 'test' },
- *   timestamp: new Date().toISOString()
- * });
- *
- * @param {string} signalId - Unique signal identifier that matches a waitFor() call.
- * @param {Record<any, any>} data - The payload to send with the signal.
- * @returns {Promise<string>} The resulting hook/stream ID.
- */
-async function signal(signalId, data) {
-    const store = common_1.asyncLocalStorage.getStore();
-    const workflowTopic = store.get('workflowTopic');
-    const connection = store.get('connection');
-    const namespace = store.get('namespace');
-    const hotMeshClient = await common_1.WorkerService.getHotMesh(workflowTopic, {
-        connection,
-        namespace,
-    });
-    if (await (0, isSideEffectAllowed_1.isSideEffectAllowed)(hotMeshClient, 'signal')) {
-        return await hotMeshClient.hook(`${namespace}.wfs.signal`, {
-            id: signalId,
-            data,
-        });
-    }
-}
-exports.signal = signal;

package/build/services/memflow/workflow/sleepFor.d.ts

@@ -1,24 +0,0 @@
-/**
- * Sleeps the workflow for a specified duration, deterministically.
- * On replay, it will not actually sleep again, but resume after sleep.
- *
- * @example
- * // Basic usage - sleep for a specific duration
- * await MemFlow.workflow.sleepFor('2 seconds');
- *
- * @example
- * // Using with Promise.all for parallel operations
- * const [greeting, timeInSeconds] = await Promise.all([
- *   someActivity(name),
- *   MemFlow.workflow.sleepFor('1 second')
- * ]);
- *
- * @example
- * // Multiple sequential sleeps
- * await MemFlow.workflow.sleepFor('1 seconds');  // First pause
- * await MemFlow.workflow.sleepFor('2 seconds');  // Second pause
- *
- * @param {string} duration - A human-readable duration string (e.g., '1m', '2 hours', '30 seconds').
- * @returns {Promise<number>} The resolved duration in seconds.
- */
-export declare function sleepFor(duration: string): Promise<number>;

package/build/services/memflow/workflow/sleepFor.js

@@ -1,52 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sleepFor = void 0;
-const common_1 = require("./common");
-const didRun_1 = require("./didRun");
-/**
- * Sleeps the workflow for a specified duration, deterministically.
- * On replay, it will not actually sleep again, but resume after sleep.
- *
- * @example
- * // Basic usage - sleep for a specific duration
- * await MemFlow.workflow.sleepFor('2 seconds');
- *
- * @example
- * // Using with Promise.all for parallel operations
- * const [greeting, timeInSeconds] = await Promise.all([
- *   someActivity(name),
- *   MemFlow.workflow.sleepFor('1 second')
- * ]);
- *
- * @example
- * // Multiple sequential sleeps
- * await MemFlow.workflow.sleepFor('1 seconds');  // First pause
- * await MemFlow.workflow.sleepFor('2 seconds');  // Second pause
- *
- * @param {string} duration - A human-readable duration string (e.g., '1m', '2 hours', '30 seconds').
- * @returns {Promise<number>} The resolved duration in seconds.
- */
-async function sleepFor(duration) {
-    const [didRunAlready, execIndex, result] = await (0, didRun_1.didRun)('sleep');
-    if (didRunAlready) {
-        return result.duration;
-    }
-    const store = common_1.asyncLocalStorage.getStore();
-    const interruptionRegistry = store.get('interruptionRegistry');
-    const workflowId = store.get('workflowId');
-    const workflowDimension = store.get('workflowDimension') ?? '';
-    const interruptionMessage = {
-        workflowId,
-        duration: (0, common_1.s)(duration),
-        index: execIndex,
-        workflowDimension,
-    };
-    interruptionRegistry.push({
-        code: common_1.HMSH_CODE_MEMFLOW_SLEEP,
-        type: 'MemFlowSleepError',
-        ...interruptionMessage,
-    });
-    await (0, common_1.sleepImmediate)();
-    throw new common_1.MemFlowSleepError(interruptionMessage);
-}
-exports.sleepFor = sleepFor;

package/build/services/memflow/workflow/trace.d.ts

@@ -1,14 +0,0 @@
-import { StringScalarType } from './common';
-/**
- * Executes a distributed trace, outputting the provided attributes
- * to the telemetry sink (e.g. OpenTelemetry).
- *
- * This trace will only run once per workflow execution by default.
- *
- * @param {StringScalarType} attributes - Key-value attributes to attach to the trace.
- * @param {{ once: boolean }} [config={ once: true }] - If `once` is true, trace only runs once.
- * @returns {Promise<boolean>} True if tracing succeeded, otherwise false.
- */
-export declare function trace(attributes: StringScalarType, config?: {
-    once: boolean;
-}): Promise<boolean>;

package/build/services/memflow/workflow/trace.js

@@ -1,33 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.trace = void 0;
-const common_1 = require("./common");
-const context_1 = require("./context");
-const isSideEffectAllowed_1 = require("./isSideEffectAllowed");
-/**
- * Executes a distributed trace, outputting the provided attributes
- * to the telemetry sink (e.g. OpenTelemetry).
- *
- * This trace will only run once per workflow execution by default.
- *
- * @param {StringScalarType} attributes - Key-value attributes to attach to the trace.
- * @param {{ once: boolean }} [config={ once: true }] - If `once` is true, trace only runs once.
- * @returns {Promise<boolean>} True if tracing succeeded, otherwise false.
- */
-async function trace(attributes, config = { once: true }) {
-    const store = common_1.asyncLocalStorage.getStore();
-    const workflowTopic = store.get('workflowTopic');
-    const connection = store.get('connection');
-    const namespace = store.get('namespace');
-    const hotMeshClient = await common_1.WorkerService.getHotMesh(workflowTopic, {
-        connection,
-        namespace,
-    });
-    const { raw, COUNTER } = (0, context_1.getContext)();
-    const { trc: traceId, spn: spanId, aid: activityId } = raw.metadata;
-    if (!config.once || await (0, isSideEffectAllowed_1.isSideEffectAllowed)(hotMeshClient, 'trace')) {
-        return await common_1.TelemetryService.traceActivity(namespace, attributes, activityId, traceId, spanId, COUNTER.counter);
-    }
-    return true;
-}
-exports.trace = trace;

package/build/services/memflow/workflow/waitFor.d.ts

@@ -1,29 +0,0 @@
-/**
- * Pauses the workflow until a signal with the given `signalId` is received.
- * This method is commonly used to coordinate between the main workflow and hook functions,
- * or to wait for external events.
- *
- * @example
- * // Basic usage - wait for a single signal
- * const payload = await MemFlow.workflow.waitFor<PayloadType>('abcdefg');
- *
- * @example
- * // Wait for multiple signals in parallel
- * const [signal1, signal2] = await Promise.all([
- *   MemFlow.workflow.waitFor<Record<string, any>>('signal1'),
- *   MemFlow.workflow.waitFor<Record<string, any>>('signal2')
- * ]);
- *
- * @example
- * // Typical pattern with hook functions
- * // In main workflow:
- * await MemFlow.workflow.waitFor<ResponseType>('hook-complete');
- *
- * // In hook function:
- * await MemFlow.workflow.signal('hook-complete', { data: result });
- *
- * @template T - The type of data expected in the signal payload
- * @param {string} signalId - A unique signal identifier shared by the sender and receiver.
- * @returns {Promise<T>} The data payload associated with the received signal.
- */
-export declare function waitFor<T>(signalId: string): Promise<T>;

package/build/services/memflow/workflow/waitFor.js

@@ -1,56 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.waitFor = void 0;
-const common_1 = require("./common");
-const didRun_1 = require("./didRun");
-/**
- * Pauses the workflow until a signal with the given `signalId` is received.
- * This method is commonly used to coordinate between the main workflow and hook functions,
- * or to wait for external events.
- *
- * @example
- * // Basic usage - wait for a single signal
- * const payload = await MemFlow.workflow.waitFor<PayloadType>('abcdefg');
- *
- * @example
- * // Wait for multiple signals in parallel
- * const [signal1, signal2] = await Promise.all([
- *   MemFlow.workflow.waitFor<Record<string, any>>('signal1'),
- *   MemFlow.workflow.waitFor<Record<string, any>>('signal2')
- * ]);
- *
- * @example
- * // Typical pattern with hook functions
- * // In main workflow:
- * await MemFlow.workflow.waitFor<ResponseType>('hook-complete');
- *
- * // In hook function:
- * await MemFlow.workflow.signal('hook-complete', { data: result });
- *
- * @template T - The type of data expected in the signal payload
- * @param {string} signalId - A unique signal identifier shared by the sender and receiver.
- * @returns {Promise<T>} The data payload associated with the received signal.
- */
-async function waitFor(signalId) {
-    const [didRunAlready, execIndex, result] = await (0, didRun_1.didRun)('wait');
-    if (didRunAlready) {
-        return result.data.data;
-    }
-    const store = common_1.asyncLocalStorage.getStore();
-    const interruptionRegistry = store.get('interruptionRegistry');
-    const workflowId = store.get('workflowId');
-    const workflowDimension = store.get('workflowDimension') ?? '';
-    const interruptionMessage = {
-        workflowId,
-        signalId,
-        index: execIndex,
-        workflowDimension,
-        type: 'MemFlowWaitForError',
-        code: common_1.HMSH_CODE_MEMFLOW_WAIT,
-    };
-    interruptionRegistry.push(interruptionMessage);
-    await (0, common_1.sleepImmediate)();
-    //if you are seeing this error in the logs, you might have forgotten to `await waitFor(...)`
-    throw new common_1.MemFlowWaitForError(interruptionMessage);
-}
-exports.waitFor = waitFor;