workdesktop-ai 1.0.0

package/dist/types/src/lib/composables/useRequest.d.ts

@@ -0,0 +1,42 @@
+import { type ApiResult } from '../core/http';
+import type { ReqOptions } from '../../types/config';
+/**
+ * useRequest（PRD 5.3）
+ * 封装请求逻辑，返回 data/loading/error + 请求方法。
+ *
+ * @example
+ * const { data, loading, run } = useRequest<User[]>('/api/users', {
+ *   method: 'post',
+ *   immediate: false,
+ *   reqConfig: { showTips: false }
+ * })
+ * run({ page: 1 })
+ */
+export interface UseRequestOptions {
+    /** 请求方法，默认 post */
+    method?: 'get' | 'post' | 'put' | 'delete';
+    /** 是否立即自动请求，默认 true */
+    immediate?: boolean;
+    /** 自动请求时的初始参数 */
+    initialParams?: any;
+    /** 请求级覆盖项（透传给 http） */
+    reqOptions?: ReqOptions;
+    /** 成功回调（data 为解封后的业务数据） */
+    onSuccess?: (data: any, result: ApiResult) => void;
+    /** 业务失败回调 */
+    onFail?: (result: ApiResult) => void;
+    /** 异常回调 */
+    onError?: (error: any) => void;
+}
+export declare function useRequest<T = any>(api: string | (() => string), options?: UseRequestOptions): {
+    data: import("vue").Ref<any, any> extends T | null ? import("vue").ShallowRef<null, null> | (T extends T & import("vue").Ref<any, any> ? import("@vue/shared").IfAny<T, import("vue").ShallowRef<T, T>, T> : import("vue").ShallowRef<T, T>) : import("vue").ShallowRef<T | null, T | null>;
+    loading: import("vue").Ref<boolean, boolean>;
+    error: import("vue").ShallowRef<Error | null, Error | null>;
+    run: (params?: any) => Promise<ApiResult<T> | null>;
+    refresh: () => Promise<ApiResult<T> | null>;
+    abort: () => void;
+};
+/** 工具：解包可能为 ref 的值 */
+export declare function unrefValue<T>(v: T | {
+    value: T;
+}): T;

package/dist/types/src/lib/configs/default-config.d.ts

@@ -0,0 +1,6 @@
+import type { WorkDesktopConfig } from '../../types/config';
+/**
+ * 默认配置层（库内置，不可改）
+ * PRD 5.2 / 第 7 章
+ */
+export declare const defaultConfig: WorkDesktopConfig;

package/dist/types/src/lib/core/config.d.ts

@@ -0,0 +1,28 @@
+import type { DeepPartial, WorkDesktopConfig } from '../../types/config';
+/**
+ * 增量合并到全局层。库 install 时与运行时 setGlobalConfig 共用。
+ * 返回 merge 后的有效配置。
+ */
+export declare function setGlobalConfig(partial?: DeepPartial<WorkDesktopConfig>): WorkDesktopConfig;
+/**
+ * 读取当前全局层（含默认层 merge 结果）
+ */
+export declare function getGlobalConfig(): WorkDesktopConfig;
+/**
+ * 恢复默认层
+ */
+export declare function resetConfig(): WorkDesktopConfig;
+/**
+ * 合并本地层（组件 props / 组件级配置），产出最终配置。
+ * 优先级：localProps > globalConfig > defaultConfig
+ */
+export declare function mergeConfig(local?: DeepPartial<WorkDesktopConfig> | Record<string, any>): WorkDesktopConfig;
+/**
+ * 取某组件类型的全局默认配置（page.componentDefault[PascalName]）
+ */
+export declare function getComponentDefault(componentName: string): Record<string, any>;
+/**
+ * 库初始化：合并双入口配置（npm app.use 参数 + window.workDesktopConfig）
+ * 两条入口汇入同一套 merge 逻辑，行为一致（PRD 8.2）
+ */
+export declare function initConfig(useConfig?: DeepPartial<WorkDesktopConfig>): WorkDesktopConfig;

package/dist/types/src/lib/core/http.d.ts

@@ -0,0 +1,83 @@
+import { type AxiosRequestConfig } from 'axios';
+import type { ReqOptions } from '../../types/config';
+/**
+ * HTTP 请求模块（PRD 5.1 / 第 7 章）
+ *
+ * 响应处理流程：
+ * 1. 请求前显示 loading（可配置）
+ * 2. 响应到达，按 resConfig 解封：取 code/message/data
+ * 3. code 匹配成功码 → apiSuccess + 成功提示
+ * 4. code 不匹配 → apiFail + 失败提示（业务失败 resolve，不 reject）
+ * 5. 网络异常 → apiException + 异常提示（reject）
+ * 6. 请求完成 → apiAfter + 关闭 loading
+ */
+export type ApiEventType = 'apiBefore' | 'apiSuccess' | 'apiFail' | 'apiException' | 'apiAfter';
+export interface ApiEventPayload {
+    type: ApiEventType;
+    url?: string;
+    method?: string;
+    params?: any;
+    /** 解封后的业务数据 */
+    data?: any;
+    code?: number | string;
+    message?: string;
+    error?: any;
+    /** 原始响应 */
+    raw?: any;
+}
+export type ApiEventHandler = (payload: ApiEventPayload) => void;
+/** 业务失败时 resolve 的结果（PRD 7.4：不抛异常，组件据此感知） */
+export interface ApiResult<T = any> {
+    success: boolean;
+    data: T | null;
+    code?: number | string;
+    message?: string;
+    raw?: any;
+}
+type Listener = ApiEventHandler;
+/**
+ * WorkDesktop HTTP 客户端
+ */
+declare class WorkDesktopHttp {
+    private axiosInstance;
+    private listeners;
+    /** 组件/实例级配置覆盖（request.create 使用） */
+    private instanceConfig;
+    private loadingInstance;
+    private loadingCount;
+    constructor(axiosConfig?: AxiosRequestConfig);
+    /**
+     * 创建绑定组件级配置的实例（PRD 5.1）
+     */
+    create(componentReqConfig?: DeepPartialConfig): WorkDesktopHttp;
+    on(handler: Listener): () => void;
+    off(handler: Listener): void;
+    private emit;
+    /**
+     * 取有效配置：全局配置 + 实例级覆盖
+     */
+    private resolveConfig;
+    private openLoading;
+    private closeLoading;
+    /**
+     * 核心请求方法
+     * 返回 Promise<ApiResult<T>>：业务失败也 resolve（success=false），仅网络异常 reject
+     */
+    request<T = any>(config: AxiosRequestConfig, reqOptions?: ReqOptions): Promise<ApiResult<T>>;
+    /**
+     * 解封响应体：按 resConfig 取 code/message/data
+     */
+    private unpack;
+    private checkSuccess;
+    private buildUrl;
+    get<T = any>(url: string, params?: any, reqOptions?: ReqOptions): Promise<ApiResult<T>>;
+    post<T = any>(url: string, data?: any, reqOptions?: ReqOptions): Promise<ApiResult<T>>;
+    put<T = any>(url: string, data?: any, reqOptions?: ReqOptions): Promise<ApiResult<T>>;
+    delete<T = any>(url: string, params?: any, reqOptions?: ReqOptions): Promise<ApiResult<T>>;
+}
+type DeepPartialConfig = Record<string, any>;
+/**
+ * 全局单例（脱离组件直接调用，PRD 5.1）
+ */
+export declare const request: WorkDesktopHttp;
+export default request;

package/dist/types/src/lib/core/linkage.d.ts

@@ -0,0 +1,48 @@
+/**
+ * 声明式联动注册中心（PRD 6.2）
+ *
+ * filter 分组机制：所有参与联动的组件有通用 prop `filter`（默认 ''）。
+ * 联动只在 filter 相同的组件之间发生。
+ *
+ * DataGrid 挂载时按 filter 注册到注册中心；
+ * DataForm / ApiButton / Dialog / Drawer 等动作完成后，
+ * 调用 refreshDataGrid(headRefreshDatagrid, selfFilter) 刷新目标。
+ */
+export interface DataGridInstance {
+    /** 组件 filter 分组标识 */
+    filter: string;
+    /** 刷新当前页数据 */
+    refresh: () => any;
+    /** 带搜索参数查询（重置到第一页，合并搜索条件） */
+    search?: (params?: Record<string, any>) => any;
+    /** 清空搜索条件并刷新 */
+    resetSearch?: () => any;
+}
+/**
+ * 注册 DataGrid 实例，返回注销函数（组件 onUnmounted 调用）
+ */
+export declare function registerDataGrid(instance: DataGridInstance): () => void;
+/**
+ * 刷新目标 DataGrid
+ * @param headRefreshDatagrid true=刷同 filter 组；字符串=定向刷该 filter 组
+ * @param selfFilter 发起组件自身 filter
+ * @returns 被刷新的实例数量
+ */
+export declare function refreshDataGrid(headRefreshDatagrid: boolean | string | undefined, selfFilter?: string): number;
+/**
+ * 获取某 filter 组的 DataGrid 实例（事件联动 / 自定义逻辑用）
+ */
+export declare function getDataGrids(filter?: string): DataGridInstance[];
+/**
+ * SearchPanel 联动：带搜索参数刷新目标 DataGrid（重置到第一页）
+ * @param params 搜索表单值
+ */
+export declare function searchDataGrid(params: Record<string, any> | undefined, headRefreshDatagrid: boolean | string | undefined, selfFilter?: string): number;
+/**
+ * SearchPanel 重置联动：清空目标 DataGrid 搜索条件并刷新
+ */
+export declare function resetSearchDataGrid(headRefreshDatagrid: boolean | string | undefined, selfFilter?: string): number;
+/**
+ * 仅供测试 / 调试：清空注册中心
+ */
+export declare function clearLinkageRegistry(): void;

package/dist/types/src/lib/core/theme.d.ts

@@ -0,0 +1,6 @@
+import type { ThemeConfig } from '../../types/config';
+/**
+ * 将 theme 配置写入 :root CSS 变量（PRD 9.2 方式二）
+ * colors 展开优先级低于 cssVars（cssVars 可直接覆盖 colors 生成的变量）
+ */
+export declare function applyTheme(theme?: ThemeConfig): void;

package/dist/types/src/lib/core/utils.d.ts

@@ -0,0 +1,28 @@
+/**
+ * 通用工具函数
+ */
+/**
+ * 判断是否为普通对象（用于 deep merge）
+ */
+export declare function isPlainObject(value: unknown): value is Record<string, any>;
+/**
+ * deep merge：对象深合并；数组覆盖；基本类型后者覆盖前者
+ * 与 lodash.merge 语义一致：从左到右，后者优先级高
+ */
+export declare function deepMerge<T = any>(...sources: any[]): T;
+/**
+ * 按路径取对象值，如 getValue(obj, 'a.b.c')
+ */
+export declare function getValueByPath(obj: any, path: string): any;
+export declare function uniqueId(prefix?: string): string;
+/**
+ * 安全 JSON parse（localStorage 用）
+ */
+export declare function safeJsonParse<T>(text: string | null, fallback: T): T;
+/**
+ * 防抖
+ */
+export declare function debounce<F extends (...args: any[]) => any>(fn: F, wait?: number): {
+    (this: unknown, ...args: Parameters<F>): void;
+    cancel(): void;
+};

package/dist/types/src/lib/install.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Vue 插件入口（PRD 8.2 双入口）
+ *
+ * npm：app.use(WorkDesktop, config)
+ * script：window.workDesktopConfig 配置 + window.WorkDesktop 自动安装
+ */
+import type { Plugin } from 'vue';
+declare const install: Plugin['install'];
+declare const WorkDesktop: Plugin;
+export default WorkDesktop;
+export { install };

package/dist/types/src/types/config.d.ts

@@ -0,0 +1,109 @@
+/**
+ * WorkDesktop 全局配置类型（PRD 5.2）
+ */
+export type DeepPartial<T> = {
+    [P in keyof T]?: T[P] extends object ? DeepPartial<T[P]> : T[P];
+};
+export interface RequestLoadingConfig {
+    enable: boolean;
+    props?: Record<string, any>;
+}
+export interface PageParamConfig {
+    /** 当前页字段名，默认 'currentPage' */
+    pageField: string;
+    /** 每页条数字段名，默认 'pageSize' */
+    sizeField: string;
+    /** 搜索条件外层字段名，默认 'param' */
+    searchField: string;
+}
+export interface TransformConfig {
+    /** 请求拦截器（加 token 等），返回处理后的 axios config */
+    requestInterceptor?: (config: any) => any;
+    /** 响应拦截器 */
+    responseInterceptor?: (response: any) => any;
+}
+export interface RequestConfig {
+    /** 接口地址前缀 */
+    urlPrefix: string;
+    /** 网络异常是否抛出 */
+    throwException: boolean;
+    loading: RequestLoadingConfig;
+    /** 透传给 axios 的配置（headers、timeout、withCredentials 等） */
+    axiosConfig: Record<string, any>;
+    pageParam: PageParamConfig;
+    transform: TransformConfig;
+}
+export interface ResponsePropsConfig {
+    codeName: string;
+    messageName: string;
+    dataName: string;
+}
+export interface ResponseListConfig {
+    listName: string;
+    totalName: string;
+    pageSizeName: string;
+    currentPageName: string;
+}
+export interface TipsConfig {
+    /** 提示类型：success/warning/error/info/message/notify/none */
+    tipsType: string;
+    /** 是否显示提示 */
+    showTips?: boolean;
+    /** 透传给 ElMessage/ElNotification 的属性 */
+    props?: Record<string, any>;
+}
+export interface ResponseConfig {
+    props: ResponsePropsConfig;
+    /** code >= successCode 视为成功（负数为失败） */
+    successCode: number;
+    list: ResponseListConfig;
+    success: TipsConfig;
+    fail: TipsConfig;
+    exception: TipsConfig;
+    complete: {
+        tipsType: string;
+    };
+}
+export interface PagerConfig {
+    size: number;
+    pageSizes: number[];
+    pageSize: number;
+    layout: string;
+    hideOnSinglePage: boolean;
+}
+export interface PageConfig {
+    /** 全局尺寸：large/default/small */
+    global: {
+        size: string;
+    };
+    /** 按组件类型的默认配置，key 为组件 PascalName，如 WdDatagrid */
+    componentDefault: Record<string, any>;
+    pager: PagerConfig;
+}
+export interface ThemeConfig {
+    /** 语义令牌覆盖（primary/success/warning/danger/info） */
+    colors?: Record<string, string>;
+    /** CSS 变量覆盖（--wd-* / --el-*），优先级高于 colors */
+    cssVars?: Record<string, string>;
+}
+export interface WorkDesktopConfig {
+    page: PageConfig;
+    request: RequestConfig;
+    response: ResponseConfig;
+    theme: ThemeConfig;
+}
+/** 请求级覆盖项（PRD 5.1 reqOptions） */
+export interface ReqOptions {
+    /** 是否显示 loading */
+    showLoading?: boolean;
+    /** 是否显示提示 */
+    showTips?: boolean;
+    /** 提示配置覆盖 */
+    tipsConfig?: Partial<Record<'success' | 'fail' | 'exception', TipsConfig>>;
+    /** 透传给 axios 的单次配置 */
+    axiosConfig?: Record<string, any>;
+    /** AbortSignal，用于中断 */
+    signal?: AbortSignal;
+    /** 是否列表请求（影响封包分页参数与解封列表结构），由调用方组件控制，http 不强制 */
+    [key: string]: any;
+}

package/dist/types/src/types/index.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 类型汇总导出
+ */
+export type * from './config';

package/dist/types/vite.config.d.ts

@@ -0,0 +1,2 @@
+declare const _default: import("vite").UserConfig;
+export default _default;

package/package.json

@@ -0,0 +1,68 @@
+{
+  "name": "workdesktop-ai",
+  "version": "1.0.0",
+  "description": "WorkDesktop 企业级 Vue3 组件库（基于 ElementPlus，HTML 模板渲染友好、AI 编码友好）",
+  "type": "module",
+  "main": "dist/index.umd.js",
+  "module": "dist/index.esm.js",
+  "types": "dist/types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/index.d.ts",
+      "import": "./dist/index.esm.js",
+      "require": "./dist/index.umd.js"
+    },
+    "./style.css": "./dist/style.css"
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "scripts": {
+    "dev": "vite",
+    "build": "vite build && npm run build:types",
+    "build:lib": "vite build",
+    "build:types": "vue-tsc --declaration --emitDeclarationOnly --outDir dist/types",
+    "typecheck": "vue-tsc --noEmit",
+    "preview": "vite preview",
+    "docs:dev": "vite --config docs/vite.config.ts",
+    "docs:build": "vite build --config docs/vite.config.ts",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage"
+  },
+  "keywords": [
+    "vue3",
+    "element-plus",
+    "component-library",
+    "workdesktop",
+    "datagrid",
+    "dataform"
+  ],
+  "license": "MIT",
+  "peerDependencies": {
+    "@element-plus/icons-vue": "^2.0.0",
+    "element-plus": "^2.5.0",
+    "vue": "^3.3.0"
+  },
+  "dependencies": {
+    "axios": "^1.7.7"
+  },
+  "devDependencies": {
+    "@element-plus/icons-vue": "^2.3.1",
+    "@types/node": "^22.7.0",
+    "@vitejs/plugin-vue": "^5.1.4",
+    "@vitest/coverage-v8": "^2.1.9",
+    "@vue/test-utils": "^2.5.0",
+    "element-plus": "^2.8.4",
+    "happy-dom": "^20.14.0",
+    "typescript": "~5.6.2",
+    "vite": "^5.4.8",
+    "vitest": "^2.1.9",
+    "vue": "^3.5.10",
+    "vue-router": "^4.6.4",
+    "vue-tsc": "^2.1.6"
+  }
+}