ch3chi-commons-vue 1.2.0 → 1.8.1

package/dist/model/CMenuItem.d.ts

@@ -1,86 +0,0 @@
-import { Ref } from 'vue';
-import { PermissionDescriptor } from '../auth/PermissionDescriptor';
-/**
- * MenuItem 介面用於描述左側選單項目結構
- * name: 顯示名稱
- * icon: 圖示 class 或路徑（可選）
- * path: 路由路徑
- * children: 子選單項目（可選，型別為 CMenuItem 陣列）
- */
-export interface MenuItem {
-    id: string;
-    name: string;
-    icon?: string;
-    fontIcon?: string;
-    path?: string;
-    children?: MenuItem[];
-    needRoles?: string[];
-    permission?: string | string[];
-    activePaths?: string[];
-    hasChildren?: () => boolean;
-}
-/**
- * CMenuItem 類別實現 MenuItem 介面
- */
-export declare class CMenuItem implements MenuItem {
-    id: string;
-    name: string;
-    icon?: string;
-    fontIcon?: string;
-    path?: string;
-    needRoles?: string[];
-    permission?: string | string[];
-    permissionDescriptors?: PermissionDescriptor[];
-    activePaths?: string[];
-    children?: CMenuItem[];
-    isOpen?: Ref<boolean>;
-    isActive?: Ref<boolean>;
-    constructor(params: MenuItem);
-    /**
-     * 判斷是否有子選單項目
-     * @returns {boolean} 如果有子選單項目則返回 true，否則返回 false
-     */
-    hasChildren(): boolean;
-    /**
-     * 使用 collapse 屬性來控制子選單的展開或收起狀態
-     * 這個方法可以在 Vue 模板中使用 v-bind 指令來
-     * 綁定到 collapse 屬性上，以實現子選單的折
-     */
-    useCollapseAttribute(): Record<string, any>;
-    /**
-     * 使用 collapseId 方法來生成唯一的折疊 ID
-     */
-    useCollapseId(): string;
-    /**
-     * 使用 useClassName 方法來生成 CSS 類名
-     */
-    useClassNameForNavLink(): string;
-    /**
-     * 使用 useClassName 方法來生成 CSS 類名
-     */
-    useClassNameForLi(): string;
-    /**
-     * 計算箭頭圖示的 CSS 類名
-     */
-    computeArrowClass(): string;
-    /**
-     * 計算折疊顯示的 CSS 類名
-     */
-    computeCollapseShowClass(): string;
-    /**
-     * 計算折疊的 CSS 類名
-     * @returns {string} 返回折疊的 CSS 類名
-     */
-    collapseClassName(): string;
-    /**
-     * 檢查當前路徑是否與此選單項目的路徑匹配
-     * @param currentPath
-     */
-    checkCurrentPath(currentPath: string): boolean;
-    /**
-     * 靜態方法用於從 MenuItem 物件解析出 CMenuItem 實例
-     * @param item {MenuItem} 要解析的 MenuItem 物件
-     * @return {CMenuItem} 返回解析後的 CMenuItem 實例
-     */
-    static parse(item: MenuItem): CMenuItem;
-}

package/dist/model/EmailReceiverDataModel.d.ts

@@ -1,57 +0,0 @@
-import { BaseFormDataModel } from './BaseFormDataModel';
-import { ComputedRef } from 'vue';
-import * as yup from "yup";
-/**
- * Email 收件人資料
- */
-export declare class EmailRecipientData extends BaseFormDataModel {
-    email: string;
-    type: 'receiver' | 'cc' | 'bcc';
-    constructor(data?: Partial<EmailRecipientData>);
-    dataFieldNameList(): string[];
-    initFormSchema(): yup.ObjectSchema<{
-        email: string;
-        type: NonNullable<"receiver" | "cc" | "bcc" | undefined>;
-    }, yup.AnyObject, {
-        email: undefined;
-        type: undefined;
-    }, "">;
-}
-/**
- * Email 收件人資料模型
- *
- */
-export declare class EmailReceiverDataModel extends BaseFormDataModel {
-    recipientList: Array<EmailRecipientData>;
-    constructor(data?: Partial<EmailReceiverDataModel>);
-    dataFieldNameList(): string[];
-    initFormSchema(): yup.ObjectSchema<{
-        recipientList: {
-            type: NonNullable<"receiver" | "cc" | "bcc" | undefined>;
-            email: string;
-        }[] | undefined;
-    }, yup.AnyObject, {
-        recipientList: "";
-    }, "">;
-    toPayload(key?: string): Record<string, any>;
-    /**
-     * 收件人列表
-     * @return {ComputedRef<Array<EmailRecipientData>>}
-     */
-    dataList(): ComputedRef<Array<EmailRecipientData>>;
-    /**
-     * 新增收件人
-     * @param data
-     */
-    add(data?: Partial<EmailRecipientData>): void;
-    /**
-     * 刪除收件人
-     * @param index
-     */
-    remove(index: number): void;
-    /**
-     * 清空表單
-     */
-    clean(): void;
-    get recipientListField(): import('vee-validate').FieldContext;
-}

package/dist/model/EmptyDataModel.d.ts

@@ -1,7 +0,0 @@
-import { BaseFormDataModel } from './BaseFormDataModel';
-import * as yup from 'yup';
-export declare class EmptyDataModel extends BaseFormDataModel {
-    constructor(data?: Partial<EmptyDataModel>);
-    initFormSchema(): yup.ObjectSchema<{}, yup.AnyObject, {}, "">;
-    dataFieldNameList(): string[];
-}

package/dist/model/FormOptions.d.ts

@@ -1,60 +0,0 @@
-/**
- * 表單選項相關的 TypeScript 接口定義
- */
-/**
- * COptionItem 接口定義
- */
-export interface COptionItem {
-    id: string;
-    text: string;
-    value: string | number | boolean;
-    disabled?: boolean;
-    selected?: boolean;
-    children?: CCOptionItem[];
-    meta?: Record<string, any>;
-}
-/**
- * COptionItem 類別實現
- */
-export declare class CCOptionItem implements COptionItem {
-    id: string;
-    text: string;
-    value: string | number | boolean;
-    disabled?: boolean;
-    selected?: boolean;
-    children?: CCOptionItem[];
-    meta?: Record<string, any>;
-    constructor(data?: Partial<COptionItem>);
-}
-/**
- * DataCategory 資料類別
- */
-export declare class DataCategory {
-    slug?: string;
-    name?: string;
-    constructor(data?: Partial<DataCategory>);
-}
-/**
- * 基本狀態選項
- */
-export declare const ToggleStatusOptions: COptionItem[];
-/**
- * 通用選項，適用當 value 為 boolean 時
- */
-export declare const CommonStatusOptions: COptionItem[];
-/**
- * 通用選項，適用當 value 為字串時
- */
-export declare const CommonStatusStrOptions: COptionItem[];
-/**
- * 是/否 選項
- */
-export declare const YesNoStatusOptions: COptionItem[];
-export declare const OptionUtils: {
-    /**
-     * 根據 CommonStatusOptions 產生對應的 狀態標籤 HTML
-     * @param value 狀態值
-     */
-    makeCommonStatusLabelText: (value: string | boolean) => string;
-};
-export declare const __FormOptionsTypes__: COptionItem & DataCategory;

package/dist/model/LoginDataModel.d.ts

@@ -1,12 +0,0 @@
-import { BaseFormDataModel } from './BaseFormDataModel';
-import { ObjectSchema } from 'yup';
-export declare class LoginDataModel extends BaseFormDataModel {
-    account?: string;
-    password?: string;
-    turnstileToken?: string;
-    enableCFTurnstile: boolean;
-    constructor(data?: Partial<LoginDataModel>);
-    dataFieldNameList(): string[];
-    initFormSchema(): ObjectSchema<any>;
-    formToJsonData(): Record<string, any>;
-}

package/dist/model/PasswordDataModel.d.ts

@@ -1,15 +0,0 @@
-import { BaseFormDataModel } from './BaseFormDataModel';
-import { ObjectSchema } from 'yup';
-/**
- * 密碼數據模型
- */
-export declare class PasswordDataModel extends BaseFormDataModel {
-    oldPassword: string | null;
-    newPassword: string | null;
-    confirmNewPassword: string | null;
-    requiredOldPassword: boolean;
-    constructor(data?: Partial<PasswordDataModel>);
-    dataFieldNameList(): string[];
-    initFormSchema(): ObjectSchema<any>;
-    toPayload(): Record<string, any>;
-}

package/dist/model/QueryParameter.d.ts

@@ -1,92 +0,0 @@
-import { ApiResponse } from '../api/ApiService';
-export type SortDirection = 'ASC' | 'asc' | 'DESC' | 'desc';
-/**
- * QuerySort 定義了查詢的排序條件
- */
-export interface QuerySort {
-    field: string;
-    direction: SortDirection;
-}
-/**
- * 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;
-}
-export declare const __QueryParameterDefine__: SortDirection;

package/dist/model/SessionUser.d.ts

@@ -1,45 +0,0 @@
-/**
- * Role model
- */
-export declare class Role {
-    uid?: string;
-    name?: string;
-    type?: string;
-}
-/**
- * 用來描述操作人員的物件
- * 用來保存已登入的使用者資訊
- */
-export declare class SessionUser {
-    userUid?: 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>): this;
-    /**
-     * 從驗證會話資料載入
-     * @param data
-     */
-    loadFromValidateSession(data: any): this;
-    /**
-     * 合併資料
-     * @param data
-     */
-    merge(data: Partial<SessionUser>): SessionUser;
-    /**
-     * 對載入的資料進行預處理
-     * @param data
-     */
-    process(data: Record<string, any>): Record<string, any>;
-    toJSON(): Record<string, any>;
-    loadJSON(data: Record<string, any>): this;
-}

package/dist/model/ShowMessageDataModel.d.ts

@@ -1,44 +0,0 @@
-/**
- * ShowMessage 訊息類型列舉
- */
-export declare enum ShowMessageType {
-    /** 忘記密碼郵件已發送 */
-    FORGOT_PASSWORD_SENT = "FP_SENT",
-    /** 重置密碼成功 */
-    RESET_PASSWORD_SUCCESS = "RP_OK",
-    /** 認證過期 */
-    AUTH_EXPIRED = "AUTH_EXP"
-}
-/**
- * ShowMessage 頁面訊息資料模型
- * 用於定義系統各種訊息的標題、內容、狀態碼等資訊
- */
-export interface IShowMessageData {
-    title: string;
-    message: string;
-    code?: string;
-    showLoginButton?: boolean;
-    showHomeButton?: boolean;
-}
-/**
- * ShowMessage 訊息定義
- */
-export declare class ShowMessageDataModel {
-    private static _messageMap;
-    static set messageMap(map: Record<ShowMessageType, IShowMessageData>);
-    /**
-     * 根據訊息類型取得訊息資料
-     */
-    static getMessageData(type: ShowMessageType): IShowMessageData;
-    /**
-     * 根據 key 字串取得訊息資料（用於從 query string 解析）
-     */
-    static getMessageDataByKey(key: string): IShowMessageData | null;
-    /**
-     * 將訊息類型轉換為路由參數（path params）
-     */
-    static toRouteParams(type: ShowMessageType): {
-        type: string;
-    };
-}
-export declare const __ShowMessageDataModelDefine__: ShowMessageType & IShowMessageData;

package/dist/model/TokenUser.d.ts

@@ -1,50 +0,0 @@
-import { SessionUser } from './SessionUser';
-/**
- * 存放存取權杖相關資訊
- */
-export declare class AccessToken {
-    tokenType?: string;
-    accessToken?: string;
-    accessTokenExpiresAt?: string;
-    refreshToken?: string;
-    refreshTokenExpiresAt?: string;
-    sessionUid?: string;
-    constructor(data?: Partial<AccessToken>);
-    /**
-     * 存取權杖是否已過期
-     */
-    isExpired(): boolean;
-    /**
-     * 刷新權杖是否已過期
-     */
-    isRefreshTokenExpired(): boolean;
-    /**
-     * 載入資料
-     * @param data
-     */
-    loadToken(data: Record<string, any>): this;
-    /**
-     * 轉換為 JSON 物件
-     */
-    toJSON(): Record<string, any>;
-    /**
-     * 從 JSON 資料載入
-     * @param data
-     */
-    loadJSON(data: Record<string, any>): this;
-    /**
-     * 取得 Bearer Token 字串
-     */
-    get bearerToken(): string;
-}
-/**
- * 帶有 Token 資訊的使用者物件
- */
-export declare class TokenUser extends SessionUser {
-    tokens?: AccessToken;
-    profile?: Record<string, any>;
-    constructor(data?: Partial<AccessToken>);
-    load(data: Record<string, any>): this;
-    toJSON(): Record<string, any>;
-    loadJSON(data: Record<string, any>): this;
-}

package/dist/stores/FormDataStore.d.ts

@@ -1,31 +0,0 @@
-/**
- * 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;
-}>;