@vuepress/client 2.0.0-rc.15 → 2.0.0-rc.17

package/README.md

@@ -5,7 +5,7 @@
 
 ## Documentation
 
-https://v2.vuepress.vuejs.org
+https://vuepress.vuejs.org
 
 ## License
 

package/dist/app.js

@@ -12,7 +12,7 @@ import {
   usePageLang,
   usePageLayout,
   withBase
-} from "./chunk-YRXAAVF4.js";
+} from "./chunk-LVRERRCW.js";
 
 // src/app.ts
 import { clientConfigs } from "@internal/clientConfigs";
@@ -31,10 +31,10 @@ if (__VUEPRESS_DEV__ && (import.meta.webpackHot || import.meta.hot)) {
 // src/router/createVueRouter.ts
 import { removeEndingSlash } from "@vuepress/shared";
 import {
+  START_LOCATION,
   createMemoryHistory,
   createRouter,
-  createWebHistory,
-  START_LOCATION
+  createWebHistory
 } from "vue-router";
 var historyCreator = __VUEPRESS_SSR__ ? createMemoryHistory : createWebHistory;
 var createVueRouter = () => {
@@ -99,7 +99,7 @@ var setupGlobalComputed = (app, router, clientConfigs2) => {
     __VUE_HMR_RUNTIME__.updatePageData = async (newPageData) => {
       const oldPageChunk = await routes.value[newPageData.path].loader();
       const newPageChunk = { comp: oldPageChunk.comp, data: newPageData };
-      routes.value[newPageData.path].loader = () => Promise.resolve(newPageChunk);
+      routes.value[newPageData.path].loader = async () => Promise.resolve(newPageChunk);
       if (newPageData.path === router.currentRoute.value.meta._pageChunk?.data.path) {
         pageChunk.value = newPageChunk;
       }
@@ -165,6 +165,52 @@ var setupGlobalComputed = (app, router, clientConfigs2) => {
 // src/setupUpdateHead.ts
 import { isPlainObject, isString } from "@vuepress/shared";
 import { onMounted, provide, useSSRContext, watch } from "vue";
+var queryHeadElement = ([
+  tagName,
+  attrs,
+  content = ""
+]) => {
+  const attrsSelector = Object.entries(attrs).map(([key, value]) => {
+    if (isString(value)) {
+      return `[${key}=${JSON.stringify(value)}]`;
+    }
+    if (value) {
+      return `[${key}]`;
+    }
+    return "";
+  }).join("");
+  const selector = `head > ${tagName}${attrsSelector}`;
+  const headElements = Array.from(
+    document.querySelectorAll(selector)
+  );
+  const matchedHeadElement = headElements.find(
+    (item) => item.innerText === content
+  );
+  return matchedHeadElement ?? null;
+};
+var createHeadElement = ([
+  tagName,
+  attrs,
+  content
+]) => {
+  if (!isString(tagName)) {
+    return null;
+  }
+  const headElement = document.createElement(tagName);
+  if (isPlainObject(attrs)) {
+    Object.entries(attrs).forEach(([key, value]) => {
+      if (isString(value)) {
+        headElement.setAttribute(key, value);
+      } else if (value) {
+        headElement.setAttribute(key, "");
+      }
+    });
+  }
+  if (isString(content)) {
+    headElement.appendChild(document.createTextNode(content));
+  }
+  return headElement;
+};
 var setupUpdateHead = () => {
   const head = usePageHead();
   const lang = usePageLang();
@@ -224,52 +270,6 @@ var setupUpdateHead = () => {
     watch(head, updateHead, { immediate: __VUEPRESS_DEV__ });
   });
 };
-var queryHeadElement = ([
-  tagName,
-  attrs,
-  content = ""
-]) => {
-  const attrsSelector = Object.entries(attrs).map(([key, value]) => {
-    if (isString(value)) {
-      return `[${key}=${JSON.stringify(value)}]`;
-    }
-    if (value === true) {
-      return `[${key}]`;
-    }
-    return "";
-  }).join("");
-  const selector = `head > ${tagName}${attrsSelector}`;
-  const headElements = Array.from(
-    document.querySelectorAll(selector)
-  );
-  const matchedHeadElement = headElements.find(
-    (item) => item.innerText === content
-  );
-  return matchedHeadElement || null;
-};
-var createHeadElement = ([
-  tagName,
-  attrs,
-  content
-]) => {
-  if (!isString(tagName)) {
-    return null;
-  }
-  const headElement = document.createElement(tagName);
-  if (isPlainObject(attrs)) {
-    Object.entries(attrs).forEach(([key, value]) => {
-      if (isString(value)) {
-        headElement.setAttribute(key, value);
-      } else if (value === true) {
-        headElement.setAttribute(key, "");
-      }
-    });
-  }
-  if (isString(content)) {
-    headElement.appendChild(document.createTextNode(content));
-  }
-  return headElement;
-};
 
 // src/app.ts
 var appCreator = __VUEPRESS_DEV__ ? createApp : createSSRApp;
@@ -281,18 +281,18 @@ var createVueApp = async () => {
       for (const clientConfig of clientConfigs) {
         clientConfig.setup?.();
       }
-      const rootComponents = clientConfigs.flatMap(
-        ({ rootComponents: rootComponents2 = [] }) => rootComponents2.map((component) => h(component))
+      const clientRootComponents = clientConfigs.flatMap(
+        ({ rootComponents = [] }) => rootComponents.map((component) => h(component))
       );
       const pageLayout = usePageLayout();
-      return () => [h(pageLayout.value), rootComponents];
+      return () => [h(pageLayout.value), clientRootComponents];
     }
   });
   const router = createVueRouter();
   setupGlobalComponents(app);
   const globalComputed = setupGlobalComputed(app, router, clientConfigs);
   if (__VUEPRESS_DEV__ || __VUE_PROD_DEVTOOLS__) {
-    const { setupDevtools } = await import("./setupDevtools-HHDGOOYC.js");
+    const { setupDevtools } = await import("./setupDevtools-7MC2TMWH.js");
     setupDevtools(app, globalComputed);
   }
   for (const clientConfig of clientConfigs) {
@@ -305,8 +305,8 @@ var createVueApp = async () => {
   };
 };
 if (!__VUEPRESS_SSR__) {
-  createVueApp().then(({ app, router }) => {
-    router.isReady().then(() => {
+  void createVueApp().then(({ app, router }) => {
+    void router.isReady().then(() => {
       app.mount("#app");
     });
   });

package/dist/{chunk-YRXAAVF4.js → chunk-LVRERRCW.js}

@@ -156,11 +156,11 @@ var RouteLink = defineComponent({
         href: path.value,
         onClick: (event = {}) => {
           if (guardEvent(event)) {
-            router.push(props.to).catch();
+            void router.push(props.to).catch();
           }
         }
       },
-      slots.default?.()
+      slots.default()
     );
   }
 });
@@ -219,7 +219,7 @@ var AutoLink = defineComponent2({
     });
     return () => {
       const { before, after, default: defaultSlot } = slots;
-      const content = defaultSlot?.(config.value) || [
+      const content = defaultSlot?.(config.value) ?? [
         before?.(config.value),
         config.value.text,
         after?.(config.value)
@@ -264,7 +264,6 @@ var ClientOnly = defineComponent3({
 // src/components/Content.ts
 import { computed as computed3, defineAsyncComponent, defineComponent as defineComponent4, h as h3 } from "vue";
 var Content = defineComponent4({
-  // eslint-disable-next-line vue/no-reserved-component-names
   name: "Content",
   props: {
     path: {
@@ -278,7 +277,9 @@ var Content = defineComponent4({
     const ContentComponent = computed3(() => {
       if (!props.path) return pageComponent.value;
       const route = resolveRoute(props.path);
-      return defineAsyncComponent(() => route.loader().then(({ comp }) => comp));
+      return defineAsyncComponent(
+        async () => route.loader().then(({ comp }) => comp)
+      );
     });
     return () => h3(ContentComponent.value);
   }
@@ -356,8 +357,9 @@ var resolvers = reactive({
     head: [
       // when merging head, the locales head should be placed before root head
       // to get higher priority
+      // eslint-disable-next-line @typescript-eslint/no-unnecessary-condition -- unsafe indexed access
       ...locales[routeLocale]?.head ?? [],
-      ...siteData.head ?? []
+      ...siteData.head
     ]
   })
 });

package/dist/index.d.ts

@@ -41,8 +41,8 @@ type RoutePath = string;
 type RouteLocale = string;
 type LayoutsRef = ComputedRef<Layouts>;
 type PageComponentRef = ComputedRef<PageComponent>;
-type PageDataRef<T extends Record<any, any> = Record<never, never>> = ComputedRef<PageData<T>>;
-type PageFrontmatterRef<T extends Record<any, any> = Record<never, never>> = ComputedRef<PageFrontmatter<T>>;
+type PageDataRef<T extends Record<string, unknown> = Record<string, unknown>> = ComputedRef<PageData<T>>;
+type PageFrontmatterRef<T extends Record<string, unknown> = Record<string, unknown>> = ComputedRef<PageFrontmatter<T>>;
 type PageHeadRef = ComputedRef<PageHead>;
 type PageHeadTitleRef = ComputedRef<PageHeadTitle>;
 type PageLangRef = ComputedRef<PageLang>;
@@ -82,7 +82,7 @@ interface ClientConfig {
         app: App;
         router: Router;
         siteData: SiteDataRef;
-    }) => void | Promise<void>;
+    }) => Promise<void> | void;
     /**
      * A function to be called inside the setup function of vue app
      */
@@ -101,7 +101,7 @@ interface AutoLinkConfig {
     /**
      * Pattern to determine if the link should be active, which has higher priority than `exact`
      */
-    activeMatch?: string | RegExp;
+    activeMatch?: RegExp | string;
     /**
      * The `aria-label` attribute
      */
@@ -133,51 +133,55 @@ interface AutoLinkConfig {
  * - If the link is internal, it will be rendered as a `<RouteLink>`
  * - If the link is external, it will be rendered as a normal `<a>` tag
  */
-declare const AutoLink: vue.DefineComponent<{
+declare const AutoLink: vue.DefineComponent<vue.ExtractPropTypes<{
     config: {
         type: PropType<AutoLinkConfig>;
         required: true;
     };
-}, () => VNode<vue.RendererNode, vue.RendererElement, {
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
-}>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
     config: {
         type: PropType<AutoLinkConfig>;
         required: true;
     };
-}>>, {}, SlotsType<{
-    default?: (config: AutoLinkConfig) => VNode[] | VNode;
-    before?: (config: AutoLinkConfig) => VNode[] | VNode | null;
-    after?: (config: AutoLinkConfig) => VNode[] | VNode | null;
-}>>;
+}>> & Readonly<{}>, {}, SlotsType<{
+    default?: (config: AutoLinkConfig) => VNode | VNode[];
+    before?: (config: AutoLinkConfig) => VNode | VNode[] | null;
+    after?: (config: AutoLinkConfig) => VNode | VNode[] | null;
+}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 /**
  * Wrapper component that only renders its content on the client side and skips server side rendering
+ *
+ * Since vue 3.5, you can try the new `data-allow-mismatch` attribute instead of `<ClientOnly>` component in some cases to avoid hydration mismatch.
+ *
+ * @see https://blog.vuejs.org/posts/vue-3-5#data-allow-mismatch
  */
 declare const ClientOnly: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
-}>[] | null | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{}>>, {}, {}>;
+}>[] | null | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 /**
  * Markdown rendered content
  */
-declare const Content: vue.DefineComponent<{
+declare const Content: vue.DefineComponent<vue.ExtractPropTypes<{
     path: {
         type: StringConstructor;
         required: false;
         default: string;
     };
-}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+}>, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
-}>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
     path: {
         type: StringConstructor;
         required: false;
         default: string;
     };
-}>>, {
+}>> & Readonly<{}>, {
     path: string;
-}, {}>;
+}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 interface RouteLinkProps {
     /**
@@ -206,7 +210,7 @@ interface RouteLinkProps {
  *
  * It's recommended to use `RouteLink` in VuePress.
  */
-declare const RouteLink: vue.DefineComponent<{
+declare const RouteLink: vue.DefineComponent<vue.ExtractPropTypes<{
     /**
      * The route path to link to
      */
@@ -227,9 +231,9 @@ declare const RouteLink: vue.DefineComponent<{
         type: StringConstructor;
         default: string;
     };
-}, () => VNode<vue.RendererNode, vue.RendererElement, {
+}>, () => VNode<vue.RendererNode, vue.RendererElement, {
     [key: string]: any;
-}>, unknown, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
+}>, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<vue.ExtractPropTypes<{
     /**
      * The route path to link to
      */
@@ -250,12 +254,12 @@ declare const RouteLink: vue.DefineComponent<{
         type: StringConstructor;
         default: string;
     };
-}>>, {
+}>> & Readonly<{}>, {
     active: boolean;
     activeClass: string;
 }, SlotsType<{
-    default: () => string | VNode | (string | VNode)[];
-}>>;
+    default: () => (VNode | string)[] | VNode | string;
+}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
 
 /**
  * Injection key for client data
@@ -268,8 +272,8 @@ declare const useClientData: () => ClientData;
 
 declare const useLayouts: () => LayoutsRef;
 declare const usePageComponent: () => PageComponentRef;
-declare const usePageData: <T extends Record<any, any> = Record<never, never>>() => PageDataRef<T>;
-declare const usePageFrontmatter: <T extends Record<any, any> = Record<string, unknown>>() => PageFrontmatterRef<T>;
+declare const usePageData: <T extends Record<string, unknown> = Record<string, unknown>>() => PageDataRef<T>;
+declare const usePageFrontmatter: <T extends Record<string, unknown> = Record<string, unknown>>() => PageFrontmatterRef<T>;
 declare const usePageHead: () => PageHeadRef;
 declare const usePageLang: () => PageLangRef;
 declare const usePageLayout: () => PageLayoutRef;

package/dist/index.js

@@ -28,7 +28,7 @@ import {
   useSiteLocaleData,
   useUpdateHead,
   withBase
-} from "./chunk-YRXAAVF4.js";
+} from "./chunk-LVRERRCW.js";
 export {
   AutoLink,
   ClientOnly,

package/dist/{setupDevtools-HHDGOOYC.js → setupDevtools-7MC2TMWH.js}

@@ -16,8 +16,8 @@ var setupDevtools = (app, clientData) => {
       id: PLUGIN_ID,
       label: PLUGIN_LABEL,
       packageName: "@vuepress/client",
-      homepage: "https://v2.vuepress.vuejs.org",
-      logo: "https://v2.vuepress.vuejs.org/images/hero.png",
+      homepage: "https://vuepress.vuejs.org",
+      logo: "https://vuepress.vuejs.org/images/hero.png",
       componentStateTypes: [PLUGIN_COMPONENT_STATE_TYPE]
     },
     (api) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/client",
-  "version": "2.0.0-rc.15",
+  "version": "2.0.0-rc.17",
   "description": "Client package of VuePress",
   "keywords": [
     "vuepress",
@@ -33,10 +33,10 @@
     "types.d.ts"
   ],
   "dependencies": {
-    "@vue/devtools-api": "^6.6.3",
-    "vue": "^3.4.37",
-    "vue-router": "^4.4.3",
-    "@vuepress/shared": "2.0.0-rc.15"
+    "@vue/devtools-api": "^7.4.6",
+    "vue": "^3.5.10",
+    "vue-router": "^4.4.5",
+    "@vuepress/shared": "2.0.0-rc.17"
   },
   "publishConfig": {
     "access": "public"

package/types.d.ts

@@ -1,7 +1,7 @@
+/* eslint-disable @typescript-eslint/naming-convention, no-underscore-dangle */
 declare const __VUEPRESS_VERSION__: string
 declare const __VUEPRESS_BASE__: string
 declare const __VUEPRESS_DEV__: boolean
 declare const __VUEPRESS_SSR__: boolean
-declare const __VUE_HMR_RUNTIME__: Record<string, any>
-declare const __VUE_OPTIONS_API__: boolean
+declare const __VUE_HMR_RUNTIME__: Record<string, unknown>
 declare const __VUE_PROD_DEVTOOLS__: boolean