@imfusion/web-ui 0.5.1-dev.6.gece7a7b5 → 0.6.0

package/src/llms/skills/imf-web-ui-conventions/topics/library-boundary.md

@@ -0,0 +1,35 @@
+# Library boundary
+
+The contract between an app and `@imfusion/web-ui`.
+
+## Stay behind the library
+
+- Never import Base UI (or any other upstream the library wraps) directly — no upstream stylesheets, no upstream components,
+  even when upstream docs show it that way: everything a component needs ships in `@imfusion/web-ui`.
+- Library missing something upstream has → report the gap (see `imf-web-ui-components`); don't reach around it.
+- Import icons from `@imfusion/web-ui/icons` and render them through its `Icon` component. Direct imports from
+  `iconoir-react` are outside the library boundary.
+
+## Wrap primitives when the app has a reason to
+
+- Repeated adaptation around a primitive (default props, a styling override, a composition, an accessibility refinement, a
+  restriction of the API) → wrap it once in an app-level dumb component in `components/` ([components.md](components.md)).
+- The wrapper derives its props from the primitive (`React.ComponentProps<typeof Button>`, narrowed or extended) and styles
+  itself through the sanctioned seams — never the library's internals.
+- Wrap for a reason — any repeated adaptation counts; a wrapper that only renames a primitive is indirection with no payoff.
+- Components marked `experimental` in the identity index get wrapped **always**, even with nothing added yet — a breaking
+  upstream change then lands in one file instead of every call site.
+
+## Derive types, don't import them
+
+- Prop types come from the components themselves: `React.ComponentProps<typeof Button>`.
+- The library deliberately exports no `Props` types — don't look for them, don't re-declare prop shapes by hand.
+
+## Integrations own their peers
+
+- `@imfusion/web-ui/integrations/*` components depend on optional peers (e.g. `@tanstack/highlight` for `CodeHighlight`). Add
+  the peer explicitly to the consumer's `package.json` — never rely on hoisting.
+
+## Styling crosses the boundary through seams
+
+- Tokens in, sanctioned selectors at the edge, never the library's internals — the full contract is [styling.md](styling.md).

package/src/llms/skills/imf-web-ui-conventions/topics/library-setup.md

@@ -0,0 +1,26 @@
+# Library setup
+
+Library wiring (styles import + `WebUIProvider`) for anyone using `@imfusion/web-ui` — `imf-web-ui-setup library-setup`
+proposes a bootstrap change, `imf-web-ui-audit library-setup` is the read-only health check.
+
+## Entry-point wiring
+
+- Every consumer entry point has exactly two lines, in this order:
+
+  ```tsx
+  import "@imfusion/web-ui/styles.css";
+  import { WebUIProvider, Button } from "@imfusion/web-ui";
+  ```
+
+- Wrap the app root in `<WebUIProvider>` once — components rendered outside it lack the theme and CSS-variable context they
+  expect.
+- Never import a Base UI (or other upstream) stylesheet or component directly — everything a web-ui component needs is inside
+  `styles.css` and the package's own exports. What may be reached for when the library lacks a component:
+  [library boundary](library-boundary.md).
+
+## Symptoms of broken setup
+
+- Components render but look unstyled → the `styles.css` import is missing from the entry point.
+- Components render but ignore the theme (wrong colors, CSS variables not resolving) → mounted outside `<WebUIProvider>`.
+- An integration component throws on import → its optional peer dependency is not installed; check the component's
+  description in the docgen index (`imf-web-ui-components`) for which peer to add to `package.json`.

package/src/llms/skills/imf-web-ui-conventions/topics/npm-project.md

@@ -0,0 +1,53 @@
+# npm project
+
+The npm side of an ImFusion frontend: `package.json`, scripts, dependencies. `imf-web-ui-setup` audits against this file.
+
+## package.json
+
+```jsonc
+{
+  "name": "@imfusion/scan-review",
+  "type": "module",
+  "private": true, // only when the package is not meant to be published
+  "engines": { "node": ">=22" },
+  "imports": { "#/*": "./src/*" }
+}
+```
+
+- `"type": "module"` always.
+- `"private": true` only for apps that never publish.
+- Pin Node via `engines.node` or `.nvmrc` — never a personal version manager's config.
+- Wire the `#/` alias through `imports` ([project-structure.md](project-structure.md)).
+
+## Scripts
+
+Same name, same meaning, every repo — "what can I run to check this?" is tab-completing `verify:`.
+
+| Script             | Runs                                                                  |
+| ------------------ | --------------------------------------------------------------------- |
+| `dev`              | dev server                                                            |
+| `build`            | production build                                                      |
+| `verify:deps`      | exact-pin check over `dependencies` and `devDependencies`             |
+| `verify:format`    | `prettier --check .`                                                  |
+| `verify:lint`      | `eslint . --cache --max-warnings=0`                                   |
+| `verify:typecheck` | `tsc --noEmit` (or `tsc -b --noEmit` in a project-references setup)   |
+| `verify:tests`     | `vitest run`                                                          |
+| `verify:knip`      | `knip` — dead-code and unused-export check                            |
+| `verify:staged`    | staged-file subset, called by the pre-commit hook                     |
+| `verify:full`      | every `verify:*` check plus the build; what CI runs                   |
+| `format`           | `prettier --write .`                                                  |
+| `lint`             | `eslint . --cache --fix`                                              |
+| `git:config`       | see [git.md](git.md); run by hand once per clone, named in the README |
+
+- **Every check is `verify:*`** — one namespace for everything that reads and reports.
+- **Write-mode scripts keep the tool name** (`format`, `lint`): changing files isn't verifying — no prefix, no `:fix` suffix.
+- `verify:staged` is fast and partial: staged-file format/lint plus the relevant project-wide checks for staged source or
+  config changes, including `verify:knip` — a passing commit is not CI green.
+- `verify:full` is the CI gate.
+
+## Dependencies
+
+- **Pin exactly** — no `^`, `~`, or `latest`, in `dependencies` and `devDependencies` alike: `verify:deps` catches drift,
+  `save-exact=true` in `.npmrc` prevents it.
+- **`ignore-scripts=true` in `.npmrc`** — blocks lifecycle scripts on install (the supply-chain vector); setup that matters
+  is a command someone runs, not a hook that fires on install.

package/src/llms/skills/imf-web-ui-conventions/topics/project-structure.md

@@ -0,0 +1,44 @@
+# Project structure
+
+Kebab-case throughout, folders and files alike; exported symbols stay PascalCase — only the filename is kebab.
+
+## Layout
+
+```
+src/
+  main.tsx         # providers and router bootstrap; one WebUIProvider at the app root
+  routes/          # TanStack Router file-based routes; routing only — they compose, they don't fetch inline
+    __root.tsx     # document-wide error/not-found boundary and Outlet
+    _public/       # anonymous route group; resolves the current user when public pages need it
+      route.tsx
+    _app/          # pathless authenticated route group; guards the subtree before children render
+      route.tsx
+  api/             # one folder per API topic — layout and behaviour in data.md
+    auth/           # one current-user query plus server-owned login/logout URL helpers
+  components/      # grouped by kind — anatomy in components.md
+    app-shell/     # optional persistent authenticated chrome: brand, navigation, and session action
+  http/            # transport: client, error normalisation — the only transport-aware place (data.md)
+  lib/             # framework-free helpers, each with a colocated .test.ts when it has decisions to test
+    auth/
+      login-url.ts
+      login-url.test.ts
+```
+
+- Each subtree's rules live with its topic: [data.md](data.md) for `api/` and `http/`, [components.md](components.md) for
+  `components/`.
+
+## Application boundary
+
+- Start every frontend with the root providers, a current-user query, and pathless `_public/` and `_app/` route groups —
+  contract in [authentication.md](authentication.md); add feature routes only after that boundary exists.
+- Greenfield: `_app/` starts with a minimal `AppShell` — ImFusion logo, route navigation, and a stable session-action area
+  around the route `Outlet`.
+- Omit the shell only when the human explicitly says the product has no persistent authenticated navigation; the `_app/`
+  guard stays.
+- An established project preserves its working choice; public pages can use a small branded header instead.
+
+## Imports
+
+- `#/` alias for anything outside the current folder, plain `./` for siblings.
+- The alias is always `#/` → `src/`: `#` is Node's own subpath-import prefix, so it can't collide with an npm scope.
+- Wire it once, through `package.json`'s `imports` field (toolchain-native), with a matching tsconfig `paths` entry.

package/src/llms/skills/imf-web-ui-conventions/topics/react.md

@@ -0,0 +1,109 @@
+# React
+
+House defaults for React around `@imfusion/web-ui`. Links are for you, the agent — authoritative when a case here is
+ambiguous; hand them to the human only if asked.
+
+## Composition: pages (smart containers), partials, dumb components
+
+The architecture principle, top-down — rooted in Dan Abramov's
+[Presentational and Container Components](https://medium.com/@dan_abramov/smart-and-dumb-components-7ca2f9a7c7d0) and
+[Thinking in React](https://react.dev/learn/thinking-in-react). Styling lives exclusively in dumb and layout components,
+nowhere else:
+
+- **Pages are the smart containers.** The route component in `routes/` is the container — don't go looking for `*Container`
+  files. It owns how things _work_: loaders prefetch, the component fetches data, orchestrates, composes partials and passes
+  data down. Zero styling — a page wanting CSS (two panels side by side) means a layout component, not an inline style. A
+  standalone container earns its place only off-route (a modal fetching its own data).
+- **Partials** are pure composition: reusable units of dumb and layout components with light logic and zero styling of their
+  own, extracted because they read as a unit. A partial with a CSS file is a red flag — the styled element wants to be its
+  own dumb component, or the wrapper wants to be a layout component.
+- **Layout components** own _arrangement_ and nothing else: `Stack`-/`Row`-based wrappers with token gaps, a page grid, a
+  section frame.
+- **Dumb components** own how things _look_: style and compose library primitives, take plain data and callbacks as props; no
+  fetching, routing, or business logic. All non-layout styling lives here and only here — logic-free dumb components (the
+  `@imfusion/web-ui` layer) keep screens restylable, testable with plain props, resilient to library updates.
+- Wrapping library primitives in app-level dumb components: [library-boundary.md](library-boundary.md).
+
+```tsx
+// Dumb — renders what it's given
+function UserCard({ name, role, onEdit }: { name: string; role: string; onEdit: () => void }) {
+  return (
+    <Card.Root>
+      <Card.Content>
+        <Typo>{name}</Typo>
+        <Chip>{role}</Chip>
+      </Card.Content>
+      <Card.Footer>
+        <Button onClick={onEdit}>Edit</Button>
+      </Card.Footer>
+    </Card.Root>
+  );
+}
+```
+
+```tsx
+// Smart — knows where data comes from, renders the dumb component
+function UserCardContainer({ userId }: { userId: string }) {
+  const user = useUserQuery(userId);
+  const openEditor = useEditorNavigation(userId);
+  return <UserCard name={user.data.name} role={user.data.role} onEdit={openEditor} />;
+}
+```
+
+## Compose, don't configure
+
+- Build screen-level pieces by composing primitives (`Stack`, `Row`, `Card`, dumb components), not one component with a dozen
+  boolean props — a prop list that reads like a settings page wanted to be two or three components.
+- Lift state shared between siblings to the nearest common parent
+  ([Sharing State Between Components](https://react.dev/learn/sharing-state-between-components)); never sync copies.
+
+## Put state where its truth lives
+
+Work down this list; stop at the first match:
+
+1. **URL state** — shareable via the address bar (filters, sort, pagination, active tab) → TanStack Router search params;
+   back button and copied links come free. These cross an external boundary — parse per [validation.md](validation.md).
+2. **Server state** — from an API → TanStack Query's cache ([data.md](data.md)); never copy it into `useState` — that's how
+   stale-UI bugs are born.
+3. **Subtree state** — resets on leave (wizard progress) → React context.
+4. **Client state** — app-wide and persistent → TanStack Store, and only now: tiers 1–2 usually dissolve the "we need a
+   store" instinct.
+5. **Local state** — one component's own (input value, open/closed, a draft, a hover flag) → `useState`. Most state is local;
+   keep it in the component, no library.
+
+- A form turning drafts into a submitted domain value validates that boundary per [validation.md](validation.md).
+- Shape the state itself per [Choosing the State Structure](https://react.dev/learn/choosing-the-state-structure) —
+  especially its rules on redundant and duplicated state.
+
+## Effects: last resort, and named
+
+- No `useEffect` for: derived values (render or `useMemo`), responses to user actions (the event handler), server sync (the
+  data-fetching layer). Effects only synchronize with systems _outside_ React.
+- Read [You Might Not Need an Effect](https://react.dev/learn/you-might-not-need-an-effect) — the definitive misuse catalog —
+  before every effect you're tempted to write.
+- Extract a genuine effect into a custom hook named for its purpose (`useSyncedScroll`, `useDocumentTitle`, `useHotkey`),
+  never an anonymous inline `useEffect`: the name documents intent, the hook isolates the dependency array. Pattern:
+  [Reusing Logic with Custom Hooks](https://react.dev/learn/reusing-logic-with-custom-hooks).
+- The rare effect that stays inline still names its callback, so intent survives without a comment:
+
+```tsx
+useEffect(
+  function syncDocumentTitle() {
+    document.title = title;
+  },
+  [title]
+);
+```
+
+- A dependency sourced from a hook or query return: destructure the primitive first — [typescript.md](typescript.md#naming).
+
+## Reading list
+
+Consult while building; each is the authority for its topic:
+
+- [Thinking in React](https://react.dev/learn/thinking-in-react) — decomposition and one-way data flow
+- [Keeping Components Pure](https://react.dev/learn/keeping-components-pure) — why dumb components stay dumb
+- [Choosing the State Structure](https://react.dev/learn/choosing-the-state-structure) — shaping state without duplication
+- [Sharing State Between Components](https://react.dev/learn/sharing-state-between-components) — lifting state
+- [You Might Not Need an Effect](https://react.dev/learn/you-might-not-need-an-effect) — the effect misuse catalog
+- [Reusing Logic with Custom Hooks](https://react.dev/learn/reusing-logic-with-custom-hooks) — named effects live here

package/src/llms/skills/imf-web-ui-conventions/topics/styling.md

@@ -0,0 +1,88 @@
+# Styling
+
+How app CSS is written and how it meets `@imfusion/web-ui`.
+
+## CSS authoring
+
+- **CSS Modules with native CSS only** — no Sass, no CSS-in-JS, no utility-class framework: nesting and custom properties
+  already cover DRY. Stylesheet location and ownership: [components.md](components.md).
+- Nest pseudo-elements, states, and child selectors under the root so the prefix is written once:
+
+  ```css
+  .root {
+    transition: clip-path var(--ease);
+
+    &:focus-visible {
+      outline: var(--imf-ui-border-size-2) solid var(--imf-ui-color-fg-support);
+    }
+
+    &[data-disabled] {
+      opacity: 0.5;
+    }
+  }
+  ```
+
+- Lift a repeated literal (an easing, a colour-math result) into a custom property; custom properties also carry
+  per-state/per-variant values down the tree — native parameterisation, no mixin needed.
+- Don't merge rules that only look similar — structurally different output (three distinct `clip-path` polygons) isn't
+  repetition; keep it explicit.
+
+## Build custom UI from tokens
+
+- Custom UI the library doesn't cover (a stat widget, a custom panel) uses names from the shipped token index
+  ([tokens.md](tokens.md)) for color, size, radius, and type — that's what makes it look native and survive theme changes.
+- A hex code or a magic `px` next to a concept the tokens already name is a defect.
+- Geometry that can't be a token (a clip-path percentage, a hairline `1px`) → named custom property at the top of the
+  stylesheet, invariant written next to it. Don't silently approximate to the nearest token.
+
+## Override through the sanctioned seams
+
+- All library styles live in the `imf-ui.components` CSS layer, so any plain selector you write wins — that's the whole
+  override contract.
+- Target the stable hooks: `data-imf-ui-component` attributes and your own classes/wrappers.
+- Never target the library's internal class names — they are generated and change without notice.
+- Never `!important` — needing it means you're targeting the wrong thing.
+- Style against state via data attributes (`[data-checked]`, `[data-disabled]`, `[data-popup-open]`) — components expose
+  state there, so never maintain your own state classes. `className` is purely a styling surface:
+
+  ```css
+  [data-imf-ui-component="Switch"][data-checked] {
+    outline: 2px solid var(--imf-ui-color-bg-positive);
+  }
+  ```
+
+## The color system
+
+- Roles: **surfaces** (`main` canvas, `support` panels, `minor` popovers); **brand** (identity, full saturation) vs
+  **primary** (contrast-tuned, CTAs) — distinct roles on purpose; **status** (`negative`, `warning`, `positive`, `info`);
+  three **accent** slots.
+- **Controls** are the 80/20 customization surface — override one and every derived token shifts:
+
+  ```css
+  :root {
+    --imf-ui-color-primary-hue: 30; /* every primary semantic token follows */
+  }
+  ```
+
+- **Semantic tokens** are what you consume: `--imf-ui-color-bg-{name}` per role, a flat
+  `--imf-ui-color-fg-{main|support|minor|oncolor|…}` ladder for text. Borders and rings draw from `fg-*`.
+- Push a hue control into a pale corner → you own overriding the matching `fg-*` token.
+- Color scheme is `<html data-imf-ui-color-scheme="light|dark">`, set by the provider; scheme-specific styling selects via
+  that attribute.
+
+## Responsive styling
+
+- Tune components per breakpoint by overriding their `--imf-ui-*` variables inside your own media queries — custom properties
+  cross the `@media` boundary, props don't (why sizing is variables, not a `width` prop):
+
+  ```css
+  @media (min-width: 768px) {
+    .my-shell {
+      --imf-ui-appshell-navbar-width: 22rem;
+    }
+  }
+  ```
+
+- Write literal breakpoint values — the library's `@custom-media` aliases are build-internal and don't ship.
+- JS only for behaviour (render a burger menu on mobile): `useMediaQuery(minWidth("md"))`. Never for styling CSS can do.
+- No responsive props — `size={{ sm: … }}` objects are deliberately not offered; write the media query.

package/src/llms/skills/imf-web-ui-conventions/topics/testing.md

@@ -0,0 +1,25 @@
+# Testing
+
+Test the **decisions**, not the rendering.
+
+## Naming
+
+- Colocated tests use `.test.ts` / `.test.tsx` (e.g. `login-url.test.ts`) — not `.spec.*` or plural `.tests.*`.
+
+## What gets a test
+
+- **Pure logic gets unit tests** — pricing, permissions, date math, parsing, reducers: cheap, fast, and where bugs actually
+  hide.
+- **Presentational components generally don't**: a component mapping props onto web-ui primitives has no logic of its own —
+  asserting a `<Button>` rendered tests React, not your code.
+- **Behaviour a user performs gets an interaction test** — a validating form, a stepped flow — through the interface the user
+  has (roles, labels, visible text), not through internals.
+- **Extract the decision out of a hook and test it as a plain function** — easier than a render harness; a hook that only
+  wraps a browser API has no decision to extract.
+- The measure isn't coverage percentage — it's whether a failing test tells you something you didn't already know.
+
+## Layer-specific recipes
+
+- Data layer: stub `fetch`, run the real query client — the recipe is in [data.md](data.md).
+- A schema whose constraints or transforms encode product behavior gets focused accepted, rejected, and transformed cases:
+  [validation.md](validation.md).

package/src/llms/skills/imf-web-ui-conventions/topics/tokens.md

@@ -0,0 +1,7 @@
+# Tokens
+
+## Token index
+
+- `@imfusion/web-ui` ships the generated token index at `node_modules/@imfusion/web-ui/src/llms/tokens.gen.json` — the only
+  source for consumer token names and authored default values.
+- Look up the exact entry there; never invent, recall, or duplicate a plausible `--imf-ui-*` name.

package/src/llms/skills/imf-web-ui-conventions/topics/tooling.md

@@ -0,0 +1,116 @@
+# Tooling
+
+Dependency and configuration baseline for an ImFusion frontend; check before adding a dependency and before writing its
+config.
+
+## Topic-to-tool map
+
+- Use the mapped tool for each topic; prefer typed config (`.ts` over `.json`) where the tool supports it.
+
+| Topic                 | Tool                                                                                                  |
+| --------------------- | ----------------------------------------------------------------------------------------------------- |
+| Build                 | [Vite](https://vite.dev)                                                                              |
+| Routing, URL state    | [TanStack Router](https://tanstack.com/router) — file-based, type-safe search params                  |
+| Server state          | [TanStack Query](https://tanstack.com/query) — the pattern around it is [data.md](data.md)            |
+| Forms                 | [TanStack Form](https://tanstack.com/form)                                                            |
+| Data grids            | [TanStack Table](https://tanstack.com/table) + web-ui's styled `Table` parts                          |
+| App-wide client state | [TanStack Store](https://tanstack.com/store) — last resort in the state ladder ([react.md](react.md)) |
+| Schema validation     | [Zod](https://zod.dev) — at the network boundary ([data.md](data.md))                                 |
+| Styling               | CSS Modules ([styling.md](styling.md))                                                                |
+| Test                  | [Vitest](https://vitest.dev)                                                                          |
+| Format                | [Prettier](https://prettier.io)                                                                       |
+| Lint                  | [ESLint](https://eslint.org) flat config                                                              |
+| Types                 | `tsc --noEmit` — own script, own CI step                                                              |
+| Staged files          | [lint-staged](https://github.com/lint-staged/lint-staged) (or nano-staged, drop-in)                   |
+| Dead code             | [Knip](https://knipjs.dev) via `verify:knip` — needs per-repo config                                  |
+
+## When a library owns a layer
+
+- Adopt the library once you're rebuilding what it does — validation timing and cross-field rules (Form), caching and
+  refetching (Query), URL as source of truth (Router), sorting/pagination over rows (Table): adding it mid-project is cheap,
+  unpicking a hand-rolled version later is not.
+
+## Devtools
+
+- Every TanStack library with a devtools package gets it as a dev dependency, mounted in development only — Router's
+  `@tanstack/react-router-devtools` is a given; Query's goes in when Query does.
+- Check for a `-devtools` sibling on every new TanStack dependency — not every library has one yet.
+- Once several are in, host them in one panel via `@tanstack/devtools`.
+
+## Docs over memory
+
+- `npx @tanstack/cli` for TanStack docs — never work from memory.
+- Where `@tanstack/intent` is wired up, use it to reach and read the Agent Skills the TanStack dependencies ship.
+
+## Prettier
+
+- Config file shape is free (`.prettierrc`, `prettier.config.ts`); the values are not:
+
+```ts
+import type { Config } from "prettier";
+
+const config: Config = {
+  printWidth: 125,
+  tabWidth: 2,
+  useTabs: false,
+  trailingComma: "none",
+  arrowParens: "avoid",
+  semi: true,
+  singleQuote: false,
+  proseWrap: "always"
+};
+```
+
+- Never omit the config file — no file means defaults, and the values silently differ.
+
+## ESLint
+
+Flat config (`eslint.config.ts`):
+
+- `strictTypeChecked` + `stylisticTypeChecked`, `projectService: true`
+- `as` and `!` banned outside tests (`consistent-type-assertions`)
+- `.gitignore` as the ignore source (`includeIgnoreFile` from `@eslint/compat`)
+- `#/` alias enforced via `no-restricted-imports` banning `../*` — parent-relative paths error, siblings (`./`) stay relative
+  ([project-structure.md](project-structure.md))
+
+## tsconfig
+
+```jsonc
+{
+  "compilerOptions": {
+    "strict": true,
+    "moduleResolution": "bundler",
+    "verbatimModuleSyntax": true, // import type stays import type
+    "noUnusedLocals": true,
+    "noUnusedParameters": true,
+    "noFallthroughCasesInSwitch": true,
+    "noUncheckedSideEffectImports": true,
+    "skipLibCheck": true,
+    "paths": { "#/*": ["./src/*"] }
+  }
+}
+```
+
+- `#/` → `src/` alias rationale: [project-structure.md](project-structure.md).
+
+## Staged files
+
+- Runner config (lint-staged or nano-staged) applies eslint `--fix` and prettier `--write` to staged files only.
+- The pre-commit runner also invokes `verify:knip` when staged source or project config can change the reachability graph.
+
+## CSS class names
+
+- Generated CSS Module class names are readable in the DOM, `{prefix}-{file}-{local}`, never the default hash: a legible DOM
+  is what makes devtools and browser automation usable.
+- The library ships the plugin; pass a short, app-scoped prefix:
+
+```ts
+import { readableCssModuleNames } from "@imfusion/web-ui/build/vite-css-module-names";
+
+export default defineConfig({
+  plugins: [react(), readableCssModuleNames({ prefix: "acme" })]
+});
+```
+
+- One pattern for dev, Storybook, and production: register the plugin in **every** tool that compiles the CSS — a compiler
+  left out generates different names for the same source, and its styles silently don't apply.

package/src/llms/skills/imf-web-ui-conventions/topics/typescript.md

@@ -0,0 +1,73 @@
+# TypeScript & code style
+
+Functional by default: pure functions over stateful classes, immutable data over in-place mutation, expressions over
+statements, side effects at the edges (network, DOM, store).
+
+## Types
+
+- No `any`. `unknown` at a boundary you can't type, narrowed before use.
+- Infer locals; annotate contracts. Exported functions get an explicit return type.
+- No temporal coupling — model the states instead of initialising `null` and filling in later.
+- Avoid `as`. Fix the type. The honest exception: an untyped third-party boundary, kept at the boundary.
+- Derive, don't duplicate:
+
+```ts
+const sizes = ["sm", "md", "lg"] as const;
+type Size = (typeof sizes)[number];
+
+const labels: Record<Size, string> = { sm: "S", md: "M", lg: "L" }; // compiler breaks if `sizes` changes
+```
+
+- Same rule across boundaries: library props via `React.ComponentProps<typeof Button>`
+  ([library-boundary.md](library-boundary.md)), untrusted data via a runtime schema and `z.infer`
+  ([validation.md](validation.md)).
+- Function signatures: 1–2 positional arguments; at 3+, one destructured object.
+
+## Immutability & expressions
+
+- Array methods before loops — `map`, `filter`, `find`, `some`, `flatMap` name what they do:
+
+```ts
+const activeNames = users.filter(u => u.isActive).map(u => u.name);
+```
+
+- Produce new values: spreads and `structuredClone` over in-place edits, `toSorted`/`toReversed` over `sort`/`reverse` (which
+  mutate their receiver).
+- Allowed exceptions: a genuine early exit (`for` + `break`), a measured hot loop.
+- Keep chains flat: 3–4 steps read well; longer wants named intermediates, and a `reduce` doing four things wants to be a
+  loop.
+
+## Naming
+
+- Say what it is, not what it's made of: `useUserQuery`, not `useUserHook`; `retryDelay`, not `num`.
+- Booleans read as assertions: `isOpen`, `hasAccess`, `canSubmit`.
+- Handlers: `onX` as props, `handleX` as implementations.
+- Match the vocabulary the product and the API already use — no synonyms for terms the backend named.
+- Keep the object a hook or query returns as a namespace instead of destructuring it, and drop the `Query`/`Mutation` suffix
+  from the local binding — the binding reads as the domain name, and every field access shows where it came from:
+
+```tsx
+const search = Route.useSearch(); // not const { page, filter } = ...
+const user = useSuspenseQuery(context.api.user.getDetails()); // not const { data } = ...
+const updateUser = useMutation(context.api.user.update());
+
+search.page;
+user.data.name;
+updateUser.mutate(values);
+updateUser.isPending;
+```
+
+- Exception: a `useEffect` dependency array needs a stable primitive, since deps compare by identity — destructure the
+  primitive out first rather than listing the object or a deep path into it:
+
+```tsx
+const user = useSuspenseQuery(context.api.auth.getUser());
+const { name } = user.data; // destructure for the dep array
+
+useEffect(
+  function syncDocumentTitle() {
+    document.title = name;
+  },
+  [name]
+);
+```

package/src/llms/skills/imf-web-ui-conventions/topics/validation.md

@@ -0,0 +1,62 @@
+# Validation
+
+Validate where data crosses from untrusted representation into frontend-owned values; the schema is the single source of
+truth for runtime check and TypeScript type.
+
+## Boundaries
+
+- Validate once, at the edge: network responses on entry; URL path and search params before business logic; persisted browser
+  data on read; user input becoming a submitted domain or request value.
+- Inside the boundary: parsed values only, no repeated defensive shape checks.
+- Outgoing requests built from already parsed domain values are serialized, not re-validated.
+- A typed client's handwritten generic is not validation — it only asserts a type onto an untrusted response.
+
+## Schema first, type derived
+
+- Zod schema, type via `z.infer`; never a handwritten type beside its schema.
+- Same rule for request and response shapes the frontend owns or consumes at runtime.
+
+```ts
+import { z } from "zod";
+
+export const userSchema = z.object({
+  id: z.string(),
+  email: z.email()
+});
+
+export type User = z.infer<typeof userSchema>;
+```
+
+## TanStack Router search params
+
+- `validateSearch` takes a Zod v4 schema directly (TanStack Router v1) — no adapter or parsing wrapper.
+- `Route.useSearch()` infers its type from `validateSearch`.
+- `.catch()`: malformed URL input falls back without interrupting navigation.
+- `.default()`: only for missing values; malformed values still follow the route's validation error path.
+
+```tsx
+import { createFileRoute } from "@tanstack/react-router";
+import { z } from "zod";
+
+const searchSchema = z.object({
+  page: z.number().int().positive().catch(1),
+  filter: z.string().catch("")
+});
+
+export const Route = createFileRoute("/users")({
+  validateSearch: searchSchema,
+  component: Users
+});
+
+function Users() {
+  const search = Route.useSearch(); // inferred: z.infer<typeof searchSchema>
+  return <UserList page={search.page} filter={search.filter} />;
+}
+```
+
+## Failure handling
+
+- `schema.parse`: invalid data is a contract failure on the normal error path (malformed backend response → route error
+  boundary).
+- `schema.safeParse`: failure is expected and the caller handles the issues (submitted user input).
+- Transforms and coercion live in the boundary schema — never scatter trimming, number conversion, or defaulting downstream.