@storybook/react-webpack5 7.1.0-alpha.3 → 7.1.0-alpha.31

package/dist/index.d.ts

@@ -1,3 +1,27 @@
-export { F as FrameworkOptions, S as StorybookConfig } from './types-6a41b796.js';
-import '@storybook/preset-react-webpack';
-import '@storybook/builder-webpack5';
+import { ReactOptions, StorybookConfig as StorybookConfig$1, TypescriptOptions as TypescriptOptions$1 } from '@storybook/preset-react-webpack';
+import { BuilderOptions, StorybookConfigWebpack, TypescriptOptions } from '@storybook/builder-webpack5';
+
+type FrameworkName = '@storybook/react-webpack5';
+type BuilderName = '@storybook/builder-webpack5';
+type FrameworkOptions = ReactOptions & {
+    builder?: BuilderOptions;
+};
+type StorybookConfigFramework = {
+    framework: FrameworkName | {
+        name: FrameworkName;
+        options: FrameworkOptions;
+    };
+    core?: StorybookConfig$1['core'] & {
+        builder?: BuilderName | {
+            name: BuilderName;
+            options: BuilderOptions;
+        };
+    };
+    typescript?: Partial<TypescriptOptions & TypescriptOptions$1> & StorybookConfig$1['typescript'];
+};
+/**
+ * The interface for Storybook configuration in `main.ts` files.
+ */
+type StorybookConfig = Omit<StorybookConfig$1, keyof StorybookConfigWebpack | keyof StorybookConfigFramework> & StorybookConfigWebpack & StorybookConfigFramework;
+
+export { FrameworkOptions, StorybookConfig };

package/dist/index.mjs

@@ -0,0 +1 @@
+

package/dist/preset.d.ts

@@ -1,7 +1,7 @@
 import { FileSystemCache } from 'file-system-cache';
 import { TransformOptions } from '@babel/core';
 import { Server } from 'http';
-import { S as StorybookConfig$1 } from './types-6a41b796.js';
+import { StorybookConfig as StorybookConfig$1 } from './index.js';
 import '@storybook/preset-react-webpack';
 import '@storybook/builder-webpack5';
 
@@ -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,6 +758,8 @@ 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 &
@@ -1052,13 +1097,19 @@ interface StorybookConfig {
     previewHead?: PresetValue<string>;
     previewBody?: PresetValue<string>;
     /**
-     * Programatically override the preview's main page template.
+     * 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;
+    /**
+     * 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 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>;

package/package.json

@@ -1,18 +1,18 @@
 {
   "name": "@storybook/react-webpack5",
-  "version": "7.1.0-alpha.3",
+  "version": "7.1.0-alpha.31",
   "description": "Storybook for React: Develop React Component in isolation with Hot Reloading.",
   "keywords": [
     "storybook"
   ],
-  "homepage": "https://github.com/storybookjs/storybook/tree/main/frameworks/react-webpack5",
+  "homepage": "https://github.com/storybookjs/storybook/tree/next/code/frameworks/react-webpack5",
   "bugs": {
     "url": "https://github.com/storybookjs/storybook/issues"
   },
   "repository": {
     "type": "git",
     "url": "https://github.com/storybookjs/storybook.git",
-    "directory": "frameworks/react-webpack5"
+    "directory": "code/frameworks/react-webpack5"
   },
   "funding": {
     "type": "opencollective",
@@ -21,15 +21,14 @@
   "license": "MIT",
   "exports": {
     ".": {
+      "types": "./dist/index.d.ts",
       "node": "./dist/index.js",
       "require": "./dist/index.js",
-      "import": "./dist/index.mjs",
-      "types": "./dist/index.d.ts"
+      "import": "./dist/index.mjs"
     },
     "./preset": {
-      "require": "./dist/preset.js",
-      "import": "./dist/preset.mjs",
-      "types": "./dist/preset.d.ts"
+      "types": "./dist/preset.d.ts",
+      "require": "./dist/preset.js"
     },
     "./package.json": "./package.json"
   },
@@ -48,17 +47,17 @@
     "prep": "../../../scripts/prepare/bundle.ts"
   },
   "dependencies": {
-    "@storybook/builder-webpack5": "7.1.0-alpha.3",
-    "@storybook/preset-react-webpack": "7.1.0-alpha.3",
-    "@storybook/react": "7.1.0-alpha.3",
+    "@storybook/builder-webpack5": "7.1.0-alpha.31",
+    "@storybook/preset-react-webpack": "7.1.0-alpha.31",
+    "@storybook/react": "7.1.0-alpha.31",
     "@types/node": "^16.0.0"
   },
   "devDependencies": {
-    "jest-specific-snapshot": "^7.0.0",
+    "jest-specific-snapshot": "^8.0.0",
     "typescript": "~4.9.3"
   },
   "peerDependencies": {
-    "@babel/core": "^7.11.5",
+    "@babel/core": "^7.22.0",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0",
     "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0"
   },
@@ -83,5 +82,5 @@
     ],
     "platform": "node"
   },
-  "gitHead": "d0acd16fdf394463add948bac3f226b93f92c235"
-}
+  "gitHead": "e6a7fd8a655c69780bc20b9749c2699e44beae16"
+}

package/src/typings.d.ts

@@ -0,0 +1,44 @@
+// TODO: Replace, as soon as @types/react-dom 17.0.14 is used
+// Source: https://github.com/DefinitelyTyped/DefinitelyTyped/blob/fb0f14b7a35cde26ffaa82e7536c062e593e9ae6/types/react-dom/client.d.ts
+declare module 'react-dom/client' {
+  import React = require('react');
+
+  export interface HydrationOptions {
+    onHydrated?(suspenseInstance: Comment): void;
+    onDeleted?(suspenseInstance: Comment): void;
+    /**
+     * Prefix for `useId`.
+     */
+    identifierPrefix?: string;
+    onRecoverableError?: (error: unknown) => void;
+  }
+
+  export interface RootOptions {
+    /**
+     * Prefix for `useId`.
+     */
+    identifierPrefix?: string;
+    onRecoverableError?: (error: unknown) => void;
+  }
+
+  export interface Root {
+    render(children: React.ReactChild | Iterable<React.ReactNode>): void;
+    unmount(): void;
+  }
+
+  /**
+   * Replaces `ReactDOM.render` when the `.render` method is called and enables Concurrent Mode.
+   *
+   * @see https://reactjs.org/docs/concurrent-mode-reference.html#createroot
+   */
+  export function createRoot(
+    container: Element | Document | DocumentFragment | Comment,
+    options?: RootOptions
+  ): Root;
+
+  export function hydrateRoot(
+    container: Element | Document | DocumentFragment | Comment,
+    initialChildren: React.ReactChild | Iterable<React.ReactNode>,
+    options?: HydrationOptions
+  ): Root;
+}

package/dist/preset.mjs

@@ -1 +0,0 @@
-var __require=(x=>typeof require<"u"?require:typeof Proxy<"u"?new Proxy(x,{get:(a,b)=>(typeof require<"u"?require:a)[b]}):x)(function(x){if(typeof require<"u")return require.apply(this,arguments);throw new Error('Dynamic require of "'+x+'" is not supported')});import{dirname,join}from"path";var wrapForPnP=input=>dirname(__require.resolve(join(input,"package.json"))),addons=[wrapForPnP("@storybook/preset-react-webpack")],defaultFrameworkOptions={legacyRootApi:!0},frameworkOptions=async(_,options)=>{let config=await options.presets.apply("framework");return typeof config=="string"?{name:config,options:defaultFrameworkOptions}:typeof config>"u"?{name:wrapForPnP("@storybook/react-webpack5"),options:defaultFrameworkOptions}:{name:config.name,options:{...defaultFrameworkOptions,...config.options}}},core=async(config,options)=>{let framework=await options.presets.apply("framework");return{...config,builder:{name:wrapForPnP("@storybook/builder-webpack5"),options:typeof framework=="string"?{}:framework.options.builder||{}},renderer:wrapForPnP("@storybook/react")}},webpack=async config=>(config.resolve=config.resolve||{},config.resolve.alias={...config.resolve?.alias,"@storybook/react":wrapForPnP("@storybook/react")},config);export{addons,core,frameworkOptions,webpack};

package/dist/types-6a41b796.d.ts

@@ -1,27 +0,0 @@
-import { ReactOptions, StorybookConfig as StorybookConfig$1, TypescriptOptions as TypescriptOptions$1 } from '@storybook/preset-react-webpack';
-import { BuilderOptions, StorybookConfigWebpack, TypescriptOptions } from '@storybook/builder-webpack5';
-
-type FrameworkName = '@storybook/react-webpack5';
-type BuilderName = '@storybook/builder-webpack5';
-type FrameworkOptions = ReactOptions & {
-    builder?: BuilderOptions;
-};
-type StorybookConfigFramework = {
-    framework: FrameworkName | {
-        name: FrameworkName;
-        options: FrameworkOptions;
-    };
-    core?: StorybookConfig$1['core'] & {
-        builder?: BuilderName | {
-            name: BuilderName;
-            options: BuilderOptions;
-        };
-    };
-    typescript?: Partial<TypescriptOptions & TypescriptOptions$1> & StorybookConfig$1['typescript'];
-};
-/**
- * The interface for Storybook configuration in `main.ts` files.
- */
-type StorybookConfig = Omit<StorybookConfig$1, keyof StorybookConfigWebpack | keyof StorybookConfigFramework> & StorybookConfigWebpack & StorybookConfigFramework;
-
-export { FrameworkOptions as F, StorybookConfig as S };