not-node 6.4.13 → 6.5.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "not-node",
-	"version": "6.4.13",
+	"version": "6.5.0",
 	"description": "node complimentary part for client side notFramework.",
 	"main": "index.js",
 	"scripts": {

package/src/bootstrap/route.js

@@ -4,7 +4,10 @@ const getApp = require("../getApp.js"),
     configInit = require("not-config"),
     { sayForModule } = require("not-locale"),
     { objHas, isFunc, executeFunctionAsAsync } = require("../common"),
-    LogInit = require("not-log");
+    LogInit = require("not-log"),
+    genericFormsGenerators = require("../generic/forms"),
+    createDefaultFormInstance = require("../generic/form.js");
+
 module.exports = ({
     target,
     MODULE_NAME,
@@ -33,7 +36,9 @@ module.exports = ({
     accessRulesBuilders = {}, //per action builders, {actionName: (preapared: any, req: ExpressRequest)=>{/** pass or throw an exception **/ */}}
     accessRuleBuilder = false, //universal will be used if no dedicated action builder was found
     defaultAccessRule = false, //if builder is not found, safe by default
-    createForm = Form.createDefaultInstance,
+    createForm = createDefaultFormInstance,
+    formValidators = {},
+    dataValidators = {},
 }) => {
     const Log = LogInit(target, `${MODEL_NAME}/Routes'`);
     const say = sayForModule(MODULE_NAME);
@@ -80,26 +85,66 @@ module.exports = ({
         }
     };
 
+    const initGenericActionForm = ({
+        app,
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName,
+        validators,
+        dataValidators,
+    }) => {
+        if (Object.keys(genericFormsGenerators).includes(actionName)) {
+            return new genericFormsGenerators[actionName]({
+                app,
+                MODULE_NAME,
+                MODEL_NAME,
+                actionName,
+                validators,
+                dataValidators,
+            })(app);
+        } else {
+            createForm({
+                app: getApp(),
+                MODULE_NAME,
+                MODEL_NAME,
+                actionName,
+            });
+        }
+    };
+
     const getForm = (actionName) => {
-        const form = getApp().getForm(
-            Form.createPath(MODULE_NAME, MODEL_NAME, actionName)
+        //trying inited and cached
+        const fullFormPath = Form.createPath(
+            MODULE_NAME,
+            MODEL_NAME,
+            actionName
         );
+        const form = getApp().getForm(fullFormPath);
         if (form) {
             return form;
         }
+
         const form2 = getApp().getForm(
             Form.createPath(MODULE_NAME, undefined, actionName)
         );
+
         if (form2) {
             return form2;
         }
-
-        return createForm({
-            app: getApp(),
+        //creating new from generics lib
+        const newelyCreatedForm = initGenericActionForm({
             MODULE_NAME,
             MODEL_NAME,
             actionName,
+            app: getApp(),
+            validators: formValidators,
+            dataValidators,
         });
+        //caching
+        getApp()
+            .getModule(MODULE_NAME)
+            .setForm(fullFormPath.split("//")[1], newelyCreatedForm);
+        return newelyCreatedForm;
     };
 
     const beforeDecorator = async (req, res, next) => {

package/src/form/form.js

@@ -116,6 +116,7 @@ class Form {
         this.#MODEL_NAME = MODEL_NAME;
         this.#MODULE_NAME = MODULE_NAME;
         this.#setFields(app, FIELDS);
+
         this.#createValidationSchema(app);
         this.#augmentValidationSchema();
         this.#addInstructions(INSTRUCTIONS);
@@ -202,24 +203,6 @@ class Form {
         }
     }
 
-    /**
-     *
-     * @param   {object} options
-     * @param   {import('../app.js')}   options.app
-     * @param   {string}   options.MODULE_NAME
-     * @param   {string}   options.MODEL_NAME
-     * @param   {string}   options.actionName
-     * @returns {object}    instance of Form
-     */
-    static createDefaultInstance({ app, MODULE_NAME, MODEL_NAME, actionName }) {
-        const FIELDS = [
-            ["identity", "not-node//identity"],
-            ["data", `${MODULE_NAME}//_${firstLetterToLower(MODEL_NAME)}`],
-        ];
-        const FORM_NAME = Form.createName(MODULE_NAME, MODEL_NAME, actionName);
-        return new Form({ FIELDS, FORM_NAME, app, MODULE_NAME });
-    }
-
     /**
      *
      *

package/src/generic/field._data.js

@@ -1,8 +1,57 @@
 const Schema = require("mongoose").Schema;
 const getApp = require("../getApp");
 const { firstLetterToLower } = require("../common");
+const genericDataForm = require("./forms/form._data");
+const Form = require("../form/form");
 
-module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "data" }) => {
+const initGenericDataForm = ({
+    MODULE_NAME,
+    MODEL_NAME,
+    actionName,
+    formName,
+    validators = [],
+    afterExtract = async (input /*, req = null*/) => input,
+}) => {
+    try {
+        const cls = genericDataForm({
+            MODULE_NAME,
+            MODEL_NAME,
+            actionName,
+            validators,
+            afterExtract,
+        });
+        const App = getApp();
+        App.getModule(MODULE_NAME).setFormConstructor(formName, cls);
+        App.getModule(MODULE_NAME).setForm(formName, new cls(App));
+        return true;
+    } catch (e) {
+        getApp().logger.error(e);
+        return false;
+    }
+};
+
+module.exports = ({
+    MODULE_NAME,
+    MODEL_NAME,
+    actionName = "_data",
+    FORM_PATH,
+    validators = [],
+    afterExtract = async (input /*, req = null*/) => input,
+}) => {
+    if (!FORM_PATH) {
+        FORM_PATH = Form.createPath(MODULE_NAME, MODEL_NAME, actionName);
+    }
+    const formName = FORM_PATH.split("//")[1];
+    if (!getApp().getModule(MODULE_NAME).getFormConstructor(formName)) {
+        initGenericDataForm({
+            MODULE_NAME,
+            MODEL_NAME,
+            actionName,
+            formName,
+            validators,
+            afterExtract,
+        });
+    }
     return {
         model: {
             type: Schema.Types.Mixed,
@@ -10,9 +59,7 @@ module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "data" }) => {
             validate: [
                 {
                     validator(val) {
-                        return getApp()
-                            .getForm(`${MODULE_NAME}//_${actionName}`)
-                            .run(val);
+                        return getApp().getForm(FORM_PATH).run(val);
                     },
                     message: `${MODULE_NAME}:${firstLetterToLower(
                         MODEL_NAME

package/src/generic/field.js

@@ -0,0 +1,54 @@
+const getApp = require("../getApp");
+const genericDataField = require("./field._data");
+const Form = require("../form/form");
+
+const initGenericDataField = (
+    MODULE_NAME,
+    MODEL_NAME,
+    actionName = "_data",
+    validators = [],
+    afterExtract = async (input /*, req = null*/) => input
+) => {
+    //not-module//modelName._data
+    const fieldGenericPath = Form.createPath(
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName
+    );
+    //modelName._data
+    const fieldGenericName = fieldGenericPath.split("//")[1];
+    const App = getApp();
+    //if already exists - returning full path to it
+    if (App.getModule(MODULE_NAME).getField(fieldGenericName)) {
+        return fieldGenericPath;
+    }
+    //create new definition, register, return
+    return genericDataField({
+        MODULE_NAME,
+        MODEL_NAME,
+        FORM_PATH: fieldGenericPath,
+        validators,
+        afterExtract,
+    });
+};
+
+const getGenericDataField = ({
+    fieldPath,
+    MODULE_NAME,
+    MODEL_NAME,
+    validators,
+    afterExtract,
+}) => {
+    if (getApp().getField(fieldPath)) {
+        return fieldPath;
+    } else {
+        return initGenericDataField({
+            MODULE_NAME,
+            MODEL_NAME,
+            validators,
+            afterExtract,
+        });
+    }
+};
+
+module.exports = { getGenericDataField, initGenericDataField };

package/src/generic/form.js

@@ -0,0 +1,29 @@
+const Common = require("../common.js");
+const Form = require("../form/form.js");
+
+/**
+ *
+ * @param   {object} options
+ * @param   {import('../app.js')}   options.app
+ * @param   {string}   options.MODULE_NAME
+ * @param   {string}   options.MODEL_NAME
+ * @param   {string}   options.actionName
+ * @returns {object}    instance of Form
+ */
+function createDefaultInstance({
+    app,
+    MODULE_NAME,
+    MODEL_NAME,
+    actionName,
+    /* validators = [],
+    dataValidators = [],*/
+}) {
+    const FIELDS = [
+        ["identity", "not-node//identity"],
+        ["data", `${MODULE_NAME}//_${Common.firstLetterToLower(MODEL_NAME)}`],
+    ];
+    const FORM_NAME = Form.createName(MODULE_NAME, MODEL_NAME, actionName);
+    return new Form({ FIELDS, FORM_NAME, app, MODULE_NAME });
+}
+
+module.exports = createDefaultInstance;

package/src/generic/{form._data.js → forms/form._data.js}

@@ -1,4 +1,4 @@
-const Form = require("../form/form");
+const Form = require("../../form/form");
 
 module.exports = ({
     MODULE_NAME,

package/src/generic/{form.authorizedAction.js → forms/form.authorizedAction.js}

@@ -1,5 +1,5 @@
 //DB related validation tools
-const Form = require("../form/form");
+const Form = require("../../form/form");
 
 //form
 const STANDART_FIELDS = [["identity", "not-node//identity"]];

package/src/generic/forms/form.count.js

@@ -0,0 +1,9 @@
+const genericListForm = require("./form.list");
+
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "count" }) => {
+    return genericListForm({
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName,
+    });
+};

package/src/generic/forms/form.create.js

@@ -0,0 +1,58 @@
+const Form = require("../../form/form");
+const { getGenericDataField } = require("../field");
+/**
+ * Creates generic Crud form, if data field is not defined in fields/ it creates and registers field in module and sub _data form
+ *
+ * @param {Object}              param
+ * @param {string}              param.MODULE_NAME
+ * @param {string}              param.MODEL_NAME
+ * @param {string}              [param.actionName="create"]
+ * @param {string}              [param.dataFieldName = "_data"]
+ * @param {Array<function>}     [param.validators = []]
+ * @param {Array<function>}     [param.dataValidators = []],
+ * @param {function}            [param.afterExtract = async (input , req) => input]
+ * @param {function}            [param.afterDataExtract = async (input,  req) => input]
+ */
+module.exports = ({
+    MODULE_NAME,
+    MODEL_NAME,
+    actionName = "create",
+    dataFieldName = "data",
+    validators = [],
+    dataValidators = [],
+    afterExtract = async (input /*, req*/) => input,
+    afterDataExtract = async (input /*, req*/) => input,
+}) => {
+    const defaultDataFieldPath = Form.createPath(
+        MODULE_NAME,
+        MODEL_NAME,
+        dataFieldName
+    );
+
+    const dataFieldDefinition = getGenericDataField({
+        fieldPath: defaultDataFieldPath,
+        MODULE_NAME,
+        MODEL_NAME,
+        validators: dataValidators,
+        afterExtract: afterDataExtract,
+    });
+
+    const FIELDS = [
+        ["identity", "not-node//identity"],
+        ["data", dataFieldDefinition],
+    ];
+    return class extends Form {
+        constructor({ app }) {
+            super({ FIELDS, app, MODULE_NAME, MODEL_NAME, actionName });
+        }
+
+        async afterExtract(input, req) {
+            input = await super.afterExtract(input, req);
+            return await afterExtract(input, req);
+        }
+
+        getFormValidationRules() {
+            return validators;
+        }
+    };
+};

package/src/generic/forms/form.delete.js

@@ -0,0 +1,9 @@
+const genericGetByIdForm = require("./form.getById");
+
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "delete" }) => {
+    return genericGetByIdForm({
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName,
+    });
+};

package/src/generic/forms/form.get.js

@@ -0,0 +1,9 @@
+const genericGetByIdForm = require("./form.getById");
+
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "get" }) => {
+    return genericGetByIdForm({
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName,
+    });
+};

package/src/generic/{form.getByID.js → forms/form.getByID.js}

@@ -1,5 +1,5 @@
 //DB related validation tools
-const Form = require("../form/form");
+const Form = require("../../form/form");
 
 //form
 const FIELDS = [

package/src/generic/{form.getById.js → forms/form.getById.js}

@@ -1,5 +1,5 @@
 //DB related validation tools
-const Form = require("../form/form");
+const Form = require("../../form/form");
 
 //form
 const FIELDS = [

package/src/generic/forms/form.getRaw.js

@@ -0,0 +1,9 @@
+const genericGetByIdForm = require("./form.getById");
+
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "getRaw" }) => {
+    return genericGetByIdForm({
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName,
+    });
+};

package/src/generic/{form.list.js → forms/form.list.js}

@@ -1,7 +1,7 @@
-const Form = require("../form/form");
+const Form = require("../../form/form");
 
 const notFilter = require("not-filter");
-const notAppIdentity = require("../identity");
+const notAppIdentity = require("../../identity");
 
 const FIELDS = [
     ["query", `not-filter//_filterQuery`],
@@ -32,8 +32,8 @@ const FactoryFormList = ({ MODULE_NAME, MODEL_NAME, actionName = "list" }) => {
         /**
          *
          *
-         * @param {import('../types').notNodeExpressRequest} req
-         * @return {Promise<import('../types').PreparedData>}
+         * @param {import('../../types').notNodeExpressRequest} req
+         * @return {Promise<import('../../types').PreparedData>}
          */
         async extract(req) {
             const envs = this.extractRequestEnvs(req);

package/src/generic/forms/form.listAll.js

@@ -0,0 +1,9 @@
+const genericAuthorizedActionForm = require("./form.authorizedAction");
+
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName = "listAll" }) => {
+    return genericAuthorizedActionForm({
+        MODULE_NAME,
+        MODEL_NAME,
+        actionName,
+    });
+};

package/src/generic/{form.listAndCount.js → forms/form.listAndCount.js}

@@ -1,7 +1,7 @@
-const Form = require("../form/form");
+const Form = require("../../form/form");
 
 const notFilter = require("not-filter");
-const notAppIdentity = require("../identity");
+const notAppIdentity = require("../../identity");
 
 const FIELDS = [
     ["query", `not-filter//_filterQuery`],
@@ -36,8 +36,8 @@ const FactoryFormListAndCount = ({
         /**
          *
          *
-         * @param {import('../types').notNodeExpressRequest} req
-         * @return {Promise<import('../types').PreparedData>}
+         * @param {import('../../types').notNodeExpressRequest} req
+         * @return {Promise<import('../../types').PreparedData>}
          */
         async extract(req) {
             const envs = this.extractRequestEnvs(req);

package/src/generic/forms/form.update.js

@@ -0,0 +1,62 @@
+const Form = require("../../form/form");
+const { getGenericDataField } = require("../field");
+/**
+ * Creates generic crUd form, if data field is not defined in fields/ it creates and registers field in module and sub _data form
+ *
+ * @param {Object}              param
+ * @param {string}              param.MODULE_NAME
+ * @param {string}              param.MODEL_NAME
+ * @param {string}              [param.actionName="update"]
+ * @param {string}              [param.dataFieldName = "_data"]
+ * @param {Array<function>}     [param.validators = []]
+ * @param {Array<function>}     [param.dataValidators = []],
+ * @param {function}            [param.afterExtract = async (input , req) => input]
+ * @param {function}            [param.afterDataExtract = async (input,  req) => input]
+ */
+function genericUpdateForm({
+    MODULE_NAME,
+    MODEL_NAME,
+    actionName = "update",
+    dataFieldName = "_data",
+    validators = [],
+    dataValidators = [],
+    afterExtract = async (input /*, req*/) => input,
+    afterDataExtract = async (input /*, req*/) => input,
+}) {
+    const defaultDataFieldPath = Form.createPath(
+        MODULE_NAME,
+        MODEL_NAME,
+        dataFieldName
+    );
+
+    const dataFieldDefinition = getGenericDataField({
+        fieldPath: defaultDataFieldPath,
+        MODULE_NAME,
+        MODEL_NAME,
+        validators: dataValidators,
+        afterExtract: afterDataExtract,
+    });
+
+    const FIELDS = [
+        ["targetId", { required: true }, "not-node//objectId"],
+        ["identity", "not-node//identity"],
+        ["data", dataFieldDefinition],
+    ];
+
+    return class extends Form {
+        constructor({ app }) {
+            super({ FIELDS, app, MODULE_NAME, MODEL_NAME, actionName });
+        }
+
+        async afterExtract(input, req) {
+            input = await super.afterExtract(input, req);
+            return await afterExtract(input, req);
+        }
+
+        getFormValidationRules() {
+            return validators;
+        }
+    };
+}
+
+module.exports = genericUpdateForm;

package/src/generic/forms/index.js

@@ -0,0 +1,12 @@
+module.exports = {
+    create: require("./form.create"),
+    update: require("./form.update"),
+    list: require("./form.list"),
+    listAndCount: require("./form.listAndCount"),
+    listAll: require("./form.listAll"),
+    count: require("./form.count"),
+    get: require("./form.get"),
+    getByID: require("./form.getByID"),
+    getRaw: require("./form.getRaw"),
+    delete: require("./form.delete"),
+};

package/src/generic/index.js

@@ -1,14 +1,14 @@
 module.exports.GenericLogic = require("./logic.js");
 module.exports.GenericRoute = require("./route.js");
-module.exports.GenericGetByIdForm = require("./form.getById.js");
-module.exports.GenericGetByIDForm = require("./form.getByID.js");
+module.exports.GenericGetByIdForm = require("./forms/form.getById.js");
+module.exports.GenericGetByIDForm = require("./forms/form.getByID.js");
 module.exports.GenericDataField = require("./field._data.js");
-module.exports.GenericDataForm = require("./form._data.js");
-module.exports.GenericCreateForm = require("./form.create.js");
-module.exports.GenericUpdateForm = require("./form.update.js");
-module.exports.GenericAuthorizedActionForm = require("./form.authorizedAction.js");
-module.exports.GenericListAndCountForm = require("./form.listAndCount.js");
-module.exports.GenericListForm = require("./form.list.js");
+module.exports.GenericDataForm = require("./forms/form._data.js");
+module.exports.GenericCreateForm = require("./forms/form.create.js");
+module.exports.GenericUpdateForm = require("./forms/form.update.js");
+module.exports.GenericAuthorizedActionForm = require("./forms/form.authorizedAction.js");
+module.exports.GenericListAndCountForm = require("./forms/form.listAndCount.js");
+module.exports.GenericListForm = require("./forms/form.list.js");
 
 const FORMS = {};
 

package/src/generic/form.create.js

@@ -1,29 +0,0 @@
-const Form = require("../form/form");
-
-module.exports = ({
-    MODULE_NAME,
-    MODEL_NAME,
-    actionName = "create",
-    dataFieldName = "data",
-    validators = [],
-    afterExtract = async (input /*, req*/) => input,
-}) => {
-    const FIELDS = [
-        ["identity", "not-node//identity"],
-        ["data", `${MODULE_NAME}//_${dataFieldName}`],
-    ];
-    return class extends Form {
-        constructor({ app }) {
-            super({ FIELDS, app, MODULE_NAME, MODEL_NAME, actionName });
-        }
-
-        async afterExtract(input, req) {
-            input = await super.afterExtract(input, req);
-            return await afterExtract(input, req);
-        }
-
-        getFormValidationRules() {
-            return validators;
-        }
-    };
-};

package/src/generic/form.update.js

@@ -1,31 +0,0 @@
-const Form = require("../form/form");
-
-module.exports = ({
-    MODULE_NAME,
-    MODEL_NAME,
-    actionName = "update",
-    dataFieldName = "data",
-    validators = [],
-    afterExtract = async (input /*, req*/) => input,
-}) => {
-    const FIELDS = [
-        ["targetId", { required: true }, "not-node//objectId"],
-        ["identity", "not-node//identity"],
-        ["data", `${MODULE_NAME}//_${dataFieldName}`],
-    ];
-
-    return class extends Form {
-        constructor({ app }) {
-            super({ FIELDS, app, MODULE_NAME, MODEL_NAME, actionName });
-        }
-
-        async afterExtract(input, req) {
-            input = await super.afterExtract(input, req);
-            return await afterExtract(input, req);
-        }
-
-        getFormValidationRules() {
-            return validators;
-        }
-    };
-};