@mu-cabin/opms-permission 0.8.35 → 0.9.2

package/dist/index.d.mts

@@ -1,18 +1,121 @@
+interface ApiResponse<T> {
+    obj: T;
+    success: boolean;
+    msg: string;
+    code: number;
+}
+type ResourceType = 'MENU' | 'FOLDER' | 'WIDGET' | 'UNDEFINED';
+type OpenIndicatorType = 'INNER_COMPONENT' | 'OUTER_URL';
 interface Resource {
-    resourceId: number;
-    resourceCode: string;
-    resourceName?: string;
-    showName?: string;
-    resourceType?: string;
-    defaultResourceType?: string;
+    belongingContainerId: number;
+    belongingContainerType: string;
     componentPath?: string;
-    defaultUrl?: string;
-    icon?: string;
     defaultIcon?: string;
-    openIndicator: string;
-    prefix?: string;
+    defaultResourceType: string;
+    defaultUrl?: string;
+    nodeLevel?: number;
+    poolParentResourceId?: number;
+    poolShowOrder?: number;
+    resourceId: number;
+    resourceName: string;
+    showName: string;
+    resourceCode: string;
+    searchPath?: string;
     children?: Resource[];
+    prefix: string;
+    resourceType: ResourceType;
+    icon?: string;
+    openIndicator: OpenIndicatorType;
+    orgQueryMode: EnumOrgQueryMode;
+    orgQueryScope: EnumOrgQueryScope;
+}
+type CodeSourceType = 'FLY_NET' | 'COS' | 'CSM';
+interface OrgRecord$1 {
+    orgId: number;
+    orgName: string;
+    orgShortName: string;
+    orgCode: string;
+    nodeLevel: number;
+    hasPermission: boolean;
+    children?: OrgRecord$1[];
+    orgQueryMode?: EnumOrgQueryMode;
+}
+interface UserOrganization$1 {
+    orgId: number;
+    orgCode: string;
+    parentOrgId: number | null;
+    parentOrgCode: string | null;
+    branchId: number | null;
+    branchCode: string | null;
+    orgName: string;
+    orgShortName: string;
+    orgType: string;
+    showOrder: number | null;
+    orgCodeSearchPath: string;
+    positionInfo: any[];
+    orgBindType: string;
+    csmOrgCode: string | null;
+    hasPermission: boolean;
+    canModify: boolean;
+    nodeLevel: number;
+    searchPath: string;
+    children: UserOrganization$1[];
+}
+interface UserRole {
+    roleId: number;
+    roleName: string;
+    parentRoleId: number | null;
+    grantType: string;
+    nodeLevel: number | null;
+    searchPath: string | null;
+    children: UserRole[];
+}
+interface UserInfo$1 {
+    ehrId: number;
+    account: string;
+    crewId: number | null;
+    crewCode: string | null;
+    name: string;
+    individualType: string | null;
+    individualStatus: string | null;
+    opmsRole: string;
+    userOrganizations: UserOrganization$1[];
+    userRoles: UserRole[];
+    uniAccount: string;
 }
+declare enum EnumOrgQueryMode {
+    BY_ROLES = "BY_ROLES",// 配置了页面权限的方式
+    BY_DEPT = "BY_DEPT"
+}
+declare enum EnumOrgQueryScope {
+    ONLY_BRANCH = "ONLY_BRANCH",// 查询到子公司
+    STEWARD_UNIT = "STEWARD_UNIT",// 查询到乘务部(如果用户是业务部门的话包含所有乘务部), 不包括业务部门
+    WITH_DEPARTMENT = "WITH_DEPARTMENT"
+}
+interface UserOrgTreeParams {
+    orgQueryMode: keyof typeof EnumOrgQueryMode;
+    orgQueryScope: keyof typeof EnumOrgQueryScope;
+    menuResourceId?: number;
+    stewardUnitLevel?: number;
+    keepHead?: boolean;
+}
+declare function login(baseUrl: string, authorizationCode: string): Promise<ApiResponse<{
+    token: string;
+}>>;
+declare function logout(baseUrl: string): Promise<ApiResponse<void>>;
+declare function getUserInfo(baseUrl: string): Promise<ApiResponse<UserInfo$1>>;
+declare function queryResource(baseUrl: string, params: {
+    systemId: string;
+}): Promise<ApiResponse<Resource[]>>;
+declare function getOrgTree(baseUrl: string, params: {
+    systemId: string;
+    name: CodeSourceType;
+}): Promise<ApiResponse<OrgRecord$1>>;
+declare function getUserOrgTree(baseUrl: string, params: UserOrgTreeParams): Promise<ApiResponse<OrgRecord$1[]>>;
+declare function queryOrgCompanies(baseUrl: string, params: {
+    queryAllBranches?: boolean;
+}): Promise<ApiResponse<OrgRecord$1[]>>;
+
 interface MenuItem {
     icon?: string;
     path: string;
@@ -58,7 +161,7 @@ interface ChildOrganization {
     orgShortName: string;
     orgType: string;
 }
-interface OrgRecord$1 {
+interface OrgRecord {
     allOrgTags: boolean;
     allSystem: boolean;
     canModify: boolean;
@@ -97,14 +200,54 @@ declare function handlePermissionTree<T extends {
     noAuthMap: Record<number | string, T>;
 };
 
-interface OrgRecord {
-    orgId: number;
-    orgName: string;
-    orgShortName: string;
-    orgCode: string;
-    nodeLevel: number;
-    hasPermission: boolean;
-    children?: OrgRecord[];
+type PermissionEventType = 'tokenChange';
+type PermissionEventListener<T = any> = (data: T) => void;
+interface PermissionEventMap {
+    tokenChange: string;
+}
+/**
+ * Generic Event Emitter class for handling events
+ */
+declare class EventEmitter<TEventMap extends Record<string, any> = PermissionEventMap> {
+    private eventListeners;
+    private allowedEvents;
+    constructor(allowedEvents?: (keyof TEventMap)[]);
+    /**
+     * Add event listener
+     */
+    listen<TEvent extends keyof TEventMap>(event: TEvent, listener: PermissionEventListener<TEventMap[TEvent]>): () => void;
+    /**
+     * Remove event listener
+     */
+    unlisten<TEvent extends keyof TEventMap>(event: TEvent, listener: PermissionEventListener<TEventMap[TEvent]>): void;
+    /**
+     * Remove all listeners for a specific event or all events
+     */
+    unlistenAll(event?: keyof TEventMap): void;
+    /**
+     * Emit event to all listeners
+     */
+    emit<TEvent extends keyof TEventMap>(event: TEvent, data: TEventMap[TEvent]): void;
+    /**
+     * Get the number of listeners for a specific event
+     */
+    getListenerCount(event: keyof TEventMap): number;
+    /**
+     * Check if there are any listeners for a specific event
+     */
+    hasListeners(event: keyof TEventMap): boolean;
+    /**
+     * Get all registered event types
+     */
+    getEventTypes(): (keyof TEventMap)[];
+    /**
+     * Get all allowed event types
+     */
+    getAllowedEvents(): (keyof TEventMap)[];
+    /**
+     * Check if an event is allowed
+     */
+    isEventAllowed(event: keyof TEventMap): boolean;
 }
 
 interface PermissionOptions {
@@ -115,7 +258,7 @@ interface PermissionOptions {
  * 组织树处理工具
  */
 declare const DataHandler: {
-    iterateOrgTree(orgTree: OrgRecord[]): OrgTreeItem[];
+    iterateOrgTree(orgTree: OrgRecord$1[]): OrgTreeItem[];
     iterateNestedArray: typeof iterateNestedArray;
     getAllUnitOptions(orgTree: OrgTreeItem[]): Option[];
     getCompaniesOptions(orgTree: OrgTreeItem[], hasRootAuth: boolean): Option[];
@@ -140,8 +283,6 @@ declare const DataHandler: {
 };
 declare class Permission {
     private _userInfo;
-    private _orgTree;
-    private _orgCompany;
     private systemId;
     private baseUrl;
     resources: Resource[];
@@ -155,7 +296,32 @@ declare class Permission {
     menuMap: {
         [path: string]: MenuItem;
     };
+    private eventEmitter;
     constructor(options: PermissionOptions);
+    /**
+     * Add event listener
+     */
+    listen<T extends PermissionEventType>(event: T, listener: PermissionEventListener<PermissionEventMap[T]>): () => void;
+    /**
+     * Remove event listener
+     */
+    unlisten<T extends PermissionEventType>(event: T, listener: PermissionEventListener<PermissionEventMap[T]>): void;
+    /**
+     * Remove all listeners for a specific event or all events
+     */
+    unlistenAll(event?: PermissionEventType): void;
+    /**
+     * Emit event to all listeners
+     */
+    private emit;
+    /**
+     * Get available events that can be listened to
+     */
+    getAvailableEvents(): PermissionEventType[];
+    /**
+     * Check if an event is supported
+     */
+    isEventSupported(event: string): event is PermissionEventType;
     /**
      * Login using code from URL, save userInfo
      */
@@ -165,7 +331,7 @@ declare class Permission {
      */
     logout(clearData?: boolean): Promise<void>;
     clear(): void;
-    getUserInfo(): Promise<UserInfo | null>;
+    getUserInfo(): Promise<UserInfo$1>;
     /**
      * Get resources and process to menuList, menuMap, widgetMap (matches app store logic)
      */
@@ -181,27 +347,56 @@ declare class Permission {
         menuMap: Record<number, MenuItem>;
     }>;
     /**
-     * Query and process organization tree
+     * Generate cache key for user orgs query
+     */
+    private generateUserOrgsCacheKey;
+    /**
+     * Query and process organization tree with caching
      */
-    queryUserOrgs(): Promise<{
+    queryUserOrgs(params: UserOrgTreeParams, config?: {
+        force?: boolean;
+        cacheTimeout?: number;
+    }): Promise<{
         orgTree: OrgTreeItem[];
-        orgNoAuthMap: Record<number, OrgTreeItem>;
-        authOrgTree: OrgTreeItem[];
     } | null>;
-    queryCompanies(): Promise<OrgRecord[]>;
     isLogin(): boolean;
     getToken(): string | null;
     setToken(token: string): void;
-    get userInfo(): UserInfo | null;
-    get hasRootAuth(): boolean;
-    get userOrganizations(): UserOrganization[];
-    get allCompanyOptions(): Option[];
-    get companyOptions(): Option[];
-    get firstCompanyOrgCode(): string;
-    get unitOptions(): Option[];
-    get allUnitOptions(): Option[];
-    get firstUnitOrgCode(): string;
-    get topLevelUnitOrgCodes(): string[];
+    /**
+     * Get storage information for debugging and monitoring
+     */
+    getStorageInfo(): {
+        permissionKeys: {
+            resourceKey: string;
+            tokenKey: string;
+            userInfoKey: string;
+        };
+        hasData: {
+            resources: boolean;
+            token: boolean;
+            userInfo: boolean;
+        };
+        cacheInfo: {
+            userOrgsCacheCount: number;
+            userOrgsCacheKeys: string[];
+        };
+        systemId: number | string | undefined;
+        currentVersion: string;
+        totalKeys: number;
+        systemKeys: number;
+    };
+    /**
+     * Get current storage version
+     */
+    getStorageVersion(): string;
+    /**
+     * Clear all storage data for this system
+     */
+    clearStorage(): void;
+    /**
+     * Clear user orgs cache for specific parameters or all
+     */
+    clearUserOrgsCache(params?: UserOrgTreeParams): void;
 }
 
 /**
@@ -226,4 +421,4 @@ declare function jumpToSSOLogout({ baseUrl, redirectToUrl, clientId, }: {
     clientId?: string;
 }): void;
 
-export { type ChildOrganization, DataHandler, type MenuItem, Permission as OpmsPermission, type Option, type OrgRecord$1 as OrgRecord, type OrgTreeItem, type Resource, type UserInfo, type UserOrganization, jumpToSSOLogin, jumpToSSOLogout };
+export { type ApiResponse, type ChildOrganization, type CodeSourceType, DataHandler, EnumOrgQueryMode, EnumOrgQueryScope, EventEmitter, type MenuItem, type OpenIndicatorType, Permission as OpmsPermission, type Option, type OrgRecord, type OrgTreeItem, type PermissionEventListener, type PermissionEventMap, type PermissionEventType, type Resource, type ResourceType, type UserInfo, type UserOrgTreeParams, type UserOrganization, type UserRole, getOrgTree, getUserInfo, getUserOrgTree, jumpToSSOLogin, jumpToSSOLogout, login, logout, queryOrgCompanies, queryResource };

package/dist/index.d.ts

@@ -1,18 +1,121 @@
+interface ApiResponse<T> {
+    obj: T;
+    success: boolean;
+    msg: string;
+    code: number;
+}
+type ResourceType = 'MENU' | 'FOLDER' | 'WIDGET' | 'UNDEFINED';
+type OpenIndicatorType = 'INNER_COMPONENT' | 'OUTER_URL';
 interface Resource {
-    resourceId: number;
-    resourceCode: string;
-    resourceName?: string;
-    showName?: string;
-    resourceType?: string;
-    defaultResourceType?: string;
+    belongingContainerId: number;
+    belongingContainerType: string;
     componentPath?: string;
-    defaultUrl?: string;
-    icon?: string;
     defaultIcon?: string;
-    openIndicator: string;
-    prefix?: string;
+    defaultResourceType: string;
+    defaultUrl?: string;
+    nodeLevel?: number;
+    poolParentResourceId?: number;
+    poolShowOrder?: number;
+    resourceId: number;
+    resourceName: string;
+    showName: string;
+    resourceCode: string;
+    searchPath?: string;
     children?: Resource[];
+    prefix: string;
+    resourceType: ResourceType;
+    icon?: string;
+    openIndicator: OpenIndicatorType;
+    orgQueryMode: EnumOrgQueryMode;
+    orgQueryScope: EnumOrgQueryScope;
+}
+type CodeSourceType = 'FLY_NET' | 'COS' | 'CSM';
+interface OrgRecord$1 {
+    orgId: number;
+    orgName: string;
+    orgShortName: string;
+    orgCode: string;
+    nodeLevel: number;
+    hasPermission: boolean;
+    children?: OrgRecord$1[];
+    orgQueryMode?: EnumOrgQueryMode;
+}
+interface UserOrganization$1 {
+    orgId: number;
+    orgCode: string;
+    parentOrgId: number | null;
+    parentOrgCode: string | null;
+    branchId: number | null;
+    branchCode: string | null;
+    orgName: string;
+    orgShortName: string;
+    orgType: string;
+    showOrder: number | null;
+    orgCodeSearchPath: string;
+    positionInfo: any[];
+    orgBindType: string;
+    csmOrgCode: string | null;
+    hasPermission: boolean;
+    canModify: boolean;
+    nodeLevel: number;
+    searchPath: string;
+    children: UserOrganization$1[];
+}
+interface UserRole {
+    roleId: number;
+    roleName: string;
+    parentRoleId: number | null;
+    grantType: string;
+    nodeLevel: number | null;
+    searchPath: string | null;
+    children: UserRole[];
+}
+interface UserInfo$1 {
+    ehrId: number;
+    account: string;
+    crewId: number | null;
+    crewCode: string | null;
+    name: string;
+    individualType: string | null;
+    individualStatus: string | null;
+    opmsRole: string;
+    userOrganizations: UserOrganization$1[];
+    userRoles: UserRole[];
+    uniAccount: string;
 }
+declare enum EnumOrgQueryMode {
+    BY_ROLES = "BY_ROLES",// 配置了页面权限的方式
+    BY_DEPT = "BY_DEPT"
+}
+declare enum EnumOrgQueryScope {
+    ONLY_BRANCH = "ONLY_BRANCH",// 查询到子公司
+    STEWARD_UNIT = "STEWARD_UNIT",// 查询到乘务部(如果用户是业务部门的话包含所有乘务部), 不包括业务部门
+    WITH_DEPARTMENT = "WITH_DEPARTMENT"
+}
+interface UserOrgTreeParams {
+    orgQueryMode: keyof typeof EnumOrgQueryMode;
+    orgQueryScope: keyof typeof EnumOrgQueryScope;
+    menuResourceId?: number;
+    stewardUnitLevel?: number;
+    keepHead?: boolean;
+}
+declare function login(baseUrl: string, authorizationCode: string): Promise<ApiResponse<{
+    token: string;
+}>>;
+declare function logout(baseUrl: string): Promise<ApiResponse<void>>;
+declare function getUserInfo(baseUrl: string): Promise<ApiResponse<UserInfo$1>>;
+declare function queryResource(baseUrl: string, params: {
+    systemId: string;
+}): Promise<ApiResponse<Resource[]>>;
+declare function getOrgTree(baseUrl: string, params: {
+    systemId: string;
+    name: CodeSourceType;
+}): Promise<ApiResponse<OrgRecord$1>>;
+declare function getUserOrgTree(baseUrl: string, params: UserOrgTreeParams): Promise<ApiResponse<OrgRecord$1[]>>;
+declare function queryOrgCompanies(baseUrl: string, params: {
+    queryAllBranches?: boolean;
+}): Promise<ApiResponse<OrgRecord$1[]>>;
+
 interface MenuItem {
     icon?: string;
     path: string;
@@ -58,7 +161,7 @@ interface ChildOrganization {
     orgShortName: string;
     orgType: string;
 }
-interface OrgRecord$1 {
+interface OrgRecord {
     allOrgTags: boolean;
     allSystem: boolean;
     canModify: boolean;
@@ -97,14 +200,54 @@ declare function handlePermissionTree<T extends {
     noAuthMap: Record<number | string, T>;
 };
 
-interface OrgRecord {
-    orgId: number;
-    orgName: string;
-    orgShortName: string;
-    orgCode: string;
-    nodeLevel: number;
-    hasPermission: boolean;
-    children?: OrgRecord[];
+type PermissionEventType = 'tokenChange';
+type PermissionEventListener<T = any> = (data: T) => void;
+interface PermissionEventMap {
+    tokenChange: string;
+}
+/**
+ * Generic Event Emitter class for handling events
+ */
+declare class EventEmitter<TEventMap extends Record<string, any> = PermissionEventMap> {
+    private eventListeners;
+    private allowedEvents;
+    constructor(allowedEvents?: (keyof TEventMap)[]);
+    /**
+     * Add event listener
+     */
+    listen<TEvent extends keyof TEventMap>(event: TEvent, listener: PermissionEventListener<TEventMap[TEvent]>): () => void;
+    /**
+     * Remove event listener
+     */
+    unlisten<TEvent extends keyof TEventMap>(event: TEvent, listener: PermissionEventListener<TEventMap[TEvent]>): void;
+    /**
+     * Remove all listeners for a specific event or all events
+     */
+    unlistenAll(event?: keyof TEventMap): void;
+    /**
+     * Emit event to all listeners
+     */
+    emit<TEvent extends keyof TEventMap>(event: TEvent, data: TEventMap[TEvent]): void;
+    /**
+     * Get the number of listeners for a specific event
+     */
+    getListenerCount(event: keyof TEventMap): number;
+    /**
+     * Check if there are any listeners for a specific event
+     */
+    hasListeners(event: keyof TEventMap): boolean;
+    /**
+     * Get all registered event types
+     */
+    getEventTypes(): (keyof TEventMap)[];
+    /**
+     * Get all allowed event types
+     */
+    getAllowedEvents(): (keyof TEventMap)[];
+    /**
+     * Check if an event is allowed
+     */
+    isEventAllowed(event: keyof TEventMap): boolean;
 }
 
 interface PermissionOptions {
@@ -115,7 +258,7 @@ interface PermissionOptions {
  * 组织树处理工具
  */
 declare const DataHandler: {
-    iterateOrgTree(orgTree: OrgRecord[]): OrgTreeItem[];
+    iterateOrgTree(orgTree: OrgRecord$1[]): OrgTreeItem[];
     iterateNestedArray: typeof iterateNestedArray;
     getAllUnitOptions(orgTree: OrgTreeItem[]): Option[];
     getCompaniesOptions(orgTree: OrgTreeItem[], hasRootAuth: boolean): Option[];
@@ -140,8 +283,6 @@ declare const DataHandler: {
 };
 declare class Permission {
     private _userInfo;
-    private _orgTree;
-    private _orgCompany;
     private systemId;
     private baseUrl;
     resources: Resource[];
@@ -155,7 +296,32 @@ declare class Permission {
     menuMap: {
         [path: string]: MenuItem;
     };
+    private eventEmitter;
     constructor(options: PermissionOptions);
+    /**
+     * Add event listener
+     */
+    listen<T extends PermissionEventType>(event: T, listener: PermissionEventListener<PermissionEventMap[T]>): () => void;
+    /**
+     * Remove event listener
+     */
+    unlisten<T extends PermissionEventType>(event: T, listener: PermissionEventListener<PermissionEventMap[T]>): void;
+    /**
+     * Remove all listeners for a specific event or all events
+     */
+    unlistenAll(event?: PermissionEventType): void;
+    /**
+     * Emit event to all listeners
+     */
+    private emit;
+    /**
+     * Get available events that can be listened to
+     */
+    getAvailableEvents(): PermissionEventType[];
+    /**
+     * Check if an event is supported
+     */
+    isEventSupported(event: string): event is PermissionEventType;
     /**
      * Login using code from URL, save userInfo
      */
@@ -165,7 +331,7 @@ declare class Permission {
      */
     logout(clearData?: boolean): Promise<void>;
     clear(): void;
-    getUserInfo(): Promise<UserInfo | null>;
+    getUserInfo(): Promise<UserInfo$1>;
     /**
      * Get resources and process to menuList, menuMap, widgetMap (matches app store logic)
      */
@@ -181,27 +347,56 @@ declare class Permission {
         menuMap: Record<number, MenuItem>;
     }>;
     /**
-     * Query and process organization tree
+     * Generate cache key for user orgs query
+     */
+    private generateUserOrgsCacheKey;
+    /**
+     * Query and process organization tree with caching
      */
-    queryUserOrgs(): Promise<{
+    queryUserOrgs(params: UserOrgTreeParams, config?: {
+        force?: boolean;
+        cacheTimeout?: number;
+    }): Promise<{
         orgTree: OrgTreeItem[];
-        orgNoAuthMap: Record<number, OrgTreeItem>;
-        authOrgTree: OrgTreeItem[];
     } | null>;
-    queryCompanies(): Promise<OrgRecord[]>;
     isLogin(): boolean;
     getToken(): string | null;
     setToken(token: string): void;
-    get userInfo(): UserInfo | null;
-    get hasRootAuth(): boolean;
-    get userOrganizations(): UserOrganization[];
-    get allCompanyOptions(): Option[];
-    get companyOptions(): Option[];
-    get firstCompanyOrgCode(): string;
-    get unitOptions(): Option[];
-    get allUnitOptions(): Option[];
-    get firstUnitOrgCode(): string;
-    get topLevelUnitOrgCodes(): string[];
+    /**
+     * Get storage information for debugging and monitoring
+     */
+    getStorageInfo(): {
+        permissionKeys: {
+            resourceKey: string;
+            tokenKey: string;
+            userInfoKey: string;
+        };
+        hasData: {
+            resources: boolean;
+            token: boolean;
+            userInfo: boolean;
+        };
+        cacheInfo: {
+            userOrgsCacheCount: number;
+            userOrgsCacheKeys: string[];
+        };
+        systemId: number | string | undefined;
+        currentVersion: string;
+        totalKeys: number;
+        systemKeys: number;
+    };
+    /**
+     * Get current storage version
+     */
+    getStorageVersion(): string;
+    /**
+     * Clear all storage data for this system
+     */
+    clearStorage(): void;
+    /**
+     * Clear user orgs cache for specific parameters or all
+     */
+    clearUserOrgsCache(params?: UserOrgTreeParams): void;
 }
 
 /**
@@ -226,4 +421,4 @@ declare function jumpToSSOLogout({ baseUrl, redirectToUrl, clientId, }: {
     clientId?: string;
 }): void;
 
-export { type ChildOrganization, DataHandler, type MenuItem, Permission as OpmsPermission, type Option, type OrgRecord$1 as OrgRecord, type OrgTreeItem, type Resource, type UserInfo, type UserOrganization, jumpToSSOLogin, jumpToSSOLogout };
+export { type ApiResponse, type ChildOrganization, type CodeSourceType, DataHandler, EnumOrgQueryMode, EnumOrgQueryScope, EventEmitter, type MenuItem, type OpenIndicatorType, Permission as OpmsPermission, type Option, type OrgRecord, type OrgTreeItem, type PermissionEventListener, type PermissionEventMap, type PermissionEventType, type Resource, type ResourceType, type UserInfo, type UserOrgTreeParams, type UserOrganization, type UserRole, getOrgTree, getUserInfo, getUserOrgTree, jumpToSSOLogin, jumpToSSOLogout, login, logout, queryOrgCompanies, queryResource };