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

package/CHANGELOG.md

@@ -1,152 +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.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 {};

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

@@ -1,70 +0,0 @@
-import type { HeadConfig } from './head';
-/**
- * Vuepress page data
- */
-export declare type PageData<ExtendedPageData extends Record<any, any> = Record<never, never>> = ExtendedPageData & {
-    /**
-     * 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;
-    /**
-     * Excerpt of the page
-     */
-    excerpt: string;
-    /**
-     * Headers of the page
-     */
-    headers: PageHeader[];
-};
-/**
- * Vuepress page frontmatter
- *
- * Notice that frontmatter is parsed from yaml or other languages,
- * so we cannot guarantee the type safety
- */
-export declare type PageFrontmatter<T extends Record<any, any> = Record<string, unknown>> = Partial<T> & {
-    layout?: string;
-    permalink?: string;
-    permalinkPattern?: string;
-    date?: string | Date;
-    lang?: string;
-    title?: string;
-    description?: string;
-    head?: HeadConfig[];
-};
-/**
- * Vuepress page header
- */
-export interface PageHeader {
-    level: number;
-    title: string;
-    slug: string;
-    children: PageHeader[];
-}

package/lib/esm/types/page.js

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

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

@@ -1,42 +0,0 @@
-import type { HeadConfig } from './head';
-import type { LocaleConfig } from './locale';
-/**
- * Vuepress site data
- */
-export interface SiteData extends SiteLocaleData {
-    base: string;
-    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
- */
-export interface SiteLocaleData {
-    lang: string;
-    title: string;
-    description: string;
-    head: HeadConfig[];
-}
-/**
- * Site locale config
- *
- * @example
- * {
- *   '/en/': {
- *     lang: 'en-US',
- *     title: 'Hello',
- *   },
- *   '/zh/: {
- *     lang: 'zh-CN',
- *     title: '你好',
- *   }
- * }
- *
- * @remark suffix `Config` means this is for user config
- */
-export declare type SiteLocaleConfig = LocaleConfig<SiteLocaleData>;

package/lib/esm/types/site.js

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

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

@@ -1,8 +0,0 @@
-import type { HeadConfig } from './head';
-/**
- * Context for SSR
- */
-export interface VuepressSSRContext {
-    lang: string;
-    head: HeadConfig[];
-}

package/lib/esm/types/ssr.js

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

package/lib/esm/utils/dedupeHead.d.ts

@@ -1,7 +0,0 @@
-import type { HeadConfig } from '../types';
-/**
- * Dedupe head config with identifier
- *
- * Items that appear earlier have higher priority
- */
-export declare const dedupeHead: (head: HeadConfig[]) => HeadConfig[];

package/lib/esm/utils/dedupeHead.js

@@ -1,18 +0,0 @@
-import { resolveHeadIdentifier } from './resolveHeadIdentifier';
-/**
- * Dedupe head config with identifier
- *
- * Items that appear earlier have higher priority
- */
-export const dedupeHead = (head) => {
-    const identifierSet = new Set();
-    const result = [];
-    head.forEach((item) => {
-        const identifier = resolveHeadIdentifier(item);
-        if (!identifierSet.has(identifier)) {
-            identifierSet.add(identifier);
-            result.push(item);
-        }
-    });
-    return result;
-};

package/lib/esm/utils/ensureEndingSlash.d.ts

@@ -1,4 +0,0 @@
-/**
- * Ensure a url string to have ending slash /
- */
-export declare const ensureEndingSlash: (str: string) => string;

package/lib/esm/utils/ensureEndingSlash.js

@@ -1,4 +0,0 @@
-/**
- * Ensure a url string to have ending slash /
- */
-export const ensureEndingSlash = (str) => /(\.html|\/)$/.test(str) ? str : str + '/';

package/lib/esm/utils/ensureLeadingSlash.d.ts

@@ -1,4 +0,0 @@
-/**
- * Ensure a url string to have leading slash /
- */
-export declare const ensureLeadingSlash: (str: string) => string;

package/lib/esm/utils/ensureLeadingSlash.js

@@ -1,4 +0,0 @@
-/**
- * Ensure a url string to have leading slash /
- */
-export const ensureLeadingSlash = (str) => str.replace(/^\/?/, '/');

package/lib/esm/utils/formatDateString.d.ts

@@ -1,4 +0,0 @@
-/**
- * Format a date string to `yyyy-MM-dd`
- */
-export declare const formatDateString: (str: string, defaultDateString?: string) => string;

package/lib/esm/utils/formatDateString.js

@@ -1,14 +0,0 @@
-/**
- * Format a date string to `yyyy-MM-dd`
- */
-export const formatDateString = (str, defaultDateString = '') => {
-    // match the `yyyy-(M)M-(d)d` pattern
-    const dateMatch = str.match(/\b(\d{4})-(\d{1,2})-(\d{1,2})\b/);
-    // return `defaultDateString` if no matched pattern
-    if (dateMatch === null) {
-        return defaultDateString;
-    }
-    // fill leading zeros for month and day
-    const [, yearStr, monthStr, dayStr] = dateMatch;
-    return [yearStr, monthStr.padStart(2, '0'), dayStr.padStart(2, '0')].join('-');
-};

package/lib/esm/utils/htmlEscape.d.ts

@@ -1,4 +0,0 @@
-/**
- * Escape html chars
- */
-export declare const htmlEscape: (str: string) => string;

package/lib/esm/utils/htmlEscape.js

@@ -1,12 +0,0 @@
-const htmlEscapeMap = {
-    '&': '&',
-    '<': '&lt;',
-    '>': '&gt;',
-    "'": '&#39;',
-    '"': '&quot;',
-};
-const htmlEscapeRegexp = /[&<>'"]/g;
-/**
- * Escape html chars
- */
-export const htmlEscape = (str) => str.replace(htmlEscapeRegexp, (char) => htmlEscapeMap[char]);

package/lib/esm/utils/htmlUnescape.d.ts

@@ -1,4 +0,0 @@
-/**
- * Unescape html chars
- */
-export declare const htmlUnescape: (str: string) => string;

package/lib/esm/utils/htmlUnescape.js

@@ -1,17 +0,0 @@
-const htmlUnescapeMap = {
-    '&': '&',
-    '&': '&',
-    '&lt;': '<',
-    '&#60;': '<',
-    '&gt;': '>',
-    '&#62;': '>',
-    '&apos;': "'",
-    '&#39;': "'",
-    '&quot;': '"',
-    '&#34;': '"',
-};
-const htmlUnescapeRegexp = /&(amp|#38|lt|#60|gt|#62|apos|#39|quot|#34);/g;
-/**
- * Unescape html chars
- */
-export const htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);

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

@@ -1,18 +0,0 @@
-export { isArray, isFunction, isPromise, isString } from '@vue/shared';
-export * from './dedupeHead';
-export * from './ensureLeadingSlash';
-export * from './ensureEndingSlash';
-export * from './formatDateString';
-export * from './htmlEscape';
-export * from './htmlUnescape';
-export * from './isLinkExternal';
-export * from './isLinkHttp';
-export * from './isLinkMailto';
-export * from './isLinkTel';
-export * from './isPlainObject';
-export * from './normalizePackageName';
-export * from './removeEndingSlash';
-export * from './removeLeadingSlash';
-export * from './resolveHeadIdentifier';
-export * from './resolveLocalePath';
-export * from './resolveRoutePathFromUrl';

package/lib/esm/utils/index.js

@@ -1,18 +0,0 @@
-export { isArray, isFunction, isPromise, isString } from '@vue/shared';
-export * from './dedupeHead';
-export * from './ensureLeadingSlash';
-export * from './ensureEndingSlash';
-export * from './formatDateString';
-export * from './htmlEscape';
-export * from './htmlUnescape';
-export * from './isLinkExternal';
-export * from './isLinkHttp';
-export * from './isLinkMailto';
-export * from './isLinkTel';
-export * from './isPlainObject';
-export * from './normalizePackageName';
-export * from './removeEndingSlash';
-export * from './removeLeadingSlash';
-export * from './resolveHeadIdentifier';
-export * from './resolveLocalePath';
-export * from './resolveRoutePathFromUrl';

package/lib/esm/utils/isLinkExternal.d.ts

@@ -1,4 +0,0 @@
-/**
- * Determine a link is external or not
- */
-export declare const isLinkExternal: (link: string, base?: string) => boolean;

package/lib/esm/utils/isLinkExternal.js

@@ -1,15 +0,0 @@
-import { isLinkHttp } from './isLinkHttp';
-/**
- * Determine a link is external or not
- */
-export const isLinkExternal = (link, base = '/') => {
-    // http link
-    if (isLinkHttp(link)) {
-        return true;
-    }
-    // absolute link that does not start with `base`
-    if (link.startsWith('/') && !link.startsWith(base)) {
-        return true;
-    }
-    return false;
-};

package/lib/esm/utils/isLinkHttp.d.ts

@@ -1,8 +0,0 @@
-/**
- * Determine a link is http link or not
- *
- * - http://github.com
- * - https://github.com
- * - //github.com
- */
-export declare const isLinkHttp: (link: string) => boolean;

package/lib/esm/utils/isLinkHttp.js

@@ -1,8 +0,0 @@
-/**
- * Determine a link is http link or not
- *
- * - http://github.com
- * - https://github.com
- * - //github.com
- */
-export const isLinkHttp = (link) => /^(https?:)?\/\//.test(link);

package/lib/esm/utils/isLinkMailto.d.ts

@@ -1,4 +0,0 @@
-/**
- * Determine a link is a mailto: address or not
- */
-export declare const isLinkMailto: (link: string) => boolean;

package/lib/esm/utils/isLinkMailto.js

@@ -1,4 +0,0 @@
-/**
- * Determine a link is a mailto: address or not
- */
-export const isLinkMailto = (link) => /^mailto:/.test(link);

package/lib/esm/utils/isLinkTel.d.ts

@@ -1,4 +0,0 @@
-/**
- * Determine a link is a tel: address or not
- */
-export declare const isLinkTel: (link: string) => boolean;

package/lib/esm/utils/isLinkTel.js

@@ -1,4 +0,0 @@
-/**
- * Determine a link is a tel: address or not
- */
-export const isLinkTel = (link) => /^tel:/.test(link);

package/lib/esm/utils/isPlainObject.d.ts

@@ -1,4 +0,0 @@
-/**
- * Check if a value is plain object, with generic type support
- */
-export declare const isPlainObject: <T extends Record<any, any> = Record<any, any>>(val: unknown) => val is T;

package/lib/esm/utils/isPlainObject.js

@@ -1,4 +0,0 @@
-/**
- * Check if a value is plain object, with generic type support
- */
-export const isPlainObject = (val) => Object.prototype.toString.call(val) === '[object Object]';

package/lib/esm/utils/normalizePackageName.d.ts

@@ -1,4 +0,0 @@
-/**
- * Normalize package name
- */
-export declare const normalizePackageName: (request: string, org: string, type?: string | null) => string;

package/lib/esm/utils/normalizePackageName.js

@@ -1,37 +0,0 @@
-/**
- * Normalize package name
- */
-export const normalizePackageName = (request, org, type = null) => {
-    // org prefix and type prefix
-    const orgPrefix = `${org}-`;
-    const typePrefix = type === null ? '' : `${type}-`;
-    // scoped package pattern
-    const scopedMatch = request.match(/^@(.*)\/(.*)$/);
-    // handle non-scoped package
-    if (scopedMatch === null) {
-        // full name, return as is
-        if (request.startsWith(`${orgPrefix}${typePrefix}`)) {
-            return request;
-        }
-        // short name, add org prefix and type prefix
-        return `${orgPrefix}${typePrefix}${request}`;
-    }
-    // handle scoped package
-    const [, reqOrg, reqName] = scopedMatch;
-    // handle default org
-    if (reqOrg === org) {
-        // full name, return as is
-        if (reqName.startsWith(typePrefix)) {
-            return request;
-        }
-        // short name, add type prefix
-        return `@${reqOrg}/${typePrefix}${reqName}`;
-    }
-    // handle other org
-    // full name, return as is
-    if (reqName.startsWith(`${orgPrefix}${typePrefix}`)) {
-        return request;
-    }
-    // short name, add org prefix and type prefix
-    return `@${reqOrg}/${orgPrefix}${typePrefix}${reqName}`;
-};

package/lib/esm/utils/removeEndingSlash.d.ts

@@ -1,4 +0,0 @@
-/**
- * Remove ending slash / from a string
- */
-export declare const removeEndingSlash: (str: string) => string;

package/lib/esm/utils/removeEndingSlash.js

@@ -1,4 +0,0 @@
-/**
- * Remove ending slash / from a string
- */
-export const removeEndingSlash = (str) => str.replace(/\/$/, '');

package/lib/esm/utils/removeLeadingSlash.d.ts

@@ -1,4 +0,0 @@
-/**
- * Remove leading slash / from a string
- */
-export declare const removeLeadingSlash: (str: string) => string;

package/lib/esm/utils/removeLeadingSlash.js

@@ -1,4 +0,0 @@
-/**
- * Remove leading slash / from a string
- */
-export const removeLeadingSlash = (str) => str.replace(/^\//, '');