@nu-art/permissions-backend 0.401.8 → 0.500.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nu-art/permissions-backend",
-  "version": "0.401.8",
+  "version": "0.500.0",
   "description": "Permissions Backend",
   "keywords": [
     "TacB0sS",
@@ -11,7 +11,6 @@
     "nu-art",
     "permissions",
     "saml",
-    "thunderstorm",
     "typescript",
     "user-account"
   ],
@@ -35,15 +34,13 @@
     "test": "ts-mocha -w -p src/test/tsconfig.json --timeout 0 --inspect=8107 --watch-files '**/*.ts' src/test/__all-tests.ts"
   },
   "dependencies": {
-    "@nu-art/permissions-shared": "0.401.8",
-    "@nu-art/firebase-backend": "0.401.8",
-    "@nu-art/firebase-shared": "0.401.8",
-    "@nu-art/google-services-backend": "0.401.8",
-    "@nu-art/thunderstorm-backend": "0.401.8",
-    "@nu-art/thunderstorm-shared": "0.401.8",
-    "@nu-art/ts-common": "0.401.8",
-    "@nu-art/user-account-backend": "0.401.8",
-    "@nu-art/user-account-shared": "0.401.8",
+    "@nu-art/permissions-shared": "0.500.0",
+    "@nu-art/firebase-backend": "0.500.0",
+    "@nu-art/firebase-shared": "0.500.0",
+    "@nu-art/google-services-backend": "0.500.0",
+    "@nu-art/ts-common": "0.500.0",
+    "@nu-art/user-account-backend": "0.500.0",
+    "@nu-art/user-account-shared": "0.500.0",
     "express": "^4.18.2",
     "firebase": "^11.9.0",
     "firebase-admin": "13.4.0",
@@ -52,7 +49,11 @@
     "react": "^18.0.0",
     "react-dom": "^18.0.0",
     "react-router-dom": "^6.9.0",
-    "saml2-js": "^4.0.1"
+    "saml2-js": "^4.0.1",
+    "@nu-art/http-server": "{{THUNDERSTORM_VERSION}}",
+    "@nu-art/api-types": "{{THUNDERSTORM_VERSION}}",
+    "@nu-art/db-api-backend": "0.500.0",
+    "@nu-art/db-api-shared": "0.500.0"
   },
   "devDependencies": {
     "@types/react": "^18.0.0",

package/permissions-wire.d.ts

@@ -0,0 +1,46 @@
+import type { Logger, Module } from '@nu-art/ts-common';
+import type { ServiceAccountDef } from '@nu-art/permissions-shared';
+/** Injectable app-config key handler. When using @nu-art/app-config-backend, set this so PermissionKey_BE registers and delegates get/set. */
+export type AppConfigKeyHandler = {
+    registerKey(key: {
+        key: string | number;
+        resolver: (logger: Logger) => Promise<unknown>;
+        dataManipulator: (data: unknown) => Promise<unknown>;
+    }): void;
+    getAppKey(key: {
+        key: string | number;
+    }, logger?: Logger): Promise<unknown>;
+    setAppKey(key: {
+        key: string | number;
+    }, value: unknown): Promise<void>;
+};
+export declare function setAppConfigKeyHandler(handler: AppConfigKeyHandler | null): void;
+export declare function getAppConfigKeyHandler(): AppConfigKeyHandler | null;
+export type EnvConfigRef = {
+    get(config: Record<string, unknown>): Promise<Record<string, unknown>>;
+    set(config: Record<string, unknown>): Promise<void>;
+};
+export declare function setEnvConfigRefForModule(module: Module, ref: EnvConfigRef): void;
+export declare function getEnvConfigRef(module: Module): EnvConfigRef | null;
+export declare function setGlobalEnvConfigRef(ref: EnvConfigRef | null): void;
+export declare function getGlobalEnvConfigRef(): EnvConfigRef | null;
+export declare function setCreatePermissionKeyDefaults(fn: ((module: Module) => Promise<void>) | null): void;
+export declare function getCreatePermissionKeyDefaults(): ((module: Module) => Promise<void>) | null;
+export declare function setActionProcessor(proc: {
+    registerAction(opts: {
+        key: string;
+        group: string;
+        description: string;
+        processor: () => Promise<void>;
+    }, thisArg: unknown): void;
+} | null): void;
+export declare function getActionProcessor(): {
+    registerAction(opts: {
+        key: string;
+        group: string;
+        description: string;
+        processor: () => Promise<void>;
+    }, thisArg: unknown): void;
+} | null;
+export declare function setServiceAccountsProvider(provider: (() => Promise<ServiceAccountDef[]>) | null): void;
+export declare function getServiceAccountsProvider(): (() => Promise<ServiceAccountDef[]>) | null;

package/permissions-wire.js

@@ -0,0 +1,47 @@
+/*
+ * Permissions management system
+ * Copyright (C) 2020 Adam van der Kruk aka TacB0sS
+ * Licensed under the Apache License, Version 2.0
+ */
+let appConfigKeyHandler = null;
+export function setAppConfigKeyHandler(handler) {
+    appConfigKeyHandler = handler;
+}
+export function getAppConfigKeyHandler() {
+    return appConfigKeyHandler;
+}
+let envConfigRefByModule = new Map();
+let globalEnvConfigRef = null;
+let createPermissionKeyDefaultsFn = null;
+let actionProcessor = null;
+let serviceAccountsProvider = null;
+export function setEnvConfigRefForModule(module, ref) {
+    envConfigRefByModule.set(module, ref);
+}
+export function getEnvConfigRef(module) {
+    return envConfigRefByModule.get(module) ?? null;
+}
+export function setGlobalEnvConfigRef(ref) {
+    globalEnvConfigRef = ref;
+}
+export function getGlobalEnvConfigRef() {
+    return globalEnvConfigRef;
+}
+export function setCreatePermissionKeyDefaults(fn) {
+    createPermissionKeyDefaultsFn = fn;
+}
+export function getCreatePermissionKeyDefaults() {
+    return createPermissionKeyDefaultsFn;
+}
+export function setActionProcessor(proc) {
+    actionProcessor = proc;
+}
+export function getActionProcessor() {
+    return actionProcessor;
+}
+export function setServiceAccountsProvider(provider) {
+    serviceAccountsProvider = provider;
+}
+export function getServiceAccountsProvider() {
+    return serviceAccountsProvider;
+}

package/permissions.js

@@ -1,45 +1,43 @@
-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 { ApiDef_Permissions, DBDef_PermissionAccessLevel, DBDef_PermissionAPI, DBDef_PermissionDomain, DBDef_PermissionGroup, DBDef_PermissionProject, DBDef_PermissionUser, DefaultAccessLevel_Admin, DefaultAccessLevel_Delete, DefaultAccessLevel_NoAccess, DefaultAccessLevel_Read, DefaultAccessLevel_Write, toPermissionDomainId, toPermissionGroupId, } 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 { Path_ActionProcessor_Execute, Path_ActionProcessor_List, Path_CollectionActions_UpgradeAll, Path_SyncEnv_CreateBackup, Path_SyncEnv_FetchBackupMetadata, Path_SyncEnv_SyncFirebaseFromBackup, Path_SyncEnv_SyncFromEnvBackup, Path_SyncEnv_SyncToEnv, } from './core/external-api-paths.js';
+import { ApiDef_UserAccount, DBDef_Accounts } from '@nu-art/user-account-shared';
 import { 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,
+    _id: toPermissionDomainId(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 },
+        { path: ApiDef_UserAccount.refreshSession.path, accessLevel: DefaultAccessLevel_NoAccess.name },
+        { path: ApiDef_Permissions.createProject.path, accessLevel: DefaultAccessLevel_Admin.name },
+        { path: ApiDef_Permissions.toggleStrictMode.path, accessLevel: DefaultAccessLevel_Admin.name },
     ]
 };
 const _Domain_PermissionsAssign = {
-    _id: Domain_PermissionsAssign_ID,
+    _id: toPermissionDomainId(Domain_PermissionsAssign_ID),
     namespace: 'Permissions Assign',
     dbNames: [DBDef_PermissionGroup.dbKey, DBDef_PermissionUser.dbKey],
 };
 const _Domain_AccountManagement = {
-    _id: Domain_AccountManagement_ID,
+    _id: toPermissionDomainId(Domain_AccountManagement_ID),
     namespace: 'Account Management',
     dbNames: [DBDef_Accounts.dbKey],
     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_UserAccount.createAccount.path, accessLevel: DefaultAccessLevel_Admin.name },
+        { path: ApiDef_UserAccount.createToken.path, accessLevel: DefaultAccessLevel_Admin.name },
+        { path: ApiDef_UserAccount.getSessions.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,
+    _id: toPermissionDomainId(Domain_Developer_ID),
     namespace: 'Developer',
     permissionKeys: [
         PermissionKeyBE_DeveloperViewer,
@@ -47,14 +45,14 @@ const _Domain_Developer = {
         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 },
+        { path: Path_CollectionActions_UpgradeAll, accessLevel: DefaultAccessLevel_Delete.name },
+        { path: Path_ActionProcessor_List, accessLevel: DefaultAccessLevel_Read.name },
+        { path: Path_ActionProcessor_Execute, accessLevel: DefaultAccessLevel_Admin.name },
+        { path: Path_SyncEnv_FetchBackupMetadata, accessLevel: DefaultAccessLevel_Read.name },
+        { path: Path_SyncEnv_CreateBackup, accessLevel: DefaultAccessLevel_Write.name },
+        { path: Path_SyncEnv_SyncFromEnvBackup, accessLevel: DefaultAccessLevel_Write.name },
+        { path: Path_SyncEnv_SyncFirebaseFromBackup, accessLevel: DefaultAccessLevel_Write.name },
+        { path: Path_SyncEnv_SyncToEnv, accessLevel: DefaultAccessLevel_Admin.name },
     ]
 };
 export const Domain_PermissionsDefine = Object.freeze(_Domain_PermissionsDefine);
@@ -77,7 +75,7 @@ export const PermissionsPackage_Developer = {
 };
 //Needed?
 export const PermissionGroup_PermissionsDefine_NoAccess = {
-    _id: 'cacf1da8ccca1e4dede8859f0d72c55c',
+    _id: toPermissionGroupId('cacf1da8ccca1e4dede8859f0d72c55c'),
     name: `${Domain_PermissionsDefine.namespace}/No Access`,
     uiLabel: `${Domain_PermissionsDefine.namespace}/No Access`,
     accessLevels: {
@@ -85,7 +83,7 @@ export const PermissionGroup_PermissionsDefine_NoAccess = {
     },
 };
 export const PermissionGroup_PermissionsDefine_Viewer = {
-    _id: '0079f39e0f50b70942b8d69bfe1741d5',
+    _id: toPermissionGroupId('0079f39e0f50b70942b8d69bfe1741d5'),
     name: `${Domain_PermissionsDefine.namespace}/Viewer`,
     uiLabel: `${Domain_PermissionsDefine.namespace}/Viewer`,
     accessLevels: {
@@ -93,7 +91,7 @@ export const PermissionGroup_PermissionsDefine_Viewer = {
     },
 };
 export const PermissionGroup_PermissionsDefine_Editor = {
-    _id: '46fb6b35f1d4d11913ce231bd4a42b4b',
+    _id: toPermissionGroupId('46fb6b35f1d4d11913ce231bd4a42b4b'),
     name: `${Domain_PermissionsDefine.namespace}/Editor`,
     uiLabel: `${Domain_PermissionsDefine.namespace}/Editor`,
     accessLevels: {
@@ -101,7 +99,7 @@ export const PermissionGroup_PermissionsDefine_Editor = {
     },
 };
 export const PermissionGroup_PermissionsDefine_Admin = {
-    _id: 'fa260d42ce16a69bc654bf0efd1a2287',
+    _id: toPermissionGroupId('fa260d42ce16a69bc654bf0efd1a2287'),
     name: `${Domain_PermissionsDefine.namespace}/Admin`,
     uiLabel: `${Domain_PermissionsDefine.namespace}/Admin`,
     accessLevels: {
@@ -109,7 +107,7 @@ export const PermissionGroup_PermissionsDefine_Admin = {
     },
 };
 export const PermissionGroup_PermissionsAssign_NoAccess = {
-    _id: 'dafebd8f706d638400e696345c400fc3',
+    _id: toPermissionGroupId('dafebd8f706d638400e696345c400fc3'),
     name: `${Domain_PermissionsAssign.namespace}/No Access`,
     uiLabel: `${Domain_PermissionsAssign.namespace}/No Access`,
     accessLevels: {
@@ -117,7 +115,7 @@ export const PermissionGroup_PermissionsAssign_NoAccess = {
     },
 };
 export const PermissionGroup_PermissionsAssign_Viewer = {
-    _id: '5b6d75f5644dd9501551487f9a8748b9',
+    _id: toPermissionGroupId('5b6d75f5644dd9501551487f9a8748b9'),
     name: `${Domain_PermissionsAssign.namespace}/Viewer`,
     uiLabel: `${Domain_PermissionsAssign.namespace}/Viewer`,
     accessLevels: {
@@ -125,7 +123,7 @@ export const PermissionGroup_PermissionsAssign_Viewer = {
     },
 };
 export const PermissionGroup_PermissionsAssign_Editor = {
-    _id: 'ac5050d644251fa0b95506280a2ebfb3',
+    _id: toPermissionGroupId('ac5050d644251fa0b95506280a2ebfb3'),
     name: `${Domain_PermissionsAssign.namespace}/Editor`,
     uiLabel: `${Domain_PermissionsAssign.namespace}/Editor`,
     accessLevels: {
@@ -133,7 +131,7 @@ export const PermissionGroup_PermissionsAssign_Editor = {
     },
 };
 export const PermissionGroup_PermissionsAssign_Admin = {
-    _id: '232a8bb28f770ac62d4fa74ed594bfeb',
+    _id: toPermissionGroupId('232a8bb28f770ac62d4fa74ed594bfeb'),
     name: `${Domain_PermissionsAssign.namespace}/Admin`,
     uiLabel: `${Domain_PermissionsAssign.namespace}/Admin`,
     accessLevels: {

package/types.d.ts

@@ -1,5 +1,5 @@
 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';
+import { DatabaseDef_PermissionDomain, DatabaseDef_PermissionProject, 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;
@@ -8,13 +8,13 @@ export type PermissionTypes = {
     PermissionUser: DB_PermissionUser;
 };
 export type DefaultDef_Project = {
-    _id: string;
+    _id: DatabaseDef_PermissionProject['id'];
     name: string;
     packages: DefaultDef_Package[];
     groups?: DefaultDef_Group[];
 };
 export type DefaultDef_Domain = {
-    _id: string;
+    _id: DatabaseDef_PermissionDomain['id'];
     namespace: string;
     levels?: DefaultDef_AccessLevel[];
     customApis?: DefaultDef_Api[];