@weapp-core/api 0.2.0 → 0.3.1

package/dist/vitest/setup.d.mts

@@ -0,0 +1 @@
+export {}

package/dist/vitest/setup.mjs

@@ -0,0 +1,5 @@
+import { setupApiMock } from "../vitest.mjs";
+//#region src/vitest/setup.ts
+setupApiMock(["@weapp-core/api"]);
+//#endregion
+export {};

package/dist/vitest.d.mts

@@ -0,0 +1,55 @@
+import { D as WeapiInstance, K as WeapiMiniProgramCrossPlatformRawAdapter, W as WeapiCrossPlatformRawAdapter, z as WeapiAdapter } from "./index-Bt6fzcnM.mjs";
+import { Mock } from "vitest";
+//#region src/vitest/index.d.ts
+type Procedure = (...args: any[]) => any;
+type MockImplementation<T extends Procedure> = (...args: Parameters<T>) => ReturnType<T>;
+type ApiMockFunction<TPublic extends Procedure, TRaw extends Procedure = TPublic> = Omit<Mock<TPublic>, 'mockImplementation' | 'mockImplementationOnce' | 'withImplementation'> & TPublic & {
+  mockImplementation: {
+    (implementation: MockImplementation<TRaw>): ApiMockFunction<TPublic, TRaw>;
+    (implementation: MockImplementation<TPublic>): ApiMockFunction<TPublic, TRaw>;
+  };
+  mockImplementationOnce: {
+    (implementation: MockImplementation<TRaw>): ApiMockFunction<TPublic, TRaw>;
+    (implementation: MockImplementation<TPublic>): ApiMockFunction<TPublic, TRaw>;
+  };
+  withImplementation: {
+    (implementation: MockImplementation<TRaw>, callback: () => Promise<unknown>): Promise<ApiMockFunction<TPublic, TRaw>>;
+    (implementation: MockImplementation<TRaw>, callback: () => unknown): ApiMockFunction<TPublic, TRaw>;
+    (implementation: MockImplementation<TPublic>, callback: () => Promise<unknown>): Promise<ApiMockFunction<TPublic, TRaw>>;
+    (implementation: MockImplementation<TPublic>, callback: () => unknown): ApiMockFunction<TPublic, TRaw>;
+  };
+};
+type RawMethod<TAdapter extends WeapiAdapter, TKey extends PropertyKey, TFallback extends Procedure> = TKey extends keyof TAdapter ? TAdapter[TKey] extends Procedure ? TAdapter[TKey] : TFallback : TFallback;
+/**
+ * @description 与 API 实例方法签名对齐的 Vitest mock 对象。
+ */
+export type ApiMock<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter> = { [TKey in keyof WeapiInstance<TAdapter>]: WeapiInstance<TAdapter>[TKey] extends Procedure ? ApiMockFunction<WeapiInstance<TAdapter>[TKey], RawMethod<TAdapter, TKey, WeapiInstance<TAdapter>[TKey]>> : WeapiInstance<TAdapter>[TKey]; };
+/**
+ * @description 创建 API mock 时预设的属性或方法实现。
+ */
+export type ApiMockOverrides<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter> = Partial<WeapiInstance<TAdapter>>;
+/**
+ * @description 创建与 API 类型对齐、按访问惰性生成方法的 Vitest mock。
+ */
+export declare function createApiMock<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter>(overrides?: ApiMockOverrides<NoInfer<TAdapter>>): ApiMock<TAdapter>;
+/**
+ * @description 默认 API Vitest mock 单例。
+ */
+export declare const apiMock: ApiMock<WeapiMiniProgramCrossPlatformRawAdapter>;
+/**
+ * @description 默认 API Vitest mock 单例的兼容名称。
+ */
+export declare const wpiMock: ApiMock<WeapiMiniProgramCrossPlatformRawAdapter>;
+/**
+ * @description 创建 API Vitest mock 的兼容名称。
+ */
+export declare const createWpiMock: typeof createApiMock;
+/**
+ * @description 重置指定 API mock 自身已创建的方法，不影响其他 Vitest mocks。
+ */
+export declare function resetApiMock(mock?: ApiMock<any>): void;
+/**
+ * @description 在 Vitest setup 文件中注册需要替换 API 实例的模块入口。
+ */
+export declare function setupApiMock(moduleIds: readonly string[]): void;
+//#endregion

package/dist/vitest.mjs

@@ -0,0 +1,107 @@
+import { i as WEAPI_WECHAT_METHODS, n as WEAPI_DOUYIN_METHODS, t as WEAPI_ALIPAY_METHODS } from "./apiCatalog-aYGell1q.mjs";
+import { beforeEach, vi } from "vitest";
+//#region src/vitest/index.ts
+const INTERNAL_METHOD_NAMES = [
+	"getAdapter",
+	"resolveTarget",
+	"setAdapter",
+	"supports"
+];
+const API_METHOD_NAMES = /* @__PURE__ */ new Set([
+	...WEAPI_WECHAT_METHODS,
+	...WEAPI_ALIPAY_METHODS,
+	...WEAPI_DOUYIN_METHODS,
+	...INTERNAL_METHOD_NAMES
+]);
+const API_VALUE_NAMES = /* @__PURE__ */ new Set(["platform", "raw"]);
+const API_MOCK_STATES = /* @__PURE__ */ new WeakMap();
+function createNamedMock(name, implementation) {
+	return (implementation ? vi.fn(implementation) : vi.fn()).mockName(`api.${String(name)}`);
+}
+function materializeOverride(state, key, value) {
+	if (typeof value === "function") {
+		const mock = vi.isMockFunction(value) ? value : createNamedMock(key, value);
+		state.mocks.add(mock);
+		state.values.set(key, mock);
+		return;
+	}
+	state.values.set(key, value);
+}
+/**
+* @description 创建与 API 类型对齐、按访问惰性生成方法的 Vitest mock。
+*/
+function createApiMock(overrides = {}) {
+	const state = {
+		mocks: /* @__PURE__ */ new Set(),
+		values: /* @__PURE__ */ new Map()
+	};
+	for (const key of Reflect.ownKeys(overrides)) materializeOverride(state, key, Reflect.get(overrides, key));
+	const proxy = new Proxy(Object.create(null), {
+		get(_target, key) {
+			if (key === Symbol.toStringTag) return "ApiMock";
+			if (key === "then") return;
+			if (state.values.has(key)) return state.values.get(key);
+			if (API_VALUE_NAMES.has(key) || typeof key !== "string" && !API_METHOD_NAMES.has(key)) return;
+			const mock = createNamedMock(key);
+			state.mocks.add(mock);
+			state.values.set(key, mock);
+			return mock;
+		},
+		getOwnPropertyDescriptor(_target, key) {
+			if (!state.values.has(key)) return;
+			return {
+				configurable: true,
+				enumerable: true,
+				value: state.values.get(key),
+				writable: true
+			};
+		},
+		has(_target, key) {
+			return state.values.has(key) || API_METHOD_NAMES.has(key);
+		},
+		ownKeys() {
+			return [...state.values.keys()];
+		},
+		set(_target, key, value) {
+			materializeOverride(state, key, value);
+			return true;
+		}
+	});
+	API_MOCK_STATES.set(proxy, state);
+	return proxy;
+}
+/**
+* @description 默认 API Vitest mock 单例。
+*/
+const apiMock = createApiMock();
+/**
+* @description 默认 API Vitest mock 单例的兼容名称。
+*/
+const wpiMock = apiMock;
+/**
+* @description 创建 API Vitest mock 的兼容名称。
+*/
+const createWpiMock = createApiMock;
+/**
+* @description 重置指定 API mock 自身已创建的方法，不影响其他 Vitest mocks。
+*/
+function resetApiMock(mock = apiMock) {
+	API_MOCK_STATES.get(mock)?.mocks.forEach((item) => item.mockReset());
+}
+/**
+* @description 在 Vitest setup 文件中注册需要替换 API 实例的模块入口。
+*/
+function setupApiMock(moduleIds) {
+	for (const moduleId of moduleIds) vi.doMock(moduleId, async () => {
+		return {
+			...await vi.importActual(moduleId),
+			api: apiMock,
+			wpi: apiMock
+		};
+	});
+	beforeEach(() => {
+		resetApiMock(apiMock);
+	});
+}
+//#endregion
+export { apiMock, createApiMock, createWpiMock, resetApiMock, setupApiMock, wpiMock };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@weapp-core/api",
   "type": "module",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "description": "Framework-agnostic cross-platform mini-program API proxy",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -22,12 +22,22 @@
     "adapter",
     "weapp"
   ],
-  "sideEffects": false,
+  "sideEffects": [
+    "./dist/vitest/setup.mjs"
+  ],
   "weapp-vite-dev": {
     "exports": {
       ".": {
         "types": "./src/index.ts",
         "default": "./src/index.ts"
+      },
+      "./vitest": {
+        "types": "./src/vitest/index.ts",
+        "default": "./src/vitest/index.ts"
+      },
+      "./vitest/setup": {
+        "types": "./src/vitest/setup.ts",
+        "default": "./src/vitest/setup.ts"
       }
     },
     "main": "./src/index.ts",
@@ -41,6 +51,14 @@
         "types": "./types/index.d.ts",
         "default": "./dist/index.mjs"
       }
+    },
+    "./vitest": {
+      "types": "./dist/vitest.d.mts",
+      "import": "./dist/vitest.mjs"
+    },
+    "./vitest/setup": {
+      "types": "./dist/vitest/setup.d.mts",
+      "import": "./dist/vitest/setup.mjs"
     }
   },
   "main": "./dist/index.mjs",
@@ -51,11 +69,25 @@
     "dist",
     "types"
   ],
+  "peerDependencies": {
+    "vitest": ">=4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "vitest": {
+      "optional": true
+    }
+  },
   "dependencies": {
     "@douyin-microapp/typings": "^1.3.1",
     "@mini-types/alipay": "^3.0.14",
     "miniprogram-api-typings": "^5.2.3"
   },
+  "tsd": {
+    "compilerOptions": {
+      "module": "NodeNext",
+      "moduleResolution": "NodeNext"
+    }
+  },
   "publishConfig": {
     "access": "public"
   },