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

package/lib/composables/pageHead.d.ts

@@ -1,18 +0,0 @@
-import type { HeadConfig } from '@vuepress/shared';
-import type { ComputedRef, InjectionKey } from 'vue';
-/**
- * Page head config, which would be used for generate html tags in `<head>`
- */
-export declare type PageHead = HeadConfig[];
-/**
- * Ref wrapper of `PageHead`
- */
-export declare type PageHeadRef = ComputedRef<PageHead>;
-/**
- * Injection key for page head
- */
-export declare const pageHeadSymbol: InjectionKey<PageHeadRef>;
-/**
- * Returns the ref of the head config of current page
- */
-export declare const usePageHead: () => PageHeadRef;

package/lib/composables/pageHead.js

@@ -1,15 +0,0 @@
-import { inject } from 'vue';
-/**
- * Injection key for page head
- */
-export const pageHeadSymbol = Symbol(__VUEPRESS_DEV__ ? 'pageHead' : '');
-/**
- * Returns the ref of the head config of current page
- */
-export const usePageHead = () => {
-    const pageHead = inject(pageHeadSymbol);
-    if (!pageHead) {
-        throw new Error('usePageHead() is called without provider.');
-    }
-    return pageHead;
-};

package/lib/composables/pageHeadTitle.d.ts

@@ -1,17 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-/**
- * Page head title, which would be used as the content of `head > title` tag
- */
-export declare type PageHeadTitle = string;
-/**
- * Ref wrapper of `PageHeadTitle`
- */
-export declare type PageHeadTitleRef = ComputedRef<PageHeadTitle>;
-/**
- * Injection key for page head title
- */
-export declare const pageHeadTitleSymbol: InjectionKey<PageHeadTitleRef>;
-/**
- * Returns the ref of the head title of current page
- */
-export declare const usePageHeadTitle: () => PageHeadTitleRef;

package/lib/composables/pageHeadTitle.js

@@ -1,15 +0,0 @@
-import { inject } from 'vue';
-/**
- * Injection key for page head title
- */
-export const pageHeadTitleSymbol = Symbol(__VUEPRESS_DEV__ ? 'pageHeadTitle' : '');
-/**
- * Returns the ref of the head title of current page
- */
-export const usePageHeadTitle = () => {
-    const pageHeadTitle = inject(pageHeadTitleSymbol);
-    if (!pageHeadTitle) {
-        throw new Error('usePageHeadTitle() is called without provider.');
-    }
-    return pageHeadTitle;
-};

package/lib/composables/pageLang.d.ts

@@ -1,17 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-/**
- * Page language
- */
-export declare type PageLang = string;
-/**
- * Ref wrapper of `PageLang`
- */
-export declare type PageLangRef = ComputedRef<PageLang>;
-/**
- * Injection key for page language
- */
-export declare const pageLangSymbol: InjectionKey<PageLangRef>;
-/**
- * Returns the ref of the language of current page
- */
-export declare const usePageLang: () => PageLangRef;

package/lib/composables/pageLang.js

@@ -1,15 +0,0 @@
-import { inject } from 'vue';
-/**
- * Injection key for page language
- */
-export const pageLangSymbol = Symbol(__VUEPRESS_DEV__ ? 'pageLang' : '');
-/**
- * Returns the ref of the language of current page
- */
-export const usePageLang = () => {
-    const pageLang = inject(pageLangSymbol);
-    if (!pageLang) {
-        throw new Error('usePageLang() is called without provider.');
-    }
-    return pageLang;
-};

package/lib/composables/pagesData.d.ts

@@ -1,21 +0,0 @@
-import type { PageData } from '@vuepress/shared';
-import type { Ref } from 'vue';
-/**
- * Data resolvers of all pages
- *
- * The key is page key, and the value is an async function that
- * returns the page data
- */
-export declare type PagesData = Record<string, (() => Promise<PageData>) | undefined>;
-/**
- * Ref wrapper of `PagesData`
- */
-export declare type PagesDataRef = Ref<PagesData>;
-/**
- * Global pages data ref
- */
-export declare const pagesData: PagesDataRef;
-/**
- * Returns the ref of data resolvers of all pages
- */
-export declare const usePagesData: () => PagesDataRef;

package/lib/composables/pagesData.js

@@ -1,10 +0,0 @@
-import { pagesData as pagesDataRaw } from '@internal/pagesData';
-import { ref } from 'vue';
-/**
- * Global pages data ref
- */
-export const pagesData = ref(pagesDataRaw);
-/**
- * Returns the ref of data resolvers of all pages
- */
-export const usePagesData = () => pagesData;

package/lib/composables/routeLocale.d.ts

@@ -1,17 +0,0 @@
-import type { ComputedRef, InjectionKey } from 'vue';
-/**
- * Route locale path
- */
-export declare type RouteLocale = string;
-/**
- * Ref wrapper of `RouteLocale`
- */
-export declare type RouteLocaleRef = ComputedRef<RouteLocale>;
-/**
- * Injection key for page route locale path
- */
-export declare const routeLocaleSymbol: InjectionKey<RouteLocaleRef>;
-/**
- * Returns the ref of the route locale path of current page
- */
-export declare const useRouteLocale: () => RouteLocaleRef;

package/lib/composables/routeLocale.js

@@ -1,15 +0,0 @@
-import { inject } from 'vue';
-/**
- * Injection key for page route locale path
- */
-export const routeLocaleSymbol = Symbol(__VUEPRESS_DEV__ ? 'routeLocale' : '');
-/**
- * Returns the ref of the route locale path of current page
- */
-export const useRouteLocale = () => {
-    const routeLocale = inject(routeLocaleSymbol);
-    if (!routeLocale) {
-        throw new Error('useRouteLocale() is called without provider.');
-    }
-    return routeLocale;
-};

package/lib/composables/siteData.d.ts

@@ -1,15 +0,0 @@
-import type { SiteData } from '@vuepress/shared';
-import type { Ref } from 'vue';
-export type { SiteData };
-/**
- * Ref wrapper of `SiteData`
- */
-export declare type SiteDataRef = Ref<SiteData>;
-/**
- * Global site data ref
- */
-export declare const siteData: SiteDataRef;
-/**
- * Returns the ref of the site data
- */
-export declare const useSiteData: () => SiteDataRef;

package/lib/composables/siteData.js

@@ -1,16 +0,0 @@
-import { siteData as siteDataRaw } from '@internal/siteData';
-import { ref } from 'vue';
-/**
- * Global site data ref
- */
-export const siteData = ref(siteDataRaw);
-/**
- * Returns the ref of the site data
- */
-export const useSiteData = () => siteData;
-if (import.meta.webpackHot || import.meta.hot) {
-    // reuse vue HMR runtime
-    __VUE_HMR_RUNTIME__.updateSiteData = (data) => {
-        siteData.value = data;
-    };
-}

package/lib/composables/siteLocaleData.d.ts

@@ -1,18 +0,0 @@
-import type { SiteData } from '@vuepress/shared';
-import type { ComputedRef, InjectionKey } from 'vue';
-/**
- * Site data of current locale
- */
-export declare type SiteLocaleData = SiteData;
-/**
- * Ref wrapper of `SiteLocaleData`
- */
-export declare type SiteLocaleDataRef = ComputedRef<SiteLocaleData>;
-/**
- * Injection key for site locale data
- */
-export declare const siteLocaleDataSymbol: InjectionKey<SiteLocaleDataRef>;
-/**
- * Returns the ref of the site data of current locale
- */
-export declare const useSiteLocaleData: () => SiteLocaleDataRef;

package/lib/composables/siteLocaleData.js

@@ -1,15 +0,0 @@
-import { inject } from 'vue';
-/**
- * Injection key for site locale data
- */
-export const siteLocaleDataSymbol = Symbol(__VUEPRESS_DEV__ ? 'siteLocaleData' : '');
-/**
- * Returns the ref of the site data of current locale
- */
-export const useSiteLocaleData = () => {
-    const siteLocaleData = inject(siteLocaleDataSymbol);
-    if (!siteLocaleData) {
-        throw new Error('useSiteLocaleData() is called without provider.');
-    }
-    return siteLocaleData;
-};

package/lib/composables/updateHead.d.ts

@@ -1,13 +0,0 @@
-import type { InjectionKey } from 'vue';
-/**
- * A util function to force update `<head>` of current page
- */
-export declare type UpdateHead = () => void;
-/**
- * Injection key for `updateHead` util
- */
-export declare const updateHeadSymbol: InjectionKey<UpdateHead>;
-/**
- * Returns the `updateHead` util
- */
-export declare const useUpdateHead: () => UpdateHead;

package/lib/composables/updateHead.js

@@ -1,15 +0,0 @@
-import { inject } from 'vue';
-/**
- * Injection key for `updateHead` util
- */
-export const updateHeadSymbol = Symbol(__VUEPRESS_DEV__ ? 'updateHead' : '');
-/**
- * Returns the `updateHead` util
- */
-export const useUpdateHead = () => {
-    const updateHead = inject(updateHeadSymbol);
-    if (!updateHead) {
-        throw new Error('useUpdateHead() is called without provider.');
-    }
-    return updateHead;
-};

package/lib/helpers/defineClientAppEnhance.d.ts

@@ -1,2 +0,0 @@
-import type { ClientAppEnhance } from '../types';
-export declare const defineClientAppEnhance: (clientAppEnhance: ClientAppEnhance) => ClientAppEnhance;

package/lib/helpers/defineClientAppEnhance.js

@@ -1 +0,0 @@
-export const defineClientAppEnhance = (clientAppEnhance) => clientAppEnhance;

package/lib/helpers/defineClientAppSetup.d.ts

@@ -1,2 +0,0 @@
-import type { ClientAppSetup } from '../types';
-export declare const defineClientAppSetup: (clientAppSetup: ClientAppSetup) => ClientAppSetup;

package/lib/helpers/defineClientAppSetup.js

@@ -1 +0,0 @@
-export const defineClientAppSetup = (clientAppSetup) => clientAppSetup;

package/lib/helpers/index.d.ts

@@ -1,3 +0,0 @@
-export * from './defineClientAppEnhance';
-export * from './defineClientAppSetup';
-export * from './withBase';

package/lib/helpers/index.js

@@ -1,3 +0,0 @@
-export * from './defineClientAppEnhance';
-export * from './defineClientAppSetup';
-export * from './withBase';

package/lib/helpers/withBase.d.ts

@@ -1,4 +0,0 @@
-/**
- * Prefix url with site base
- */
-export declare const withBase: (url: string) => string;

package/lib/helpers/withBase.js

@@ -1,11 +0,0 @@
-import { isLinkHttp, removeLeadingSlash } from '@vuepress/shared';
-import { useSiteData } from '../composables';
-/**
- * Prefix url with site base
- */
-export const withBase = (url) => {
-    if (isLinkHttp(url))
-        return url;
-    const base = useSiteData().value.base;
-    return `${base}${removeLeadingSlash(url)}`;
-};

package/lib/index.d.ts

@@ -1,8 +0,0 @@
-export type { PageHeader } from '@vuepress/shared';
-export { RouterLink, useRoute, useRouter } from 'vue-router';
-export * from './components';
-export * from './composables';
-export * from './helpers';
-export * from './types';
-export * from './app';
-export * from './resolvers';

package/lib/index.js

@@ -1,7 +0,0 @@
-export { RouterLink, useRoute, useRouter } from 'vue-router';
-export * from './components';
-export * from './composables';
-export * from './helpers';
-export * from './types';
-export * from './app';
-export * from './resolvers';

package/lib/resolvers.d.ts

@@ -1,15 +0,0 @@
-import type { PageData, PageFrontmatter, PageHead, PageHeadTitle, PageLang, RouteLocale, SiteData, SiteLocaleData } from './composables';
-/**
- * Resolver methods to get global computed
- *
- * Users can override corresponding method for advanced customization
- */
-export declare const resolvers: {
-    resolvePageData: (pageKey: string) => Promise<PageData>;
-    resolvePageFrontmatter: (pageData: PageData) => PageFrontmatter;
-    resolvePageHead: (headTitle: PageHeadTitle, frontmatter: PageFrontmatter, siteLocale: SiteLocaleData) => PageHead;
-    resolvePageHeadTitle: (page: PageData, siteLocale: SiteLocaleData) => PageHeadTitle;
-    resolvePageLang: (pageData: PageData) => PageLang;
-    resolveRouteLocale: (locales: SiteData['locales'], routePath: string) => RouteLocale;
-    resolveSiteLocaleData: (site: SiteData, routeLocale: RouteLocale) => SiteLocaleData;
-};

package/lib/resolvers.js

@@ -1,64 +0,0 @@
-import { dedupeHead, isArray, isString, resolveLocalePath, } from '@vuepress/shared';
-import { reactive } from 'vue';
-import { pageDataEmpty, pagesData } from './composables';
-/**
- * Resolver methods to get global computed
- *
- * Users can override corresponding method for advanced customization
- */
-export const resolvers = reactive({
-    /**
-     * Resolve page data according to page key
-     */
-    resolvePageData: async (pageKey) => {
-        const pageDataResolver = pagesData.value[pageKey];
-        const pageData = await (pageDataResolver === null || pageDataResolver === void 0 ? void 0 : pageDataResolver());
-        return pageData !== null && pageData !== void 0 ? pageData : pageDataEmpty;
-    },
-    /**
-     * Resolve page frontmatter from page data
-     */
-    resolvePageFrontmatter: (pageData) => pageData.frontmatter,
-    /**
-     * Merge the head config in frontmatter and site locale
-     *
-     * Frontmatter should take priority over site locale
-     */
-    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 }],
-        ];
-        return dedupeHead(head);
-    },
-    /**
-     * Resolve the content of page head title
-     *
-     * It would be used as the content of the `<title>` tag
-     */
-    resolvePageHeadTitle: (page, siteLocale) => `${page.title ? `${page.title} | ` : ``}${siteLocale.title}`,
-    /**
-     * Resolve page language from page data
-     *
-     * It would be used as the `lang` attribute of `<html>` tag
-     */
-    resolvePageLang: (pageData) => pageData.lang || 'en',
-    /**
-     * Resolve locale path according to route path and locales config
-     */
-    resolveRouteLocale: (locales, routePath) => resolveLocalePath(locales, routePath),
-    /**
-     * Resolve site data for specific locale
-     *
-     * It would merge the locales fields to the root fields
-     */
-    resolveSiteLocaleData: (site, routeLocale) => ({
-        ...site,
-        ...site.locales[routeLocale],
-    }),
-});

package/lib/router.d.ts

@@ -1,5 +0,0 @@
-import type { Router } from 'vue-router';
-/**
- * Create vue-router instance
- */
-export declare const createVueRouter: () => Router;

package/lib/router.js

@@ -1,40 +0,0 @@
-import { pagesComponents } from '@internal/pagesComponents';
-import { pagesRoutes } from '@internal/pagesRoutes';
-import { removeEndingSlash } from '@vuepress/shared';
-import { createMemoryHistory, createRouter, createWebHistory, START_LOCATION, } from 'vue-router';
-import { pageData, siteData } from './composables';
-import { resolvers } from './resolvers';
-/**
- * - use `createWebHistory` in dev mode and build mode client bundle
- * - use `createMemoryHistory` in build mode server bundle
- */
-const historyCreator = __VUEPRESS_SSR__ ? createMemoryHistory : createWebHistory;
-/**
- * Create vue-router instance
- */
-export const createVueRouter = () => {
-    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 };
-        },
-    });
-    router.beforeResolve(async (to, from) => {
-        var _a;
-        if (to.path !== from.path || from === START_LOCATION) {
-            // ensure page data and page component have been loaded
-            ;
-            [pageData.value] = await Promise.all([
-                resolvers.resolvePageData(to.name),
-                (_a = pagesComponents[to.name]) === null || _a === void 0 ? void 0 : _a.__asyncLoader(),
-            ]);
-        }
-    });
-    return router;
-};

package/lib/setupDevtools.d.ts

@@ -1,3 +0,0 @@
-import type { App } from 'vue';
-import type { GlobalComputed } from './setupGlobalComputed';
-export declare const setupDevtools: (app: App, globalComputed: GlobalComputed) => void;

package/lib/setupDevtools.js

@@ -1,22 +0,0 @@
-import { setupDevtoolsPlugin } from '@vue/devtools-api';
-export const setupDevtools = (app, globalComputed) => {
-    setupDevtoolsPlugin({
-        // fix recursive reference
-        app: app,
-        id: 'org.vuejs.vuepress',
-        label: 'VuePress',
-        packageName: '@vuepress/client',
-        homepage: 'https://v2.vuepress.vuejs.org',
-        logo: 'https://v2.vuepress.vuejs.org/images/hero.png',
-        componentStateTypes: ['VuePress'],
-    }, (api) => {
-        api.on.inspectComponent((payload) => {
-            payload.instanceData.state.push(...Object.entries(globalComputed).map(([name, item]) => ({
-                type: 'VuePress',
-                key: name,
-                editable: false,
-                value: item.value,
-            })));
-        });
-    });
-};

package/lib/setupGlobalComponents.d.ts

@@ -1,5 +0,0 @@
-import type { App } from 'vue';
-/**
- * Register global built-in components
- */
-export declare const setupGlobalComponents: (app: App) => void;

package/lib/setupGlobalComponents.js

@@ -1,10 +0,0 @@
-import { ClientOnly, Content } from './components';
-/**
- * Register global built-in components
- */
-export const setupGlobalComponents = (app) => {
-    /* eslint-disable vue/match-component-file-name */
-    app.component('ClientOnly', ClientOnly);
-    app.component('Content', Content);
-    /* eslint-enable vue/match-component-file-name */
-};

package/lib/setupGlobalComputed.d.ts

@@ -1,34 +0,0 @@
-import type { App } from 'vue';
-import type { Router } from 'vue-router';
-import type { PageData, PageDataRef, PageFrontmatter, PageFrontmatterRef, PageHead, PageHeadRef, PageHeadTitle, PageHeadTitleRef, PageLang, PageLangRef, RouteLocale, RouteLocaleRef, SiteData, SiteDataRef, SiteLocaleData, SiteLocaleDataRef } from './composables';
-import { withBase } from './helpers';
-/**
- * Vuepress client global computed
- */
-export interface GlobalComputed {
-    pageData: PageDataRef;
-    pageFrontmatter: PageFrontmatterRef;
-    pageHead: PageHeadRef;
-    pageHeadTitle: PageHeadTitleRef;
-    pageLang: PageLangRef;
-    routeLocale: RouteLocaleRef;
-    siteData: SiteDataRef;
-    siteLocaleData: SiteLocaleDataRef;
-}
-/**
- * Create and provide global computed
- */
-export declare const setupGlobalComputed: (app: App, router: Router) => GlobalComputed;
-declare module '@vue/runtime-core' {
-    interface ComponentCustomProperties {
-        $frontmatter: PageFrontmatter;
-        $head: PageHead;
-        $headTitle: PageHeadTitle;
-        $lang: PageLang;
-        $page: PageData;
-        $routeLocale: RouteLocale;
-        $site: SiteData;
-        $siteLocale: SiteLocaleData;
-        $withBase: typeof withBase;
-    }
-}

package/lib/setupGlobalComputed.js

@@ -1,45 +0,0 @@
-import { computed } from 'vue';
-import { pageData, pageFrontmatterSymbol, pageHeadSymbol, pageHeadTitleSymbol, pageLangSymbol, routeLocaleSymbol, siteData, siteLocaleDataSymbol, } from './composables';
-import { withBase } from './helpers';
-import { resolvers } from './resolvers';
-/**
- * Create and provide global computed
- */
-export const setupGlobalComputed = (app, router) => {
-    // create global computed
-    const routeLocale = computed(() => resolvers.resolveRouteLocale(siteData.value.locales, router.currentRoute.value.path));
-    const siteLocaleData = computed(() => resolvers.resolveSiteLocaleData(siteData.value, routeLocale.value));
-    const pageFrontmatter = computed(() => resolvers.resolvePageFrontmatter(pageData.value));
-    const pageHeadTitle = computed(() => resolvers.resolvePageHeadTitle(pageData.value, siteLocaleData.value));
-    const pageHead = computed(() => resolvers.resolvePageHead(pageHeadTitle.value, pageFrontmatter.value, siteLocaleData.value));
-    const pageLang = computed(() => resolvers.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 helpers
-    Object.defineProperties(app.config.globalProperties, {
-        $frontmatter: { get: () => pageFrontmatter.value },
-        $head: { get: () => pageHead.value },
-        $headTitle: { get: () => pageHeadTitle.value },
-        $lang: { get: () => pageLang.value },
-        $page: { get: () => pageData.value },
-        $routeLocale: { get: () => routeLocale.value },
-        $site: { get: () => siteData.value },
-        $siteLocale: { get: () => siteLocaleData.value },
-        $withBase: { get: () => withBase },
-    });
-    return {
-        pageData,
-        pageFrontmatter,
-        pageHead,
-        pageHeadTitle,
-        pageLang,
-        routeLocale,
-        siteData,
-        siteLocaleData,
-    };
-};

package/lib/setupUpdateHead.d.ts

@@ -1,13 +0,0 @@
-import type { HeadConfig } from '@vuepress/shared';
-/**
- * Auto update head and provide as global util
- */
-export declare const setupUpdateHead: () => void;
-/**
- * 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;