@aotter/mantle-admin-ui 0.1.0-alpha.8 → 0.1.2-alpha.1

package/README.md

@@ -2,9 +2,71 @@
 
 Admin SPA shell for mantle.
 
-This package builds a React/Tailwind static bundle copied by `mantle generate`
-to `public/_mantle/admin/`. It currently provides the system admin shell, preference
-UI, site overview surfaces, and Mantle-branded system pages.
+This package builds a React/Tailwind static bundle. When it is installed,
+`mantle generate` copies that bundle to `public/_mantle/admin/` (excluding
+`server.*` exports). Core-only projects that omit this package skip the copy.
+It currently provides the system admin shell, preference UI, site overview
+surfaces, and Mantle-branded system pages.
+
+## Mantle UI kit
+
+Applications that need the same React/shadcn visual language without embedding
+the Admin product can import the domain-neutral primitives and compiled theme:
+
+```tsx
+import { Button, Card, CardContent, Input } from "@aotter/mantle-admin-ui/kit";
+import "@aotter/mantle-admin-ui/kit.css";
+```
+
+Use `@aotter/mantle-admin-ui/tokens.css` when an application only needs the
+Mantle color, radius, background, and sidebar variables. The kit intentionally
+does not export `AdminApp`, authenticated layouts, routes, queries, or feature
+views; use the static Admin SPA or sandbox preview for the complete product.
+
+`dist/r/auth-page.json` is a shadcn registry item for a working email OTP page.
+It is copied into the consuming application, so its agent or author can change
+the markup and flow without forking this package. The recipe accepts optional
+Privacy Policy and Terms of Use links; their discovery and enforcement remain
+the application's responsibility.
 
 This package is prerelease software. Its `package.json` is the exact version
 authority; the API surface may change until `v0.1.0`.
+
+## Same-origin sandbox preview
+
+Use the separate `dist/preview.html` document for a Builder preview. Copy its
+assets unchanged; replace the `/_mantle/admin/` asset prefix if mounting the copy
+elsewhere. Serve the preview document at your own preview route. Do not patch the
+JavaScript bundle or change the canonical Admin document.
+
+Before its module script boots, install your sandbox transport as `window.fetch`
+and set `window.__MANTLE_ADMIN_PREVIEW__ = { fetch: window.fetch }`. The transport
+must intercept `/admin/api/*` requests and reject failures; never fall back
+to live Admin API requests. Preview permits only this same-origin fetch surface,
+with native connections and form submissions disabled by document CSP. Use an
+in-memory implementation or delegate with `postMessage` to the parent; a bridge
+that performs native fetch inside the iframe is blocked. The preview refuses to render without this explicit
+bridge, outside an iframe, in nested frames, or with a foreign-origin parent.
+Only a same-origin top-level parent is supported. The ordinary `index.html`
+continues to refuse all iframe rendering.
+
+Sign-in, OAuth consent, connected apps and sign-out are unavailable in preview.
+An unauthorized bridge response stays an error instead of navigating to live
+sign-in. Internal edits/search/pagination use the Admin router; CSV downloads use
+the bridge and a local blob. Canonical Admin retains its normal account flows
+and browser-streamed downloads, without buffering large exports in the SPA.
+
+This is a consumer-owned sandbox contract, not a way to embed authenticated
+production Admin. Do not mount it in an untrusted same-origin application.
+
+## Staff operations
+
+The Operations navigation item (`/admin/operations`) lists authorized staff
+Procedures without a row binding or `uiSchema.collectionAction`. It works on a
+site with no collections. Bound operations stay in their collection and row
+menus. All use the existing Admin operations API and schema form.
+
+Successful output stays in the dialog until closed. Failed input, diagnostics,
+and generated idempotency keys remain available for retry. Close and reopen a
+successful operation to start a new invocation. API authorization and Procedure
+validation remain authoritative.