codehooks-js 1.1.11 → 1.2.0

package/README.md

@@ -1,6 +1,6 @@
 # codehooks-js 
 
-Codehooks.io official helper library - provides Express.JS-like syntax for using codehooks.io (and more).
+Codehooks.io official development library - provides Express.JS-like syntax for using codehooks.io.
 
 Read the [Quickstart for developers](https://codehooks.io/docs/quickstart-cli).
 
@@ -8,15 +8,22 @@ For more details navigate to official docs: [https://codehooks.io/docs](https://
 
 ## Install
 
+Install the [Codehooks CLI](https://codehooks.io/docs/cli): 
+
+```shell
+$ npm install -g codehooks
+```
+Next install the codehooks-js NPM package in your project.
+
 ```shell
-npm install codehooks-js -s
+npm install codehooks-js
 ```
 
-## Usage
+## JavaScript ES6 development
 
 Example code for a serverless backend API and NoSQL database:
 
-```
+```javascript
 /*
 * REST API with NoSQL database storage.
 * Codehooks (c) example code.
@@ -42,13 +49,76 @@ app.crudlify({}, {prefix: "/"})
 export default app.init()
 ```
 
-## Deploy
+## 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. 
+
+```typescript
+/*
+* REST API with NoSQL database storage.
+* Codehooks (c) example code in TypeScript.
+*/
+
+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})
+});
+
+// Serve web content from the uploaded directory /static
+app.static({directory: "/static"})
+
+// CRUD REST API for any collection
+app.crudlify({}, {prefix: "/"})
+
+// return app to serverless runtime engine
+export default app.init()
+```
+
+## Compile
+
+When running the `coho compile` command, it will automatically create a `tsconfig.json` file in the project directory. The tsconfig file can be further adapted to your needs, the initial configuration is shown in the example below:
+
+```json
+{
+    "files": [
+        "./index.ts"
+    ],
+    "compilerOptions": {
+        "allowJs": true,
+        "lib": [
+            "ES6",
+            "dom"
+        ]
+    }
+}
+```
+
+Any syntax or type error will be displayed accordingly from the compile command, for example:
 
-Install the [Codehooks CLI](https://codehooks.io/docs/cli): 
 ```shell
-$ npm install -g codehooks
+$ coho compile
+
+🤔 [tsl] ERROR in /Users/jane/projects/tsdemo/index.ts(9,9)
+      TS2345: Argument of type '(req: httpRequest, res: httpResponse) => void' is not assignable to parameter of type 'string'.
 ```
 
+Correcting the errors should ultimately show a successfull compile output, ready for deployment of your backend app.
+
+```shell
+$ coho compile
+
+OK 🙌
+
+```
+
+## Deploy
+
 From the project directory run: 
 ```shell
 $ codehooks deploy

package/aggregation/index.mjs

@@ -1,10 +1,17 @@
 import lodash from 'lodash';
+/**
+* Persistent NoSql and Kev-Value datastore
+* @typedef {Object} DataStream
+* @property {function(string, function(*)):void} on - Emits data, stream.on('data', (data) => //console.debug(data))
+* @property {function(httpResponse):void} json - Pipe datastream to JSON output
+* @property {function():Promise.<object[]>} toArray - Return an array of objects
+*/
 
 /**
  * 
- * @param {ReadableStream} readable - JSON stream
+ * @param {DataStream} readable - JSON stream
  * @param {Object} spec - JSON aggregation spec 
- * @returns Promise with aggregation result
+ * @returns {Promise} with aggregation result
  * @example
  * Spec JSON example:
  * {

package/index.js

@@ -13,32 +13,6 @@ function createRoute(str) {
 }
 
 
-/**
-* getMany options for query filtering, indexes and projections 
-* @typedef {Object} getManyOptions
-* @property {Object} filter - MongoDB query filter. (Read query language docs)
-* @property {string} useIndex - indexed field name. 
-- Indexes are created with CLI, e.g. coho createindex -c sales -i Region
-* @property {string} startIndex - jump into the index
-* @property {string} endIndex - where to end in the index
-* @property {number} limit - how many items to return
-* @property {Object} hints - include or omit fields. 
-- Include fields example: {$fields: {name: 1, address: 1}. 
-- Omit fields example: {$fields: {name: 0, _id_: 0}}
-* @property {number} offset - how many items to skip before returning any
-* @property {boolean} reverse - reverese scan of index, i.e. descending sort
-*/
-
-/**
-* updateMany options
-* @typedef {Object} updateOptions
-* @property {Object} filter - MongoDB query filter. (Read query language docs)
-* @property {string} useIndex - indexed field name. Indexes are created with CLI, 
-- e.g. coho createindex -c sales -i Region
-* @property {string} startIndex - jump into the index
-* @property {string} endIndex - where to end in the index
-*/
-
 /**
 * keyvalOptions
 * @typedef {Object} keyvalOptions
@@ -49,49 +23,55 @@ function createRoute(str) {
 /**
  * NoSQL API
  * @typedef {Object} NoSQLAPI
- * @property {function(objectID.<string|Array.<string>):Promise.<Object>} getOne - Get object by ID, returns a Promise with the object
- * @property {function(getManyOptions):DataStream} getMany - Get stream of objects by query
- * @property {function(getManyOptions):DataStream} find - Get stream of objects by query, alias for getMany
- * @property {function(json.<object>):Promise.<Object>} insertOne - Insert a new data object into a collection in the current Datastore
- * @property {function(objectID.<string>, document.<Object>):Promise.<Object>} updateOne - Update one data object by ID in a datastore collection. 
+ * @see https://codehooks.io/docs/nosql-database-api
+ * @property {function(string|object):Promise.<object>} getOne - Get object by ID, returns a Promise with the object
+ * @property {function(object, object):DataStream} getMany - Get stream of objects by query
+ * @property {function(object, object):DataStream} find - Get stream of objects by query, alias for getMany
+ * @property {function(object):Promise.<object>} insertOne - Insert a new data object into a collection in the current Datastore
+ * @property {function(string|object, object):Promise.<object>} updateOne - Update one data object by ID in a datastore collection. 
  * - Input document is patched with the matched database object
- * @property {function(document.<Object>, updateOptions):Promise.<Object>} updateMany - Update multiple data objects in a datastore collection. 
+ * @property {function(object, object):Promise.<object>} updateMany - Update multiple data objects in a datastore collection. 
  * - Input document is patched with the matched database objects
- * @property {function(objectID.<string>, document.<Object>):Promise.<Object>} replaceOne - Replace one data object by ID in a datastore collection. 
+ * @property {function(string|object, object):Promise.<object>} replaceOne - Replace one data object by ID in a datastore collection. 
  * - Input document overwrites the matched database object, the _id value is not overwritten. 
- * @property {function(document.<Object>, updateOptions):Promise.<Object>} replaceMany - Replace multiple data objects in a datastore collection. 
+ * @property {function(object, object):Promise.<object>} replaceMany - Replace multiple data objects in a datastore collection. 
  * - Input document overwrites the matched database objects. The _id value is not overwritten
- * @property {function(objectID.<string>):Promise.<Object>} removeOne - Remove one data object by ID in a collection in the current Datastore
- * @property {function(updateOptions):Promise.<Object>} removeMany - Remove multiple data objects in a collection in the current Datastore
+ * @property {function(string|object):Promise.<object>} removeOne - Remove one data object by ID in a collection in the current Datastore
+ * @property {function(object):Promise.<object>} removeMany - Remove multiple data objects in a collection in the current Datastore
  */
 
 /**
  * Database API
  * @typedef {Object} DatastoreAPI
- * @property {function(collection.<string>):NoSQLAPI} collection - Get database collection by string name, returns an NoSQL API object
- * @property {function(collection.<string>, objectID.<string|Array.<string>):Promise.<Object>} getOne - Get object by ID, returns a Promise with the object
- * @property {function(collection, getManyOptions):DataStream} getMany - Get stream of objects by query
- * @property {function(collection.<string>, json.<object>):Promise.<Object>} insertOne - Insert a new data object into a collection in the current Datastore
- * @property {function(collection.<string>, objectID.<string>, document.<Object>):Promise.<Object>} updateOne - Update one data object by ID in a datastore collection. 
+ * @see https://codehooks.io/docs/nosql-database-api
+ * @see https://codehooks.io/docs/key-value-database-api
+ * @property {function(string):NoSQLAPI} collection - Get database collection by string name, returns an NoSQL API object
+ * @property {function(string, string|object):Promise.<object>} getOne - Get object by Query or ObjectID, returns a Promise with the object
+ * @property {function(string, object, object):DataStream} getMany - Get stream of objects by query
+ * - @see https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+ * @property {function(string, object, object):DataStream} find - Alias for getMany
+ * - @see https://codehooks.io/docs/nosql-database-api#getmanycollection-query-options
+ * @property {function(string, object):Promise.<object>} insertOne - Insert a new data object into a collection in the current Datastore
+ * @property {function(string, string, object):Promise.<object>} updateOne - Update one data object by ID in a datastore collection. 
  * - Input document is patched with the matched database object
- * @property {function(collection.<string>, document.<Object>, updateOptions):Promise.<Object>} updateMany - Update multiple data objects in a datastore collection. 
+ * @property {function(string, object, object):Promise.<object>} updateMany - Update multiple data objects in a datastore collection. 
  * - Input document is patched with the matched database objects
- * @property {function(collection.<string>, objectID.<string>, document.<Object>):Promise.<Object>} replaceOne - Replace one data object by ID in a datastore collection. 
+ * @property {function(string, string, object):Promise.<object>} replaceOne - Replace one data object by ID in a datastore collection. 
  * - Input document overwrites the matched database object, the _id value is not overwritten. 
- * @property {function(collection.<string>, document.<Object>, updateOptions):Promise.<Object>} replaceMany - Replace multiple data objects in a datastore collection. 
+ * @property {function(string, object, object):Promise.<object>} replaceMany - Replace multiple data objects in a datastore collection. 
  * - Input document overwrites the matched database objects. The _id value is not overwritten
- * @property {function(collection.<string>, objectID.<string>):Promise.<Object>} removeOne - Remove one data object by ID in a collection in the current Datastore
- * @property {function(collection.<string>, updateOptions):Promise.<Object>} removeMany - Remove multiple data objects in a collection in the current Datastore
- * @property {function(key.<string>, value<string>, keyvalOptions):Promise.<Object>} set - Set a key-value pair in the current Datastore
- * @property {function(key.<string>, keyvalOptions):Promise.<Object>} get - Get a key-value pair in the current Datastore
- * @property {function(keypattern.<string>, keyvalOptions):DataStream} getAll - Get all key-value pair that matches keypattern in the current Datastore
- * @property {function(key.<string>, number, keyvalOptions):Promise.<Object>} incr - Increment a key-value pair in the current Datastore
- * @property {function(key.<string>, number, keyvalOptions):Promise.<Object>} decr - Decrement a key-value pair in the current Datastore
- * @property {function(key.<string>, keyvalOptions):Promise.<Object>} del - Delete a key-value pair in the current Datastore
- * @property {function(keypattern.<string>, keyvalOptions):Promise.<Object>} delAll - Delete a range of key-value pairs in the current Datastore
- * @property {function(topic.<string>, payload.<Object>, options.<Object>):Promise.<Object>} enqueue - Add a queued job in a datastore. 
+ * @property {function(string, string):Promise.<object>} removeOne - Remove one data object by ID in a collection in the current Datastore
+ * @property {function(string, object):Promise.<object>} removeMany - Remove multiple data objects in a collection in the current Datastore
+ * @property {function(string, string, object):Promise.<object>} set - Set a key-value pair in the current Datastore
+ * @property {function(string, object):Promise.<object>} get - Get a key-value pair in the current Datastore
+ * @property {function(string, object):DataStream} getAll - Get all key-value pair that matches keypattern in the current Datastore
+ * @property {function(string, number, object):Promise.<object>} incr - Increment a key-value pair in the current Datastore
+ * @property {function(string, number, object):Promise.<object>} decr - Decrement a key-value pair in the current Datastore
+ * @property {function(string, object):Promise.<object>} del - Delete a key-value pair in the current Datastore
+ * @property {function(string, object):Promise.<object>} delAll - Delete a range of key-value pairs in the current Datastore
+ * @property {function(string, object, object):Promise.<object>} enqueue - Add a queued job in a datastore. 
  * - Jobs in the queue are processed by your worker function.
- * @property {function(collection.<string>, query.<Object>, topic.<string>, payload.<Object>, options.<Object>):Promise.<Object>} enqueueFromQuery - Add multiple queued jobs from the result of a database query in a datastore. 
+ * @property {function(string, object, string, object):Promise.<object>} enqueueFromQuery - Add multiple queued jobs from the result of a database query in a datastore. 
  * - Each object from the collection in the query result will be processed by your worker function. 
  * - If your collection has 1000 items, a match all query ({}) will add 1000 items to the queue and call your worker function 1000 times.
 */
@@ -99,8 +79,10 @@ function createRoute(str) {
 /**
 * Persistent NoSql and Kev-Value datastore
 * @typedef {Object} DataStream
-* @property {function("data"|"end"|"error", callback.<Function>):DataStream} on - Emits data, stream.on('data', (data) => //console.debug(data))
-* @property {function(httpResponse)} json - Pipe datastream to JSON output
+* @property {function(string, function(*)):void} on - Emits data, stream.on('data', (data) => //console.debug(data))
+* @property {function(httpResponse):void} json - Pipe datastream to JSON output
+* @property {function():Promise.<object[]>} toArray - Return an array of objects
+* @property {function(function(object):void):Promise.<object[]>} forEach - Return an iterator with objects
 */
 
 /**
@@ -112,30 +94,56 @@ function createRoute(str) {
 
 /**
  * @typedef {Object} httpRequest
- * @property {object} headers - HTTP header key value pairs, e.g. req.headers['content-type']
- * @property {object} query - Get the URL query parameters as key-value pairs
- * @property {object} params - Get the URL route variables as key-value pairs
- * @property {object} body - Get the request body
- * @property {object} path - Get the URL full path, e.g. /dev/myroute
- * @property {object} apiPath - Get the URL api path, e.g. /myroute
- * @property {object} originalUrl - Get the URL full path and query parameter string
- * @property {object} method - Get the HTTP request verb
- * @property {object} hostname - Get the project URL domain name
+ * @property {*} headers - HTTP header key value pairs, e.g. req.headers['content-type']
+ * @property {*} query - Get the URL query parameters as key-value pairs
+ * @property {*} params - Get the URL route variables as key-value pairs
+ * @property {*} body - Get the request body
+ * - JSON payload
+ * @property {string} path - Get the URL full path, e.g. /dev/myroute
+ * @property {string} apiPath - Get the URL api path, e.g. /myroute
+ * @property {string} originalUrl - Get the URL full path and query parameter string
+ * @property {string} method - Get the HTTP request verb
+ * @property {string} hostname - Get the project URL domain name
  */
 
+
 /**
  * @typedef {Object} httpResponse
- * @property {function(data.<string>)} end - End request (optional: send text data to client)
- * * @property {function(data.<string>)} send - Send text data to client and end request
- * @property {function(data.<json>)} json - End request and send JSON data to client
- * @property {function(data.<string>)} write - Write stream data to the client response. 
+ * @property {function(string|object|void): void} end - End request (optional: send text|JSON data to client)
+ * @property {function(string|object): void} send - Send text|JSON data to client and end request
+ * @property {function(object)} json - End request and send JSON data to client
+ * @property {function(string)} write - Write stream data to the client response. 
  * - Content-type must be set before any write operations
- * @property {function(header.<string>, value.<string>)} set - Set a response header value, 
+ * @property {function(string, string)} set - Set a response header value, 
  * - e.g. res.set('Content-Type', 'text/html; charset=UTF-8');
- * @property {function(headers.<json>)} headers - Set multiple response header values, 
+ * @property {function(object)} headers - Set multiple response header values, 
  * - e.g. res.headers({'Content-Type': 'text/html; charset=UTF-8','X-myheader': '123456890'});
- * @property {function(HttpStatusCode.<number>)} status - Return a HTTP response status code for a client request, 
+ * @property {function(number)} status - Return a HTTP response status code for a client request, 
  * - e.g. res.status(401);
+ * @property {function(string, object):void} render - Render template with object data
+ * - example: res.render('services', {title: "Services page"})
+ */
+
+/**
+ * @typedef {Object} Filesystem
+ * 
+ * @property {function(string, Object): Promise<ReadableStream>} getReadStream 
+ * - Get binary file input stream. Takes a path (string) to file (e.g. /static/logo.png) and an options object (Object) for future use. Returns a Promise resolving to a binary data stream emitter.
+ * 
+ * @property {function(string, Object): Promise<string>} readFile 
+ * - Get file as text. Takes an absolute path (string) to file (e.g. /static/home.html) and an options object (Object) for future use. Returns a Promise resolving to the file content (string).
+ * 
+ * @property {function(string, Buffer, Object): Promise<any>} saveFile 
+ * - Save file binary buffer. Takes an absolute path (string) to file (e.g. /static/home.html), a buffer (Buffer) to save, and file meta data (Object). Returns a Promise resolving to the save result.
+ * 
+ * @property {function(string, Object): Promise<any>} deleteFile 
+ * - Delete a file. Takes an absolute path (string) to file and an options object (Object) for future use. Returns a Promise resolving to the result.
+ * 
+ * @property {function(string, Object): Promise<any>} list 
+ * - List content of a file directory. Takes an absolute path (string) to file and an options object (Object) for future use. Returns a Promise resolving to the result.
+ * 
+ * @property {function(*): Promise<Buffer>} readFileAsBuffer 
+ * - Read file into a Buffer. Takes an absolute path (*) to file. Returns a Promise resolving to a Buffer.
  */
 
 
@@ -161,7 +169,7 @@ class Codehooks {
    *  res.json({"message": "thanks!"})
    * })
    * @param {string} path - API route, e.g. '/foo'
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    */
   post = (path, ...hook) => {
     this.routes[`POST ${createRoute(path)}`] = hook;
@@ -175,7 +183,7 @@ class Codehooks {
    *  res.json({"message": "thanks!"})
    * })
    * @param {string} path - API route, e.g. '/foo/:ID'
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    */
   get = (path, ...hook) => {
     this.routes[`GET ${createRoute(path)}`] = hook;
@@ -189,7 +197,7 @@ class Codehooks {
    *  res.json({"message": "thanks!"})
    * })
    * @param {string} path - API route, e.g. '/foo/:ID'
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, [next])
    */
   put = (path, ...hook) => {
     this.routes[`PUT ${createRoute(path)}`] = hook;
@@ -203,7 +211,7 @@ class Codehooks {
    *  res.json({"message": "thanks!"})
    * })
    * @param {string} path - API route, e.g. '/foo/:ID'
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    */
   patch = (path, ...hook) => {
     this.routes[`PATCH ${createRoute(path)}`] = hook;
@@ -216,7 +224,7 @@ class Codehooks {
    *  res.json({"message": "thanks!"})
    * })
    * @param {string} path - API route, e.g. '/foo/:ID'
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    */
   delete = (path, ...hook) => {
     this.routes[`DELETE ${createRoute(path)}`] = hook;
@@ -230,7 +238,7 @@ class Codehooks {
    *  res.json({"message": "thanks!"})
    * })
    * @param {string} path - API route, e.g. '- API endpoint route, e.g. '/pets' 
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string)):void} hook - callback function(s) with parameters (req, res, [next])
    */
   all = (path, ...hook) => {
     this.routes[`* ${createRoute(path)}`] = hook;
@@ -246,8 +254,8 @@ class Codehooks {
    *    res.status(403).end('No soup!')
    *  }
    * })
-   * @param {string} path - API route, e.g. '/foo/*'
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param {string|RegExp} path - API route, e.g. '/foo/*'
+   * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, [next])
    */
   auth = (path, ...hook) => {
     this.auths[createRoute(path)] = hook;
@@ -262,12 +270,12 @@ class Codehooks {
    *  next(); // proceed
    * })
    * // middleware on a specific route
-   * app.use('/myroute', (req, res, next) => {
+   * app.useRoute('/myroute', (req, res, next) => {
    *  //console.debug("Route middleware was here!");
    *  next(); // proceed
    * })
    * @param {string} path - Optional API route, e.g. '/myroute/*'
-   * @param  {...function(httpRequest, httpResponse, next.<function>)} hook - callback function(s) with parameters (req, res, next)
+   * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, next)
    */
   use = (...hook) => {
     if ((typeof hook[0] === 'string')) {      
@@ -281,10 +289,30 @@ class Codehooks {
     this.appmiddleware = this.appmiddleware.flat();
   };
 
+  /**
+   * Global route middleware
+   * @example
+   * // Global middleware on a specific route
+   * app.useRoute('/myroute', (req, res, next) => {
+   *  //console.debug("Route middleware was here!");
+   *  next(); // proceed
+   * })
+   * @param {string|RegExp} path - Optional API route, e.g. '/myroute/*'
+   * @param  {...function(httpRequest, httpResponse, function(string):void):void} hook - callback function(s) with parameters (req, res, next)
+   */
+  useRoute = (route, ...hook) => {
+    if ((typeof route === 'string')) {      
+        this.appmiddleware.push({ path: route, func: hook[0]});      
+    } else if ((route instanceof RegExp)) {
+      this.appmiddleware.push({ regex: JSON.stringify({$regex: route.toString()}), func: hook[0]});
+    }
+    this.appmiddleware = this.appmiddleware.flat();
+  };
+
   /**
    * Process queue job items for topic
    * @param {string} topic 
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    */
   queue = (topic, ...hook) => {
     this.queues[topic] = hook;
@@ -293,7 +321,7 @@ class Codehooks {
   /**
    * Add application worker function
    * @param {string} name a unique worker name 
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    * @example
    * app.worker('myworker', (data, job) => {
    *  const {body:{payload}} = data
@@ -316,7 +344,7 @@ class Codehooks {
    *  res.end()
    * })
    * @param {string} cronExpression - cron expression
-   * @param  {...function(httpRequest, httpResponse)} hook - callback function(s) with parameters (req, res, [next])
+   * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    */
   job = (cronExpression, ...hook) => {
     this.jobs[cronExpression] = hook;
@@ -337,12 +365,18 @@ class Codehooks {
    * @param {*} val 
    * @example 
    * app.set('views', '/views')
-   * app.set('view engine', 'handlebars')
+   * app.set('view engine', {"hbs": handlebars})
    */
   set = (key, val) => {
     this.settings[key] = val;
   }
 
+  /**
+   * 
+   * @param {string} view 
+   * @param {object} data 
+   * @param {function(string):void)} cb 
+   */
   render = async (view, data, cb) => {
     renderView(view, data, this.settings, cb)
     /*
@@ -353,11 +387,11 @@ class Codehooks {
 
   /**
    * @description Create CRUD REST API for database
-   * @param {*} schema 
-   * @param {*} options 
+   * @param {object} schema 
+   * @param {object} options 
    * @returns Eventhooks - Promise
    */
-  crudlify = (schema, options) => {
+  crudlify = (schema={}, options={}) => {
     return crud(Codehooks.getInstance(), schema, options);
   }
 
@@ -365,7 +399,7 @@ class Codehooks {
    * Returns the Codehooks serverless definitions used by a serverless runtime engine
    * @example
    * export default app.init();
-   * @returns {Object} App instance manifest
+   * @returns {Object} App instance
    */
   init = () => {
     const manifest = {
@@ -521,6 +555,7 @@ export const coderunner = coderun;
  */
 export const schedule = {
   /**
+   * @async
    * Call worker function later
    * @param {Date} datetime to execute
    * @param {Object} payload data
@@ -537,6 +572,7 @@ export const schedule = {
     return await conn.runAt(date, payload, worker)
   },
   /**
+   * @async
    * Call worker function immediate
    * @param {Object} payload to worker function
    * @param {string} worker name 
@@ -551,7 +587,7 @@ export const schedule = {
 }
 
 /**
- * @description API to access deployed static files
+ * @description Virtual filestore
  */
 const _filestore = {
   /**
@@ -576,7 +612,7 @@ const _filestore = {
     return _coho_fs.getFileStream(path, options);
   },
   /**
-   * Get file as text
+   * readFile - Get file as text
    * @param {string} path Absolute path to file, e.g. /static/home.html 
    * @param {Object} options For future use   
    * @returns Promise with file content

package/package.json

@@ -1,9 +1,10 @@
 {
   "name": "codehooks-js",
-  "version": "1.1.11",
+  "version": "1.2.0",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",
+  "types": "./types",
   "files": [
     "index.js",
     "coderunner.mjs",
@@ -16,7 +17,9 @@
     "./crudlify/lib/query/q2m/q2m.mjs",
     "./crudlify/lib/schema/yup/index.mjs",
     "./crudlify/lib/schema/json-schema/index.mjs",
-    "./crudlify/lib/schema/zod/index.mjs"
+    "./crudlify/lib/schema/zod/index.mjs",
+    "./types",
+    "tsconfig.json"
   ],
   "scripts": {
     "test": "echo \"Warning: no tests specified\""

package/tsconfig.json

@@ -0,0 +1,22 @@
+{
+    // Change this to match your project
+    "include": ["**/*"],
+    "exclude": ["node_modules/**"],
+    "compilerOptions": {
+      // Tells TypeScript to read JS files, as
+      // normally they are ignored as source files
+      "allowJs": true,
+      // Generate d.ts files
+      "declaration": true,
+      // This compiler run should
+      // only output d.ts files
+      "emitDeclarationOnly": true,
+      // Types should go into this directory.
+      // Removing this would place the .d.ts files
+      // next to the .js files
+      "outDir": "dist",
+      // go to js file when using IDE functions like
+      // "Go to Definition" in VSCode
+      "declarationMap": true
+    }
+  }

package/types/aggregation/index.d.mts

@@ -0,0 +1,43 @@
+/**
+* Persistent NoSql and Kev-Value datastore
+* @typedef {Object} DataStream
+* @property {function(string, function(*)):void} on - Emits data, stream.on('data', (data) => //console.debug(data))
+* @property {function(httpResponse):void} json - Pipe datastream to JSON output
+* @property {function():Promise.<object[]>} toArray - Return an array of objects
+*/
+/**
+ *
+ * @param {DataStream} readable - JSON stream
+ * @param {Object} spec - JSON aggregation spec
+ * @returns {Promise} with aggregation result
+ * @example
+ * Spec JSON example:
+ * {
+ *      "$max": {$field: "open", $label: "Open"},
+        "$group": {
+            "$field": "Ticker",
+            $label: "Symbol",
+            "$max": "high",
+            "$min": {$field: "close", $label: "Low"}
+        }
+    }
+ */
+export function agg(readable: DataStream, spec: any): Promise<any>;
+/**
+ * Persistent NoSql and Kev-Value datastore
+ */
+export type DataStream = {
+    /**
+     * - Emits data, stream.on('data', (data) => //console.debug(data))
+     */
+    on: (arg0: string, arg1: (arg0: any) => any) => void;
+    /**
+     * - Pipe datastream to JSON output
+     */
+    json: (arg0: httpResponse) => void;
+    /**
+     * - Return an array of objects
+     */
+    toArray: () => Promise<object[]>;
+};
+//# sourceMappingURL=index.d.mts.map

package/types/aggregation/index.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.mts","sourceRoot":"","sources":["../../aggregation/index.mjs"],"names":[],"mappings":"AACA;;;;;;EAME;AAEF;;;;;;;;;;;;;;;;GAgBG;AACH,8BAfW,UAAU,2BAsCpB;;;;;;;;eA7CqB,MAAM,+BAAe,IAAI;;;;kCACX,IAAI;;;;mBAChB,QAAS,MAAM,EAAE,CAAC"}

package/types/coderunner.d.mts

@@ -0,0 +1,2 @@
+export default function execAll(funcarr: any, context: any, callfuncs: any, nextfunc: any): void;
+//# sourceMappingURL=coderunner.d.mts.map

package/types/coderunner.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"coderunner.d.mts","sourceRoot":"","sources":["../coderunner.mjs"],"names":[],"mappings":"AAAA,iGAqBC"}

package/types/cronjob.d.mts

@@ -0,0 +1,2 @@
+export default function run(cronexpr: any, theFunc: any): void;
+//# sourceMappingURL=cronjob.d.mts.map

package/types/cronjob.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"cronjob.d.mts","sourceRoot":"","sources":["../cronjob.mjs"],"names":[],"mappings":"AAMA,+DA6BC"}