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

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(/^\//, '');

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

@@ -1,18 +0,0 @@
-/**
- * Resolve identifier of a tag, to avoid duplicated tags in `<head>`
- */
-export 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]);
-};

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

@@ -1,18 +0,0 @@
-/**
- * Resolve the matched locale path of route path
- */
-export 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 '/';
-};

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

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

package/lib/esm/utils/resolveRoutePathFromUrl.js

@@ -1,5 +0,0 @@
-export const resolveRoutePathFromUrl = (url, base = '/') => url
-    // remove url origin
-    .replace(/^(https?:)?\/\/[^/]*/, '')
-    // remove site base
-    .replace(new RegExp(`^${base}`), '/');

package/lib/index.d.ts

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

package/lib/index.js

@@ -1,14 +0,0 @@
-"use strict";
-var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
-    if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
-}) : (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("./types"), exports);
-__exportStar(require("./utils"), exports);