codehooks-js 1.3.22 → 1.3.24

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "codehooks-js",
-  "version": "1.3.22",
+  "version": "1.3.24",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",
@@ -22,7 +22,8 @@
     "tsconfig.json"
   ],
   "scripts": {
-    "test": "echo \"Warning: no tests specified\""
+    "test": "echo \"Warning: no tests specified\"",
+    "generate-monaco-types": "node scripts/generate-monaco-types.cjs"
   },
   "author": "Codehooks",
   "license": "ISC",

package/types/index.d.ts

@@ -198,13 +198,19 @@ export type keyvalOptions = {
  */
 export type NoSQLAPI = {
   /**
-   * - Get object by ID, returns a Promise with the object
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object
+   * @throws {Error} Rejects if the object is not found
    */
   getOne: (query: string | object) => Promise<object>;
   /**
-   * - Get object by ID, returns a Promise with the object - alias for getOne
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object - alias for getOne
+   * @throws {Error} Rejects if the object is not found
    */
   findOne: (query: string | object) => Promise<object>;
+  /**
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object or null if not found
+   */
+  findOneOrNull: (query: string | object) => Promise<object | null>;
   /**
    * - Get stream of objects by query
    * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
@@ -306,7 +312,7 @@ export type DatastoreAPI = {
    */
   collection: (collection: string) => NoSQLAPI;
   /**
-   * - Get object by ID, returns a Promise with the object
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object
    */
   getOne: (collection: string, query: string | object) => Promise<any>;
   /**
@@ -315,9 +321,13 @@ export type DatastoreAPI = {
    */
   getMany: (collection: string, query?: object, options?: object) => DataStream;
   /**
-   * - Get object by ID, returns a Promise with the object (alias for getOne)
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object (alias for getOne)
    */
   findOne: (collection: string, query: string | object) => Promise<any>;
+  /**
+   * - Get object by ID (objectID) or query (NoSQL query {...}), returns a Promise with the object or null if not found
+   */
+  findOneOrNull: (collection: string, query: string | object) => Promise<any>;
   /**
    * - Alias for getMany
    * https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options

package/workflow/engine.mjs

@@ -165,6 +165,16 @@ class Workflow extends EventEmitter {
         return stepConfig?.workers ?? this.#defaultStepOptions.workers ?? 1;
     }
 
+    /**
+     * Get the timeout for a specific step
+     * @param {string} stepName - Name of the step
+     * @returns {number} The timeout in milliseconds for the step
+     */
+    getTimeoutForStep(stepName) {
+        const stepConfig = this.#steps[stepName];
+        return stepConfig?.timeout ?? this.#defaultStepOptions.timeout ?? this.#timeout;
+    }
+
     /**
      * Set the default number of workers for steps
      * @param {number} workers - Number of workers
@@ -185,6 +195,26 @@ class Workflow extends EventEmitter {
         return this.#defaultStepOptions.workers;
     }
 
+    /**
+     * Set the default timeout for steps
+     * @param {number} timeout - Timeout in milliseconds
+     * @throws {Error} If timeout is not a positive number
+     */
+    setDefaultTimeout(timeout) {
+        if (typeof timeout !== 'number' || timeout <= 0) {
+            throw new Error('Timeout must be a positive number');
+        }
+        this.#defaultStepOptions.timeout = timeout;
+    }
+
+    /**
+     * Get the default timeout for steps
+     * @returns {number} The default timeout in milliseconds
+     */
+    getDefaultTimeout() {
+        return this.#defaultStepOptions.timeout;
+    }
+
     /**
      * Configure the steps engine
      * @param {Object} config - Configuration object
@@ -204,6 +234,7 @@ class Workflow extends EventEmitter {
         }
         if (config.timeout) {
             this.setTimeout(config.timeout);
+            this.setDefaultTimeout(config.timeout);
         }
         if (config.maxStepCount) {
             this.setMaxStepCount(config.maxStepCount);
@@ -405,7 +436,7 @@ class Workflow extends EventEmitter {
                                         state: mergedState,
                                         options: options,
                                         instanceId: instanceId
-                                    }, { workers: this.getWorkersForStep(step) });
+                                    }, { workers: this.getWorkersForStep(step), timeout: this.getTimeoutForStep(step) });
                                 }
                             } else {
                                 console.debug('enqueue step', nextStep, instanceId);
@@ -415,7 +446,7 @@ class Workflow extends EventEmitter {
                                     state: mergedState,
                                     options: options,
                                     instanceId: instanceId
-                                }, { workers: this.getWorkersForStep(nextStep) });
+                                }, { workers: this.getWorkersForStep(nextStep), timeout: this.getTimeoutForStep(nextStep) });
                             }
                             this.emit('stepEnqueued', { workflowName: stepsName, step: nextStep, state: newState, instanceId });
                             resolve();
@@ -469,6 +500,7 @@ class Workflow extends EventEmitter {
         // Log current configuration state at registration time
         console.debug('Workflow registration config:', {
             defaultWorkers: this.#defaultStepOptions.workers,
+            defaultTimeout: this.#defaultStepOptions.timeout,
             stepsConfig: this.#steps
         });
 
@@ -478,7 +510,8 @@ class Workflow extends EventEmitter {
                 // Skip null, undefined, or invalid step names
                 if (stepName !== undefined && stepName !== null && stepName !== 'null' && stepName.trim() !== '') {
                     const workerCount = this.getWorkersForStep(stepName);
-                    console.debug('registering queue for step', `${this.#queuePrefix}_${name}_${stepName}`, { workers: workerCount, stepConfig: this.#steps[stepName] });
+                    const timeoutMs = this.getTimeoutForStep(stepName);
+                    console.debug('registering queue for step', `${this.#queuePrefix}_${name}_${stepName}`, { workers: workerCount, timeout: timeoutMs, stepConfig: this.#steps[stepName] });
                     app.worker(`${this.#queuePrefix}_${name}_${stepName}`, async (req, res) => {
                         try {
                             const { stepsName, goto, state, instanceId, options } = req.body.payload;
@@ -499,7 +532,7 @@ class Workflow extends EventEmitter {
                             //console.debug('Worker res.end', stepName);
                             res.end();
                         }
-                    }, { workers: workerCount });
+                    }, { workers: workerCount, timeout: timeoutMs });
                 }
             } catch (error) {
                 console.error(`Invalid step definition '${stepName}': ${error.message}`);
@@ -550,7 +583,7 @@ class Workflow extends EventEmitter {
                     state: newState,
                     instanceId: newState._id,
                     options: {}
-                }, { workers: this.getWorkersForStep(firstStepName) });
+                }, { workers: this.getWorkersForStep(firstStepName), timeout: this.getTimeoutForStep(firstStepName) });
                 resolve(newState);
             } catch (error) {
                 console.error('Error starting workflow:', error.message);
@@ -631,7 +664,7 @@ class Workflow extends EventEmitter {
                 state: state,
                 options: {},
                 instanceId: instanceId
-            }, { workers: this.getWorkersForStep(state.nextStep) });
+            }, { workers: this.getWorkersForStep(state.nextStep), timeout: this.getTimeoutForStep(state.nextStep) });
 
             resolve({ instanceId });
         });
@@ -751,10 +784,9 @@ class Workflow extends EventEmitter {
 
         const step = workflow.stepCount[stepToCheck];
 
-        // Get the timeout value for this step
-        // First try step-specific config, then default options, finally fallback to global timeout
+        // Get the timeout value for this step using the helper method
         const stepConfig = this.#steps[stepToCheck];
-        const stepTimeout = stepConfig?.timeout ?? this.#defaultStepOptions.timeout ?? this.#timeout;
+        const stepTimeout = this.getTimeoutForStep(stepToCheck);
 
         // If the step hasn't finished, check if it's been running too long
         console.debug('isStepTimedOut', stepToCheck, stepTimeout);
@@ -770,7 +802,7 @@ class Workflow extends EventEmitter {
                 step: stepToCheck,
                 startTime: step.startTime,
                 currentTime: now.toISOString(),
-                timeoutSource: stepConfig ? 'stepConfig' : (this.#defaultStepOptions.timeout ? 'defaultOptions' : 'globalTimeout')
+                timeoutSource: stepConfig?.timeout ? 'stepConfig' : (this.#defaultStepOptions.timeout !== 30000 ? 'defaultOptions' : 'globalTimeout')
             };
         }
 
@@ -786,7 +818,7 @@ class Workflow extends EventEmitter {
             step: stepToCheck,
             startTime: step.startTime,
             finishTime: step.finishTime,
-            timeoutSource: stepConfig ? 'stepConfig' : (this.#defaultStepOptions.timeout ? 'defaultOptions' : 'globalTimeout')
+            timeoutSource: stepConfig?.timeout ? 'stepConfig' : (this.#defaultStepOptions.timeout !== 30000 ? 'defaultOptions' : 'globalTimeout')
         };
     }