@vuepress/client 2.0.0-beta.37 → 2.0.0-beta.40

package/dist/index.d.ts

@@ -0,0 +1,220 @@
+import { PageData, PageFrontmatter, HeadConfig, SiteData } from '@vuepress/shared';
+export { PageData, PageFrontmatter, PageHeader, SiteData } from '@vuepress/shared';
+import { Router } from 'vue-router';
+export { RouterLink, useRoute, useRouter } from 'vue-router';
+import * as vue from 'vue';
+import { Ref, ComputedRef, InjectionKey, App, FunctionalComponent } from 'vue';
+export { C as CreateVueAppFunction } from './createVueAppFunction-c8e67ca1.js';
+
+/**
+ * Ref wrapper of `PageData`
+ */
+declare type PageDataRef<T extends Record<any, any> = Record<never, never>> = Ref<PageData<T>>;
+/**
+ * Empty page data to be used as the fallback value
+ */
+declare const pageDataEmpty: PageData<Record<never, never>, Record<string, unknown>>;
+/**
+ * Global page data ref
+ */
+declare const pageData: PageDataRef;
+/**
+ * Returns the ref of the data of current page
+ */
+declare const usePageData: <T extends Record<any, any> = Record<never, never>>() => PageDataRef<T>;
+
+/**
+ * Ref wrapper of `PageFrontmatter`
+ */
+declare type PageFrontmatterRef<T extends Record<any, any> = Record<string, unknown>> = ComputedRef<PageFrontmatter<T>>;
+/**
+ * Injection key for page frontmatter
+ */
+declare const pageFrontmatterSymbol: InjectionKey<PageFrontmatterRef>;
+/**
+ * Returns the ref of the frontmatter of current page
+ */
+declare const usePageFrontmatter: <T extends Record<any, any> = Record<string, unknown>>() => PageFrontmatterRef<T>;
+
+/**
+ * Page head config, which would be used for generate html tags in `<head>`
+ */
+declare type PageHead = HeadConfig[];
+/**
+ * Ref wrapper of `PageHead`
+ */
+declare type PageHeadRef = ComputedRef<PageHead>;
+/**
+ * Injection key for page head
+ */
+declare const pageHeadSymbol: InjectionKey<PageHeadRef>;
+/**
+ * Returns the ref of the head config of current page
+ */
+declare const usePageHead: () => PageHeadRef;
+
+/**
+ * Page head title, which would be used as the content of `head > title` tag
+ */
+declare type PageHeadTitle = string;
+/**
+ * Ref wrapper of `PageHeadTitle`
+ */
+declare type PageHeadTitleRef = ComputedRef<PageHeadTitle>;
+/**
+ * Injection key for page head title
+ */
+declare const pageHeadTitleSymbol: InjectionKey<PageHeadTitleRef>;
+/**
+ * Returns the ref of the head title of current page
+ */
+declare const usePageHeadTitle: () => PageHeadTitleRef;
+
+/**
+ * Page language
+ */
+declare type PageLang = string;
+/**
+ * Ref wrapper of `PageLang`
+ */
+declare type PageLangRef = ComputedRef<PageLang>;
+/**
+ * Injection key for page language
+ */
+declare const pageLangSymbol: InjectionKey<PageLangRef>;
+/**
+ * Returns the ref of the language of current page
+ */
+declare const usePageLang: () => PageLangRef;
+
+/**
+ * Data resolvers of all pages
+ *
+ * The key is page key, and the value is an async function that
+ * returns the page data
+ */
+declare type PagesData = Record<string, (() => Promise<PageData>) | undefined>;
+/**
+ * Ref wrapper of `PagesData`
+ */
+declare type PagesDataRef = Ref<PagesData>;
+/**
+ * Global pages data ref
+ */
+declare const pagesData: PagesDataRef;
+/**
+ * Returns the ref of data resolvers of all pages
+ */
+declare const usePagesData: () => PagesDataRef;
+
+/**
+ * Route locale path
+ */
+declare type RouteLocale = string;
+/**
+ * Ref wrapper of `RouteLocale`
+ */
+declare type RouteLocaleRef = ComputedRef<RouteLocale>;
+/**
+ * Injection key for page route locale path
+ */
+declare const routeLocaleSymbol: InjectionKey<RouteLocaleRef>;
+/**
+ * Returns the ref of the route locale path of current page
+ */
+declare const useRouteLocale: () => RouteLocaleRef;
+
+/**
+ * Ref wrapper of `SiteData`
+ */
+declare type SiteDataRef = Ref<SiteData>;
+/**
+ * Global site data ref
+ */
+declare const siteData: SiteDataRef;
+/**
+ * Returns the ref of the site data
+ */
+declare const useSiteData: () => SiteDataRef;
+
+/**
+ * Site data of current locale
+ */
+declare type SiteLocaleData = SiteData;
+/**
+ * Ref wrapper of `SiteLocaleData`
+ */
+declare type SiteLocaleDataRef = ComputedRef<SiteLocaleData>;
+/**
+ * Injection key for site locale data
+ */
+declare const siteLocaleDataSymbol: InjectionKey<SiteLocaleDataRef>;
+/**
+ * Returns the ref of the site data of current locale
+ */
+declare const useSiteLocaleData: () => SiteLocaleDataRef;
+
+/**
+ * A util function to force update `<head>` of current page
+ */
+declare type UpdateHead = () => void;
+/**
+ * Injection key for `updateHead` util
+ */
+declare const updateHeadSymbol: InjectionKey<UpdateHead>;
+/**
+ * Returns the `updateHead` util
+ */
+declare const useUpdateHead: () => UpdateHead;
+
+declare type ClientAppEnhance = (context: {
+    app: App;
+    router: Router;
+    siteData: SiteDataRef;
+}) => void | Promise<void>;
+
+declare type ClientAppSetup = () => void;
+
+declare const ClientOnly: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>[] | null | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, vue.EmitsOptions, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{}>>, {}>;
+
+/**
+ * Markdown rendered content
+ */
+declare const Content: FunctionalComponent<{
+    pageKey?: string;
+}>;
+
+/**
+ * Global Layout
+ */
+declare const Vuepress: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, vue.EmitsOptions, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{}>>, {}>;
+
+declare const defineClientAppEnhance: (clientAppEnhance: ClientAppEnhance) => ClientAppEnhance;
+
+declare const defineClientAppSetup: (clientAppSetup: ClientAppSetup) => ClientAppSetup;
+
+/**
+ * Resolver methods to get global computed
+ *
+ * Users can override corresponding method for advanced customization
+ */
+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;
+};
+
+/**
+ * Prefix url with site base
+ */
+declare const withBase: (url: string) => string;
+
+export { ClientAppEnhance, ClientAppSetup, ClientOnly, Content, PageDataRef, PageFrontmatterRef, PageHead, PageHeadRef, PageHeadTitle, PageHeadTitleRef, PageLang, PageLangRef, PagesData, PagesDataRef, RouteLocale, RouteLocaleRef, SiteDataRef, SiteLocaleData, SiteLocaleDataRef, UpdateHead, Vuepress, defineClientAppEnhance, defineClientAppSetup, pageData, pageDataEmpty, pageFrontmatterSymbol, pageHeadSymbol, pageHeadTitleSymbol, pageLangSymbol, pagesData, resolvers, routeLocaleSymbol, siteData, siteLocaleDataSymbol, updateHeadSymbol, usePageData, usePageFrontmatter, usePageHead, usePageHeadTitle, usePageLang, usePagesData, useRouteLocale, useSiteData, useSiteLocaleData, useUpdateHead, withBase };

package/dist/index.js

@@ -0,0 +1,70 @@
+import {
+  ClientOnly,
+  Content,
+  Vuepress,
+  pageData,
+  pageDataEmpty,
+  pageFrontmatterSymbol,
+  pageHeadSymbol,
+  pageHeadTitleSymbol,
+  pageLangSymbol,
+  pagesData,
+  resolvers,
+  routeLocaleSymbol,
+  siteData,
+  siteLocaleDataSymbol,
+  updateHeadSymbol,
+  usePageData,
+  usePageFrontmatter,
+  usePageHead,
+  usePageHeadTitle,
+  usePageLang,
+  usePagesData,
+  useRouteLocale,
+  useSiteData,
+  useSiteLocaleData,
+  useUpdateHead,
+  withBase
+} from "./chunk-RTLFYRTT.js";
+
+// src/index.ts
+import { RouterLink, useRoute, useRouter } from "vue-router";
+
+// src/helpers/defineClientAppEnhance.ts
+var defineClientAppEnhance = (clientAppEnhance) => clientAppEnhance;
+
+// src/helpers/defineClientAppSetup.ts
+var defineClientAppSetup = (clientAppSetup) => clientAppSetup;
+export {
+  ClientOnly,
+  Content,
+  RouterLink,
+  Vuepress,
+  defineClientAppEnhance,
+  defineClientAppSetup,
+  pageData,
+  pageDataEmpty,
+  pageFrontmatterSymbol,
+  pageHeadSymbol,
+  pageHeadTitleSymbol,
+  pageLangSymbol,
+  pagesData,
+  resolvers,
+  routeLocaleSymbol,
+  siteData,
+  siteLocaleDataSymbol,
+  updateHeadSymbol,
+  usePageData,
+  usePageFrontmatter,
+  usePageHead,
+  usePageHeadTitle,
+  usePageLang,
+  usePagesData,
+  useRoute,
+  useRouteLocale,
+  useRouter,
+  useSiteData,
+  useSiteLocaleData,
+  useUpdateHead,
+  withBase
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/client",
-  "version": "2.0.0-beta.37",
+  "version": "2.0.0-beta.40",
   "description": "Client package of VuePress",
   "keywords": [
     "vuepress",
@@ -15,31 +15,62 @@
     "url": "git+https://github.com/vuepress/vuepress-next.git"
   },
   "license": "MIT",
-  "author": "Evan You",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "author": "meteorlxy",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./app": "./dist/app.js",
+    "./helpers": "./helpers/index.js",
+    "./package.json": "./package.json",
+    "./templates/*": "./templates/*",
+    "./types": "./types.d.ts"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
-    "lib",
+    "dist",
     "templates",
     "types.d.ts"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig.build.json",
-    "clean": "rimraf lib *.tsbuildinfo",
-    "copy": "cpx \"src/**/*.{d.ts,css}\" lib"
-  },
   "dependencies": {
     "@vue/devtools-api": "^6.1.4",
-    "@vuepress/shared": "2.0.0-beta.37",
-    "vue": "^3.2.31",
+    "@vuepress/shared": "2.0.0-beta.40",
+    "vue": "^3.2.33",
     "vue-router": "^4.0.14"
   },
-  "devDependencies": {
-    "@types/webpack-env": "^1.16.3",
-    "vite": "~2.8.6"
-  },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6600a8c1a293b948be977c348eb9907178bb3263"
-}
+  "tsup": {
+    "clean": true,
+    "dts": [
+      "src/index.ts"
+    ],
+    "entry": [
+      "src/app.ts",
+      "src/index.ts"
+    ],
+    "external": [
+      "@internal/clientAppEnhances",
+      "@internal/clientAppRootComponents",
+      "@internal/clientAppSetups",
+      "@internal/layoutComponents",
+      "@internal/pagesComponents",
+      "@internal/pagesData",
+      "@internal/pagesRoutes",
+      "@internal/siteData"
+    ],
+    "format": [
+      "esm"
+    ],
+    "outDir": "dist",
+    "sourcemap": false,
+    "target": "es2020",
+    "tsconfig": "tsconfig.dts.json"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist"
+  }
+}

package/lib/app.d.ts

@@ -1,7 +0,0 @@
-import type { App } from 'vue';
-import type { Router } from 'vue-router';
-export declare type CreateVueAppFunction = () => Promise<{
-    app: App;
-    router: Router;
-}>;
-export declare const createVueApp: CreateVueAppFunction;

package/lib/app.js

@@ -1,65 +0,0 @@
-import { clientAppEnhances } from '@internal/clientAppEnhances';
-import { clientAppRootComponents } from '@internal/clientAppRootComponents';
-import { clientAppSetups } from '@internal/clientAppSetups';
-import { createApp, createSSRApp, h } from 'vue';
-import { RouterView } from 'vue-router';
-import { siteData } from './composables';
-import { createVueRouter } from './router';
-import { setupDevtools } from './setupDevtools';
-import { setupGlobalComponents } from './setupGlobalComponents';
-import { setupGlobalComputed } from './setupGlobalComputed';
-import { setupUpdateHead } from './setupUpdateHead';
-/**
- * - use `createApp` in dev mode
- * - use `createSSRApp` in build mode
- */
-const appCreator = __VUEPRESS_DEV__ ? createApp : createSSRApp;
-export const createVueApp = async () => {
-    // create vue app
-    const app = appCreator({
-        name: 'VuepressApp',
-        setup() {
-            // auto update head
-            setupUpdateHead();
-            // invoke all clientAppSetups
-            for (const clientAppSetup of clientAppSetups) {
-                clientAppSetup();
-            }
-            return () => [
-                h(RouterView),
-                ...clientAppRootComponents.map((comp) => h(comp)),
-            ];
-        },
-    });
-    // create vue-router instance
-    const router = createVueRouter();
-    // global components and computed
-    setupGlobalComponents(app);
-    const globalComputed = setupGlobalComputed(app, router);
-    // setup devtools in dev mode
-    if (__VUEPRESS_DEV__ || __VUE_PROD_DEVTOOLS__) {
-        setupDevtools(app, globalComputed);
-    }
-    // invoke all clientAppEnhances
-    for (const clientAppEnhance of clientAppEnhances) {
-        await clientAppEnhance({ app, router, siteData });
-    }
-    // vue-router will start to initialize once it is installed
-    // via `app.use()`, but users might make some modifications
-    // to router in `clientAppEnhance`, so we install it after
-    // that. This can also avoid the `scrollBehavior` issue on
-    // initial navigation.
-    app.use(router);
-    return {
-        app,
-        router,
-    };
-};
-// mount app in client bundle
-if (!__VUEPRESS_SSR__) {
-    createVueApp().then(({ app, router }) => {
-        router.isReady().then(() => {
-            app.mount('#app');
-        });
-    });
-}

package/lib/components/ClientOnly.d.ts

@@ -1,3 +0,0 @@
-export declare const ClientOnly: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
-    [key: string]: any;
-}>[] | null | undefined, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;

package/lib/components/ClientOnly.js

@@ -1,10 +0,0 @@
-import { defineComponent, onMounted, ref } from 'vue';
-export const ClientOnly = defineComponent({
-    setup(_, ctx) {
-        const isMounted = ref(false);
-        onMounted(() => {
-            isMounted.value = true;
-        });
-        return () => { var _a, _b; return (isMounted.value ? (_b = (_a = ctx.slots).default) === null || _b === void 0 ? void 0 : _b.call(_a) : null); };
-    },
-});

package/lib/components/Content.d.ts

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

package/lib/components/Content.js

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

package/lib/components/Vuepress.d.ts

@@ -1,6 +0,0 @@
-/**
- * Global Layout
- */
-export declare const Vuepress: import("vue").DefineComponent<{}, () => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
-    [key: string]: any;
-}>, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;

package/lib/components/Vuepress.js

@@ -1,38 +0,0 @@
-import { layoutComponents } from '@internal/layoutComponents';
-import { isString } from '@vuepress/shared';
-import { computed, defineComponent, h, resolveComponent } from 'vue';
-import { usePageData } from '../composables';
-/**
- * Global Layout
- */
-export const Vuepress = defineComponent({
-    name: 'Vuepress',
-    setup() {
-        const page = usePageData();
-        // resolve layout component
-        const layoutComponent = computed(() => {
-            // resolve layout name of current page
-            let layoutName;
-            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 default layout
-                    layoutName = 'Layout';
-                }
-            }
-            else {
-                // if current page does not exist
-                // use 404 layout
-                layoutName = '404';
-            }
-            // use theme layout or fallback to custom layout
-            return layoutComponents[layoutName] || resolveComponent(layoutName, false);
-        });
-        return () => h(layoutComponent.value);
-    },
-});

package/lib/components/index.d.ts

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

package/lib/components/index.js

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

package/lib/composables/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/composables/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/composables/pageData.d.ts

@@ -1,19 +0,0 @@
-import type { PageData } from '@vuepress/shared';
-import type { Ref } from 'vue';
-export type { PageData };
-/**
- * Ref wrapper of `PageData`
- */
-export declare type PageDataRef<T extends Record<any, any> = Record<never, never>> = Ref<PageData<T>>;
-/**
- * Empty page data to be used as the fallback value
- */
-export declare const pageDataEmpty: PageData<Record<never, never>>;
-/**
- * Global page data ref
- */
-export declare const pageData: PageDataRef;
-/**
- * Returns the ref of the data of current page
- */
-export declare const usePageData: <T extends Record<any, any> = Record<never, never>>() => PageDataRef<T>;

package/lib/composables/pageData.js

@@ -1,31 +0,0 @@
-import { readonly, ref } from 'vue';
-import { pagesData } from './pagesData';
-/**
- * Empty page data to be used as the fallback value
- */
-export const pageDataEmpty = readonly({
-    key: '',
-    path: '',
-    title: '',
-    lang: '',
-    frontmatter: {},
-    excerpt: '',
-    headers: [],
-});
-/**
- * Global page data ref
- */
-export const pageData = ref(pageDataEmpty);
-/**
- * Returns the ref of the data of current page
- */
-export const usePageData = () => pageData;
-if (import.meta.webpackHot || import.meta.hot) {
-    // reuse vue HMR runtime
-    __VUE_HMR_RUNTIME__.updatePageData = (data) => {
-        pagesData.value[data.key] = () => Promise.resolve(data);
-        if (data.key === pageData.value.key) {
-            pageData.value = data;
-        }
-    };
-}

package/lib/composables/pageFrontmatter.d.ts

@@ -1,15 +0,0 @@
-import type { PageFrontmatter } from '@vuepress/shared';
-import type { ComputedRef, InjectionKey } from 'vue';
-export type { PageFrontmatter };
-/**
- * Ref wrapper of `PageFrontmatter`
- */
-export declare type PageFrontmatterRef<T extends Record<any, any> = Record<string, unknown>> = ComputedRef<PageFrontmatter<T>>;
-/**
- * Injection key for page frontmatter
- */
-export declare const pageFrontmatterSymbol: InjectionKey<PageFrontmatterRef>;
-/**
- * Returns the ref of the frontmatter of current page
- */
-export declare const usePageFrontmatter: <T extends Record<any, any> = Record<string, unknown>>() => PageFrontmatterRef<T>;

package/lib/composables/pageFrontmatter.js

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