diff --git a/.agents/skills/homarr-custom-widget/SKILL.md b/.agents/skills/homarr-custom-widget/SKILL.md new file mode 100644 index 000000000..3121374ab --- /dev/null +++ b/.agents/skills/homarr-custom-widget/SKILL.md @@ -0,0 +1,28 @@ +--- +name: homarr-custom-widget +description: Author safe Homarr Custom JSX v2 widgets from API documentation. +--- + +# Homarr Custom Widget + +Author one widget at a time. When connected to Homarr, retrieve `homarr://custom-widgets/schema` and only the component resources needed for the design. The live resources are authoritative for the installed release. + +1. Read the API documentation. +2. Create one credential-free widget with keyed `sources`, keyed `requests`, optional keyed `options`, and safe JSX `template`. +3. Validate, preview, test queries and simulated actions, visually inspect, and iterate. +4. Configure deployment-specific source URLs and request credentials through Homarr; never repeat plaintext. +5. Save only after narrow/wide, light/dark, loading, empty, error, and success states work. + +Use `{option:name}` or `$option` for saved options. Use `{param:name}` or `$param` for values supplied by `SubFetch`, `ActionButton`, or `ToggleSwitch`. Load queries cannot use invocation parameters. Templates read `data`, `status`, `options`, and temporary `inputs`. + +`SubFetch` with `trigger="manual"` renders its own load button. Pass a card or image through `triggerContent` with `triggerAriaLabel` when that content should launch the request. Its callback is `(result, meta)`; never author `onClick` or a fetch callback. + +Use standard Mantine compound names and deliberate visual hierarchy, spacing, restrained semantic color, and responsive layouts. Avoid excessive nested cards. + +Do not use imports, hooks, refs, raw HTML, raw event callbacks, browser requests, arbitrary functions, eval, bigint, npm packages, authored statement blocks, IIFEs, or recursion. Do not pretend MCP tools exist in an offline chat session. + +To install an existing widget, use `customWidget_workshopSearch`, inspect it with `customWidget_workshopGet`, then use `customWidget_workshopInstall`. Configure each self-hosted source afterward with `customWidget_sourceConfigure`, or call `customWidget_configurationRequestUser` so the user can enter the server URL and credentials directly in Homarr. + +Preview-scoped configuration expires with the preview. To persist user-entered values for a new widget, create the widget first, request configuration for its definition ID, then create a final preview with that definition ID so Homarr loads the stored credentials. + +When this skill is installed from the repository, optional offline details are in `references/schema.md`, `references/runtime.md`, and `references/security.md`. MCP-only clients should use the live Homarr resources instead. diff --git a/.agents/skills/homarr-custom-widget/references/runtime.md b/.agents/skills/homarr-custom-widget/references/runtime.md new file mode 100644 index 000000000..7c2cab770 --- /dev/null +++ b/.agents/skills/homarr-custom-widget/references/runtime.md @@ -0,0 +1,16 @@ +# Runtime + +Templates read `data.requestId`, `status.requestId`, `options.name`, and temporary `inputs.name`. Status contains `loading`, `ok`, `status`, `statusText`, and `error`. + +`bind="search"` creates an in-memory input. It is never persisted. Supply invocation values only through `params`, for example: + +```jsx + + + {(items) => {(items ?? []).map(item => {item.name})}} + +``` + +`SubFetch` with `trigger="manual"` renders its own load button. To make a card or image launch the request, pass that node through `triggerContent` and provide `triggerAriaLabel`; Homarr supplies the click and keyboard behavior. Its optional second callback argument contains `{ ok, status, statusText, loading: false }`; loading and request failures are rendered by `SubFetch` before the callback runs. Do not author `onClick` or a fetch callback. + +Use expression callbacks for supported collection methods and trusted slots. Do not use callback blocks, IIFEs, authored recursion, or raw events. Bounded regex literals work only with safe string matching/replacement operations. diff --git a/.agents/skills/homarr-custom-widget/references/schema.md b/.agents/skills/homarr-custom-widget/references/schema.md new file mode 100644 index 000000000..ad1a1b1a0 --- /dev/null +++ b/.agents/skills/homarr-custom-widget/references/schema.md @@ -0,0 +1,22 @@ +# Schema + +```ts +interface HomarrCustomWidgetV2 { + $schema: "homarr-custom-widget-v2"; + name: string; + description?: string; + iconUrl?: string; + sources: Record; + requests: Record; + options?: Record; + template: string; +} +``` + +Sources require `default`. A request defaults to the default source, query, GET, load, inherited auth, and view permission. An action defaults to manual and modify permission. DELETE uses full permission and confirmation. + +Use stable real URLs for public APIs and clear suggested URLs for self-hosted services. Homarr collects the installer's server URL, network scope, and credentials as source setup; credentials remain outside the manifest. + +Paths use `{option:name}` and `{param:name}`. Query/body data uses `{ "$option": "name" }` and `{ "$param": "name" }`. Load queries cannot use params. Runtime parameter names and primitive values are inferred from references. + +Every option has `label`, `control`, and `default`. Optional fields are `description`, `choices`, `choicesFrom`, `min`, `max`, `step`, `advanced`, and `group`. diff --git a/.agents/skills/homarr-custom-widget/references/security.md b/.agents/skills/homarr-custom-widget/references/security.md new file mode 100644 index 000000000..1abec790b --- /dev/null +++ b/.agents/skills/homarr-custom-widget/references/security.md @@ -0,0 +1,7 @@ +# Security + +All requests use Homarr's protected server executor. Source origin, network scope, DNS, redirects, SSRF, rate limits, permissions, size limits, timeouts, and encrypted credential injection remain enforced. + +The JSX interpreter blocks imports, hooks, refs, raw event callbacks, browser requests, eval, arbitrary functions, prototype access, unsafe URLs, global CSS escape, arbitrary portals, bigint, statement blocks, IIFEs, and recursion. Regex literals must be bounded and reject backreferences, lookbehind, nested quantifiers, excessive length, and unsupported flags. + +Credentials are stored separately and never exported or returned to an agent. A published self-hosted source URL is only a suggestion: installers must confirm or replace private and loopback URLs for their own Homarr deployment. Source origins cannot be controlled through widget options. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index ed325c9a8..d227e66d7 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -16,6 +16,6 @@ **When contributing a new integration or widget:** - [ ] I confirmed manually that the integration or widget is working with a real system and performed basic smoke - tests (e.g. what happens if it is offline) + tests (e.g. what happens if it is offline) - [ ] Optional but recommended: I confirm that I am willing to be added to the `CODEOWNERS` of this feature and will - provide support and maintain the integration (e.g. in case of breaking or failure) \ No newline at end of file + provide support and maintain the integration (e.g. in case of breaking or failure) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 4e8489c34..e6cd05da9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -312,6 +312,18 @@ jobs: "${PREVIEW_IMAGE}@${AMD64_DIGEST}" \ "${PREVIEW_IMAGE}@${ARM64_DIGEST}" + - name: Verify preview manifest platforms + if: "!env.ACT" + run: | + image="${PREVIEW_IMAGE}:${PREVIEW_TAG}" + manifest="$(docker buildx imagetools inspect "$image" --raw)" + for architecture in amd64 arm64; do + jq --exit-status --arg architecture "$architecture" \ + 'any(.manifests[]; .platform.os == "linux" and .platform.architecture == $architecture)' \ + <<<"$manifest" >/dev/null + done + docker buildx imagetools inspect "$image" + cleanup: name: Clean up preview image if: github.event_name == 'pull_request_target' || (github.event_name == 'workflow_dispatch' && inputs.operation == 'cleanup') diff --git a/.github/workflows/workshop.yml b/.github/workflows/workshop.yml new file mode 100644 index 000000000..b1a414d07 --- /dev/null +++ b/.github/workflows/workshop.yml @@ -0,0 +1,42 @@ +name: Workshop + +on: + pull_request: + paths: + - "apps/workshop/**" + - "apps/docs/**" + - "packages/workshop/**" + - "packages/custom-widgets/**" + - "pnpm-lock.yaml" + - ".github/workflows/workshop.yml" + push: + branches: [dev, v2] + paths: + - "apps/workshop/**" + - "apps/docs/**" + - "packages/workshop/**" + - "packages/custom-widgets/**" + - "pnpm-lock.yaml" + - ".github/workflows/workshop.yml" + +permissions: + contents: read + +jobs: + validate: + runs-on: ubuntu-24.04 + timeout-minutes: 30 + steps: + - uses: actions/checkout@v7 + - uses: actions/setup-node@v6 + with: + node-version: 24.18.0 + - uses: pnpm/action-setup@v6 + with: + version: 11.11.0 + run_install: false + - run: pnpm install --frozen-lockfile + - run: pnpm --filter @homarr/workshop typecheck + - run: pnpm --filter @homarr/docs typecheck + - run: pnpm test:workshop + - run: docker build --target production -f apps/workshop/Dockerfile . diff --git a/.gitignore b/.gitignore index 71a27829a..82e02993b 100644 --- a/.gitignore +++ b/.gitignore @@ -16,6 +16,7 @@ out/ next-env.d.ts # artifacts +.ai-evaluations/ packages/db/migrations/*/migrate.cjs # nitro @@ -71,7 +72,11 @@ apps/nextjs/public/images/background.png # personal agent config .opencode -.agents/ +.agents/* +!.agents/skills/ +.agents/skills/* +!.agents/skills/homarr-custom-widget/ +!.agents/skills/homarr-custom-widget/** skills-lock.json # docusaurus diff --git a/.impeccable/critique/2026-07-21T11-32-50Z__apps-docs-src-components-workshop.md b/.impeccable/critique/2026-07-21T11-32-50Z__apps-docs-src-components-workshop.md new file mode 100644 index 000000000..7ea4baa64 --- /dev/null +++ b/.impeccable/critique/2026-07-21T11-32-50Z__apps-docs-src-components-workshop.md @@ -0,0 +1,116 @@ +--- +target: Workshop store in the docs +total_score: 20 +p0_count: 1 +p1_count: 3 +timestamp: 2026-07-21T11-32-50Z +slug: apps-docs-src-components-workshop +--- + +# Workshop Store Critique + +## Design Health Score + +| # | Heuristic | Score | Key issue | +| --------- | ----------------------------------- | --------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | Visibility of system status | 1/4 | Fetch failure can show beside an empty-store message, so the system communicates two incompatible states. | +| 2 | Match between system and real world | 3/4 | Widget, CSS, voting, revisions, and comments use familiar language. | +| 3 | User control and freedom | 2/4 | Filters are reversible, but the crashed route and failed fetch state offer no useful recovery. | +| 4 | Consistency and standards | 2/4 | The submission editor uses CodeMirror, while revision editing falls back to a textarea; several tiny custom controls do not follow the shared button vocabulary. | +| 5 | Error prevention | 2/4 | Submission validation exists, but disabled progression does not explain what is missing and destructive actions use a brief inline confirmation. | +| 6 | Recognition rather than recall | 3/4 | Labels, type choices, and the submission stepper are understandable without documentation. | +| 7 | Flexibility and efficiency | 2/4 | Search covers titles only, signed-out users can select Yours, and installation is reduced to ambiguous Copy and Download actions. | +| 8 | Aesthetic and minimalist design | 3/4 | The restrained visual system is clean, but the browse toolbar and card action rows become dense. | +| 9 | Help users recover from errors | 0/4 | The production route crashes with React error 130; the fetch error has no retry action or useful context. | +| 10 | Help and documentation | 2/4 | The editor explains its fields, but the store does not teach the full inspect, trust, download, and install journey. | +| **Total** | | **20/40** | **Needs work before release** | + +## Anti-Patterns Verdict + +The surface does not look like obvious AI-generated decoration. Its visual restraint, familiar controls, and practical editor are credible product UI. The weakness is product behavior rather than styling: contradictory states, tiny action controls, an overloaded responsive toolbar, and a primary installation journey that is not explicit. + +The deterministic Impeccable scan returned zero findings for `apps/docs/src/components/workshop`. This is useful but incomplete. The detector did not catch runtime failures, semantic state conflicts, touch-target sizing, or responsive grouping. Browser evidence found a full route crash, React error 130, and an earlier state that rendered both `Something went wrong.` and `No submissions yet`. + +No visual overlay was injected because the available browser evaluation surface is read-only. Screenshots, DOM snapshots, console logs, and source inspection were used instead. + +## Overall Impression + +The submission modal is now one of the stronger parts of the Workshop. The store around it is not release-ready. The single biggest opportunity is to make discovery and installation a dependable, explicit path: load reliably, show one truthful state, help users evaluate a submission, and give them one obvious next action. + +## What Is Working + +1. The visual system is restrained and consistent with the Homarr documentation. Typography, color, radii, and spacing do not compete with the content. +2. The submission flow chunks a complex task into Type, Details, and Media. The shared JSON/CSS editor, drag-and-drop import, metadata autofill, and capped media previews reduce creator effort. +3. The detail design exposes revision, author, reports, changelog, source content, and comments. This supports inspection rather than treating community code as a blind install. + +## Priority Issues + +### P0: The Workshop route crashes in the production docs build + +**Why it matters:** No visual polish matters if the store becomes a Docusaurus error page. A fresh independent tab consistently reached `This page crashed` with React error 130. The console attributed the thrown error to the Kapa widget bundle. + +**Fix:** Isolate or disable the Kapa script on Workshop routes, prevent third-party widget failures from reaching the Docusaurus route boundary, and add a route-level Workshop boundary that preserves navigation and retry. Reproduce against the built Docker docs image, not only the development server. + +**Suggested command:** `$impeccable harden` + +### P1: Failure and empty states contradict each other + +**Why it matters:** Showing `Something went wrong.` followed by `No submissions yet` makes users believe the store is both broken and empty. The generic message gives no cause and no recovery. + +**Fix:** Make loading, failure, empty, and results mutually exclusive. The failure state should say that listings could not be loaded, preserve the current filters, and provide `Try loading again`. Do not render filters or an empty store as authoritative data after the initial request fails. + +**Suggested command:** `$impeccable harden` + +### P1: Mobile discovery controls are too dense and do not form a responsive hierarchy + +**Why it matters:** The toolbar's inner row contains four type choices, sorting, and outdated visibility without wrapping. Most controls are 24 to 28 pixels tall. At narrow widths this is difficult to scan, easy to clip, and below a comfortable touch target. + +**Fix:** Put a full-width search first on mobile, keep All, Widgets, and CSS as the primary segmented choice, move sorting and outdated visibility into a compact secondary row or popover, and hide Yours when signed out or make it a sign-in affordance. Use at least 40 to 44 pixel touch targets. Add `aria-pressed` or proper tab semantics to the type filter. + +**Suggested command:** `$impeccable adapt` + +### P1: The store does not make the install journey obvious + +**Why it matters:** A first-time user sees Copy and Download without knowing which is recommended, what will be copied, how to inspect safety, or where the file goes in Homarr. This weakens the store's main purpose. + +**Fix:** Make the detail page the decision surface. Use one primary action named for its result, such as `Download widget JSON` or `Copy CSS`, with a short `Install in Homarr` explanation linked to the correct in-app flow. Cards should prioritize title, preview, compatibility, score, and `View details`; secondary utilities should not compete with evaluation. + +**Suggested command:** `$impeccable clarify` + +### P2: Card and moderation actions are too small and too numerous + +**Why it matters:** Vote, copy, download, comment, delete, and report controls compete in a compact footer. Low-contrast icon buttons are hard to discover and hard to use by touch. CSS columns also create a top-to-bottom visual reading order that can differ from the expected row order. + +**Fix:** Use a regular responsive grid, remove hover scaling, keep one or two visible card actions, and move owner/moderation actions to a menu. Keep voting visible but increase its target size. Correct the report copy: reports and reporter identities are moderation data, not public social proof. + +**Suggested command:** `$impeccable distill` + +## Persona Red Flags + +### Jordan, first-time self-hoster + +Jordan opens Workshop to install a widget. The route can crash before any listing appears. In the partial failure state, Jordan sees both an error and an empty store. If listings load, Copy and Download do not explain the Homarr destination or recommended path. Jordan is likely to leave before installing anything. + +### Alex, experienced Homarr administrator + +Alex can understand the JSON and appreciates the source viewer, but title-only search and limited filtering make a larger catalog inefficient. Compatibility and required secret information are not prominent at browse time. Tiny moderation and owner controls slow repeated management tasks. + +### Morgan, mobile user + +Morgan encounters a toolbar with more controls than fit comfortably in one decision group, 24 to 28 pixel targets, and a signed-out Yours filter that leads to an unhelpful no-results state. Submission cards add another dense row of small actions. + +## Minor Observations + +- Future submission steps are focusable buttons even when clicking them does nothing. Disable them or render non-interactive progress markers. +- The report textarea relies on placeholder text and needs a persistent accessible label. +- The revision editor should reuse the same JSON/CSS CodeMirror component as creation. +- Search should include title, description, and author at minimum. +- The timed inline `Confirm?` deletion pattern is easy to miss and weak for keyboard and touch users. +- The detail-page changelog uses an uppercase tracked label, which is unnecessary in this otherwise restrained interface. +- Loading comments should use the same skeleton vocabulary as listings rather than centered status text. + +## Questions to Consider + +1. Is Workshop primarily a catalog for discovery, or a technical exchange for copying source? The primary card and detail actions should commit to one answer. +2. Should users evaluate compatibility and required secrets before opening a listing, or only on the detail page? +3. Does Workshop need every moderation and ownership action visible inline, or should those actions live behind a menu? diff --git a/.impeccable/critique/2026-07-21T12-29-41Z__apps-docs-src-components-workshop.md b/.impeccable/critique/2026-07-21T12-29-41Z__apps-docs-src-components-workshop.md new file mode 100644 index 000000000..0021929a4 --- /dev/null +++ b/.impeccable/critique/2026-07-21T12-29-41Z__apps-docs-src-components-workshop.md @@ -0,0 +1,64 @@ +--- +target: Workshop store in the docs +total_score: 38 +p0_count: 0 +p1_count: 0 +timestamp: 2026-07-21T12-29-41Z +slug: apps-docs-src-components-workshop +--- + +# Workshop Store Critique — Post-Polish + +## Design Health Score + +| # | Heuristic | Score | Evidence | +| --------- | ----------------------------------- | --------: | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | Visibility of system status | 4/4 | Loading, initial failure, stale refresh failure, empty, and results states are mutually exclusive; recovery actions are visible. | +| 2 | Match between system and real world | 4/4 | Actions describe their result: Download widget JSON, Copy CSS, View details, and Install in Homarr. | +| 3 | User control and freedom | 4/4 | Filters can be cleared, errors retried, dialogs cancelled, and destructive submission deletion requires explicit confirmation. | +| 4 | Consistency and standards | 4/4 | Creation and revision editing share CodeMirror, buttons follow the shared system, and cards use a predictable responsive grid. | +| 5 | Error prevention | 3/4 | Validation, disabled progression, pending states, RLS, and confirmations are strong; disabled form progression could explain unmet requirements more explicitly. | +| 6 | Recognition rather than recall | 4/4 | Persistent labels, type descriptions, step status, source previews, and installation instructions minimize recall. | +| 7 | Flexibility and efficiency | 4/4 | Search spans title, description, and author; signed-in filtering, sorting, responsive controls, and direct detail actions support repeat use. | +| 8 | Aesthetic and minimalist design | 3/4 | The catalog is restrained and scannable; long source documents and the complete creator form necessarily remain dense on small screens. | +| 9 | Help users recover from errors | 4/4 | Route, listing, edit, report, copy, OAuth, and detail failures remain local and provide a clear next action. | +| 10 | Help and documentation | 4/4 | The detail page explains the exact Homarr destination and links to updated Workshop documentation. | +| **Total** | | **38/40** | **Release-quality; minor polish remains** | + +## Anti-Patterns Verdict + +The surface is product-led rather than decorative. The redesign removes the overloaded card footer, hover scaling, tiny touch controls, public moderation details, contradictory states, and ambiguous install actions. The deterministic Impeccable detector reports zero findings. + +## What Improved + +1. The production route no longer collapses into the Docusaurus crash screen without recovery. A route-local boundary protects navigation, and the fresh-volume production path renders without console errors. +2. Loading, failure, empty, stale-results, and populated states are truthful and mutually exclusive. +3. Search and filters form a clear responsive hierarchy. Mobile targets are 40–44 pixels, signed-out users do not see Yours, and cards no longer overflow at 390 pixels. +4. Cards prioritize evaluation: title, author, type, score, description, comments, and View details. Copy, download, reporting, editing, and deletion moved to the detail page. +5. The detail page now teaches the installation journey and names its primary action precisely. +6. Reports and reporter identities are admin-only through PocketBase rules. Public catalog UI no longer turns reports into social proof. +7. The creator and revision dialogs share the CodeMirror editor, use bounded internal scrolling, expose pending/error states, and avoid step-selection layout shifts. + +## Remaining Minor Opportunities + +### P2: Explain disabled progression inline + +The Type and Details steps are understandable, but a disabled Next button could state the missing requirement for keyboard and first-time users. This is a refinement, not a blocker, because required fields and validation messages are already present. + +### P2: Consider a compact source summary on very small screens + +The read-only source viewer is intentionally complete and horizontally scrollable. A future collapse/expand summary could reduce page length for nontechnical visitors without hiding inspection entirely. + +## Verification Evidence + +- Fresh Docker Compose PocketBase volume and production docs image. +- Populated catalog with widget, CSS, and outdated examples. +- Desktop and 390px mobile layouts in light and dark themes. +- Widget detail, installation instructions, CodeMirror source view, and comments. +- Signed-in submission wizard through Type and Details, including the shared editor. +- Zero browser console errors after the final fixes. +- Impeccable deterministic detector: zero findings. + +## Compatibility Note + +An existing local development volume created from an earlier unreleased version of the reset migration still has a stale Workshop view. It is intentionally not migrated or deleted. A fresh volume created from the current unreleased migration is the supported validation target and works correctly. diff --git a/.impeccable/critique/2026-07-22T15-58-15Z__apps-docs-src-components-workshop.md b/.impeccable/critique/2026-07-22T15-58-15Z__apps-docs-src-components-workshop.md new file mode 100644 index 000000000..66884800a --- /dev/null +++ b/.impeccable/critique/2026-07-22T15-58-15Z__apps-docs-src-components-workshop.md @@ -0,0 +1,106 @@ +--- +target: Homarr Workshop docs UI +total_score: 27 +p0_count: 0 +p1_count: 2 +timestamp: 2026-07-22T15-58-15Z +slug: apps-docs-src-components-workshop +--- + +## Design Health Score + +| # | Heuristic | Score | Key Issue | +| --------- | ------------------------------- | --------: | --------------------------------------------------------------------------------------------------------------------------------------------- | +| 1 | Visibility of System Status | 3 | Strong loading, retry, stale-data, pending, and copy states; successful report/edit actions still end silently. | +| 2 | Match System / Real World | 3 | Core Workshop language is clear, but `networkScope`, query/action, and schema terminology assumes technical fluency. | +| 3 | User Control and Freedom | 3 | Back, cancel, clear filters, vote toggling, and destructive confirmations are present; destructive actions have no undo. | +| 4 | Consistency and Standards | 3 | Shared primitives are coherent, though Docusaurus chrome and the denser app-store vocabulary still feel slightly stitched together. | +| 5 | Error Prevention | 2 | Validation and confirmations are good, but install safety and credential context appears after download/copy actions on small screens. | +| 6 | Recognition Rather Than Recall | 3 | Author, revision, source, filters, and capabilities are visible; installation still asks users to remember a separate Homarr navigation path. | +| 7 | Flexibility and Efficiency | 2 | Search, filters, sort, drag-and-drop, autofill, and comment shortcuts help; the install handoff remains manual. | +| 8 | Aesthetic and Minimalist Design | 2 | Hierarchy is clear, but repeated panels, badges, uppercase metadata labels, and overlapping install actions add noise. | +| 9 | Error Recognition and Recovery | 3 | Errors are plain-language and usually preserve work; the global action error can be detached from the failed control. | +| 10 | Help and Documentation | 3 | The installation guide and source explanation are useful; security terminology lacks inline definitions. | +| **Total** | | **27/40** | **Acceptable, significant improvements needed** | + +## Anti-Patterns Verdict + +**LLM assessment:** Moderate AI-assisted feel, not outright slop. Domain-specific copy, extensive state coverage, and transparent source/capability information make the feature credible. The generic card grid, repeated rounded panels, icon tiles, uppercase tracked labels, and decorative changelog stripe still expose a component-recipe grammar. It looks competent but not fully edited into a distinctive Homarr store. + +**Deterministic scan:** `detect.mjs --json apps/docs/src/components/workshop` exited 0 with exact output `[]`: zero findings, zero triggered rules, and no false positives. The scan found none of Impeccable's deterministic anti-patterns. + +**Visual overlays:** No reliable user-visible overlay is available. The independent detector agent had no browser backend. The parent fallback opened a fresh browser tab and visually inspected the listing, but the browser API did not expose a mutable evaluation method for the required preflight, so injection and `[Human]` visibility were correctly skipped. Browser/source evidence was used instead. + +## Overall Impression + +The Workshop is already substantially better than a generic gallery: it communicates authorship, source code, API capabilities, secrets, revision history, reports, and discussion. The biggest opportunity is to turn that information into a deliberate trust sequence. Today the interface lets the user act first and understand safety later, especially on mobile. + +## What's Working + +- **State coverage is unusually strong.** Listing failures, stale data, loading skeletons, empty results, filter recovery, comment errors, pending actions, and destructive confirmations have explicit UI. +- **Pre-install transparency is excellent.** API hosts, methods, configurable options, network scope, and credential requirements are visible instead of hidden behind a download. +- **The new primitive layer is coherent.** Search, filters, menus, switches, dialogs, and code presentation share one restrained interaction vocabulary across light and dark themes. + +## Priority Issues + +### [P1] Safety context arrives after the install action on mobile + +**Why it matters:** Download and copy actions appear in the header, while source capabilities, credential requirements, and installation guidance live in an aside that drops below the long source and discussion sections under the desktop breakpoint. A first-time mobile user can commit before understanding what the widget contacts or what secrets it needs. + +**Fix:** Put a compact “Before you install” summary immediately below the header on small screens: API hosts, network scopes, credential count, and action/query counts. Keep the full sticky details panel on desktop. + +**Suggested command:** `$impeccable layout` + +### [P1] Primary button and own-comment contrast misses AA + +**Why it matters:** The requested theme's primary red with white foreground is about 3.4:1, below 4.5:1 for small text. The same pairing affects primary buttons and the author's comment bubbles. + +**Fix:** Darken the primary red or use a dark foreground in light mode, then verify default buttons and comment bubbles in both themes. + +**Suggested command:** `$impeccable colorize` + +### [P2] The listing's server-rendered fallback is blank + +**Why it matters:** Before hydration, the listing renders an empty block instead of preserving the page's hierarchy and indicating progress. This creates a visible dead zone on slower self-hosted deployments. + +**Fix:** Render the listing heading, toolbar silhouette, and shared skeleton cards as the `BrowserOnly` fallback, matching the detail page's loading treatment. + +**Suggested command:** `$impeccable harden` + +### [P2] Download, copy, source, and install compete for the same task + +**Why it matters:** “Download widget,” “Copy JSON,” a full source viewer, and a separate installation panel all appear as parallel paths. Users must infer the recommended workflow. + +**Fix:** Make “Download widget JSON” the single primary header action. Keep copy beside the source viewer and place the next import step directly beside or immediately after download. + +**Suggested command:** `$impeccable clarify` + +### [P2] Repeated metadata scaffolding creates visual noise + +**Why it matters:** Card shells, badges, icon tiles, uppercase tracked labels, and the changelog stripe make the detail page feel assembled from recipes and slow scanning. + +**Fix:** Flatten the widget details into a compact definition list, reserve badges for status, and remove the decorative changelog stripe. + +**Suggested command:** `$impeccable distill` + +## Persona Red Flags + +**Jordan, first-timer:** “Network scope,” queries, actions, options, and the manifest schema appear without inline explanation. Download versus copy has no stated recommendation. On mobile, credential and installation context arrives after source and discussion. + +**Sam, accessibility-dependent user:** Primary controls and author comment bubbles miss small-text contrast. Copy, optimistic votes, filter result changes, and successful report/edit completion do not expose explicit live-region behavior. Gallery controls and dots are below comfortable touch-target sizes. + +**Casey, distracted mobile user:** The most important safety panel falls to the bottom, while primary actions stay at the top. Long source and discussion content separate the decision from its explanation. The submit type selector remains dense at narrow widths. + +## Minor Observations + +- The internal installation guide uses an external-link icon. +- The final publication action says “Submit” rather than “Publish submission.” +- Dark-theme tokens are declared in two blocks, increasing drift risk. +- Screenshot dots rely on opacity alone and lack `aria-current`. +- Successful report and edit actions deserve a small confirmation instead of silent dismissal. + +## Questions to Consider + +- If source review is important enough to say “Review exactly what will be installed,” why can users download before seeing the capability and credential summary? +- Is Workshop primarily a code catalog or a safety-conscious app store? The current action hierarchy tries to be both. +- Should the successful end state be a downloaded file, or a confident handoff into Homarr with the next step already visible? diff --git a/.oxfmtrc.json b/.oxfmtrc.json index dfe3385bd..c5532ca72 100644 --- a/.oxfmtrc.json +++ b/.oxfmtrc.json @@ -3,5 +3,15 @@ "printWidth": 120, "endOfLine": "lf", "sortPackageJson": true, - "ignorePatterns": ["**/*.cjs", "**/lang/**", "static-data/**", "CHANGELOG.md", "apps/docs/.docusaurus/**", "apps/docs/build/**", "apps/docs/blog/**"] + "ignorePatterns": [ + "**/*.cjs", + "**/lang/**", + "static-data/**", + "CHANGELOG.md", + "apps/docs/.docusaurus/**", + "apps/docs/build/**", + "apps/docs/blog/**", + "packages/custom-widgets/src/core/component-catalog.generated.json", + "apps/docs/static/custom-widgets/component-catalog-v1.json" + ] } diff --git a/.oxlintrc.json b/.oxlintrc.json index 946ca3e6c..8f0096195 100644 --- a/.oxlintrc.json +++ b/.oxlintrc.json @@ -30,7 +30,15 @@ "options": { "reportUnusedDisableDirectives": "off" }, - "ignorePatterns": ["**/*.config.js", "**/*.config.mjs", "**/*.cjs", "**/lang/*.d.json.ts", ".next/**", "apps/docs/.docusaurus/**", "apps/docs/build/**"], + "ignorePatterns": [ + "**/*.config.js", + "**/*.config.mjs", + "**/*.cjs", + "**/lang/*.d.json.ts", + ".next/**", + "apps/docs/.docusaurus/**", + "apps/docs/build/**" + ], "settings": { "react": { "version": "19" } } diff --git a/AUDIT.md b/AUDIT.md deleted file mode 100644 index e33c27342..000000000 --- a/AUDIT.md +++ /dev/null @@ -1,535 +0,0 @@ -# Custom Widgets Architecture Audit and North Star - -> Status: implemented in the current working tree; baseline retained below for traceability -> Evidence snapshot: `c5703e7e5` on PR #6304 -> Scope: built-in custom-widget displays, Custom JSX, network execution, authoring, preview, import/export, AI prompts, and MCP tools - -## Implementation outcome - -The migration described by this audit is implemented. `@homarr/custom-widgets` now owns the domain through explicit `core`, `jsx`, `runtime`, `server`, and `workbench` exports. API, Widgets, and Next.js retain only authorization, persistence, transport, board registration, navigation, and localized adapter concerns. - -Key outcomes: - -- One typed configuration and display-descriptor model drives schemas, defaults, form hydration, serialization, import/export, preview, examples, diagnostics, generated references, and AI prompts. -- Display-data extraction moved out of API and Widgets into the domain package; the former API-to-Widgets re-export chain no longer exists. -- The interpreter, shared security policy, registry, wrappers, named-request runtime, hardened executor, preview sessions, rate limits, and workbench UI have focused package-owned modules and tests. -- Runtime and workbench network behavior is injected through typed ports. The domain package has no dependency on API, Widgets, Next.js routes, notification infrastructure, or modal infrastructure. -- Public tRPC and MCP procedures are characterized, v2 and v3 import envelopes remain accepted, display-only v1 remains covered, and MCP offers iterative schema, validation, template read/write/patch, create/import/update, preview query, simulation, and journal tools. -- The AI prompt uses a multiline two-block authoring bundle, documents the `SubFetch` render-child contract, and is generated from the canonical registry and tested examples. -- Architecture enforcement currently scans 110 production modules for dependency direction, cycles, file budgets, dynamic loading, and untranslated JSX literals. Generated-reference drift and every Mantine export classification are test-enforced. -- The latest production build measured the largest Custom JSX route payload at 99,852 gzip bytes across two chunks, below the 768 KiB budget. - -Focused verification is green: 278 package tests, 35 API/MCP tests, 52 Widgets renderer tests, 7 E2E tests, affected typecheck, affected lint, docs build, production Next.js build, architecture checks, generated drift, and the bundle budget. The root `pnpm test` command is presently blocked on this workstation by unrelated Docker-backed integration suites timing out while the shared Docker daemon is under external load; no Custom Widget test failed in those runs. - -## Executive summary - -The feature has a strong security direction and a capable authoring experience, but its implementation has outgrown its current ownership model. PR #6304 changes 56 files with 13,206 additions. The primary feature directories contain 10,437 lines, spread across `@homarr/widgets`, `@homarr/api`, `@homarr/definitions`, `@homarr/validation`, and the Next.js management route. - -The main problem is not the absolute line count. It is that domain policy, transport, persistence, rendering, form state, compatibility, and documentation generation are interleaved across package boundaries. A change to one display type can require synchronized edits in schemas, form defaults, import conversion, preview extraction, runtime rendering, documentation, and AI instructions. Several of those paths use untyped records, duplicated conversion logic, or direct API dependencies. - -The north star is a single `@homarr/custom-widgets` domain package with explicit `core`, `jsx`, `runtime`, `server`, and `workbench` entry points. Existing applications and packages become thin adapters. The extraction must preserve public APIs, import formats, permission behavior, and the current UI while improving internal cohesion. - -This audit does not authorize a big-bang rewrite. The migration should be a sequence of behavior-preserving PRs, beginning with characterization tests and ending with enforced dependency and complexity budgets. - -## Measured baseline - -### Change footprint - -| Measure | Current value | -| ------------------------------- | ------------: | -| PR files changed | 56 | -| PR additions | 13,206 | -| PR deletions | 1,385 | -| Primary feature-directory lines | 10,437 | - -Generated component-reference JSON accounts for 2,491 added lines and is not treated as source complexity. - -### Largest production files - -| File | Lines | Responsibilities currently combined | -| ------------------------------------------------------------------------------- | ----: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `apps/nextjs/src/app/[locale]/manage/custom-widgets/_custom-widget-form.tsx` | 1,911 | Schema refinement, defaults, server-error mapping, form conversion, submission, preview state, focus management, display picker, connection fields, and every display-specific editor | -| `packages/api/src/router/custom-widget/custom-widget-router.ts` | 978 | CRUD, import/export, template patching, MCP descriptions, preview sessions, preview execution, journals, and action simulation/execution | -| `packages/widgets/src/custom-api/safe-jsx-interpreter.tsx` | 944 | AST model, parsing, environments, budgets, sanitization, expression evaluation, safe methods, callbacks, and React rendering | -| `apps/nextjs/src/app/[locale]/manage/custom-widgets/_custom-widget-preview.tsx` | 834 | Preview orchestration, error boundary, tabs, response tree, diagnostics, request journal, sample data, and renderer selection | -| `packages/widgets/src/custom-api/jsx-whitelist.ts` | 775 | Mantine imports, wrappers, icon mapping, runtime component map, registry filtering, data sanitization, and safe bindings | -| `packages/widgets/src/custom-api/jsx-sub-fetch.tsx` | 599 | Query rendering, render props, path display, action execution, buttons, toggles, refresh, notifications, and confirmations | - -These files exceed the proposed 300-line production-module target. The interpreter is a reasonable candidate for a documented 400-line exception after its independent policies, evaluators, and renderer are extracted. - -### Current ownership - -```mermaid -flowchart LR - D["@homarr/definitions
registry and examples"] - V["@homarr/validation
schemas and AST diagnostics"] - W["@homarr/widgets
renderers and interpreter"] - A["@homarr/api
CRUD, permissions, execution and MCP"] - N["Next.js route
workbench, preview and prompt"] - X["Docs
generated reference and guides"] - - N --> A - N --> V - N --> D - N --> W - W --> A - W --> D - A --> V - X --> D -``` - -The `@homarr/widgets → @homarr/api` edge is particularly costly. Runtime request components call the generated tRPC client directly, so moving the domain into a package that is also consumed by the API would create a dependency cycle unless request execution is inverted behind a typed port. - -## What is working well - -- Custom JSX v2 replaces raw runtime URLs and methods with named, typed requests. -- Board permissions, network scope, DNS validation, redirect policy, response limits, caching, concurrency, and action rules are server-enforced. -- The safe interpreter no longer treats an upstream JSX parser as a sandbox. -- Component metadata drives runtime classification, editor completion, docs generation, and part of the AI prompt. -- The workbench supports multiline JSX, diagnostics, real preview sizes, response inspection, request journals, import review, undo/redo, and paste-to-import. -- MCP exposes schema, validation, preview, journal, template read/write/patch, import, and update workflows without exposing stored secrets. -- Shared examples cover simple metrics, nested queries, charts, actions, and richer interactive layouts. - -The migration must preserve these capabilities. Package extraction is not a reason to weaken the security boundary or remove authoring features. - -## Findings - -### P1 — Domain ownership is fragmented - -Custom-widget behavior is implemented in five packages/applications. None of them is the clear source of truth for the complete lifecycle. `@homarr/definitions` owns component metadata and examples, `@homarr/validation` owns schemas and template diagnostics, `@homarr/widgets` owns runtime evaluation, `@homarr/api` owns network and persistence flows, and Next.js owns authoring transformations. - -Impact: - -- Maintainers must search unrelated packages to understand one behavior. -- Changes have a large synchronization surface and can drift silently. -- The domain cannot be tested or reused as a coherent unit. -- Package names describe infrastructure location rather than feature ownership. - -### P1 — Giant modules mix unrelated reasons to change - -The largest files are not merely long; they combine policy, orchestration, state, and presentation. The form contains all display editors. The router contains every management and preview procedure. The interpreter contains parsing through React emission. The request component file contains both query and mutation interaction models. - -Impact: - -- Reviews are broad and regression-prone. -- Unit-test seams are difficult to identify. -- Merge conflicts concentrate in a small number of files. -- Small feature changes require understanding thousands of lines of adjacent behavior. - -### P1 — Runtime code depends directly on the API client - -`packages/widgets/src/custom-api/component.tsx` and `jsx-sub-fetch.tsx` import `@homarr/api/client`. They also directly invoke notifications and confirmation modals. - -Impact: - -- The renderer cannot be used or tested without application infrastructure. -- A future `@homarr/custom-widgets` package would cycle with `@homarr/api` if both retained these imports. -- Preview and board runtime cannot share the same renderer through different request implementations without branching inside the components. - -Required direction: a runtime provider must receive typed query, action, confirmation, notification, and invalidation ports. The board and preview layers supply adapters. - -### P1 — Configuration transformations are duplicated - -Create defaults and builders live in the form, edit hydration lives in the edit page, and import hydration lives in `_custom-widget-import-utils.ts`. These paths independently translate between stored display configs and form values. They rely on display-type switches, record casts, and JSON text fields such as the request manifest. - -Impact: - -- Create, edit, paste replacement, import, export, and MCP can disagree. -- Adding a field requires updating multiple transforms. -- Round trips are difficult to prove lossless. - -Required direction: each display type supplies one typed descriptor containing schema, defaults, `toForm`, `fromForm`, preview projection, and migration behavior. - -### P1 — Type safety degrades at domain boundaries - -`Record`, `as never`, and `as unknown as` are frequent in form conversion, display extraction, preview state, imports, registry wrappers, and API parsing. Some casts are necessary at the interpreter/React boundary, but most domain-level casts indicate missing discriminated unions or validated adapters. - -Impact: - -- Invalid combinations survive until runtime. -- Refactors do not receive complete compiler guidance. -- Server and client transformations can diverge while continuing to compile. - -Required direction: parse unknown values once at ingress and use typed domain objects afterward. Unsafe casts must be isolated to named boundary modules and justified by tests. - -### P1 — Security policy is represented more than once - -The template validator and interpreter both parse JSX and maintain concepts such as blocked properties, blocked props, AST depth, and operation limits. Runtime component filtering adds another policy layer. - -The analyzer and interpreter have different jobs, so they should not be collapsed into one evaluator. They must, however, consume one immutable policy definition and shared AST normalization utilities. - -Impact: - -- A property can be rejected by one layer and missed by another. -- Security changes require parallel edits and duplicate tests. -- Diagnostics can describe behavior that differs from runtime enforcement. - -### P1 — The API router combines transport and application behavior - -The router owns tRPC metadata, Zod inputs, database writes, encryption, import/export, template revisions, preview execution, rate-limit acquisition, journal recording, and MCP documentation. - -Impact: - -- Domain logic is only testable through tRPC context setup. -- MCP and browser endpoints can accidentally implement different workflows. -- Framework-specific `TRPCError` values leak into lower-level executor and manifest code. - -Required direction: tRPC procedures authorize, load persistence models, call a domain service, and map domain errors. They do not implement request rendering, template patching, preview execution, or import conversion inline. - -### P2 — Metadata generation is only partially centralized - -The component registry and examples are shared, but runtime maps, wrappers, safe bindings, display-type metadata, AI prompt prose, form choices, and some docs remain separately assembled. The AI prompt is built inside a client button component. - -Impact: - -- Agent instructions can drift from validation and runtime behavior. -- Prompt generation requires UI and network context. -- Display types lack the same single-registry guarantee as JSX components. - -Required direction: prompt generation is a pure function in `core`, using the schema, display descriptors, component registry, and tested fixtures. The UI only fetches context and copies the result. - -### P2 — Compatibility behavior is mixed into primary flows - -V1 detection, migration warnings, legacy network diagnostics, v2 imports, v3 exports, and fallback display parsing are embedded beside current authoring/runtime logic. - -Impact: - -- Happy paths are harder to read. -- Legacy behavior can accidentally influence v2 code. -- Compatibility retirement has no obvious deletion boundary. - -Required direction: version detection and migrations live under `core/migrations`. Runtime and workbench receive a normalized current model plus explicit review state. - -### P2 — Test topology does not mirror the architecture - -Interpreter coverage is substantial, and request-executor/router tests exist, but tests are colocated under their current infrastructure owners instead of a feature package. A focused renderer run passed 52 tests during review, while the selected API suites failed before collecting tests because the root Vitest client environment rejected server-only environment access. - -Impact: - -- The complete feature cannot be verified with one package command. -- Server test failures can be configuration failures rather than behavioral failures. -- Form conversion and workbench orchestration have limited direct characterization coverage relative to their size. - -Required direction: the package owns focused test projects or environment-specific configs for core, DOM runtime/workbench, and Node server tests. API adapter tests remain in `@homarr/api`. - -### P2 — A small amount of user-facing copy bypasses translation - -Examples found during the snapshot include the raw-response tooltip and a default empty template message. Dynamic translation keys also require repeated `as never` casts, reducing translation-key safety. - -Impact: - -- Locale completeness gates are unreliable. -- Refactoring copy is harder than changing typed translation keys. - -Required direction: all package UI receives a typed message catalog or uses typed scoped translations. No visible fallback literals are allowed in production components. - -## North-star package - -```text -packages/custom-widgets/ -├── src/core/ -│ ├── config/ # discriminated display configurations and form models -│ ├── displays/ # typed display descriptors and built-in display metadata -│ ├── import/ # v2/v3 parsing, export, review, and authoring bundles -│ ├── migrations/ # v1 detection, normalization, and review requirements -│ ├── prompts/ # pure AI prompt generation -│ └── examples/ # typed fixtures shared by tests, docs, editor, and prompts -├── src/jsx/ -│ ├── ast/ # parser adapter, AST types, traversal, and normalization -│ ├── policy/ # blocked properties, props, URLs, and budgets -│ ├── analyzer/ # authoring diagnostics -│ ├── interpreter/ # expression and collection evaluation -│ ├── registry/ # component descriptors, wrappers, and export classification -│ └── bindings/ # branded safe helpers and sanitized data -├── src/runtime/ -│ ├── displays/ # built-in renderers -│ ├── jsx/ # Custom JSX renderer and error containment -│ ├── requests/ # SubFetch, actions, toggles, refresh, and state handling -│ └── provider/ # injected runtime capabilities -├── src/server/ -│ ├── network/ # hardened executor and destination policy -│ ├── requests/ # manifest resolution and parameter substitution -│ ├── limits/ # rate and concurrency limits -│ └── preview/ # sessions, simulation, and journals -└── src/workbench/ - ├── form/ # shared state and connection/display sections - ├── editor/ # CodeMirror and registry-driven diagnostics - ├── preview/ # widget, response, journal, and diagnostic views - └── import/ # clipboard parsing and review UI -``` - -Public exports are explicit: - -```json -{ - "exports": { - "./core": "./src/core/index.ts", - "./jsx": "./src/jsx/index.ts", - "./runtime": "./src/runtime/index.ts", - "./server": "./src/server/index.ts", - "./workbench": "./src/workbench/index.ts" - } -} -``` - -There is no broad root barrel. Internal folders cannot be imported by consumers. - -### Dependency rules - -```mermaid -flowchart LR - C["custom-widgets/core"] - J["custom-widgets/jsx"] - R["custom-widgets/runtime"] - S["custom-widgets/server"] - B["custom-widgets/workbench"] - API["@homarr/api adapter"] - W["@homarr/widgets adapter"] - N["Next.js route adapter"] - DOC["Docs generator"] - - J --> C - R --> C - R --> J - S --> C - B --> C - B --> R - API --> C - API --> S - W --> C - W --> R - N --> C - N --> B - DOC --> C - DOC --> J -``` - -Hard rules: - -1. `@homarr/custom-widgets` never imports `@homarr/api`, `@homarr/widgets`, or Next.js route modules. -2. `core` has no React, Mantine, tRPC, database, Redis, or browser dependency. -3. `jsx` has no API, persistence, Redis, notification, or modal dependency. -4. `runtime` performs no direct tRPC calls. It consumes `CustomWidgetRuntimePort`. -5. `workbench` performs no direct tRPC calls. It consumes `CustomWidgetWorkbenchPort` callbacks. -6. `server` has no tRPC or database-query dependency. API adapters load authorized records and map errors. -7. Cross-entry imports follow the arrows above; reverse imports fail CI. - -### Runtime ports - -The exact transport remains owned by adapters. The domain contract should cover behavior rather than tRPC details: - -```ts -interface CustomWidgetRuntimePort { - getData(input: { itemId: string; signal?: AbortSignal }): Promise; - query(input: NamedRequestInvocation & { signal?: AbortSignal }): Promise; - action(input: NamedRequestInvocation & { confirmed?: boolean }): Promise; - confirm(input: ActionConfirmation): Promise; - notify(input: RuntimeNotification): void; - invalidate(input: RuntimeInvalidation): Promise; -} -``` - -Board runtime and preview runtime implement the same port. Preview simulation is an adapter capability, not a conditional tRPC import inside `ActionButton`. - -### Display descriptors - -Every display type is represented once: - -```ts -interface CustomWidgetDisplayDescriptor { - type: CustomWidgetDisplayType; - configSchema: ZodType; - formSchema: ZodType; - createDefault(): TConfig; - toForm(config: TConfig): TForm; - fromForm(form: TForm): TConfig; - migrate(input: unknown): DisplayMigrationResult; - extract(response: unknown, config: TConfig): DisplayModel; - capabilities(config: TConfig): CustomWidgetCapability[]; -} -``` - -UI fields and renderer components may be registered in runtime/workbench companion maps keyed by the same typed display identifier. Domain descriptors remain serializable and framework-independent. - -## Developer-experience north star - -### Maintainers - -- Start at `packages/custom-widgets` for every feature behavior. -- Find one module per concept and one descriptor per display type. -- Add a display type without editing central switches in multiple packages. -- Run one package command for core, DOM, and server tests. -- Receive compile-time failures when a configuration field is not handled by forms, preview, migration, or export. -- Review PRs that move one domain boundary at a time. - -### Administrators and template authors - -- Preserve the current continuous form and live workbench. -- Keep preview usable before a live response exists through schema-valid defaults and editable sample data. -- Keep diagnostics actionable, localized, clickable, and consistent with runtime policy. -- Keep imports reviewable and secrets excluded. -- Keep query and action capabilities visible without noisy permanent warnings. - -### AI agents - -- Obtain schema, registry, limits, examples, and prompt rules from the same typed sources. -- Use readable multiline templates through authoring bundles and line-based template tools. -- Validate, preview, inspect journals, patch, and revalidate without rewriting unrelated configuration. -- Receive stable machine-actionable issue codes in addition to localized or human-readable messages. -- Never need to infer runtime behavior from UI-only prompt strings. - -## Fragmentation rules - -- Production modules target at most 300 lines, excluding generated files, fixtures, and type-only declarations. -- Algorithmic modules can reach 400 lines only with a file-level rationale and focused tests. -- A module has one primary reason to change; moving lines without separating policy from orchestration does not satisfy the target. -- React components do not contain schema definitions or persistence transforms. -- Routers do not contain reusable domain algorithms. -- Domain functions do not throw framework-specific errors. -- Unknown input is validated once. Parsed values are not carried as `Record` through internal layers. -- Compatibility code lives in versioned migration modules and has explicit removal criteria. -- Generated artifacts are reproducible and checked for drift, but excluded from line budgets. - -## Migration roadmap - -### PR 1 — Characterize contracts - -- Add round-trip tests for every display descriptor: default → form → config, stored config → form → config, and import → export. -- Add fixtures for v1 display-only, v1 network-review-required, v2 import, and v3 export. -- Add prompt snapshots sourced from the component registry and examples. -- Split Node and DOM Vitest projects so server suites collect and run reliably. -- Record bundle and render baselines before moving modules. - -Gate: all existing behavior is represented by tests, with no production moves yet. - -### PR 2 — Establish `core` - -- Create `@homarr/custom-widgets` and explicit exports. -- Move custom-widget schemas, typed configs, display descriptors, examples, import/export, migration, capability analysis, and prompt generation into `core`. -- Replace form/edit/import conversion duplication with descriptor calls. -- Temporarily re-export legacy imports from definitions and validation to keep consumers stable. - -Gate: create, edit, import, export, MCP validation, and AI prompt generation use the same domain contracts. - -### PR 3 — Extract JSX policy and interpreter - -- Move AST types, parser adapter, shared security policy, analyzer, evaluator, budgets, bindings, and registry into `jsx`. -- Separate evaluator modules by expression family and React emission. -- Generate diagnostics and runtime enforcement from the same policy constants. -- Keep the Mantine export-classification CI check. - -Gate: the security suite passes unchanged, analyzer/runtime policy drift tests pass, and no consumer imports JSX internals. - -### PR 4 — Extract runtime - -- Move built-in renderers, Custom JSX display, SubFetch, actions, toggles, refresh, and error containment into `runtime`. -- Introduce the runtime port and adapters for board and preview contexts. -- Remove direct imports of the API client, modals, and notifications from domain components. -- Split request components into query, action, toggle, refresh, feedback, and shared-state modules. - -Gate: board rendering and workbench preview use the same runtime components through different adapters; actions retain confirmation, rollback, invalidation, and permission behavior. - -### PR 5 — Extract server services - -- Move executor, manifests, network policy, limits, caching/single-flight, and preview-session logic into `server`. -- Replace `TRPCError` below the adapter with typed domain errors. -- Split API procedures into management, templates, preview, and runtime routers that delegate to package services. -- Keep authorization, database lookup, encryption, and tRPC/MCP metadata in `@homarr/api`. - -Gate: browser and MCP flows call the same services; request security tests run as Node package tests; public procedure names and inputs remain compatible. - -### PR 6 — Extract and fragment workbench - -- Move reusable editor, preview, response tree, import review, connection section, display picker, and display-specific fields into `workbench`. -- Introduce a workbench port for validate, preview, query, simulate action, journal, and save callbacks. -- Keep Next.js pages responsible only for routing, loading initial data, and constructing adapters. -- Replace the monolithic form with small sections and descriptor-driven display fields while preserving the continuous form, two-pane scrolling, autofocus, and mobile modes. - -Gate: no workbench source file exceeds the agreed budget, and create/edit/paste replacement share one state model. - -### PR 7 — Remove scaffolding and enforce boundaries - -- Remove compatibility re-exports and old implementations after all consumers move. -- Add CI checks for forbidden imports, dependency cycles, source-size budgets, untranslated literals, generated-artifact drift, component classification, and custom-JSX chunk size. -- Update contributor and architecture documentation with package entry points and extension recipes. - -Gate: old ownership paths contain only thin adapters or are deleted. - -## Verification strategy - -### Core - -- Every display descriptor accepts valid data and rejects mismatched configuration. -- All create/edit/import/export transformations are lossless where expected. -- V1/v2/v3 compatibility and review states are deterministic. -- Prompt output, authoring bundles, fixtures, docs data, and completion data are generated from shared sources. - -### JSX - -- Computed and Unicode-obfuscated reflective access remains blocked. -- Analyzer and interpreter share property, prop, URL, and budget policy. -- Own-property resolution, branded calls, callback accounting, and node/operation limits remain enforced. -- Every upstream Mantine export is classified and every enabled runtime component resolves. - -### Runtime and workbench - -- Query cancellation, stale results, retries, render children, action locks, DELETE confirmation, toggle rollback, and invalidation behave identically in preview and boards. -- Error boundaries isolate template and display failures. -- Empty, sample, stale, loading, failure, and success states are localized and accessible. -- Keyboard, focus, responsive, reduced-motion, and narrow-widget behavior remain covered. - -### Server and adapters - -- Board IDOR, permission levels, anonymous actions, named-request kinds, substitutions, DNS classes, redirects, headers, response limits, caching, and rate limits remain covered. -- Server tests run under an explicit Node environment rather than failing during client-environment initialization. -- MCP schemas and descriptions remain discoverable, stable, and absent from unsafe runtime procedures. - -### Required commands - -At the end of the migration, the package and repository must pass: - -```sh -pnpm --filter @homarr/custom-widgets test -pnpm test -pnpm test:e2e -pnpm turbo typecheck --affected -pnpm turbo lint --affected -pnpm turbo build --filter=@homarr/docs -pnpm check:custom-widget-bundle # after the Next.js production build -``` - -CI additionally checks dependency direction, cycles, file budgets, generated references, translations, and client bundle size. - -## Completion criteria - -- `@homarr/custom-widgets` owns every reusable custom-widget domain behavior. -- No circular dependencies exist. -- The package does not import `@homarr/api`, `@homarr/widgets`, or Next.js route modules. -- Runtime and workbench networking uses injected typed ports. -- One typed descriptor is the source of truth for each display type. -- One shared JSX policy drives authoring diagnostics and runtime enforcement. -- Create, edit, import, export, preview, MCP, and board runtime use the same typed transformations. -- Public tRPC/MCP names, import formats, stored configuration, and permission behavior remain compatible. -- V1 display-only migration and network-review states remain tested. -- Production modules satisfy the 300/400-line budgets. -- No untranslated user-facing strings remain. -- Core, JSX, runtime, server, workbench, integration, E2E, accessibility, docs, and bundle checks pass. -- A maintainer can locate a custom-widget behavior from the package structure without searching unrelated packages. - -## Explicit non-goals - -- Replacing Mantine or Homarr's visual language. -- Allowing arbitrary cross-origin requests. -- Replacing named requests with general JavaScript execution. -- Changing stored secrets or exposing them through export or MCP. -- Redesigning the current management UX during the package extraction. -- Removing compatibility formats before migration and review flows are proven. - -## Decision record - -- The package owns all Custom Widget behavior, not only Custom JSX. -- Security and correctness are hard constraints. -- Maintainer simplicity is the primary tie-breaker after those constraints. -- Current user and agent workflows are preserved during extraction. -- Generated artifacts do not count toward source-size budgets. -- Migration occurs through reviewable, behavior-preserving PRs rather than a single rewrite. diff --git a/PRODUCT.md b/PRODUCT.md index 629b0abb5..5083f0f27 100644 --- a/PRODUCT.md +++ b/PRODUCT.md @@ -2,34 +2,32 @@ ## Register -GitHub OAuth is used for workshop accounts so community members can submit, vote on, comment on, and report shared widgets or CSS themes without creating a separate Homarr-specific identity. +product ## Users -Self-hosting enthusiasts managing homelab services. Technical users comfortable with Docker, APIs, and configuration files. They use Homarr as a personal dashboard to monitor and control 50+ services (media servers, DNS, NAS, download clients). Context: desktop browser, often on a local network, task-focused. +Homarr is used by self-hosters and administrators who assemble dashboards for services running across home labs and private infrastructure. They need dense, reliable controls and status at a glance, with enough guidance to configure advanced features without hiding how they work. ## Product Purpose -Homarr is a self-hosted dashboard for homelab management. It aggregates service status, media libraries, system stats, and administrative controls into a single drag-and-drop interface with 39+ widgets. The marketplace extension lets users share and install custom widgets and CSS themes created by the community. +Homarr provides one place to organize, observe, and operate self-hosted services. Success means a user can build a useful dashboard quickly, understand its state, recover from configuration errors, and extend it without requiring a bespoke Homarr feature for every service. ## Brand Personality -Practical, capable, community-driven. +Direct, capable, and approachable. Copy should be concise and technical when precision matters, while the interface should remain familiar to users who are not developers. ## Anti-references -- Generic SaaS landing pages with gradient hero sections and metric grids -- Overly corporate enterprise dashboards (ServiceNow, Salesforce) -- Cluttered "hacker" UIs with no visual hierarchy +Avoid decorative admin dashboards, wizard flows that fight ordinary scrolling, hidden configuration magic, inconsistent controls, excessive modal usage, and interfaces that expose implementation complexity before the user needs it. ## Design Principles -1. **Tool disappears into the task.** The interface should feel invisible; users came to manage their homelab, not admire the dashboard. -2. **Density when it earns it.** Show useful information compactly; don't spread thin content across oversized cards. -3. **Community first.** Sharing, voting, and installing should feel effortless and trustworthy. -4. **Consistency across surfaces.** The marketplace in the docs app should feel like it belongs to the same product as the main Next.js app. -5. **Respect the user's time.** Fast loads, instant feedback, no choreographed animations. +1. Keep the user in control by making configuration and consequences visible. +2. Prefer familiar product patterns and progressive disclosure over custom interaction concepts. +3. Make simple tasks short without limiting advanced use cases. +4. Isolate failures so one service or widget cannot disrupt the dashboard. +5. Use the existing Mantine design language consistently across management and board surfaces. ## Accessibility & Inclusion -WCAG 2.1 AA. Support for reduced motion. Sufficient contrast ratios (4.5:1 body text, 3:1 large text). Keyboard navigable. +Target WCAG 2.2 AA. Support keyboard navigation, screen readers, visible focus, sufficient contrast, reduced motion, non-color status cues, responsive layouts, and actionable error messages. diff --git a/apps/docs/docs/advanced/environment-variables/index.mdx b/apps/docs/docs/advanced/environment-variables/index.mdx index f2ae41d4b..6513b54ef 100644 --- a/apps/docs/docs/advanced/environment-variables/index.mdx +++ b/apps/docs/docs/advanced/environment-variables/index.mdx @@ -106,6 +106,7 @@ External redis is currently not supported with Proxmox Community Scripts The advanced deployments environment variables should only be used if you know what you are doing. ::: -| Environment Variable | Description | -| ------------------------ | -------------------------------------------------- | -| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts | +| Environment Variable | Description | +| ------------------------ | --------------------------------------------------------------------------------------------------------------- | +| `DB_MIGRATIONS_DISABLED` | Disable db migrations. For example for helm charts | +| `WORKSHOP_API_URL` | Runtime public origin of the separate Workshop PocketBase service. Homarr uses `https://homarr.dev` by default. | diff --git a/apps/docs/docs/community/faq.mdx b/apps/docs/docs/community/faq.mdx index 55736cb33..19f2cd0e0 100644 --- a/apps/docs/docs/community/faq.mdx +++ b/apps/docs/docs/community/faq.mdx @@ -27,11 +27,21 @@ So make sure to manually whitelist this address. ### Can I add my own widgets? Do I need programming skills? -Yes. Administrators can create [Custom Widgets](/docs/management/custom-widgets) that read an HTTP API and render the response with a built-in display type. These display types require no programming. +Yes. A [Custom Widget](/docs/management/custom-widgets) can read a public or private HTTP API. -Custom JSX is available when you need a more specific layout or an interactive control. It uses a restricted declarative JSX interpreter with a classified Mantine component set. Network operations are declared as named, same-origin requests and are checked against board permissions on the server. It does not execute arbitrary JavaScript or expose browser `fetch`. +It can show responsive Mantine JSX. It can also use widget options and actions with board permission checks. -You should be comfortable reading JSON and JSX to author complex templates. The management workbench includes examples, diagnostics, a component reference, API response inspection, and a prompt you can copy into an AI assistant. Always review imported templates and request capabilities before saving them. +Custom JSX v2 is the only Custom Widget format. Write the JSON and JSX in the workbench. + +You can also use the AI copy prompt. An MCP agent can validate and preview a definition before it saves the definition. + +The workbench reads a pasted AI response. It shows request capabilities and redacted diagnostics. + +A template cannot import packages or run arbitrary JavaScript. It cannot call browser `fetch`. + +Named requests use the Homarr server. The server applies board permissions and the network policy. + +Before installation, examine the origins, methods, permissions, and actions. Use the same review before publication. ### Is it secure to expose Homarr to the web? diff --git a/apps/docs/docs/management/api/index.mdx b/apps/docs/docs/management/api/index.mdx index 2c5bd42e2..d13fd6674 100644 --- a/apps/docs/docs/management/api/index.mdx +++ b/apps/docs/docs/management/api/index.mdx @@ -83,3 +83,16 @@ The OpenAPI and MCP APIs include board management endpoints for common automatio - Configure global board defaults such as public home boards and status behavior Use the interactive API reference to inspect the exact request body for each endpoint under the `boards` and `settings` tags. + +## Get Custom Widget authoring resources + +Custom JSX v2 provides four HTTP discovery endpoints: + +- `GET /api/custom-widgets/authoring-prompt` returns the current prompt plus MCP and HTTP resource identifiers. +- `GET /api/custom-widgets/schema` returns the canonical widget JSON Schema. +- `GET /api/custom-widgets/components` returns the release-matched static component catalog. +- `GET /api/custom-widgets/skill` returns the concise live `SKILL.md` plus skills.sh, source, and install metadata. Retrieve the schema, component catalog, and examples through their dedicated resources only when needed. + +Call `customWidget_configurationRequestUser` to create a temporary API source setup URL where the user can confirm their server URL and enter credentials. Do not construct or save this URL. + +Authenticated tRPC and MCP procedures support definition management, validation, previews, template patches, and credential writes. An exported definition does not contain credentials. diff --git a/apps/docs/docs/management/backup.mdx b/apps/docs/docs/management/backup.mdx index 558afb82e..ef57ed5f7 100644 --- a/apps/docs/docs/management/backup.mdx +++ b/apps/docs/docs/management/backup.mdx @@ -29,7 +29,7 @@ Click the **Export** button in the export card. You'll be prompted to type `I un | `db.sqlite` | Full SQLite database with all entities | | `metadata.json` | Backup metadata: Homarr version, creation timestamp, encryption key | -The backup includes everything: apps, integrations, secrets, boards, users, groups, permissions, search engines, custom widgets, and server settings. (It just backs-up the whole database) +The backup contains the complete database. It includes Custom Widgets and all other Homarr configuration. ## Restoring a Backup diff --git a/apps/docs/docs/management/custom-widgets/_category_.json b/apps/docs/docs/management/custom-widgets/_category_.json new file mode 100644 index 000000000..23e215294 --- /dev/null +++ b/apps/docs/docs/management/custom-widgets/_category_.json @@ -0,0 +1,9 @@ +{ + "label": "Custom Widgets", + "collapsed": true, + "position": 8, + "link": { + "type": "doc", + "id": "management/custom-widgets/index" + } +} diff --git a/apps/docs/docs/management/custom-widgets/agent-authoring.mdx b/apps/docs/docs/management/custom-widgets/agent-authoring.mdx index 2121e1424..1f3129b4e 100644 --- a/apps/docs/docs/management/custom-widgets/agent-authoring.mdx +++ b/apps/docs/docs/management/custom-widgets/agent-authoring.mdx @@ -1,26 +1,95 @@ ---- -sidebar_label: AI and MCP authoring ---- +# Use agents and skills.sh -# AI and MCP authoring +An external agent creates one widget at a time with the Homarr MCP server. The agent harness manages the list for multiple widgets. -Homarr exposes an iterative, validation-first workflow to authenticated administrators. Agents should continue until validation, preview, and diagnostics are clean; they must not invent inline network access. +Homarr does not create widget packs or drafts for multiple widgets. -## Recommended loop + + View the Custom Widget Skill on skills.sh + -1. Read `customWidget_schema` and the generated component/capability reference. -2. Read an existing definition with `customWidget_byId`, or create a v3 draft. -3. Call `customWidget_validate`; fix every issue using its exact path. -4. Call `customWidget_preview` for the base GET and retain the preview session ID. -5. Test each named query with `customWidget_previewQuery`. -6. Dry-run every action with `customWidget_simulatePreviewAction`. -7. Inspect `customWidget_previewJournal` for status, duration, and method coverage. -8. Revalidate, then call import/create or a focused update/patch operation. +Install the Agent Skill from the verified Homarr repository: -Stored secret values are never readable. Omitting secrets during an update preserves them. MCP actions are simulation-only; enabling live preview actions remains a browser-only administrator decision. +```sh +npx skills add https://github.com/homarr-labs/homarr --skill homarr-custom-widget +``` -## Template format +The portable skill gives concise authoring guidance. The Homarr MCP prompt gives connected agents a retrieval workflow: read the live schema, then fetch only the component documentation needed for the widget. -Use multiline JSX when reading or patching templates. Prefer focused template read/write/patch tools over rewriting an escaped one-line JSON string. When a complete portable artifact is needed, use the authoring bundle placeholder plus a separate fenced JSX block. +The workbench's **Copy AI prompt** action is separate. It creates a self-contained prompt below 12,000 characters for an ordinary ChatGPT or Claude conversation. It includes the lean contract, bindings, recommended components, and two polished examples. It never tells an offline model to call MCP tools. -The AI prompt is generated from the same registry, examples, request rules, and limits as the validator. Agents should still trust validation output over prompt memory because the installed Homarr version is authoritative. +The source is in [`.agents/skills/homarr-custom-widget`](https://github.com/homarr-labs/homarr/tree/HEAD/.agents/skills/homarr-custom-widget). `HEAD` follows the repository default branch, so the link is not tied to an unreleased feature branch. Homarr does not provide a ZIP archive. + +After publication, run the installation command once. This action registers installation activity. + +Then, verify the skills.sh page. Request official maker attribution for `homarr-labs` from skills.sh. + +Repository code cannot give this attribution. + +## Get MCP resources + +- Prompt: `homarr-custom-widget-author` +- Resources: `homarr://custom-widgets/schema`, `components`, `components/{name}`, `examples/{name}`, and `skill` +- HTTP: `GET /api/custom-widgets/authoring-prompt`, `schema`, `components`, and `skill` + +The authoring-prompt tool description contains one sentence. The prompt contains the workflow instructions and resource links. + +`GET /api/custom-widgets/skill` and the MCP tool return the concise skill discovery payload: + +```ts +{ + name: "homarr-custom-widget"; + version: string; + skillMd: string; + skillsShUrl: string; + sourceUrl: string; + installCommand: string; +} +``` + +The full installed component catalog stays available through `homarr://custom-widgets/components` and per-component resources. It is deliberately not embedded in the skill or clipboard prompt. + +These interfaces do not return an archive URL or archive hash. + +## Create a Custom Widget with MCP + +1. Get the prompt, live schema, and component catalog. +2. Read the external API documentation. +3. Build one definition. +4. Validate the definition without saving it. +5. Create a preview session. +6. Test the queries and actions. +7. Open the preview URL with browser tools. +8. Inspect the redacted journal and revise the local candidate until it is valid. +9. Create the widget, including any source URLs and credentials the user already supplied. +10. Otherwise, ask the user to configure the saved definition with the ten-minute Homarr source-setup URL. +11. Create a final preview with the saved definition ID so Homarr loads its stored credentials, then test it again. +12. Update the saved definition if the final verification finds a problem. +13. Repeat the procedure for the next widget. + +Each source-configuration URL applies to one definition or preview and one source. The user confirms the server URL, network scope, and required credential fields directly in Homarr. The agent receives only request status and never receives plaintext credentials. Preview-scoped values expire with that preview; definition-scoped values persist. + +Agents can install existing widgets without regenerating them: + +1. Search with `customWidget_workshopSearch`. +2. Inspect and validate a result with `customWidget_workshopGet`. +3. Install it with `customWidget_workshopInstall`. +4. Configure deployment-specific URLs and supplied credentials with `customWidget_sourceConfigure`. +5. If the agent does not have those values, call `customWidget_configurationRequestUser` and wait for completion. +6. Test the installed definition, then use `board_addItem` with kind `customApi` and the returned definition ID. + +Homarr encrypts the plaintext immediately. Homarr does not return the plaintext. + +## Evaluate the copied prompt + +Homarr maintainers can run the same self-contained prompt that the workbench copies through the live generation-quality suite: + +```sh +OPENROUTER_API_KEY=... pnpm --filter @homarr/custom-widgets test:ai +``` + +The suite uses DeepSeek V4 Pro to author five complex widgets and DeepSeek V4 Flash to judge only widgets that pass Homarr's real parser and canonical schema. It saves every response, validated `widget.json`, `widget.jsx`, and detailed category scores under `packages/custom-widgets/.ai-evaluations/`. + +The run has a hard budget of ten generation attempts across all scenarios. Override the models or budget with `OPENROUTER_GENERATOR_MODEL`, `OPENROUTER_JUDGE_MODEL`, and `CUSTOM_WIDGET_AI_MAX_LOOPS`. Generated artifacts are local and ignored by Git; promote a reviewed, validated result into the bundled-widget source deliberately. + +The reference API check uses a real PokeAPI list/detail request and a read-only Portainer container query when `PORTAINER_BASE_URL` and `PORTAINER_API_KEY` are set. Use `pnpm --filter @homarr/custom-widgets test:reference-apis -- --pokeapi-only` for the public PokeAPI check alone. To exercise start, restart, and stop against a disposable container, also set `PORTAINER_TEST_CONTAINER_ID` and the explicit safeguard `PORTAINER_ALLOW_MUTATIONS=1`; the script restores the container's original running state. diff --git a/apps/docs/docs/management/custom-widgets/architecture.mdx b/apps/docs/docs/management/custom-widgets/architecture.mdx deleted file mode 100644 index 508eef439..000000000 --- a/apps/docs/docs/management/custom-widgets/architecture.mdx +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_label: Maintainer architecture ---- - -# Maintainer architecture - -Reusable Custom Widget behavior belongs to `@homarr/custom-widgets`: - -- `core` owns schemas, descriptors, migrations, import/export, examples, diagnostics metadata, and prompt generation. -- `jsx` owns AST parsing, shared policy, interpreter, bindings, registry, wrappers, and analysis. -- `runtime` owns renderers and named-request controls through injected ports. -- `server` owns manifests, network execution, caching, limits, preview sessions, and typed domain errors. -- `workbench` owns form contracts, editor analysis, preview UI, response tree, and import review through injected ports. - -The API package retains persistence and board authorization adapters. Widgets retain board registration and runtime transport wiring. Next.js routes retain navigation and shells. The domain package must never import API, widgets, or route modules. - -## Add a display type - -Extend the typed descriptor and discriminated schema, defaults/hydration/serialization, renderer, workbench section, preview, import round-trip fixtures, docs, and translations. Create, edit, import, export, MCP, and preview must all use the same transform. - -## Add a JSX component - -Classify the upstream export, document safety mode and supported props, add a wrapper if behavior needs constraining, and update registry tests. CI fails when a Mantine upgrade introduces an unclassified export. - -## Change networking - -Implement policy below the framework-neutral server boundary and expose infrastructure through a typed port. Add tests for permissions, typed substitution, DNS classes, redirects, headers, timeouts, limits, redaction, cache behavior, and action non-retry semantics before wiring the tRPC adapter. - -Production files target 300 lines. Algorithmic AST/network modules may use a documented 400-line ceiling. Dependency-boundary, cycle, file-size, translation, generated-artifact, component-classification, focused unit, integration, E2E, accessibility, and docs-build gates protect the architecture. After a Next.js production build, `pnpm check:custom-widget-bundle` also enforces a 768 KiB gzip ceiling across the client chunks referenced by Custom JSX. diff --git a/apps/docs/docs/management/custom-widgets/authoring.mdx b/apps/docs/docs/management/custom-widgets/authoring.mdx index ebe31288c..2fc8d2c1f 100644 --- a/apps/docs/docs/management/custom-widgets/authoring.mdx +++ b/apps/docs/docs/management/custom-widgets/authoring.mdx @@ -1,36 +1,37 @@ ---- -sidebar_label: Authoring workbench ---- +# Create a Custom Widget -# Authoring workbench +import { CanonicalCustomWidgetExample } from "@site/src/components/custom-widget-code"; -The Custom Widget form is a continuous workflow: choose a display, configure the HTTP connection, configure the display, then test it in the adjacent preview. Each section stays visible so you can revisit earlier choices without losing context. +The workbench is visual-first: configure the default API connection, add request cards, add option rows, then write JSX. Additional sources and raw manifest JSON remain under Advanced. Code and preview sit side by side on desktop and use tabs on mobile. -## Choose a display +## Manual workflow -The display grid is the first product decision. Built-in displays are best for common metrics, tables, statuses, and actions. Choose Custom JSX when the layout needs multiple Mantine components, conditional presentation, charts, dates, or named requests. +1. Configure the default API source, network scope, authentication, and credential. +2. Add query/action cards. Values can be literals, widget options, or invocation parameters. +3. Add widget options with their control and default value. +4. Write responsive JSX using `data`, `status`, `options`, and temporary `inputs`. +5. Test and preview, inspect Data and the redacted request journal, then save. -Changing display type preserves shared connection fields and initializes safe display defaults. A Custom JSX template is never blank; new and migrated forms receive the tested starter fixture. + -## Test and preview + -The preview has four tabs: +Every option has a default. Supported controls include text, textarea, number, switch, select, multi-select, slider, date, time, color, icon, URL, duration, time zone, and JSON. Dynamic choices use `choicesFrom` with a query ID and value/label paths. -- **Widget** renders at compact, standard, or wide board-like sizes. -- **Response** uses a tree to inspect data, copy paths, and insert paths into JSX. The external-response action opens a temporary local blob and never publishes the response. -- **Request** shows the redacted base request, named capabilities, status, duration, and preview journal. -- **Diagnostics** shows template size, named requests, network scope, and blocking or advisory issues. +## ChatGPT or Claude -Only GET base requests run automatically. Preview actions are simulated until an administrator explicitly enables live actions for the five-minute preview session. DELETE still requires confirmation. +Enter the desired widget and optional API documentation URL, then select **Copy AI prompt**. The single self-contained prompt is below 12,000 characters, starts with your request, includes the lean contract and two polished examples, and never claims that an offline chat has MCP tools. -## Keyboard and clipboard +The model must return exactly: -The JSX and JSON editors support native Ctrl/Cmd+Z and redo, plus visible toolbar controls. Cursor position, character count, and the 50,000-character limit remain visible. +1. One fenced `json` block with `template: "__HOMARR_TEMPLATE__"`. +2. One fenced `jsx` block with the readable template. -On the list page, paste a complete v3 export with Ctrl+V or Command+V to import it as new. On an edit page, pasting opens a replacement review. Nothing is applied before the origin, methods, credential inheritance, and permissions are shown. +Select **Paste AI response**. Homarr fills the visual builders and shows all actionable schema or JSX errors inline. Enter credentials separately. The prompt deliberately recommends a focused Mantine component set, visual hierarchy, responsive layout, theme compatibility, and loading, empty, failure, and success states. -For AI output, prefer the authoring bundle format: a JSON block containing `"template": "__HOMARR_TEMPLATE__"`, followed by a JSX block. This keeps multiline JSX readable and avoids JSON escape errors. - -## Save behavior - -Errors block save; warnings do not. Server validation runs again on every create or update. Leaving with dirty changes triggers protection. Secrets omitted during edit remain unchanged, and secrets are never exported. +Connected agents should use the skills.sh skill and retrieve the live schema and individual component metadata only as needed. diff --git a/apps/docs/docs/management/custom-widgets/custom-jsx.mdx b/apps/docs/docs/management/custom-widgets/custom-jsx.mdx index d00334b92..bb59f114d 100644 --- a/apps/docs/docs/management/custom-widgets/custom-jsx.mdx +++ b/apps/docs/docs/management/custom-widgets/custom-jsx.mdx @@ -1,49 +1,44 @@ ---- -sidebar_label: Custom JSX language ---- +# Use the safe JSX runtime -# Custom JSX language +Templates are JSX expressions interpreted inside a widget-local safety and render budget. They can read: -Custom JSX is a declarative expression language, not browser JavaScript. Homarr parses an explicit AST subset and emits React elements from a classified component registry. Templates cannot access browser globals, native prototypes, constructors, refs, portals, raw event handlers, or direct `fetch`. +- `data.requestId` — the latest response +- `status.requestId` — `{ loading, ok, status, statusText, error }` +- `options.name` — saved widget configuration +- `inputs.name` — temporary values from declarative `bind` -## Data and rendering +Use normal Mantine layouts, typography, feedback, dates, and charts. Official compound names such as `Card.Section`, `Tabs.List`, and `Radio.Group` are supported. Ordinary safe props pass through; a dangerous capability produces an explicit error. -The base GET response is available as `data`. Safe member access, conditionals, arrays, object literals, and interpreter-created collection callbacks can compose displays: +## Temporary inputs ```jsx - - {data.services - .filter((service) => service.visible) - .map((service) => ( - - {service.name} - {service.status} - - ))} + + + + {(results) => ( + + {(results ?? []).map((item) => ( + {item.name} + ))} + + )} + ``` -Properties are resolved own-only. Reflective names such as `constructor`, `prototype`, `__proto__`, `caller`, `callee`, `arguments`, `bind`, `call`, and `apply` are rejected even when computed or Unicode escaped. +Bound values live only in React memory while the widget is mounted. They are not saved to the database, board options, exports, browser storage, or `localStorage`. Remounting resets them. Components can share a binding when their adapter types agree. -## Components and props +## Expression language -Every Mantine export is classified as allowed, wrapped, or denied. The [generated component reference](./#component-reference) is authoritative. Props are allowlisted per component; unsupported props produce warnings and are ignored. Polymorphic roots, unsafe URLs, portals, positioning escapes, refs, and function props are stripped. +Use expressions, conditionals, optional chaining, arrays, objects, template strings, safe standard helpers, and expression callbacks for `map`, `filter`, `sort`, and trusted runtime slots. Callback blocks, authored `const`, IIFEs, authored recursion, arbitrary functions, imports, hooks, refs, raw events, browser requests, `eval`, and bigint are blocked. -`SubData` is a convenience for simple response paths. Prefer the render-child pattern for rich nested results: +Bounded regex literals are supported for string matching, splitting, search, and replacement. Patterns with lookbehind, backreferences, nested quantifiers, excessive length, or unsupported flags are rejected. -```jsx - - {(detail, meta) => ( - - {detail.name} - HTTP {meta.status} - - )} - -``` +## Runtime components -## Safe helpers and budgets +- `SubFetch` runs a manual query with its `params`. Set `triggerContent` to a card or image to make that content the accessible click and keyboard trigger instead of showing the default load button. +- `ActionButton` and `ToggleSwitch` run actions. +- `RefreshButton` renders a compact, accessible icon control that refreshes load queries. +- `Icon`/`TablerIcon` resolves installed safe icons. -Bindings include restricted conversion, string, array, object, JSON, math, URI, and pure date helpers. Native `Date` objects and native prototypes are not exposed. - -Templates are limited to 50,000 characters, 10,000 rendered nodes, and explicit AST-depth, operation, collection, and string budgets. Budget errors stop only the Custom JSX renderer and are contained by its error boundary. +Always include responsive loading, empty, error, and success states. Runtime failures remain inside the widget tile. diff --git a/apps/docs/docs/management/custom-widgets/extension-recipes.mdx b/apps/docs/docs/management/custom-widgets/extension-recipes.mdx deleted file mode 100644 index 650963432..000000000 --- a/apps/docs/docs/management/custom-widgets/extension-recipes.mdx +++ /dev/null @@ -1,66 +0,0 @@ ---- -sidebar_label: Extension recipes ---- - -# Custom Widget extension recipes - -These recipes keep every authoring and runtime path on the same typed source of truth. Run `pnpm check:custom-widgets` after each structural change and add focused package tests before changing an adapter. - -## Add a built-in display type - -1. Add the discriminated configuration schema in `@homarr/custom-widgets/core`. -2. Add one descriptor with its icon, category, localized metadata keys, defaults, hydration, serialization, and validation. -3. Add the renderer to the runtime display map. It must consume normalized display data and injected actions only. -4. Add a bounded workbench section that edits the descriptor-owned form fields. -5. Add one fixture and assert create, edit, v2/v3 import, export, MCP, and preview round trips against it. -6. Add translation keys and update the display table in the user guide. - -Do not add route-specific conversion code. `buildDisplayFormValues` and `buildDisplayConfigFromFormValues` are the only form conversion boundary. - -## Add or update a JSX component - -1. Classify the Mantine export as `allowed`, `wrapped`, or `denied` in the component registry. Denied entries require a reason. -2. Declare supported props and subcomponents. Function props, refs, portals, polymorphic roots, and unsafe positioning stay denied unless a wrapper removes the unsafe behavior. -3. Implement wrappers in the JSX package and register them through the package runtime-component factory. -4. Add analyzer and renderer tests for accepted props, stripped props, reflective-property attacks, and the rendered-node budget. -5. Regenerate the docs reference and verify the editor completion and AI prompt include the same entry. - -The component-classification test must pass against the locked Mantine version. Never expose an upstream namespace or native prototype as a shortcut. - -## Add a named-request capability - -1. Extend the request schema and manifest renderer in `core` and `server` without accepting a raw runtime URL, method, header, or body. -2. Enforce permission, network scope, redirect, DNS, header, body, response, concurrency, and rate policies in the framework-neutral server service. -3. Expose infrastructure through a typed server port. Translate domain errors only in the API adapter. -4. Add the control to runtime through the injected request port. Queries use query semantics; actions require a gesture and use mutation semantics. -5. Add preview simulation and redacted-journal coverage. Live actions remain an explicit administrator-only browser choice. -6. Update MCP validation and simulation tools without exposing stored secrets or unrestricted action execution. - -Tests must prove actions are never mounted automatically, polled, retried, cached, or redirected. DELETE must retain full permission and confirmation. - -## Add a workbench feature - -1. Put reusable state, analysis, or presentation in `@homarr/custom-widgets/workbench`. -2. Receive localized messages and typed callbacks as props. The package cannot import the tRPC client, Next.js navigation, notifications, or Homarr widget adapters. -3. Keep the Next.js component as a transport and page-shell adapter. -4. Cover keyboard operation, focus order, reduced motion, 320/768/desktop layouts, dirty-state behavior, and error-boundary recovery. -5. Keep each production module below 300 lines and preserve the continuous two-pane form behavior. - -## Change examples or AI authoring - -Examples live as typed shared fixtures. Tests, snippets, documentation data, and the AI prompt consume those fixtures. AI output uses an authoring bundle: a JSON block with `__HOMARR_TEMPLATE__`, followed by a readable multiline JSX block. Do not require agents to escape an entire template into one JSON string. - -After changing a fixture, validate every example, render it, regenerate the component reference, and run the prompt snapshot tests. MCP agents must be able to read a widget, patch template lines with a revision, validate, preview named queries, simulate actions, inspect the journal, and update the definition without receiving secret values. - -## Required checks - -```bash -pnpm check:custom-widgets -pnpm test -pnpm test:e2e -pnpm turbo typecheck --affected -pnpm turbo lint --affected -pnpm turbo build --filter=@homarr/docs -``` - -Also run the component-classification, generated-reference drift, bundle-budget, accessibility, and focused package/API suites configured by the repository. A change is incomplete if any create, edit, import, export, MCP, preview, or board-runtime path uses a separate transform. diff --git a/apps/docs/docs/management/custom-widgets/index.mdx b/apps/docs/docs/management/custom-widgets/index.mdx index decb337aa..31b4fe9a1 100644 --- a/apps/docs/docs/management/custom-widgets/index.mdx +++ b/apps/docs/docs/management/custom-widgets/index.mdx @@ -1,204 +1,80 @@ --- -tags: - - Custom Widgets - - API - - Widgets - - JSX +title: Custom Widgets +sidebar_label: Overview +tags: [Custom Widgets, API, JSX, MCP] --- -import { CustomJsxComponentReference } from "@site/src/components/custom-jsx-component-reference"; +import { BundledCustomWidgetGallery, CustomWidgetCodeExample } from "@site/src/components/custom-widget-code"; + +export const completeManifest = `{ + "$schema": "homarr-custom-widget-v2", + "name": "Service status", + "sources": { + "default": { "name": "Service API", "baseUrl": "https://status.example.com", "networkScope": "public", "auth": "none" } + }, + "requests": { "status": { "path": "/api/status" } }, + "options": {}, + "template": "{data.status?.label ?? 'Unknown'}" +}`; # Custom Widgets -Custom widgets connect a dashboard item to an HTTP API without compiling a new Homarr widget. Administrators choose the endpoint and authentication, then use a built-in display type or a Custom JSX template to render the response. +:::warning Experimental feature -## Guides - -- [Authoring workbench](./authoring): create, edit, preview, paste, undo, import, and export. -- [Custom JSX language](./custom-jsx): supported syntax, components, bindings, diagnostics, and limits. -- [Named requests and security](./requests-and-security): permissions, network scopes, request manifests, and server protections. -- [AI and MCP authoring](./agent-authoring): an iterative agent workflow that validates and previews before saving. -- [Compatibility and migration](./migration): v1/v2 JSX and v2/v3 import behavior. -- [Troubleshooting](./troubleshooting): common editor, preview, permission, and networking failures. -- [Maintainer architecture](./architecture): package boundaries, extension points, and required tests. -- [Extension recipes](./extension-recipes): step-by-step changes for displays, JSX components, requests, and workbench features. - -:::caution - -A custom widget can expose data or perform actions with the credentials configured for it. Import definitions only from sources you trust and review every network capability before using the widget on a shared board. +This feature is experimental and will probably change. If you encounter bugs, need more capabilities, or find something confusing, tell us in the [official discussion thread](https://github.com/homarr-labs/homarr/discussions/categories/custom-widgets). Your feedback directly shapes what comes next. Happy hacking! ::: -## Create a widget +Custom JSX v2 is Homarr's only Custom Widget format. A definition contains keyed API sources, keyed requests, optional widget options, and one safe JSX template. Credentials are encrypted separately and never exported. -Open **Management → Custom Widgets**, select **Add**, and configure: - -- **Name, description, and icon**: identify the widget in management and the widget picker. -- **URL**: the full HTTP or HTTPS base endpoint. -- **Authentication**: none, bearer token, basic authentication, API-key header, or API-key query parameter. -- **Display type**: a built-in renderer or Custom JSX. - -Use **Test** to run the current GET request. The preview workbench separates the rendered widget, sanitized response tree, redacted request journal, and diagnostics. It marks sample data as stale whenever the connection or display configuration changes after a test. - -Testing creates a five-minute, administrator-bound preview session for unsaved named queries. Action controls are simulated by default. An administrator can explicitly enable live actions for that session; DELETE still requires confirmation. - -## Display types - -| Display type | Use it for | -| ---------------- | --------------------------------------------------------- | -| Single Value | One metric with a label and unit | -| Key Value | Several labeled values | -| Table | Arrays of records | -| Stat Grid | Compact colored metrics | -| Progress Bars | Capacity, quota, and completion | -| Status Indicator | Health and availability | -| Count Grid | Compact counters | -| Raw | Sanitized JSON inspection | -| Action Button | One explicit API action | -| Custom JSX | A declarative Mantine layout with optional named requests | - -## Custom JSX workbench - -The JSX editor provides syntax highlighting, formatting, undo/redo buttons and Ctrl/Cmd+Z shortcuts, a searchable component reference, character and cursor status, and diagnostics. Errors block saving; warnings identify behavior that still receives server-side validation. Templates can contain up to 50,000 characters and render up to 10,000 nodes. - -The template reads the base GET response from `data`: - -```jsx - - {data.name} - {data.status} - -``` - -The **Copy AI prompt** action is available on desktop and mobile. Its prompt, component list, and examples are generated from the same metadata used by the renderer, so the reference stays aligned with the installed Homarr version. - -### JSX API versions - -- **Version 2** is the default. Network access is declared in a named-request manifest and enforced by the server. -- **Version 1** remains available for display-only templates. Inline network components are disabled until the definition is reviewed and migrated. - -Definitions without `jsxApiVersion` are treated as version 1. Display-only templates can be migrated by selecting version 2 and saving an empty request list. - -## Named requests - -Version 2 templates never choose an arbitrary URL, method, header, or body at runtime. An administrator declares each allowed operation once, and the template references its `requestId` with typed parameters. - -```json -{ - "type": "customJsx", - "jsxApiVersion": 2, - "networkScope": "public", - "template": "", - "requests": [ - { - "id": "service-detail", - "kind": "query", - "method": "GET", - "pathTemplate": "/api/services/{id}", - "parameters": { "id": "string" }, - "auth": "inherit", - "minimumBoardPermission": "view", - "cacheTtlSeconds": 30 - } - ] +```ts +interface HomarrCustomWidgetV2 { + $schema: "homarr-custom-widget-v2"; + name: string; + description?: string; + iconUrl?: string; + sources: Record; + requests: Record; + options?: Record; + template: string; } ``` -Path placeholders use `{parameter}` and are URL-encoded by the server. JSON body placeholders use `{ "$param": "parameter" }` and preserve the declared string, number, or boolean type. + -`SubData` remains available for simple paths. For richer nested output, pass an interpreter-created render child; it receives the response data and safe status metadata: +The browser renders JSX. Homarr's server executes named requests, applies board permissions and network protections, and injects credentials. The browser never receives source credentials. -```jsx - - {(detail, meta) => ( - - {detail.status} - HTTP {meta.status} - - )} - -``` +## Authoring paths -| Component | Request kind | Behavior | -| --------------- | ------------ | ------------------------------------------------------------- | -| `SubFetch` | `query` | Loads a named GET request automatically or manually | -| `ActionButton` | `action` | Runs a named POST, PUT, PATCH, or DELETE after a user gesture | -| `ToggleSwitch` | `action` | Passes declared on/off parameters and rolls back on failure | -| `RefreshButton` | None | Refreshes the parent GET response | +- [Create a Custom Widget](./authoring) visually or with one copied AI prompt. +- [Use the JSX runtime](./custom-jsx) for data, Mantine components, temporary inputs, and diagnostics. +- [Configure requests and security](./requests-and-security). +- [Use MCP and the skills.sh skill](./agent-authoring). +- [Correct problems](./troubleshooting). -Queries require board **view** permission. POST, PUT, and PATCH actions require **modify** by default. DELETE requires **full** permission and confirmation. Allowing viewers to execute a non-DELETE action requires explicit administrator approval. Anonymous viewers cannot execute actions. +The workbench keeps one continuous layout with visual source, request, and option editors. Advanced raw JSON remains available for experts and AI paste. Invalid values stay inline and only disable the widget preview. -### Network scopes +Exports, imports, Workshop, MCP, and storage all validate the same schema. Old formats are rejected. A missing definition only renders **Custom widget unavailable** inside its tile. -| Scope | Allowed destinations | -| ---------- | ------------------------------------------------------------ | -| `public` | Public IP addresses only | -| `private` | Public addresses plus RFC1918 and IPv6 ULA private addresses | -| `loopback` | Public, private, and loopback addresses | +When adding widgets while editing a board, the Custom Widgets section always includes **Install from Workshop**. The Workshop and API source review open above the widget picker without closing it. After import, the new definition appears in the picker. Its tile waits for the board to be saved before server requests run and loads automatically after a successful save; no page reload is required. -Link-local, cloud-metadata, unspecified, multicast, documentation, carrier-grade NAT, and IPv4-mapped bypass addresses remain blocked in every scope. +## Import and Workshop -### Example with a named query +Import review shows origins, authentication modes, network scopes, methods, actions, and permissions. Every source has a suggested URL, but private and loopback sources must be confirmed or replaced for the current Homarr installation. The same screen accepts API keys, tokens, usernames, and passwords; credentials remain optional at install time and missing values stay visible on the Custom Widgets page. -The editor and AI prompt include a shared Pokédex fixture that loads details only for the visible page. Its named request is equivalent to: +For example, installing **Tautulli Activity** asks for both the user's Tautulli URL and API key. A stable public source such as PokéAPI keeps its published URL without creating unnecessary setup work. -```json -{ - "id": "pokemon-detail", - "kind": "query", - "method": "GET", - "pathTemplate": "/api/v2/pokemon/{name}", - "parameters": { "name": "string" }, - "auth": "none", - "minimumBoardPermission": "view", - "cacheTtlSeconds": 300 -} -``` +Workshop publishes technically valid widgets immediately; users can vote or report them, and administrators can delete submissions. Publishers should replace personal private-network hosts with a clear service placeholder before publishing. -## Agent authoring through MCP +Connected agents can search, inspect, and install Workshop widgets with `customWidget_workshopSearch`, `customWidget_workshopGet`, and `customWidget_workshopInstall`. After installation they can set a source URL and credentials with `customWidget_sourceConfigure`, or create a secure user-facing setup URL with `customWidget_configurationRequestUser`. Secret values are never returned through MCP. -Administrators can use Homarr's MCP server to iterate on custom widgets without bypassing validation or network controls. A typical agent workflow is: +## Bundled examples -1. Call `customWidget_schema` to inspect the current import format. -2. Generate a complete `homarr-custom-widget-v3` draft. -3. Call `customWidget_validate` and correct every returned issue. -4. Call `customWidget_preview` to test the base GET request through Homarr's hardened executor. -5. Use `customWidget_previewQuery` for named queries and `customWidget_simulatePreviewAction` to verify action parameters without sending mutations. -6. Inspect `customWidget_previewJournal`, then validate again. -7. Call `customWidget_import`, or read an existing widget with `customWidget_byId` and apply a focused `customWidget_update`. +Homarr seeds five disabled examples without credentials and never overwrites an edited seed. They use the same public contract. The Tautulli example is the highest-scoring widget preserved from Homarr's AI authoring evaluation: -MCP preview actions are simulation-only. Enabling live preview actions remains an explicit administrator choice in the browser workbench. Stored secret values are never returned by MCP; omit `secrets` when updating an existing widget to preserve them. - -## Component reference - -Custom JSX exposes a classified subset of Mantine Core, Charts, Dates, and Homarr components. Allowed components render directly. Wrapped components receive safe props or read-only behavior. Denied components remain in the registry so dependency upgrades cannot silently expand the template surface. - - - -This table and the searchable component list in the editor are generated from Homarr's runtime registry. - -Component props are filtered. Polymorphic roots, portals, refs, unsafe positioning, raw event handlers, and `dangerouslySetInnerHTML` are not exposed. Direct browser globals and direct `fetch` calls are unavailable, while ordinary text containing the word “fetch” is valid. - -Safe bindings include conversion helpers, a restricted `Math` and `JSON` surface, object and array helpers, URI encoding helpers, and pure date formatting helpers. Collection callbacks and rendered output are subject to interpreter budgets. - -## HTTP protections and limits - -All base, preview, query, and action requests use the same server executor: - -- Only HTTP and HTTPS are accepted. URL credentials and fragments are rejected. -- Named paths must stay on the base endpoint origin. -- DNS results are validated against the selected network scope and pinned for the request. -- Queries can follow up to three revalidated same-origin redirects. Actions do not follow redirects. -- Authorization, cookie, host, forwarding, proxy, content-length, and hop-by-hop headers cannot be supplied by a template. -- Request bodies are limited to 10 KiB. Decompressed responses are limited to 1 MiB, 32 JSON levels, and 50,000 JSON nodes. -- GET requests can be cached and deduplicated. Actions are never cached, polled, or retried automatically. - -## Import and export - -New exports use `"$schema": "homarr-custom-widget-v3"`. Version 2 imports remain accepted. Secrets are never exported and must be entered again after import. - -Review the base origin, network scope, named request methods, inherited authentication, and required permissions before saving an imported widget. A version 1 template that contains inline network components stays disabled until it is converted to named requests. - -AI-generated Custom JSX can also be pasted as a Homarr authoring bundle: one fenced JSON block with `"template": "__HOMARR_TEMPLATE__"`, followed by one fenced JSX block containing the readable multiline template. Homarr combines the blocks before validation, avoiding JSON newline and quote escaping. Raw JSON imports remain supported. - -On the custom-widget list, paste a complete export with Ctrl+V or Command+V to open the import review and create it as a new definition. On an edit page, the same shortcut opens a replacement review and fills the existing form after confirmation. Pasted definitions never include secrets. + diff --git a/apps/docs/docs/management/custom-widgets/migration.mdx b/apps/docs/docs/management/custom-widgets/migration.mdx deleted file mode 100644 index 828845454..000000000 --- a/apps/docs/docs/management/custom-widgets/migration.mdx +++ /dev/null @@ -1,19 +0,0 @@ ---- -sidebar_label: Compatibility and migration ---- - -# Compatibility and migration - -Homarr preserves existing display definitions while moving network-enabled Custom JSX to the named-request model. - -## JSX API versions - -Missing `jsxApiVersion` means v1. Display-only v1 templates can be opened and saved as v2 with an empty request manifest. Inline `url`, `method`, `headers`, and body props are inert in v2. - -Static v1 network components can be converted by creating a named request and replacing inline capability props with `requestId` and typed `params`. Dynamic target construction requires an administrator to design an explicit path template and parameter list. Existing non-GET base definitions stop polling and show a network-review state. - -## Import versions - -Exports use `homarr-custom-widget-v3`; v2 imports remain accepted. Import migration normalizes display configuration, preserves v1 semantics, and never imports secret values. The review screen must be accepted before persistence. - -Test migration with the same base response and compare rendered output, query results, action simulation, permissions, and journal entries before enabling the migrated definition on shared boards. diff --git a/apps/docs/docs/management/custom-widgets/requests-and-security.mdx b/apps/docs/docs/management/custom-widgets/requests-and-security.mdx index 6afc34745..cc784cbe9 100644 --- a/apps/docs/docs/management/custom-widgets/requests-and-security.mdx +++ b/apps/docs/docs/management/custom-widgets/requests-and-security.mdx @@ -1,32 +1,42 @@ ---- -sidebar_label: Requests and security ---- +# Configure requests and security -# Named requests and security +Most widgets use a single source named `default`. Extra keyed sources are available under Advanced for widgets that combine APIs. Authentication is `none`, `bearer`, `basic`, an API-key header, or an API-key query parameter. Credentials belong to the widget but remain outside its manifest. -Custom JSX v2 uses a saved request manifest. Runtime components pass only a `requestId` and declared primitive parameters; they cannot change the URL, method, headers, authentication, or body shape. +## Named requests -## Capability kinds +Requests are keyed by ID. `source`, `kind`, `method`, `trigger`, `auth`, and `permission` have sensible defaults, so a load query can be as small as: -`SubFetch` references a GET `query`. `ActionButton` and `ToggleSwitch` reference a POST, PUT, PATCH, or DELETE `action`. Base data is GET-only. Actions require an explicit gesture and are never polled, cached, retried automatically, or run on mount. +```json +{ "status": { "path": "/api/status" } } +``` -Default board permissions are view for queries, modify for POST/PUT/PATCH, and full for DELETE. Viewer actions require explicit high-risk approval; anonymous users cannot execute actions. DELETE always requires confirmation. +The request `path` is appended to the source `baseUrl`, including a base path such as `/api/v2`. -## Parameter substitution +GET, POST, PUT, PATCH, and DELETE work for queries and actions. Kind—not method—controls behavior. Load queries run automatically, manual queries run through `SubFetch`, and actions run only from `ActionButton` or `ToggleSwitch`. -Path placeholders use `{name}` and are URL-encoded by the server. Runtime parameters must exactly match all declared names and types. JSON bodies substitute `{ "$param": "name" }` recursively and preserve string, number, or boolean types. +Bind values directly where they are used: -## Network boundary +```json +{ + "containers": { + "path": "/api/endpoints/{option:endpointId}/docker/containers/json", + "query": { "all": { "$option": "showAll" } } + }, + "restart": { + "kind": "action", + "method": "POST", + "path": "/api/endpoints/{option:endpointId}/docker/containers/{param:id}/restart", + "invalidates": ["containers"] + } +} +``` -Named paths stay on the base URL origin. HTTP and HTTPS are accepted; URL credentials and fragments are rejected. DNS answers are classified and pinned. Public, private, and loopback scopes progressively allow destinations, but link-local, metadata, unspecified, multicast, documentation, carrier-grade NAT, and IPv4-mapped addresses are always blocked. +`{option:name}` and `$option` read saved widget options. `{param:name}` and `$param` read invocation-time `params`. Load queries cannot use invocation parameters. Homarr infers the exact parameter names and primitive values from these references, rejecting missing or extra invocation params at the request boundary. -Queries may follow three revalidated same-origin redirects. Actions do not follow redirects. Credentials never cross origins. Reserved authentication, cookie, host, forwarding, proxy, content-length, security, and hop-by-hop headers cannot be declared. +Paths and query-string values must resolve to text, numbers, or booleans. JSON bodies can also use structured `json` and `multiSelect` option values, for example `{ "entity_ids": { "$option": "entities" } }`. -## Limits +## Protection -- Request body: 10 KiB UTF-8. -- Decompressed response: 1 MiB, 32 JSON levels, 50,000 JSON nodes. -- Per user/item: 60 queries, 10 actions, and 3 deletes per minute. -- Concurrency: 4 per user/item and 8 per definition. +Every request uses Homarr's existing server executor: same-origin source enforcement, network scope, DNS and redirect validation, SSRF protection, board permissions, rate and request limits, body and response limits, timeouts, and encrypted credential injection. Static headers cannot override credentials, cookies, routing, proxy, forwarding, or hop-by-hop headers. -Successful GETs can use manifest cache TTLs and single-flight deduplication. Logs contain redacted origin/method/error metadata, never secrets, request bodies, or query values. +Queries default to view permission and actions to modify. DELETE always requires full permission and confirmation. Actions are never cached, retried, or run on load. diff --git a/apps/docs/docs/management/custom-widgets/troubleshooting.mdx b/apps/docs/docs/management/custom-widgets/troubleshooting.mdx index 0fd46a3d4..20b216afe 100644 --- a/apps/docs/docs/management/custom-widgets/troubleshooting.mdx +++ b/apps/docs/docs/management/custom-widgets/troubleshooting.mdx @@ -1,33 +1,59 @@ ---- -sidebar_label: Troubleshooting ---- +# Correct Custom Widget problems -# Troubleshooting +## Correct an unavailable widget -## The preview says the template is required +The definition does not exist. Remove the unavailable tile from the board. -New Custom JSX forms always include the starter fixture. If an imported definition has an empty template, reopen its import review; malformed imports must be corrected rather than previewed as JSX. +Then, install or create a Custom JSX v2 definition. Homarr does not provide recovery or migration for old formats. -## A prop is ignored +## Correct an invalid saved definition -The diagnostics name the component and prop. Check the generated component reference. Unsupported props are intentionally removed; use a supported layout primitive or wrapper prop instead of polymorphic, portal, ref, positioning, or raw handler props. +The Custom Widgets page isolates a definition that does not conform to the current schema. The other definitions remain available. -## A request does not run +An invalid definition shows its validation errors. You can delete it. -Confirm that the component kind matches the manifest: `SubFetch` needs a query; action controls need an action. Parameter names and primitive types must match exactly. Base requests and queries require GET. Actions only run from a gesture, and edit mode disables controls. +You cannot edit, enable, export, duplicate, publish, or select an invalid definition. Recreate the definition or import a valid definition. -## Network scope errors +Homarr does not migrate old Custom JSX formats. -Resolve the hostname from the Homarr server environment. Select private or loopback scope only when required and understood. Link-local and metadata destinations cannot be enabled by any scope. Redirects must remain on the base origin. +## Correct validation errors -## Permission errors +Read the first schema or JSX diagnostic. Use its path to find the invalid value. -The placed board item is the authorization anchor. A definition ID alone cannot authorize credential use. Verify board view/modify/full access, explicit viewer-action approval, and that the caller is not anonymous. +Make sure keyed API source and request names are valid and unique. -## Stale or failed preview data +Make sure that each named request references an API source. Use explicit `$option` and `$param` references. -Connection, authentication, body, method, secret, or manifest changes mark samples stale. Run the GET test again. Background query failures keep prior content visible and offer retry; actions roll toggles back and show error feedback. +Make sure every option default matches its control. Use the correct request kind for each runtime component. -## Import paste is ignored +An incomplete API source URL or icon URL causes a form validation error. The workbench keeps the draft open. -Paste a complete v2/v3 JSON export or authoring bundle while the list or edit page is focused. Ordinary text and partial JSON are ignored so normal typing is not intercepted. +The workbench marks the invalid field while you type. An invalid URL does not replace the form with the error boundary. + +An invalid definition disables only the widget preview. The Data, Options, Actions, and Diagnostics tabs remain available. + +The Diagnostics tab shows the current schema errors. + +## Correct request errors + +Check the API source network scope. Check the base URL and credentials. + +Check the request method, path, body, direct value bindings, and board permission. + +For “invalid placeholder,” use `{option:name}` or `{param:name}`. Load queries can only reference options. The preview journal does not show credentials. + +The journal shows the method, request ID, path template, status, and duration. + +## Correct a Mantine prop warning + +`UNKNOWN_MANTINE_PROP` is a warning. Homarr passes the prop to Mantine. + +Check the prop in the documentation for the installed Mantine version. `BLOCKED_CAPABILITY` identifies an unsafe capability. + +Use safe widget options, temporary inputs, or named requests instead. + +## Repair an existing item + +The widget option definitions changed and the saved values are invalid. Open the item settings. + +Correct the marked configuration values. Homarr does not infer widget option migrations. diff --git a/apps/docs/docs/management/mcp.mdx b/apps/docs/docs/management/mcp.mdx index aa1b5972c..35a17b52b 100644 --- a/apps/docs/docs/management/mcp.mdx +++ b/apps/docs/docs/management/mcp.mdx @@ -162,58 +162,65 @@ The tools table on the MCP tab is dynamically generated - it always reflects the - **"How many users are on my Homarr instance?"** - AI lists all users (admin only) - **"Toggle Pi-hole blocking for 5 minutes"** - AI interacts with DNS controls - **"How are my servers doing?"** - AI fetches Beszel system stats including CPU, memory, disk, and alerts -- **"Build and refine a custom widget for this API"** - AI validates the draft, tests GET data and named queries, simulates actions, and creates or updates the widget +- **"Build a Custom Widget for this API"** - AI validates and previews one definition before it saves the definition -## Custom Widget Workflow for AI Agents +## Create a Custom Widget with an AI agent -AI agents can create and iterate on custom widgets using these tools in sequence. +An agent creates one `homarr-custom-widget-v2` definition at a time. Start with the native prompt `homarr-custom-widget-author`. -:::tip Editing an existing widget? -Skip to step 5. Use `customWidget_byId` to fetch it and `customWidget_readTemplate` / `customWidget_writeTemplate` to edit its template directly. -::: +Then, read the live schema and component resources. These resources describe the installed Mantine components. -### 1. Get the schema +1. Call `customWidget_getAuthoringPrompt` and `customWidget_schema`. +2. Build one Custom Widget definition. +3. Call `customWidget_validate` without saving the definition. +4. Call `customWidget_previewCreate`. +5. Test named requests with `customWidget_previewQuery` and `customWidget_previewAction`. +6. Open the returned preview URL. +7. Examine `customWidget_previewJournal`. +8. Revise the local candidate and create another preview session until it is ready. +9. Call `customWidget_create`, supplying any credentials and deployment-specific source URLs the user already provided. +10. If the user must enter the source URL or credentials, call `customWidget_configurationRequestUser` with the new definition ID and wait for completion. +11. Create a final preview with that definition ID so Homarr loads its stored credentials, then test it again. +12. Use `customWidget_update` or `customWidget_templatePatch` for any final saved-definition corrections. +13. Repeat this procedure for the next Custom Widget. -Call `customWidget_schema` to receive the JSON Schema for the `homarr-custom-widget-v3` format. This tells the agent what fields are required and their types. +The agent receives the configuration-request status. The agent does not receive plaintext credentials. A preview-scoped setup URL configures only that temporary preview; use a definition-scoped URL when the values must persist. -### 2. Draft and validate +Discovery resources: -Build a widget JSON object and call `customWidget_validate` with it. The tool returns structured issues (path + message) so the agent can fix and re-validate until the draft is clean. +- `homarr://custom-widgets/schema` +- `homarr://custom-widgets/components` +- `homarr://custom-widgets/components/{name}` +- `homarr://custom-widgets/examples/{name}` +- `homarr://custom-widgets/skill` -### 3. Create the widget +An HTTP-only harness can use the matching `/api/custom-widgets/authoring-prompt`, `/schema`, `/components`, and `/skill` endpoints instead of MCP resource URIs. -Call `customWidget_import` with the validated `homarr-custom-widget-v3` draft. This returns the new widget `id`. Use `customWidget_create` only when you intentionally need its lower-level creation input, including secret fields. +The Custom Widget tools are: -### 4. Test with real data +- `customWidget_schema` +- `customWidget_validate` +- `customWidget_list` +- `customWidget_get` +- `customWidget_create` +- `customWidget_update` +- `customWidget_delete` +- `customWidget_templatePatch` +- `customWidget_previewCreate` +- `customWidget_previewQuery` +- `customWidget_previewAction` +- `customWidget_previewJournal` +- `customWidget_secretSet` +- `customWidget_sourceConfigure` +- `customWidget_configurationRequestUser` +- `customWidget_workshopSearch` +- `customWidget_workshopGet` +- `customWidget_workshopInstall` +- `customWidget_getAuthoringPrompt` +- `customWidget_getSkill` -Call `customWidget_preview` with the widget's connection info. This makes a real GET request through Homarr's hardened executor and returns the sanitized response plus a preview session ID. +The `custom-widget-manage` permission permits authoring. A direct credential write also requires the `custom-widget-secret-write` permission. -For Custom JSX v2 widgets with named requests, use `customWidget_previewQuery` to test each named GET query, and `customWidget_simulatePreviewAction` to dry-run actions without network calls. +Homarr applies its request security controls during request execution. These controls include SSRF, DNS, redirect, size, timeout, rate, and permission controls. -### 5. Iterate on the template - -Use `customWidget_readTemplate` to get the current JSX template as plain text, then `customWidget_writeTemplate` to push updates. The write tool accepts either: - -- `template` — a single string (newlines as `\n`) -- `templateLines` — an array of strings (joined with newlines server-side, avoids `\n` escaping) - -Both options validate the template AST before saving. This avoids re-sending the full widget JSON for template-only edits. - -For small changes, prefer `customWidget_patchTemplate`. Pass the `revision` returned by `customWidget_readTemplate` and one or more line edits. Homarr rejects stale revisions, applies all edits atomically, and validates the complete template against its named request manifest before saving. - -### 6. Update non-template fields - -Call `customWidget_byId` to get the full widget, modify fields, and call `customWidget_update` with only the changed fields. - -### Available components in templates - -Custom JSX templates support 100+ Mantine components plus: - -- `` — 100+ curated Tabler icons by kebab-case name (e.g. `"player-play"`, `"alert-triangle"`) -- `` / `` / `` — network-capable components for named requests -- Array methods: `map`, `filter`, `find`, `findIndex`, `some`, `every`, `reduce`, `sort`, `slice`, `flat`, `reverse`, `at`, `pop`, `join`, `includes`, `indexOf` (note: `pop` returns last element without mutating) -- String methods: `toUpperCase`, `toLowerCase`, `trim`, `trimStart`, `trimEnd`, `slice`, `substring`, `includes`, `startsWith`, `endsWith`, `split`, `replace`, `replaceAll`, `repeat`, `padStart`, `padEnd`, `charAt`, `indexOf`, `lastIndexOf` - -:::note -All `customWidget_*` tools require admin-level API key permissions. The preview executor enforces rate limits (60 queries/min, 10 actions/min). -::: +Read [Use agents and skills.sh](./custom-widgets/agent-authoring) for the complete procedure and the portable Agent Skill. diff --git a/apps/docs/docs/management/workshop/index.mdx b/apps/docs/docs/management/workshop/index.mdx index c187e2f99..37adbff22 100644 --- a/apps/docs/docs/management/workshop/index.mdx +++ b/apps/docs/docs/management/workshop/index.mdx @@ -7,6 +7,12 @@ tags: # Community Workshop +:::warning Experimental feature + +This feature is experimental and will probably change. If you encounter bugs, need more capabilities, or find something confusing, tell us in the [official discussion thread](https://github.com/homarr-labs/homarr/discussions/categories/custom-widgets). Your feedback directly shapes what comes next. Happy hacking! + +::: + The [Community Workshop](pathname:///workshop) is where Homarr users share and discover **custom CSS themes** and **custom widgets**. You can browse submissions, upvote the ones you like, report abuse, and install entries directly into your own Homarr instance. @@ -19,20 +25,31 @@ The workshop contains community-made content. Widgets may contain unwanted or ma ## Browsing and voting -- Filter by **Widgets** or **CSS**, and sort by **Top rated** or **Newest**. +- Filter by **Widgets** or **CSS**, show or hide outdated entries, and sort by popularity, creation date, recent updates, or discussion activity. - Sign in with **GitHub** to upvote/downvote, submit your own creations, or report a submission. -- Each submission shows its title, description, author, version, an optional screenshot, and the full content. +- Each submission shows its title, description, linked GitHub author, revision, optional screenshots, comments, and full content. Widget pages also summarize API sources, actions, options, network access, and required credentials before installation. +- A new submission receives one real upvote owned by its author. Votes remain unique per user and submission. +- Report details and reporter identities are visible only to Workshop administrators. Reported submissions are highlighted in the administration page, where each open report can be dismissed or the submission can be deleted. Reports do not automatically remove a submission. +- The manual **Outdated** badge warns visitors that a submission may need an update. + +## Comments + +Comments are publicly readable and appear in chronological conversation bubbles with the author's avatar and GitHub profile. Signed-in users can post; authors can edit or delete their own comments, and Workshop administrators can delete any comment. Failed posts keep the text you typed. When SMTP and `WORKSHOP_PUBLIC_ORIGIN` are configured, the submission author receives one email for a comment from another user. Self-comments, edits, and deletions do not send mail. ## Submitting 1. Sign in with GitHub. -2. Click **Submit** and choose the type: +2. Click **Share yours** and choose the type: - **Custom widget** — paste the JSON exported from **Manage → Custom Widgets → Export**. It must match the `homarr-custom-widget-v2` schema (validated before submission). - **Custom CSS** — paste your stylesheet (max 16384 characters). -3. Add a title, description, optional screenshot, and changelog, then submit. +3. Review the widget JSON or CSS in the syntax-aware editor, then add a title, description, optional screenshots, and changelog. +4. Submit the entry. Submissions are published immediately. Reported entries are reviewed and may be removed. +Authors can edit a submission later to publish a new revision. The edit form can keep or remove existing screenshots and add new PNG, JPG, or WebP images without changing the Workshop URL. + +When SMTP and `WORKSHOP_PUBLIC_ORIGIN` are configured, every current Workshop administrator receives an email when a report is submitted. If an administrator deletes the reported submission, its author receives a separate removal email. Author self-deletion does not send a moderation email. ## Submission guidelines @@ -44,16 +61,29 @@ that primarily promotes unrelated products or services. You can install workshop entries without leaving Homarr: -- **Custom widgets** — go to **Manage → Custom Widgets**, click **Install from Workshop**, pick an - entry, and it is imported (secrets such as API keys must be re-entered afterwards). +- **Custom widgets** — go to **Manage → Custom Widgets**, or use **Install from Workshop** in the + board widget picker. Pick an entry, review its capabilities, and enter any required local secrets before import. - **Custom CSS** — open a board's **Settings → Custom CSS**, click **Install from Workshop**, and pick a theme to load it into the editor before saving. -Alternatively, use **Copy** (or **Download** for widgets) on any submission and import it -manually. +Alternatively, open a submission in the Workshop and use **Download widget JSON** or **Copy CSS**. The submission page shows the matching manual installation steps before the source code. + +Custom Widget imports detect required bearer, basic, header, or query credentials. You can enter them during import or explicitly defer them; secret values are never stored in Workshop content. Missing credentials remain visible on the local Custom Widget afterward. ## Workshop deployment Workshop is powered by [PocketBase](https://pocketbase.io). The production image compiles the current Docusaurus site and serves it together with the API from one origin. The deployment lives in `apps/workshop/` with a Dockerfile, Compose configuration, version-controlled migrations, hooks, a smoke test, and ACT-local workflow instructions. +Run `pnpm docker:workshop` for the PocketBase development service or `pnpm docker:docs` for the built documentation and Workshop site. Both use `apps/workshop/docker-compose.yml` and the persistent `pb_data` volume. Normal start and stop commands retain data; `docker compose -f apps/workshop/docker-compose.yml down --volumes` intentionally recreates the database. + +Because Workshop is still unreleased, reset an older development volume if it predates the current schema and comments report that their collection context is missing. No compatibility migrations are maintained for these pre-release databases. + +GitHub needs only the central callback `https:///api/oauth2-redirect`. Keep PocketBase origins unrestricted unless every self-hosted Homarr caller is explicitly listed. Configure `GITHUB_CLIENT_ID`, `GITHUB_CLIENT_SECRET`, `WORKSHOP_PUBLIC_ORIGIN`, and PocketBase SMTP settings for authentication, comment email, report alerts, and submission-removal notices. + Homarr instances use `NEXT_PUBLIC_WORKSHOP_API_URL` to reach the central API and `NEXT_PUBLIC_WORKSHOP_URL` for links to the public page. Docusaurus uses `WORKSHOP_URL` only when its development server runs separately; the combined production image always uses its own origin. + +## Client architecture + +Workshop access is centralized in `@homarr/workshop/backend`. It exports the typed `WorkshopBackend`, its typed PocketBase instance, stable TanStack Query option factories, and the `useWorkshop…` query and mutation hooks used by Homarr. The documentation site uses the same backend rather than maintaining a second API contract. + +Listing fields derived by the `workshop_listings` view—such as submission type, score, and counts—are normalized by the shared client. Healthy deployments keep filtering, sorting, and pagination in PocketBase. If a persistent development volume still has an older view that rejects those fields, the client retries without them and applies the same operations locally; it can also fall back to the base submissions collection. Production deployments should nevertheless apply the current migration so the view exposes the complete metadata. diff --git a/apps/docs/docs/widgets/custom-api/index.mdx b/apps/docs/docs/widgets/custom-api/index.mdx index 1f61f7aa4..b3d1e15ab 100644 --- a/apps/docs/docs/widgets/custom-api/index.mdx +++ b/apps/docs/docs/widgets/custom-api/index.mdx @@ -1,6 +1,6 @@ --- title: "Custom API" -description: "Displays data from an administrator-defined HTTP API using built-in renderers or safe Custom JSX." +description: "The Custom API widget shows a Custom JSX v2 definition with server-side API requests, widget options, and actions." hide_title: true --- @@ -10,30 +10,48 @@ import { customApiWidget } from "."; -The Custom API widget displays an API definition created by an administrator in [Management → Custom Widgets](/docs/management/custom-widgets). A definition owns the endpoint, credentials, display configuration, and any named network capabilities used by Custom JSX. +The Custom API widget shows a Custom JSX v2 definition. Create the definition in [Management → Custom Widgets](/docs/management/custom-widgets). + +A definition contains API sources, named requests, a widget options schema, and one safe JSX template. + +Temporary inputs exist only while the tile is mounted. Homarr encrypts source credentials separately. + +Homarr does not send these credentials to the browser. Homarr does not include them in an export. ### Add the widget -Choose a custom-widget definition and a refresh interval. The board item stores only the selected definition and display options; credentials remain server-side. +Select a definition from the searchable picker. Configure its generated widget options. + +Select a refresh interval. The board item stores the definition ID and the validated widget option values. + +Credentials remain on the server. :::note -A definition must be enabled and available to the board before it appears in the widget picker. +Enable the definition before you use it. The definition must also be available to the board. ::: ### Permissions and actions -The base response and named query requests require permission to view the board. Named POST, PUT, and PATCH actions require permission to modify the board by default. DELETE requires full board permission and a confirmation. Anonymous viewers cannot execute actions. +Each named request declares its minimum board permission. This permission does not depend on the HTTP method. -Interactive controls are disabled while the board is in edit mode. Actions run only after an explicit user gesture and are never triggered by mounting, refresh polling, or automatic retries. Authoring previews simulate actions unless an administrator explicitly enables live actions for the short-lived preview session. +Queries and actions can use GET, POST, PUT, PATCH, or DELETE. The `kind` value controls runtime behavior. + +A DELETE request requires full board permission and confirmation. An anonymous viewer cannot run an action. + +Homarr disables interactive controls in board edit mode. An action runs only after a user action. + +Mounting, refresh polling, and automatic retries do not run actions. An authoring preview simulates actions by default. + +An administrator can enable live actions for the short preview session. ### Refresh behavior -The refresh interval applies to the base GET response. A Custom JSX query can declare its own cache duration and can be refreshed manually. Named actions can invalidate the parent response or related named queries after they succeed. +The refresh interval runs load queries again. `SubFetch` runs manual queries. -If the definition needs a non-GET base request, migrate it to a GET base response plus a named action. Existing non-GET Custom JSX definitions require review before network access is enabled. +Each query can declare a cache duration. A successful action can invalidate only its declared queries. -See [Custom Widgets management](/docs/management/custom-widgets) for the editor, display types, named-request manifest, network scopes, security limits, and migration guidance. +Read [Custom Widgets management](/docs/management/custom-widgets) for authoring, widget options, named requests, Mantine, network scopes, and security limits. diff --git a/apps/docs/docs/widgets/custom-api/index.ts b/apps/docs/docs/widgets/custom-api/index.ts index c6c56bc53..6b72691d0 100644 --- a/apps/docs/docs/widgets/custom-api/index.ts +++ b/apps/docs/docs/widgets/custom-api/index.ts @@ -4,6 +4,7 @@ import { IconApi } from "@tabler/icons-react"; export const customApiWidget: WidgetDefinition = { icon: IconApi, name: "Custom API", - description: "Displays data from a custom API endpoint using configurable display types and optional JSX templates.", + description: + "Renders an administrator-defined Custom JSX v2 widget with server-side API requests, options, and actions.", path: "../../widgets/custom-api", }; diff --git a/apps/docs/docusaurus.config.ts b/apps/docs/docusaurus.config.ts index 62384c741..d4518fbaf 100644 --- a/apps/docs/docusaurus.config.ts +++ b/apps/docs/docusaurus.config.ts @@ -12,6 +12,9 @@ const config: Config = { favicon: "img/logo.png", organizationName: "homarr-labs", projectName: "homarr", + customFields: { + workshopUrl: process.env.WORKSHOP_URL ?? "", + }, i18n: { defaultLocale: "en", locales: ["en"], @@ -20,11 +23,6 @@ const config: Config = { onBrokenAnchors: "throw", onDuplicateRoutes: "throw", - customFields: { - // Empty means same-origin, which is the production Workshop image shape. - workshopUrl: process.env.WORKSHOP_URL ?? "", - }, - future: { v4: { removeLegacyPostBuildHeadAttribute: true, @@ -48,17 +46,6 @@ const config: Config = { themes: ["@docusaurus/theme-mermaid"], - scripts: [ - { - src: "https://widget.kapa.ai/kapa-widget.bundle.js", - "data-website-id": "1e4656f4-abeb-4343-bbae-1d8626f52378", - "data-project-name": "Homarr", - "data-project-color": "#2B2B2B", - "data-project-logo": "https://homarr.dev/img/favicon.png", - async: true, - }, - ], - presets: [ [ "classic", @@ -128,6 +115,7 @@ const config: Config = { label: "Blog", position: "left", to: "/blog", + className: "navbar-item--secondary", }, { label: "Workshop", @@ -138,16 +126,19 @@ const config: Config = { label: "About us", position: "left", to: "/about-us", + className: "navbar-item--collapse-first", }, { to: "https://demo.homarr.dev/", label: "Demo", position: "right", + className: "navbar-item--secondary", }, { to: "https://opencollective.com/homarr", label: "💴 Donate", position: "right", + className: "navbar-item--collapse-first", }, { type: "dropdown", @@ -246,11 +237,19 @@ const config: Config = { }, ], logo: { - alt: "Homarr Logo", - src: "img/logo.png", - height: 100, + alt: "Homarr home", + src: "img/logo.svg", + href: "/", + width: 86, + height: 58, }, - copyright: `Copyright © ${new Date().getFullYear()} Homarr — License`, + copyright: ` +
+ Homarr + Your dashboard for the services you run. + © ${new Date().getFullYear()} Homarr · License +
+ `, }, prism: { theme: prismThemes.github, @@ -287,12 +286,21 @@ const config: Config = { function homarrPackagesPlugin() { return { name: "resolve-homarr-packages", - configureWebpack() { + configureWebpack(_config, isServer, { getJSLoader }) { return { resolve: { symlinks: false, alias: { "@": require("path").resolve(__dirname, "src") }, }, + module: { + rules: [ + { + test: /\.[jt]sx?$/iu, + include: /node_modules[\\/]@homarr/u, + use: [getJSLoader({ isServer })], + }, + ], + }, }; }, }; @@ -324,19 +332,18 @@ const config: Config = { }, }; }, - function workshopDetailRoutePlugin() { + function workshopRoutesPlugin() { return { - name: "workshop-detail-route", + name: "workshop-routes", async contentLoaded({ actions }) { actions.addRoute({ path: "/workshop/:id", - component: "@site/src/components/workshop/DetailPage", + component: "@site/src/components/workshop/WorkshopDetailRoutePage", exact: true, }); }, }; }, - "@signalwire/docusaurus-plugin-llms-txt", async function tailwindCssPlugin() { return { name: "docusaurus-tailwindcss", diff --git a/apps/docs/package.json b/apps/docs/package.json index a38e620fc..35f10f691 100644 --- a/apps/docs/package.json +++ b/apps/docs/package.json @@ -27,25 +27,37 @@ "@docusaurus/plugin-content-docs": "^3.10.1", "@docusaurus/plugin-sitemap": "^3.10.1", "@docusaurus/preset-classic": "^3.10.1", + "@homarr/custom-widgets": "workspace:^", "@homarr/definitions": "workspace:^", + "@homarr/workshop": "workspace:^", + "@mantine/core": "catalog:", "@mdx-js/react": "^3.1.1", "@nivo/line": "^0.99.0", "@scalar/api-reference-react": "catalog:", - "@signalwire/docusaurus-plugin-llms-txt": "^1.2.2", + "@shadcn/react": "catalog:", "@tabler/icons-react": "catalog:", "@tailwindcss/postcss": "^4.3.2", "class-variance-authority": "catalog:", "clsx": "catalog:", + "cmdk": "catalog:", + "date-fns": "catalog:", "dayjs": "catalog:", "docusaurus-plugin-image-zoom": "^3.0.1", + "embla-carousel-react": "catalog:", + "input-otp": "catalog:", "leader-line-new": "^1.1.9", + "next-themes": "catalog:", "pocketbase": "catalog:", "postcss": "^8.5.16", "posthog-docusaurus": "^2.0.5", "prism-react-renderer": "^2.4.1", "random-word-slugs": "^0.1.7", "react": "catalog:", + "react-day-picker": "catalog:", "react-dom": "catalog:", + "react-resizable-panels": "catalog:", + "recharts": "3.8.0", + "sonner": "catalog:", "swiper": "^14.0.5", "tailwind-merge": "catalog:", "tailwindcss": "^4.3.2", diff --git a/apps/docs/src/components/custom-jsx-component-reference.module.css b/apps/docs/src/components/custom-jsx-component-reference.module.css new file mode 100644 index 000000000..66fe6bff0 --- /dev/null +++ b/apps/docs/src/components/custom-jsx-component-reference.module.css @@ -0,0 +1,451 @@ +.explorer { + --catalog-border: color-mix(in srgb, var(--ifm-color-emphasis-500) 42%, transparent); + --catalog-surface: color-mix(in srgb, var(--ifm-background-surface-color) 90%, var(--ifm-color-primary) 10%); + border: 1px solid var(--catalog-border); + border-radius: 18px; + margin: 1.5rem 0 2rem; + overflow: hidden; +} + +.header { + align-items: flex-start; + background: linear-gradient(135deg, color-mix(in srgb, var(--ifm-color-primary) 13%, transparent), transparent 65%); + display: flex; + gap: 1.5rem; + justify-content: space-between; + padding: 1.4rem; +} + +.eyebrow { + color: var(--ifm-color-primary); + font-size: 0.72rem; + font-weight: 750; + letter-spacing: 0.09em; + margin: 0 0 0.35rem; + text-transform: uppercase; +} + +.title { + font-size: clamp(1.25rem, 3vw, 1.65rem); + margin: 0; +} + +.summary { + color: var(--ifm-color-emphasis-700); + margin: 0.45rem 0 0; + max-width: 68ch; +} + +.rawLink, +.expandButton, +.showMoreButton, +.resetButton { + align-items: center; + border-radius: 9px; + cursor: pointer; + display: inline-flex; + font: inherit; + font-weight: 650; + justify-content: center; +} + +.rawLink, +.expandButton, +.showMoreButton { + background: var(--ifm-color-primary); + border: 1px solid var(--ifm-color-primary); + color: var(--ifm-color-white); + padding: 0.58rem 0.85rem; + text-decoration: none; +} + +.rawLink { + flex: 0 0 auto; + white-space: nowrap; +} + +.rawLink:hover, +.expandButton:hover, +.showMoreButton:hover { + background: var(--ifm-color-primary-dark); + color: var(--ifm-color-white); + text-decoration: none; +} + +.versions { + border-bottom: 1px solid var(--catalog-border); + border-top: 1px solid var(--catalog-border); + display: grid; + grid-template-columns: repeat(4, minmax(0, 1fr)); + margin: 0; +} + +.globalProps { + align-items: center; + border-bottom: 1px solid var(--catalog-border); + display: grid; + gap: 1rem; + grid-template-columns: minmax(0, 1fr) auto; + padding: 1rem 1.4rem; + scroll-margin-top: calc(var(--ifm-navbar-height) + 1rem); +} + +.globalProps h4, +.globalProps p { + margin: 0; +} + +.globalProps p { + color: var(--ifm-color-emphasis-700); + font-size: 0.86rem; + margin-top: 0.2rem; +} + +.globalPropsTable { + grid-column: 1 / -1; +} + +.versions div { + padding: 0.75rem 1.4rem; +} + +.versions div + div { + border-left: 1px solid var(--catalog-border); +} + +.versions dt { + color: var(--ifm-color-emphasis-700); + font-size: 0.72rem; + font-weight: 650; + text-transform: uppercase; +} + +.versions dd { + font-family: var(--ifm-font-family-monospace); + font-size: 0.86rem; + margin: 0.12rem 0 0; +} + +.filters { + align-items: end; + background: var(--catalog-surface); + display: grid; + gap: 0.8rem; + grid-template-columns: minmax(220px, 2fr) repeat(3, minmax(130px, 1fr)); + padding: 1.15rem 1.4rem; +} + +.filters label:not(.checkboxField) { + display: grid; + gap: 0.3rem; +} + +.filters label > span { + color: var(--ifm-color-emphasis-700); + font-size: 0.76rem; + font-weight: 700; +} + +.filters input[type="search"], +.filters select { + background: var(--ifm-background-color); + border: 1px solid var(--catalog-border); + border-radius: 9px; + color: var(--ifm-font-color-base); + font: inherit; + min-height: 42px; + padding: 0.55rem 0.68rem; + width: 100%; +} + +.filters input:focus-visible, +.filters select:focus-visible, +.expandButton:focus-visible, +.showMoreButton:focus-visible, +.resetButton:focus-visible, +.anchorLink:focus-visible { + outline: 3px solid color-mix(in srgb, var(--ifm-color-primary) 45%, transparent); + outline-offset: 2px; +} + +.checkboxField { + align-items: center; + display: flex; + gap: 0.5rem; + grid-column: 1 / -1; +} + +.checkboxField input { + height: 1rem; + margin: 0; + width: 1rem; +} + +.resultSummary { + align-items: center; + border-bottom: 1px solid var(--catalog-border); + display: flex; + gap: 0.6rem; + min-height: 48px; + padding: 0.7rem 1.4rem; +} + +.resetButton { + background: transparent; + border: 0; + color: var(--ifm-color-primary); + margin-left: auto; + padding: 0.35rem; +} + +.componentList { + display: grid; +} + +.componentCard { + scroll-margin-top: calc(var(--ifm-navbar-height) + 1rem); +} + +.componentCard + .componentCard { + border-top: 1px solid var(--catalog-border); +} + +.componentHeading { + align-items: center; + display: flex; + gap: 1rem; + justify-content: space-between; + padding: 1rem 1.4rem; +} + +.componentNameRow { + align-items: baseline; + display: flex; + gap: 0.45rem; +} + +.componentNameRow h4 { + font-family: var(--ifm-font-family-monospace); + font-size: 1.05rem; + margin: 0; +} + +.anchorLink { + font-weight: 700; + opacity: 0; + text-decoration: none; +} + +.componentCard:hover .anchorLink, +.anchorLink:focus-visible { + opacity: 1; +} + +.badges { + display: flex; + flex-wrap: wrap; + gap: 0.38rem; + margin-top: 0.45rem; +} + +.badges span { + background: var(--ifm-color-emphasis-200); + border-radius: 999px; + color: var(--ifm-color-emphasis-800); + font-size: 0.7rem; + padding: 0.2rem 0.48rem; +} + +.badges span[data-safety="allowed"] { + background: color-mix(in srgb, #2f9e44 18%, transparent); + color: color-mix(in srgb, #2f9e44 78%, var(--ifm-font-color-base)); +} + +.badges span[data-safety="wrapped"] { + background: color-mix(in srgb, var(--ifm-color-primary) 18%, transparent); + color: var(--ifm-color-primary-darkest); +} + +.badges span[data-safety="denied"] { + background: color-mix(in srgb, #e03131 18%, transparent); + color: color-mix(in srgb, #e03131 78%, var(--ifm-font-color-base)); +} + +.expandButton { + background: transparent; + color: var(--ifm-color-primary); + flex: 0 0 auto; + padding: 0.42rem 0.7rem; +} + +.expandButton:hover { + background: color-mix(in srgb, var(--ifm-color-primary) 12%, transparent); + color: var(--ifm-color-primary-dark); +} + +.description, +.deniedReason { + color: var(--ifm-color-emphasis-700); + margin: -0.45rem 1.4rem 1rem; +} + +.deniedReason { + color: #c92a2a; +} + +.details { + background: var(--catalog-surface); + border-top: 1px solid var(--catalog-border); + padding: 1.25rem 1.4rem; +} + +.details h5 { + font-size: 0.9rem; + margin: 0 0 0.6rem; +} + +.detailsGrid { + display: grid; + gap: 1rem; + grid-template-columns: minmax(0, 1.15fr) minmax(0, 0.85fr); + margin-bottom: 1.2rem; +} + +.detailsGrid > section { + background: var(--ifm-background-color); + border: 1px solid var(--catalog-border); + border-radius: 12px; + min-width: 0; + padding: 0.9rem; +} + +.detailsGrid p:last-of-type { + margin-bottom: 0.6rem; +} + +.a11yList { + font-size: 0.86rem; + margin: 0 0 0.7rem; + padding-left: 1.1rem; +} + +.tableScroll { + border: 1px solid var(--catalog-border); + border-radius: 10px; + max-height: 480px; + overflow: auto; +} + +.propsTable { + display: table; + font-size: 0.78rem; + margin: 0; + width: 100%; +} + +.propsTable th { + background: var(--ifm-background-color); + position: sticky; + top: 0; + z-index: 1; +} + +.propsTable th, +.propsTable td { + min-width: 96px; + padding: 0.58rem; + vertical-align: top; +} + +.propsTable td:nth-child(2) { + max-width: 340px; + min-width: 190px; +} + +.type { + overflow-wrap: anywhere; + white-space: normal; +} + +.muted { + color: var(--ifm-color-emphasis-600); +} + +.rawComponent { + margin-top: 1rem; +} + +.rawComponent summary { + color: var(--ifm-color-primary); + cursor: pointer; + font-weight: 650; +} + +.rawComponent > div { + margin-top: 0.6rem; +} + +.showMoreButton { + display: flex; + margin: 1.1rem auto; +} + +.loading, +.error, +.empty { + background: var(--ifm-background-surface-color); + border: 1px solid var(--ifm-color-emphasis-300); + border-radius: 12px; + margin: 1rem 0; + padding: 1rem; +} + +.empty { + border: 0; + margin: 0; + text-align: center; +} + +.error { + border-color: color-mix(in srgb, #e03131 58%, transparent); +} + +@media (max-width: 996px) { + .filters { + grid-template-columns: repeat(2, minmax(0, 1fr)); + } + + .searchField { + grid-column: 1 / -1; + } +} + +@media (max-width: 650px) { + .header, + .componentHeading { + align-items: stretch; + flex-direction: column; + } + + .rawLink, + .expandButton { + align-self: flex-start; + } + + .versions, + .filters, + .detailsGrid, + .globalProps { + grid-template-columns: 1fr; + } + + .versions div + div { + border-left: 0; + border-top: 1px solid var(--catalog-border); + } + + .searchField, + .checkboxField { + grid-column: auto; + } +} diff --git a/apps/docs/src/components/custom-jsx-component-reference.tsx b/apps/docs/src/components/custom-jsx-component-reference.tsx index af37a7105..23c028787 100644 --- a/apps/docs/src/components/custom-jsx-component-reference.tsx +++ b/apps/docs/src/components/custom-jsx-component-reference.tsx @@ -1,66 +1,497 @@ -import React from "react"; +import BrowserOnly from "@docusaurus/BrowserOnly"; +import useBaseUrl from "@docusaurus/useBaseUrl"; +import { useEffect, useMemo, useState } from "react"; -import customJsxComponentRegistry from "../generated/custom-jsx-components.json"; +import { buildCustomJsxComponentUsageExample } from "@homarr/custom-widgets/catalog-example"; +import type { + CustomJsxAuthoringCatalog, + CustomJsxComponentApi, + CustomJsxPropDescriptor, +} from "@homarr/custom-widgets/catalog"; -const enabledComponents = customJsxComponentRegistry.filter((component) => component.safety !== "denied"); -const deniedComponents = customJsxComponentRegistry.filter((component) => component.safety === "denied"); -const categories = [...new Set(enabledComponents.map((component) => component.category))]; +import { CustomWidgetCodeExample } from "./custom-widget-code"; +import styles from "./custom-jsx-component-reference.module.css"; + +type ComponentCatalog = CustomJsxAuthoringCatalog; +type CatalogComponent = CustomJsxComponentApi; +type CatalogProp = CustomJsxPropDescriptor; + +const PAGE_SIZE = 40; export function CustomJsxComponentReference() { return ( - <> -

Enabled and wrapped components

- - - - - - - - - {categories.map((category) => ( - - - - - ))} - -
CategoryComponents
- {category} - - {enabledComponents - .filter((component) => component.category === category) - .map((component) => ( - - - {component.name} - - {component.safety === "wrapped" && (wrapped)} - - ))} -
- -

Denied components

- - - - - - - - - {deniedComponents.map((component) => ( - - - - - ))} - -
ComponentReason
- - {component.name} - - {component.reason}
- + }>{() => } ); } + +function ComponentReferenceFallback() { + return ( +
+ Loading the Custom JSX component catalog… +
+ ); +} + +function CustomJsxComponentReferenceClient() { + const catalogUrl = useBaseUrl("/custom-widgets/component-catalog-v1.json"); + const [catalog, setCatalog] = useState(null); + const [loadError, setLoadError] = useState(null); + const [query, setQuery] = useState(""); + const [packageFilter, setPackageFilter] = useState("all"); + const [categoryFilter, setCategoryFilter] = useState("all"); + const [safetyFilter, setSafetyFilter] = useState("available"); + const [bindableOnly, setBindableOnly] = useState(false); + const [visibleCount, setVisibleCount] = useState(PAGE_SIZE); + const [expanded, setExpanded] = useState>(() => new Set()); + const [showGlobalProps, setShowGlobalProps] = useState(false); + + useEffect(() => { + const controller = new AbortController(); + setLoadError(null); + + void fetch(catalogUrl, { signal: controller.signal }) + .then(async (response) => { + if (!response.ok) throw new Error(`The catalog request returned HTTP ${response.status}.`); + return (await response.json()) as ComponentCatalog; + }) + .then((value) => { + if (!Array.isArray(value.components) || !Array.isArray(value.types) || !Array.isArray(value.globalProps)) { + throw new Error("The catalog response has an unsupported shape."); + } + setCatalog(value); + }) + .catch((error: unknown) => { + if (controller.signal.aborted) return; + setLoadError(error instanceof Error ? error.message : "The component catalog could not be loaded."); + }); + + return () => controller.abort(); + }, [catalogUrl]); + + const categories = useMemo( + () => [...new Set(catalog?.components.map((component) => component.category) ?? [])].sort(), + [catalog], + ); + const packages = useMemo( + () => [...new Set(catalog?.components.map((component) => component.package) ?? [])].sort(), + [catalog], + ); + const filteredComponents = useMemo(() => { + if (!catalog) return []; + const normalizedQuery = query.trim().toLocaleLowerCase(); + return catalog.components.filter((component) => { + if (packageFilter !== "all" && component.package !== packageFilter) return false; + if (categoryFilter !== "all" && component.category !== categoryFilter) return false; + if (safetyFilter === "available" && component.safety === "denied") return false; + if (safetyFilter !== "all" && safetyFilter !== "available" && component.safety !== safetyFilter) return false; + if (bindableOnly && !component.bind) return false; + if (!normalizedQuery) return true; + + return [ + component.name, + component.package, + component.category, + component.description, + component.deniedReason, + ...component.subcomponents, + ...component.props.map((prop) => prop.name), + ].some((value) => value?.toLocaleLowerCase().includes(normalizedQuery)); + }); + }, [bindableOnly, catalog, categoryFilter, packageFilter, query, safetyFilter]); + const visibleComponents = filteredComponents.slice(0, visibleCount); + + useEffect(() => { + setVisibleCount(PAGE_SIZE); + }, [bindableOnly, categoryFilter, packageFilter, query, safetyFilter]); + + useEffect(() => { + if (!catalog) return; + + const revealHashTarget = () => { + const hash = decodeLocationHash(window.location.hash); + const component = catalog.components.find((entry) => componentAnchor(entry.name) === hash); + if (!component) return; + + if (!document.getElementById(hash)) { + setQuery(component.name); + setPackageFilter("all"); + setCategoryFilter("all"); + setSafetyFilter(component.safety === "denied" ? "all" : "available"); + setBindableOnly(false); + setVisibleCount(PAGE_SIZE); + } + setExpanded((current) => new Set([...current, component.name])); + window.requestAnimationFrame(() => { + window.requestAnimationFrame(() => document.getElementById(hash)?.scrollIntoView({ block: "start" })); + }); + }; + + revealHashTarget(); + window.addEventListener("hashchange", revealHashTarget); + return () => window.removeEventListener("hashchange", revealHashTarget); + }, [catalog]); + + if (loadError) { + return ( +
+ Component catalog unavailable. {loadError} Open the raw catalog to + inspect the generated data directly. +
+ ); + } + + if (!catalog) return ; + + return ( +
+
+
+

Release-matched static catalog

+

Explore {catalog.components.length} Custom JSX components

+

+ This browser reads the same versioned JSON artifact used by offline authoring. It never imports or executes + the listed component objects. +

+
+ + Open raw JSON + +
+ +
+
+
Catalog schema
+
v{catalog.schemaVersion}
+
+
+
Custom Widget
+
{catalog.customWidgetVersion}
+
+
+
Mantine
+
{catalog.mantineVersion}
+
+
+
Blocked capabilities
+
{catalog.blockedCapabilities.length}
+
+
+ +
+
+

Shared serializable props

+

+ Every available component also receives these {catalog.globalProps.length} generated global, ARIA, data, and + safe style props. Component cards below list only their component-specific additions. +

+
+ + {showGlobalProps && ( +
+ +
+ )} +
+ +
+ + + + + +
+ +
+ {filteredComponents.length} matching component{filteredComponents.length === 1 ? "" : "s"} + {(query || + packageFilter !== "all" || + categoryFilter !== "all" || + safetyFilter !== "available" || + bindableOnly) && ( + + )} +
+ + {filteredComponents.length === 0 ? ( +
No component matches these filters.
+ ) : ( +
+ {visibleComponents.map((component) => { + const isExpanded = expanded.has(component.name); + return ( +
+
+
+
+

{component.name}

+ + # + +
+
+ {component.package} + {humanize(component.category)} + {component.safety} + {component.bind && bind: {component.bind.type}} +
+
+ +
+ {(component.description || component.deniedReason) && ( +

+ {component.deniedReason ?? component.description} +

+ )} + + {isExpanded && ( + + )} +
+ ); + })} +
+ )} + + {visibleCount < filteredComponents.length && ( + + )} +
+ ); +} + +function decodeLocationHash(hash: string) { + const value = hash.slice(1); + try { + return decodeURIComponent(value); + } catch { + return value; + } +} + +function ComponentDetails({ id, component, types }: { id: string; component: CatalogComponent; types: string[] }) { + return ( +
+
+
+ +
+ +
+
Component contract
+ {component.bind ? ( +

+ bind stores a temporary {component.bind.type} input. Initialize it with{" "} + {component.bind.initialProp}. +

+ ) : ( +

This component does not expose a temporary-input adapter.

+ )} + {component.subcomponents.length > 0 && ( +

+ Subcomponents:{" "} + {component.subcomponents.map((name, index) => ( + + {index > 0 && ", "} + {name} + + ))} +

+ )} + {component.blockedProps.length > 0 && ( +
    + {component.blockedProps.map((prop) => ( +
  • + {prop.name} is blocked: {prop.reason} +
    • + ))} +
+ )} + {component.accessibilityRequirements.length > 0 && ( +
    + {component.accessibilityRequirements.map((requirement) => ( +
  • {requirement}
    • + ))} +
+ )} + + Open upstream documentation + +
+
+ +
+
+ Component props ({component.props.length}) +
+ {component.props.length === 0 ? ( +

No component-specific props are exposed.

+ ) : ( + + )} +
+ +
+ Raw component JSON + +
+
+ ); +} + +function PropTable({ props, types }: { props: CatalogProp[]; types: string[] }) { + return ( +
+ + + + + + + + + + + + {props.map((prop) => ( + + + + + + + + ))} + +
PropTypeRequiredKnown valuesDescription
+ {prop.name} + + {types[prop.typeRef] ?? "unknown"} + {prop.required ? Yes : "No"} + {prop.literalValues?.length ? ( + {prop.literalValues.map(formatLiteral).join(" | ")} + ) : ( + — + )} + {prop.description ?? —}
+
+ ); +} + +function componentAnchor(name: string) { + return `custom-jsx-component-${name + .replaceAll(".", "-") + .replace(/([a-z0-9])([A-Z])/g, "$1-$2") + .toLowerCase()}`; +} + +function humanize(value: string) { + return value.replaceAll("-", " ").replace(/\b\w/g, (character) => character.toUpperCase()); +} + +function formatLiteral(value: string | number | boolean | null) { + return typeof value === "string" ? JSON.stringify(value) : String(value); +} diff --git a/apps/docs/src/components/custom-widget-code-client.tsx b/apps/docs/src/components/custom-widget-code-client.tsx new file mode 100644 index 000000000..ce35fc60a --- /dev/null +++ b/apps/docs/src/components/custom-widget-code-client.tsx @@ -0,0 +1,123 @@ +import { useState } from "react"; +import { useColorMode } from "@docusaurus/theme-common"; +import { MantineProvider, Select, Stack, Text } from "@mantine/core"; +/* oxlint-disable import/no-unassigned-import -- Mantine component styles intentionally load for side effects. */ +import "@mantine/core/styles.layer.css"; +/* oxlint-enable import/no-unassigned-import */ + +import { + BUNDLED_CUSTOM_WIDGETS, + CUSTOM_WIDGET_OPTIONS_EXAMPLES, + CUSTOM_WIDGET_REQUEST_EXAMPLES, +} from "@homarr/custom-widgets/core"; +import type { CustomWidgetEditorMessages } from "@homarr/custom-widgets/workbench"; +import { CustomWidgetCodeEditor, ReadOnlyCustomWidgetCode } from "@homarr/custom-widgets/workbench"; + +import type { + CanonicalCustomWidgetExampleProps, + CustomWidgetCodeExampleProps, + CustomWidgetCodeInputProps, +} from "./custom-widget-code"; + +const messages: CustomWidgetEditorMessages = { + languageJsx: "JSX", + languageJson: "JSON", + undo: "Undo", + redo: "Redo", + components: "Components", + componentSearch: "Search components", + componentEmpty: "No matching components", + componentCount: (count) => `${count} components`, + insertStarter: "Insert starter", + format: "Format", + copy: "Copy", + copied: "Copied", + schema: "Schema", + schemaTab: "JSON Schema", + minimalTab: "Minimal example", + fullTab: "Full example", + errors: (count) => `${count} errors`, + warnings: (count) => `${count} warnings`, + ready: "Read-only example", + position: ({ line, column }) => `Ln ${line}, Col ${column}`, + characters: (count, limit) => (limit ? `${count} / ${limit}` : `${count} characters`), + diagnosticsTitle: "Diagnostics", + diagnostic: (diagnostic) => diagnostic.value ?? diagnostic.code, +}; +const editableMessages: CustomWidgetEditorMessages = { ...messages, ready: "Ready" }; + +export function CanonicalCustomWidgetExampleClient({ id, label, example, height }: CanonicalCustomWidgetExampleProps) { + const value = example === "requests" ? CUSTOM_WIDGET_REQUEST_EXAMPLES.full : CUSTOM_WIDGET_OPTIONS_EXAMPLES.full; + + return ; +} + +export function CustomWidgetCodeExampleClient(props: CustomWidgetCodeExampleProps) { + const { colorMode } = useColorMode(); + + return ( + + + + ); +} + +export function CustomWidgetCodeInputClient(props: CustomWidgetCodeInputProps) { + const { colorMode } = useColorMode(); + + return ( + + + + ); +} + +export function BundledCustomWidgetGalleryClient() { + const { colorMode } = useColorMode(); + const [selectedId, setSelectedId] = useState(BUNDLED_CUSTOM_WIDGETS[0]?.id ?? null); + const selected = BUNDLED_CUSTOM_WIDGETS.find(({ id }) => id === selectedId) ?? BUNDLED_CUSTOM_WIDGETS[0]; + if (!selected) return null; + const manifest = { ...selected.widget, template: "__HOMARR_TEMPLATE__" }; + + return ( + + + + ); +} + +function InputGroupTextarea({ className, ...props }: React.ComponentProps<"textarea">) { + return ( +