@webitel/ui-sdk 24.12.95 → 24.12.97

package/src/modules/Userinfo/v2/stores/accessStore.ts

@@ -0,0 +1,131 @@
+import { defineStore } from 'pinia';
+import { NavigationGuard } from 'vue-router';
+
+import {
+  CrudAction,
+  type WtApplication,
+  type WtObject,
+} from '../../../../enums';
+import type { SpecialGlobalAction } from '../enums';
+import {
+  getWtAppByUiSection,
+  makeAppVisibilityMap,
+  makeGlobalAccessMap,
+  makeScopeAccessMap,
+  makeSectionVisibilityMap,
+} from '../scripts/utils';
+import type {
+  AppVisibilityMap,
+  CreateUserAccessStoreConfig,
+  CreateUserAccessStoreRawAccess,
+  GlobalActionAccessMap,
+  ScopeAccessMap,
+  SectionVisibilityMap,
+  UiSection,
+  UserAccessStore,
+} from '../types/UserAccess.d.ts';
+
+export const createUserAccessStore = ({
+  namespace = 'userinfo',
+}: CreateUserAccessStoreConfig = {}) => {
+  return defineStore(`${namespace}/access`, (): UserAccessStore => {
+    let globalAccess: GlobalActionAccessMap = new Map();
+
+    let scopeAccess: ScopeAccessMap = new Map();
+
+    let appVisibilityAccess: AppVisibilityMap = new Map();
+
+    let sectionVisibilityAccess: SectionVisibilityMap = new Map();
+
+    const hasAccess = (
+      action: CrudAction | SpecialGlobalAction,
+      object?: WtObject,
+    ) => {
+      const allowGlobalAccess = globalAccess.get(action);
+      if (allowGlobalAccess) return true;
+
+      const allowScopeAccess =
+        object && scopeAccess.get(object)?.get(action as CrudAction);
+      if (allowScopeAccess) return true;
+
+      return false;
+    };
+
+    const hasReadAccess = (object?: WtObject) => {
+      return hasAccess(CrudAction.Read, object);
+    };
+
+    const hasCreateAccess = (object?: WtObject) => {
+      return hasAccess(CrudAction.Create, object);
+    };
+
+    const hasUpdateAccess = (object?: WtObject) => {
+      return hasAccess(CrudAction.Update, object);
+    };
+
+    const hasDeleteAccess = (object?: WtObject) => {
+      return hasAccess(CrudAction.Delete, object);
+    };
+
+    const hasApplicationVisibility = (app: WtApplication) => {
+      return hasReadAccess() || appVisibilityAccess.get(app);
+    };
+
+    const hasSectionVisibility = (section: UiSection, object: WtObject) => {
+      const appOfSection = getWtAppByUiSection(section);
+      const objectOfSection = object; /*castUiSectionToWtObject(section)*/
+      const hasSectionVisibilityAccess = (section: UiSection) => {
+        return sectionVisibilityAccess.get(section);
+      };
+
+      const allowGlobalAccess = hasReadAccess();
+      if (allowGlobalAccess) return true;
+
+      const allowAppVisibility = hasApplicationVisibility(appOfSection);
+      const allowObjectAccess = hasReadAccess(objectOfSection);
+      const allowSectionVisibility = hasSectionVisibilityAccess(section);
+
+      return allowAppVisibility && allowObjectAccess && allowSectionVisibility;
+    };
+
+    const routeAccessGuard: NavigationGuard = (to) => {
+      /* find last because "matched" has top=>bottom routes order */
+      const uiSection = to.matched
+        .toReversed()
+        .find(({ meta }) => meta.UiSection)?.meta?.UiSection as UiSection;
+      /* find last because "matched" has top=>bottom routes order */
+      const wtObject = to.matched
+        .toReversed()
+        .find(({ meta }) => meta.UiSection)?.meta?.WtObject as WtObject;
+
+      if (uiSection && !hasSectionVisibility(uiSection, wtObject)) {
+        // return false;
+        return { path: '/access-denied' };
+      }
+
+      return true;
+    };
+
+    const initialize = ({
+      permissions: rawGlobalAccess,
+      scope: rawScopeAccess,
+      access: rawVisibilityAccess,
+    }: CreateUserAccessStoreRawAccess) => {
+      globalAccess = makeGlobalAccessMap(rawGlobalAccess);
+      scopeAccess = makeScopeAccessMap(rawScopeAccess);
+      appVisibilityAccess = makeAppVisibilityMap(rawVisibilityAccess);
+      sectionVisibilityAccess = makeSectionVisibilityMap(rawVisibilityAccess);
+    };
+
+    return {
+      initialize,
+
+      hasReadAccess,
+      hasCreateAccess,
+      hasUpdateAccess,
+      hasDeleteAccess,
+
+      routeAccessGuard,
+    };
+  });
+};

package/src/modules/Userinfo/v2/stores/userinfoStore.ts

@@ -0,0 +1,56 @@
+import { defineStore } from 'pinia';
+import { ref } from 'vue';
+
+import { getSession, getUiVisibilityAccess } from '../api/UserinfoAPI';
+import { createUserAccessStore } from './accessStore';
+
+export const createUserinfoStore = () => {
+  const namespace = 'userinfo';
+  const useAccessStore = createUserAccessStore({
+    namespace,
+  });
+
+  const store = defineStore(namespace, () => {
+    const accessStore = useAccessStore();
+    const {
+      hasReadAccess,
+      hasCreateAccess,
+      hasUpdateAccess,
+      hasDeleteAccess,
+      initialize: initializeAccessStore,
+      routeAccessGuard,
+    } = accessStore;
+
+    const userId = ref();
+
+    const initialize = async () => {
+      const { scope, permissions, ...userinfo } = await getSession();
+      const access = await getUiVisibilityAccess();
+
+      userId.value = userinfo.userId;
+
+      initializeAccessStore({
+        scope,
+        permissions,
+        access,
+      });
+    };
+
+    return {
+      userId,
+      initialize,
+
+      hasReadAccess,
+      hasCreateAccess,
+      hasUpdateAccess,
+      hasDeleteAccess,
+
+      routeAccessGuard,
+    };
+  });
+
+  // @ts-ignore
+  window._userinfoStore = store;
+
+  return store;
+};

package/src/modules/Userinfo/v2/types/UserAccess.d.ts

@@ -0,0 +1,118 @@
+import { NavigationGuard } from 'vue-router';
+
+import type {
+  AdminSections,
+  AuditorSections,
+  CrmSections,
+  CrudAction,
+  SupervisorSections,
+  WtApplication,
+  WtObject,
+} from '../../../../enums';
+import type {
+  CrudGlobalAction,
+  ScopeClass,
+  SpecialGlobalAction,
+} from '../enums';
+
+/**
+ * @description
+ * Represents union of all Webitel web client applications/sections
+ * */
+export type UiSection =
+  | AdminSections
+  | AuditorSections
+  | SupervisorSections
+  | CrmSections;
+
+/**
+ * @internal
+ * @description Received from backend
+ * */
+export type GlobalAction = CrudGlobalAction | SpecialGlobalAction;
+
+/**
+ * @internal
+ * */
+export interface GlobalAccessApiResponseItem {
+  id: GlobalAction;
+  name: string;
+  usage: string;
+}
+
+/**
+ * @internal
+ * */
+export interface ScopeAccessApiResponseItem {
+  class: ScopeClass;
+  access: string;
+}
+
+/**
+ * @internal
+ * @description
+ * Represents admin->permissions->roles->access.
+ * */
+export type VisibilityAccess = unknown;
+
+/**
+ * @internal
+ * @description
+ * Represents raw access data, received from backend.
+ * */
+export interface CreateUserAccessStoreRawAccess {
+  permissions: GlobalAccessApiResponseItem[];
+  scope: ScopeAccessApiResponseItem[];
+  access: VisibilityAccess;
+}
+
+/**
+ * @internal
+ */
+export interface CreateUserAccessStoreConfig {
+  /**
+   * @default 'userinfo'
+   * */
+  namespace?: string;
+}
+
+/**
+ * @description
+ * Map is used for quick access to user permissions
+ * */
+export type GlobalActionAccessMap = Map<
+  CrudAction | SpecialGlobalAction,
+  boolean
+>;
+
+/**
+ * @description
+ * Map is used for quick access to user permissions
+ * */
+export type ScopeAccessMap = Map<WtObject, Map<CrudAction, boolean>>;
+
+/**
+ * @description
+ * Map is used for quick access to user permissions
+ * */
+export type AppVisibilityMap = Map<WtApplication, boolean>;
+
+/**
+ * @description
+ * Map is used for quick access to user permissions
+ * */
+export type SectionVisibilityMap = Map<UiSection, boolean>;
+
+export interface UserAccessStore {
+  initialize: (CreateUserAccessStoreRawAccess) => void;
+
+  hasReadAccess: (object?: WtObject) => boolean;
+  hasCreateAccess: (object?: WtObject) => boolean;
+  hasUpdateAccess: (object?: WtObject) => boolean;
+  hasDeleteAccess: (object?: WtObject) => boolean;
+
+  routeAccessGuard: NavigationGuard;
+
+  // hasApplicationVisibility: (app: WtApplication) => boolean;
+  // hasSectionVisibility: (section: UiSection) => boolean;
+}