@webitel/ui-sdk 24.12.95 → 24.12.96

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webitel/ui-sdk",
-  "version": "24.12.95",
+  "version": "24.12.96",
   "private": false,
   "scripts": {
     "dev": "vite",
@@ -16,8 +16,9 @@
     "docs:dev": "vitepress dev docs --port 8080",
     "docs:build": "vitepress build docs",
     "docs:preview": "vitepress preview docs",
-    "tsc": "vue-tsc -p tsconfig.json",
-    "update-node": "nvm install --lts && nvm alias default node"
+    "tsc": "tsc -p tsconfig.json",
+    "update-node": "nvm install --lts && nvm alias default node",
+    "i": "npm install"
   },
   "main": "./dist/@webitel/ui-sdk.mjs",
   "type": "module",
@@ -34,6 +35,10 @@
       "import": "./src/enums/index.js",
       "require": "./src/enums/index.js"
     },
+    "./components": {
+      "import": "./src/components/index.js",
+      "require": "./src/components/index.js"
+    },
     "./scripts": {
       "import": "./src/scripts/index.js",
       "require": "./src/scripts/index.js"
@@ -140,13 +145,13 @@
   "devDependencies": {
     "@eslint/js": "^9.17.0",
     "@tsconfig/node22": "^22.0.0",
-    "@types/node": "^22.9.1",
+    "@types/node": "^22.12.0",
     "@vitejs/plugin-vue": "^5.2.0",
     "@vitest/coverage-v8": "^2.1.5",
     "@vue/compat": "^3.5.13",
     "@vue/compiler-sfc": "^3.5.13",
     "@vue/test-utils": "^2.4.6",
-    "@vue/tsconfig": "^0.6.0",
+    "@vue/tsconfig": "^0.7.0",
     "eslint": "^9.17.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-simple-import-sort": "^12.1.1",
@@ -162,8 +167,8 @@
     "prettier": "^3.4.2",
     "prismjs": "^1.29.0",
     "sass": "^1.81.0",
-    "typescript": "5.6.3",
-    "typescript-eslint": "^8.18.1",
+    "typescript": "5.7.3",
+    "typescript-eslint": "^8.22.0",
     "typescript-plugin-css-modules": "^5.1.0",
     "vite": "^5.4.11",
     "vite-plugin-checker": "^0.8.0",
@@ -175,7 +180,8 @@
     "vitest": "^2.1.5",
     "vue": "^3.5.13",
     "vue-tsc": "^2.1.10",
-    "vuex": "^4.1.0"
+    "vuex": "^4.1.0",
+    "pinia": "^2.3.0"
   },
   "optionalDependencies": {
     "@rollup/rollup-linux-x64-gnu": "4.9.5"

package/src/api/defaults/getDefaultInstance/getDefaultInstance.js

@@ -2,13 +2,16 @@ import generateInstance from '../../axios/generateInstance.js';
 import updateTokenInterceptor from '../../interceptors/request/updateToken.interceptor.js';
 import handleUnauthorizedInterceptor from '../../interceptors/response/handleUnauthorized.interceptor.js';
 
-const getDefaultInstance = () =>
-  generateInstance({
+const getDefaultInstance = () => {
+  return generateInstance({
     interceptors: {
       request: [updateTokenInterceptor],
       response: [handleUnauthorizedInterceptor],
     },
     baseURL: import.meta.env.VITE_API_URL,
   });
+};
+
+export { getDefaultInstance };
 
 export default getDefaultInstance;

package/src/api/defaults/index.js

@@ -4,8 +4,8 @@ import getDefaultInstance from './getDefaultInstance/getDefaultInstance.js';
 import getDefaultOpenAPIConfig from './getDefaultOpenAPIConfig/getDefaultOpenAPIConfig.js';
 
 export {
-  getDefaultGetParams,
   getDefaultGetListResponse,
+  getDefaultGetParams,
   getDefaultInstance,
   getDefaultOpenAPIConfig,
 };

package/src/components/wt-dual-panel/wt-dual-panel.vue

@@ -33,8 +33,7 @@
 <script setup>
 import { computed, defineEmits, ref } from 'vue';
 
-import IconAction from '../../enums/IconAction/IconAction.enum.js';
-import { ComponentSize } from '../../enums/index.js';
+import { ComponentSize, IconAction } from '../../enums';
 
 const props = defineProps({
   actionsPanel: {

package/src/components/wt-icon-action/iconMappings.js

@@ -1,4 +1,4 @@
-import { IconAction } from '../../enums/index.js';
+import { IconAction } from '../../enums';
 
 export const WtIconActionIconMappings = Object.freeze({
   [IconAction.ADD]: 'plus',

package/src/composables/useAccessControl/v2/createUserAccessControl.ts

@@ -0,0 +1,66 @@
+import { computed } from 'vue';
+import { useRoute } from 'vue-router';
+
+import { _wtUiLog } from '../../../scripts/logger';
+import type {
+  CreateUserAccessControlComposableParams,
+  UseAccessControlReturn,
+} from './types/CreateUserAccessControl';
+
+export const createUserAccessControlComposable = (
+  useUserinfoStore: CreateUserAccessControlComposableParams,
+) => {
+  const useUserAccessControl = (
+    resource?: string,
+    // options: UseUserAccessControlComposableOptions = {},
+  ): UseAccessControlReturn => {
+    const route = useRoute();
+    const object = resource || route?.meta?.WtObject;
+
+    const userinfoStore = useUserinfoStore();
+
+    if (!object) {
+      _wtUiLog.error({
+        module: 'access control',
+        entity: 'useUserAccessControl composable',
+      })(
+        'No WtObject found in route meta or passed as first param, cannot check access control',
+      );
+    }
+
+    const hasReadAccess = computed(() => {
+      return userinfoStore.hasReadAccess(object);
+    });
+    const hasCreateAccess = computed(() => {
+      return userinfoStore.hasCreateAccess(object);
+    });
+    const hasUpdateAccess = computed(() => {
+      return userinfoStore.hasUpdateAccess(object);
+    });
+    const hasDeleteAccess = computed(() => {
+      return userinfoStore.hasDeleteAccess(object);
+    });
+
+    const hasSaveActionAccess = computed(() => {
+      if (route.params.id === 'new') return hasCreateAccess.value;
+      return hasUpdateAccess.value;
+    });
+
+    const disableUserInput = computed(() => {
+      if (route.params.id === 'new') return !hasCreateAccess.value;
+      return !hasUpdateAccess.value;
+    });
+
+    return {
+      hasReadAccess,
+      hasCreateAccess,
+      hasUpdateAccess,
+      hasDeleteAccess,
+
+      hasSaveActionAccess,
+      disableUserInput,
+    };
+  };
+
+  return useUserAccessControl;
+};

package/src/composables/useAccessControl/v2/types/CreateUserAccessControl.d.ts

@@ -0,0 +1,21 @@
+import type { Ref } from 'vue';
+
+import type { WtObject } from '../../../../enums';
+import type { createUserAccessStore } from '../../../../modules/Userinfo/v2/stores/accessStore';
+
+export type CreateUserAccessControlComposableParams =
+  ReturnType<createUserAccessStore>;
+
+export type UseUserAccessControlComposableOptions = {
+  resource?: WtObject;
+};
+
+export interface UseAccessControlReturn {
+  hasReadAccess: Ref<boolean>;
+  hasCreateAccess: Ref<boolean>;
+  hasUpdateAccess: Ref<boolean>;
+  hasDeleteAccess: Ref<boolean>;
+
+  hasSaveActionAccess: Ref<boolean>;
+  disableUserInput: Ref<boolean>;
+}

package/src/enums/CrudAction/CrudAction.js

@@ -0,0 +1,6 @@
+export const CrudAction = {
+    Read: 'read',
+    Create: 'create',
+    Update: 'update',
+    Delete: 'delete',
+};

package/src/enums/CrudAction/CrudAction.ts

@@ -0,0 +1,8 @@
+export const CrudAction = {
+  Read: 'read',
+  Create: 'create',
+  Update: 'update',
+  Delete: 'delete',
+} as const;
+
+export type CrudAction = (typeof CrudAction)[keyof typeof CrudAction];

package/src/enums/WtObject/WtObject.js

@@ -5,5 +5,55 @@ export const WtObject = {
     Agent: 'agent',
     Queue: 'queue',
     Contact: 'contact',
-    Regions: 'regions',
+    Region: 'region',
+    User: 'user',
+    Resource: 'resource',
+    Device: 'device',
+    License: 'license',
+    Flow: 'flow',
+    Dialplan: 'dialplan',
+    Gateway: 'gateway',
+    Chatplan: 'chatplan',
+    ChatGateway: 'chatGateway',
+    Blacklist: 'blacklist',
+    Calendar: 'calendar',
+    Communication: 'communication',
+    PauseCause: 'pauseCause',
+    Media: 'media',
+    ShiftTemplate: 'shiftTemplate',
+    PauseTemplate: 'pauseTemplate',
+    WorkingCondition: 'workingCondition',
+    Skill: 'skill',
+    Bucket: 'bucket',
+    Member: 'member',
+    ResourceGroup: 'resourceGroup',
+    Team: 'team',
+    Storage: 'storage',
+    CognitiveProfile: 'cognitiveProfile',
+    EmailProfile: 'emailProfile',
+    SingleSignOn: 'singleSignOn',
+    ImportCsv: 'importCsv',
+    Trigger: 'trigger',
+    Role: 'role',
+    Object: 'object',
+    ChangeLog: 'changelog',
+    Configuration: 'configuration',
+    GlobalVariable: 'globalVariable',
+    ActiveCall: 'activeCall',
+    Scorecard: 'scorecard',
+    Logger: 'logger',
+    Call: 'call',
+    RecordFile: 'recordFile',
+    ContactGroup: 'contactGroup',
+    ChatBot: 'chatBot',
+    Cases: 'cases',
+    CaseComment: 'caseComment',
+    Slas: 'slas',
+    ServiceCatalog: 'serviceCatalog',
+    CaseSource: 'caseSource',
+    CloseReasonGroup: 'closeReasonGroup',
+    Priorities: 'priorities',
+    Status: 'status',
+    Source: 'source',
+    CustomLookup: 'customLookup',
 };

package/src/enums/WtObject/WtObject.ts

@@ -5,7 +5,57 @@ export const WtObject = {
   Agent: 'agent',
   Queue: 'queue',
   Contact: 'contact',
-  Regions: 'regions',
+  Region: 'region',
+  User: 'user',
+  Resource: 'resource',
+  Device: 'device',
+  License: 'license',
+  Flow: 'flow',
+  Dialplan: 'dialplan',
+  Gateway: 'gateway',
+  Chatplan: 'chatplan',
+  ChatGateway: 'chatGateway',
+  Blacklist: 'blacklist',
+  Calendar: 'calendar',
+  Communication: 'communication',
+  PauseCause: 'pauseCause',
+  Media: 'media',
+  ShiftTemplate: 'shiftTemplate',
+  PauseTemplate: 'pauseTemplate',
+  WorkingCondition: 'workingCondition',
+  Skill: 'skill',
+  Bucket: 'bucket',
+  Member: 'member',
+  ResourceGroup: 'resourceGroup',
+  Team: 'team',
+  Storage: 'storage',
+  CognitiveProfile: 'cognitiveProfile',
+  EmailProfile: 'emailProfile',
+  SingleSignOn: 'singleSignOn',
+  ImportCsv: 'importCsv',
+  Trigger: 'trigger',
+  Role: 'role',
+  Object: 'object',
+  ChangeLog: 'changelog',
+  Configuration: 'configuration',
+  GlobalVariable: 'globalVariable',
+  ActiveCall: 'activeCall',
+  Scorecard: 'scorecard',
+  Logger: 'logger',
+  Call: 'call',
+  RecordFile: 'recordFile',
+  ContactGroup: 'contactGroup',
+  ChatBot: 'chatBot',
+  Cases: 'cases',
+  CaseComment: 'caseComment',
+  Slas: 'slas',
+  ServiceCatalog: 'serviceCatalog',
+  CaseSource: 'caseSource',
+  CloseReasonGroup: 'closeReasonGroup',
+  Priorities: 'priorities',
+  Status: 'status',
+  Source: 'source',
+  CustomLookup: 'customLookup',
 } as const;
 
 export type WtObject = (typeof WtObject)[keyof typeof WtObject];

package/src/enums/index.js

@@ -2,28 +2,15 @@ import AbstractUserStatus from './AbstractUserStatus/AbstractUserStatus.enum.js'
 import AgentStatus from './AgentStatus/AgentStatus.enum.js';
 import ChatGatewayProvider from './ChatGatewayProvider/ChatGatewayProvider.enum.js';
 import { ComponentSize } from './ComponentSize/ComponentSize';
+import { CrudAction } from './CrudAction/CrudAction';
 import IconAction from './IconAction/IconAction.enum.js';
 import QueueType from './QueueType/QueueType.enum.js';
 import TypesExportedSettings from './TypesExportedSettings/TypesExportedSettings.enum.js';
 import { AdminSections } from './WebitelApplications/AdminSections';
-import AuditorSections from './WebitelApplications/AuditorSections.enum.js';
-import CrmSections from './WebitelApplications/CrmSections.enum.js';
-import SupervisorSections from './WebitelApplications/SupervisorSections.enum.js';
+import { AuditorSections } from './WebitelApplications/AuditorSections';
+import { CrmSections } from './WebitelApplications/CrmSections';
+import { SupervisorSections } from './WebitelApplications/SupervisorSections';
 import WebitelApplications from './WebitelApplications/WebitelApplications.enum.js';
+import { WtApplication } from './WebitelApplications/WtApplication';
 import { WtObject } from './WtObject/WtObject';
-
-export {
-  AbstractUserStatus,
-  AdminSections,
-  AgentStatus,
-  AuditorSections,
-  ChatGatewayProvider,
-  ComponentSize,
-  CrmSections,
-  IconAction,
-  QueueType,
-  SupervisorSections,
-  TypesExportedSettings,
-  WebitelApplications,
-  WtObject,
-};
+export { AbstractUserStatus, AdminSections, AgentStatus, AuditorSections, ChatGatewayProvider, ComponentSize, CrmSections, CrudAction, IconAction, QueueType, SupervisorSections, TypesExportedSettings, WebitelApplications, WtApplication, WtObject, };

package/src/enums/index.ts

@@ -0,0 +1,33 @@
+import AbstractUserStatus from './AbstractUserStatus/AbstractUserStatus.enum.js';
+import AgentStatus from './AgentStatus/AgentStatus.enum.js';
+import ChatGatewayProvider from './ChatGatewayProvider/ChatGatewayProvider.enum.js';
+import { ComponentSize } from './ComponentSize/ComponentSize';
+import { CrudAction } from './CrudAction/CrudAction';
+import IconAction from './IconAction/IconAction.enum.js';
+import QueueType from './QueueType/QueueType.enum.js';
+import TypesExportedSettings from './TypesExportedSettings/TypesExportedSettings.enum.js';
+import { AdminSections } from './WebitelApplications/AdminSections';
+import { AuditorSections } from './WebitelApplications/AuditorSections';
+import { CrmSections } from './WebitelApplications/CrmSections';
+import { SupervisorSections } from './WebitelApplications/SupervisorSections';
+import WebitelApplications from './WebitelApplications/WebitelApplications.enum.js';
+import { WtApplication } from './WebitelApplications/WtApplication';
+import { WtObject } from './WtObject/WtObject';
+
+export {
+  AbstractUserStatus,
+  AdminSections,
+  AgentStatus,
+  AuditorSections,
+  ChatGatewayProvider,
+  ComponentSize,
+  CrmSections,
+  CrudAction,
+  IconAction,
+  QueueType,
+  SupervisorSections,
+  TypesExportedSettings,
+  WebitelApplications,
+  WtApplication,
+  WtObject,
+};

package/src/locale/en/en.js

@@ -6,8 +6,8 @@ import {
   EngineRoutingSchemaType,
 } from 'webitel-sdk';
 
+import { IconAction } from '../../enums';
 import ChatGatewayProvider from '../../enums/ChatGatewayProvider/ChatGatewayProvider.enum.js';
-import { IconAction } from '../../enums/index.js';
 import QueueType from '../../enums/QueueType/QueueType.enum.js';
 import AdminSections from '../../enums/WebitelApplications/AdminSections.enum.js';
 import AuditorSections from '../../enums/WebitelApplications/AuditorSections.enum.js';

package/src/locale/ru/ru.js

@@ -6,8 +6,8 @@ import {
   EngineRoutingSchemaType,
 } from 'webitel-sdk';
 
+import { IconAction } from '../../enums';
 import ChatGatewayProvider from '../../enums/ChatGatewayProvider/ChatGatewayProvider.enum.js';
-import { IconAction } from '../../enums/index.js';
 import QueueType from '../../enums/QueueType/QueueType.enum.js';
 import AdminSections from '../../enums/WebitelApplications/AdminSections.enum.js';
 import AuditorSections from '../../enums/WebitelApplications/AuditorSections.enum.js';

package/src/locale/ua/ua.js

@@ -6,8 +6,8 @@ import {
   EngineRoutingSchemaType,
 } from 'webitel-sdk';
 
+import { IconAction } from '../../enums';
 import ChatGatewayProvider from '../../enums/ChatGatewayProvider/ChatGatewayProvider.enum.js';
-import { IconAction } from '../../enums/index.js';
 import QueueType from '../../enums/QueueType/QueueType.enum.js';
 import AdminSections from '../../enums/WebitelApplications/AdminSections.enum.js';
 import AuditorSections from '../../enums/WebitelApplications/AuditorSections.enum.js';

package/src/modules/Userinfo/api/userinfo.js

@@ -1,38 +1,25 @@
-import applyTransform, {
-  notify,
-  snakeToCamel,
-} from '../../../api/transformers/index.js';
+import {
+  getSession,
+  getUiVisibilityAccess,
+  logout,
+  setInstance,
+} from '../v2/api/UserinfoAPI';
 
-const userinfo = (instance) => ({
-  async getSession() {
-    const url = '/userinfo';
-    try {
-      const response = await instance.get(url);
-      return applyTransform(response.data, [snakeToCamel()]);
-    } catch (err) {
-      throw applyTransform(err, [notify]);
-    }
-  },
+/**
+ * @deprecated remove after v25.06 release
+ * @description
+ * backward compat
+ * */
+const userinfo = (instance) => {
+  if (instance) {
+    setInstance(instance);
+  }
 
-  async getApplicationsAccess() {
-    const url = 'role/metadata/access';
-    try {
-      const response = await instance.get(url);
-      return applyTransform(response.data, [snakeToCamel()]);
-    } catch (err) {
-      throw applyTransform(err, [notify]);
-    }
-  },
-
-  async logout() {
-    const url = '/logout';
-
-    try {
-      return await instance.post(url, {});
-    } catch (err) {
-      throw applyTransform(err, [notify]);
-    }
-  },
-});
+  return {
+    getSession,
+    logout,
+    getUiVisibilityAccess,
+  };
+};
 
 export default userinfo;

package/src/modules/Userinfo/store/UserinfoStoreModule.js

@@ -117,7 +117,7 @@ export default class UserinfoStoreModule extends BaseStoreModule {
       }
 
       await context.dispatch('SET_SESSION', session);
-      const access = await userinfo.getApplicationsAccess();
+      const access = await userinfo.getUiVisibilityAccess();
       await context.dispatch(
         'SET_APPLICATIONS_ACCESS',
         new ApplicationsAccess({ access }).getAccess(),

package/src/modules/Userinfo/v2/api/UserinfoAPI.ts

@@ -0,0 +1,62 @@
+import type { AxiosInstance } from 'axios';
+
+import getDefaultInstance from '../../../../api/defaults/getDefaultInstance/getDefaultInstance';
+import applyTransform, {
+  merge,
+  notify,
+  snakeToCamel,
+} from '../../../../api/transformers/index.js';
+import type {
+  GlobalAccessApiResponseItem,
+  ScopeAccessApiResponseItem,
+  VisibilityAccess,
+} from '../types/UserAccess';
+
+let instance = getDefaultInstance();
+
+const setInstance = (newInstance: AxiosInstance) => {
+  instance = newInstance;
+};
+
+const getSession = async (): Promise<{
+  scope: ScopeAccessApiResponseItem[];
+  permissions: GlobalAccessApiResponseItem[];
+  userId: string;
+}> => {
+  const url = '/userinfo';
+  try {
+    const defaultObject = () => ({
+      scope: [],
+      permissions: [],
+    });
+
+    const response = await instance.get(url);
+    return applyTransform(response.data, [
+      merge(defaultObject()),
+      snakeToCamel(),
+    ]);
+  } catch (err) {
+    throw applyTransform(err, [notify]);
+  }
+};
+
+const getUiVisibilityAccess = async (): Promise<VisibilityAccess> => {
+  const url = 'role/metadata/access';
+  try {
+    const response = await instance.get(url);
+    return applyTransform(response.data, [snakeToCamel()]);
+  } catch (err) {
+    throw applyTransform(err, [notify]);
+  }
+};
+
+const logout = async () => {
+  const url = '/logout';
+  try {
+    return await instance.post(url, {});
+  } catch (err) {
+    throw applyTransform(err, [notify]);
+  }
+};
+
+export { getSession, getUiVisibilityAccess, logout, setInstance };

package/src/modules/Userinfo/v2/enums/GlobalActions/GlobalActions.ts

@@ -0,0 +1,36 @@
+/**
+ * @internal
+ * @description
+ * Represents backend response
+ * format for Global Access to Crud Actions.
+ * Should be converted to {@link CrudAction}
+ * */
+export const CrudGlobalAction = {
+  Read: 'read',
+  Write: 'write',
+  Delete: 'delete',
+  Add: 'add',
+} as const;
+
+export type CrudGlobalAction =
+  (typeof CrudGlobalAction)[keyof typeof CrudGlobalAction];
+
+/**
+ * @description
+ * Represents access to global specific actions
+ * like downloading files or exporting data
+ * */
+export const SpecialGlobalAction = {
+  PlaybackRecordFile: 'playbackRecordFile',
+  ManageUserLicense: 'manageUserLicense',
+  SchemeVariables: 'schemeVariables',
+  SystemSetting: 'systemSetting',
+  ManageUserRoles: 'manageUserRoles',
+  ExportDataGrid: 'exportDataGrid',
+  ViewCdrPhoneNumbers: 'viewCdrPhoneNumbers',
+  ChangeUserPassword: 'changeUserPassword',
+  EavesdropCall: 'eavesdropCall',
+} as const;
+
+export type SpecialGlobalAction =
+  (typeof SpecialGlobalAction)[keyof typeof SpecialGlobalAction];

package/src/modules/Userinfo/v2/enums/ScopeClass/ScopeClass.ts

@@ -0,0 +1,47 @@
+/**
+ * @description
+ * backend `scope` field userinfo response classes
+ * `class` represents a group of entities, managed by this one class
+ */
+export const ScopeClass = {
+  /**
+   * Includes:
+   * - {@link WtObject.Agent}
+   * - {@link }
+   */
+  Agent: 'cc_agent',
+  Queue: 'cc_queue',
+  Dictionaries: 'dictionaries',
+  EmailProfile: 'email_profile',
+
+  Skills: 'cc_skill',
+  Users: 'users',
+  Devices: 'devices',
+  AcrRouting: 'acr_routing',
+  Gateways: 'gateways',
+  AcrChatPlan: 'acr_chat_plan',
+  Chats: 'chats',
+  List: 'cc_list',
+  Calendars: 'calendars',
+  Team: 'cc_team',
+  ResourceGroup: 'cc_resource_group',
+  Resource: 'cc_resource',
+  StorageProfile: 'storage_profile',
+  CognitiveProfile: 'cognitive_profile',
+  SingleSignOn: 'single_sign_on',
+  ImportTemplate: 'import_template',
+  Trigger: 'trigger',
+  Schema: 'schema',
+  Role: 'roles',
+  Contacts: 'contacts',
+  MediaFile: 'media_file',
+  Logger: 'logger',
+  Calls: 'calls',
+  RecordFile: 'record_file',
+  ContactGroups: 'contact_groups',
+  ChatBots: 'chat_bots',
+  Cases: 'cases',
+  CaseComments: 'case_comments',
+} as const;
+
+export type ScopeClass = (typeof ScopeClass)[keyof typeof ScopeClass];

package/src/modules/Userinfo/v2/enums/index.ts

@@ -0,0 +1,7 @@
+import {
+  CrudGlobalAction,
+  SpecialGlobalAction,
+} from './GlobalActions/GlobalActions';
+import { ScopeClass } from './ScopeClass/ScopeClass';
+
+export { CrudGlobalAction, ScopeClass, SpecialGlobalAction };