@alipay-inc/mpaas-ide-openapi 1.0.0-beta.8 → 1.0.4-alpha.1

package/README.md

@@ -8,18 +8,19 @@
 
 #### 私有云 
 
+- 请联系PDSA
 
 
 ### 接口返回数据标准
 
 ```js
 {
-  data:      'any',      // 返回数据
-  errorCode: 'string',   // 错误代码，非必选
-  requestId: 'string',   // 请求ID，非必选
-  resultMsg: 'string',   // 当success !== true，必选
-  success:   'boolean',  // 是否正确返回
-  ...                    // 各环境自定义字段
+  data:      '<any>',     // 返回数据
+  errorCode: '<string>',  // 错误代码，非必选
+  requestId: '<string>',  // 请求ID，非必选
+  resultMsg: '<string>',  // 当success !== true，必选
+  success:   '<boolean>', // 是否正确返回
+  ...                     // 各环境自定义字段
 }
 ```
 
@@ -36,28 +37,40 @@
     - ```javascript
       {
         ...配置文件内容,
-        openapi: {
-          type:            'aliyun',
-          accessKeyId:     '<阿里云 AccessKey ID>',
-          accessKeySecret: '<阿里云 AccessKey Secret>',
-          endpoint:        'mpaas.cn-hangzhou.aliyuncs.com',
+        "openapi": {
+          "type":            'aliyun',                             // 必填、固定值
+          "userId":          '<string>',                           // 必填、字母数字下划线
+          "accessKeyId":     '<阿里云 AccessKey ID>',               // 必填
+          "accessKeySecret": '<阿里云 AccessKey Secret>',           // 必填
+          "endpoint":        'mpaas.cn-hangzhou.aliyuncs.com',     // 必填、固定值
         }
       }
       ```
-
+  
   - 私有化openapi，需要配置rsa
-
+  
     - ```javascript
       {
         ...配置文件内容,
-        openapi: {
-          type:            'antfin',
-          privateKey:      '<私钥 string format>',
-          api_url:         '<私有云api地址>'
+        "openapi": {
+          "type":            'antfin',                             // 必填、固定值
+          "userId":          '<string>',                           // 必填、字母数字下划线
+          "privateKey":      '<私钥 string format>',                // 必填 https://www.samltool.com/format_privatekey.php
+          "api_url":         '<私有云api地址>'                       // 必填
         }
       }
       ```
+      
     
+  - 如果需要详细日志，可以在配置文件中加一个字段，将产生一个 .mpaas-ide-openapi.${yyyy-MM-dd}.log 文件
+  
+    - ```js
+      {
+        ...配置文件内容,
+        "log": true
+      }
+      ```
+  
       
 
 ### 使用方法
@@ -80,7 +93,7 @@
   
   
 
-### 主要API
+### API
 
 #### getAppListByApi 拉取小程序列表 
 
@@ -92,314 +105,139 @@
     {
       data: [
        {
-          appCode:     'string',
-          gmtCreate:   'string'
-          gmtModified: 'string',
-          h5Id:        'string',
-          h5Name:      'string'
-        }
+          appCode:     '<string>',
+          gmtCreate:   '<string>',
+          gmtModified: '<string>',
+          h5Id:        '<string>',
+          h5Name:      '<string>',
+         ...
+        },
+        ...
       ],
       errorCode: 'OK',
-      requestId: 'string',
+      requestId: '<string>',
       resultMsg: '',
       success:   true
     }
     ```
 
-
 #### getPackageInfoByApi 拉取小程序配置 
 
-- 入参
-
-  - ```js
-    {
-      h5Id:         'string',
-      packageTypes: 'string'  // 可选，默认 '1,2,3,4'
-    }
-    ```
-
-- 返回
-
-  - ```javascript
-    {
-      data: {
-        appCode: 'ONEX7036F60021129-a3',
-        autoInstall: 0,
-        clientVersionMax: '',
-        clientVersionMin: '0.0.0.0;0.0.0.0',
-        downloadUrl: 'https://mcube-prod.cn-hangzhou.oss.aliyuncs.com/ONEX7036F60021129-a3/1234567890123452/1.0.0.1_all/nebula/1234567890123452_1.0.0.1.amr',
-        extendInfo: '',
-        extraData: '{"enableKeepAlive":"0","enableOptionMenu":"1","enableTabBar":"0","iconUrl":"https://mcube-prod.cn-hangzhou.oss.aliyuncs.com/ONEX7036F60021129-a3/1234567890123452/1.0.0.1_all/icon/1234567890123452_1.0.0.1_版权.png","resourceType":"4"}',
-        fallbackBaseUrl: 'https://mcube-prod.cn-hangzhou.oss.aliyuncs.com/ONEX7036F60021129-a3/1234567890123452/1.0.0.1_all/nebula/fallback/;https://mcube-prod.cn-hangzhou.oss.aliyuncs.com/ONEX7036F60021129-a3/1234567890123452/1.0.0.1_all/nebula/fallback/',
-        gmtCreate: '2021-07-22 16:13:44',
-        gmtModified: '2021-07-22 16:23:43',
-        h5Id: '1234567890123452',
-        h5Name: '小程序5',
-        h5Version: '1.0.0.1',
-        id: 587253,
-        installType: 0,
-        mainUrl: '',
-        memo: 'https://mcube-prod.cn-hangzhou.oss.aliyuncs.com/ONEX7036F60021129-a3/1234567890123452/1.0.0.1_all/nebula/nebula_json/h5_json.json',
-        packageType: 1,
-        platform: 'all',
-        publishPeriod: 3,
-        resourceType: 4,
-        status: 1
-      },
-      errorCode: 'OK',
-      requestId: 'string',
-      resultMsg: '',
-      success: true
-    }
-    ```
-
-#### createWhiteListByApi 创建白名单 
+- 若此小程序从未发布过，则读取默认配置
 
 - 入参
 
   - ```js
     {
-      userId:         'string',  // IDE 中如果非openapi的话，拿login返回的userId。如果是openapi去local设置的uuid
-      whitelistValue: 'string'
+      h5Id:         '<string>',  // 必填，小程序ID
+      h5Name:       '<string>',  // 必填，小程序名称
+      packageTypes: '<string>'   // 可选，默认 '1,2,3,4'
     }
     ```
 
 - 返回
 
-  - ```js
+  - ```javascript
     {
-      data:      'string',	// 创建的白名单ID
+      data:      '<object>',
       errorCode: 'OK',
-      requestId: 'string',
+      requestId: '<string>',
       resultMsg: '',
       success:   true
     }
     ```
 
-#### uploadPackage 上传小程序包 
-
-- 入参
-
-  - ```js
-    {
-      appInfo:        'object',  // 小程序配置
-      packageType:    'string',  // 包类型  （1,2 为正式包。3,4 为测试包）
-      resourceFile:   'string',  // 小程序包的本地绝对路径 （远程包需要自行下载到本地转换为本地绝对路径）
-      iconFile:       'string',  // 小程序图标的本地绝对路径 （远程包需要自行下载到本地转换为本地绝对路径）
-    }
-    ```
+#### uploadPackageByApi 上传小程序并发布
 
-- 返回
+- 上传小程序包之前，需要检测是否配置虚拟域名，若未配置，则报错
 
-  - ```js
-    {
-      data:      'string',	// 上传任务ID
-      errorCode: 'OK',
-      requestId: 'string',
-      resultMsg: '',
-      success:   true
-    }
-    ```
+- 预览调试包上传并发布，正式包只上传
 
-#### createNebulaTask 发布小程序
+- 调试包上传之前需要检测是否有白名单，若无白名单，则直接报错返回
 
 - 入参
 
   - ```js
     {
-      packageId:      'string',  // 白名单ID
-      whitelistIds:   'string',  // 上传任务ID
+      appInfo:        '<object>',  // 必填，小程序配置
+      packageType:    '<string>',  // 必填，包类型（1,2 为正式包。3,4 为测试包）
+      resourceFile:   '<string>',  // 必填，小程序包的本地绝对路径
+      iconFile:       '<string>',  // 选填，小程序图标的本地绝对路径
+      h5Version:      '<string>',  // 选填，版本号（若传入，则使用此版本号。若未传入，则使用appInfo.h5Version + packageType生成新的版本号）
+      whitelistValue: '<string>',  // 选填，白名单（若packageType === '3' || '4'，则为测试包，需要白名单）
+      sourceCodeFile: '<string>',  // 选填，源码包本地的压缩包地址
     }
     ```
 
 - 返回
 
-  - ```js
+  - ```javascript
     {
-      data:      'string',	// 发布任务ID
+      data:      '<string>',
+      // packageType === 3 || 4。"{&quot;debugUrl&quot;:&quot;mpaas://platformapi/startapp?appId=20001101&amp;token=ide_qr&amp;scheme=mpaas%3A%2F%2Fplatformapi%2Fstartapp%3FappId%3D1234567890123456%26nbsv%3D1.4.25.62%26nbsource%3Ddebug%26nbprefer%3DYES%26nbsn%3DDEBUG%26nboffline%3Dsync%26nbtoken%3Dide_qr%26enableBugme%3Dfalse%26chInfo%3Dch_scan%26channelId%3Dnull%26enablePolyfillWorker%3D%26isRemoteDebug%3Dfalse%26enableBugme%3Dfalse%26websocketUrl%3Dwss%3A%2F%2Fcn-hangzhou-mproxy.cloud.alipay.com&quot;,&quot;userId&quot;:&quot;shengyong_zhu&quot;}"
+      // packageType === 1 || 2。 "发布ID"
       errorCode: 'OK',
-      requestId: 'string',
+      requestId: '<string>',
       resultMsg: '',
       success:   true
     }
     ```
 
+### 公共API
 
-
-#### uploadPackageByApi 上传小程序并发布
-
-- 集合了createWhiteListByApi、uploadPackage、createNebulaTask 三个接口
-
-- 预览调试包上传并发布，正式包只上传。
-- 调试包上传之前需要检测是否有白名单，若无白名单，则直接报错返回。
-
-- 此接口只有IDE原有的classic提供，其他端需要模拟
-  - https://yuque.antfin-inc.com/docs/share/7a4a6272-36e4-4176-b50d-2d346a351267?#%20%E3%80%8AIDE%E4%B8%8A%E4%BC%A0%E5%B0%8F%E7%A8%8B%E5%BA%8F%E5%8C%85%E6%8E%A5%E5%8F%A3%E8%AF%B4%E6%98%8E%E3%80%8B
-
-- 入参
-
-  - ```javascript
-    {
-      appInfo:        'object',  // 小程序配置
-      packageType:    'string',  // 包类型  （1,2 为正式包。3,4 为测试包）
-      resourceFile:   'string',  // 小程序包的本地绝对路径 （远程包需要自行下载到本地转换为本地绝对路径）
-      iconFile:       'string',  // 小程序图标的本地绝对路径 （远程包需要自行下载到本地转换为本地绝对路径）
-      h5Version:      'string',  // 版本号，可选。（若传入，则使用此版本号。若未传入，则使用appInfo.h5Version + packageType生成新的版本号）
-      whitelistValue: 'string',  // 白名单（若packageType === '3' || '4'，则为测试包，需要白名单）
-      userId:         'string',  // 可选。用来区分白名单名称 `${appId}-${workspaceId}-${tenantId}-${userId}`
-    }
-    ```
-
-
-
-### 通用API
-
-#### uploadFile 上传文件 
+#### cloudBuild 云构建小程序
 
 - 入参
 
   - ```js
     {
-      filePath: 'string', // 目前支持本地文件的绝对路径，后期可以考虑file object/远程文件地址
+      file:         '<string>', // 必填，本地amr文件路径、或者本地项目的根目录
+      config:       '<object>', // 必填，配置文件
+      h5Id:         '<string>', // 必填，mPaaS小程序ID
     }
     ```
 
 - 返回
 
-  - ```js
-    {
-      data:      'string',  // 上传文件后保存在服务器的地址
-      errorCode: '',
-      success:   true
-    }
-    ```
-
-#### getVersion 获取版本 
-
-- 入参
-
-  - ```js
-    {
-      version: '1.1.1.5'
-    }
-    ```
-
-- 返回
-
-  - ```js
+  - ```javascript
     {
       data: {
-        current:  '1.1.1.5',  // 当前版本
-        nextProd: '1.1.2.0',  // 下一生产版本
-        nextDev:  '1.1.1.6'  // 下一测试版本
+        file:       '<string>',  // 本地根据h5Id生成的mPaaS zip文件，可以直接从控制台上传
+        originFile: '<string>'   // 云构建原始文件
       },
-      success:    true
+      success:      true
     }
     ```
 
-#### getUUID 获取uuid 
+#### getZipFromTar 将本地IDE/mpaasu构建后的小程序tar文件转为mPaaS格式的zip文件
 
 - 入参
 
   - ```js
     {
-      url: 'string'
+      tarFilePath:  '<string>', // 必填，本地tar文件
+      h5Id:         '<string>'  // 必填，mPaaS小程序ID
     }
     ```
 
 - 返回
 
-  - ```js
-    {
-      data:    'dbc1898e-2501-417f-b2dc-5e6e1fc2739e',
-      success: true
-    }
-    ```
-
-#### getZipFromTar tar文件转zip ，用来拿到IDE/mpaasu 构建后的小程序包转为mpaas可上传的格式
-
-- 入参
-
-  - ```js
-    {
-      tarFilePath: '/var/folders/ls/9svnt3gj0_q3f_gyflbk7gqw0000gn/T/minicode_compile_dy/dist-OikE6ZQHD-1629797477127/dist.tar',
-      appId:       '123456'
-    }
-    ```
-
-- 返回
-
-  - ```js
+  - ```javascript
     {
-      data:    '/var/folders/ls/9svnt3gj0_q3f_gyflbk7gqw0000gn/T/9593340d-8e28-4681-880c-4d7320736685/123456.zip',
-      success: true
+      data:         '<string>',  // 转换后的zip文件本地路径
+      success:      true
     }
     ```
 
-#### getVhostByApi 查询当前app是否设置虚拟域名
+#### cleanCache 清除openapi的缓存文件
 
 - 入参 -
 
 - 返回
 
-  - ```js
-    {
-      data:      'tinyapp.com',
-      errorCode: 'OK',
-      requestId: '599D03FC-2558-533C-BB88-3B3DCD67FB05',
-      resultMsg: '',
-      success:   true
-    }
-    ```
-
-#### getPackageType 判断当前的包类型
-
-- 入参 
-
-  - packageType
-
-- 返回
-
-  - ```js
-    {
-      data:   'production' || 'development',
-      success: true
-    }
-    ```
-
-#### looseJsonParse 不规范json string转换json object
-
-- 入参 
-
-  - string
-
-- 返回
-
-  - ```js
-    {
-      data:   'json object',
-      success: true
-    }
-    ```
-
-#### downloadFile 远程文件保存至本地
-
-- 入参 
-
-  - ```
-    {
-      url:    'string', // 需要下载文件的远程地址
-      target: 'string'	// 需要保存至本地的路径。可选，不填写的话，会保存至本地的 `${tmpdir()}/.mpaas_ide_openapi`
-    }
-    ```
-
-    
-
-- 返回
-
-  - ```js
+  - ```javascript
     {
-      data:   'string',	// 下载至本地的文件地址
+      data:    'ok',
       success: true
     }
     ```