新增：深层级的 API my.ap.xx、swan.ai.xx 和 createMapContext 之类的 API 处理

Author: ChanceYu

.gitignore

@@ -1,6 +1,7 @@
 .DS_Store
 .AppleDouble
 .LSOverride
+package-lock.json
 
 ._*
 

.npmignore

@@ -1,4 +1,7 @@
-examples
+assets
+example
 node_modules
 *.js.map
-webpack.config.js
+webpack.config.js
+package-lock.json
+CHANGELOG.md

CHANGELOG.md

@@ -1,3 +1,7 @@
+## 0.2.1
+- 新增：深层级的 API `my.ap.xx`、`swan.ai.xx` 和 `createMapContext` 之类的 API 处理
+- 修改：example 示例为 `mpvue`
+
 ## 0.2.0
 - 新增字节跳动小程序
 - 重构

README.md

@@ -2,7 +2,7 @@
 
 > mpapi（miniProgram API），小程序 API 兼容插件，一次编写，多端运行。
 
-:alarm_clock: 更新日期: 2019-05-30
+:alarm_clock: 更新日期: 2019-05-31
 
 [![NPM][img-npm-badge]][url-npm] [![Language][img-javascript]][url-github] [![License][img-mit]][url-mit]
 
@@ -32,28 +32,12 @@ api.alert({...}).then((res) => {})
 api.confirm({...}).then((res) => {})
 api.getLocation().then((res) => {})
 ...
-
-// 微信小程序的处理
-if(api.isWechat){
-  api.setTopBarText({...}).then((res) => {})
-}
-
-// 支付宝小程序的处理
-if(api.isAlipay){
-  api.startZMVerify({...}).then((res) => {})
-}
-
-// 百度智能小程序的处理
-if(api.isSwan){
-  api.getSwanId().then((res) => {})
-}
 ```
 
 
 ## 快速查看
 - [兼容 API 列表](#兼容api列表)
 - [其它包装成 Promise 的 API](#其它包装成promise的api)
-- [优化的 API](#优化的api)
 - [API 差异](#小程序之间的api差异)
 - [使用说明](#使用说明)
 - [特殊 API 的事件处理](#特殊api的事件处理)，`request`、`downloadFile`、`uploadFile` 等
@@ -119,7 +103,7 @@ if(api.isSwan){
 ## 其它包装成Promise的API
 > 只在特定小程序下才会支持。
 
-微信小程序![wx](./assets/wx.png)、支付宝小程序![my](./assets/my.png)、百度智能小程序![swan](./assets/swan.png)、字节跳动小程序![tt](./assets/tt.png)，有图标表示只支持对应小程序，没有图标表示支持所有小程序。
+微信小程序![wx](./assets/wx.png)、支付宝小程序![my](./assets/my.png)、百度智能小程序![swan](./assets/swan.png)、字节跳动小程序![tt](./assets/tt.png)，有图标表示只支持对应小程序，没有图标表示都支持。
 
 
 - 交互
@@ -354,6 +338,41 @@ if(api.isSwan){
 
 
 
+- **深层级的 API**
+  - `api.ap` ![my](./assets/my.png)
+    - [x] `api.ap.$faceVerify`
+    - [x] `api.ap.$navigateToAlipayPage`
+    - [x] `...`
+  - `api.ai` ![swan](./assets/swan.png)
+    - [x] `api.ai.$ocrIdCard`
+    - [x] `api.ai.$ocrBankCard`
+    - [x] `...`
+
+- **某些新实例的对象上面的 API**
+  
+  - [x] `createMapContext` ![%= lbl %>](./assets/wx.png) ![%= lbl %>](./assets/my.png) ![%= lbl %>](./assets/swan.png) 
+  - [x] `createVideoContext` ![%= lbl %>](./assets/wx.png) ![%= lbl %>](./assets/swan.png) 
+  - [x] `createAudioContext` ![%= lbl %>](./assets/wx.png) 
+  - [x] `createCameraContext` ![%= lbl %>](./assets/wx.png) ![%= lbl %>](./assets/swan.png) 
+  - [x] `createInnerAudioContext` ![%= lbl %>](./assets/wx.png) ![%= lbl %>](./assets/swan.png) ![%= lbl %>](./assets/tt.png) 
+  - [x] `createLivePusherContext` ![%= lbl %>](./assets/wx.png) 
+  - [x] `createLivePlayerContext` ![%= lbl %>](./assets/wx.png) 
+  - [x] `getBackgroundAudioManager` ![%= lbl %>](./assets/wx.png) ![%= lbl %>](./assets/swan.png) 
+  - [x] `getRecorderManager` ![%= lbl %>](./assets/wx.png) ![%= lbl %>](./assets/swan.png) ![%= lbl %>](./assets/tt.png) 
+  - [x] `createSelectorQuery` 
+  - [x] `getFileSystemManager` ![%= lbl %>](./assets/wx.png) 
+  - [x] `createARCameraContext` ![%= lbl %>](./assets/swan.png) 
+
+例如：**注意：方法加了 `$` 前缀**
+```javascript
+let ctx = api.createMapContext('maper')
+
+ctx.$getCenterLocation().then((res) => {
+  console.log('createMapContext:getCenterLocation')
+  console.log(res)
+})
+```
+
 
 ## 小程序之间的API差异
 
@@ -492,14 +511,6 @@ api.chooseImage({
 })
 ```
 
-3、深层级的 API，也可以通过 `api` 来调用，并且支持 `Promise` 语法（**有 `success` 回调的才有**）
-```javascript
-// 支付宝小程序支持的
-api.ap.imgRisk({...}).then((res) => {})
-api.ap.navigateToAlipayPage({...}).then((res) => {})
-...
-```
-
 
 ## 特殊API的事件处理
 某些 API 既要支持 Promise，又要调用它的事件，那么可以采用如下方式：
@@ -544,7 +555,7 @@ downloadTask.$event('onProgressUpdate', (res) => {
 
 
 ## Changelog
-[更新日志](./CHANGELOG.md)。
+[更新日志](./CHANGELOG.md)
 
 
 ## License

TEMPLATE.md

@@ -32,28 +32,12 @@ api.alert({...}).then((res) => {})
 api.confirm({...}).then((res) => {})
 api.getLocation().then((res) => {})
 ...
-
-// 微信小程序的处理
-if(api.isWechat){
-  api.setTopBarText({...}).then((res) => {})
-}
-
-// 支付宝小程序的处理
-if(api.isAlipay){
-  api.startZMVerify({...}).then((res) => {})
-}
-
-// 百度智能小程序的处理
-if(api.isSwan){
-  api.getSwanId().then((res) => {})
-}
 ```
 
 
 ## 快速查看
 - [兼容 API 列表](#兼容api列表)
 - [其它包装成 Promise 的 API](#其它包装成promise的api)
-- [优化的 API](#优化的api)
 - [API 差异](#小程序之间的api差异)
 - [使用说明](#使用说明)
 - [特殊 API 的事件处理](#特殊api的事件处理)，`request`、`downloadFile`、`uploadFile` 等
@@ -71,14 +55,38 @@ if(api.isSwan){
 ## 其它包装成Promise的API
 > 只在特定小程序下才会支持。
 
-微信小程序![wx](./assets/wx.png)、支付宝小程序![my](./assets/my.png)、百度智能小程序![swan](./assets/swan.png)、字节跳动小程序![tt](./assets/tt.png)，有图标表示只支持对应小程序，没有图标表示支持所有小程序。
+微信小程序![wx](./assets/wx.png)、支付宝小程序![my](./assets/my.png)、百度智能小程序![swan](./assets/swan.png)、字节跳动小程序![tt](./assets/tt.png)，有图标表示只支持对应小程序，没有图标表示都支持。
 
 <% _.each(obj.normalApi, function(group){ %>
 - <%= group.title %>
 <% _.each(group.items, function(item){ %>  - [x] `<%= item.title %>` <% _.each(item.labels, function(lbl){ %> ![%= lbl %>](./assets/<%= lbl %>.png) <% }) %>
 <% }) %>
 <% }) %>
 
+- **深层级的 API**
+  - `api.ap` ![my](./assets/my.png)
+    - [x] `api.ap.$faceVerify`
+    - [x] `api.ap.$navigateToAlipayPage`
+    - [x] `...`
+  - `api.ai` ![swan](./assets/swan.png)
+    - [x] `api.ai.$ocrIdCard`
+    - [x] `api.ai.$ocrBankCard`
+    - [x] `...`
+
+- **某些新实例的对象上面的 API**
+  <% _.each(obj.instanceApi, function(group){ %>
+  - [x] `<%= group.title %>` <% _.each(group.labels, function(lbl){ %>![%= lbl %>](./assets/<%= lbl %>.png) <% }) %><% }) %>
+
+例如：**注意：方法加了 `$` 前缀**
+```javascript
+let ctx = api.createMapContext('maper')
+
+ctx.$getCenterLocation().then((res) => {
+  console.log('createMapContext:getCenterLocation')
+  console.log(res)
+})
+```
+
 
 ## 小程序之间的API差异
 
@@ -217,14 +225,6 @@ api.chooseImage({
 })
 ```
 
-3、深层级的 API，也可以通过 `api` 来调用，并且支持 `Promise` 语法（**有 `success` 回调的才有**）
-```javascript
-// 支付宝小程序支持的
-api.ap.imgRisk({...}).then((res) => {})
-api.ap.navigateToAlipayPage({...}).then((res) => {})
-...
-```
-
 
 ## 特殊API的事件处理
 某些 API 既要支持 Promise，又要调用它的事件，那么可以采用如下方式：
@@ -269,7 +269,7 @@ downloadTask.$event('onProgressUpdate', (res) => {
 
 
 ## Changelog
-[更新日志](./CHANGELOG.md)。
+[更新日志](./CHANGELOG.md)
 
 
 ## License

doc.js

@@ -8,9 +8,11 @@ const TEMPLATE = path.join(__dirname, 'TEMPLATE.md')
 const README = path.join(__dirname, 'README.md')
 
 const NORMALAPI_FILE = path.join(__dirname, 'src/api/normalApi.js')
+const INSTANCEAPI_FILE = path.join(__dirname, 'src/api/instanceApi.js')
 const POLYFILLS_FILE = path.join(__dirname, 'src/polyfills/index.js')
 
 let NORMALAPI_DATA = []
+let INSTANCEAPI_DATA = []
 let POLYFILLS_DATA = []
 
 // normalApi.js 转换成数组数据
@@ -53,6 +55,43 @@ function handlerNormalApi(){
 }
 
 
+
+// instanceApi.js 转换成数组数据
+function handlerInstanceApi(){
+  let rl = readline(INSTANCEAPI_FILE, { retainBuffer: true })
+
+  let ready = false
+
+  return new Promise((resolve) => {
+    rl.on('line', (data) => {
+      let content = data.toString()
+      
+      if(/module\.exports/.test(content)){
+        ready = true
+      }
+  
+      if(ready){
+        let matchApi = content.match(/'(\w+)',(\s+\/\/\s+([\w\s]+))?/)
+        if(matchApi && matchApi[1]){
+          let labels = []
+  
+          if(matchApi[3]){
+            labels = matchApi[3].split(/\s/)
+          }
+          
+          INSTANCEAPI_DATA.push({
+            title: matchApi[1],
+            labels: labels
+          })
+        }
+      }
+    });
+  
+    rl.on('end', resolve)
+  })
+}
+
+
 // polyfills/index.js 转换成数组数据
 function handlerPolyfills(){
   let rl = readline(POLYFILLS_FILE, { retainBuffer: true })
@@ -102,6 +141,7 @@ function writeMarkdown(){
 
   tplContent = compiled({
     updateDate: moment().format('YYYY-MM-DD'),
+    instanceApi: INSTANCEAPI_DATA,
     normalApi: NORMALAPI_DATA,
     polyfills: POLYFILLS_DATA
   });
@@ -111,6 +151,7 @@ function writeMarkdown(){
 
 async function init(){
   await handlerNormalApi()
+  await handlerInstanceApi()
   await handlerPolyfills()
 
   writeMarkdown()

example/mpvue/.babelrc

@@ -0,0 +1,18 @@
+{
+  "presets": [
+    ["env", {
+      "modules": false,
+      "targets": {
+        "browsers": ["> 1%", "last 2 versions", "not ie <= 8"]
+      }
+    }],
+    "stage-2"
+  ],
+  "plugins": ["transform-runtime"],
+  "env": {
+    "test": {
+      "presets": ["env", "stage-2"],
+      "plugins": ["istanbul"]
+    }
+  }
+}

example/mpvue/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

example/mpvue/.eslintignore

@@ -0,0 +1,2 @@
+build/*.js
+config/*.js

example/mpvue/.eslintrc.js

@@ -0,0 +1,42 @@
+// http://eslint.org/docs/user-guide/configuring
+
+module.exports = {
+  root: true,
+  parser: 'babel-eslint',
+  parserOptions: {
+    sourceType: 'module'
+  },
+  env: {
+    browser: false,
+    node: true,
+    es6: true
+  },
+  // https://github.com/standard/standard/blob/master/docs/RULES-en.md
+  extends: 'standard',
+  // required to lint *.vue files
+  plugins: [
+    'html'
+  ],
+  // add your custom rules here
+  'rules': {
+    // allow paren-less arrow functions
+    'arrow-parens': 0,
+    // allow async-await
+    'generator-star-spacing': 0,
+    // allow debugger during development
+    'no-debugger': process.env.NODE_ENV === 'production' ? 2 : 0
+  },
+  globals: {
+    App: true,
+    Page: true,
+    wx: true,
+    swan: true,
+    tt: true,
+    my: true,
+    getApp: true,
+    getPage: true,
+    requirePlugin: true,
+    mpvue: true,
+    mpvuePlatform: true
+  }
+}