ch3chi-commons-vue 0.1.11 → 0.1.13

package/dist/model/QueryParameter.d.ts

@@ -0,0 +1,94 @@
+import { ApiResponse } from '../api/ApiService';
+/**
+ * QuerySort 定義了查詢的排序條件
+ */
+export interface QuerySort {
+    field: string;
+    direction: 'asc' | 'desc';
+}
+/**
+ * PageSizeOptions 定義了可用的分頁大小選項
+ */
+export declare const PageSizeOptions: number[];
+/**
+ * IQueryPage 定義了查詢的分頁資訊
+ */
+export interface IQueryPage {
+    pageIndex: number;
+    pageSize: number;
+    totalPage: number;
+    totalCount: number;
+}
+/**
+ * QueryPage 實現了 IQueryPage 接口，提供分頁資訊的管理
+ */
+export declare class QueryPage implements IQueryPage {
+    pageIndex: number;
+    pageSize: number;
+    totalPage: number;
+    private _totalCount;
+    pageRangeDisplayed: number;
+    constructor(data?: Partial<QueryPage>);
+    get totalCount(): number;
+    set totalCount(value: number);
+    get offset(): number;
+    /**
+     * 計算總頁數
+     */
+    calcTotalPage(): void;
+    hasPreviousPage(): boolean;
+    hasNextPage(): boolean;
+    previous(): void;
+    next(): void;
+    isShowFirstPage(): boolean;
+    isShowLastPage(): boolean;
+    usePageItemArray(): number[];
+    /**
+     * 生成分頁的顯示範圍，項目為從 0 開始的頁碼陣列
+     *
+     * @returns {number[]} 返回一個包含顯示頁碼的陣列
+     */
+    pageRange(): number[];
+}
+export interface QueryParameter {
+    keyword?: string | null;
+    page?: QueryPage;
+    sort?: QuerySort[];
+}
+export declare class QueryParameter implements QueryParameter {
+    keyword?: string | null;
+    page?: QueryPage;
+    sort?: QuerySort[];
+    constructor(data?: Partial<QueryParameter>);
+    /**
+     * 載入查詢參數資料
+     * @param data 部分或全部的查詢參數
+     */
+    load(data?: Partial<QueryParameter>): void;
+    /**
+     * 載入 API 回應資料
+     * @param response
+     */
+    loadResponse(response: ApiResponse): void;
+    /**
+     * 產生 API 使用的 payload
+     * @returns {Record<string, any>} 返回一個包含查詢參數的物件
+     */
+    toPayload(): Record<string, any>;
+    /**
+     * 產生 URL 查詢參數
+     */
+    toQueryStringParam(): Record<string, any>;
+    /**
+     * 清除查詢參數
+     */
+    clear(): void;
+}
+/**
+ * 適用於 Date Range 的查詢參數
+ */
+export declare class DateRangeParam extends QueryParameter {
+    startsAt?: Date | null;
+    endsAt?: Date | null;
+    clear(): void;
+}

package/dist/model/SessionUser.d.ts

@@ -0,0 +1,30 @@
+/**
+ * 用來描述操作人員的物件
+ * 用來保存已登入的使用者資訊
+ */
+export declare class SessionUser {
+    sub?: string;
+    iat?: number;
+    account?: string;
+    name?: string;
+    email?: string;
+    roleCode?: string;
+    roleName?: string;
+    permissions?: string[];
+    constructor(data?: Partial<SessionUser>);
+    /**
+     * 載入資料
+     * @param data
+     */
+    load(data: Record<string, any>): SessionUser;
+    /**
+     * 合併資料
+     * @param data
+     */
+    merge(data: Partial<SessionUser>): SessionUser;
+    /**
+     * 對載入的資料進行預處理
+     * @param data
+     */
+    process(data: Record<string, any>): Record<string, any>;
+}

package/dist/stores/FormDataStore.d.ts

@@ -0,0 +1,31 @@
+/**
+ * Backup Form Data Store
+ * This store is used to manage the system setting details in a backup form.
+ */
+export declare const backupFormDataStore: import('pinia').StoreDefinition<"formData", {
+    store: Record<string, any>;
+}, {
+    getBackupData: (state: {
+        store: Record<string, any>;
+    } & import('pinia').PiniaCustomStateProperties<{
+        store: Record<string, any>;
+    }>) => (dataName: string) => Record<string, any> | null;
+}, {
+    backupData(dataName: string, data: Record<string, any>): void;
+}>;
+/**
+ * 用來保留查詢表單的資料到 local storage
+ */
+export declare const useQueryFormDataStore: import('pinia').StoreDefinition<"queryFormData", {
+    store: Record<string, any>;
+}, {
+    getQueryParam: (state: {
+        store: Record<string, any>;
+    } & import('pinia').PiniaCustomStateProperties<{
+        store: Record<string, any>;
+    }>) => (formName: string) => Record<string, any> | null;
+}, {
+    save(formName: string, queryParam: Record<string, any>): void;
+    loadAllFromLocalStorage(): void;
+    clearQueryParam(formName: string): void;
+}>;

package/dist/stores/ViewStore.d.ts

@@ -0,0 +1,215 @@
+import { ComponentPublicInstance } from 'vue';
+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';
+export type RouterNavigationType = 'push' | 'back' | 'forward' | 'unknown';
+/**
+ * 保存視圖相關的狀態，例如側邊欄開啟狀態、模態框、Toast、全局加載等
+ */
+export declare const useViewStore: import('pinia').StoreDefinition<"view", {
+    navigationType: RouterNavigationType;
+    isSidebarOpen: boolean;
+    mainBSModal: ComponentPublicInstance<typeof CAlert> | null;
+    toastView: ComponentPublicInstance<typeof CBSToast> | null;
+    globalSpinner: ComponentPublicInstance<typeof CGlobalSpinner> | null;
+    version: string;
+}, {}, {
+    routerNavigationType(type: RouterNavigationType): void;
+    toggleSidebar(): void;
+    showModal(data: CAlertModalData): void;
+    showModalError(data: CAlertModalData): void;
+    showModelAlert(data: CAlertModalData): void;
+    showModalConfirm(data: CAlertModalData): void;
+    hideModal(): void;
+    addToast(data: CAlertModalData): void;
+    showSpinner(): void;
+    hideSpinner(): void;
+    setVersion(version: string): void;
+}>;
+/**
+ * 保存使用者會話相關的狀態，例如使用者資訊、是否已登入等
+ */
+export declare const useSessionStore: import('pinia').StoreDefinition<"session", {
+    user: SessionUser | 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;
+    checkSessionIsValid(): Promise<boolean>;
+    startSessionCheck(): void;
+    stopSessionCheck(): void;
+    logout(): void;
+}>;

package/dist/utils/CToolUtils.d.ts

@@ -0,0 +1,41 @@
+import * as yup from "yup";
+/**
+ * 空函式
+ */
+export declare const voidFunction: () => void;
+/**
+ * 寫入 Vue ref 物件的值
+ * @param refObj
+ * @param value
+ */
+export declare const writeVueRefValue: (refObj: any, value: any) => void;
+/**
+ * Lodash 擴充工具
+ */
+export declare const lodashExTools: {
+    getVal: (obj: any, path: string | null | undefined, defaultValue?: any) => any;
+};
+/**
+ * 檢查是否有相同的檔案
+ * @param fileList 檔案列表
+ * @param file 要檢查的檔案
+ */
+export declare const checkHasSameFile: (fileList: File[], file: File) => boolean;
+/**
+ * 格式化物件中的所有日期屬性為指定格式的字串。
+ * @param obj
+ */
+export declare function formatDatesInObject(obj: any): any;
+/**
+ * 建立一個日期區間驗證器，用於 yup 的 test 方法中。
+ * @param startDateKey
+ * @param endDateKey
+ * @param startDateMessage
+ * @param endDateMessage
+ */
+export declare function makeDateRangeValidator({ startDateKey, endDateKey, startDateMessage, endDateMessage }: {
+    startDateKey: string;
+    endDateKey: string;
+    startDateMessage: string;
+    endDateMessage: string;
+}): (this: yup.TestContext, formValues: Record<string, any>) => true | yup.ValidationError;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ch3chi-commons-vue",
-  "version": "0.1.11",
+  "version": "0.1.13",
   "description": "",
   "main": "dist/index.es.js",
   "types": "dist/index.d.ts",