rspack-plugin-mock 2.0.0 → 2.2.0

package/dist/helper.d.ts

@@ -1,8 +1,7 @@
-import { _ as WebSocketSetupContext, a as LogType, c as MockMatchPriority, d as MockRequest, f as MockResponse, g as ServerBuildOption, h as ResponseBody, i as LogLevel, l as MockMatchSpecialPriority, m as MockWebsocketItem, n as ExtraRequest, o as Method, p as MockServerPluginOptions, r as FormidableFile, s as MockHttpItem, t as BodyParserOptions, u as MockOptions } from "./types-GT6M6WuI.js";
+import { A as ResponseBody, C as HandleFunction, D as MockResponse, E as MockRequest, M as CookiesOption, N as GetCookieOption, O as NextFunction, P as SetCookieOption, S as ExtraRequest, T as Method, _ as RecordedMeta, a as MockWebsocketItem, b as RecordedRes, c as MockHttpItem, d as LogType, f as MockMatchPriority, g as RecordOptions, h as ServerBuildOption, i as MockOptions, j as SimpleHandleFunction, k as NextHandleFunction, l as BodyParserOptions, m as MockServerPluginOptions, n as HttpProxyPlugin, o as WebSocketSetupContext, p as MockMatchSpecialPriority, r as PathFilter, s as MockErrorConfig, t as FormidableFile, u as LogLevel, v as RecordedReq, w as Headers, x as ResolvedRecordOptions, y as RecordedRequest } from "./index-BjZK24gW.js";
 import { Transform } from "node:stream";
 import { IncomingMessage, OutgoingHttpHeaders, ServerResponse } from "node:http";
-
-//#region src/helper/createSSEStream.d.ts
+//#region src/helpers/createSSEStream.d.ts
 interface SSEMessage {
   data?: string | object;
   comment?: string;
@@ -16,18 +15,18 @@ interface WriteHeaders {
 }
 type HeaderStream = NodeJS.WritableStream & WriteHeaders;
 /**
-* Transforms "messages" to W3C event stream content.
-* See https://html.spec.whatwg.org/multipage/server-sent-events.html
-* A message is an object with one or more of the following properties:
-* - data (String or object, which gets turned into JSON)
-* - event
-* - id
-* - retry
-* - comment
-*
-* If constructed with a HTTP Request, it will optimise the socket for streaming.
-* If this stream is piped to an HTTP Response, it will set appropriate headers.
-*/
+ * Transforms "messages" to W3C event stream content.
+ * See https://html.spec.whatwg.org/multipage/server-sent-events.html
+ * A message is an object with one or more of the following properties:
+ * - data (String or object, which gets turned into JSON)
+ * - event
+ * - id
+ * - retry
+ * - comment
+ *
+ * If constructed with a HTTP Request, it will optimise the socket for streaming.
+ * If this stream is piped to an HTTP Response, it will set appropriate headers.
+ */
 declare class SSEStream extends Transform {
   constructor(req: IncomingMessage);
   pipe<T extends HeaderStream>(destination: T, options?: {
@@ -39,88 +38,126 @@ declare class SSEStream extends Transform {
   destroy(error?: Error): this;
 }
 /**
-* 创建一个 Server-sent events 写入流，用于支持模拟 EventSource
-*
-* @example
-* ```ts
-* import { createSSEStream, defineMock } from 'vite-plugin-mock-dev-server'
-*
-* export default defineMock({
-*   url: '/api',
-*   response: (req, res) => {
-*     const sse = createSSEStream(req, res)
-*     sse.write({ event: 'message', data: { message: 'hello world' } })
-*   }
-* })
-* ```
-*/
+ * 创建一个 Server-sent events 写入流，用于支持模拟 EventSource
+ *
+ * @example
+ * ```ts
+ * import { createSSEStream, defineMock } from 'vite-plugin-mock-dev-server'
+ *
+ * export default defineMock({
+ *   url: '/api',
+ *   response: (req, res) => {
+ *     const sse = createSSEStream(req, res)
+ *     sse.write({ event: 'message', data: { message: 'hello world' } })
+ *   }
+ * })
+ * ```
+ */
 declare function createSSEStream(req: IncomingMessage, res: ServerResponse): SSEStream;
 //#endregion
-//#region src/helper/defineMock.d.ts
+//#region src/helpers/defineMock.d.ts
 /**
-* mock config Type helper
-*
-* mock配置 类型帮助函数
-* @param config see config docs:
-* {@link https://vite-plugin-mock-dev-server.netlify.app/guide/mock-config en-US DOC} |
-* {@link https://vite-plugin-mock-dev-server.netlify.app/zh/guide/mock-config zh-CN DOC}
-*
-* @example
-* Mock Http Request
-* ```ts
-* export default defineMock({
-*   url: '/api/example',
-*   method: ['GET', 'POST'],
-*   body: { a: 1 },
-* })
-* ```
-* ```ts
-* export default defineMock({
-*   url: '/api/example',
-*   method: 'GET',
-*   body: ({ query }) => ({ a: 1, b: query.b }),
-* })
-* ```
-* @example
-* Mock WebSocket
-* ```ts
-* export default defineMock({
-*   url: '/socket.io',
-*   ws: true,
-*   setup(wss) {
-*     wss.on('connection', (ws) => {
-*       ws.on('message', (rawData) => console.log(rawData))
-*       ws.send('data')
-*     })
-*   },
-* })
-* ```
-*/
+ * Mock config Type helper
+ *
+ * mock配置 类型帮助函数
+ * @param config see config docs:
+ * {@link https://vite-plugin-mock-dev-server.netlify.app/guide/mock-config en-US DOC} |
+ * {@link https://vite-plugin-mock-dev-server.netlify.app/zh/guide/mock-config zh-CN DOC}
+ *
+ * @example
+ * Mock Http Request
+ * ```ts
+ * export default defineMock({
+ *   url: '/api/example',
+ *   method: ['GET', 'POST'],
+ *   body: { a: 1 },
+ * })
+ * ```
+ * ```ts
+ * export default defineMock({
+ *   url: '/api/example',
+ *   method: 'GET',
+ *   body: ({ query }) => ({ a: 1, b: query.b }),
+ * })
+ * ```
+ * @example
+ * Mock WebSocket
+ * ```ts
+ * export default defineMock({
+ *   url: '/socket.io',
+ *   ws: true,
+ *   setup(wss) {
+ *     wss.on('connection', (ws) => {
+ *       ws.on('message', (rawData) => console.log(rawData))
+ *       ws.send('data')
+ *     })
+ *   },
+ * })
+ * ```
+ */
 declare function defineMock(config: MockHttpItem): MockHttpItem;
 declare function defineMock(config: MockWebsocketItem): MockWebsocketItem;
 declare function defineMock(config: MockOptions): MockOptions;
 /**
-* Return a custom defineMock function to support preprocessing of mock config.
-*
-* 返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
-* @param transformer preprocessing function
-* @example
-* ```ts
-* const definePostMock = createDefineMock((mock) => {
-*   mock.url = '/api/post/' + mock.url
-* })
-* export default definePostMock({
-*   url: 'list',
-*   body: [{ title: '1' }, { title: '2' }],
-* })
-* ```
-*/
+ * Return a custom defineMock function to support preprocessing of mock config.
+ *
+ * 返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
+ * @param transformer preprocessing function
+ * @example
+ * ```ts
+ * const definePostMock = createDefineMock((mock) => {
+ *   mock.url = '/api/post/' + mock.url
+ * })
+ * export default definePostMock({
+ *   url: 'list',
+ *   body: [{ title: '1' }, { title: '2' }],
+ * })
+ * ```
+ */
 declare function createDefineMock(transformer: (mock: MockHttpItem | MockWebsocketItem) => MockHttpItem | MockWebsocketItem | void): typeof defineMock;
 //#endregion
-//#region src/helper/defineMockData.d.ts
+//#region src/helpers/defineMockData.d.ts
+/**
+ * Options for defineMockData
+ *
+ * defineMockData 的选项
+ */
+interface DefineMockDataOptions {
+  /**
+   * Whether to persist the data value on HMR (Hot Module Replacement).
+   *
+   * 热更新时是否保持数据值
+   *
+   * @default false
+   */
+  persistOnHMR?: boolean;
+}
+/**
+ * Mock data type with getter, setter, and value property
+ *
+ * 带有 getter、setter 和 value 属性的 Mock 数据类型
+ *
+ * @template T - Type of mock data / Mock 数据的类型
+ */
 type MockData<T = any> = readonly [() => T, (val: T | ((val: T) => T | void)) => void] & {
+  /**
+   * Current value
+   *
+   * 当前值
+   */
   value: T;
 };
-declare function defineMockData<T = any>(key: string, initialData: T): MockData<T>;
+/**
+ * Define mock data with memory-based sharing mechanism
+ *
+ * 定义带有基于内存的共享机制的 Mock 数据
+ *
+ * @template T - Type of mock data / Mock 数据的类型
+ * @param key - Unique key for mock data / Mock 数据的唯一键
+ * @param initialData - Initial data value / 初始数据值
+ * @param options - Options / 选项
+ * @returns MockData object with getter, setter, and value property / 带有 getter、setter 和 value 属性的 MockData 对象
+ */
+declare function defineMockData<T = any>(key: string, initialData: T, options?: DefineMockDataOptions): MockData<T>;
 //#endregion
-export { BodyParserOptions, ExtraRequest, FormidableFile, HeaderStream, LogLevel, LogType, Method, MockData, MockHttpItem, MockMatchPriority, MockMatchSpecialPriority, MockOptions, MockRequest, MockResponse, MockServerPluginOptions, MockWebsocketItem, ResponseBody, SSEMessage, ServerBuildOption, WebSocketSetupContext, createDefineMock, createSSEStream, defineMock, defineMockData };
+export { type BodyParserOptions, type CookiesOption, DefineMockDataOptions, type ExtraRequest, type FormidableFile, type GetCookieOption, type HandleFunction, HeaderStream, type Headers, type HttpProxyPlugin, type LogLevel, type LogType, type Method, MockData, type MockErrorConfig, type MockHttpItem, type MockMatchPriority, type MockMatchSpecialPriority, type MockOptions, type MockRequest, type MockResponse, type MockServerPluginOptions, type MockWebsocketItem, type NextFunction, type NextHandleFunction, type PathFilter, type RecordOptions, type RecordedMeta, type RecordedReq, type RecordedRequest, type RecordedRes, type ResolvedRecordOptions, type ResponseBody, SSEMessage, type ServerBuildOption, type SetCookieOption, type SimpleHandleFunction, type WebSocketSetupContext, createDefineMock, createSSEStream, defineMock, defineMockData };

package/dist/helper.js

@@ -1,19 +1,8 @@
+import { deepClone, isArray, isFunction } from "@pengzhanbo/utils";
+import { createHash } from "node:crypto";
 import { Transform } from "node:stream";
-import { deepClone, deepEqual, isArray, isFunction } from "@pengzhanbo/utils";
-//#region src/helper/createSSEStream.ts
-/**
-* Transforms "messages" to W3C event stream content.
-* See https://html.spec.whatwg.org/multipage/server-sent-events.html
-* A message is an object with one or more of the following properties:
-* - data (String or object, which gets turned into JSON)
-* - event
-* - id
-* - retry
-* - comment
-*
-* If constructed with a HTTP Request, it will optimise the socket for streaming.
-* If this stream is piped to an HTTP Response, it will set appropriate headers.
-*/
+
+
 var SSEStream = class extends Transform {
 	constructor(req) {
 		super({ objectMode: true });
@@ -59,48 +48,18 @@ function dataString(data) {
 	if (typeof data === "object") return dataString(JSON.stringify(data));
 	return data.split(/\r\n|\r|\n/).map((line) => `data: ${line}\n`).join("");
 }
-/**
-* 创建一个 Server-sent events 写入流，用于支持模拟 EventSource
-*
-* @example
-* ```ts
-* import { createSSEStream, defineMock } from 'vite-plugin-mock-dev-server'
-*
-* export default defineMock({
-*   url: '/api',
-*   response: (req, res) => {
-*     const sse = createSSEStream(req, res)
-*     sse.write({ event: 'message', data: { message: 'hello world' } })
-*   }
-* })
-* ```
-*/
+
 function createSSEStream(req, res) {
 	const sse = new SSEStream(req);
 	sse.pipe(res);
 	return sse;
 }
-//#endregion
-//#region src/helper/defineMock.ts
+
+
 function defineMock(config) {
 	return config;
 }
-/**
-* Return a custom defineMock function to support preprocessing of mock config.
-*
-* 返回一个自定义的 defineMock 函数，用于支持对 mock config 的预处理。
-* @param transformer preprocessing function
-* @example
-* ```ts
-* const definePostMock = createDefineMock((mock) => {
-*   mock.url = '/api/post/' + mock.url
-* })
-* export default definePostMock({
-*   url: 'list',
-*   body: [{ title: '1' }, { title: '2' }],
-* })
-* ```
-*/
+
 function createDefineMock(transformer) {
 	const define = (config) => {
 		if (isArray(config)) config = config.map((item) => transformer(item) || item);
@@ -109,48 +68,60 @@ function createDefineMock(transformer) {
 	};
 	return define;
 }
-//#endregion
-//#region src/helper/defineMockData.ts
-/**
-* 由于插件是 分别独立对 `*.mock.*` 等文件作为单独入口进行编译的，
-* 这导致了 mock 文件编译后的依赖关系不一致，每个 mock 文件拥有独立的作用域，
-* 使得即使多个 `*.mock.*` 虽然引入了同一个 `data.ts` 文件，然而确是完全不同两份 `data`，
-* 使得对 `data` 的操作，在不同的 `*.mock.*` 文件中并不能共享。
-*
-* 为此，插件提供了一种基于 memory 的数据共享机制。
-*/
-const mockDataCache = /* @__PURE__ */ new Map();
-const responseCache = /* @__PURE__ */ new WeakMap();
+
+
+
+
+const mockDataCache =  new Map();
+
+const responseCache =  new WeakMap();
+
 const staleInterval = 70;
+
 var CacheImpl = class {
+	
 	value;
-	#initialValue;
+	
+	#hash;
+	
 	#lastUpdate;
-	constructor(value) {
+	
+	#persistOnHMR;
+	
+	constructor(value, persistOnHMR) {
 		this.value = value;
-		this.#initialValue = deepClone(value);
+		this.#hash = getHash(value);
 		this.#lastUpdate = Date.now();
+		this.#persistOnHMR = persistOnHMR ?? false;
 	}
+	
 	hotUpdate(value) {
+		if (this.#persistOnHMR) return;
 		if (Date.now() - this.#lastUpdate < staleInterval) return;
-		if (!deepEqual(value, this.#initialValue)) {
-			this.value = value;
-			this.#initialValue = deepClone(value);
+		const hash = getHash(value);
+		if (this.#hash !== hash) {
+			this.value = deepClone(value);
+			this.#hash = hash;
 			this.#lastUpdate = Date.now();
 		}
 	}
+	
+	setPersistOnHMR(persistOnHMR) {
+		if (!this.#persistOnHMR) this.#persistOnHMR = persistOnHMR;
+	}
 };
-function defineMockData(key, initialData) {
+
+function defineMockData(key, initialData, options) {
 	let cache = mockDataCache.get(key);
 	if (!cache) {
-		const newCache = new CacheImpl(initialData);
+		const newCache = new CacheImpl(initialData, options?.persistOnHMR);
 		const existing = mockDataCache.get(key);
 		if (existing) cache = existing;
 		else {
 			mockDataCache.set(key, newCache);
 			cache = newCache;
 		}
-	}
+	} else cache.setPersistOnHMR(options?.persistOnHMR ?? false);
 	cache.hotUpdate(initialData);
 	if (responseCache.has(cache)) return responseCache.get(cache);
 	const res = [() => cache.value, (val) => {
@@ -168,5 +139,8 @@ function defineMockData(key, initialData) {
 	responseCache.set(cache, res);
 	return res;
 }
-//#endregion
+function getHash(data) {
+	return createHash("sha256").update(JSON.stringify(data)).digest("hex");
+}
+
 export { createDefineMock, createSSEStream, defineMock, defineMockData };