@vuepress/client 2.0.0-rc.27 → 2.0.0-rc.29

package/dist/app.js

@@ -1,4 +1,4 @@
-import { D as usePageHead, O as usePageLang, R as clientDataSymbol, a as ClientOnly, d as resolveRoute, h as updateHeadSymbol, i as Content, k as usePageLayout, m as routes, p as redirects, r as resolvers, s as RouteLink, t as withBase } from "./utils-_b2e7bpk.js";
+import { D as usePageHead, O as usePageLang, R as clientDataSymbol, a as ClientOnly, d as resolveRoute, h as updateHeadSymbol, i as Content, k as usePageLayout, m as routes, p as redirects, r as resolvers, s as RouteLink, t as withBase } from "./utils-CIxUK0LM.js";
 import { clientConfigs } from "@internal/clientConfigs";
 import { computed, createApp, createSSRApp, customRef, h, onMounted, provide, shallowRef, useSSRContext, watch } from "vue";
 import { siteData } from "@internal/siteData";

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { A as SiteData, C as PageLayoutRef, D as RoutePath, E as RouteLocaleRef, F as Redirects, I as Route, L as RouteMeta, M as SiteLocaleData, N as SiteLocaleDataRef, O as RoutePathRef, P as PageChunk, R as Routes, S as PageLayout, T as RouteLocale, _ as PageHeadTitle, a as ClientData, b as PageLang, c as LayoutsRef, d as PageData, f as PageDataRef, g as PageHeadRef, h as PageHead, i as ClientConfig, j as SiteDataRef, k as RoutesRef, l as PageComponent, m as PageFrontmatterRef, n as ContentUpdatedReason, o as HeadConfig, p as PageFrontmatter, r as CreateVueAppFunction, s as Layouts, t as ContentUpdatedCallback, u as PageComponentRef, v as PageHeadTitleRef, w as RedirectsRef, x as PageLangRef, y as PageHeader } from "./index-CNztZIId.js";
-import * as vue from "vue";
+import * as _$vue from "vue";
 import { InjectionKey, PropType, SlotsType, VNode } from "vue";
 import { RouteLocationNormalizedLoaded, Router, useRoute, useRouter } from "vue-router";
 
@@ -40,14 +40,14 @@ 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<vue.ExtractPropTypes<{
+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;
-}>, {}, {}, {}, 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;
@@ -56,7 +56,7 @@ declare const AutoLink: vue.DefineComponent<vue.ExtractPropTypes<{
   default?: (config: AutoLinkConfig) => VNode | VNode[];
   before?: (config: AutoLinkConfig) => VNode | VNode[] | null;
   after?: (config: AutoLinkConfig) => VNode | VNode[] | null;
-}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+}>, {}, {}, string, _$vue.ComponentProvideOptions, true, {}, any>;
 //#endregion
 //#region src/components/ClientOnly.d.ts
 /**
@@ -66,23 +66,23 @@ declare const AutoLink: vue.DefineComponent<vue.ExtractPropTypes<{
  *
  * @see https://blog.vuejs.org/posts/vue-3-5#data-allow-mismatch
  */
-declare const ClientOnly: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+declare const ClientOnly: _$vue.DefineComponent<{}, () => _$vue.VNode<_$vue.RendererNode, _$vue.RendererElement, {
   [key: string]: any;
-}>[] | null | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, {}, string, vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+}>[] | null | undefined, {}, {}, {}, _$vue.ComponentOptionsMixin, _$vue.ComponentOptionsMixin, {}, string, _$vue.PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, _$vue.ComponentProvideOptions, true, {}, any>;
 //#endregion
 //#region src/components/Content.d.ts
 /**
  * Markdown rendered content
  */
-declare const Content: vue.DefineComponent<vue.ExtractPropTypes<{
+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;
-}>, {}, {}, {}, 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;
@@ -90,7 +90,7 @@ declare const Content: vue.DefineComponent<vue.ExtractPropTypes<{
   };
 }>> & Readonly<{}>, {
   path: string;
-}, {}, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+}, {}, {}, {}, string, _$vue.ComponentProvideOptions, true, {}, any>;
 //#endregion
 //#region src/components/RouteLink.d.ts
 interface RouteLinkProps {
@@ -120,7 +120,7 @@ interface RouteLinkProps {
  *
  * It's recommended to use `RouteLink` in VuePress.
  */
-declare const RouteLink: vue.DefineComponent<vue.ExtractPropTypes<{
+declare const RouteLink: _$vue.DefineComponent<_$vue.ExtractPropTypes<{
   /**
    * The route path to link to
    */
@@ -141,9 +141,9 @@ declare const RouteLink: vue.DefineComponent<vue.ExtractPropTypes<{
     type: StringConstructor;
     default: string;
   };
-}>, () => VNode<vue.RendererNode, vue.RendererElement, {
+}>, () => VNode<_$vue.RendererNode, _$vue.RendererElement, {
   [key: string]: any;
-}>, {}, {}, {}, 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
    */
@@ -169,7 +169,7 @@ declare const RouteLink: vue.DefineComponent<vue.ExtractPropTypes<{
   activeClass: string;
 }, SlotsType<{
   default: () => (VNode | string)[] | VNode | string;
-}>, {}, {}, string, vue.ComponentProvideOptions, true, {}, any>;
+}>, {}, {}, string, _$vue.ComponentProvideOptions, true, {}, any>;
 //#endregion
 //#region src/composables/clientData.d.ts
 /**

package/dist/index.js

@@ -1,3 +1,3 @@
-import { A as useRedirects, C as usePage, D as usePageHead, E as usePageFrontmatter, F as useSiteData, I as useSiteLocale, L as useSiteLocaleData, M as useRoutePath, N as useRoutes, O as usePageLang, P as useSite, R as clientDataSymbol, S as useLayouts, T as usePageData, _ as onContentUpdated, a as ClientOnly, b as useHead, c as useRoute, d as resolveRoute, f as resolveRoutePath, g as useUpdateHead, h as updateHeadSymbol, i as Content, j as useRouteLocale, k as usePageLayout, l as useRouter, n as defineClientConfig, o as AutoLink, r as resolvers, s as RouteLink, t as withBase, u as resolveRouteFullPath, v as useData, w as usePageComponent, x as useLang, y as useFrontmatter, z as useClientData } from "./utils-_b2e7bpk.js";
+import { A as useRedirects, C as usePage, D as usePageHead, E as usePageFrontmatter, F as useSiteData, I as useSiteLocale, L as useSiteLocaleData, M as useRoutePath, N as useRoutes, O as usePageLang, P as useSite, R as clientDataSymbol, S as useLayouts, T as usePageData, _ as onContentUpdated, a as ClientOnly, b as useHead, c as useRoute, d as resolveRoute, f as resolveRoutePath, g as useUpdateHead, h as updateHeadSymbol, i as Content, j as useRouteLocale, k as usePageLayout, l as useRouter, n as defineClientConfig, o as AutoLink, r as resolvers, s as RouteLink, t as withBase, u as resolveRouteFullPath, v as useData, w as usePageComponent, x as useLang, y as useFrontmatter, z as useClientData } from "./utils-CIxUK0LM.js";
 import { c as constants_exports } from "./constants-COBTj3zj.js";
 export { AutoLink, ClientOnly, Content, constants_exports as DEVTOOLS, RouteLink, clientDataSymbol, defineClientConfig, onContentUpdated, resolveRoute, resolveRouteFullPath, resolveRoutePath, resolvers, updateHeadSymbol, useClientData, useData, useFrontmatter, useHead, useLang, useLayouts, usePage, usePageComponent, usePageData, usePageFrontmatter, usePageHead, usePageLang, usePageLayout, useRedirects, useRoute, useRouteLocale, useRoutePath, useRouter, useRoutes, useSite, useSiteData, useSiteLocale, useSiteLocaleData, useUpdateHead, withBase };

package/dist/{utils-_b2e7bpk.js → utils-CIxUK0LM.js}

@@ -155,11 +155,22 @@ const guardEvent = (event) => {
 const RouteLink = defineComponent({
 	name: "RouteLink",
 	props: {
+		/**
+		* The route path to link to
+		*/
 		to: {
 			type: String,
 			required: true
 		},
+		/**
+		* Whether the link is active to have an active class
+		*
+		* Notice that the active status is not automatically determined according to the current route.
+		*/
 		active: Boolean,
+		/**
+		* The class to add when the link is active
+		*/
 		activeClass: {
 			type: String,
 			default: "route-link-active"
@@ -312,10 +323,18 @@ const LAYOUT_NAME_DEFAULT = "Layout";
 * @experimental - This is an experimental API and may be changed in minor versions
 */
 const resolvers = reactive({
+	/**
+	* Resolve layouts component map
+	*/
 	resolveLayouts: (clientConfigs) => clientConfigs.reduce((prev, item) => ({
 		...prev,
 		...item.layouts
 	}), {}),
+	/**
+	* Merge the head config in frontmatter and site locale
+	*
+	* Frontmatter should take priority over site locale
+	*/
 	resolvePageHead: (pageHeadTitle, pageFrontmatter, siteLocaleDate) => {
 		const description = isString(pageFrontmatter.description) ? pageFrontmatter.description : siteLocaleDate.description;
 		return dedupeHead([
@@ -332,14 +351,35 @@ const resolvers = reactive({
 			}]
 		]);
 	},
+	/**
+	* Resolve the content of page head title
+	*
+	* It would be used as the content of the `<title>` tag
+	*/
 	resolvePageHeadTitle: (pageData, siteLocaleDate) => [pageData.title, siteLocaleDate.title].filter((item) => !!item).join(" | "),
+	/**
+	* Resolve page language from page data
+	*
+	* It would be used as the `lang` attribute of `<html>` tag
+	*/
 	resolvePageLang: (pageData, siteLocaleData) => pageData.lang || siteLocaleData.lang || "en-US",
+	/**
+	* Resolve layout component of current page
+	*/
 	resolvePageLayout: (pageData, layouts) => {
 		const layoutName = isString(pageData.frontmatter.layout) ? pageData.frontmatter.layout : LAYOUT_NAME_DEFAULT;
 		if (!layouts[layoutName]) throw new Error(`[vuepress] Cannot resolve layout: ${layoutName}`);
 		return layouts[layoutName];
 	},
+	/**
+	* Resolve locale path according to route path and locales config
+	*/
 	resolveRouteLocale: (locales, routePath) => resolveLocalePath(locales, decodeURI(routePath)),
+	/**
+	* Resolve site data for specific locale
+	*
+	* It would merge the locales fields to the root fields
+	*/
 	resolveSiteLocaleData: ({ base, locales, ...siteData }, routeLocale) => ({
 		...siteData,
 		...locales[routeLocale],

package/package.json

@@ -1,22 +1,30 @@
 {
   "name": "@vuepress/client",
-  "version": "2.0.0-rc.27",
+  "version": "2.0.0-rc.29",
   "description": "Client package of VuePress",
   "keywords": [
-    "vuepress",
-    "client"
+    "client",
+    "vuepress"
   ],
   "homepage": "https://github.com/vuepress",
   "bugs": {
     "url": "https://github.com/vuepress/core/issues"
   },
+  "license": "MIT",
+  "author": "meteorlxy",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/vuepress/core.git"
   },
-  "license": "MIT",
-  "author": "meteorlxy",
+  "files": [
+    "dist",
+    "templates",
+    "types.d.ts"
+  ],
   "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": "./dist/index.js",
     "./app": "./dist/app.js",
@@ -24,24 +32,16 @@
     "./templates/*": "./templates/*",
     "./types": "./types.d.ts"
   },
-  "main": "./dist/index.js",
-  "module": "./dist/index.js",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "dist",
-    "templates",
-    "types.d.ts"
-  ],
-  "dependencies": {
-    "@vue/devtools-api": "^8.0.7",
-    "@vue/devtools-kit": "^8.0.7",
-    "vue": "^3.5.29",
-    "vue-router": "^5.0.3",
-    "@vuepress/shared": "2.0.0-rc.27"
-  },
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "@vue/devtools-api": "^8.1.1",
+    "@vue/devtools-kit": "^8.1.1",
+    "vue": "^3.5.34",
+    "vue-router": "^5.0.6",
+    "@vuepress/shared": "2.0.0-rc.29"
+  },
   "tsdown": {
     "deps": {
       "neverBundle": [
@@ -55,10 +55,10 @@
       "./src/app.ts",
       "./src/index.ts"
     ],
+    "fixedExtension": false,
     "format": "esm",
     "outDir": "./dist",
     "target": "es2023",
-    "fixedExtension": false,
     "tsconfig": "./tsconfig.dts.json"
   },
   "scripts": {