@histoire/shared 0.14.1 → 0.15.0

package/dist/types/config.d.ts

@@ -197,7 +197,7 @@ export interface HistoireConfig {
     /**
      * Transpile dependencies when collecting stories on Node.js
      */
-    viteNodeInlineDeps?: RegExp[];
+    viteNodeInlineDeps?: (string | RegExp)[];
     /**
      * Determine the transform method of modules
      */
@@ -223,5 +223,15 @@ export interface HistoireConfig {
      * By default based on available number of cores.
      */
     collectMaxThreads?: number;
+    /**
+     * Build options
+     */
+    build?: {
+        /**
+         * By default all dependencies in `node_modules` are bundled into a single 'vendors' file.
+         * You can use this option to exclude some dependencies from this file.
+         */
+        excludeFromVendorsChunk?: (string | RegExp)[];
+    };
 }
 export type ConfigMode = 'build' | 'dev';

package/dist/types/plugin.d.ts

@@ -2,6 +2,7 @@ import type path from 'pathe';
 import type fs from 'fs-extra';
 import type pc from 'picocolors';
 import type chokidar from 'chokidar';
+import type { InlineConfig as ViteInlineConfig } from 'vite';
 import type { ServerStoryFile, ServerStory, ServerVariant } from './story.js';
 import type { HistoireConfig, ConfigMode } from './config.js';
 import type { PluginCommand } from './command.js';
@@ -36,16 +37,19 @@ export interface PluginApiBase {
 export interface PluginApiDev extends PluginApiBase {
     watcher: typeof chokidar;
 }
-export type BuildEndCallback = () => Promise<void> | void;
+export type ChangeViteConfigCallback = (config: ViteInlineConfig) => Awaitable<void>;
+export type BuildEndCallback = () => Awaitable<void>;
 export type PreviewStoryCallback = (payload: {
     file: string;
     story: ServerStory;
     variant: ServerVariant;
     url: string;
-}) => Promise<void> | void;
+}) => Awaitable<void>;
 export interface PluginApiBuild extends PluginApiBase {
+    changeViteConfigCallbacks: ChangeViteConfigCallback[];
     buildEndCallbacks: BuildEndCallback[];
     previewStoryCallbacks: PreviewStoryCallback[];
+    changeViteConfig: (cb: ChangeViteConfigCallback) => void;
     onBuildEnd: (cb: BuildEndCallback) => void;
     onPreviewStory: (cb: PreviewStoryCallback) => void;
 }
@@ -79,16 +83,20 @@ export interface Plugin {
     /**
      * Use this hook to read and store the final resolved histoire config.
      */
-    configResolved?: (config: HistoireConfig) => void | Promise<void>;
+    configResolved?: (config: HistoireConfig) => Awaitable<void>;
     /**
      * Use this hook to do processing during development. The `onCleanup` hook
      * should handle cleanup tasks when development server is closed.
      */
-    onDev?: (api: PluginApiDev, onCleanup: (cb: () => void | Promise<void>) => void) => void | Promise<void>;
+    onDev?: (api: PluginApiDev, onCleanup: (cb: () => Awaitable<void>) => void) => Awaitable<void>;
     /**
      * Use this hook to do processing during production build.
      */
-    onBuild?: (api: PluginApiBuild) => void | Promise<void>;
+    onBuild?: (api: PluginApiBuild) => Awaitable<void>;
+    /**
+     * Use this hook to do processing when preview is started.
+     */
+    onPreview?: () => Awaitable<void>;
     /**
      * This plugin exposes a support plugin (example: Vue, Svelte, etc.)
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@histoire/shared",
-  "version": "0.14.1",
+  "version": "0.15.0",
   "description": "Shared utilities for Histoire",
   "license": "MIT",
   "author": {
@@ -25,7 +25,7 @@
   "types": "./dist/index.d.ts",
   "sideEffects": false,
   "dependencies": {
-    "@histoire/vendors": "^0.14.1",
+    "@histoire/vendors": "^0.15.0",
     "@types/fs-extra": "^9.0.13",
     "@types/markdown-it": "^12.2.3",
     "chokidar": "^3.5.3",

package/src/types/config.ts

@@ -206,7 +206,7 @@ export interface HistoireConfig {
   /**
    * Transpile dependencies when collecting stories on Node.js
    */
-  viteNodeInlineDeps?: RegExp[]
+  viteNodeInlineDeps?: (string | RegExp)[]
   /**
    * Determine the transform method of modules
    */
@@ -232,6 +232,16 @@ export interface HistoireConfig {
    * By default based on available number of cores.
    */
   collectMaxThreads?: number
+  /**
+   * Build options
+   */
+  build?: {
+    /**
+     * By default all dependencies in `node_modules` are bundled into a single 'vendors' file.
+     * You can use this option to exclude some dependencies from this file.
+     */
+    excludeFromVendorsChunk?: (string | RegExp)[]
+  }
 }
 
 export type ConfigMode = 'build' | 'dev'

package/src/types/plugin.ts

@@ -2,6 +2,7 @@ import type path from 'pathe'
 import type fs from 'fs-extra'
 import type pc from 'picocolors'
 import type chokidar from 'chokidar'
+import type { InlineConfig as ViteInlineConfig } from 'vite'
 import type {
   ServerStoryFile,
   ServerStory,
@@ -56,13 +57,16 @@ export interface PluginApiDev extends PluginApiBase {
   watcher: typeof chokidar
 }
 
-export type BuildEndCallback = () => Promise<void> | void
-export type PreviewStoryCallback = (payload: { file: string, story: ServerStory, variant: ServerVariant, url: string }) => Promise<void> | void
+export type ChangeViteConfigCallback = (config: ViteInlineConfig) => Awaitable<void>
+export type BuildEndCallback = () => Awaitable<void>
+export type PreviewStoryCallback = (payload: { file: string, story: ServerStory, variant: ServerVariant, url: string }) => Awaitable<void>
 
 export interface PluginApiBuild extends PluginApiBase {
+  changeViteConfigCallbacks: ChangeViteConfigCallback[]
   buildEndCallbacks: BuildEndCallback[]
   previewStoryCallbacks: PreviewStoryCallback[]
 
+  changeViteConfig: (cb: ChangeViteConfigCallback) => void
   onBuildEnd: (cb: BuildEndCallback) => void
   onPreviewStory: (cb: PreviewStoryCallback) => void
 }
@@ -98,16 +102,20 @@ export interface Plugin {
   /**
    * Use this hook to read and store the final resolved histoire config.
    */
-  configResolved?: (config: HistoireConfig) => void | Promise<void>
+  configResolved?: (config: HistoireConfig) => Awaitable<void>
   /**
    * Use this hook to do processing during development. The `onCleanup` hook
    * should handle cleanup tasks when development server is closed.
    */
-  onDev?: (api: PluginApiDev, onCleanup: (cb: () => void | Promise<void>) => void) => void | Promise<void>
+  onDev?: (api: PluginApiDev, onCleanup: (cb: () => Awaitable<void>) => void) => Awaitable<void>
   /**
    * Use this hook to do processing during production build.
    */
-  onBuild?: (api: PluginApiBuild) => void | Promise<void>
+  onBuild?: (api: PluginApiBuild) => Awaitable<void>
+  /**
+   * Use this hook to do processing when preview is started.
+   */
+  onPreview?: () => Awaitable<void>
   /**
    * This plugin exposes a support plugin (example: Vue, Svelte, etc.)
    */