ch3chi-commons-vue 0.1.14 → 1.2.0

package/dist/model/BSFieldStyleConfig.d.ts

@@ -0,0 +1,121 @@
+/**
+ * BSFieldStyleConfig 配置物件
+ * 用於以配置方式自訂欄位外觀和行為
+ */
+export interface IBSFieldStyleConfig {
+    containerClass?: string;
+    labelClass?: string;
+    labelPrefix?: string;
+    labelSuffix?: string;
+    hideLabel?: boolean;
+    requiredLabelClass?: string;
+    requiredLabelText?: string;
+    plainTextClass?: string;
+    inputClass?: string;
+    inputPrefix?: {
+        text?: string;
+        class?: string;
+    };
+    inputSuffix?: {
+        text?: string;
+        class?: string;
+    };
+    wrapperClass?: string;
+    selectClass?: string;
+    selectSize?: 'sm' | 'lg';
+    selectMultiple?: boolean;
+    selectPlaceholder?: string;
+    textareaClass?: string;
+    textareaRows?: number;
+    textareaResize?: 'none' | 'both' | 'horizontal' | 'vertical';
+    textareaAutoGrow?: boolean;
+    checkboxClass?: string;
+    checkboxLabelClass?: string;
+    checkboxWrapperClass?: string;
+    radioClass?: string;
+    radioLabelClass?: string;
+    radioWrapperClass?: string;
+    radioInline?: boolean;
+    fileClass?: string;
+    fileAccept?: string;
+    fileMultiple?: boolean;
+    fileDragDrop?: boolean;
+    calendarIconClass?: string;
+    calendarClearIconClass?: string;
+    changePasswordButtonClass?: string;
+    changePasswordButtonIcon?: string;
+    errorClass?: string;
+    errorPrefix?: string;
+}
+/**
+ * BSFieldStyleConfig 類別
+ */
+export declare class BSFieldStyleConfig {
+    config: IBSFieldStyleConfig;
+    /**
+     * 單一實例
+     */
+    static instance: BSFieldStyleConfig;
+    /**
+     * 合併配置
+     * @param config 要合併到全域實例的配置
+     */
+    static merge(config: IBSFieldStyleConfig): void;
+    /**
+     * 混合多個樣式配置，建立新的 BSFieldStyleConfig 實例
+     * 優先順序：propStyle > defaultStyle > instance（全域設定）
+     *
+     * @param defaultStyle 預設樣式配置（例如組件內建的預設值）
+     * @param propStyle 組件 prop 傳入的樣式配置
+     * @returns 合併後的 BSFieldStyleConfig 實例
+     *
+     * @example
+     * ```typescript
+     * // 在組件中使用
+     * const bStyleConfig = BSFieldStyleConfig.mix(
+     *   { plainTextClass: 'form-control-plaintext bg-light' }, // 組件預設值
+     *   props.styleConfig // 從 prop 傳入的值
+     * );
+     * ```
+     */
+    static mix(defaultStyle: IBSFieldStyleConfig, propStyle?: IBSFieldStyleConfig): BSFieldStyleConfig;
+    constructor(config?: IBSFieldStyleConfig);
+    get containerClass(): string;
+    get labelClass(): string;
+    get inputClass(): string;
+    get wrapperClass(): string;
+    get errorClass(): string;
+    get hideLabel(): boolean;
+    get requiredLabelClass(): string;
+    get requiredLabelText(): string;
+    get plainTextClass(): string;
+    get hasInputPrefix(): boolean;
+    get hasInputSuffix(): boolean;
+    get inputPrefixText(): string;
+    get inputSuffixText(): string;
+    get inputPrefixClass(): string;
+    get inputSuffixClass(): string;
+    get selectClass(): string;
+    get selectMultiple(): boolean;
+    get selectPlaceholder(): string;
+    get textareaClass(): string;
+    get textareaRows(): number;
+    get textareaResizeStyle(): string;
+    get textareaAutoGrow(): boolean;
+    get checkboxClass(): string;
+    get checkboxLabelClass(): string;
+    get checkboxWrapperClass(): string;
+    get radioClass(): string;
+    get radioLabelClass(): string;
+    get radioWrapperClass(): string;
+    get radioInline(): boolean;
+    get fileClass(): string;
+    get fileAccept(): string;
+    get fileMultiple(): boolean;
+    get fileDragDrop(): boolean;
+    get calendarIconClass(): string;
+    get calendarClearIconClass(): string;
+    get changePasswordButtonClass(): string;
+    get changePasswordButtonIcon(): string;
+}
+export declare const __BSFieldStyleConfigDefine__: IBSFieldStyleConfig;

package/dist/model/BaseDictionary.d.ts

@@ -0,0 +1,34 @@
+/**
+ * BaseDictionary class
+ * 用於 distionary store 的基底類別
+ */
+export declare abstract class BaseDictionary {
+    protected data: Record<string, any>;
+    dataProvider: (key: string) => Promise<any> | any;
+    lastUpdatedAt: number;
+    protected constructor(data?: Partial<BaseDictionary>);
+    /**
+     * 初始化方法，讓子類別可以覆寫以進行自訂初始化
+     * @protected
+     */
+    abstract init(): void;
+    val(key: string): any;
+    setVal(key: string, value: any): void;
+    hasVal(key: string): boolean;
+    /**
+     * 載入所有字典資料
+     * 使用 Promise.allSettled 確保即使某個載入失敗，其他的也能繼續執行
+     */
+    loadAll(): Promise<void>;
+    /**
+     * load dictionary data
+     * 支援 Promise 或是直接回傳資料物件
+     * @param key
+     */
+    loadDictionary(key: string): Promise<Record<string, any>>;
+    loadFromStore(storeData: Record<string, any>): this;
+}
+export declare class CBaseDictionary extends BaseDictionary {
+    constructor(data?: Partial<CBaseDictionary>);
+    init(): void;
+}

package/dist/model/BaseFormDataModel.d.ts

@@ -7,8 +7,10 @@ import * as yup from "yup";
  * 子類別需要實現 initFormSchema 方法來定義具體的表單驗證邏輯。
  */
 export declare abstract class BaseFormDataModel {
+    _debug?: boolean;
     uid?: string;
     rowId?: string;
+    _formMode?: string;
     __rowNumber?: number;
     __isLastAndLastPage?: boolean;
     /**
@@ -152,6 +154,8 @@ export declare abstract class BaseFormDataModel {
      * @param propertyName 屬性名稱列表
      */
     parseStringToDate(data: Record<string, any>, propertyName: string[]): void;
+    set formMode(type: string);
+    get formMode(): string | undefined;
     /**
      * 將指定的屬性列表轉換為 JSON 格式的數據。
      * @param propertyList

package/dist/model/BaseListViewModel.d.ts

@@ -2,10 +2,12 @@ import { QueryPage, QueryParameter } from './QueryParameter';
 import { BaseFormDataModel } from './BaseFormDataModel';
 import { CTableColumn, CTableColumnActionType } from '../components/CTableDefine';
 import { Router } from 'vue-router';
+import { GlobalViewActions } from '../stores/ViewStore';
 import { ApiResponse } from '../api/ApiService';
 export interface ListApiEndpointMeta {
     key: string;
     pathParam?: Record<string, any>;
+    dataListFinder?: (response: ApiResponse) => any[];
     dataParser: (dataItem: any) => any;
 }
 /**
@@ -16,11 +18,20 @@ export declare abstract class BaseListViewModel<Q extends QueryParameter, V exte
     dataList: V[];
     tableColumnArray: CTableColumn[];
     router?: Router;
+    storeAction?: GlobalViewActions;
     enableQueryParamDefault?: boolean;
     queryParamDefaultValues?: Record<string, any>;
     saveOnQueryFormDataStore?: boolean;
     autoSearchOnClear?: boolean;
     protected constructor(data?: Partial<BaseListViewModel<Q, V>>);
+    /**
+     * 初始化方法
+     * @param options
+     */
+    init(options: {
+        router: Router;
+        storeAction?: GlobalViewActions;
+    }): this;
     /**
      * 查詢列表的 API 端點元資料
      */
@@ -58,6 +69,7 @@ export declare abstract class BaseListViewModel<Q extends QueryParameter, V exte
      * @param options 載入選項
      */
     loadApiResponse(response: ApiResponse, options: {
+        dataListFinder?: (response: ApiResponse) => any[];
         parser?: (data: any) => V;
     }): void;
     /**
@@ -100,6 +112,10 @@ export declare abstract class BaseListViewModel<Q extends QueryParameter, V exte
      * 從查詢表單數據存儲中讀取查詢參數
      */
     readQueryParamFromStore(): void;
+    /**
+     * 前往新增頁面
+     */
+    goToCreatePage(): void;
     /**
      * 執行搜尋操作
      * 查詢時會將查詢參數保存到 store 中，並呼叫 API 獲取資料
@@ -110,6 +126,10 @@ export declare abstract class BaseListViewModel<Q extends QueryParameter, V exte
      * 清除查詢參數，並根據設定決定是否重新執行搜尋
      */
     doClear(): Promise<void>;
+    /**
+     * 處理排序變更事件
+     */
+    onSortChange(): Promise<void>;
     /**
      * 處理分頁變更事件
      * @param params
@@ -142,3 +162,4 @@ export declare abstract class CheckableListViewModel<Q extends QueryParameter, V
      */
     resetCheckedData(): void;
 }
+export declare const __BaseListViewModelDefine__: ListApiEndpointMeta;

package/dist/model/CMenuItem.d.ts

@@ -1,4 +1,5 @@
 import { Ref } from 'vue';
+import { PermissionDescriptor } from '../auth/PermissionDescriptor';
 /**
  * MenuItem 介面用於描述左側選單項目結構
  * name: 顯示名稱
@@ -29,6 +30,7 @@ export declare class CMenuItem implements MenuItem {
     path?: string;
     needRoles?: string[];
     permission?: string | string[];
+    permissionDescriptors?: PermissionDescriptor[];
     activePaths?: string[];
     children?: CMenuItem[];
     isOpen?: Ref<boolean>;

package/dist/model/FormOptions.d.ts

@@ -11,6 +11,7 @@ export interface COptionItem {
     disabled?: boolean;
     selected?: boolean;
     children?: CCOptionItem[];
+    meta?: Record<string, any>;
 }
 /**
  * COptionItem 類別實現
@@ -22,6 +23,7 @@ export declare class CCOptionItem implements COptionItem {
     disabled?: boolean;
     selected?: boolean;
     children?: CCOptionItem[];
+    meta?: Record<string, any>;
     constructor(data?: Partial<COptionItem>);
 }
 /**
@@ -37,11 +39,13 @@ export declare class DataCategory {
  */
 export declare const ToggleStatusOptions: COptionItem[];
 /**
- * 通用選項，適用
- * 1. 帳號狀態選項
- * 2. 最新消息狀態選項
+ * 通用選項，適用當 value 為 boolean 時
  */
 export declare const CommonStatusOptions: COptionItem[];
+/**
+ * 通用選項，適用當 value 為字串時
+ */
+export declare const CommonStatusStrOptions: COptionItem[];
 /**
  * 是/否 選項
  */
@@ -53,3 +57,4 @@ export declare const OptionUtils: {
      */
     makeCommonStatusLabelText: (value: string | boolean) => string;
 };
+export declare const __FormOptionsTypes__: COptionItem & DataCategory;

package/dist/model/LoginDataModel.d.ts

@@ -4,6 +4,7 @@ export declare class LoginDataModel extends BaseFormDataModel {
     account?: string;
     password?: string;
     turnstileToken?: string;
+    enableCFTurnstile: boolean;
     constructor(data?: Partial<LoginDataModel>);
     dataFieldNameList(): string[];
     initFormSchema(): ObjectSchema<any>;

package/dist/model/QueryParameter.d.ts

@@ -1,15 +1,12 @@
 import { ApiResponse } from '../api/ApiService';
+export type SortDirection = 'ASC' | 'asc' | 'DESC' | 'desc';
 /**
  * QuerySort 定義了查詢的排序條件
  */
 export interface QuerySort {
     field: string;
-    direction: 'asc' | 'desc';
+    direction: SortDirection;
 }
-/**
- * PageSizeOptions 定義了可用的分頁大小選項
- */
-export declare const PageSizeOptions: number[];
 /**
  * IQueryPage 定義了查詢的分頁資訊
  */
@@ -92,3 +89,4 @@ export declare class DateRangeParam extends QueryParameter {
     endsAt?: Date | null;
     clear(): void;
 }
+export declare const __QueryParameterDefine__: SortDirection;

package/dist/model/SessionUser.d.ts

@@ -1,9 +1,17 @@
+/**
+ * Role model
+ */
+export declare class Role {
+    uid?: string;
+    name?: string;
+    type?: string;
+}
 /**
  * 用來描述操作人員的物件
  * 用來保存已登入的使用者資訊
  */
 export declare class SessionUser {
-    sub?: string;
+    userUid?: string;
     iat?: number;
     account?: string;
     name?: string;
@@ -16,7 +24,12 @@ export declare class SessionUser {
      * 載入資料
      * @param data
      */
-    load(data: Record<string, any>): SessionUser;
+    load(data: Record<string, any>): this;
+    /**
+     * 從驗證會話資料載入
+     * @param data
+     */
+    loadFromValidateSession(data: any): this;
     /**
      * 合併資料
      * @param data
@@ -27,4 +40,6 @@ export declare class 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

@@ -0,0 +1,44 @@
+/**
+ * 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

@@ -0,0 +1,50 @@
+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;
+}