@hadss/hmrouter-plugin 1.0.0-rc.0 → 1.0.0-rc.10

package/dist/constants/ConfigConstants.d.ts

@@ -0,0 +1,11 @@
+export default class ConfigConstants {
+    static readonly DEFAULT_SCAN_DIR = "src/main/ets";
+    static readonly DEFAULT_ROUTER_MAP_DIR = "src/main/resources/base/profile";
+    static readonly DEFAULT_BUILD_DIR = "src/main/ets/generated";
+    static readonly DEFAULT_BUILD_TPL = "viewBuilder.ejs";
+    static readonly ROUTER_ANNOTATION = "HMRouter";
+    static readonly ANIMATOR_ANNOTATION = "HMAnimator";
+    static readonly INTERCEPTOR_ANNOTATION = "HMInterceptor";
+    static readonly LIFECYCLE_ANNOTATION = "HMLifecycle";
+    static readonly SERVICE_ANNOTATION = "HMService";
+}

package/dist/constants/ConfigConstants.js

@@ -0,0 +1,15 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class ConfigConstants {
+}
+ConfigConstants.DEFAULT_SCAN_DIR = 'src/main/ets';
+ConfigConstants.DEFAULT_ROUTER_MAP_DIR = 'src/main/resources/base/profile';
+ConfigConstants.DEFAULT_BUILD_DIR = 'src/main/ets/generated';
+ConfigConstants.DEFAULT_BUILD_TPL = 'viewBuilder.ejs';
+ConfigConstants.ROUTER_ANNOTATION = 'HMRouter';
+ConfigConstants.ANIMATOR_ANNOTATION = 'HMAnimator';
+ConfigConstants.INTERCEPTOR_ANNOTATION = 'HMInterceptor';
+ConfigConstants.LIFECYCLE_ANNOTATION = 'HMLifecycle';
+ConfigConstants.SERVICE_ANNOTATION = 'HMService';
+exports.default = ConfigConstants;
+;

package/dist/constants/TaskConstants.d.ts

@@ -0,0 +1,9 @@
+export default class TaskConstants {
+    static readonly PRE_BUILD = "@PreBuild";
+    static readonly MERGE_PROFILE = "@MergeProfile";
+    static readonly PROCESS_ROUTER_MAP = "@ProcessRouterMap";
+    static readonly PROCESS_RESOURCE = "@ProcessResource";
+    static readonly PLUGIN_TASK = "@HMRouterPluginTask";
+    static readonly COPY_ROUTER_MAP_TASK = "@HMRouterCopyRouterMapToRawFileTask";
+    static readonly GENERATE_OBFUSCATION_TASK = "@HMRouterGenerateObfuscationFileTask";
+}

package/dist/constants/TaskConstants.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class TaskConstants {
+}
+TaskConstants.PRE_BUILD = '@PreBuild';
+TaskConstants.MERGE_PROFILE = '@MergeProfile';
+TaskConstants.PROCESS_ROUTER_MAP = '@ProcessRouterMap';
+TaskConstants.PROCESS_RESOURCE = '@ProcessResource';
+TaskConstants.PLUGIN_TASK = '@HMRouterPluginTask';
+TaskConstants.COPY_ROUTER_MAP_TASK = '@HMRouterCopyRouterMapToRawFileTask';
+TaskConstants.GENERATE_OBFUSCATION_TASK = '@HMRouterGenerateObfuscationFileTask';
+exports.default = TaskConstants;
+;

package/dist/store/PluginStore.d.ts

@@ -0,0 +1,12 @@
+export default class PluginStore implements IPluginStore {
+    private static instance;
+    variableCache: Map<string, Map<string, string[]>>;
+    projectFilePath: string;
+    static clear(): void;
+    static getInstance(): IPluginStore;
+}
+interface IPluginStore {
+    variableCache: Map<string, Map<string, string[]>>;
+    projectFilePath: string;
+}
+export {};

package/dist/store/PluginStore.js

@@ -0,0 +1,19 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+class PluginStore {
+    constructor() {
+        this.variableCache = new Map();
+        this.projectFilePath = '';
+    }
+    static clear() {
+        this.instance = null;
+    }
+    static getInstance() {
+        if (!this.instance) {
+            this.instance = new PluginStore();
+        }
+        return this.instance;
+    }
+}
+PluginStore.instance = null;
+exports.default = PluginStore;

package/dist/utils/ConfusionUtil.d.ts

@@ -0,0 +1,4 @@
+import { RouterInfo } from '../common/PluginModel';
+export default class ConfusionUtil {
+    static buildObfuscatedStrings(routerMap: RouterInfo[]): string;
+}

package/dist/utils/ConfusionUtil.js

@@ -0,0 +1,27 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CommonConstants_1 = __importDefault(require("../constants/CommonConstants"));
+class ConfusionUtil {
+    static buildObfuscatedStrings(routerMap) {
+        let srcPathArr = [...new Set(routerMap.map((routerInfo) => {
+                return CommonConstants_1.default.CURRENT_DELIMITER + routerInfo.pageSourceFile;
+            }))];
+        let classNameArr = [...new Set(routerMap.filter((routerInfo) => {
+                return routerInfo.name.includes('__');
+            }).map((routerInfo) => {
+                return routerInfo.customData.name;
+            }))];
+        let functionName = [...new Set(routerMap.filter((routerInfo) => {
+                return routerInfo.name.includes(CommonConstants_1.default.SERVICE_PREFIX);
+            }).map((routerInfo) => {
+                return routerInfo.customData.functionName;
+            }))];
+        return CommonConstants_1.default.KEEP_FILE_NAME + CommonConstants_1.default.LINE_BREAK +
+            srcPathArr.concat(CommonConstants_1.default.KEEP_PROPERTY_NAME, classNameArr, functionName)
+                .join(CommonConstants_1.default.LINE_BREAK);
+    }
+}
+exports.default = ConfusionUtil;

package/dist/utils/FileUtil.d.ts

@@ -0,0 +1,11 @@
+import { FileUtil } from '@ohos/hvigor';
+import fs from 'fs';
+export default class HMFileUtil extends FileUtil {
+    static rmSync(path: fs.PathLike, options?: fs.RmOptions): void;
+    static unlinkSync(path: fs.PathLike): void;
+    static readdirSync(path: fs.PathLike, options?: {
+        encoding: BufferEncoding | null;
+        withFileTypes?: false | undefined;
+        recursive?: boolean | undefined;
+    }): string[];
+}

package/dist/utils/FileUtil.js

@@ -0,0 +1,20 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const hvigor_1 = require("@ohos/hvigor");
+const fs_1 = __importDefault(require("fs"));
+class HMFileUtil extends hvigor_1.FileUtil {
+    static rmSync(path, options) {
+        return fs_1.default.rmSync(path, options);
+    }
+    static unlinkSync(path) {
+        return fs_1.default.unlinkSync(path);
+    }
+    static readdirSync(path, options) {
+        return fs_1.default.readdirSync(path, options);
+    }
+}
+exports.default = HMFileUtil;
+;

package/dist/utils/ObfuscationUtil.d.ts

@@ -0,0 +1,4 @@
+import { RouterInfo } from '../common/PluginModel';
+export default class ObfuscationUtil {
+    static buildObfuscatedStrings(routerMap: RouterInfo[]): string;
+}

package/dist/utils/ObfuscationUtil.js

@@ -0,0 +1,34 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const CommonConstants_1 = __importDefault(require("../constants/CommonConstants"));
+class ObfuscationUtil {
+    static buildObfuscatedStrings(routerMap) {
+        let srcPathArr = [...new Set(routerMap.map((routerInfo) => {
+                return CommonConstants_1.default.CURRENT_DELIMITER + routerInfo.pageSourceFile;
+            }))];
+        let classNameArr = [...new Set(routerMap.filter((routerInfo) => {
+                return routerInfo.name.includes('__');
+            }).map((routerInfo) => {
+                return routerInfo.customData.name;
+            }))];
+        let functionName = [...new Set(routerMap.filter((routerInfo) => {
+                return routerInfo.name.includes(CommonConstants_1.default.SERVICE_PREFIX);
+            }).map((routerInfo) => {
+                return routerInfo.customData.functionName;
+            }))];
+        let watchFunctionName = [...new Set(routerMap.filter((routerInfo) => {
+                return routerInfo.buildFunction;
+            }).map((routerInfo) => {
+                return routerInfo.buildFunction + CommonConstants_1.default.WARP_BUILDER;
+            }))];
+        return CommonConstants_1.default.KEEP_FILE_NAME + CommonConstants_1.default.LINE_BREAK +
+            srcPathArr.concat(CommonConstants_1.default.KEEP_PROPERTY_NAME, functionName)
+                .concat(CommonConstants_1.default.KEEP_GLOBAL_NAME, classNameArr, watchFunctionName)
+                .join(CommonConstants_1.default.LINE_BREAK);
+    }
+}
+exports.default = ObfuscationUtil;
+;

package/dist/utils/StringUtil.d.ts

@@ -0,0 +1,3 @@
+export declare class StringUtil {
+    static stringToHashCode(str: string): number;
+}

package/dist/utils/StringUtil.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.StringUtil = void 0;
+class StringUtil {
+    static stringToHashCode(str) {
+        let hash = 0;
+        if (str.length === 0) {
+            return hash;
+        }
+        for (let i = 0; i < str.length; i++) {
+            const char = str.charCodeAt(i);
+            hash = (hash << 5) - hash + char;
+            hash |= 0;
+        }
+        return hash;
+    }
+}
+exports.StringUtil = StringUtil;

package/dist/utils/TsAstUtil.d.ts

@@ -0,0 +1,9 @@
+import { Project, SourceFile } from 'ts-morph';
+export declare let project: Project | null;
+export declare class TsAstUtil {
+    static getSourceFile(filePath: string): SourceFile;
+    static clearProject(): void;
+    static parseConstantValue(sourceFile: SourceFile, variableName: string, propertyName?: string): string;
+    static parseCrossModuleVariable(scanDir: string): Map<string, string[]>;
+    private static getExportedVariables;
+}

package/dist/utils/TsAstUtil.js

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TsAstUtil = exports.project = void 0;
+const ts_morph_1 = require("ts-morph");
+const hvigor_1 = require("@ohos/hvigor");
+const Logger_1 = require("../common/Logger");
+exports.project = null;
+class TsAstUtil {
+    static getSourceFile(filePath) {
+        if (!hvigor_1.FileUtil.exist(filePath)) {
+            throw new Error(`File not found: ${filePath}`);
+        }
+        if (!exports.project) {
+            exports.project = new ts_morph_1.Project({
+                compilerOptions: { target: ts_morph_1.ScriptTarget.ES2021 }
+            });
+        }
+        return exports.project.addSourceFileAtPath(filePath);
+    }
+    static clearProject() {
+        exports.project = null;
+    }
+    static parseConstantValue(sourceFile, variableName, propertyName) {
+        let result;
+        if (propertyName) {
+            let classInstance = sourceFile.getClasses().find((classes) => {
+                return classes.getName() === variableName;
+            });
+            if (!classInstance) {
+                throw new Error(`Unknown class '${variableName}'`);
+            }
+            let property = classInstance.getProperties().find((properties) => {
+                return properties.getName() === propertyName;
+            });
+            if (!property) {
+                throw new Error(`Unknown property '${propertyName}'`);
+            }
+            result = property.getInitializer();
+        }
+        else {
+            let constant = sourceFile.getVariableDeclarations().find(declaration => {
+                return declaration.getName() === variableName;
+            });
+            if (!constant) {
+                throw new Error(`Unknown constant '${variableName}'`);
+            }
+            result = constant.getInitializer();
+        }
+        if (result.getKind() !== ts_morph_1.SyntaxKind.StringLiteral) {
+            Logger_1.Logger.error(Logger_1.PluginError.ERR_INVALID_STRING_VALUE, variableName);
+            throw new Error('Invalid constants value, only string literal is supported, variableName:' + variableName);
+        }
+        return result.asKind(ts_morph_1.SyntaxKind.StringLiteral)?.getLiteralValue();
+    }
+    static parseCrossModuleVariable(scanDir) {
+        let sourceFiles = exports.project.addSourceFilesAtPaths(`${scanDir}/**/*.ets`);
+        const exportMap = new Map();
+        for (let sourceFile of sourceFiles) {
+            const exportedNames = this.getExportedVariables(sourceFile);
+            if (exportedNames.length > 0) {
+                exportMap.set(sourceFile.getFilePath(), exportedNames);
+            }
+        }
+        return exportMap;
+    }
+    static getExportedVariables(sourceFile) {
+        const exportSymbols = [];
+        let exportKeywordNodes = sourceFile.getDescendantsOfKind(ts_morph_1.SyntaxKind.ExportKeyword);
+        exportKeywordNodes.forEach((node) => {
+            let parentNodeKind = node.getParent()?.getKind();
+            switch (parentNodeKind) {
+                case ts_morph_1.SyntaxKind.VariableStatement:
+                    let variableStatement = node.getParent()?.asKind(ts_morph_1.SyntaxKind.VariableStatement);
+                    let variableNames = variableStatement.getDeclarationList().getDeclarations().map((declaration) => {
+                        return declaration.getName();
+                    });
+                    exportSymbols.push(...variableNames);
+                    break;
+                case ts_morph_1.SyntaxKind.ClassDeclaration:
+                    let classDeclaration = node.getParent();
+                    let className = classDeclaration?.asKind(ts_morph_1.SyntaxKind.ClassDeclaration)?.getName();
+                    exportSymbols.push(className);
+                    break;
+            }
+        });
+        return exportSymbols;
+    }
+}
+exports.TsAstUtil = TsAstUtil;

package/package.json

@@ -1,27 +1,46 @@
-{
-  "name": "@hadss/hmrouter-plugin",
-  "version": "1.0.0-rc.0",
-  "description": "HMRouter Compiler Plugin",
-  "main": "lib/index.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1",
-    "dev": "tsc && node lib/index.js",
-    "builder": "tsc"
-  },
-  "keywords": [
-    "hmrouter",
-    "harmonyos",
-    "openharmony"
-  ],
-  "author": "Huawei-HADSS",
-  "license": "Apache-2.0",
-  "dependencies": {
-    "typescript": "^5.5.3",
-    "handlebars": "^4.7.8"
-  },
-  "devDependencies": {
-    "@types/node": "^20.14.10",
-    "@ohos/hvigor": "^5.2.3",
-    "@ohos/hvigor-ohos-plugin": "^5.2.3"
-  }
-}
+{
+  "name": "@hadss/hmrouter-plugin",
+  "version": "1.0.0-rc.10",
+  "description": "HMRouter Compiler Plugin",
+  "main": "dist/Index.js",
+  "scripts": {
+    "test:unit": "cross-env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' TEST_ENV='unit' mocha",
+    "test": "cross-env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha",
+    "dev": "tsc && node dist/index.js",
+    "build": "tsc",
+    "release": "tsc && npm publish --access public"
+  },
+  "keywords": [
+    "hmrouter",
+    "harmonyos",
+    "openharmony"
+  ],
+  "author": "DTSE",
+  "license": "Apache-2.0",
+  "dependencies": {
+    "ejs": "^3.1.10",
+    "micromatch": "^4.0.8",
+    "ts-morph": "^23.0.0"
+  },
+  "devDependencies": {
+    "@ohos/hvigor": "^5.8.9",
+    "@ohos/hvigor-ohos-plugin": "^5.8.9",
+    "@types/chai": "^4.3.19",
+    "@types/ejs": "^3.1.5",
+    "@types/micromatch": "^4.0.9",
+    "@types/mocha": "^10.0.8",
+    "@types/node": "^20.16.6",
+    "chai": "^4.5.0",
+    "cross-env": "^7.0.3",
+    "mocha": "^10.7.3",
+    "ts-node": "^10.9.2"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "homepage": "https://gitee.com/hadss/hmrouter",
+  "repository": {
+    "type": "git",
+    "url": "https://gitee.com/hadss/hmrouter"
+  }
+}

package/viewBuilder.ejs

@@ -0,0 +1,103 @@
+/*
+ * Copyright (c) 2024 Huawei Device Co., Ltd.
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+// auto-generated <%= componentName %>Builder.ets by HMRouter
+import <%if(isDefaultExport) {%> <%= componentName %> <% } else {%> { <%= componentName %> } <% } %> from '<%= importPath %>'
+import { TemplateService, TranslateOption, ScaleOption, OpacityOption, HMRouterMgr } from '@hadss/hmrouter'
+
+@Builder
+export function <%= componentName %>Builder(name: string, param: Object) {
+  <%= componentName %>Generated()
+}
+
+export const <%= componentName %>BuilderWrapBuilder = wrapBuilder(<%= componentName %>Builder)
+
+@Component
+export struct <%= componentName %>Generated {
+  @State translateOption: TranslateOption = new TranslateOption()
+  @State scaleOption: ScaleOption = new ScaleOption()
+  @State opacityOption: OpacityOption = new OpacityOption()
+  private pageUrl: string = ''
+  private ndId: string = ''
+  private navigationId: string = ''
+
+  aboutToAppear(): void {
+    this.navigationId = this.queryNavigationInfo()!.navigationId;
+    const allPathName = HMRouterMgr.getPathStack(this.navigationId)?.getAllPathName();
+    this.pageUrl = allPathName ? allPathName[allPathName.length - 1] : '';
+    TemplateService.aboutToAppear(this.navigationId, this.pageUrl, <%= dialog %>,
+      this.translateOption, this.scaleOption, this.opacityOption)
+  }
+
+  aboutToDisappear(): void {
+    TemplateService.aboutToDisappear(this.navigationId, this.pageUrl, this.ndId)
+  }
+
+  build() {
+    NavDestination() {
+      <%= componentName %>()
+    }
+    <% if(dialog){ %>.mode(NavDestinationMode.DIALOG)<% } %>
+    .hideTitleBar(true)
+    .gesture(PanGesture()
+      .onActionStart((event: GestureEvent) => {
+        TemplateService.interactiveStart(this.navigationId, this.ndId, event)
+      })
+      .onActionUpdate((event: GestureEvent) =>{
+        TemplateService.interactiveProgress(this.navigationId, this.ndId, event)
+      })
+      .onActionEnd((event: GestureEvent) =>{
+        TemplateService.interactiveFinish(this.navigationId, this.ndId, event)
+      })
+      .onActionCancel(() =>{
+        TemplateService.interactiveCancel(this.navigationId, this.ndId)
+      })
+    )
+    .translate(this.translateOption)
+    .scale(this.scaleOption)
+    .opacity(this.opacityOption.opacity)
+    .onAppear(() => {
+      TemplateService.onAppear(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onDisAppear(() => {
+      TemplateService.onDisAppear(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onShown(() => {
+      TemplateService.onShown(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onHidden(() => {
+      TemplateService.onHidden(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onWillAppear(() => {
+      TemplateService.onWillAppear(this.navigationId, this.pageUrl)
+    })
+    .onWillDisappear(() => {
+      TemplateService.onWillDisappear(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onWillShow(() => {
+      TemplateService.onWillShow(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onWillHide(() => {
+      TemplateService.onWillHide(this.navigationId, this.pageUrl, this.ndId)
+    })
+    .onReady((navContext: NavDestinationContext) => {
+      this.ndId = navContext.navDestinationId!
+      TemplateService.onReady(this.navigationId, this.pageUrl, navContext)
+    })
+    .onBackPressed(() => {
+      return TemplateService.onBackPressed(this.navigationId, this.pageUrl, this.ndId)
+    })
+  }
+}