@tarojs/router 3.3.13 → 3.3.17

package/dist/router.esm.js

@@ -1,4 +1,5 @@
-import { container, SERVICE_IDENTIFIER, eventCenter, Current, stringify, createPageConfig, requestAnimationFrame } from '@tarojs/runtime';
+import { requestAnimationFrame, container, SERVICE_IDENTIFIER, eventCenter, Current, createPageConfig, stringify } from '@tarojs/runtime';
+import { initTabBarApis } from '@tarojs/taro';
 
 function _extends() {
   _extends = Object.assign || function (target) {
@@ -47,55 +48,141 @@ function setHistoryMode(mode, base = '/') {
 }
 function prependBasename(url = '') {
     return basename.replace(/\/$/, '') + '/' + url.replace(/^\//, '');
-}
-
-const stacks = [];
+}
+const hasBasename = (path, prefix) => new RegExp('^' + prefix + '(\\/|\\?|#|$)', 'i').test(path);
+const stripBasename = (path, prefix) => hasBasename(path, prefix) ? path.substr(prefix.length) : path;
 
-let routesAlias = {};
-function setRoutesAlias(alias) {
-    routesAlias = alias;
+class Stacks {
+    constructor() {
+        this.stacks = [];
+        this.backDelta = 0;
+    }
+    set delta(delta) {
+        if (delta > 0) {
+            this.backDelta = delta;
+        }
+        else {
+            --this.backDelta;
+        }
+    }
+    get length() {
+        return this.stacks.length;
+    }
+    get last() {
+        return this.stacks[this.length - 1];
+    }
+    get() {
+        return this.stacks;
+    }
+    getItem(index) {
+        return this.stacks[index];
+    }
+    getLastIndex(pathname) {
+        const list = [...this.stacks].reverse();
+        return list.findIndex((page, i) => { var _a; return i !== 0 && ((_a = page.path) === null || _a === void 0 ? void 0 : _a.replace(/\?.*/g, '')) === pathname; });
+    }
+    getDelta(pathname) {
+        if (this.backDelta >= 1) {
+            return this.backDelta;
+        }
+        // NOTE: 此处为了修复浏览器后退多级页面，在大量重复路由状况下可能出现判断错误的情况 （增强判断能力只能考虑在 query 中新增参数来判断，暂时搁置）
+        return this.getLastIndex(pathname) || 1;
+    }
+    getPrevIndex(pathname) {
+        const lastIndex = this.getLastIndex(pathname);
+        if (lastIndex < 0) {
+            return -1;
+        }
+        return this.length - 1 - lastIndex;
+    }
+    pop() {
+        return this.stacks.pop();
+    }
+    push(page) {
+        return this.stacks.push(page);
+    }
 }
+const stacks = new Stacks();
+
 function addLeadingSlash(path) {
     if (path == null) {
         return '';
     }
     return path.charAt(0) === '/' ? path : '/' + path;
 }
-// 解决navigateBack调用delta>1时,路由栈异常问题
-// 比如:A->B->C,navigateBack({delta: 2}),此时路由栈中还存在B页面
-// 原因:主要是由于一次性退出多层级页面时,此action只会执行一次,此处进行手动处理
-let historyBackDelta = 1;
-function setHistoryBackDelta(delta) {
-    historyBackDelta = delta;
-}
-// eslint-disable-next-line @typescript-eslint/ban-types
-const throttle = (fn, threshold) => {
-    let lastTime = 0;
-    return function () {
-        const now = Date.now();
-        if (now - lastTime > threshold) {
-            fn.apply(this, arguments);
-            lastTime = now;
+class RoutesAlias {
+    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) => {
+                return arr.includes(url);
+            }).reduce((p, a) => {
+                p.push(a[1]);
+                return p;
+            }, [url]);
+        };
+    }
+    set(customRoutes = {}) {
+        for (let key in customRoutes) {
+            const path = customRoutes[key];
+            key = addLeadingSlash(key);
+            if (typeof path === 'string') {
+                this.conf.push([key, addLeadingSlash(path)]);
+            }
+            else if ((path === null || path === void 0 ? void 0 : path.length) > 0) {
+                this.conf.push(...path.map(p => [key, addLeadingSlash(p)]));
+            }
         }
-    };
-};
-const stripBasename = (path, basename) => path.startsWith(basename) ? path.replace(basename, '') : path;
+    }
+}
+const routesAlias = new RoutesAlias();
 const isTabBar = (config) => {
     var _a, _b;
     const { customRoutes = {}, basename = '', pathname } = config.router;
     const routePath = stripBasename(pathname, basename);
-    const pagePath = ((_a = Object.entries(customRoutes).find(([, target]) => target === routePath)) === null || _a === void 0 ? void 0 : _a[0]) || routePath;
+    const pagePath = ((_a = Object.entries(customRoutes).find(([, target]) => {
+        if (typeof target === 'string') {
+            return target === routePath;
+        }
+        else if ((target === null || target === void 0 ? void 0 : target.length) > 0) {
+            return target.includes(routePath);
+        }
+        return false;
+    })) === null || _a === void 0 ? void 0 : _a[0]) || routePath;
     return !!pagePath && (((_b = config.tabBar) === null || _b === void 0 ? void 0 : _b.list) || []).some(t => t.pagePath === pagePath);
 };
 
 function processNavigateUrl(option) {
+    var _a;
     const pathPieces = J(option.url);
     // 处理自定义路由
-    Object.keys(routesAlias).forEach(key => {
-        if (addLeadingSlash(key) === addLeadingSlash(pathPieces.pathname)) {
-            pathPieces.pathname = routesAlias[key];
-        }
-    });
+    pathPieces.pathname = routesAlias.getAlias(addLeadingSlash(pathPieces.pathname));
+    // 处理相对路径
+    if ((_a = pathPieces === null || pathPieces === void 0 ? void 0 : pathPieces.pathname) === null || _a === void 0 ? void 0 : _a.includes('./')) {
+        const parts = history.location.pathname.split('/');
+        parts.pop();
+        pathPieces.pathname.split('/').forEach((item) => {
+            if (item === '.') {
+                return;
+            }
+            item === '..' ? parts.pop() : parts.push(item);
+        });
+        pathPieces.pathname = parts.join('/');
+    }
     // 处理 basename
     pathPieces.pathname = prependBasename(pathPieces.pathname);
     // hack fix history v5 bug: https://github.com/remix-run/history/issues/814
@@ -107,9 +194,10 @@ async function navigate(option, method) {
     return new Promise((resolve, reject) => {
         const { success, complete, fail } = option;
         const unListen = history.listen(() => {
-            success === null || success === void 0 ? void 0 : success();
-            complete === null || complete === void 0 ? void 0 : complete();
-            resolve();
+            const res = { errMsg: `${method}: ok` };
+            success === null || success === void 0 ? void 0 : success(res);
+            complete === null || complete === void 0 ? void 0 : complete(res);
+            resolve(res);
             unListen();
         });
         try {
@@ -119,19 +207,24 @@ async function navigate(option, method) {
                 if (method === 'navigateTo') {
                     history.push(pathPieces, state);
                 }
-                else if (method === 'redirectTo') {
+                else if (method === 'redirectTo' || method === 'switchTab') {
+                    history.replace(pathPieces, state);
+                }
+                else if (method === 'reLaunch') {
+                    stacks.delta = stacks.length;
                     history.replace(pathPieces, state);
                 }
             }
             else if (method === 'navigateBack') {
-                setHistoryBackDelta(option.delta);
+                stacks.delta = option.delta;
                 history.go(-option.delta);
             }
         }
         catch (error) {
-            fail === null || fail === void 0 ? void 0 : fail(error);
-            complete === null || complete === void 0 ? void 0 : complete();
-            reject(error);
+            const res = { errMsg: `${method}: fail ${error.message || error}` };
+            fail === null || fail === void 0 ? void 0 : fail(res);
+            complete === null || complete === void 0 ? void 0 : complete(res);
+            reject(res);
         }
     });
 }
@@ -148,15 +241,14 @@ function navigateBack(options = { delta: 1 }) {
     return navigate(options, 'navigateBack');
 }
 function switchTab(option) {
-    // TODO: 清除掉所有的栈去目标页面
-    return redirectTo(option);
+    return navigate(option, 'switchTab');
 }
 function reLaunch(option) {
-    // TODO: 清除掉所有的栈去目标页面
-    return redirectTo(option);
+    return navigate(option, 'reLaunch');
 }
 function getCurrentPages() {
-    return stacks;
+    const pages = stacks.get();
+    return pages.map(e => (Object.assign(Object.assign({}, e), { route: e.path || '' })));
 }
 
 /**
@@ -802,18 +894,18 @@ var UniversalRouter = function () {
 
 UniversalRouter.pathToRegexp = pathToRegexp_1;
 
+// @ts-nocheck
 function initTabbar(config) {
     if (config.tabBar == null) {
         return;
     }
     // TODO: 找到 tabbar 的类型
     const tabbar = document.createElement('taro-tabbar');
-    const homePage = config.pages ? config.pages[0] : '';
+    const homePage = config.entryPagePath || (config.pages ? config.pages[0] : '');
     tabbar.conf = config.tabBar;
     tabbar.conf.homePage = history.location.pathname === '/' ? homePage : history.location.pathname;
     const routerConfig = config.router;
     tabbar.conf.mode = routerConfig && routerConfig.mode ? routerConfig.mode : 'hash';
-    tabbar.conf.custom = !!routerConfig.customRoutes;
     if (routerConfig.customRoutes) {
         tabbar.conf.custom = true;
         tabbar.conf.customRoutes = routerConfig.customRoutes;
@@ -828,6 +920,7 @@ function initTabbar(config) {
     const container = document.getElementById('container');
     // eslint-disable-next-line no-unused-expressions
     container === null || container === void 0 ? void 0 : container.appendChild(tabbar);
+    initTabBarApis(config);
 }
 
 const routerConfig = Object.create(null);
@@ -851,6 +944,58 @@ function init(config) {
     initTabbar(config);
 }
 
+let pageScrollFn;
+let pageDOM = window;
+function bindPageScroll(page, config) {
+    pageDOM.removeEventListener('scroll', pageScrollFn);
+    pageDOM = getScrollContainer();
+    const distance = config.onReachBottomDistance || 50;
+    let isReachBottom = false;
+    pageScrollFn = function () {
+        page.onPageScroll && page.onPageScroll({
+            scrollTop: pageDOM instanceof Window ? window.scrollY : pageDOM.scrollTop
+        });
+        if (isReachBottom && getOffset() > distance) {
+            isReachBottom = false;
+        }
+        if (page.onReachBottom &&
+            !isReachBottom &&
+            getOffset() < distance) {
+            isReachBottom = true;
+            page.onReachBottom();
+        }
+    };
+    pageDOM.addEventListener('scroll', pageScrollFn, false);
+}
+window.addEventListener('DOMSubtreeModified', (e) => {
+    var _a;
+    // @ts-ignore
+    const className = (_a = e.target) === null || _a === void 0 ? void 0 : _a.className;
+    if (className && /taro-tabbar__/.test(className)) {
+        pageDOM.removeEventListener('scroll', pageScrollFn);
+        pageDOM = getScrollContainer();
+        pageDOM.addEventListener('scroll', pageScrollFn, false);
+    }
+}, false);
+function getScrollContainer() {
+    if (document.querySelector('.taro-tabbar__tabbar') === null) {
+        // 没设置tabbar
+        return window;
+    }
+    else {
+        // 有设置tabbar
+        return document.querySelector('.taro-tabbar__panel') || window;
+    }
+}
+function getOffset() {
+    if (pageDOM instanceof Window) {
+        return document.documentElement.scrollHeight - window.scrollY - window.innerHeight;
+    }
+    else {
+        return pageDOM.scrollHeight - pageDOM.scrollTop - pageDOM.clientHeight;
+    }
+}
+
 function createCommonjsModule(fn, module) {
 	return module = { exports: {} }, fn(module, module.exports), module.exports;
 }
@@ -1402,12 +1547,23 @@ var queryString_5 = queryString.stringifyUrl;
 var queryString_6 = queryString.pick;
 var queryString_7 = queryString.exclude;
 
+function getSearch() {
+    let search = '?';
+    if (routerConfig.router.mode === 'hash') {
+        const idx = location.hash.indexOf('?');
+        if (idx > -1) {
+            search = location.hash.slice(idx);
+        }
+    }
+    else {
+        search = location.search;
+    }
+    return search.substr(1);
+}
 const qs = function (stamp = 0) {
-    const search = routerConfig.router.mode === 'hash'
-        ? location.hash.slice(routerConfig.router.pathname.length + 1)
-        : location.search;
+    const search = getSearch();
     const query = search
-        ? queryString.parse(search.substr(1))
+        ? queryString.parse(search)
         : {};
     if (stamp) {
         query.stamp = stamp.toString();
@@ -1415,95 +1571,13 @@ const qs = function (stamp = 0) {
     return query;
 };
 
-let pageScrollFn;
-let pageDOM = window;
-function bindPageScroll(page, config) {
-    pageDOM.removeEventListener('scroll', pageScrollFn);
-    pageDOM = getScrollContainer();
-    const distance = config.onReachBottomDistance || 50;
-    let isReachBottom = false;
-    pageScrollFn = function () {
-        page.onPageScroll && page.onPageScroll({
-            scrollTop: pageDOM instanceof Window ? window.scrollY : pageDOM.scrollTop
-        });
-        if (isReachBottom && getOffset() > distance) {
-            isReachBottom = false;
-        }
-        if (page.onReachBottom &&
-            !isReachBottom &&
-            getOffset() < distance) {
-            isReachBottom = true;
-            page.onReachBottom();
-        }
-    };
-    pageDOM.addEventListener('scroll', pageScrollFn, false);
-}
-window.addEventListener('DOMSubtreeModified', (e) => {
-    var _a;
-    // @ts-ignore
-    const className = (_a = e.target) === null || _a === void 0 ? void 0 : _a.className;
-    if (className && /taro-tabbar__/.test(className)) {
-        pageDOM.removeEventListener('scroll', pageScrollFn);
-        pageDOM = getScrollContainer();
-        pageDOM.addEventListener('scroll', pageScrollFn, false);
-    }
-}, false);
-function getScrollContainer() {
-    if (document.querySelector('.taro-tabbar__tabbar') === null) {
-        // 没设置tabbar
-        return window;
-    }
-    else {
-        // 有设置tabbar
-        return document.querySelector('.taro-tabbar__panel') || window;
-    }
-}
-function getOffset() {
-    if (pageDOM instanceof Window) {
-        return document.documentElement.scrollHeight - window.scrollY - window.innerHeight;
-    }
-    else {
-        return pageDOM.scrollHeight - pageDOM.scrollTop - pageDOM.clientHeight;
-    }
-}
-
 /* eslint-disable dot-notation */
-function hidePage(page) {
-    if (page != null) {
-        page.onHide();
-        const pageEl = document.getElementById(page.path);
-        if (pageEl) {
-            pageEl.style.display = 'none';
-        }
-    }
-}
-function showPage(page, pageConfig, stacksIndex = 0) {
-    if (page != null) {
-        page.onShow();
-        let pageEl = document.getElementById(page.path);
-        if (pageEl) {
-            pageEl.style.display = 'block';
-        }
-        else {
-            page.onLoad(qs(stacksIndex));
-            pageEl = document.getElementById(page.path);
-            pageOnReady(pageEl, page, false);
-        }
-        bindPageScroll(page, pageConfig || {});
-    }
-}
-function unloadPage(page) {
-    if (page != null) {
-        stacks.pop();
-        page.onUnload();
-    }
-}
-function pageOnReady(pageEl, page, onLoad = true) {
-    var _a;
+function pageOnReady(page, onLoad = true) {
+    var _a, _b;
+    const pageEl = document.getElementById(page.path);
     if (pageEl && !(pageEl === null || pageEl === void 0 ? void 0 : pageEl['__isReady'])) {
         const el = pageEl.firstElementChild;
-        // eslint-disable-next-line no-unused-expressions
-        (_a = el === null || el === void 0 ? void 0 : el['componentOnReady']) === null || _a === void 0 ? void 0 : _a.call(el).then(() => {
+        (_b = (_a = el === null || el === void 0 ? void 0 : el['componentOnReady']) === null || _a === void 0 ? void 0 : _a.call(el)) === null || _b === void 0 ? void 0 : _b.then(() => {
             requestAnimationFrame(() => {
                 page.onReady();
                 pageEl['__isReady'] = true;
@@ -1512,42 +1586,75 @@ function pageOnReady(pageEl, page, onLoad = true) {
         onLoad && (pageEl['__page'] = page);
     }
 }
-function loadPage(page, pageConfig, stacksIndex = 0) {
-    if (page !== null) {
-        let pageEl = document.getElementById(page.path);
-        if (pageEl) {
-            pageEl.style.display = 'block';
-        }
-        else {
-            page.onLoad(qs(stacksIndex), function () {
-                pageEl = document.getElementById(page.path);
-                pageOnReady(pageEl, page);
-            });
-        }
-        stacks.push(page);
-        page.onShow();
-        bindPageScroll(page, pageConfig || {});
+function loadPage(page, pageConfig = {}, stacksIndex = 0) {
+    if (!page)
+        return;
+    const pageEl = document.getElementById(page.path);
+    if (pageEl) {
+        pageEl.style.display = 'block';
+    }
+    else {
+        page.onLoad(qs(stacksIndex), () => pageOnReady(page, true));
+    }
+    stacks.push(page);
+    page.onShow();
+    bindPageScroll(page, pageConfig);
+}
+function unloadPage(page, delta = 1) {
+    if (!page)
+        return;
+    stacks.delta = --delta;
+    stacks.pop();
+    page.onUnload();
+    if (delta >= 1)
+        unloadPage(stacks.last, delta);
+}
+function showPage(page, pageConfig = {}, stacksIndex = 0) {
+    if (!page)
+        return;
+    page.onShow();
+    const pageEl = document.getElementById(page.path);
+    if (pageEl) {
+        pageEl.style.display = 'block';
     }
+    else {
+        page.onLoad(qs(stacksIndex), () => pageOnReady(page, false));
+    }
+    bindPageScroll(page, pageConfig);
 }
+function hidePage(page) {
+    if (!page)
+        return;
+    // NOTE: 修复多页并发问题，此处可能因为路由跳转过快，执行时页面可能还没有创建成功
+    const pageEl = document.getElementById(page.path);
+    if (pageEl) {
+        pageEl.style.display = 'none';
+        page.onHide();
+    }
+    else {
+        setTimeout(() => hidePage(page), 0);
+    }
+}
+
+/* eslint-disable dot-notation */
 function createRouter(app, config, framework) {
     var _a;
     init(config);
     const routes = [];
-    const alias = (_a = config.router.customRoutes) !== null && _a !== void 0 ? _a : {};
     const runtimeHooks = container.get(SERVICE_IDENTIFIER.Hooks);
-    setRoutesAlias(alias);
+    routesAlias.set(config.router.customRoutes);
     for (let i = 0; i < config.routes.length; i++) {
         const route = config.routes[i];
         const path = addLeadingSlash(route.path);
         routes.push({
-            path: alias[path] || path,
+            path: routesAlias.getAll(path),
             action: route.load
         });
     }
     const basename = config.router.basename;
     const router = new UniversalRouter(routes, { baseUrl: basename || '' });
     app.onLaunch();
-    const render = throttle(async ({ location, action }) => {
+    const render = async ({ location, action }) => {
         var _a, _b, _c, _d;
         routerConfig.router.pathname = location.pathname;
         let element;
@@ -1567,8 +1674,10 @@ function createRouter(app, config, framework) {
         if (!element)
             return;
         const pageConfig = config.routes.find(r => {
+            var _a;
             const path = addLeadingSlash(r.path);
-            return path === location.pathname || alias[path] === location.pathname;
+            const urlPath = stripBasename(location.pathname, routerConfig.router.basename);
+            return path === urlPath || ((_a = routesAlias.getConfig(path)) === null || _a === void 0 ? void 0 : _a.includes(urlPath));
         });
         let enablePullDownRefresh = false;
         eventCenter.trigger('__taroRouterChange', {
@@ -1580,67 +1689,53 @@ function createRouter(app, config, framework) {
             document.title = (_b = pageConfig.navigationBarTitleText) !== null && _b !== void 0 ? _b : document.title;
             enablePullDownRefresh = pageConfig.enablePullDownRefresh;
         }
+        const currentPage = Current.page;
+        const pathname = location.pathname;
         let shouldLoad = false;
         if (action === 'POP') {
-            unloadPage(Current.page);
-            let delta = historyBackDelta;
-            while (delta-- > 1) {
-                unloadPage(stacks.slice(-1)[0]);
-            }
-            // 最终必须重置为 1
-            setHistoryBackDelta(1);
-            const prevIndex = stacks.reduceRight((p, s, i) => {
-                if (p !== 0)
-                    return p;
-                else if (s.path === location.pathname + stringify(qs(i)))
-                    return i;
-                else
-                    return 0;
-            }, 0);
-            const prev = stacks[prevIndex];
-            if (prev) {
-                showPage(prev, pageConfig, prevIndex);
+            // NOTE: 浏览器事件退后多次时，该事件只会被触发一次
+            const prevIndex = stacks.getPrevIndex(pathname);
+            const delta = stacks.getDelta(pathname);
+            unloadPage(currentPage, delta);
+            if (prevIndex > -1) {
+                showPage(stacks.getItem(prevIndex), pageConfig, prevIndex);
             }
             else {
                 shouldLoad = true;
             }
         }
         else if (action === 'PUSH') {
-            hidePage(Current.page);
+            hidePage(currentPage);
             shouldLoad = true;
         }
         else if (action === 'REPLACE') {
             if (isTabBar(config)) {
-                hidePage(Current.page);
-                const pathname = stripBasename(config.router.pathname, basename);
-                const prevIndex = stacks.findIndex((r) => {
-                    var _a;
-                    return ((_a = r.path) === null || _a === void 0 ? void 0 : _a.replace(/\?.*/g, '')) === pathname;
-                });
+                hidePage(currentPage);
+                const prevIndex = stacks.getPrevIndex(pathname);
                 if (prevIndex > -1) {
-                    // tabbar 页且之前出现过，直接复用
-                    const prev = stacks[prevIndex];
-                    return showPage(prev, pageConfig, prevIndex);
+                    // NOTE: tabbar 页且之前出现过，直接复用
+                    return showPage(stacks.getItem(prevIndex), pageConfig, prevIndex);
                 }
             }
             else {
-                unloadPage(Current.page);
+                const delta = stacks.getDelta(pathname);
+                // NOTE: 页面路由记录并不会清空，只是移除掉缓存的 stack 以及页面
+                unloadPage(currentPage, delta);
             }
             shouldLoad = true;
         }
-        if (shouldLoad) {
+        if (shouldLoad || stacks.length < 1) {
             const el = (_c = element.default) !== null && _c !== void 0 ? _c : element;
             const loadConfig = Object.assign({}, pageConfig);
+            const stacksIndex = stacks.length;
             delete loadConfig['path'];
             delete loadConfig['load'];
-            const pathname = stripBasename(config.router.pathname, basename);
-            const routerIndex = stacks.length;
-            const page = createPageConfig(enablePullDownRefresh ? (_d = runtimeHooks.createPullDownComponent) === null || _d === void 0 ? void 0 : _d.call(runtimeHooks, el, location.pathname, framework, routerConfig.PullDownRefresh) : el, pathname + stringify(qs(routerIndex)), {}, loadConfig);
-            loadPage(page, pageConfig, routerIndex);
+            const page = createPageConfig(enablePullDownRefresh ? (_d = runtimeHooks.createPullDownComponent) === null || _d === void 0 ? void 0 : _d.call(runtimeHooks, el, location.pathname, framework, routerConfig.PullDownRefresh) : el, pathname + stringify(qs(stacksIndex)), {}, loadConfig);
+            return loadPage(page, pageConfig, stacksIndex);
         }
-    }, 500);
+    };
     if (history.location.pathname === '/') {
-        history.replace(prependBasename(routes[0].path + history.location.search));
+        history.replace(prependBasename((config.entryPagePath || ((_a = routes[0].path) === null || _a === void 0 ? void 0 : _a[0])) + history.location.search));
     }
     render({ location: history.location, action: r.Push });
     app.onShow(qs(stacks.length));