@vuepress/client 2.0.0-beta.43 → 2.0.0-beta.44

package/dist/app.js

@@ -17,9 +17,7 @@ import {
 } from "./chunk-RTLFYRTT.js";
 
 // src/app.ts
-import { clientAppEnhances } from "@internal/clientAppEnhances";
-import { clientAppRootComponents } from "@internal/clientAppRootComponents";
-import { clientAppSetups } from "@internal/clientAppSetups";
+import { clientConfigs } from "@internal/clientConfigs";
 import { createApp, createSSRApp, h } from "vue";
 import { RouterView } from "vue-router";
 
@@ -223,12 +221,12 @@ var createVueApp = async () => {
     name: "VuepressApp",
     setup() {
       setupUpdateHead();
-      for (const clientAppSetup of clientAppSetups) {
-        clientAppSetup();
+      for (const clientConfig of clientConfigs) {
+        clientConfig.setup?.();
       }
       return () => [
         h(RouterView),
-        ...clientAppRootComponents.map((comp) => h(comp))
+        ...clientConfigs.flatMap(({ rootComponents = [] }) => rootComponents.map((component) => h(component)))
       ];
     }
   });
@@ -238,8 +236,8 @@ var createVueApp = async () => {
   if (__VUEPRESS_DEV__ || __VUE_PROD_DEVTOOLS__) {
     setupDevtools(app, globalComputed);
   }
-  for (const clientAppEnhance of clientAppEnhances) {
-    await clientAppEnhance({ app, router, siteData });
+  for (const clientConfig of clientConfigs) {
+    await clientConfig.enhance?.({ app, router, siteData });
   }
   app.use(router);
   return {

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { PageData, PageFrontmatter, HeadConfig, SiteData } from '@vuepress/shared';
 export { PageData, PageFrontmatter, PageHeader, SiteData } from '@vuepress/shared';
 import * as vue from 'vue';
-import { Ref, ComputedRef, InjectionKey, App, FunctionalComponent } from 'vue';
+import { Ref, ComputedRef, InjectionKey, App, ComponentOptions, FunctionalComponent } from 'vue';
 import { Router } from 'vue-router';
 export { C as CreateVueAppFunction } from './createVueAppFunction-c8e67ca1.js';
 
@@ -166,13 +166,28 @@ declare const updateHeadSymbol: InjectionKey<UpdateHead>;
  */
 declare const useUpdateHead: () => UpdateHead;
 
-declare type ClientAppEnhance = (context: {
-    app: App;
-    router: Router;
-    siteData: SiteDataRef;
-}) => void | Promise<void>;
-
-declare type ClientAppSetup = () => void;
+/**
+ * Configure vuepress client
+ */
+interface ClientConfig {
+    /**
+     * An enhance function to be called after vue app instance and
+     * vue-router instance has been created
+     */
+    enhance?: (context: {
+        app: App;
+        router: Router;
+        siteData: SiteDataRef;
+    }) => void | Promise<void>;
+    /**
+     * A function to be called inside the setup function of vue app
+     */
+    setup?: () => void;
+    /**
+     * Components to be placed directly into the root node of vue app
+     */
+    rootComponents?: ComponentOptions[];
+}
 
 declare const ClientOnly: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
@@ -192,9 +207,10 @@ declare const Vuepress: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode
     [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;
+/**
+ * A helper function to help you define vuepress client config file
+ */
+declare const defineClientConfig: (clientConfig: ClientConfig) => ClientConfig;
 
 /**
  * Resolver methods to get global computed
@@ -216,4 +232,4 @@ declare const resolvers: {
  */
 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 };
+export { ClientConfig, ClientOnly, Content, PageDataRef, PageFrontmatterRef, PageHead, PageHeadRef, PageHeadTitle, PageHeadTitleRef, PageLang, PageLangRef, PagesData, PagesDataRef, RouteLocale, RouteLocaleRef, SiteDataRef, SiteLocaleData, SiteLocaleDataRef, UpdateHead, Vuepress, defineClientConfig, 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

@@ -27,17 +27,13 @@ import {
   withBase
 } from "./chunk-RTLFYRTT.js";
 
-// src/helpers/defineClientAppEnhance.ts
-var defineClientAppEnhance = (clientAppEnhance) => clientAppEnhance;
-
-// src/helpers/defineClientAppSetup.ts
-var defineClientAppSetup = (clientAppSetup) => clientAppSetup;
+// src/helpers/defineClientConfig.ts
+var defineClientConfig = (clientConfig) => clientConfig;
 export {
   ClientOnly,
   Content,
   Vuepress,
-  defineClientAppEnhance,
-  defineClientAppSetup,
+  defineClientConfig,
   pageData,
   pageDataEmpty,
   pageFrontmatterSymbol,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/client",
-  "version": "2.0.0-beta.43",
+  "version": "2.0.0-beta.44",
   "description": "Client package of VuePress",
   "keywords": [
     "vuepress",
@@ -20,7 +20,6 @@
   "exports": {
     ".": "./dist/index.js",
     "./app": "./dist/app.js",
-    "./helpers": "./helpers/index.js",
     "./package.json": "./package.json",
     "./templates/*": "./templates/*",
     "./types": "./types.d.ts"
@@ -35,9 +34,9 @@
   ],
   "dependencies": {
     "@vue/devtools-api": "^6.1.4",
-    "@vuepress/shared": "2.0.0-beta.43",
+    "@vuepress/shared": "2.0.0-beta.44",
     "vue": "^3.2.33",
-    "vue-router": "^4.0.14"
+    "vue-router": "^4.0.15"
   },
   "publishConfig": {
     "access": "public"
@@ -52,9 +51,7 @@
       "src/index.ts"
     ],
     "external": [
-      "@internal/clientAppEnhances",
-      "@internal/clientAppRootComponents",
-      "@internal/clientAppSetups",
+      "@internal/clientConfigs",
       "@internal/layoutComponents",
       "@internal/pagesComponents",
       "@internal/pagesData",