@vuepress/client 2.0.0-beta.9 → 2.0.0-rc.0

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,6 +0,0 @@
-import { ref } from 'vue';
-import { pagesData as pagesDataRaw } from '@internal/pagesData';
-export const pagesData = ref(pagesDataRaw);
-export const usePagesData = () => {
-    return pagesData;
-};

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,10 +0,0 @@
-import { ref } from 'vue';
-import { siteData as siteDataRaw } from '@internal/siteData';
-export const siteData = ref(siteDataRaw);
-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/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;

package/lib/injections/updateHead.js

@@ -1,100 +0,0 @@
-import { onMounted, ref, useSSRContext, watch } from 'vue';
-import { useRoute } from 'vue-router';
-import { isPlainObject, isString } from '@vuepress/shared';
-import { usePageHead } from './pageHead';
-import { usePageLang } from './pageLang';
-/**
- * Query the matched head tag of head config
- */
-export const queryHeadTag = ([tagName, attrs, content = '',]) => {
-    const attrsSelector = Object.entries(attrs).map(([key, value]) => {
-        if (isString(value)) {
-            return `[${key}="${value}"]`;
-        }
-        if (value === true) {
-            return `[${key}]`;
-        }
-        return '';
-    });
-    const selector = `head > ${tagName}${attrsSelector}`;
-    const tags = Array.from(document.querySelectorAll(selector));
-    const matchedTag = tags.find((item) => item.innerText === content);
-    return matchedTag || null;
-};
-/**
- * Create head tag from head config
- */
-export const createHeadTag = ([tagName, attrs, content,]) => {
-    if (!isString(tagName)) {
-        return null;
-    }
-    // create element
-    const tag = document.createElement(tagName);
-    // set attributes
-    if (isPlainObject(attrs)) {
-        Object.entries(attrs).forEach(([key, value]) => {
-            if (isString(value)) {
-                tag.setAttribute(key, value);
-            }
-            else if (value === true) {
-                tag.setAttribute(key, '');
-            }
-        });
-    }
-    // set content
-    if (isString(content)) {
-        tag.appendChild(document.createTextNode(content));
-    }
-    return tag;
-};
-/**
- * Auto update head
- *
- * This composable function should be used only once in the root app
- */
-export const useUpdateHead = () => {
-    const route = useRoute();
-    const head = usePageHead();
-    const lang = usePageLang();
-    // ssr-only, extract page meta info to ssrContext
-    if (__SSR__) {
-        const ssrContext = useSSRContext();
-        if (ssrContext) {
-            ssrContext.head = head.value;
-            ssrContext.lang = lang.value;
-        }
-        return;
-    }
-    const headTags = ref([]);
-    // load current head tags from DOM
-    const loadHead = () => {
-        head.value.forEach((item) => {
-            const tag = queryHeadTag(item);
-            if (tag) {
-                headTags.value.push(tag);
-            }
-        });
-    };
-    // update html lang attribute and head tags to DOM
-    const updateHead = () => {
-        document.documentElement.lang = lang.value;
-        headTags.value.forEach((item) => {
-            if (item.parentNode === document.head) {
-                document.head.removeChild(item);
-            }
-        });
-        headTags.value.splice(0, headTags.value.length);
-        head.value.forEach((item) => {
-            const tag = createHeadTag(item);
-            if (tag !== null) {
-                document.head.appendChild(tag);
-                headTags.value.push(tag);
-            }
-        });
-    };
-    onMounted(() => {
-        loadHead();
-        updateHead();
-        watch(() => route.path, () => updateHead());
-    });
-};

package/lib/server.d.ts

@@ -1,8 +0,0 @@
-import type { CreateVueAppResult } from './app';
-export interface ServerEntry {
-    createServerApp: () => Promise<CreateVueAppResult>;
-}
-/**
- * Server entry point, used for SSR
- */
-export declare const createServerApp: () => Promise<CreateVueAppResult>;

package/lib/server.js

@@ -1,10 +0,0 @@
-import { createSSRApp } from 'vue';
-import { createMemoryHistory } from 'vue-router';
-import { createVueApp } from './app';
-/**
- * Server entry point, used for SSR
- */
-export const createServerApp = async () => createVueApp({
-    appCreator: createSSRApp,
-    historyCreator: createMemoryHistory,
-});

package/lib/types/clientAppEnhance.d.ts

@@ -1,8 +0,0 @@
-import type { App } from 'vue';
-import type { Router } from 'vue-router';
-import type { SiteDataRef } from '../injections';
-export declare type ClientAppEnhance = (context: {
-    app: App;
-    router: Router;
-    siteData: SiteDataRef;
-}) => void | Promise<void>;

package/lib/types/clientAppEnhance.js

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

package/lib/types/clientAppSetup.d.ts

@@ -1 +0,0 @@
-export declare type ClientAppSetup = () => void;

package/lib/types/clientAppSetup.js

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

package/lib/types/index.d.ts

@@ -1,7 +0,0 @@
-export * from './clientAppEnhance';
-export * from './clientAppSetup';
-declare module 'vue-router' {
-    interface RouteMeta {
-        title?: string;
-    }
-}

package/lib/types/index.js

@@ -1,2 +0,0 @@
-export * from './clientAppEnhance';
-export * from './clientAppSetup';

package/lib/types/internal/clientAppEnhances.d.ts

@@ -1,5 +0,0 @@
-import type { ClientAppEnhance } from '../clientAppEnhance'
-
-declare module '@internal/clientAppEnhances' {
-  export const clientAppEnhances: ClientAppEnhance[]
-}

package/lib/types/internal/clientAppRootComponents.d.ts

@@ -1,5 +0,0 @@
-import type { ComponentOptions } from 'vue'
-
-declare module '@internal/clientAppRootComponents' {
-  export const clientAppRootComponents: ComponentOptions[]
-}

package/lib/types/internal/clientAppSetups.d.ts

@@ -1,5 +0,0 @@
-import type { ClientAppSetup } from '../clientAppSetup'
-
-declare module '@internal/clientAppSetups' {
-  export const clientAppSetups: ClientAppSetup[]
-}

package/lib/types/internal/layoutComponents.d.ts

@@ -1,5 +0,0 @@
-import type { AsyncComponentLoader } from 'vue'
-
-declare module '@internal/layoutComponents' {
-  export const layoutComponents: Record<string, AsyncComponentLoader>
-}

package/lib/types/internal/pagesComponent.d.ts

@@ -1,5 +0,0 @@
-import type { ComponentOptions } from 'vue'
-
-declare module '@internal/pagesComponent' {
-  export const pagesComponent: Record<string, ComponentOptions>
-}

package/lib/types/internal/pagesData.d.ts

@@ -1,5 +0,0 @@
-import type { PageData } from '@vuepress/shared'
-
-declare module '@internal/pagesData' {
-  export const pagesData: Record<string, () => Promise<PageData>>
-}

package/lib/types/internal/pagesRoutes.d.ts

@@ -1,5 +0,0 @@
-import type { RouteRecordRaw } from 'vue-router'
-
-declare module '@internal/pagesRoutes' {
-  export const pagesRoutes: RouteRecordRaw[]
-}

package/lib/types/internal/siteData.d.ts

@@ -1,5 +0,0 @@
-import type { SiteData } from '@vuepress/shared'
-
-declare module '@internal/siteData' {
-  export const siteData: SiteData
-}

package/lib/utils/defineClientAppEnhance.d.ts

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

package/lib/utils/defineClientAppEnhance.js

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

package/lib/utils/defineClientAppSetup.d.ts

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

package/lib/utils/defineClientAppSetup.js

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

package/lib/utils/index.d.ts

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

package/lib/utils/index.js

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

package/lib/utils/withBase.d.ts

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

package/lib/utils/withBase.js

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

package/templates/index.ssr.html

@@ -1,12 +0,0 @@
-<!DOCTYPE html>
-<html lang="{{ lang }}">
-  <head>
-    <!--vuepress-ssr-head-->
-    <!--vuepress-ssr-resources-->
-    <!--vuepress-ssr-styles-->
-  </head>
-  <body>
-    <div id="app"><!--vuepress-ssr-app--></div>
-    <!--vuepress-ssr-scripts-->
-  </body>
-</html>