feat(api): support api promisify in 2.10.2

Author: SgLy

CHANGELOG.md

@@ -1,3 +1,6 @@
+## 2020-03-18 v2.10.2-1
+- 支持 API Promise 化调用
+
 ## 2020-02-26 v2.10.2
 - 同步 API 定义到基础库 2.10.2
 - 将命名空间从 `wx` 更改为更正式的 `WechatMinigame`，这是一个 **破坏性改动**，原本字面上引用了 `wx` 命名空间的代码可能失效

VERSIONS.md

@@ -2,5 +2,5 @@
 
 基础库版本|npm 版本|命令
 -|-|-
-[v2.10.2](https://developers.weixin.qq.com/miniprogram/dev/framework/release/#v2-10-2-2020-02-20) | [2.10.2](https://www.npmjs.com/package/miniprogram-api-typings/v/2.10.2) | `npm install [email protected]`
+[v2.10.2](https://developers.weixin.qq.com/miniprogram/dev/framework/release/#v2-10-2-2020-02-20) | [2.10.2-1](https://www.npmjs.com/package/miniprogram-api-typings/v/2.10.2-1) | `npm install [email protected]-1`
 [v2.6.5](https://developers.weixin.qq.com/miniprogram/dev/framework/release/#v2-6-5-2019-04-02) | [2.6.5](https://www.npmjs.com/package/minigame-api-typings/v/2.6.5) | `npm install [email protected]`

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "minigame-api-typings",
-  "version": "2.10.2",
+  "version": "2.10.2-1",
   "description": "Type definitions for APIs of Wechat MiniGame in TypeScript",
   "main": "./index.d.ts",
   "types": "./index.d.ts",

package.json

@@ -0,0 +1,70 @@
+import { expectType } from 'tsd'
+
+// call with callback
+wx.getFriendCloudStorage({
+  keyList: [],
+  success(res) {
+    expectType<WechatMinigame.GetFriendCloudStorageSuccessCallbackResult>(res)
+  },
+})
+wx.requestMidasPayment({
+  currencyType: 'CNY',
+  mode: 'game',
+  offerId: '',
+  success(res) {
+    expectType<WechatMinigame.MidasPaymentError>(res)
+  },
+})
+wx.stopAccelerometer({
+  fail(res) {
+    expectType<WechatMinigame.GeneralCallbackResult>(res)
+  },
+})
+
+wx.stopCompass({
+  complete(res) {
+    expectType<WechatMinigame.GeneralCallbackResult>(res)
+  },
+})
+
+// call with Promise.prototype.then
+wx.getFriendCloudStorage({
+  keyList: [],
+}).then(res => {
+  expectType<WechatMinigame.GetFriendCloudStorageSuccessCallbackResult>(res)
+})
+wx.requestMidasPayment({
+  currencyType: 'CNY',
+  mode: 'game',
+  offerId: '',
+}).then(res => {
+  expectType<WechatMinigame.MidasPaymentError>(res)
+})
+wx.stopAccelerometer().then(res => {
+  expectType<WechatMinigame.GeneralCallbackResult>(res)
+})
+wx.stopCompass().then(res => {
+  expectType<WechatMinigame.GeneralCallbackResult>(res)
+})
+
+// call with await
+async () => {
+  expectType<WechatMinigame.GetFriendCloudStorageSuccessCallbackResult>(
+    await wx.getFriendCloudStorage({
+      keyList: [],
+    }),
+  )
+  expectType<WechatMinigame.MidasPaymentError>(
+    await wx.requestMidasPayment({
+      currencyType: 'CNY',
+      mode: 'game',
+      offerId: '',
+    }),
+  )
+  expectType<WechatMinigame.GeneralCallbackResult>(
+    await wx.stopAccelerometer(),
+  )
+  expectType<WechatMinigame.GeneralCallbackResult>(
+    await wx.stopCompass(),
+  )
+}

test/api_doc.test.ts renamed to test/api-doc.test.ts

@@ -5,7 +5,7 @@
     "experimentalDecorators": true,
     "inlineSourceMap": true,
     "inlineSources": true,
-    "lib": ["es5"],
+    "lib": ["es6"],
     "module": "CommonJS",
     "noFallthroughCasesInSwitch": true,
     "noImplicitAny": true,

test/api-promisify.test.ts

@@ -27,4 +27,17 @@ declare namespace WechatMinigame {
     type IAnyObject = Record<string, any>
     type Optional<F> = F extends (arg: infer P) => infer R ? (arg?: P) => R : F
     type OptionalInterface<T> = { [K in keyof T]: Optional<T[K]> }
+    interface AsyncMethodOptionLike {
+        success?: (...args: any[]) => void
+    }
+    type PromisifySuccessResult<
+        P,
+        T extends AsyncMethodOptionLike
+    > = P extends { success: any }
+        ? void
+        : P extends { fail: any }
+            ? void
+            : P extends { complete: any }
+                ? void
+                : Promise<Parameters<Exclude<T['success'], undefined>>[0]>
 }