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

package/lib/app.js

@@ -1,133 +0,0 @@
-import { computed, h } from 'vue';
-import { createRouter, RouterView, START_LOCATION } from 'vue-router';
-import { removeEndingSlash } from '@vuepress/shared';
-import { clientAppEnhances } from '@internal/clientAppEnhances';
-import { clientAppRootComponents } from '@internal/clientAppRootComponents';
-import { clientAppSetups } from '@internal/clientAppSetups';
-import { pagesComponent } from '@internal/pagesComponent';
-import { pagesRoutes } from '@internal/pagesRoutes';
-import { siteData, pageData, resolvePageData, pageFrontmatterSymbol, resolvePageFrontmatter, pageHeadSymbol, resolvePageHead, pageHeadTitleSymbol, resolvePageHeadTitle, pageLangSymbol, resolvePageLang, routeLocaleSymbol, resolveRouteLocale, siteLocaleDataSymbol, resolveSiteLocaleData, useUpdateHead, } from './injections';
-import { Content, OutboundLink } from './components';
-import { withBase } from './utils';
-/**
- * Create a vue app
- *
- * Accepting different app creator and history creator, so it
- * can be reused for both client side and server side
- */
-export const createVueApp = async ({ appCreator, historyCreator, }) => {
-    // options to create vue app
-    const appOptions = {
-        setup() {
-            // auto update head
-            useUpdateHead();
-            // invoke all clientAppSetups
-            for (const clientAppSetup of clientAppSetups) {
-                clientAppSetup();
-            }
-            return () => [
-                h(RouterView),
-                ...clientAppRootComponents.map((comp) => h(comp)),
-            ];
-        },
-    };
-    // create vue app
-    const app = appCreator(appOptions);
-    // create vue-router
-    const router = createRouter({
-        // TODO: it might be an issue of vue-router that have to remove the ending slash
-        history: historyCreator(removeEndingSlash(siteData.value.base)),
-        routes: pagesRoutes,
-        scrollBehavior: (to, from, savedPosition) => {
-            if (savedPosition) {
-                return savedPosition;
-            }
-            if (to.hash) {
-                return { el: to.hash };
-            }
-            return { top: 0 };
-        },
-    });
-    // use vue-router
-    app.use(router);
-    router.beforeResolve(async (to, from) => {
-        if (to.path !== from.path || from === START_LOCATION) {
-            pageData.value = await resolvePageData(to.path);
-        }
-    });
-    // create global computed
-    const routeLocale = computed(() => resolveRouteLocale(siteData.value.locales, router.currentRoute.value.path));
-    const siteLocaleData = computed(() => resolveSiteLocaleData(siteData.value, routeLocale.value));
-    const pageFrontmatter = computed(() => resolvePageFrontmatter(pageData.value));
-    const pageHeadTitle = computed(() => resolvePageHeadTitle(pageData.value, siteLocaleData.value));
-    const pageHead = computed(() => resolvePageHead(pageHeadTitle.value, pageFrontmatter.value, siteLocaleData.value));
-    const pageLang = computed(() => resolvePageLang(pageData.value));
-    // provide global computed
-    app.provide(routeLocaleSymbol, routeLocale);
-    app.provide(siteLocaleDataSymbol, siteLocaleData);
-    app.provide(pageFrontmatterSymbol, pageFrontmatter);
-    app.provide(pageHeadTitleSymbol, pageHeadTitle);
-    app.provide(pageHeadSymbol, pageHead);
-    app.provide(pageLangSymbol, pageLang);
-    // provide global data & helpers
-    Object.defineProperties(app.config.globalProperties, {
-        $routeLocale: {
-            get() {
-                return routeLocale.value;
-            },
-        },
-        $site: {
-            get() {
-                return siteData.value;
-            },
-        },
-        $siteLocale: {
-            get() {
-                return siteLocaleData.value;
-            },
-        },
-        $page: {
-            get() {
-                return pageData.value;
-            },
-        },
-        $frontmatter: {
-            get() {
-                return pageFrontmatter.value;
-            },
-        },
-        $lang: {
-            get() {
-                return pageLang.value;
-            },
-        },
-        $headTitle: {
-            get() {
-                return pageHeadTitle.value;
-            },
-        },
-        $withBase: {
-            get() {
-                return withBase;
-            },
-        },
-    });
-    // register built-in components
-    /* eslint-disable vue/match-component-file-name */
-    app.component('ClientOnly', __SSR__ ? () => null : (_, ctx) => { var _a, _b; return (_b = (_a = ctx.slots).default) === null || _b === void 0 ? void 0 : _b.call(_a); });
-    app.component('Content', Content);
-    app.component('OutboundLink', OutboundLink);
-    /* eslint-enable vue/match-component-file-name */
-    // register all pages components
-    Object.entries(pagesComponent).forEach(([name, component]) => {
-        app.component(name, component);
-    });
-    // invoke all clientAppEnhances
-    for (const clientAppEnhance of clientAppEnhances) {
-        await clientAppEnhance({ app, router, siteData });
-    }
-    return {
-        app,
-        router,
-    };
-};

package/lib/client.d.ts

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

package/lib/client.js

@@ -1,14 +0,0 @@
-import { createApp } from 'vue';
-import { createWebHistory } from 'vue-router';
-import { createVueApp } from './app';
-/**
- * Client entry point
- */
-createVueApp({
-    appCreator: createApp,
-    historyCreator: createWebHistory,
-}).then(({ app, router }) => {
-    router.isReady().then(() => {
-        app.mount('#app');
-    });
-});

package/lib/components/Content.d.ts

@@ -1,7 +0,0 @@
-import type { FunctionalComponent } from 'vue';
-/**
- * Markdown rendered content
- */
-export declare const Content: FunctionalComponent<{
-    pagePath?: string;
-}>;

package/lib/components/Content.js

@@ -1,34 +0,0 @@
-import { h } from 'vue';
-import { pagesComponent } from '@internal/pagesComponent';
-import { usePageData } from '../injections';
-/**
- * Markdown rendered content
- */
-export const Content = (props) => {
-    let key;
-    // use the page key from props directly
-    if (props.pagePath) {
-        key = props.pagePath;
-    }
-    else {
-        // get current page key from page data
-        const page = usePageData();
-        key = page.value.path;
-    }
-    const component = pagesComponent[key];
-    // use page component
-    if (component) {
-        return h(component);
-    }
-    // fallback
-    return h('div', __DEV__
-        ? 'Page does not exist. This is a fallback content.'
-        : '404 Not Found');
-};
-Content.displayName = 'Content';
-Content.props = {
-    pagePath: {
-        type: String,
-        required: false,
-    },
-};

package/lib/components/OutboundLink.css

@@ -1,7 +0,0 @@
-.icon.outbound {
-  position: relative;
-  display: inline-block;
-  color: #aaa;
-  vertical-align: middle;
-  top: -1px;
-}

package/lib/components/OutboundLink.d.ts

@@ -1,3 +0,0 @@
-import type { FunctionalComponent } from 'vue';
-import './OutboundLink.css';
-export declare const OutboundLink: FunctionalComponent;

package/lib/components/OutboundLink.js

@@ -1,24 +0,0 @@
-import { h } from 'vue';
-import './OutboundLink.css';
-const svg = h('svg', {
-    class: 'icon outbound',
-    xmlns: 'http://www.w3.org/2000/svg',
-    ariaHidden: 'true',
-    focusable: 'false',
-    x: '0px',
-    y: '0px',
-    viewBox: '0 0 100 100',
-    width: '15',
-    height: '15',
-}, [
-    h('path', {
-        fill: 'currentColor',
-        d: 'M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z',
-    }),
-    h('polygon', {
-        fill: 'currentColor',
-        points: '45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9',
-    }),
-]);
-export const OutboundLink = (_, { slots }) => { var _a; return h('span', [svg, (_a = slots.default) === null || _a === void 0 ? void 0 : _a.call(slots)]); };
-OutboundLink.displayName = 'OutboundLink';

package/lib/components/Vuepress.d.ts

@@ -1,5 +0,0 @@
-import type { FunctionalComponent } from 'vue';
-/**
- * Global Layout
- */
-export declare const Vuepress: FunctionalComponent;

package/lib/components/Vuepress.js

@@ -1,33 +0,0 @@
-import { h } from 'vue';
-import { isString } from '@vuepress/shared';
-import { layoutComponents } from '@internal/layoutComponents';
-import { usePageData } from '../injections';
-import { Content } from './Content';
-/**
- * Global Layout
- */
-export const Vuepress = () => {
-    // get layout of current page
-    let layoutName = '404';
-    const page = usePageData();
-    if (page.value.path) {
-        // if current page exists
-        // use layout from frontmatter
-        const frontmatterLayout = page.value.frontmatter.layout;
-        if (isString(frontmatterLayout)) {
-            layoutName = frontmatterLayout;
-        }
-        else {
-            // fallback to Layout component
-            layoutName = 'Layout';
-        }
-    }
-    const layoutComponent = layoutComponents[layoutName];
-    // use layout component
-    if (layoutComponent) {
-        return h(layoutComponent);
-    }
-    // fallback to Content
-    return h(Content);
-};
-Vuepress.displayName = 'Vuepress';

package/lib/components/index.d.ts

@@ -1,3 +0,0 @@
-export * from './Content';
-export * from './OutboundLink';
-export * from './Vuepress';

package/lib/components/index.js

@@ -1,3 +0,0 @@
-export * from './Content';
-export * from './OutboundLink';
-export * from './Vuepress';

package/lib/constants.d.ts

@@ -1,4 +0,0 @@
-declare const __VERSION__: string
-declare const __DEV__: boolean
-declare const __SSR__: boolean
-declare const __VUE_HMR_RUNTIME__: Record<string, any>

package/lib/index.d.ts

@@ -1,7 +0,0 @@
-export * from './app';
-export * from './components';
-export * from './injections';
-export * from './types';
-export * from './utils';
-export type { PageHeader } from '@vuepress/shared';
-export type { ServerEntry } from './server';

package/lib/index.js

@@ -1,5 +0,0 @@
-export * from './app';
-export * from './components';
-export * from './injections';
-export * from './types';
-export * from './utils';

package/lib/injections/index.d.ts

@@ -1,10 +0,0 @@
-export * from './pageData';
-export * from './pageFrontmatter';
-export * from './pageHead';
-export * from './pageHeadTitle';
-export * from './pageLang';
-export * from './pagesData';
-export * from './routeLocale';
-export * from './siteData';
-export * from './siteLocaleData';
-export * from './updateHead';

package/lib/injections/index.js

@@ -1,10 +0,0 @@
-export * from './pageData';
-export * from './pageFrontmatter';
-export * from './pageHead';
-export * from './pageHeadTitle';
-export * from './pageLang';
-export * from './pagesData';
-export * from './routeLocale';
-export * from './siteData';
-export * from './siteLocaleData';
-export * from './updateHead';

package/lib/injections/pageData.d.ts

@@ -1,7 +0,0 @@
-import type { Ref } from 'vue';
-import type { PageData } from '@vuepress/shared';
-export type { PageData };
-export declare type PageDataRef<T extends Record<any, any> = Record<never, never>> = Ref<PageData<T>>;
-export declare const pageData: PageDataRef;
-export declare const usePageData: <T extends Record<any, any> = Record<never, never>>() => PageDataRef<T>;
-export declare const resolvePageData: (routePath: string) => Promise<PageData>;

package/lib/injections/pageData.js

@@ -1,31 +0,0 @@
-import { ref, readonly } from 'vue';
-import { pagesData } from './pagesData';
-const pageDataEmpty = readonly({
-    key: '',
-    path: '',
-    title: '',
-    lang: '',
-    frontmatter: {},
-    excerpt: '',
-    headers: [],
-});
-export const pageData = ref(pageDataEmpty);
-export const usePageData = () => {
-    return pageData;
-};
-export const resolvePageData = async (routePath) => {
-    const pageDataResolver = pagesData.value[routePath];
-    if (!pageDataResolver) {
-        return pageDataEmpty;
-    }
-    const pageData = await pageDataResolver();
-    return pageData !== null && pageData !== void 0 ? pageData : pageDataEmpty;
-};
-if (import.meta.webpackHot || import.meta.hot) {
-    // reuse vue HMR runtime
-    __VUE_HMR_RUNTIME__.updatePageData = (newPageData) => {
-        if (newPageData.key === pageData.value.key) {
-            pageData.value = newPageData;
-        }
-    };
-}

package/lib/injections/pageFrontmatter.d.ts

@@ -1,7 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-import type { PageData, PageFrontmatter } from '@vuepress/shared';
-export type { PageFrontmatter };
-export declare type PageFrontmatterRef<T extends Record<any, any> = Record<string, unknown>> = ComputedRef<PageFrontmatter<T>>;
-export declare const pageFrontmatterSymbol: InjectionKey<PageFrontmatterRef>;
-export declare const usePageFrontmatter: <T extends Record<any, any> = Record<string, unknown>>() => PageFrontmatterRef<T>;
-export declare const resolvePageFrontmatter: (pageData: PageData) => PageFrontmatter;

package/lib/injections/pageFrontmatter.js

@@ -1,10 +0,0 @@
-import { inject } from 'vue';
-export const pageFrontmatterSymbol = Symbol(__DEV__ ? 'pageFrontmatter' : '');
-export const usePageFrontmatter = () => {
-    const pageFrontmatter = inject(pageFrontmatterSymbol);
-    if (!pageFrontmatter) {
-        throw new Error('usePageFrontmatter() is called without provider.');
-    }
-    return pageFrontmatter;
-};
-export const resolvePageFrontmatter = (pageData) => pageData.frontmatter;

package/lib/injections/pageHead.d.ts

@@ -1,15 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-import type { HeadConfig } from '@vuepress/shared';
-import type { PageFrontmatter } from './pageFrontmatter';
-import type { PageHeadTitle } from './pageHeadTitle';
-import type { SiteLocaleData } from './siteLocaleData';
-export declare type PageHead = HeadConfig[];
-export declare type PageHeadRef = ComputedRef<PageHead>;
-export declare const pageHeadSymbol: InjectionKey<PageHeadRef>;
-export declare const usePageHead: () => PageHeadRef;
-/**
- * Merge the head config in frontmatter and site locale
- *
- * Frontmatter should take priority over site locale
- */
-export declare const resolvePageHead: (headTitle: PageHeadTitle, frontmatter: PageFrontmatter, siteLocale: SiteLocaleData) => HeadConfig[];

package/lib/injections/pageHead.js

@@ -1,33 +0,0 @@
-import { inject } from 'vue';
-import { dedupeHead, isArray, isString } from '@vuepress/shared';
-export const pageHeadSymbol = Symbol(__DEV__ ? 'pageHead' : '');
-export const usePageHead = () => {
-    const pageHead = inject(pageHeadSymbol);
-    if (!pageHead) {
-        throw new Error('usePageHead() is called without provider.');
-    }
-    return pageHead;
-};
-/**
- * Merge the head config in frontmatter and site locale
- *
- * Frontmatter should take priority over site locale
- */
-export const resolvePageHead = (headTitle, frontmatter, siteLocale) => {
-    const description = isString(frontmatter.description)
-        ? frontmatter.description
-        : siteLocale.description;
-    const head = [
-        ...(isArray(frontmatter.head) ? frontmatter.head : []),
-        ...siteLocale.head,
-        ['title', {}, headTitle],
-        ['meta', { name: 'description', content: description }],
-        ['meta', { charset: 'utf-8' }],
-        [
-            'meta',
-            { name: 'viewport', content: 'width=device-width,initial-scale=1' },
-        ],
-        ['meta', { name: 'generator', content: `VuePress ${__VERSION__}` }],
-    ];
-    return dedupeHead(head);
-};

package/lib/injections/pageHeadTitle.d.ts

@@ -1,11 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-import type { PageData } from './pageData';
-import type { SiteLocaleData } from './siteLocaleData';
-export declare type PageHeadTitle = string;
-export declare type PageHeadTitleRef = ComputedRef<PageHeadTitle>;
-export declare const pageHeadTitleSymbol: InjectionKey<PageHeadTitleRef>;
-export declare const usePageHeadTitle: () => PageHeadTitleRef;
-/**
- * Title to displayed in `<head>` tag
- */
-export declare const resolvePageHeadTitle: (page: PageData, siteLocale: SiteLocaleData) => PageHeadTitle;

package/lib/injections/pageHeadTitle.js

@@ -1,13 +0,0 @@
-import { inject } from 'vue';
-export const pageHeadTitleSymbol = Symbol(__DEV__ ? 'pageHeadTitle' : '');
-export const usePageHeadTitle = () => {
-    const pageHeadTitle = inject(pageHeadTitleSymbol);
-    if (!pageHeadTitle) {
-        throw new Error('usePageHeadTitle() is called without provider.');
-    }
-    return pageHeadTitle;
-};
-/**
- * Title to displayed in `<head>` tag
- */
-export const resolvePageHeadTitle = (page, siteLocale) => `${page.title ? `${page.title} | ` : ``}${siteLocale.title}`;

package/lib/injections/pageLang.d.ts

@@ -1,13 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-import type { PageData } from '@vuepress/shared';
-export declare type PageLang = string;
-export declare type PageLangRef = ComputedRef<PageLang>;
-export declare const pageLangSymbol: InjectionKey<PageLangRef>;
-export declare const usePageLang: () => PageLangRef;
-/**
- * Resolve language of current page
- *
- * It's mainly used for the `lang` attribute of `<html>` tag,
- * which should not be empty
- */
-export declare const resolvePageLang: (pageData: PageData) => PageLang;

package/lib/injections/pageLang.js

@@ -1,16 +0,0 @@
-import { inject } from 'vue';
-export const pageLangSymbol = Symbol(__DEV__ ? 'pageLang' : '');
-export const usePageLang = () => {
-    const pageLang = inject(pageLangSymbol);
-    if (!pageLang) {
-        throw new Error('usePageLang() is called without provider.');
-    }
-    return pageLang;
-};
-/**
- * Resolve language of current page
- *
- * It's mainly used for the `lang` attribute of `<html>` tag,
- * which should not be empty
- */
-export const resolvePageLang = (pageData) => pageData.lang || 'en';

package/lib/injections/pagesData.d.ts

@@ -1,6 +0,0 @@
-import type { Ref } from 'vue';
-import type { PageData } from '@vuepress/shared';
-export declare type PagesData = Record<string, () => Promise<PageData>>;
-export declare type PagesDataRef = Ref<PagesData>;
-export declare const pagesData: PagesDataRef;
-export declare const usePagesData: () => PagesDataRef;

package/lib/injections/pagesData.js

@@ -1,16 +0,0 @@
-import { readonly, ref } from 'vue';
-import { pagesData as pagesDataRaw } from '@internal/pagesData';
-export const pagesData = ref(readonly(pagesDataRaw));
-export const usePagesData = () => {
-    return pagesData;
-};
-if (import.meta.webpackHot) {
-    import.meta.webpackHot.accept('@internal/pagesData', () => {
-        pagesData.value = readonly(pagesDataRaw);
-    });
-}
-if (import.meta.hot) {
-    import.meta.hot.accept('@internal/pagesData', () => {
-        pagesData.value = readonly(pagesDataRaw);
-    });
-}

package/lib/injections/routeLocale.d.ts

@@ -1,10 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-import type { SiteData } from '@vuepress/shared';
-export declare type RouteLocale = string;
-export declare type RouteLocaleRef = ComputedRef<RouteLocale>;
-export declare const routeLocaleSymbol: InjectionKey<RouteLocaleRef>;
-export declare const useRouteLocale: () => RouteLocaleRef;
-/**
- * Resolve locale path of the route path
- */
-export declare const resolveRouteLocale: (locales: SiteData['locales'], routePath: string) => RouteLocale;

package/lib/injections/routeLocale.js

@@ -1,14 +0,0 @@
-import { inject } from 'vue';
-import { resolveLocalePath } from '@vuepress/shared';
-export const routeLocaleSymbol = Symbol(__DEV__ ? 'routeLocale' : '');
-export const useRouteLocale = () => {
-    const routeLocale = inject(routeLocaleSymbol);
-    if (!routeLocale) {
-        throw new Error('useRouteLocale() is called without provider.');
-    }
-    return routeLocale;
-};
-/**
- * Resolve locale path of the route path
- */
-export const resolveRouteLocale = (locales, routePath) => resolveLocalePath(locales, routePath);

package/lib/injections/siteData.d.ts

@@ -1,6 +0,0 @@
-import type { Ref } from 'vue';
-import type { SiteData } from '@vuepress/shared';
-export type { SiteData };
-export declare type SiteDataRef = Ref<SiteData>;
-export declare const siteData: SiteDataRef;
-export declare const useSiteData: () => SiteDataRef;

package/lib/injections/siteData.js

@@ -1,14 +0,0 @@
-import { readonly, ref } from 'vue';
-import { siteData as siteDataRaw } from '@internal/siteData';
-export const siteData = ref(readonly(siteDataRaw));
-export const useSiteData = () => siteData;
-if (import.meta.webpackHot) {
-    import.meta.webpackHot.accept('@internal/siteData', () => {
-        siteData.value = readonly(siteDataRaw);
-    });
-}
-if (import.meta.hot) {
-    import.meta.hot.accept('@internal/siteData', () => {
-        siteData.value = readonly(siteDataRaw);
-    });
-}

package/lib/injections/siteLocaleData.d.ts

@@ -1,12 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-import type { SiteData } from '@vuepress/shared';
-import type { RouteLocale } from './routeLocale';
-export declare type SiteLocaleData = SiteData;
-export declare type SiteLocaleDataRef = ComputedRef<SiteLocaleData>;
-export declare const siteLocaleDataSymbol: InjectionKey<SiteLocaleDataRef>;
-export declare const useSiteLocaleData: () => SiteLocaleDataRef;
-/**
- * Merge the locales fields to the root fields
- * according to the route path
- */
-export declare const resolveSiteLocaleData: (site: SiteData, routeLocale: RouteLocale) => SiteLocaleData;

package/lib/injections/siteLocaleData.js

@@ -1,17 +0,0 @@
-import { inject } from 'vue';
-export const siteLocaleDataSymbol = Symbol(__DEV__ ? 'siteLocaleData' : '');
-export const useSiteLocaleData = () => {
-    const siteLocaleData = inject(siteLocaleDataSymbol);
-    if (!siteLocaleData) {
-        throw new Error('useSiteLocaleData() is called without provider.');
-    }
-    return siteLocaleData;
-};
-/**
- * Merge the locales fields to the root fields
- * according to the route path
- */
-export const resolveSiteLocaleData = (site, routeLocale) => ({
-    ...site,
-    ...site.locales[routeLocale],
-});

package/lib/injections/updateHead.d.ts

@@ -1,15 +0,0 @@
-import type { HeadConfig } from '@vuepress/shared';
-/**
- * Query the matched head tag of head config
- */
-export declare const queryHeadTag: ([tagName, attrs, content,]: HeadConfig) => HTMLElement | null;
-/**
- * Create head tag from head config
- */
-export declare const createHeadTag: ([tagName, attrs, content,]: HeadConfig) => HTMLElement | null;
-/**
- * Auto update head
- *
- * This composable function should be used only once in the root app
- */
-export declare const useUpdateHead: () => void;