@chatbi-v/mocks 2.1.6 → 2.1.8

package/dist/index.d.ts

@@ -0,0 +1,330 @@
+import { ApiAdapter, ApiRequestConfig, ApiEndpointConfig, StreamCallbacks } from '@chatbi-v/core';
+
+type MockMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
+type MockType = 'json' | 'sse' | 'sse-page';
+interface MockEvent {
+    event: string;
+    data: any;
+    /** Delay in ms, or a mockjs template string like '@increment(100)' */
+    delay?: number | string;
+}
+interface MockStrategy {
+    /**
+     * Process the schema and return the result.
+     * For JSON: returns the mocked object.
+     * For SSE: returns an array of formatted event strings (chunks).
+     */
+    process(config: MockConfig, requestParams?: any): any;
+}
+interface BaseMockConfig {
+    /** Optional: URL pattern if used in global interceptor */
+    url?: string;
+    /** Optional: Method if used in global interceptor */
+    method?: MockMethod;
+    /** Global delay for the request */
+    delay?: number;
+    /** Optional: HTTP status code (default: 200) */
+    status?: number;
+    /** Mock type (default: 'json') */
+    type?: MockType;
+}
+interface JsonMockConfig extends BaseMockConfig {
+    type?: 'json';
+    /** The MockJS template for the response body */
+    responseSchema: any;
+}
+interface SseMockConfig extends BaseMockConfig {
+    type: 'sse';
+    /**
+     * Dictionary of event templates.
+     * Key can be a mockjs template like 'data|3-5'
+     */
+    responseSchema: Record<string, MockEvent[]>;
+}
+interface SsePageMockConfig extends BaseMockConfig {
+    type: 'sse-page';
+    /** Dictionary of event templates */
+    responseSchema: Record<string, MockEvent[]>;
+    /** Special event for pagination metadata */
+    pageEvent: MockEvent;
+}
+type MockConfig = JsonMockConfig | SseMockConfig | SsePageMockConfig;
+type MockSchema = Record<string, MockConfig>;
+interface ChatStreamConfig {
+    _type: 'chat_stream';
+    agentName?: string;
+    plan?: string[];
+    data?: Record<string, any>;
+    timeline?: Array<{
+        log?: string | {
+            content: string;
+            level?: 'info' | 'warning' | 'error';
+            agent?: string;
+        };
+        planIndex?: number;
+        delay?: number;
+    }>;
+    content: string | Record<string, any> | ((data: any) => string | Record<string, any>);
+}
+interface HistoryStreamConfig {
+    _type: 'history_stream';
+    template: Record<string, any>;
+    prepend?: any[];
+}
+type AdvancedMockSchema = ChatStreamConfig | HistoryStreamConfig;
+interface MockGeneratorStrategy {
+    generate(schema: any): string[];
+}
+declare function createChatStream(config: Omit<ChatStreamConfig, '_type'>): ChatStreamConfig;
+declare function createHistoryStream(config: Omit<HistoryStreamConfig, '_type'>): HistoryStreamConfig;
+
+/**
+ * 基于 Mock.js 的请求适配器
+ * @description 根据 API 配置中的 responseSchema 自动生成 Mock 数据，支持普通 JSON 和流式 SSE 响应
+ */
+declare class MockAdapter implements ApiAdapter {
+    private delay;
+    private static strategies;
+    /**
+     * 构造函数
+     * @param delay 全局模拟延迟时间（毫秒），默认 300ms
+     */
+    constructor(delay?: number);
+    /**
+     * 注册自定义 Mock 生成策略
+     * @param key 策略唯一标识符 (e.g., 'chat_stream', 'history_stream')
+     * @param strategy 实现了 MockGeneratorStrategy 接口的策略实例
+     */
+    static registerStrategy(key: string, strategy: MockGeneratorStrategy): void;
+    /**
+     * 处理普通 HTTP 请求（非流式）
+     * @param config 请求配置对象
+     * @param endpointConfig API 端点配置，包含 responseSchema
+     * @returns Promise 返回模拟的响应数据
+     */
+    request<T = any>(config: ApiRequestConfig, endpointConfig?: ApiEndpointConfig): Promise<T>;
+    /**
+     * 处理流式请求 (SSE)
+     * @param config 请求配置对象
+     * @param callbacks 流式回调函数集合 (onMessage, onFinish, onError)
+     * @param endpointConfig API 端点配置，包含 responseSchema
+     */
+    stream(config: ApiRequestConfig, callbacks: StreamCallbacks, endpointConfig?: ApiEndpointConfig): Promise<void>;
+    /**
+     * 判断是否为遗留的 schema 格式
+     */
+    private isLegacySchema;
+    /**
+     * 判断是否为新版配置格式
+     * @description 检查配置对象中是否包含有效的 type 字段
+     */
+    private isNewConfig;
+    /**
+     * 生成遗留的高级 schema 数据块
+     */
+    private generateAdvancedChunks;
+}
+
+/**
+ * Mock 响应生成器
+ * @description 用于动态生成流式响应数据，支持阶段流转、日志插入和内容分块
+ */
+declare class MockResponseGenerator {
+    private events;
+    private sessionId;
+    private agentName;
+    private currentTodos;
+    constructor(agentName?: string, sessionId?: string);
+    /**
+     * 生成历史消息流
+     */
+    emitHistory(history: {
+        role: string;
+        content: string;
+        createTime: string;
+        todos?: any[];
+    }[]): this;
+    /**
+     * 初始化执行计划
+     * @param steps 计划步骤列表
+     */
+    initPlan(steps: string[]): this;
+    /**
+     * 更新执行计划状态
+     * @param activeIndex 当前正在进行的步骤索引
+     */
+    updatePlanStatus(activeIndex: number): this;
+    /**
+     * 标记所有计划为完成
+     */
+    completePlan(): this;
+    /**
+     * 添加日志
+     * @param content 日志内容
+     * @param type 日志类型
+     * @param agentName 可选的 Agent 名称
+     */
+    addLog(content: string, type?: 'info' | 'warning' | 'error', agentName?: string): this;
+    /**
+     * 添加系统错误事件
+     * @param errorCode 错误码
+     * @param errorMessage 错误信息
+     */
+    addError(errorCode: string, errorMessage: string): this;
+    /**
+     * 添加流式内容块
+     * @param content 完整内容
+     * @param chunkSize 分块大小
+     */
+    streamContent(content: string, chunkSize?: number): this;
+    /**
+     * 结束流
+     */
+    finish(): this;
+    /**
+     * 生成 A2UI 响应
+     * @param component A2UI 组件配置对象
+     */
+    emitA2UI(component: Record<string, any>): this;
+    /**
+     * 生成最终的响应字符串
+     */
+    toString(): string;
+    private pushTodos;
+    private pushEvent;
+}
+
+declare global {
+    interface Window {
+        _originalFetch: typeof fetch;
+        _originalEventSource: typeof EventSource;
+    }
+}
+declare function installFetchMock(schema: MockSchema): void;
+declare function installSSEMock(): void;
+declare function setupMock(schema: MockSchema): void;
+
+declare class ChatStreamStrategy implements MockGeneratorStrategy {
+    generate(schema: any): string[];
+}
+declare class HistoryStreamStrategy implements MockGeneratorStrategy {
+    generate(schema: any): string[];
+}
+declare class JsonStrategy implements MockStrategy {
+    process(config: MockConfig, _requestParams?: any): any;
+}
+declare class SseStrategy implements MockStrategy {
+    process(config: MockConfig, requestParams?: any): MockEvent[];
+}
+declare class SsePageStrategy implements MockStrategy {
+    process(config: MockConfig, requestParams?: any): MockEvent[];
+}
+declare const StrategyFactory: {
+    getStrategy(type?: string): MockStrategy;
+};
+
+declare const sleep: (ms: number) => Promise<unknown>;
+/**
+ * Process string templates like "{{$query.pageNo * 10}}" in object values.
+ * Supports $query (for backward compatibility), $body, and $param.
+ */
+declare function processTemplate(data: any, context: Record<string, any>): any;
+/**
+ * Flatten eventsSchema into a sorted array of events.
+ *
+ * Supports Mock.js array generation rules in keys, e.g.:
+ * { 'data|8-12': [{ event: 'data', ... }] }
+ * -> generates 8 to 12 data events.
+ */
+declare function flatEvents(eventsSchema: Record<string, MockEvent[]>, requestData?: any): MockEvent[];
+/**
+ * Convert an array of events into a ReadableStream (for SSE).
+ */
+declare function eventsToStream(events: MockEvent[]): ReadableStream;
+
+/**
+ * @file index.ts
+ * @description Mock 模块入口，导出模拟数据适配器、生成器及静态测试数据
+ * @author ChatBI Team
+ */
+/**
+ * Mock 数据模块
+ * @description 提供前端开发所需的模拟数据适配器和工具
+ */
+
+/**
+ * 模拟用户数据
+ */
+declare const MOCK_USER: {
+    id: string;
+    name: string;
+    avatar: string;
+    role: string;
+};
+declare const MOCK_SESSIONS: {
+    id: string;
+    title: string;
+    date: string;
+    lastMessage: string;
+}[];
+declare const MOCK_FAVORITES: {
+    id: string;
+    title: string;
+    date: string;
+}[];
+declare const MOCK_SCENES: {
+    id: string;
+    name: string;
+    description: string;
+    code: string;
+    creator: string;
+    createTime: string;
+    tableCount: number;
+    kbCount: number;
+    qaCount: number;
+    cover: string;
+}[];
+declare const generateMockMessages: (sessionId: string) => {
+    key: string;
+    role: string;
+    content: string;
+    time: string;
+}[];
+declare const mockData: {
+    user: {
+        id: string;
+        name: string;
+        avatar: string;
+        role: string;
+    };
+    sessions: {
+        id: string;
+        title: string;
+        date: string;
+        lastMessage: string;
+    }[];
+    favorites: {
+        id: string;
+        title: string;
+        date: string;
+    }[];
+    scenes: {
+        id: string;
+        name: string;
+        description: string;
+        code: string;
+        creator: string;
+        createTime: string;
+        tableCount: number;
+        kbCount: number;
+        qaCount: number;
+        cover: string;
+    }[];
+    favoritesList: {
+        id: string;
+        title: string;
+        date: string;
+    }[];
+};
+
+export { type AdvancedMockSchema, type BaseMockConfig, type ChatStreamConfig, ChatStreamStrategy, type HistoryStreamConfig, HistoryStreamStrategy, type JsonMockConfig, JsonStrategy, MOCK_FAVORITES, MOCK_SCENES, MOCK_SESSIONS, MOCK_USER, MockAdapter, type MockConfig, type MockEvent, type MockGeneratorStrategy, type MockMethod, MockResponseGenerator, type MockSchema, type MockStrategy, type MockType, type SseMockConfig, type SsePageMockConfig, SsePageStrategy, SseStrategy, StrategyFactory, createChatStream, createHistoryStream, eventsToStream, flatEvents, generateMockMessages, installFetchMock, installSSEMock, mockData, processTemplate, setupMock, sleep };

package/dist/index.js

@@ -1,78 +1,25 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
 // src/index.ts
-var index_exports = {};
-__export(index_exports, {
-  ChatStreamStrategy: () => ChatStreamStrategy,
-  HistoryStreamStrategy: () => HistoryStreamStrategy,
-  JsonStrategy: () => JsonStrategy,
-  MOCK_FAVORITES: () => MOCK_FAVORITES,
-  MOCK_SCENES: () => MOCK_SCENES,
-  MOCK_SESSIONS: () => MOCK_SESSIONS,
-  MOCK_USER: () => MOCK_USER,
-  MockAdapter: () => MockAdapter,
-  MockResponseGenerator: () => MockResponseGenerator,
-  SsePageStrategy: () => SsePageStrategy,
-  SseStrategy: () => SseStrategy,
-  StrategyFactory: () => StrategyFactory,
-  createChatStream: () => createChatStream,
-  createHistoryStream: () => createHistoryStream,
-  eventsToStream: () => eventsToStream,
-  flatEvents: () => flatEvents,
-  generateMockMessages: () => generateMockMessages,
-  installFetchMock: () => installFetchMock,
-  installSSEMock: () => installSSEMock,
-  mockData: () => mockData,
-  processTemplate: () => processTemplate,
-  setupMock: () => setupMock,
-  sleep: () => sleep
-});
-module.exports = __toCommonJS(index_exports);
-var import_core3 = require("@chatbi-v/core");
+import { dateUtils as dateUtils3 } from "@chatbi-v/core";
 
 // src/adapter.ts
-var import_core2 = require("@chatbi-v/core");
-var import_mockjs3 = __toESM(require("mockjs"));
+import {
+  createLogger,
+  dateUtils as dateUtils2
+} from "@chatbi-v/core";
+import Mock3 from "mockjs";
 
 // src/strategies.ts
-var import_mockjs2 = __toESM(require("mockjs"));
+import Mock2 from "mockjs";
 
 // src/generator.ts
-var import_core = require("@chatbi-v/core");
+import { dateUtils } from "@chatbi-v/core";
 var MockResponseGenerator = class {
   events = [];
   sessionId;
   agentName;
   currentTodos = [];
   constructor(agentName = "Assistant", sessionId) {
-    this.sessionId = sessionId || "conv_" + import_core.dateUtils.now();
+    this.sessionId = sessionId || "conv_" + dateUtils.now();
     this.agentName = agentName;
   }
   /**
@@ -212,8 +159,8 @@ data: ${JSON.stringify(data)}
 };
 
 // src/utils.ts
-var import_dayjs = __toESM(require("dayjs"));
-var import_mockjs = __toESM(require("mockjs"));
+import dayjs from "dayjs";
+import Mock from "mockjs";
 var sleep = (ms) => new Promise((r) => setTimeout(r, ms));
 function processTemplate(data, context) {
   if (typeof data === "string") {
@@ -250,12 +197,12 @@ function flatEvents(eventsSchema, requestData = {}) {
     $body: requestData,
     $param: requestData?.param || requestData
   };
-  import_mockjs.default.Random.extend({
+  Mock.Random.extend({
     $query: () => context.$query,
     $body: () => context.$body,
     $param: () => context.$param
   });
-  const compiled = import_mockjs.default.mock(eventsSchema);
+  const compiled = Mock.mock(eventsSchema);
   return Object.values(compiled).flat().map((event) => processTemplate(event, context)).sort((a, b) => {
     const delayA = typeof a.delay === "number" ? a.delay : parseInt(String(a.delay || 0));
     const delayB = typeof b.delay === "number" ? b.delay : parseInt(String(b.delay || 0));
@@ -272,10 +219,10 @@ function eventsToStream(events) {
       }
       (async () => {
         try {
-          const startTime = (0, import_dayjs.default)().valueOf();
+          const startTime = dayjs().valueOf();
           for (const eventItem of events) {
             const delay = typeof eventItem.delay === "number" ? eventItem.delay : parseInt(String(eventItem.delay || 0));
-            const elapsed = (0, import_dayjs.default)().valueOf() - startTime;
+            const elapsed = dayjs().valueOf() - startTime;
             const remaining = Math.max(0, delay - elapsed);
             if (remaining > 0) {
               await sleep(remaining);
@@ -301,7 +248,7 @@ var ChatStreamStrategy = class {
     const config = schema;
     const defaultName = config.agentName || "BI\u52A9\u624B";
     const generator = new MockResponseGenerator(defaultName);
-    const mockData2 = config.data ? import_mockjs2.default.mock(config.data) : {};
+    const mockData2 = config.data ? Mock2.mock(config.data) : {};
     if (config.plan) {
       generator.initPlan(config.plan);
     }
@@ -338,7 +285,7 @@ var HistoryStreamStrategy = class {
   generate(schema) {
     const config = schema;
     const generator = new MockResponseGenerator("BI\u52A9\u624B");
-    const historyMock = import_mockjs2.default.mock(config.template);
+    const historyMock = Mock2.mock(config.template);
     const fullHistory = [...config.prepend || [], ...historyMock.list || historyMock];
     generator.emitHistory(fullHistory);
     return generator.toString().split("\n\n").map((chunk) => chunk + "\n\n");
@@ -348,7 +295,7 @@ var JsonStrategy = class {
   process(config, _requestParams) {
     const jsonConfig = config;
     if (!jsonConfig.responseSchema) return {};
-    return import_mockjs2.default.mock(jsonConfig.responseSchema);
+    return Mock2.mock(jsonConfig.responseSchema);
   }
 };
 var SseStrategy = class {
@@ -370,12 +317,12 @@ var SsePageStrategy = class {
         $body: requestParams,
         $param: requestParams?.param || requestParams
       };
-      import_mockjs2.default.Random.extend({
+      Mock2.Random.extend({
         $query: () => context.$query,
         $body: () => context.$body,
         $param: () => context.$param
       });
-      let pageEvent = import_mockjs2.default.mock(ssePageConfig.pageEvent);
+      let pageEvent = Mock2.mock(ssePageConfig.pageEvent);
       pageEvent = processTemplate(pageEvent, context);
       let maxDelay = 0;
       if (events.length > 0) {
@@ -411,7 +358,7 @@ var StrategyFactory = {
 };
 
 // src/adapter.ts
-var logger = (0, import_core2.createLogger)("MockAdapter");
+var logger = createLogger("MockAdapter");
 var MockAdapter = class _MockAdapter {
   delay;
   // 遗留策略（为了兼容旧版代码）
@@ -466,7 +413,7 @@ var MockAdapter = class _MockAdapter {
             const error = new Error(`Request failed with status code ${effectiveConfig.status}`);
             error.response = {
               status: effectiveConfig.status,
-              data: import_mockjs3.default.mock(schema),
+              data: Mock3.mock(schema),
               headers: {}
             };
             reject(error);
@@ -525,10 +472,10 @@ var MockAdapter = class _MockAdapter {
             resolve();
             return;
           }
-          const requestStart = import_core2.dateUtils.now();
+          const requestStart = dateUtils2.now();
           logger.info(`[SSE Start] Request: ${config.method} ${config.url}`, {
             params: config.data || config.params,
-            time: import_core2.dateUtils.dayjs().toISOString()
+            time: dateUtils2.dayjs().toISOString()
           });
           let schema = endpointConfig.responseSchema;
           if (typeof schema === "function") {
@@ -544,7 +491,7 @@ var MockAdapter = class _MockAdapter {
           if (effectiveConfig.status !== 200) {
             const response = {
               status: effectiveConfig.status,
-              data: import_mockjs3.default.mock(schema),
+              data: Mock3.mock(schema),
               headers: {}
             };
             if (callbacks.onResponse) {
@@ -580,7 +527,7 @@ var MockAdapter = class _MockAdapter {
               config.params || config.data
             );
             if (Array.isArray(events)) {
-              const startTime = import_core2.dateUtils.now();
+              const startTime = dateUtils2.now();
               let eventCount = 0;
               logger.info(
                 `[SSE Processing] Generated ${events.length} events for ${type} strategy`
@@ -588,12 +535,12 @@ var MockAdapter = class _MockAdapter {
               for (const event of events) {
                 if (signal && signal.aborted) {
                   logger.info(
-                    `[SSE Abort] Stream aborted by user after ${import_core2.dateUtils.now() - requestStart}ms`
+                    `[SSE Abort] Stream aborted by user after ${dateUtils2.now() - requestStart}ms`
                   );
                   break;
                 }
                 const delay2 = typeof event.delay === "number" ? event.delay : parseInt(String(event.delay || 0));
-                const elapsed = import_core2.dateUtils.now() - startTime;
+                const elapsed = dateUtils2.now() - startTime;
                 const remaining = Math.max(0, delay2 - elapsed);
                 if (remaining > 0) {
                   await sleep(remaining);
@@ -622,7 +569,7 @@ data: ${JSON.stringify(event.data)}
             } else if (this.isLegacySchema(schema)) {
               chunks = this.generateAdvancedChunks(schema);
             } else {
-              const mockData2 = import_mockjs3.default.mock(schema);
+              const mockData2 = Mock3.mock(schema);
               chunks = [`data: ${JSON.stringify(mockData2)}
 
 `];
@@ -640,7 +587,7 @@ data: ${JSON.stringify(event.data)}
           }
           if (!signal || !signal.aborted) {
             logger.info(
-              `[SSE Complete] Stream finished successfully in ${import_core2.dateUtils.now() - requestStart}ms`
+              `[SSE Complete] Stream finished successfully in ${dateUtils2.now() - requestStart}ms`
             );
             if (onFinish) onFinish();
           }
@@ -813,7 +760,7 @@ var generateMockMessages = (sessionId) => [
     key: `msg_${sessionId}_1`,
     role: "assistant",
     content: `\u60A8\u597D\uFF01\u6211\u662F\u60A8\u7684\u667A\u80FD\u52A9\u624B\u3002\u5F53\u524D\u4F1A\u8BDD ID: ${sessionId}\u3002\u8BF7\u95EE\u6709\u4EC0\u4E48\u53EF\u4EE5\u5E2E\u60A8\uFF1F`,
-    time: import_core3.dateUtils.dayjs(import_core3.dateUtils.now() - 1e4).toISOString()
+    time: dateUtils3.dayjs(dateUtils3.now() - 1e4).toISOString()
   }
 ];
 var mockData = {
@@ -824,8 +771,7 @@ var mockData = {
   favoritesList: MOCK_FAVORITES
   // Alias for compatibility if needed
 };
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
+export {
   ChatStreamStrategy,
   HistoryStreamStrategy,
   JsonStrategy,
@@ -849,5 +795,4 @@ var mockData = {
   processTemplate,
   setupMock,
   sleep
-});
-//# sourceMappingURL=index.js.map
+};

package/package.json

@@ -1,15 +1,16 @@
 {
   "name": "@chatbi-v/mocks",
-  "version": "2.1.6",
+  "version": "2.1.8",
+  "type": "module",
   "main": "dist/index.cjs",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
   "files": [
     "dist"
   ],
   "publishConfig": {
     "access": "public"
   },
-  "module": "dist/index.mjs",
-  "types": "dist/index.d.ts",
   "exports": {
     ".": {
       "types": "./dist/index.d.ts",
@@ -21,13 +22,13 @@
     "mockjs": "^1.1.0",
     "dayjs": "^1.11.10",
     "react": ">=18.0.0",
-    "@chatbi-v/core": "2.1.6"
+    "@chatbi-v/core": "2.1.8"
   },
   "devDependencies": {
     "@types/mockjs": "^1.0.10",
     "tsup": "^8.5.1",
-    "@chatbi-v/cli": "2.1.6",
-    "@chatbi-v/config": "2.1.6"
+    "@chatbi-v/config": "2.1.8",
+    "@chatbi-v/cli": "2.1.8"
   },
   "scripts": {
     "build": "chatbi-cli build",