@esmx/router 3.0.0-rc.17 → 3.0.0-rc.19

package/src/matcher/create-matcher.ts

@@ -1,293 +0,0 @@
-import { compile, match, pathToRegexp } from 'path-to-regexp';
-
-import type {
-    HistoryState,
-    RouteConfig,
-    RouteMatch,
-    RouteRecord,
-    RouterLocation,
-    RouterMatcher
-} from '../types';
-import {
-    decode,
-    encodePath,
-    normalizeLocation,
-    normalizePath,
-    parsePath,
-    stringifyPath
-} from '../utils';
-
-/**
- * 路由匹配器
- */
-class RouteMatcher {
-    /*
-     * 路由匹配规则
-     */
-    protected routeMatches: RouteMatch[];
-
-    /*
-     * 原始路由配置
-     */
-    // protected routes: RouteConfig[];
-
-    constructor(routes: RouteConfig[]) {
-        // this.routes = routes;
-        this.routeMatches = createRouteMatches(routes);
-    }
-
-    /*
-     * 根据配置匹配对应的路由
-     */
-    public match(
-        rawLocation: RouterLocation,
-        {
-            base,
-            redirectedFrom
-        }: { base: string; redirectedFrom?: RouteRecord } = { base: '' }
-    ): RouteRecord | null {
-        let path = '';
-        /* 按 Hanson 要求加入 undefined 类型 */
-        let query: Record<string, string | undefined> = {};
-        let queryArray: Record<string, string[]> = {};
-        let params: Record<string, string> = {};
-        let hash = '';
-        let state: HistoryState = {};
-
-        const parsedOption = parsePath(rawLocation.path);
-        path = parsedOption.pathname;
-        query = rawLocation.query || parsedOption.query || {};
-        queryArray = rawLocation.queryArray || parsedOption.queryArray || {};
-        hash = rawLocation.hash || parsedOption.hash || '';
-        state = rawLocation.state || {};
-
-        const routeMatch = this.routeMatches.find(({ match }) => {
-            return match(path);
-        });
-
-        if (routeMatch) {
-            const {
-                component,
-                asyncComponent,
-                compile,
-                meta,
-                redirect,
-                matched,
-                parse
-            } = routeMatch.internalRedirect || routeMatch; // 优先使用内部重定向
-
-            params = rawLocation.params || parse(path).params || {};
-
-            const realPath = normalizePath(
-                compile({
-                    query,
-                    queryArray,
-                    params,
-                    hash
-                })
-            );
-
-            const {
-                params: realParams,
-                query: realQuery,
-                queryArray: realQueryArray,
-                hash: realHash
-            } = parse(realPath);
-
-            const routeRecord = {
-                base,
-                path: normalizePath(
-                    compile({
-                        params: realParams
-                    })
-                ),
-                fullPath: realPath,
-                params: realParams,
-                query: realQuery,
-                queryArray: realQueryArray,
-                hash: realHash,
-                state,
-                component,
-                asyncComponent,
-                meta,
-                redirect,
-                redirectedFrom,
-                matched
-            };
-
-            if (redirect) {
-                const normalizedLocation = normalizeLocation(
-                    typeof redirect === 'function'
-                        ? redirect(routeRecord)
-                        : redirect,
-                    base
-                );
-                return this.match(normalizedLocation, {
-                    base,
-                    redirectedFrom: routeRecord
-                });
-            }
-            return routeRecord;
-        }
-        return null;
-    }
-
-    /*
-     * 获取当前路由匹配规则
-     */
-    public getRoutes(): RouteMatch[] {
-        return this.routeMatches;
-    }
-
-    /**
-     * 新增单个路由匹配规则
-     */
-    // public addRoute(route: RouteConfig) {
-    //     this.routes.push(route);
-    //     this.routeMatches = createRouteMatches(this.routes);
-    // }
-
-    /**
-     * 新增多个路由匹配规则
-     */
-    // public addRoutes(routes: RouteConfig[]) {
-    //     this.routes.push(...routes);
-    //     this.routeMatches = createRouteMatches(this.routes);
-    // }
-}
-
-/**
- * 创建路由匹配器
- */
-export function createRouterMatcher(routes: RouteConfig[]): RouterMatcher {
-    return new RouteMatcher(routes);
-}
-
-/**
- * 生成打平的路由匹配规则
- */
-function createRouteMatches(
-    routes: RouteConfig[],
-    parent?: RouteMatch
-): RouteMatch[] {
-    const routeMatches: RouteMatch[] = [];
-    for (const route of routes) {
-        routeMatches.push(
-            ...createRouteMatch(
-                {
-                    ...route,
-                    path:
-                        route.path instanceof Array ? route.path : [route.path]
-                },
-                parent
-            )
-        );
-    }
-    return routeMatches;
-}
-
-/**
- * 生成单个路由匹配规则
- */
-function createRouteMatch(
-    route: RouteConfig & { path: string },
-    parent?: RouteMatch
-): RouteMatch;
-function createRouteMatch(
-    route: RouteConfig & { path: string[] },
-    parent?: RouteMatch
-): RouteMatch[];
-function createRouteMatch(
-    route: RouteConfig,
-    parent?: RouteMatch
-): RouteMatch | RouteMatch[] {
-    const pathList = route.path instanceof Array ? route.path : [route.path];
-    const routeMatches: RouteMatch[] = pathList.reduce<RouteMatch[]>(
-        (acc, item, index) => {
-            const { children } = route;
-            const path = normalizePath(item, parent?.path);
-            let regex: RegExp;
-            try {
-                regex = pathToRegexp(path);
-            } catch (error) {
-                console.warn(
-                    `@create route rule failed on path: ${path}`,
-                    route
-                );
-                return acc;
-            }
-            const toPath = compile(path, { encode: encodePath });
-            const parseParams = match(path, { decode });
-            const current: RouteMatch = {
-                regex,
-                match: (path: string) => {
-                    return regex.test(path);
-                },
-                parse: (
-                    path: string
-                ): {
-                    params: Record<string, string>;
-                    query: Record<string, string>;
-                    queryArray: Record<string, string[]>;
-                    hash: string;
-                } => {
-                    const { pathname, query, queryArray, hash } =
-                        parsePath(path);
-                    const { params } = parseParams(pathname) || { params: {} };
-                    return {
-                        params: Object.assign({}, params), // parse的 params 是使用 Object.create(null) 创建的没有原型的对象，需要进行包装处理
-                        query,
-                        queryArray,
-                        hash
-                    };
-                },
-                compile: (
-                    { params = {}, query = {}, queryArray = {}, hash = '' } = {
-                        params: {},
-                        query: {},
-                        queryArray: {},
-                        hash: ''
-                    }
-                ) => {
-                    const pathString = toPath(params);
-                    return stringifyPath({
-                        pathname: pathString,
-                        query,
-                        queryArray,
-                        hash
-                    });
-                },
-                path,
-                appType: route.appType || parent?.appType || '',
-                component: route.component,
-                asyncComponent: route.asyncComponent,
-                meta: route.meta || {},
-                redirect: route.redirect,
-                /**
-                 * 第一个 path 作为基准，后续 path 会内部重定向到第一个 path
-                 * 同时如果父路由存在内部跳转，子路由也需要处理内部跳转
-                 */
-                internalRedirect:
-                    index > 0 || parent?.internalRedirect
-                        ? createRouteMatch(
-                              {
-                                  ...route,
-                                  path: pathList[0]
-                              },
-                              parent?.internalRedirect || parent
-                          )
-                        : undefined,
-                matched: [...(parent?.matched || []), route]
-            };
-            if (children && children.length > 0) {
-                acc.push(...createRouteMatches(children, current));
-            }
-            acc.push(current);
-            return acc;
-        },
-        []
-    );
-    return route.path instanceof Array
-        ? routeMatches
-        : routeMatches[routeMatches.length - 1];
-}

package/src/matcher/index.ts

@@ -1 +0,0 @@
-export { createRouterMatcher } from './create-matcher';

package/src/task-pipe/index.ts

@@ -1 +0,0 @@
-export { Tasks, createTasks } from './task';

package/src/task-pipe/task.ts

@@ -1,97 +0,0 @@
-import type { Awaitable } from '../types';
-import { warn } from '../utils';
-
-/**
- * 创建可操作的任务队列
- */
-
-type func = (...args: any) => any;
-
-/**
- * 任务状态
- */
-export enum TaskStatus {
-    INITIAL = 'initial',
-    RUNNING = 'running',
-    FINISHED = 'finished',
-    ERROR = 'error',
-    ABORTED = 'aborted'
-}
-
-export class Tasks<T extends func = func> {
-    protected handlers: T[] = [];
-
-    public add(handler: T | T[]) {
-        const params: T[] = handler instanceof Array ? handler : [handler];
-        this.handlers.push(...params);
-    }
-
-    public reset() {
-        this.handlers = [];
-    }
-
-    get list() {
-        return this.handlers;
-    }
-
-    get length() {
-        return this.handlers.length;
-    }
-
-    status: TaskStatus = TaskStatus.INITIAL;
-
-    public async run({
-        cb,
-        final
-    }: {
-        cb?: (res: Awaited<ReturnType<T>>) => Awaitable<void>;
-        final?: () => Awaitable<void>;
-    } = {}) {
-        if (this.status !== 'initial') {
-            if (process.env.NODE_ENV !== 'production') {
-                warn(`task start failed in status ${this.status}`);
-            }
-            return;
-        }
-
-        this.status = TaskStatus.RUNNING;
-
-        for await (const handler of this.list) {
-            if ((this.status as TaskStatus) === TaskStatus.ABORTED) {
-                return;
-            }
-            if (typeof handler === 'function') {
-                try {
-                    const res = await handler();
-                    cb && (await cb(res));
-                } catch (error) {
-                    // if (process.env.NODE_ENV !== 'production') {
-                    warn('task error:', error);
-                    // }
-                    this.status = TaskStatus.ERROR;
-                }
-            } else {
-                // if (process.env.NODE_ENV !== 'production') {
-                warn('task is not a function', handler);
-                // }
-            }
-        }
-        if ((this.status as TaskStatus) !== TaskStatus.RUNNING) return;
-        final && (await final());
-        this.status = TaskStatus.FINISHED;
-    }
-
-    public abort() {
-        if (
-            process.env.NODE_ENV !== 'production' &&
-            this.status === TaskStatus.RUNNING
-        ) {
-            warn('abort task when task is running');
-        }
-        this.status = TaskStatus.ABORTED;
-    }
-}
-
-export function createTasks<T extends func = func>() {
-    return new Tasks<T>();
-}

package/src/utils/bom.ts

@@ -1,14 +0,0 @@
-/**
- * 在新窗口打开页面，如果被拦截，则会降级到当前窗口打开
- * @param url 打开的地址
- */
-export function openWindow(url: string, target?: string) {
-    try {
-        const newWindow = window.open(url, target);
-        if (!newWindow) {
-            location.href = url;
-        }
-    } catch (e) {
-        location.href = url;
-    }
-}

package/src/utils/encoding.ts

@@ -1,153 +0,0 @@
-import { warn } from './warn';
-
-/**
- * Encoding Rules (␣ = Space)
- * - Path: ␣ " < > # ? { }
- * - Query: ␣ " < > # & =
- * - Hash: ␣ " < > `
- *
- * On top of that, the RFC3986 (https://tools.ietf.org/html/rfc3986#section-2.2)
- * defines some extra characters to be encoded. Most browsers do not encode them
- * in encodeURI https://github.com/whatwg/url/issues/369, so it may be safer to
- * also encode `!'()*`. Leaving un-encoded only ASCII alphanumeric(`a-zA-Z0-9`)
- * plus `-._~`. This extra safety should be applied to query by patching the
- * string returned by encodeURIComponent encodeURI also encodes `[\]^`. `\`
- * should be encoded to avoid ambiguity. Browsers (IE, FF, C) transform a `\`
- * into a `/` if directly typed in. The _backtick_ (`````) should also be
- * encoded everywhere because some browsers like FF encode it when directly
- * written while others don't. Safari and IE don't encode ``"<>{}``` in hash.
- */
-// const EXTRA_RESERVED_RE = /[!'()*]/g
-// const encodeReservedReplacer = (c: string) => '%' + c.charCodeAt(0).toString(16)
-
-const HASH_RE = /#/g; // %23
-const AMPERSAND_RE = /&/g; // %26
-const SLASH_RE = /\//g; // %2F
-const EQUAL_RE = /=/g; // %3D
-const IM_RE = /\?/g; // %3F
-export const PLUS_RE = /\+/g; // %2B
-/**
- * NOTE: It's not clear to me if we should encode the + symbol in queries, it
- * seems to be less flexible than not doing so and I can't find out the legacy
- * systems requiring this for regular requests like text/html. In the standard,
- * the encoding of the plus character is only mentioned for
- * application/x-www-form-urlencoded
- * (https://url.spec.whatwg.org/#urlencoded-parsing) and most browsers seems lo
- * leave the plus character as is in queries. To be more flexible, we allow the
- * plus character on the query, but it can also be manually encoded by the user.
- *
- * Resources:
- * - https://url.spec.whatwg.org/#urlencoded-parsing
- * - https://stackoverflow.com/questions/1634271/url-encoding-the-space-character-or-20
- */
-
-const ENC_BRACKET_OPEN_RE = /%5B/g; // [
-const ENC_BRACKET_CLOSE_RE = /%5D/g; // ]
-const ENC_CARET_RE = /%5E/g; // ^
-const ENC_BACKTICK_RE = /%60/g; // `
-const ENC_CURLY_OPEN_RE = /%7B/g; // {
-const ENC_PIPE_RE = /%7C/g; // |
-const ENC_CURLY_CLOSE_RE = /%7D/g; // }
-const ENC_SPACE_RE = /%20/g; // }
-
-/**
- * Encode characters that need to be encoded on the path, search and hash
- * sections of the URL.
- *
- * @internal
- * @param text - string to encode
- * @returns encoded string
- */
-function commonEncode(text: string | number): string {
-    return encodeURIComponent('' + text)
-        .replace(ENC_PIPE_RE, '|')
-        .replace(ENC_BRACKET_OPEN_RE, '[')
-        .replace(ENC_BRACKET_CLOSE_RE, ']');
-}
-
-/**
- * Encode characters that need to be encoded on the hash section of the URL.
- *
- * @param text - string to encode
- * @returns encoded string
- */
-export function encodeHash(text: string): string {
-    return commonEncode(text)
-        .replace(ENC_CURLY_OPEN_RE, '{')
-        .replace(ENC_CURLY_CLOSE_RE, '}')
-        .replace(ENC_CARET_RE, '^');
-}
-
-/**
- * Encode characters that need to be encoded query values on the query
- * section of the URL.
- *
- * @param text - string to encode
- * @returns encoded string
- */
-export function encodeQueryValue(text: string | number): string {
-    return (
-        commonEncode(text)
-            // Encode the space as +, encode the + to differentiate it from the space
-            .replace(PLUS_RE, '%2B')
-            .replace(ENC_SPACE_RE, '+')
-            .replace(HASH_RE, '%23')
-            .replace(AMPERSAND_RE, '%26')
-            .replace(ENC_BACKTICK_RE, '`')
-            .replace(ENC_CURLY_OPEN_RE, '{')
-            .replace(ENC_CURLY_CLOSE_RE, '}')
-            .replace(ENC_CARET_RE, '^')
-    );
-}
-
-/**
- * Like `encodeQueryValue` but also encodes the `=` character.
- *
- * @param text - string to encode
- */
-export function encodeQueryKey(text: string | number): string {
-    return encodeQueryValue(text).replace(EQUAL_RE, '%3D');
-}
-
-/**
- * Encode characters that need to be encoded on the path section of the URL.
- *
- * @param text - string to encode
- * @returns encoded string
- */
-export function encodePath(text: string | number): string {
-    return commonEncode(text).replace(HASH_RE, '%23').replace(IM_RE, '%3F');
-}
-
-/**
- * Encode characters that need to be encoded on the path section of the URL as a
- * param. This function encodes everything {@link encodePath} does plus the
- * slash (`/`) character. If `text` is `null` or `undefined`, returns an empty
- * string instead.
- *
- * @param text - string to encode
- * @returns encoded string
- */
-export function encodeParam(text: string | number | null | undefined): string {
-    return text == null ? '' : encodePath(text).replace(SLASH_RE, '%2F');
-}
-
-/**
- * Decode text using `decodeURIComponent`. Returns the original text if it
- * fails.
- *
- * @param text - string to decode
- * @returns decoded string
- */
-export function decode(text: string | number): string {
-    try {
-        return decodeURIComponent('' + text);
-    } catch (err) {
-        warn(`Error decoding "${text}". Using original value`);
-    }
-    return '' + text;
-}
-
-export function decodeQuery(text: string): string {
-    return decode(text.replace(PLUS_RE, ' '));
-}

package/src/utils/guards.ts

@@ -1,25 +0,0 @@
-import type { RouteRecord } from '../types';
-
-/**
- * 判断是否是同一个路由
- */
-export function isSameRoute(from: RouteRecord, to: RouteRecord) {
-    return (
-        from.matched.length === to.matched.length &&
-        from.matched.every((record, i) => record === to.matched[i])
-    );
-}
-
-/**
- * 判断是否是全等的路由: 路径完全相同
- */
-export function isEqualRoute(from: RouteRecord, to: RouteRecord) {
-    return (
-        // 这里不仅仅判断了前后的path是否一致
-        // 同时判断了匹配路由对象的个数
-        // 这是因为在首次初始化时 this.current 的值为 { path:'/',matched:[] }
-        // 假如我们打开页面同样为 / 路径时，此时如果单纯判断path那么就会造成无法渲染
-        from.fullPath === to.fullPath &&
-        from.matched.length === to.matched.length
-    );
-}

package/src/utils/index.ts

@@ -1,27 +0,0 @@
-export {
-    regexDomain,
-    normalizePath,
-    parsePath,
-    stringifyPath,
-    normalizeLocation,
-    isPathWithProtocolOrDomain
-} from './path';
-export { isESModule, inBrowser } from './utils';
-export { warn } from './warn';
-export { isSameRoute, isEqualRoute } from './guards';
-export {
-    computeScrollPosition,
-    scrollToPosition,
-    saveScrollPosition,
-    getSavedScrollPosition,
-    getKeepScrollPosition
-} from './scroll';
-export { openWindow } from './bom';
-export {
-    encodeHash,
-    encodeParam,
-    encodePath,
-    encodeQueryKey,
-    encodeQueryValue,
-    decode
-} from './encoding';

package/src/utils/path.spec.ts

@@ -1,32 +0,0 @@
-import { describe, it } from 'vitest';
-
-import { normalizeLocation, normalizePath } from './path';
-
-describe('testing normalizeLocation', () => {
-    it('testing normal domain', ({ expect }) => {
-        expect(
-            normalizeLocation(
-                'http://localhost:5173/en/en/en/en/en',
-                'http://localhost:5173/en/'
-            ).path
-        ).toBe('/en/en/en/en');
-    });
-    it('testing path', ({ expect }) => {
-        expect(
-            normalizeLocation('/test1/test2?t=https://www-six.betafollowme.com')
-                .path
-        ).toBe('/test1/test2');
-    });
-});
-
-describe('testing normalizePath', () => {
-    it('testing normal domain', ({ expect }) => {
-        expect(normalizePath('test2', 'test1')).toBe('/test1/test2');
-    });
-    it('testing path', ({ expect }) => {
-        expect(
-            normalizeLocation('/test1/test2?t=https://www-six.betafollowme.com')
-                .path
-        ).toBe('/test1/test2');
-    });
-});