@hotmeshio/hotmesh 0.1.15 → 0.1.16

package/build/services/{durable → meshflow}/connection.d.ts

@@ -1,4 +1,5 @@
-import { Connection, ConnectionConfig } from '../../types/durable';
+import { Connection, ConnectionConfig } from '../../types/meshflow';
 export declare class ConnectionService {
+    constructor();
     static connect(config: ConnectionConfig): Promise<Connection>;
 }

package/build/services/{durable → meshflow}/connection.js

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConnectionService = void 0;
 class ConnectionService {
+    constructor() { }
     static async connect(config) {
         return {
             class: config.class,

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

@@ -0,0 +1,29 @@
+import { ILogger } from '../logger';
+import { StoreService } from '../store';
+import { ExportOptions, MeshFlowJobExport, TimelineType, TransitionType, ExportFields } from '../../types/exporter';
+import { RedisClient, RedisMulti } from '../../types/redis';
+import { StringStringType, Symbols } from '../../types/serializer';
+declare class ExporterService {
+    appId: string;
+    logger: ILogger;
+    store: StoreService<RedisClient, RedisMulti>;
+    symbols: Promise<Symbols> | Symbols;
+    private static symbols;
+    constructor(appId: string, store: StoreService<RedisClient, RedisMulti>, logger: ILogger);
+    export(jobId: string, options?: ExportOptions): Promise<MeshFlowJobExport>;
+    inflate(jobHash: StringStringType, options: ExportOptions): MeshFlowJobExport;
+    resolveValue(raw: string, withValues: boolean): Record<string, any> | string | number | null;
+    inflateKey(key: string): string;
+    filterFields(fullObject: MeshFlowJobExport, block?: ExportFields[], allow?: ExportFields[]): Partial<MeshFlowJobExport>;
+    inflateTransition(match: RegExpMatchArray, value: string, transitionsObject: Record<string, TransitionType>): void;
+    sortEntriesByCreated(obj: {
+        [key: string]: TransitionType;
+    }): TransitionType[];
+    keyToObject(key: string): {
+        index: number;
+        dimension?: string;
+        secondary?: number;
+    };
+    sortParts(parts: TimelineType[]): TimelineType[];
+}
+export { ExporterService };

package/build/services/{durable → meshflow}/exporter.js

@@ -9,10 +9,6 @@ class ExporterService {
         this.logger = logger;
         this.store = store;
     }
-    /**
-     * Convert the job hash from its compiles format into a DurableJobExport object with
-     * facets that describe the workflow in terms relevant to narrative storytelling.
-     */
     async export(jobId, options = {}) {
         if (!ExporterService.symbols.has(this.appId)) {
             const symbols = this.store.getAllSymbols();
@@ -22,12 +18,6 @@ class ExporterService {
         const jobExport = this.inflate(jobData, options);
         return jobExport;
     }
-    /**
-     * Inflates the job data from Redis into a DurableJobExport object
-     * @param jobHash - the job data from Redis
-     * @param dependencyList - the list of dependencies for the job
-     * @returns - the inflated job data
-     */
     inflate(jobHash, options) {
         const timeline = [];
         const state = {};
@@ -37,15 +27,12 @@ class ExporterService {
         Object.entries(jobHash).forEach(([key, value]) => {
             const match = key.match(regex);
             if (match) {
-                //transitions
                 this.inflateTransition(match, value, transitionsObject);
             }
             else if (key.startsWith('_')) {
-                //data
                 data[key.substring(1)] = value;
             }
             else if (key.startsWith('-')) {
-                //timeline
                 const keyParts = this.keyToObject(key);
                 timeline.push({
                     ...keyParts,
@@ -54,7 +41,6 @@ class ExporterService {
                 });
             }
             else if (key.length === 3) {
-                //state
                 state[this.inflateKey(key)] = serializer_1.SerializerService.fromString(value);
             }
         });
@@ -81,12 +67,6 @@ class ExporterService {
         }
         return resolved;
     }
-    /**
-     * Inflates the key from Redis, 3-character symbol
-     * into a human-readable JSON path, reflecting the
-     * tree-like structure of the unidimensional Hash
-     * @private
-     */
     inflateKey(key) {
         const symbols = ExporterService.symbols.get(this.appId);
         if (key in symbols) {
@@ -124,7 +104,6 @@ class ExporterService {
         const activity = parts[0];
         const isCreate = path.endsWith('/output/metadata/ac');
         const isUpdate = path.endsWith('/output/metadata/au');
-        //for now only export activity start/stop; activity data would also be interesting
         if (isCreate || isUpdate) {
             const targetName = `${activity},${dimensions}`;
             const target = transitionsObject[targetName];
@@ -148,9 +127,6 @@ class ExporterService {
         });
         return entriesArray;
     }
-    /**
-     * marker names are overloaded with details like sequence, type, etc
-     */
     keyToObject(key) {
         function extractDimension(label) {
             const parts = label.split(',');
@@ -161,14 +137,12 @@ class ExporterService {
         }
         const parts = key.split('-');
         if (parts.length === 4) {
-            //-proxy-5-     -search-1-1-
             return {
                 index: parseInt(parts[2], 10),
                 dimension: extractDimension(parts[1]),
             };
         }
         else {
-            //-search,0,0-1-1-    -proxy,0,0-1-
             return {
                 index: parseInt(parts[2], 10),
                 secondary: parseInt(parts[3], 10),
@@ -176,9 +150,6 @@ class ExporterService {
             };
         }
     }
-    /**
-     * idem list has a complicated sort order based on indexes and dimensions
-     */
     sortParts(parts) {
         return parts.sort((a, b) => {
             const { dimension: aDim, index: aIdx, secondary: aSec } = a;

package/build/services/meshflow/handle.d.ts

@@ -0,0 +1,22 @@
+import { HotMesh } from '../hotmesh';
+import { MeshFlowJobExport, ExportOptions } from '../../types/exporter';
+import { JobInterruptOptions } from '../../types/job';
+import { StreamError } from '../../types/stream';
+import { ExporterService } from './exporter';
+export declare class WorkflowHandleService {
+    exporter: ExporterService;
+    hotMesh: HotMesh;
+    workflowTopic: string;
+    workflowId: string;
+    constructor(hotMesh: HotMesh, workflowTopic: string, workflowId: string);
+    export(options?: ExportOptions): Promise<MeshFlowJobExport>;
+    signal(signalId: string, data: Record<any, any>): Promise<void>;
+    state(metadata?: boolean): Promise<Record<string, any>>;
+    queryState(fields: string[]): Promise<Record<string, any>>;
+    status(): Promise<number>;
+    interrupt(options?: JobInterruptOptions): Promise<string>;
+    result<T>(config?: {
+        state?: boolean;
+        throwOnError?: boolean;
+    }): Promise<T | StreamError>;
+}

package/build/services/{durable → meshflow}/handle.js

@@ -12,24 +12,12 @@ class WorkflowHandleService {
     async export(options) {
         return this.exporter.export(this.workflowId, options);
     }
-    /**
-     * Sends a signal to the workflow. This is a way to send
-     * a message to a workflow that is paused due to having
-     * executed `Durable.workflow.waitFor`. The workflow
-     * will awaken if no other signals are pending.
-     */
     async signal(signalId, data) {
         await this.hotMesh.hook(`${this.hotMesh.appId}.wfs.signal`, {
             id: signalId,
             data,
         });
     }
-    /**
-     * Returns the job state of the workflow. If the workflow has completed
-     * this is also the job output. If the workflow is still running, this
-     * is the current state of the job, but it may change depending upon
-     * the activities that remain.
-     */
     async state(metadata = false) {
         const state = await this.hotMesh.getState(`${this.hotMesh.appId}.execute`, this.workflowId);
         if (!state.data && state.metadata.err) {
@@ -37,56 +25,25 @@ class WorkflowHandleService {
         }
         return metadata ? state : state.data;
     }
-    /**
-     * Returns the current search state of the workflow. This is
-     * different than the job state or individual activity state.
-     * Search state represents name/value pairs that were added
-     * to the workflow. As the workflow is stored in a Redis hash,
-     * this is a way to store additional data that is indexed
-     * and searchable using the RediSearch module.
-     */
     async queryState(fields) {
         return await this.hotMesh.getQueryState(this.workflowId, fields);
     }
-    /**
-     * Returns the current status of the workflow. This is a semaphore
-     * value that represents the current state of the workflow, where
-     * 0 is complete and a negative value represents that the flow was
-     * interrupted.
-     */
     async status() {
         return await this.hotMesh.getStatus(this.workflowId);
     }
-    /**
-     * Interrupts a running workflow. Standard Job Completion tasks will
-     * run. Subscribers will be notified and the job hash will be expired.
-     */
     async interrupt(options) {
         return await this.hotMesh.interrupt(`${this.hotMesh.appId}.execute`, this.workflowId, options);
     }
-    /**
-     * Waits for the workflow to complete and returns the result. If
-     * the workflow response includes an error, this method will rethrow
-     * the error, including the stack trace if available.
-     * Wrap calls in a try/catch as necessary to avoid unhandled exceptions.
-     */
     async result(config) {
         const topic = `${this.hotMesh.appId}.executed.${this.workflowId}`;
         let isResolved = false;
         return new Promise(async (resolve, reject) => {
-            /**
-             * rejects/resolves the promise based on the `throwOnError`
-             * default behavior is to throw if error
-             */
             const safeReject = (err) => {
                 if (config?.throwOnError === false) {
                     return resolve(err);
                 }
                 reject(err);
             };
-            /**
-             * Common completion function that unsubscribes from the topic/returns
-             */
             const complete = async (response, err) => {
                 if (isResolved)
                     return;
@@ -109,7 +66,6 @@ class WorkflowHandleService {
                 }
                 resolve(response);
             };
-            //more expensive; fetches the entire job, not just the `status`
             if (config?.state) {
                 const state = await this.hotMesh.getState(`${this.hotMesh.appId}.execute`, this.workflowId);
                 if (state?.data?.done && !state.data?.$error) {
@@ -122,7 +78,6 @@ class WorkflowHandleService {
                     return complete(null, JSON.parse(state.metadata.err));
                 }
             }
-            //subscribe to 'done' topic
             this.hotMesh.sub(topic, async (_topic, state) => {
                 this.hotMesh.unsub(topic);
                 if (state.data.done && !state.data?.$error) {
@@ -136,7 +91,6 @@ class WorkflowHandleService {
                     return await complete(null, error);
                 }
             });
-            //check state in case completed during wiring
             const status = await this.hotMesh.getStatus(this.workflowId);
             if (status <= 0) {
                 await complete();

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

@@ -0,0 +1,17 @@
+import { ContextType } from '../../types/meshflow';
+import { ClientService } from './client';
+import { ConnectionService } from './connection';
+import { Search } from './search';
+import { WorkerService } from './worker';
+import { WorkflowService } from './workflow';
+declare class MeshFlowClass {
+    constructor();
+    static Client: typeof ClientService;
+    static Connection: typeof ConnectionService;
+    static Search: typeof Search;
+    static Worker: typeof WorkerService;
+    static workflow: typeof WorkflowService;
+    static shutdown(): Promise<void>;
+}
+export { MeshFlowClass as MeshFlow };
+export type { ContextType };

package/build/services/meshflow/index.js

@@ -0,0 +1,23 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MeshFlow = void 0;
+const hotmesh_1 = require("../hotmesh");
+const client_1 = require("./client");
+const connection_1 = require("./connection");
+const search_1 = require("./search");
+const worker_1 = require("./worker");
+const workflow_1 = require("./workflow");
+class MeshFlowClass {
+    constructor() { }
+    static async shutdown() {
+        await MeshFlowClass.Client.shutdown();
+        await MeshFlowClass.Worker.shutdown();
+        await hotmesh_1.HotMesh.stop();
+    }
+}
+exports.MeshFlow = MeshFlowClass;
+MeshFlowClass.Client = client_1.ClientService;
+MeshFlowClass.Connection = connection_1.ConnectionService;
+MeshFlowClass.Search = search_1.Search;
+MeshFlowClass.Worker = worker_1.WorkerService;
+MeshFlowClass.workflow = workflow_1.WorkflowService;

package/build/services/meshflow/schemas/factory.d.ts

@@ -0,0 +1,4 @@
+declare const APP_VERSION = "3";
+declare const APP_ID = "durable";
+declare const getWorkflowYAML: (app: string, version: string) => string;
+export { getWorkflowYAML, APP_VERSION, APP_ID };

package/build/services/{durable → meshflow}/schemas/factory.js

@@ -1,39 +1,10 @@
 "use strict";
-/**
- *********** HOTMESH 'DURABLE' MODULE APPLICATION GRAPH **********
- *
- * This HotMesh application spec uses 50 activities and 25 transitions
- * to model and emulate the Temporal Application & Query servers using
- * Redis as the backend.
- *
- * It's particularly useful for organizations with high-speed, high-volume
- * use cases as it uses in-memory Redis Streams for transactional,
- * workflow processing, while adhering to Temporal's developer-friendly syntax.
- *
- * This YAML file can also serve as a useful starting point for building
- * Integration/BPM/Workflow servers in general (MuleSoft, etc) without the need
- * for a physical application server.
- *
- * Possible use cases include:
- * * Orchestration servers
- * * Integration servers
- * * BPMN engines
- * * Reentrant process servers
- * * Service Meshes
- * * Master Data Management systems
- */
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.APP_ID = exports.APP_VERSION = exports.getWorkflowYAML = void 0;
 const APP_VERSION = '3';
 exports.APP_VERSION = APP_VERSION;
 const APP_ID = 'durable';
 exports.APP_ID = APP_ID;
-/**
- * returns a new durable workflow schema
- * @param {string} app - app name (e.g., 'durable')
- * @param {string} version - number as string (e.g., '1')
- * @returns {string} HotMesh App YAML
- */
 const getWorkflowYAML = (app, version) => {
     return `app:
   id: ${app}
@@ -41,7 +12,7 @@ const getWorkflowYAML = (app, version) => {
   graphs:
 
     ###################################################
-    #         THE DURABLE-REENTRANT-WORKFLOW          #
+    #         THE MESHFLOW-REENTRANT-WORKFLOW          #
     #                                                 #
     - subscribes: ${app}.execute
       publishes: ${app}.executed
@@ -785,6 +756,7 @@ const getWorkflowYAML = (app, version) => {
           type: signal
           subtype: one
           topic: ${app}.flow.signal
+          statusThreshold: 1
           signal:
             schema:
               type: object

package/build/services/meshflow/search.d.ts

@@ -0,0 +1,23 @@
+import { HotMesh } from '../hotmesh';
+import { RedisClient, RedisMulti } from '../../types/redis';
+import { StoreService } from '../store';
+import { WorkflowSearchOptions } from '../../types/meshflow';
+export declare class Search {
+    jobId: string;
+    searchSessionId: string;
+    searchSessionIndex: number;
+    hotMeshClient: HotMesh;
+    store: StoreService<RedisClient, RedisMulti> | null;
+    cachedFields: Record<string, string>;
+    constructor(workflowId: string, hotMeshClient: HotMesh, searchSessionId: string);
+    safeKey(key: string): string;
+    static configureSearchIndex(hotMeshClient: HotMesh, search?: WorkflowSearchOptions): Promise<void>;
+    static listSearchIndexes(hotMeshClient: HotMesh): Promise<string[]>;
+    getSearchSessionGuid(): string;
+    set(...args: string[]): Promise<number>;
+    get(key: string): Promise<string>;
+    mget(...args: string[]): Promise<string[]>;
+    del(...args: string[]): Promise<number | void>;
+    incr(key: string, val: number): Promise<number>;
+    mult(key: string, val: number): Promise<number>;
+}

package/build/services/{durable → meshflow}/search.js

@@ -16,38 +16,12 @@ class Search {
         this.hotMeshClient = hotMeshClient;
         this.store = hotMeshClient.engine.store;
     }
-    /**
-     * Prefixes the key with an underscore to keep separate from the
-     * activity and job history (and searchable via HKEYS)
-     * @param {string} key - the key to be sanitized. Wrap in quotes to avoid sanitization.
-     * @returns {string} - the sanitized key
-     * @private
-     */
     safeKey(key) {
         if (key.startsWith('"')) {
             return key.slice(1, -1);
         }
         return `_${key}`;
     }
-    /**
-     * For those deployments with a redis stack backend (with the FT module),
-     * this method will configure the search index for the workflow. For all
-     * others, this method will exit/fail gracefully and not index
-     * the fields in the HASH. All values are searchable via HKEYS/HSC/HGET
-     * @param {HotMesh} hotMeshClient - the hotmesh client
-     * @param {WorkflowSearchOptions} search - the search options
-     * @returns {Promise<void>}
-     * @example
-     * const search = {
-     *  index: 'my_search_index',
-     *  prefix: ['my_workflow_prefix'],
-     *  schema: {
-     *   field1: { type: 'TEXT', sortable: true },
-     *   field2: { type: 'NUMERIC', sortable: true }
-     *  }
-     * }
-     * await Search.configureSearchIndex(hotMeshClient, search);
-     */
     static async configureSearchIndex(hotMeshClient, search) {
         if (search?.schema) {
             const store = hotMeshClient.engine.store;
@@ -85,15 +59,6 @@ class Search {
             }
         }
     }
-    /**
-     * For those deployments with a redis stack backend (with the FT module),
-     * this method will list all search indexes.
-     *
-     * @param {HotMesh} hotMeshClient - the hotmesh client
-     * @returns {Promise<string[]>} - the list of search indexes
-     * @example
-     * const searchIndexes = await Search.listSearchIndexes(hotMeshClient);
-     */
     static async listSearchIndexes(hotMeshClient) {
         try {
             const store = hotMeshClient.engine.store;
@@ -107,25 +72,9 @@ class Search {
             return [];
         }
     }
-    /**
-     * increments the index to return a unique search session guid when
-     * calling any method that produces side effects (changes the value)
-     * @private
-     */
     getSearchSessionGuid() {
-        //return the search session as it would exist in the search session index
         return `${this.searchSessionId}-${this.searchSessionIndex++}-`;
     }
-    /**
-     * Sets the fields listed in args. Returns the
-     * count of new fields that were set (does not
-     * count fields that were updated)
-     * @param args
-     * @returns {number}
-     * @example
-     * const search = new Search();
-     * const count = await search.set('field1', 'value1', 'field2', 'value2');
-     */
     async set(...args) {
         const ssGuid = this.getSearchSessionGuid();
         const store = storage_1.asyncLocalStorage.getStore();
@@ -142,18 +91,9 @@ class Search {
             return Number(replay[ssGuid]);
         }
         const fieldCount = await this.store.exec('HSET', this.jobId, ...safeArgs);
-        //no need to wait; set this interim value in the replay
         this.store.exec('HSET', this.jobId, ssGuid, fieldCount.toString());
         return Number(fieldCount);
     }
-    /**
-     * Returns the value of the field in the HASH stored at key.
-     * @param key
-     * @returns {string}
-     * @example
-     * const search = new Search();
-     * const value = await search.get('field1');
-     */
     async get(key) {
         try {
             if (key in this.cachedFields) {
@@ -168,11 +108,6 @@ class Search {
             return '';
         }
     }
-    /**
-     * Returns the values of all specified fields in the HASH stored at key.
-     * @param args
-     * @returns
-     */
     async mget(...args) {
         let isCached = true;
         const values = [];
@@ -205,16 +140,6 @@ class Search {
             return [];
         }
     }
-    /**
-     * Deletes the fields provided as args. Returns the
-     * count of fields that were deleted.
-     *
-     * @param args
-     * @returns {number}
-     * @example
-     * sont search = new Search();
-     * const count = await search.del('field1', 'field2', 'field3');
-     */
     async del(...args) {
         const ssGuid = this.getSearchSessionGuid();
         const store = storage_1.asyncLocalStorage.getStore();
@@ -235,18 +160,6 @@ class Search {
         this.store.exec('HSET', this.jobId, ssGuid, formattedResponse.toString());
         return formattedResponse;
     }
-    /**
-     * Increments the value of a float field by the given amount. Returns the
-     * new value of the field after the increment. Pass a negative
-     * number to decrement the value.
-     *
-     * @param key - the key to increment
-     * @param val - the value to increment by
-     * @returns {number} - the new value
-     * @example
-     * const search = new Search();
-     * const count = await search.incr('field1', 1.5);
-     */
     async incr(key, val) {
         delete this.cachedFields[key];
         const ssGuid = this.getSearchSessionGuid();
@@ -259,18 +172,6 @@ class Search {
         this.store.exec('HSET', this.jobId, ssGuid, num.toString());
         return Number(num);
     }
-    /**
-     * Multiplies the value of a field by the given amount. Returns the
-     * new value of the field after the multiplication. NOTE:
-     * this is exponential multiplication.
-     *
-     * @param key - the key to multiply
-     * @param val - the value to multiply by
-     * @returns {number} - the new product of the multiplication
-     * @example
-     * const search = new Search();
-     * const product = await search.mult('field1', 1.5);
-     */
     async mult(key, val) {
         delete this.cachedFields[key];
         const ssGuid = this.getSearchSessionGuid();

package/build/services/{durable → meshflow}/worker.d.ts

@@ -1,11 +1,12 @@
-import { HotMeshService as HotMesh } from '../hotmesh';
-import { Registry, WorkerConfig, WorkerOptions } from '../../types/durable';
+import { HotMesh } from '../hotmesh';
+import { Registry, WorkerConfig, WorkerOptions } from '../../types/meshflow';
 export declare class WorkerService {
     static activityRegistry: Registry;
     static instances: Map<string, HotMesh | Promise<HotMesh>>;
     workflowRunner: HotMesh;
     activityRunner: HotMesh;
     static getHotMesh: (workflowTopic: string, config?: Partial<WorkerConfig>, options?: WorkerOptions) => Promise<HotMesh>;
+    constructor();
     static activateWorkflow(hotMesh: HotMesh): Promise<void>;
     static registerActivities<ACT>(activities: ACT): Registry;
     static create(config: WorkerConfig): Promise<WorkerService>;