@vuepress/shared 2.0.0-beta.7 → 2.0.0-rc.0

package/dist/index.d.ts

@@ -0,0 +1,266 @@
+import { MarkdownItHeader } from '@mdit-vue/types';
+export { isArray, isFunction, isString } from '@vue/shared';
+
+/**
+ * Config for `<head>` tags
+ */
+type HeadConfig = [HeadTagEmpty, HeadAttrsConfig] | [HeadTagNonEmpty, HeadAttrsConfig, string];
+/**
+ * Allowed tags in `<head>`
+ *
+ * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head
+ */
+type HeadTag = HeadTagNonEmpty | HeadTagEmpty;
+/**
+ * Non-empty tags in `<head>`
+ */
+type HeadTagNonEmpty = 'title' | 'style' | 'script' | 'noscript' | 'template';
+/**
+ * Empty tags in `<head>`
+ */
+type HeadTagEmpty = 'base' | 'link' | 'meta' | 'script';
+/**
+ * Attributes to be set for tags in `<head>`
+ */
+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
+ */
+type LocaleConfig<T extends LocaleData = LocaleData> = Record<string, Partial<T>>;
+/**
+ * Locales data
+ */
+type LocaleData = Record<never, never>;
+
+/**
+ * Base type of vuepress page
+ */
+interface 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>;
+    /**
+     * Headers of the page
+     */
+    headers: PageHeader[];
+}
+/**
+ * Vuepress page data
+ */
+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
+ */
+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 | null;
+    routeMeta?: Record<string, unknown>;
+    title?: string;
+};
+/**
+ * Vuepress page header
+ */
+type PageHeader = MarkdownItHeader;
+
+/**
+ * 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
+ */
+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;
+
+/**
+ * Determine a link is external or not
+ */
+declare const isLinkExternal: (link: string, base?: 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 has protocol or not
+ */
+declare const isLinkWithProtocol: (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;
+
+/**
+ * Omit properties from an object
+ */
+declare const omit: <T extends Record<string, unknown>, U extends string[]>(obj: T, ...keys: U) => Omit<T, U[number]>;
+
+/**
+ * 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, isLinkExternal, isLinkHttp, isLinkWithProtocol, isPlainObject, omit, removeEndingSlash, removeLeadingSlash, resolveHeadIdentifier, resolveLocalePath, resolveRoutePathFromUrl };

package/dist/index.js

@@ -0,0 +1,128 @@
+// src/utils/index.ts
+import { isArray, isFunction, 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[0] === "/" ? str : `/${str}`;
+
+// src/utils/ensureEndingSlash.ts
+var ensureEndingSlash = (str) => str[str.length - 1] === "/" || str.endsWith(".html") ? 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/isLinkHttp.ts
+var isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
+
+// src/utils/isLinkExternal.ts
+var markdownLinkRegexp = /.md((\?|#).*)?$/;
+var isLinkExternal = (link, base = "/") => {
+  if (isLinkHttp(link)) {
+    return true;
+  }
+  if (link.startsWith("/") && !link.startsWith(base) && !markdownLinkRegexp.test(link)) {
+    return true;
+  }
+  return false;
+};
+
+// src/utils/isLinkWithProtocol.ts
+var isLinkWithProtocol = (link) => /^[a-z][a-z0-9+.-]*:/.test(link);
+
+// src/utils/isPlainObject.ts
+var isPlainObject = (val) => Object.prototype.toString.call(val) === "[object Object]";
+
+// src/utils/omit.ts
+var omit = (obj, ...keys) => {
+  const result = { ...obj };
+  for (const key of keys) {
+    delete result[key];
+  }
+  return result;
+};
+
+// src/utils/removeEndingSlash.ts
+var removeEndingSlash = (str) => str[str.length - 1] === "/" ? str.slice(0, -1) : str;
+
+// src/utils/removeLeadingSlash.ts
+var removeLeadingSlash = (str) => str[0] === "/" ? str.slice(1) : str;
+
+// 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 = "/") => {
+  const pathname = url.replace(/^(https?:)?\/\/[^/]*/, "");
+  return pathname.startsWith(base) ? `/${pathname.slice(base.length)}` : pathname;
+};
+export {
+  dedupeHead,
+  ensureEndingSlash,
+  ensureLeadingSlash,
+  formatDateString,
+  isArray,
+  isFunction,
+  isLinkExternal,
+  isLinkHttp,
+  isLinkWithProtocol,
+  isPlainObject,
+  isString,
+  omit,
+  removeEndingSlash,
+  removeLeadingSlash,
+  resolveHeadIdentifier,
+  resolveLocalePath,
+  resolveRoutePathFromUrl
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/shared",
-  "version": "2.0.0-beta.7",
+  "version": "2.0.0-rc.0",
   "description": "Utils that shared between VuePress node and client",
   "keywords": [
     "vuepress",
@@ -16,22 +16,41 @@
     "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": {
+    ".": "./dist/index.js",
+    "./package.json": "./package.json"
+  },
+  "main": "./dist/index.js",
+  "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.11"
+    "@mdit-vue/types": "^1.0.0",
+    "@vue/shared": "^3.3.8"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "f798c4df7489d7fbf27bf430ea547413e8655af4"
-}
+  "tsup": {
+    "clean": true,
+    "dts": "./src/index.ts",
+    "entry": [
+      "./src/index.ts"
+    ],
+    "format": [
+      "esm"
+    ],
+    "outDir": "./dist",
+    "sourcemap": false,
+    "target": "es2022",
+    "tsconfig": "../tsconfig.dts.json"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist"
+  }
+}

package/CHANGELOG.md

@@ -1,160 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [2.0.0-beta.7](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.6...v2.0.0-beta.7) (2021-04-09)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-beta.4](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.3...v2.0.0-beta.4) (2021-03-20)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-beta.1](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.0...v2.0.0-beta.1) (2021-03-13)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-beta.0](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.26...v2.0.0-beta.0) (2021-03-13)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-alpha.25](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.24...v2.0.0-alpha.25) (2021-02-20)
-
-
-### Code Refactoring
-
-* **core:** remove theme data from site data ([187aef3](https://github.com/vuepress/vuepress-next/commit/187aef36607efc62d7b2d5c773553f89685cf64c))
-
-
-### BREAKING CHANGES
-
-* **core:** `themeConfig` is not available in site data any more
-
-
-
-
-
-# [2.0.0-alpha.24](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.23...v2.0.0-alpha.24) (2021-02-13)
-
-
-### Code Refactoring
-
-* **core:** change page default date to 0000-00-00 ([1ce602e](https://github.com/vuepress/vuepress-next/commit/1ce602ef811f29f083a8d10695a7b212ed82cae5))
-
-
-### BREAKING CHANGES
-
-* **core:** change page default date from 1970-01-01 to 0000-00-00
-
-
-
-
-
-# [2.0.0-alpha.20](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.19...v2.0.0-alpha.20) (2021-02-04)
-
-
-### Features
-
-* **core:** make language available in page data ([03bb09f](https://github.com/vuepress/vuepress-next/commit/03bb09fd51aeaff56d26820a1401b87ea8bdeb38))
-
-
-
-
-
-# [2.0.0-alpha.19](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.18...v2.0.0-alpha.19) (2021-01-24)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-alpha.18](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.17...v2.0.0-alpha.18) (2021-01-17)
-
-
-### Features
-
-* **shared:** optimize frontmatter type and support generics ([8a7025f](https://github.com/vuepress/vuepress-next/commit/8a7025ff39b4656f98f9a35e93848373ce72ddbe))
-
-
-
-
-
-# [2.0.0-alpha.15](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.14...v2.0.0-alpha.15) (2021-01-04)
-
-
-### Bug Fixes
-
-* **core:** fix site locale data type ([7898500](https://github.com/vuepress/vuepress-next/commit/7898500f8b611662777ca3bdeb89c5b3bb658595))
-
-
-
-
-
-# [2.0.0-alpha.13](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.12...v2.0.0-alpha.13) (2020-12-23)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-alpha.7](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.6...v2.0.0-alpha.7) (2020-12-09)
-
-**Note:** Version bump only for package @vuepress/shared
-
-
-
-
-
-# [2.0.0-alpha.6](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.5...v2.0.0-alpha.6) (2020-12-09)
-
-
-### Features
-
-* **shared:** add esm build ([f8463e7](https://github.com/vuepress/vuepress-next/commit/f8463e791c909493e343d98468663c9d31bcbb5f))
-
-
-
-
-
-# 2.0.0-alpha.1 (2020-12-01)
-
-
-### Bug Fixes
-
-* **shared:** missing type inference for resolveLocaleConfigItem ([3e230fd](https://github.com/vuepress/vuepress-next/commit/3e230fd72020ba2e2e9d9c0fef90f035410c184f))
-* **shared:** remove title from ssr context ([6eddf75](https://github.com/vuepress/vuepress-next/commit/6eddf75ea14cac471d93fcfbee2df03c1089ac58))
-
-
-### Features
-
-* **shared:** add children field in page header ([6f29d05](https://github.com/vuepress/vuepress-next/commit/6f29d05e6103d172ffe9263ff964c45afd82a4c1))
-* **shared:** add head utils ([f020af0](https://github.com/vuepress/vuepress-next/commit/f020af0d6abcb5505692e9ecd3ae16d8b846008f))
-* **shared:** add htmlUnescape and htmlEscape utils ([5e55f95](https://github.com/vuepress/vuepress-next/commit/5e55f95bcfd0b039ca1f4398f8d064af9fe4223a))
-* **shared:** add isLinkAbsolute and isLinkHttp utils ([bbe8e99](https://github.com/vuepress/vuepress-next/commit/bbe8e995d2f93ff9d8919d699be81d429e0d6abd))
-* **shared:** add link utils ([59e8fd5](https://github.com/vuepress/vuepress-next/commit/59e8fd521a92dc5ed4e1ea5d313dac40b46e7a90))
-* **shared:** add resolveRoutePathFromUrl util ([460f39b](https://github.com/vuepress/vuepress-next/commit/460f39ba26cda4601b02fc8c0437a88a36d6dd59))
-* **shared:** add utils to resolve locale data ([4d5ccd5](https://github.com/vuepress/vuepress-next/commit/4d5ccd56cac166bd76260b3ba3aedac562deead2))
-* **shared:** expose isPlainObject util ([1558de3](https://github.com/vuepress/vuepress-next/commit/1558de3248f12f2a2508bfb5ebbe53ca26c466cb))
-* **shared:** extract locale path util ([54b747c](https://github.com/vuepress/vuepress-next/commit/54b747c96e6c81f1af289317e7b80c5daff6f517))
-* **shared:** make PageData type extendable ([aacbecc](https://github.com/vuepress/vuepress-next/commit/aacbeccb26ff7d58776678faffdc8fdabcaf36c3))
-* **shared:** migrate isPlainObject with generics support ([fb1f7c3](https://github.com/vuepress/vuepress-next/commit/fb1f7c301514759a63443b19b5d62362d098fde7))
-* **shared:** optimize type definitions and remove resolveSiteLocaleData ([e1d58f6](https://github.com/vuepress/vuepress-next/commit/e1d58f6f3e40458e03e660e15ffc10e7e3acc7f5))

package/lib/esm/index.d.ts

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './utils';

package/lib/esm/index.js

@@ -1,2 +0,0 @@
-export * from './types';
-export * from './utils';

package/lib/esm/types/head.d.ts

@@ -1,27 +0,0 @@
-/**
- * Config for `<head>` tags
- *
- * @example ['link', { rel: 'icon', href: '/logo.png' }]
- * @example ['style', { type: 'text/css' }, 'p { color: red; }']
- *
- * @remark suffix `Config` means this is for user config
- */
-export declare type HeadConfig = [HeadTagEmpty, HeadAttrsConfig] | [HeadTagNonEmpty, HeadAttrsConfig, string];
-/**
- * Allowed tags in `<head>`
- *
- * @see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/head
- */
-export declare type HeadTag = HeadTagNonEmpty | HeadTagEmpty;
-/**
- * Non-empty tags in `<head>`
- */
-export declare type HeadTagNonEmpty = 'title' | 'style' | 'script' | 'noscript' | 'template';
-/**
- * Empty tags in `<head>`
- */
-export declare type HeadTagEmpty = 'base' | 'link' | 'meta' | 'script';
-/**
- * Attributes to be set for tags in `<head>`
- */
-export declare type HeadAttrsConfig = Record<string, string | boolean>;

package/lib/esm/types/head.js

@@ -1 +0,0 @@
-export {};

package/lib/esm/types/index.d.ts

@@ -1,5 +0,0 @@
-export * from './head';
-export * from './locale';
-export * from './page';
-export * from './site';
-export * from './ssr';

package/lib/esm/types/index.js

@@ -1,5 +0,0 @@
-export * from './head';
-export * from './locale';
-export * from './page';
-export * from './site';
-export * from './ssr';

package/lib/esm/types/locale.d.ts

@@ -1,13 +0,0 @@
-/**
- * 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
- */
-export declare type LocaleConfig<T extends LocaleData = LocaleData> = Record<string, Partial<T>>;
-/**
- * Locales data
- */
-export declare type LocaleData = Record<string, any>;

package/lib/esm/types/locale.js

@@ -1 +0,0 @@
-export {};