@storybook/tanstack-react 0.0.0-pr-34863-sha-dc1c4dcb → 0.0.0-pr-34874-sha-dee98dbf

package/dist/index.d.ts

@@ -8,39 +8,31 @@ import { RoutesByPath, RouteOptions, ResolveParams, AnyContext } from '@tanstack
 import { BuilderOptions } from '@storybook/builder-vite';
 import { StorybookConfig as StorybookConfig$1 } from '@storybook/react-vite';
 
-/**
-Convert a union type to an intersection type.
-
-Inspired by [this Stack Overflow answer](https://stackoverflow.com/a/50375286/2172153).
-
-@example
-```
-import type {UnionToIntersection} from 'type-fest';
+declare global {
+	interface SymbolConstructor {
+		readonly observable: symbol;
+	}
+}
 
-type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};
+/**
+@see Simplify
+*/
+interface SimplifyOptions {
+	/**
+	Do the simplification recursively.
 
-type Intersection = UnionToIntersection<Union>;
-//=> {the(): void} & {great(arg: string): void} & {escape: boolean}
-```
+	@default false
+	*/
+	deep?: boolean;
+}
 
-@category Type
-*/
-type UnionToIntersection<Union> = (
-	// `extends unknown` is always going to be the case and is used to convert the
-	// `Union` into a [distributive conditional
-	// type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
-	Union extends unknown
-		// The union type is used as the only argument to a function since the union
-		// of function arguments is an intersection.
-		? (distributedUnion: Union) => void
-		// This won't happen.
-		: never
-		// Infer the `Intersection` type since TypeScript represents the positional
-		// arguments of unions of functions as an intersection of the union.
-) extends ((mergedIntersection: infer Intersection) => void)
-	// The `& Union` is to ensure result of `UnionToIntersection<A | B>` is always assignable to `A | B`
-	? Intersection & Union
-	: never;
+// Flatten a type without worrying about the result.
+type Flatten<
+	AnyType,
+	Options extends SimplifyOptions = {},
+> = Options['deep'] extends true
+	? {[KeyType in keyof AnyType]: Simplify<AnyType[KeyType], Options>}
+	: {[KeyType in keyof AnyType]: AnyType[KeyType]};
 
 /**
 Useful to flatten the type output to improve type hints shown in editors. And also to transform an interface into a type to aide with assignability.
@@ -87,25 +79,27 @@ const literal = {foo: 123, bar: 'hello', baz: 456};
 const someType: SomeType = literal;
 const someInterface: SomeInterface = literal;
 
-declare function fn(object: Record<string, unknown>): void;
+function fn(object: Record<string, unknown>): void {}
 
 fn(literal); // Good: literal object type is sealed
 fn(someType); // Good: type is sealed
-// @ts-expect-error
 fn(someInterface); // Error: Index signature for type 'string' is missing in type 'someInterface'. Because `interface` can be re-opened
 fn(someInterface as Simplify<SomeInterface>); // Good: transform an `interface` into a `type`
 ```
 
 @link https://github.com/microsoft/TypeScript/issues/15300
-@see {@link SimplifyDeep}
+
 @category Object
 */
-type Simplify<T> = {[KeyType in keyof T]: T[KeyType]} & {};
+type Simplify<
+	AnyType,
+	Options extends SimplifyOptions = {},
+> = Flatten<AnyType> extends AnyType
+	? Flatten<AnyType, Options>
+	: AnyType;
 
 /**
-Omit any index signatures from the given object type, leaving only explicitly defined properties.
-
-This is the counterpart of `PickIndexSignature`.
+Remove any index signatures from the given object type, so that only explicitly defined properties remain.
 
 Use-cases:
 - Remove overly permissive signatures from third-party types.
@@ -119,9 +113,8 @@ It relies on the fact that an empty object (`{}`) is assignable to an object wit
 ```
 const indexed: Record<string, unknown> = {}; // Allowed
 
-// @ts-expect-error
 const keyed: Record<'foo', unknown> = {}; // Error
-// TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
+// => TS2739: Type '{}' is missing the following properties from type 'Record<"foo" | "bar", unknown>': foo, bar
 ```
 
 Instead of causing a type error like the above, you can also use a [conditional type](https://www.typescriptlang.org/docs/handbook/2/conditional-types.html) to test whether a type is assignable to another:
@@ -130,75 +123,147 @@ Instead of causing a type error like the above, you can also use a [conditional
 type Indexed = {} extends Record<string, unknown>
 	? '✅ `{}` is assignable to `Record<string, unknown>`'
 	: '❌ `{}` is NOT assignable to `Record<string, unknown>`';
-
-type IndexedResult = Indexed;
-//=> '✅ `{}` is assignable to `Record<string, unknown>`'
+// => '✅ `{}` is assignable to `Record<string, unknown>`'
 
 type Keyed = {} extends Record<'foo' | 'bar', unknown>
-	? '✅ `{}` is assignable to `Record<\'foo\' | \'bar\', unknown>`'
-	: '❌ `{}` is NOT assignable to `Record<\'foo\' | \'bar\', unknown>`';
-
-type KeyedResult = Keyed;
-//=> '❌ `{}` is NOT assignable to `Record<\'foo\' | \'bar\', unknown>`'
+	? "✅ `{}` is assignable to `Record<'foo' | 'bar', unknown>`"
+	: "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`";
+// => "❌ `{}` is NOT assignable to `Record<'foo' | 'bar', unknown>`"
 ```
 
 Using a [mapped type](https://www.typescriptlang.org/docs/handbook/2/mapped-types.html#further-exploration), you can then check for each `KeyType` of `ObjectType`...
 
 ```
-type OmitIndexSignature<ObjectType> = {
+import type {RemoveIndexSignature} from 'type-fest';
+
+type RemoveIndexSignature<ObjectType> = {
 	[KeyType in keyof ObjectType // Map each key of `ObjectType`...
-	]: ObjectType[KeyType]; // ...to its original value, i.e. `OmitIndexSignature<Foo> == Foo`.
+	]: ObjectType[KeyType]; // ...to its original value, i.e. `RemoveIndexSignature<Foo> == Foo`.
 };
 ```
 
 ...whether an empty object (`{}`) would be assignable to an object with that `KeyType` (`Record<KeyType, unknown>`)...
 
 ```
-type OmitIndexSignature<ObjectType> = {
+import type {RemoveIndexSignature} from 'type-fest';
+
+type RemoveIndexSignature<ObjectType> = {
 	[KeyType in keyof ObjectType
-	// Is `{}` assignable to `Record<KeyType, unknown>`?
-	as {} extends Record<KeyType, unknown>
-		? never // ✅ `{}` is assignable to `Record<KeyType, unknown>`
-		: KeyType // ❌ `{}` is NOT assignable to `Record<KeyType, unknown>`
+		// Is `{}` assignable to `Record<KeyType, unknown>`?
+		as {} extends Record<KeyType, unknown>
+			? ... // ✅ `{}` is assignable to `Record<KeyType, unknown>`
+			: ... // ❌ `{}` is NOT assignable to `Record<KeyType, unknown>`
 	]: ObjectType[KeyType];
 };
 ```
 
 If `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a "real" key and we want to keep it.
 
+```
+import type {RemoveIndexSignature} from 'type-fest';
+
+type RemoveIndexSignature<ObjectType> = {
+	[KeyType in keyof ObjectType
+		as {} extends Record<KeyType, unknown>
+			? never // => Remove this `KeyType`.
+			: KeyType // => Keep this `KeyType` as it is.
+	]: ObjectType[KeyType];
+};
+```
+
 @example
 ```
-import type {OmitIndexSignature} from 'type-fest';
+import type {RemoveIndexSignature} from 'type-fest';
 
-type Example = {
+interface Example {
 	// These index signatures will be removed.
-	[x: string]: any;
-	[x: number]: any;
-	[x: symbol]: any;
-	[x: `head-${string}`]: string;
-	[x: `${string}-tail`]: string;
-	[x: `head-${string}-tail`]: string;
-	[x: `${bigint}`]: string;
-	[x: `embedded-${number}`]: string;
+	[x: string]: any
+	[x: number]: any
+	[x: symbol]: any
+	[x: `head-${string}`]: string
+	[x: `${string}-tail`]: string
+	[x: `head-${string}-tail`]: string
+	[x: `${bigint}`]: string
+	[x: `embedded-${number}`]: string
 
 	// These explicitly defined keys will remain.
 	foo: 'bar';
 	qux?: 'baz';
-};
+}
 
-type ExampleWithoutIndexSignatures = OmitIndexSignature<Example>;
-//=> {foo: 'bar'; qux?: 'baz'}
+type ExampleWithoutIndexSignatures = RemoveIndexSignature<Example>;
+// => { foo: 'bar'; qux?: 'baz' | undefined; }
 ```
 
-@see {@link PickIndexSignature}
 @category Object
 */
-type OmitIndexSignature<ObjectType> = {
+type RemoveIndexSignature<ObjectType> = {
 	[KeyType in keyof ObjectType as {} extends Record<KeyType, unknown>
 		? never
 		: KeyType]: ObjectType[KeyType];
 };
 
+/**
+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).
+
+Inspired by [this Stack Overflow answer](https://stackoverflow.com/a/50375286/2172153).
+
+@example
+```
+import type {UnionToIntersection} from 'type-fest';
+
+type Union = {the(): void} | {great(arg: string): void} | {escape: boolean};
+
+type Intersection = UnionToIntersection<Union>;
+//=> {the(): void; great(arg: string): void; escape: boolean};
+```
+
+A more applicable example which could make its way into your library code follows.
+
+@example
+```
+import type {UnionToIntersection} from 'type-fest';
+
+class CommandOne {
+	commands: {
+		a1: () => undefined,
+		b1: () => undefined,
+	}
+}
+
+class CommandTwo {
+	commands: {
+		a2: (argA: string) => undefined,
+		b2: (argB: string) => undefined,
+	}
+}
+
+const union = [new CommandOne(), new CommandTwo()].map(instance => instance.commands);
+type Union = typeof union;
+//=> {a1(): void; b1(): void} | {a2(argA: string): void; b2(argB: string): void}
+
+type Intersection = UnionToIntersection<Union>;
+//=> {a1(): void; b1(): void; a2(argA: string): void; b2(argB: string): void}
+```
+
+@category Type
+*/
+type UnionToIntersection<Union> = (
+	// `extends unknown` is always going to be the case and is used to convert the
+	// `Union` into a [distributive conditional
+	// type](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-2-8.html#distributive-conditional-types).
+	Union extends unknown
+		// The union type is used as the only argument to a function since the union
+		// of function arguments is an intersection.
+		? (distributedUnion: Union) => void
+		// This won't happen.
+		: never
+		// Infer the `Intersection` type since TypeScript represents the positional
+		// arguments of unions of functions as an intersection of the union.
+	) extends ((mergedIntersection: infer Intersection) => void)
+		? Intersection
+		: never;
+
 /** Union of every registered full path (e.g. `'/' | '/admin/users' | '/$libraryId/$version'`). */
 type RegisteredFullPath = keyof Register['router']['routesByPath'];
 type IsAppRouteTree<TRoute> = TRoute extends Register['router']['routeTree'] ? true : false;
@@ -324,7 +389,7 @@ interface TanStackTypes<TRoute = undefined, Path extends DefaultStoryPath<TRoute
 /** Extracts and unions all args types from an array of decorators. */
 type DecoratorsArgs<TRenderer extends Renderer, Decorators> = UnionToIntersection<Decorators extends DecoratorFunction<TRenderer, infer TArgs> ? TArgs : unknown>;
 type InferCombinedTypes<T, TArgs, Decorators> = ReactTypes & T & {
-    args: Simplify<TArgs & Simplify<OmitIndexSignature<DecoratorsArgs<ReactTypes & T, Decorators>>>>;
+    args: Simplify<TArgs & Simplify<RemoveIndexSignature<DecoratorsArgs<ReactTypes & T, Decorators>>>>;
 };
 type Preview<TRoute extends AnyRoute | undefined = undefined> = ProjectAnnotations<ReactTypes & TanStackTypes<TRoute>>;
 declare function definePreview<TRoute extends AnyRoute | undefined = undefined, const TPath extends DefaultStoryPath<TRoute> = DefaultStoryPath<TRoute>, Addons extends PreviewAddon<never>[] = []>(preview: {

package/dist/node/index.js

@@ -1,10 +1,10 @@
-import CJS_COMPAT_NODE_URL_3y2aivro9bk from 'node:url';
-import CJS_COMPAT_NODE_PATH_3y2aivro9bk from 'node:path';
-import CJS_COMPAT_NODE_MODULE_3y2aivro9bk from "node:module";
+import CJS_COMPAT_NODE_URL_1827c7h9ksp from 'node:url';
+import CJS_COMPAT_NODE_PATH_1827c7h9ksp from 'node:path';
+import CJS_COMPAT_NODE_MODULE_1827c7h9ksp from "node:module";
 
-var __filename = CJS_COMPAT_NODE_URL_3y2aivro9bk.fileURLToPath(import.meta.url);
-var __dirname = CJS_COMPAT_NODE_PATH_3y2aivro9bk.dirname(__filename);
-var require = CJS_COMPAT_NODE_MODULE_3y2aivro9bk.createRequire(import.meta.url);
+var __filename = CJS_COMPAT_NODE_URL_1827c7h9ksp.fileURLToPath(import.meta.url);
+var __dirname = CJS_COMPAT_NODE_PATH_1827c7h9ksp.dirname(__filename);
+var require = CJS_COMPAT_NODE_MODULE_1827c7h9ksp.createRequire(import.meta.url);
 
 // ------------------------------------------------------------
 // end of CJS compatibility banner, injected by Storybook's esbuild configuration

package/dist/preset.js

@@ -1,10 +1,10 @@
-import CJS_COMPAT_NODE_URL_3y2aivro9bk from 'node:url';
-import CJS_COMPAT_NODE_PATH_3y2aivro9bk from 'node:path';
-import CJS_COMPAT_NODE_MODULE_3y2aivro9bk from "node:module";
+import CJS_COMPAT_NODE_URL_1827c7h9ksp from 'node:url';
+import CJS_COMPAT_NODE_PATH_1827c7h9ksp from 'node:path';
+import CJS_COMPAT_NODE_MODULE_1827c7h9ksp from "node:module";
 
-var __filename = CJS_COMPAT_NODE_URL_3y2aivro9bk.fileURLToPath(import.meta.url);
-var __dirname = CJS_COMPAT_NODE_PATH_3y2aivro9bk.dirname(__filename);
-var require = CJS_COMPAT_NODE_MODULE_3y2aivro9bk.createRequire(import.meta.url);
+var __filename = CJS_COMPAT_NODE_URL_1827c7h9ksp.fileURLToPath(import.meta.url);
+var __dirname = CJS_COMPAT_NODE_PATH_1827c7h9ksp.dirname(__filename);
+var require = CJS_COMPAT_NODE_MODULE_1827c7h9ksp.createRequire(import.meta.url);
 
 // ------------------------------------------------------------
 // end of CJS compatibility banner, injected by Storybook's esbuild configuration

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@storybook/tanstack-react",
-  "version": "0.0.0-pr-34863-sha-dc1c4dcb",
+  "version": "0.0.0-pr-34874-sha-dee98dbf",
   "description": "Storybook for TanStack (React, Vite): Router and Start ready Storybook framework",
   "keywords": [
     "storybook",
@@ -75,9 +75,9 @@
     "!src/**/*"
   ],
   "dependencies": {
-    "@storybook/builder-vite": "0.0.0-pr-34863-sha-dc1c4dcb",
-    "@storybook/react": "0.0.0-pr-34863-sha-dc1c4dcb",
-    "@storybook/react-vite": "0.0.0-pr-34863-sha-dc1c4dcb"
+    "@storybook/builder-vite": "0.0.0-pr-34874-sha-dee98dbf",
+    "@storybook/react": "0.0.0-pr-34874-sha-dee98dbf",
+    "@storybook/react-vite": "0.0.0-pr-34874-sha-dee98dbf"
   },
   "devDependencies": {
     "@tanstack/react-router": "^1.168.10",
@@ -95,7 +95,7 @@
     "@tanstack/start-client-core": "^1.167.9",
     "react": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
     "react-dom": "^16.8.0 || ^17.0.0 || ^18.0.0 || ^19.0.0",
-    "storybook": "^0.0.0-pr-34863-sha-dc1c4dcb",
+    "storybook": "^0.0.0-pr-34874-sha-dee98dbf",
     "vite": "^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0"
   },
   "peerDependenciesMeta": {