@storybook/tanstack-react 10.5.2 → 10.6.0-alpha.1

package/dist/chunk-B2-fTWlC.d.ts

@@ -0,0 +1,131 @@
+import { CompatibleString } from "storybook/internal/types";
+import { AnyRoute, FileRoutesByPath, Register } from "@tanstack/react-router";
+import { Decorator } from "@storybook/react";
+import { AnyContext, ResolveParams, RouteOptions, RoutesByPath } from "@tanstack/router-core";
+import { BuilderOptions } from "@storybook/builder-vite";
+import { StorybookConfig } from "@storybook/react-vite";
+
+//#region code/frameworks/tanstack-react/.dts-emit/code/frameworks/tanstack-react/src/routing/types.d.ts
+/** 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;
+type IsRoute<T> = T extends AnyRoute ? true : T extends FileRoutesByPath[keyof FileRoutesByPath] ? true : false;
+type ExtractAllPathsFromFileRoutes<TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] | AnyRoute> = TRoute['path'];
+type StoryRoutePath<TRoute = undefined> = TRoute extends FileRoutesByPath[keyof FileRoutesByPath] ? ExtractAllPathsFromFileRoutes<TRoute> : keyof FileRoutesByPath | `/${string}`;
+type StoryRouteSearch<TRoute> = IsAppRouteTree<TRoute> extends true ? Record<string, unknown> : TRoute extends FileRoutesByPath[keyof FileRoutesByPath] ? TRoute['preLoaderRoute'] extends {
+  types: {
+    allSearch: infer A;
+  };
+} ? A : never : Record<string, unknown>;
+type StoryRouteFileOptions<TRoute = undefined> = IsRoute<TRoute> extends true ? TRoute extends {
+  options: infer O;
+} ? Pick<O, Extract<keyof O, 'loader' | 'beforeLoad' | 'validateSearch' | 'loaderDeps' | 'context' | 'params' | 'head' | 'search' | 'parseParams' | 'context'>> : Pick<RouteOptions<unknown>, 'loader' | 'beforeLoad' | 'validateSearch' | 'loaderDeps' | 'context' | 'params' | 'head' | 'search' | 'parseParams' | 'context'> : Pick<RouteOptions<unknown>, 'loader' | 'beforeLoad' | 'validateSearch' | 'loaderDeps' | 'context' | 'params' | 'head' | 'search' | 'parseParams' | 'context'>;
+type CreateStoryRouteOptions<TRoute = undefined> = StoryRouteFileOptions<TRoute> & {
+  path?: StoryRoutePath<TRoute>;
+};
+type StoryRouteOptions<TRoute = undefined> = CreateStoryRouteOptions<TRoute> | (TRoute extends AnyRoute ? TRoute : AnyRoute);
+/**
+ * Per-route override options for use inside `RouteTreeOverrides`.
+ * Users can override `loader`, `beforeLoad`, etc. for a specific route.
+ */
+interface RouteOverrideOptions<TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] | undefined = undefined> {
+  /** Override the route's loader function. */
+  loader?: TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] ? TRoute['options']['loader'] | ((ctx: unknown) => Promise<unknown> | unknown) : (ctx: unknown) => Promise<unknown> | unknown;
+  /** Override the route's beforeLoad function. */
+  beforeLoad?: TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] ? TRoute['options']['beforeLoad'] | ((ctx: unknown) => Promise<void> | void) : (ctx: unknown) => Promise<void> | void;
+  /** Override the route's search params validation. */
+  validateSearch?: TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] ? TRoute['options']['validateSearch'] | ((search: unknown) => Promise<void> | void) : (search: unknown) => Promise<void> | void;
+  /** Override the route's loader dependencies. */
+  loaderDeps?: TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] ? TRoute['options']['loaderDeps'] | string[] : string[];
+  /** Override the route's context function. */
+  context?: TRoute extends FileRoutesByPath[keyof FileRoutesByPath]['preLoaderRoute'] ? TRoute['options']['context'] | ((ctx: unknown) => Promise<unknown> | unknown) : (ctx: unknown) => Promise<unknown> | unknown;
+}
+/**
+ * A map of route overrides keyed by route ID.
+ * Each entry can override `loader`, `beforeLoad`, etc. for that route.
+ *
+ * @example
+ * ```ts
+ * routeOverrides: {
+ *   '/_authed': { beforeLoad: () => {} },
+ *   '/demo/form/simple/$id': {
+ *     loader: async () => ({ name: 'Mock User' }),
+ *   },
+ * }
+ * ```
+ */
+type RouteTreeOverrides = Partial<{ [routePath in keyof FileRoutesByPath]: RouteOverrideOptions<FileRoutesByPath[routePath]['preLoaderRoute']> | undefined }>;
+interface RouterParameters<TRoute = undefined, Path extends (TRoute extends AnyRoute ? keyof RoutesByPath<TRoute> : RegisteredFullPath) = (TRoute extends AnyRoute ? keyof RoutesByPath<TRoute> : keyof FileRoutesByPath)> {
+  route?: StoryRouteOptions<TRoute>;
+  /**
+   * Path to resolve the story route against.
+   * Constrained to known registered paths in route tree mode, but can be any string in app route mode (since the user may be passing a custom `route` that doesn't exist in the registered tree).
+   */
+  path?: Path;
+  /** URL params to interpolate into the path (e.g. `{ id: '42' }` for `/$id`). */
+  params?: ResolveParams<Path>;
+  /** Search/query params to append to the URL (e.g. `{ tab: 'details' }`). */
+  query?: Partial<StoryRouteSearch<TRoute>>;
+  /**
+   * Override options for specific routes in the app route tree (route tree mode only).
+   *
+   * Each key is a route ID (e.g. `'/about'`, `'__root__'`, `'/demo/form/simple/$id'`).
+   * Values can override `loader`, `beforeLoad`, etc. for that route.
+   *
+   * @example
+   * ```ts
+   * routeOverrides: {
+   *   '/_authed': { beforeLoad: () => {} },
+   *   '/demo/form/simple/$id': {
+   *     loader: async () => ({ name: 'Mock User' }),
+   *   },
+   * }
+   * ```
+   */
+  routeOverrides?: RouteTreeOverrides;
+  context?: Record<string, unknown>;
+  /**
+   *
+   */
+  useRouterContext?: ({
+    storyContext
+  }: {
+    storyContext: Parameters<Decorator>[1];
+  }) => AnyContext;
+}
+//#endregion
+//#region code/frameworks/tanstack-react/.dts-emit/code/frameworks/tanstack-react/src/types.d.ts
+type FrameworkName = CompatibleString<'@storybook/tanstack-react'>;
+type BuilderName = CompatibleString<'@storybook/builder-vite'>;
+type FrameworkOptions = {
+  /** Builder options passed through to @storybook/builder-vite. */builder?: BuilderOptions;
+};
+type StorybookConfigFramework = {
+  framework: FrameworkName | {
+    name: FrameworkName;
+    options: FrameworkOptions;
+  };
+  core?: StorybookConfig['core'] & {
+    builder?: BuilderName | {
+      name: BuilderName;
+      options: BuilderOptions;
+    };
+  };
+};
+/** The interface for Storybook configuration in `main.ts` files. */
+type StorybookConfig$1 = Omit<StorybookConfig, keyof StorybookConfigFramework> & StorybookConfigFramework;
+/** Path constraint mirroring `RouterParameters`'s second generic. */
+type DefaultStoryPath<TRoute> = TRoute extends AnyRoute ? keyof RoutesByPath<TRoute> : RegisteredFullPath;
+interface TanStackPreviewOptions<TRoute = undefined, Path extends DefaultStoryPath<TRoute> = DefaultStoryPath<TRoute>> {
+  /** Router configuration for stories */
+  router?: RouterParameters<TRoute, Path>;
+}
+interface TanStackParameters<TRoute = undefined, Path extends DefaultStoryPath<TRoute> = DefaultStoryPath<TRoute>> {
+  /** TanStack framework configuration (router integration). */
+  tanstack?: TanStackPreviewOptions<TRoute, Path>;
+}
+interface TanStackTypes<TRoute = undefined, Path extends DefaultStoryPath<TRoute> = DefaultStoryPath<TRoute>> {
+  parameters: TanStackParameters<TRoute, Path>;
+}
+//#endregion
+export { TanStackPreviewOptions as a, IsRoute as c, StoryRouteOptions as d, TanStackParameters as i, RouterParameters as l, FrameworkOptions as n, TanStackTypes as o, StorybookConfig$1 as r, CreateStoryRouteOptions as s, DefaultStoryPath as t, StoryRouteFileOptions as u };