@storybook/html-webpack5 0.0.0-pr-24997-sha-135e638f → 0.0.0-pr-24975-sha-7ac48cba

package/dist/preset.d.ts

@@ -1,6 +1,9 @@
 import { FileSystemCache } from 'file-system-cache';
 import { TransformOptions } from '@babel/core';
 import { Server } from 'http';
+import { StorybookConfig as StorybookConfig$1 } from './index.js';
+import '@storybook/preset-html-webpack';
+import '@storybook/builder-webpack5';
 
 /**
 Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
@@ -2784,13 +2787,9 @@ interface Presets {
     apply(extension: 'entries', config?: [], args?: any): Promise<unknown>;
     apply(extension: 'stories', config?: [], args?: any): Promise<StoriesEntry[]>;
     apply(extension: 'managerEntries', config: [], args?: any): Promise<string[]>;
-    apply(extension: 'refs', config?: [], args?: any): Promise<StorybookConfigRaw['refs']>;
-    apply(extension: 'core', config?: StorybookConfigRaw['core'], args?: any): Promise<NonNullable<StorybookConfigRaw['core']>>;
-    apply(extension: 'docs', config?: StorybookConfigRaw['docs'], args?: any): Promise<NonNullable<StorybookConfigRaw['docs']>>;
-    apply(extension: 'features', config?: StorybookConfigRaw['features'], args?: any): Promise<NonNullable<StorybookConfigRaw['features']>>;
-    apply(extension: 'typescript', config?: StorybookConfigRaw['typescript'], args?: any): Promise<NonNullable<StorybookConfigRaw['typescript']>>;
-    apply(extension: 'build', config?: StorybookConfigRaw['build'], args?: any): Promise<NonNullable<StorybookConfigRaw['build']>>;
-    apply(extension: 'staticDirs', config?: StorybookConfigRaw['staticDirs'], args?: any): Promise<StorybookConfigRaw['staticDirs']>;
+    apply(extension: 'refs', config?: [], args?: any): Promise<unknown>;
+    apply(extension: 'core', config?: {}, args?: any): Promise<CoreConfig>;
+    apply(extension: 'build', config?: {}, args?: any): Promise<StorybookConfig['build']>;
     apply<T>(extension: string, config?: T, args?: unknown): Promise<T>;
 }
 interface LoadedPreset {
@@ -2850,7 +2849,7 @@ interface BuilderOptions {
     cache?: FileSystemCache;
     configDir: string;
     docsMode?: boolean;
-    features?: StorybookConfigRaw['features'];
+    features?: StorybookConfig['features'];
     versionCheck?: VersionCheck;
     disableWebpackDefaults?: boolean;
     serverChannelUrl?: string;
@@ -2956,10 +2955,9 @@ interface TestBuildConfig {
     test?: TestBuildFlags;
 }
 /**
- * The interface for Storybook configuration used internally in presets
- * The difference is that these values are the raw values, AKA, not wrapped with `PresetValue<>`
+ * The interface for Storybook configuration in `main.ts` files.
  */
-interface StorybookConfigRaw {
+interface StorybookConfig {
     /**
      * Sets the addons you want to use with Storybook.
      *
@@ -2967,6 +2965,11 @@ interface StorybookConfigRaw {
      */
     addons?: Preset[];
     core?: CoreConfig;
+    /**
+     * Sets a list of directories of static files to be loaded by Storybook server
+     *
+     * @example `['./public']` or `[{from: './public', 'to': '/assets'}]`
+     */
     staticDirs?: (DirectoryMapping | string)[];
     logLevel?: string;
     features?: {
@@ -3008,29 +3011,91 @@ interface StorybookConfigRaw {
         disallowImplicitActionsInRenderV8?: boolean;
     };
     build?: TestBuildConfig;
+    /**
+     * Tells Storybook where to find stories.
+     *
+     * @example `['./src/*.stories.@(j|t)sx?']`
+     */
     stories: StoriesEntry[];
+    /**
+     * Framework, e.g. '@storybook/react-vite', required in v7
+     */
     framework?: Preset;
+    /**
+     * Controls how Storybook handles TypeScript files.
+     */
     typescript?: Partial<TypescriptOptions>;
-    refs?: CoreCommon_StorybookRefs;
-    babel?: TransformOptions;
-    swc?: Options$2;
-    env?: Record<string, string>;
-    babelDefault?: TransformOptions;
-    config?: Entry[];
-    previewAnnotations?: Entry[];
-    storyIndexers?: StoryIndexer[];
-    experimental_indexers?: Indexer[];
+    /**
+     * References external Storybooks
+     */
+    refs?: PresetValue<CoreCommon_StorybookRefs>;
+    /**
+     * Modify or return babel config.
+     */
+    babel?: (config: TransformOptions, options: Options) => TransformOptions | Promise<TransformOptions>;
+    /**
+     * Modify or return swc config.
+     */
+    swc?: (config: Options$2, options: Options) => Options$2 | Promise<Options$2>;
+    /**
+     * Modify or return env config.
+     */
+    env?: PresetValue<Record<string, string>>;
+    /**
+     * Modify or return babel config.
+     */
+    babelDefault?: (config: TransformOptions, options: Options) => TransformOptions | Promise<TransformOptions>;
+    /**
+     * Add additional scripts to run in the preview a la `.storybook/preview.js`
+     *
+     * @deprecated use `previewAnnotations` or `/preview.js` file instead
+     */
+    config?: PresetValue<Entry[]>;
+    /**
+     * Add additional scripts to run in the preview a la `.storybook/preview.js`
+     */
+    previewAnnotations?: PresetValue<Entry[]>;
+    /**
+     * Process CSF files for the story index.
+     * @deprecated use {@link experimental_indexers} instead
+     */
+    storyIndexers?: PresetValue<StoryIndexer[]>;
+    /**
+     * Process CSF files for the story index.
+     */
+    experimental_indexers?: PresetValue<Indexer[]>;
+    /**
+     * Docs related features in index generation
+     */
     docs?: DocsOptions;
-    previewHead?: string;
-    previewBody?: string;
+    /**
+     * Programmatically modify the preview head/body HTML.
+     * The previewHead and previewBody functions accept a string,
+     * which is the existing head/body, and return a modified string.
+     */
+    previewHead?: PresetValue<string>;
+    previewBody?: PresetValue<string>;
+    /**
+     * Programmatically override the preview's main page template.
+     * This should return a reference to a file containing an `.ejs` template
+     * that will be interpolated with environment variables.
+     *
+     * @example '.storybook/index.ejs'
+     */
     previewMainTemplate?: string;
-    managerHead?: string;
+    /**
+     * Programmatically modify the preview head/body HTML.
+     * The managerHead function accept a string,
+     * which is the existing head content, and return a modified string.
+     */
+    managerHead?: PresetValue<string>;
 }
-type PresetProperty<K, TStorybookConfig = StorybookConfigRaw> = TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | PresetPropertyFn<K, TStorybookConfig>;
-type PresetPropertyFn<K, TStorybookConfig = StorybookConfigRaw, TOptions = {}> = (config: TStorybookConfig[K extends keyof TStorybookConfig ? K : never], options: Options & TOptions) => TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | Promise<TStorybookConfig[K extends keyof TStorybookConfig ? K : never]>;
+type PresetValue<T> = T | ((config: T, options: Options) => T | Promise<T>);
+type PresetProperty<K, TStorybookConfig = StorybookConfig> = TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | PresetPropertyFn<K, TStorybookConfig>;
+type PresetPropertyFn<K, TStorybookConfig = StorybookConfig, TOptions = {}> = (config: TStorybookConfig[K extends keyof TStorybookConfig ? K : never], options: Options & TOptions) => TStorybookConfig[K extends keyof TStorybookConfig ? K : never] | Promise<TStorybookConfig[K extends keyof TStorybookConfig ? K : never]>;
 type Path = string;
 
-declare const addons: PresetProperty<'addons'>;
-declare const core: PresetProperty<'core'>;
+declare const addons: PresetProperty<'addons', StorybookConfig$1>;
+declare const core: PresetProperty<'core', StorybookConfig$1>;
 
 export { addons, core };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/html-webpack5",
-  "version": "0.0.0-pr-24997-sha-135e638f",
+  "version": "0.0.0-pr-24975-sha-7ac48cba",
   "description": "Storybook for HTML: View HTML snippets in isolation with Hot Reloading.",
   "keywords": [
     "storybook"
@@ -47,15 +47,15 @@
     "prep": "node --loader ../../../scripts/node_modules/esbuild-register/loader.js -r ../../../scripts/node_modules/esbuild-register/register.js ../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@storybook/builder-webpack5": "0.0.0-pr-24997-sha-135e638f",
-    "@storybook/core-common": "0.0.0-pr-24997-sha-135e638f",
+    "@storybook/builder-webpack5": "0.0.0-pr-24975-sha-7ac48cba",
+    "@storybook/core-common": "0.0.0-pr-24975-sha-7ac48cba",
     "@storybook/global": "^5.0.0",
-    "@storybook/html": "0.0.0-pr-24997-sha-135e638f",
-    "@storybook/preset-html-webpack": "0.0.0-pr-24997-sha-135e638f",
+    "@storybook/html": "0.0.0-pr-24975-sha-7ac48cba",
+    "@storybook/preset-html-webpack": "0.0.0-pr-24975-sha-7ac48cba",
     "@types/node": "^18.0.0"
   },
   "devDependencies": {
-    "typescript": "^5.3.2"
+    "typescript": "~4.9.3"
   },
   "peerDependencies": {
     "@babel/core": "*"