ch3chi-commons-vue 0.1.11 → 0.1.12

package/dist/api/ApiService.d.ts

@@ -0,0 +1,126 @@
+import { AxiosProgressEvent, RawAxiosResponseHeaders } from 'axios';
+/**
+ * ApiEndpoint 定義 API 端點的結構
+ */
+export interface ApiEndpoint {
+    path: string;
+    method: string;
+    isAuthenticated?: boolean;
+    errorMessageMap?: Record<number, string>;
+    noSpinner?: boolean;
+    headers?: Record<string, string>;
+}
+/**
+ * ApiRequest 定義 API 請求的結構
+ */
+export declare class ApiRequest {
+    endpointKey: string;
+    headers?: Record<string, string>;
+    pathParam?: Record<string, any>;
+    queryParam?: Record<string, any>;
+    postBody?: Record<string, any> | FormData;
+    isDownloadMode?: boolean;
+    downloadFileName?: string;
+    onUploadProgress?: (progressEvent: AxiosProgressEvent) => void;
+    constructor(data: ApiRequest);
+}
+/**
+ * ApiResponse 定義 API 回應的結構
+ */
+export declare class ApiResponse {
+    httpStatus: number;
+    code: number;
+    message?: string;
+    data?: any;
+    nativeError?: any;
+    paging?: Record<string, any>;
+    blobData?: Blob;
+    headers?: RawAxiosResponseHeaders;
+    constructor(data?: Partial<ApiResponse>);
+    isOk(): boolean;
+}
+/**
+ * ApiRejectError 定義 API 呼叫失敗時的自訂錯誤
+ * 此物件給 ApiService.call 呼叫後，並且回傳 Promise.reject() 使用
+ */
+export declare class ApiRejectError extends Error {
+    response: ApiResponse;
+    type?: string;
+    constructor(response: ApiResponse);
+    notFound(): this;
+}
+/**
+ * ApiService 提供呼叫後端 API 的功能
+ */
+export declare class ApiService {
+    private static _apiEndpoints;
+    private static _customHeaders;
+    private static _customErrorMessageMap;
+    constructor();
+    /**
+     * 靜態方法，配置 ApiService
+     * 為方便管理，建議在專案啟動時呼叫此方法註冊所有端點
+     * 可以配置
+     * - endpoints: 預設註冊的 API 端點
+     * - customHeaders: 全域自訂標頭
+     * - customErrorMessageMap: 全域自訂錯誤訊息對應
+     * @param config
+     */
+    static configure(config: {
+        endpoints: Record<string, ApiEndpoint>;
+        customHeaders?: Record<string, string>;
+        customErrorMessageMap?: Record<number, string>;
+    }): void;
+    /**
+     * 靜態方法，新增單一 API 端點
+     * @param key
+     * @param endpoint
+     */
+    static addEndpoints(key: string, endpoint: ApiEndpoint): void;
+    /**
+     * 靜態方法，方便直接呼叫 API
+     * @param request
+     */
+    static call(request: ApiRequest): Promise<ApiResponse>;
+    /**
+     * 靜態方法，方便直接下載檔案
+     * @param request
+     */
+    static download(request: ApiRequest): Promise<void>;
+    /**
+     * 取得指定的 API 端點資訊
+     * @param endpointKey
+     */
+    getEndpoint(endpointKey: string): ApiEndpoint | undefined;
+    /**
+     * 取得完整的 API URL
+     * @param endpointKey
+     */
+    getFullUrl(endpointKey: string): string | undefined;
+    /**
+     * 組合完整的 API URL
+     * @param endpoint
+     */
+    makeBaseUrl(endpoint: ApiEndpoint): string | undefined;
+    /**
+     * 呼叫 API
+     * @param request
+     */
+    callApi(request: ApiRequest): Promise<ApiResponse>;
+    /**
+     * 下載檔案
+     * @param request
+     */
+    downloadFile(request: ApiRequest): Promise<void>;
+    /**
+     * 決定下載檔案名稱
+     * @param request
+     * @param response
+     */
+    resolveExportFileName(request: ApiRequest, response: ApiResponse): string;
+    /**
+     * 解碼 RFC 2047 編碼的字串
+     * @param str RFC 2047 編碼的字串
+     */
+    decodeRfc2047(str: string): string;
+}

package/dist/auth/AuthorizationService.d.ts

@@ -0,0 +1,57 @@
+import { CMenuItem, MenuItem } from '../model/CMenuItem';
+/**
+ * 提供選單項目的參數介面
+ */
+type ProvideMenuByPermissionParams = {
+    roleCode: string;
+    permissions: string[];
+    picker?: (roleCode: string) => MenuItem[];
+};
+/**
+ * AuthorizationService 類別負責處理權限相關的邏輯
+ */
+export declare class AuthorizationService {
+    /**
+     * 角色權限映射表
+     * 定義角色對應多個權限項目
+     * @private
+     */
+    private static _rolePermissionMap;
+    /**
+     * 選單定義映射表
+     * 定義不同角色對應的選單結構
+     * @private
+     */
+    private static _menuDefineMap;
+    /**
+     * 設定角色權限映射
+     * @param map 角色權限映射物件
+     */
+    static set rolePermissionMap(map: Record<string, string[]>);
+    /**
+     * 設定選單定義映射
+     * @param map
+     */
+    static set menuDefineMap(map: Record<string, MenuItem[]>);
+    /**
+     * 配置角色與權限關係，以及選單定義映射
+     * @param config 配置物件
+     */
+    static configure(config: {
+        rolePermissionMap?: Record<string, string[]>;
+        menuDefineMap: Record<string, MenuItem[]>;
+    }): void;
+    /**
+     * 檢查角色列表是否包含所需的權限
+     * @param roleCodes
+     * @param requiredPermission
+     */
+    static hasPermissionByRole(roleCodes: string[], requiredPermission: string): boolean;
+    /**
+     * 根據角色列表提供選單項目
+     * @param roleCode 角色代碼
+     * @param permissions 權限列表
+     */
+    static provideMenuByPermission(param: ProvideMenuByPermissionParams): CMenuItem[];
+}
+export {};

package/dist/components/CAlert.vue.d.ts

@@ -0,0 +1,17 @@
+import { CAlertModalData } from './CAlertDefine';
+type __VLS_Props = {
+    id?: string;
+};
+declare function show(data?: CAlertModalData): void;
+declare function hide(): void;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    show: typeof show;
+    hide: typeof hide;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "c.modal.ok": (...args: any[]) => void;
+    "c.modal.cancel": (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onC.modal.ok"?: ((...args: any[]) => any) | undefined;
+    "onC.modal.cancel"?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/CAlertDefine.d.ts

@@ -0,0 +1,12 @@
+export interface CAlertModalData {
+    title?: string;
+    content?: string;
+    onCancel?: () => void;
+    onOk?: () => void;
+}
+export declare enum CAlertModalType {
+    Error = "error",// 警告類型
+    Alert = "alert",// 警告類型
+    Confirm = "confirm",// 確認類型
+    Info = "info"
+}

package/dist/components/CBSToast.vue.d.ts

@@ -0,0 +1,6 @@
+import { CAlertModalData } from '../components/CAlertDefine';
+declare function addToast(data: CAlertModalData): void;
+declare const _default: import('vue').DefineComponent<{}, {
+    addToast: typeof addToast;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, true, {}, any>;
+export default _default;

package/dist/components/CGlobalSpinner.vue.d.ts

@@ -0,0 +1,10 @@
+type __VLS_Props = {
+    show?: boolean;
+};
+declare function showSpinner(): void;
+declare function hide(): void;
+declare const _default: import('vue').DefineComponent<__VLS_Props, {
+    show: typeof showSpinner;
+    hide: typeof hide;
+}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/CRowCheckBox.vue.d.ts

@@ -0,0 +1,14 @@
+import { ComputedRef } from 'vue';
+type __VLS_Props = {
+    align?: 'left' | 'center' | 'right';
+    rowData: Record<string, any>;
+    cancelable?: boolean;
+    disableComputed?: ComputedRef<boolean>;
+    readMode?: boolean;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:checked": (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:checked"?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/CRowTextInput.vue.d.ts

@@ -0,0 +1,10 @@
+type __VLS_Props = {
+    rowData: Record<string, any>;
+    dataName: string;
+};
+declare const _default: import('vue').DefineComponent<__VLS_Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {
+    "update:textInput": (...args: any[]) => void;
+}, string, import('vue').PublicProps, Readonly<__VLS_Props> & Readonly<{
+    "onUpdate:textInput"?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLInputElement>;
+export default _default;

package/dist/components/CTableDefine.d.ts

@@ -0,0 +1,125 @@
+import { VNode } from 'vue';
+/**
+ * CTableColumnType 定義了表格欄位的類型
+ * - RowNumber: 行號類型
+ * - Text: 文字類型
+ * - Date: 日期類型
+ * - DateTime: 日期時間類型
+ * - Action: 操作類型
+ */
+export declare enum CTableColumnType {
+    RowNumber = "rowNumber",// 行號類型
+    Text = "text",// 文字類型
+    TextInput = "textInput",// 文字輸入類型(可手動切換?)
+    Date = "date",// 日期類型
+    DateRange = "dateRange",// 日期範圍類型
+    DateTime = "datetime",// 日期時間類型
+    Action = "action",// 操作類型
+    Checkbox = "checkbox"
+}
+/**
+ * CTableColumnActionType 定義了表格欄位的操作類型
+ */
+export declare enum CTableColumnActionType {
+    Edit = "edit",// 編輯操作
+    Delete = "delete",// 刪除操作
+    Review = "review",// 審核操作
+    Vote = "vote",// 投票操作
+    Check = "check"
+}
+/**
+ * CTableColumnActionParam 定義了表格欄位操作的參數
+ */
+export interface CTableColumnActionParam {
+    actionType: CTableColumnActionType;
+    rowData: Record<string, any>;
+    event?: Event;
+}
+export interface CTableColumnActionMeta {
+    actionType: CTableColumnActionType;
+    text?: string;
+    cls?: string;
+    icon?: string;
+    onClick?: (p: CTableColumnActionParam) => void;
+    emit?: (event: string, ...args: any[]) => void;
+}
+/**
+ * CTableColumnDefine 定義了表格欄位的屬性和行為
+ */
+export interface CTableColumnDefine {
+    id?: string;
+    type: CTableColumnType;
+    idName?: string;
+    dataName?: string;
+    dataNameList?: string[];
+    text: string;
+    defaultText?: string;
+    width?: string;
+    align?: 'left' | 'center' | 'right';
+    dataAlign?: 'left' | 'center' | 'right';
+    formatPattern?: string;
+    actionList?: CTableColumnActionMeta[];
+    customRender?: (rowData: Record<string, any>) => string | HTMLElement | VNode;
+    useHtml?: boolean;
+    useVNode?: boolean;
+    vNodeAttrs?: Record<string, any>;
+}
+/**
+ * CTableColumn 類別定義了表格欄位的屬性和行為
+ */
+export declare class CTableColumn implements CTableColumnDefine {
+    id?: string;
+    type: CTableColumnType;
+    idName?: string;
+    dataName?: string;
+    dataNameList?: string[];
+    text: string;
+    defaultText?: string;
+    width?: string;
+    align?: 'left' | 'center' | 'right';
+    dataAlign?: 'left' | 'center' | 'right';
+    formatPattern?: string;
+    actionList?: CTableColumnActionMeta[];
+    defaultRender?: (rowData: Record<string, any>) => string | HTMLElement | VNode;
+    customRender?: (rowData: Record<string, any>) => string | HTMLElement | VNode;
+    useHtml: boolean;
+    useVNode: boolean;
+    vNodeAttrs?: Record<string, any>;
+    constructor(define: CTableColumnDefine);
+    static defaultIconMap: Record<CTableColumnActionType, string>;
+    static defaultBtnClassMap: Record<CTableColumnActionType, string>;
+    static configure(config: {
+        iconMap?: Partial<Record<CTableColumnActionType, string>>;
+        btnClassMap?: Partial<Record<CTableColumnActionType, string>>;
+    }): void;
+    /**
+     * 渲染欄位內容
+     * @param rowData 當前行的數據
+     */
+    render(rowData: Record<string, any>): string | HTMLElement | VNode;
+    /**
+     * 生成 th 的 class 名稱
+     */
+    thClass(): string;
+    /**
+     * 生成 td 的 class 名稱
+     */
+    tdClass(): string;
+    /**
+     * 處理欄位操作
+     * @private
+     */
+    private handleAction;
+    /**
+     * 生成默認渲染函數
+     * @private
+     */
+    private makeDefaultRender;
+    /**
+     * 根據操作類型生成按鈕的樣式和文字
+     * @param actionType 操作類型
+     * @returns {cls: string, text: string} 按鈕的樣式和文字
+     * @private
+     */
+    private buildActionButtonMeta;
+}

package/dist/directive/CDateFormatterDirective.d.ts

@@ -2,5 +2,9 @@ import { Directive } from 'vue';
 /**
  * v-date-formatter 指令
  * 解析 ref<Date> 並格式化為文字，根據元素型態輸出
+ * 可以透過 attribute data-date-format 指定日期格式，預設為 'YYYY-MM-DD'
+ * 使用方式：
+ * <input type="text" v-date-formatter="dateRef" data-date-format="YYYY/MM/DD" />
+ * <span v-date-formatter="dateRef" data-date-format="DD-MM-YYYY"></span>
  */
 export declare const vdDateFormatter: Directive;

package/dist/directive/CFTurnstileDirective.d.ts

@@ -1,2 +1,9 @@
 import { Directive } from 'vue';
+/**
+ * v-cf-turnstile 指令
+ * 用於在表單中嵌入 Cloudflare Turnstile 驗證碼
+ * 使用方式：
+ * <div v-cf-turnstile="fieldContext"></div>
+ * 其中 fieldContext 為 vee-validate 的 FieldContext，用於接收驗證碼 token
+ */
 export declare const CFTurnstileDirective: Directive;