basalt-ui 1.25.0 → 1.27.0

package/agent/rules/basalt-content.md

@@ -1,409 +0,0 @@
----
-source: basalt-ui
-description: Content/prose surface from basalt-ui/content — Prose, CodeBlock, Callout, TableOfContents, ReadingProgress, Markdown (streaming-aware), MermaidDiagram, MDX component map, ArticleLayout, ArticleCard/Grid, GuideLink/GuideDrawer, and the content-collections + TanStack Start recipe. Mantine-coupled.
-paths:
-  - 'src/content/**'
-  - 'apps/**/src/**/*content*'
----
-
-# Basalt Content — Prose, Markdown, Mermaid, MDX, Docs Framing
-
-basalt-ui ships `./content` — a Mantine-coupled surface for long-form reading (docs, guides,
-hand-authored articles, AI-streamed prose) plus the docs-framing chrome around it: a page layout,
-overview cards, and a contextual-help drawer.
-
-## Prose vs Markdown vs MDX
-
-| Entry                                     | Input              | Use case                                                               |
-| ----------------------------------------- | ------------------ | ---------------------------------------------------------------------- |
-| `<Prose>`                                 | React children     | hand-authored JSX articles                                             |
-| `<Markdown>`                              | a markdown string  | CMS content, files, **AI-streamed output** (`streaming` prop)          |
-| `mdxComponents` / `createMdxComponents()` | MDX runtime output | `content-collections`/any MDX pipeline's `MDXContent components={...}` |
-
-All three route through the SAME typography CSS (`Prose`), the same `CodeBlock`/`MermaidDiagram`
-fenced-code rendering, and the same GFM-alert-aware `Callout` blockquote mapping — a hand-authored
-article, a rendered markdown file, and an MDX guide are visually indistinguishable. `Markdown`
-wraps its own `<Prose>` internally; `mdxComponents` does NOT — wrap MDX output in `<Prose>`
-yourself, or reach for `ArticleLayout` (below), which wraps it for you.
-
-## Density
-
-`density='article'` (default) — 16px body, 1.7 leading, a 72ch measure (`VX.text.h1`/`h2` + the
-`--vx-prose-measure` token), generous block spacing. `density='chat'` — the compact chat typography
-(15px/1.55). Use `chat` density for agent/chat text, e.g. `<Markdown streaming density="chat">`.
-
-**The type-ladder rule applies here too**: never a literal font-size in JSX or a bespoke CSS value
-— every size in `Prose`/`CodeBlock`/`Callout`/`ArticleLayout`/`ArticleCard`/`GuideDrawer` resolves
-to a `VX.text.*` / `--vx-text-*` step. `h1` (26px) and `h2` (21px) are the two ladder steps this
-surface added.
-
-## CodeBlock — optional-peer behavior
-
-`shiki` is an OPTIONAL peer, lazy-loaded via a module-level singleton (`createHighlighterCore`,
-dual `github-light`/`github-dark` themes, `defaultColor: false` — a Mantine scheme flip is then
-pure CSS, zero re-highlighting). Without `shiki` installed, or for an unrecognized `language`,
-`CodeBlock` degrades to a plain mono `<pre>` — never a crash, never an unhandled rejection.
-
-```bash
-bun add shiki
-```
-
-```tsx
-import { CodeBlock } from 'basalt-ui/content'
-
-<CodeBlock title="vite.config.ts" language="ts" code={source} />
-<CodeBlock language="bash" code="bun add basalt-ui" />
-```
-
-## TableOfContents / ReadingProgress
-
-`TableOfContents` auto-collects `h2`/`h3` ids from a `containerRef` (IntersectionObserver
-scroll-spy) or takes an explicit `items` list — pair it with `headingSlug`/`SlugTracker` when
-authoring heading ids by hand. `ReadingProgress` is an opt-in scroll-driven top bar, `target`
-defaults to the whole document. Both are headless-styled but Mantine-coupled; `ArticleLayout`
-already wires both for you (below) — reach for them directly only when composing a custom page
-shell.
-
-## Markdown — streaming contract
-
-`<Markdown streaming>` is the flagship AI-stream path: pass the accumulating string on every
-token, no debouncing needed.
-
-- **`blockSplit`** (own fence-aware, blank-line lexer — no dep) splits `children` into top-level
-  blocks. Every block except the last renders through a `React.memo`'d renderer — referentially
-  stable `components`/`urlTransform` (built once per `Markdown` render via `useMemo`) is what makes
-  the memo actually skip re-rendering an unchanged settled block.
-- The LAST (in-flight) block is repaired via `remend` before rendering — unclosed `**`/`` ` ``/
-  `~~`/`$$`, an incomplete `[text](url` link (remend rewrites it to
-  `streamdown:incomplete-link` — any `streamdown:` href is dropped by the link hardening below).
-  `remend` is a lazy optional peer (dynamic `import()`); the root `.` entry no longer hard-requires
-  it.
-- **`streaming` is a RENDERING mode only** — it says the text is still arriving, not who wrote it.
-  Trust is a separate prop, `contentTrust: 'trusted' | 'untrusted'`, and it is the sole input to the
-  image allowlist below. Any surface rendering agent/model output must pin
-  `contentTrust="untrusted"` explicitly — a finished agent message is still model-generated, so
-  don't lean on `streaming` as a stand-in for trust.
-- **Hardening is ALWAYS ON**, streaming or not: `allowedLinkPrefixes` (default `['https://',
-'mailto:', '#', '/']`) / `defaultOrigin` (resolves a relative URL before the allowlist check's
-  result is used) / a `rehype-sanitize` pass (optional peer; `sanitizeSchema` only ADDS to the
-  default schema, never removes from it). `allowedImagePrefixes` defaults off `contentTrust`, NOT
-  `streaming`: `['https://', '/']` when trusted, same-origin-only `['/']` when untrusted — an
-  auto-fetched image is the classic prompt-injection exfiltration channel. `contentTrust` itself
-  defaults to `'untrusted'` when `streaming` is set, `'trusted'` otherwise — a backward-compat
-  floor, not the policy (see the bullet above). An explicit `allowedImagePrefixes` always overrides
-  the `contentTrust` default. A disallowed `href`/`src` renders as an unlinked `<span>` / a dropped
-  image — never a raw unsafe URL.
-- Fenced code highlights/upgrades per BLOCK on settle, not per token — the in-flight fence renders
-  plain mono (`CodeBlock showCopy={false}`) until its block settles.
-- Heading ids: a document-wide `SlugTracker` in non-streaming mode gives correct cross-heading
-  dedup (`overview`, `overview-1`, …). In `streaming` mode each block gets its OWN tracker instead
-  (a shared tracker would have to live across memoized blocks that never re-render) — a heading
-  text repeated across two DIFFERENT blocks will NOT get a deduped suffix. Streamed chat content
-  doesn't drive a `TableOfContents`, so this is an accepted tradeoff, not a bug.
-- `StreamingMarkdown` is DELETED — `Markdown` is the package's only markdown renderer. Render
-  agent/chat text via `<Markdown streaming density="chat">`. `agent/** -> content` is lint-blocked
-  by design, so `./agent` deliberately ships NO renderer — `PartList` takes a consumer-supplied
-  `components.text` instead.
-
-## MermaidDiagram — support matrix
-
-`beautiful-mermaid` (optional peer, lazy dynamic import, module-level singleton) covers exactly
-six diagram types: **flowchart, state, sequence, class, ER, XY chart**. Anything else (full
-mermaid grammar — gantt, git graphs, mindmaps, …) is a consumer escape hatch: install the full
-`mermaid` package yourself and render it outside `Markdown`/`MermaidDiagram`; this module does not
-attempt to cover it.
-
-Theming passes `var(--vx-*)` strings straight through as `bg`/`fg`/`line`/`accent`/`muted`/
-`surface`/`border` — the emitted SVG references those custom properties directly, so a Mantine
-scheme flip never re-renders the diagram. A ` ```mermaid ` fence inside `Markdown`'s `streaming`
-mode renders as plain `CodeBlock` while it's the in-flight block and upgrades to `MermaidDiagram`
-once the block settles (parse errors keep the last successfully-rendered SVG rather than blanking
-a working diagram).
-
-## ArticleLayout — the docs-page frame
-
-The page shell around a `Prose`/`Markdown`/`MDXContent` body: a centered content column, a sticky
-scroll-spy TOC rail (`toc`, default `true`, auto-hides below 1200px), an opt-in reading-progress
-bar (`readingProgress`, default `false`), a title/description/date/reading-time meta header
-(`meta`), and a prev/next pagination footer (`prev`/`next`). The header/content/footer share ONE
-grid column, so the article body reads as a single consistent width whether or not the TOC rail is
-visible.
-
-```tsx
-import { ArticleLayout } from 'basalt-ui/content'
-import { Link } from '@tanstack/react-router'
-;<ArticleLayout
-  meta={{
-    title: 'Reading dashboards',
-    description: 'Why most internal dashboards fail the five-second glance test.',
-    date: 'Jul 16, 2026',
-    readingTime: 6,
-  }}
-  readingProgress
-  next={{ label: 'Chart guide', href: '/guides/charts' }}
-  renderLink={(target, node) => <Link to={target.href}>{node}</Link>}
->
-  <h2 id="setup">Setup</h2>
-  <p>…</p>
-</ArticleLayout>
-```
-
-**The `renderLink` router-bridge convention** — every content component that links (`ArticleLayout`
-prev/next, `ArticleCard`, `GuideDrawer`'s "open full page" link) takes an optional `renderLink:
-(target, node) => ReactNode` prop. It defaults to a plain `<a href={target.href}>{node}</a>`; pass
-a router bridge to get client-side navigation:
-
-```tsx
-// TanStack Router
-renderLink={(target, node) => <Link to={target.href}>{node}</Link>}
-```
-
-## ArticleCard / ArticleGrid — overview pages
-
-The docs-landing card grid (StatCard-family aesthetics: panel bg, shadow-card, card radius, no
-explicit `p`/`radius` on the underlying `Card` — the shared inset idiom). `ArticleCard` is
-clickable three ways: `href` alone renders the card itself as an anchor; `href` + `renderLink`
-hands it to a router bridge; `onClick` alone renders a keyboard-operable button-role card. Omit all
-three for a static card.
-
-```tsx
-import { ArticleCard, ArticleGrid } from 'basalt-ui/content'
-import { Link } from '@tanstack/react-router'
-;<ArticleGrid>
-  <ArticleCard
-    title="Reading dashboards"
-    description="Why most internal dashboards fail the five-second glance test."
-    meta="6 min read · guide"
-    href="/content"
-    renderLink={(target, node) => <Link to={target.href}>{node}</Link>}
-  />
-</ArticleGrid>
-```
-
-## Article model — classification, sorting, filtering, search
-
-`Article<C, T>` (`basalt-ui/content`) is the structured data model behind `ArticleCard`/
-`ArticleLayout`: pure data + pure operators (`sortArticles`, `filterArticles`,
-`formatArticleDate`), no React, no `@mantine/*`. It is GENERIC over the taxonomy — the framework
-ships the shape and the operators; _which_ categories/tags exist is domain data the consumer
-declares. This is the `VX.series` doctrine (see `packages/basalt-ui/CLAUDE.md` "Consumer-series
-extensibility") applied to content instead of chart series. Reference implementation:
-`apps/playground/src/demo/articles.ts` (`ARTICLE_CATEGORIES`, `ARTICLE_TAGS`, `ARTICLES satisfies
-readonly Article<ArticleCategory, ArticleTag>[]`).
-
-There is deliberately NO `defineArticles` factory. `satisfies readonly Article<Cat, Tag>[]` gives
-identical inference with no import — contrast `defineSeries`, which earns its place because
-`buildPaletteCss`/`seriesTokens` actually consume the map it returns; a plain article list has no
-such consumer, so a factory would be a config bag with no payoff.
-
-`date` is ISO 8601 (`'2026-07-16'`). Rendering always goes through `formatArticleDate`, which pins
-BOTH `locale` (`'en-US'`) and `timeZone` (`'UTC'`) — both load-bearing against SSR/client hydration
-mismatch: an unpinned zone shifts a date-only ISO string by a day depending on the runtime's UTC
-offset, the same failure mode an unpinned locale causes on the string shape. "No date library"
-still holds — `Intl` is a native API.
-
-**Filter semantics** (`filterArticles`): `category` is exact-match; `tags` is ANY-OF (OR); the two
-axes AND together — matching the existing multi-facet `filterFn` semantics in
-`data/data-table.tsx`. An empty query returns the list unchanged.
-
-**Filter state is URL state.** Single-select axes (category) use `createSearchParamStore`;
-multi-select axes (tags) use `createMultiSearchParamStore` — both from `basalt-ui/router-tanstack`.
-That holds for the enum-shaped axes an article filter has. **It is not a general URL-state mandate**:
-a route whose `validateSearch` is a real Zod object is hand-written, and `createSearchSchemaStore`
-is planned, not shipped — see `basalt-router.md` → "validateSearch".
-
-Two stores compose on one route by spreading both `validateSearch` results:
-
-```ts
-// apps/playground/src/demo/article-filter-stores.ts (reference implementation in the basalt-ui repo)
-export const articleCategory = createSearchParamStore({
-  key: 'article-category',
-  param: 'category',
-  values: ['all', ...ARTICLE_CATEGORIES] as const,
-  fallback: 'all',
-})
-
-export const articleTags = createMultiSearchParamStore({
-  key: 'article-tags',
-  param: 'tags',
-  values: ARTICLE_TAGS,
-})
-
-// routes/content-overview.tsx
-export const Route = createFileRoute('/content-overview')({
-  validateSearch: (search) => ({
-    ...articleCategory.validateSearch(search),
-    ...articleTags.validateSearch(search),
-  }),
-})
-```
-
-The `'all'` sentinel is a UI concern added by the consumer, NOT an `Article`/`filterArticles`
-concept — `filterArticles` treats `undefined`/`''` as "no constraint" and deliberately does NOT
-special-case the string `'all'` (a consumer could legitimately have a category literally named
-`'all'`), so the page maps `category === 'all' ? undefined : category` before calling it.
-
-**The store/UI split is a LAYER boundary, not a style choice.** `basalt-ui/router-tanstack` is
-headless (`@mantine/*` banned by the Mantine-free boundary), so the store itself cannot render.
-`ArticleFilterBar` (`basalt-ui/content`) is the Mantine half: a fully controlled component wired to
-the store pair per `createSearchParamStore`'s 5-step JSDoc recipe (the filter bar is that recipe's
-step 3).
-
-**`toArticleActions`** is a pure in-memory PROJECTOR into the already-shipped Spotlight command
-surface (`basalt-ui/commands`) — the same tier as `toRouteActions`. It joins title, description,
-category, tags, and slug into a `keywords` string for substring search; it does not tokenize, rank,
-index, or persist. An app that outgrows substring matching over a client-side array brings its own
-search index — see <https://github.com/jkrumm/basalt-ui/blob/master/docs/CONTENT-SPEC.md> §9 (Non-goals), which is not in the package.
-
-`ArticleGrid` stays a dumb layout wrapper — deliberate, so callers keep composition (sorting,
-filtering, and pagination all happen above it, not inside it).
-
-**Mobile.** `ArticleFilterBar`'s category control renders a `SegmentedControl` above the `sm`
-breakpoint and a `Select` below it, switched via Mantine's CSS-based `visibleFrom`/`hiddenFrom`
-props — NOT `useMediaQuery`. A JS media-query hook renders differently on the server than on the
-first client paint (the server has no viewport to query), which trips a React hydration mismatch;
-the CSS-based switch has no such server/client branch.
-
-## GuideLink / GuideDrawer — contextual help
-
-The "this chart has a guide" pattern (GitLab Pajamas / Stripe-dashboard style): `GuideDrawer` is a
-controlled right-side `Drawer` rendering an article at article density (`markdown` string via
-`Markdown`, or `children` via `Prose`) with an optional "open full page" footer link; `GuideLink`
-is the uncontrolled quiet trigger + drawer pair — mount it next to whatever it explains. The
-trigger MUST read as quiet (faint ink, accent on hover) — it is never a loud primary button.
-
-```tsx
-import { GuideLink } from 'basalt-ui/content'
-
-<GuideLink
-  title="How p95 latency is measured"
-  markdown={p95GuideMarkdown}
-  fullPageHref="/guides/p95-latency"
-/>
-
-// Icon-only variant, for a tight chart-card header
-<GuideLink title="How this metric works" markdown={guideMarkdown} iconOnly />
-```
-
-## content-collections + TanStack Start recipe
-
-Build-time content tooling is a **recipe, not a dependency** — `@content-collections/*` are
-consumer devDeps, never a `basalt-ui` dependency. Resolved versions: `@content-collections/core`
-`0.15`, `@content-collections/vite` `0.3`, `@content-collections/mdx` `0.2`. Wire the MDX runtime
-part (`@content-collections/mdx/react`) as a regular dependency instead of a devDep if the consumer
-does strict prod-only installs — it's imported at runtime, not just build time.
-
-**Install:**
-
-```bash
-bun add -D @content-collections/core @content-collections/vite @content-collections/mdx
-```
-
-**`vite.config.ts`** — the content-collections vite plugin MUST precede every other plugin (it
-generates the virtual `content-collections` module other plugins/transforms may depend on).
-TanStack Start (`>= 1.121`) wires it the same way. This ordering holds regardless of what else is in
-the `plugins` array — see `agent/rules/basalt-app.md` for where `basaltAppPlugin` sits relative to
-it:
-
-```ts
-import { defineConfig } from 'vite'
-import viteReact from '@vitejs/plugin-react'
-import { contentCollections } from '@content-collections/vite'
-import { tanstackStart } from '@tanstack/react-start/plugin/vite'
-
-export default defineConfig({
-  resolve: { tsconfigPaths: true }, // makes the `content-collections` tsconfig alias resolve
-  plugins: [
-    contentCollections(), // FIRST — before tanstackStart()/react()
-    tanstackStart(),
-    viteReact(), // react's vite plugin must come AFTER start's
-  ],
-})
-```
-
-**`tsconfig.json`** — path alias so `import { allDocs } from 'content-collections'` resolves to the
-generated output (picked up by `resolve.tsconfigPaths` above):
-
-```json
-{
-  "compilerOptions": {
-    "paths": {
-      "content-collections": ["./.content-collections/generated"]
-    }
-  }
-}
-```
-
-**`.gitignore`** — the generated output is build tooling, not source:
-
-```
-.content-collections
-```
-
-**`content-collections.ts`** — a Standard Schema definition (a plain zod object works directly;
-`content: z.string()` is required by the frontmatter parser) plus an MDX `transform` that compiles
-the body once at build time:
-
-```ts
-import { defineCollection, defineConfig } from '@content-collections/core'
-import { compileMDX } from '@content-collections/mdx'
-import { z } from 'zod'
-
-const docs = defineCollection({
-  name: 'docs',
-  directory: 'content/docs',
-  include: '**/*.mdx',
-  schema: (z) => ({
-    title: z.string(),
-    description: z.string().optional(),
-    date: z.string().optional(),
-    content: z.string(),
-  }),
-  transform: async (doc, ctx) => ({
-    ...doc,
-    mdx: await compileMDX(ctx, doc),
-  }),
-})
-
-export default defineConfig({ collections: [docs] })
-```
-
-**The page/route** — `MDXContent` from `@content-collections/mdx/react` renders the compiled body
-onto `mdxComponents`, wrapped in `ArticleLayout` for the full docs-page frame:
-
-```tsx
-import { allDocs } from 'content-collections'
-import { MDXContent } from '@content-collections/mdx/react'
-import { ArticleLayout } from 'basalt-ui/content'
-import { mdxComponents } from 'basalt-ui/content'
-import { Link } from '@tanstack/react-router'
-
-const doc = allDocs.find((d) => d.slug === slug)
-
-<ArticleLayout
-  meta={{ title: doc.title, description: doc.description, date: doc.date }}
-  renderLink={(target, node) => <Link to={target.href}>{node}</Link>}
->
-  <MDXContent code={doc.mdx} components={mdxComponents} />
-</ArticleLayout>
-```
-
-**Wiring articles into Spotlight** — `allDocs` is a typed article list; map it into page actions the
-same way the shell's own nav model does, via `toRouteActions` (`basalt-ui/commands`) so every
-article is instantly searchable without a separate search index:
-
-```ts
-import { allDocs } from 'content-collections'
-import { toRouteActions } from 'basalt-ui/commands'
-
-const articleActions = toRouteActions(
-  allDocs.map((doc) => ({ key: doc.slug, label: doc.title, href: `/docs/${doc.slug}` })),
-  { navigate },
-)
-```
-
-## Escape hatches / non-goals
-
-KaTeX/math, full mermaid grammar bundling (d2, pintora), Vega-Lite streamed specs, versioned docs/
-i18n routing, and a `create-basalt-docs` scaffold are all out of scope for 1.0 — see
-<https://github.com/jkrumm/basalt-ui/blob/master/docs/CONTENT-SPEC.md> §9 for the full non-goals list and rationale (not in the package).