codehooks-js 1.3.0 → 1.3.2

package/index.js

@@ -1,7 +1,7 @@
 import {agg} from './aggregation/index.mjs';
 import {crudlify as crud} from './crudlify/index.mjs';
 import {serveStatic as ws, render as renderView} from './webserver.mjs';
-import {Steps, StepsConfig} from './workflow/index.mjs';
+import {Steps as Workflow, StepsConfig as WorkflowConfig} from './workflow/index.mjs';
 
 function createRoute(str) {
   if(str instanceof RegExp) {
@@ -117,9 +117,9 @@ class Codehooks {
     })
   }
   
-  createSteps = (name, description, steps, options={}) => {
-    Steps.register(this, name, description, steps, options);
-    return Steps;
+  createWorkflow = (name, description, steps, options={}) => {
+    Workflow.register(this, name, description, steps, options);
+    return Workflow;
   }
 
   init = (hook) => {
@@ -193,10 +193,10 @@ export const aggregation = agg;
 export const crudlify = crud;
 export const coho = _coho;
 export const app = _coho;
-export const stepsconfig = StepsConfig;
+export const workflowconfig = WorkflowConfig;
 export {
-  Steps,
-  StepsConfig
+  Workflow,
+  WorkflowConfig
 };
 export const realtime = {
   createChannel: (path, ...hook) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codehooks-js",
-  "version": "1.3.0",
+  "version": "1.3.2",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",

package/types/index.d.ts

@@ -4,7 +4,7 @@ export const aggregation: typeof agg;
 export const crudlify: typeof crud;
 export const coho: Codehooks;
 export const app: Codehooks;
-export const stepsconfig: {
+export const workflowconfig: {
     setCollectionName: any;
     setQueuePrefix: any;
 };
@@ -62,7 +62,7 @@ declare class Codehooks {
     set: (key: any, val: any) => void;
     render: (view: any, data: any, cb: any) => Promise<void>;
     crudlify: (schema?: {}, options?: {}) => Promise<import("./crudlify/lib/eventhooks.mjs").EventHooks>;
-    createSteps: (name: any, description: any, steps: any, options?: {}) => {
+    createWorkflow: (name: any, description: any, steps: any, options?: {}) => {
         definitions: Map<any, any>;
         getDefinition(stepsName: string, stepName: string): Function;
         validateStepDefinition(step: Function): void;
@@ -77,7 +77,7 @@ declare class Codehooks {
             qId: string;
         }>;
         getStepsStatus(id: string): Promise<any>;
-        listSteps(filter: any): Promise<any[]>;
+        getInstances(filter: any): Promise<any[]>;
         cancelSteps(id: string): Promise<any>;
         [EventEmitter.captureRejectionSymbol]?<K>(error: Error, event: string | symbol, ...args: any[]): void;
         addListener<K>(eventName: string | symbol, listener: (...args: any[]) => void): any;
@@ -124,7 +124,7 @@ declare class Codehooks {
     };
     addListener: (observer: any) => void;
 }
-import { Steps } from './workflow/index.mjs';
-import { StepsConfig } from './workflow/index.mjs';
+import { Steps as Workflow } from './workflow/index.mjs';
+import { StepsConfig as WorkflowConfig } from './workflow/index.mjs';
 declare const _coho: Codehooks;
-export { Steps, StepsConfig };
+export { Workflow, WorkflowConfig };

package/types/workflow/engine.d.mts

@@ -112,7 +112,7 @@ declare class StepsEngine extends EventEmitter<[never]> {
      * @param {Object} filter - Filter criteria for steps workflows
      * @returns {Promise<Array>} List of steps instances
      */
-    listSteps(filter: any): Promise<any[]>;
+    getInstances(filter: any): Promise<any[]>;
     /**
      * Cancel a steps instance
      * @param {string} id - ID of the steps instance to cancel

package/workflow/engine.mjs

@@ -117,7 +117,7 @@ class StepsEngine extends EventEmitter {
             const isFinished = nextStep === null;
 
             // Handle single next step
-            StepsEngine.getInstance().emit('stepStarted', { stepsName, step: nextStep, state: newState, instanceId });
+            StepsEngine.getInstance().emit('stepStarted', { workflowName: stepsName, step: nextStep, state: newState, instanceId });
             const connection = await Datastore.open();
             // remove the _id from the newState
             delete newState._id;
@@ -126,7 +126,7 @@ class StepsEngine extends EventEmitter {
                 { _id: instanceId },
                 { $set: { ...newState, nextStep: nextStep, updatedAt: new Date().toISOString(), isFinished: isFinished } });
             
-            StepsEngine.getInstance().emit('stateUpdated', { stepsName, state: newState, instanceId });
+            StepsEngine.getInstance().emit('stateUpdated', { workflowName: stepsName, state: newState, instanceId });
             
             // Get the next step function
             const func = StepsEngine.getInstance().getDefinition(stepsName, nextStep);
@@ -134,7 +134,7 @@ class StepsEngine extends EventEmitter {
             // Check if the step is waiting for input
             if (options && options.waitForInput === true) {
                 console.log('Steps workflow is paused, waiting for input for at step', nextStep);
-                this.emit('stepWaiting', { stepsName, step: nextStep, instanceId });
+                this.emit('stepWaiting', { workflowName: stepsName, step: nextStep, instanceId });
                 return;
             }
 
@@ -173,7 +173,7 @@ class StepsEngine extends EventEmitter {
                             instanceId: instanceId
                         });
                         
-                        StepsEngine.getInstance().emit('stepEnqueued', { stepsName, step: nextStep, state: newState, instanceId });
+                        StepsEngine.getInstance().emit('stepEnqueued', { workflowName: stepsName, step: nextStep, state: newState, instanceId });
                     } catch (error) {
                         console.log('error', error.message);
                         throw error;
@@ -203,7 +203,7 @@ class StepsEngine extends EventEmitter {
      * @throws {Error} If step definition is invalid
      */
     async register(app, name, description, definition) {
-        StepsEngine.getInstance().emit('stepsRegistered', { name, description });
+        StepsEngine.getInstance().emit('workflowCreated', { name, description });
 
         // Validate each step in the definition
         for (const [stepName, step] of Object.entries(definition)) {
@@ -238,7 +238,7 @@ class StepsEngine extends EventEmitter {
      * @throws {Error} If starting steps fails
      */
     async start(name, initialState) {
-        StepsEngine.getInstance().emit('stepsStarted', { name, initialState });
+        StepsEngine.getInstance().emit('workflowStarted', { name, initialState });
 
         return new Promise(async (resolve, reject) => {
             try {
@@ -316,7 +316,7 @@ class StepsEngine extends EventEmitter {
         }
         
         console.log('continue state', state);
-        StepsEngine.getInstance().emit('stepContinued', { stepsName, step: state.nextStep, instanceId });                    
+        StepsEngine.getInstance().emit('workflowContinued', { stepsName, step: state.nextStep, instanceId });                    
 
         return new Promise(async (resolve, reject) => {
             const { _id: ID } = await connection.enqueue(`${StepsEngine.queuePrefix}`, {
@@ -349,7 +349,7 @@ class StepsEngine extends EventEmitter {
      * @param {Object} filter - Filter criteria for steps workflows
      * @returns {Promise<Array>} List of steps instances
      */
-    async listSteps(filter) {
+    async getInstances(filter) {
         return new Promise(async (resolve, reject) => {
             const connection = await Datastore.open();
             const states = await connection.find(StepsEngine.collectionName, filter).toArray();
@@ -364,7 +364,7 @@ class StepsEngine extends EventEmitter {
      * @returns {Promise<Object>} The cancellation result
      */
     async cancelSteps(id) {
-        StepsEngine.getInstance().emit('stepsCancelled', { id });
+        StepsEngine.getInstance().emit('cancelled', { id });
         return new Promise(async (resolve, reject) => {
             const connection = await Datastore.open();
             const state = await connection.updateOne(StepsEngine.collectionName,