rspack-plugin-mock 2.0.0 → 2.1.0

package/dist/{options-Bd0PSZeT.js → options-CI0LRpJZ.js}

@@ -1,8 +1,8 @@
-import { a as processRawData, c as normalizePath, f as getPackageDepList, i as processMockData, l as vfs, m as createMatcher, p as getPackageDeps, u as createLogger } from "./ws-BcLCWVaK.js";
+import { c as processRawData, d as normalizePath, f as vfs, h as createMatcher, m as getPackageDeps, p as getPackageDepList, s as processMockData, t as createLogger } from "./logger-CzeuHKAL.js";
 import { createRequire } from "node:module";
-import { attemptAsync, isBoolean, isPlainObject, toArray, uniq } from "@pengzhanbo/utils";
 import path from "node:path";
 import process from "node:process";
+import { attemptAsync, isBoolean, isPlainObject, toArray, uniq } from "@pengzhanbo/utils";
 import * as rspackCore from "@rspack/core";
 import fs, { promises } from "node:fs";
 import fsp from "node:fs/promises";
@@ -272,7 +272,7 @@ var MockCompiler = class extends EventEmitter {
 //#endregion
 //#region package.json
 var name = "rspack-plugin-mock";
-var version = "2.0.0";
+var version = "2.1.0";
 //#endregion
 //#region src/build/packageJson.ts
 function generatePackageJson(options, externals) {
@@ -362,6 +362,7 @@ async function writeMockEntryFile(entryFile, files, cwd, dir) {
 //#endregion
 //#region src/build/generate.ts
 async function buildMockServer(options, outputDir) {
+	const buildOptions = options.build;
 	const entryFile = path.resolve(process.cwd(), "node_modules/.cache/mock-server/mock-server.ts");
 	const { pattern, ignore } = createMatcher(options.include, options.exclude);
 	await writeMockEntryFile(entryFile, await glob(pattern, {
@@ -389,6 +390,16 @@ async function buildMockServer(options, outputDir) {
 			source: generatePackageJson(options, externals)
 		}
 	];
+	if (options.record.enabled && buildOptions.includeRecord) {
+		const files = await glob(path.join(options.record.dir, "**/*.json"), {
+			cwd: options.cwd,
+			dot: true
+		});
+		for (const file of files) outputList.push({
+			filename: path.join(outputDir, file),
+			source: await fsp.readFile(path.join(options.cwd, file), "utf-8")
+		});
+	}
 	const dist = path.resolve(outputDir, options.build.dist);
 	options.logger.info(`${ansis.green("✓")} generate mock server in ${ansis.cyan(path.relative(process.cwd(), dist))}`);
 	if (!fs.existsSync(dist)) await fsp.mkdir(dist, { recursive: true });
@@ -400,8 +411,8 @@ async function buildMockServer(options, outputDir) {
 	}
 }
 //#endregion
-//#region src/options.ts
-function resolvePluginOptions({ prefix = [], wsPrefix = [], cwd, dir = "mock", include = ["**/*.mock.{js,ts,cjs,mjs,json,json5}"], exclude = [], reload = false, log = "info", cors = true, formidableOptions = {}, build = false, cookiesOptions = {}, bodyParserOptions = {}, priority = {} }, { alias, context, plugins, proxies: rawProxies }) {
+//#region src/core/options.ts
+function resolvePluginOptions({ prefix = [], wsPrefix = [], cwd, dir = "mock", include = ["**/*.mock.{js,ts,cjs,mjs,json,json5}"], exclude = [], reload = false, log = "info", cors = true, formidableOptions = {}, build = false, cookiesOptions = {}, bodyParserOptions = {}, priority = {}, activeScene = [], record = false, replay }, { alias, context, plugins, proxies: rawProxies }) {
 	const logger = createLogger("rspack:mock", isBoolean(log) ? log ? "info" : "error" : log);
 	const proxies = [...toArray(prefix), ...rawProxies];
 	const wsProxies = toArray(wsPrefix);
@@ -412,10 +423,13 @@ function resolvePluginOptions({ prefix = [], wsPrefix = [], cwd, dir = "mock", i
 		...corsOptions,
 		...cors
 	};
+	cwd = cwd || context || process.cwd();
+	const resolvedRecord = resolveRecordOptions(cwd, dir, record);
 	return {
+		enabled: true,
 		prefix,
 		wsPrefix,
-		cwd: cwd || context || process.cwd(),
+		cwd,
 		dir,
 		include,
 		exclude,
@@ -439,7 +453,34 @@ function resolvePluginOptions({ prefix = [], wsPrefix = [], cwd, dir = "mock", i
 		plugins,
 		proxies,
 		wsProxies,
-		logger
+		logger,
+		activeScene: toArray(activeScene),
+		record: resolvedRecord,
+		replay: replay ?? resolvedRecord.enabled ?? false
+	};
+}
+/**
+* Resolve record options
+*
+* 解析录制配置
+*
+* @param cwd - Current working directory / 当前工作目录
+* @param dir - Mock context directory / 模拟上下文目录
+* @param record - Record options / 录制配置
+* @returns Resolved record options / 解析后的录制配置
+*/
+function resolveRecordOptions(cwd, dir, record) {
+	const recordOptions = typeof record === "boolean" ? { enabled: record } : record;
+	const expires = recordOptions?.expires ?? 0;
+	return {
+		enabled: recordOptions?.enabled ?? false,
+		cwd,
+		dir: path.join(dir, recordOptions?.dir || ".recordings"),
+		overwrite: recordOptions?.overwrite ?? true,
+		status: toArray(recordOptions?.status).map(Number),
+		expires: expires === 0 ? Number.MAX_SAFE_INTEGER : expires * 1e3,
+		gitignore: recordOptions?.gitignore ?? true,
+		filter: recordOptions?.filter || (() => true)
 	};
 }
 //#endregion

package/dist/rsbuild.d.ts

@@ -1,7 +1,8 @@
-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-BMMGM-eD.js";
+import { DefineMockDataOptions, HeaderStream, MockData, SSEMessage, createDefineMock, createSSEStream, defineMock, defineMockData } from "./helper.js";
 import { RsbuildPlugin } from "@rsbuild/core";
 
-//#region src/rsbuild.d.ts
+//#region src/core/rsbuild.d.ts
 declare function pluginMockServer(options?: MockServerPluginOptions): RsbuildPlugin;
 //#endregion
-export { BodyParserOptions, ExtraRequest, FormidableFile, LogLevel, LogType, Method, MockHttpItem, MockMatchPriority, MockMatchSpecialPriority, MockOptions, MockRequest, MockResponse, MockServerPluginOptions, MockWebsocketItem, ResponseBody, ServerBuildOption, WebSocketSetupContext, pluginMockServer };
+export { BodyParserOptions, CookiesOption, DefineMockDataOptions, ExtraRequest, type FormidableFile, GetCookieOption, HandleFunction, HeaderStream, Headers, HttpProxyPlugin, LogLevel, LogType, Method, MockData, MockErrorConfig, type MockHttpItem, MockMatchPriority, MockMatchSpecialPriority, type MockOptions, type MockRequest, MockResponse, type MockServerPluginOptions, type MockWebsocketItem, NextFunction, NextHandleFunction, PathFilter, RecordOptions, RecordedMeta, RecordedReq, RecordedRequest, RecordedRes, ResolvedRecordOptions, ResponseBody, SSEMessage, ServerBuildOption, SetCookieOption, SimpleHandleFunction, WebSocketSetupContext, createDefineMock, createSSEStream, defineMock, defineMockData, pluginMockServer };

package/dist/rsbuild.js

@@ -1,16 +1,16 @@
-import { n as baseMiddleware, r as rewriteRequest, t as mockWebSocket } from "./ws-BcLCWVaK.js";
-import { n as buildMockServer, r as createMockCompiler, t as resolvePluginOptions } from "./options-Bd0PSZeT.js";
-import { isArray, objectEntries, toArray } from "@pengzhanbo/utils";
+import { a as rewriteRequest, i as createMockMiddleware, o as Recorder, r as mockWebSocket } from "./logger-CzeuHKAL.js";
+import { n as buildMockServer, r as createMockCompiler, t as resolvePluginOptions } from "./options-CI0LRpJZ.js";
+import { createDefineMock, createSSEStream, defineMock, defineMockData } from "./helper.js";
 import path from "node:path";
 import process from "node:process";
+import { isArray, objectEntries, toArray } from "@pengzhanbo/utils";
 import rspack from "@rspack/core";
-import ansis from "ansis";
-import { Socket } from "node:net";
-//#region src/rsbuild.ts
+//#region src/core/rsbuild.ts
 function pluginMockServer(options = {}) {
 	return {
 		name: "plugin-mock-server",
 		setup(api) {
+			if (options.enabled === false) return;
 			const rsbuildConfig = api.getRsbuildConfig();
 			const resolvedOptions = resolvePluginOptions(options, {
 				proxies: resolveConfigProxies(rsbuildConfig),
@@ -32,9 +32,29 @@ function pluginMockServer(options = {}) {
 				});
 				else mockCompiler.updateAlias(compiler.options.resolve?.alias || {});
 			});
-			api.modifyRsbuildConfig((config) => updateServerProxyConfigByHttpMock(config));
+			let recorder = null;
+			if (resolvedOptions.record.enabled) recorder = new Recorder(resolvedOptions.record);
+			function wrapProxyOptions(options) {
+				const plugins = options.plugins ??= [];
+				plugins.push((proxyServer) => proxyServer.on("proxyReq", rewriteRequest));
+				if (resolvedOptions.record.enabled && recorder) plugins.push(recorder.getPlugin());
+				return options;
+			}
+			api.modifyRsbuildConfig((config) => {
+				if (!config.server?.proxy) return;
+				if (isArray(config.server.proxy)) config.server.proxy = config.server.proxy.map((item) => item.ws ? item : wrapProxyOptions(item));
+				else if (config.server.proxy) {
+					const proxy = config.server.proxy;
+					Object.keys(proxy).forEach((key) => {
+						const target = proxy[key];
+						const options = typeof target === "string" ? { target } : target;
+						if (options.ws) return;
+						proxy[key] = wrapProxyOptions(options);
+					});
+				}
+			});
 			function initMockServer(server) {
-				server.middlewares.use(baseMiddleware(mockCompiler, resolvedOptions));
+				server.middlewares.use(createMockMiddleware(mockCompiler, resolvedOptions));
 				if (resolvedOptions.reload && api.context.action === "dev") mockCompiler.on("update", () => server.sockWrite("static-changed"));
 				if (toArray(resolvedOptions.wsPrefix).length > 0) mockWebSocket(mockCompiler, server.httpServer, resolvedOptions);
 				mockCompiler.run();
@@ -45,38 +65,6 @@ function pluginMockServer(options = {}) {
 		}
 	};
 }
-function onProxyError(err, _req, res) {
-	console.error(ansis.red(err?.stack || err.message));
-	if (!(res instanceof Socket)) res.statusCode = 500;
-	res.end();
-}
-function wrapProxyOptions(options) {
-	const { on, ...rest } = options;
-	return {
-		...rest,
-		on: {
-			...on,
-			proxyReq: (proxyReq, req, ...args) => {
-				on?.proxyReq?.(proxyReq, req, ...args);
-				rewriteRequest(proxyReq, req);
-			},
-			error: on?.error || onProxyError
-		}
-	};
-}
-function updateServerProxyConfigByHttpMock(config) {
-	if (!config.server?.proxy) return;
-	if (isArray(config.server.proxy)) config.server.proxy = config.server.proxy.map((item) => item.ws ? item : wrapProxyOptions(item));
-	else if (config.server.proxy) {
-		const proxy = config.server.proxy;
-		Object.keys(proxy).forEach((key) => {
-			const target = proxy[key];
-			const options = typeof target === "string" ? { target } : target;
-			if (options.ws) return;
-			proxy[key] = wrapProxyOptions(options);
-		});
-	}
-}
 function resolveConfigProxies(config) {
 	config.server ??= {};
 	const proxy = config.server.proxy ??= {};
@@ -89,4 +77,4 @@ function resolveConfigProxies(config) {
 	return proxies;
 }
 //#endregion
-export { pluginMockServer };
+export { createDefineMock, createSSEStream, defineMock, defineMockData, pluginMockServer };

package/dist/{server-_doRwsZm.d.ts → server-pC78IYdH.d.ts}

@@ -1,15 +1,14 @@
-import { g as ServerBuildOption, i as LogLevel, m as MockWebsocketItem, p as MockServerPluginOptions, s as MockHttpItem, u as MockOptions } from "./types-GT6M6WuI.js";
+import { a as MockWebsocketItem, c as MockHttpItem, h as ServerBuildOption, i as MockOptions, k as NextHandleFunction, m as MockServerPluginOptions, r as PathFilter, u as LogLevel, x as ResolvedRecordOptions } from "./index-BMMGM-eD.js";
+import { Arrayable } from "@pengzhanbo/utils";
 import { Compiler, RspackPluginInstance } from "@rspack/core";
 import { Matcher } from "picomatch";
-import Debug from "debug";
 import EventEmitter from "node:events";
 import { FSWatcher } from "chokidar";
 import { CorsOptions } from "cors";
-import * as http$1 from "node:http";
-import http, { Server } from "node:http";
+import { Server } from "node:http";
 import { Http2SecureServer } from "node:http2";
 
-//#region src/utils/logger.d.ts
+//#region src/core/logger.d.ts
 interface Logger {
   debug: (msg: string, level?: boolean | LogLevel) => void;
   info: (msg: string, level?: boolean | LogLevel) => void;
@@ -19,25 +18,22 @@ interface Logger {
 declare const logLevels: Record<LogLevel, number>;
 declare function createLogger(prefix: string, defaultLevel?: LogLevel): Logger;
 //#endregion
-//#region src/options.d.ts
+//#region src/core/options.d.ts
 interface ResolvedCompilerOptions {
-  alias: Record<string, false | string | (string | false)[]>;
-  proxies: (string | ((pathname: string, req: http.IncomingMessage) => boolean))[];
-  wsProxies: (string | ((pathname: string, req: http.IncomingMessage) => boolean))[];
+  alias: Record<string, Arrayable<false | string>>;
+  proxies: PathFilter[];
+  wsProxies: PathFilter[];
   plugins: RspackPluginInstance[];
   context?: string;
-  cors: false | CorsOptions;
 }
 type ResolvePluginOptions = Required<Omit<MockServerPluginOptions, "build">> & ResolvedCompilerOptions & {
   logger: Logger;
   build: false | ServerBuildOption;
+  cors: false | CorsOptions;
+  record: ResolvedRecordOptions;
+  activeScene: string[];
 };
 //#endregion
-//#region src/compiler/processData.d.ts
-declare function processRawData(rawData: (readonly [any, string])[]): (MockHttpItem | MockWebsocketItem | MockOptions)[];
-declare function processMockData(mockList: (MockHttpItem | MockWebsocketItem | MockOptions)[]): Record<string, MockOptions>;
-declare function sortByValidator(mocks: MockOptions): (MockHttpItem | MockWebsocketItem)[];
-//#endregion
 //#region src/compiler/mockCompiler.d.ts
 declare class MockCompiler extends EventEmitter {
   options: ResolvePluginOptions;
@@ -58,25 +54,53 @@ declare class MockCompiler extends EventEmitter {
   watchMockFiles(isMatch: Matcher): void;
 }
 //#endregion
-//#region src/core/mockMiddleware.d.ts
-interface BaseMiddlewareOptions extends Pick<MockServerPluginOptions, "formidableOptions" | "cookiesOptions" | "bodyParserOptions" | "priority"> {
-  proxies: (string | ((pathname: string, req: any) => boolean))[];
+//#region src/compiler/processData.d.ts
+declare function processRawData(rawData: (readonly [any, string])[]): (MockHttpItem | MockWebsocketItem | MockOptions)[];
+declare function processMockData(mockList: (MockHttpItem | MockWebsocketItem | MockOptions)[]): Record<string, MockOptions>;
+declare function sortByValidator(mocks: MockOptions): (MockHttpItem | MockWebsocketItem)[];
+//#endregion
+//#region src/mockHttp/middleware.d.ts
+interface CreateMockMiddlewareOptions extends Pick<ResolvePluginOptions, "formidableOptions" | "cookiesOptions" | "bodyParserOptions" | "priority" | "record" | "replay" | "activeScene"> {
+  proxies: PathFilter[];
   logger: Logger;
   cors: false | CorsOptions;
 }
-declare function baseMiddleware(compiler: MockCompiler, {
+/**
+* Create mock middleware
+*
+* 创建 Mock 中间件
+*
+* @param compiler - Compiler instance / 编译器实例
+* @param options - Middleware options / 中间件配置项
+* @param options.formidableOptions - Formidable options / Formidable 配置项
+* @param options.bodyParserOptions - Body parser options / 请求体解析配置项
+* @param options.proxies - Proxy paths / 代理路径
+* @param options.cookiesOptions - Cookies options / Cookies 配置项
+* @param options.logger - Logger instance / 日志实例
+* @param options.priority - Path matching priority / 路径匹配优先级
+* @param options.cors - CORS options / CORS 配置项
+* @param options.record - Record options / 录制配置项
+* @param options.replay - Replay options / 回放配置项
+* @param options.activeScene - Active scene / 活动场景
+*
+* @returns Connect middleware function / Connect 中间件函数
+*/
+declare function createMockMiddleware(compiler: MockCompiler, {
   formidableOptions,
   bodyParserOptions,
   proxies,
   cookiesOptions,
   logger,
   priority,
-  cors: corsOptions
-}: BaseMiddlewareOptions): (req: http$1.IncomingMessage, res: http$1.ServerResponse, next: (err?: any) => void) => void;
+  cors: corsOptions,
+  record,
+  replay,
+  activeScene
+}: CreateMockMiddlewareOptions): NextHandleFunction;
 //#endregion
-//#region src/core/ws.d.ts
+//#region src/mockWebsocket/server.d.ts
 interface MockSocketOptions {
-  wsProxies: (string | ((pathname: string, req: any) => boolean))[];
+  wsProxies: PathFilter[];
   cookiesOptions: MockServerPluginOptions["cookiesOptions"];
   logger: Logger;
 }
@@ -86,4 +110,4 @@ declare function mockWebSocket(compiler: MockCompiler, httpServer: Server | Http
   logger
 }: MockSocketOptions): void;
 //#endregion
-export { processMockData as a, Logger as c, baseMiddleware as i, createLogger as l, mockWebSocket as n, processRawData as o, BaseMiddlewareOptions as r, sortByValidator as s, MockSocketOptions as t, logLevels as u };
+export { processMockData as a, MockCompiler as c, createLogger as d, logLevels as f, createMockMiddleware as i, ResolvePluginOptions as l, mockWebSocket as n, processRawData as o, CreateMockMiddlewareOptions as r, sortByValidator as s, MockSocketOptions as t, Logger as u };

package/dist/server.d.ts

@@ -1,2 +1,2 @@
-import { a as processMockData, c as Logger, i as baseMiddleware, l as createLogger, n as mockWebSocket, o as processRawData, r as BaseMiddlewareOptions, s as sortByValidator, t as MockSocketOptions, u as logLevels } from "./server-_doRwsZm.js";
-export { BaseMiddlewareOptions, Logger, MockSocketOptions, baseMiddleware, createLogger, logLevels, mockWebSocket, processMockData, processRawData, sortByValidator };
+import { a as processMockData, d as createLogger, f as logLevels, i as createMockMiddleware, n as mockWebSocket, o as processRawData, r as CreateMockMiddlewareOptions, s as sortByValidator, t as MockSocketOptions, u as Logger } from "./server-pC78IYdH.js";
+export { CreateMockMiddlewareOptions, Logger, MockSocketOptions, createLogger, createMockMiddleware, logLevels, mockWebSocket, processMockData, processRawData, sortByValidator };

package/dist/server.js

@@ -1,2 +1,2 @@
-import { a as processRawData, d as logLevels, i as processMockData, n as baseMiddleware, o as sortByValidator, t as mockWebSocket, u as createLogger } from "./ws-BcLCWVaK.js";
-export { baseMiddleware, createLogger, logLevels, mockWebSocket, processMockData, processRawData, sortByValidator };
+import { c as processRawData, i as createMockMiddleware, l as sortByValidator, n as logLevels, r as mockWebSocket, s as processMockData, t as createLogger } from "./logger-CzeuHKAL.js";
+export { createLogger, createMockMiddleware, logLevels, mockWebSocket, processMockData, processRawData, sortByValidator };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "rspack-plugin-mock",
   "type": "module",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "inject api mock server to development server",
   "author": "pengzhanbo <q942450674@outlook.com> (https://github.com/pengzhanbo)",
   "license": "MIT",
@@ -59,7 +59,8 @@
   },
   "peerDependencies": {
     "@rsbuild/core": ">=2.0.0",
-    "@rspack/core": ">=2.0.0"
+    "@rspack/core": ">=2.0.0",
+    "zstd-codec": ">=0.1.5"
   },
   "peerDependenciesMeta": {
     "@rsbuild/core": {
@@ -67,6 +68,9 @@
     },
     "@rspack/core": {
       "optional": true
+    },
+    "zstd-codec": {
+      "optional": true
     }
   },
   "dependencies": {
@@ -107,7 +111,8 @@
     "husky": "^9.1.7",
     "lint-staged": "^16.4.0",
     "tsdown": "^0.21.10",
-    "typescript": "^6.0.3"
+    "typescript": "^6.0.3",
+    "zstd-codec": "^0.1.5"
   },
   "lint-staged": {
     "*": "eslint --fix"