ch3chi-commons-vue 0.1.13 → 1.2.0

package/dist/stores/ViewStore.d.ts

@@ -1,22 +1,30 @@
 import { ComponentPublicInstance } from 'vue';
+import { DefineStoreOptions } from 'pinia';
 import { default as CAlert } from '../components/CAlert.vue';
 import { CAlertModalData } from '../components/CAlertDefine';
 import { default as CBSToast } from '../components/CBSToast.vue';
 import { default as CGlobalSpinner } from '../components/CGlobalSpinner.vue';
 import { SessionUser } from '../model/SessionUser';
 import { CMenuItem } from '../model/CMenuItem';
+import { ShowMessageType } from '../model/ShowMessageDataModel';
+import { AccessToken } from '../model/TokenUser';
+import { BaseDictionary, CBaseDictionary } from '../model/BaseDictionary';
 export type RouterNavigationType = 'push' | 'back' | 'forward' | 'unknown';
 /**
- * 保存視圖相關的狀態，例如側邊欄開啟狀態、模態框、Toast、全局加載等
+ * 全局視圖相關的狀態
  */
-export declare const useViewStore: import('pinia').StoreDefinition<"view", {
+export type GlobalViewState = {
     navigationType: RouterNavigationType;
     isSidebarOpen: boolean;
     mainBSModal: ComponentPublicInstance<typeof CAlert> | null;
     toastView: ComponentPublicInstance<typeof CBSToast> | null;
     globalSpinner: ComponentPublicInstance<typeof CGlobalSpinner> | null;
     version: string;
-}, {}, {
+};
+/**
+ * 全局視圖相關的行為
+ */
+export interface GlobalViewActions {
     routerNavigationType(type: RouterNavigationType): void;
     toggleSidebar(): void;
     showModal(data: CAlertModalData): void;
@@ -28,188 +36,314 @@ export declare const useViewStore: import('pinia').StoreDefinition<"view", {
     showSpinner(): void;
     hideSpinner(): void;
     setVersion(version: string): void;
-}>;
+}
+/**
+ * 全局視圖相關的 getters
+ */
+export interface GlobalViewGetters {
+}
+/**
+ * 全局視圖 store 定義類型
+ */
+export type GlobalViewStoreOptionDefine = Omit<DefineStoreOptions<'view', GlobalViewState, GlobalViewGetters, GlobalViewActions>, 'id'>;
 /**
- * 保存使用者會話相關的狀態，例如使用者資訊、是否已登入等
+ * 全局視圖 store 定義
  */
-export declare const useSessionStore: import('pinia').StoreDefinition<"session", {
-    user: SessionUser | null;
+export declare const globalViewStoreOptions: GlobalViewStoreOptionDefine;
+/**
+ * 保存視圖相關的狀態，例如側邊欄開啟狀態、模態框、Toast、全局加載等
+ */
+export declare const useViewStore: import('pinia').StoreDefinition<"view", GlobalViewState, GlobalViewGetters & ThisType<{
+    navigationType: RouterNavigationType;
+    isSidebarOpen: boolean;
+    mainBSModal: ComponentPublicInstance<typeof CAlert> | null;
+    toastView: ComponentPublicInstance<typeof CBSToast> | null;
+    globalSpinner: ComponentPublicInstance<typeof CGlobalSpinner> | null;
+    version: string;
+} & {} & {} & import('pinia').PiniaCustomProperties<string, import('pinia').StateTree, import('pinia')._GettersTree<import('pinia').StateTree>, import('pinia')._ActionsTree>> & import('pinia')._GettersTree<GlobalViewState>, GlobalViewActions & ThisType<GlobalViewActions & {
+    navigationType: RouterNavigationType;
+    isSidebarOpen: boolean;
+    mainBSModal: ComponentPublicInstance<typeof CAlert> | null;
+    toastView: ComponentPublicInstance<typeof CBSToast> | null;
+    globalSpinner: ComponentPublicInstance<typeof CGlobalSpinner> | null;
+    version: string;
+} & import('pinia')._StoreWithState<"view", GlobalViewState, GlobalViewGetters, GlobalViewActions> & {} & {} & import('pinia').PiniaCustomProperties<string, import('pinia').StateTree, import('pinia')._GettersTree<import('pinia').StateTree>, import('pinia')._ActionsTree>>>;
+export declare const __GlobalViewStoreDefine__: GlobalViewState & GlobalViewActions & GlobalViewGetters & GlobalViewStoreOptionDefine;
+/**
+ * 使用者會話相關的狀態
+ */
+export type UserSessionState<T extends SessionUser = SessionUser> = {
+    user: T | null;
+    token?: AccessToken | null;
     isAuth: boolean;
     sessionCheckTimer: number | null;
-}, {
-    isAuthenticated: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => boolean;
-    userUid: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => string | undefined;
-    account: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => string | undefined;
-    userName: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => string | undefined;
-    email: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => string | undefined;
-    roleCode: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => string | undefined;
-    permissions: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => string[] | undefined;
-    menuItems(): CMenuItem[];
-    caseDataScope: (state: {
-        user: {
-            sub?: string | undefined;
-            iat?: number | undefined;
-            account?: string | undefined;
-            name?: string | undefined;
-            email?: string | undefined;
-            roleCode?: string | undefined;
-            roleName?: string | undefined;
-            permissions?: string[] | undefined;
-            load: (data: Record<string, any>) => SessionUser;
-            merge: (data: Partial<SessionUser>) => SessionUser;
-            process: (data: Record<string, any>) => Record<string, any>;
-        } | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    } & import('pinia').PiniaCustomStateProperties<{
-        user: SessionUser | null;
-        isAuth: boolean;
-        sessionCheckTimer: number | null;
-    }>) => never[];
-}, {
-    saveUser(user: SessionUser | null): void;
+    shouldRedirectToLogin: boolean | null;
+    shouldRedirectToMessage?: boolean;
+    redirectMessageType?: ShowMessageType | null;
+};
+/**
+ * 使用者會話相關的行為
+ */
+export interface UserSessionActions<T extends SessionUser = SessionUser> {
+    saveUser(user: T | null): void;
+    saveToken(token: AccessToken | null): void;
+    setAuthenticated(isAuth: boolean): void;
     checkSessionIsValid(): Promise<boolean>;
+    validateSession(helper: () => Promise<T>): Promise<boolean>;
+    refreshToken(helper: () => Promise<AccessToken>): Promise<boolean>;
     startSessionCheck(): void;
     stopSessionCheck(): void;
+    hasPermission(needPermission: string | string[]): boolean;
     logout(): void;
-}>;
+    triggerManualLogout: () => void;
+    resetShouldRedirectToLogin: () => void;
+    triggerAuthFailedRedirect: () => void;
+    resetAuthFailedRedirect: () => void;
+}
+/**
+ * 使用者會話相關的 getters
+ */
+export interface UserSessionGetters<T extends SessionUser = SessionUser> {
+    currentUser(state: UserSessionState<T>): T | null;
+    currentToken(state: UserSessionState<T>): AccessToken | null;
+    isAuthenticated(state: UserSessionState<T>): boolean;
+    userUid(state: UserSessionState<T>): string | undefined;
+    account(state: UserSessionState<T>): string | undefined;
+    userName(state: UserSessionState<T>): string | undefined;
+    email(state: UserSessionState<T>): string | undefined;
+    roleCode(state: UserSessionState<T>): string | undefined;
+    permissions(state: UserSessionState<T>): string[] | undefined;
+    menuItems(): CMenuItem[];
+}
+/**
+ * 使用者會話 store 定義類型
+ */
+export type UserSessionStoreOptionDefine<T extends SessionUser = SessionUser> = Omit<DefineStoreOptions<'session', UserSessionState<T>, UserSessionGetters<T>, UserSessionActions<T>>, 'id'>;
+/**
+ * 使用者會話 store 定義
+ * 此方式僅適用於 SessionUser 類型，只使用 session 當作帳號權限驗證
+ */
+export declare const userSessionStoreOptions: UserSessionStoreOptionDefine<SessionUser>;
+/**
+ * 持久化設定選項
+ */
+export interface PersistOptions<T extends SessionUser = SessionUser> {
+    enabled?: boolean;
+    key?: string;
+    storage?: Storage;
+    paths?: string[];
+    userConstructor?: new () => T;
+    serializer?: {
+        serialize: (state: any) => string;
+        deserialize: (str: string) => any;
+    };
+    onLogout?: (user: T | null, token: AccessToken | null) => void;
+    onLogin?: (user: T) => void;
+}
+/**
+ * 創建使用者會話 store 選項的工廠函數，支援自訂的 SessionUser 類型
+ * @param persistOptions
+ */
+export declare function createUserSessionOptions<T extends SessionUser = SessionUser>(persistOptions?: PersistOptions<T>): UserSessionStoreOptionDefine<T>;
+/**
+ * 創建使用者會話 store 的工廠函數，支援自訂的 SessionUser 類型
+ */
+export declare function createUserSessionStore<T extends SessionUser = SessionUser>(storeId?: string, persistOptions?: PersistOptions<T>): import('pinia').StoreDefinition<string, UserSessionState<T>, UserSessionGetters<T> & ThisType<{
+    user: import('vue').UnwrapRef<T> | null;
+    token?: {
+        tokenType?: string | undefined;
+        accessToken?: string | undefined;
+        accessTokenExpiresAt?: string | undefined;
+        refreshToken?: string | undefined;
+        refreshTokenExpiresAt?: string | undefined;
+        sessionUid?: string | undefined;
+        isExpired: () => boolean;
+        isRefreshTokenExpired: () => boolean;
+        loadToken: (data: Record<string, any>) => AccessToken;
+        toJSON: () => Record<string, any>;
+        loadJSON: (data: Record<string, any>) => AccessToken;
+        readonly bearerToken: string;
+    } | null | undefined;
+    isAuth: boolean;
+    sessionCheckTimer: number | null;
+    shouldRedirectToLogin: boolean | null;
+    shouldRedirectToMessage?: boolean | undefined;
+    redirectMessageType?: (ShowMessageType | null) | undefined;
+} & {
+    readonly currentUser: T | null;
+    readonly currentToken: AccessToken | null;
+    readonly isAuthenticated: boolean;
+    readonly userUid: string | undefined;
+    readonly account: string | undefined;
+    readonly userName: string | undefined;
+    readonly email: string | undefined;
+    readonly roleCode: string | undefined;
+    readonly permissions: string[] | undefined;
+    readonly menuItems: CMenuItem[];
+} & {} & import('pinia').PiniaCustomProperties<string, import('pinia').StateTree, import('pinia')._GettersTree<import('pinia').StateTree>, import('pinia')._ActionsTree>> & import('pinia')._GettersTree<UserSessionState<T>>, UserSessionActions<T> & ThisType<UserSessionActions<T> & {
+    user: import('vue').UnwrapRef<T> | null;
+    token?: {
+        tokenType?: string | undefined;
+        accessToken?: string | undefined;
+        accessTokenExpiresAt?: string | undefined;
+        refreshToken?: string | undefined;
+        refreshTokenExpiresAt?: string | undefined;
+        sessionUid?: string | undefined;
+        isExpired: () => boolean;
+        isRefreshTokenExpired: () => boolean;
+        loadToken: (data: Record<string, any>) => AccessToken;
+        toJSON: () => Record<string, any>;
+        loadJSON: (data: Record<string, any>) => AccessToken;
+        readonly bearerToken: string;
+    } | null | undefined;
+    isAuth: boolean;
+    sessionCheckTimer: number | null;
+    shouldRedirectToLogin: boolean | null;
+    shouldRedirectToMessage?: boolean | undefined;
+    redirectMessageType?: (ShowMessageType | null) | undefined;
+} & import('pinia')._StoreWithState<"session", UserSessionState<T>, UserSessionGetters<T>, UserSessionActions<T>> & {
+    readonly currentUser: T | null;
+    readonly currentToken: AccessToken | null;
+    readonly isAuthenticated: boolean;
+    readonly userUid: string | undefined;
+    readonly account: string | undefined;
+    readonly userName: string | undefined;
+    readonly email: string | undefined;
+    readonly roleCode: string | undefined;
+    readonly permissions: string[] | undefined;
+    readonly menuItems: CMenuItem[];
+} & {} & import('pinia').PiniaCustomProperties<string, import('pinia').StateTree, import('pinia')._GettersTree<import('pinia').StateTree>, import('pinia')._ActionsTree>>>;
+/**
+ * 預設的使用者會話 store（使用 SessionUser）
+ */
+export declare const useUserSessionStore: import('pinia').StoreDefinition<string, UserSessionState<SessionUser>, UserSessionGetters<SessionUser> & ThisType<{
+    user: {
+        userUid?: string | undefined;
+        iat?: number | undefined;
+        account?: string | undefined;
+        name?: string | undefined;
+        email?: string | undefined;
+        roleCode?: string | undefined;
+        roleName?: string | undefined;
+        permissions?: string[] | undefined;
+        load: (data: Record<string, any>) => SessionUser;
+        loadFromValidateSession: (data: any) => SessionUser;
+        merge: (data: Partial<SessionUser>) => SessionUser;
+        process: (data: Record<string, any>) => Record<string, any>;
+        toJSON: () => Record<string, any>;
+        loadJSON: (data: Record<string, any>) => SessionUser;
+    } | null;
+    token?: {
+        tokenType?: string | undefined;
+        accessToken?: string | undefined;
+        accessTokenExpiresAt?: string | undefined;
+        refreshToken?: string | undefined;
+        refreshTokenExpiresAt?: string | undefined;
+        sessionUid?: string | undefined;
+        isExpired: () => boolean;
+        isRefreshTokenExpired: () => boolean;
+        loadToken: (data: Record<string, any>) => AccessToken;
+        toJSON: () => Record<string, any>;
+        loadJSON: (data: Record<string, any>) => AccessToken;
+        readonly bearerToken: string;
+    } | null | undefined;
+    isAuth: boolean;
+    sessionCheckTimer: number | null;
+    shouldRedirectToLogin: boolean | null;
+    shouldRedirectToMessage?: boolean | undefined;
+    redirectMessageType?: (ShowMessageType | null) | undefined;
+} & {
+    readonly currentUser: SessionUser | null;
+    readonly currentToken: AccessToken | null;
+    readonly isAuthenticated: boolean;
+    readonly userUid: string | undefined;
+    readonly account: string | undefined;
+    readonly userName: string | undefined;
+    readonly email: string | undefined;
+    readonly roleCode: string | undefined;
+    readonly permissions: string[] | undefined;
+    readonly menuItems: CMenuItem[];
+} & {} & import('pinia').PiniaCustomProperties<string, import('pinia').StateTree, import('pinia')._GettersTree<import('pinia').StateTree>, import('pinia')._ActionsTree>> & import('pinia')._GettersTree<UserSessionState<SessionUser>>, UserSessionActions<SessionUser> & ThisType<UserSessionActions<SessionUser> & {
+    user: {
+        userUid?: string | undefined;
+        iat?: number | undefined;
+        account?: string | undefined;
+        name?: string | undefined;
+        email?: string | undefined;
+        roleCode?: string | undefined;
+        roleName?: string | undefined;
+        permissions?: string[] | undefined;
+        load: (data: Record<string, any>) => SessionUser;
+        loadFromValidateSession: (data: any) => SessionUser;
+        merge: (data: Partial<SessionUser>) => SessionUser;
+        process: (data: Record<string, any>) => Record<string, any>;
+        toJSON: () => Record<string, any>;
+        loadJSON: (data: Record<string, any>) => SessionUser;
+    } | null;
+    token?: {
+        tokenType?: string | undefined;
+        accessToken?: string | undefined;
+        accessTokenExpiresAt?: string | undefined;
+        refreshToken?: string | undefined;
+        refreshTokenExpiresAt?: string | undefined;
+        sessionUid?: string | undefined;
+        isExpired: () => boolean;
+        isRefreshTokenExpired: () => boolean;
+        loadToken: (data: Record<string, any>) => AccessToken;
+        toJSON: () => Record<string, any>;
+        loadJSON: (data: Record<string, any>) => AccessToken;
+        readonly bearerToken: string;
+    } | null | undefined;
+    isAuth: boolean;
+    sessionCheckTimer: number | null;
+    shouldRedirectToLogin: boolean | null;
+    shouldRedirectToMessage?: boolean | undefined;
+    redirectMessageType?: (ShowMessageType | null) | undefined;
+} & import('pinia')._StoreWithState<"session", UserSessionState<SessionUser>, UserSessionGetters<SessionUser>, UserSessionActions<SessionUser>> & {
+    readonly currentUser: SessionUser | null;
+    readonly currentToken: AccessToken | null;
+    readonly isAuthenticated: boolean;
+    readonly userUid: string | undefined;
+    readonly account: string | undefined;
+    readonly userName: string | undefined;
+    readonly email: string | undefined;
+    readonly roleCode: string | undefined;
+    readonly permissions: string[] | undefined;
+    readonly menuItems: CMenuItem[];
+} & {} & import('pinia').PiniaCustomProperties<string, import('pinia').StateTree, import('pinia')._GettersTree<import('pinia').StateTree>, import('pinia')._ActionsTree>>>;
+export declare const __UserSessionTypes__: UserSessionState & UserSessionGetters & UserSessionActions & UserSessionStoreOptionDefine & PersistOptions;
+export interface DictionaryPersistOptions<T extends BaseDictionary = CBaseDictionary> {
+    enabled?: boolean;
+    key?: string;
+    storage?: Storage;
+    paths?: string[];
+    dictConstructor?: new () => T;
+    serializer?: {
+        serialize: (state: any) => string;
+        deserialize: (str: string) => any;
+    };
+}
+export type DictionaryState<T extends BaseDictionary = CBaseDictionary> = {
+    dictionary: T | null;
+};
+export interface DictionaryActions<T extends BaseDictionary = CBaseDictionary> {
+    setDictionary(dict: T): void;
+    loadAll(): void;
+    loadDictionary(key: string): void;
+}
+export interface DictionaryGetters<T extends BaseDictionary = CBaseDictionary> {
+    dict(): T | null;
+}
+/**
+ * Dictionary store 定義類型
+ */
+export type DictionaryStoreOptionDefine<T extends BaseDictionary = CBaseDictionary> = Omit<DefineStoreOptions<'dictionary', DictionaryState<T>, DictionaryGetters<T>, DictionaryActions<T>>, 'id'>;
+/**
+ * 創建 Dictionary store 選項的工廠函數
+ * @param dictConstructor
+ */
+export declare function createDictionaryStoreOptions<T extends BaseDictionary = CBaseDictionary>(options: {
+    dictionary?: T;
+    persistOptions?: DictionaryPersistOptions<T>;
+}): DictionaryStoreOptionDefine<T>;
+export declare const __DictionaryStoreTypes__: DictionaryState & DictionaryActions & DictionaryGetters & DictionaryStoreOptionDefine;