@hadss/hmrouter-plugin 1.0.0-rc.9 → 1.1.1-alpha.0

package/examples/CustomExtension.ts

@@ -0,0 +1,256 @@
+/*
+ * 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.
+ */
+
+import { appTasks } from '@ohos/hvigor-ohos-plugin';
+import {
+  BaseAnalyzeResult,
+  ExtensionContext,
+  Logger,
+  PluginExtension,
+  registerPluginExtension
+} from '@hadss/hmrouter-plugin';
+import { ClassDeclaration, Expression, PropertyAssignment, SourceFile, SyntaxKind } from 'ts-morph';
+
+interface RouterInfo {
+  name: string;
+  pageSourceFile: string;
+  buildFunction: string;
+  customData: Record<string, any>;
+}
+
+interface MyExtensionContext extends ExtensionContext {
+  customPages?: RouterInfo[];
+  routerMap: RouterInfo[];
+}
+
+interface MyAnalyzeResult extends BaseAnalyzeResult {
+  [key: string]: any;
+}
+
+// 示例1: RouterParam注解分析器
+export class RouterParamAnalyzer {
+  readonly name = 'RouterParamAnalyzer';
+
+  analyze(sourceFile: SourceFile, filePath: string, context: MyExtensionContext): void {
+    Logger.debug('', `开始分析RouterParam注解: ${filePath}`);
+
+    // 获取所有ExpressionStatement以获取struct关键字后面的组件名称
+    const viewNameArr = sourceFile
+      .getChildrenOfKind(SyntaxKind.ExpressionStatement)
+      .map((node) => node.getText())
+      .filter((text) => text !== 'struct');
+
+    // 解析结构体声明中的RouterParam注解
+    sourceFile.getChildrenOfKind(SyntaxKind.MissingDeclaration).forEach((node, index) => {
+      node.getChildrenOfKind(SyntaxKind.Decorator).forEach((decorator) => {
+        if (decorator.getName() === "RouterParam") {
+          // 解析RouterParam注解的参数
+          const result: MyAnalyzeResult = {
+            name: viewNameArr[index],
+            annotation: decorator.getName(),
+            sourceFilePath: filePath
+          };
+
+          // 解析装饰器参数
+          decorator.getArguments().forEach((arg) => {
+            const objLiteral = arg.asKind(SyntaxKind.ObjectLiteralExpression);
+            if (objLiteral) {
+              objLiteral.getProperties().forEach((prop) => {
+                if (prop.getKind() === SyntaxKind.PropertyAssignment) {
+                  const propertyAssignment = prop as PropertyAssignment;
+                  const propertyName = propertyAssignment.getName();
+                  const initializer = propertyAssignment.getInitializer();
+
+                  if (initializer) {
+                    // 将解析结果添加到result对象
+                    result[propertyName] = this.parsePrimitiveValue(initializer);
+                  }
+                }
+              });
+            }
+          });
+
+          // 如果需要后续保存到路由表中请调用addAnalyzeResults添加分析结果
+          // context.addAnalyzeResults(result);
+
+          // 为组件添加模板数据，用于代码生成
+          context.addTemplateData(result.name, {
+            paramType: result['paramType'] || 'default',
+            isCustomParam: true,
+            customParams: result['params'] || [],
+            sourceFile: filePath
+          });
+
+          Logger.debug('', `发现RouterParam注解: ${result.name}`);
+        }
+      });
+    });
+  }
+
+  private parsePrimitiveValue(value: Expression): any {
+    let propertyValue;
+    switch (value.getKind()) {
+      case SyntaxKind.StringLiteral:
+        propertyValue = value.asKind(SyntaxKind.StringLiteral)?.getLiteralValue();
+        break;
+      case SyntaxKind.NumericLiteral:
+        propertyValue = value.asKind(SyntaxKind.NumericLiteral)?.getLiteralValue();
+        break;
+      case SyntaxKind.TrueKeyword:
+        propertyValue = true;
+        break;
+      case SyntaxKind.FalseKeyword:
+        propertyValue = false;
+        break;
+      case SyntaxKind.ArrayLiteralExpression:
+        propertyValue = value
+          .asKind(SyntaxKind.ArrayLiteralExpression)
+          ?.getElements()
+          .map((item) => {
+            if (item.getKind() === SyntaxKind.StringLiteral) {
+              return item.asKind(SyntaxKind.StringLiteral)?.getLiteralValue();
+            }
+            return null;
+          })
+          .filter(item => item !== null);
+        break;
+    }
+    return propertyValue;
+  }
+}
+
+// 示例2: CustomPage注解分析器
+export class CustomPageAnalyzer {
+  readonly name = 'CustomPageAnalyzer';
+
+  analyze(sourceFile: SourceFile, filePath: string, context: MyExtensionContext): void {
+    Logger.debug('', `开始分析CustomPage注解: ${filePath}`);
+
+    // 分析使用@CustomPage注解的类
+    sourceFile.getClasses().forEach((cls: ClassDeclaration) => {
+      cls.getDecorators().forEach(decorator => {
+        if (decorator.getName() === 'CustomPage') {
+          const className = cls.getName() || '';
+
+          // 创建分析结果
+          const result: MyAnalyzeResult = {
+            name: className,
+            annotation: 'CustomPage',
+            sourceFilePath: filePath
+          };
+
+          // 解析装饰器参数
+          decorator.getArguments().forEach((arg) => {
+            const objLiteral = arg.asKind(SyntaxKind.ObjectLiteralExpression);
+            if (objLiteral) {
+              objLiteral.getProperties().forEach((prop) => {
+                if (prop.getKind() === SyntaxKind.PropertyAssignment) {
+                  const propertyAssignment = prop as PropertyAssignment;
+                  const propertyName = propertyAssignment.getName();
+                  const initializer = propertyAssignment.getInitializer();
+
+                  if (initializer && initializer.getKind() === SyntaxKind.StringLiteral) {
+                    result[propertyName] = initializer.asKind(SyntaxKind.StringLiteral)?.getLiteralValue();
+                  }
+                }
+              });
+            }
+          });
+
+          // 添加分析结果
+          context.addAnalyzeResults(result);
+
+          // 存储自定义页面路径信息
+          const customPages = context.customPages || [];
+          customPages.push(result);
+          context.customPages = customPages;
+
+          Logger.debug('', `发现CustomPage注解: ${className}, pageUrl: ${result['pageUrl']}`);
+        }
+      });
+    });
+  }
+}
+
+// 插件扩展类
+export class CustomPluginExtension extends PluginExtension<MyExtensionContext> {
+  get name(): string {
+    return 'CustomPluginExtension';
+  }
+
+  // 提供注解分析器
+  afterAnnotationAnalysis(sourceFile: SourceFile, filePath: string, context: MyExtensionContext): void {
+    const analyzers = [new RouterParamAnalyzer(), new CustomPageAnalyzer()];
+    for (const analyzer of analyzers) {
+      analyzer.analyze(sourceFile, filePath, context);
+    }
+  }
+
+  // 代码生成阶段，可以使用RouterParam注解分析结果
+  afterCodeGeneration(context: MyExtensionContext): void {
+    // 获取所有模板数据
+    const templateDataMap = context.getTemplateDataMap();
+
+    // 示例: 输出找到的RouterParam数据
+    for (const [componentName, templateData] of templateDataMap.entries()) {
+      if (templateData.isCustomParam) {
+        Logger.info(
+          this.name,
+          `组件 ${componentName} 将使用自定义参数类型: ${templateData.paramType}`
+        );
+        // 实际场景可以在此生成额外的代码
+      }
+    }
+  }
+
+  // 路由表构建阶段，将CustomPage注解分析结果添加到路由表
+  afterRouterMapBuilding(context: MyExtensionContext): void {
+    // 从私有存储获取CustomPage分析结果
+    const customPages = context.customPages || [];
+
+    // 将CustomPage添加到路由表
+    for (const page of customPages) {
+      const pageUrl = page.customData['pageUrl'];
+      if (pageUrl) {
+        // 检查路由表中是否已存在该路径
+        const existingRoute = context.routerMap.find(route => route.customData.pageUrl === pageUrl);
+        if (!existingRoute) {
+          // 创建新的路由项并添加到路由表
+          context.routerMap.push({
+            name: pageUrl,
+            buildFunction: page.name,
+            pageSourceFile: page.pageSourceFile,
+            customData: {
+              ...page.customData,
+            }
+          });
+
+          Logger.info(
+            this.name,
+            `添加自定义页面到路由表: ${pageUrl} -> ${page.name}`
+          );
+        }
+      }
+    }
+  }
+}
+
+// 注册扩展
+registerPluginExtension(new CustomPluginExtension());
+
+export default {
+  system: appTasks,
+  plugins: []
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hadss/hmrouter-plugin",
-  "version": "1.0.0-rc.9",
+  "version": "1.1.1-alpha.0",
   "description": "HMRouter Compiler Plugin",
   "main": "dist/Index.js",
   "scripts": {
@@ -8,7 +8,6 @@
     "test": "cross-env TS_NODE_COMPILER_OPTIONS='{\"module\": \"commonjs\" }' mocha",
     "dev": "tsc && node dist/index.js",
     "build": "tsc",
-    "package": "tsc && npm pack && mv hadss*.tgz ../libs",
     "release": "tsc && npm publish --access public"
   },
   "keywords": [
@@ -24,8 +23,9 @@
     "ts-morph": "^23.0.0"
   },
   "devDependencies": {
-    "@ohos/hvigor": "5.7.4",
-    "@ohos/hvigor-ohos-plugin": "5.7.4",
+    "@ohos/hvigor": "^5.8.9",
+    "@ohos/hvigor-ohos-plugin": "^5.8.9",
+    "typescript": "4.9.5",
     "@types/chai": "^4.3.19",
     "@types/ejs": "^3.1.5",
     "@types/micromatch": "^4.0.9",
@@ -39,9 +39,10 @@
   "publishConfig": {
     "registry": "https://registry.npmjs.org"
   },
-  "homepage": "https://gitee.com/hadss/hmrouter",
+  "homepage": "https://gitcode.com/openharmony-sig/ohrouter",
   "repository": {
     "type": "git",
-    "url": "https://gitee.com/hadss/hmrouter"
+    "url": "https://gitcode.com/openharmony-sig/ohrouter.git",
+    "directory": "HMRouterPlugin"
   }
-}
+}

package/template/customBuilder.ejs

@@ -0,0 +1,25 @@
+/*
+ * 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.
+ */
+
+// instrument ignore file
+// auto-generated <%= componentName %>Builder.ets by HMRouter
+import <%if(isDefaultExport) {%> <%= componentName %> <% } else {%> { <%= componentName %> } <% } %> from '<%= importPath %>'
+
+@Builder
+export function <%= componentName %>Builder(name: string, param: Object) {
+  <%= componentName %>()
+}
+
+export const <%= componentName %>BuilderWrapBuilder = wrapBuilder(<%= componentName %>Builder)

package/template/viewBuilder.ejs

@@ -0,0 +1,51 @@
+/*
+ * 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.
+ */
+
+// instrument ignore file
+// auto-generated <%= componentName %>Builder.ets by HMRouter
+import <%if(isDefaultExport) {%> <%= componentName %> <% } else {%> { <%= componentName %> } <% } %> from '<%= importPath %>'
+import { NavDestinationHelper } 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 {
+  private helper: NavDestinationHelper = new NavDestinationHelper(this);
+
+  build() {
+    NavDestination() {
+      <%= componentName %>()
+    }
+    <% if(dialog){ %>.mode(NavDestinationMode.DIALOG)<% } %>
+    .hideTitleBar(true)
+    .attributeModifier(this.helper.modifier)
+    .gestureModifier(this.helper.gestureModifier)
+    .onWillAppear(()=>{this.helper.onWillAppear()})
+    .onAppear(() => {this.helper.onAppear()})
+    .onWillShow(()=>{this.helper.onWillAppear()})
+    .onShown(()=>{this.helper.onShown()})
+    .onWillHide(()=>{this.helper.onWillHide()})
+    .onHidden(()=>{this.helper.onHidden()})
+    .onWillDisappear(()=>{this.helper.onWillDisappear()})
+    .onDisAppear(()=>{this.helper.onDisAppear()})
+    .onReady((ctx)=>{this.helper.onReady(ctx)})
+    .onBackPressed(()=> this.helper.onBackPressed())
+  }
+}

package/{viewBuilder.ejs → template/viewBuilder_v1.ejs}

@@ -13,26 +13,31 @@
  * limitations under the License.
  */
 
+// instrument ignore file
 // auto-generated <%= componentName %>Builder.ets by HMRouter
-import { <%= componentName %> } from '<%= importPath %>'
-import { TemplateService, TranslateOption, ScaleOption, OpacityOption } from '@hadss/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 = '<%= pageUrl %>'
+  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)
   }
@@ -47,7 +52,6 @@ export struct <%= componentName %>Generated {
     }
     <% if(dialog){ %>.mode(NavDestinationMode.DIALOG)<% } %>
     .hideTitleBar(true)
-    .hitTestBehavior(HitTestMode.Transparent)
     .gesture(PanGesture()
       .onActionStart((event: GestureEvent) => {
         TemplateService.interactiveStart(this.navigationId, this.ndId, event)
@@ -58,6 +62,9 @@ export struct <%= componentName %>Generated {
       .onActionEnd((event: GestureEvent) =>{
         TemplateService.interactiveFinish(this.navigationId, this.ndId, event)
       })
+      .onActionCancel(() =>{
+        TemplateService.interactiveCancel(this.navigationId, this.ndId)
+      })
     )
     .translate(this.translateOption)
     .scale(this.scaleOption)

package/dist/common/Constant.d.ts

@@ -1,27 +0,0 @@
-export declare class HMRouterPluginConstant {
-    static readonly ANIMATOR_PREFIX = "__animator__";
-    static readonly INTERCEPTOR_PREFIX = "__interceptor__";
-    static readonly LIFECYCLE_PREFIX = "__lifecycle__";
-    static readonly SERVICE_PREFIX = "__service__";
-    static readonly PAGE_URL_PREFIX = "";
-    static readonly FILE_SEPARATOR: "\\" | "/";
-    static readonly DELIMITER = "/";
-    static readonly MODULE_ROUTER_MAP_NAME = "$profile:hm_router_map";
-    static readonly ROUTER_MAP_NAME = "hm_router_map.json";
-    static readonly TEMP_ROUTER_MAP_PATH = "../../intermediates/router_map";
-    static readonly RAWFILE_DIR = "src/main/resources/rawfile/hm_router_map.json";
-    static readonly VIEW_NAME_PREFIX = "HM";
-    static readonly VIEW_NAME_SUFFIX = ".ets";
-    static readonly JSON_SUFFIX = ".json";
-    static readonly HAP_PLUGIN_ID = "HAP_HMROUTER_PLUGIN";
-    static readonly HSP_PLUGIN_ID = "HSP_HMROUTER_PLUGIN";
-    static readonly HAR_PLUGIN_ID = "HAR_HMROUTER_PLUGIN";
-    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";
-    static readonly CLASS_ANNOTATION_ARR: string[];
-    static readonly CONFIG_FILE_NAME = "hmrouter_config.json";
-    static readonly PARENT_DELIMITER = "../";
-}

package/dist/common/Constant.js

@@ -1,35 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.HMRouterPluginConstant = void 0;
-const path_1 = __importDefault(require("path"));
-class HMRouterPluginConstant {
-}
-exports.HMRouterPluginConstant = HMRouterPluginConstant;
-HMRouterPluginConstant.ANIMATOR_PREFIX = '__animator__';
-HMRouterPluginConstant.INTERCEPTOR_PREFIX = '__interceptor__';
-HMRouterPluginConstant.LIFECYCLE_PREFIX = '__lifecycle__';
-HMRouterPluginConstant.SERVICE_PREFIX = '__service__';
-HMRouterPluginConstant.PAGE_URL_PREFIX = '';
-HMRouterPluginConstant.FILE_SEPARATOR = path_1.default.sep;
-HMRouterPluginConstant.DELIMITER = '/';
-HMRouterPluginConstant.MODULE_ROUTER_MAP_NAME = '$profile:hm_router_map';
-HMRouterPluginConstant.ROUTER_MAP_NAME = 'hm_router_map.json';
-HMRouterPluginConstant.TEMP_ROUTER_MAP_PATH = '../../intermediates/router_map';
-HMRouterPluginConstant.RAWFILE_DIR = 'src/main/resources/rawfile/hm_router_map.json';
-HMRouterPluginConstant.VIEW_NAME_PREFIX = 'HM';
-HMRouterPluginConstant.VIEW_NAME_SUFFIX = '.ets';
-HMRouterPluginConstant.JSON_SUFFIX = '.json';
-HMRouterPluginConstant.HAP_PLUGIN_ID = 'HAP_HMROUTER_PLUGIN';
-HMRouterPluginConstant.HSP_PLUGIN_ID = 'HSP_HMROUTER_PLUGIN';
-HMRouterPluginConstant.HAR_PLUGIN_ID = 'HAR_HMROUTER_PLUGIN';
-HMRouterPluginConstant.ROUTER_ANNOTATION = 'HMRouter';
-HMRouterPluginConstant.ANIMATOR_ANNOTATION = 'HMAnimator';
-HMRouterPluginConstant.INTERCEPTOR_ANNOTATION = 'HMInterceptor';
-HMRouterPluginConstant.LIFECYCLE_ANNOTATION = 'HMLifecycle';
-HMRouterPluginConstant.SERVICE_ANNOTATION = 'HMService';
-HMRouterPluginConstant.CLASS_ANNOTATION_ARR = ['HMAnimator', 'HMInterceptor', 'HMLifecycle'];
-HMRouterPluginConstant.CONFIG_FILE_NAME = 'hmrouter_config.json';
-HMRouterPluginConstant.PARENT_DELIMITER = '../';

package/dist/utils/ConfusionUtil.d.ts

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

package/dist/utils/ConfusionUtil.js

@@ -1,27 +0,0 @@
-"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;