@vuepress/shared 2.0.0-beta.38 → 2.0.0-beta.41

package/lib/types/index.js

@@ -1,21 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-__exportStar(require("./head"), exports);
-__exportStar(require("./locale"), exports);
-__exportStar(require("./page"), exports);
-__exportStar(require("./site"), exports);
-__exportStar(require("./ssr"), exports);

package/lib/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/types/locale.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/types/page.d.ts

@@ -1,75 +0,0 @@
-import type { HeadConfig } from './head';
-/**
- * Base type of vuepress page
- */
-export 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
- */
-export 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
- */
-export 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
- */
-export interface PageHeader {
-    level: number;
-    title: string;
-    slug: string;
-    children: PageHeader[];
-}

package/lib/types/page.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/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/types/site.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/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/types/ssr.js

@@ -1,2 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });

package/lib/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/utils/dedupeHead.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.dedupeHead = void 0;
-const resolveHeadIdentifier_1 = require("./resolveHeadIdentifier");
-/**
- * Dedupe head config with identifier
- *
- * Items that appear earlier have higher priority
- */
-const dedupeHead = (head) => {
-    const identifierSet = new Set();
-    const result = [];
-    head.forEach((item) => {
-        const identifier = (0, resolveHeadIdentifier_1.resolveHeadIdentifier)(item);
-        if (!identifierSet.has(identifier)) {
-            identifierSet.add(identifier);
-            result.push(item);
-        }
-    });
-    return result;
-};
-exports.dedupeHead = dedupeHead;

package/lib/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/utils/ensureEndingSlash.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureEndingSlash = void 0;
-/**
- * Ensure a url string to have ending slash /
- */
-const ensureEndingSlash = (str) => /(\.html|\/)$/.test(str) ? str : str + '/';
-exports.ensureEndingSlash = ensureEndingSlash;

package/lib/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/utils/ensureLeadingSlash.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureLeadingSlash = void 0;
-/**
- * Ensure a url string to have leading slash /
- */
-const ensureLeadingSlash = (str) => str.replace(/^\/?/, '/');
-exports.ensureLeadingSlash = ensureLeadingSlash;

package/lib/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/utils/formatDateString.js

@@ -1,18 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.formatDateString = void 0;
-/**
- * Format a date string to `yyyy-MM-dd`
- */
-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('-');
-};
-exports.formatDateString = formatDateString;

package/lib/utils/htmlEscape.d.ts

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

package/lib/utils/htmlEscape.js

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.htmlEscape = void 0;
-const htmlEscapeMap = {
-    '&': '&',
-    '<': '&lt;',
-    '>': '&gt;',
-    "'": '&#39;',
-    '"': '&quot;',
-};
-const htmlEscapeRegexp = /[&<>'"]/g;
-/**
- * Escape html chars
- */
-const htmlEscape = (str) => str.replace(htmlEscapeRegexp, (char) => htmlEscapeMap[char]);
-exports.htmlEscape = htmlEscape;

package/lib/utils/htmlUnescape.d.ts

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

package/lib/utils/htmlUnescape.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.htmlUnescape = void 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
- */
-const htmlUnescape = (str) => str.replace(htmlUnescapeRegexp, (char) => htmlUnescapeMap[char]);
-exports.htmlUnescape = htmlUnescape;

package/lib/utils/index.d.ts

@@ -1,19 +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 './isLinkFtp';
-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/utils/index.js

@@ -1,40 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    var desc = Object.getOwnPropertyDescriptor(m, k);
-    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
-      desc = { enumerable: true, get: function() { return m[k]; } };
-    }
-    Object.defineProperty(o, k2, desc);
-}) : (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    o[k2] = m[k];
-}));
-var __exportStar = (this && this.__exportStar) || function(m, exports) {
-    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isString = exports.isPromise = exports.isFunction = exports.isArray = void 0;
-var shared_1 = require("@vue/shared");
-Object.defineProperty(exports, "isArray", { enumerable: true, get: function () { return shared_1.isArray; } });
-Object.defineProperty(exports, "isFunction", { enumerable: true, get: function () { return shared_1.isFunction; } });
-Object.defineProperty(exports, "isPromise", { enumerable: true, get: function () { return shared_1.isPromise; } });
-Object.defineProperty(exports, "isString", { enumerable: true, get: function () { return shared_1.isString; } });
-__exportStar(require("./dedupeHead"), exports);
-__exportStar(require("./ensureLeadingSlash"), exports);
-__exportStar(require("./ensureEndingSlash"), exports);
-__exportStar(require("./formatDateString"), exports);
-__exportStar(require("./htmlEscape"), exports);
-__exportStar(require("./htmlUnescape"), exports);
-__exportStar(require("./isLinkExternal"), exports);
-__exportStar(require("./isLinkFtp"), exports);
-__exportStar(require("./isLinkHttp"), exports);
-__exportStar(require("./isLinkMailto"), exports);
-__exportStar(require("./isLinkTel"), exports);
-__exportStar(require("./isPlainObject"), exports);
-__exportStar(require("./normalizePackageName"), exports);
-__exportStar(require("./removeEndingSlash"), exports);
-__exportStar(require("./removeLeadingSlash"), exports);
-__exportStar(require("./resolveHeadIdentifier"), exports);
-__exportStar(require("./resolveLocalePath"), exports);
-__exportStar(require("./resolveRoutePathFromUrl"), exports);

package/lib/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/utils/isLinkExternal.js

@@ -1,20 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLinkExternal = void 0;
-const isLinkFtp_1 = require("./isLinkFtp");
-const isLinkHttp_1 = require("./isLinkHttp");
-/**
- * Determine a link is external or not
- */
-const isLinkExternal = (link, base = '/') => {
-    // http link or ftp link
-    if ((0, isLinkHttp_1.isLinkHttp)(link) || (0, isLinkFtp_1.isLinkFtp)(link)) {
-        return true;
-    }
-    // absolute link that does not start with `base`
-    if (link.startsWith('/') && !link.startsWith(base)) {
-        return true;
-    }
-    return false;
-};
-exports.isLinkExternal = isLinkExternal;

package/lib/utils/isLinkFtp.d.ts

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

package/lib/utils/isLinkFtp.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLinkFtp = void 0;
-/**
- * Determine a link is ftp link or not
- */
-const isLinkFtp = (link) => link.startsWith('ftp://');
-exports.isLinkFtp = isLinkFtp;

package/lib/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/utils/isLinkHttp.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLinkHttp = void 0;
-/**
- * Determine a link is http link or not
- *
- * - http://github.com
- * - https://github.com
- * - //github.com
- */
-const isLinkHttp = (link) => /^(https?:)?\/\//.test(link);
-exports.isLinkHttp = isLinkHttp;

package/lib/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/utils/isLinkMailto.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLinkMailto = void 0;
-/**
- * Determine a link is a mailto: address or not
- */
-const isLinkMailto = (link) => /^mailto:/.test(link);
-exports.isLinkMailto = isLinkMailto;

package/lib/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/utils/isLinkTel.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isLinkTel = void 0;
-/**
- * Determine a link is a tel: address or not
- */
-const isLinkTel = (link) => /^tel:/.test(link);
-exports.isLinkTel = isLinkTel;

package/lib/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/utils/isPlainObject.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isPlainObject = void 0;
-/**
- * Check if a value is plain object, with generic type support
- */
-const isPlainObject = (val) => Object.prototype.toString.call(val) === '[object Object]';
-exports.isPlainObject = isPlainObject;

package/lib/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/utils/normalizePackageName.js

@@ -1,41 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.normalizePackageName = void 0;
-/**
- * Normalize package name
- */
-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}`;
-};
-exports.normalizePackageName = normalizePackageName;

package/lib/utils/removeEndingSlash.d.ts

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

package/lib/utils/removeEndingSlash.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeEndingSlash = void 0;
-/**
- * Remove ending slash / from a string
- */
-const removeEndingSlash = (str) => str.replace(/\/$/, '');
-exports.removeEndingSlash = removeEndingSlash;

package/lib/utils/removeLeadingSlash.d.ts

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

package/lib/utils/removeLeadingSlash.js

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.removeLeadingSlash = void 0;
-/**
- * Remove leading slash / from a string
- */
-const removeLeadingSlash = (str) => str.replace(/^\//, '');
-exports.removeLeadingSlash = removeLeadingSlash;

package/lib/utils/resolveHeadIdentifier.d.ts

@@ -1,5 +0,0 @@
-import type { HeadConfig } from '../types';
-/**
- * Resolve identifier of a tag, to avoid duplicated tags in `<head>`
- */
-export declare const resolveHeadIdentifier: ([tag, attrs, content,]: HeadConfig) => string;

package/lib/utils/resolveHeadIdentifier.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveHeadIdentifier = void 0;
-/**
- * Resolve identifier of a tag, to avoid duplicated tags in `<head>`
- */
-const resolveHeadIdentifier = ([tag, attrs, content,]) => {
-    // avoid duplicated `<meta>` with same `name`
-    if (tag === 'meta' && attrs.name) {
-        return `${tag}.${attrs.name}`;
-    }
-    // there should be only one `<title>` or `<base>`
-    if (['title', 'base'].includes(tag)) {
-        return tag;
-    }
-    // avoid duplicated `<template>` with same `id`
-    if (tag === 'template' && attrs.id) {
-        return `${tag}.${attrs.id}`;
-    }
-    return JSON.stringify([tag, attrs, content]);
-};
-exports.resolveHeadIdentifier = resolveHeadIdentifier;

package/lib/utils/resolveLocalePath.d.ts

@@ -1,5 +0,0 @@
-import type { LocaleConfig } from '../types';
-/**
- * Resolve the matched locale path of route path
- */
-export declare const resolveLocalePath: (locales: LocaleConfig, routePath: string) => string;

package/lib/utils/resolveLocalePath.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveLocalePath = void 0;
-/**
- * Resolve the matched locale path of route path
- */
-const 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 '/';
-};
-exports.resolveLocalePath = resolveLocalePath;

package/lib/utils/resolveRoutePathFromUrl.d.ts

@@ -1 +0,0 @@
-export declare const resolveRoutePathFromUrl: (url: string, base?: string) => string;