@hotmeshio/hotmesh 0.3.2 → 0.3.3

package/README.md

@@ -10,7 +10,7 @@ npm install @hotmeshio/hotmesh
 You have a Redis instance? Good. You're ready to go.
 
 ## Learn
-[📄 Docs](https://hotmeshio.github.io/sdk-typescript/) | [💼 Projects](https://github.com/hotmeshio/samples-typescript) | [🎥 Overview (3m)](https://www.loom.com/share/211bd4b4038d42f0ba34374ef5b6f961?sid=7b889a56-f60f-4ccc-84e7-8c2697e548a9) | [🎥 Transactional Workflow (9m)](https://www.loom.com/share/54ffd5266baf4ac6b287578abfd1d821?sid=0db2cef8-ef0d-4e02-a0b7-a1ee14f476ce)
+[📄 Docs](https://hotmeshio.github.io/sdk-typescript/) | [💼 Sample Projects](https://github.com/hotmeshio/samples-typescript) | [🎥 Intro (3m)](https://www.loom.com/share/211bd4b4038d42f0ba34374ef5b6f961?sid=7b889a56-f60f-4ccc-84e7-8c2697e548a9) | [🎥 Transactional Workflow (9m)](https://www.loom.com/share/54ffd5266baf4ac6b287578abfd1d821?sid=0db2cef8-ef0d-4e02-a0b7-a1ee14f476ce)
 
 ## MeshCall | Connect Everything
 [MeshCall](https://hotmeshio.github.io/sdk-typescript/classes/services_meshcall.MeshCall.html) connects your services as a singular mesh, exposing functions as idempotent endpoints. Function responses are cacheable and functions can even run as idempotent cron jobs. Make blazing fast interservice calls that return in milliseconds without the overhead of HTTP.

package/build/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@hotmeshio/hotmesh",
-    "version": "0.3.2",
+    "version": "0.3.3",
     "description": "Unbreakable Workflows",
     "main": "./build/index.js",
     "types": "./build/index.d.ts",

package/build/services/meshcall/index.js

@@ -43,7 +43,7 @@ class MeshCall {
                 await hotMesh.activate(version);
             }
             catch (error) {
-                hotMesh.engine.logger.error('durable-client-activate-err', { error });
+                hotMesh.engine.logger.error('meshcall-client-activate-err', { error });
                 throw error;
             }
         }
@@ -53,7 +53,7 @@ class MeshCall {
                 await hotMesh.activate(version);
             }
             catch (error) {
-                hotMesh.engine.logger.error('durable-client-deploy-activate-err', {
+                hotMesh.engine.logger.error('meshcall-client-deploy-activate-err', {
                     ...error,
                 });
                 throw error;

package/build/services/meshdata/index.js

@@ -13,7 +13,7 @@ class MeshData {
         this.instances = new Map();
         this.mesh = {
             sub: async (callback, options = {}) => {
-                const hotMesh = await this.getHotMesh(options.namespace || 'durable');
+                const hotMesh = await this.getHotMesh(options.namespace || 'meshflow');
                 const callbackWrapper = (topic, message) => {
                     if (message.type === 'pong' && !message.originator) {
                         if (message.profile?.worker_topic) {
@@ -37,11 +37,11 @@ class MeshData {
                 await hotMesh.quorum?.sub(callbackWrapper);
             },
             pub: async (message, options = {}) => {
-                const hotMesh = await this.getHotMesh(options.namespace || 'durable');
+                const hotMesh = await this.getHotMesh(options.namespace || 'meshflow');
                 await hotMesh.quorum?.pub(message);
             },
             unsub: async (callback, options = {}) => {
-                const hotMesh = await this.getHotMesh(options.namespace || 'durable');
+                const hotMesh = await this.getHotMesh(options.namespace || 'meshflow');
                 await hotMesh.quorum?.unsub(callback);
             },
         };
@@ -132,7 +132,7 @@ class MeshData {
         }
         return `${entity}${id}`;
     }
-    async getHotMesh(namespace = 'durable') {
+    async getHotMesh(namespace = 'meshflow') {
         let hotMesh = await this.instances.get(namespace);
         if (!hotMesh) {
             hotMesh = hotmesh_1.HotMesh.init({
@@ -257,10 +257,10 @@ class MeshData {
         return await this.getClient().workflow.signal(guid, payload, namespace);
     }
     async rollCall(options = {}) {
-        return (await this.getHotMesh(options.namespace || 'durable')).rollCall(options.delay || 1000);
+        return (await this.getHotMesh(options.namespace || 'meshflow')).rollCall(options.delay || 1000);
     }
     async throttle(options) {
-        return (await this.getHotMesh(options.namespace || 'durable')).throttle(options);
+        return (await this.getHotMesh(options.namespace || 'meshflow')).throttle(options);
     }
     async hook({ entity, id, hookEntity, hookArgs, options = {}, }) {
         const workflowId = MeshData.mintGuid(entity, id);
@@ -428,7 +428,7 @@ class MeshData {
         return (await hotMesh.engine?.store?.findJobs(options.match, options.limit, options.batch, options.cursor));
     }
     async find(entity, options, ...args) {
-        return await this.getClient().workflow.search(options.taskQueue ?? entity, options.workflowName ?? entity, options.namespace || 'durable', options.index ?? options.search?.index ?? this.search.index ?? '', ...args);
+        return await this.getClient().workflow.search(options.taskQueue ?? entity, options.workflowName ?? entity, options.namespace || 'meshflow', options.index ?? options.search?.index ?? this.search.index ?? '', ...args);
     }
     async findWhere(entity, options) {
         const targetSearch = options.options?.search ?? this.search;

package/build/services/meshflow/client.js

@@ -117,7 +117,7 @@ class ClientService {
                     return await this.search(hotMeshClient, index, query);
                 }
                 catch (error) {
-                    hotMeshClient.engine.logger.error('durable-client-search-err', {
+                    hotMeshClient.engine.logger.error('meshflow-client-search-err', {
                         ...error,
                     });
                     throw error;
@@ -153,7 +153,7 @@ class ClientService {
                 await hotMesh.activate(version);
             }
             catch (error) {
-                hotMesh.engine.logger.error('durable-client-activate-err', { error });
+                hotMesh.engine.logger.error('meshflow-client-activate-err', { error });
                 throw error;
             }
         }
@@ -163,7 +163,7 @@ class ClientService {
                 await hotMesh.activate(version);
             }
             catch (error) {
-                hotMesh.engine.logger.error('durable-client-deploy-activate-err', {
+                hotMesh.engine.logger.error('meshflow-client-deploy-activate-err', {
                     ...error,
                 });
                 throw error;

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

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

package/build/services/meshflow/schemas/factory.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.APP_ID = exports.APP_VERSION = exports.getWorkflowYAML = void 0;
 const APP_VERSION = '4';
 exports.APP_VERSION = APP_VERSION;
-const APP_ID = 'durable';
+const APP_ID = 'meshflow';
 exports.APP_ID = APP_ID;
 const getWorkflowYAML = (app, version) => {
     return `app:

package/build/services/meshflow/search.js

@@ -53,7 +53,7 @@ class Search {
                 await store.exec('FT.CREATE', `${search.index}`, 'ON', 'HASH', 'PREFIX', prefixes.length.toString(), ...prefixes, 'SCHEMA', ...schema);
             }
             catch (error) {
-                hotMeshClient.engine.logger.info('durable-client-search-err', {
+                hotMeshClient.engine.logger.info('meshflow-client-search-err', {
                     ...error,
                 });
             }
@@ -66,7 +66,7 @@ class Search {
             return searchIndexes;
         }
         catch (error) {
-            hotMeshClient.engine.logger.info('durable-client-search-list-err', {
+            hotMeshClient.engine.logger.info('meshflow-client-search-list-err', {
                 ...error,
             });
             return [];
@@ -104,7 +104,7 @@ class Search {
             return value;
         }
         catch (error) {
-            this.hotMeshClient.logger.error('durable-search-get-error', { ...error });
+            this.hotMeshClient.logger.error('meshflow-search-get-error', { ...error });
             return '';
         }
     }
@@ -134,7 +134,7 @@ class Search {
             return returnValues;
         }
         catch (error) {
-            this.hotMeshClient.logger.error('durable-search-mget-error', {
+            this.hotMeshClient.logger.error('meshflow-search-mget-error', {
                 ...error,
             });
             return [];

package/build/services/meshflow/worker.js

@@ -21,7 +21,7 @@ class WorkerService {
                 await hotMesh.activate(factory_1.APP_VERSION);
             }
             catch (err) {
-                hotMesh.engine.logger.error('durable-worker-deploy-activate-err', err);
+                hotMesh.engine.logger.error('meshflow-worker-deploy-activate-err', err);
                 throw err;
             }
         }
@@ -30,7 +30,7 @@ class WorkerService {
                 await hotMesh.activate(factory_1.APP_VERSION);
             }
             catch (err) {
-                hotMesh.engine.logger.error('durable-worker-activate-err', err);
+                hotMesh.engine.logger.error('meshflow-worker-activate-err', err);
                 throw err;
             }
         }
@@ -81,7 +81,7 @@ class WorkerService {
         }
     }
     async run() {
-        this.workflowRunner.engine.logger.info('durable-worker-running');
+        this.workflowRunner.engine.logger.info('meshflow-worker-running');
     }
     async initActivityWorker(config, activityTopic) {
         const redisConfig = {
@@ -121,7 +121,7 @@ class WorkerService {
                 };
             }
             catch (err) {
-                this.activityRunner.engine.logger.error('durable-worker-activity-err', {
+                this.activityRunner.engine.logger.error('meshflow-worker-activity-err', {
                     name: err.name,
                     message: err.message,
                     stack: err.stack,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hotmeshio/hotmesh",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "description": "Unbreakable Workflows",
   "main": "./build/index.js",
   "types": "./build/index.d.ts",

package/types/meshdata.ts

@@ -36,9 +36,10 @@ export type CallOptions = {
    */
   fields?: string[];
   /**
-   * namespace for the the execution client; how it appears in Redis (defaults to 'durable')
+   * namespace for the the execution client
+   * @default 'meshflow'
    */
-  namespace?: string; //optional namespace for the workflowId (defaults to 'durable')
+  namespace?: string;
 
   /**
    * Custom marker data field used for adding a searchable marker to the job.
@@ -72,9 +73,10 @@ export type ConnectOptions = {
    */
   prefix?: string;
   /**
-   * optional namespace for the the worker; how it appears in Redis (defaults to 'durable')
+   * optional namespace for the the worker
+   * @default 'meshflow'
    */
-  namespace?: string; //optional namespace for the workflowId (defaults to 'durable')
+  namespace?: string;
   /**
    * extended worker options
    */
@@ -175,7 +177,7 @@ export type HookInput = {
 
 export type MeshDataWorkflowOptions = {
   /**
-   * The app deployment namespace; how it appears in redis (e.g., 'durable')
+   * The app deployment namespace; how it appears in redis (e.g., 'meshflow')
    */
   namespace?: string;
 
@@ -225,7 +227,7 @@ export type MeshDataWorkflowOptions = {
   config?: WorkflowConfig;
 
   /**
-   * Set to 'infinity' to make the function durable; otherwise, '1 minute', '1 hour', etc
+   * Set to 'infinity', '1 minute', '1 hour', etc
    */
   ttl?: string;
 

package/types/meshflow.ts

@@ -65,7 +65,8 @@ type WorkflowContext = {
   replay: StringStringType;
 
   /**
-   * the HotMesh App namespace. `durable` is the default.
+   * the HotMesh App namespace
+   * @default meshflow
    */
   namespace: string;
 
@@ -252,7 +253,8 @@ type SearchResults = {
 
 type WorkflowOptions = {
   /**
-   * the namespace for the workflow; `durable` is the default namespace if not provided
+   * the namespace for the workflow
+   * @default meshflow
    */
   namespace?: string;
 
@@ -358,7 +360,8 @@ type WorkflowOptions = {
 
 /**
  * Options for setting up a hook.
- * 'durable' is the default namespace if not provided; similar to setting `appid` in the YAML
+ * 'meshflow' is the default namespace if not provided;
+ * similar to setting `appid` in the YAML
  */
 type HookOptions = {
   /** Optional namespace under which the hook function will be grouped */
@@ -450,8 +453,8 @@ type WorkerConfig = {
   connection: Connection;
 
   /**
-   * Namespace used in the app configuration, denoted as `appid` in the YAML (e.g., 'durable')
-   * @default durable
+   * Namespace used in the app configuration, denoted as `appid` in the YAML
+   * @default meshflow
    */
   namespace?: string;
 
@@ -505,7 +508,10 @@ type FindJobsOptions = {
   /** The workflow name; include an asterisk for wilcard search; refer to Redis SCAN for the allowed format */
   match?: string;
 
-  /** application namespace; defaults to 'durable' */
+  /**
+   * application namespace
+   * @default meshflow
+  */
   namespace?: string;
 
   /** The suggested response limit. Reduce batch size to reduce the likelihood of large overages. */