@weapp-core/api 0.3.0 → 0.3.2

package/README.md

@@ -388,7 +388,7 @@ resetApiMock(localWpi)
 ## 行为说明
 
 - **只在不传回调时返回 Promise**
-- 同步 API（`*Sync`）与事件 API（`onXxx/offXxx`）直接透传
+- 同步直接返回 API（包括无 `Sync` 后缀的宿主同步 API）、`*Sync` API 与事件 API（`onXxx/offXxx`）直接透传
 - 可通过 `api.resolveTarget('showModal')` 查看当前平台目标方法与可用性
 - 可通过 `api.supports('showModal')` 快速判断当前平台是否支持调用
 - 缺失 API 时：

package/dist/{index-BcqIvCCn.d.mts → index-Bt6fzcnM.d.mts}

@@ -176,15 +176,7 @@ type WeapiMiniProgramCrossPlatformRawAdapter = MergeAdapters<MergeAdapters<Weapi
 type WeapiCrossPlatformRawAdapter = WeapiMiniProgramCrossPlatformRawAdapter;
 //#endregion
 //#region src/core/nonPromisifiedMethods.d.ts
-/**
- * @description `wpi` 中需要保留原始同步返回值的方法名单。
- *
- * 这些方法虽然不一定带有 `Sync` 后缀，但本质上属于以下几类：
- * - 宿主能力探测与同步工具方法
- * - 各类上下文 / manager / socket / observer 工厂
- * - 同步返回句柄的调度与分析方法
- */
-declare const WEAPI_NON_PROMISIFIED_METHOD_NAMES: readonly ["arrayBufferToBase64", "base64ToArrayBuffer", "canIUse", "cancelIdleCallback", "createAnimation", "createAudioContext", "createCameraContext", "createCanvasContext", "createEditorContext", "createInnerAudioContext", "createIntersectionObserver", "createInterstitialAd", "createLivePlayerContext", "createLivePusherContext", "createMapContext", "createMediaAudioPlayer", "createMediaContainer", "createMediaRecorder", "createOffscreenCanvas", "createRewardedVideoAd", "createSelectorQuery", "createTCPSocket", "createUDPSocket", "createVKSession", "createVideoContext", "createWebAudioContext", "createWorker", "getBackgroundAudioManager", "getFileSystemManager", "getLogManager", "getMenuButtonBoundingClientRect", "getNFCAdapter", "getOpenDataContext", "getPerformance", "getRealtimeLogManager", "getRecorderManager", "getUpdateManager", "getUserCryptoManager", "getXrFrameSystem", "nextTick", "reportAnalytics", "requestIdleCallback"];
+declare const WEAPI_NON_PROMISIFIED_METHOD_NAMES: readonly ["arrayBufferToBase64", "base64ToArrayBuffer", "cancelIdleCallback", "canIUse", "checkIsPictureInPictureActive", "createAnimation", "createAudioContext", "createBufferURL", "createCacheManager", "createCameraContext", "createCanvasContext", "createGlobalPayment", "createInferenceSession", "createInnerAudioContext", "createIntersectionObserver", "createInterstitialAd", "createLivePlayerContext", "createLivePusherContext", "createMapContext", "createMediaAudioPlayer", "createMediaContainer", "createMediaRecorder", "createOffscreenCanvas", "createRewardedVideoAd", "createSelectorQuery", "createTCPSocket", "createUDPSocket", "createVideoContext", "createVideoDecoder", "createVKSession", "createWebAudioContext", "createWorker", "getApiCategory", "getAppAuthorizeSetting", "getAppBaseInfo", "getBackgroundAudioManager", "getDeviceInfo", "getFileSystemManager", "getLogManager", "getMenuButtonBoundingClientRect", "getNFCAdapter", "getPerformance", "getPluginUpdateManager", "getRealtimeLogManager", "getRecorderManager", "getSystemSetting", "getUpdateManager", "getUserCryptoManager", "getWindowInfo", "getXrFrameSystem", "isVKSupport", "nextTick", "postMessageToReferrerMiniProgram", "postMessageToReferrerPage", "reportAnalytics", "reportEvent", "reportMonitor", "reportPerformance", "requestAppleSubscribeSign", "requestIdleCallback", "revokeBufferURL", "createEditorContext", "getOpenDataContext"];
 type WeapiNonPromisifiedMethodName = typeof WEAPI_NON_PROMISIFIED_METHOD_NAMES[number];
 //#endregion
 //#region src/core/promisify/index.d.ts
@@ -1105,7 +1097,7 @@ interface WeapiCrossPlatformMethodDocsChooseVideoToOpenDocumentChooseVideoToGetL
    *
    * 示例：
    * ```ts
-   * const info = await wpi.getWindowInfo()
+   * const info = wpi.getWindowInfo()
    *
    * console.log(info.windowWidth, info.windowHeight)
    * ```

package/dist/index.d.mts

@@ -1,2 +1,2 @@
-import { $ as WeapiMiniProgramLogManager, A as WeapiMiniProgramAlipayAdapter, B as WeapiError, C as CreateWeapiOptions, Ct as WeapiTtMiniProgramRawAdapterSource, D as WeapiInstance, E as WeapiDouyinAdapter, F as WeapiNetworkOverflowPolicy, G as WeapiDouyinRawAdapter, H as WeapiPromisify, I as WeapiResolvedTarget, J as WeapiMiniProgramBluetoothError, K as WeapiMiniProgramCrossPlatformRawAdapter, L as WeapiSupportLevel, M as WeapiMiniProgramDouyinAdapter, N as WeapiMiniProgramWxAdapter, O as WeapiMethodSupportQueryOptions, P as WeapiNetworkOptions, Q as WeapiMiniProgramGeneralCallbackResult, R as WeapiWxAdapter, S as createWeapi, St as WeapiMiniProgramRuntimeRawAdapterSourceRegistry, T as WeapiCrossPlatformAdapter, U as WeapiAlipayRawAdapter, V as WeapiPromise, W as WeapiCrossPlatformRawAdapter, X as WeapiMiniProgramConnectSocketOption, Y as WeapiMiniProgramClipboardDataResult, Z as WeapiMiniProgramDouyinRawAdapter, _ as WeapiWechatMethodName, _t as WeapiDouyinMiniProgramRawAdapterSource, a as normalizeMiniProgramPlatform, at as WeapiMiniProgramRequestTask, b as WEAPI_RUNTIME_TYPE_SOURCES, bt as WeapiMiniProgramRawAdapterSourceName, c as WeapiDouyinMethodName, ct as WeapiMiniProgramSystemInfo, d as WeapiMiniProgramMethodName, dt as WeapiMiniProgramWechatRawAdapter, et as WeapiMiniProgramRawAdapter, f as WeapiMiniProgramWechatMethodName, ft as WeapiMiniProgramWxRawAdapter, g as WeapiTypeSourceName, gt as WeapiDefaultMiniProgramRawAdapterSource, h as WeapiRuntimeTypeSourceName, ht as WeapiAlipayMiniProgramRawAdapterSource, i as MiniProgramApiPlatformDescriptor, it as WeapiMiniProgramRequestSuccessResult, j as WeapiMiniProgramCrossPlatformAdapter, k as WeapiMiniProgramAdapter, l as WeapiMiniProgramAlipayMethodName, lt as WeapiMiniProgramUpdateManager, m as WeapiPlatformTypeSourceName, mt as WeapiWxRawAdapter, n as wpi, nt as WeapiMiniProgramRequestMethod, o as resolveMiniProgramPlatform, ot as WeapiMiniProgramSelectorQuery, p as WeapiMiniProgramWxMethodName, pt as WeapiWechatRawAdapter, q as WeapiMiniProgramAlipayRawAdapter, r as MINI_PROGRAM_API_PLATFORM_DESCRIPTORS, rt as WeapiMiniProgramRequestOption, s as WeapiAlipayMethodName, st as WeapiMiniProgramSocketTask, t as api, tt as WeapiMiniProgramRequestFailResult, u as WeapiMiniProgramDouyinMethodName, ut as WeapiMiniProgramVideoContext, v as WeapiWxMethodName, vt as WeapiMiniProgramPlatformRawAdapterSourceName, w as WeapiAlipayAdapter, wt as WeapiWechatMiniProgramRawAdapterSource, x as WEAPI_TYPE_SOURCES, xt as WeapiMiniProgramRuntimeRawAdapterSourceName, y as WEAPI_PLATFORM_TYPE_SOURCES, yt as WeapiMiniProgramPlatformRawAdapterSourceRegistry, z as WeapiAdapter } from "./index-BcqIvCCn.mjs";
+import { $ as WeapiMiniProgramLogManager, A as WeapiMiniProgramAlipayAdapter, B as WeapiError, C as CreateWeapiOptions, Ct as WeapiTtMiniProgramRawAdapterSource, D as WeapiInstance, E as WeapiDouyinAdapter, F as WeapiNetworkOverflowPolicy, G as WeapiDouyinRawAdapter, H as WeapiPromisify, I as WeapiResolvedTarget, J as WeapiMiniProgramBluetoothError, K as WeapiMiniProgramCrossPlatformRawAdapter, L as WeapiSupportLevel, M as WeapiMiniProgramDouyinAdapter, N as WeapiMiniProgramWxAdapter, O as WeapiMethodSupportQueryOptions, P as WeapiNetworkOptions, Q as WeapiMiniProgramGeneralCallbackResult, R as WeapiWxAdapter, S as createWeapi, St as WeapiMiniProgramRuntimeRawAdapterSourceRegistry, T as WeapiCrossPlatformAdapter, U as WeapiAlipayRawAdapter, V as WeapiPromise, W as WeapiCrossPlatformRawAdapter, X as WeapiMiniProgramConnectSocketOption, Y as WeapiMiniProgramClipboardDataResult, Z as WeapiMiniProgramDouyinRawAdapter, _ as WeapiWechatMethodName, _t as WeapiDouyinMiniProgramRawAdapterSource, a as normalizeMiniProgramPlatform, at as WeapiMiniProgramRequestTask, b as WEAPI_RUNTIME_TYPE_SOURCES, bt as WeapiMiniProgramRawAdapterSourceName, c as WeapiDouyinMethodName, ct as WeapiMiniProgramSystemInfo, d as WeapiMiniProgramMethodName, dt as WeapiMiniProgramWechatRawAdapter, et as WeapiMiniProgramRawAdapter, f as WeapiMiniProgramWechatMethodName, ft as WeapiMiniProgramWxRawAdapter, g as WeapiTypeSourceName, gt as WeapiDefaultMiniProgramRawAdapterSource, h as WeapiRuntimeTypeSourceName, ht as WeapiAlipayMiniProgramRawAdapterSource, i as MiniProgramApiPlatformDescriptor, it as WeapiMiniProgramRequestSuccessResult, j as WeapiMiniProgramCrossPlatformAdapter, k as WeapiMiniProgramAdapter, l as WeapiMiniProgramAlipayMethodName, lt as WeapiMiniProgramUpdateManager, m as WeapiPlatformTypeSourceName, mt as WeapiWxRawAdapter, n as wpi, nt as WeapiMiniProgramRequestMethod, o as resolveMiniProgramPlatform, ot as WeapiMiniProgramSelectorQuery, p as WeapiMiniProgramWxMethodName, pt as WeapiWechatRawAdapter, q as WeapiMiniProgramAlipayRawAdapter, r as MINI_PROGRAM_API_PLATFORM_DESCRIPTORS, rt as WeapiMiniProgramRequestOption, s as WeapiAlipayMethodName, st as WeapiMiniProgramSocketTask, t as api, tt as WeapiMiniProgramRequestFailResult, u as WeapiMiniProgramDouyinMethodName, ut as WeapiMiniProgramVideoContext, v as WeapiWxMethodName, vt as WeapiMiniProgramPlatformRawAdapterSourceName, w as WeapiAlipayAdapter, wt as WeapiWechatMiniProgramRawAdapterSource, x as WEAPI_TYPE_SOURCES, xt as WeapiMiniProgramRuntimeRawAdapterSourceName, y as WEAPI_PLATFORM_TYPE_SOURCES, yt as WeapiMiniProgramPlatformRawAdapterSourceRegistry, z as WeapiAdapter } from "./index-Bt6fzcnM.mjs";
 export { type CreateWeapiOptions as CreateApiOptions, type CreateWeapiOptions, MINI_PROGRAM_API_PLATFORM_DESCRIPTORS, type WeapiInstance as MiniProgramApiInstance, type WeapiInstance, type MiniProgramApiPlatformDescriptor, WEAPI_PLATFORM_TYPE_SOURCES, WEAPI_RUNTIME_TYPE_SOURCES, WEAPI_TYPE_SOURCES, type WeapiAdapter, type WeapiAlipayAdapter, type WeapiAlipayMethodName, type WeapiAlipayMiniProgramRawAdapterSource, type WeapiAlipayRawAdapter, type WeapiCrossPlatformAdapter, type WeapiCrossPlatformRawAdapter, type WeapiDefaultMiniProgramRawAdapterSource, type WeapiDouyinAdapter, type WeapiDouyinMethodName, type WeapiDouyinMiniProgramRawAdapterSource, type WeapiDouyinRawAdapter, type WeapiError, type WeapiMethodSupportQueryOptions, type WeapiMiniProgramAdapter, type WeapiMiniProgramAlipayAdapter, type WeapiMiniProgramAlipayMethodName, type WeapiMiniProgramAlipayRawAdapter, type WeapiMiniProgramBluetoothError, type WeapiMiniProgramClipboardDataResult, type WeapiMiniProgramConnectSocketOption, type WeapiMiniProgramCrossPlatformAdapter, type WeapiMiniProgramCrossPlatformRawAdapter, type WeapiMiniProgramDouyinAdapter, type WeapiMiniProgramDouyinMethodName, type WeapiMiniProgramDouyinRawAdapter, type WeapiMiniProgramGeneralCallbackResult, type WeapiMiniProgramLogManager, type WeapiMiniProgramMethodName, type WeapiMiniProgramPlatformRawAdapterSourceName, type WeapiMiniProgramPlatformRawAdapterSourceRegistry, type WeapiMiniProgramRawAdapter, type WeapiMiniProgramRawAdapterSourceName, type WeapiMiniProgramRequestFailResult, type WeapiMiniProgramRequestMethod, type WeapiMiniProgramRequestOption, type WeapiMiniProgramRequestSuccessResult, type WeapiMiniProgramRequestTask, type WeapiMiniProgramRuntimeRawAdapterSourceName, type WeapiMiniProgramRuntimeRawAdapterSourceRegistry, type WeapiMiniProgramSelectorQuery, type WeapiMiniProgramSocketTask, type WeapiMiniProgramSystemInfo, type WeapiMiniProgramUpdateManager, type WeapiMiniProgramVideoContext, type WeapiMiniProgramWechatMethodName, type WeapiMiniProgramWechatRawAdapter, type WeapiMiniProgramWxAdapter, type WeapiMiniProgramWxMethodName, type WeapiMiniProgramWxRawAdapter, type WeapiNetworkOptions, type WeapiNetworkOverflowPolicy, type WeapiPlatformTypeSourceName, type WeapiPromise, type WeapiPromisify, type WeapiResolvedTarget, type WeapiRuntimeTypeSourceName, type WeapiSupportLevel, type WeapiTtMiniProgramRawAdapterSource, type WeapiTypeSourceName, type WeapiWechatMethodName, type WeapiWechatMiniProgramRawAdapterSource, type WeapiWechatRawAdapter, type WeapiWxAdapter, type WeapiWxMethodName, type WeapiWxRawAdapter, api, createWeapi as createApi, createWeapi, normalizeMiniProgramPlatform, resolveMiniProgramPlatform, wpi };

package/dist/index.mjs

@@ -232,16 +232,26 @@ function detectGlobalAdapter() {
 	}
 	return {};
 }
-const WEAPI_NON_PROMISIFIED_METHOD_NAME_SET = /* @__PURE__ */ new Set([
+//#endregion
+//#region src/core/apiCatalog/wxDirectReturnMethods.ts
+/**
+* @description 微信无回调直接返回 API 名单（由 typings 自动提取，请勿手工修改）
+* @generated by scripts/sync-api-catalog.mjs
+*/
+const WEAPI_WX_DIRECT_RETURN_METHODS = [
 	"arrayBufferToBase64",
 	"base64ToArrayBuffer",
-	"canIUse",
 	"cancelIdleCallback",
+	"canIUse",
+	"checkIsPictureInPictureActive",
 	"createAnimation",
 	"createAudioContext",
+	"createBufferURL",
+	"createCacheManager",
 	"createCameraContext",
 	"createCanvasContext",
-	"createEditorContext",
+	"createGlobalPayment",
+	"createInferenceSession",
 	"createInnerAudioContext",
 	"createIntersectionObserver",
 	"createInterstitialAd",
@@ -256,26 +266,46 @@ const WEAPI_NON_PROMISIFIED_METHOD_NAME_SET = /* @__PURE__ */ new Set([
 	"createSelectorQuery",
 	"createTCPSocket",
 	"createUDPSocket",
-	"createVKSession",
 	"createVideoContext",
+	"createVideoDecoder",
+	"createVKSession",
 	"createWebAudioContext",
 	"createWorker",
+	"getApiCategory",
+	"getAppAuthorizeSetting",
+	"getAppBaseInfo",
 	"getBackgroundAudioManager",
+	"getDeviceInfo",
 	"getFileSystemManager",
 	"getLogManager",
 	"getMenuButtonBoundingClientRect",
 	"getNFCAdapter",
-	"getOpenDataContext",
 	"getPerformance",
+	"getPluginUpdateManager",
 	"getRealtimeLogManager",
 	"getRecorderManager",
+	"getSystemSetting",
 	"getUpdateManager",
 	"getUserCryptoManager",
+	"getWindowInfo",
 	"getXrFrameSystem",
+	"isVKSupport",
 	"nextTick",
+	"postMessageToReferrerMiniProgram",
+	"postMessageToReferrerPage",
 	"reportAnalytics",
-	"requestIdleCallback"
-]);
+	"reportEvent",
+	"reportMonitor",
+	"reportPerformance",
+	"requestAppleSubscribeSign",
+	"requestIdleCallback",
+	"revokeBufferURL"
+];
+//#endregion
+//#region src/core/nonPromisifiedMethods.ts
+const WEAPI_LEGACY_NON_PROMISIFIED_METHOD_NAMES = ["createEditorContext", "getOpenDataContext"];
+const WEAPI_NON_PROMISIFIED_METHOD_NAMES = [...WEAPI_WX_DIRECT_RETURN_METHODS, ...WEAPI_LEGACY_NON_PROMISIFIED_METHOD_NAMES];
+const WEAPI_NON_PROMISIFIED_METHOD_NAME_SET = new Set(WEAPI_NON_PROMISIFIED_METHOD_NAMES);
 /**
 * @description 判断方法是否应保留原始同步返回值，而不是包装为 Promise。
 */

package/dist/vitest.d.mts

@@ -1,4 +1,4 @@
-import { D as WeapiInstance, K as WeapiMiniProgramCrossPlatformRawAdapter, W as WeapiCrossPlatformRawAdapter, z as WeapiAdapter } from "./index-BcqIvCCn.mjs";
+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;
@@ -23,34 +23,33 @@ type RawMethod<TAdapter extends WeapiAdapter, TKey extends PropertyKey, TFallbac
 /**
  * @description 与 API 实例方法签名对齐的 Vitest mock 对象。
  */
-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]; };
+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 时预设的属性或方法实现。
  */
-type ApiMockOverrides<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter> = Partial<WeapiInstance<TAdapter>>;
+export type ApiMockOverrides<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter> = Partial<WeapiInstance<TAdapter>>;
 /**
  * @description 创建与 API 类型对齐、按访问惰性生成方法的 Vitest mock。
  */
-declare function createApiMock<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter>(overrides?: ApiMockOverrides<NoInfer<TAdapter>>): ApiMock<TAdapter>;
+export declare function createApiMock<TAdapter extends WeapiAdapter = WeapiCrossPlatformRawAdapter>(overrides?: ApiMockOverrides<NoInfer<TAdapter>>): ApiMock<TAdapter>;
 /**
  * @description 默认 API Vitest mock 单例。
  */
-declare const apiMock: ApiMock<WeapiMiniProgramCrossPlatformRawAdapter>;
+export declare const apiMock: ApiMock<WeapiMiniProgramCrossPlatformRawAdapter>;
 /**
  * @description 默认 API Vitest mock 单例的兼容名称。
  */
-declare const wpiMock: ApiMock<WeapiMiniProgramCrossPlatformRawAdapter>;
+export declare const wpiMock: ApiMock<WeapiMiniProgramCrossPlatformRawAdapter>;
 /**
  * @description 创建 API Vitest mock 的兼容名称。
  */
-declare const createWpiMock: typeof createApiMock;
+export declare const createWpiMock: typeof createApiMock;
 /**
  * @description 重置指定 API mock 自身已创建的方法，不影响其他 Vitest mocks。
  */
-declare function resetApiMock(mock?: ApiMock<any>): void;
+export declare function resetApiMock(mock?: ApiMock<any>): void;
 /**
  * @description 在 Vitest setup 文件中注册需要替换 API 实例的模块入口。
  */
-declare function setupApiMock(moduleIds: readonly string[]): void;
-//#endregion
-export { ApiMock, ApiMockOverrides, apiMock, createApiMock, createWpiMock, resetApiMock, setupApiMock, wpiMock };
+export declare function setupApiMock(moduleIds: readonly string[]): void;
+//#endregion

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@weapp-core/api",
   "type": "module",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "description": "Framework-agnostic cross-platform mini-program API proxy",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -15,12 +15,14 @@
     "url": "https://github.com/weapp-vite/weapp-vite/issues"
   },
   "keywords": [
+    "weapp-vite",
+    "weapp",
+    "wechat",
     "mini-program",
     "miniprogram",
     "cross-platform",
     "api",
-    "adapter",
-    "weapp"
+    "adapter"
   ],
   "sideEffects": [
     "./dist/vitest/setup.mjs"
@@ -69,6 +71,9 @@
     "dist",
     "types"
   ],
+  "engines": {
+    "node": "^20.19.0 || >=22.12.0"
+  },
   "peerDependencies": {
     "vitest": ">=4.0.0"
   },
@@ -89,7 +94,8 @@
     }
   },
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "registry": "https://registry.npmjs.org"
   },
   "scripts": {
     "dev": "tsdown -w",