@vuepress/core 2.0.0-rc.30 → 2.0.0-rc.31

package/dist/index.d.ts

@@ -1,7 +1,11 @@
 import { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageBase, PageData, PageData as PageData$1, PageFrontmatter, PageFrontmatter as PageFrontmatter$1, PageHeader, PageHeader as PageHeader$1, SiteData, SiteData as SiteData$1, SiteLocaleConfig } from "@vuepress/shared";
 import { TemplateRenderer } from "@vuepress/utils";
 import { Markdown, MarkdownLink, MarkdownOptions, MarkdownSfcBlocks } from "@vuepress/markdown";
-
+//#region src/types/helpers.d.ts
+type DeepPartialArray<T> = DeepPartial<T>[];
+type DeepPartialObject<T> = { [P in keyof T]?: DeepPartial<T[P]>; };
+type DeepPartial<T> = T extends Function ? T : T extends (infer U)[] ? DeepPartialArray<U> : T extends object ? DeepPartialObject<T> : T | undefined;
+//#endregion
 //#region src/types/bundler.d.ts
 /**
  * Vuepress bundler
@@ -15,6 +19,10 @@ interface Bundler {
    * Name of the bundler
    */
   name: string;
+  /**
+   * Type of the bundler, e.g. 'vite' or 'webpack'
+   */
+  type: string;
   /**
    * Method to run vuepress app in dev mode, starting dev server
    */
@@ -23,6 +31,10 @@ interface Bundler {
    * Method to run vuepress app in build mode, generating static pages and assets
    */
   build: (app: App) => Promise<void>;
+  /**
+   * Merge config helper for current bundler.
+   */
+  mergeConfig: <Config extends Record<string, unknown> = Record<string, unknown>>(currentConfig: Config, newConfig: DeepPartial<Config>) => Config;
 }
 type BundlerOptions = Record<string, unknown>;
 //#endregion
@@ -166,7 +178,7 @@ type PromiseOrNot<T> = Promise<T> | T;
 interface Closable {
   close(): void;
 }
-interface Hook<Exposed, Normalized = Exposed, Result = (Normalized extends ((...args: any) => infer U) ? U extends Promise<infer V> ? V : U : never)> {
+interface Hook<Exposed, Normalized = Exposed, Result = Normalized extends ((...args: any) => infer U) ? U extends Promise<infer V> ? V : U : never> {
   exposed: Exposed;
   normalized: Normalized;
   result: Result;
@@ -201,15 +213,15 @@ type HooksName = keyof Hooks;
 /**
  * Exposed hooks API that can be accessed by a plugin
  */
-type HooksExposed = { [K in HooksName]: Hooks[K]['exposed'] };
+type HooksExposed = { [K in HooksName]: Hooks[K]['exposed']; };
 /**
  * Normalized hooks
  */
-type HooksNormalized = { [K in HooksName]: Hooks[K]['normalized'] };
+type HooksNormalized = { [K in HooksName]: Hooks[K]['normalized']; };
 /**
  * Result of hooks
  */
-type HooksResult = { [K in HooksName]: Hooks[K]['result'] };
+type HooksResult = { [K in HooksName]: Hooks[K]['result']; };
 /**
  * Hook item
  */
@@ -239,7 +251,7 @@ interface PluginApi {
   /**
    * All available hooks
    */
-  hooks: { [K in HooksName]: HookQueue<K> };
+  hooks: { [K in HooksName]: HookQueue<K>; };
   /**
    * Register hooks of plugins
    *
@@ -479,19 +491,29 @@ interface AppConfigDev {
  */
 interface AppConfigBuild {
   /**
-   * Determine what resource files should be preloaded. Use boolean value to
-   * totally enable / disable.
+   * Determine what resource files should be preloaded.
+   *
+   * - `false` disables preloading.
+   * - `true` preloads script and style resource files used by the current page.
+   * - A function preloads a candidate file when it returns `true`. It receives
+   *   the output file name and inferred resource type.
    *
    * @default true
    */
   shouldPreload?: boolean | ((file: string, type: string) => boolean);
   /**
-   * Determine what resource files should be prefetched. Use boolean value to
-   * totally enable / disable.
+   * Determine what resource files should be prefetched.
    *
-   * @default true
+   * - `false` disables prefetching.
+   * - `true` prefetches all async resource files not used by the current page.
+   * - `'as-needed'` prefetches async resource files only for pages linked from
+   *   the current page's Markdown content.
+   * - A function prefetches a candidate file when it returns `true`. It receives
+   *   the output file name and inferred resource type.
+   *
+   * @default 'as-needed'
    */
-  shouldPrefetch?: boolean | ((file: string, type: string) => boolean);
+  shouldPrefetch?: boolean | 'as-needed' | ((file: string, type: string) => boolean);
   /**
    * Specify the path of the HTML template to be used for build
    *
@@ -733,4 +755,4 @@ declare const renderPageToVue: (app: App, page: Page) => string;
 //#region src/constants.d.ts
 declare const DEFAULT_IGNORE_PATTERNS: string[];
 //#endregion
-export { AliasHook, App, AppConfig, AppConfigBuild, AppConfigCommon, AppConfigDev, AppDir, AppDirFunction, AppEnv, AppOptions, AppPropertiesBase, AppPropertiesInitialized, AppWriteTemp, BuildApp, Bundler, BundlerOptions, ClientConfigFileHook, DEFAULT_IGNORE_PATTERNS, DefineHook, DevApp, ExtendsHook, type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, Hook, HookItem, HookQueue, Hooks, HooksExposed, HooksName, HooksNormalized, HooksResult, LifeCycleHook, type LocaleConfig, type LocaleData, Page, type PageData, type PageFrontmatter, type PageHeader, PageOptions, Plugin, PluginApi, PluginConfig, PluginFunction, PluginObject, type SiteData, type SiteLocaleConfig, Theme, ThemeFunction, ThemeInfo, ThemeObject, createBuildApp, createDevApp, createPage, preparePageChunk, prepareRoutes, renderPageToVue, resolveAppDir };
+export { type AliasHook, type App, type AppConfig, type AppConfigBuild, type AppConfigCommon, type AppConfigDev, type AppDir, type AppDirFunction, type AppEnv, type AppOptions, type AppPropertiesBase, type AppPropertiesInitialized, type AppWriteTemp, type BuildApp, type Bundler, type BundlerOptions, type ClientConfigFileHook, DEFAULT_IGNORE_PATTERNS, type DefineHook, type DevApp, type ExtendsHook, type HeadAttrsConfig, type HeadConfig, type HeadTag, type HeadTagEmpty, type HeadTagNonEmpty, type Hook, type HookItem, type HookQueue, type Hooks, type HooksExposed, type HooksName, type HooksNormalized, type HooksResult, type LifeCycleHook, type LocaleConfig, type LocaleData, type Page, type PageData, type PageFrontmatter, type PageHeader, type PageOptions, type Plugin, type PluginApi, type PluginConfig, type PluginFunction, type PluginObject, type SiteData, type SiteLocaleConfig, type Theme, type ThemeFunction, type ThemeInfo, type ThemeObject, createBuildApp, createDevApp, createPage, preparePageChunk, prepareRoutes, renderPageToVue, resolveAppDir };

package/dist/index.js

@@ -524,6 +524,10 @@ const prepareUserStyle = async (app, fileExists = null) => {
 */
 const resolveAppMarkdown = async (app) => {
 	await app.pluginApi.hooks.extendsMarkdownOptions.process(app.options.markdown, app);
+	if (app.options.markdown.assets !== false) {
+		app.options.markdown.assets ??= {};
+		app.options.markdown.assets.absolutePathPrependBase ??= app.options.bundler.type === "webpack";
+	}
 	const markdown = createMarkdown(app.options.markdown);
 	await app.pluginApi.hooks.extendsMarkdown.process(markdown, app);
 	return markdown;
@@ -826,7 +830,7 @@ const require$1 = createRequire(import.meta.url);
 *
 * @internal
 */
-const resolveAppOptions = ({ base = "/", lang = "en-US", title = "", description = "", head = [], locales = {}, source, dest = path.resolve(source, ".vuepress/dist"), temp = path.resolve(source, ".vuepress/.temp"), cache = path.resolve(source, ".vuepress/.cache"), public: publicDir = path.resolve(source, ".vuepress/public"), host = "0.0.0.0", port = 8080, open = false, templateDev = path.normalize(require$1.resolve("@vuepress/client/templates/dev.html")), shouldPreload = true, shouldPrefetch = true, templateBuild = path.normalize(require$1.resolve("@vuepress/client/templates/build.html")), templateBuildRenderer = templateRenderer, bundler, debug = false, markdown = {}, pagePatterns = ["**/*.md", "!.vuepress"], permalinkPattern = null, userStyle = null, plugins = [], theme }) => {
+const resolveAppOptions = ({ base = "/", lang = "en-US", title = "", description = "", head = [], locales = {}, source, dest = path.resolve(source, ".vuepress/dist"), temp = path.resolve(source, ".vuepress/.temp"), cache = path.resolve(source, ".vuepress/.cache"), public: publicDir = path.resolve(source, ".vuepress/public"), host = "0.0.0.0", port = 8080, open = false, templateDev = path.normalize(require$1.resolve("@vuepress/client/templates/dev.html")), shouldPreload = true, shouldPrefetch = "as-needed", templateBuild = path.normalize(require$1.resolve("@vuepress/client/templates/build.html")), templateBuildRenderer = templateRenderer, bundler, debug = false, markdown = {}, pagePatterns = ["**/*.md", "!.vuepress"], permalinkPattern = null, userStyle = null, plugins = [], theme }) => {
 	locales["/"] ??= {
 		lang,
 		title,
@@ -1020,4 +1024,4 @@ const createDevApp = (config) => {
 	return app;
 };
 //#endregion
-export { DEFAULT_IGNORE_PATTERNS, appInit, appPrepare, appUse, createAppDirFunction, createBaseApp, createBuildApp, createDevApp, createHookQueue, createPage, createPluginApi, createPluginApiHooks, createPluginApiRegisterHooks, inferPagePath, normalizeAliasDefineHook, normalizeClientConfigFileHook, parsePageContent, prepareClientConfigs, preparePageChunk, prepareRoutes, prepareSiteData, prepareUserStyle, renderPageToVue, resolveAppDir, resolveAppEnv, resolveAppOptions, resolveAppPages, resolveAppSiteData, resolveAppVersion, resolveAppWriteTemp, resolvePageChunkInfo, resolvePageContent, resolvePageDate, resolvePageFilePath, resolvePageHtmlInfo, resolvePageLang, resolvePagePath, resolvePagePermalink, resolvePageRouteMeta, resolvePageSlug, resolvePluginObject, resolveThemeInfo };
+export { DEFAULT_IGNORE_PATTERNS, appInit, appPrepare, appUse, createAppDirFunction, createBaseApp, createBuildApp, createDevApp, createHookQueue, createPage, createPluginApi, createPluginApiHooks, createPluginApiRegisterHooks, inferPagePath, normalizeAliasDefineHook, normalizeClientConfigFileHook, parsePageContent, prepareClientConfigs, preparePageChunk, prepareRoutes, prepareSiteData, prepareUserStyle, renderPageToVue, resolveAppDir, resolveAppEnv, resolveAppOptions, resolveAppPages, resolveAppSiteData, resolveAppVersion, resolveAppWriteTemp, resolvePageChunkInfo, resolvePageContent, resolvePageDate, resolvePageFilePath, resolvePageHtmlInfo, resolvePageLang, resolvePagePath, resolvePagePermalink, resolvePageRedirects, resolvePageRouteMeta, resolvePageSlug, resolvePluginObject, resolveThemeInfo };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/core",
-  "version": "2.0.0-rc.30",
+  "version": "2.0.0-rc.31",
   "description": "Core package of VuePress",
   "keywords": [
     "core",
@@ -31,11 +31,11 @@
     "access": "public"
   },
   "dependencies": {
-    "vue": "^3.5.34",
-    "@vuepress/shared": "2.0.0-rc.30",
-    "@vuepress/utils": "2.0.0-rc.30",
-    "@vuepress/client": "2.0.0-rc.30",
-    "@vuepress/markdown": "2.0.0-rc.30"
+    "vue": "^3.5.40",
+    "@vuepress/markdown": "2.0.0-rc.31",
+    "@vuepress/client": "2.0.0-rc.31",
+    "@vuepress/utils": "2.0.0-rc.31",
+    "@vuepress/shared": "2.0.0-rc.31"
   },
   "tsdown": {
     "dts": true,