@vuepress/core 2.0.0-beta.26 → 2.0.0-beta.32

package/lib/types/app/app.d.ts

@@ -1,6 +1,6 @@
 import type { Markdown } from '@vuepress/markdown';
 import type { SiteData } from '@vuepress/shared';
-import type { BundlerDev, BundlerBuild } from '../bundler';
+import type { BundlerBuild, BundlerDev } from '../bundler';
 import type { Page } from '../page';
 import type { Plugin, PluginOptions } from '../plugin';
 import type { PluginApi } from '../pluginApi';
@@ -10,14 +10,6 @@ import type { AppDir, AppEnv, AppWriteTemp } from './utils';
  * Vuepress app
  */
 export interface App {
-    /**
-     * Version of vuepress core
-     */
-    version: string;
-    /**
-     * Options that filled all optional fields with a default value
-     */
-    options: AppOptions;
     /**
      * Directory utils
      */
@@ -27,17 +19,21 @@ export interface App {
      */
     env: AppEnv;
     /**
-     * Site data, which will be used in client side
-     */
-    siteData: SiteData;
-    /**
-     * Markdown-it instance
+     * Options that filled all optional fields with a default value
      */
-    markdown: Markdown;
+    options: AppOptions;
     /**
      * Plugin system
      */
     pluginApi: PluginApi;
+    /**
+     * Site data, which will be used in client side
+     */
+    siteData: SiteData;
+    /**
+     * Version of vuepress core
+     */
+    version: string;
     /**
      * Write temp file
      */
@@ -65,6 +61,12 @@ export interface App {
      * Only available after initialization
      */
     layouts: Record<string, string>;
+    /**
+     * Markdown-it instance.
+     *
+     * Only available after initialization
+     */
+    markdown: Markdown;
     /**
      * Page objects.
      *

package/lib/types/app/options.d.ts

@@ -1,33 +1,44 @@
 import type { MarkdownOptions } from '@vuepress/markdown';
-import type { SiteLocaleConfig, SiteLocaleData } from '@vuepress/shared';
+import type { SiteData } from '@vuepress/shared';
 import type { BundlerConfig } from '../bundler';
 import type { PluginConfig } from '../plugin';
 import type { ThemeConfig } from '../theme';
 /**
- * Vuepress app options
+ * Config to create vuepress app
  */
-export interface AppOptions<T extends ThemeConfig = ThemeConfig, U extends BundlerConfig = BundlerConfig> extends SiteLocaleData {
-    base: string;
-    locales: SiteLocaleConfig;
-    theme: string;
-    themeConfig: Partial<T>;
-    bundler: string;
-    bundlerConfig: Partial<U>;
+export declare type AppConfig<T extends ThemeConfig = ThemeConfig, U extends BundlerConfig = BundlerConfig> = Partial<SiteData> & AppConfigDev & AppConfigBuild & {
+    theme?: string;
+    themeConfig?: Partial<T>;
+    bundler?: string;
+    bundlerConfig?: Partial<U>;
     source: string;
-    dest: string;
-    temp: string;
-    cache: string;
-    public: string;
-    markdown: MarkdownOptions;
-    debug: boolean;
-    host: string;
-    port: number;
-    open: boolean;
-    pagePatterns: string[];
-    templateDev: string;
-    templateSSR: string;
-    shouldPreload: ((file: string, type: string) => boolean) | boolean;
-    shouldPrefetch: ((file: string, type: string) => boolean) | boolean;
-    plugins: PluginConfig[];
+    dest?: string;
+    temp?: string;
+    cache?: string;
+    public?: string;
+    debug?: boolean;
+    pagePatterns?: string[];
+    markdown?: MarkdownOptions;
+    plugins?: PluginConfig[];
+};
+/**
+ * Vuepress app config for dev
+ */
+export interface AppConfigDev {
+    host?: string;
+    port?: number;
+    open?: boolean;
+    templateDev?: string;
 }
-export declare type AppConfig = Partial<AppOptions> & Pick<AppOptions, 'source'>;
+/**
+ * Vuepress app config for build
+ */
+export interface AppConfigBuild {
+    shouldPreload?: ((file: string, type: string) => boolean) | boolean;
+    shouldPrefetch?: ((file: string, type: string) => boolean) | boolean;
+    templateBuild?: string;
+}
+/**
+ * Vuepress app options
+ */
+export declare type AppOptions<T extends ThemeConfig = ThemeConfig, U extends BundlerConfig = BundlerConfig> = Required<AppConfig<T, U>>;

package/lib/types/index.d.ts

@@ -1,4 +1,4 @@
-import type { HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, HeadAttrsConfig, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig } from '@vuepress/shared';
+import type { HeadAttrsConfig, HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig } from '@vuepress/shared';
 export type { HeadConfig, HeadTag, HeadTagEmpty, HeadTagNonEmpty, HeadAttrsConfig, LocaleConfig, LocaleData, PageData, PageFrontmatter, PageHeader, SiteData, SiteLocaleConfig, };
 export * from './app';
 export * from './bundler';

package/lib/types/page.d.ts

@@ -3,11 +3,11 @@ import type { PageData, PageFrontmatter } from '@vuepress/shared';
 /**
  * Vuepress Page
  */
-export interface Page<T extends PageData = PageData> extends PageData {
+export declare type Page<ExtraPageData extends Record<any, any> = Record<never, never>, ExtraPageFields extends Record<any, any> = Record<never, never>> = PageData & ExtraPageFields & {
     /**
      * Data of the page, which will be available in client code
      */
-    data: T;
+    data: PageData<ExtraPageData>;
     /**
      * Raw Content of the page
      */
@@ -56,6 +56,12 @@ export interface Page<T extends PageData = PageData> extends PageData {
      * If the page does not have a permalink, it would be `null`
      */
     permalink: string | null;
+    /**
+     * Custom data to be attached to the page route record of vue-router
+     *
+     * @see https://next.router.vuejs.org/api/#meta
+     */
+    routeMeta: Record<string, unknown>;
     /**
      * Slug of the page
      */
@@ -108,7 +114,7 @@ export interface Page<T extends PageData = PageData> extends PageData {
      * Rendered html file path relative to dest directory
      */
     htmlFilePathRelative: string;
-}
+};
 /**
  * Options to create vuepress page
  */

package/lib/types/pluginApi/hooks.d.ts

@@ -1,4 +1,4 @@
-import type { Markdown } from '@vuepress/markdown';
+import type { Markdown, MarkdownOptions } from '@vuepress/markdown';
 import type { App } from '../app';
 import type { Page, PageOptions } from '../page';
 declare type PromiseOrNot<T> = Promise<T> | T;
@@ -11,11 +11,9 @@ export declare type Hook<Exposed, Normalized = Exposed, Result = Normalized exte
     result: Result;
 };
 export declare type LifeCycleHook<T extends unknown[] = []> = Hook<(app: App, ...args: T) => PromiseOrNot<void>>;
+export declare type ExtendsHook<T> = Hook<(extendable: T, app: App) => PromiseOrNot<void>>;
 export declare type ClientFilesHook = Hook<string | string[] | ((app: App) => PromiseOrNot<string | string[]>), (app: App) => Promise<string[]>>;
 export declare type ReturnObjectHook = Hook<Record<string, any> | ((app: App) => PromiseOrNot<Record<string, any>>), (app: App) => Promise<Record<string, any>>>;
-export declare type ExtendsMarkdownHook = Hook<(md: Markdown, app: App) => PromiseOrNot<void>>;
-export declare type ExtendsPageOptionsHook = Hook<(options: PageOptions, app: App) => PromiseOrNot<PageOptions>>;
-export declare type ExtendsPageDataHook = Hook<(page: Omit<Page, 'data'>, app: App) => PromiseOrNot<Record<string, any>>>;
 /**
  * List of hooks
  */
@@ -24,9 +22,10 @@ export interface Hooks {
     onPrepared: LifeCycleHook;
     onWatched: LifeCycleHook<[watchers: Closable[], restart: () => Promise<void>]>;
     onGenerated: LifeCycleHook;
-    extendsMarkdown: ExtendsMarkdownHook;
-    extendsPageOptions: ExtendsPageOptionsHook;
-    extendsPageData: ExtendsPageDataHook;
+    extendsMarkdownOptions: ExtendsHook<MarkdownOptions>;
+    extendsMarkdown: ExtendsHook<Markdown>;
+    extendsPageOptions: ExtendsHook<PageOptions>;
+    extendsPage: ExtendsHook<Page>;
     clientAppEnhanceFiles: ClientFilesHook;
     clientAppRootComponentFiles: ClientFilesHook;
     clientAppSetupFiles: ClientFilesHook;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/core",
-  "version": "2.0.0-beta.26",
+  "version": "2.0.0-beta.32",
   "description": "Core package of VuePress",
   "keywords": [
     "vuepress",
@@ -26,15 +26,15 @@
     "clean": "rimraf lib *.tsbuildinfo"
   },
   "dependencies": {
-    "@vuepress/client": "2.0.0-beta.26",
-    "@vuepress/markdown": "2.0.0-beta.25",
-    "@vuepress/shared": "2.0.0-beta.25",
-    "@vuepress/utils": "2.0.0-beta.25",
+    "@vuepress/client": "2.0.0-beta.32",
+    "@vuepress/markdown": "2.0.0-beta.32",
+    "@vuepress/shared": "2.0.0-beta.32",
+    "@vuepress/utils": "2.0.0-beta.32",
     "gray-matter": "^4.0.3",
     "toml": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6cbf3e07b2871383cebad5180fcbb02d69c79566"
+  "gitHead": "8ffa71313607fe78f3956e3ccb886fcae0ddf5e9"
 }

package/lib/app/createAppDir.js

@@ -1,32 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAppDir = exports.createAppDirFunction = void 0;
-const utils_1 = require("@vuepress/utils");
-/**
- * Create directory util function
- */
-const createAppDirFunction = (baseDir) => {
-    return (...args) => utils_1.path.resolve(baseDir, ...args);
-};
-exports.createAppDirFunction = createAppDirFunction;
-/**
- * Create directory utils for vuepress app
- */
-const createAppDir = (options) => {
-    const cache = exports.createAppDirFunction(options.cache);
-    const temp = exports.createAppDirFunction(options.temp);
-    const source = exports.createAppDirFunction(options.source);
-    const dest = exports.createAppDirFunction(options.dest);
-    const publicDir = exports.createAppDirFunction(options.public);
-    // @vuepress/client
-    const client = exports.createAppDirFunction(utils_1.path.resolve(require.resolve('@vuepress/client/package.json'), '..'));
-    return {
-        cache,
-        temp,
-        source,
-        dest,
-        client,
-        public: publicDir,
-    };
-};
-exports.createAppDir = createAppDir;

package/lib/app/createAppEnv.d.ts

@@ -1,5 +0,0 @@
-import type { AppEnv, AppOptions } from '../types';
-/**
- * Create environment flags for vuepress app
- */
-export declare const createAppEnv: (options: AppOptions, isBuild: boolean) => AppEnv;

package/lib/app/createAppEnv.js

@@ -1,12 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAppEnv = void 0;
-/**
- * Create environment flags for vuepress app
- */
-const createAppEnv = (options, isBuild) => ({
-    isBuild,
-    isDev: !isBuild,
-    isDebug: options.debug,
-});
-exports.createAppEnv = createAppEnv;

package/lib/app/createAppOptions.d.ts

@@ -1,5 +0,0 @@
-import type { AppConfig, AppOptions } from '../types';
-/**
- * Create app options with default values
- */
-export declare const createAppOptions: ({ base, lang, title, description, head, locales, theme, themeConfig, bundler, bundlerConfig, source, dest, temp, cache, public: publicDir, markdown, host, port, debug, open, pagePatterns, templateDev, templateSSR, shouldPreload, shouldPrefetch, plugins, }: AppConfig) => AppOptions;

package/lib/app/createAppPages.d.ts

@@ -1,5 +0,0 @@
-import type { App, Page } from '../types';
-/**
- * Create pages for vuepress app
- */
-export declare const createAppPages: (app: App) => Promise<Page[]>;

package/lib/app/createAppPages.js

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAppPages = void 0;
-const utils_1 = require("@vuepress/utils");
-const page_1 = require("../page");
-const log = utils_1.debug('vuepress:core/app');
-/**
- * Create pages for vuepress app
- */
-const createAppPages = async (app) => {
-    log('createAppPages start');
-    // resolve page absolute file paths according to the page patterns
-    const pageFilePaths = await utils_1.globby(app.options.pagePatterns, {
-        absolute: true,
-        cwd: app.dir.source(),
-    });
-    // create pages from files
-    const pages = await Promise.all(pageFilePaths.map((filePath) => page_1.createPage(app, { filePath })));
-    // if there is no 404 page, add one
-    if (!pages.some((page) => page.path === '/404.html')) {
-        pages.push(await page_1.createPage(app, {
-            path: '/404.html',
-            frontmatter: {
-                layout: '404',
-            },
-        }));
-    }
-    log('createAppPages finish');
-    return pages;
-};
-exports.createAppPages = createAppPages;

package/lib/app/createAppSiteData.d.ts

@@ -1,7 +0,0 @@
-import type { AppOptions, SiteData } from '../types';
-/**
- * Create site data for vuepress app
- *
- * Site data will also be used in client
- */
-export declare const createAppSiteData: (options: AppOptions) => SiteData;

package/lib/app/createAppVersion.d.ts

@@ -1,4 +0,0 @@
-/**
- * Create version of vuepress app
- */
-export declare const createAppVersion: () => string;

package/lib/app/createAppVersion.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.createAppVersion = void 0;
-/**
- * Create version of vuepress app
- */
-const createAppVersion = () => {
-    return require('../../package.json').version;
-};
-exports.createAppVersion = createAppVersion;

package/lib/app/createAppWriteTemp.d.ts

@@ -1,5 +0,0 @@
-import type { AppDir, AppWriteTemp } from '../types';
-/**
- * Create write temp file util for vuepress app
- */
-export declare const createAppWriteTemp: (dir: AppDir) => AppWriteTemp;

package/lib/app/resolvePlugin.d.ts

@@ -1,5 +0,0 @@
-import type { App, Plugin, PluginObject, PluginOptions } from '../types';
-/**
- * Resolve a plugin according to name / path / module and config
- */
-export declare const resolvePlugin: <T extends PluginOptions = PluginOptions, U extends PluginObject = PluginObject>(app: App, plugin: string | Plugin<T, U>, config?: Partial<T>) => U;

package/lib/app/resolvePlugin.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePlugin = void 0;
-const shared_1 = require("@vuepress/shared");
-const utils_1 = require("@vuepress/utils");
-const resolvePluginModule_1 = require("./resolvePluginModule");
-/**
- * Resolve a plugin according to name / path / module and config
- */
-const resolvePlugin = (app, plugin, config = {}) => {
-    const pluginModule = shared_1.isString(plugin)
-        ? resolvePluginModule_1.resolvePluginModule(plugin)
-        : plugin;
-    if (pluginModule === null) {
-        throw utils_1.logger.createError(`plugin is not found: ${utils_1.chalk.magenta(plugin)}`);
-    }
-    const pluginObject = shared_1.isFunction(pluginModule)
-        ? pluginModule(config, app)
-        : pluginModule;
-    return pluginObject;
-};
-exports.resolvePlugin = resolvePlugin;

package/lib/app/resolveTheme.d.ts

@@ -1,5 +0,0 @@
-import type { App, ThemeObject } from '../types';
-/**
- * Resolve a theme according to the theme name
- */
-export declare const resolveTheme: (app: App, themeName: string) => ThemeObject;

package/lib/app/resolveTheme.js

@@ -1,22 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolveTheme = void 0;
-const shared_1 = require("@vuepress/shared");
-const utils_1 = require("@vuepress/utils");
-const resolvePlugin_1 = require("./resolvePlugin");
-/**
- * Resolve a theme according to the theme name
- */
-const resolveTheme = (app, themeName) => {
-    // resolve theme entry according to theme name
-    const themeEntry = utils_1.requireResolve(utils_1.path.isAbsolute(themeName)
-        ? themeName
-        : shared_1.normalizePackageName(themeName, 'vuepress', 'theme'));
-    if (themeEntry === null) {
-        throw utils_1.logger.createError(`theme is not found: ${utils_1.chalk.magenta(themeName)}`);
-    }
-    // resolve theme from theme entry
-    const theme = resolvePlugin_1.resolvePlugin(app, themeEntry, app.options.themeConfig);
-    return theme;
-};
-exports.resolveTheme = resolveTheme;

package/lib/page/resolvePageData.d.ts

@@ -1,8 +0,0 @@
-import type { App, Page, PageData } from '../types';
-/**
- * Resolve page data
- */
-export declare const resolvePageData: ({ app, page, }: {
-    app: App;
-    page: Page;
-}) => Promise<PageData>;

package/lib/page/resolvePageData.js

@@ -1,23 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePageData = void 0;
-/**
- * Resolve page data
- */
-const resolvePageData = async ({ app, page, }) => {
-    const { key, path, title, lang, frontmatter, excerpt, headers } = page;
-    const data = {
-        key,
-        path,
-        title,
-        lang,
-        frontmatter,
-        excerpt,
-        headers,
-    };
-    // plugin hook: extendsPageData
-    const extendsPageData = await app.pluginApi.hooks.extendsPageData.process(page, app);
-    extendsPageData.forEach((item) => Object.assign(data, item));
-    return data;
-};
-exports.resolvePageData = resolvePageData;

package/lib/page/resolvePageOptions.d.ts

@@ -1,8 +0,0 @@
-import type { App, PageOptions } from '../types';
-/**
- * Render page content and extract related info
- */
-export declare const resolvePageOptions: ({ app, optionsRaw, }: {
-    app: App;
-    optionsRaw: PageOptions;
-}) => Promise<PageOptions>;

package/lib/page/resolvePageOptions.js

@@ -1,15 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.resolvePageOptions = void 0;
-/**
- * Render page content and extract related info
- */
-const resolvePageOptions = async ({ app, optionsRaw, }) => {
-    // avoid mutating the original options object provided by user
-    const options = { ...optionsRaw };
-    // plugin hook: extendsPageOptions
-    const extendsPageOptions = await app.pluginApi.hooks.extendsPageOptions.process(options, app);
-    extendsPageOptions.forEach((item) => Object.assign(options, item));
-    return options;
-};
-exports.resolvePageOptions = resolvePageOptions;