@ray-js/router-mp 1.6.30 → 2.0.0-alpha.0

package/lib/Router.d.ts

@@ -1,4 +1,4 @@
-import { Router as TRouter, RouteOptions } from '@ray-js/types';
+import type { RouteOptions, Router as TRouter } from '@ray-js/types';
 import { RouterScheduler } from './RouterScheduler';
 export declare class Router implements TRouter {
     private urlPrefix;
@@ -19,7 +19,25 @@ export declare class Router implements TRouter {
      * 标准化路由路径，将 web 标准的地址栏转化到 小程序地址
      */
     private normalizeRoute;
+    /**
+     * 跳转到指定路由
+     * @param to - routes.config.ts 中配置的路由地址
+     * @param options
+     * @param options.subpackage - 分包名
+     *
+     * @example
+     * router.push('/cat', { subpackage: 'packageA' });
+     */
     push(to: string, options?: RouteOptions): void;
+    /**
+     * 替换当前页到指定路由
+     * @param to - routes.config.ts 中配置的路由地址
+     * @param options
+     * @param options.subpackage - 分包名
+     *
+     * @example
+     * router.replace('/cat', { subpackage: 'packageA' });
+     */
     replace(to: string, options?: RouteOptions): void;
     reload(): void;
     go(delta: number): void;

package/lib/Router.js

@@ -1,6 +1,6 @@
 import _objectSpread from "@babel/runtime/helpers/esm/objectSpread2";
+import { navigateBack, navigateTo, reLaunch, redirectTo, switchTab } from '@ray-js/api';
 import { url } from '@ray-js/library';
-import { navigateBack, navigateTo, reLaunch, switchTab, redirectTo } from '@ray-js/api';
 import { RouterScheduler, currentPage } from './RouterScheduler';
 function pathRelative(fromPath, toPath) {
   const from = fromPath.split('/');
@@ -119,6 +119,16 @@ export class Router {
     }
     return Promise.resolve(matchedPage);
   }
+
+  /**
+   * 跳转到指定路由
+   * @param to - routes.config.ts 中配置的路由地址
+   * @param options
+   * @param options.subpackage - 分包名
+   *
+   * @example
+   * router.push('/cat', { subpackage: 'packageA' });
+   */
   push(to, options) {
     const subpackage = options === null || options === void 0 ? void 0 : options.subpackage;
     this.normalizeRoute({
@@ -137,6 +147,16 @@ export class Router {
       }
     });
   }
+
+  /**
+   * 替换当前页到指定路由
+   * @param to - routes.config.ts 中配置的路由地址
+   * @param options
+   * @param options.subpackage - 分包名
+   *
+   * @example
+   * router.replace('/cat', { subpackage: 'packageA' });
+   */
   replace(to, options) {
     const subpackage = options === null || options === void 0 ? void 0 : options.subpackage;
     this.normalizeRoute({
@@ -168,6 +188,7 @@ export class Router {
       delta: 1
     });
   }
+
   // 获取宿主环境上的 href ，小程序端需要通过 path 进行转换
   get href() {
     const page = currentPage();

package/lib/RouterScheduler.d.ts

@@ -1,4 +1,4 @@
-import { RouterScheduler as IRouterScheduler, Routes, SubPackages, TabBar } from '@ray-js/types';
+import { RouterScheduler as IRouterScheduler, type Routes, type SubPackages, type TabBar } from '@ray-js/types';
 export type Route = Routes[number] & {
     isTabBar: boolean;
 };
@@ -30,7 +30,7 @@ export declare class RouterScheduler extends IRouterScheduler<Route> {
         tabBar: TabBar;
         subpackages?: SubPackages;
     }): void;
-    getMatchedPage(pathname: string): import("@ray-js/types").Route & {
+    getMatchedPage(pathname: string): import("@ray-js/types").RootRouteItem & {
         isTabBar: boolean;
     } & {
         params: object;

package/lib/RouterScheduler.js

@@ -3,11 +3,11 @@ import "core-js/modules/esnext.iterator.constructor.js";
 import "core-js/modules/esnext.iterator.find.js";
 import "core-js/modules/esnext.iterator.for-each.js";
 import "core-js/modules/esnext.iterator.some.js";
-import { compile, match, pathToRegexp } from 'path-to-regexp';
+import { getLaunchOptionsSync } from '@ray-js/api';
 import { url } from '@ray-js/library';
-import slash from 'slash';
 import { RouterScheduler as IRouterScheduler } from '@ray-js/types';
-import { getLaunchOptionsSync } from '@ray-js/api';
+import { compile, match, pathToRegexp } from 'path-to-regexp';
+import slash from 'slash';
 export function currentPage() {
   const pages = getCurrentPages();
   if (pages.length > 0) {
@@ -43,8 +43,7 @@ export class RouterScheduler extends IRouterScheduler {
     if (!normalizedRoute.startsWith('/')) {
       normalizedRoute = '/' + normalizedRoute;
     }
-    const matchedRoute = this.getRouteByPath(normalizedRoute);
-    return matchedRoute;
+    return this.getRouteByPath(normalizedRoute);
   }
 
   /**
@@ -92,7 +91,8 @@ export class RouterScheduler extends IRouterScheduler {
     const tabBarList = (tabBar === null || tabBar === void 0 ? void 0 : tabBar.list) || [];
     subpackages.forEach(subPackage => {
       const root = subPackage.root;
-      subPackage.pages.forEach(page => {
+      const subPackagesPages = subPackage.routes || subPackage.pages || [];
+      subPackagesPages.forEach(page => {
         this.addSubPackagePage({
           root,
           route: page.route || page.path,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ray-js/router-mp",
-  "version": "1.6.30",
+  "version": "2.0.0-alpha.0",
   "description": "Ray Core",
   "keywords": [
     "ray"
@@ -23,22 +23,23 @@
     "watch": "tsc -p ./tsconfig.build.json --module esnext --outDir lib --watch"
   },
   "peerDependencies": {
-    "@ray-js/api": "1.5.17"
+    "@ray-js/api": "2.0.0-alpha.0"
   },
   "dependencies": {
-    "@ray-js/env": "1.6.30",
-    "@ray-js/library": "1.6.30",
-    "@ray-js/types": "1.6.30",
+    "@ray-js/env": "1.6.29",
+    "@ray-js/library": "1.6.29",
+    "@ray-js/types": "2.0.0-alpha.0",
     "@react-navigation/core": "^6.4.17",
     "path-to-regexp": "^6.3.0",
     "slash": "^5.1.0"
   },
   "devDependencies": {
-    "@ray-js/cli": "1.6.30"
+    "@ray-js/cli": "2.0.0-alpha.0",
+    "typescript": "^5.8.2"
   },
   "publishConfig": {
     "access": "public",
     "registry": "https://registry.npmjs.com"
   },
-  "gitHead": "6db627db6ff0dffe0a249fbfc07b0281454e82c9"
+  "gitHead": "511cd3f8d57c2888411700526781e65959037c5b"
 }

package/LICENSE.md

@@ -1,9 +0,0 @@
-Copyright © 2014-2022 Tuya.inc
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.