aiot-toolkit 2.0.5-beta.9 → 2.0.5-widget-provider-beta.1

package/README.md

@@ -1,92 +1,94 @@
-<!-- 此文档由 tools/createFile.ts 生成， 请勿手动修改 -->
-<!--
-
-生成方法
-1. 修改 tools/README.template.md
-2. 修改 tools/VelaBuilderParam.json
-3. 执行 tools/createFile.ts
- -->
-
-# 项目介绍
-
-aiot-toolkit 2.0 是将 **源码项目** 转换为 **目标代码项目** 并生成 **目标代码应用** 的命令行工具，同时配备了 **模拟器** 相关功能供开发者使用。
-
-aiot-toolkit2.0目前支持的打包格式如下：
-
-- ux：vela 平台下的应用，目前大量使用于小米手表、音箱等智能穿戴及物联网设备
-
-## 安装使用
-
-- 全局安装
-
-  `npm i aiot-toolkit -g`
-
-  `npm i create-aiot -g`
-
-- 创建项目
-
-  1. `create-aiot ux`
-  2. 在项目根目录执行：`npm i`
-
-- 本机运行项目
-
-  在项目根目录执行 `aiot start`，此会启动模拟器，并运行项目
-
-* 打包项目
-
-  在项目根目录执行 `aiot release`
-
-## 常用命令
-
-| 命令                     | 说明                                           |
-| ------------------------ | ---------------------------------------------- |
-| npm create aiot          | 创建并手动选择项目                             |
-| npm create aiot ux       | 创建ux项目                                     |
-| aiot build               | 构建项目                                       |
-| aiot release             | 构建项目-release模式                           |
-| aiot start               | 构建项目并运行到模拟器                         |
-| aiot getConnectedDevices | 获取已连接设备列表                             |
-| aiot getPlatforms        | 获取设置平台                                   |
-| aiot installDbgAndMkp    | 在真机上安装快应用调试器                       |
-| aiot createVVD           | 创建 vela 模拟器                               |
-| aiot deleteVVD           | 删除 vela 模拟器                               |
-| aiot resign              | build目录重新生成rpk, 详情： [resign](#resign) |
-
-## build 参数
-
-
-| 参数 | 类型 | 描述 | 默认值 | 参考 |
-| --- | --- | --- | --- | --- |
-| *devtool* | string | source map 配置 |  | https://www.webpackjs.com/configuration/devtool/#devtool |
-| *enable-jsc* | confirm | 是否启用 jsc bundle | `false` |  |
-| *enable-protobuf* | confirm | 是否启用 `protobuf` | `false` |  |
-| *enable-e2e* | confirm | 是否为当前项目注入测试套件 | `false` | https://doc.quickapp.cn/tutorial/others/testing.html |
-| *enable-stats* | confirm | 分析 webpack 输出文件的大小 | `false` |  |
-| *optimize-css-attr* | confirm | 优化压缩css名称 | `false` |  |
-| *complete-feature* | confirm | 自动将代码中使用的功能，补全到 manifest.json 的 features 字段中 | `false` |  |
-| *start-page* | string | 启动页面，示例：`--start-page 'pages/index?a=1&b=2'` |  |  |
-| *e2e-config-path* | string | e2e 配置文件的路径, 示例：--e2e-config-path ./test2/autoTestConfig.json |  |  |
-| *~~enable-custom-component~~* | confirm | **已废弃** |  |  |
-| *~~stats~~* | confirm | **已废弃** |  |  |
-
-## resign
-
-build目录重新生成rpk
-
-步骤
-
-1. 创建任意名称的空目录, 例如 `folder`
-2. 将 `build` 复制到 `folder`
-3. (可跳过)如需自定义证书，将证书复制到 `folder/sign`
-4. 进入 `folder` 目录，执行 `aiot resign`，会在`foler/dist`中生成rpk
-5. 目录结构如下
-
-```sh
-folder
-  build // 用户复制
-  sign  // 用户复制，可选
-     certificate.pem
-     private.pem
-  dist  // 生成
-     ***.rpk
-```
+<!-- 此文档由 tools/createFile.ts 生成， 请勿手动修改 -->
+<!--
+
+生成方法
+1. 修改 tools/README.template.md
+2. 修改 tools/VelaBuilderParam.json
+3. 执行 tools/createFile.ts
+ -->
+
+# 项目介绍
+
+aiot-toolkit 2.0 是将 **源码项目** 转换为 **目标代码项目** 并生成 **目标代码应用** 的命令行工具，同时配备了 **模拟器** 相关功能供开发者使用。
+
+aiot-toolkit2.0目前支持的打包格式如下：
+
+- ux：vela 平台下的应用，目前大量使用于小米手表、音箱等智能穿戴及物联网设备
+
+## 安装使用
+
+- 全局安装
+
+  `npm i aiot-toolkit -g`
+
+  `npm i create-aiot -g`
+
+- 创建项目
+
+  1. `create-aiot ux`
+  2. 在项目根目录执行：`npm i`
+
+- 本机运行项目
+
+  在项目根目录执行 `aiot start`，此会启动模拟器，并运行项目
+
+* 打包项目
+
+  在项目根目录执行 `aiot release`
+
+## 常用命令
+
+| 命令                     | 说明                                           |
+| ------------------------ | ---------------------------------------------- |
+| npm create aiot          | 创建并手动选择项目                             |
+| npm create aiot ux       | 创建ux项目                                     |
+| aiot build               | 构建项目                                       |
+| aiot release             | 构建项目-release模式                           |
+| aiot start               | 构建项目并运行到模拟器                         |
+| aiot getConnectedDevices | 获取已连接设备列表                             |
+| aiot getPlatforms        | 获取设置平台                                   |
+| aiot installDbgAndMkp    | 在真机上安装快应用调试器                       |
+| aiot createVVD           | 创建 vela 模拟器                               |
+| aiot deleteVVD           | 删除 vela 模拟器                               |
+| aiot resign              | build目录重新生成rpk, 详情： [resign](#resign) |
+
+## build 参数
+
+
+| 参数 | 类型 | 描述 | 默认值 | 参考 |
+| --- | --- | --- | --- | --- |
+| *devtool* | string | source map 配置 |  | https://www.webpackjs.com/configuration/devtool/#devtool |
+| *enable-jsc* | confirm | 是否启用 jsc bundle | `false` |  |
+| *enable-protobuf* | confirm | 是否启用 `protobuf` | `false` |  |
+| *enable-e2e* | confirm | 是否为当前项目注入测试套件 | `false` | https://doc.quickapp.cn/tutorial/others/testing.html |
+| *enable-stats* | confirm | 分析 webpack 输出文件的大小 | `false` |  |
+| *optimize-css-attr* | confirm | 优化压缩css名称 | `false` |  |
+| *complete-feature* | confirm | 自动将代码中使用的功能，补全到 manifest.json 的 features 字段中 | `false` |  |
+| *start-page* | string | 启动页面，示例：`--start-page 'pages/index?a=1&b=2'` |  |  |
+| *e2e-config-path* | string | e2e 配置文件的路径, 示例：--e2e-config-path ./test2/autoTestConfig.json |  |  |
+| *enable-image-png8* | confirm | 压缩png文件为png8 |  |  |
+| *drop-console* | string | 删除 console.   <br/>+ `true`: 全部删除  <br/>+ `false`: 不删除. <br/>+ string: 自定义. <br/>示例：`--drop-console=warn,error` ,`--drop-console=true`   | `false` |  |
+| *~~enable-custom-component~~* | confirm | **已废弃** |  |  |
+| *~~stats~~* | confirm | **已废弃** |  |  |
+
+## resign
+
+build目录重新生成rpk
+
+步骤
+
+1. 创建任意名称的空目录, 例如 `folder`
+2. 将 `build` 复制到 `folder`
+3. (可跳过)如需自定义证书，将证书复制到 `folder/sign`
+4. 进入 `folder` 目录，执行 `aiot resign`，会在`foler/dist`中生成rpk
+5. 目录结构如下
+
+```sh
+folder
+  build // 用户复制
+  sign  // 用户复制，可选
+     certificate.pem
+     private.pem
+  dist  // 生成
+     ***.rpk
+```

package/lib/bin.js

@@ -7,10 +7,8 @@ var _aiotpack = require("@aiot-toolkit/aiotpack");
 var _commander = require("@aiot-toolkit/commander");
 var _AndroidUxBuilder = _interopRequireDefault(require("./builder/AndroidUxBuilder"));
 var _VelaUxBuilder = _interopRequireDefault(require("./builder/VelaUxBuilder"));
-var _XtsBuilder = _interopRequireDefault(require("./builder/XtsBuilder"));
 var _AndroidUxStart = _interopRequireDefault(require("./starter/AndroidUxStart"));
 var _VelaUxStarter = _interopRequireDefault(require("./starter/VelaUxStarter"));
-var _XtsStarter = _interopRequireDefault(require("./starter/XtsStarter"));
 var _DeviceUtil = _interopRequireDefault(require("./utils/DeviceUtil"));
 var _VelaAvdUtils = _interopRequireDefault(require("./utils/VelaAvdUtils"));
 var _ZipUtil = _interopRequireDefault(require("@aiot-toolkit/aiotpack/lib/compiler/javascript/vela/utils/ZipUtil"));
@@ -38,10 +36,6 @@ const projectMapper = {
     builder: _VelaUxBuilder.default,
     starter: _VelaUxStarter.default
   },
-  [_sharedUtils.ProjectType.VELA_XTS]: {
-    builder: _XtsBuilder.default,
-    starter: _XtsStarter.default
-  },
   [_sharedUtils.ProjectType.ANDDROID_UX]: {
     builder: _AndroidUxBuilder.default,
     starter: _AndroidUxStart.default
@@ -64,6 +58,11 @@ function build(command, description) {
         option.mode = command === 'release' ? _aiotpack.CompileMode.PRODUCTION : _aiotpack.CompileMode.DEVELOPMENT;
         const projectPath = process.cwd();
         await builder.build(projectPath, option);
+        if (process.env.TERM_PROGRAM !== 'aiot-ide') {
+          _sharedUtils.ColorConsole.warn('please use', {
+            word: 'AIoT-IDE: https://iot.mi.com/vela/quickapp/zh/guide/start/use-ide.html'
+          });
+        }
       } catch (error) {
         _sharedUtils.ColorConsole.error('Build Error:', {
           word: error?.toString() || 'unknown error'

package/lib/builder/AndroidUxBuilder.js

@@ -7,8 +7,8 @@ exports.default = void 0;
 var _sharedUtils = require("@aiot-toolkit/shared-utils");
 var _UxBuilderBase = _interopRequireDefault(require("./UxBuilderBase"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * AndroidUxBuilder
+/**
+ * AndroidUxBuilder
  */
 class AndroidUxBuilder extends _UxBuilderBase.default {
   params = [{

package/lib/builder/UxBuilderBase.js

@@ -26,12 +26,12 @@ var _IFileLaneEvents = _interopRequireWildcard(require("file-lane/lib/interface/
 function _getRequireWildcardCache(e) { if ("function" != typeof WeakMap) return null; var r = new WeakMap(), t = new WeakMap(); return (_getRequireWildcardCache = function (e) { return e ? t : r; })(e); }
 function _interopRequireWildcard(e, r) { if (!r && e && e.__esModule) return e; if (null === e || "object" != typeof e && "function" != typeof e) return { default: e }; var t = _getRequireWildcardCache(r); if (t && t.has(e)) return t.get(e); var n = { __proto__: null }, a = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var u in e) if ("default" !== u && {}.hasOwnProperty.call(e, u)) { var i = a ? Object.getOwnPropertyDescriptor(e, u) : null; i && (i.get || i.set) ? Object.defineProperty(n, u, i) : n[u] = e[u]; } return n.default = e, t && t.set(e, n), n; }
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * UxBuilderBase
+/**
+ * UxBuilderBase
  */
 class UxBuilderBase {
-  /**
-   * 配置文件
+  /**
+   * 配置文件
    */
   QUICKAPP_CONFIG = 'quickapp.config.js';
   constructor() {
@@ -39,11 +39,11 @@ class UxBuilderBase {
     this.events = events;
   }
 
-  /**
-   * ux项目的build函数
-   * @param projectPath 项目路径
-   * @param options 命令参数
-   * @param watch 是否开启监听
+  /**
+   * ux项目的build函数
+   * @param projectPath 项目路径
+   * @param options 命令参数
+   * @param watch 是否开启监听
    */
   async build(projectPath, options) {
     if (this.fileLane) {
@@ -60,7 +60,15 @@ class UxBuilderBase {
       message: ['start build: ', {
         word: JSON.stringify({
           projectPath,
-          options,
+          options: {
+            ...compilerOption,
+            // 去除敏感信息
+            clientRecordPath: undefined,
+            dataCoverage: undefined,
+            projectPath: undefined,
+            webpack: undefined,
+            server: undefined
+          },
           watch,
           node: process.version,
           platform: process.platform,
@@ -93,10 +101,10 @@ class UxBuilderBase {
     this.fileLane = undefined;
   }
 
-  /**
-   * 获取build的编译配置
-   * @param projectPath 项目路径
-   * @param options 命令参数
+  /**
+   * 获取build的编译配置
+   * @param projectPath 项目路径
+   * @param options 命令参数
    */
   getCompilerOption(projectPath, options) {
     // 读取项目中文件的配置

package/lib/builder/VelaUxBuilder.js

@@ -8,8 +8,8 @@ var _sharedUtils = require("@aiot-toolkit/shared-utils");
 var _UxBuilderBase = _interopRequireDefault(require("./UxBuilderBase"));
 var _IVelaUxBuilderOption = require("../interface/IVelaUxBuilderOption");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * VelaUxBuilder
+/**
+ * VelaUxBuilder
  */
 class VelaUxBuilder extends _UxBuilderBase.default {
   params = (() => _IVelaUxBuilderOption.velaUxBuilderParams)();

package/lib/interface/IVelaUxBuilderOption.d.ts

@@ -54,6 +54,14 @@ interface IVelaUxBuilderOption extends IUxBuildOption {
      * e2e 配置文件的路径, 示例：--e2e-config-path ./test2/autoTestConfig.json
      */
     e2eConfigPath?: string;
+    /**
+     * 压缩png文件为png8
+     */
+    enableImagePng8?: boolean;
+    /**
+     * 删除 console.   <br/>+ `true`: 全部删除  <br/>+ `false`: 不删除. <br/>+ string: 自定义. <br/>示例：`--drop-console=warn,error` ,`--drop-console=true`
+     */
+    dropConsole?: string;
 }
 declare const velaUxBuilderParams: IParam[];
 export { velaUxBuilderParams };

package/lib/interface/IVelaUxBuilderOption.js

@@ -4,12 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.velaUxBuilderParams = void 0;
-/*****
- *  由 tools/createFile.ts 生成， 请勿手动修改
- *
- *  生成方法
- *  1. 修改 tools/VelaBuilderParam.json
- *  2. 执行 tools/createFile.ts
+/*****
+ *  由 tools/createFile.ts 生成， 请勿手动修改
+ *
+ *  生成方法
+ *  1. 修改 tools/VelaBuilderParam.json
+ *  2. 执行 tools/createFile.ts
  */
 
 const velaUxBuilderParams = exports.velaUxBuilderParams = [{
@@ -66,4 +66,13 @@ const velaUxBuilderParams = exports.velaUxBuilderParams = [{
   "type": "string",
   "name": "e2e-config-path",
   "description": "e2e config file path, example: --e2e-config-path ./test2/autoTestConfig.json"
+}, {
+  "type": "confirm",
+  "name": "enable-image-png8",
+  "description": "translate image to png8"
+}, {
+  "type": "string",
+  "name": "drop-console",
+  "description": "drop console. true: drop all, false: do nothing, string: custom.  example: --drop-console warn,error",
+  "defaultValue": false
 }];

package/lib/starter/AndroidUxStart.js

@@ -14,11 +14,11 @@ var _AndroidUxBuilder = _interopRequireDefault(require("../builder/AndroidUxBuil
 var _IStarter = _interopRequireDefault(require("./IStarter"));
 var _PackageRouter = _interopRequireDefault(require("./androidRouter/PackageRouter"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * AndroidUxStart
- *
- * 1. 启动本机开发者http服务器，并提供二维码，以下载 rpk
- * 2. 打包 rpk，并监听文件变化，重新打包
+/**
+ * AndroidUxStart
+ *
+ * 1. 启动本机开发者http服务器，并提供二维码，以下载 rpk
+ * 2. 打包 rpk，并监听文件变化，重新打包
  */
 class AndroidUxStart extends _IStarter.default {
   builder = (() => new _AndroidUxBuilder.default())();
@@ -44,10 +44,10 @@ class AndroidUxStart extends _IStarter.default {
     });
   }
 
-  /**
-   * 启动
-   * 1. build 项目
-   * 2. build 成功，则创建http服务器
+  /**
+   * 启动
+   * 1. build 项目
+   * 2. build 成功，则创建http服务器
    */
   async start(projectPath, options) {
     this.projectPath = projectPath;
@@ -59,12 +59,12 @@ class AndroidUxStart extends _IStarter.default {
     await this.createServer(buildOption);
   }
 
-  /**
-   * 创建服务器
-   *
-   * 1. 使用 koa 创建服务器
-   * 2. 显示服务器地址和二维码
-   * @returns
+  /**
+   * 创建服务器
+   *
+   * 1. 使用 koa 创建服务器
+   * 2. 显示服务器地址和二维码
+   * @returns
    */
   async createServer(options) {
     return new Promise(async resolve => {
@@ -118,10 +118,10 @@ class AndroidUxStart extends _IStarter.default {
     this.server?.close();
   }
 
-  /**
-   * 通知已知的设备，应用有更新
-   * @param projectPath
-   * @param options
+  /**
+   * 通知已知的设备，应用有更新
+   * @param projectPath
+   * @param options
    */
   noticeDeviceListUpdate(projectPath, options) {
     const {

package/lib/starter/IStarter.js

@@ -4,12 +4,12 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-/**
- * IStarter
+/**
+ * IStarter
  */
 class IStarter {
-  /**
-   * start 的参数列表
+  /**
+   * start 的参数列表
    */
   params = [];
   constructor(name, description) {
@@ -20,8 +20,8 @@ class IStarter {
     return;
   }
 
-  /**
-   * start 的命令
+  /**
+   * start 的命令
    */
   getCommond() {
     return {
@@ -36,10 +36,10 @@ class IStarter {
     };
   }
 
-  /**
-   * 运行项目
-   * @param projectPath 项目路径
-   * @param options 命令参数
+  /**
+   * 运行项目
+   * @param projectPath 项目路径
+   * @param options 命令参数
    */
 }
 exports.default = IStarter;

package/lib/starter/VelaUxStarter.js

@@ -19,9 +19,9 @@ var _events = _interopRequireDefault(require("events"));
 var _FileLaneTriggerType = _interopRequireDefault(require("file-lane/lib/enum/FileLaneTriggerType"));
 var _IVelaUxBuilderOption = require("../interface/IVelaUxBuilderOption");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
-/**
- * VelaUxStarter
- * ux快应用启动器
+/**
+ * VelaUxStarter
+ * ux快应用启动器
  */
 class VelaUxStarter extends _IStarter.default {
   constructor(name, description) {
@@ -145,11 +145,11 @@ class VelaUxStarter extends _IStarter.default {
     });
   }
 
-  /**
-   * 检查选择的模拟器在当前环境下是否可以使用
-   * 下面的几种情况会导致模拟器不可用：1. 模拟器绑定的Vela镜像不存在；2. Vela4.0缺少coredump.core或者vela_data.bin文件
-   * @param avdName 模拟器名称
-   * @returns {boolean}
+  /**
+   * 检查选择的模拟器在当前环境下是否可以使用
+   * 下面的几种情况会导致模拟器不可用：1. 模拟器绑定的Vela镜像不存在；2. Vela4.0缺少coredump.core或者vela_data.bin文件
+   * @param avdName 模拟器名称
+   * @returns {boolean}
    */
   isAvailableEmulator(avdName) {
     const {

package/lib/starter/androidRouter/LinkMode.js

@@ -4,8 +4,8 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-/**
- * 连接类型
+/**
+ * 连接类型
  */
 var LinkMode = /*#__PURE__*/function (LinkMode) {
   LinkMode[LinkMode["NULL"] = 0] = "NULL";

package/lib/starter/androidRouter/PackageRouter.js

@@ -11,9 +11,9 @@ var _qrImage = _interopRequireDefault(require("qr-image"));
 var _LinkMode = _interopRequireDefault(require("./LinkMode"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
 const CLIENT_PORT = 39517;
-/**
- * 打包相关的路由配置
- * 用于开发机的httpServer
+/**
+ * 打包相关的路由配置
+ * 用于开发机的httpServer
  */
 class PackageRouter {
   constructor(param) {
@@ -34,10 +34,10 @@ class PackageRouter {
     }
   }];
 
-  /**
-   * 下载 rpk 包
-   * @param ctx
-   * @param next
+  /**
+   * 下载 rpk 包
+   * @param ctx
+   * @param next
    */
   handlerDownLoadRpk = (ctx, next) => {
     const {
@@ -60,26 +60,26 @@ class PackageRouter {
     return next();
   };
 
-  /**
-   * 记录设备信息
-   *
-   * 获取请求的 ip 和端口，记录到本机中，最多记录5个
-   *
-   * 文件内容的格式为：
-   * ```
-   * records: {
-   *    "快应用项目路径":[
-   *        {ip:"", port:""},
-   *        {ip:"", port:""},
-   *        {ip:"", port:""}
-   *    ]
-   * }
-   * ```
-   *
-   *
-   * 此记录的作用是：当重新打包后，获取已连接的设备列表
-   * @param ctx
-   * @param next
+  /**
+   * 记录设备信息
+   *
+   * 获取请求的 ip 和端口，记录到本机中，最多记录5个
+   *
+   * 文件内容的格式为：
+   * ```
+   * records: {
+   *    "快应用项目路径":[
+   *        {ip:"", port:""},
+   *        {ip:"", port:""},
+   *        {ip:"", port:""}
+   *    ]
+   * }
+   * ```
+   *
+   *
+   * 此记录的作用是：当重新打包后，获取已连接的设备列表
+   * @param ctx
+   * @param next
    */
   recordDevice = async ctx => {
     const clientInfo = this.getClientFromRequest(ctx);
@@ -134,13 +134,13 @@ class PackageRouter {
     };
   }
 
-  /**
-   * http 请求中，用于返回下载文件
-   *
-   * 调用此方法后，仍需调用 next()
-   *
-   * @param filePath 文件绝对路径
-   * @param ctx 请求上下文
+  /**
+   * http 请求中，用于返回下载文件
+   *
+   * 调用此方法后，仍需调用 next()
+   *
+   * @param filePath 文件绝对路径
+   * @param ctx 请求上下文
    */
   download(filePath, ctx) {
     if (filePath && _fsExtra.default.existsSync(filePath)) {