vite-plugin-mock-dev-server 2.0.7 → 2.1.0

package/dist/{types-C8ZwTU-4.d.mts → config-7dnQWJSY.d.ts}

@@ -1,27 +1,15 @@
 import { CorsOptions } from "cors";
 import { Options } from "co-body";
 import formidable from "formidable";
-import http, { IncomingMessage, ServerResponse } from "node:http";
-import crypto from "node:crypto";
+import http from "node:http";
 import { Buffer } from "node:buffer";
 import { WebSocketServer } from "ws";
 import { Readable } from "node:stream";
 import { Connect } from "vite";
 
-//#region src/cookies/Keygrip.d.ts
-declare class Keygrip {
-  private algorithm;
-  private encoding;
-  private keys;
-  constructor(keys: string[], algorithm?: string, encoding?: crypto.BinaryToTextEncoding);
-  sign(data: string, key?: string): string;
-  index(data: string, digest: string): number;
-  verify(data: string, digest: string): boolean;
-}
-//#endregion
-//#region src/cookies/types.d.ts
+//#region src/types/cookies.d.ts
 interface CookiesOption {
-  keys?: string[] | Keygrip;
+  keys?: string[];
   secure?: boolean;
 }
 interface SetCookieOption {
@@ -119,18 +107,422 @@ interface GetCookieOption {
   signed: boolean;
 }
 //#endregion
-//#region src/cookies/Cookies.d.ts
-declare class Cookies {
-  request: IncomingMessage;
-  response: ServerResponse<IncomingMessage>;
-  secure: boolean | undefined;
-  keys: Keygrip | undefined;
-  constructor(req: IncomingMessage, res: ServerResponse<IncomingMessage>, options?: CookiesOption);
-  set(name: string, value?: string | null, options?: SetCookieOption): this;
-  get(name: string, options?: GetCookieOption): string | void;
+//#region src/types/http.d.ts
+type Method = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "TRACE" | "OPTIONS";
+type Headers = http.IncomingHttpHeaders;
+type ResponseBody = Record<string, any> | any[] | string | number | Readable | Buffer | null;
+/**
+* 扩展 request，添加额外的属性和方法
+*/
+interface ExtraRequest {
+  /**
+  * The query string located after `?` in the request address has been parsed into JSON.
+  *
+  * 请求地址中位于 `?` 后面的 queryString，已解析为 json
+  */
+  query: Record<string, any>;
+  /**
+  * The queryString located after `?` in the referer request has been parsed as JSON.
+  *
+  * 请求 referer 中位于 `?` 后面的 queryString，已解析为 json
+  */
+  refererQuery: Record<string, any>;
+  /**
+  * Body data in the request
+  *
+  * 请求体中 body 数据
+  */
+  body: Record<string, any>;
+  /**
+  * The params parameter parsed from the `/api/id/:id` in the request address.
+  *
+  * 请求地址中，`/api/id/:id` 解析后的 params 参数
+  */
+  params: Record<string, any>;
+  /**
+  * headers data in the request
+  * 请求体中 headers
+  */
+  headers: Headers;
+  /**
+  * Get the cookie carried in the request.
+  *
+  * 获取 请求中携带的 cookie
+  * @see [cookies](https://github.com/pillarjs/cookies#cookiesgetname--options)
+  */
+  getCookie: (name: string, options?: GetCookieOption) => string | void;
 }
+type MockRequest = Connect.IncomingMessage & ExtraRequest;
+type MockResponse = http.ServerResponse<http.IncomingMessage> & {
+  /**
+  * Set cookie in response
+  *
+  * 向请求响应中设置 cookie
+  * @see [cookies](https://github.com/pillarjs/cookies#cookiessetname--values--options)
+  */
+  setCookie: (name: string, value: string, options?: SetCookieOption) => void;
+};
 //#endregion
-//#region src/types.d.ts
+//#region src/types/record.d.ts
+/**
+* Record configuration options
+*
+* 录制配置选项
+*/
+interface RecordOptions {
+  /**
+  * Whether to enable the record feature
+  * - true: Enable, automatically record proxy responses
+  * - false: Disable (default)
+  *
+  * 是否启用录制功能
+  * - true: 启用，自动录制 proxy 响应
+  * - false: 禁用（默认）
+  *
+  * @default false
+  */
+  enabled?: boolean;
+  /**
+  * Filter requests to record
+  * - Function: Custom filter function, return true to record
+  * - Object: Include/exclude patterns with glob or path-to-regexp mode
+  *
+  * 过滤要录制的请求
+  * - 函数：自定义过滤函数，返回 true 表示录制
+  * - 对象：包含/排除模式，支持 glob 或 path-to-regexp 模式
+  *
+  * @example
+  * ```ts
+  * // Record all requests
+  * filter: (req) => true
+  * // Record requests using glob pattern
+  * filter: { mode: 'glob', include: '/api/**' }
+  * // Record requests using path-to-regexp pattern
+  * filter: { mode: 'path-to-regexp', include: '/api/:id' }
+  * ```
+  */
+  filter?: ((req: RecordedReq) => boolean) | {
+    /**
+    * Include the request links that need to be recorded
+    *
+    * String: Glob pattern or path-to-regexp pattern
+    * (Use the mode option to set the mode, default is glob)
+    *
+    * 包含需要录制的请求链接
+    *
+    * glob 模式或 path-to-regexp 模式
+    * (使用 mode 选项设置模式，默认为 glob)
+    */
+    include?: string | string[];
+    /**
+    * Exclude request links that do not need to be recorded
+    *
+    * String: Glob pattern or path-to-regexp pattern
+    * (Use the mode option to set the mode, default is glob)
+    *
+    * 排除不需要录制的请求链接
+    *
+    * glob 模式或 path-to-regexp 模式
+    * (使用 mode 选项设置模式，默认为 glob)
+    */
+    exclude?: string | string[];
+    /**
+    * Matching mode for include/exclude patterns
+    * - 'glob': Glob pattern matching (default)
+    * - 'path-to-regexp': Path-to-regexp pattern matching
+    *
+    * 包含/排除模式的匹配模式
+    * - 'glob': glob 模式匹配（默认）
+    * - 'path-to-regexp': path-to-regexp 模式匹配
+    */
+    mode: "glob" | "path-to-regexp";
+  };
+  /**
+  * Directory to store recorded data
+  * Relative to project root
+  *
+  * 录制数据存储目录
+  * 相对于项目根目录
+  *
+  * @default 'mock/.recordings'
+  */
+  dir?: string;
+  /**
+  * Whether to overwrite existing recorded data
+  * - true: Overwrite old data for the same request (default)
+  * - false: Keep old data, do not record new data
+  *
+  * 是否覆盖已有录制数据
+  * - true: 相同请求覆盖旧数据（默认）
+  * - false: 保留旧数据，不录制新数据
+  *
+  * @default true
+  */
+  overwrite?: boolean;
+  /**
+  * Expiration time for recorded data in seconds
+  * - 0: Never expire (default)
+  * - Positive number: Expire after specified seconds
+  *
+  * 录制数据过期时间（秒）
+  * - 0: 永不过期（默认）
+  * - 正数：指定秒数后过期
+  *
+  * @default 0
+  */
+  expires?: number;
+  /**
+  * Status codes to record
+  * - Empty array: Record all status codes (default)
+  * - Specify one or more status codes to filter
+  *
+  * 要录制的状态码
+  * - 为空数组时记录所有状态码（默认）
+  * - 指定一个或多个状态码进行过滤
+  *
+  * @default []
+  */
+  status?: number | number[];
+  /**
+  * Should a .gitignore be added to the recording directory
+  * - true: Add (default)
+  * - false: Do not add
+  *
+  * 是否在录制目录中添加 .gitignore
+  * - true: 添加（默认）
+  * - false: 不添加
+  *
+  * @default true
+  */
+  gitignore?: boolean;
+}
+interface RecordedMeta {
+  /**
+  * Recording timestamp
+  *
+  * 录制数据创建时间戳
+  */
+  timestamp: number;
+  /**
+  * Recorded data create time
+  *
+  * 录制数据创建时间
+  */
+  createAt: string;
+  /**
+  * Recorded data file path
+  *
+  * 录制数据文件路径
+  */
+  filepath: string;
+  /**
+  * Reference the source of the original request
+  *
+  * 对原始请求的来源引用
+  */
+  referer?: string;
+}
+interface RecordedReq {
+  /**
+  * Request method
+  *
+  * 请求方法
+  */
+  method: string;
+  /**
+  * Request pathname
+  *
+  * 请求路径
+  */
+  pathname: string;
+  /**
+  * Request query parameters
+  *
+  * 请求参数
+  */
+  query: Record<string, any>;
+  /**
+  * Request body
+  *
+  * 请求体
+  */
+  body: unknown;
+  /**
+  * Request body type
+  *
+  * 请求体类型
+  */
+  bodyType: string;
+}
+interface RecordedRes {
+  /**
+  * Response status code
+  *
+  * 响应状态码
+  */
+  status: number;
+  /**
+  * Response status text
+  *
+  * 响应状态文本
+  */
+  statusText: string;
+  /**
+  * Response headers
+  *
+  * 响应头
+  */
+  headers: Record<string, string>;
+  /**
+  * Response body
+  *
+  * 响应体
+  */
+  body: string;
+}
+/**
+* Recorded request data structure
+*
+* 录制的请求数据结构
+*/
+interface RecordedRequest {
+  /**
+  * Recorded request metadata
+  *
+  * 录制请求元数据
+  */
+  meta: RecordedMeta;
+  /**
+  * Recorded request data
+  *
+  * 录制请求数据
+  */
+  req: RecordedReq;
+  /**
+  * Recorded response data
+  *
+  * 录制响应数据
+  */
+  res: RecordedRes;
+}
+/**
+* Resolved record options with all fields required
+*
+* 解析后的录制配置选项，所有字段为必填
+*/
+interface ResolvedRecordOptions extends Omit<Required<RecordOptions>, "status"> {
+  cwd: string;
+  status: number[];
+}
+//#endregion
+//#region src/types/options.d.ts
+type BodyParserOptions = Options & {
+  jsonLimit?: string | number;
+  formLimit?: string | number;
+  textLimit?: string | number;
+};
+type LogType = "info" | "warn" | "error" | "debug";
+type LogLevel = LogType | "silent";
+interface ServerBuildOption {
+  /**
+  * Service startup port
+  *
+  * 服务启动端口
+  * @default 8080
+  */
+  serverPort?: number;
+  /**
+  * Service application output directory
+  *
+  * 服务应用输出目录
+  * @default 'dist/mockServer'
+  */
+  dist?: string;
+  /**
+  * Service application log level
+  *
+  * 服务应用日志级别
+  * @default 'error'
+  */
+  log?: LogLevel;
+  /**
+  * Whether to include record files in the build output
+  *
+  * 是否在构建输出中包含录制文件
+  *
+  * @default true
+  */
+  includeRecord?: boolean;
+}
+interface MockMatchPriority {
+  /**
+  * The priority of matching rules is global.
+  * The rules declared in this option will take priority over the default rules.
+  * The higher the position of the rule in the array, the higher the priority.
+  *
+  * Do not declare general rules in this option, such as /api/(.*),
+  * as it will prevent subsequent rules from taking effect.
+  * Unless you are clear about the priority of the rules,
+  * most of the time you do not need to configure this option.
+  *
+  * 匹配规则优先级, 全局生效。
+  * 声明在该选项中的规则将优先于默认规则生效。
+  * 规则在数组越靠前的位置，优先级越高。
+  *
+  * 不要在此选项中声明通用性的规则，比如 `/api/(.*)`，这将导致后续的规则无法生效。
+  * 除非你明确知道规则的优先级，否则大多数情况下都不需要配置该选项。
+  * @default []
+  */
+  global?: string[];
+  /**
+  * For some special cases where the priority of certain rules needs to be adjusted,
+  * this option can be used. For example, when a request matches both Rule A and Rule B,
+  * and Rule A has a higher priority than Rule B, but it is desired for Rule B to take effect.
+  *
+  * 对于一些特殊情况，需要调整部分规则的优先级，可以使用此选项。
+  * 比如一个请求同时命中了规则 A 和 B，且 A 比 B 优先级高， 但期望规则 B 生效时。
+  *
+  * @example
+  * ```ts
+  * {
+  *   special: {
+  *     // /api/a/:b/c 优先级将提升到 /api/a/b/:c 前面
+  *     // The /api/a/:b/c priority is promoted to /api/a/b/:c
+  *     '/api/a/:b/c': ['/api/a/b/:c'],
+  *     // 仅在请求满足 /api/a/b/c 时生效
+  *     // Only when the request satisfies /api/a/b/c
+  *     '/api/:a/b/c': {
+  *        rules: ['/api/a/:b/c'],
+  *        when: ['/api/a/b/c']
+  *      }
+  *   }
+  * }
+  * ```
+  */
+  special?: MockMatchSpecialPriority;
+}
+interface MockMatchSpecialPriority {
+  /**
+  * When both A and B or C match, and B or C is at the top of the sort order,
+  * insert A into the top position.The `when` option is used to further constrain
+  * the priority adjustment to be effective only for certain requests.
+  *
+  * 当 A 与 B或 C 同时满足匹配，`B` 或 `C` 在排序首位时，将A插入到首位。
+  * when 选项用于进一步约束该优先级调整仅针对哪些请求有效。
+  *
+  * @example
+  * ```ts
+  * {
+  *   A: ['B', 'C'],
+  *   A: { rules: ['B', 'C'], when: ['/api/a/b/c'] }
+  * }
+  * ```
+  */
+  [key: string]: string[] | {
+    rules: string[];
+    when: string[];
+  };
+}
 /**
 * Configure plugin
 *
@@ -162,6 +554,13 @@ interface MockServerPluginOptions {
   */
   wsPrefix?: string | string[];
   /**
+  * Whether to enable mock server
+  *
+  * 是否开启 mock 服务
+  * @default true
+  */
+  enabled?: boolean;
+  /**
   * Configure the matching context for `include` and `exclude`.
   *
   * 配置 `include` 和 `exclude` 的匹配上下文
@@ -268,158 +667,38 @@ interface MockServerPluginOptions {
   * ```
   */
   priority?: MockMatchPriority;
-}
-interface MockMatchPriority {
-  /**
-  * The priority of matching rules is global.
-  * The rules declared in this option will take priority over the default rules.
-  * The higher the position of the rule in the array, the higher the priority.
-  *
-  * Do not declare general rules in this option, such as /api/(.*),
-  * as it will prevent subsequent rules from taking effect.
-  * Unless you are clear about the priority of the rules,
-  * most of the time you do not need to configure this option.
-  *
-  * 匹配规则优先级, 全局生效。
-  * 声明在该选项中的规则将优先于默认规则生效。
-  * 规则在数组越靠前的位置，优先级越高。
-  *
-  * 不要在此选项中声明通用性的规则，比如 `/api/(.*)`，这将导致后续的规则无法生效。
-  * 除非你明确知道规则的优先级，否则大多数情况下都不需要配置该选项。
-  * @default []
-  */
-  global?: string[];
   /**
-  * For some special cases where the priority of certain rules needs to be adjusted,
-  * this option can be used. For example, when a request matches both Rule A and Rule B,
-  * and Rule A has a higher priority than Rule B, but it is desired for Rule B to take effect.
+  * Record and replay configuration
+  * Can be abbreviated as: record: true
   *
-  * 对于一些特殊情况，需要调整部分规则的优先级，可以使用此选项。
-  * 比如一个请求同时命中了规则 A 和 B，且 A 比 B 优先级高， 但期望规则 B 生效时。
+  * 录制回放配置
+  * 可简写为：record: true
   *
+  * @default false
   * @example
   * ```ts
-  * {
-  *   special: {
-  *     // /api/a/:b/c 优先级将提升到 /api/a/b/:c 前面
-  *     // The /api/a/:b/c priority is promoted to /api/a/b/:c
-  *     '/api/a/:b/c': ['/api/a/b/:c'],
-  *     // 仅在请求满足 /api/a/b/c 时生效
-  *     // Only when the request satisfies /api/a/b/c
-  *     '/api/:a/b/c': {
-  *        rules: ['/api/a/:b/c'],
-  *        when: ['/api/a/b/c']
-  *      }
-  *   }
+  * // Enable with default settings
+  * record: true
+  *
+  * // Or with custom configuration
+  * record: {
+  *   enabled: true,
+  *   dir: 'mock/.recordings',
+  *   overwrite: true,
+  *   sensitiveFields: ['password', 'token']
   * }
   * ```
   */
-  special?: MockMatchSpecialPriority;
-}
-interface MockMatchSpecialPriority {
+  record?: boolean | RecordOptions;
   /**
-  * When both A and B or C match, and B or C is at the top of the sort order,
-  * insert A into the top position.The `when` option is used to further constrain
-  * the priority adjustment to be effective only for certain requests.
+  * Replay recorded requests, default enabled when record enabled
   *
-  * 当 A 与 B或 C 同时满足匹配，`B` 或 `C` 在排序首位时，将A插入到首位。
-  * when 选项用于进一步约束该优先级调整仅针对哪些请求有效。
-  *
-  * @example
-  * ```ts
-  * {
-  *   A: ['B', 'C'],
-  *   A: { rules: ['B', 'C'], when: ['/api/a/b/c'] }
-  * }
-  * ```
+  * 回放已记录的请求，默认请求录制启用时自动启用回放功能
   */
-  [key: string]: string[] | {
-    rules: string[];
-    when: string[];
-  };
+  replay?: boolean;
 }
-type BodyParserOptions = Options & {
-  jsonLimit?: string | number;
-  formLimit?: string | number;
-  textLimit?: string | number;
-};
-interface ServerBuildOption {
-  /**
-  * Service startup port
-  *
-  * 服务启动端口
-  * @default 8080
-  */
-  serverPort?: number;
-  /**
-  * Service application output directory
-  *
-  * 服务应用输出目录
-  * @default 'dist/mockServer'
-  */
-  dist?: string;
-  /**
-  * Service application log level
-  *
-  * 服务应用日志级别
-  * @default 'error'
-  */
-  log?: LogLevel;
-}
-type Method = "GET" | "POST" | "PUT" | "DELETE" | "PATCH" | "HEAD" | "TRACE" | "OPTIONS";
-type Headers = http.IncomingHttpHeaders;
-type ResponseBody = Record<string, any> | any[] | string | number | Readable | Buffer | null;
-/**
-* 扩展 request，添加额外的属性和方法
-*/
-interface ExtraRequest {
-  /**
-  * The query string located after `?` in the request address has been parsed into JSON.
-  *
-  * 请求地址中位于 `?` 后面的 queryString，已解析为 json
-  */
-  query: Record<string, any>;
-  /**
-  * The queryString located after `?` in the referer request has been parsed as JSON.
-  *
-  * 请求 referer 中位于 `?` 后面的 queryString，已解析为 json
-  */
-  refererQuery: Record<string, any>;
-  /**
-  * Body data in the request
-  *
-  * 请求体中 body 数据
-  */
-  body: Record<string, any>;
-  /**
-  * The params parameter parsed from the `/api/id/:id` in the request address.
-  *
-  * 请求地址中，`/api/id/:id` 解析后的 params 参数
-  */
-  params: Record<string, any>;
-  /**
-  * headers data in the request
-  * 请求体中 headers
-  */
-  headers: Headers;
-  /**
-  * Get the cookie carried in the request.
-  *
-  * 获取 请求中携带的 cookie
-  * @see [cookies](https://github.com/pillarjs/cookies#cookiesgetname--options)
-  */
-  getCookie: Cookies["get"];
-}
-type MockRequest = Connect.IncomingMessage & ExtraRequest;
-type MockResponse = http.ServerResponse<http.IncomingMessage> & {
-  /**
-  * Set cookie in response
-  *
-  * 向请求响应中设置 cookie
-  * @see [cookies](https://github.com/pillarjs/cookies#cookiessetname--values--options)
-  */
-  setCookie: Cookies["set"];
-};
+//#endregion
+//#region src/types/basicConfig.d.ts
 type ResponseBodyFn = (request: MockRequest) => ResponseBody | Promise<ResponseBody>;
 type ResponseHeaderFn = (request: MockRequest) => Headers | Promise<Headers>;
 type CookieValue = string | [string, SetCookieOption];
@@ -428,16 +707,16 @@ type ResponseCookiesFn = (request: MockRequest) => ResponseCookies | Promise<Res
 interface MockBaseItem {
   /**
   * The interface address that needs to be mocked,
-  * supported by `path-to-regexp` for path matching.
+  * supported by `path-to-regexp@8.3.0` for path matching.
   *
-  * 需要进行 mock 的接口地址, 由 `path-to-regexp` 提供路径匹配支持
+  * 需要进行 mock 的接口地址, 由 `path-to-regexp@8.3.0` 提供路径匹配支持
   * @see [path-to-regexp](https://github.com/pillarjs/path-to-regexp)
   * @example
   * ```txt
   * /api/login
   * /api/post/:id
-  * /api/post/:id
-  * /api/anything/(.*)
+  * /api/users{/:id}
+  * /api/files/*path
   * ```
   */
   url: string;
@@ -468,6 +747,38 @@ interface MockBaseItem {
   */
   log?: boolean | LogLevel;
 }
+//#endregion
+//#region src/types/httpConfig.d.ts
+interface MockErrorConfig {
+  /**
+  * Error probability (0-1), default is 0.5
+  *
+  * 错误概率（0-1），默认 0.5
+  * @default 0.5
+  */
+  probability?: number;
+  /**
+  * Error status code, default is 500
+  *
+  * 错误状态码，默认 500
+  * @default 500
+  */
+  status?: number;
+  /**
+  * Error status text
+  *
+  * 错误状态文本
+  */
+  statusText?: string;
+  /**
+  * Custom error response body, suitable for when the status is 200, but the response body needs to simulate an error scenario
+  *
+  * 自定义错误响应体，适用于 status 为 200，但响应体需要模拟错误场景
+  * @example
+  * { code: 500, msg: 'Internal Server Error', result: null }
+  */
+  body?: ResponseBody | ResponseBodyFn;
+}
 interface MockHttpItem extends MockBaseItem {
   /**
   * The interface allows request methods, and by default allows both GET and POST.
@@ -648,8 +959,26 @@ interface MockHttpItem extends MockBaseItem {
   * ```
   */
   validator?: Partial<Omit<ExtraRequest, "getCookie">> | ((request: ExtraRequest) => boolean);
+  /**
+  * Configure error simulation
+  *
+  * 配置错误模拟
+  * @example
+  * ```ts
+  * export default {
+  *   error: {
+  *     probability: 0.5,
+  *     status: 500,
+  *     message: 'Internal Server Error'
+  *   }
+  * }
+  * ```
+  */
+  error?: MockErrorConfig;
   ws?: false;
 }
+//#endregion
+//#region src/types/wsConfig.d.ts
 interface MockWebsocketItem extends MockBaseItem {
   ws: true;
   /**
@@ -694,9 +1023,8 @@ interface WebSocketSetupContext {
   */
   onCleanup: (cleanup: () => void) => void;
 }
+//#endregion
+//#region src/types/config.d.ts
 type MockOptions = (MockHttpItem | MockWebsocketItem)[];
-type FormidableFile = formidable.File | formidable.File[];
-type LogType = "info" | "warn" | "error" | "debug";
-type LogLevel = LogType | "silent";
 //#endregion
-export { WebSocketSetupContext as _, LogType as a, MockMatchPriority as c, MockRequest as d, MockResponse as f, ServerBuildOption as g, ResponseBody as h, LogLevel as i, MockMatchSpecialPriority as l, MockWebsocketItem as m, ExtraRequest as n, Method as o, MockServerPluginOptions as p, FormidableFile as r, MockHttpItem as s, BodyParserOptions as t, MockOptions as u };
+export { MockResponse as C, SetCookieOption as D, GetCookieOption as E, MockRequest as S, CookiesOption as T, RecordedRes as _, MockHttpItem as a, Headers as b, LogType as c, MockServerPluginOptions as d, ServerBuildOption as f, RecordedRequest as g, RecordedReq as h, MockErrorConfig as i, MockMatchPriority as l, RecordedMeta as m, MockWebsocketItem as n, BodyParserOptions as o, RecordOptions as p, WebSocketSetupContext as r, LogLevel as s, MockOptions as t, MockMatchSpecialPriority as u, ResolvedRecordOptions as v, ResponseBody as w, Method as x, ExtraRequest as y };