not-node 6.3.0 → 6.3.2

package/src/form/fabric.js

@@ -12,10 +12,10 @@ module.exports = class FormFabric {
 
             /**
              * Extracts data
-             * @param {ExpressRequest} req expressjs request object
-             * @return {Object}        forma data
+             * @param {import('../types').notNodeExpressRequest} req expressjs request object
+             * @return {Promise<Object>}        forma data
              **/
-            extract(req) {
+            async extract(req) {
                 return extractor(req);
             }
         };

package/src/form/form.js

@@ -9,7 +9,7 @@ const { objHas, isFunc, firstLetterToUpper } = require("../common");
 const ValidationBuilder = require("not-validation").Builder;
 const ValidationSession = require("not-validation").Session;
 
-const { notValidationError, notError } = require("not-error");
+const { notValidationError, notError } = require("not-error/src");
 
 const {
     FormExceptionExtractorForFieldIsUndefined,
@@ -25,11 +25,12 @@ const DEFAULT_TRANSFORMERS = require("./transformers");
  **/
 class Form {
     /**
-     * @prop {SCHEMA} validation schema
+     * @prop {import('not-validation/src/builder').notValidationSchema} validation schema
      **/
     #SCHEMA = {
         fields: {},
         form: [],
+        forms: {},
     };
     /**
      * @prop {string} name of form
@@ -72,6 +73,13 @@ class Form {
         this.#addTransformers(TRANSFORMERS);
     }
 
+    /**
+     *
+     *
+     * @param {import('../types').notNodeExpressRequest} req
+     * @return {*}
+     * @memberof Form
+     */
     getModelName(req) {
         if (this.#MODEL_NAME) {
             return this.#MODEL_NAME;
@@ -81,6 +89,12 @@ class Form {
         return undefined;
     }
 
+    /**
+     *
+     *
+     * @return {string}
+     * @memberof Form
+     */
     getModuleName() {
         return this.#MODULE_NAME;
     }
@@ -88,9 +102,9 @@ class Form {
     /**
      * Extract data from ExpressRequest object and validates it
      * returns it or throws
-     * @param {ExpressRequest} req expressjs request object
-     * @return {Promise<Object>} form data
-     * @throws {notValidationError}
+     * @param   {import('../types').notNodeExpressRequest}   req expressjs request object
+     * @return  {Promise<Object>} form data
+     * @throws  {notValidationError}
      **/
     async run(req) {
         let data = await this.extract(req);
@@ -100,8 +114,8 @@ class Form {
 
     /**
      * Extracts data, should be overriden
-     * @param {ExpressRequest} req expressjs request object
-     * @return {Object}        forma data
+     * @param {import('../types').notNodeExpressRequest} req expressjs request object
+     * @return {Promise<import('../types').PreparedData>}        forma data
      **/
     async extract(req) {
         return {
@@ -137,7 +151,7 @@ class Form {
      * if validation failes - returns error object with detail per field description
      * of errors
      * @param {object} data input data for validation
-     * @returns {Promise<void>} resolves or throwing notValidationError or notError if reason is unknown
+     * @returns {Promise<undefined>} resolves or throwing notValidationError or notError if reason is unknown
      **/
     async validate(data) {
         try {
@@ -205,7 +219,7 @@ class Form {
 
     /**
      * Returns array of validators
-     * @return {Arrays<Object>}
+     * @return {Array<Object>}
      **/
     getValidatorsForField(fieldName) {
         return this.#SCHEMA.fields[fieldName];
@@ -255,7 +269,7 @@ class Form {
     /**
      * Validates form data or throws
      * @param {Object} data    form data
-     * @return {Object}
+     * @return {Promise<Object>}
      * @throws {notValidationError}
      **/
     async #_validate(data) {
@@ -363,6 +377,11 @@ class Form {
         }
     }
 
+    /**
+     *
+     * @param {import('../types').notNodeExpressRequest}   req     Express Request
+     * @returns {Array<string>|Array<Array<string>>}
+     */
     extractActionFieldsFromRequest(req) {
         if (
             req?.notRouteData?.actionData?.fields &&
@@ -396,6 +415,13 @@ class Form {
         return result;
     }
 
+    /**
+     *
+     * @param {import('express').Request}   req
+     * @param {Array<string>}               mainInstruction
+     * @param {object}                      exceptions
+     * @returns
+     */
     extractByInstructionsFromRouteActionFields(
         req,
         mainInstruction = ["fromBody", "xss"],
@@ -411,6 +437,7 @@ class Form {
 
     /**
      * Value transformers
+     * @param   {object}    transformers
      */
     #addTransformers(transformers = {}) {
         if (transformers) {

package/src/generic/form.authorizedAction.js

@@ -1,8 +1,6 @@
 //DB related validation tools
 const Form = require("../form/form");
 const { firstLetterToUpper } = require("../common");
-//not-node
-const { getIP } = require("../auth");
 //form
 const FIELDS = [
     ["activeUserId", { required: true }, "not-node//objectId"],
@@ -10,18 +8,18 @@ const FIELDS = [
     ["ip", "not-node//ip"],
 ];
 
-module.exports = ({ MODULE_NAME, actionName }) => {
-    const FORM_NAME = `${MODULE_NAME}:${firstLetterToUpper(actionName)}Form`;
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
+    const FORM_NAME = `${MODULE_NAME}:${MODEL_NAME}:${firstLetterToUpper(
+        actionName
+    )}Form`;
     return class extends Form {
         constructor({ app }) {
             super({ FIELDS, FORM_NAME, app });
         }
 
-        extract(req) {
+        async extract(req) {
             return {
-                activeUser: req?.user,
-                activeUserId: req?.user._id,
-                ip: getIP(req),
+                ...this.extractRequestEnvs(req),
             };
         }
     };

package/src/generic/form.getByID.js

@@ -1,8 +1,6 @@
 //DB related validation tools
 const Form = require("../form/form");
-const { firstLetterToUpper, firstLetterToLower } = require("../common");
-//not-node
-const { getIP } = require("../auth");
+const { firstLetterToUpper } = require("../common");
 //form
 const FIELDS = [
     ["targetID", { required: true }, "not-node//ID"],
@@ -12,19 +10,19 @@ const FIELDS = [
 ];
 
 module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
-    const FORM_NAME = `${MODULE_NAME}:${firstLetterToUpper(actionName)}Form`;
+    const FORM_NAME = `${MODULE_NAME}:${MODEL_NAME}:${firstLetterToUpper(
+        actionName
+    )}Form`;
     return class extends Form {
         constructor({ app }) {
             super({ FIELDS, FORM_NAME, app });
         }
 
-        extract(req) {
-            const incField = `${firstLetterToLower(MODEL_NAME)}ID`;
+        async extract(req) {
+            const envs = this.extractRequestEnvs(req);
             return {
-                targetId: req.params[incField],
-                activeUser: req?.user,
-                activeUserId: req?.user._id,
-                ip: getIP(req),
+                ...envs,
+                targetId: envs.modelNameID,
             };
         }
     };

package/src/generic/form.getById.js

@@ -1,8 +1,7 @@
 //DB related validation tools
 const Form = require("../form/form");
 const { firstLetterToUpper } = require("../common");
-//not-node
-const { getIP } = require("../auth");
+
 //form
 const FIELDS = [
     ["targetId", { required: true }, "not-node//objectId"],
@@ -11,19 +10,19 @@ const FIELDS = [
     ["ip", "not-node//ip"],
 ];
 
-module.exports = ({ MODULE_NAME, actionName }) => {
-    const FORM_NAME = `${MODULE_NAME}:${firstLetterToUpper(actionName)}Form`;
+module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
+    const FORM_NAME = `${MODULE_NAME}:${MODEL_NAME}:${firstLetterToUpper(
+        actionName
+    )}Form`;
     return class extends Form {
         constructor({ app }) {
             super({ FIELDS, FORM_NAME, app });
         }
 
-        extract(req) {
+        async extract(req) {
+            const envs = this.extractRequestEnvs(req);
             return {
-                targetId: req.params._id,
-                activeUser: req?.user,
-                activeUserId: req?.user._id,
-                ip: getIP(req),
+                ...envs,
             };
         }
     };

package/src/generic/form.listAndCount.js

@@ -1,8 +1,6 @@
 const Form = require("../form/form");
 const { firstLetterToUpper } = require("../common");
-const { getIP } = require("../auth");
 const notFilter = require("not-filter");
-const getApp = require("../getApp");
 
 const FIELDS = [
     ["query", `not-filter//_filterQuery`],
@@ -11,42 +9,46 @@ const FIELDS = [
     ["ip", "not-node//ip"],
 ];
 
-module.exports = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
+/**
+ * Generates generic form to get perform list and count action
+ *
+ * @param {object}  params
+ * @param {string}  params.MODULE_NAME  //module name
+ * @param {string}  params.MODEL_NAME   //model name
+ * @param {string}  params.actionName   //action name
+ * @return {Form}   form class definition
+ */
+const FactoryFormListAndCount = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
     const FORM_NAME = `${MODULE_NAME}:${MODEL_NAME}:${firstLetterToUpper(
         actionName
     )}Form`;
+
     return class extends Form {
         constructor({ app }) {
             super({ FIELDS, FORM_NAME, app });
         }
 
-        extract(req) {
-            const thisSchema = getApp().getModelSchema(
-                `${MODULE_NAME}//${MODEL_NAME}`
-            );
-            const { skip, size } = notFilter.pager.process(req), //skip,size
-                sorter = notFilter.sorter.process(req, thisSchema),
-                search = notFilter.search.process(req, thisSchema);
-            let filter = notFilter.filter.process(req, thisSchema);
-
+        /**
+         *
+         *
+         * @param {import('../types').notNodeExpressRequest} req
+         * @return {Promise<import('../types').PreparedData>}
+         */
+        async extract(req) {
+            const envs = this.extractRequestEnvs(req);
             if (!req.user.isRoot() && !req.user.isAdmin()) {
-                filter = notFilter.filter.modifyRules(filter, {
-                    owner: req.user._id,
-                });
+                envs.query.filter = notFilter.filter.modifyRules(
+                    envs.query.filter,
+                    {
+                        owner: req.user._id,
+                    }
+                );
             }
-
             return {
-                query: {
-                    skip,
-                    size,
-                    sorter,
-                    filter,
-                    search,
-                },
-                activeUser: req?.user,
-                activeUserId: req?.user._id,
-                ip: getIP(req),
+                ...envs,
             };
         }
     };
 };
+
+module.exports = FactoryFormListAndCount;

package/src/generic/logic.js

@@ -58,6 +58,11 @@ module.exports = ({
         static isOwner = isOwner;
         static ownerFieldName = ownerFieldName;
 
+        /**
+         *
+         * @param {import('../types').PreparedData}  prepared
+         * @returns {Promise<Object>}
+         */
         static async _create({
             action,
             data,
@@ -92,11 +97,7 @@ module.exports = ({
 
         /**
          * create item
-         * @param {Object}  prepared
-         * @param {Object}  prepared.data           data extracted from request
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               new document
          **/
         static async create({ data, activeUser, ip, root = false }) {
@@ -112,11 +113,7 @@ module.exports = ({
 
         /**
          * create item and own it
-         * @param {Object}  prepared
-         * @param {Object}  prepared.data           data extracted from request
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               new document
          **/
         static async createOwn({ data, activeUser, ip, root = false }) {
@@ -130,6 +127,11 @@ module.exports = ({
             });
         }
 
+        /**
+         *
+         * @param {import('../types').PreparedData}  prepared
+         * @returns {Promise<Object>}
+         */
         static async _updateOne({
             targetId,
             data,
@@ -169,12 +171,7 @@ module.exports = ({
 
         /**
          * update item
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.data           data extracted from request
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               updated document
          **/
         static async update({ targetId, data, activeUser, ip, root = false }) {
@@ -191,12 +188,7 @@ module.exports = ({
 
         /**
          * update own item
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.data           data extracted from request
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               updated document
          **/
         static async updateOwn({
@@ -219,12 +211,7 @@ module.exports = ({
 
         /**
          * get item with populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
-         * @param {boolean}  prepared.shouldOwn     if user should be owner of target
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async _getOne({
@@ -269,11 +256,7 @@ module.exports = ({
 
         /**
          * get item with populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async get({ targetId, activeUser, ip, root = false }) {
@@ -289,11 +272,7 @@ module.exports = ({
 
         /**
          * get activeUser own item with populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async getOwn({ targetId, activeUser, ip, root = false }) {
@@ -309,12 +288,7 @@ module.exports = ({
 
         /**
          * get item with populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetID       target item ID
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
-         * @param {boolean}  prepared.shouldOwn     if user should be owner of target
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async _getOneByID({
@@ -363,11 +337,7 @@ module.exports = ({
 
         /**
          * get item with populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetID       target item ID
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async getByID({ targetID, activeUser, ip, root = false }) {
@@ -383,11 +353,7 @@ module.exports = ({
 
         /**
          * get activeUser own item with populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetID       target item ID
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async getByIDOwn({ targetID, activeUser, ip, root = false }) {
@@ -403,12 +369,7 @@ module.exports = ({
 
         /**
          * get item without populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
-         * @param {boolean}  prepared.shouldOwn     if user should be owner of target
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async _getOneRaw({
@@ -448,11 +409,7 @@ module.exports = ({
 
         /**
          * get item without populated sub-documents
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async getRaw({ targetId, activeUser, ip, root = false }) {
@@ -468,11 +425,7 @@ module.exports = ({
 
         /**
          * get item without populated sub-documents, if it's owned by activeUser
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async getOwnRaw({ targetId, activeUser, ip, root = false }) {
@@ -488,11 +441,7 @@ module.exports = ({
 
         /**
          * removes item by id, if activeUser is its owner
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async _delete({
@@ -562,11 +511,7 @@ module.exports = ({
 
         /**
          * removes item by id
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async delete({ targetId, activeUser, ip, root = false }) {
@@ -582,11 +527,7 @@ module.exports = ({
 
         /**
          * removes item by id, if activeUser is its owner
-         * @param {Object}  prepared
-         * @param {Object}  prepared.targetId       target item _id
-         * @param {Object}  prepared.activeUser     current user info
-         * @param {string}  prepared.ip             current user ip
-         * @param {boolean}  prepared.root          current user is root
+         * @param {import('../types').PreparedData}  prepared
          * @returns {Promise<Object>}               requested document
          **/
         static async deleteOwn({ targetId, activeUser, ip, root = false }) {
@@ -600,6 +541,11 @@ module.exports = ({
             });
         }
 
+        /**
+         *
+         * @param {import('../types').PreparedData}  prepared
+         * @returns {Promise<Array<Object>>}
+         */
         static async _listAll({
             activeUser,
             ip,

package/src/identity/index.js

@@ -14,8 +14,8 @@ module.exports = class notAppIdentity {
 
     /**
      *  Collects various authentification and authorization data from request object
-     *  @params {object}  req       ExpressRequest
-     * @return {object}  various authentification data for actor { root:boolean, auth: boolean, role: [string], uid: ObjectId, sid: string, ip:string }
+     *  @param {import('../types').notNodeExpressRequest}  req       ExpressRequest
+     *  @return {object}  various authentification data for actor { root:boolean, auth: boolean, role: [string], uid: ObjectId, sid: string, ip:string }
      */
     static extractAuthData(req) {
         const identity = this.#identity.of(req);
@@ -30,6 +30,10 @@ module.exports = class notAppIdentity {
         };
     }
 
+    /**
+     *
+     * @param    {import('../types').notNodeExpressRequest}     req
+     */
     constructor(req) {
         return notAppIdentity.identity.of(req);
     }

package/src/identity/providers/session.js

@@ -41,16 +41,18 @@ module.exports = class IdentityProviderSession {
      **/
     getPrimaryRole() {
         const roles = this.getRole();
-        for (let role of roles) {
-            if (
-                Array.isArray(
-                    IdentityProviderSession.#getOptions().primaryRoles
-                ) &&
-                IdentityProviderSession.#getOptions().primaryRoles.includes(
-                    role
-                )
-            ) {
-                return role;
+        if (Array.isArray(roles)) {
+            for (let role of roles) {
+                if (
+                    Array.isArray(
+                        IdentityProviderSession.#getOptions().primaryRoles
+                    ) &&
+                    IdentityProviderSession.#getOptions().primaryRoles.includes(
+                        role
+                    )
+                ) {
+                    return role;
+                }
             }
         }
         return CONST.DEFAULT_USER_ROLE_FOR_GUEST;
@@ -58,7 +60,7 @@ module.exports = class IdentityProviderSession {
 
     /**
      *	Returns user role from request object
-     *	@return {Array<string>} user role
+     *	@return {Array<string>|undefined} user role
      **/
     getRole() {
         const req = this.req;
@@ -133,7 +135,7 @@ module.exports = class IdentityProviderSession {
     /**
      *	Set auth data in session, user id and role
      *	@param	{string}	id 		user id
-     *	@param	{string}	role 	user role
+     *	@param	{Array<string>}	role 	user role
      **/
     setAuth(id, role) {
         this.setUserId(id);