@yeepay/client-utils 3.0.1 → 3.0.3

package/README.md

@@ -4,8 +4,80 @@
 
 > 3.0 版本之后，ESMOnly.
 
+# Features
+
 - **getQueryObject**: 获取 url 参数
 - **setTokenFromUrl(key)**: 通过 url 中的参数 key 设置 TOKEN, 并存入 cookie 中
 - **getToken**: 从 cookie 中获取 TOKEN
 - **removeToken**: 从 cookie 中删除 TOKEN
 - **serviceFactory**: 请求封装的工厂函数
+
+## serviceFactory 介绍
+
+### 基本使用
+
+```javascript
+import { serviceFactory } from '@yeepay/client-utils'
+
+const service = serviceFactory(
+  {
+    baseUrl: '/xxx-server',
+    headers: {},
+  },
+  successCallback,
+  failCallback,
+  unauthorizedCallback,
+  forbiddenCallback,
+  notfoundCallback,
+)
+```
+
+### Mock数据
+
+```javascript
+import { serviceFactory } from '@yeepay/client-utils'
+
+const service = serviceFactory(
+  {
+    baseUrl: '/xxx-server',
+    headers: {},
+    // glob mock 数据文件位置
+    mockModules: import.meta.glob('./mock/**/*.json', { eager: true }),
+  },
+  successCallback,
+  failCallback,
+  unauthorizedCallback,
+  forbiddenCallback,
+  notfoundCallback,
+)
+```
+
+比如 mock 数据文件 `./mock/get/user.json` 内容如下：
+
+```json
+{
+  "code": "000000",
+  "data": {
+    "name": "John Doe"
+  }
+}
+```
+
+在你调用 uri 为 /get/user 的接口时，mock 数据将会被返回。
+
+你还可以使用 js 文件来自定义 status、response、headers:
+
+比如 mock 数据文件 `./mock/get/user.ts` 内容如下：
+
+```typescript
+import type { AxiosRequestConfig } from 'axios'
+
+export default (config: AxiosRequestConfig) => {
+  return [400, {
+    code: '000000',
+    data: {
+      message: 'User not found'
+    },
+  }, { 'new-header-hello': 'world' }]
+}
+```

package/dist/index.js

@@ -1,11 +1,12 @@
 import { toArray } from "@imyangyong/utils";
 import axios from "axios";
+import { bold, cyan, gray, green, red, yellow } from "ansis";
 import AxiosMockAdapter from "axios-mock-adapter";
 import Cookie from "js-cookie";
 
 //#region src/request/mock.ts
 /**
-* 查找数组中最长相同前缀子序列
+* 查找数组中最长相同前缀连续子序列
 */
 function longestCommonPrefix(strs) {
 	if (!strs || strs.length === 0) return "";
@@ -16,9 +17,6 @@ function longestCommonPrefix(strs) {
 	}
 	return prefix;
 }
-function escapeRegExp(string) {
-	return string.replace(/[.*+?^${}()|[\]\\]/g, "\\$&");
-}
 function setupMockAdapter(axiosInstance, mockModules) {
 	if (!mockModules) return;
 	const mock = new AxiosMockAdapter(axiosInstance);
@@ -29,7 +27,16 @@ function setupMockAdapter(axiosInstance, mockModules) {
 		const dotIndex = path.lastIndexOf(".");
 		const uri = path.slice(longestPrefixIndex, dotIndex);
 		const registerMock = (mod) => {
-			mock.onAny(/* @__PURE__ */ new RegExp(`^${escapeRegExp(uri)}$`)).reply(200, mod);
+			const replyFunc = typeof mod.default === "function" ? mod.default : () => [200, mod.default];
+			mock.onAny(new RegExp(uri)).reply((config) => {
+				const response = replyFunc(config);
+				const status = String(response[0]);
+				const statusColor = status.startsWith("2") ? green(status) : status.startsWith("3") ? yellow(status) : red(status);
+				const data = response[1] ? JSON.stringify(response[1], null, 2) : "";
+				const headers = response[2] ? JSON.stringify(response[2], null, 2) : "";
+				console.log(`${gray("Mocked:")} ${bold("URI")}: ${cyan.bold(uri)} \n${bold("Status")}: ${statusColor} \n${bold("Response")}: ${data} \n${headers ? `${bold("Headers:")} ${headers}` : ""}`);
+				return response;
+			});
 		};
 		if (typeof mockModules[path] === "function") mockModules[path]().then(registerMock).catch((error) => {
 			console.error(`@yeepay/client-utils mock trying to loading ${path} failed`, error);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@yeepay/client-utils",
   "type": "module",
-  "version": "3.0.1",
+  "version": "3.0.3",
   "description": "shared utilities for yeepay client packages",
   "author": "Yong Yang",
   "homepage": "http://gitlab.yeepay.com/ued/client-utils#readme",
@@ -20,6 +20,7 @@
   ],
   "dependencies": {
     "@imyangyong/utils": "^0.8.0",
+    "ansis": "^4.1.0",
     "axios": "^1.7.0",
     "axios-mock-adapter": "^2.1.0",
     "js-cookie": "^3.0.5"