@yeepay/yee-boss-ui 0.1.0

package/README.md

@@ -0,0 +1,155 @@
+# @yeepay/yee-boss-ui
+
+运营后台平台公共 UI、主题和轻量列表页基础能力。
+
+## 当前范围
+
+当前提供：
+
+- light/dark 语义化 Theme Tokens。
+- `--yee-*` 全量公共 CSS Variables。
+- Ant Design Vue Theme Token 映射。
+- `PlatformConfigProvider`。
+- `usePlatformTheme` 只读主题上下文。
+- `YeePage` 页面容器。
+- `YeeForm` Schema 查询表单。
+- `useYeeGrid` 与 `gridApi/formApi`。
+- Tailwind CSS 语义主题 preset。
+
+不提供主题切换器、业务组件或对 Ant Design Vue 基础组件的机械封装，也不依赖任何 `@vben-*` 包。
+
+## 安装
+
+```bash
+pnpm add @yeepay/yee-boss-ui ant-design-vue vue vxe-table vxe-pc-ui
+```
+
+## 使用
+
+```vue
+<script setup lang="ts">
+import {
+  PlatformConfigProvider,
+  type PlatformTheme,
+} from '@yeepay/yee-boss-ui'
+import '@yeepay/yee-boss-ui/style.css'
+
+const theme: PlatformTheme = {
+  mode: 'light',
+}
+</script>
+
+<template>
+  <PlatformConfigProvider :theme="theme">
+    <RouterView />
+  </PlatformConfigProvider>
+</template>
+```
+
+Portal 负责决定当前主题并通过 Runtime Context 传给子应用；组件库只负责映射和消费。语言与 locale 继续由应用国际化层负责。
+
+只需要公共主题、不使用组件时，可以只引入：
+
+```ts
+import '@yeepay/yee-boss-ui/theme.css'
+```
+
+`theme.css` 在 `:root` 提供 light 默认值，并同时支持 `html.dark` 和 `[data-theme="dark"]`。Portal 需要在根节点同步主题标识；子应用不自行维护另一套主题变量。
+
+所有公共变量统一使用 `--yee-*`，例如：
+
+```css
+.custom-card {
+  color: var(--yee-card-foreground);
+  background: var(--yee-card);
+  border: 1px solid var(--yee-border);
+  border-radius: var(--yee-radius);
+}
+```
+
+## Tailwind CSS
+
+```js
+// tailwind.config.mjs
+import bossUiTailwindPreset from '@yeepay/yee-boss-ui/tailwind-preset'
+
+export default {
+  presets: [bossUiTailwindPreset],
+  content: ['./index.html', './src/**/*.{vue,ts}'],
+}
+```
+
+业务页面可以直接使用 `bg-background`、`bg-background-deep`、`bg-card`、`bg-accent`、`text-foreground`、`text-muted-foreground` 和 `border-border`，底层统一映射到 `--yee-*`。
+
+## YeePage 与 VXE Grid
+
+```vue
+<script setup lang="ts">
+import type {
+  YeeFormOptions,
+  YeeGridOptions,
+} from '@yeepay/yee-boss-ui'
+import {
+  YeePage,
+  useYeeGrid,
+} from '@yeepay/yee-boss-ui'
+
+interface OrderItem {
+  orderNo: string
+}
+
+interface QueryValues {
+  orderNo?: string
+}
+
+const formOptions: YeeFormOptions<QueryValues> = {
+  schema: [
+    {
+      component: 'Input',
+      componentProps: { allowClear: true },
+      fieldName: 'orderNo',
+      label: '订单号',
+    },
+  ],
+}
+
+const gridOptions: YeeGridOptions<OrderItem, QueryValues> = {
+  columns: [{ field: 'orderNo', title: '订单号' }],
+  pagerConfig: {},
+  proxyConfig: {
+    ajax: {
+      query: async ({ page }, formValues) => {
+        return getOrderPage({
+          ...formValues,
+          pageNo: page.currentPage,
+          pageSize: page.pageSize,
+        })
+      },
+    },
+  },
+}
+
+const [YeeGrid, gridApi] = useYeeGrid({
+  formOptions,
+  gridOptions,
+})
+
+defineExpose({ reload: gridApi.reload })
+</script>
+
+<template>
+  <yee-page auto-content-height>
+    <yee-grid table-title="订单明细" />
+  </yee-page>
+</template>
+```
+
+组件的 TypeScript 导出使用 `YeeForm`、`YeeGrid`、`YeePage`，Vue 模板标签对应 `yee-form`、`yee-grid`、`yee-page`。新代码统一使用 `useYeeGrid`，不提供旧命名兼容别名。查询接口统一返回 `{ items, total }`。
+
+## 开发
+
+```bash
+pnpm install
+pnpm check
+pnpm pack --dry-run
+```

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

@@ -0,0 +1,23 @@
+import { PlatformTheme } from '../theme/types';
+interface Props {
+    theme?: PlatformTheme;
+}
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        default?(_: {}): any;
+    };
+    refs: {};
+    rootEl: any;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<Props, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<Props> & Readonly<{}>, {
+    theme: PlatformTheme;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, any>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/form/YeeForm.vue.d.ts

@@ -0,0 +1,14 @@
+import { YeeFormValues, YeeFormProps } from './types';
+declare const _default: <TValues extends object = YeeFormValues>(__VLS_props: NonNullable<Awaited<typeof __VLS_setup>>["props"], __VLS_ctx?: __VLS_PrettifyLocal<Pick<NonNullable<Awaited<typeof __VLS_setup>>, "attrs" | "emit" | "slots">>, __VLS_expose?: NonNullable<Awaited<typeof __VLS_setup>>["expose"], __VLS_setup?: Promise<{
+    props: __VLS_PrettifyLocal<Pick<Partial<{}> & Omit<{} & import('vue').VNodeProps & import('vue').AllowedComponentProps & import('vue').ComponentCustomProps, never>, never> & YeeFormProps<TValues> & Partial<{}>> & import('vue').PublicProps;
+    expose(exposed: import('vue').ShallowUnwrapRef<{}>): void;
+    attrs: any;
+    slots: {};
+    emit: {};
+}>) => import('vue').VNode & {
+    __ctx?: Awaited<typeof __VLS_setup>;
+};
+export default _default;
+type __VLS_PrettifyLocal<T> = {
+    [K in keyof T]: T[K];
+} & {};

package/dist/components/form/form-api.d.ts

@@ -0,0 +1,14 @@
+import { ShallowRef } from 'vue';
+import { YeeFormOptions, YeeFormSchema, YeeFormSchemaUpdate, YeeFormValues } from './types';
+export declare class YeeFormApi<TValues extends object = YeeFormValues> {
+    readonly schema: ShallowRef<readonly YeeFormSchema<TValues>[]>;
+    private initialValues;
+    private readonly values;
+    configure(options: YeeFormOptions<TValues>): void;
+    getFieldValue(fieldName: keyof TValues & string): unknown;
+    getValues(): TValues;
+    resetForm(): void;
+    setFieldValue(fieldName: keyof TValues & string, value: unknown): void;
+    setValues(values: Partial<TValues>): void;
+    updateSchema(updates: readonly YeeFormSchemaUpdate<TValues>[]): void;
+}

package/dist/components/form/index.d.ts

@@ -0,0 +1,3 @@
+export { default as YeeForm } from './YeeForm.vue';
+export { YeeFormApi } from './form-api';
+export type { YeeFormComponent, YeeFormOptions, YeeFormSchema, YeeFormSchemaUpdate, YeeFormValues, YeeFormProps, } from './types';

package/dist/components/form/types.d.ts

@@ -0,0 +1,28 @@
+export type YeeFormComponent = 'Input' | 'RangePicker' | 'Select';
+export type YeeFormValues = Record<string, unknown>;
+export interface YeeFormSchema<TValues extends object = YeeFormValues> {
+    component: YeeFormComponent;
+    componentProps?: Record<string, unknown>;
+    fieldName: keyof TValues & string;
+    hide?: boolean;
+    label: string;
+}
+export interface YeeFormSchemaUpdate<TValues extends object = YeeFormValues> extends Partial<Omit<YeeFormSchema<TValues>, 'fieldName'>> {
+    fieldName: keyof TValues & string;
+}
+export interface YeeFormOptions<TValues extends object = YeeFormValues> {
+    collapsed?: boolean;
+    collapsedRows?: number;
+    handleCollapsedChange?: (collapsed: boolean) => void;
+    initialValues?: Partial<TValues>;
+    schema: readonly YeeFormSchema<TValues>[];
+    showCollapseButton?: boolean;
+    submitOnChange?: boolean;
+    submitOnEnter?: boolean;
+}
+export interface YeeFormProps<TValues extends object = YeeFormValues> {
+    api: import('./form-api').YeeFormApi<TValues>;
+    onReset?: () => Promise<void> | void;
+    onSubmit?: (values: TValues) => Promise<void> | void;
+    options: YeeFormOptions<TValues>;
+}

package/dist/components/grid/YeeGrid.vue.d.ts

@@ -0,0 +1,134 @@
+import { VxeGridProps } from 'vxe-table';
+import { YeeGridInternalProps } from './types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: Partial<Record<string, (_: {
+        [key: string]: any;
+        $table: import('vxe-table').VxeTableConstructor<any>;
+        $grid: import('vxe-table').VxeGridConstructor<any> | null | undefined;
+        $gantt: import('vxe-pc-ui').VxeGanttConstructor<any> | null | undefined;
+        rowid: string;
+        row: any;
+        rowIndex: number;
+        $rowIndex: number;
+        _rowIndex: number;
+        column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
+        columnIndex: number;
+        $columnIndex: number;
+        _columnIndex: number;
+        option: import("vxe-table").VxeColumnPropTypes.FilterItem;
+        type: string;
+        fixed: import("vxe-table").VxeColumnPropTypes.Fixed;
+        checked: boolean;
+        indeterminate: boolean;
+        seq: string | number;
+        level: number;
+        isEdit: boolean;
+        isHidden: boolean;
+        field: string;
+        item: any;
+        data: any;
+        tooltipContent: string;
+        groupContent: string;
+        groupField: string;
+        childCount: number;
+        groupValues: number;
+        aggValue: number;
+        visibleData: any[];
+        items: any[];
+    }) => any>> & {
+        'table-title'?(_: {}): any;
+        'toolbar-actions'?(_: {
+            [key: string]: any;
+            $table: import('vxe-table').VxeTableConstructor<any>;
+            $grid: import('vxe-table').VxeGridConstructor<any> | null | undefined;
+            $gantt: import('vxe-pc-ui').VxeGanttConstructor<any> | null | undefined;
+            rowid: string;
+            row: any;
+            rowIndex: number;
+            $rowIndex: number;
+            _rowIndex: number;
+            column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
+            columnIndex: number;
+            $columnIndex: number;
+            _columnIndex: number;
+            option: import("vxe-table").VxeColumnPropTypes.FilterItem;
+            type: string;
+            fixed: import("vxe-table").VxeColumnPropTypes.Fixed;
+            checked: boolean;
+            indeterminate: boolean;
+            seq: string | number;
+            level: number;
+            isEdit: boolean;
+            isHidden: boolean;
+            field: string;
+            item: any;
+            data: any;
+            tooltipContent: string;
+            groupContent: string;
+            groupField: string;
+            childCount: number;
+            groupValues: number;
+            aggValue: number;
+            visibleData: any[];
+            items: any[];
+        }): any;
+        'toolbar-tools'?(_: {
+            [key: string]: any;
+            $table: import('vxe-table').VxeTableConstructor<any>;
+            $grid: import('vxe-table').VxeGridConstructor<any> | null | undefined;
+            $gantt: import('vxe-pc-ui').VxeGanttConstructor<any> | null | undefined;
+            rowid: string;
+            row: any;
+            rowIndex: number;
+            $rowIndex: number;
+            _rowIndex: number;
+            column: import("vxe-table").VxeTableDefines.ColumnInfo<any>;
+            columnIndex: number;
+            $columnIndex: number;
+            _columnIndex: number;
+            option: import("vxe-table").VxeColumnPropTypes.FilterItem;
+            type: string;
+            fixed: import("vxe-table").VxeColumnPropTypes.Fixed;
+            checked: boolean;
+            indeterminate: boolean;
+            seq: string | number;
+            level: number;
+            isEdit: boolean;
+            isHidden: boolean;
+            field: string;
+            item: any;
+            data: any;
+            tooltipContent: string;
+            groupContent: string;
+            groupField: string;
+            childCount: number;
+            groupValues: number;
+            aggValue: number;
+            visibleData: any[];
+            items: any[];
+        }): any;
+        empty?(_: {}): any;
+    };
+    refs: {
+        gridRef: (import('vxe-table').VxeGridMethods<any> & {
+            $props: VxeGridProps<any> & import('vxe-table').VxeGridEventProps<any>;
+            $slots: import('vxe-table').VxeGridSlots<any>;
+        }) | null;
+    };
+    rootEl: HTMLElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<YeeGridInternalProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<YeeGridInternalProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {
+    gridRef: (import('vxe-table').VxeGridMethods<any> & {
+        $props: VxeGridProps<any> & import('vxe-table').VxeGridEventProps<any>;
+        $slots: import('vxe-table').VxeGridSlots<any>;
+    }) | null;
+}, HTMLElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/grid/index.d.ts

@@ -0,0 +1,4 @@
+export { YeeGridApi } from './yee-grid-api';
+export { useYeeGrid } from './use-yee-grid';
+export type { YeeGridPage, YeeGridQuery, YeeGridQueryParams, YeeGridToolbarConfig, YeeGridOptions, UseYeeGridOptions, } from './types';
+export type { VxeGridDefines, VxeGridListeners, VxeGridPropTypes, VxeTableDefines, } from 'vxe-table';

package/dist/components/grid/types.d.ts

@@ -0,0 +1,42 @@
+import { VxeGridInstance, VxeGridListeners, VxeGridProps as NativeVxeGridProps } from 'vxe-table';
+import { YeeFormOptions, YeeFormValues } from '../form';
+import { YeeGridApi } from './yee-grid-api';
+type NativeProxyConfig<T> = NonNullable<NativeVxeGridProps<T>['proxyConfig']>;
+type NativeProxyAjax<T> = NonNullable<NativeProxyConfig<T>['ajax']>;
+type NativeProxyQuery<T> = NonNullable<NativeProxyAjax<T>['query']>;
+export type YeeGridQueryParams<T> = Parameters<NativeProxyQuery<T>>[0];
+export interface YeeGridPage<T> {
+    items: readonly T[];
+    total: number;
+}
+export type YeeGridQuery<T, TFormValues extends object = YeeFormValues> = (params: YeeGridQueryParams<T>, formValues: TFormValues) => Promise<YeeGridPage<T>>;
+type YeeGridProxyAjax<T, TFormValues extends object> = Omit<NativeProxyAjax<T>, 'query'> & {
+    query?: YeeGridQuery<T, TFormValues>;
+};
+type YeeGridProxyConfig<T, TFormValues extends object> = Omit<NativeProxyConfig<T>, 'ajax'> & {
+    ajax?: YeeGridProxyAjax<T, TFormValues>;
+};
+type NativeToolbarConfig<T> = NonNullable<NativeVxeGridProps<T>['toolbarConfig']>;
+export type YeeGridToolbarConfig<T> = NativeToolbarConfig<T> & {
+    search?: boolean;
+};
+export type YeeGridOptions<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> = Omit<NativeVxeGridProps<T>, 'proxyConfig' | 'toolbarConfig'> & {
+    proxyConfig?: YeeGridProxyConfig<T, TFormValues>;
+    toolbarConfig?: YeeGridToolbarConfig<T>;
+};
+export interface UseYeeGridOptions<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> {
+    formOptions?: YeeFormOptions<TFormValues>;
+    gridEvents?: VxeGridListeners<T>;
+    gridOptions: YeeGridOptions<T, TFormValues>;
+    separator?: boolean;
+    showSearchForm?: boolean;
+}
+export interface YeeGridRuntimeProps {
+    tableTitle?: string;
+    tableTitleHelp?: string;
+}
+export interface YeeGridInternalProps extends YeeGridRuntimeProps {
+    api: YeeGridApi;
+}
+export type YeeGridRef<T> = VxeGridInstance<T>;
+export {};

package/dist/components/grid/use-yee-grid.d.ts

@@ -0,0 +1,5 @@
+import { DefineComponent } from 'vue';
+import { YeeFormValues } from '../form';
+import { YeeGridApi } from './yee-grid-api';
+import { YeeGridRuntimeProps, UseYeeGridOptions } from './types';
+export declare function useYeeGrid<T = Record<string, unknown>, TFormValues extends object = YeeFormValues>(options: UseYeeGridOptions<T, TFormValues>): readonly [DefineComponent<YeeGridRuntimeProps>, YeeGridApi<T, TFormValues>];

package/dist/components/grid/vxe-init.d.ts

@@ -0,0 +1 @@
+export declare function initializeVxeTable(): void;

package/dist/components/grid/yee-grid-api.d.ts

@@ -0,0 +1,18 @@
+import { ShallowRef } from 'vue';
+import { YeeFormApi, YeeFormValues } from '../form';
+import { YeeGridOptions, YeeGridRef, UseYeeGridOptions } from './types';
+export declare class YeeGridApi<T = Record<string, unknown>, TFormValues extends object = YeeFormValues> {
+    readonly formApi: YeeFormApi<TFormValues>;
+    readonly searchFormVisible: ShallowRef<boolean>;
+    readonly state: ShallowRef<UseYeeGridOptions<T, TFormValues>>;
+    private grid;
+    constructor(options: UseYeeGridOptions<T, TFormValues>);
+    mount(grid: YeeGridRef<T>): void;
+    query: (values?: Partial<TFormValues>) => Promise<unknown>;
+    reload: (values?: Partial<TFormValues>) => Promise<unknown>;
+    setGridOptions(options: Partial<YeeGridOptions<T, TFormValues>>): void;
+    setLoading(loading: boolean): void;
+    setState(state: Partial<UseYeeGridOptions<T, TFormValues>>): void;
+    toggleSearchForm(show?: boolean): boolean;
+    unmount(): void;
+}

package/dist/components/page/YeePage.vue.d.ts

@@ -0,0 +1,25 @@
+import { YeePageProps } from './types';
+declare function __VLS_template(): {
+    attrs: Partial<{}>;
+    slots: {
+        title?(_: {}): any;
+        description?(_: {}): any;
+        extra?(_: {}): any;
+        default?(_: {}): any;
+        footer?(_: {}): any;
+    };
+    refs: {};
+    rootEl: HTMLElement;
+};
+type __VLS_TemplateResult = ReturnType<typeof __VLS_template>;
+declare const __VLS_component: import('vue').DefineComponent<YeePageProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<YeePageProps> & Readonly<{}>, {
+    autoContentHeight: boolean;
+    heightOffset: number | string;
+}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLElement>;
+declare const _default: __VLS_WithTemplateSlots<typeof __VLS_component, __VLS_TemplateResult["slots"]>;
+export default _default;
+type __VLS_WithTemplateSlots<T, S> = T & {
+    new (): {
+        $slots: S;
+    };
+};

package/dist/components/page/index.d.ts

@@ -0,0 +1,2 @@
+export { default as YeePage } from './YeePage.vue';
+export type { YeePageProps } from './types';

package/dist/components/page/types.d.ts

@@ -0,0 +1,9 @@
+export interface YeePageProps {
+    autoContentHeight?: boolean;
+    contentClass?: string;
+    description?: string;
+    footerClass?: string;
+    headerClass?: string;
+    heightOffset?: number | string;
+    title?: string;
+}

package/dist/index.d.ts

@@ -0,0 +1,9 @@
+export { default as PlatformConfigProvider } from './components/PlatformConfigProvider.vue';
+export * from './components/form';
+export * from './components/grid';
+export * from './components/page';
+export { toAntDesignTheme } from './theme/ant-theme';
+export { platformThemeKey, usePlatformTheme } from './theme/context';
+export { toPlatformCssVariables } from './theme/css-variables';
+export { darkThemeTokens, lightThemeTokens, resolvePlatformTheme, } from './theme/tokens';
+export type { PlatformTheme, PlatformThemeMode, PlatformThemeTokens, ResolvedPlatformTheme, } from './theme/types';