@uozi-admin/curd/dist/types/config.d.ts

Easy to implement curd.

import { I18nOptions } from 'vue-i18n';
/**
 * The pagination map
 * @description The map of the pagination data
 */
export interface PaginationMap {
    params: {
        current: string;
        pageSize: string;
    };
    response: {
        total: string;
        current: string;
        pageSize: string;
        totalPages: string;
    };
}
/**
 * The pagination data
 * @description The data of the pagination
 */
export interface PaginationData {
    total: number;
    current: number;
    pageSize: number;
    totalPages: number;
}
/**
 * The response data
 * @description The data of the response
 */
export interface ResponseData {
    data: any[];
    pagination: PaginationData;
}
/**
 * The response format function
 * @description The function is used to format the response data
 */
export interface ResponseFormatFn {
    (response: any): ResponseData;
}
/**
 * The request format function
 * @description The function is used to format the request parameters
 */
export interface RequestFormatFn {
    (params: Record<string, any>): Record<string, any>;
}
/**
 * The i18n language
 * @description The Languages built-in in the curd
 */
export type I18nLanguage = 'zh-CN' | 'zh-HK' | 'zh-TW' | 'en-US';
/**
 * The time config
 * @description The config for the time
 */
export interface TimeConfig {
    timestamp?: boolean;
}
/**
 * The i18n token
 * @description The token used in the curd i18n
 */
export type I18nToken = 'total' | 'list' | 'item(s)' | 'view' | 'edit' | 'delete' | 'restore' | 'deletePermanently' | 'reset' | 'close' | 'ok' | 'selectorTitle' | 'generate' | 'save' | 'add' | 'trash' | 'backToList' | 'exportExcel' | 'formValidateError' | 'deleteConfirm' | 'restoreConfirm' | 'deletePermanentlyConfirm' | 'savedSuccessfully' | 'deletedSuccessfully' | 'restoredSuccessfully' | 'selectAll' | 'batchEdit' | 'pleaseSelectAtLeastOneItem' | 'batchModify' | 'saveSuccessfully' | 'belowsAreSelectedItems' | 'leaveBlankIfDoNotWantToModify' | 'no' | 'upload' | 'This field should not be empty' | 'This field should be a valid email address' | 'This value is already taken' | 'This field should be a valid hostname' | 'This field should only contain letters, unicode characters, numbers, and -_.';
export type I18nLanguageObject = Partial<Record<I18nToken, any>>;
export interface CurdConfigT {
    listApi?: {
        /**
         * The path to the pagination data in the response
         * @default '$.pagination'
         * @description `$.` is the root of the response data
         * @example
         * ```json
         * {
         *  paginationPath: '$.pagination',
         * }
         * ```
         */
        paginationPath?: string;
        /**
         * The mapping of the pagination data in the response
         * @default {
         *  total: 'total',
         *  current: 'current',
         *  pageSize: 'pageSize',
         *  totalPages: 'totalPages',
         * }
         */
        paginationMap?: PaginationMap;
        /**
         * The response format function
         * @description The function is used to format the response data
         * @example
         * ```ts
         * const responseFormat = (response: any) => {
         *  return {
         *    data: response.data,
         *    pagination: response.pagination,
         *  }
         * }
         */
        responseFormat?: ResponseFormatFn;
        /**
         * The request format function
         * @description The function is used to format the request parameters
         * @example
         * ```ts
         * const requestFormat = (params: Record<string, any>) => {
         *  return {
         *    ...params,
         *  }
         * }
         */
        requestFormat?: RequestFormatFn;
    };
    /**
     * The i18n options
     * @description The options for the i18n same as the vue-i18n options
     * @example
     * ```ts
     * const i18nOptions = {
     *  locale: 'zh-CN',
     *  fallbackLocale: 'en-US',
     *  messages: {
     *    'zh-CN': {
     *      ...I18nLanguageObject,
     *    },
     *    'zh-HK': {
     *      ...I18nLanguageObject,
     *    },
     *    'zh-TW': {
     *      ...I18nLanguageObject,
     *    },
     *  },
     * }
     */
    i18n?: I18nOptions<{
        message: I18nLanguageObject;
    }>;
    /**
     * The time config
     * @description The config for the time
     */
    time?: TimeConfig;
    /**
     * The selector config
     * @description The config for the selector
     */
    selector?: {
        /**
         * The omit zero string
         * @description The flag to omit the zero string
         */
        omitZeroString?: boolean;
    };
    /**
     * The search config
     * @description The config for the search
     */
    search?: {
        /**
         * The show search btn
         * @description The flag to show the search btn
         */
        showSearchBtn?: boolean;
        /**
         * The hide reset btn
         */
        hideResetBtn?: boolean;
    };
}