valaxy 0.9.3 → 0.10.2

package/dist/node/index.d.ts

@@ -1,18 +1,24 @@
 import { ViteSSGOptions } from 'vite-ssg';
+import * as vite from 'vite';
+import { UserConfig as UserConfig$1, InlineConfig } from 'vite';
+import { D as DefaultThemeConfig, U as UserSiteConfig, P as PartialDeep, S as SiteConfig } from '../config-1d500fb4.js';
 import Vue from '@vitejs/plugin-vue';
 import Components from 'unplugin-vue-components/vite';
 import { VitePluginConfig } from 'unocss/vite';
 import Pages from 'vite-plugin-pages';
-import * as vite from 'vite';
-import { UserConfig, InlineConfig } from 'vite';
 import { presetUno, presetAttributify, presetIcons, presetTypography } from 'unocss';
-import { V as ValaxyConfig, U as UserConfig$1, P as PartialDeep, a as ValaxyThemeConfig } from '../config-1d2e9ebd.js';
 import MarkdownIt from 'markdown-it';
 import { Theme } from 'shiki';
 import Anchor from 'markdown-it-anchor';
 import { KatexOptions } from 'katex';
 import { Awaitable } from '@antfu/utils';
 
+declare module 'vite' {
+    interface UserConfig {
+        ssgOptions?: ViteSSGOptions;
+    }
+}
+
 interface BlockItem {
     text?: string;
     icon?: string;
@@ -63,14 +69,15 @@ interface MarkdownOptions {
     blocks?: Blocks;
 }
 
-interface ValaxyEntryOptions {
-    /**
-     * theme name
-     */
-    theme?: string;
-    userRoot?: string;
-}
-interface ValaxyPluginOptions {
+declare type ValaxyConfig<ThemeConfig = DefaultThemeConfig> = UserSiteConfig<ThemeConfig> & ValaxyExtendConfig;
+declare type UserConfig<ThemeConfig = DefaultThemeConfig> = ValaxyConfig<ThemeConfig>;
+/**
+ * fn with options for theme config
+ */
+declare type ValaxyConfigFn<ThemeConfig = DefaultThemeConfig> = (options: ResolvedValaxyOptions<ThemeConfig>) => ValaxyConfig | Promise<ValaxyConfig>;
+declare type ValaxyConfigExport<ThemeConfig = DefaultThemeConfig> = ValaxyConfig<ThemeConfig> | ValaxyConfigFn<ThemeConfig>;
+interface ValaxyExtendConfig {
+    vite?: UserConfig$1;
     vue?: Parameters<typeof Vue>[0];
     components?: Parameters<typeof Components>[0];
     unocss?: VitePluginConfig;
@@ -94,11 +101,35 @@ interface ValaxyPluginOptions {
         excerpt?: string;
         path: string;
     }) => void;
+    addons?: ValaxyAddonOptions;
 }
-interface ValaxyThemePlugin extends ValaxyPluginOptions {
-    vite?: Omit<UserConfig, 'valaxy'>;
+interface ValaxyAddon {
+    global?: boolean;
+    props?: Record<string, any>;
+    options?: Record<string, any>;
+}
+declare type ValaxyAddonLike = ValaxyAddon | false | null | undefined;
+declare type ValaxyAddonOptions = ([string, ValaxyAddonLike] | string)[] | Record<string, ValaxyAddonLike>;
+declare type ValaxyAddonFn<ThemeConfig = DefaultThemeConfig> = (addonOptions: ValaxyAddonResolver, valaxyOptions: ResolvedValaxyOptions<ThemeConfig>) => ValaxyConfig | Promise<ValaxyConfig>;
+declare type ValaxyAddonExport<ThemeConfig = DefaultThemeConfig> = ValaxyConfig<ThemeConfig> | ValaxyAddonFn<ThemeConfig>;
+interface ValaxyAddonResolver {
+    name: string;
+    root: string;
+    enable: boolean;
+    global: boolean;
+    props: Record<string, any>;
+    options: Record<string, any>;
+    configFile?: string;
+}
+
+interface ValaxyEntryOptions {
+    /**
+     * theme name
+     */
+    theme?: string;
+    userRoot?: string;
 }
-interface ResolvedValaxyOptions {
+interface ResolvedValaxyOptions<ThemeConfig = DefaultThemeConfig> {
     mode: 'dev' | 'build';
     /**
      * package.json root
@@ -118,6 +149,10 @@ interface ResolvedValaxyOptions {
      * Theme root path
      */
     themeRoot: string;
+    /**
+     * Addon root path
+     */
+    addonRoots: string[];
     /**
      * Theme name
      */
@@ -126,57 +161,65 @@ interface ResolvedValaxyOptions {
     /**
      * Valaxy Config
      */
-    config: ValaxyConfig;
+    config: ValaxyConfig<ThemeConfig>;
     /**
      * config file path
      */
     configFile: string;
     pages: string[];
+    /**
+     * all addons
+     * Record<package-name, OptionResolver>
+     */
+    addons: ValaxyAddonResolver[];
 }
 interface ValaxyServerOptions {
     onConfigReload?: (newConfig: ValaxyConfig, config: ValaxyConfig, force?: boolean) => void;
 }
-declare function isPath(name: string): boolean;
+declare function resolveOptions(options: ValaxyEntryOptions, mode?: ResolvedValaxyOptions['mode']): Promise<ResolvedValaxyOptions<DefaultThemeConfig>>;
+
+/**
+ * merge vite.config.ts (user & theme)
+ * @internal
+ * @param param
+ * @param command
+ * @returns
+ */
+declare function mergeViteConfigs({ userRoot, themeRoot }: ResolvedValaxyOptions, command: 'serve' | 'build'): Promise<InlineConfig>;
 /**
- * get theme roots
- * @param name
- * @param entry
+ * generate index.html from user/theme/client
+ * @internal
+ * @param
  * @returns
  */
-declare function getThemeRoot(name: string, entry: string): string;
-declare function resolveOptions(options: ValaxyEntryOptions, mode?: ResolvedValaxyOptions['mode']): Promise<ResolvedValaxyOptions>;
+declare function getIndexHtml({ clientRoot, themeRoot, userRoot, config }: ResolvedValaxyOptions): Promise<string>;
 
-declare module 'vite' {
-    interface UserConfig {
-        /**
-         * Custom internal plugin options for Valaxy (advanced)
-         *
-         * @see ./options.ts'
-         */
-        valaxy?: ValaxyPluginOptions;
-        ssgOptions?: ViteSSGOptions;
-    }
-}
+declare function build(options: ResolvedValaxyOptions, viteConfig?: InlineConfig): Promise<void>;
+declare function ssgBuild(options: ResolvedValaxyOptions, viteConfig?: InlineConfig): Promise<void>;
 
 /**
- * Type config helper
+ * Type site helper
  */
-declare function defineConfig<ThemeConfig>(config: UserConfig$1<ThemeConfig>): PartialDeep<ValaxyConfig<ThemeConfig>>;
+declare function defineSite<ThemeConfig>(config: UserSiteConfig<ThemeConfig>): PartialDeep<SiteConfig<ThemeConfig>>;
 /**
- * Type config helper for custom theme config
+ * Type site helper for custom theme site
  */
-declare function defineConfigWithTheme<ThemeConfig>(config: UserConfig$1<ThemeConfig>): PartialDeep<ValaxyConfig<ThemeConfig>>;
-declare function resolveConfig(options?: ValaxyEntryOptions): Promise<{
-    config: ValaxyConfig<ValaxyThemeConfig>;
-    configFile: string;
-    theme: string;
-}>;
-declare type ThemeConfigExport = ValaxyThemePlugin | Promise<ValaxyThemePlugin> | ThemeConfigFn;
-declare type ThemeConfigFn = (options: ResolvedValaxyOptions) => ValaxyThemePlugin | Promise<ValaxyThemePlugin>;
-declare function defineThemePlugin(config: ThemeConfigExport): ThemeConfigExport;
+declare function defineSiteWithTheme<ThemeConfig>(config: UserSiteConfig<ThemeConfig>): PartialDeep<SiteConfig<ThemeConfig>>;
+/**
+ * Type valaxy config helper
+ */
+declare function defineConfig<ThemeConfig>(config: UserConfig<ThemeConfig>): UserConfig<ThemeConfig>;
+declare type ValaxyConfigExtendKey = 'vite' | 'vue' | 'unocss' | 'unocssPresets' | 'markdown' | 'extendMd';
+declare type ValaxyPickConfig = Pick<ValaxyConfig, ValaxyConfigExtendKey>;
+declare type ValaxyTheme<ThemeConfig = DefaultThemeConfig> = ValaxyPickConfig & {
+    themeConfig?: ThemeConfig;
+};
+declare function defineTheme<ThemeConfig = DefaultThemeConfig>(theme: ValaxyTheme<ThemeConfig> | ((options: ResolvedValaxyOptions<ThemeConfig>) => ValaxyTheme<ThemeConfig>)): ValaxyTheme<ThemeConfig> | ((options: ResolvedValaxyOptions<ThemeConfig>) => ValaxyTheme<ThemeConfig>);
+declare function defineAddon(addon: ValaxyPickConfig | ((addonOptions: ValaxyAddonResolver, valaxyOptions: ResolvedValaxyOptions) => ValaxyPickConfig)): ValaxyPickConfig | ((addonOptions: ValaxyAddonResolver, valaxyOptions: ResolvedValaxyOptions) => ValaxyPickConfig);
+declare const defaultSiteConfig: SiteConfig;
 declare type UnoSetup = () => Awaitable<Partial<VitePluginConfig> | undefined>;
 declare function defineUnoSetup(fn: UnoSetup): UnoSetup;
 
 declare function createServer(options: ResolvedValaxyOptions, viteConfig?: InlineConfig, serverOptions?: ValaxyServerOptions): Promise<vite.ViteDevServer>;
 
-export { ResolvedValaxyOptions, ThemeConfigExport, ThemeConfigFn, UnoSetup, ValaxyEntryOptions, ValaxyPluginOptions, ValaxyServerOptions, ValaxyThemePlugin, createServer, defineConfig, defineConfigWithTheme, defineThemePlugin, defineUnoSetup, getThemeRoot, isPath, resolveConfig, resolveOptions };
+export { ResolvedValaxyOptions, UnoSetup, UserConfig, ValaxyAddon, ValaxyAddonExport, ValaxyAddonFn, ValaxyAddonLike, ValaxyAddonOptions, ValaxyAddonResolver, ValaxyConfig, ValaxyConfigExport, ValaxyConfigExtendKey, ValaxyConfigFn, ValaxyEntryOptions, ValaxyExtendConfig, ValaxyPickConfig, ValaxyServerOptions, ValaxyTheme, build, createServer, defaultSiteConfig, defineAddon, defineConfig, defineSite, defineSiteWithTheme, defineTheme, defineUnoSetup, getIndexHtml, mergeViteConfigs, resolveOptions, ssgBuild };

package/dist/node/index.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunk4ICNZPINjs = require('../chunk-4ICNZPIN.js');exports.createServer = _chunk4ICNZPINjs.t; exports.defineConfig = _chunk4ICNZPINjs.e; exports.defineConfigWithTheme = _chunk4ICNZPINjs.f; exports.defineThemePlugin = _chunk4ICNZPINjs.h; exports.defineUnoSetup = _chunk4ICNZPINjs.i; exports.getThemeRoot = _chunk4ICNZPINjs.m; exports.isPath = _chunk4ICNZPINjs.l; exports.resolveConfig = _chunk4ICNZPINjs.g; exports.resolveOptions = _chunk4ICNZPINjs.n;
+"use strict";Object.defineProperty(exports, "__esModule", {value: true});var _chunkS7EBKLNLjs = require('../chunk-S7EBKLNL.js');exports.build = _chunkS7EBKLNLjs.q; exports.createServer = _chunkS7EBKLNLjs.s; exports.defaultSiteConfig = _chunkS7EBKLNLjs.n; exports.defineAddon = _chunkS7EBKLNLjs.m; exports.defineConfig = _chunkS7EBKLNLjs.k; exports.defineSite = _chunkS7EBKLNLjs.i; exports.defineSiteWithTheme = _chunkS7EBKLNLjs.j; exports.defineTheme = _chunkS7EBKLNLjs.l; exports.defineUnoSetup = _chunkS7EBKLNLjs.o; exports.getIndexHtml = _chunkS7EBKLNLjs.f; exports.mergeViteConfigs = _chunkS7EBKLNLjs.e; exports.resolveOptions = _chunkS7EBKLNLjs.p; exports.ssgBuild = _chunkS7EBKLNLjs.r;

package/dist/node/index.mjs

@@ -1 +1 @@
-import{e as o,f as r,g as m,h as p,i as t,l as e,m as f,n as x,t as i}from"../chunk-WXYDKT6O.mjs";export{i as createServer,o as defineConfig,r as defineConfigWithTheme,p as defineThemePlugin,t as defineUnoSetup,f as getThemeRoot,e as isPath,m as resolveConfig,x as resolveOptions};
+import{e as o,f as r,i as m,j as p,k as t,l as e,m as f,n as x,o as i,p as a,q as b,r as c,s as d}from"../chunk-6PDG5NQV.mjs";export{b as build,d as createServer,x as defaultSiteConfig,f as defineAddon,t as defineConfig,m as defineSite,p as defineSiteWithTheme,e as defineTheme,i as defineUnoSetup,r as getIndexHtml,o as mergeViteConfigs,a as resolveOptions,c as ssgBuild};

package/dist/types/index.d.ts

@@ -1,4 +1,4 @@
-export { A as AlgoliaSearchOptions, P as PartialDeep, S as SocialLink, U as UserConfig, V as ValaxyConfig, a as ValaxyThemeConfig } from '../config-1d2e9ebd.js';
+export { A as AlgoliaSearchOptions, D as DefaultThemeConfig, P as PartialDeep, S as SiteConfig, a as SocialLink, U as UserSiteConfig } from '../config-1d500fb4.js';
 
 interface Post extends Record<string, any> {
     /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "valaxy",
-  "version": "0.9.3",
+  "version": "0.10.2",
   "description": "📄 Vite & Vue powered static blog generator.",
   "author": {
     "email": "me@yunyoujun.cn",
@@ -22,11 +22,7 @@
       "import": "./dist/node/index.mjs"
     },
     "./client/*": "./client/*",
-    "./client": {
-      "types": "./dist/client/index.d.ts",
-      "require": "./dist/client/index.js",
-      "import": "./dist/client/index.mjs"
-    },
+    "./client": "./client/index.ts",
     "./node": {
       "types": "./dist/node/index.d.ts",
       "require": "./dist/node/index.js",
@@ -57,23 +53,24 @@
     "@ctrl/tinycolor": "^3.4.1",
     "@iconify-json/carbon": "^1.1.6",
     "@iconify-json/ri": "^1.1.3",
-    "@intlify/vite-plugin-vue-i18n": "^3.4.0",
+    "@intlify/vite-plugin-vue-i18n": "^5.0.0",
     "@vitejs/plugin-vue": "^2.3.3",
-    "@vueuse/core": "^8.9.2",
+    "@vueuse/core": "^8.9.4",
     "@vueuse/head": "^0.7.6",
     "consola": "^2.15.3",
     "critters": "^0.0.16",
     "cross-spawn": "^7.0.3",
-    "dayjs": "^1.11.3",
+    "dayjs": "^1.11.4",
     "ejs": "^3.1.8",
     "escape-html": "^1.0.3",
     "feed": "^4.2.2",
     "global-dirs": "^3.0.0",
     "gray-matter": "^4.0.3",
     "is-installed-globally": "^0.4.0",
+    "jiti": "^1.14.0",
     "katex": "^0.16.0",
     "kolorist": "^1.5.1",
-    "lru-cache": "^7.13.0",
+    "lru-cache": "^7.13.1",
     "markdown-it": "^13.0.1",
     "markdown-it-anchor": "^8.6.4",
     "markdown-it-attrs": "^4.1.4",
@@ -84,12 +81,13 @@
     "markdown-it-task-lists": "^2.1.1",
     "nprogress": "^0.2.0",
     "open": "^8.4.0",
+    "pascal-case": "^3.1.2",
     "pinia": "^2.0.16",
     "sass": "^1.53.0",
     "shiki": "^0.10.1",
     "star-markdown-css": "^0.4.0",
     "unconfig": "^0.3.5",
-    "unocss": "^0.44.2",
+    "unocss": "^0.44.5",
     "unplugin-vue-components": "^0.21.1",
     "vite": "^2.9.14",
     "vite-plugin-pages": "^0.25.0",

package/types/config.ts

@@ -1,4 +1,4 @@
-export type ValaxyThemeConfig = Record<string, any>
+export type DefaultThemeConfig = Record<string, any>
 
 export interface SocialLink {
   /**
@@ -25,8 +25,8 @@ export interface AlgoliaSearchOptions {
   initialQuery?: string
 }
 
-// packages/valaxy/node/config.ts
-export interface ValaxyConfig<T = ValaxyThemeConfig> {
+// shared with valaxy node and client
+export interface SiteConfig<T = DefaultThemeConfig> {
   /**
    * enable auto (light/dark mode)
    * @default 'auto'
@@ -226,5 +226,4 @@ export type PartialDeep<T> = {
  * Valaxy User Config
  * @description Valaxy 用户配置
  */
-export type UserConfig<ThemeConfig = ValaxyThemeConfig> = PartialDeep<ValaxyConfig<ThemeConfig>>
-
+export type UserSiteConfig<ThemeConfig = DefaultThemeConfig> = PartialDeep<SiteConfig<ThemeConfig>>