@nu-art/permissions-backend 0.401.9 → 0.500.6

package/core/utils.js

@@ -1,85 +0,0 @@
-import { _values, md5 } from '@nu-art/ts-common';
-import { CreateDefaultAccessLevels, DefaultAccessLevel_NoAccess, DefaultAccessLevel_Read } from '@nu-art/permissions-shared';
-import { defaultValueResolverV2, PermissionKey_BE } from '../PermissionKey_BE.js';
-export const Permissions_abTest = (seed, namespace, permutations) => {
-    const domains = permutations.map(permutation => {
-        const name = `${namespace}/${permutation}`;
-        const domain = {
-            _id: md5(`${seed}${name}`),
-            namespace: name,
-            permissionKeys: permutations.map(permutation => {
-                const initialDataResolver = () => defaultValueResolverV2(domain._id, DefaultAccessLevel_Read.name);
-                return new PermissionKey_BE(`${namespace}/${permutation}`, initialDataResolver);
-            }),
-            levels: CreateDefaultAccessLevels(seed, [DefaultAccessLevel_NoAccess, DefaultAccessLevel_Read]),
-        };
-        return domain;
-    });
-    const groups = permutations.map((permutation, index) => {
-        const name = `${namespace}/${permutation}`;
-        const domain = domains[index];
-        const group = {
-            _id: md5(`${domain._id}/${name}`),
-            name,
-            uiLabel: name,
-            accessLevels: {
-                [domain._id]: DefaultAccessLevel_Read.name,
-            }
-        };
-        return group;
-    });
-    const Permission_Package = {
-        name: namespace,
-        domains: domains,
-        groups: groups
-    };
-    return Permission_Package;
-};
-/**
- * Generate automatic BE permission keys for a domain
- * @param accessLevels the relevant access levels to generate keys for
- * @param keyByLevelMapper the key name mapper by access level name
- * @param domainId the domain id to apply in the resolver
- */
-export const generatePermissionKeys = (accessLevels, keyByLevelMapper, domainId) => {
-    return accessLevels.reduce((mapper, currentAccessLevel) => {
-        // declare default
-        const key = keyByLevelMapper[currentAccessLevel.name];
-        // update acc mapper
-        mapper[currentAccessLevel.name] = new PermissionKey_BE(key, () => defaultValueResolverV2(domainId, currentAccessLevel.name));
-        return mapper;
-    }, {});
-};
-/**
- * Automatic generator for domain default definitions,
- * @param key MUST NEVER CHANGE! the key is the "key" to uniqueness of the entire permission decleration
- * @param namespace The name space of the current generated domain definitions
- * @param preDBAccessLevels The access levels to create (can be default or custom)
- * @param permissionKeysByLevel The permission key name for each access level
- * @param dbNames List of db names (optional)
- */
-export const generateDomainDefaults = (key, namespace, preDBAccessLevels, permissionKeysByLevel, dbNames) => {
-    // Generate the new domain id
-    const newDomainId = md5(`domain/${key}`);
-    // Get all default db ready access levels using the provided ones
-    const accessLevels = CreateDefaultAccessLevels(newDomainId, preDBAccessLevels);
-    const keyDefinitions = generatePermissionKeys(preDBAccessLevels, permissionKeysByLevel, newDomainId);
-    return {
-        domain: {
-            _id: newDomainId,
-            namespace,
-            permissionKeys: _values(keyDefinitions),
-            levels: accessLevels,
-            dbNames
-        },
-        groups: accessLevels.map(accessLevel => ({
-            _id: md5(`${key}/${accessLevel.name}`),
-            name: `${namespace}/${accessLevel.name}`,
-            uiLabel: `${namespace}/${accessLevel.name}`,
-            accessLevels: {
-                [namespace]: accessLevel.name
-            }
-        })),
-        keys: keyDefinitions
-    };
-};

package/modules/consts.d.ts

@@ -1,11 +0,0 @@
-import { DefaultDef_Package } from '../types.js';
-export declare const Domain_PermissionAssignment: Readonly<{
-    _id: "1f41541c4514b50140ae62c1f7097029";
-    namespace: "Permissions Assignment";
-}>;
-export declare const Permissions_PermissionAssignment: DefaultDef_Package;
-export declare const Domain_PermissionManagement: Readonly<{
-    _id: "1f41541c4514b50140ae62c1f7097029";
-    namespace: "Permissions Management";
-}>;
-export declare const Permissions_PermissionManagement: DefaultDef_Package;

package/modules/consts.js

@@ -1,29 +0,0 @@
-import { DBDef_PermissionAccessLevel, DBDef_PermissionAPI, DBDef_PermissionDomain, DBDef_PermissionGroup, DBDef_PermissionProject, DBDef_PermissionUser, DomainNamespace_PermissionAssignment, DomainNamespace_PermissionManagement, DuplicateDefaultAccessLevels } from '@nu-art/permissions-shared';
-export const Domain_PermissionAssignment = Object.freeze({
-    _id: '1f41541c4514b50140ae62c1f7097029',
-    namespace: DomainNamespace_PermissionAssignment
-});
-export const Permissions_PermissionAssignment = {
-    name: Domain_PermissionAssignment.namespace,
-    domains: [
-        {
-            ...Domain_PermissionAssignment,
-            levels: [...DuplicateDefaultAccessLevels(Domain_PermissionAssignment._id)],
-            dbNames: [DBDef_PermissionUser.dbKey, DBDef_PermissionGroup.dbKey]
-        }
-    ]
-};
-export const Domain_PermissionManagement = Object.freeze({
-    _id: '1f41541c4514b50140ae62c1f7097029',
-    namespace: DomainNamespace_PermissionManagement
-});
-export const Permissions_PermissionManagement = {
-    name: Domain_PermissionManagement.namespace,
-    domains: [
-        {
-            ...Domain_PermissionManagement,
-            levels: [...DuplicateDefaultAccessLevels(Domain_PermissionManagement._id)],
-            dbNames: [DBDef_PermissionProject.dbKey, DBDef_PermissionDomain.dbKey, DBDef_PermissionAccessLevel.dbKey, DBDef_PermissionAPI.dbKey]
-        }
-    ]
-};

package/modules/index.d.ts

@@ -1 +0,0 @@
-export * from './consts.js';

package/modules/index.js

@@ -1,19 +0,0 @@
-/*
- * Permissions management system, define access level for each of
- * your server apis, and restrict users by giving them access levels
- *
- * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-export * from './consts.js';

package/permissions.d.ts

@@ -1,23 +0,0 @@
-import { DefaultDef_Group } from '@nu-art/permissions-shared';
-import { PermissionKey_BE } from './PermissionKey_BE.js';
-import { DefaultDef_Domain, DefaultDef_Package } from './types.js';
-export declare const PermissionKeyBE_AccountManagement: PermissionKey_BE<"permission-key--account-management-admin">;
-export declare const PermissionKeyBE_DeveloperViewer: PermissionKey_BE<"permission-key--developer-viewer">;
-export declare const PermissionKeyBE_DeveloperEditor: PermissionKey_BE<"permission-key--developer-editor">;
-export declare const PermissionKeyBE_DeveloperAdmin: PermissionKey_BE<"permission-key--developer-admin">;
-export declare const Domain_PermissionsDefine: Readonly<DefaultDef_Domain>;
-export declare const Domain_PermissionsAssign: Readonly<DefaultDef_Domain>;
-export declare const Domain_AccountManagement: Readonly<DefaultDef_Domain>;
-export declare const Domain_Developer: Readonly<DefaultDef_Domain>;
-export declare const PermissionsPackage_Permissions: DefaultDef_Package;
-export declare const PermissionsPackage_Developer: DefaultDef_Package;
-export declare const PermissionGroup_PermissionsDefine_NoAccess: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsDefine_Viewer: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsDefine_Editor: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsDefine_Admin: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsAssign_NoAccess: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsAssign_Viewer: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsAssign_Editor: DefaultDef_Group;
-export declare const PermissionGroup_PermissionsAssign_Admin: DefaultDef_Group;
-export declare const PermissionGroups_PermissionsDefine: DefaultDef_Group[];
-export declare const PermissionGroups_PermissionsAssign: DefaultDef_Group[];

package/permissions.js

@@ -1,159 +0,0 @@
-import { ApiDef_Permissions, DBDef_PermissionAccessLevel, DBDef_PermissionAPI, DBDef_PermissionDomain, DBDef_PermissionGroup, DBDef_PermissionProject, DBDef_PermissionUser, DefaultAccessLevel_Admin, DefaultAccessLevel_Delete, DefaultAccessLevel_NoAccess, DefaultAccessLevel_Read, DefaultAccessLevel_Write, } from '@nu-art/permissions-shared';
-import { defaultValueResolverV2, PermissionKey_BE } from './PermissionKey_BE.js';
-import { ApiDef_ActionProcessing } from '@nu-art/thunderstorm-shared/action-processor/index';
-import { ApiDef_CollectionActions } from '@nu-art/thunderstorm-shared/collection-actions/api-def';
-import { ApiDef_Account, DBDef_Accounts } from '@nu-art/user-account-shared';
-import { PermissionKey_AccountManagementAdmin, PermissionKey_DeveloperAdmin, PermissionKey_DeveloperViewer, PermissionKey_DeveloperWriter } from '@nu-art/permissions-shared/permission-keys';
-import { ApiDef_SyncEnv } from '@nu-art/thunderstorm-shared';
-// export const PermissionsAccessLevel_ReadSelf = Object.freeze({name: 'Read-Self', value: 50});
-const Domain_PermissionsDefine_ID = '48d5ace0cbb2a14c8a0ca3773a4a2962';
-const Domain_PermissionsAssign_ID = 'ecf9cfe952d034ad8d1f182bbec6e2db';
-const Domain_AccountManagement_ID = 'a02fd6cef8ccae193ad7357d596131e4';
-const Domain_Developer_ID = '1f62a6e2fc4e2cfaa8aa1aa1a45b8c1b';
-const _Domain_PermissionsDefine = {
-    _id: Domain_PermissionsDefine_ID,
-    namespace: 'Permissions Define',
-    dbNames: [DBDef_PermissionProject, DBDef_PermissionDomain, DBDef_PermissionAPI, DBDef_PermissionAccessLevel].map(dbDef => dbDef.dbKey),
-    customApis: [
-        { path: ApiDef_Account._v1.refreshSession.path, accessLevel: DefaultAccessLevel_NoAccess.name },
-        { path: ApiDef_Permissions.v1.createProject.path, accessLevel: DefaultAccessLevel_Admin.name },
-        { path: ApiDef_Permissions.v1.toggleStrictMode.path, accessLevel: DefaultAccessLevel_Admin.name },
-    ]
-};
-const _Domain_PermissionsAssign = {
-    _id: Domain_PermissionsAssign_ID,
-    namespace: 'Permissions Assign',
-    dbNames: [DBDef_PermissionGroup.dbKey, DBDef_PermissionUser.dbKey],
-};
-export const PermissionKeyBE_AccountManagement = new PermissionKey_BE(PermissionKey_AccountManagementAdmin, () => defaultValueResolverV2(_Domain_AccountManagement._id, DefaultAccessLevel_Admin.name));
-const _Domain_AccountManagement = {
-    _id: Domain_AccountManagement_ID,
-    namespace: 'Account Management',
-    dbNames: [DBDef_Accounts.dbKey],
-    permissionKeys: [
-        PermissionKeyBE_AccountManagement,
-    ],
-    customApis: [
-        { path: ApiDef_Account._v1.createAccount.path, accessLevel: DefaultAccessLevel_Admin.name },
-        { path: ApiDef_Account._v1.createToken.path, accessLevel: DefaultAccessLevel_Admin.name },
-        { path: ApiDef_Account._v1.getSessions.path, accessLevel: DefaultAccessLevel_Admin.name },
-        { path: ApiDef_Account._v1.deleteAccount.path, accessLevel: DefaultAccessLevel_Admin.name },
-    ]
-};
-export const PermissionKeyBE_DeveloperViewer = new PermissionKey_BE(PermissionKey_DeveloperViewer, () => defaultValueResolverV2(Domain_Developer._id, DefaultAccessLevel_Read.name));
-export const PermissionKeyBE_DeveloperEditor = new PermissionKey_BE(PermissionKey_DeveloperWriter, () => defaultValueResolverV2(Domain_Developer._id, DefaultAccessLevel_Write.name));
-export const PermissionKeyBE_DeveloperAdmin = new PermissionKey_BE(PermissionKey_DeveloperAdmin, () => defaultValueResolverV2(Domain_Developer._id, DefaultAccessLevel_Admin.name));
-const _Domain_Developer = {
-    _id: Domain_Developer_ID,
-    namespace: 'Developer',
-    permissionKeys: [
-        PermissionKeyBE_DeveloperViewer,
-        PermissionKeyBE_DeveloperEditor,
-        PermissionKeyBE_DeveloperAdmin,
-    ],
-    customApis: [
-        { path: ApiDef_CollectionActions.upgrade.all.path, accessLevel: DefaultAccessLevel_Delete.name },
-        { path: ApiDef_ActionProcessing.vv1.list.path, accessLevel: DefaultAccessLevel_Read.name },
-        { path: ApiDef_ActionProcessing.vv1.execute.path, accessLevel: DefaultAccessLevel_Admin.name },
-        { path: ApiDef_SyncEnv.vv1.fetchBackupMetadata.path, accessLevel: DefaultAccessLevel_Read.name },
-        { path: ApiDef_SyncEnv.vv1.createBackup.path, accessLevel: DefaultAccessLevel_Write.name },
-        { path: ApiDef_SyncEnv.vv1.syncFromEnvBackup.path, accessLevel: DefaultAccessLevel_Write.name },
-        { path: ApiDef_SyncEnv.vv1.syncFirebaseFromBackup.path, accessLevel: DefaultAccessLevel_Write.name },
-        { path: ApiDef_SyncEnv.vv1.syncToEnv.path, accessLevel: DefaultAccessLevel_Admin.name },
-    ]
-};
-export const Domain_PermissionsDefine = Object.freeze(_Domain_PermissionsDefine);
-export const Domain_PermissionsAssign = Object.freeze(_Domain_PermissionsAssign);
-export const Domain_AccountManagement = Object.freeze(_Domain_AccountManagement);
-export const Domain_Developer = Object.freeze(_Domain_Developer);
-export const PermissionsPackage_Permissions = {
-    name: 'Permissions',
-    domains: [
-        Domain_AccountManagement,
-        Domain_PermissionsDefine,
-        Domain_PermissionsAssign,
-    ],
-};
-export const PermissionsPackage_Developer = {
-    name: 'Developer',
-    domains: [
-        Domain_Developer,
-    ],
-};
-//Needed?
-export const PermissionGroup_PermissionsDefine_NoAccess = {
-    _id: 'cacf1da8ccca1e4dede8859f0d72c55c',
-    name: `${Domain_PermissionsDefine.namespace}/No Access`,
-    uiLabel: `${Domain_PermissionsDefine.namespace}/No Access`,
-    accessLevels: {
-        [Domain_PermissionsDefine.namespace]: DefaultAccessLevel_NoAccess.name,
-    },
-};
-export const PermissionGroup_PermissionsDefine_Viewer = {
-    _id: '0079f39e0f50b70942b8d69bfe1741d5',
-    name: `${Domain_PermissionsDefine.namespace}/Viewer`,
-    uiLabel: `${Domain_PermissionsDefine.namespace}/Viewer`,
-    accessLevels: {
-        [Domain_PermissionsDefine.namespace]: DefaultAccessLevel_Read.name,
-    },
-};
-export const PermissionGroup_PermissionsDefine_Editor = {
-    _id: '46fb6b35f1d4d11913ce231bd4a42b4b',
-    name: `${Domain_PermissionsDefine.namespace}/Editor`,
-    uiLabel: `${Domain_PermissionsDefine.namespace}/Editor`,
-    accessLevels: {
-        [Domain_PermissionsDefine.namespace]: DefaultAccessLevel_Delete.name,
-    },
-};
-export const PermissionGroup_PermissionsDefine_Admin = {
-    _id: 'fa260d42ce16a69bc654bf0efd1a2287',
-    name: `${Domain_PermissionsDefine.namespace}/Admin`,
-    uiLabel: `${Domain_PermissionsDefine.namespace}/Admin`,
-    accessLevels: {
-        [Domain_PermissionsDefine.namespace]: DefaultAccessLevel_Admin.name,
-    },
-};
-export const PermissionGroup_PermissionsAssign_NoAccess = {
-    _id: 'dafebd8f706d638400e696345c400fc3',
-    name: `${Domain_PermissionsAssign.namespace}/No Access`,
-    uiLabel: `${Domain_PermissionsAssign.namespace}/No Access`,
-    accessLevels: {
-        [Domain_PermissionsAssign.namespace]: DefaultAccessLevel_NoAccess.name,
-    },
-};
-export const PermissionGroup_PermissionsAssign_Viewer = {
-    _id: '5b6d75f5644dd9501551487f9a8748b9',
-    name: `${Domain_PermissionsAssign.namespace}/Viewer`,
-    uiLabel: `${Domain_PermissionsAssign.namespace}/Viewer`,
-    accessLevels: {
-        [Domain_PermissionsAssign.namespace]: DefaultAccessLevel_Read.name,
-    },
-};
-export const PermissionGroup_PermissionsAssign_Editor = {
-    _id: 'ac5050d644251fa0b95506280a2ebfb3',
-    name: `${Domain_PermissionsAssign.namespace}/Editor`,
-    uiLabel: `${Domain_PermissionsAssign.namespace}/Editor`,
-    accessLevels: {
-        [Domain_PermissionsAssign.namespace]: DefaultAccessLevel_Delete.name,
-    },
-};
-export const PermissionGroup_PermissionsAssign_Admin = {
-    _id: '232a8bb28f770ac62d4fa74ed594bfeb',
-    name: `${Domain_PermissionsAssign.namespace}/Admin`,
-    uiLabel: `${Domain_PermissionsAssign.namespace}/Admin`,
-    accessLevels: {
-        [Domain_PermissionsAssign.namespace]: DefaultAccessLevel_Admin.name,
-    },
-};
-export const PermissionGroups_PermissionsDefine = [
-    PermissionGroup_PermissionsDefine_NoAccess,
-    PermissionGroup_PermissionsDefine_Viewer,
-    PermissionGroup_PermissionsDefine_Editor,
-    PermissionGroup_PermissionsDefine_Admin,
-];
-export const PermissionGroups_PermissionsAssign = [
-    PermissionGroup_PermissionsAssign_NoAccess,
-    PermissionGroup_PermissionsAssign_Viewer,
-    PermissionGroup_PermissionsAssign_Editor,
-    PermissionGroup_PermissionsAssign_Admin,
-];

package/types.d.ts

@@ -1,28 +0,0 @@
-import { PermissionKey_BE } from './PermissionKey_BE.js';
-import { DB_PermissionAccessLevel, DB_PermissionDomain, DB_PermissionGroup, DB_PermissionProject, DB_PermissionUser, DefaultDef_AccessLevel, DefaultDef_Api, DefaultDef_Group } from '@nu-art/permissions-shared';
-export type PermissionTypes = {
-    PermissionProject: DB_PermissionProject;
-    PermissionDomain: DB_PermissionDomain;
-    PermissionAccessLevel: DB_PermissionAccessLevel;
-    PermissionGroup: DB_PermissionGroup;
-    PermissionUser: DB_PermissionUser;
-};
-export type DefaultDef_Project = {
-    _id: string;
-    name: string;
-    packages: DefaultDef_Package[];
-    groups?: DefaultDef_Group[];
-};
-export type DefaultDef_Domain = {
-    _id: string;
-    namespace: string;
-    levels?: DefaultDef_AccessLevel[];
-    customApis?: DefaultDef_Api[];
-    dbNames?: string[];
-    permissionKeys?: PermissionKey_BE<string>[];
-};
-export type DefaultDef_Package = {
-    name: string;
-    domains: DefaultDef_Domain[];
-    groups?: DefaultDef_Group[];
-};