codehooks-js 1.2.0 → 1.2.2

package/crudlify/index.mjs

@@ -16,11 +16,12 @@ let _eventHooks = null;
 
 
 /**
- * 
+ * Crudlify
+ * @see {@link https://codehooks.io/docs/database-rest-api}
  * @param {object} app - Codehooks app ( npm package codehooks-js)
  * @param {object} schema - Yup schema object
  * @param {object} options - Options
- * @returns {EventHooks} Hooks for REST operations
+ * @returns {Promise} EventHooks for REST operations
  */
 export default async function crudlify(app, schema = {}, options = { schema: "yup", query: "q2m", prefix: "" }) {
     console.log('Init crudlify', schema, options)
@@ -121,7 +122,7 @@ async function createFunc(req, res) {
                 })
                 .catch(function (err) {
                     console.error(err, document)
-                    res.status(400).json(err.message || err);
+                    res.status(400).json(err);
                 });
         } else {
             // insert with collection name but no schema  
@@ -214,7 +215,7 @@ async function updateFunc(req, res) {
                 })
                 .catch(function (err) {
                     console.error(err, document)
-                    res.status(400).json(err.message || err);
+                    res.status(400).json(err);
                 });
         } else {
             document._id = ID; // put back id that was removed for validation

package/index.js

@@ -389,7 +389,7 @@ class Codehooks {
    * @description Create CRUD REST API for database
    * @param {object} schema 
    * @param {object} options 
-   * @returns Eventhooks - Promise
+   * @returns  {Promise} EventHooks
    */
   crudlify = (schema={}, options={}) => {
     return crud(Codehooks.getInstance(), schema, options);
@@ -583,6 +583,15 @@ export const schedule = {
   "run": async (payload, worker) => {
     const conn = await datastore.open()
     return await conn.runAt(new Date(), payload, worker)
+  },
+  /**
+   * Call function on cron expression
+   * @param {string} payload 
+   * @param {function} worker 
+   * @returns void
+   */
+  "cron": async (cronExpression, ...hook) => {
+    return Codehooks.getInstance().job(cronExpression, ...hook);
   }
 }
 

package/package.json

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

package/types/aggregation/index.d.mts

@@ -5,6 +5,9 @@
 * @property {function(httpResponse):void} json - Pipe datastream to JSON output
 * @property {function():Promise.<object[]>} toArray - Return an array of objects
 */
+
+import { httpResponse } from "..";
+
 /**
  *
  * @param {DataStream} readable - JSON stream
@@ -34,7 +37,7 @@ export type DataStream = {
     /**
      * - Pipe datastream to JSON output
      */
-    json: (arg0: httpResponse) => void;
+    json: (response: httpResponse) => void;
     /**
      * - Return an array of objects
      */

package/types/crudlify/index.d.mts

@@ -3,9 +3,9 @@
  * @param {object} app - Codehooks app ( npm package codehooks-js)
  * @param {object} schema - Yup schema object
  * @param {object} options - Options
- * @returns {EventHooks} Hooks for REST operations
+ * @returns {Promise} EventHooks for REST operations
  */
-export default function crudlify(app: object, schema?: object, options?: object): EventHooks;
+export default function crudlify(app: object, schema?: object, options?: object): Promise<EventHooks>;
 import { EventHooks } from "./lib/eventhooks.mjs";
 export function setDatastore(ds: any): void;
 //# sourceMappingURL=index.d.mts.map

package/types/index.d.ts

@@ -28,6 +28,7 @@ export const coderunner: any;
 export namespace schedule {
     function runAt(date: any, payload: any, worker: string): Promise<any>;
     function run(payload: any, worker: string): Promise<any>;
+    function cron(cronExpression: string, ...hook: ((request: httpRequest, response: httpResponse, next: (error?: string) => void) => any)[]): void;    
 }
 /**
  * Virtual filesystem
@@ -38,11 +39,11 @@ export namespace filestore {
      * @param path Absolute path til file
      * @param options Not in use
      */
-    function getReadStream(path: string, options?: any): any;
-    function readFile(path: string, options?: any): any;
-    function saveFile(path: string, buffer: any, options?: any): any;
-    function deleteFile(path: string, options?: any): any;
-    function list(path: string, options?: any): any;
+    function getReadStream(path: string, options?: any): Promise<ReadableStream>;
+    function readFile(path: string, options?: any): Promise<String>;
+    function saveFile(path: string, buffer: any, options?: any): Promise<any>;
+    function deleteFile(path: string, options?: any): Promise<any>;
+    function list(path: string, options?: any): Promise<Array<Object>>;
     function readFileAsBuffer(path: any): Promise<any>;
 }
 export default _coho;
@@ -326,30 +327,30 @@ export type Filesystem = {
     /**
      * - 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.
      */
-    getReadStream: (arg0: string, arg1: any) => Promise<ReadableStream>;
+    getReadStream: (filePath: string, options?: any) => Promise<ReadableStream>;
     /**
      * - 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).
      */
-    readFile: (arg0: string, arg1: any) => Promise<string>;
+    readFile: (filePath: string, options?: any) => Promise<string>;
     /**
      * - 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.
      */
-    saveFile: (arg0: string, arg1: Buffer, arg2: any) => Promise<any>;
+    saveFile: (filePath: string, buf: any, options?: any) => Promise<any>;
     /**
      * - 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.
      */
-    deleteFile: (arg0: string, arg1: any) => Promise<any>;
+    deleteFile: (filePath: string, options?: any) => Promise<any>;
     /**
      * - 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.
      */
-    list: (arg0: string, arg1: any) => Promise<any>;
+    list: (filePath: string, options?: any) => Promise<any>;
     /**
      * - Read file into a Buffer. Takes an absolute path (*) to file. Returns a Promise resolving to a Buffer.
      */
-    readFileAsBuffer: (arg0: any) => Promise<Buffer>;
+    readFileAsBuffer: (filePath: any) => Promise<any>;
 };
 import { agg } from './aggregation/index.mjs';
-import { crudlify as crud } from './crudlify/index.mjs';
+import * as crud from './crudlify/index.mjs';
 /**
 * keyvalOptions
 * @typedef {Object} keyvalOptions
@@ -648,11 +649,12 @@ declare class Codehooks {
     render: (view: string, data: object, cb: any) => Promise<void>;
     /**
      * @description Create CRUD REST API for database
+     * @see {@link https://codehooks.io/docs/database-rest-api}
      * @param {object} schema
      * @param {object} options
-     * @returns Eventhooks - Promise
+     * @returns Promise - Eventhooks
      */
-    crudlify: (schema?: object, options?: object) => import("./crudlify/lib/eventhooks.mjs").EventHooks;
+    crudlify: (schema?: object, options?: object) => Promise<import("./crudlify/lib/eventhooks.mjs").EventHooks>;
     /**
      * Returns the Codehooks serverless definitions used by a serverless runtime engine
      * @example