@storybook/html-webpack5 7.2.0 → 7.2.2-alpha.0

package/dist/preset.d.ts

@@ -720,11 +720,17 @@ 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 ExportName = string;
+type MetaId = string;
 interface StoriesSpecifier {
     /**
      * When auto-titling, what to prefix all generated titles with (default: '')
@@ -753,15 +759,89 @@ interface IndexedStory {
 }
 interface IndexedCSFFile {
     meta: {
+        id?: string;
         title?: string;
         tags?: Tag[];
     };
     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[]>;
+    /**
+     * @soonDeprecated Use {@link index} instead
+     */
+    indexer?: never;
+};
+type DeprecatedIndexer = BaseIndexer & {
     indexer: (fileName: string, options: IndexerOptions) => Promise<IndexedCSFFile>;
-}
+    index?: never;
+};
+/**
+ * @soonDeprecated Use {@link Indexer} instead
+ */
+type StoryIndexer = Indexer | DeprecatedIndexer;
+/**
+ * The base input for indexing a story or docs entry.
+ */
+type BaseIndexInput = {
+    /** The file to import from e.g. the story file. */
+    importPath: Path;
+    /** The name of the export to import. */
+    exportName: ExportName;
+    /** The name of the entry, auto-generated from {@link exportName} if unspecified. */
+    name?: StoryName;
+    /** The location in the sidebar, auto-generated from {@link importPath} if unspecified. */
+    title?: ComponentTitle;
+    /**
+     * The custom id optionally set at `meta.id` if it needs to differ from the id generated via {@link title}.
+     * If unspecified, the meta id will be auto-generated from {@link title}.
+     * If specified, the meta in the CSF file _must_ have a matching id set at `meta.id`, to be correctly matched.
+     */
+    metaId?: MetaId;
+    /** Tags for filtering entries in Storybook and its tools. */
+    tags?: Tag[];
+    /**
+     * The id of the entry, auto-generated from {@link title}/{@link metaId} and {@link exportName} if unspecified.
+     * If specified, the story in the CSF file _must_ have a matching id set at `parameters.__id`, to be correctly matched.
+     * Only use this if you need to override the auto-generated id.
+     */
+    __id?: StoryId;
+};
+/**
+ * The input for indexing a story entry.
+ */
+type StoryIndexInput = BaseIndexInput & {
+    type: 'story';
+};
+/**
+ * The input for indexing a docs entry.
+ */
+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 +1117,13 @@ interface StorybookConfig {
     previewAnnotations?: PresetValue<Entry[]>;
     /**
      * Process CSF files for the story index.
+     * @soonDeprecated 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
      */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/html-webpack5",
-  "version": "7.2.0",
+  "version": "7.2.2-alpha.0",
   "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": "7.2.0",
-    "@storybook/core-common": "7.2.0",
+    "@storybook/builder-webpack5": "7.2.2-alpha.0",
+    "@storybook/core-common": "7.2.2-alpha.0",
     "@storybook/global": "^5.0.0",
-    "@storybook/html": "7.2.0",
-    "@storybook/preset-html-webpack": "7.2.0",
+    "@storybook/html": "7.2.2-alpha.0",
+    "@storybook/preset-html-webpack": "7.2.2-alpha.0",
     "@types/node": "^16.0.0"
   },
   "devDependencies": {