@yeepay/request-mock 0.1.0-alpha.0

package/README.md

@@ -0,0 +1,19 @@
+# @yeepay/request-mock
+
+为 `@yeepay/request` 添加本地开发与测试 Mock。支持 glob/正则模块匹配、includes、excludes、延迟、可注入日志和未命中透传。
+
+## 安装与示例
+
+`pnpm add -D @yeepay/request-mock`
+
+```ts
+const mocked = withRequestMock(http, {
+  modules: { '/users/*': ({ url }) => ({ id: url.split('/').at(-1) }) },
+})
+```
+
+## 配置与迁移
+
+`includes` 和 `excludes` 控制启用范围，`delayMs` 模拟延迟，`logger` 由应用注入。未命中请求透传真实客户端。该包不得加入生产依赖；从 Axios Mock Adapter 迁移时改为包装公开 HttpClient。
+
+[公司飞书规范](https://yeepay.feishu.cn/docx/S67Wd9mdVokULGxIRmFcQiK8nKg)

package/dist/index.d.mts

@@ -0,0 +1,21 @@
+import { HttpClient } from "@yeepay/request";
+//#region src/index.d.ts
+type MockPattern = string | RegExp;
+interface MockContext<TBody = unknown> {
+  body?: TBody | undefined;
+  method: string;
+  url: string;
+}
+type MockHandler = unknown | ((context: MockContext) => Promise<unknown> | unknown);
+interface RequestMockOptions {
+  delayMs?: number;
+  enabled?: boolean;
+  excludes?: readonly MockPattern[];
+  includes?: readonly MockPattern[];
+  logger?: (message: string) => void;
+  modules: Readonly<Record<string, MockHandler>>;
+}
+declare function withRequestMock(client: HttpClient, options: RequestMockOptions): HttpClient;
+//#endregion
+export { MockContext, MockHandler, MockPattern, RequestMockOptions, withRequestMock };
+//# sourceMappingURL=index.d.mts.map

package/dist/index.mjs

@@ -0,0 +1,47 @@
+import picomatch from "picomatch";
+//#region src/index.ts
+function matches(value, pattern) {
+	return pattern instanceof RegExp ? pattern.test(value) : picomatch.isMatch(value, pattern);
+}
+function allowed(url, options) {
+	if ((options.excludes ?? []).some((pattern) => matches(url, pattern))) return false;
+	return (options.includes ?? ["**"]).some((pattern) => matches(url, pattern));
+}
+function wait(duration) {
+	return new Promise((resolve) => setTimeout(resolve, duration));
+}
+function withRequestMock(client, options) {
+	async function request(method, url, config = {}) {
+		if (options.enabled === false || !allowed(url, options)) return client.request(method, url, config);
+		const entry = Object.entries(options.modules).find(([pattern]) => matches(url, pattern));
+		if (!entry) return client.request(method, url, config);
+		if ((options.delayMs ?? 0) > 0) await wait(options.delayMs ?? 0);
+		options.logger?.(`[request-mock] ${method.toUpperCase()} ${url}`);
+		return typeof entry[1] === "function" ? await entry[1]({
+			body: config.body,
+			method: method.toUpperCase(),
+			url
+		}) : entry[1];
+	}
+	return {
+		request,
+		get: (url, config) => request("GET", url, config),
+		post: (url, body, config) => request("POST", url, {
+			...config,
+			body
+		}),
+		put: (url, body, config) => request("PUT", url, {
+			...config,
+			body
+		}),
+		patch: (url, body, config) => request("PATCH", url, {
+			...config,
+			body
+		}),
+		delete: (url, config) => request("DELETE", url, config)
+	};
+}
+//#endregion
+export { withRequestMock };
+
+//# sourceMappingURL=index.mjs.map

package/dist/index.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.mjs","names":[],"sources":["../src/index.ts"],"sourcesContent":["import type { HttpClient, HttpRequestConfig } from '@yeepay/request'\nimport picomatch from 'picomatch'\n\nexport type MockPattern = string | RegExp\nexport interface MockContext<TBody = unknown> {\n  body?: TBody | undefined\n  method: string\n  url: string\n}\nexport type MockHandler = unknown | ((context: MockContext) => Promise<unknown> | unknown)\n\nexport interface RequestMockOptions {\n  delayMs?: number\n  enabled?: boolean\n  excludes?: readonly MockPattern[]\n  includes?: readonly MockPattern[]\n  logger?: (message: string) => void\n  modules: Readonly<Record<string, MockHandler>>\n}\n\nfunction matches(value: string, pattern: MockPattern): boolean {\n  return pattern instanceof RegExp ? pattern.test(value) : picomatch.isMatch(value, pattern)\n}\n\nfunction allowed(url: string, options: RequestMockOptions): boolean {\n  if ((options.excludes ?? []).some(pattern => matches(url, pattern)))\n    return false\n  return (options.includes ?? ['**']).some(pattern => matches(url, pattern))\n}\n\nfunction wait(duration: number): Promise<void> {\n  return new Promise(resolve => setTimeout(resolve, duration))\n}\n\nexport function withRequestMock(client: HttpClient, options: RequestMockOptions): HttpClient {\n  async function request<TResponse, TBody = unknown>(method: string, url: string, config: HttpRequestConfig<TBody> = {}): Promise<TResponse> {\n    if (options.enabled === false || !allowed(url, options))\n      return client.request<TResponse, TBody>(method, url, config)\n    const entry = Object.entries(options.modules).find(([pattern]) => matches(url, pattern))\n    if (!entry)\n      return client.request<TResponse, TBody>(method, url, config)\n    if ((options.delayMs ?? 0) > 0)\n      await wait(options.delayMs ?? 0)\n    options.logger?.(`[request-mock] ${method.toUpperCase()} ${url}`)\n    const value = typeof entry[1] === 'function'\n      ? await entry[1]({ body: config.body, method: method.toUpperCase(), url })\n      : entry[1]\n    return value as TResponse\n  }\n\n  return {\n    request,\n    get: (url, config) => request('GET', url, config),\n    post: (url, body, config) => request('POST', url, { ...config, body }),\n    put: (url, body, config) => request('PUT', url, { ...config, body }),\n    patch: (url, body, config) => request('PATCH', url, { ...config, body }),\n    delete: (url, config) => request('DELETE', url, config),\n  }\n}\n"],"mappings":";;AAoBA,SAAS,QAAQ,OAAe,SAA+B;CAC7D,OAAO,mBAAmB,SAAS,QAAQ,KAAK,KAAK,IAAI,UAAU,QAAQ,OAAO,OAAO;AAC3F;AAEA,SAAS,QAAQ,KAAa,SAAsC;CAClE,KAAK,QAAQ,YAAY,CAAC,EAAA,CAAG,MAAK,YAAW,QAAQ,KAAK,OAAO,CAAC,GAChE,OAAO;CACT,QAAQ,QAAQ,YAAY,CAAC,IAAI,EAAA,CAAG,MAAK,YAAW,QAAQ,KAAK,OAAO,CAAC;AAC3E;AAEA,SAAS,KAAK,UAAiC;CAC7C,OAAO,IAAI,SAAQ,YAAW,WAAW,SAAS,QAAQ,CAAC;AAC7D;AAEA,SAAgB,gBAAgB,QAAoB,SAAyC;CAC3F,eAAe,QAAoC,QAAgB,KAAa,SAAmC,CAAC,GAAuB;EACzI,IAAI,QAAQ,YAAY,SAAS,CAAC,QAAQ,KAAK,OAAO,GACpD,OAAO,OAAO,QAA0B,QAAQ,KAAK,MAAM;EAC7D,MAAM,QAAQ,OAAO,QAAQ,QAAQ,OAAO,CAAC,CAAC,MAAM,CAAC,aAAa,QAAQ,KAAK,OAAO,CAAC;EACvF,IAAI,CAAC,OACH,OAAO,OAAO,QAA0B,QAAQ,KAAK,MAAM;EAC7D,KAAK,QAAQ,WAAW,KAAK,GAC3B,MAAM,KAAK,QAAQ,WAAW,CAAC;EACjC,QAAQ,SAAS,kBAAkB,OAAO,YAAY,EAAE,GAAG,KAAK;EAIhE,OAHc,OAAO,MAAM,OAAO,aAC9B,MAAM,MAAM,EAAE,CAAC;GAAE,MAAM,OAAO;GAAM,QAAQ,OAAO,YAAY;GAAG;EAAI,CAAC,IACvE,MAAM;CAEZ;CAEA,OAAO;EACL;EACA,MAAM,KAAK,WAAW,QAAQ,OAAO,KAAK,MAAM;EAChD,OAAO,KAAK,MAAM,WAAW,QAAQ,QAAQ,KAAK;GAAE,GAAG;GAAQ;EAAK,CAAC;EACrE,MAAM,KAAK,MAAM,WAAW,QAAQ,OAAO,KAAK;GAAE,GAAG;GAAQ;EAAK,CAAC;EACnE,QAAQ,KAAK,MAAM,WAAW,QAAQ,SAAS,KAAK;GAAE,GAAG;GAAQ;EAAK,CAAC;EACvE,SAAS,KAAK,WAAW,QAAQ,UAAU,KAAK,MAAM;CACxD;AACF"}

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@yeepay/request-mock",
+  "version": "0.1.0-alpha.0",
+  "type": "module",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.mts",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "scripts": {
+    "build": "tsdown src/index.ts --format esm --dts --sourcemap",
+    "clean": "rm -rf dist",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "picomatch": "4.0.5"
+  },
+  "peerDependencies": {
+    "@yeepay/request": "^0.1.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/picomatch": "4.0.2",
+    "@yeepay/request": "workspace:*"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}