codehooks-js 1.3.14 → 1.3.15

package/README.md

@@ -1,10 +1,11 @@
-# codehooks-js 
+# codehooks-js
 
 The official JavaScript/TypeScript library for [Codehooks.io](https://codehooks.io) - a serverless backend platform that provides everything you need to build and deploy backend applications.
 
 ## What is Codehooks.io?
 
 Codehooks.io is a complete serverless backend platform that combines:
+
 - **Database** - NoSQL document storage with MongoDB-like queries
 - **API Server** - Express.js-style routing and middleware
 - **Background Jobs** - Queues, workers, and scheduled tasks
@@ -16,7 +17,7 @@ All in one platform with zero infrastructure management.
 
 ## Quick Start
 
-Install the [Codehooks CLI](https://codehooks.io/docs/cli): 
+Install the [Codehooks CLI](https://codehooks.io/docs/cli):
 
 ```shell
 $ npm install -g codehooks
@@ -34,59 +35,65 @@ Example code for a serverless backend API and NoSQL database:
 
 ```javascript
 /*
-* REST API with NoSQL database storage.
-* Codehooks (c) example code.
-*/
+ * REST API with NoSQL database storage.
+ * Codehooks (c) example code.
+ */
 
-import {app, datastore} from 'codehooks-js';
+import { app, datastore } from 'codehooks-js';
 
 // Example GET route and a NoSQL database insert operation
 app.get('/myroute', async (req, res) => {
-  console.log("GET")
-  const conn = await datastore.open()    
-  const doc = await conn.insertOne('greetings', {"message": "Hello World!", "when": new Date()})
-  res.json({...doc})
+  console.log('GET');
+  const conn = await datastore.open();
+  const doc = await conn.insertOne('greetings', {
+    message: 'Hello World!',
+    when: new Date(),
+  });
+  res.json({ ...doc });
 });
 
 // Serve web content from the uploaded directory /static
-app.static({directory: "/static"})
+app.static({ directory: '/static' });
 
 // CRUD REST API for any collection
-app.crudlify({}, {prefix: "/"})
+app.crudlify({}, { prefix: '/' });
 
 // return app to serverless runtime engine
-export default app.init()
+export default app.init();
 ```
 
 ## TypeScript development
 
 Rename the index.js to index.ts or create a new index.ts file.
-Start developing using TypeScript and strong types shown in the example code below. 
+Start developing using TypeScript and strong types shown in the example code below.
 
 ```typescript
 /*
-* REST API with NoSQL database storage.
-* Codehooks (c) example code in TypeScript.
-*/
+ * REST API with NoSQL database storage.
+ * Codehooks (c) example code in TypeScript.
+ */
 
-import {app, datastore, httpResponse, httpRequest} from 'codehooks-js';
+import { app, datastore, httpResponse, httpRequest } from 'codehooks-js';
 
 // Example GET route and a NoSQL database insert operation
 app.get('/myroute', async (req: httpRequest, res: httpResponse) => {
-  console.log("GET")
-  const conn = await datastore.open()    
-  const doc = await conn.insertOne('greetings', {"message": "Hello World!", "when": new Date()})
-  res.json({...doc})
+  console.log('GET');
+  const conn = await datastore.open();
+  const doc = await conn.insertOne('greetings', {
+    message: 'Hello World!',
+    when: new Date(),
+  });
+  res.json({ ...doc });
 });
 
 // Serve web content from the uploaded directory /static
-app.static({directory: "/static"})
+app.static({ directory: '/static' });
 
 // CRUD REST API for any collection
-app.crudlify({}, {prefix: "/"})
+app.crudlify({}, { prefix: '/' });
 
 // return app to serverless runtime engine
-export default app.init()
+export default app.init();
 ```
 
 ## Compile
@@ -95,16 +102,11 @@ When running the `coho compile` command, it will automatically create a `tsconfi
 
 ```json
 {
-    "files": [
-        "./index.ts"
-    ],
-    "compilerOptions": {
-        "allowJs": true,
-        "lib": [
-            "ES6",
-            "dom"
-        ]
-    }
+  "files": ["./index.ts"],
+  "compilerOptions": {
+    "allowJs": true,
+    "lib": ["ES6", "dom"]
+  }
 }
 ```
 
@@ -131,7 +133,8 @@ Your backend application is now available at your project's endpoint URL. For ex
 
 ## Deploy
 
-From the project directory run: 
+From the project directory run:
+
 ```shell
 $ codehooks deploy
 ```
@@ -147,44 +150,50 @@ For complete documentation, visit [https://codehooks.io/docs](https://codehooks.
 The Codehooks class provides a comprehensive backend application framework with the following APIs:
 
 ### **HTTP Routing APIs**
+
 - **`post(path, ...hook)`** - Register POST route handlers
-- **`get(path, ...hook)`** - Register GET route handlers  
+- **`get(path, ...hook)`** - Register GET route handlers
 - **`put(path, ...hook)`** - Register PUT route handlers
 - **`patch(path, ...hook)`** - Register PATCH route handlers
 - **`delete(path, ...hook)`** - Register DELETE route handlers
 - **`all(path, ...hook)`** - Register handlers for all HTTP methods
 
 ### **Middleware & Authentication APIs**
+
 - **`use(...hook)`** - Register global middleware (supports string paths, RegExp, or function)
 - **`useRoute(route, ...hook)`** - Register route-specific middleware
 - **`auth(path, ...hook)`** - Register authentication middleware for specific paths
 
 ### **Background Processing APIs**
+
 - **`queue(topic, ...hook)`** - Register queue handlers for background processing
 - **`worker(name, ...hook)`** - Register worker functions (also adds to queues for legacy support)
 - **`job(cronExpression, ...hook)`** - Register scheduled cron jobs
 
 ### **Static File Serving APIs**
+
 - **`static(options, hook)`** - Serve static files from source code directory
 - **`storage(options, hook)`** - Serve files from blob storage directory
 
 ### **Template & Configuration APIs**
+
 - **`set(key, val)`** - Set application configuration settings
 - **`render(view, data, cb)`** - Render templates with data
 - **`crudlify(schema, options)`** - Auto-generate CRUD REST API endpoints
 
 ### **Real-time Communication APIs**
+
 - **`realtime(path, ...hook)`** - Set up server-sent events (SSE) channels for real-time communication
 
 ### **Workflow Management APIs**
+
 - **`createWorkflow(name, description, steps, options)`** - Create and register a new workflow instance
 
 ### **Application Lifecycle APIs**
+
 - **`init(hook)`** - Initialize the application and return manifest
 - **`start(hook)`** - Alias for `init()` method
 
-
-
 The Codehooks class serves as a comprehensive backend application framework that combines HTTP routing, background processing, real-time communication, and workflow management capabilities in a single, cohesive API.
 
 ## Datastore API Reference
@@ -192,18 +201,21 @@ The Codehooks class serves as a comprehensive backend application framework that
 The Datastore provides a unified interface for both NoSQL document storage and Key-Value operations. It supports MongoDB-like query syntax and provides streaming capabilities for large datasets.
 
 ### **Connection & Collection Management**
+
 - **`open()`** - Connect to the Datastore and return the API interface
 - **`collection(name)`** - Get a NoSQL collection by name for document operations
 
 ### **NoSQL Document Operations**
 
 #### **Read Operations**
+
 - **`getOne(collection, query)`** - Get a single document by ID or query
 - **`findOne(collection, query)`** - Alias for getOne
 - **`getMany(collection, query?, options?)`** - Get a stream of documents matching query
 - **`find(collection, query?, options?)`** - Alias for getMany
 
 #### **Write Operations**
+
 - **`insertOne(collection, document)`** - Insert a new document into a collection
 - **`updateOne(collection, query, document, updateOperators?, options?)`** - Update one document (patches existing data)
 - **`updateMany(collection, query, document, updateOperators?)`** - Update multiple documents
@@ -211,32 +223,38 @@ The Datastore provides a unified interface for both NoSQL document storage and K
 - **`replaceMany(collection, query, document, options?)`** - Replace multiple documents
 
 #### **Delete Operations**
+
 - **`removeOne(collection, query)`** - Remove one document by ID or query
 - **`removeMany(collection, query)`** - Remove multiple documents matching query
 
 #### **Schema Management**
+
 - **`createSchema(collection, schema)`** - Validate collection data against JSON-Schema
 - **`setSchema(collection, schema)`** - Alias for createSchema
 - **`removeSchema(collection)`** - Remove JSON-schema validation for collection
 - **`getSchema(collection)`** - Get JSON-schema for collection
 
 #### **Utility Operations**
+
 - **`count(collection)`** - Count documents in a collection
 
 ### **Key-Value Operations**
 
 #### **Basic Key-Value Operations**
+
 - **`set(key, value, options?)`** - Set a key-value pair
 - **`get(key, options?)`** - Get a value by key
 - **`getAll(keyPattern, options?)`** - Get all key-value pairs matching pattern
-- **`del(key, value)`** - Delete a key-value pair
+- **`del(key, options?)`** - Delete a key-value pair
 - **`delAll(keyPattern, options?)`** - Delete all key-value pairs matching pattern
 
 #### **Numeric Operations**
+
 - **`incr(key, value, options?)`** - Increment a numeric value
 - **`decr(key, value, options?)`** - Decrement a numeric value
 
 ### **Queue Operations**
+
 - **`enqueue(topic, document, options?)`** - Add a job to a queue for background processing
 - **`enqueueFromQuery(collection, query, topic, options?)`** - Queue each item from a database query
 
@@ -258,7 +276,10 @@ import { datastore } from 'codehooks-js';
 const conn = await datastore.open();
 
 // NoSQL operations
-const doc = await conn.insertOne('users', { name: 'John', email: 'john@example.com' });
+const doc = await conn.insertOne('users', {
+  name: 'John',
+  email: 'john@example.com',
+});
 const user = await conn.getOne('users', { _id: doc._id });
 const users = await conn.getMany('users', { active: true }).toArray();
 await conn.updateOne('users', { _id: doc._id }, { lastLogin: new Date() });
@@ -269,7 +290,10 @@ const session = await conn.get('user:123:session');
 await conn.incr('visits', 1);
 
 // Queue operations
-await conn.enqueue('emailWorker', { to: 'user@example.com', template: 'welcome' });
+await conn.enqueue('emailWorker', {
+  to: 'user@example.com',
+  template: 'welcome',
+});
 ```
 
 ### **Query Syntax**
@@ -278,22 +302,48 @@ The Datastore supports MongoDB-like query syntax:
 
 ```javascript
 // Simple equality
-{ status: 'active' }
+{
+  status: 'active';
+}
 
 // Comparison operators
-{ age: { $gt: 18 } }
-{ price: { $lte: 100 } }
+{
+  age: {
+    $gt: 18;
+  }
+}
+{
+  price: {
+    $lte: 100;
+  }
+}
 
 // Logical operators
-{ $and: [{ status: 'active' }, { age: { $gte: 18 } }] }
-{ $or: [{ category: 'A' }, { category: 'B' }] }
+{
+  $and: [{ status: 'active' }, { age: { $gte: 18 } }];
+}
+{
+  $or: [{ category: 'A' }, { category: 'B' }];
+}
 
 // Array operations
-{ tags: { $in: ['javascript', 'nodejs'] } }
-{ tags: { $all: ['javascript', 'nodejs'] } }
+{
+  tags: {
+    $in: ['javascript', 'nodejs'];
+  }
+}
+{
+  tags: {
+    $all: ['javascript', 'nodejs'];
+  }
+}
 
 // Regular expressions
-{ name: { $regex: /john/i } }
+{
+  name: {
+    $regex: /john/i;
+  }
+}
 ```
 
 ### **Options**
@@ -302,14 +352,20 @@ Many operations accept an options object for additional configuration:
 
 ```javascript
 // Upsert option for updates
-await conn.updateOne('users', { email: 'john@example.com' }, 
-  { lastLogin: new Date() }, {}, { upsert: true });
+await conn.updateOne(
+  'users',
+  { email: 'john@example.com' },
+  { lastLogin: new Date() },
+  {},
+  { upsert: true }
+);
 
 // Key-Value options
 await conn.set('key', 'value', { ttl: 3600000 }); // 1 hour TTL
 ```
 
 ### **Key Features:**
+
 1. **Express-style routing** with support for all HTTP methods
 2. **Middleware system** with global and route-specific middleware
 3. **Background processing** with queues, workers, and scheduled jobs

package/package.json

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

package/types/index.d.ts

@@ -401,7 +401,7 @@ export type DatastoreAPI = {
   /**
    * - Delete a key-value pair in the current Datastore
    */
-  del: (key: string, value: object) => Promise<any>;
+  del: (key: string, options?: object) => Promise<any>;
   /**
    * - Delete a range of key-value pairs in the current Datastore
    */
@@ -466,11 +466,11 @@ export type DatastoreAPI = {
    * @returns Promise with result
    */
   getSchema: (collection: string) => Promise<object>;
-   /**
-   * Count database collection items
-   * @returns Promise result
-   */
-   count: (collection: string) => Promise<object>;
+  /**
+  * Count database collection items
+  * @returns Promise result
+  */
+  count: (collection: string) => Promise<object>;
 };
 /**
  * Persistent NoSql and Kev-Value datastore
@@ -956,8 +956,8 @@ export class Codehooks {
    *  })
    * @returns void
    */
-  static: (options: any, 
-      ...hook: ((
+  static: (options: any,
+    ...hook: ((
       request: httpRequest,
       response: httpResponse,
       next: nextFunction
@@ -967,12 +967,12 @@ export class Codehooks {
    * @param {Object} options - {route: "/documents", directory: "/docs"}
    * @returns void
    */
-  storage: (options: any, 
+  storage: (options: any,
     ...hook: ((
-    request: httpRequest,
-    response: httpResponse,
-    next: nextFunction
-  ) => any)[]) => void;
+      request: httpRequest,
+      response: httpResponse,
+      next: nextFunction
+    ) => any)[]) => void;
   /**
    * Configuration settings
    * @param {string} key
@@ -1067,31 +1067,31 @@ export type WorkflowEvents = {
    * @event
    */
   'workflowCreated': { name: string; description: string };
-  
+
   /**
    * Emitted when a new workflow instance is started
    * @event
    */
   'workflowStarted': { name: string; initialState: any };
-  
+
   /**
    * Emitted when a step begins execution
    * @event
    */
   'stepStarted': { workflowName: string; step: string; state: any; instanceId: string };
-  
+
   /**
    * Emitted when a step's state is updated
    * @event
    */
   'stateUpdated': { workflowName: string; state: any; instanceId: string };
-  
+
   /**
    * Emitted when a step is enqueued for execution
    * @event
    */
   'stepEnqueued': { workflowName: string; step: string; state: any; instanceId: string };
-  
+
   /**
    * Emitted when a workflow instance is continued after waiting
    * @event
@@ -1103,7 +1103,7 @@ export type WorkflowEvents = {
    * @event
    */
   'completed': { message: string; state: any };
-  
+
   /**
    * Emitted when a workflow instance is cancelled
    * @event
@@ -1121,9 +1121,9 @@ export type WorkflowEvents = {
  * Definition of a workflow step function
  */
 export type WorkflowDefinition = Record<string, (
-    state: any, 
-    callback: (nextStep: string | string[] | null, newState: any, options?: any) => void,
-    waiterFunction?: (waiter?: any) => void
+  state: any,
+  callback: (nextStep: string | string[] | null, newState: any, options?: any) => void,
+  waiterFunction?: (waiter?: any) => void
 ) => Promise<void>>;
 
 /**
@@ -1255,14 +1255,14 @@ export type Workflow = {
    * @returns Promise with the registered workflow name
    */
   register: (app: Codehooks) => Promise<string>;
-  
+
   /**
    * Start a new workflow instance
    * @param initialState - Initial state for the workflow instance
    * @returns Promise with the workflow instance
    */
   start: (initialState: any) => Promise<any>;
-  
+
   /**
    * Update the state of a workflow instance
    * @param instanceId - ID of the workflow instance
@@ -1271,7 +1271,7 @@ export type Workflow = {
    * @returns Promise with the updated state
    */
   updateState: (instanceId: string, state: any, options?: UpdateOptions) => Promise<any>;
-  
+
   /**
    * Set the complete state of a workflow instance
    * @param instanceId - ID of the workflow instance
@@ -1279,7 +1279,7 @@ export type Workflow = {
    * @returns Promise<void>
    */
   setState: (instanceId: string, stateData: { _id: string; state: any }) => Promise<void>;
-  
+
   /**
    * Continue a paused workflow instance
    * @param instanceId - ID of the workflow instance
@@ -1287,21 +1287,21 @@ export type Workflow = {
    * @returns Promise with the queue ID for the continued step
    */
   continue: (instanceId: string, reset?: boolean) => Promise<{ instanceId: string }>;
-  
+
   /**
    * Get the status of a workflow instance
    * @param id - ID of the workflow instance
    * @returns Promise with the workflow status
    */
   getStepsStatus: (id: string) => Promise<any>;
-  
+
   /**
    * Get all workflow instances matching a filter
    * @param filter - Filter criteria for workflows
    * @returns Promise with list of workflow instances
    */
   getInstances: (filter: any) => Promise<any[]>;
-  
+
   /**
    * Cancel a workflow instance
    * @param id - ID of the workflow instance to cancel
@@ -1319,21 +1319,21 @@ export type Workflow = {
    * });
    */
   on: (event: WorkflowEvent, listener: (data: WorkflowEventData) => void) => Workflow;
-  
+
   /**
    * Register a one-time event listener
    * @param event - Name of the event to listen for
    * @param listener - Callback function to handle the event
    */
   once: (event: WorkflowEvent, listener: (data: WorkflowEventData) => void) => Workflow;
-  
+
   /**
    * Remove an event listener
    * @param event - Name of the event
    * @param listener - Callback function to remove
    */
   off: (event: WorkflowEvent, listener: (data: WorkflowEventData) => void) => Workflow;
-  
+
   /**
    * Emit an event
    * @param event - Name of the event to emit
@@ -1345,7 +1345,7 @@ export type Workflow = {
    * Continue all timed out workflow instances
    * @returns Promise with array of results containing queue IDs for continued workflows
    */
-  continueAllTimedOut: () => Promise<Array<{instanceId: string}>>;
+  continueAllTimedOut: () => Promise<Array<{ instanceId: string }>>;
 
   /**
    * Check if a specific step in a workflow instance has timed out
@@ -1427,7 +1427,7 @@ export type UpdateOptions = {
 /**
  * Workflow event types
  */
-export type WorkflowEvent = 
+export type WorkflowEvent =
   | 'workflowCreated'
   | 'workflowStarted'
   | 'workflowContinued'