not-node 6.3.7 → 6.3.9

package/package.json

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

package/src/auth/const.js

@@ -1,4 +1,8 @@
-const DEFAULT_USER_ROLE_FOR_ADMIN = "root";
+/** @type {string} system administrator, cant change system's content */
+const DEFAULT_USER_ROLE_FOR_ROOT = "root";
+/** @type {string} content administrator, cant change system's configuration */
+const DEFAULT_USER_ROLE_FOR_ADMIN = "admin";
+/** @type {string} unknown user */
 const DEFAULT_USER_ROLE_FOR_GUEST = "guest";
 
 const ACTION_SIGNATURE_CREATE = "create";
@@ -24,6 +28,7 @@ module.exports = {
     TOKEN_TTL,
     OBJECT_STRING,
     DEFAULT_USER_ROLE_FOR_GUEST,
+    DEFAULT_USER_ROLE_FOR_ROOT,
     DEFAULT_USER_ROLE_FOR_ADMIN,
     DOCUMENT_OWNER_FIELD_NAME,
     ACTION_SIGNATURES,

package/src/generic/form.list.js

@@ -1,6 +1,7 @@
 const Form = require("../form/form");
 const { firstLetterToUpper } = require("../common");
 const notFilter = require("not-filter");
+const notAppIdentity = require("../identity");
 
 const FIELDS = [
     ["query", `not-filter//_filterQuery`],
@@ -36,11 +37,12 @@ const FactoryFormList = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
          */
         async extract(req) {
             const envs = this.extractRequestEnvs(req);
-            if (!req.user.isRoot() && !req.user.isAdmin()) {
+            const user = notAppIdentity.extractAuthData(req);
+            if (!user.root && !user.admin) {
                 envs.query.filter = notFilter.filter.modifyRules(
                     envs.query.filter,
                     {
-                        owner: req.user._id,
+                        owner: user.uid,
                     }
                 );
             }

package/src/generic/form.listAndCount.js

@@ -1,6 +1,7 @@
 const Form = require("../form/form");
 const { firstLetterToUpper } = require("../common");
 const notFilter = require("not-filter");
+const notAppIdentity = require("../identity");
 
 const FIELDS = [
     ["query", `not-filter//_filterQuery`],
@@ -36,11 +37,12 @@ const FactoryFormListAndCount = ({ MODULE_NAME, MODEL_NAME, actionName }) => {
          */
         async extract(req) {
             const envs = this.extractRequestEnvs(req);
-            if (!req.user.isRoot() && !req.user.isAdmin()) {
+            const user = notAppIdentity.extractAuthData(req);
+            if (!user.root && !user.admin) {
                 envs.query.filter = notFilter.filter.modifyRules(
                     envs.query.filter,
                     {
-                        owner: req.user._id,
+                        owner: user.uid,
                     }
                 );
             }

package/src/identity/identity.js

@@ -1,3 +1,8 @@
+const {
+    DEFAULT_USER_ROLE_FOR_ROOT,
+    DEFAULT_USER_ROLE_FOR_ADMIN,
+    DEFAULT_USER_ROLE_FOR_GUEST,
+} = require("../auth/const");
 const { copyObj, objHas } = require("../common");
 const IdentityProviderSession = require("./providers/session");
 const IdentityProviderToken = require("./providers/token");
@@ -17,7 +22,11 @@ class Identity {
         token: IdentityProviderToken,
     };
 
-    static #primaryRoles = [];
+    static #primaryRoles = [
+        DEFAULT_USER_ROLE_FOR_ROOT,
+        DEFAULT_USER_ROLE_FOR_ADMIN,
+        DEFAULT_USER_ROLE_FOR_GUEST,
+    ];
     static #secondaryRoles = [];
 
     static setPrimaryRoles(list = []) {

package/src/identity/index.js

@@ -15,12 +15,13 @@ module.exports = class notAppIdentity {
     /**
      *  Collects various authentification and authorization data from request object
      *  @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 }
+     *  @return {import('../types').notAppIdentityData}  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);
         return {
             root: identity.isRoot(),
+            admin: identity.isAdmin(),
             auth: identity.isUser(),
             role: identity.getRole(),
             primaryRole: identity.getPrimaryRole(),

package/src/identity/providers/session.js

@@ -98,11 +98,31 @@ module.exports = class IdentityProviderSession {
         }
     }
 
+    /**
+     * Root is for system configaration
+     *
+     * @return {boolean}
+     */
     isRoot() {
         return (
             this.isUser() &&
             ROLES.compareRoles(
-                this.getRole(),
+                this.getPrimaryRole(),
+                CONST.DEFAULT_USER_ROLE_FOR_ROOT
+            )
+        );
+    }
+
+    /**
+     * Admin is for system content management
+     *
+     * @return {boolean}
+     */
+    isAdmin() {
+        return (
+            this.isUser() &&
+            ROLES.compareRoles(
+                this.getPrimaryRole(),
                 CONST.DEFAULT_USER_ROLE_FOR_ADMIN
             )
         );

package/src/identity/providers/token.js

@@ -239,7 +239,22 @@ module.exports = class IdentityProviderToken {
         return (
             this.isUser() &&
             ROLES.compareRoles(
-                this.getRole(),
+                this.getPrimaryRole(),
+                CONST.DEFAULT_USER_ROLE_FOR_ROOT
+            )
+        );
+    }
+
+    /**
+     * Admin is for system content management
+     *
+     * @return {boolean}
+     */
+    isAdmin() {
+        return (
+            this.isUser() &&
+            ROLES.compareRoles(
+                this.getPrimaryRole(),
                 CONST.DEFAULT_USER_ROLE_FOR_ADMIN
             )
         );

package/src/types.js

@@ -80,4 +80,17 @@
  * @typedef     {import('express').Request & notNodeExpressRequestProperties}    notNodeExpressRequest
  */
 
+/**
+ *
+ * @typedef     {object}        notAppIdentityData
+ * @property    {boolean}       root        //system configuration administrator
+ * @property    {boolean}       admin       //system content administrator
+ * @property    {boolean}       auth        //authenticated user
+ * @property    {Array<string>} role        //list of roles, exactly one should be primary role
+ * @property    {string}        primaryRole //primary role
+ * @property    {string}        uid         //user identificator
+ * @property    {string}        sid         //user session identificator
+ * @property    {string}        ip          //request source ip
+ */
+
 module.exports = {};

package/test/auth/roles.js

@@ -1,17 +1,16 @@
-module.exports = ({
-  Auth,
-  expect
-}) => {
-  describe('Roles', () => {
-    describe('compareRolesArrayAgainstArray', ()=>{
-      it('userRoles: Array, actionRoles: Array, strict = true', ()=>{
-        const userRoles = ['user', 'manager', 'comfirmed'];
-        const actionRoles = ['user','comfirmed'];
-        let result = Auth.compareRolesArrayAgainstArray(userRoles, actionRoles, false);
-        expect(result).to.deep.equal(true);
-      });
+module.exports = ({ Auth, expect }) => {
+    describe("Roles", () => {
+        describe("compareRolesArrayAgainstArray", () => {
+            it("userRoles: Array, actionRoles: Array, strict = true", () => {
+                const userRoles = ["user", "manager", "comfirmed"];
+                const actionRoles = ["user", "comfirmed"];
+                let result = Auth.compareRolesArrayAgainstArray(
+                    userRoles,
+                    actionRoles,
+                    false
+                );
+                expect(result).to.deep.equal(true);
+            });
+        });
     });
-    
-  });
-
 };

package/test/auth/routes.js

@@ -67,6 +67,7 @@ module.exports = ({ Auth, expect }) => {
                 let result = Auth.extractAuthData(req);
                 expect(result).to.deep.equal({
                     root: false,
+                    admin: false,
                     auth: false,
                     role: [Auth.DEFAULT_USER_ROLE_FOR_GUEST],
                     primaryRole: Auth.DEFAULT_USER_ROLE_FOR_GUEST,
@@ -108,12 +109,12 @@ module.exports = ({ Auth, expect }) => {
         });
 
         describe("checkRoot", function () {
-            it("check if admin exists and continues", function () {
+            it("check if root exists and continues", function () {
                 const req = {
                         get() {},
                         session: {
                             user: true,
-                            role: [Auth.DEFAULT_USER_ROLE_FOR_ADMIN],
+                            role: [Auth.DEFAULT_USER_ROLE_FOR_ROOT],
                         },
                     },
                     next = function (val) {
@@ -123,7 +124,7 @@ module.exports = ({ Auth, expect }) => {
                 expect(result).to.deep.equal();
             });
 
-            it("check if admin exists and throw exception", function () {
+            it("check if root exists and throw exception", function () {
                 const req = {
                         session: {
                             user: true,
@@ -144,7 +145,7 @@ module.exports = ({ Auth, expect }) => {
                 const req = {
                         session: {
                             user: true,
-                            role: [Auth.DEFAULT_USER_ROLE_FOR_ADMIN],
+                            role: [Auth.DEFAULT_USER_ROLE_FOR_ROOT],
                         },
                         get() {},
                     },

package/test/fakes.js

@@ -13,6 +13,7 @@ module.exports = {
     fakeIdentity: (
         id = {
             root: false,
+            admin: false,
             auth: false,
             role: [DEFAULT_USER_ROLE_FOR_GUEST],
             primaryRole: DEFAULT_USER_ROLE_FOR_GUEST,
@@ -27,6 +28,9 @@ module.exports = {
                     static isRoot() {
                         return id.root;
                     }
+                    static isAdmin() {
+                        return id.admin;
+                    }
                     static isUser() {
                         return id.auth;
                     }

package/test/identity/providers/session.js

@@ -1,7 +1,15 @@
 const Provider = require("../../../src/identity/providers/session");
-const { DEFAULT_USER_ROLE_FOR_GUEST } = require("../../../src/auth/const");
+const {
+    DEFAULT_USER_ROLE_FOR_GUEST,
+    DEFAULT_USER_ROLE_FOR_ADMIN,
+    DEFAULT_USER_ROLE_FOR_ROOT,
+} = require("../../../src/auth/const");
 const mongoose = require("mongoose");
-
+Provider.setPrimaryRoles([
+    DEFAULT_USER_ROLE_FOR_ROOT,
+    DEFAULT_USER_ROLE_FOR_ADMIN,
+    DEFAULT_USER_ROLE_FOR_GUEST,
+]);
 const SESSION_NOT_EXISTS = "session not exists";
 
 module.exports = ({ expect }) => {
@@ -26,17 +34,17 @@ module.exports = ({ expect }) => {
         });
 
         describe("isRoot", function () {
-            it("check if user admin - true", function () {
+            it("check if user root - true", function () {
                 var t = {
                     session: {
                         user: mongoose.Types.ObjectId(),
-                        role: "root",
+                        role: ["root"],
                     },
                 };
-                var res = new Provider(t).isRoot();
+                const res = new Provider(t).isRoot();
                 expect(res).to.eql(true);
             });
-            it("check if user admin - false", function () {
+            it("check if user root - false", function () {
                 var t = {
                     session: {
                         user: mongoose.Types.ObjectId(),
@@ -53,12 +61,12 @@ module.exports = ({ expect }) => {
                 var t = {
                     session: {
                         user: mongoose.Types.ObjectId(),
-                        role: "root",
+                        role: ["root"],
                         save() {},
                     },
                 };
-                var res = new Provider(t).getRole();
-                expect(res).to.eql("root");
+                const res = new Provider(t).getRole();
+                expect(res).to.be.deep.eql(["root"]);
             });
             it("get role - undefined", function () {
                 var t = {
@@ -77,7 +85,7 @@ module.exports = ({ expect }) => {
                 var t = {
                     session: {
                         user: mongoose.Types.ObjectId(),
-                        role: "user",
+                        role: ["user"],
                         save() {},
                     },
                 };
@@ -96,7 +104,7 @@ module.exports = ({ expect }) => {
             it("session exist, set _id", function () {
                 const t = {
                     session: {
-                        role: "user",
+                        role: ["user"],
                         save() {},
                     },
                 };
@@ -118,7 +126,7 @@ module.exports = ({ expect }) => {
                 const t = {
                     session: {
                         user: mongoose.Types.ObjectId(),
-                        role: "user",
+                        role: ["user"],
                         save() {},
                     },
                 };
@@ -138,7 +146,7 @@ module.exports = ({ expect }) => {
                 const t = {
                     session: {
                         id: mongoose.Types.ObjectId(),
-                        role: "user",
+                        role: ["user"],
                         save() {},
                     },
                 };
@@ -199,7 +207,7 @@ module.exports = ({ expect }) => {
                 const t = {
                     session: {
                         user: id,
-                        role: "admin",
+                        role: ["admin"],
                         save() {},
                         destroy() {
                             destroyed = true;
@@ -217,7 +225,7 @@ module.exports = ({ expect }) => {
                 const t = {
                     session: {
                         user: id,
-                        role: "admin",
+                        role: ["admin"],
                         save() {},
                     },
                 };

package/test/notApp.js

@@ -26,6 +26,7 @@ describe("noApp", function () {
                 static of() {
                     return class {
                         static isRoot() {}
+                        static isAdmin() {}
                         static isUser() {}
                         static getRole() {}
                         static getPrimaryRole() {}

package/test/notRoute.js

@@ -1,4 +1,4 @@
-const { DEFAULT_USER_ROLE_FOR_ADMIN } = require("../src/auth");
+const { DEFAULT_USER_ROLE_FOR_ROOT } = require("../src/auth");
 const notAppIdentity = require("../src/identity");
 
 const HttpError = require("../src/error").Http,
@@ -146,8 +146,8 @@ describe("notRoute", function () {
             notAppIdentity.identity = require("./fakes").fakeIdentity({
                 auth: true,
                 root: true,
-                primaryRole: DEFAULT_USER_ROLE_FOR_ADMIN,
-                role: [DEFAULT_USER_ROLE_FOR_ADMIN],
+                primaryRole: DEFAULT_USER_ROLE_FOR_ROOT,
+                role: [DEFAULT_USER_ROLE_FOR_ROOT],
             });
             let req = {},
                 actionData = {
@@ -278,8 +278,8 @@ describe("notRoute", function () {
             notAppIdentity.identity = require("./fakes").fakeIdentity({
                 auth: true,
                 root: true,
-                primaryRole: DEFAULT_USER_ROLE_FOR_ADMIN,
-                role: [DEFAULT_USER_ROLE_FOR_ADMIN],
+                primaryRole: DEFAULT_USER_ROLE_FOR_ROOT,
+                role: [DEFAULT_USER_ROLE_FOR_ROOT],
             });
             let req = {
                     get() {},
@@ -436,8 +436,8 @@ describe("notRoute", function () {
             notAppIdentity.identity = require("./fakes").fakeIdentity({
                 auth: true,
                 root: true,
-                primaryRole: DEFAULT_USER_ROLE_FOR_ADMIN,
-                role: [DEFAULT_USER_ROLE_FOR_ADMIN],
+                primaryRole: DEFAULT_USER_ROLE_FOR_ROOT,
+                role: [DEFAULT_USER_ROLE_FOR_ROOT],
             });
             let req = {
                     get() {},
@@ -494,8 +494,8 @@ describe("notRoute", function () {
             notAppIdentity.identity = require("./fakes").fakeIdentity({
                 auth: true,
                 root: true,
-                primaryRole: DEFAULT_USER_ROLE_FOR_ADMIN,
-                role: [DEFAULT_USER_ROLE_FOR_ADMIN],
+                primaryRole: DEFAULT_USER_ROLE_FOR_ROOT,
+                role: [DEFAULT_USER_ROLE_FOR_ROOT],
             });
             let req = {
                     get() {},
@@ -553,8 +553,8 @@ describe("notRoute", function () {
             notAppIdentity.identity = require("./fakes").fakeIdentity({
                 auth: true,
                 root: true,
-                primaryRole: DEFAULT_USER_ROLE_FOR_ADMIN,
-                role: [DEFAULT_USER_ROLE_FOR_ADMIN],
+                primaryRole: DEFAULT_USER_ROLE_FOR_ROOT,
+                role: [DEFAULT_USER_ROLE_FOR_ROOT],
             });
             let req = {
                     get() {},