codehooks-js 1.2.14 → 1.2.16

package/crudlify/index.mjs

@@ -52,15 +52,19 @@ export default async function crudlify(app, schema = {}, options = { schema: "yu
         // schema provider other than Yup?
         for (const property in schema) {
             //console.log(`${property}: ${schema[property].toString()}`);
-            if (schema[property] !== undefined) {
-                if (schema[property].parse) {
-                    _opt.schema = 'zod';
-                } else if (schema[property].properties) {
-                    _opt.schema = 'json-schema';
+            try {
+                if (schema[property] !== undefined) {
+                    if (schema[property].parse) {
+                        _opt.schema = 'zod';
+                    } else if (schema[property].properties) {
+                        _opt.schema = 'json-schema';
+                    }
+                } else {
+                    console.error(`${property} is undefined`)
+                    //schema[property] = null;
                 }
-            } else {
-                console.error(`${property} is undefined`)
-                //schema[property] = null;
+            } catch (error) {
+                console.error("Unknown schema validator", error.message)
             }
         }
         
@@ -137,7 +141,7 @@ async function createFunc(req, res) {
             }
         }
     } else {
-        if (Object.keys(_schema).length === 0) {
+        if (_schema[collection] === null || Object.keys(_schema).length === 0) {
             console.debug("data", collection, document)
             // insert any collection name no schema definitions, anything goes
             try {
@@ -150,7 +154,7 @@ async function createFunc(req, res) {
                 res.status(400).send(ex);
             }
         } else {
-            console.error('schema for' ,collection, 'is not valid:', _schema[collection])
+            console.error('schema for' ,collection, 'is not found:', _schema[collection])
             return res.status(400).json({ "error": `Collection schema not found: ${collection}` });
         }
         

package/crudlify/lib/schema/yup/index.mjs

@@ -4,9 +4,9 @@ export const validate = (schema, document) => {
     
     return new Promise(async (resolve, reject) => {
         debug('Validate Yup', document)
-        if (schema == null) {
+        if (schema === null || (schema && !schema.validate)) {
             debug('Null validator')
-            resolve(document)
+            return resolve(document)
         }
         try {
             const valid = await schema.validate(document);
@@ -27,7 +27,7 @@ export const validate = (schema, document) => {
 
 export const cast = (schema, document) => {
     debug('Cast', document, schema)
-    return schema.cast(document)
+    return schema.cast ? schema.cast(document) : document;
 }
 
 export const prepare = (schemas) => {

package/index.js

@@ -1,9 +1,6 @@
 import {agg} from './aggregation/index.mjs';
 import {crudlify as crud} from './crudlify/index.mjs';
 import {serveStatic as ws, render as renderView} from './webserver.mjs';
-let cronjob = null;
-let coderun = null;
-
 
 function createRoute(str) {
   if(str instanceof RegExp) {
@@ -119,7 +116,7 @@ class Codehooks {
     })
   }
 
-  init = (...hook) => {
+  init = (hook) => {
     const manifest = {
       workerhooks: this.workers,
       routehooks: this.routes,
@@ -127,7 +124,6 @@ class Codehooks {
       jobhooks: this.jobs,
       authhooks: this.auths,
       globalhooks: this.appmiddleware,
-      useExpress: this.useExpress,
       settings: this.settings,
       realtime: this.realtime,
       app: this
@@ -140,56 +136,6 @@ class Codehooks {
   // alias
   start = this.init;
 
-  useExpress = async (express, options) => {
-    cronjob = import("./cronjob.mjs")
-    coderun = import('./coderunner.mjs')
-    const { datastore, space = '/dev' } = options;
-    await datastore.connect();
-    this.setDatastore(datastore);
-
-    for (let key in this.auths) {
-      const func = this.auth[key];
-      console.error('Auth middleware not implemented:', key)
-    }
-
-    for (let key in this.appmiddleware) {
-      const func = this.appmiddleware[key];
-      if (func.path) {
-        express.use(`${space}${func.path}`, func.func);
-      } else {
-        express.use(func);
-      }
-    }
-
-    for (let key in this.routes) {
-      const func = this.routes[key];
-      const [method, route] = key.split(' ');
-      switch (method) {
-        case 'GET': express.get(`${space}${route}`, ...func); break;
-        case 'PUT': express.put(`${space}${route}`, ...func); break;
-        case 'POST': express.post(`${space}${route}`, ...func); break;
-        case 'PATCH': express.patch(`${space}${route}`, ...func); break;
-        case 'DELETE': express.delete(`${space}${route}`, ...func); break;
-        case '*': express.all(`${space}${route}`, ...func); break;
-      }
-    }
-
-    // apply jobs
-    for (let key in this.jobs) {
-      const func = this.jobs[key];
-      const cron = key;
-      cronjob(cron, func);
-    }
-
-    // apply queue workers
-    for (let key in this.queues) {
-      const func = this.queues[key];
-      const topic = key;
-      //console.debug('Apply queue', topic, func);
-      this.datastore.setQueue(topic, func);
-    }
-  }
-
   setDatastore = (ds) => {
     this.datastore = ds;
     this.listeners.forEach(observer => observer(this))
@@ -205,9 +151,11 @@ class Codehooks {
       }
     }
   }
+
   addListener = (observer) => {
     this.listeners.push(observer);
   }
+
   static getInstance() {
     if (!this.instance) {
       this.instance = new Codehooks();
@@ -239,7 +187,6 @@ export const aggregation = agg;
 export const crudlify = crud;
 export const coho = _coho;
 export const app = _coho;
-export const coderunner = coderun;
 
 export const realtime = {
   createChannel: (path, ...hook) => {

package/package.json

@@ -1,14 +1,12 @@
 {
   "name": "codehooks-js",
-  "version": "1.2.14",
+  "version": "1.2.16",
   "type": "module",
   "description": "Codehooks.io official library - provides express.JS like syntax",
   "main": "index.js",
   "types": "./types",
   "files": [
     "index.js",
-    "coderunner.mjs",
-    "cronjob.mjs",
     "./aggregation/index.mjs",
     "./webserver.mjs",
     "./crudlify/index.mjs",

package/types/index.d.ts

@@ -262,6 +262,34 @@ export type NoSQLAPI = {
    * - Remove multiple data objects in a collection in the current Datastore
    */
   removeMany: (query: object) => Promise<object>;
+  /**
+   * Validate database colletion data agains JSON-Schema
+   * @param schema JSON-schema
+   * @returns Promise with result
+   */
+  createSchema: (schema: object) => Promise<object>;
+  /**
+   * Validate database colletion data agains JSON-Schema
+   * @param schema JSON-schema
+   * @returns Promise with result
+   */
+  setSchema: (schema: object) => Promise<object>;
+  /**
+   * Remove JSON-schema for database collection
+   * @param collection string
+   * @returns Promise with result
+   */
+  removeSchema: () => Promise<object>;
+  /**
+   * Get JSON-schema for database collection
+   * @returns Promise with result
+   */
+  getSchema: () => Promise<object>;
+  /**
+   * Count database collection items
+   * @returns Promise result
+   */
+  count: () => Promise<object>;
 };
 /**
  * Database API
@@ -400,6 +428,37 @@ export type DatastoreAPI = {
     topic: string,
     options?: object
   ) => Promise<object>;
+  /**
+   * Validate database colletion data agains JSON-Schema
+   * @param collection string
+   * @param schema JSON-schema
+   * @returns Promise with result
+   */
+  createSchema: (collection: string, schema: object) => Promise<object>;
+  /**
+   * Validate database colletion data agains JSON-Schema
+   * @param collection string
+   * @param schema JSON-schema
+   * @returns Promise with result
+   */
+  setSchema: (collection: string, schema: object) => Promise<object>;
+  /**
+   * Remove JSON-schema for database collection
+   * @param collection string
+   * @returns Promise with result
+   */
+  removeSchema: (collection: string) => Promise<object>;
+  /**
+   * Get JSON-schema for database collection
+   * @param collection string
+   * @returns Promise with result
+   */
+  getSchema: (collection: string) => Promise<object>;
+   /**
+   * Count database collection items
+   * @returns Promise result
+   */
+   count: (collection: string) => Promise<object>;
 };
 /**
  * Persistent NoSql and Kev-Value datastore
@@ -476,26 +535,40 @@ export type httpResponse = {
   end: (data: string | object | void) => void;
   /**
    * - Send text|JSON data to client and end request
+   * @example
+   * res.end()
+   * res.status(404).end()
    */
   send: (data: string | object) => void;
   /**
    * - End request and send JSON data to client
+   * @example
+   * res.json({ user: 'tobi' })
+   * res.status(500).json({ error: 'message' })
    */
   json: (document: object) => any;
   /**
    * - Write stream data to the client response.
    * - Content-type must be set before any write operations
    * - set optional type to 'buffer' for binary write operations
+   * @example
+   * res.set('content-type', 'text/plain')
+   * res.write('line one')
+   * res.write('\n')
+   * res.write('line two')
+   * res.end()
    */
   write: (data: any, type?: string) => any;
   /**
    * - Set a response header value,
-   * - e.g. res.set('Content-Type', 'text/html; charset=UTF-8');
+   * @example
+   * res.set('Content-Type', 'text/html; charset=UTF-8');
    */
   set: (header: string, value: string) => any;
   /**
    * - Set multiple response header values,
-   * - e.g. res.headers({'Content-Type': 'text/html; charset=UTF-8','X-myheader': '123456890'});
+   * @example
+   * res.headers({'Content-Type': 'text/html; charset=UTF-8','X-myheader': '123456890'});
    */
   headers: (headers: object) => any;
   /**
@@ -513,14 +586,26 @@ export type httpResponse = {
   removeHeader: (header: string) => any;
   /**
    * - Return a HTTP response status code for a client request,
-   * - e.g. res.status(401);
+   * @example
+   * res.status(401).end();
    */
   status: (code: number) => any;
   /**
    * - Render template with object data
-   * - example: res.render('services', {title: "Services page"})
+   * @example
+   * res.render('services', {title: "Services page"})
    */
   render: (template: string, context: object) => void;
+  /**
+   * - Sets the response header to redirect client request
+   * @param statusCode - optional, set to 302 by default
+   * @param url 
+   * @returns 
+   * @example 
+   * res.redirect('/assets/login.html'); // default status 302, Temporary
+   * res.redirect(301, '/home/correct.html'); // status code 301, Permanently
+   */
+  redirect: (statusCode: number | string, url?: string) => void;
 };
 
 export type nextFunction = (error?: string) => void;
@@ -785,7 +870,7 @@ declare class Codehooks {
   ) => void;
   /**
    * Add application worker function
-   * @param {string} name a unique worker name
+   * @param {object} name a unique worker name or JSON configuration
    * @param  {...function(httpRequest, httpResponse, function(string):void)} hook - callback function(s) with parameters (req, res, [next])
    * @example
    * app.worker('myworker', (data, job) => {
@@ -794,9 +879,16 @@ declare class Codehooks {
    *  // do stuff with payload data
    *  job.end()
    *})
+   * @example
+   * app.worker({name: 'myworker', workers: 5}, (data, job) => {
+   *  const {body:{payload}} = data
+   *  //console.debug('worker payload data', payload)
+   *  // do stuff with payload data
+   *  job.end()
+   *})
    */
   worker: (
-    name: string,
+    name: string | object,
     ...hook: ((
       request: httpRequest,
       response: httpResponse,
@@ -840,7 +932,16 @@ declare class Codehooks {
 
   /**
    * Serve static file content from a source code diretory
-   * @param {Object} options - {route: "/", default: "index.html", directory: "/static"}
+   * @param {Object} options -
+   * - options.route - API route to serve assets
+   * - options.directory - path to directory with assets/files
+   * - options.default - default file name if root is /
+   @param  {...function(httpRequest, httpResponse, function(string):void)} hook - Optional middleware functions to be applied before resource is served
+   * @example
+   * app.static({route:'/static', directory: '/assets'}, (req, res, next) => {
+   *   console.log("Serving a static resource", req.path);
+   *   next();
+   *  })
    * @returns void
    */
   static: (options: any, 

package/coderunner.mjs

@@ -1,22 +0,0 @@
-export default function execAll(funcarr, context, callfuncs, nextfunc) {
-    const runOne = (pos) => {
-        (async function () {
-            try {
-                if (funcarr[pos] !== null && funcarr[pos] !== undefined) {
-                    await funcarr[pos](context, callfuncs, (nextparam) => {
-                        if (nextparam && nextfunc) {
-                            return nextfunc(nextparam)
-                        }
-                        runOne(pos + 1);
-                    });
-                } else {
-                    if (nextfunc) nextfunc();
-                }
-            } catch (ex) {
-                console.error("Unhandled Codehook function exception:", ex || ex, funcarr, pos);
-                callfuncs.end("Unhandled Codehook exception:" + ex.message || ex);
-            }
-        })();
-    }
-    runOne(0);
-}

package/cronjob.mjs

@@ -1,36 +0,0 @@
-import crontab from 'node-cron';
-import cronparser from 'cron-parser';
-import execAll from './coderunner.mjs';
-const debug = console.debug;
-
-
-export default function run(cronexpr, theFunc) {
-    //return console.log('Not implemented in standalone version')
-    try {
-        // verify cron expression
-        cronparser.parseExpression(cronexpr);
-        const newtimer = crontab.schedule(cronexpr, async () => {            
-            const theContext = {                
-                end: function (output) {
-                    if (output) console.log(output);
-                    return this;
-                }                
-            };
-            debug('tick', cronexpr, theFunc);
-            try {
-                if (Array.isArray(theFunc)) {
-                    await execAll(theFunc, {}, theContext);
-                } else {
-                    await theFunc({}, theContext);
-                }
-            } catch (ex) {
-                console.log("Cron err", ex.message)
-            }
-        });
-    } catch (ex) {
-        console.error("Something is fishy with the cron expression", `'${cronexpr}'`)
-        if (argv.debug) console.error(ex.message)
-        debug(ex)
-        process.exit(1)
-    }
-}