@tarojs/router 3.5.0-alpha.1 → 3.5.0-alpha.4

package/dist/router/spa.js

@@ -1,4 +1,12 @@
-/* eslint-disable dot-notation */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 import { container, createPageConfig, Current, eventCenter, SERVICE_IDENTIFIER, stringify } from '@tarojs/runtime';
 import { Action as LocationAction } from 'history';
 import UniversalRouter from 'universal-router';
@@ -8,6 +16,7 @@ import stacks from './stack';
 import { addLeadingSlash, routesAlias, stripBasename } from '../utils';
 import { RouterConfig } from '.';
 export function createRouter(app, config, framework) {
+    var _a, _b, _c;
     RouterConfig.config = config;
     const handler = new PageHandler(config);
     const runtimeHooks = container.get(SERVICE_IDENTIFIER.Hooks);
@@ -17,19 +26,20 @@ export function createRouter(app, config, framework) {
         path: routesAlias.getAll(addLeadingSlash(route.path)),
         action: route.load
     }));
-    const entryPagePath = config.entryPagePath || routes[0].path?.[0];
+    const entryPagePath = config.entryPagePath || ((_a = routes[0].path) === null || _a === void 0 ? void 0 : _a[0]) || '';
     const router = new UniversalRouter(routes, { baseUrl: basename || '' });
     const launchParam = handler.getQuery(stacks.length);
-    app.onLaunch?.(launchParam);
-    const render = async ({ location, action }) => {
+    (_b = app.onLaunch) === null || _b === void 0 ? void 0 : _b.call(app, launchParam);
+    const render = ({ location, action }) => __awaiter(this, void 0, void 0, function* () {
+        var _d, _e, _f, _g, _h;
         handler.pathname = decodeURI(location.pathname);
         let element;
         try {
-            element = await router.resolve(handler.router.forcePath || handler.pathname);
+            element = yield router.resolve(handler.router.forcePath || handler.pathname);
         }
         catch (error) {
             if (error.status === 404) {
-                app.onPageNotFound?.({
+                (_d = app.onPageNotFound) === null || _d === void 0 ? void 0 : _d.call(app, {
                     path: handler.pathname
                 });
             }
@@ -40,14 +50,14 @@ export function createRouter(app, config, framework) {
         if (!element)
             return;
         const pageConfig = handler.pageConfig;
-        let enablePullDownRefresh = config?.window?.enablePullDownRefresh || false;
+        let enablePullDownRefresh = ((_e = config === null || config === void 0 ? void 0 : config.window) === null || _e === void 0 ? void 0 : _e.enablePullDownRefresh) || false;
         eventCenter.trigger('__taroRouterChange', {
             toLocation: {
                 path: handler.pathname
             }
         });
         if (pageConfig) {
-            document.title = pageConfig.navigationBarTitleText ?? document.title;
+            document.title = (_f = pageConfig.navigationBarTitleText) !== null && _f !== void 0 ? _f : document.title;
             if (typeof pageConfig.enablePullDownRefresh === 'boolean') {
                 enablePullDownRefresh = pageConfig.enablePullDownRefresh;
             }
@@ -89,22 +99,20 @@ export function createRouter(app, config, framework) {
             shouldLoad = true;
         }
         if (shouldLoad || stacks.length < 1) {
-            const el = element.default ?? element;
-            const loadConfig = { ...pageConfig };
+            const el = (_g = element.default) !== null && _g !== void 0 ? _g : element;
+            const loadConfig = Object.assign({}, pageConfig);
             const stacksIndex = stacks.length;
             delete loadConfig['path'];
             delete loadConfig['load'];
-            const page = createPageConfig(enablePullDownRefresh ? runtimeHooks.createPullDownComponent?.(el, location.pathname, framework, handler.PullDownRefresh) : el, pathname + stringify(handler.getQuery(stacksIndex)), {}, loadConfig);
+            const page = createPageConfig(enablePullDownRefresh ? (_h = runtimeHooks.createPullDownComponent) === null || _h === void 0 ? void 0 : _h.call(runtimeHooks, el, location.pathname, framework, handler.PullDownRefresh) : el, pathname + stringify(handler.getQuery(stacksIndex)), {}, loadConfig);
             return handler.load(page, pageConfig, stacksIndex);
         }
-    };
-    if (history.location.pathname === '/') {
-        const stripped = stripBasename(history.location.pathname, handler.basename);
-        if (stripped === '/' || stripped === '') {
-            history.replace(prependBasename(entryPagePath + history.location.search));
-        }
+    });
+    const stripped = stripBasename(history.location.pathname, handler.basename);
+    if (stripped === '/' || stripped === '') {
+        history.replace(prependBasename(entryPagePath + history.location.search));
     }
     render({ location: history.location, action: LocationAction.Push });
-    app.onShow?.(launchParam);
+    (_c = app.onShow) === null || _c === void 0 ? void 0 : _c.call(app, launchParam);
     return history.listen(render);
 }

package/dist/router/stack.js

@@ -1,6 +1,8 @@
 class Stacks {
-    stacks = [];
-    backDelta = 0;
+    constructor() {
+        this.stacks = [];
+        this.backDelta = 0;
+    }
     set delta(delta) {
         if (delta > 0) {
             this.backDelta = delta;
@@ -29,7 +31,7 @@ class Stacks {
     }
     getLastIndex(pathname, stateWith = 1) {
         const list = [...this.stacks].reverse();
-        return list.findIndex((page, i) => i >= stateWith && page.path?.replace(/\?.*/g, '') === pathname);
+        return list.findIndex((page, i) => { var _a; return i >= stateWith && ((_a = page.path) === null || _a === void 0 ? void 0 : _a.replace(/\?.*/g, '')) === pathname; });
     }
     getDelta(pathname) {
         if (this.backDelta >= 1) {

package/dist/tabbar.js

@@ -24,6 +24,6 @@ export function initTabbar(config) {
         tabbar.conf.basename = routerConfig.basename;
     }
     const container = document.getElementById('container');
-    container?.appendChild(tabbar);
+    container === null || container === void 0 ? void 0 : container.appendChild(tabbar);
     initTabBarApis(config);
 }

package/dist/utils.js

@@ -2,7 +2,31 @@ export const addLeadingSlash = (url = '') => (url.charAt(0) === '/' ? url : '/'
 export const hasBasename = (path = '', prefix = '') => new RegExp('^' + prefix + '(\\/|\\?|#|$)', 'i').test(path) || path === prefix;
 export const stripBasename = (path = '', prefix = '') => hasBasename(path, prefix) ? path.substr(prefix.length) : path;
 class RoutesAlias {
-    conf = [];
+    constructor() {
+        this.conf = [];
+        this.getConfig = (url = '') => {
+            const customRoute = this.conf.filter((arr) => {
+                return arr.includes(url);
+            });
+            return customRoute[0];
+        };
+        this.getOrigin = (url = '') => {
+            var _a;
+            return ((_a = this.getConfig(url)) === null || _a === void 0 ? void 0 : _a[0]) || url;
+        };
+        this.getAlias = (url = '') => {
+            var _a;
+            return ((_a = this.getConfig(url)) === null || _a === void 0 ? void 0 : _a[1]) || url;
+        };
+        this.getAll = (url = '') => {
+            return this.conf
+                .filter((arr) => arr.includes(url))
+                .reduceRight((p, a) => {
+                p.unshift(a[1]);
+                return p;
+            }, []);
+        };
+    }
     set(customRoutes = {}) {
         for (let key in customRoutes) {
             const path = customRoutes[key];
@@ -10,30 +34,10 @@ class RoutesAlias {
             if (typeof path === 'string') {
                 this.conf.push([key, addLeadingSlash(path)]);
             }
-            else if (path?.length > 0) {
+            else if ((path === null || path === void 0 ? void 0 : path.length) > 0) {
                 this.conf.push(...path.map(p => [key, addLeadingSlash(p)]));
             }
         }
     }
-    getConfig = (url = '') => {
-        const customRoute = this.conf.filter((arr) => {
-            return arr.includes(url);
-        });
-        return customRoute[0];
-    };
-    getOrigin = (url = '') => {
-        return this.getConfig(url)?.[0] || url;
-    };
-    getAlias = (url = '') => {
-        return this.getConfig(url)?.[1] || url;
-    };
-    getAll = (url = '') => {
-        return this.conf
-            .filter((arr) => arr.includes(url))
-            .reduceRight((p, a) => {
-            p.unshift(a[1]);
-            return p;
-        }, []);
-    };
 }
 export const routesAlias = new RoutesAlias();

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@tarojs/router",
-  "version": "3.5.0-alpha.1",
+  "version": "3.5.0-alpha.4",
   "description": "Taro-router",
-  "main:h5": "dist/router.js",
-  "main": "dist/index.cjs.js",
-  "module": "dist/router.js",
+  "browser": "dist/index.esm.js",
+  "main:h5": "dist/index.js",
+  "main": "dist/index.js",
+  "module": "dist/index.cjs.js",
   "typings": "src/index.ts",
   "files": [
     "dist",
@@ -12,7 +13,7 @@
     "index.js"
   ],
   "scripts": {
-    "build": "cross-env TARGET=umd rollup -c rollup.config.js && tsc",
+    "build": "rollup -c && tsc",
     "dev": "tsc -w",
     "test": "jest",
     "test:dev": "jest --watch"
@@ -27,11 +28,11 @@
   "author": "O2Team",
   "license": "MIT",
   "dependencies": {
-    "@tarojs/runtime": "3.5.0-alpha.1",
-    "@tarojs/taro": "3.5.0-alpha.1",
+    "@tarojs/runtime": "3.5.0-alpha.4",
+    "@tarojs/taro": "3.5.0-alpha.4",
     "history": "^5.1.0",
     "query-string": "^7.1.1",
     "universal-router": "^8.3.0"
   },
-  "gitHead": "3bd136d26d77b847a1a18e028d5b0d048c89f288"
+  "gitHead": "b35cf347b6e511c93d509243867a4f67294d0c67"
 }

package/types/api.d.ts

@@ -0,0 +1,15 @@
+declare module '@tarojs/router/types/api' {
+  interface Base {
+    success?: (...args: any[]) => void
+    fail?: (...args: any[]) => void
+    complete?: (...args: any[]) => void
+  }
+
+  interface Option extends Base {
+    url: string
+  }
+
+  interface NavigateBackOption extends Base {
+    delta: number
+  }
+}

package/types/history.d.ts

@@ -0,0 +1,8 @@
+declare module '@tarojs/router/types/history' {
+  interface StateEvent extends Event {
+    action?: 'pushState' | 'replaceState' | 'popState'
+    state?: any
+    unused?: string
+    url?: string | URL | null
+  }
+}

package/types/router.d.ts

@@ -0,0 +1,32 @@
+declare module '@tarojs/router/types/router' {
+  import { AppConfig, PageConfig } from '@tarojs/taro'
+  import { IH5RouterConfig } from '@tarojs/taro/types/compile'
+
+  interface Route extends PageConfig {
+    path?: string
+    load?: () => Promise<any>
+  }
+
+  interface Router {
+    mode: IH5RouterConfig['mode']
+    basename: string
+    customRoutes?: Record<string, string | string[]>
+    pathname: string
+    forcePath?: string
+  }
+
+  interface SpaRouterConfig extends AppConfig {
+    routes: Route[]
+    router: Router
+    // 下拉刷新组件
+    PullDownRefresh?: any
+  }
+
+  interface MpaRouterConfig extends AppConfig {
+    route: Route,
+    pageName: string
+    router: Router
+    // 下拉刷新组件
+    PullDownRefresh?: any
+  }
+}

package/types/index.d.ts

@@ -1,288 +0,0 @@
-import { IH5RouterConfig } from '@tarojs/taro/types/compile'
-/**
- *
- * original code from: https://github.com/qiu8310/minapp/blob/master/packages/minapp-wx/typing/wx.d.ts
- * Lincenced under MIT license: https://github.com/qiu8310/minapp/issues/69
- * thanks for the great work by @qiu8310 👍👍👍
- *
- */
-declare namespace Router {
-  namespace navigateTo {
-    type Param = {
-      /**
-       * 需要跳转的应用内非 tabBar 的页面的路径 , 路径后可以带参数。参数与路径之间使用`?`分隔，参数键与参数值用`=`相连，不同参数用`&`分隔；如 'path?key=value&key2=value2'
-       */
-      url: string
-      /**
-       * 接口调用成功的回调函数
-       */
-      success?: ParamPropSuccess
-      /**
-       * 接口调用失败的回调函数
-       */
-      fail?: ParamPropFail
-      /**
-       * 接口调用结束的回调函数（调用成功、失败都会执行）
-       */
-      complete?: ParamPropComplete
-    }
-    /**
-     * 接口调用成功的回调函数
-     */
-    type ParamPropSuccess = (res: any) => any
-    /**
-     * 接口调用失败的回调函数
-     */
-    type ParamPropFail = (err: any) => any
-    /**
-     * 接口调用结束的回调函数（调用成功、失败都会执行）
-     */
-    type ParamPropComplete = () => any
-  }
-  /**
-   * 保留当前页面，跳转到应用内的某个页面，使用`Router.navigateBack`可以返回到原页面。
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     Router.navigateTo({
-   *       url: 'test?id=1'
-   *     })
-   *     ```
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     //test.js
-   *     Page({
-   *       onLoad: function(option){
-   *         console.log(option.query)
-   *       }
-   *     })
-   *     ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxnavigatetoobject
-   */
-  function navigateTo(OBJECT: navigateTo.Param): void
-
-  namespace redirectTo {
-    type Param = {
-      /**
-       * 需要跳转的应用内非 tabBar 的页面的路径，路径后可以带参数。参数与路径之间使用`?`分隔，参数键与参数值用`=`相连，不同参数用`&`分隔；如 'path?key=value&key2=value2'
-       */
-      url: string
-      /**
-       * 接口调用成功的回调函数
-       */
-      success?: ParamPropSuccess
-      /**
-       * 接口调用失败的回调函数
-       */
-      fail?: ParamPropFail
-      /**
-       * 接口调用结束的回调函数（调用成功、失败都会执行）
-       */
-      complete?: ParamPropComplete
-    }
-    /**
-     * 接口调用成功的回调函数
-     */
-    type ParamPropSuccess = (res: any) => any
-    /**
-     * 接口调用失败的回调函数
-     */
-    type ParamPropFail = (err: any) => any
-    /**
-     * 接口调用结束的回调函数（调用成功、失败都会执行）
-     */
-    type ParamPropComplete = () => any
-  }
-  /**
-   * 关闭当前页面，跳转到应用内的某个页面。
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     Router.redirectTo({
-   *       url: 'test?id=1'
-   *     })
-   *     ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxredirecttoobject
-   */
-  function redirectTo(OBJECT: redirectTo.Param): void
-
-  namespace reLaunch {
-    type Param = {
-      /**
-       * 需要跳转的应用内页面路径 , 路径后可以带参数。参数与路径之间使用`?`分隔，参数键与参数值用`=`相连，不同参数用`&`分隔；如 'path?key=value&key2=value2'，如果跳转的页面路径是 tabBar 页面则不能带参数
-       */
-      url: string
-      /**
-       * 接口调用成功的回调函数
-       */
-      success?: ParamPropSuccess
-      /**
-       * 接口调用失败的回调函数
-       */
-      fail?: ParamPropFail
-      /**
-       * 接口调用结束的回调函数（调用成功、失败都会执行）
-       */
-      complete?: ParamPropComplete
-    }
-    /**
-     * 接口调用成功的回调函数
-     */
-    type ParamPropSuccess = (res: any) => any
-    /**
-     * 接口调用失败的回调函数
-     */
-    type ParamPropFail = (err: any) => any
-    /**
-     * 接口调用结束的回调函数（调用成功、失败都会执行）
-     */
-    type ParamPropComplete = () => any
-  }
-  /**
-   * @since 1.1.0
-   *
-   * 关闭所有页面，打开到应用内的某个页面。
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     Router.reLaunch({
-   *       url: 'test?id=1'
-   *     })
-   *     ```
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     //test.js
-   *     Page({
-   *       onLoad: function(option){
-   *         console.log(option.query)
-   *       }
-   *     })
-   *     ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxrelaunchobject
-   */
-  function reLaunch(OBJECT: reLaunch.Param): void
-
-  namespace switchTab {
-    type Param = {
-      /**
-       * 需要跳转的 tabBar 页面的路径（需在 app.json 的 [tabBar](https://developers.weixin.qq.com/miniprogram/dev/framework/config.html#tabbar) 字段定义的页面），路径后不能带参数
-       */
-      url: string
-      /**
-       * 接口调用成功的回调函数
-       */
-      success?: ParamPropSuccess
-      /**
-       * 接口调用失败的回调函数
-       */
-      fail?: ParamPropFail
-      /**
-       * 接口调用结束的回调函数（调用成功、失败都会执行）
-       */
-      complete?: ParamPropComplete
-    }
-    /**
-     * 接口调用成功的回调函数
-     */
-    type ParamPropSuccess = (res: any) => any
-    /**
-     * 接口调用失败的回调函数
-     */
-    type ParamPropFail = (err: any) => any
-    /**
-     * 接口调用结束的回调函数（调用成功、失败都会执行）
-     */
-    type ParamPropComplete = () => any
-  }
-  /**
-   * 跳转到 tabBar 页面，并关闭其他所有非 tabBar 页面
-   *
-   * **示例代码：**
-   *
-   *     ```json
-   *     {
-   *       "tabBar": {
-   *         "list": [{
-   *           "pagePath": "index",
-   *           "text": "首页"
-   *         },{
-   *           "pagePath": "other",
-   *           "text": "其他"
-   *         }]
-   *       }
-   *     }
-   *     ```
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     Router.switchTab({
-   *       url: '/index'
-   *     })
-   *     ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxswitchtabobject
-   */
-  function switchTab(OBJECT: switchTab.Param): void
-
-  namespace navigateBack {
-    type Param = {
-      /**
-       * 返回的页面数，如果 delta 大于现有页面数，则返回到首页。
-       *
-       * @default 1
-       */
-      delta?: number
-    }
-  }
-  /**
-   * 关闭当前页面，返回上一页面或多级页面。可通过 [`getCurrentPages()`](https://developers.weixin.qq.com/miniprogram/dev/framework/app-service/page.html#getCurrentPages()) 获取当前的页面栈，决定需要返回几层。
-   *
-   * **Tip：**
-   *
-   * 1.  `tip`: Router.navigateTo 和 Router.redirectTo 不允许跳转到 tabbar 页面，只能用 Router.switchTab 跳转到 tabbar 页面
-   *
-   * **示例代码：**
-   *
-   *     ```javascript
-   *     // 注意：调用 navigateTo 跳转时，调用该方法的页面会被加入堆栈，而 redirectTo 方法则不会。见下方示例代码
-   *
-   *     // 此处是A页面
-   *     Router.navigateTo({
-   *       url: 'B?id=1'
-   *     })
-   *
-   *     // 此处是B页面
-   *     Router.navigateTo({
-   *       url: 'C?id=1'
-   *     })
-   *
-   *     // 在C页面内 navigateBack，将返回A页面
-   *     Router.navigateBack({
-   *       delta: 2
-   *     })
-   *     ```
-   * @see https://developers.weixin.qq.com/miniprogram/dev/api/ui-navigate.html#wxnavigatebackobject
-   */
-  function navigateBack(OBJECT: navigateBack.Param): void
-}
-
-declare const createHistory: (props: {
-  basename?: string;
-  mode: IH5RouterConfig['mode'],
-  firstPagePath: string;
-  customRoutes: {
-    [key: string]: string | string[]
-  };
-}) => any;
-
-export {
-  Router,
-  createHistory
-}