bitboss-ui 3.0.0-beta.36 → 3.0.0-beta.37

package/README.md

@@ -12,7 +12,7 @@ Published artifacts are **`dist/`** (ESM JavaScript, `.d.ts`, the two stylesheet
 
 - **Global stylesheet** — import `bitboss-ui/styles.css` once. It bundles design tokens, base rules, and styles for all exported components (built from the library’s PostCSS/Tailwind pipeline).
 - **Optional reset** — `bitboss-ui/reset.css`, only if your app has no reset of its own. Import it _before_ `styles.css` (or let the build plugin inject it with `resetCss: true`). A reset is a **prerequisite** of the components, not a nicety: their sizes are written for `border-box`, and native controls and fieldsets are expected to arrive without their browser chrome. Use this one, or your own — Tailwind's Preflight covers it, which is why `resetCss` defaults to off. The component test suite runs against this file.
-- **Cascade layers (opt-in)** — on Tailwind v4 the library must sit in your layer order or its unlayered rules outrank every utility you put on a component. `cssLayers: TAILWIND_V4_LAYERS` in the build plugin (both exported from `bitboss-ui/vite`) places it after Preflight and before the utilities. Details in `ai/guides/installation-and-plugin-setup.md` § Cascade layers.
+- **Cascade layers (opt-in)** — on Tailwind v4 the library must sit in your layer order or its unlayered rules outrank every utility you put on a component. `cssLayers: TAILWIND_V4_LAYERS` in the build plugin (both exported from `bitboss-ui/vite`) places it after Preflight and before the utilities. Details in `dist/ai/guides/installation-and-plugin-setup.md` § Cascade layers.
 
 ### TypeScript: use `vue-tsc` 3
 
@@ -30,11 +30,11 @@ gate looks like it is working. A real consumer shipped
 `<BbRadioGroup label="…">` (the prop is `legend`) through six release slices on
 `vue-tsc@^2.2.12` with a green `--noEmit`.
 
-Full detail: `ai/guides/installation-and-plugin-setup.md`.
+Full detail: `dist/ai/guides/installation-and-plugin-setup.md`.
 
 ### TypeScript: icons
 
-- **`IconType`**, **`IconRegistry`** — types used by icon-aware components; extend `IconRegistry` in your app to register project-specific icons.
+- **`IconType`** — the type of every icon prop: a plain `prefix:name` string (`lucide:save`, or `local:<name>` for an SVG in `iconDir`). There is no registry to extend; the build plugin ships what your code names (see Icons below).
 
 ### Composables
 
@@ -76,12 +76,14 @@ presentational glyphs **`BbBaseCheckboxIcon`**, **`BbBaseRadioIcon`**,
 
 Product-ready components with labels, hints, errors, and consistent styling:
 
-- **Forms & actions:** `BbTextInput`, `BbTextarea`, `BbNumberInput`, `BbSelect`, `BbSelectPopover`, `BbCheckbox`, `BbCheckboxGroup`, `BbRadio`, `BbRadioGroup`, `BbSwitch`, `BbSwitchGroup`, `BbSlider`, `BbRating`, `BbColorInput`, `BbColorPalette`, `BbDatePicker`, `BbDatePickerInput`, `BbTimePicker`, `BbTimePickerInput`, `BbButton`, `BbBadge`, `BbBadgeButton`, `BbIndicator`, `BbTag`, `BbDropdown`, `BbDropdownGroup`, `BbDropdownButton`, `BbAsterisk`
+- **Forms & actions:** `BbTextInput`, `BbTextarea`, `BbNumberInput`, `BbSelect`, `BbSelectPopover`, `BbCheckbox`, `BbCheckboxGroup`, `BbRadio`, `BbRadioGroup`, `BbSwitch`, `BbSwitchGroup`, `BbSlider`, `BbRating`, `BbColorInput`, `BbColorPalette`, `BbCalendar`, `BbDatePicker`, `BbDatePickerInput`, `BbTimePicker`, `BbTimePickerInput`, `BbButton`, `BbBadge`, `BbBadgeButton`, `BbIndicator`, `BbTag`, `BbDropdown`, `BbDropdownGroup`, `BbDropdownButton`, `BbAsterisk`
 - **Feedback:** `BbAlert`, `BbProgress`, `BbSpinner`, `BbToast`, `BbToastPortal`, `BbTooltip`
 - **Layout & navigation:** `BbAccordion`, `BbCollapsible`, `BbTabs` (+ `BbTabsRoot`, `BbTabsList`, `BbTabsPanels`), `BbBreadcrumbs`, `BbPagination`, `BbSmoothHeight`
 - **Overlays & panels:** `BbDialog`, `BbConfirm`, `BbConfirmPortal`, `BbOffCanvas`, `BbPopover`
 - **Data:** `BbTable`, `BbTree`
 - **Media & files:** `BbAvatar`, `BbDropzone`, `BbIcon`
+- **Validated forms** (`bitboss-ui/validated`, needs `vee-validate`): `BbForm`, `useBbFormContext`, and validated twins of 16 form controls (same names, plus `rules` / `vid`; not yet `BbRadio` or the pickers without an input).
+- **Passthrough scopes:** `BbPtScope` + `definePt` — a named `pt` map applied to one area of the app.
 
 ### Passthrough (`pt`)
 
@@ -91,7 +93,7 @@ or, in the object form, a style and attributes — typed and linted in the
 attribute form, on top of any variant. Classes append to ours, attributes win, listeners run after the
 component's own handler. A build-time `pt` map in the Vite / Nuxt plugin seeds
 every instance. Grammar, merge rules and the per-component vocabulary:
-[`ai/guides/passthrough.md`](ai/guides/passthrough.md).
+[`passthrough.md`](https://llms-bitboss-ui.bitboss.it/dist/ai/guides/passthrough.md) (installed: `dist/ai/guides/passthrough.md`).
 
 ```vue
 <BbButton
@@ -122,10 +124,10 @@ v3 prerelease; pin an exact version (`bitboss-ui@3.0.0-beta.32`) for stable
 links. Sizes grow with the catalogue — treat them as the current order of
 magnitude, not a contract.
 
-- [Core knowledge base](https://llms-bitboss-ui.bitboss.it/dist/llms-medium.txt) (~190 KB) — **start here if you can only fetch one file.** Hard rules, setup, component picker, design language, and the full component catalogue.
-- [Index](https://llms-bitboss-ui.bitboss.it/llms.txt) (~22 KB) — link index into every document.
+- [Core knowledge base](https://llms-bitboss-ui.bitboss.it/dist/llms-medium.txt) (about 200 KB) — **start here if you can only fetch one file.** Hard rules, setup, component picker, design language, and the full component catalogue.
+- [Index](https://llms-bitboss-ui.bitboss.it/llms.txt) (about 20 KB) — link index into every document.
 - [components.json](https://llms-bitboss-ui.bitboss.it/dist/ai/components.json) — machine-readable API surface, for programmatic validation.
-- [Complete knowledge base](https://llms-bitboss-ui.bitboss.it/dist/llms-full.txt) (~4.3 MB) — everything concatenated. Bulk ingestion only; too large to prompt with.
+- [Complete knowledge base](https://llms-bitboss-ui.bitboss.it/dist/llms-full.txt) (about 5 MB) — everything concatenated. Bulk ingestion only; too large to prompt with.
 
 Already installed? Prefer the local copy under `node_modules/bitboss-ui/dist/ai/`,
 run `npx bitboss-ui ai-init` to write agent pointers, and
@@ -213,8 +215,8 @@ gitignored, hidden, binary, `node_modules`/`vendor`/`storage`/`outDir` and
 This holds in dev exactly as in prod: dev registers the same set and re-scans a
 file on every save. A name that does not resolve renders a built-in placeholder
 (`data-bb-icon-missing="<name>"`) and logs one error with the fix; it never
-throws. Details: `ai/guides/icons-policy.md` and
-`ai/guides/installation-and-plugin-setup.md` § Icons.
+throws. Details: `dist/ai/guides/icons-policy.md` and
+`dist/ai/guides/installation-and-plugin-setup.md` § Icons.
 
 ### Nuxt module
 
@@ -307,6 +309,23 @@ bitbossUi({ iconDir: './assets/icons', mcp: true });
 
 Restart your agent harness once after either path so it picks up the new server.
 
+The server's tools: `search_docs` (the section that answers a "how do I…"
+question, across every guide and component), `search_components` (empty query
+= the catalogue), `get_component` (compact: every prop, event, slot and pt
+part, plus guide sections on request; also answers for type names and for v2 /
+beta names that were renamed), `get_guide`, `get_composable`, `list_recipes` /
+`get_recipe`, `list_tokens`, `list_changes` and `validate`.
+
+### CLI commands
+
+| Command                                                                   | What it does                                                                                                             |
+| ------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `npx bitboss-ui ai-init [--update] [--no-mcp]`                            | Writes the agent pointer files and registers the MCP server (installs its optional peers).                               |
+| `npx bitboss-ui check [paths…] [--fix] [--json]`                          | Validates `Bb*` markup in `.vue` / `.md` files against the installed version; `--fix` applies the v2 → v3 renames first. |
+| `npx bitboss-ui changelog --since <version> [--until <version>] [--json]` | Lists the **breaking** changes between the version you are on and the installed one — what breaks if you bump.           |
+| `npx bitboss-ui mcp`                                                      | Starts the MCP server on stdio (harnesses launch it for you after `ai-init`).                                            |
+| `npx bitboss-ui --help`                                                   | Every command and flag.                                                                                                  |
+
 ### ESLint plugin
 
 `bitboss-ui/eslint-plugin` flags unknown props, unknown `v-model`s, and
@@ -595,7 +614,7 @@ To make a report actionable, include:
 
 v3 ships as a prerelease (`npm i bitboss-ui@beta`). Expect breaking changes
 between prereleases; each one is recorded in the migration guides under
-[`ai/guides/migration/`](ai/guides/migration/).
+[`migration/v2-to-v3.md`](https://llms-bitboss-ui.bitboss.it/dist/ai/guides/migration/v2-to-v3.md) (installed: `dist/ai/guides/migration/`).
 
 ---