@vuepress/shared 2.0.0-beta.4 → 2.0.0-beta.42

package/dist/index.cjs

@@ -0,0 +1,198 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  dedupeHead: () => dedupeHead,
+  ensureEndingSlash: () => ensureEndingSlash,
+  ensureLeadingSlash: () => ensureLeadingSlash,
+  formatDateString: () => formatDateString,
+  htmlEscape: () => htmlEscape,
+  htmlUnescape: () => htmlUnescape,
+  isArray: () => import_shared.isArray,
+  isFunction: () => import_shared.isFunction,
+  isLinkExternal: () => isLinkExternal,
+  isLinkFtp: () => isLinkFtp,
+  isLinkHttp: () => isLinkHttp,
+  isLinkMailto: () => isLinkMailto,
+  isLinkTel: () => isLinkTel,
+  isPlainObject: () => isPlainObject,
+  isPromise: () => import_shared.isPromise,
+  isString: () => import_shared.isString,
+  removeEndingSlash: () => removeEndingSlash,
+  removeLeadingSlash: () => removeLeadingSlash,
+  resolveHeadIdentifier: () => resolveHeadIdentifier,
+  resolveLocalePath: () => resolveLocalePath,
+  resolveRoutePathFromUrl: () => resolveRoutePathFromUrl
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/utils/index.ts
+var import_shared = require("@vue/shared");
+
+// src/utils/resolveHeadIdentifier.ts
+var resolveHeadIdentifier = ([
+  tag,
+  attrs,
+  content
+]) => {
+  if (tag === "meta" && attrs.name) {
+    return `${tag}.${attrs.name}`;
+  }
+  if (["title", "base"].includes(tag)) {
+    return tag;
+  }
+  if (tag === "template" && attrs.id) {
+    return `${tag}.${attrs.id}`;
+  }
+  return JSON.stringify([tag, attrs, content]);
+};
+
+// src/utils/dedupeHead.ts
+var dedupeHead = (head) => {
+  const identifierSet = /* @__PURE__ */ new Set();
+  const result = [];
+  head.forEach((item) => {
+    const identifier = resolveHeadIdentifier(item);
+    if (!identifierSet.has(identifier)) {
+      identifierSet.add(identifier);
+      result.push(item);
+    }
+  });
+  return result;
+};
+
+// src/utils/ensureLeadingSlash.ts
+var ensureLeadingSlash = (str) => str.replace(/^\/?/, "/");
+
+// src/utils/ensureEndingSlash.ts
+var ensureEndingSlash = (str) => /(\.html|\/)$/.test(str) ? str : str + "/";
+
+// src/utils/formatDateString.ts
+var formatDateString = (str, defaultDateString = "") => {
+  const dateMatch = str.match(/\b(\d{4})-(\d{1,2})-(\d{1,2})\b/);
+  if (dateMatch === null) {
+    return defaultDateString;
+  }
+  const [, yearStr, monthStr, dayStr] = dateMatch;
+  return [yearStr, monthStr.padStart(2, "0"), dayStr.padStart(2, "0")].join("-");
+};
+
+// src/utils/htmlEscape.ts
+var htmlEscapeMap = {
+  "&": "&",
+  "<": "&lt;",
+  ">": "&gt;",
+  "'": "&#39;",
+  '"': "&quot;"
+};
+var htmlEscapeRegexp = /[&<>'"]/g;
+var htmlEscape = (str) => str.replace(htmlEscapeRegexp, (char) => htmlEscapeMap[char]);
+
+// src/utils/htmlUnescape.ts
+var htmlUnescapeMap = {
+  "&amp;": "&",
+  "&#38;": "&",
+  "&lt;": "<",
+  "&#60;": "<",
+  "&gt;": ">",
+  "&#62;": ">",
+  "&apos;": "'",
+  "&#39;": "'",
+  "&quot;": '"',
+  "&#34;": '"'
+};
+var htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+var htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);
+
+// src/utils/isLinkFtp.ts
+var isLinkFtp = (link) => link.startsWith("ftp://");
+
+// src/utils/isLinkHttp.ts
+var isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
+
+// src/utils/isLinkExternal.ts
+var isLinkExternal = (link, base = "/") => {
+  if (isLinkHttp(link) || isLinkFtp(link)) {
+    return true;
+  }
+  if (link.startsWith("/") && !link.startsWith(base)) {
+    return true;
+  }
+  return false;
+};
+
+// src/utils/isLinkMailto.ts
+var isLinkMailto = (link) => /^mailto:/.test(link);
+
+// src/utils/isLinkTel.ts
+var isLinkTel = (link) => /^tel:/.test(link);
+
+// src/utils/isPlainObject.ts
+var isPlainObject = (val) => Object.prototype.toString.call(val) === "[object Object]";
+
+// src/utils/removeEndingSlash.ts
+var removeEndingSlash = (str) => str.replace(/\/$/, "");
+
+// src/utils/removeLeadingSlash.ts
+var removeLeadingSlash = (str) => str.replace(/^\//, "");
+
+// src/utils/resolveLocalePath.ts
+var resolveLocalePath = (locales, routePath) => {
+  const localePaths = Object.keys(locales).sort((a, b) => {
+    const levelDelta = b.split("/").length - a.split("/").length;
+    if (levelDelta !== 0) {
+      return levelDelta;
+    }
+    return b.length - a.length;
+  });
+  for (const localePath of localePaths) {
+    if (routePath.startsWith(localePath)) {
+      return localePath;
+    }
+  }
+  return "/";
+};
+
+// src/utils/resolveRoutePathFromUrl.ts
+var resolveRoutePathFromUrl = (url, base = "/") => url.replace(/^(https?:)?\/\/[^/]*/, "").replace(new RegExp(`^${base}`), "/");
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  dedupeHead,
+  ensureEndingSlash,
+  ensureLeadingSlash,
+  formatDateString,
+  htmlEscape,
+  htmlUnescape,
+  isArray,
+  isFunction,
+  isLinkExternal,
+  isLinkFtp,
+  isLinkHttp,
+  isLinkMailto,
+  isLinkTel,
+  isPlainObject,
+  isPromise,
+  isString,
+  removeEndingSlash,
+  removeLeadingSlash,
+  resolveHeadIdentifier,
+  resolveLocalePath,
+  resolveRoutePathFromUrl
+});

package/dist/index.d.ts

@@ -0,0 +1,289 @@
+export { isArray, isFunction, isPromise, isString } from '@vue/shared';
+
+/**
+ * Config for `<head>` tags
+ */
+declare type HeadConfig = [HeadTagEmpty, HeadAttrsConfig] | [HeadTagNonEmpty, HeadAttrsConfig, string];
+/**
+ * Allowed tags in `<head>`
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head
+ */
+declare type HeadTag = HeadTagNonEmpty | HeadTagEmpty;
+/**
+ * Non-empty tags in `<head>`
+ */
+declare type HeadTagNonEmpty = 'title' | 'style' | 'script' | 'noscript' | 'template';
+/**
+ * Empty tags in `<head>`
+ */
+declare type HeadTagEmpty = 'base' | 'link' | 'meta' | 'script';
+/**
+ * Attributes to be set for tags in `<head>`
+ */
+declare type HeadAttrsConfig = Record<string, string | boolean>;
+
+/**
+ * Locales config, a key-value object
+ *
+ * - Key is the locale path (prefix)
+ * - Value is the locales data
+ *
+ * @remark suffix `Config` means this is for user config
+ */
+declare type LocaleConfig<T extends LocaleData = LocaleData> = Record<string, Partial<T>>;
+/**
+ * Locales data
+ */
+declare type LocaleData = Record<string, any>;
+
+/**
+ * Base type of vuepress page
+ */
+declare type PageBase<ExtraPageFrontmatter extends Record<any, any> = Record<string, unknown>> = {
+    /**
+     * Identifier of the page
+     *
+     * Will also be used as the component name
+     *
+     * @example 'v-foobar'
+     */
+    key: string;
+    /**
+     * Route path of the page
+     *
+     * Firstly inferred from the file path
+     *
+     * Might be overridden by permalink
+     *
+     * @example '/guide/index.html'
+     * @example '/2020/02/02/hello-world.html'
+     */
+    path: string;
+    /**
+     * Title of the page
+     */
+    title: string;
+    /**
+     * Language of the page
+     */
+    lang: string;
+    /**
+     * Front matter of the page
+     */
+    frontmatter: PageFrontmatter<ExtraPageFrontmatter>;
+    /**
+     * Excerpt of the page
+     */
+    excerpt: string;
+    /**
+     * Headers of the page
+     */
+    headers: PageHeader[];
+};
+/**
+ * Vuepress page data
+ */
+declare type PageData<ExtraPageData extends Record<any, any> = Record<never, never>, ExtraPageFrontmatter extends Record<any, any> = Record<string, unknown>> = PageBase<ExtraPageFrontmatter> & ExtraPageData;
+/**
+ * Vuepress page frontmatter
+ *
+ * Notice that frontmatter is parsed from yaml or other languages,
+ * so we cannot guarantee the type safety
+ */
+declare type PageFrontmatter<T extends Record<any, any> = Record<string, unknown>> = Partial<T> & {
+    date?: string | Date;
+    description?: string;
+    head?: HeadConfig[];
+    lang?: string;
+    layout?: string;
+    permalink?: string;
+    permalinkPattern?: string;
+    routeMeta?: Record<string, unknown>;
+    title?: string;
+};
+/**
+ * Vuepress page header
+ */
+interface PageHeader {
+    level: number;
+    title: string;
+    slug: string;
+    children: PageHeader[];
+}
+
+/**
+ * Vuepress site data
+ */
+interface SiteData extends SiteLocaleData {
+    /**
+     * The base URL the site will be deployed at
+     *
+     * It should always start and end with a slash
+     *
+     * @default '/'
+     */
+    base: '/' | `/${string}/`;
+    /**
+     * Specify locales for i18n support
+     *
+     * It will override the root-level site data in different subpath
+     *
+     * @example
+     * {
+     *   '/en/': {
+     *     lang: 'en-US',
+     *     title: 'Hello',
+     *     description: 'This will take effect under /en/ subpath',
+     *   },
+     *   '/zh/': {
+     *     lang: 'zh-CN',
+     *     title: '你好',
+     *     description: '它将会在 /zh/ 子路径下生效',
+     *   }
+     * }
+     */
+    locales: SiteLocaleConfig;
+}
+/**
+ * Locales data of vuepress site
+ *
+ * If they are set in the root of site data, they will be used
+ * as the default value
+ *
+ * If they are set in the `locales` of site data, they will be
+ * used for specific locale
+ */
+interface SiteLocaleData {
+    /**
+     * Language for the site
+     *
+     * @default 'en-US'
+     */
+    lang: string;
+    /**
+     * Title for the site
+     *
+     * @default ''
+     */
+    title: string;
+    /**
+     * Description for the site
+     *
+     * @default ''
+     */
+    description: string;
+    /**
+     * Head config
+     *
+     * Descibe the tags to be appended into the `<head>` tag
+     *
+     * @default []
+     *
+     * @example ['link', { rel: 'icon', href: '/logo.png' }]
+     * @example ['style', { type: 'text/css' }, 'p { color: red; }']
+     */
+    head: HeadConfig[];
+}
+/**
+ * Site locale config
+ */
+declare type SiteLocaleConfig = LocaleConfig<SiteLocaleData>;
+
+/**
+ * Context for SSR
+ */
+interface VuepressSSRContext {
+    lang: string;
+    head: HeadConfig[];
+}
+
+/**
+ * Dedupe head config with identifier
+ *
+ * Items that appear earlier have higher priority
+ */
+declare const dedupeHead: (head: HeadConfig[]) => HeadConfig[];
+
+/**
+ * Ensure a url string to have leading slash /
+ */
+declare const ensureLeadingSlash: (str: string) => string;
+
+/**
+ * Ensure a url string to have ending slash /
+ */
+declare const ensureEndingSlash: (str: string) => string;
+
+/**
+ * Format a date string to `yyyy-MM-dd`
+ */
+declare const formatDateString: (str: string, defaultDateString?: string) => string;
+
+/**
+ * Escape html chars
+ */
+declare const htmlEscape: (str: string) => string;
+
+/**
+ * Unescape html chars
+ */
+declare const htmlUnescape: (str: string) => string;
+
+/**
+ * Determine a link is external or not
+ */
+declare const isLinkExternal: (link: string, base?: string) => boolean;
+
+/**
+ * Determine a link is ftp link or not
+ */
+declare const isLinkFtp: (link: string) => boolean;
+
+/**
+ * Determine a link is http link or not
+ *
+ * - http://github.com
+ * - https://github.com
+ * - //github.com
+ */
+declare const isLinkHttp: (link: string) => boolean;
+
+/**
+ * Determine a link is a mailto: address or not
+ */
+declare const isLinkMailto: (link: string) => boolean;
+
+/**
+ * Determine a link is a tel: address or not
+ */
+declare const isLinkTel: (link: string) => boolean;
+
+/**
+ * Check if a value is plain object, with generic type support
+ */
+declare const isPlainObject: <T extends Record<any, any> = Record<any, any>>(val: unknown) => val is T;
+
+/**
+ * Remove ending slash / from a string
+ */
+declare const removeEndingSlash: (str: string) => string;
+
+/**
+ * Remove leading slash / from a string
+ */
+declare const removeLeadingSlash: (str: string) => string;
+
+/**
+ * Resolve identifier of a tag, to avoid duplicated tags in `<head>`
+ */
+declare const resolveHeadIdentifier: ([tag, attrs, content,]: HeadConfig) => string;
+
+/**
+ * Resolve the matched locale path of route path
+ */
+declare const resolveLocalePath: (locales: LocaleConfig, routePath: string) => string;
+
+declare const resolveRoutePathFromUrl: (url: string, base?: string) => string;
+
+export { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageBase, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig, SiteLocaleData, VuepressSSRContext, dedupeHead, ensureEndingSlash, ensureLeadingSlash, formatDateString, htmlEscape, htmlUnescape, isLinkExternal, isLinkFtp, isLinkHttp, isLinkMailto, isLinkTel, isPlainObject, removeEndingSlash, removeLeadingSlash, resolveHeadIdentifier, resolveLocalePath, resolveRoutePathFromUrl };

package/dist/index.js

@@ -0,0 +1,152 @@
+// src/utils/index.ts
+import { isArray, isFunction, isPromise, isString } from "@vue/shared";
+
+// src/utils/resolveHeadIdentifier.ts
+var resolveHeadIdentifier = ([
+  tag,
+  attrs,
+  content
+]) => {
+  if (tag === "meta" && attrs.name) {
+    return `${tag}.${attrs.name}`;
+  }
+  if (["title", "base"].includes(tag)) {
+    return tag;
+  }
+  if (tag === "template" && attrs.id) {
+    return `${tag}.${attrs.id}`;
+  }
+  return JSON.stringify([tag, attrs, content]);
+};
+
+// src/utils/dedupeHead.ts
+var dedupeHead = (head) => {
+  const identifierSet = /* @__PURE__ */ new Set();
+  const result = [];
+  head.forEach((item) => {
+    const identifier = resolveHeadIdentifier(item);
+    if (!identifierSet.has(identifier)) {
+      identifierSet.add(identifier);
+      result.push(item);
+    }
+  });
+  return result;
+};
+
+// src/utils/ensureLeadingSlash.ts
+var ensureLeadingSlash = (str) => str.replace(/^\/?/, "/");
+
+// src/utils/ensureEndingSlash.ts
+var ensureEndingSlash = (str) => /(\.html|\/)$/.test(str) ? str : str + "/";
+
+// src/utils/formatDateString.ts
+var formatDateString = (str, defaultDateString = "") => {
+  const dateMatch = str.match(/\b(\d{4})-(\d{1,2})-(\d{1,2})\b/);
+  if (dateMatch === null) {
+    return defaultDateString;
+  }
+  const [, yearStr, monthStr, dayStr] = dateMatch;
+  return [yearStr, monthStr.padStart(2, "0"), dayStr.padStart(2, "0")].join("-");
+};
+
+// src/utils/htmlEscape.ts
+var htmlEscapeMap = {
+  "&": "&",
+  "<": "&lt;",
+  ">": "&gt;",
+  "'": "&#39;",
+  '"': "&quot;"
+};
+var htmlEscapeRegexp = /[&<>'"]/g;
+var htmlEscape = (str) => str.replace(htmlEscapeRegexp, (char) => htmlEscapeMap[char]);
+
+// src/utils/htmlUnescape.ts
+var htmlUnescapeMap = {
+  "&amp;": "&",
+  "&#38;": "&",
+  "&lt;": "<",
+  "&#60;": "<",
+  "&gt;": ">",
+  "&#62;": ">",
+  "&apos;": "'",
+  "&#39;": "'",
+  "&quot;": '"',
+  "&#34;": '"'
+};
+var htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
+var htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);
+
+// src/utils/isLinkFtp.ts
+var isLinkFtp = (link) => link.startsWith("ftp://");
+
+// src/utils/isLinkHttp.ts
+var isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
+
+// src/utils/isLinkExternal.ts
+var isLinkExternal = (link, base = "/") => {
+  if (isLinkHttp(link) || isLinkFtp(link)) {
+    return true;
+  }
+  if (link.startsWith("/") && !link.startsWith(base)) {
+    return true;
+  }
+  return false;
+};
+
+// src/utils/isLinkMailto.ts
+var isLinkMailto = (link) => /^mailto:/.test(link);
+
+// src/utils/isLinkTel.ts
+var isLinkTel = (link) => /^tel:/.test(link);
+
+// src/utils/isPlainObject.ts
+var isPlainObject = (val) => Object.prototype.toString.call(val) === "[object Object]";
+
+// src/utils/removeEndingSlash.ts
+var removeEndingSlash = (str) => str.replace(/\/$/, "");
+
+// src/utils/removeLeadingSlash.ts
+var removeLeadingSlash = (str) => str.replace(/^\//, "");
+
+// src/utils/resolveLocalePath.ts
+var resolveLocalePath = (locales, routePath) => {
+  const localePaths = Object.keys(locales).sort((a, b) => {
+    const levelDelta = b.split("/").length - a.split("/").length;
+    if (levelDelta !== 0) {
+      return levelDelta;
+    }
+    return b.length - a.length;
+  });
+  for (const localePath of localePaths) {
+    if (routePath.startsWith(localePath)) {
+      return localePath;
+    }
+  }
+  return "/";
+};
+
+// src/utils/resolveRoutePathFromUrl.ts
+var resolveRoutePathFromUrl = (url, base = "/") => url.replace(/^(https?:)?\/\/[^/]*/, "").replace(new RegExp(`^${base}`), "/");
+export {
+  dedupeHead,
+  ensureEndingSlash,
+  ensureLeadingSlash,
+  formatDateString,
+  htmlEscape,
+  htmlUnescape,
+  isArray,
+  isFunction,
+  isLinkExternal,
+  isLinkFtp,
+  isLinkHttp,
+  isLinkMailto,
+  isLinkTel,
+  isPlainObject,
+  isPromise,
+  isString,
+  removeEndingSlash,
+  removeLeadingSlash,
+  resolveHeadIdentifier,
+  resolveLocalePath,
+  resolveRoutePathFromUrl
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/shared",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.42",
   "description": "Utils that shared between VuePress node and client",
   "keywords": [
     "vuepress",
@@ -16,22 +16,46 @@
     "url": "git+https://github.com/vuepress/vuepress-next.git"
   },
   "license": "MIT",
-  "author": "Evan You",
-  "main": "lib/index.js",
-  "module": "lib/esm/index.js",
-  "types": "lib/index.d.ts",
+  "author": "meteorlxy",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    },
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
-    "lib"
+    "dist"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig.build.json",
-    "clean": "rimraf lib *.tsbuildinfo"
-  },
   "dependencies": {
-    "@vue/shared": "^3.0.7"
+    "@vue/shared": "^3.2.33"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d42716e1b5b682ffb5d7cf124d0a24344493c467"
-}
+  "tsup": {
+    "clean": true,
+    "dts": [
+      "src/index.ts"
+    ],
+    "entry": [
+      "src/index.ts"
+    ],
+    "format": [
+      "cjs",
+      "esm"
+    ],
+    "outDir": "dist",
+    "sourcemap": false,
+    "target": "es2020",
+    "tsconfig": "tsconfig.dts.json"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist"
+  }
+}