@hbdlzy/ui-core 0.1.6 → 0.1.8

package/src/components/BaseEChart/BaseEChart.vue.d.ts

@@ -0,0 +1,66 @@
+import { echarts } from '../../echarts';
+import type { BaseEChartProps } from './BaseEChart.types';
+declare const _default: import("vue").DefineComponent<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BaseEChartProps>, {
+    option: () => {};
+    initOptions: () => echarts.EChartsInitOpts;
+    setOptionOptions: () => echarts.SetOptionOpts;
+    loading: boolean;
+    autoResize: boolean;
+    useDefaultColors: boolean;
+    colorStorageKey: string;
+    defaultColors: () => never[];
+    group: undefined;
+}>>, {
+    getInstance: () => echarts.ECharts | null;
+    setOption: (option: echarts.EChartsOption, setOptionOptions?: boolean | echarts.SetOptionOpts | undefined) => echarts.ECharts | null;
+    resize: (resizeOptions?: echarts.ResizeOpts | undefined) => void;
+    dispatchAction: (payload: Record<string, unknown>) => void;
+    showLoading: (type?: string | undefined, loadingOptions?: object | undefined) => void;
+    hideLoading: () => void;
+    clear: () => void;
+    dispose: () => void;
+    on: (eventName: string, handler: (...args: any[]) => void, context?: unknown) => void;
+    off: (eventName?: string | undefined, handler?: ((...args: any[]) => void) | undefined) => void;
+}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    ready: (chart: echarts.ECharts) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_WithDefaults<__VLS_TypePropsToRuntimeProps<BaseEChartProps>, {
+    option: () => {};
+    initOptions: () => echarts.EChartsInitOpts;
+    setOptionOptions: () => echarts.SetOptionOpts;
+    loading: boolean;
+    autoResize: boolean;
+    useDefaultColors: boolean;
+    colorStorageKey: string;
+    defaultColors: () => never[];
+    group: undefined;
+}>>> & Readonly<{
+    onReady?: ((chart: echarts.ECharts) => any) | undefined;
+}>, {
+    option: echarts.EChartsOption;
+    loading: boolean;
+    initOptions: echarts.EChartsInitOpts;
+    setOptionOptions: boolean | echarts.SetOptionOpts;
+    autoResize: boolean;
+    useDefaultColors: boolean;
+    colorStorageKey: string;
+    defaultColors: string[];
+    group: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>;
+export default _default;
+type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
+type __VLS_TypePropsToRuntimeProps<T> = {
+    [K in keyof T]-?: {} extends Pick<T, K> ? {
+        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
+    } : {
+        type: import('vue').PropType<T[K]>;
+        required: true;
+    };
+};
+type __VLS_WithDefaults<P, D> = {
+    [K in keyof Pick<P, keyof P>]: K extends keyof D ? __VLS_Prettify<P[K] & {
+        default: D[K];
+    }> : P[K];
+};
+type __VLS_Prettify<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/src/components/BaseEChart/README.md

@@ -134,3 +134,36 @@ const gradient = new echarts.graphic.LinearGradient(0, 0, 0, 1, [
 - 页面层只维护 `option`，不要重复写 `echarts.init`
 - 默认走 `BaseEChart + option`，只有确实需要时再通过 `ref` 调暴露方法
 - 渐变色、图形工具优先从 `@hbdlzy/ui-core` 导出的 `echarts` 使用
+
+## AI 使用指引
+
+AI 在生成 ECharts 图表页面时，应优先使用 `BaseEChart`，不要在页面组件里重复写 `echarts.init`、`setOption`、`resize`、`dispose` 和窗口尺寸监听。
+
+推荐优先从统一入口导入：
+
+```ts
+import { BaseEChart, echarts, type EChartOption, type BaseEChartExpose } from '@hbdlzy/ui'
+```
+
+如果当前只安装了核心包，也可以从 `@hbdlzy/ui-core` 导入。
+
+AI 生成代码时按下面顺序判断：
+
+1. 父容器必须给出明确高度，再放入 `<BaseEChart :option="option" />`
+2. 图表配置统一维护在 `option` 或 `computed option` 中
+3. 需要渐变色、图形工具时，使用统一导出的 `echarts`
+4. 需要手动刷新、隐藏 tooltip、派发 action 时，再通过 `ref<BaseEChartExpose>` 调用暴露方法
+5. 后端数据变化时，只更新 `option` 数据，不重新初始化图表实例
+
+AI 不应该做这些事：
+
+- 不要在业务页面直接调用 `echarts.init(dom)`
+- 不要手动注册 `window.resize` 来处理普通图表自适应
+- 不要在页面卸载时重复写 `dispose`，组件已处理
+- 不要把接口请求逻辑放进 `BaseEChart`，页面层负责取数，图表组件只接收 `option`
+
+生成代码前建议同时读取：
+
+- `packages/ui-core/components.manifest.json`
+- `packages/ui-core/src/components/BaseEChart/BaseEChart.types.ts`
+- 本 README 的 `Props / Events / Expose` 部分

package/src/components/BaseEChart/index.d.ts

@@ -0,0 +1,3 @@
+import BaseEChart from './BaseEChart.vue';
+export default BaseEChart;
+export type { BaseEChartExpose, BaseEChartProps } from './BaseEChart.types';

package/src/components/BaseExportButton/BaseExportButton.types.d.ts

@@ -0,0 +1,21 @@
+import type { ExcelExportOptions } from '../../excel/exportExcel';
+export interface ExportResponseHeaders {
+    [key: string]: string | undefined;
+}
+export interface ExportResponseLike {
+    data: Blob | BlobPart | ArrayBuffer;
+    headers?: ExportResponseHeaders;
+}
+export type ExportRequestHandler = () => Promise<ExportResponseLike>;
+export type ExportMode = 'excel' | 'request' | 'none' | 'invalid';
+export type ExportBeforeHandler = () => boolean | void | Promise<boolean | void>;
+export interface ExportSuccessPayload {
+    mode: Exclude<ExportMode, 'none' | 'invalid'>;
+    fileName?: string;
+}
+export interface BaseExportExcelConfig<Row = Record<string, any>> {
+    excelOptions: ExcelExportOptions<Row>;
+}
+export interface BaseExportRequestConfig {
+    requestHandler: ExportRequestHandler;
+}

package/src/components/BaseExportButton/BaseExportButton.utils.d.ts

@@ -0,0 +1,4 @@
+import type { ExportResponseLike } from './BaseExportButton.types';
+export declare function extractFileNameFromDisposition(contentDisposition?: string): string;
+export declare function normalizeExportFileName(fileName?: string): string;
+export declare function downloadExportResponse(response: ExportResponseLike, fallbackFileName?: string): string;

package/src/components/BaseExportButton/BaseExportButton.vue.d.ts

@@ -0,0 +1,128 @@
+import type { PropType } from 'vue';
+import { type ExcelExportOptions } from '../../excel/exportExcel';
+import type { ExportBeforeHandler, ExportRequestHandler, ExportSuccessPayload } from './BaseExportButton.types';
+declare const _default: __VLS_WithTemplateSlots<import("vue").DefineComponent<import("vue").ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    type: {
+        type: PropType<"" | "success" | "warning" | "info" | "danger" | "primary">;
+        default: string;
+    };
+    size: {
+        type: PropType<"small" | "default" | "large">;
+        default: string;
+    };
+    plain: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    link: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    text: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fileName: {
+        type: StringConstructor;
+        default: string;
+    };
+    excelOptions: PropType<ExcelExportOptions<Record<string, any>>>;
+    requestHandler: PropType<ExportRequestHandler>;
+    beforeExport: PropType<ExportBeforeHandler>;
+    successMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    autoMessage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    start: () => void;
+    success: (payload: ExportSuccessPayload) => void;
+    error: (error: unknown) => void;
+}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    label: {
+        type: StringConstructor;
+        default: string;
+    };
+    type: {
+        type: PropType<"" | "success" | "warning" | "info" | "danger" | "primary">;
+        default: string;
+    };
+    size: {
+        type: PropType<"small" | "default" | "large">;
+        default: string;
+    };
+    plain: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    link: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    text: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    disabled: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    fileName: {
+        type: StringConstructor;
+        default: string;
+    };
+    excelOptions: PropType<ExcelExportOptions<Record<string, any>>>;
+    requestHandler: PropType<ExportRequestHandler>;
+    beforeExport: PropType<ExportBeforeHandler>;
+    successMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    errorMessage: {
+        type: StringConstructor;
+        default: string;
+    };
+    autoMessage: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & Readonly<{
+    onError?: ((error: unknown) => any) | undefined;
+    onSuccess?: ((payload: ExportSuccessPayload) => any) | undefined;
+    onStart?: (() => any) | undefined;
+}>, {
+    label: string;
+    link: boolean;
+    text: boolean;
+    type: "" | "success" | "warning" | "info" | "danger" | "primary";
+    disabled: boolean;
+    size: "small" | "default" | "large";
+    fileName: string;
+    plain: boolean;
+    successMessage: string;
+    errorMessage: string;
+    autoMessage: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, {
+    default?(_: {}): any;
+}>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/src/components/BaseExportButton/README.md

@@ -119,3 +119,37 @@ const requestHandler = async () => {
 ## 相关能力
 
 - 工具函数：`@hbdlzy/ui-core` 中的 `exportExcel`
+
+## AI 使用指引
+
+AI 在生成导出入口时，应优先使用 `BaseExportButton` 或 `exportExcel`，不要在每个页面重复写导出按钮 loading、二进制下载、成功失败提示和前端 Excel 生成逻辑。
+
+推荐优先从统一入口导入：
+
+```ts
+import { BaseExportButton, type ExcelExportOptions } from '@hbdlzy/ui'
+```
+
+如果当前只安装了核心包，也可以从 `@hbdlzy/ui-core` 导入。
+
+AI 生成代码时按下面顺序判断：
+
+1. 前端已有完整表格数据时，优先使用 `excelOptions`
+2. 后端返回文件流时，优先使用 `requestHandler + fileName`
+3. 导出前需要校验筛选条件时，使用 `beforeExport`
+4. 页面需要感知结果时，监听 `start`、`success`、`error`
+5. 只需要工具函数而不是按钮时，直接使用 `exportExcel`
+
+AI 不应该做这些事：
+
+- 不要同时传 `excelOptions` 和 `requestHandler`
+- 不要在页面里重复写 `Blob`、`URL.createObjectURL`、临时 `a` 标签下载逻辑
+- 不要在多个页面复制同一套导出 loading 和消息提示
+- 不要把业务查询流程塞进组件，查询参数应由页面层准备好后再触发导出
+
+生成代码前建议同时读取：
+
+- `packages/ui-core/components.manifest.json`
+- `packages/ui-core/src/components/BaseExportButton/BaseExportButton.types.ts`
+- `packages/ui-core/src/excel/exportExcel.ts`
+- 本 README 的 `Props / Events / 约束` 部分

package/src/components/BaseExportButton/index.d.ts

@@ -0,0 +1,5 @@
+import BaseExportButton from './BaseExportButton.vue';
+export { BaseExportButton };
+export { downloadExportResponse, extractFileNameFromDisposition, normalizeExportFileName } from './BaseExportButton.utils';
+export type { BaseExportExcelConfig, BaseExportRequestConfig, ExportBeforeHandler, ExportMode, ExportRequestHandler, ExportResponseHeaders, ExportResponseLike, ExportSuccessPayload } from './BaseExportButton.types';
+export default BaseExportButton;

package/src/components/BaseTable/BaseTable.types.d.ts

@@ -0,0 +1,178 @@
+export type BaseTableCssValue = string | number;
+export type BaseTableAlign = 'left' | 'center' | 'right';
+export type BaseTableColumnKind = 'text' | 'link' | 'actions' | 'image' | 'tag' | 'html' | 'input';
+export type BaseTableSortOrder = 'ascending' | 'descending' | null;
+export type BaseTableSortDirection = string | null;
+export type BaseTableHeaderSearchType = 'input' | 'select' | 'cascader';
+export type BaseTableHeaderSearchPrimitiveValue = string | number | boolean;
+export type BaseTableHeaderSearchPathValue = BaseTableHeaderSearchPrimitiveValue[];
+export type BaseTableHeaderSearchValue = BaseTableHeaderSearchPrimitiveValue | BaseTableHeaderSearchPrimitiveValue[];
+export interface BaseTableHeaderSearchConfig {
+    type?: BaseTableHeaderSearchType;
+    paramKey?: string;
+    placeholder?: string;
+    width?: BaseTableCssValue;
+    searchText?: string;
+    resetText?: string;
+    options?: BaseTableOption[];
+    multiple?: boolean;
+    clearable?: boolean;
+    filterable?: boolean;
+    optionValueKey?: string;
+    optionLabelKey?: string;
+    optionDisabledKey?: string;
+    optionChildrenKey?: string;
+}
+export interface BaseTableOption {
+    label: string;
+    value: string | number | boolean;
+    tagType?: '' | 'success' | 'warning' | 'info' | 'danger' | 'primary';
+    color?: string;
+    disabled?: boolean;
+    children?: BaseTableOption[];
+}
+export interface BaseTableAction<Row = Record<string, any>> {
+    label: string;
+    type: string;
+    buttonType?: '' | 'primary' | 'success' | 'warning' | 'info' | 'danger';
+    disabled?: boolean | ((row: Row) => boolean);
+    visible?: boolean | ((row: Row) => boolean);
+}
+export interface BaseTableColumn<Row = Record<string, any>> {
+    label: string;
+    prop?: keyof Row | string;
+    kind?: BaseTableColumnKind;
+    type?: string;
+    width?: BaseTableCssValue;
+    minWidth?: BaseTableCssValue;
+    align?: BaseTableAlign;
+    headerAlign?: BaseTableAlign;
+    fixed?: boolean | 'left' | 'right';
+    sortable?: boolean | 'custom';
+    sortField?: string;
+    headerSearch?: boolean | BaseTableHeaderSearchConfig;
+    showOverflowTooltip?: boolean;
+    className?: string;
+    headerClassName?: string;
+    actions?: BaseTableAction<Row>[];
+    clickable?: boolean;
+    options?: BaseTableOption[];
+    optionValueKey?: string;
+    optionLabelKey?: string;
+    optionTagTypeKey?: string;
+    emptyText?: string;
+    inputType?: string;
+    imageFit?: '' | 'fill' | 'contain' | 'cover' | 'none' | 'scale-down';
+    imageWidth?: BaseTableCssValue;
+    imageHeight?: BaseTableCssValue;
+    slotName?: string;
+    headerSlotName?: string;
+    formatter?: (row: Row, column: BaseTableColumn<Row>) => unknown;
+    html?: (row: Row, column: BaseTableColumn<Row>) => string;
+    clickHandler?: (row: Row, column: BaseTableColumn<Row>) => void;
+    inputHandler?: (value: string, row: Row, column: BaseTableColumn<Row>) => void;
+}
+export interface BaseTablePagination {
+    currentPage: number;
+    pageSize: number;
+    total: number;
+    pageSizes: number[];
+}
+export interface BaseTableRequestParams {
+    currentPage: number;
+    pageSize: number;
+    [key: string]: unknown;
+}
+export interface BaseTableSortState {
+    prop?: string;
+    order: BaseTableSortOrder;
+}
+export interface BaseTableSortOrderMap {
+    ascending: string;
+    descending: string;
+}
+export interface BaseTableRequestResult<Row = Record<string, any>> {
+    records?: Row[];
+    list?: Row[];
+    items?: Row[];
+    total?: number;
+    data?: {
+        records?: Row[];
+        list?: Row[];
+        items?: Row[];
+        total?: number;
+    };
+}
+export interface BaseTableNormalizedResult<Row = Record<string, any>> {
+    rows?: Row[];
+    total?: number;
+}
+export type BaseTableRequestHandler<Row = Record<string, any>> = (params: BaseTableRequestParams) => Promise<BaseTableRequestResult<Row> | Row[]>;
+export type BaseTableResultAdapter<Row = Record<string, any>> = (result: unknown, params: BaseTableRequestParams) => BaseTableNormalizedResult<Row>;
+export interface BaseTableProps<Row = Record<string, any>> {
+    columns: BaseTableColumn<Row>[];
+    data?: Row[];
+    request?: BaseTableRequestHandler<Row>;
+    requestParams?: Record<string, unknown>;
+    resultAdapter?: BaseTableResultAdapter<Row>;
+    autoLoad?: boolean;
+    reloadOnParamsChange?: boolean;
+    reloadOnSortChange?: boolean;
+    rowKey?: string;
+    height?: BaseTableCssValue;
+    border?: boolean;
+    stripe?: boolean;
+    showToolbar?: boolean;
+    showPagination?: boolean;
+    hasSelection?: boolean;
+    hasIndex?: boolean;
+    indexLabel?: string;
+    indexWidth?: BaseTableCssValue;
+    selectionWidth?: BaseTableCssValue;
+    rowSelectable?: (row: Row, index: number) => boolean;
+    pagination?: Partial<BaseTablePagination>;
+    currentPageKey?: string;
+    pageSizeKey?: string;
+    defaultSort?: BaseTableSortState;
+    sortFieldKey?: string;
+    sortOrderKey?: string;
+    sortOrderMap?: BaseTableSortOrderMap;
+    sortMapper?: (payload: BaseTableSortPayload<Row>) => Record<string, unknown> | void;
+    emptyText?: string;
+    loadingText?: string;
+}
+export interface BaseTableSortPayload<Row = Record<string, any>> {
+    column: BaseTableColumn<Row> | undefined;
+    prop?: string;
+    order: BaseTableSortOrder;
+    field?: string;
+    direction: BaseTableSortDirection;
+}
+export interface BaseTableRowActionPayload<Row = Record<string, any>> {
+    row: Row;
+    action: BaseTableAction<Row>;
+    column: BaseTableColumn<Row>;
+}
+export interface BaseTableCellPayload<Row = Record<string, any>> {
+    row: Row;
+    column: BaseTableColumn<Row>;
+    value: unknown;
+}
+export interface BaseTableLoadedPayload<Row = Record<string, any>> {
+    rows: Row[];
+    total: number;
+    params: BaseTableRequestParams;
+}
+export interface BaseTableExpose<Row = Record<string, any>> {
+    load: (data?: Row[]) => Promise<void>;
+    refresh: () => Promise<void>;
+    setData: (data: Row[]) => void;
+    resetPage: () => Promise<void>;
+    setHeaderSearchValue: (key: string, value: BaseTableHeaderSearchValue, shouldReload?: boolean) => Promise<void>;
+    resetHeaderSearch: (key?: string) => Promise<void>;
+    getHeaderSearchValues: () => Record<string, BaseTableHeaderSearchValue>;
+    clearSelection: () => void;
+    toggleRowSelection: (row: Row, selected?: boolean) => void;
+    getSelectionRows: () => Row[];
+    getRows: () => Row[];
+}

package/src/components/BaseTable/BaseTable.types.ts

@@ -3,13 +3,28 @@ export type BaseTableAlign = 'left' | 'center' | 'right'
 export type BaseTableColumnKind = 'text' | 'link' | 'actions' | 'image' | 'tag' | 'html' | 'input'
 export type BaseTableSortOrder = 'ascending' | 'descending' | null
 export type BaseTableSortDirection = string | null
+export type BaseTableHeaderSearchType = 'input' | 'select' | 'cascader'
+export type BaseTableHeaderSearchPrimitiveValue = string | number | boolean
+export type BaseTableHeaderSearchPathValue = BaseTableHeaderSearchPrimitiveValue[]
+export type BaseTableHeaderSearchValue =
+  | BaseTableHeaderSearchPrimitiveValue
+  | BaseTableHeaderSearchPrimitiveValue[]
 
 export interface BaseTableHeaderSearchConfig {
+  type?: BaseTableHeaderSearchType
   paramKey?: string
   placeholder?: string
   width?: BaseTableCssValue
   searchText?: string
   resetText?: string
+  options?: BaseTableOption[]
+  multiple?: boolean
+  clearable?: boolean
+  filterable?: boolean
+  optionValueKey?: string
+  optionLabelKey?: string
+  optionDisabledKey?: string
+  optionChildrenKey?: string
 }
 
 export interface BaseTableOption {
@@ -17,6 +32,8 @@ export interface BaseTableOption {
   value: string | number | boolean
   tagType?: '' | 'success' | 'warning' | 'info' | 'danger' | 'primary'
   color?: string
+  disabled?: boolean
+  children?: BaseTableOption[]
 }
 
 export interface BaseTableAction<Row = Record<string, any>> {
@@ -176,9 +193,9 @@ export interface BaseTableExpose<Row = Record<string, any>> {
   refresh: () => Promise<void>
   setData: (data: Row[]) => void
   resetPage: () => Promise<void>
-  setHeaderSearchValue: (key: string, value: string, shouldReload?: boolean) => Promise<void>
+  setHeaderSearchValue: (key: string, value: BaseTableHeaderSearchValue, shouldReload?: boolean) => Promise<void>
   resetHeaderSearch: (key?: string) => Promise<void>
-  getHeaderSearchValues: () => Record<string, string>
+  getHeaderSearchValues: () => Record<string, BaseTableHeaderSearchValue>
   clearSelection: () => void
   toggleRowSelection: (row: Row, selected?: boolean) => void
   getSelectionRows: () => Row[]