@timber-js/app 0.2.0-alpha.13 → 0.2.0-alpha.132

package/src/routing/link-codegen.ts

@@ -0,0 +1,308 @@
+/**
+ * Typed `<Link>` codegen — interface augmentation generation.
+ *
+ * Extracted from `codegen.ts` to keep that file under the project's
+ * 500-line cap. This module owns everything that emits the
+ * `interface LinkFunction { ... }` augmentation blocks in the generated
+ * `.timber/timber-routes.d.ts`.
+ *
+ * Two augmentation blocks are emitted:
+ *
+ * 1. **Per-route discriminated union** (`formatTypedLinkOverloads`) —
+ *    one call signature whose props is a union keyed on `href`. TS
+ *    narrows by literal href and reports prop errors against the
+ *    matched variant. See TIM-835 and `design/09-typescript.md`.
+ *
+ * 2. **Catch-all overloads** (`formatLinkCatchAllOverloads`) — external
+ *    href literals (`http://`, `mailto:`, etc.) and a computed-string
+ *    `<H extends string>` signature for runtime-computed paths.
+ *
+ * Block ordering is critical for error UX: per-route is emitted FIRST
+ * so that, after TS's "later overload set ordered first" merge rule,
+ * the discriminated union ends up LAST in resolution order — the
+ * overload TS reports against on failure.
+ */
+
+import type { ParamEntry, RouteEntry } from './codegen-types.js';
+import {
+  buildCodecChainType,
+  buildSchemaParamType,
+  formatSearchParamsType,
+} from './codegen-shared.js';
+
+/** Shared Link base-props type literal used in every emitted call signature. */
+export const LINK_BASE_PROPS_TYPE =
+  "Omit<import('react').AnchorHTMLAttributes<HTMLAnchorElement>, 'href'> & { prefetch?: boolean; scroll?: boolean; preserveSearchParams?: true | string[]; onNavigate?: import('./client/link.js').OnNavigateHandler; children?: import('react').ReactNode }";
+
+/**
+ * Build a TypeScript template literal pattern for a dynamic route.
+ * e.g. '/products/[id]'        → '/products/${string}'
+ *      '/blog/[...slug]'       → '/blog/${string}'
+ *      '/docs/[[...path]]'     → '/docs/${string}' (also matches /docs)
+ *      '/[org]/[repo]'         → '/${string}/${string}'
+ */
+export function buildResolvedPattern(route: RouteEntry): string | null {
+  const parts = route.urlPath.split('/');
+  const templateParts = parts.map((part) => {
+    if (part.startsWith('[[...') && part.endsWith(']]')) {
+      // Optional catch-all — matches any trailing path
+      return '${string}';
+    }
+    if (part.startsWith('[...') && part.endsWith(']')) {
+      // Catch-all — matches one or more segments
+      return '${string}';
+    }
+    if (part.startsWith('[') && part.endsWith(']')) {
+      // Dynamic segment
+      return '${string}';
+    }
+    return part;
+  });
+  return templateParts.join('/');
+}
+
+/**
+ * Format the segmentParams type for Link overloads.
+ *
+ * Link params accept `string | number` for single dynamic segments
+ * (convenience — values are stringified at runtime). Catch-all and
+ * optional catch-all remain `string[]` / `string[] | undefined`.
+ *
+ * When the segment's params chain (TIM-834) declares a typed codec, the
+ * inferred type from the codec wins via a nested conditional.
+ */
+export function formatLinkParamsType(
+  params: ParamEntry[],
+  importBase?: string,
+  hasSchema?: boolean
+): string {
+  if (params.length === 0) {
+    return '{}';
+  }
+
+  const fields = params.map((p) => {
+    const fallback = p.type === 'string' ? 'string | number' : p.type;
+    const codecType = hasSchema
+      ? buildSchemaParamType(p, fallback)
+      : buildCodecChainType(p, importBase, fallback);
+    return `${p.name}: ${codecType}`;
+  });
+  return `{ ${fields.join('; ')} }`;
+}
+
+/**
+ * Catch-all call signatures for `<Link>` — external hrefs and computed
+ * `string` variables. Emitted from codegen in a SEPARATE
+ * `declare module` block (declared AFTER the per-route block) so the TS
+ * "later overload set ordered first" rule places these catch-all
+ * signatures ahead of per-route in resolution order, leaving per-route
+ * as the final overload whose error message is reported on failure.
+ *
+ * The conditional `string extends H ? ... : never` protection preserves
+ * TIM-624's guarantee that unknown internal path literals don't match
+ * the catch-all — typos like `<Link href="/typo" />` still error.
+ */
+export function formatLinkCatchAllOverloads(): string[] {
+  const lines: string[] = [];
+  const baseProps = LINK_BASE_PROPS_TYPE;
+
+  // TIM-830: the catch-all signatures accept EITHER the legacy
+  // `{ definition, values }` wrapper OR a flat `Record<string, unknown>`
+  // values object. External/computed hrefs can't be looked up in the
+  // runtime registry, so the wrapped form is still the reliable path;
+  // the flat form is kept permissive for callers migrating from typed-
+  // route hrefs to computed strings. `resolveHref` discriminates at
+  // runtime via the presence of a `definition` key.
+  const catchAllSearchParams =
+    '{ definition: SearchParamsDefinition<Record<string, unknown>>; values: Record<string, unknown> } | Record<string, unknown>';
+
+  // ExternalHref inlined here rather than referenced as an exported
+  // alias so the generated .d.ts stands alone without source imports.
+  const externalHref =
+    '`http://${string}` | `https://${string}` | `mailto:${string}` | `tel:${string}` | `ftp://${string}` | `//${string}` | `#${string}` | `?${string}`';
+
+  lines.push('  // Typed Link overloads — catch-all (block 2 / emitted second)');
+  lines.push('  interface LinkFunction {');
+
+  // (1) External/literal-protocol hrefs.
+  //
+  // TIM-833: `segmentParams` is permissively typed as
+  // `Record<string, unknown>` (not `never`) so generic wrappers that
+  // forward a `LinkProps`-shaped object can compile when the wrapper
+  // happens to bottom out at an external href. There are no dynamic
+  // segments to interpolate for an external href, so this prop is
+  // ignored at runtime — accepting an open-shape object instead of
+  // forbidding it removes a footgun without changing behavior.
+  lines.push(`    (props: ${baseProps} & {`);
+  lines.push(`      href: ${externalHref}`);
+  lines.push(`      segmentParams?: Record<string, unknown>`);
+  lines.push(`      searchParams?: ${catchAllSearchParams}`);
+  lines.push(`    }): import('react').JSX.Element`);
+
+  // (2) Computed/variable href — non-literal `string` only.
+  //
+  // `string extends H` is true only when H is the wide `string` type,
+  // not a specific literal. For literal hrefs, this overload must NOT
+  // be selectable so the per-route discriminated union (block 1) is
+  // the resolution target.
+  //
+  // TIM-833 follow-up: the previous shape used `string extends H ? {...} : never`
+  // on the WHOLE props type. For literal H, that collapsed `props` to
+  // `never`, and JSX type inference then read `(never).children` as
+  // `never` — producing the misleading
+  // `'children' prop expects type 'never' which requires multiple
+  // children, but only a single child was provided` (TS2745) error,
+  // which buried the actual prop-mismatch message under a noise diagnostic.
+  //
+  // Fix: move the `: never` from the whole props onto just the `href`
+  // field. The overload remains uncallable for literal H (since `"/x"`
+  // is not assignable to `never`), but `children` retains its real
+  // `ReactNode` type so JSX inference no longer collapses to never.
+  // The diagnostic surface becomes: TS reports the per-route block's
+  // error chain (the helpful "Type 'number' is not assignable to type
+  // 'string'" message) WITHOUT a leading TS2745 noise line.
+  lines.push(`    <H extends string>(`);
+  lines.push(`      props: ${baseProps} & {`);
+  lines.push(`        href: string extends H ? H : never`);
+  lines.push(`        segmentParams?: Record<string, string | number | string[]>`);
+  lines.push(`        searchParams?: ${catchAllSearchParams}`);
+  lines.push(`      }`);
+  lines.push(`    ): import('react').JSX.Element`);
+
+  lines.push('  }');
+  return lines;
+}
+
+/**
+ * Generate typed per-route Link call signatures via LinkFunction
+ * interface merging.
+ *
+ * TIM-835: This emits a SINGLE call signature whose props is a
+ * discriminated union keyed on `href`. TypeScript narrows the union by
+ * the literal `href` at the call site, then checks the rest of the
+ * props against the matched variant. When `segmentParams` or
+ * `searchParams` is wrong, TS reports the error against the matched
+ * variant — naming the user's actual `href` and the offending field.
+ *
+ * Before TIM-835, this function emitted N separate per-route overloads
+ * (one per route, sometimes two for dynamic routes). When ALL overloads
+ * failed, TS would pick an arbitrary failed overload (heuristically the
+ * "last tried") to render the diagnostic, often pointing at a route
+ * completely unrelated to the one the user wrote. The discriminated
+ * union sidesteps overload-resolution heuristics entirely.
+ *
+ * Open property shapes (`Record<string, unknown>` instead of `never`)
+ * for `segmentParams` on routes that don't declare them keep generic
+ * `LinkProps`-spreading wrappers compiling. (Aligned with TIM-833.)
+ *
+ * TIM-832: this function still emits the per-route block FIRST and the
+ * catch-all block follows, so per-route remains the LAST overload set in
+ * resolution order — the one TS reports against on failure. With a
+ * discriminated union there is only one call signature in this block,
+ * so the resolved-template-vs-pattern ordering reduces to placing the
+ * pattern variant before the resolved-template variant inside the union.
+ */
+export function formatTypedLinkOverloads(
+  routes: RouteEntry[],
+  importBase?: string,
+  hasSchema?: boolean
+): string[] {
+  const lines: string[] = [];
+  const baseProps = LINK_BASE_PROPS_TYPE;
+
+  // Build the union variants. Each route contributes one variant for the
+  // pattern href (e.g. '/products/[id]') and, for dynamic routes, an
+  // additional variant for the resolved-template href (e.g.
+  // `/products/${string}`).
+  //
+  // The PATTERN variant must be listed BEFORE the resolved-template
+  // variant for the same route so that when the user writes the literal
+  // pattern href (`<Link href="/products/[id]" />`), TS narrows to the
+  // pattern variant (which carries the typed `segmentParams` shape)
+  // rather than the looser resolved-template variant. Without this
+  // ordering, TS would silently match the resolved-template variant
+  // first — swallowing typed-segmentParams type errors.
+  const variants: string[] = [];
+  for (const route of routes) {
+    const hasDynamicParams = route.params.length > 0;
+    // For routes with no dynamic params, accept an absent OR open-shape
+    // segmentParams. `Record<string, unknown>` keeps generic spreads
+    // compiling and gives a readable error if a non-object is passed.
+    const paramsProp = hasDynamicParams
+      ? `segmentParams: ${formatLinkParamsType(route.params, importBase, hasSchema)}`
+      : 'segmentParams?: Record<string, unknown>';
+
+    const searchParamsType = route.hasSearchParams
+      ? formatSearchParamsType(route, importBase)
+      : null;
+    // TIM-830: pattern href uses the FLAT `Partial<T>` shape — the
+    // runtime registry is keyed by the un-interpolated pattern.
+    //
+    // TIM-833: when the route has NO searchParams definition, use
+    // `Record<string, unknown>` (open shape) instead of
+    // `Record<string, never>` so generic `LinkProps`-spreading wrappers
+    // compile. The trade-off vs the original TIM-835 strict shape is
+    // that excess searchParams keys on a no-def route no longer raise
+    // a type error — but those keys are runtime no-ops anyway, and
+    // wrapper compatibility is the more common pain point. Routes WITH
+    // a searchParams definition still get strict `Partial<T>` typing.
+    const patternSearchParamsProp = searchParamsType
+      ? `searchParams?: Partial<${searchParamsType}>`
+      : 'searchParams?: Record<string, unknown>';
+
+    // Pattern variant FIRST (more specific).
+    variants.push(
+      `${baseProps} & { href: '${route.urlPath}'; ${paramsProp}; ${patternSearchParamsProp} }`
+    );
+
+    // Resolved-template variant SECOND (looser, matches interpolated hrefs).
+    if (hasDynamicParams) {
+      const templatePattern = buildResolvedPattern(route);
+      if (templatePattern) {
+        // TIM-830: resolved-template href keeps the WRAPPED
+        // `{ definition, values }` shape — the registry can't be looked
+        // up by an already-interpolated href.
+        //
+        // TIM-833: searchParams falls back to `Record<string, unknown>`
+        // (was `Record<string, never>`) when the route has no
+        // definition, mirroring the pattern-variant change above. The
+        // resolved-template `segmentParams` is intentionally KEPT as
+        // `Record<string, never>` below to preserve TIM-835's
+        // pattern-variant typo detection: loosening segmentParams here
+        // would let the resolved-template variant shadow the pattern
+        // variant on literal pattern hrefs and silently swallow keyed
+        // typos like `<Link href="/[id]" segmentParams={{ idz: 1 }} />`.
+        const resolvedSearchParamsProp = searchParamsType
+          ? `searchParams?: { definition: SearchParamsDefinition<${searchParamsType}>; values: Partial<${searchParamsType}> }`
+          : 'searchParams?: Record<string, unknown>';
+        // TIM-835: `Record<string, never>` for segmentParams forbids ANY
+        // provided keys on the resolved-template variant. Without this,
+        // the resolved-template would shadow the pattern variant for
+        // literal pattern hrefs (`<Link href="/products/[id]" segmentParams={...} />`)
+        // because both variants accept the literal `'/products/[id]'`
+        // and the looser variant would silently swallow segmentParams
+        // type errors.
+        variants.push(
+          `${baseProps} & { href: \`${templatePattern}\`; segmentParams?: Record<string, never>; ${resolvedSearchParamsProp} }`
+        );
+      }
+    }
+  }
+
+  lines.push('  interface LinkFunction {');
+  if (variants.length === 0) {
+    // No page routes — emit nothing. The catch-all block in the second
+    // augmentation still provides external/computed-string signatures.
+    lines.push('  }');
+    return lines;
+  }
+  lines.push('    (');
+  lines.push('      props:');
+  for (const variant of variants) {
+    lines.push(`        | (${variant})`);
+  }
+  lines.push(`    ): import('react').JSX.Element`);
+  lines.push('  }');
+
+  return lines;
+}