codehooks-js 1.2.14 → 1.2.15

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) {
@@ -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.15",
   "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

@@ -476,26 +476,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 +527,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;
@@ -840,7 +866,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)
-    }
-}