@storybook/tanstack-react 10.6.0-alpha.0 → 10.6.0-alpha.2

package/dist/_browser-chunks/{chunk-WQHJSC2D.js → chunk-FF4C4TUQ.js}

@@ -1,6 +1,6 @@
 import {
   normalizeFileRoutePath
-} from "./chunk-XKNIZ3MM.js";
+} from "./chunk-LTDGLEVR.js";
 import {
   __export
 } from "./chunk-4BE7D4DS.js";
@@ -28,7 +28,12 @@ import {
 } from "@tanstack/react-router";
 
 // src/routing/duplicate-tree.ts
-import { createRoute, RootRoute, createRootRouteWithContext } from "@tanstack/react-router";
+import {
+  createRoute,
+  RootRoute,
+  createRootRouteWithContext,
+  joinPaths
+} from "@tanstack/react-router";
 var MAX_PARENT_WALK = 50;
 function findRootRoute(route) {
   let current = route;
@@ -50,9 +55,9 @@ function initSourceTree(route, counter) {
       initSourceTree(child, counter);
 }
 function cloneChild(oldRoute, parent, overrides, byId) {
-  let options = oldRoute.options ?? {}, { id: _id, getParentRoute: _g, ...rest } = options, override = getOverrideFor(overrides, oldRoute.id), cloned = createRoute({
-    ...rest,
-    ...override,
+  let options = oldRoute.options ?? {}, { id: originalId, getParentRoute: _g, ...rest } = options, override = getOverrideFor(overrides, oldRoute.id), merged = { ...rest, ...override }, cloned = createRoute({
+    ...!merged.path && originalId != null ? { id: originalId } : {},
+    ...merged,
     getParentRoute: () => parent
   });
   byId.set(oldRoute.id, cloned);
@@ -67,7 +72,12 @@ function cloneChild(oldRoute, parent, overrides, byId) {
 }
 function duplicateRouteTree(rootRoute, { overrides } = {}) {
   initSourceTree(rootRoute, { i: 0 });
-  let byId = /* @__PURE__ */ new Map(), rootOptions = rootRoute.options ?? {}, rootOverride = getOverrideFor(overrides, "__root__"), { id: _rootId, getParentRoute: _rootGetParent, ...restRoot } = rootOptions, newRoot = createRootRouteWithContext()({
+  let byId = /* @__PURE__ */ new Map(), rootOptions = rootRoute.options ?? {}, rootOverride = getOverrideFor(overrides, "__root__"), {
+    id: _rootId,
+    getParentRoute: _rootGetParent,
+    shellComponent: _rootShell,
+    ...restRoot
+  } = rootOptions, newRoot = createRootRouteWithContext()({
     ...restRoot,
     ...rootOverride
   });
@@ -81,6 +91,16 @@ function duplicateRouteTree(rootRoute, { overrides } = {}) {
   }
   return { root: newRoot, byId };
 }
+function mountPathFor(route) {
+  let segments = [], current = route;
+  for (let i = 0; i < MAX_PARENT_WALK && current; i += 1) {
+    let routePath = current.options?.path;
+    routePath && routePath !== "/" && segments.unshift(routePath);
+    let getParent = current.options?.getParentRoute;
+    current = typeof getParent == "function" ? getParent() : void 0;
+  }
+  return joinPaths(["/", ...segments]);
+}
 function resolveStoryLeaf(tree, { path, boundRouteId }) {
   let { root, byId } = tree;
   if (path) {
@@ -134,7 +154,7 @@ function createStoryRouter({
   context,
   routerContext
 }) {
-  let routerParameters = context.parameters.tanstack?.router ?? {}, { tree, leaf } = resolveTree(Story, context), routeTree = tree.root, inferredPath = routerParameters?.path || leaf.fullPath || (leaf.id ? normalizeFileRoutePath(leaf.id) : void 0) || routeTree.children?.[0]?.fullPath || "/", resolvedPath = interpolatePath({
+  let routerParameters = context.parameters.tanstack?.router ?? {}, { tree, leaf } = resolveTree(Story, context), routeTree = tree.root, inferredPath = routerParameters?.path || leaf.fullPath || (leaf.id ? normalizeFileRoutePath(leaf.id) : void 0) || mountPathFor(leaf), resolvedPath = interpolatePath({
     path: inferredPath,
     params: routerParameters?.params ?? {}
   }).interpolatedPath, search = routerParameters?.query ? defaultStringifySearch(routerParameters.query) : "";
@@ -154,6 +174,24 @@ function createStoryRouter({
     context: routerContext
   });
 }
+function ensureMatchableLeaf(tree, leaf) {
+  if (!(leaf !== tree.root && !leaf.options?.path && leaf.options?.id != null))
+    return leaf;
+  let existingIndexChild = (leaf.children ?? []).find(
+    (child) => child.options?.path === "/"
+  );
+  if (existingIndexChild)
+    return existingIndexChild;
+  let syntheticLeaf = createRoute2({
+    path: "/",
+    component: () => null,
+    getParentRoute: () => leaf
+  });
+  return leaf.addChildren([
+    ...leaf.children ?? [],
+    syntheticLeaf
+  ]), syntheticLeaf;
+}
 function injectStoryComponent(leaf, Story, overrides, leafId) {
   let userOverride = overrides?.[leafId];
   userOverride && "component" in userOverride && userOverride.component !== void 0 || leaf.update({ component: () => React.createElement(Story, null) });
@@ -165,7 +203,9 @@ function resolveTree(Story, context) {
       path: routerParameters.path,
       boundRouteId: resolvedRoute && resolvedRoute !== rootRoute ? resolvedRoute.id : void 0
     });
-    return injectStoryComponent(leaf, Story, routeOverrides, leaf.id), { tree, leaf };
+    injectStoryComponent(leaf, Story, routeOverrides, leaf.id);
+    let renderLeaf = ensureMatchableLeaf(tree, leaf);
+    return { tree, leaf: renderLeaf };
   }
   if (isRoute(routerParameterRoute)) {
     let syntheticRoot2 = createRootRoute(
@@ -173,7 +213,9 @@ function resolveTree(Story, context) {
     );
     routerParameterRoute.update({ getParentRoute: () => syntheticRoot2 }), syntheticRoot2.addChildren([routerParameterRoute]);
     let tree = duplicateRouteTree(syntheticRoot2, { overrides: routeOverrides }), leaf = tree.byId.get(routerParameterRoute.id) ?? tree.root;
-    return injectStoryComponent(leaf, Story, routeOverrides, leaf.id), { tree, leaf };
+    injectStoryComponent(leaf, Story, routeOverrides, leaf.id);
+    let renderLeaf = ensureMatchableLeaf(tree, leaf);
+    return { tree, leaf: renderLeaf };
   }
   let plainOptions = routerParameterRoute ?? {}, {
     path: plainRoutePath,

package/dist/_browser-chunks/{chunk-XKNIZ3MM.js → chunk-LTDGLEVR.js}

@@ -13,7 +13,15 @@ function removeUnderscores(s) {
 function normalizeFileRoutePath(path) {
   return removeGroups(removeUnderscores(removeLayoutSegments(path)) ?? "") || "/";
 }
+function isPathlessSegment(segment) {
+  return segment.startsWith("_") || segment.startsWith("(") && segment.endsWith(")");
+}
+function isPathlessFileRouteId(id) {
+  let segments = id.split("/").filter(Boolean), lastSegment = segments[segments.length - 1];
+  return lastSegment != null && isPathlessSegment(lastSegment);
+}
 
 export {
-  normalizeFileRoutePath
+  normalizeFileRoutePath,
+  isPathlessFileRouteId
 };

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 };