@questpie/admin 1.1.1 → 3.0.0

package/skills/questpie-admin/SKILL.md

@@ -0,0 +1,397 @@
+---
+name: questpie-admin
+description: QUESTPIE admin panel setup branding theming sidebar dashboard media localization live-preview auth dark-mode CSS variables configuration
+type: skill
+---
+
+# QUESTPIE Admin Panel
+
+The QUESTPIE admin panel is a **projection of your server schema** — not the framework itself. It reads collections, globals, and config via introspection and generates a full admin interface. Your backend works without it.
+
+## Sub-Skills
+
+| Skill                                            | Covers                                                                                 |
+| ------------------------------------------------ | -------------------------------------------------------------------------------------- |
+| [questpie-admin/views](./views/SKILL.md)         | List views, form views, dashboard, sidebar, filters, bulk actions, visibility, history |
+| [questpie-admin/blocks](./blocks/SKILL.md)       | Block definitions, fields, prefetch, renderers, block picker                           |
+| [questpie-admin/custom-ui](./custom-ui/SKILL.md) | Custom fields, custom views, registries, reactive fields, widgets                      |
+
+## Tech Stack
+
+- **React** + **Tailwind CSS v4** + **shadcn** components
+- **@base-ui/react** primitives (NOT @radix-ui)
+- **@iconify/react** with Phosphor icon set (`ph:icon-name`)
+- **sonner** for toasts — `toast.error()`, `toast.success()`
+- Brutalist flat design: `--radius: 0px`, no shadows
+
+## Setup
+
+### 1. Install
+
+```bash
+bun add @questpie/admin
+```
+
+### 2. Server Plugin
+
+```ts title="questpie.config.ts"
+import { adminPlugin } from "@questpie/admin/plugin";
+import { runtimeConfig } from "questpie";
+
+export default runtimeConfig({
+	plugins: [adminPlugin()],
+	app: { url: process.env.APP_URL || "http://localhost:3000" },
+	db: { url: process.env.DATABASE_URL },
+	secret: process.env.APP_SECRET,
+});
+```
+
+The plugin tells codegen to discover admin-specific file conventions: `sidebar.ts`, `dashboard.ts`, `branding.ts`, `blocks/`, `admin-locale.ts`.
+
+### 3. Modules
+
+```ts title="modules.ts"
+import { adminModule, auditModule } from "@questpie/admin/server";
+
+export default [adminModule, auditModule] as const;
+```
+
+| Module        | Provides                              |
+| ------------- | ------------------------------------- |
+| `adminModule` | User collection, auth pages, admin UI |
+| `auditModule` | Audit log collection, timeline widget |
+
+### 4. Convention Files
+
+```ts title="sidebar.ts"
+import { sidebar } from "#questpie";
+
+export default sidebar({
+	sections: [
+		{ id: "overview", title: { en: "Overview" } },
+		{ id: "content", title: { en: "Content" } },
+	],
+	items: [
+		{
+			sectionId: "overview",
+			type: "link",
+			label: { en: "Dashboard" },
+			href: "/admin",
+			icon: { type: "icon", props: { name: "ph:house" } },
+		},
+		{
+			sectionId: "content",
+			type: "collection",
+			collection: "posts",
+		},
+	],
+});
+```
+
+```ts title="branding.ts"
+import { branding } from "#questpie";
+
+export default branding({
+	name: { en: "My App Admin" },
+});
+```
+
+### 5. Codegen
+
+```bash
+bunx questpie generate
+```
+
+### 6. Mount the Admin
+
+```ts title="routes/admin/$.tsx"
+import { AdminRouter } from "@questpie/admin/client";
+import { admin } from "@/questpie/admin/admin";
+
+export default function AdminPage() {
+  return <AdminRouter admin={admin} />;
+}
+```
+
+The admin client config is auto-generated by codegen at `admin/.generated/client.ts`. No manual builder setup needed.
+
+## Branding
+
+```ts title="branding.ts"
+import { branding } from "#questpie";
+
+export default branding({
+	name: { en: "Barbershop Control", sk: "Riadenie barbershopu" },
+});
+```
+
+| Option | Type             | Description                      |
+| ------ | ---------------- | -------------------------------- |
+| `name` | `string \| i18n` | App name shown in sidebar header |
+| `logo` | `string`         | Logo URL or path                 |
+
+## Theming (CSS Variables)
+
+The admin uses CSS variables for all theming. Override them in your own CSS file.
+
+### Light Theme (`:root`)
+
+| Variable               | Default   | Purpose                          |
+| ---------------------- | --------- | -------------------------------- |
+| `--background`         | `#FFFFFF` | Page background                  |
+| `--foreground`         | `#0A0A0A` | Primary text                     |
+| `--card`               | `#F8F8F8` | Cards, panels, sidebar           |
+| `--popover`            | `#FFFFFF` | Dropdowns, tooltips, dialogs     |
+| `--muted`              | `#F0F0F0` | Hover states, table headers      |
+| `--muted-foreground`   | `#666666` | Secondary text, placeholders     |
+| `--primary`            | `#B700FF` | Brand accent (CTAs, focus rings) |
+| `--primary-foreground` | `#FFFFFF` | Text on primary backgrounds      |
+| `--destructive`        | `#FF3D57` | Errors, delete actions           |
+| `--success`            | `#00E676` | Positive states                  |
+| `--warning`            | `#FFB300` | Caution states                   |
+| `--info`               | `#40C4FF` | Informational emphasis           |
+| `--border`             | `#E0E0E0` | All structural borders           |
+| `--ring`               | `#B700FF` | Focus ring color                 |
+| `--radius`             | `0px`     | Border radius (0 = brutalist)    |
+
+### Dark Theme (`.dark` class)
+
+Dark mode uses the `.dark` class on the root element. Key overrides:
+
+| Variable       | Dark Value |
+| -------------- | ---------- |
+| `--background` | `#0A0A0A`  |
+| `--foreground` | `#FFFFFF`  |
+| `--card`       | `#111111`  |
+| `--border`     | `#333333`  |
+| `--muted`      | `#1A1A1A`  |
+
+### Typography
+
+| Variable      | Value                                                               |
+| ------------- | ------------------------------------------------------------------- |
+| `--font-sans` | `"Geist Variable"` — body text, descriptions                        |
+| `--font-mono` | `"JetBrains Mono Variable"` — UI chrome: nav, buttons, tabs, badges |
+
+### Sidebar Variables
+
+Separate tokens for independent sidebar theming: `--sidebar`, `--sidebar-foreground`, `--sidebar-primary`, `--sidebar-accent`, `--sidebar-border`, `--sidebar-ring`.
+
+### Custom Theme
+
+1. Copy the admin CSS file
+2. Change variable values
+3. Import your copy instead
+4. Zero component changes needed
+
+## Content Localization
+
+When collections have `.localized()` fields, the admin shows a locale switcher:
+
+```ts title="questpie.config.ts"
+export default runtimeConfig({
+	localization: {
+		defaultLocale: "en",
+		locales: [
+			{ code: "en", label: { en: "English" }, flagCountryCode: "gb" },
+			{ code: "sk", label: { en: "Slovak" } },
+		],
+	},
+});
+```
+
+The admin tracks content locale separately from UI locale. Only localized field values change when switching.
+
+## Media & Uploads
+
+```ts
+avatar: f.upload({
+  to: "assets",
+  mimeTypes: ["image/*"],
+  maxSize: 5_000_000,
+}),
+```
+
+The admin renders drag-and-drop upload, image preview, file info, and remove button.
+
+## Live Preview (V2)
+
+Live Preview V2 uses a direct `postMessage` patch bus for instant same-tab feedback. Save/autosave is persistence only — NOT the live transport. Realtime (SSE/WebSocket) is reserved for detached or shared preview sessions.
+
+For full architecture details, see: `/docs/workspace/live-preview/architecture`
+
+### Server Config
+
+Add `.preview()` to a collection to enable split-screen editing:
+
+```ts title="collections/pages.ts"
+export const pages = collection("pages")
+	.fields(({ f }) => ({
+		title: f.text({ required: true, localized: true }),
+		slug: f.text({ required: true }),
+		content: f.blocks({ localized: true }),
+	}))
+	.preview({
+		url: ({ record }) => {
+			const slug = record.slug as string;
+			return slug === "home" ? "/?preview=true" : `/${slug}?preview=true`;
+		},
+		watch: ["title", "slug", "content"],
+		strategy: "hybrid", // "instant" | "server" | "hybrid"
+	});
+```
+
+| Strategy    | Behavior                                                            |
+| ----------- | ------------------------------------------------------------------- |
+| `"instant"` | Patches applied locally only — fastest, no server round-trip        |
+| `"server"`  | Every change round-trips through server before preview updates      |
+| `"hybrid"`  | Local patches for instant response + server reconcile derived data  |
+
+### Frontend Integration
+
+Use `useQuestpiePreview` (replaces the old `useCollectionPreview`) with `<PreviewRoot>`, `<PreviewField>`, and `<PreviewBlock>` components:
+
+```tsx
+import { useQuestpiePreview, PreviewRoot, PreviewField } from "@questpie/admin/client";
+
+function PagePreview({ initialData }) {
+	const router = useRouter();
+	const { data } = useQuestpiePreview({
+		initialData,
+		reconcile: () => router.invalidate(),
+	});
+
+	return (
+		<PreviewRoot>
+			<h1><PreviewField path="title">{data.title}</PreviewField></h1>
+		</PreviewRoot>
+	);
+}
+```
+
+### Key Principles
+
+- Same-tab preview = direct `postMessage` patch bus (NOT save-driven reload)
+- Save/autosave = persistence only
+- Realtime = extension for detached/shared preview only
+- Each message carries `sessionId`, `seq`, `timestamp`, `protocolVersion`
+- Preview wrappers must prevent accidental navigation in the iframe
+
+## History & Versions
+
+Enable `auditModule` for activity timeline. Enable `.versioning()` on collections for snapshot restore:
+
+```ts
+export const pages = collection("pages")
+  .versioning({ drafts: true, maxVersions: 20 })
+  .fields(({ f }) => ({ ... }));
+```
+
+## Scope (Multi-Tenancy)
+
+The admin provides scope primitives for multi-tenant applications. Import from `@questpie/admin/client`.
+
+### ScopeProvider
+
+Wraps the admin to enable scope selection. Manages scope ID in React state and persists to localStorage.
+
+```tsx
+import { ScopeProvider } from "@questpie/admin/client";
+
+<ScopeProvider
+	headerName="x-selected-workspace" // HTTP header for scope ID
+	storageKey="admin-workspace" // localStorage key
+	defaultScope={null} // default value
+>
+	<AdminLayout>...</AdminLayout>
+</ScopeProvider>;
+```
+
+### ScopePicker
+
+Dropdown for selecting the current scope. Place in sidebar via `slots.afterBrand`:
+
+```tsx
+import { ScopePicker } from "@questpie/admin/client";
+
+<AdminLayout
+	admin={admin}
+	basePath="/admin"
+	slots={{
+		afterBrand: (
+			<div className="px-3 py-2 border-b">
+				<ScopePicker
+					collection="workspaces"
+					labelField="name"
+					allowClear
+					compact
+				/>
+			</div>
+		),
+	}}
+/>;
+```
+
+Three data sources: `collection` (queries a collection), `options` (static array), `loadOptions` (async function).
+
+### useScopedFetch / createScopedFetch
+
+Inject scope header into all API calls:
+
+```tsx
+import { useScopedFetch, createScopedFetch } from "@questpie/admin/client";
+
+// React hook
+const scopedFetch = useScopedFetch();
+const client = useMemo(
+	() => createClient({ baseURL: "/api", fetch: scopedFetch }),
+	[scopedFetch],
+);
+
+// Non-React
+const scopedFetch = createScopedFetch("x-selected-workspace", () =>
+	getScopeId(),
+);
+```
+
+### useScope / useScopeSafe
+
+Access current scope state in any component:
+
+```tsx
+import { useScope, useScopeSafe } from "@questpie/admin/client";
+
+const { scopeId, setScope, clearScope, headerName } = useScope(); // throws outside ScopeProvider
+const scope = useScopeSafe(); // returns null outside ScopeProvider
+```
+
+For the full server-side setup (context resolver, type augmentation, access rules), see the `questpie-core/multi-tenancy` skill.
+
+## Common Mistakes
+
+1. **CRITICAL: Using `asChild` prop** — QUESTPIE admin uses `@base-ui/react`, which uses the `render` prop. `asChild` is a Radix pattern and does NOT work here.
+
+   ```tsx
+   // WRONG
+   <DialogTrigger asChild><Button>Open</Button></DialogTrigger>
+   // CORRECT
+   <DialogTrigger render={<Button>Open</Button>} />
+   ```
+
+2. **CRITICAL: Importing from `@radix-ui/*`** — use `@base-ui/react` instead.
+
+3. **HIGH: Using `@phosphor-icons/react`** — use `@iconify/react` with `ph:` prefix.
+
+   ```tsx
+   // WRONG
+   import { CaretDown } from "@phosphor-icons/react";
+   // CORRECT
+   import { Icon } from "@iconify/react";
+   <Icon icon="ph:caret-down" width={16} height={16} />;
+   ```
+
+4. **HIGH: Using lucide-react icons** — use `@iconify/react` with Phosphor icon set.
+
+5. **MEDIUM: Custom `<button>` or `<div>` instead of shadcn components** — use `<Button>`, `<Card>`, etc.
+
+6. **MEDIUM: `console.error` for user errors** — use `toast.error()` from `sonner`.

package/skills/questpie-admin/blocks/SKILL.md

@@ -0,0 +1,305 @@
+---
+name: questpie-admin/blocks
+description: QUESTPIE blocks content-blocks page-builder block-definition fields prefetch renderers block-picker categories nested-blocks upload relation
+type: skill
+---
+
+# QUESTPIE Blocks
+
+This skill builds on questpie-admin.
+
+Blocks are reusable content components for page builders. Define them server-side with fields and admin metadata, then render them client-side with React components.
+
+```text
+Server: block("hero")           Client: HeroRenderer
+  .fields({ title, image })  ->    Receives { values, data }
+  .admin({ label, icon })         Returns JSX
+  .prefetch({ with: {...} })
+```
+
+## Defining Blocks
+
+Blocks are defined in `blocks/` using the `block()` factory:
+
+```ts title="blocks/hero.ts"
+import { block } from "#questpie";
+
+export const heroBlock = block("hero")
+	.admin(({ c }) => ({
+		label: { en: "Hero Section", sk: "Hero sekcia" },
+		icon: c.icon("ph:image"),
+		category: "sections",
+	}))
+	.fields(({ f }) => ({
+		title: f.text({ localized: true, required: true }),
+		subtitle: f.textarea({ localized: true }),
+		backgroundImage: f.upload({ to: "assets" }),
+		overlayOpacity: f.number({ defaultValue: 60 }),
+		alignment: f.select({
+			options: ["left", "center", "right"],
+			defaultValue: "center",
+		}),
+		ctaText: f.text({ localized: true }),
+		ctaLink: f.text(),
+	}))
+	.prefetch({ with: { backgroundImage: true } });
+```
+
+### Admin Metadata
+
+```ts
+.admin(({ c }) => ({
+  label: { en: "Hero Section" },      // Display name in block picker
+  icon: c.icon("ph:image"),           // Icon in block picker (Phosphor set)
+  category: "sections",               // Group in block picker
+}))
+```
+
+### Multiple Blocks Per File
+
+Export multiple named blocks from one file:
+
+```ts title="blocks/layout.ts"
+import { block } from "#questpie";
+
+export const twoColumnBlock = block("twoColumn")
+	.admin(({ c }) => ({
+		label: { en: "Two Columns" },
+		icon: c.icon("ph:columns"),
+		category: "layout",
+	}))
+	.fields(({ f }) => ({
+		left: f.blocks(),
+		right: f.blocks(),
+	}));
+
+export const spacerBlock = block("spacer")
+	.admin(({ c }) => ({
+		label: { en: "Spacer" },
+		icon: c.icon("ph:arrows-out-line-vertical"),
+		category: "layout",
+	}))
+	.fields(({ f }) => ({
+		height: f.select({
+			options: ["sm", "md", "lg", "xl"],
+			defaultValue: "md",
+		}),
+	}));
+```
+
+## Using Blocks in Collections
+
+Add a `blocks` field to any collection:
+
+```ts title="collections/pages.ts"
+import { collection } from "#questpie";
+
+export const pages = collection("pages").fields(({ f }) => ({
+	title: f.text({ required: true, localized: true }),
+	slug: f.text({ required: true }),
+	content: f.blocks({ localized: true }),
+}));
+```
+
+The admin renders a visual block editor for this field.
+
+## Prefetch
+
+Blocks often reference related data (images, linked records). Use `.prefetch()` to load them alongside block values.
+
+### Declarative Prefetch
+
+```ts
+.prefetch({
+  with: {
+    backgroundImage: true,  // Load the full image record
+  },
+})
+```
+
+### Nested Prefetch
+
+```ts
+.prefetch({
+  with: {
+    featuredBarber: {
+      with: {
+        avatar: true,
+        services: true,
+      },
+    },
+  },
+})
+```
+
+### Functional Prefetch
+
+For complex queries, use a function. The `ctx` parameter provides fully typed `collections` and `globals` via `AppContext` augmentation — no imports needed:
+
+```ts title="blocks/featured.ts"
+import { block } from "#questpie";
+
+export const featuredBlock = block("featured")
+	.fields(({ f }) => ({
+		heading: f.text({ required: true }),
+	}))
+	.prefetch(async ({ values, ctx }) => {
+		return {
+			posts: (await ctx.collections.posts.find({ limit: 5 })).docs,
+		};
+	});
+```
+
+### Using Prefetched Data in Renderers
+
+```tsx
+function HeroRenderer({ values, data }: BlockProps<"hero">) {
+	// values.backgroundImage = "asset-id-123" (just the ID)
+	// data.backgroundImage = { url: "/api/assets/...", filename: "hero.jpg", ... }
+
+	return (
+		<section>
+			{data?.backgroundImage?.url && (
+				<img src={data.backgroundImage.url} alt="" />
+			)}
+			<h1>{values.title}</h1>
+		</section>
+	);
+}
+```
+
+## Block Renderers
+
+React components that receive block data and return JSX.
+
+### Defining a Renderer
+
+```tsx title="admin/blocks/hero.tsx"
+import type { BlockProps } from "@questpie/admin/client";
+
+export function HeroRenderer({ values, data }: BlockProps<"hero">) {
+	return (
+		<section
+			className="relative flex items-center justify-center"
+			style={{ minHeight: "60vh" }}
+		>
+			{data?.backgroundImage?.url && (
+				<img
+					src={data.backgroundImage.url}
+					alt=""
+					className="absolute inset-0 w-full h-full object-cover"
+				/>
+			)}
+			<div className="relative text-center">
+				<h1 className="text-5xl font-bold">{values.title}</h1>
+				{values.subtitle && <p className="text-xl mt-4">{values.subtitle}</p>}
+				{values.ctaText && (
+					<a href={values.ctaLink} className="mt-6 inline-block btn">
+						{values.ctaText}
+					</a>
+				)}
+			</div>
+		</section>
+	);
+}
+```
+
+### BlockProps
+
+| Property   | Type        | Description                                        |
+| ---------- | ----------- | -------------------------------------------------- |
+| `values`   | `object`    | Block field values (title, subtitle, etc.)         |
+| `data`     | `object`    | Prefetched relation data (images, related records) |
+| `children` | `ReactNode` | Nested block content                               |
+
+### Registering Renderers
+
+```tsx title="admin/blocks/index.tsx"
+import { HeroRenderer } from "./hero";
+import { GalleryRenderer } from "./gallery";
+import { CTARenderer } from "./cta";
+
+export const renderers = {
+	hero: HeroRenderer,
+	gallery: GalleryRenderer,
+	cta: CTARenderer,
+};
+```
+
+### Frontend Rendering
+
+Use block renderers on the public frontend:
+
+```tsx title="components/page-renderer.tsx"
+import { renderers } from "@/questpie/admin/blocks";
+
+function PageRenderer({ page }) {
+	return (
+		<div>
+			{page.content?.map((block, i) => {
+				const Renderer = renderers[block.type];
+				if (!Renderer) return null;
+				return <Renderer key={i} values={block.values} data={block.data} />;
+			})}
+		</div>
+	);
+}
+```
+
+## Common Mistakes
+
+1. **HIGH: Not using `ctx.collections.*` in functional prefetch** — use the context-injected collections directly. Do NOT import `app` from `#questpie` inside block files (causes circular dependencies).
+
+   ```ts
+   // WRONG — importing app creates circular dependency
+   import { app } from "#questpie";
+   .prefetch(async ({ values, ctx }) => {
+     const posts = await app.collections.posts.find({});
+   })
+
+   // CORRECT — use ctx.collections directly
+   .prefetch(async ({ values, ctx }) => {
+     const posts = await ctx.collections.posts.find({});
+   })
+   ```
+
+2. **HIGH: Importing from `.generated/` inside block files** — block files are imported BY `.generated/index.ts`, so importing from it back creates circular dependencies. Use the `ctx` parameter instead.
+
+3. **MEDIUM: Block renderer not exported as default or named export** — codegen discovers named exports from block renderer files. Ensure the component is exported.
+
+4. **MEDIUM: Using `{ with: { field: true } }` prefetch for complex queries** — declarative prefetch only loads related records by ID. For filtered/sorted/limited queries, use functional prefetch instead.
+
+5. **MEDIUM: Forgetting `.prefetch()` for upload fields** — without prefetch, `values.backgroundImage` is just an ID string. Add `{ with: { backgroundImage: true } }` to get the full asset record with `url`.
+
+6. **LOW: Missing `category` in `.admin()`** — blocks without a category won't be grouped in the block picker, making it harder to find them.
+
+## Blocks in Live Preview
+
+When a collection has `.preview()` configured, blocks participate in the live preview patch bus.
+
+### PreviewBlock Wrapper
+
+Use `<PreviewBlock>` in your frontend to mark block regions for live preview focus and patch targeting:
+
+```tsx
+import { PreviewBlock } from "@questpie/admin/client";
+
+function PageRenderer({ blocks, previewData }) {
+	return blocks.map((block) => {
+		const Renderer = renderers[block.type];
+		return (
+			<PreviewBlock key={block.id} id={block.id}>
+				<Renderer values={block.values} data={block.data} />
+			</PreviewBlock>
+		);
+	});
+}
+```
+
+When the editor focuses a block, `<PreviewBlock>` highlights it in the preview. Patches target individual blocks by ID for granular updates.
+
+### Block Prefetch and Server Reconcile
+
+In `"hybrid"` preview strategy, blocks with functional `.prefetch()` trigger a server reconcile when their field values change. For example, a "featured posts" block with a `limit` field will re-run its prefetch handler on the server to fetch updated data, while simple field changes (title, subtitle) apply instantly via the local patch bus.
+
+Blocks with declarative prefetch (`{ with: { image: true } }`) resolve relations during reconcile — the preview shows the image URL immediately after the server round-trip completes, not just the asset ID.