storybook 10.2.0-alpha.14 → 10.2.0-alpha.16

package/dist/csf/index.d.ts

@@ -1,4 +1,4 @@
-import { StorybookTypes, Renderer as Renderer$1, ProjectAnnotations as ProjectAnnotations$1, NormalizedProjectAnnotations, Args as Args$1, ComponentAnnotations as ComponentAnnotations$1, StoryAnnotations as StoryAnnotations$1, ComposedStoryFn, TestFunction as TestFunction$1 } from 'storybook/internal/types';
+import { StorybookTypes, Renderer as Renderer$1, ProjectAnnotations as ProjectAnnotations$1, NormalizedProjectAnnotations, ComponentAnnotations as ComponentAnnotations$1, StoryAnnotations as StoryAnnotations$1, ComposedStoryFn, TestFunction as TestFunction$1 } from 'storybook/internal/types';
 import { AddonTypes as AddonTypes$1, StoryContext as StoryContext$1 } from 'storybook/internal/csf';
 
 declare global {
@@ -7,6 +7,74 @@ declare global {
 	}
 }
 
+/**
+Returns a boolean for whether the two given types are equal.
+
+@link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
+@link https://stackoverflow.com/questions/68961864/how-does-the-equals-work-in-typescript/68963796#68963796
+*/
+type IsEqual<T, U> =
+	(<G>() => G extends T ? 1 : 2) extends
+	(<G>() => G extends U ? 1 : 2)
+		? true
+		: false;
+
+/**
+Filter out keys from an object.
+
+Returns `never` if `Exclude` is strictly equal to `Key`.
+Returns `never` if `Key` extends `Exclude`.
+Returns `Key` otherwise.
+
+@example
+```
+type Filtered = Filter<'foo', 'foo'>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', string>;
+//=> never
+```
+
+@example
+```
+type Filtered = Filter<'bar', 'foo'>;
+//=> 'bar'
+```
+
+@see {Except}
+*/
+type Filter<KeyType, ExcludeType> = IsEqual<KeyType, ExcludeType> extends true ? never : (KeyType extends ExcludeType ? never : KeyType);
+
+/**
+Create a type from an object type without certain keys.
+
+This type is a stricter version of [`Omit`](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-5.html#the-omit-helper-type). The `Omit` type does not restrict the omitted keys to be keys present on the given type, while `Except` does. The benefits of a stricter type are avoiding typos and allowing the compiler to pick up on rename refactors automatically.
+
+This type was proposed to the TypeScript team, which declined it, saying they prefer that libraries implement stricter versions of the built-in types ([microsoft/TypeScript#30825](https://github.com/microsoft/TypeScript/issues/30825#issuecomment-523668235)).
+
+@example
+```
+import type {Except} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b: string;
+	c: boolean;
+};
+
+type FooWithoutA = Except<Foo, 'a' | 'c'>;
+//=> {b: string};
+```
+
+@category Object
+*/
+type Except<ObjectType, KeysType extends keyof ObjectType> = {
+	[KeyType in keyof ObjectType as Filter<KeyType, KeysType>]: ObjectType[KeyType];
+};
+
 /**
 @see Simplify
 */
@@ -196,6 +264,39 @@ type RemoveIndexSignature<ObjectType> = {
 		: KeyType]: ObjectType[KeyType];
 };
 
+/**
+Create a type that makes the given keys optional. The remaining keys are kept as is. The sister of the `SetRequired` type.
+
+Use-case: You want to define a single model where the only thing that changes is whether or not some of the keys are optional.
+
+@example
+```
+import type {SetOptional} from 'type-fest';
+
+type Foo = {
+	a: number;
+	b?: string;
+	c: boolean;
+}
+
+type SomeOptional = SetOptional<Foo, 'b' | 'c'>;
+// type SomeOptional = {
+// 	a: number;
+// 	b?: string; // Was already optional and still is.
+// 	c?: boolean; // Is now optional.
+// }
+```
+
+@category Object
+*/
+type SetOptional<BaseType, Keys extends keyof BaseType> =
+	Simplify<
+		// Pick just the keys that are readonly from the base type.
+		Except<BaseType, Keys> &
+		// Pick the keys that should be mutable from the base type and make them mutable.
+		Partial<Pick<BaseType, Keys>>
+	>;
+
 /**
 Convert a union type to an intersection type using [distributive conditional types](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
 
@@ -515,8 +616,9 @@ interface TestTypes {
 interface Viewport {
     name: string;
     styles: ViewportStyles;
-    type?: 'desktop' | 'mobile' | 'tablet' | 'other';
+    type?: ViewportType;
 }
+type ViewportType = 'desktop' | 'mobile' | 'tablet' | 'watch' | 'other';
 interface ViewportStyles {
     height: string;
     width: string;
@@ -524,7 +626,8 @@ interface ViewportStyles {
 type GlobalState = {
     /**
      * When set, the viewport is applied and cannot be changed using the toolbar. Must match the key
-     * of one of the available viewports.
+     * of one of the available viewports or follow the format '{width}-{height}', e.g. '320-480' which
+     * may include a unit (e.g. '100vw' or '100pct').
      */
     value: string | undefined;
     /**
@@ -671,8 +774,8 @@ interface InputType {
         category?: string;
         /** @see https://storybook.js.org/docs/api/arg-types#tabledefaultvalue */
         defaultValue?: {
-            summary?: string;
-            detail?: string;
+            summary?: string | undefined;
+            detail?: string | undefined;
         };
         /** @see https://storybook.js.org/docs/api/arg-types#tabledisable */
         disable?: boolean;
@@ -680,8 +783,8 @@ interface InputType {
         subcategory?: string;
         /** @see https://storybook.js.org/docs/api/arg-types#tabletype */
         type?: {
-            summary?: string;
-            detail?: string;
+            summary?: string | undefined;
+            detail?: string | undefined;
         };
     };
     /** @see https://storybook.js.org/docs/api/arg-types#type */
@@ -719,7 +822,23 @@ interface GlobalTypes {
 interface StrictGlobalTypes {
     [name: string]: StrictInputType;
 }
+/**
+ * AddonTypes allows addons to extend the type system with additional args, parameters, and globals.
+ *
+ * Addons can use `definePreviewAddon<AddonTypes>()` to declare additional types that will be merged
+ * into the story context. For example, an addon that provides a `theme` arg could declare:
+ *
+ * ```ts
+ * const themeAddon = definePreviewAddon<{ args: { theme: 'light' | 'dark' } }>({
+ *   decorators: [(Story, { args }) => <ThemeProvider theme={args.theme}><Story /></ThemeProvider>]
+ * });
+ * ```
+ *
+ * When users include this addon in their preview config, the `theme` arg becomes available and
+ * type-checked across all stories.
+ */
 interface AddonTypes {
+    args?: unknown;
     parameters?: Record<string, any>;
     globals?: Record<string, any>;
 }
@@ -989,11 +1108,12 @@ interface Preview<TRenderer extends Renderer$1 = Renderer$1> {
         addons?: PreviewAddon<never>[];
     };
     composed: NormalizedProjectAnnotations<TRenderer>;
-    meta<TArgs extends Args$1, TInput extends ComponentAnnotations$1<TRenderer & {
+    meta<TArgs, TInput extends ComponentAnnotations$1<TRenderer & {
         args: TArgs;
-    }, TArgs>>(input: TInput): Meta<TRenderer & {
+    }, TArgs & TRenderer['args']>>(input: TInput): Meta<TRenderer & {
         args: TArgs;
     }, TInput>;
+    type<T>(): Preview<TRenderer & T>;
 }
 type InferTypes<T extends PreviewAddon<never>[]> = T extends PreviewAddon<infer C>[] ? C & {
     csf4: true;
@@ -1005,14 +1125,14 @@ interface PreviewAddon<in TExtraContext extends AddonTypes$1 = AddonTypes$1> ext
 }
 declare function definePreviewAddon<TExtraContext extends AddonTypes$1 = AddonTypes$1>(preview: ProjectAnnotations$1<Renderer$1>): PreviewAddon<TExtraContext>;
 declare function isPreview(input: unknown): input is Preview<Renderer$1>;
-interface Meta<TRenderer extends Renderer$1, TInput extends ComponentAnnotations$1<TRenderer, TRenderer['args']> = ComponentAnnotations$1<TRenderer, TRenderer['args']>> {
+interface Meta<TRenderer extends Renderer$1, TMetaInput extends ComponentAnnotations$1<TRenderer, TRenderer['args']> = ComponentAnnotations$1<TRenderer, TRenderer['args']>> {
     readonly _tag: 'Meta';
-    input: TInput;
+    input: TMetaInput;
     preview: Preview<TRenderer>;
     story(input?: () => TRenderer['storyResult']): Story<TRenderer, {
         render: () => TRenderer['storyResult'];
     }>;
-    story<TInput extends StoryAnnotations$1<TRenderer, TRenderer['args']>>(input?: TInput): Story<TRenderer, TInput>;
+    story<TInput extends StoryAnnotations$1<TRenderer, TRenderer['args'], SetOptional<TRenderer['args'], keyof TRenderer['args'] & keyof TMetaInput['args']>>>(input?: TInput): Story<TRenderer, TInput>;
 }
 declare function isMeta(input: unknown): input is Meta<Renderer$1>;
 interface Story<TRenderer extends Renderer$1, TInput extends StoryAnnotations$1<TRenderer, TRenderer['args']> = StoryAnnotations$1<TRenderer, TRenderer['args']>> {

package/dist/csf/index.js

@@ -10,7 +10,7 @@ import {
   mountDestructured,
   normalizeArrays,
   normalizeProjectAnnotations
-} from "../_browser-chunks/chunk-BGSDJMFM.js";
+} from "../_browser-chunks/chunk-NVLTWT3B.js";
 import "../_browser-chunks/chunk-MEXTPDJG.js";
 import {
   Tag
@@ -1825,6 +1825,9 @@ function definePreview(input) {
         composeConfigs([...getCoreAnnotations(), ...addons2 ?? [], rest])
       ), composed;
     },
+    type() {
+      return this;
+    },
     meta(meta) {
       return defineMeta(meta, this);
     }
@@ -1843,7 +1846,7 @@ function isMeta(input) {
 function defineMeta(input, preview) {
   return {
     _tag: "Meta",
-    input,
+    input: { ...input, parameters: { ...input.parameters, csfFactory: !0 } },
     preview,
     // @ts-expect-error hard
     story(story = {}) {

package/dist/csf-tools/index.js

@@ -1,10 +1,10 @@
-import CJS_COMPAT_NODE_URL_bgtyoteey4s from 'node:url';
-import CJS_COMPAT_NODE_PATH_bgtyoteey4s from 'node:path';
-import CJS_COMPAT_NODE_MODULE_bgtyoteey4s from "node:module";
+import CJS_COMPAT_NODE_URL_4zwbyhk64wx from 'node:url';
+import CJS_COMPAT_NODE_PATH_4zwbyhk64wx from 'node:path';
+import CJS_COMPAT_NODE_MODULE_4zwbyhk64wx from "node:module";
 
-var __filename = CJS_COMPAT_NODE_URL_bgtyoteey4s.fileURLToPath(import.meta.url);
-var __dirname = CJS_COMPAT_NODE_PATH_bgtyoteey4s.dirname(__filename);
-var require = CJS_COMPAT_NODE_MODULE_bgtyoteey4s.createRequire(import.meta.url);
+var __filename = CJS_COMPAT_NODE_URL_4zwbyhk64wx.fileURLToPath(import.meta.url);
+var __dirname = CJS_COMPAT_NODE_PATH_4zwbyhk64wx.dirname(__filename);
+var require = CJS_COMPAT_NODE_MODULE_4zwbyhk64wx.createRequire(import.meta.url);
 
 // ------------------------------------------------------------
 // end of CJS compatibility banner, injected by Storybook's esbuild configuration
@@ -38,10 +38,10 @@ import {
   vitestTransform,
   writeConfig,
   writeCsf
-} from "../_node-chunks/chunk-TXHI4M3M.js";
-import "../_node-chunks/chunk-CMIHYY2B.js";
-import "../_node-chunks/chunk-YUBIHW7G.js";
-import "../_node-chunks/chunk-E6HZLFOP.js";
+} from "../_node-chunks/chunk-TLGG6YAX.js";
+import "../_node-chunks/chunk-5E2HAJXY.js";
+import "../_node-chunks/chunk-YFUVKP3W.js";
+import "../_node-chunks/chunk-3PMH6BEP.js";
 export {
   BadMetaError,
   ConfigFile,

package/dist/docs-tools/index.d.ts

@@ -15,8 +15,8 @@ interface JsDocTags {
     returns?: JsDocReturns | null;
 }
 interface PropSummaryValue {
-    summary?: string;
-    detail?: string;
+    summary?: string | undefined;
+    detail?: string | undefined;
 }
 type PropType = PropSummaryValue;
 type PropDefaultValue = PropSummaryValue;