@storybook/html-webpack5 0.0.0-pr-22285-sha-d07bfc52 → 0.0.0-pr-23626-sha-0d5a537f

package/dist/preset.d.ts

@@ -720,11 +720,16 @@ PackageJson$1.NonStandardEntryPoints &
 PackageJson$1.TypeScriptConfiguration &
 PackageJson$1.YarnConfiguration &
 PackageJson$1.JSPMConfiguration;
+
+type StoryId = string;
+type ComponentTitle = string;
+type StoryName = string;
 type Tag = string;
 interface Parameters {
     [name: string]: any;
 }
 
+type ExportKey = string;
 interface StoriesSpecifier {
     /**
      * When auto-titling, what to prefix all generated titles with (default: '')
@@ -758,10 +763,64 @@ interface IndexedCSFFile {
     };
     stories: IndexedStory[];
 }
-interface StoryIndexer {
+/**
+ * FIXME: This is a temporary type to allow us to deprecate the old indexer API.
+ * We should remove this type and the deprecated indexer API in 8.0.
+ */
+type BaseIndexer = {
+    /**
+     * A regular expression that should match all files to be handled by this indexer
+     */
     test: RegExp;
+};
+/**
+ * An indexer describes which filenames it handles, and how to index each individual file - turning it into an entry in the index.
+ */
+type Indexer = BaseIndexer & {
+    /**
+     * Indexes a file containing stories or docs.
+     * @param fileName The name of the file to index.
+     * @param options {@link IndexerOptions} for indexing the file.
+     * @returns A promise that resolves to an array of {@link IndexInput} objects.
+     */
+    index: (fileName: string, options: IndexerOptions) => Promise<IndexInput[]>;
+    /**
+     * @deprecated Use {@link index} instead
+     */
+    indexer?: never;
+};
+type DeprecatedIndexer = BaseIndexer & {
     indexer: (fileName: string, options: IndexerOptions) => Promise<IndexedCSFFile>;
+    index?: never;
+};
+/**
+ * @deprecated Use {@link Indexer} instead
+ */
+type StoryIndexer = Indexer | DeprecatedIndexer;
+interface BaseIndexInput {
+    /** the file to import from e.g. the story file */
+    importPath: Path;
+    /** the key to import from the file e.g. the story export for this entry */
+    key: ExportKey;
+    /** the location in the sidebar, auto-generated from {@link importPath} if unspecified */
+    title?: ComponentTitle;
+    /** the name of the story, auto-generated from {@link key} if unspecified */
+    name?: StoryName;
+    /** the unique story ID, auto-generated from {@link title} and {@link name} if unspecified */
+    id?: StoryId;
+    /** tags for filtering entries in Storybook and its tools */
+    tags?: Tag[];
 }
+type StoryIndexInput = BaseIndexInput & {
+    type: 'story';
+};
+type DocsIndexInput = BaseIndexInput & {
+    type: 'docs';
+    /** paths to story files that must be pre-loaded for this docs entry */
+    storiesImports?: Path[];
+};
+type IndexInput = StoryIndexInput | DocsIndexInput;
+type Path = string;
 
 interface Options$1 {
     allowRegExp: boolean;
@@ -1037,8 +1096,13 @@ interface StorybookConfig {
     previewAnnotations?: PresetValue<Entry[]>;
     /**
      * Process CSF files for the story index.
+     * @deprecated use {@link indexers} instead
      */
     storyIndexers?: PresetValue<StoryIndexer[]>;
+    /**
+     * Process CSF files for the story index.
+     */
+    indexers?: PresetValue<Indexer[]>;
     /**
      * Docs related features in index generation
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/html-webpack5",
-  "version": "0.0.0-pr-22285-sha-d07bfc52",
+  "version": "0.0.0-pr-23626-sha-0d5a537f",
   "description": "Storybook for HTML: View HTML snippets in isolation with Hot Reloading.",
   "keywords": [
     "storybook"
@@ -47,11 +47,11 @@
     "prep": "../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@storybook/builder-webpack5": "0.0.0-pr-22285-sha-d07bfc52",
-    "@storybook/core-common": "0.0.0-pr-22285-sha-d07bfc52",
+    "@storybook/builder-webpack5": "0.0.0-pr-23626-sha-0d5a537f",
+    "@storybook/core-common": "0.0.0-pr-23626-sha-0d5a537f",
     "@storybook/global": "^5.0.0",
-    "@storybook/html": "0.0.0-pr-22285-sha-d07bfc52",
-    "@storybook/preset-html-webpack": "0.0.0-pr-22285-sha-d07bfc52",
+    "@storybook/html": "0.0.0-pr-23626-sha-0d5a537f",
+    "@storybook/preset-html-webpack": "0.0.0-pr-23626-sha-0d5a537f",
     "@types/node": "^16.0.0"
   },
   "devDependencies": {