storemw-core-client 1.0.1

package/dist/services/permission/PermissionService.d.ts

@@ -0,0 +1,296 @@
+import { ApiServiceType } from '@/lib';
+export type AppRouteId = "operator" | "administrator" | "retail" | "workstation" | "customer" | "member" | "public" | "driver";
+/** Load Custom Configs */
+import { CustomPermissionMap, CustomModuleTypesMap } from './config/custom/config';
+export declare const permissionTypes: {
+    readonly role: "role";
+};
+export declare const targetPermissionTypes: {
+    readonly role: "role";
+};
+export type PermissionType = keyof typeof permissionTypes;
+export type PermissionTargetType = typeof targetPermissionTypes[keyof typeof targetPermissionTypes];
+export type PermissionTargetKey = keyof typeof targetPermissionTypes;
+export type PermissionFunctionType = 'pageList' | 'pageNew' | 'pageView' | 'pageUpdate' | 'pageStockPost' | 'pageVerifyOut' | 'pageVerifyIn' | 'pageVerifyTransferIn' | 'pageExecute' | 'pagePack' | 'pageImages' | 'pageSettings' | 'pageChildrenNew' | 'pageChildrenUpdate' | 'remove' | 'removeChildren' | 'cancel' | 'verifyOutLogs' | 'verifyOutUndo' | 'verifyOutNew' | 'verifyInLogs' | 'verifyInUndo' | 'verifyInNew' | 'verifyTransferInLogs' | 'verifyTransferInUndo' | 'verifyTransferInNew';
+export type FunctionTypeMeta = {
+    id: PermissionFunctionType;
+    label: string;
+    type: PermissionFunctionActionType;
+    description?: string;
+};
+export type FunctionTypeMap = {
+    [key in PermissionFunctionType]: FunctionTypeMeta;
+};
+export type PermissionFunctionActionType = keyof typeof permissionFunctionActionTypes;
+export declare const permissionFunctionActionTypes: {
+    readonly pageAccess: "pageAccess";
+    readonly callAction: "callAction";
+};
+export declare const permissionFunctionTypes: FunctionTypeMap;
+declare const _permissionScopeTypes: readonly ["product", "document", "repository", "logistic", "operation", "user", "userRole", "userBranches", "branchUsers", "group", "region", "business", "customField", "injectionField", "report", "scheduler", "rate", "audit", "wallet", "transaction", "userApiKey", "customSettings"];
+export type PermissionScopeType = typeof _permissionScopeTypes[number];
+export type ScopeTypeMeta = {
+    id: PermissionScopeType;
+    label: string;
+    postValue: string;
+    description: string;
+};
+export type ScopeTypeMap = {
+    [key in PermissionScopeType]: ScopeTypeMeta;
+};
+export declare const permissionScopeTypes: ScopeTypeMap;
+type ModuleProduct = "product" | "item" | "brand" | "category" | "uom";
+type ModuleDocument = "salesOrder" | "proformaSales" | "cashSales" | "retailCashSales" | "deliveryOrder" | "replacementDelivery" | "salesDebitNote" | "salesCreditNote" | "salesInvoice" | "purchaseOrder" | "purchaseReturn" | "purchaseInvoice" | "itemReceive" | "itemTransfer" | "itemRelocate" | "itemTransform" | "itemIssue" | "itemAdjustment" | "stockTake" | "transferReturn" | "transferRequisition" | "tripOrder" | "pickOrder" | "retailPrescription";
+type ModuleRepository = "container" | "package";
+type ModuleLogistic = "transporter";
+type ModuleOperation = "examineInventory" | "itemRelocateThreshold" | "itemReorderThreshold";
+type ModuleUser = "administrator" | "customer" | "driver" | "member" | "retail" | "supplier" | "worker";
+type ModuleUserRole = "role" | "permission";
+type ModuleUserBranches = "customer" | "retail";
+type ModuleBranchUsers = "customer" | "retail";
+type ModuleGroup = "administrator" | "customer" | "supplier";
+type ModuleRegion = "country" | "area";
+type ModuleBusiness = "business";
+type ModuleCustomField = "customField";
+type ModuleInjectionField = "injectionField";
+type ModuleReport = "productItem" | "salesOrder" | "salesOrderItem" | "deliveryOrder" | "deliveryOrderItem" | "itemReceive" | "itemReceiveItem" | "itemTransfer" | "itemTransferItem";
+type ModuleScheduler = "schedulerTask" | "schedulerLog" | "schedulerRequest" | "schedulerConsole";
+type ModuleRate = "shippingRate" | "shippingRule" | "taxRate";
+type ModuleAudit = "auditTrail" | "auditTrailTag";
+type ModuleWallet = "wallet" | "walletUser";
+type ModuleTransaction = "request" | "wallet";
+type ModuleUserApiKey = "apiKey";
+export type ModuleTypeMetaScoped<T extends string> = {
+    id: T;
+    label: string;
+    postValue: string;
+    description?: string;
+};
+export type ModuleTypesMap = {
+    product: {
+        [key in ModuleProduct]: ModuleTypeMetaScoped<key>;
+    };
+    document: {
+        [key in ModuleDocument]: ModuleTypeMetaScoped<key>;
+    };
+    repository: {
+        [key in ModuleRepository]: ModuleTypeMetaScoped<key>;
+    };
+    logistic: {
+        [key in ModuleLogistic]: ModuleTypeMetaScoped<key>;
+    };
+    operation: {
+        [key in ModuleOperation]: ModuleTypeMetaScoped<key>;
+    };
+    user: {
+        [key in ModuleUser]: ModuleTypeMetaScoped<key>;
+    };
+    userRole: {
+        [key in ModuleUserRole]: ModuleTypeMetaScoped<key>;
+    };
+    userBranches: {
+        [key in ModuleUserBranches]: ModuleTypeMetaScoped<key>;
+    };
+    branchUsers: {
+        [key in ModuleBranchUsers]: ModuleTypeMetaScoped<key>;
+    };
+    group: {
+        [key in ModuleGroup]: ModuleTypeMetaScoped<key>;
+    };
+    region: {
+        [key in ModuleRegion]: ModuleTypeMetaScoped<key>;
+    };
+    business: {
+        [key in ModuleBusiness]: ModuleTypeMetaScoped<key>;
+    };
+    customField: {
+        [key in ModuleCustomField]: ModuleTypeMetaScoped<key>;
+    };
+    injectionField: {
+        [key in ModuleInjectionField]: ModuleTypeMetaScoped<key>;
+    };
+    report: {
+        [key in ModuleReport]: ModuleTypeMetaScoped<key>;
+    };
+    scheduler: {
+        [key in ModuleScheduler]: ModuleTypeMetaScoped<key>;
+    };
+    rate: {
+        [key in ModuleRate]: ModuleTypeMetaScoped<key>;
+    };
+    audit: {
+        [key in ModuleAudit]: ModuleTypeMetaScoped<key>;
+    };
+    wallet: {
+        [key in ModuleWallet]: ModuleTypeMetaScoped<key>;
+    };
+    transaction: {
+        [key in ModuleTransaction]: ModuleTypeMetaScoped<key>;
+    };
+    userApiKey: {
+        [key in ModuleUserApiKey]: ModuleTypeMetaScoped<key>;
+    };
+} & CustomModuleTypesMap;
+export declare const permissionModuleTypes: ModuleTypesMap;
+export type Scope = "product" | "document" | "wallet";
+export type Permission = {
+    [key in PermissionFunctionType]?: boolean;
+};
+export type PermissionProduct = {
+    [module in ModuleProduct]?: Permission;
+};
+export type PermissionDocument = {
+    [module in ModuleDocument]?: Permission;
+};
+export type PermissionRepository = {
+    [module in ModuleRepository]?: Permission;
+};
+export type PermissionLogistic = {
+    [module in ModuleLogistic]?: Permission;
+};
+export type PermissionOperation = {
+    [module in ModuleOperation]?: Permission;
+};
+export type PermissionUser = {
+    [module in ModuleUser]?: Permission;
+};
+export type PermissionUserRole = {
+    [module in ModuleUserRole]?: Permission;
+};
+export type PermissionUserBranches = {
+    [module in ModuleUserBranches]?: Permission;
+};
+export type PermissionBranchUsers = {
+    [module in ModuleBranchUsers]?: Permission;
+};
+export type PermissionGroup = {
+    [module in ModuleGroup]?: Permission;
+};
+export type PermissionRegion = {
+    [module in ModuleRegion]?: Permission;
+};
+export type PermissionBusiness = {
+    [module in ModuleBusiness]?: Permission;
+};
+export type PermissionCustomField = {
+    [module in ModuleCustomField]?: Permission;
+};
+export type PermissionInjectionField = {
+    [module in ModuleInjectionField]?: Permission;
+};
+export type PermissionReport = {
+    [module in ModuleReport]?: Permission;
+};
+export type PermissionScheduler = {
+    [module in ModuleScheduler]?: Permission;
+};
+export type PermissionRate = {
+    [module in ModuleRate]?: Permission;
+};
+export type PermissionAudit = {
+    [module in ModuleAudit]?: Permission;
+};
+export type PermissionWallet = {
+    [module in ModuleWallet]?: Permission;
+};
+export type PermissionTransaction = {
+    [module in ModuleTransaction]?: Permission;
+};
+export type PermissionUserApiKey = {
+    [module in ModuleUserApiKey]?: Permission;
+};
+export type PermissionMap = {
+    product: PermissionProduct;
+    document: PermissionDocument;
+    repository: PermissionRepository;
+    logistic: PermissionLogistic;
+    operation: PermissionOperation;
+    user: PermissionUser;
+    userRole: PermissionUserRole;
+    userBranches: PermissionUserBranches;
+    branchUsers: PermissionBranchUsers;
+    group: PermissionGroup;
+    region: PermissionRegion;
+    business: PermissionBusiness;
+    customField: PermissionCustomField;
+    injectionField: PermissionInjectionField;
+    report: PermissionReport;
+    scheduler: PermissionScheduler;
+    rate: PermissionRate;
+    audit: PermissionAudit;
+    wallet: PermissionWallet;
+    transaction: PermissionTransaction;
+    userApiKey: PermissionUserApiKey;
+} & CustomPermissionMap;
+export type PermissionConfig = Partial<{
+    [K in PermissionScopeType]: PermissionMap[K];
+}>;
+export type PermissionServiceProps = ApiServiceType & {
+    isOwnerUser: boolean;
+    userPermissions: any;
+    permissionTargetType?: PermissionTargetType;
+    permissionType?: PermissionType;
+    routeType?: AppRouteId;
+    scopeType?: PermissionScopeType;
+    moduleType?: AllModuleKeys;
+    permissionRouteType?: string;
+};
+export type ChangePermissionProps = {
+    id: number;
+    permissionTargetType?: PermissionTargetType;
+    permissionType?: PermissionType;
+    data: {
+        userRoles: {
+            scopeType: PermissionScopeType;
+            moduleType: ModuleBusiness;
+            functionType: PermissionFunctionType;
+            status: boolean;
+            isCustomScope: boolean;
+        }[];
+    };
+};
+type AllModuleKeys = {
+    [Scope in keyof ModuleTypesMap]: keyof ModuleTypesMap[Scope];
+}[keyof ModuleTypesMap];
+export type CheckPermissionAllowProps = {
+    routeType?: AppRouteId;
+    scopeType?: keyof typeof permissionScopeTypes;
+    moduleType?: AllModuleKeys;
+    functionType: PermissionFunctionType;
+};
+export declare const PermissionService: (props?: PermissionServiceProps) => {
+    getPermissionConfig: (routeType: AppRouteId) => Partial<{
+        document: PermissionDocument;
+        user: PermissionUser;
+        userRole: PermissionUserRole;
+        product: PermissionProduct;
+        repository: PermissionRepository;
+        logistic: PermissionLogistic;
+        operation: PermissionOperation;
+        userBranches: PermissionUserBranches;
+        branchUsers: PermissionBranchUsers;
+        group: PermissionGroup;
+        region: PermissionRegion;
+        business: PermissionBusiness;
+        customField: PermissionCustomField;
+        injectionField: PermissionInjectionField;
+        report: PermissionReport;
+        scheduler: PermissionScheduler;
+        rate: PermissionRate;
+        audit: PermissionAudit;
+        wallet: PermissionWallet;
+        transaction: PermissionTransaction;
+        userApiKey: PermissionUserApiKey;
+        customSettings: {
+            transportType?: Permission | undefined;
+            transportService?: Permission | undefined;
+        };
+    }>;
+    checkPermissionAllow: ({ routeType: overrideRouteType, scopeType: overrideScopeType, moduleType: overrideModuleType, functionType }: CheckPermissionAllowProps) => boolean;
+    changePermission: ({ id, data, permissionType: overridePermissionType, permissionTargetType: overridePermissionTargetType }: ChangePermissionProps) => Promise<{
+        status: boolean;
+        message: string;
+        data?: any;
+    }>;
+};
+export {};