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

package/dist/preset.d.ts

@@ -19,7 +19,40 @@ type Primitive =
 	| symbol
 	| bigint;
 
+/**
+Matches a JSON object.
+
+This type can be useful to enforce some input to be JSON-compatible or as a super-type to be extended from. Don't use this as a direct return type as the user would have to double-cast it: `jsonObject as unknown as CustomResponse`. Instead, you could extend your CustomResponse type from it to ensure your type only uses JSON-compatible types: `interface CustomResponse extends JsonObject { … }`.
+
+@category JSON
+*/
+type JsonObject = {[Key in string]: JsonValue} & {[Key in string]?: JsonValue | undefined};
+
+/**
+Matches a JSON array.
+
+@category JSON
+*/
+type JsonArray = JsonValue[] | readonly JsonValue[];
+
+/**
+Matches any valid JSON primitive value.
+
+@category JSON
+*/
+type JsonPrimitive = string | number | boolean | null;
+
+/**
+Matches any valid JSON value.
+
+@see `Jsonify` if you need to transform a type to one that is assignable to `JsonValue`.
+
+@category JSON
+*/
+type JsonValue = JsonPrimitive | JsonObject | JsonArray;
+
 declare global {
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions -- It has to be an `interface` so that it can be merged.
 	interface SymbolConstructor {
 		readonly observable: symbol;
 	}
@@ -85,8 +118,8 @@ declare namespace PackageJson$1 {
 			email?: string;
 		};
 
-	export interface DirectoryLocations {
-		[directoryType: string]: unknown;
+	export type DirectoryLocations = {
+		[directoryType: string]: JsonValue | undefined;
 
 		/**
 		Location for executable scripts. Sugar to generate entries in the `bin` property by walking the folder.
@@ -117,7 +150,7 @@ declare namespace PackageJson$1 {
 		Location for test files.
 		*/
 		test?: string;
-	}
+	};
 
 	export type Scripts = {
 		/**
@@ -267,22 +300,11 @@ declare namespace PackageJson$1 {
 	export type Dependency = Partial<Record<string, string>>;
 
 	/**
-	Conditions which provide a way to resolve a package entry point based on the environment.
+	A mapping of conditions and the paths to which they resolve.
 	*/
-	export type ExportCondition = LiteralUnion<
-		| 'import'
-		| 'require'
-		| 'node'
-		| 'node-addons'
-		| 'deno'
-		| 'browser'
-		| 'electron'
-		| 'react-native'
-		| 'default',
-		string
-	>;
-
-	type ExportConditions = {[condition in ExportCondition]: Exports};
+	type ExportConditions = { // eslint-disable-line @typescript-eslint/consistent-indexed-object-style
+		[condition: string]: Exports;
+	};
 
 	/**
 	Entry points of a module, optionally with conditions and subpath exports.
@@ -291,16 +313,16 @@ declare namespace PackageJson$1 {
 	| null
 	| string
 	| Array<string | ExportConditions>
-	| ExportConditions
-	| {[path: string]: Exports}; // eslint-disable-line @typescript-eslint/consistent-indexed-object-style
+	| ExportConditions;
 
 	/**
-	Import map entries of a module, optionally with conditions.
+	Import map entries of a module, optionally with conditions and subpath imports.
 	*/
 	export type Imports = { // eslint-disable-line @typescript-eslint/consistent-indexed-object-style
-		[key: string]: string | {[key in ExportCondition]: Exports};
+		[key: `#${string}`]: Exports;
 	};
 
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 	export interface NonStandardEntryPoints {
 		/**
 		An ECMAScript module ID that is the primary entry point to the program.
@@ -333,7 +355,7 @@ declare namespace PackageJson$1 {
 		sideEffects?: boolean | string[];
 	}
 
-	export interface TypeScriptConfiguration {
+	export type TypeScriptConfiguration = {
 		/**
 		Location of the bundled TypeScript declaration file.
 		*/
@@ -348,12 +370,12 @@ declare namespace PackageJson$1 {
 		Location of the bundled TypeScript declaration file. Alias of `types`.
 		*/
 		typings?: string;
-	}
+	};
 
 	/**
-	An alternative configuration for Yarn workspaces.
+	An alternative configuration for workspaces.
 	*/
-	export interface WorkspaceConfig {
+	export type WorkspaceConfig = {
 		/**
 		An array of workspace pattern strings which contain the workspace packages.
 		*/
@@ -362,10 +384,11 @@ declare namespace PackageJson$1 {
 		/**
 		Designed to solve the problem of packages which break when their `node_modules` are moved to the root workspace directory - a process known as hoisting. For these packages, both within your workspace, and also some that have been installed via `node_modules`, it is important to have a mechanism for preventing the default Yarn workspace behavior. By adding workspace pattern strings here, Yarn will resume non-workspace behavior for any package which matches the defined patterns.
 
-		[Read more](https://classic.yarnpkg.com/blog/2018/02/15/nohoist/)
+		[Supported](https://classic.yarnpkg.com/blog/2018/02/15/nohoist/) by Yarn.
+		[Not supported](https://github.com/npm/rfcs/issues/287) by npm.
 		*/
 		nohoist?: WorkspacePattern[];
-	}
+	};
 
 	/**
 	A workspace pattern points to a directory or group of directories which contain packages that should be included in the workspace installation process.
@@ -378,16 +401,7 @@ declare namespace PackageJson$1 {
 	*/
 	type WorkspacePattern = string;
 
-	export interface YarnConfiguration {
-		/**
-		Used to configure [Yarn workspaces](https://classic.yarnpkg.com/docs/workspaces/).
-
-		Workspaces allow you to manage multiple packages within the same repository in such a way that you only need to run `yarn install` once to install all of them in a single pass.
-
-		Please note that the top-level `private` property of `package.json` **must** be set to `true` in order to use workspaces.
-		*/
-		workspaces?: WorkspacePattern[] | WorkspaceConfig;
-
+	export type YarnConfiguration = {
 		/**
 		If your package only allows one version of a given dependency, and you’d like to enforce the same behavior as `yarn install --flat` on the command-line, set this to `true`.
 
@@ -399,18 +413,19 @@ declare namespace PackageJson$1 {
 		Selective version resolutions. Allows the definition of custom package versions inside dependencies without manual edits in the `yarn.lock` file.
 		*/
 		resolutions?: Dependency;
-	}
+	};
 
-	export interface JSPMConfiguration {
+	export type JSPMConfiguration = {
 		/**
 		JSPM configuration.
 		*/
 		jspm?: PackageJson$1;
-	}
+	};
 
 	/**
 	Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Containing standard npm properties.
 	*/
+	// eslint-disable-next-line @typescript-eslint/consistent-type-definitions
 	export interface PackageJsonStandard {
 		/**
 		The name of the package.
@@ -540,7 +555,7 @@ declare namespace PackageJson$1 {
 		/**
 		Is used to set configuration parameters used in package scripts that persist across upgrades.
 		*/
-		config?: Record<string, unknown>;
+		config?: JsonObject;
 
 		/**
 		The dependencies of the package.
@@ -581,7 +596,7 @@ declare namespace PackageJson$1 {
 		Engines that this package runs on.
 		*/
 		engines?: {
-			[EngineName in 'npm' | 'node' | string]?: string;
+			[EngineName in 'npm' | 'node' | string]?: string; // eslint-disable-line @typescript-eslint/no-redundant-type-constituents
 		};
 
 		/**
@@ -680,13 +695,41 @@ declare namespace PackageJson$1 {
 			*/
 			url: string;
 		};
+
+		/**
+		Used to configure [npm workspaces](https://docs.npmjs.com/cli/using-npm/workspaces) / [Yarn workspaces](https://classic.yarnpkg.com/docs/workspaces/).
+
+		Workspaces allow you to manage multiple packages within the same repository in such a way that you only need to run your install command once in order to install all of them in a single pass.
+
+		Please note that the top-level `private` property of `package.json` **must** be set to `true` in order to use workspaces.
+		*/
+		workspaces?: WorkspacePattern[] | WorkspaceConfig;
 	}
 
-	export interface PublishConfig {
+	/**
+	Type for [`package.json` file used by the Node.js runtime](https://nodejs.org/api/packages.html#nodejs-packagejson-field-definitions).
+	*/
+	export type NodeJsStandard = {
+		/**
+		Defines which package manager is expected to be used when working on the current project. It can set to any of the [supported package managers](https://nodejs.org/api/corepack.html#supported-package-managers), and will ensure that your teams use the exact same package manager versions without having to install anything else than Node.js.
+
+		__This field is currently experimental and needs to be opted-in; check the [Corepack](https://nodejs.org/api/corepack.html) page for details about the procedure.__
+
+		@example
+		```json
+		{
+			"packageManager": "<package manager name>@<version>"
+		}
+		```
+		*/
+		packageManager?: string;
+	};
+
+	export type PublishConfig = {
 		/**
 		Additional, less common properties from the [npm docs on `publishConfig`](https://docs.npmjs.com/cli/v7/configuring-npm/package-json#publishconfig).
 		*/
-		[additionalProperties: string]: unknown;
+		[additionalProperties: string]: JsonValue | undefined;
 
 		/**
 		When publishing scoped packages, the access level defaults to restricted. If you want your scoped package to be publicly viewable (and installable) set `--access=public`. The only valid values for access are public and restricted. Unscoped packages always have an access level of public.
@@ -706,7 +749,7 @@ declare namespace PackageJson$1 {
 		Default: `'latest'`
 		*/
 		tag?: string;
-	}
+	};
 }
 
 /**
@@ -715,16 +758,23 @@ Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-j
 @category File
 */
 type PackageJson$1 =
+JsonObject &
+PackageJson$1.NodeJsStandard &
 PackageJson$1.PackageJsonStandard &
 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 +808,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;
@@ -927,7 +1031,6 @@ type CoreCommon_StorybookRefs = Record<string, {
     url: string;
 } | {
     disable: boolean;
-    expanded?: boolean;
 }>;
 type DocsOptions = {
     /**
@@ -1037,8 +1140,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-e84041f2",
   "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-e84041f2",
+    "@storybook/core-common": "0.0.0-pr-23626-sha-e84041f2",
     "@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-e84041f2",
+    "@storybook/preset-html-webpack": "0.0.0-pr-23626-sha-e84041f2",
     "@types/node": "^16.0.0"
   },
   "devDependencies": {