@yeepay/client-utils 3.0.5 → 3.1.0

package/dist/index.d.ts

@@ -1,5 +1,52 @@
 import { AxiosInstance, AxiosResponse, InternalAxiosRequestConfig } from "axios";
 
+//#region src/request/mock.d.ts
+
+/**
+ * A valid `picomatch` glob pattern, or array of patterns.
+ */
+type FilterPattern = ReadonlyArray<string | RegExp> | string | RegExp | null;
+interface Mock {
+  /**
+   * Default is enable localhost domain, is disabled at other domains.
+   *
+   * @default undefined
+   */
+  enabled?: boolean;
+  /**
+   * Response delay in milliseconds.
+   *
+   * @default 200
+   */
+  delay?: number;
+  /**
+   * The Modules that store mock data.
+   *
+   * Please use glob patterns to specify the modules.
+   *
+   * @default {}
+   */
+  modules?: Record<string, unknown | (() => Promise<unknown>)>;
+  /**
+   * If enabled log in console.
+   *
+   * @default true
+   */
+  log?: boolean;
+  /**
+   * The Modules to include the mock.
+   *
+   * @default ['*']
+   */
+  includes?: FilterPattern;
+  /**
+   * The Modules to exclude the mock.
+   *
+   * @default []
+   */
+  excludes?: FilterPattern;
+}
+//#endregion
 //#region src/request/index.d.ts
 interface ServiceFactoryOptions {
   baseUrl?: string;
@@ -7,7 +54,7 @@ interface ServiceFactoryOptions {
   headers?: Record<string, string>;
   code?: string | number;
   debug?: boolean;
-  mockModules?: Record<string, unknown | (() => Promise<unknown>)>;
+  mock?: Mock;
 }
 interface ServiceFactoryCallbacks {
   successCallback?: (response: AxiosResponse<any>) => any;

package/dist/index.js

@@ -1,7 +1,8 @@
-import { toArray } from "@imyangyong/utils";
+import { interopDefault, toArray } from "@imyangyong/utils";
 import axios from "axios";
 import { bold, cyan, gray, green, red, yellow } from "ansis";
 import AxiosMockAdapter from "axios-mock-adapter";
+import picomatch from "picomatch/posix";
 import Cookie from "js-cookie";
 
 //#region src/request/mock.ts
@@ -20,32 +21,68 @@ function longestCommonPrefix(strs) {
 function isLocalhost() {
 	return window.location.hostname === "localhost";
 }
-async function setupMockAdapter(axiosInstance, mockModules) {
-	if (!mockModules) return;
-	if (!isLocalhost()) return;
-	const mock = new AxiosMockAdapter(axiosInstance);
-	const paths = Object.keys(mockModules);
-	const longestPrefix = longestCommonPrefix(paths);
-	paths.forEach((path) => {
+/**
+* Simple pattern matching function that handles basic glob patterns and regex
+*/
+function matchesPattern(str, pattern) {
+	if (pattern instanceof RegExp) return pattern.test(str);
+	if (typeof pattern === "string") {
+		if (pattern === "*") return true;
+		const isMatch = picomatch(pattern);
+		return isMatch(str);
+	}
+	return false;
+}
+/**
+* Check if a uri should be included based on includes/excludes patterns
+*/
+function shouldIncludeModule(uri, includes, excludes) {
+	const includePatterns = includes ? Array.isArray(includes) ? includes : [includes] : ["*"];
+	const excludePatterns = excludes ? Array.isArray(excludes) ? excludes : [excludes] : [];
+	const isExcluded = excludePatterns.some((pattern) => pattern && matchesPattern(uri, pattern));
+	if (isExcluded) return false;
+	const isIncluded = includePatterns.some((pattern) => pattern && matchesPattern(uri, pattern));
+	return isIncluded;
+}
+async function setupMockAdapter(axiosInstance, mock) {
+	if (!mock) return;
+	const { enabled, delay = 200, modules, includes = ["*"], excludes = [], log = true } = mock;
+	if (enabled === void 0 && !isLocalhost() || enabled === false) return;
+	if (!modules) return;
+	const mockAdapter = new AxiosMockAdapter(axiosInstance, {
+		delayResponse: delay,
+		onNoMatch: "passthrough"
+	});
+	const allPaths = Object.keys(modules);
+	const longestPrefix = longestCommonPrefix(allPaths);
+	const paths = allPaths.map((path) => {
 		const longestPrefixIndex = longestPrefix.lastIndexOf("/");
 		const dotIndex = path.lastIndexOf(".");
 		const uri = path.slice(longestPrefixIndex, dotIndex);
+		return {
+			uri,
+			path
+		};
+	});
+	const filteredPaths = paths.filter(({ uri }) => shouldIncludeModule(uri, includes, excludes));
+	if (filteredPaths.length === 0) return;
+	filteredPaths.forEach(({ uri, path }) => {
 		const registerMock = (mod) => {
-			const replyFunc = typeof mod.default === "function" ? mod.default : () => [200, mod.default];
-			mock.onAny(new RegExp(uri)).reply((config) => {
+			const replyFunc = typeof mod === "function" ? mod : () => [200, mod];
+			mockAdapter.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}` : ""}`);
+				if (log) 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) => {
+		if (typeof modules[path] === "function") interopDefault(modules[path]()).then(registerMock).catch((error) => {
 			console.error(`@yeepay/client-utils mock trying to loading ${path} failed`, error);
 		});
-		else registerMock(mockModules[path]);
+		else registerMock(modules[path]);
 	});
 }
 
@@ -128,7 +165,7 @@ function blobToJson(blob) {
 	});
 }
 function serviceFactory(options, ...callbacks) {
-	const { baseUrl = "/", timeout = 12e5, headers, code, debug, mockModules } = options;
+	const { baseUrl = "/", timeout = 12e5, headers, code, debug, mock } = options;
 	const { successCallback = (_response) => ({}), failCallback = (_error) => ({}), unauthorizedCallback = (_response) => ({}), forbiddenCallback = (_response) => ({}), notfoundCallback = (_response) => ({}), requestInterceptor = (c) => c, responseInterceptor = (r) => r } = compatibleCallback(callbacks);
 	const service = axios.create({
 		baseURL: baseUrl,
@@ -202,7 +239,7 @@ function serviceFactory(options, ...callbacks) {
 	service.interceptors.response.use(responseInterceptor, (error) => {
 		return Promise.reject(error);
 	});
-	if (mockModules) setupMockAdapter(service, mockModules);
+	if (mock) setupMockAdapter(service, mock);
 	return service;
 }
 

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@yeepay/client-utils",
   "type": "module",
-  "version": "3.0.5",
+  "version": "3.1.0",
   "description": "shared utilities for yeepay client packages",
   "author": "Yong Yang",
   "homepage": "http://gitlab.yeepay.com/ued/client-utils#readme",
@@ -14,6 +14,7 @@
       "import": "./dist/index.js"
     }
   },
+  "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "files": [
     "dist"
@@ -23,11 +24,13 @@
     "ansis": "^4.1.0",
     "axios": "^1.7.0",
     "axios-mock-adapter": "^2.1.0",
-    "js-cookie": "^3.0.5"
+    "js-cookie": "^3.0.5",
+    "picomatch": "^4.0.3"
   },
   "devDependencies": {
     "@antfu/ni": "^0.21.12",
     "@types/js-cookie": "^3.0.6",
+    "@types/picomatch": "^4.0.2",
     "@yeepay/eslint-config": "^4.17.0",
     "bumpp": "^9.4.1",
     "eslint": "^9.32.0",