@esmx/router 3.0.0-rc.18 → 3.0.0-rc.20

package/dist/utils/encoding.d.ts

@@ -1,48 +0,0 @@
-export declare const PLUS_RE: RegExp;
-/**
- * Encode characters that need to be encoded on the hash section of the URL.
- *
- * @param text - string to encode
- * @returns encoded string
- */
-export declare function encodeHash(text: string): string;
-/**
- * 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 declare function encodeQueryValue(text: string | number): string;
-/**
- * Like `encodeQueryValue` but also encodes the `=` character.
- *
- * @param text - string to encode
- */
-export declare function encodeQueryKey(text: string | number): string;
-/**
- * Encode characters that need to be encoded on the path section of the URL.
- *
- * @param text - string to encode
- * @returns encoded string
- */
-export declare function encodePath(text: string | number): string;
-/**
- * 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 declare function encodeParam(text: string | number | null | undefined): string;
-/**
- * Decode text using `decodeURIComponent`. Returns the original text if it
- * fails.
- *
- * @param text - string to decode
- * @returns decoded string
- */
-export declare function decode(text: string | number): string;
-export declare function decodeQuery(text: string): string;

package/dist/utils/encoding.mjs

@@ -1,44 +0,0 @@
-import { warn } from "./warn.mjs";
-const HASH_RE = /#/g;
-const AMPERSAND_RE = /&/g;
-const SLASH_RE = /\//g;
-const EQUAL_RE = /=/g;
-const IM_RE = /\?/g;
-export const PLUS_RE = /\+/g;
-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;
-function commonEncode(text) {
-  return encodeURIComponent("" + text).replace(ENC_PIPE_RE, "|").replace(ENC_BRACKET_OPEN_RE, "[").replace(ENC_BRACKET_CLOSE_RE, "]");
-}
-export function encodeHash(text) {
-  return commonEncode(text).replace(ENC_CURLY_OPEN_RE, "{").replace(ENC_CURLY_CLOSE_RE, "}").replace(ENC_CARET_RE, "^");
-}
-export function encodeQueryValue(text) {
-  return commonEncode(text).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, "^");
-}
-export function encodeQueryKey(text) {
-  return encodeQueryValue(text).replace(EQUAL_RE, "%3D");
-}
-export function encodePath(text) {
-  return commonEncode(text).replace(HASH_RE, "%23").replace(IM_RE, "%3F");
-}
-export function encodeParam(text) {
-  return text == null ? "" : encodePath(text).replace(SLASH_RE, "%2F");
-}
-export function decode(text) {
-  try {
-    return decodeURIComponent("" + text);
-  } catch (err) {
-    warn(`Error decoding "${text}". Using original value`);
-  }
-  return "" + text;
-}
-export function decodeQuery(text) {
-  return decode(text.replace(PLUS_RE, " "));
-}

package/dist/utils/guards.d.ts

@@ -1,9 +0,0 @@
-import type { RouteRecord } from '../types';
-/**
- * 判断是否是同一个路由
- */
-export declare function isSameRoute(from: RouteRecord, to: RouteRecord): boolean;
-/**
- * 判断是否是全等的路由: 路径完全相同
- */
-export declare function isEqualRoute(from: RouteRecord, to: RouteRecord): boolean;

package/dist/utils/guards.mjs

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

package/dist/utils/index.d.ts

@@ -1,7 +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/dist/utils/index.mjs

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

package/dist/utils/path.d.ts

@@ -1,60 +0,0 @@
-import type { Route, RouterBase, RouterLocation, RouterRawLocation } from '../types';
-/**
- * 判断路径是否以 http 或 https 开头 或者直接是域名开头
- */
-export declare const regexDomain: RegExp;
-/**
- * 判断路径是否以 scheme 协议开头
- */
-export declare const regexScheme: RegExp;
-/**
- * 判断路径是否以 http(s) 协议开头
- */
-export declare const regexHttpScheme: RegExp;
-/**
- * 格式化路径 主要用于拼接嵌套路由的路径
- * 返回的格式化后的路径如果有协议则以协议开头，如果没有协议则以/开头
- */
-export declare function normalizePath(path: string, parentPath?: string): string;
-/**
- * 路径解析方法
- * @example 输入 https://www.google.com/test1/test2?a=1&b=2#123 输出 { pathname: '/test1/test2', query: { a: '1', b: '2' }, queryArray: { a: ['1'], b: ['2'] }, hash: '123' }
- * 输入 /test1/test2?a=1&b=2#123 同样输出 { pathname: '/test1/test2', query: { a: '1', b: '2' }, queryArray: { a: ['1'], b: ['2'] }, hash: '123' }
- */
-export declare function parsePath(path?: string): {
-    pathname: string;
-    query: Record<string, string>;
-    queryArray: Record<string, string[]>;
-    hash: string;
-};
-/**
- * 将path query hash合并为完整路径
- * @example stringifyPath({ pathname: '/news', query: { a: '1' }, hash: '123' }) 输出 '/news?a=1#123'
- */
-export declare function stringifyPath({ pathname, query, queryArray, hash }?: {
-    pathname: string;
-    query: Record<string, string | undefined>;
-    queryArray: Record<string, string[]>;
-    hash: string;
-}): string;
-/**
- * 标准化 RouterLocation 字段
- */
-export declare function normalizeLocation(rawLocation: RouterRawLocation, base?: RouterBase): RouterLocation & {
-    path: string;
-    base: string;
-    queryArray: Record<string, string[]>;
-};
-/**
- * 判断路径是否以协议或域名开头
- */
-export declare function isPathWithProtocolOrDomain(location: RouterRawLocation, base?: RouterBase): {
-    /**
-     * 是否以协议或域名开头
-     */
-    flag: boolean;
-    /**
-     * 虚假的 route 信息，内部跳转时无法信任，只有外站跳转时使用
-     */
-    route: Route;
-};

package/dist/utils/path.mjs

@@ -1,282 +0,0 @@
-import normalizeUrl from "normalize-url";
-import URLParse from "url-parse";
-import {
-  decode,
-  decodeQuery,
-  encodeHash,
-  encodeQueryKey,
-  encodeQueryValue
-} from "./encoding.mjs";
-import { isValidValue } from "./utils.mjs";
-import { assert } from "./warn.mjs";
-export const regexDomain = /^(?:https?:\/\/|[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z0-9][a-z0-9-]{0,61}[a-z0-9](\/.*)?/i;
-export const regexScheme = /^(?:[a-z][a-z\d+.-]*:.+)/i;
-export const regexHttpScheme = /^(http(s)?:\/\/)/;
-function removeDuplicateSlashes(url) {
-  if (url.includes("://")) {
-    const [base, path] = url.split("://");
-    const result2 = path.replace(/\/{2,}/g, "/");
-    return `${base}://${result2}`;
-  }
-  const result = url.replace(/\/{2,}/g, "/");
-  return result;
-}
-export function normalizePath(path, parentPath) {
-  let normalizedPath = parentPath ? `${parentPath}/${path}` : `${path}`;
-  if (!regexHttpScheme.test(normalizedPath) && !normalizedPath.startsWith("/")) {
-    normalizedPath = `/${normalizedPath}`;
-  }
-  return (
-    // 只有存在父级路由才进行路由拼接
-    removeDuplicateSlashes(normalizedPath).replace(/\/$/, "") || // 移除结尾的斜杠 /
-    "/"
-  );
-}
-export function parsePath(path = "") {
-  path = normalizePath(path);
-  const { pathname, query, hash } = new URLParse(path || "/");
-  const queryObj = {};
-  const queryArray = {};
-  if (query.length > 0) {
-    query.slice(1).split("&").forEach((item) => {
-      let [key = "", value = ""] = item.split("=");
-      key = decode(key);
-      value = decodeQuery(value);
-      if (key) {
-        queryObj[key] = value;
-        queryArray[key] = (queryArray[key] || []).concat(value);
-      }
-    });
-  }
-  return {
-    pathname,
-    query: queryObj,
-    queryArray,
-    hash: decode(hash)
-  };
-}
-export function stringifyPath({
-  pathname = "",
-  query = {},
-  queryArray = {},
-  hash = ""
-} = {
-  pathname: "",
-  query: {},
-  queryArray: {},
-  hash: ""
-}) {
-  const queryString = Object.entries(
-    Object.assign({}, query, queryArray)
-  ).reduce((acc, [key, value]) => {
-    let query2 = "";
-    const encodedKey = encodeQueryKey(key);
-    if (Array.isArray(value)) {
-      query2 = value.reduce((all, item) => {
-        if (!isValidValue(item)) return all;
-        const encodedValue = encodeQueryValue(item);
-        if (encodedValue) {
-          all = all ? `${all}&${encodedKey}=${encodedValue}` : `${encodedKey}=${encodedValue}`;
-        }
-        return all;
-      }, "");
-    } else {
-      const encodedValue = encodeQueryValue(value);
-      if (isValidValue(value)) {
-        query2 = `${encodedKey}=${encodedValue}`;
-      }
-    }
-    if (query2) {
-      acc = acc ? `${acc}&${query2}` : `?${query2}`;
-    }
-    return acc;
-  }, "");
-  const hashContent = hash.startsWith("#") ? hash.replace(/^#/, "") : hash;
-  const hashString = hashContent ? `#${encodeHash(hashContent)}` : "";
-  return `${pathname}${queryString}${hashString}`;
-}
-export function normalizeLocation(rawLocation, base = "") {
-  let pathname = "";
-  let query = {};
-  let queryArray = {};
-  let hash = "";
-  let params;
-  let state = {};
-  if (typeof rawLocation === "object") {
-    const parsedOption = parsePath(rawLocation.path);
-    pathname = parsedOption.pathname;
-    if (rawLocation.query || rawLocation.queryArray) {
-      queryArray = rawLocation.queryArray || {};
-      query = rawLocation.query || {};
-    } else {
-      queryArray = parsedOption.queryArray;
-      query = parsedOption.query;
-    }
-    hash = rawLocation.hash || parsedOption.hash;
-    params = rawLocation.params;
-    state = rawLocation.state || {};
-  } else {
-    const parsedOption = parsePath(rawLocation);
-    pathname = parsedOption.pathname;
-    query = parsedOption.query;
-    queryArray = parsedOption.queryArray;
-    hash = parsedOption.hash;
-  }
-  const fullPath = stringifyPath({
-    pathname,
-    query,
-    queryArray,
-    hash
-  });
-  const baseString = normalizePath(
-    typeof base === "function" ? base({
-      fullPath,
-      query,
-      queryArray,
-      hash
-    }) : base
-  );
-  let path = pathname;
-  if (regexDomain.test(baseString)) {
-    const { pathname: pathname2 } = new URLParse(baseString);
-    path = normalizePath(path.replace(new RegExp(`^(${pathname2})`), ""));
-  }
-  path = normalizePath(path.replace(new RegExp(`^(${baseString})`), ""));
-  const { query: realQuery, queryArray: realQueryArray } = parsePath(fullPath);
-  const res = {
-    base: baseString,
-    path,
-    query: realQuery,
-    queryArray: realQueryArray,
-    hash,
-    state
-  };
-  if (params) res.params = params;
-  return res;
-}
-export function isPathWithProtocolOrDomain(location, base = "") {
-  let url = "";
-  let state = {};
-  let baseString = "";
-  if (typeof base === "string") {
-    baseString = base;
-  } else {
-    baseString = base({
-      fullPath: "",
-      query: {},
-      queryArray: {},
-      hash: ""
-    });
-  }
-  if (typeof location === "string") {
-    url = location;
-  } else {
-    state = location.state || {};
-    const {
-      path,
-      query: query2 = {},
-      queryArray: queryArray2,
-      hash: hash2 = "",
-      ...nLocation
-    } = normalizeLocation(location);
-    url = stringifyPath({
-      ...nLocation,
-      query: query2,
-      queryArray: queryArray2,
-      pathname: path,
-      hash: hash2
-    });
-  }
-  try {
-    url = normalizeUrl(url, {
-      stripWWW: false,
-      removeQueryParameters: false,
-      sortQueryParameters: false
-    });
-  } catch (error) {
-    try {
-      url = new URL(url, baseString).href;
-    } catch (error2) {
-      assert(false, `Invalid URL: ${url}`);
-    }
-  }
-  if (regexScheme.test(url) && !regexHttpScheme.test(url)) {
-    const {
-      hash: hash2,
-      host: host2,
-      hostname: hostname2,
-      href: href2,
-      origin: origin2,
-      pathname: pathname2,
-      port: port2,
-      protocol: protocol2,
-      search: search2
-    } = new URL(url);
-    const route2 = {
-      hash: hash2,
-      host: host2,
-      hostname: hostname2,
-      href: href2,
-      origin: origin2,
-      pathname: pathname2,
-      port: port2,
-      protocol: protocol2,
-      search: search2,
-      params: {},
-      query: {},
-      queryArray: {},
-      state,
-      meta: {},
-      path: pathname2,
-      fullPath: url,
-      base: "",
-      matched: []
-    };
-    return {
-      flag: true,
-      route: route2
-    };
-  }
-  const {
-    hash,
-    host,
-    hostname,
-    href,
-    origin,
-    pathname,
-    port,
-    protocol,
-    query: search
-  } = new URLParse(url);
-  const { query = {}, queryArray } = normalizeLocation(url);
-  const route = {
-    href,
-    origin,
-    host,
-    protocol,
-    hostname,
-    port,
-    pathname,
-    search,
-    hash,
-    query,
-    queryArray,
-    params: {},
-    state,
-    meta: {},
-    path: pathname,
-    fullPath: `${pathname}${search}${hash}`,
-    base: "",
-    matched: []
-  };
-  if (regexDomain.test(url)) {
-    return {
-      flag: true,
-      route
-    };
-  }
-  return {
-    flag: false,
-    route
-  };
-}

package/dist/utils/path.spec.mjs

@@ -1,27 +0,0 @@
-import { describe, it } from "vitest";
-import { normalizeLocation, normalizePath } from "./path.mjs";
-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");
-  });
-});

package/dist/utils/scroll.d.ts

@@ -1,25 +0,0 @@
-import type { RouterRawLocation, ScrollPosition, _ScrollPositionNormalized } from '../types';
-/**
- * 获取当前滚动位置
- */
-export declare const computeScrollPosition: () => _ScrollPositionNormalized;
-/**
- * 滚动到指定位置
- */
-export declare function scrollToPosition(position: ScrollPosition): void;
-/**
- * 存储的滚动位置
- */
-export declare const scrollPositions: Map<string, _ScrollPositionNormalized>;
-/**
- * 保存滚动位置
- */
-export declare function saveScrollPosition(key: string, scrollPosition: _ScrollPositionNormalized): void;
-/**
- * 获取存储的滚动位置
- */
-export declare function getSavedScrollPosition(key: string): _ScrollPositionNormalized | null;
-/**
- * 获取跳转配置的保持滚动位置参数
- */
-export declare function getKeepScrollPosition(location: RouterRawLocation): boolean;

package/dist/utils/scroll.mjs

@@ -1,59 +0,0 @@
-import { warn } from "./warn.mjs";
-export const computeScrollPosition = () => ({
-  left: window.scrollX,
-  top: window.scrollY
-});
-function getElementPosition(el, offset) {
-  const docRect = document.documentElement.getBoundingClientRect();
-  const elRect = el.getBoundingClientRect();
-  return {
-    behavior: offset.behavior,
-    left: elRect.left - docRect.left - (offset.left || 0),
-    top: elRect.top - docRect.top - (offset.top || 0)
-  };
-}
-export function scrollToPosition(position) {
-  let scrollToOptions;
-  if ("el" in position) {
-    const positionEl = position.el;
-    const isIdSelector = typeof positionEl === "string" && positionEl.startsWith("#");
-    const el = typeof positionEl === "string" ? isIdSelector ? document.getElementById(positionEl.slice(1)) : document.querySelector(positionEl) : positionEl;
-    if (!el) {
-      return;
-    }
-    scrollToOptions = getElementPosition(el, position);
-  } else {
-    scrollToOptions = position;
-  }
-  if ("scrollBehavior" in document.documentElement.style) {
-    window.scrollTo(scrollToOptions);
-  } else {
-    window.scrollTo(
-      scrollToOptions.left != null ? scrollToOptions.left : window.scrollX,
-      scrollToOptions.top != null ? scrollToOptions.top : window.scrollY
-    );
-  }
-}
-export const scrollPositions = /* @__PURE__ */ new Map();
-const POSITION_KEY = "__scroll_position_key";
-export function saveScrollPosition(key, scrollPosition) {
-  scrollPositions.set(key, scrollPosition);
-  const stateCopy = Object.assign({}, window.history.state);
-  stateCopy[POSITION_KEY] = scrollPosition;
-  try {
-    const protocolAndPath = window.location.protocol + "//" + window.location.host;
-    const absolutePath = window.location.href.replace(protocolAndPath, "");
-    window.history.replaceState(stateCopy, "", absolutePath);
-  } catch (error) {
-    warn(`Failed to save scroll position.`, error);
-  }
-}
-export function getSavedScrollPosition(key) {
-  const scroll = scrollPositions.get(key) || history.state[POSITION_KEY];
-  scrollPositions.delete(key);
-  return scroll || null;
-}
-export function getKeepScrollPosition(location) {
-  if (typeof location === "string") return false;
-  return location.keepScrollPosition || false;
-}

package/dist/utils/utils.d.ts

@@ -1,16 +0,0 @@
-/**
- * 是否在浏览器环境
- */
-export declare const inBrowser: boolean;
-/**
- *  Symbol 是否可用
- */
-export declare const isSymbolAble: boolean;
-/**
- * 判断是否是 es module 对象
- */
-export declare function isESModule(obj: any): boolean;
-/**
- * 判断是否是合法的值
- */
-export declare function isValidValue(value: any): boolean;

package/dist/utils/utils.mjs

@@ -1,11 +0,0 @@
-export const inBrowser = typeof window !== "undefined";
-export const isSymbolAble = typeof Symbol === "function" && typeof Symbol.toStringTag === "symbol";
-export function isESModule(obj) {
-  return Boolean(obj.__esModule) || isSymbolAble && obj[Symbol.toStringTag] === "Module";
-}
-export function isValidValue(value) {
-  if (value === null) return false;
-  if (value === void 0) return false;
-  if (typeof value === "number" && isNaN(value)) return false;
-  return true;
-}

package/dist/utils/warn.d.ts

@@ -1,2 +0,0 @@
-export declare function assert(condition: boolean, message: string): void;
-export declare function warn(...args: any[]): void;

package/dist/utils/warn.mjs

@@ -1,12 +0,0 @@
-export function assert(condition, message) {
-  if (!condition) {
-    throw new Error(`[@esmx/router] ${message}`);
-  }
-}
-export function warn(...args) {
-  console.log(
-    "%c ROUTER WARNING:",
-    "color: rgb(214, 77, 77); font-weight: bold;",
-    ...args
-  );
-}