@vuepress/client 2.0.0-beta.4 → 2.0.0-beta.40

package/dist/index.d.ts

@@ -0,0 +1,220 @@
+import { PageData, PageFrontmatter, HeadConfig, SiteData } from '@vuepress/shared';
+export { PageData, PageFrontmatter, PageHeader, SiteData } from '@vuepress/shared';
+import { Router } from 'vue-router';
+export { RouterLink, useRoute, useRouter } from 'vue-router';
+import * as vue from 'vue';
+import { Ref, ComputedRef, InjectionKey, App, FunctionalComponent } from 'vue';
+export { C as CreateVueAppFunction } from './createVueAppFunction-c8e67ca1.js';
+
+/**
+ * Ref wrapper of `PageData`
+ */
+declare type PageDataRef<T extends Record<any, any> = Record<never, never>> = Ref<PageData<T>>;
+/**
+ * Empty page data to be used as the fallback value
+ */
+declare const pageDataEmpty: PageData<Record<never, never>, Record<string, unknown>>;
+/**
+ * Global page data ref
+ */
+declare const pageData: PageDataRef;
+/**
+ * Returns the ref of the data of current page
+ */
+declare const usePageData: <T extends Record<any, any> = Record<never, never>>() => PageDataRef<T>;
+
+/**
+ * Ref wrapper of `PageFrontmatter`
+ */
+declare type PageFrontmatterRef<T extends Record<any, any> = Record<string, unknown>> = ComputedRef<PageFrontmatter<T>>;
+/**
+ * Injection key for page frontmatter
+ */
+declare const pageFrontmatterSymbol: InjectionKey<PageFrontmatterRef>;
+/**
+ * Returns the ref of the frontmatter of current page
+ */
+declare const usePageFrontmatter: <T extends Record<any, any> = Record<string, unknown>>() => PageFrontmatterRef<T>;
+
+/**
+ * Page head config, which would be used for generate html tags in `<head>`
+ */
+declare type PageHead = HeadConfig[];
+/**
+ * Ref wrapper of `PageHead`
+ */
+declare type PageHeadRef = ComputedRef<PageHead>;
+/**
+ * Injection key for page head
+ */
+declare const pageHeadSymbol: InjectionKey<PageHeadRef>;
+/**
+ * Returns the ref of the head config of current page
+ */
+declare const usePageHead: () => PageHeadRef;
+
+/**
+ * Page head title, which would be used as the content of `head > title` tag
+ */
+declare type PageHeadTitle = string;
+/**
+ * Ref wrapper of `PageHeadTitle`
+ */
+declare type PageHeadTitleRef = ComputedRef<PageHeadTitle>;
+/**
+ * Injection key for page head title
+ */
+declare const pageHeadTitleSymbol: InjectionKey<PageHeadTitleRef>;
+/**
+ * Returns the ref of the head title of current page
+ */
+declare const usePageHeadTitle: () => PageHeadTitleRef;
+
+/**
+ * Page language
+ */
+declare type PageLang = string;
+/**
+ * Ref wrapper of `PageLang`
+ */
+declare type PageLangRef = ComputedRef<PageLang>;
+/**
+ * Injection key for page language
+ */
+declare const pageLangSymbol: InjectionKey<PageLangRef>;
+/**
+ * Returns the ref of the language of current page
+ */
+declare const usePageLang: () => PageLangRef;
+
+/**
+ * Data resolvers of all pages
+ *
+ * The key is page key, and the value is an async function that
+ * returns the page data
+ */
+declare type PagesData = Record<string, (() => Promise<PageData>) | undefined>;
+/**
+ * Ref wrapper of `PagesData`
+ */
+declare type PagesDataRef = Ref<PagesData>;
+/**
+ * Global pages data ref
+ */
+declare const pagesData: PagesDataRef;
+/**
+ * Returns the ref of data resolvers of all pages
+ */
+declare const usePagesData: () => PagesDataRef;
+
+/**
+ * Route locale path
+ */
+declare type RouteLocale = string;
+/**
+ * Ref wrapper of `RouteLocale`
+ */
+declare type RouteLocaleRef = ComputedRef<RouteLocale>;
+/**
+ * Injection key for page route locale path
+ */
+declare const routeLocaleSymbol: InjectionKey<RouteLocaleRef>;
+/**
+ * Returns the ref of the route locale path of current page
+ */
+declare const useRouteLocale: () => RouteLocaleRef;
+
+/**
+ * Ref wrapper of `SiteData`
+ */
+declare type SiteDataRef = Ref<SiteData>;
+/**
+ * Global site data ref
+ */
+declare const siteData: SiteDataRef;
+/**
+ * Returns the ref of the site data
+ */
+declare const useSiteData: () => SiteDataRef;
+
+/**
+ * Site data of current locale
+ */
+declare type SiteLocaleData = SiteData;
+/**
+ * Ref wrapper of `SiteLocaleData`
+ */
+declare type SiteLocaleDataRef = ComputedRef<SiteLocaleData>;
+/**
+ * Injection key for site locale data
+ */
+declare const siteLocaleDataSymbol: InjectionKey<SiteLocaleDataRef>;
+/**
+ * Returns the ref of the site data of current locale
+ */
+declare const useSiteLocaleData: () => SiteLocaleDataRef;
+
+/**
+ * A util function to force update `<head>` of current page
+ */
+declare type UpdateHead = () => void;
+/**
+ * Injection key for `updateHead` util
+ */
+declare const updateHeadSymbol: InjectionKey<UpdateHead>;
+/**
+ * Returns the `updateHead` util
+ */
+declare const useUpdateHead: () => UpdateHead;
+
+declare type ClientAppEnhance = (context: {
+    app: App;
+    router: Router;
+    siteData: SiteDataRef;
+}) => void | Promise<void>;
+
+declare type ClientAppSetup = () => void;
+
+declare const ClientOnly: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [key: string]: any;
+}>[] | null | undefined, {}, {}, {}, vue.ComponentOptionsMixin, vue.ComponentOptionsMixin, vue.EmitsOptions, string, vue.VNodeProps & vue.AllowedComponentProps & vue.ComponentCustomProps, Readonly<vue.ExtractPropTypes<{}>>, {}>;
+
+/**
+ * Markdown rendered content
+ */
+declare const Content: FunctionalComponent<{
+    pageKey?: string;
+}>;
+
+/**
+ * Global Layout
+ */
+declare const Vuepress: vue.DefineComponent<{}, () => vue.VNode<vue.RendererNode, vue.RendererElement, {
+    [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;
+
+/**
+ * Resolver methods to get global computed
+ *
+ * Users can override corresponding method for advanced customization
+ */
+declare const resolvers: {
+    resolvePageData: (pageKey: string) => Promise<PageData>;
+    resolvePageFrontmatter: (pageData: PageData) => PageFrontmatter;
+    resolvePageHead: (headTitle: PageHeadTitle, frontmatter: PageFrontmatter, siteLocale: SiteLocaleData) => PageHead;
+    resolvePageHeadTitle: (page: PageData, siteLocale: SiteLocaleData) => PageHeadTitle;
+    resolvePageLang: (pageData: PageData) => PageLang;
+    resolveRouteLocale: (locales: SiteData['locales'], routePath: string) => RouteLocale;
+    resolveSiteLocaleData: (site: SiteData, routeLocale: RouteLocale) => SiteLocaleData;
+};
+
+/**
+ * Prefix url with site base
+ */
+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 };

package/dist/index.js

@@ -0,0 +1,70 @@
+import {
+  ClientOnly,
+  Content,
+  Vuepress,
+  pageData,
+  pageDataEmpty,
+  pageFrontmatterSymbol,
+  pageHeadSymbol,
+  pageHeadTitleSymbol,
+  pageLangSymbol,
+  pagesData,
+  resolvers,
+  routeLocaleSymbol,
+  siteData,
+  siteLocaleDataSymbol,
+  updateHeadSymbol,
+  usePageData,
+  usePageFrontmatter,
+  usePageHead,
+  usePageHeadTitle,
+  usePageLang,
+  usePagesData,
+  useRouteLocale,
+  useSiteData,
+  useSiteLocaleData,
+  useUpdateHead,
+  withBase
+} from "./chunk-RTLFYRTT.js";
+
+// src/index.ts
+import { RouterLink, useRoute, useRouter } from "vue-router";
+
+// src/helpers/defineClientAppEnhance.ts
+var defineClientAppEnhance = (clientAppEnhance) => clientAppEnhance;
+
+// src/helpers/defineClientAppSetup.ts
+var defineClientAppSetup = (clientAppSetup) => clientAppSetup;
+export {
+  ClientOnly,
+  Content,
+  RouterLink,
+  Vuepress,
+  defineClientAppEnhance,
+  defineClientAppSetup,
+  pageData,
+  pageDataEmpty,
+  pageFrontmatterSymbol,
+  pageHeadSymbol,
+  pageHeadTitleSymbol,
+  pageLangSymbol,
+  pagesData,
+  resolvers,
+  routeLocaleSymbol,
+  siteData,
+  siteLocaleDataSymbol,
+  updateHeadSymbol,
+  usePageData,
+  usePageFrontmatter,
+  usePageHead,
+  usePageHeadTitle,
+  usePageLang,
+  usePagesData,
+  useRoute,
+  useRouteLocale,
+  useRouter,
+  useSiteData,
+  useSiteLocaleData,
+  useUpdateHead,
+  withBase
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vuepress/client",
-  "version": "2.0.0-beta.4",
+  "version": "2.0.0-beta.40",
   "description": "Client package of VuePress",
   "keywords": [
     "vuepress",
@@ -15,25 +15,62 @@
     "url": "git+https://github.com/vuepress/vuepress-next.git"
   },
   "license": "MIT",
-  "author": "Evan You",
-  "main": "lib/index.js",
-  "types": "lib/index.d.ts",
+  "author": "meteorlxy",
+  "type": "module",
+  "exports": {
+    ".": "./dist/index.js",
+    "./app": "./dist/app.js",
+    "./helpers": "./helpers/index.js",
+    "./package.json": "./package.json",
+    "./templates/*": "./templates/*",
+    "./types": "./types.d.ts"
+  },
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
   "files": [
-    "lib",
-    "templates"
+    "dist",
+    "templates",
+    "types.d.ts"
   ],
-  "scripts": {
-    "build": "tsc -b tsconfig.build.json",
-    "clean": "rimraf lib *.tsbuildinfo",
-    "copy": "cpx \"src/**/*.{d.ts,css}\" lib"
-  },
   "dependencies": {
-    "@vuepress/shared": "2.0.0-beta.4",
-    "vue": "^3.0.7",
-    "vue-router": "^4.0.4"
+    "@vue/devtools-api": "^6.1.4",
+    "@vuepress/shared": "2.0.0-beta.40",
+    "vue": "^3.2.33",
+    "vue-router": "^4.0.14"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "d42716e1b5b682ffb5d7cf124d0a24344493c467"
-}
+  "tsup": {
+    "clean": true,
+    "dts": [
+      "src/index.ts"
+    ],
+    "entry": [
+      "src/app.ts",
+      "src/index.ts"
+    ],
+    "external": [
+      "@internal/clientAppEnhances",
+      "@internal/clientAppRootComponents",
+      "@internal/clientAppSetups",
+      "@internal/layoutComponents",
+      "@internal/pagesComponents",
+      "@internal/pagesData",
+      "@internal/pagesRoutes",
+      "@internal/siteData"
+    ],
+    "format": [
+      "esm"
+    ],
+    "outDir": "dist",
+    "sourcemap": false,
+    "target": "es2020",
+    "tsconfig": "tsconfig.dts.json"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rimraf dist"
+  }
+}

package/templates/{index.ssr.html → build.html}

@@ -1,6 +1,9 @@
 <!DOCTYPE html>
 <html lang="{{ lang }}">
   <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <meta name="generator" content="VuePress {{ version }}">
     <!--vuepress-ssr-head-->
     <!--vuepress-ssr-resources-->
     <!--vuepress-ssr-styles-->

package/templates/{index.dev.html → dev.html}

@@ -1,6 +1,8 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
   </head>
   <body>
     <div id="app"></div>

package/types.d.ts

@@ -0,0 +1,6 @@
+declare const __VUEPRESS_VERSION__: 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_PROD_DEVTOOLS__: boolean

package/CHANGELOG.md

@@ -1,171 +0,0 @@
-# Change Log
-
-All notable changes to this project will be documented in this file.
-See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
-
-# [2.0.0-beta.4](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.3...v2.0.0-beta.4) (2021-03-20)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-beta.1](https://github.com/vuepress/vuepress-next/compare/v2.0.0-beta.0...v2.0.0-beta.1) (2021-03-13)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-beta.0](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.26...v2.0.0-beta.0) (2021-03-13)
-
-
-### Features
-
-* implement vite hmr ([525c18d](https://github.com/vuepress/vuepress-next/commit/525c18d5a64fbdbdeb5ce1348ec1e1ead3dbd8f9))
-* **client:** add defineClientAppEnhance and defineClientAppSetup utils ([1520517](https://github.com/vuepress/vuepress-next/commit/15205172c3b56fc8a879bba040f4ecc815d2c924))
-
-
-
-
-
-# [2.0.0-alpha.25](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.24...v2.0.0-alpha.25) (2021-02-20)
-
-
-### Code Refactoring
-
-* **core:** remove theme data from site data ([187aef3](https://github.com/vuepress/vuepress-next/commit/187aef36607efc62d7b2d5c773553f89685cf64c))
-
-
-### BREAKING CHANGES
-
-* **core:** `themeConfig` is not available in site data any more
-
-
-
-
-
-# [2.0.0-alpha.24](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.23...v2.0.0-alpha.24) (2021-02-13)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-alpha.22](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.21...v2.0.0-alpha.22) (2021-02-10)
-
-
-### Bug Fixes
-
-* **client:** only watch route path to update head ([3174f5a](https://github.com/vuepress/vuepress-next/commit/3174f5a676d95943df256b2be31227eb844d0144))
-
-
-
-
-
-# [2.0.0-alpha.20](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.19...v2.0.0-alpha.20) (2021-02-04)
-
-
-### Features
-
-* **core:** make language available in page data ([03bb09f](https://github.com/vuepress/vuepress-next/commit/03bb09fd51aeaff56d26820a1401b87ea8bdeb38))
-
-
-
-
-
-# [2.0.0-alpha.19](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.18...v2.0.0-alpha.19) (2021-01-24)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-alpha.18](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.17...v2.0.0-alpha.18) (2021-01-17)
-
-
-### Bug Fixes
-
-* **client:** load existing head tags on mounted ([15722c5](https://github.com/vuepress/vuepress-next/commit/15722c5175e44a8d6363bfe5f138f2c2c8edeec3))
-
-
-### Features
-
-* **client:** make usePageFrontmatter generic ([2c5e5c1](https://github.com/vuepress/vuepress-next/commit/2c5e5c1400469a3cb4da2856104514a9413bff8a))
-
-
-
-
-
-# [2.0.0-alpha.16](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.15...v2.0.0-alpha.16) (2021-01-11)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-alpha.15](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.14...v2.0.0-alpha.15) (2021-01-04)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-alpha.13](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.12...v2.0.0-alpha.13) (2020-12-23)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-alpha.7](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.6...v2.0.0-alpha.7) (2020-12-09)
-
-**Note:** Version bump only for package @vuepress/client
-
-
-
-
-
-# [2.0.0-alpha.6](https://github.com/vuepress/vuepress-next/compare/v2.0.0-alpha.5...v2.0.0-alpha.6) (2020-12-09)
-
-
-### Features
-
-* **client:** remove built-in debug component ([a5962bb](https://github.com/vuepress/vuepress-next/commit/a5962bb82483f56800b33b4e35c50dcb49fd48b1))
-
-
-
-
-
-# 2.0.0-alpha.1 (2020-12-01)
-
-
-### Bug Fixes
-
-* **client:** do not prepend base to http url ([9e4e623](https://github.com/vuepress/vuepress-next/commit/9e4e6233ce988bf3b6ebbbb1bc60f83a26f6709c))
-* **client:** wrap ssr-app with a parent div ([c65b6c4](https://github.com/vuepress/vuepress-next/commit/c65b6c47f084466dde9daf17d1c1d00b88f6682d))
-
-
-### Features
-
-* **client:** add built-in styles for Debug component ([1b3b028](https://github.com/vuepress/vuepress-next/commit/1b3b028e0cd078eb6f074c36696255df1cf49267))
-* **client:** add ClientOnly component ([e2cad36](https://github.com/vuepress/vuepress-next/commit/e2cad36c5f859240e5fac62c38fbaa14b39defab))
-* **client:** add global computed and updateHead ([df83b88](https://github.com/vuepress/vuepress-next/commit/df83b887a69db9290a22d0731056f4ac2b6f0014))
-* **client:** add global data utils ([46b9fc5](https://github.com/vuepress/vuepress-next/commit/46b9fc579f51c1f037f4850f8699074805799884))
-* **client:** add OutboundLink component ([4107add](https://github.com/vuepress/vuepress-next/commit/4107add516e7acd0cbdc4a526bf4772c54fb6108))
-* **client:** add siteLocale in debug component ([e1d663b](https://github.com/vuepress/vuepress-next/commit/e1d663b4ece27012c72383f5eecb90c5fb2195ef))
-* **client:** add themeData injections ([04cafe2](https://github.com/vuepress/vuepress-next/commit/04cafe23ec835d9efc9a2b1ab8be8b7d8f0a22b4))
-* **client:** add withBase util ([f234c5d](https://github.com/vuepress/vuepress-next/commit/f234c5d74f148b55b265d13dc2c868d8531d192a))
-* **client:** augment route meta type ([6f4e1f5](https://github.com/vuepress/vuepress-next/commit/6f4e1f5995351a0dd6ebf257e1889d26e77d26e4))
-* **client:** make siteData injections generic ([86b9416](https://github.com/vuepress/vuepress-next/commit/86b941646b7554b404a621a3616a7a81958c12c3))
-* **client:** provide site locale data ([00455bd](https://github.com/vuepress/vuepress-next/commit/00455bdf21736254c8a3a488cdf8245e80742398))
-* **client:** set scrollBehavior for vue-router ([f7a12ce](https://github.com/vuepress/vuepress-next/commit/f7a12ceaa1e20ba2e87fa34c692a754fcc3f34f4))
-* **client:** support clientAppRootComponentFiles ([188c1a0](https://github.com/vuepress/vuepress-next/commit/188c1a04fed8ed6614b45a6a0c1cb3d07a4ca112))
-* **client:** take 404 as the fallback layout ([bb34903](https://github.com/vuepress/vuepress-next/commit/bb349038da090d0e5fd9069ff5cfa3372c95dc0b))

package/lib/app.d.ts

@@ -1,18 +0,0 @@
-import type { CreateAppFunction, App } from 'vue';
-import type { Router, RouterHistory } from 'vue-router';
-export declare type AppCreator = CreateAppFunction<Element>;
-export declare type HistoryCreator = (base?: string) => RouterHistory;
-export declare type CreateVueAppResult = {
-    app: App;
-    router: Router;
-};
-/**
- * Create a vue app
- *
- * Accepting different app creator and history creator, so it
- * can be reused for both client side and server side
- */
-export declare const createVueApp: ({ appCreator, historyCreator, }: {
-    appCreator: AppCreator;
-    historyCreator: HistoryCreator;
-}) => Promise<CreateVueAppResult>;