spice-js 2.5.16 → 2.5.19

package/build/bootstrap/seed.js

@@ -0,0 +1,21 @@
+"use strict";
+
+var _path = _interopRequireDefault(require("path"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+spice.seeds = {};
+
+var paths = _path.default.join(spice.root_path, "seeds");
+
+require("fs").readdirSync(paths).forEach(function (file) {
+  if (file != "index.js") {
+    var seed = require(_path.default.join(paths, file));
+
+    spice.seeds[file.split(".")[0]] = seed;
+
+    if (seed.run) {
+      seed.run();
+    }
+  }
+});

package/build/docs/generator.js

@@ -103,16 +103,16 @@ function getRoutes(models) {
             produces: ["application/json"]
           };
           _path.responses = {
-            "200": {
+            200: {
               description: "Successful Operation"
             },
-            "401": {
+            401: {
               description: "Authentication Error"
             },
-            "400": {
+            400: {
               description: "Bad Request"
             },
-            "404": {
+            404: {
               description: "Not found"
             }
           };
@@ -427,8 +427,8 @@ function _generateSpec() {
       security: [{
         Bearer: []
       }],
-      host: spice.config.spice.host + ":" + spice.config.spice.port,
-      port: 80,
+      host: spice.config.spice.host + ":" + (spice.config.spice.external_port || spice.config.spice.port),
+      port: spice.config.spice.external_port || spice.config.spice.port,
       basePath: "/",
       tags: generateTags(),
       paths: generatePaths(routes),

package/build/events/events/ResourceLifecycleTriggered.js

@@ -0,0 +1,30 @@
+"use strict";
+
+exports.__esModule = true;
+exports.default = void 0;
+
+var _Event = _interopRequireDefault(require("../Event"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+var driver = "";
+
+class ResourceLifecycleTriggered extends _Event.default {
+  constructor(args) {
+    if (args === void 0) {
+      args = {};
+    }
+
+    if (!args.driver) {
+      args.driver = driver;
+    }
+
+    args.topic = "ResourceLifecycleTriggered";
+    super(args);
+    this.topic = args.topic;
+    this.driver = args.driver;
+  }
+
+}
+
+exports.default = ResourceLifecycleTriggered;

package/build/index.js

@@ -1,7 +1,7 @@
 "use strict";
 
 exports.__esModule = true;
-exports.default = exports.status = exports.addTask = exports.MapType = exports.MailFile = exports.Storage = exports.LocalStorage = exports.DebugStorage = exports.MailDebug = exports.DataType = exports.Mail = exports.RestHelper = exports.Serializer = exports.Crypt = exports.SpiceModel = exports.SocketEventDriver = exports.SpiceEventDriver = exports.EventDebugger = exports.Event = void 0;
+exports.default = exports.status = exports.addTask = exports.MapType = exports.MailFile = exports.Storage = exports.LocalStorage = exports.DebugStorage = exports.MailDebug = exports.DataType = exports.Mail = exports.RestHelper = exports.Serializer = exports.Crypt = exports.SpiceModel = exports.ResourceLifecycleTriggered = exports.SocketEventDriver = exports.SpiceEventDriver = exports.EventDebugger = exports.Event = void 0;
 
 var _Event = _interopRequireDefault(require("./events/Event"));
 
@@ -19,6 +19,10 @@ var _SocketEventDriver = _interopRequireDefault(require("./events/providers/Sock
 
 exports.SocketEventDriver = _SocketEventDriver.default;
 
+var _ResourceLifecycleTriggered = _interopRequireDefault(require("./events/events/ResourceLifecycleTriggered"));
+
+exports.ResourceLifecycleTriggered = _ResourceLifecycleTriggered.default;
+
 var _SpiceModel = _interopRequireDefault(require("./models/SpiceModel"));
 
 exports.SpiceModel = _SpiceModel.default;
@@ -73,6 +77,8 @@ var _tasks = _interopRequireDefault(require("./bootstrap/tasks"));
 
 exports.addTask = _tasks.default;
 
+var _koa2SwaggerUi = require("koa2-swagger-ui");
+
 var _generator = _interopRequireDefault(require("./docs/generator"));
 
 function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
@@ -100,8 +106,6 @@ spice.module_root_path = path.resolve(__dirname);
 
 var convert = require("koa-convert");
 
-var koaSwagger = require("koa2-swagger-ui");
-
 spice.classes = {};
 /* spice.classes.Event = Event;
 spice.classes.Serializer = Serializer;
@@ -147,7 +151,7 @@ class Spice {
           console.log("Connection Up", sock);
         }); */
 
-        app.use(koaSwagger({
+        app.use((0, _koa2SwaggerUi.koaSwagger)({
           hideTopbar: true,
           title: "Spice JS",
           routePrefix: "/docs",
@@ -155,8 +159,10 @@ class Spice {
           swaggerOptions: {
             spec: yield (0, _generator.default)(),
             deepLinking: true,
-            displayRequestDuration: true
-          }
+            displayRequestDuration: true,
+            jsonEditor: true
+          },
+          exposeSpec: true
         }));
         yield require("./loaders").load();
         return spice;

package/build/models/SpiceModel.js

@@ -5,6 +5,10 @@ exports.default = void 0;
 
 var _2 = require("..");
 
+var _ResourceLifecycleTriggered = _interopRequireDefault(require("../events/events/ResourceLifecycleTriggered"));
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
 function _extends() { _extends = Object.assign || function (target) { for (var i = 1; i < arguments.length; i++) { var source = arguments[i]; for (var key in source) { if (Object.prototype.hasOwnProperty.call(source, key)) { target[key] = source[key]; } } } return target; }; return _extends.apply(this, arguments); }
 
 function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try { var info = gen[key](arg); var value = info.value; } catch (error) { reject(error); return; } if (info.done) { resolve(value); } else { Promise.resolve(value).then(_next, _throw); } }
@@ -89,6 +93,20 @@ class SpiceModel {
         collection: args.collection,
         scope: args.scope
       });
+
+      function removeDynamicProps(props) {
+        var returnVal = {};
+
+        for (var i in props) {
+          if (!_.has(props[i], "source") || _.get(props[i], "source") == "static") {
+            returnVal[i] = props[i];
+          }
+        }
+
+        return returnVal;
+      }
+
+      args.props = removeDynamicProps(args.props);
       this[_props] = args.props;
 
       for (var i in args.props) {
@@ -701,6 +719,17 @@ class SpiceModel {
 
     return _asyncToGenerator(function* () {
       try {
+        var resourceLifecycleTriggered = new _ResourceLifecycleTriggered.default({
+          data: {
+            data,
+            operation: op,
+            when,
+            old_data,
+            resource: _this9.type
+          }
+        });
+        resourceLifecycleTriggered.dispatch();
+
         if (_this9[_hooks] && _this9[_hooks][op] && _this9[_hooks][op][when]) {
           for (var i of _this9[_hooks][op][when]) {
             data = yield i(data, old_data);

package/build/utility/RestHelper.js

@@ -13,17 +13,25 @@ function asyncGeneratorStep(gen, resolve, reject, _next, _throw, key, arg) { try
 
 function _asyncToGenerator(fn) { return function () { var self = this, args = arguments; return new Promise(function (resolve, reject) { var gen = fn.apply(self, args); function _next(value) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "next", value); } function _throw(err) { asyncGeneratorStep(gen, resolve, reject, _next, _throw, "throw", err); } _next(undefined); }); }; }
 
-var fs = require('fs');
+var fs = require("fs");
 
-var path = require('path');
+var path = require("path");
 
 var {
   parse
-} = require('json2csv');
+} = require("json2csv");
 
 class RestHelper {
   constructor() {}
 
+  static clear_pagination(ctx, next) {
+    return _asyncToGenerator(function* () {
+      delete ctx.query.limit;
+      delete ctx.query.offset;
+      yield next();
+    })();
+  }
+
   static send_response(ctx, next) {
     return _asyncToGenerator(function* () {
       try {
@@ -46,6 +54,14 @@ class RestHelper {
     })();
   }
 
+  static clear_pagination(ctx, next) {
+    return _asyncToGenerator(function* () {
+      delete ctx.query.limit;
+      delete ctx.query.offset;
+      yield next();
+    })();
+  }
+
   static send_download(ctx, next) {
     return _asyncToGenerator(function* () {
       function makeDirectory(dir) {
@@ -55,10 +71,10 @@ class RestHelper {
       }
 
       try {
-        var download_type = ctx.request.query.format || 'csv';
+        var download_type = ctx.request.query.format || "csv";
         var content;
 
-        if (download_type == 'csv') {
+        if (download_type == "csv") {
           var items = _lodash.default.map(ctx.data, item => {
             return (0, _flat.default)(item);
           });
@@ -69,10 +85,10 @@ class RestHelper {
             fields
           };
           content = parse(items, opts);
-          ctx.set('content-type', 'text/csv');
+          ctx.set("content-type", "text/csv");
         } else {
           content = JSON.stringify(ctx.data);
-          ctx.set('content-type', 'application/json');
+          ctx.set("content-type", "application/json");
         }
 
         makeDirectory("./storage/exports");
@@ -81,7 +97,7 @@ class RestHelper {
         yield fs.writeFile(file, content, function (err) {
           if (err) throw err;
         });
-        ctx.set('content-disposition', 'attachment');
+        ctx.set("content-disposition", "attachment");
         ctx.response.attachment(file);
         ctx.status = 200;
         ctx.body = fs.createReadStream(file);
@@ -94,8 +110,8 @@ class RestHelper {
   }
 
   static makeid(length) {
-    var result = '';
-    var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
+    var result = "";
+    var characters = "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
     var charactersLength = characters.length;
 
     for (var i = 0; i < length; i++) {
@@ -167,7 +183,7 @@ class RestHelper {
     } catch (error) {
       try {
         if (value.toLowerCase() == "true" || value.toLowerCase() == "false") {
-          returnValue = value === 'true';
+          returnValue = value === "true";
           return returnValue;
         } else {
           throw Error;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "spice-js",
-  "version": "2.5.16",
+  "version": "2.5.19",
   "description": "spice",
   "main": "build/index.js",
   "repository": {
@@ -30,7 +30,7 @@
     "koa-static": "^5.0.0",
     "koa-validation": "^0.1.9",
     "koa-views": "^6.2.3",
-    "koa2-swagger-ui": "^3.0.1",
+    "koa2-swagger-ui": "^5.5.1",
     "lodash": "^4.17.15",
     "nunjucks": "^3.2.0",
     "open": "7.0.0",

package/src/bootstrap/seed.js

@@ -0,0 +1,16 @@
+import path from "path";
+
+spice.seeds = {};
+
+let paths = path.join(spice.root_path, "seeds");
+require("fs")
+  .readdirSync(paths)
+  .forEach(function (file) {
+    if (file != "index.js") {
+      let seed = require(path.join(paths, file));
+      spice.seeds[file.split(".")[0]] = seed;
+      if (seed.run) {
+        seed.run();
+      }
+    }
+  });

package/src/docs/generator.js

@@ -82,16 +82,16 @@ function getRoutes(models) {
             };
 
             path.responses = {
-              "200": {
+              200: {
                 description: "Successful Operation",
               },
-              "401": {
+              401: {
                 description: "Authentication Error",
               },
-              "400": {
+              400: {
                 description: "Bad Request",
               },
-              "404": {
+              404: {
                 description: "Not found",
               },
             };
@@ -271,27 +271,27 @@ function getProperties(obj) {
     }
 
     if (map != undefined && map.type == "model") {
-      if(map.reference != undefined){
-
-      
-      let references = _.isArray(map.reference)?map.reference:[map.reference];
-      let reference = `#/definitions/${
-        _.isString(map.reference) ? map.reference :references[0].name
-      }`;
-      if (to_return.type == "array") {
-        to_return.items.$ref = reference;
+      if (map.reference != undefined) {
+        let references = _.isArray(map.reference)
+          ? map.reference
+          : [map.reference];
+        let reference = `#/definitions/${
+          _.isString(map.reference) ? map.reference : references[0].name
+        }`;
+        if (to_return.type == "array") {
+          to_return.items.$ref = reference;
+        }
+
+        if (to_return.type == "object") {
+          to_return.$ref = reference;
+        }
+
+        if (to_return.type == "string") {
+          to_return.type = "object";
+          to_return.readOnly = true;
+          to_return.$ref = reference;
+        }
       }
-
-      if (to_return.type == "object") {
-        to_return.$ref = reference;
-      }
-
-      if (to_return.type == "string") {
-        to_return.type = "object";
-        to_return.readOnly = true;
-        to_return.$ref = reference;
-      }
-    }
     }
     return to_return;
   });
@@ -372,8 +372,10 @@ export default async function generateSpec() {
       },
     ],
 
-    host: `${spice.config.spice.host}:${spice.config.spice.port}`,
-    port: 80,
+    host: `${spice.config.spice.host}:${
+      spice.config.spice.external_port || spice.config.spice.port
+    }`,
+    port: spice.config.spice.external_port || spice.config.spice.port,
     basePath: "/",
     tags: generateTags(),
     paths: generatePaths(routes),

package/src/index.js

@@ -38,8 +38,7 @@ export { default as MailFile } from "./mail/providers/File";
 export { default as MapType } from "./utility/MapType";
 export { default as addTask } from "./bootstrap/tasks";
 const convert = require("koa-convert");
-const koaSwagger = require("koa2-swagger-ui");
-
+import { koaSwagger } from "koa2-swagger-ui";
 spice.classes = {};
 /* spice.classes.Event = Event;
 spice.classes.Serializer = Serializer;
@@ -90,7 +89,9 @@ export default class Spice {
             spec: await docGen(),
             deepLinking: true,
             displayRequestDuration: true,
+            jsonEditor: true,
           },
+          exposeSpec: true,
         })
       );
       await require("./loaders").load();

package/src/models/SpiceModel.js

@@ -69,14 +69,30 @@ export default class SpiceModel {
           cleaners: [],
         },
       };
+
       this.deleted = false;
       if (args.args) {
         delete args.args["ctx"];
       }
+
       this[_database] = new Database(args.connection || "default", {
         collection: args.collection,
         scope: args.scope,
       });
+
+      function removeDynamicProps(props) {
+        let returnVal = {};
+        for (let i in props) {
+          if (
+            !_.has(props[i], "source") ||
+            _.get(props[i], "source") == "static"
+          ) {
+            returnVal[i] = props[i];
+          }
+        }
+        return returnVal;
+      }
+      args.props = removeDynamicProps(args.props);
       this[_props] = args.props;
       for (let i in args.props) {
         if (args.args != undefined) {

package/src/utility/RestHelper.js

@@ -1,11 +1,9 @@
-import flatten from 'flat';
-import _ from "lodash"
-const fs = require('fs');
-const path = require('path');
-
-const {
-    parse
-} = require('json2csv');
+import flatten from "flat";
+import _ from "lodash";
+const fs = require("fs");
+const path = require("path");
+
+const { parse } = require("json2csv");
 export default class RestHelper {
     constructor() { }
     static async clear_pagination(ctx, next) {
@@ -31,150 +29,167 @@ export default class RestHelper {
             console.log("Error at response: ", e, e.stack);
         }
     }
+  
 
-    static async send_download(ctx, next) {
-        function makeDirectory(dir) {
-            if (!fs.existsSync(dir)) {
-                fs.mkdirSync(dir);
-            }
-        }
-        try {
-            let download_type = ctx.request.query.format || 'csv';
-            let content;
-            if (download_type == 'csv') {
-                let items = _.map(ctx.data, item => {
-                    return flatten(item);
-                });
-                let fields = _.union(_.keys(_.first(items)), _.keys(_.last(items)), _.keys(_.nth(items.length / 2)));
-                const opts = {
-                    fields
-                };
-                content = parse(items, opts);
-                ctx.set('content-type', 'text/csv');
-            } else {
-                content = JSON.stringify(ctx.data);
-                ctx.set('content-type', 'application/json');
-            }
-
-            makeDirectory(`./storage/exports`);
-            makeDirectory(`./storage/exports/${download_type}/`);
-            let file = path.resolve(`./storage/exports/${download_type}/${RestHelper.makeid(9)}.${download_type}`);
-            await fs.writeFile(file, content, function (err) {
-                if (err) throw err;
-            });
-
-            ctx.set('content-disposition', 'attachment');
-            ctx.response.attachment(file);
-            ctx.status = 200;
-            ctx.body = fs.createReadStream(file);
-        } catch (e) {
-            console.log(e.stack)
-            ctx.status = 400;
-            ctx.body = RestHelper.prepare_response(RestHelper.FAILURE, e);
-        }
+    static async clear_pagination(ctx, next) {
+        delete ctx.query.limit;
+        delete ctx.query.offset;
+        await next();
     }
 
-    static makeid(length) {
-        var result = '';
-        var characters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
-        var charactersLength = characters.length;
-        for (var i = 0; i < length; i++) {
-            result += characters.charAt(Math.floor(Math.random() * charactersLength));
-        }
-        return result;
+  static async send_download(ctx, next) {
+    function makeDirectory(dir) {
+      if (!fs.existsSync(dir)) {
+        fs.mkdirSync(dir);
+      }
     }
-
-    static SUCCESS = "SUCCESS"
-    static FAILURE = "FAILURE";
-    static prepare_collection(status, obj = {
-        data: [],
-        total: null
-    }) {
-        var data = {
-            status: status,
-            type: "collection",
-            count: obj.data.length,
-            data: obj.data,
-            total: obj.total
-        }
-        if (obj.total == null || obj.total == undefined) {
-            delete data.total;
-        }
-        return data;
+    try {
+      let download_type = ctx.request.query.format || "csv";
+      let content;
+      if (download_type == "csv") {
+        let items = _.map(ctx.data, (item) => {
+          return flatten(item);
+        });
+        let fields = _.union(
+          _.keys(_.first(items)),
+          _.keys(_.last(items)),
+          _.keys(_.nth(items.length / 2))
+        );
+        const opts = {
+          fields,
+        };
+        content = parse(items, opts);
+        ctx.set("content-type", "text/csv");
+      } else {
+        content = JSON.stringify(ctx.data);
+        ctx.set("content-type", "application/json");
+      }
+
+      makeDirectory(`./storage/exports`);
+      makeDirectory(`./storage/exports/${download_type}/`);
+      let file = path.resolve(
+        `./storage/exports/${download_type}/${RestHelper.makeid(
+          9
+        )}.${download_type}`
+      );
+      await fs.writeFile(file, content, function (err) {
+        if (err) throw err;
+      });
+
+      ctx.set("content-disposition", "attachment");
+      ctx.response.attachment(file);
+      ctx.status = 200;
+      ctx.body = fs.createReadStream(file);
+    } catch (e) {
+      console.log(e.stack);
+      ctx.status = 400;
+      ctx.body = RestHelper.prepare_response(RestHelper.FAILURE, e);
     }
+  }
+
+  static makeid(length) {
+    var result = "";
+    var characters =
+      "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789";
+    var charactersLength = characters.length;
+    for (var i = 0; i < length; i++) {
+      result += characters.charAt(Math.floor(Math.random() * charactersLength));
+    }
+    return result;
+  }
+
+  static SUCCESS = "SUCCESS";
+  static FAILURE = "FAILURE";
+  static prepare_collection(
+    status,
+    obj = {
+      data: [],
+      total: null,
+    }
+  ) {
+    var data = {
+      status: status,
+      type: "collection",
+      count: obj.data.length,
+      data: obj.data,
+      total: obj.total,
+    };
+    if (obj.total == null || obj.total == undefined) {
+      delete data.total;
+    }
+    return data;
+  }
 
-    static prepare_response(status, data, errors, token) {
-        var response = {
-            status: status,
-            type: "single"
-        }
-
-        if (token) {
-            response.token = token;
-        }
+  static prepare_response(status, data, errors, token) {
+    var response = {
+      status: status,
+      type: "single",
+    };
 
-        if (status == this.FAILURE) {
-            response.message = data;
-            if (errors) {
-                response.errors = errors;
-            }
-        } else {
-            if (data) {
-                response.data = data;
-            }
-        }
+    if (token) {
+      response.token = token;
+    }
 
-        return response;
+    if (status == this.FAILURE) {
+      response.message = data;
+      if (errors) {
+        response.errors = errors;
+      }
+    } else {
+      if (data) {
+        response.data = data;
+      }
     }
 
-    static get_typed_value(value) {
-        var returnValue;
+    return response;
+  }
+
+  static get_typed_value(value) {
+    var returnValue;
+    try {
+      returnValue = Number(value);
+      if (isNaN(returnValue)) {
+        throw returnValue;
+      } else {
+        return returnValue;
+      }
+    } catch (error) {
+      try {
+        if (value.toLowerCase() == "true" || value.toLowerCase() == "false") {
+          returnValue = value === "true";
+          return returnValue;
+        } else {
+          throw Error;
+        }
+      } catch (error) {
         try {
-            returnValue = Number(value)
-            if (isNaN(returnValue)) {
-                throw returnValue;
-            } else {
-                return returnValue;
-            }
-
+          returnValue = JSON.parse(value);
+          return returnValue;
         } catch (error) {
-            try {
-                if (value.toLowerCase() == "true" || value.toLowerCase() == "false") {
-                    returnValue = (value === 'true');
-                    return returnValue;
-                } else {
-                    throw Error;
-                }
-            } catch (error) {
-                try {
-                    returnValue = JSON.parse(value);
-                    return returnValue;
-                } catch (error) {
-                    try {
-                        returnValue = String(value);
-                        return returnValue;
-                    } catch (error) {
-                        console.log("Cant parse" + value);
-                    }
-                }
-            }
+          try {
+            returnValue = String(value);
+            return returnValue;
+          } catch (error) {
+            console.log("Cant parse" + value);
+          }
         }
+      }
     }
+  }
 
-    static normalizePort(val) {
-        var port = parseInt(val, 10);
-
-        if (isNaN(port)) {
-            // named pipe
-            return val;
-        }
+  static normalizePort(val) {
+    var port = parseInt(val, 10);
 
-        if (port >= 0) {
-            // port number
-            return port;
-        }
+    if (isNaN(port)) {
+      // named pipe
+      return val;
+    }
 
-        return false;
+    if (port >= 0) {
+      // port number
+      return port;
     }
 
-}
+    return false;
+  }
+}