not-node 6.0.7 → 6.1.0

package/tmpl/files/module.front/common/ncInit.ejs

@@ -0,0 +1,18 @@
+import { Frame } from 'not-bulma';
+
+const {
+    notSideMenu, notTopMenu, 
+    notController} = Frame;
+
+class ncInit extends notController {
+	constructor(app) {
+		super(app);
+		this.setModuleName('init');
+		this.log('init app');
+		notSideMenu.render(app);
+		notTopMenu.render(app);
+		return this;
+	}
+}
+
+export default ncInit;

package/tmpl/files/module.front/common/ws.client.main.ejs

@@ -0,0 +1,35 @@
+import {notCommon} from 'not-bulma';
+const logger = notCommon.createLogger(`WSClient(main)`);
+
+const main = {
+  logger: logger,
+  getToken: () => {
+    return notCommon.getApp().getModel('user', {}).$token({})
+      .then((res) => {
+        logger.log('token', res.result.token);
+        notCommon.getApp().setWorking('token', res.result.token);
+        return res.result.token;
+      });
+  },
+  messenger: {
+    validateTypeAndName: false,
+    secure: false,//not secure, bc its not issuing tokens and has no secret key
+    types: {
+      '__service': ['updateToken'],
+      'request': [],
+      'response': [],
+      'event': []
+    },
+  },
+  router:{
+    routes:{
+      event: {
+        notification(){
+          console.log(...arguments);
+        }
+      }
+    }
+  }
+};
+
+export default main;

package/tmpl/files/module.front/role/guest.index.ejs

@@ -0,0 +1,45 @@
+import ncInit from "../../common/ncInit";
+
+let manifest = {
+    environment: "guest",
+    router: {
+        manifest: [],
+    },
+    crud: {
+        containerSelector: ".main-container",
+    },
+    modules: {
+        user: {
+            loginFormContainerSelector: ".main-container",
+            registerFormContainerSelector: ".main-container",
+        },
+    },
+    initController: ncInit,
+    menu: {
+        top: {
+            toggleSelector: ".navbar-burger",
+            sections: [],
+            items: [
+                {
+                    title: "Вход",
+                    url: "/login",
+                    priority: 10,
+                    showOnTouch: true,
+                    type: "button",
+                    place: "start",
+                } , {
+                    id: 'register',
+                    title: 'Регистрация',
+                    url: '/register',
+                    type:       'button',
+                    priority: 11,
+                    showOnTouch:true,
+				    place: 'start'
+                },
+            ],
+        },
+    },
+};
+
+ 
+export { ncInit, manifest };

package/tmpl/files/module.front/role/index.ejs

@@ -0,0 +1,34 @@
+import ncInit from "../../common/ncInit";
+
+let manifest = {
+    environment: "client",
+    router: {
+        root: "/dashboard",
+        manifest: [],
+    },
+    crud: {
+        containerSelector: ".main-container",
+    },
+    modules: {
+        user: {},
+    },
+    brand: {
+        icon: {
+            src: "/img/icons/icon-w-64.png",
+            width: 48,
+            height: 28,
+        },
+        url: "/",
+    },
+    menu: {
+        side: {
+            sections: [],
+        },
+        top: {
+            sections: [],
+        },
+    },
+    initController: ncInit,
+};
+
+export { ncInit, manifest };

package/tmpl/files/module.server/const.ejs

@@ -0,0 +1 @@
+module.exports.MODULE_NAME = '<%- ModuleName %>';

package/tmpl/files/module.server/index.ejs

@@ -0,0 +1,8 @@
+const { generatePaths } = require("not-node").Common;
+
+const COMPONENTS = [<%- moduleLayers.map(entry => `"${entry}"`).join(',') %>];
+
+module.exports = {
+    name: require("./src/const").MODULE_NAME,
+    paths: generatePaths(COMPONENTS, __dirname + "/src"),
+};

package/tmpl/files/module.server/layers/controllers/common/crud.ejs

@@ -0,0 +1,95 @@
+import Validators from "../common/validators.js";
+import { Frame } from "not-bulma";
+const { notCRUD } = Frame;
+
+const MODULE_NAME = "";
+const MODEL_NAME = "<%- ModelName %>";
+
+const LABELS = {
+    plural: "<%- `${ModuleName}:${modelName}_label_plural` %>",
+    single: "<%- `${ModuleName}:${modelName}_label_single` %>",
+};
+
+class nc<%- ModelName %>Common extends notCRUD {
+    static MODULE_NAME = MODULE_NAME;
+    static MODEL_NAME = MODEL_NAME;
+    constructor(app, params) {
+        super(app, `${MODULE_NAME}.${MODEL_NAME}`);
+        this.setModuleName(MODULE_NAME);
+        this.setModelName(MODEL_NAME);
+        this.setOptions("names", LABELS);
+        this.setOptions("Validators", Validators);
+        this.setOptions("params", params);
+        this.setOptions("list", {
+            interface: {
+                combined: true,
+                factory: this.make.<%- modelName %>,
+            },
+            endless: false,
+            preload: {},
+            sorter: {
+                id: -1,
+            },
+            showSearch: true,
+            idField: "_id",
+            fields: [
+                <% if (increment) { %>
+                {
+                    path: ":<%- modelName %>ID",
+                    title: "ID",
+                    searchable: true,
+                    sortable: true,
+                },
+                <% } %>
+                <% for (let fieldName of fields){ %>
+                {
+                    path: ":<%- fieldName %>",
+                    title: "<%- `${ModuleName}:${modelName}_field_${fieldName}_label` %>",
+                    searchable: true,
+                    sortable: true,
+                },
+                <% } %>
+                {
+                    path: ":_id",
+                    title: "Действия",
+                    type: "button",
+                    preprocessor: (value) => {
+                        return [
+                            {
+                                action: this.goDetails.bind(this, value),
+                                title: "Подробнее",
+                                size: "small",
+                            },
+                            {
+                                action: this.goUpdate.bind(this, value),
+                                title: "Изменить",
+                                size: "small",
+                            },
+                            {
+                                action: this.goDelete.bind(this, value),
+                                color: "danger",
+                                title: "Удалить",
+                                size: "small",
+                                style: "outlined",
+                            },
+                        ];
+                    },
+                },
+            ],
+        });
+
+        this.start();
+        return this;
+    }
+
+    createDefault() {        
+        let newRecord = this.make[this.getModelName()]({
+            _id: null,
+            <% for (let fieldName of fields){ %><%- fieldName %>: null,
+            <% } %>
+        });
+        return newRecord;
+    }
+}
+
+export default nc<%- ModelName %>Common;

package/tmpl/files/module.server/layers/controllers/common/index.ejs

@@ -0,0 +1,59 @@
+import main from "../common/ws.client.main.js";
+
+<% for (let {ModelName} of entities){ %>
+import nc<%- {ModelName} %> from "./nc<%- {ModelName} %>.js";
+<% } %>
+
+const wsc = {
+    main,
+};
+
+const uis = {};
+
+const services = {};
+
+let manifest = {
+    router: {
+        manifest: [
+            <% for (let {ModelName} of entities){ %>
+            nc<%- {ModelName} %>.getRoutes(),
+            <% } %>
+        ],
+    },
+    menu: {
+        top: {
+            items: [
+                /*
+                {
+                    id: "itemId",
+                    section: "sectionId",
+                    title: "Item title",
+                },
+                */
+            ],
+        },
+        side: {
+            sections: [
+                /*
+                {
+                    id: "sectionId",                
+                    title: "Section title",
+                },
+                */
+            ],
+            items: [
+                /*
+                {
+                    priority: 10, //higher goes on top
+                    id: "sectionId.item",
+                    section: "sectionId",
+                    title: "Item title",
+                    url: "/some/localUrl",
+                },
+                */                
+            ],
+        },
+    },
+};
+
+export { manifest, wsc, services, uis};

package/tmpl/files/module.server/layers/controllers/common/validators.ejs

@@ -0,0 +1,44 @@
+import notValidationError from 'not-error/src/validation.error.browser.js';
+/*
+import vVariableLength from '../../fields/validators/variableLength.js';
+const ERR_MSG_FORM_IS_DIRTY = '<%- ModuleName %>:form_is_dirty';
+const ERR_MSG_FORM_VARIABLE_SHOULD_BE_LONGER_THAN_TEN_CHARS = '<%- ModuleName %>:form_variable_should_be_longer_than_ten_chars';
+
+
+const actionName<%- ModelName %>Validation = async (data) => {
+  if (data.variable.length < 10) {
+    throw new notValidationError(ERR_MSG_FORM_VARIABLE_SHOULD_BE_LONGER_THAN_TEN_CHARS, {
+    //form wide status
+      form: [ERR_MSG_FORM_IS_DIRTY],
+      fields: {
+        //errors in fields
+        variable: [ERR_MSG_FORM_VARIABLE_SHOULD_BE_LONGER_THAN_TEN_CHARS]
+      }
+    });
+  }
+};
+
+*/
+
+const Validators = {
+  
+  //val - value of field
+  //env - resources (constants, config reader, third party libs) needed for validation and provided from module level
+  //(val:any, env: Object)=>Promise<Boolean>
+  fields: {
+    /*
+    variable: vVariableLength,
+    */
+  },
+  //form - object with form values
+  //env - resources needed for validation and provided from module level
+  //(form:Object, env: Object)=>Promise<Boolean>
+  forms: {
+    /*
+    create: [actionName<%- ModelName %>Validation],
+    update: [actionName<%- ModelName %>Validation]
+    */
+  }
+};
+
+export default Validators;

package/tmpl/files/module.server/layers/controllers/common/ws.client.ejs

@@ -0,0 +1,25 @@
+import { notCommon } from "not-bulma";
+
+/*
+async function onEventHandler(payload) {
+    try {
+        //passing event through Application as a event bus
+        notCommon.getApp().emit("modelName//eventName", payload);
+    } catch (e) {
+        notCommon.error(e);
+    }
+}
+*/
+
+const main = {
+    router: {
+        routes: {
+            event: {
+                //"modelName//eventName": onEventHandler,
+
+            },
+        },
+    },
+};
+
+export default main;

package/tmpl/files/module.server/layers/controllers/role/crud.ejs

@@ -0,0 +1,11 @@
+import nc<%- ModelName %>Common from '../common/nc<%- ModelName %>Common.js';
+
+
+class nc<%- ModelName %> extends nc<%- ModelName %>Common {
+  constructor(app, params) {
+    super(app, params);
+    return this;
+  }
+}
+
+export default nc<%- ModelName %>;

package/tmpl/files/module.server/layers/controllers/role/index.ejs

@@ -0,0 +1,29 @@
+<% for (let {ModelName} of entities){ %>
+import nc<%- ModelName %> from "./nc<%- ModelName %>.js";
+<% } %>
+
+const wsc = {};
+const uis = {};
+const services = {};
+
+let manifest = {
+    router: {
+        manifest: [
+            <% for (let {ModelName} of entities){ %>
+            nc<%- ModelName %>.getRoutes(),
+            <% } %>
+        ],
+    },
+    menu: {
+        top: {
+            sections: [],
+            items: [],
+        },
+        side: {
+            sections: [],
+            items: [],
+        },
+    },
+};
+
+export { manifest, wsc, services, uis};

package/tmpl/files/module.server/layers/fields.ejs

@@ -0,0 +1,30 @@
+module.exports = {
+    <% if(ui){ %>
+    ui: {        
+        component: "<%- ui.component %>",
+        label: "<%- ui.label %>",
+        placeholder: "<%- ui.placeholder %>",
+        readonly: <%= ui.readonly %>,
+    },
+    <% } %>
+    <% if(model){ %>
+    model: {
+        type: <%= model.type %>,
+        <% if (model?.ref){ %>
+        ref: "<%= model.ref %>",
+        <% } %>
+        <% if (Object.hasOwn(model, 'required')){ %>
+        required: <%= model?.required ?? false %>,
+        <% } %>
+        <% if (Object.hasOwn(model, 'default')){ %>
+        default: <%= model.default %>,
+        <% } %>
+        searchable: <%= model?.searchable ?? true %>,
+        sortable: <%= model?.sortable ?? true %>,
+        safe: {
+            update: ["@owner", "root", "admin"],
+            read: ["@owner", "root", "admin"],
+        },
+    },
+    <% } %>
+};

package/tmpl/files/module.server/layers/forms/_data.ejs

@@ -0,0 +1,35 @@
+const { MODULE_NAME } = require("../const");
+
+const Form = require("not-node").Form;
+
+const FIELDS = [
+    <% if (fields && Array.isArray(fields)) { %>
+    <% for(let field of fields){ %>
+    <%- `"${field}",` -%>
+    <% } %>
+    <% } %>
+    ["owner", "not-node//owner"],
+    ["ownerModel", "not-node//ownerModel"],
+];
+
+const FORM_NAME = `${MODULE_NAME}:_<%- ModelName %>DataForm`;
+
+
+//const validateTitle = require("./validators/title.js");
+
+module.exports = class _DataForm extends Form {
+    constructor({ app }) {
+        super({ FIELDS, FORM_NAME, app });
+    }
+
+    extract(data) {
+        return data;
+    }
+
+    getFormValidationRules() {
+        return [
+            //add validators here
+            //validateTitle,
+        ];
+    }
+};

package/tmpl/files/module.server/layers/forms/create.ejs

@@ -0,0 +1,47 @@
+const getIP = require("not-node").Auth.getIP;
+const { MODULE_NAME } = require("../const");
+//DB related validation tools
+const Form = require("not-node").Form;
+//form
+const FIELDS = [    
+    <% if (fields && Array.isArray(fields)) { %>
+    <% for(let field of fields){ %>
+    "<%- field %>",
+    <% } %>
+    <% } %>
+];
+
+const FORM_NAME = `${MODULE_NAME}:<%- ModelName %>CreateForm`;
+
+/**
+ *
+ **/
+module.exports = class <%- ModelName %>CreateForm extends Form {
+    constructor({ app }) {
+        super({ FIELDS, FORM_NAME, app });
+    }
+
+    /**
+     * Extracts data
+     * @param {ExpressRequest} req expressjs request object
+     * @return {Object}        forma data
+     **/
+    extract(req) {
+        const ip = getIP(req);
+        const instructions = {
+            <% if (fields && Array.isArray(fields)) { %>
+            <% for(let field of fields){ %>
+            <%- field+': "extractFromBody",' -%>
+            <% } %>
+            <% } %>            
+            owner: "activeUserId",
+            ownerModel: "activeUserModelName",
+        };
+        const data = this.extractByInstructions(req, instructions);        
+        return {
+            activeUser: req.user,
+            ip,
+            data,
+        };
+    }
+};

package/tmpl/files/module.server/layers/forms/delete.ejs

@@ -0,0 +1,8 @@
+const { MODULE_NAME } = require("../const");
+//DB related validation tools
+const notNode = require("not-node");
+
+module.exports = notNode.Generic.GenericGetByIdForm({
+    MODULE_NAME,
+    actionName: "delete",
+});

package/tmpl/files/module.server/layers/forms/get.ejs

@@ -0,0 +1,8 @@
+const { MODULE_NAME } = require("../const");
+//DB related validation tools
+const notNode = require("not-node");
+
+module.exports = notNode.Generic.GenericGetByIdForm({
+    MODULE_NAME,
+    actionName: "get",
+});

package/tmpl/files/module.server/layers/forms/getRaw.ejs

@@ -0,0 +1,8 @@
+const { MODULE_NAME } = require("../const");
+//DB related validation tools
+const notNode = require("not-node");
+
+module.exports = notNode.Generic.GenericGetByIdForm({
+    MODULE_NAME,
+    actionName: "getRaw",
+});

package/tmpl/files/module.server/layers/forms/listAll.ejs

@@ -0,0 +1,8 @@
+const notNode = require("not-node");
+const { MODULE_NAME } = require("../const");
+
+module.exports = notNode.Generic.GenericListAndCountForm({
+    MODULE_NAME,
+    MODEL_NAME: "<%- ModelName %>",
+    actionName: "listAll",
+});

package/tmpl/files/module.server/layers/forms/listAndCount.ejs

@@ -0,0 +1,8 @@
+const notNode = require("not-node");
+const { MODULE_NAME } = require("../const");
+
+module.exports = notNode.Generic.GenericListAndCountForm({
+    MODULE_NAME,
+    MODEL_NAME: "<%- ModelName %>",
+    actionName: "listAndCount",
+});

package/tmpl/files/module.server/layers/forms/update.ejs

@@ -0,0 +1,40 @@
+const { MODULE_NAME } = require("../const");
+const Form = require("not-node").Form;
+const getIP = require("not-node").Auth.getIP;
+
+const FIELDS = [
+    ["targetId", { required: true }, "not-node//objectId"],
+    ["activeUser", "not-node//requiredObject"],
+    ["data", `${ModuleName}//_${ModelName}_data`],  //sub forms validators should start with underscore
+    ["ip", "not-node//ip"],
+];
+const FORM_NAME = `${ModuleName}:<%- ModelName %>UpdateForm`;
+
+module.exports = class <%- ModelName %>UpdateForm extends Form {
+    constructor({ app }) {
+        super({ FIELDS, FORM_NAME, app });
+    }
+
+    extract(req) {
+        const instructions = {
+            <% if (fields && Array.isArray(fields)) { %>
+            <% for(let field of fields){ %>
+            <%- field+': "extractFromBody",' -%>
+            <% } %>
+            <% } %>
+            owner: "fromBody",
+            ownerModel: "fromBody",
+        };
+        const data = this.extractByInstructions(req, instructions);
+        if (!req.user.isRoot() && !req.user.isAdmin()) {
+            data.owner = req.user._id;
+            data.ownerModel = "User";
+        }
+        return {
+            targetId: req.params._id.toString(),
+            activeUser: req.user,
+            data,
+            ip: getIP(req),
+        };
+    }
+};

package/tmpl/files/module.server/layers/forms/validator.ejs

@@ -0,0 +1,32 @@
+const notNode = require("not-node");
+const { notValidationError } = require("not-error");
+
+module.exports = async (
+    /**
+    *   Values to validate in form
+    */
+    {owner, ownerModel, vals, to , validate }, 
+    /**
+    * special container to pass around global validation libs, CONSTs and inject other entities
+    */
+    validationEnvs
+    ) => {
+    //some preparations
+    if (
+        //vals checks
+    ) {
+        throw new notValidationError(
+            "<%- ModuleName %>:validation_error",
+            {
+                //vals: ["%- ModuleName %>:vals_should_be_valid"],
+            },
+            undefined, //no source error, its custom exception
+            {
+                //information
+                //vals,
+                //owner,
+                //ownerModel
+            }
+        );
+    }
+};