@wevu/api 0.2.15 → 0.2.17

package/dist/index.d.mts

@@ -135,18 +135,6 @@ type WeapiMiniProgramBluetoothError = Parameters<NonNullable<WeapiMiniProgramCre
  */
 type WeapiMiniProgramClipboardDataResult = Parameters<NonNullable<NonNullable<WeapiMiniProgramClipboardOption>['success']>>[0];
 //#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"];
-type WeapiNonPromisifiedMethodName = typeof WEAPI_NON_PROMISIFIED_METHOD_NAMES[number];
-//#endregion
 //#region src/core/platformAdapters.d.ts
 type MergeAdapters<Primary extends WeapiAdapter, Secondary extends WeapiAdapter> = Primary & Omit<Secondary, keyof Primary>;
 /**
@@ -177,6 +165,75 @@ 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"];
+type WeapiNonPromisifiedMethodName = typeof WEAPI_NON_PROMISIFIED_METHOD_NAMES[number];
+//#endregion
+//#region src/core/promisify/index.d.ts
+type WeapiAdapter = Record<string, any>;
+/**
+ * @description weapi Promise 的通用错误类型
+ */
+interface WeapiError {
+  errMsg: string;
+  errno?: number;
+}
+/**
+ * @description 保留拒绝原因类型的 Promise
+ */
+interface WeapiPromise<TResult, TError = WeapiError> extends Promise<TResult> {
+  then: <TResult1 = TResult, TResult2 = never>(onfulfilled?: ((value: TResult) => PromiseLike<TResult1> | TResult1) | null, onrejected?: ((reason: TError) => PromiseLike<TResult2> | TResult2) | null) => WeapiPromise<TResult1 | TResult2, TError>;
+  catch: <TResult2 = never>(onrejected?: ((reason: TError) => PromiseLike<TResult2> | TResult2) | null) => WeapiPromise<TResult | TResult2, TError>;
+  finally: (onfinally?: (() => void) | null) => WeapiPromise<TResult, TError>;
+}
+type HasCallbackKey<T> = T extends object ? 'success' extends keyof T ? true : 'fail' extends keyof T ? true : 'complete' extends keyof T ? true : false : false;
+type HasCallbackOption<T> = T extends {
+  success: unknown;
+} ? true : T extends {
+  fail: unknown;
+} ? true : T extends {
+  complete: unknown;
+} ? true : false;
+type ExtractSuccessResult<T> = T extends {
+  success?: (...args: infer A) => unknown;
+} ? A[0] : void;
+type ExtractFailureResult<T> = 'fail' extends keyof T ? T extends {
+  fail?: (...args: infer A) => unknown;
+} ? A[0] : never : never;
+type IsAny<T> = 0 extends (1 & T) ? true : false;
+type NormalizeFailureResult<T> = IsAny<T> extends true ? WeapiError : unknown extends T ? WeapiError : [T] extends [never] ? WeapiError : T;
+type WechatErrorExtension<TAdapter> = TAdapter extends WeapiMiniProgramWechatRawAdapter ? Pick<WeapiError, 'errno'> : object;
+type PromisifyFailureResult<Option, TAdapter> = NormalizeFailureResult<ExtractFailureResult<Option>> & WechatErrorExtension<TAdapter>;
+type PromisifyOptionMethod<Prefix extends any[], Option extends object, Result, IsOptional extends boolean, TAdapter> = IsOptional extends true ? {
+  <TOption extends Option>(...args: [...Prefix, TOption]): HasCallbackOption<TOption> extends true ? Result : WeapiPromise<ExtractSuccessResult<Option>, PromisifyFailureResult<Option, TAdapter>>;
+  (...args: Prefix): WeapiPromise<ExtractSuccessResult<Option>, PromisifyFailureResult<Option, TAdapter>>;
+} : {
+  <TOption extends Option>(...args: [...Prefix, TOption]): HasCallbackOption<TOption> extends true ? Result : WeapiPromise<ExtractSuccessResult<Option>, PromisifyFailureResult<Option, TAdapter>>;
+};
+type NormalizePromisifyReturn<T, TAdapter> = T extends Promise<infer TResult> ? WeapiPromise<TResult, WeapiError & WechatErrorExtension<TAdapter>> : WeapiPromise<T, WeapiError & WechatErrorExtension<TAdapter>>;
+type NormalizeTupleArgs<Args extends any[]> = { [Key in keyof Args]-?: Args[Key]; };
+type DecomposeTrailingArg<Args extends any[]> = NormalizeTupleArgs<Args> extends [...infer Prefix, infer Last] ? {
+  prefix: Prefix;
+  last: Last;
+} : never;
+type IsOptionalTrailingArg<Args extends any[], Prefix extends any[]> = Record<never, never> extends Pick<Args, Prefix['length']> ? true : false;
+type RequiredObjectKeys<T extends object> = { [Key in keyof T]-?: Pick<T, Key> extends Required<Pick<T, Key>> ? Key : never; }[keyof T];
+type IsStructurallyOmittableObject<T> = T extends object ? RequiredObjectKeys<T> extends never ? true : false : false;
+type IsOmittableTrailingArg<Args extends any[], Prefix extends any[], Last> = IsOptionalTrailingArg<Args, Prefix> extends true ? true : IsStructurallyOmittableObject<NonNullable<Last>>;
+type PromisifyMethod<TMethod, TAdapter> = TMethod extends ((...args: infer Args) => infer Result) ? Args extends [] ? (...args: Args) => NormalizePromisifyReturn<Result, TAdapter> : DecomposeTrailingArg<Args> extends {
+  prefix: infer Prefix extends any[];
+  last: infer Last;
+} ? true extends HasCallbackKey<NonNullable<Last>> ? PromisifyOptionMethod<Prefix, NonNullable<Last>, Result, IsOmittableTrailingArg<Args, Prefix, Last>, TAdapter> : (...args: Args) => NormalizePromisifyReturn<Result, TAdapter> : (...args: Args) => NormalizePromisifyReturn<Result, TAdapter> : TMethod;
+type WeapiPromisify<TAdapter extends WeapiAdapter> = { [Key in keyof TAdapter]: Key extends string ? Key extends `${string}Sync` ? TAdapter[Key] : Key extends WeapiNonPromisifiedMethodName ? TAdapter[Key] : Key extends `on${Capitalize<string>}` | `off${Capitalize<string>}` ? TAdapter[Key] : PromisifyMethod<TAdapter[Key], TAdapter> : TAdapter[Key]; };
+//#endregion
 //#region src/core/types/methodDocsCanvasGetImageDataToOpenPrivacyContract/canvasGetImageDataToOpenChannelsActivity.d.ts
 interface WeapiCrossPlatformMethodDocsCanvasGetImageDataToOpenPrivacyContractCanvasGetImageDataToOpenChannelsActivity {
   /**
@@ -8126,39 +8183,6 @@ type WeapiCrossPlatformMethodDocsShowToastToOpenAppAuthorizeSetting = WeapiCross
 type WeapiCrossPlatformMethodDocs = WeapiCrossPlatformMethodDocsShowToastToOpenAppAuthorizeSetting & WeapiCrossPlatformMethodDocsPluginLoginToGetAppBaseInfo & WeapiCrossPlatformMethodDocsChooseVideoToOpenDocument & WeapiCrossPlatformMethodDocsSaveVideoToPhotosAlbumToCanAddSecureElementPass & WeapiCrossPlatformMethodDocsCanvasGetImageDataToOpenPrivacyContract & WeapiCrossPlatformMethodDocsOpenSystemBluetoothSettingToChooseLicensePlate & WeapiCrossPlatformMethodDocsChoosePoiToShareFileToGroup & WeapiCrossPlatformMethodDocsShareImageToGroupToSelectGroupMembers & WeapiCrossPlatformMethodDocsSendHCEMessageToGetRandomValues & WeapiCrossPlatformMethodDocsGetRealtimeLogManagerToCreateUDPSocket & WeapiCrossPlatformMethodDocsCreateVideoDecoderToSetInnerAudioOption & WeapiCrossPlatformMethodDocsMissingMethods;
 //#endregion
 //#region src/core/types.d.ts
-type WeapiAdapter = Record<string, any>;
-type HasCallbackKey<T> = T extends object ? 'success' extends keyof T ? true : 'fail' extends keyof T ? true : 'complete' extends keyof T ? true : false : false;
-type HasCallbackOption<T> = T extends {
-  success: unknown;
-} ? true : T extends {
-  fail: unknown;
-} ? true : T extends {
-  complete: unknown;
-} ? true : false;
-type ExtractSuccessResult<T> = T extends {
-  success?: (...args: infer A) => unknown;
-} ? A[0] : void;
-type PromisifyOptionMethod<Prefix extends any[], Option extends object, Result, IsOptional extends boolean> = IsOptional extends true ? {
-  <TOption extends Option>(...args: [...Prefix, TOption]): HasCallbackOption<TOption> extends true ? Result : Promise<ExtractSuccessResult<Option>>;
-  (...args: Prefix): Promise<ExtractSuccessResult<Option>>;
-} : {
-  <TOption extends Option>(...args: [...Prefix, TOption]): HasCallbackOption<TOption> extends true ? Result : Promise<ExtractSuccessResult<Option>>;
-};
-type NormalizePromisifyReturn<T> = T extends Promise<any> ? T : Promise<T>;
-type NormalizeTupleArgs<Args extends any[]> = { [Key in keyof Args]-?: Args[Key]; };
-type DecomposeTrailingArg<Args extends any[]> = NormalizeTupleArgs<Args> extends [...infer Prefix, infer Last] ? {
-  prefix: Prefix;
-  last: Last;
-} : never;
-type IsOptionalTrailingArg<Args extends any[], Prefix extends any[]> = Record<never, never> extends Pick<Args, Prefix['length']> ? true : false;
-type RequiredObjectKeys<T extends object> = { [Key in keyof T]-?: Pick<T, Key> extends Required<Pick<T, Key>> ? Key : never; }[keyof T];
-type IsStructurallyOmittableObject<T> = T extends object ? (RequiredObjectKeys<T> extends never ? true : false) : false;
-type IsOmittableTrailingArg<Args extends any[], Prefix extends any[], Last> = IsOptionalTrailingArg<Args, Prefix> extends true ? true : IsStructurallyOmittableObject<NonNullable<Last>>;
-type PromisifyMethod<TMethod> = TMethod extends ((...args: infer Args) => infer Result) ? Args extends [] ? (...args: Args) => NormalizePromisifyReturn<Result> : DecomposeTrailingArg<Args> extends {
-  prefix: infer Prefix extends any[];
-  last: infer Last;
-} ? true extends HasCallbackKey<NonNullable<Last>> ? PromisifyOptionMethod<Prefix, NonNullable<Last>, Result, IsOmittableTrailingArg<Args, Prefix, Last>> : (...args: Args) => NormalizePromisifyReturn<Result> : (...args: Args) => NormalizePromisifyReturn<Result> : TMethod;
-type WeapiPromisify<TAdapter extends WeapiAdapter> = { [Key in keyof TAdapter]: Key extends string ? Key extends `${string}Sync` ? TAdapter[Key] : Key extends WeapiNonPromisifiedMethodName ? TAdapter[Key] : Key extends `on${Capitalize<string>}` | `off${Capitalize<string>}` ? TAdapter[Key] : PromisifyMethod<TAdapter[Key]> : TAdapter[Key]; };
 /**
  * @description 微信小程序 API 适配器类型
  */
@@ -8402,4 +8426,4 @@ type WeapiDouyinMethodName = WeapiMiniProgramDouyinMethodName;
  */
 declare const wpi: WeapiInstance<WeapiMiniProgramCrossPlatformRawAdapter>;
 //#endregion
-export { type CreateWeapiOptions, 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 WeapiInstance, 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 WeapiMiniProgramLogManager, type WeapiMiniProgramMethodName, type WeapiMiniProgramPlatformRawAdapterSourceName, type WeapiMiniProgramPlatformRawAdapterSourceRegistry, type WeapiMiniProgramRawAdapter, type WeapiMiniProgramRawAdapterSourceName, 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 WeapiPromisify, type WeapiResolvedTarget, type WeapiRuntimeTypeSourceName, type WeapiSupportLevel, type WeapiTtMiniProgramRawAdapterSource, type WeapiTypeSourceName, type WeapiWechatMethodName, type WeapiWechatMiniProgramRawAdapterSource, type WeapiWechatRawAdapter, type WeapiWxAdapter, type WeapiWxMethodName, type WeapiWxRawAdapter, createWeapi, wpi };
+export { type CreateWeapiOptions, 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 WeapiInstance, 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 WeapiMiniProgramLogManager, type WeapiMiniProgramMethodName, type WeapiMiniProgramPlatformRawAdapterSourceName, type WeapiMiniProgramPlatformRawAdapterSourceRegistry, type WeapiMiniProgramRawAdapter, type WeapiMiniProgramRawAdapterSourceName, 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, createWeapi, wpi };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@wevu/api",
   "type": "module",
-  "version": "0.2.15",
+  "version": "0.2.17",
   "description": "tsdown bundler template",
   "author": "ice breaker <1324318532@qq.com>",
   "license": "MIT",
@@ -35,7 +35,7 @@
     "@douyin-microapp/typings": "^1.3.1",
     "@mini-types/alipay": "^3.0.14",
     "miniprogram-api-typings": "^5.2.3",
-    "@weapp-core/shared": "3.1.0"
+    "@weapp-core/shared": "3.2.0"
   },
   "publishConfig": {
     "access": "public"

package/types/index.d.ts

@@ -17,6 +17,7 @@ import type {
   WeapiDouyinMethodName,
   WeapiDouyinMiniProgramRawAdapterSource,
   WeapiDouyinRawAdapter,
+  WeapiError,
   WeapiInstance,
   WeapiMethodSupportQueryOptions,
   WeapiMiniProgramAdapter,
@@ -54,6 +55,7 @@ import type {
   WeapiMiniProgramWxMethodName,
   WeapiMiniProgramWxRawAdapter,
   WeapiPlatformTypeSourceName,
+  WeapiPromise,
   WeapiPromisify,
   WeapiResolvedTarget,
   WeapiRuntimeTypeSourceName,
@@ -86,6 +88,7 @@ export type {
   WeapiDouyinMethodName,
   WeapiDouyinMiniProgramRawAdapterSource,
   WeapiDouyinRawAdapter,
+  WeapiError,
   WeapiInstance,
   WeapiMethodSupportQueryOptions,
   WeapiMiniProgramAdapter,
@@ -123,6 +126,7 @@ export type {
   WeapiMiniProgramWxMethodName,
   WeapiMiniProgramWxRawAdapter,
   WeapiPlatformTypeSourceName,
+  WeapiPromise,
   WeapiPromisify,
   WeapiResolvedTarget,
   WeapiRuntimeTypeSourceName,