@aiot-toolkit/aiotpack 2.0.1-alpha.9 → 2.0.2-beta.1

package/lib/utils/PreWorkUtils.js

@@ -13,10 +13,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
+const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
 const del_1 = __importDefault(require("del"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
+const TranslateCache_1 = __importDefault(require("../../../parser/lib/ux/translate/vela/TranslateCache"));
 const UxFileUtils_1 = __importDefault(require("./ux/UxFileUtils"));
+const BinaryPlugin = require('@aiot-toolkit/parser/lib/ux/translate/vela/protobuf/BinaryPlugin');
 /**
  * PreWorkUtils
  */
@@ -37,11 +40,13 @@ class PreWorkUtils {
         if (manifestContent) {
             const { router } = manifestContent;
             if (!router) {
-                // 报错，没有router配置
+                // 没有router配置
+                ColorConsole_1.default.throw(`### manifest ### No router configuration`);
             }
             const { pages } = router;
             if (!pages) {
-                // 报错，没有pages配置
+                // 没有pages配置
+                ColorConsole_1.default.throw(`### manifest ### No pages configuration`);
             }
             Object.keys(pages).map((page) => {
                 const pageContent = pages[page];
@@ -51,26 +56,51 @@ class PreWorkUtils {
                     entryList.push(entryPage);
                 }
                 else {
-                    // 报错，路径不存在
+                    // 路径不存在
+                    ColorConsole_1.default.throw(`### manifest ### path '${entryPage}' does not exist`);
                 }
             });
             context['entries'] = entryList;
             return Promise.resolve();
         }
         else {
-            // 报错 manifest.json文件无有效内容
+            // manifest.json文件无有效内容
+            ColorConsole_1.default.error(`### manifest ### File has no valid content`);
             return Promise.reject();
         }
     }
+    /**
+     * 获取项目的全局样式变量配置
+     * @param context
+     */
+    static getGlobalVar(context) {
+        const { projectPath } = context;
+        const filePath = path_1.default.join(projectPath, 'src', 'globalVar.json');
+        let globalVar = {};
+        // 判断文件是否存在
+        if (fs_extra_1.default.existsSync(filePath)) {
+            // 存在则取内容，否则内容为空
+            globalVar = fs_extra_1.default.readJSONSync(filePath);
+        }
+        context.globalVar = globalVar;
+        return Promise.resolve();
+    }
 }
 _a = PreWorkUtils;
 PreWorkUtils.clean = (context, _, config, compileOption) => __awaiter(void 0, void 0, void 0, function* () {
-    (0, del_1.default)(path_1.default.join(context.projectPath, context.output));
+    yield (0, del_1.default)(path_1.default.join(context.projectPath, context.output));
     if (compileOption) {
-        (0, del_1.default)(path_1.default.join(compileOption.projectPath, compileOption.outputPath));
-        (0, del_1.default)(path_1.default.join(compileOption.projectPath, compileOption.releasePath));
+        yield (0, del_1.default)(path_1.default.join(compileOption.projectPath, compileOption.outputPath));
+        yield (0, del_1.default)(path_1.default.join(compileOption.projectPath, compileOption.releasePath));
+        yield (0, del_1.default)(path_1.default.join(context.projectPath, compileOption.outputPath));
+        yield (0, del_1.default)(path_1.default.join(context.projectPath, compileOption.releasePath));
     }
+    TranslateCache_1.default.featureCache.clear();
+    BinaryPlugin.reset();
+    BinaryPlugin.config = {
+        projectPath: context.projectPath,
+        source: compileOption === null || compileOption === void 0 ? void 0 : compileOption.sourceRoot,
+        output: compileOption === null || compileOption === void 0 ? void 0 : compileOption.outputPath
+    };
 });
 exports.default = PreWorkUtils;
-
-//# sourceMappingURL=PreWorkUtils.js.map

package/lib/utils/ux/ManifestSchema.d.ts

@@ -0,0 +1,3 @@
+import { JSONSchemaType } from '@aiot-toolkit/shared-utils/lib/utils/CommonUtil';
+declare const ManifestSchema: JSONSchemaType;
+export default ManifestSchema;

package/lib/utils/ux/ManifestSchema.js

@@ -0,0 +1,207 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const ManifestSchema = {
+    type: 'object',
+    required: ['package', 'name', 'icon', 'versionCode', 'config', 'router'],
+    properties: {
+        package: {
+            type: 'string'
+        },
+        name: {
+            type: 'string'
+        },
+        icon: {
+            type: 'string'
+        },
+        banner: {
+            type: 'string'
+        },
+        versionName: {
+            type: 'string'
+        },
+        versionCode: {
+            type: ['number']
+        },
+        minPlatformVersion: {
+            type: ['number']
+        },
+        features: {
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string'
+                    }
+                }
+            }
+        },
+        config: {
+            type: 'object',
+            properties: {
+                logLevel: {
+                    enum: ['off', 'error', 'warn', 'info', 'log', 'debug']
+                },
+                designWidth: {
+                    type: ['number', 'string']
+                },
+                data: {
+                    // TODO 全局数据对象，属性名不能以$或_开头，
+                    type: 'object'
+                },
+                background: {
+                    // TODO 更详细的后台运行配置信息，
+                    type: 'object'
+                },
+                network: {
+                    // TODO 更详细的网络配置信息，
+                    type: 'object'
+                }
+            }
+        },
+        router: {
+            // TODO 更详细的后台运行配置信息，
+            type: 'object',
+            required: ['entry', 'pages'],
+            properties: {
+                entry: {
+                    type: 'string'
+                },
+                // TODO 看下 key 不确定能否校验值，
+                pages: {
+                    type: 'object'
+                },
+                errorPage: {
+                    type: 'string'
+                },
+                // TODO 看下 key 不确定能否校验值，
+                widgets: {
+                    type: 'object'
+                }
+            }
+        },
+        display: {
+            type: 'object',
+            properties: {
+                backgroundColor: {
+                    // TODO HEXColor
+                    type: 'string'
+                },
+                fullScreen: {
+                    type: 'boolean'
+                },
+                titleBar: {
+                    type: 'boolean'
+                },
+                titleBarBackgroundColor: {
+                    // TODO HEXColor
+                    type: 'string'
+                },
+                titleBarTextColor: {
+                    // TODO HEXColor
+                    type: 'string'
+                },
+                menu: {
+                    type: 'boolean'
+                },
+                windowSoftInputMode: {
+                    enum: ['adjustPan', 'adjustResize']
+                },
+                pages: {
+                    type: 'object'
+                },
+                orientation: {
+                    enum: ['portrait', 'landscape']
+                },
+                statusBarImmersive: {
+                    type: 'boolean'
+                },
+                statusBarTextStyle: {
+                    enum: ['light', 'dark', 'auto']
+                },
+                statusBarBackgroundColor: {
+                    type: 'string'
+                },
+                statusBarBackgroundOpacity: {
+                    type: 'number'
+                },
+                fitCutout: {
+                    enum: ['none', 'portrait', 'landscape']
+                },
+                textSizeAdjust: {
+                    enum: ['none', 'auto']
+                },
+                themeMode: {
+                    enum: [-1, 0, 1]
+                },
+                menuBarData: {
+                    // TODO 详细校验
+                    type: 'object'
+                },
+                forceDark: {
+                    type: 'boolean'
+                },
+                pageCache: {
+                    type: 'boolean'
+                },
+                cacheDuration: {
+                    type: 'number'
+                }
+            }
+        },
+        subpackages: {
+            // TODO 与后面的分包校验融合
+            type: 'array',
+            items: {
+                type: 'object',
+                properties: {
+                    name: {
+                        type: 'string'
+                    },
+                    // TODO 详细的规则校验
+                    resource: {
+                        type: 'string'
+                    }
+                },
+                // 是否必须?
+                required: ['name', 'resource']
+            }
+        },
+        menuBarData: {
+            type: 'object',
+            properties: {
+                menuBar: {
+                    type: 'boolean'
+                },
+                menuBarStyle: {
+                    enum: ['dark', 'light']
+                },
+                shareTitle: {
+                    type: 'string'
+                },
+                shareDescription: {
+                    type: 'string'
+                },
+                shareIcon: {
+                    type: 'string'
+                },
+                shareCurrentPage: {
+                    type: 'string'
+                },
+                shareParams: {
+                    type: 'string'
+                },
+                shareUrl: {
+                    type: 'string'
+                }
+            }
+        },
+        deviceTypeList: {
+            type: 'array',
+            items: {
+                type: 'string'
+            }
+        }
+    }
+};
+exports.default = ManifestSchema;

package/lib/utils/ux/UxFileUtils.d.ts

@@ -1,8 +1,5 @@
 import IManifest from '../../compiler/javascript/vela/interface/IManifest';
-/**
- * FileUtils
- */
-declare class UxFileUtils {
+export declare class UxFileUtils {
     static readonly CONFIG_FILE_NAME = "manifest.json";
     /**
      * 获取manifest.json路径
@@ -18,5 +15,25 @@ declare class UxFileUtils {
      * @returns
      */
     static getMainfestInfo(projectPath: string, sourceRoot?: string): IManifest;
+    /**
+     * 检查 manifest文件，并显示错误信息
+     *
+     * 1. TypeError，使用Error 样式
+     * 2. 其它错误，使用 Warn 样式
+     * 3. 如果存在TypeError，则终止程序
+     *
+     * @param projectPath 项目路径
+     * @param sourceRoot 源码路径--相对项目根目录
+     * @returns
+     */
+    static validateManifest(projectPath: string, sourceRoot?: string): Error[] | undefined;
+    /**
+     * 检查 sitemap.json 文件，并显示错误信息
+     *
+     * 1. 当sitemap.json的 rules 中配置的page 不存在于 manifest.json 中时，报错并终止程序
+     * @param projectPath
+     * @param sourceRoot
+     */
+    static validateSitemap(projectPath: string, sourceRoot?: string): void;
 }
 export default UxFileUtils;

package/lib/utils/ux/UxFileUtils.js

@@ -3,11 +3,13 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.UxFileUtils = void 0;
+const shared_utils_1 = require("@aiot-toolkit/shared-utils");
+const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
+const CommonUtil_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/utils/CommonUtil"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
 const path_1 = __importDefault(require("path"));
-/**
- * FileUtils
- */
+const ManifestSchema_1 = __importDefault(require("./ManifestSchema"));
 class UxFileUtils {
     /**
      * 获取manifest.json路径
@@ -27,8 +29,75 @@ class UxFileUtils {
     static getMainfestInfo(projectPath, sourceRoot = 'src') {
         return fs_extra_1.default.readJSONSync(UxFileUtils.getManifestFilePath(projectPath, sourceRoot));
     }
+    /**
+     * 检查 manifest文件，并显示错误信息
+     *
+     * 1. TypeError，使用Error 样式
+     * 2. 其它错误，使用 Warn 样式
+     * 3. 如果存在TypeError，则终止程序
+     *
+     * @param projectPath 项目路径
+     * @param sourceRoot 源码路径--相对项目根目录
+     * @returns
+     */
+    static validateManifest(projectPath, sourceRoot = 'src') {
+        const path = UxFileUtils.getManifestFilePath(projectPath, sourceRoot);
+        if (!fs_extra_1.default.existsSync(path)) {
+            ColorConsole_1.default.throw(`file is missing`, {
+                word: path,
+                style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Throw)
+            });
+        }
+        const jsonData = this.getMainfestInfo(projectPath, sourceRoot);
+        const schema = ManifestSchema_1.default;
+        const errors = CommonUtil_1.default.validateJson(jsonData, schema);
+        if (errors) {
+            ColorConsole_1.default.warn(`Manefest.json error: `, ...errors.map((item, index) => {
+                return {
+                    word: `\r\n${index + 1}. ${item.message}`,
+                    style: item instanceof TypeError
+                        ? ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Error)
+                        : ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Warn)
+                };
+            }));
+            const stop = Boolean(errors.find((item) => item instanceof TypeError));
+            if (stop) {
+                ColorConsole_1.default.throw({
+                    word: `missing required content, program stoped`,
+                    style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Throw)
+                });
+            }
+        }
+        return errors;
+    }
+    /**
+     * 检查 sitemap.json 文件，并显示错误信息
+     *
+     * 1. 当sitemap.json的 rules 中配置的page 不存在于 manifest.json 中时，报错并终止程序
+     * @param projectPath
+     * @param sourceRoot
+     */
+    static validateSitemap(projectPath, sourceRoot = 'src') {
+        const sitemapPath = path_1.default.join(projectPath, sourceRoot, 'sitemap.json');
+        if (fs_extra_1.default.existsSync(sitemapPath)) {
+            try {
+                const rules = fs_extra_1.default.readJSONSync(sitemapPath).rules;
+                const manifest = this.getMainfestInfo(projectPath, sourceRoot);
+                const pages = Object.keys(manifest.router.pages || {});
+                rules.forEach((item, index) => {
+                    const page = item.page;
+                    if (page !== '*' && !pages.includes(page)) {
+                        ColorConsole_1.default.throw(`The ${index + 1}th item of sitemap rules is configured incorrectly, the page ${page} does not exist`);
+                    }
+                    return page;
+                });
+            }
+            catch (error) {
+                ColorConsole_1.default.warn(error === null || error === void 0 ? void 0 : error.toString());
+            }
+        }
+    }
 }
+exports.UxFileUtils = UxFileUtils;
 UxFileUtils.CONFIG_FILE_NAME = 'manifest.json';
 exports.default = UxFileUtils;
-
-//# sourceMappingURL=UxFileUtils.js.map

package/lib/utils/ux/UxFollowWorks.d.ts

@@ -5,6 +5,7 @@ import IJavascriptCompileOption from '../../compiler/javascript/interface/IJavas
  */
 declare class UxFollowWorks {
     static webpack: FollowWork<IJavascriptCompileOption>;
+    static protobuf: FollowWork<IJavascriptCompileOption>;
     static jsc: FollowWork<IJavascriptCompileOption>;
     static toRpk: FollowWork<IJavascriptCompileOption>;
     /**

package/lib/utils/ux/UxFollowWorks.js

@@ -13,6 +13,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 var _a;
 Object.defineProperty(exports, "__esModule", { value: true });
+const TranslateCache_1 = __importDefault(require("@aiot-toolkit/parser/lib//ux/translate/vela/TranslateCache"));
+const shared_utils_1 = require("@aiot-toolkit/shared-utils");
+const ColorConsole_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/ColorConsole"));
 const CommonUtil_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/utils/CommonUtil"));
 const FileUtil_1 = __importDefault(require("@aiot-toolkit/shared-utils/lib/utils/FileUtil"));
 const fs_extra_1 = __importDefault(require("fs-extra"));
@@ -24,6 +27,7 @@ const JavascriptDefaultCompileOption_1 = __importDefault(require("../../compiler
 const Jsc_1 = __importDefault(require("../../compiler/javascript/vela/utils/Jsc"));
 const ZipUtil_1 = __importDefault(require("../../compiler/javascript/vela/utils/ZipUtil"));
 const UxFileUtils_1 = __importDefault(require("./UxFileUtils"));
+const BinaryPlugin = require('@aiot-toolkit/parser/lib/ux/translate/vela/protobuf/BinaryPlugin');
 /**
  * UxFollowWorks
  */
@@ -31,10 +35,50 @@ class UxFollowWorks {
 }
 _a = UxFollowWorks;
 UxFollowWorks.webpack = (context, config, compilerOption) => __awaiter(void 0, void 0, void 0, function* () {
-    yield new JavascriptCompiler_1.default().compile(Object.assign(Object.assign({ projectPath: path_1.default.join(context.projectPath, context.output), mode: CompileMode_1.default.DEVELOPMENT, devtool: false, platform: 'vela' }, JavascriptDefaultCompileOption_1.default), compilerOption));
+    return new JavascriptCompiler_1.default()
+        .compile(Object.assign(Object.assign({ projectPath: path_1.default.join(context.projectPath, context.output), mode: CompileMode_1.default.DEVELOPMENT, devtool: false, platform: 'vela' }, JavascriptDefaultCompileOption_1.default), compilerOption))
+        .then(() => {
+        ColorConsole_1.default.info(`webpack complete`);
+    })
+        .catch(({ errors, warnings }) => {
+        const errorLength = (errors === null || errors === void 0 ? void 0 : errors.length) || 0;
+        const messages = [`webpack error:\r\n`];
+        if (errors === null || errors === void 0 ? void 0 : errors.length) {
+            messages.push({
+                word: errors
+                    .map((item, index) => {
+                    return `${index + 1}. ${item.message}`;
+                })
+                    .join('\r\n'),
+                style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Throw)
+            });
+        }
+        if (warnings === null || warnings === void 0 ? void 0 : warnings.length) {
+            messages.push({
+                word: warnings
+                    .map((item, index) => {
+                    return `${errorLength + index + 1}. ${item.message}`;
+                })
+                    .join('\r\n'),
+                style: ColorConsole_1.default.getStyle(shared_utils_1.LOG_LEVEL.Warn)
+            });
+        }
+        if (errors === null || errors === void 0 ? void 0 : errors.length) {
+            ColorConsole_1.default.throw(...messages);
+            throw new Error();
+        }
+        else {
+            ColorConsole_1.default.warn(...messages);
+        }
+    });
+});
+UxFollowWorks.protobuf = (context, config, compilerOption) => __awaiter(void 0, void 0, void 0, function* () {
+    if (compilerOption === null || compilerOption === void 0 ? void 0 : compilerOption.enableProtobuf) {
+        BinaryPlugin.createBinFiles();
+    }
 });
 UxFollowWorks.jsc = (context, config, compilerOption) => __awaiter(void 0, void 0, void 0, function* () {
-    if (compilerOption && !compilerOption.disabledJSC) {
+    if (compilerOption && compilerOption.disabledJSC === false) {
         return new Jsc_1.default(context.projectPath, path_1.default.join(context.projectPath, context.output, compilerOption.outputPath)).jsc();
     }
 });
@@ -54,6 +98,7 @@ UxFollowWorks.copyResource = (context, config, compilerOption) => __awaiter(void
         const { projectPath, sourceRoot, outputPath } = compilerOption;
         const manifest = fs_extra_1.default.readJSONSync(path_1.default.join(projectPath, sourceRoot, 'manifest.json'));
         const { deviceTypeList } = manifest;
+        // 生成设备的 manifest 文件，规则为：manifest.json + config-设备类型.json
         if (deviceTypeList) {
             deviceTypeList.forEach((deviceType) => {
                 let data = Object.assign({}, manifest);
@@ -87,7 +132,8 @@ UxFollowWorks.copyResource = (context, config, compilerOption) => __awaiter(void
             'md',
             'ux',
             'mix',
-            'DS_Store'
+            'DS_Store',
+            'map'
         ];
         const excludeReg = `\.(${excludeExtList.join('|')})$`;
         FileUtil_1.default.copyFiles(path_1.default.join(projectPath, sourceRoot), path_1.default.join(projectPath, outputPath), new RegExp(excludeReg));
@@ -108,6 +154,15 @@ UxFollowWorks.copyResource = (context, config, compilerOption) => __awaiter(void
         if (!content.packageInfo) {
             content.packageInfo = ZipUtil_1.default.createComment(compilerOption);
         }
+        if (TranslateCache_1.default.featureCache.size) {
+            const featureSet = new Set([
+                ...Array.from(TranslateCache_1.default.featureCache),
+                ...(content.features || []).map((item) => item.name)
+            ]);
+            content.features = Array.from(featureSet).map((item) => {
+                return { name: item };
+            });
+        }
         fs_extra_1.default.writeJSONSync(path_1.default.join(projectPath, outputPath, UxFileUtils_1.default.CONFIG_FILE_NAME), content, {
             spaces: 2
         });
@@ -141,8 +196,8 @@ UxFollowWorks.copyResource = (context, config, compilerOption) => __awaiter(void
     });
     if (compilerOption) {
         copyResourceFiles(compilerOption);
-        genDeviceManifests(compilerOption);
         updateManifest(compilerOption);
+        genDeviceManifests(compilerOption);
         yield genMetaFiles(compilerOption);
     }
 });
@@ -191,10 +246,8 @@ UxFollowWorks.symlinkNodeModule = (context, config, compilerOption) => __awaiter
     foldList.forEach((item) => {
         const sourcePath = path_1.default.join(context.projectPath, item);
         if (fs_extra_1.default.existsSync(sourcePath)) {
-            fs_extra_1.default.symlinkSync(sourcePath, path_1.default.join(compilerOption.projectPath, item));
+            fs_extra_1.default.symlinkSync(sourcePath, path_1.default.join(compilerOption.projectPath, item), 'junction');
         }
     });
 });
 exports.default = UxFollowWorks;
-
-//# sourceMappingURL=UxFollowWorks.js.map

package/lib/utils/ux/UxLoaderUtils.d.ts

@@ -1,5 +1,7 @@
+import { ILog } from '@aiot-toolkit/shared-utils';
 import { IFileLaneContext, IFileParam } from 'file-lane';
 import { SourceFile } from 'ts-morph';
+import IJavascriptCompileOption from '../../compiler/javascript/interface/IJavascriptCompileOption';
 /**
  * UxLoaderUtils
  */
@@ -12,17 +14,17 @@ declare class UxLoaderUtils {
      * @param project
      * @returns
      */
-    static compileUxToJavascript(file: IFileParam, context: IFileLaneContext, isAppUx: boolean): Promise<{
-        path: string;
-        content: string;
-    }[]>;
+    static compileUxToJavascript(file: IFileParam, context: IFileLaneContext, isAppUx: boolean, compilerOption: IJavascriptCompileOption): Promise<{
+        files: IFileParam[];
+        logs: ILog[];
+    }>;
     /**
      * 转换app.ux文件为js文件
      * @param file
      * @param resultFiles
      * @param context
      */
-    static compileAppUxToJavascript(file: IFileParam, resultFiles: IFileParam[], context: IFileLaneContext): Promise<void>;
+    static compileAppUxToJavascript(file: IFileParam, resultFiles: IFileParam[], context: IFileLaneContext, compileOption: IJavascriptCompileOption): Promise<void>;
     /**
      * 判断是否为src/app.ux
      * @param filePath
@@ -42,12 +44,14 @@ declare class UxLoaderUtils {
      * @returns
      */
     static getAppUxContent(fileContent: string): string;
+    private static addTemplateProtobuf;
     /**
      * 给template增加外层包裹内容
      * @param templateTree
      * @returns
      */
-    static wrapTempalte(templateTree: SourceFile): string;
+    static wrapTempalte(templateTree: SourceFile, file: IFileParam, compilerOption: IJavascriptCompileOption): string;
+    private static wrapStyle;
     /**
      * 给script增加外层包裹内容
      * @param isPageUx
@@ -55,6 +59,6 @@ declare class UxLoaderUtils {
      * @returns
      */
     static handleScriptContent(isPageUx: boolean, appScriptTree: SourceFile): string;
-    static getReturnType(isPageUx: boolean): "$app_exports$['entry'] =" | "return";
+    static getReturnType(isPageUx: boolean): "$app_exports$['entry'] =" | "module.exports = ";
 }
 export default UxLoaderUtils;