fimo 0.15.0 → 0.16.0-experimental.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (183) hide show
  1. package/assets/astro/components/DateTime.astro +22 -0
  2. package/assets/astro/components/index.d.ts +1 -0
  3. package/assets/astro/components/index.js +1 -0
  4. package/assets/content-templates/forms/react.eta +3 -3
  5. package/assets/content-templates/shared/types.eta +2 -0
  6. package/assets/skills/fimo-cli/SKILL.md +20 -14
  7. package/assets/skills/fimo-cli/references/account.md +1 -1
  8. package/assets/skills/fimo-cli/references/agents.md +13 -10
  9. package/assets/skills/fimo-cli/references/branches.md +39 -38
  10. package/assets/skills/fimo-cli/references/content.md +2 -2
  11. package/assets/skills/fimo-cli/references/credits.md +1 -1
  12. package/assets/skills/fimo-cli/references/deploy.md +30 -14
  13. package/assets/skills/fimo-cli/references/history.md +13 -6
  14. package/assets/skills/fimo-cli/references/hosting.md +114 -0
  15. package/assets/skills/fimo-cli/references/init.md +19 -8
  16. package/assets/skills/fimo-cli/references/integrations/firecrawl.md +2 -0
  17. package/assets/skills/fimo-cli/references/locales.md +39 -15
  18. package/assets/skills/fimo-cli/references/mcp.md +8 -8
  19. package/assets/skills/fimo-cli/references/pages.md +70 -0
  20. package/assets/skills/fimo-cli/references/preview.md +29 -20
  21. package/assets/skills/fimo-cli/references/project-vars-and-secrets.md +1 -1
  22. package/assets/skills/fimo-cli/references/projects.md +3 -3
  23. package/assets/skills/fimo-cli/references/schedules.md +8 -5
  24. package/assets/skills/fimo-cli/references/support.md +1 -1
  25. package/assets/skills/fimo-cli/references/webhooks.md +9 -5
  26. package/assets/skills/fimo-code/SKILL.md +12 -0
  27. package/assets/skills/fimo-code/assets/react-router-locales/LocaleLayout.tsx +12 -0
  28. package/assets/skills/fimo-code/assets/react-router-locales/routes.ts +7 -6
  29. package/assets/skills/fimo-code/references/best-practices/astro.md +47 -0
  30. package/assets/skills/fimo-code/references/best-practices/next.md +42 -0
  31. package/assets/skills/fimo-code/references/best-practices/sveltekit.md +17 -0
  32. package/assets/skills/fimo-code/references/content/richtext.md +5 -0
  33. package/assets/skills/fimo-code/references/content/schema.md +4 -1
  34. package/assets/skills/fimo-code/references/frameworks/astro.md +5 -3
  35. package/assets/skills/fimo-code/references/frameworks/compatibility.md +13 -8
  36. package/assets/skills/fimo-code/references/frameworks/hosting.md +28 -20
  37. package/assets/skills/fimo-code/references/frameworks/next/app-router.md +6 -0
  38. package/assets/skills/fimo-code/references/frameworks/next/locales.md +12 -2
  39. package/assets/skills/fimo-code/references/frameworks/next.md +7 -0
  40. package/assets/skills/fimo-code/references/frameworks/react-router.md +15 -7
  41. package/assets/skills/fimo-code/references/frameworks/sveltekit.md +15 -8
  42. package/assets/skills/fimo-code/references/labels.md +9 -1
  43. package/assets/skills/fimo-code/references/locales.md +8 -2
  44. package/assets/skills/fimo-code/references/migrations/react-router-route-ownership.md +93 -0
  45. package/assets/skills/fimo-code/references/ui.md +21 -2
  46. package/assets/skills/fimo-migration/SKILL.md +297 -53
  47. package/assets/skills/fimo-migration/agents/openai.yaml +2 -2
  48. package/assets/skills/fimo-migration/references/content.md +119 -35
  49. package/assets/skills/fimo-migration/references/decision.md +72 -0
  50. package/assets/skills/fimo-migration/references/forms.md +38 -6
  51. package/assets/skills/fimo-migration/references/frameworks/nextjs.md +179 -23
  52. package/assets/skills/fimo-migration/references/import-contract.md +71 -19
  53. package/assets/skills/fimo-migration/references/manifest.md +11 -161
  54. package/assets/skills/fimo-migration/references/media.md +33 -1
  55. package/assets/skills/fimo-migration/references/platforms.md +26 -2
  56. package/assets/skills/fimo-migration/references/qa.md +185 -13
  57. package/assets/skills/fimo-migration/references/url-evidence.md +242 -0
  58. package/assets/skills/fimo-migration/references/workers/content-execution.md +39 -0
  59. package/assets/skills/fimo-migration/references/workers/content-planner.md +64 -0
  60. package/assets/skills/fimo-migration/references/workers/framework.md +37 -0
  61. package/assets/skills/fimo-migration/references/workers/url-observer.md +71 -0
  62. package/assets/skills/fimo-migration/references/workers/validator.md +31 -0
  63. package/assets/skills/fimo-migration/references/workers.md +104 -0
  64. package/assets/skills/fimo-migration/references/workflow.md +152 -192
  65. package/assets/skills/fimo-migration/scripts/apply-decision.mjs +534 -0
  66. package/assets/skills/fimo-migration/scripts/build-canonical-manifest.mjs +7 -4
  67. package/assets/skills/fimo-migration/scripts/write-migration-report.mjs +191 -4
  68. package/assets/skills/fimo-studio/references/ai-chat.md +1 -1
  69. package/assets/skills/fimo-studio/references/cms.md +25 -7
  70. package/assets/skills/fimo-studio/references/webhooks.md +3 -3
  71. package/assets/sveltekit/components/DateTime.svelte +35 -0
  72. package/assets/sveltekit/components/FimoProvider.svelte +2 -2
  73. package/assets/sveltekit/components/index.d.ts +1 -0
  74. package/assets/sveltekit/components/index.js +1 -0
  75. package/dist/build/next/config.d.ts +4 -1
  76. package/dist/build/next/config.js +21 -5
  77. package/dist/build/sveltekit/vite.d.ts +3 -4
  78. package/dist/build/sveltekit/vite.js +3 -4
  79. package/dist/build/vite/plugins/runtime-env.d.ts +2 -1
  80. package/dist/build/vite/plugins/runtime-env.js +14 -10
  81. package/dist/cli/bundle.json +1 -1
  82. package/dist/cli/index.js +145 -124
  83. package/dist/runtime/app/FimoProviders.js +25 -14
  84. package/dist/runtime/app/prefetch.d.ts +3 -1
  85. package/dist/runtime/app/prefetch.js +11 -55
  86. package/dist/runtime/astro/preview.js +7 -9
  87. package/dist/runtime/content/client/internal.js +1 -0
  88. package/dist/runtime/i18n/locale.d.ts +6 -3
  89. package/dist/runtime/i18n/locale.js +16 -41
  90. package/dist/runtime/next/client-runtime.js +5 -1
  91. package/dist/runtime/next/client.d.ts +3 -2
  92. package/dist/runtime/next/client.js +2 -1
  93. package/dist/runtime/next/labels.d.ts +2 -2
  94. package/dist/runtime/next/labels.js +2 -2
  95. package/dist/runtime/next/preview.d.ts +13 -0
  96. package/dist/runtime/next/preview.js +34 -0
  97. package/dist/runtime/next/primitives/server.d.ts +2 -0
  98. package/dist/runtime/next/primitives/server.js +8 -0
  99. package/dist/runtime/next/provider.d.ts +5 -0
  100. package/dist/runtime/next/provider.js +17 -3
  101. package/dist/runtime/next/server-runtime.js +4 -1
  102. package/dist/runtime/next/server.d.ts +1 -1
  103. package/dist/runtime/next/server.js +1 -1
  104. package/dist/runtime/paths/get-fimo-paths.d.ts +6 -5
  105. package/dist/runtime/paths/get-fimo-paths.js +43 -42
  106. package/dist/runtime/preview/location.d.ts +19 -2
  107. package/dist/runtime/preview/location.js +16 -2
  108. package/dist/runtime/primitives/index.d.ts +1 -0
  109. package/dist/runtime/primitives/index.js +1 -0
  110. package/dist/runtime/react/primitives/editable/DateTime.d.ts +4 -0
  111. package/dist/runtime/react/primitives/editable/DateTime.js +13 -0
  112. package/dist/runtime/react/primitives/renderers/DateRenderer.d.ts +7 -1
  113. package/dist/runtime/react/primitives/renderers/DateRenderer.js +11 -8
  114. package/dist/runtime/react-router/{routes.d.ts → legacy/routes.d.ts} +6 -1
  115. package/dist/runtime/react-router/{routes.js → legacy/routes.js} +22 -7
  116. package/dist/runtime/routes/index.d.ts +162 -0
  117. package/dist/runtime/routes/index.js +335 -0
  118. package/dist/runtime/routing/AppRoutesProvider.js +4 -3
  119. package/dist/runtime/seo/resolver.d.ts +5 -0
  120. package/dist/runtime/seo/resolver.js +10 -42
  121. package/dist/runtime/shared/fimo-config.types.d.ts +14 -13
  122. package/dist/runtime/shared/preview-location.d.ts +1 -22
  123. package/dist/runtime/shared/preview-location.js +5 -93
  124. package/dist/runtime/sveltekit/preview.d.ts +12 -3
  125. package/dist/runtime/sveltekit/preview.js +13 -8
  126. package/dist/runtime/sveltekit/runtime.js +4 -1
  127. package/dist/runtime/templates.d.ts +19 -0
  128. package/dist/runtime/templates.js +33 -0
  129. package/dist/scripts/sync-forms.js +1 -1
  130. package/dist/scripts/sync-schemas.js +1 -4
  131. package/dist/scripts/validate-fimo-config.js +5 -1
  132. package/dist/scripts/validate-page-registry.d.ts +2 -0
  133. package/dist/scripts/validate-page-registry.js +167 -0
  134. package/dist/scripts/validate-route-metadata.js +132 -41
  135. package/package.json +10 -5
  136. package/release.json +2 -2
  137. package/templates/astro/.fimo/config.json +13 -5
  138. package/templates/astro/AGENTS.md +6 -1
  139. package/templates/astro/astro.config.mjs +7 -0
  140. package/templates/astro/package.json +1 -1
  141. package/templates/astro/pnpm-workspace.yaml +0 -3
  142. package/templates/astro/src/components/ProjectOverview.astro +9 -6
  143. package/templates/astro/src/layouts/Base.astro +1 -1
  144. package/templates/astro/src/locales.ts +4 -0
  145. package/templates/astro/src/pages/[locale]/index.astro +19 -0
  146. package/templates/astro/src/pages/[locale]/projects/[slug].astro +35 -0
  147. package/templates/astro/src/pages/[locale]/projects/index.astro +19 -0
  148. package/templates/astro/src/pages/index.astro +5 -2
  149. package/templates/astro/src/pages/projects/[slug].astro +4 -2
  150. package/templates/astro/src/pages/projects/index.astro +5 -2
  151. package/templates/nextjs/.fimo/config.json +2 -1
  152. package/templates/nextjs/AGENTS.md +6 -0
  153. package/templates/nextjs/package.json +1 -1
  154. package/templates/nextjs/src/app/(default)/layout.tsx +10 -0
  155. package/templates/nextjs/src/app/[locale]/layout.tsx +22 -0
  156. package/templates/nextjs/src/app/[locale]/page.tsx +1 -0
  157. package/templates/nextjs/src/components/Document.tsx +26 -0
  158. package/templates/nextjs/src/components/FimoPreviewBridge.tsx +13 -0
  159. package/templates/nextjs/src/locales.ts +13 -0
  160. package/templates/react-router/.fimo/config.json +3 -6
  161. package/templates/react-router/AGENTS.md +5 -0
  162. package/templates/react-router/package.json +2 -2
  163. package/templates/react-router/pnpm-workspace.yaml +1 -3
  164. package/templates/react-router/react-router.config.ts +4 -10
  165. package/templates/react-router/src/pages/LocaleLayout.tsx +12 -0
  166. package/templates/react-router/src/root.tsx +2 -4
  167. package/templates/react-router/src/routes.ts +5 -3
  168. package/templates/sveltekit/.fimo/config.json +2 -1
  169. package/templates/sveltekit/AGENTS.md +6 -0
  170. package/templates/sveltekit/package.json +1 -1
  171. package/templates/sveltekit/src/app.html +1 -1
  172. package/templates/sveltekit/src/hooks.server.ts +11 -0
  173. package/templates/sveltekit/src/locales.ts +8 -0
  174. package/templates/sveltekit/src/params/locale.ts +5 -0
  175. package/templates/sveltekit/src/routes/+layout.server.ts +6 -1
  176. package/templates/sveltekit/src/routes/+layout.svelte +5 -0
  177. package/assets/skills/fimo-migration/references/inventory/coordinator.md +0 -40
  178. package/assets/skills/fimo-migration/references/inventory/locales/next-intl.md +0 -39
  179. package/assets/skills/fimo-migration/references/inventory/locales.md +0 -41
  180. package/assets/skills/fimo-migration/scripts/inventory/locales/next-intl.mjs +0 -459
  181. package/templates/nextjs/src/app/layout.tsx +0 -17
  182. /package/templates/nextjs/src/app/{page.tsx → (default)/page.tsx} +0 -0
  183. /package/templates/sveltekit/src/routes/{+page.svelte → [[locale=locale]]/+page.svelte} +0 -0
@@ -1,8 +1,11 @@
1
1
  # Scheduled Commands
2
2
 
3
- `fimo schedules` manages recurring commands for one project environment. It uses the current checkout environment by default, or the environment passed with `--env <name>`.
3
+ `fimo schedules` manages recurring commands for one project Branch. It uses the
4
+ current checkout Branch by default, or the Branch passed with `--branch <name>`.
5
+ The legacy `--env <name>` spelling remains a compatibility alias.
4
6
 
5
- The command starts in that environment's sandbox. Commands can still target another environment explicitly, for example with `fimo schemas list --env preview`.
7
+ The command starts in that Branch's sandbox. Commands can still target another
8
+ Branch explicitly, for example with `fimo schemas list --branch preview`.
6
9
 
7
10
  ## Commands
8
11
 
@@ -24,11 +27,11 @@ fimo schedules runs show <run-id>
24
27
  fimo schedules delete <schedule>
25
28
  ```
26
29
 
27
- `<schedule>` accepts a schedule ID or an exact schedule name. Name-based commands resolve the name in the active environment and then use the stable schedule ID.
30
+ `<schedule>` accepts a schedule ID or an exact schedule name. Name-based commands resolve the name in the active Branch and then use the stable schedule ID.
28
31
 
29
32
  ## Runtime model
30
33
 
31
- Scheduled commands run in the project's environment runtime, not on the user's machine. Fimo prepares the environment and executes the stored command from the project root.
34
+ Scheduled commands run in the project's Branch runtime, not on the user's machine. Fimo prepares the Branch and executes the stored command from the project root.
32
35
 
33
36
  `--do` can be any command that works with schedule runtime permissions, such as `fimo validate`, `pnpm test`, or a project script. The runtime can edit project content and publish or unpublish the project, but it cannot manage project access, secrets, schedules, or other project-level settings.
34
37
 
@@ -67,6 +70,6 @@ All schedule commands support the CLI's global `--json` mode. List, detail, and
67
70
 
68
71
  ## Notes
69
72
 
70
- - Every operation is scoped to the active environment unless `--env` is passed.
73
+ - Every operation is scoped to the active Branch unless `--branch` (or the legacy `--env` alias) is passed.
71
74
  - Pausing stops future cron runs. It does not delete history.
72
75
  - A failed or skipped manual run exits non-zero with its run ID and an exact `runs show` command for inspecting detail.
@@ -1,6 +1,6 @@
1
1
  # Reporting a problem to Fimo
2
2
 
3
- `fimo support report` sends a project-scoped problem to Fimo support. It automatically includes the project, current environment, and CLI version so support can start investigating without asking the user to repeat that context.
3
+ `fimo support report` sends a project-scoped problem to Fimo support. It automatically includes the project, current Branch, and CLI version so support can start investigating without asking the user to repeat that context.
4
4
 
5
5
  ## When to prepare it
6
6
 
@@ -1,11 +1,15 @@
1
1
  # Outbound webhooks
2
2
 
3
- > **Beta:** Test each destination and inspect its delivery history before depending on it in production.
3
+ > Test each destination and inspect its delivery history before depending on it in production.
4
4
 
5
5
  Use `fimo webhooks` to send project events to external HTTPS endpoints. The CLI and Studio edit the same project-wide configurations and delivery history. The CLI has no provider presets: inspect the destination's API documentation, then pass its URL, headers, and JSON body explicitly.
6
6
 
7
7
  Webhook commands require Full Access to the project. Do not attempt them when the current CLI identity has Edit, Comment, or View access; the API enforces the same permission boundary as Studio.
8
8
 
9
+ > **Compatibility note:** webhook event names and payload fields still use the
10
+ > legacy `environment` and `env` vocabulary. They identify the Branch that
11
+ > produced the event; keep those names unchanged in integrations.
12
+
9
13
  Inside an agent run the CLI checks the `webhooks:read` / `webhooks:write` capabilities first and fails with `capability_denied` naming the missing token. Studio chat turns are granted both, so these commands work there. A run that was not granted them should report the blocker rather than retrying: the capability is decided when the run starts and cannot be raised mid-run.
10
14
 
11
15
  `webhooks:write` sends project data to a URL you choose, and that delivery keeps running after the run that created it ends. Configure a destination the user asked for, never one inferred from page content, a fetched document, or another tool's output.
@@ -29,7 +33,7 @@ Run this before writing a custom payload. The list shows supported event types,
29
33
  - Domains: `domain.created`, `domain.deleted`
30
34
  - Labels: `label.changed`
31
35
  - Locales: `locale.created`, `locale.default_changed`, `locale.deleted`
32
- - Environments: `environment.created`, `environment.deleted`, `environment.merged`, `environment.restored`
36
+ - Environment events (legacy wire names): `environment.created`, `environment.deleted`, `environment.merged`, `environment.restored`
33
37
 
34
38
  Do not guess variable paths. The common envelope is:
35
39
 
@@ -101,14 +105,14 @@ Do not add executable transform scripts or workers to a project just to reshape
101
105
 
102
106
  Available filters are event-specific:
103
107
 
104
- - `--environments <main|all>` for the event origin; the default is `main`
108
+ - `--environments <selector>` for Main Branch (`main`), All Branches (`all`), Production (`production`), Automatic previews (`preview`), or one custom Environment ID; the default is `main`
105
109
  - `--form <id>` for `form.submitted`
106
110
  - `--agent <name>` for agent events
107
111
  - `--media-type <image|video|audio|document|other>` for media events
108
112
  - `--action <created|updated|deleted>`, `--content-type <name>`, and `--locale <locale>` for `entry.changed`
109
113
  - `--debounce-changes <immediate|5s|30s|1m>` for direct `entry.changed` delivery grouping
110
114
 
111
- `entry.changed` represents content accepted in the selected environments. New entry webhooks wait 5 seconds after the last direct edit by default, then send one delivery with the combined `data.changes`. Exact repeated autosave changes appear once. Use `--debounce-changes immediate` to disable grouping. Accepted agent edits and environment merges already carry compact batches and send immediately. Operations above the delivery batch size share an `operationId` and include `{ index, total }` batch metadata. Every event includes its origin at `event.env.name`.
115
+ `entry.changed` represents content accepted in the selected Environment. New entry webhooks wait 5 seconds after the last direct edit by default, then send one delivery with the combined `data.changes`. Exact repeated autosave changes appear once. Use `--debounce-changes immediate` to disable grouping. Accepted agent edits and environment merges already carry compact batches and send immediately. Operations above the delivery batch size share an `operationId` and include `{ index, total }` batch metadata. Every event includes scalar `environment` and `branch` context and keeps the legacy Branch value at `event.env.name`. Publish events always report Production on `main`.
112
116
 
113
117
  ## Inspect before depending on it
114
118
 
@@ -140,7 +144,7 @@ fimo webhooks update <webhook-id> --default-body
140
144
  fimo webhooks delete <webhook-id>
141
145
  ```
142
146
 
143
- Webhooks belong to the project, with up to 20 configurations per project. The same configuration is visible from every environment. Delivery listens to `main` by default. Use `--environments all` to include branch activity, or `--environments main` to return to main-only delivery.
147
+ Webhooks belong to the project, with up to 20 configurations per project. The same configuration is visible from every Environment. Delivery listens to the Main Branch by default. Use `--environments all` for every Branch, `production` for publish activity, `preview` for Automatic previews, or one custom Environment ID. Existing omitted, `main`, and `all` filters retain their original meaning.
144
148
 
145
149
  ## Verify Fimo signatures
146
150
 
@@ -14,6 +14,12 @@ Use this skill for code that consumes the version-locked `fimo` package in the c
14
14
 
15
15
  Use the project-installed CLI for local inspection, code generation, and validation (`pnpm exec fimo`, `npm exec fimo`, `yarn fimo`, or `bunx --no-install fimo`, matching the lockfile). If that runner tries to install packages even though dependencies already exist, invoke the local `node_modules/.bin/fimo` executable instead. Load the `fimo-cli` skill for remote operational workflows such as schema pushes, label writes, entry mutations, and deploys. If the skill is not already available locally, fetch it with `npx fimo@latest skills get fimo-cli`.
16
16
 
17
+ Fimo API values may be class-backed tracked objects, not plain JSON. Keep them
18
+ as-is on the server. Before passing them to a `'use client'` prop or a
19
+ plain-JSON consumer such as Markdown, RSS, or JSON-LD, use the generated
20
+ serializer and hydrate them in the client when the generated client requires
21
+ it. Load the framework reference for the exact boundary.
22
+
17
23
  ## Orient before writing
18
24
 
19
25
  1. Run the project-installed `fimo describe --json` in a linked project and read `data.framework.slug`, schemas, locales, and tree. If the project is not linked yet, inspect `package.json` and the app directory instead.
@@ -33,6 +39,11 @@ Framework routing:
33
39
  - Astro (`astro.config.*`, `src/pages/**/*.astro`) → `references/frameworks/astro.md`.
34
40
  - SvelteKit → `references/frameworks/sveltekit.md`.
35
41
  - Nuxt, Remix, Vue, or another hosting-only setup → `references/frameworks/hosting.md`. Do not invent an SDK adapter that the installed package does not export.
42
+ - No framework (static generator, plain HTML, a build script) → `references/frameworks/hosting.md` § `runtime`: leave `runtime.framework` unset.
43
+
44
+ For public-site performance or navigation work, also load the matching
45
+ `references/best-practices/astro.md`, `references/best-practices/sveltekit.md`,
46
+ or `references/best-practices/next.md` reference.
36
47
 
37
48
  When a project's framework version is uncertain, load
38
49
  `references/frameworks/compatibility.md`. Use the project's installed version
@@ -59,6 +70,7 @@ Each reference defines one package contract. Fetch it when the task reaches that
59
70
  - Media values, `<Image>`, `<StaticImage>` → `references/assets.md`
60
71
  - Static editable copy: `Label`, `t()`, providers, and server label readers → `references/labels.md`
61
72
  - Locale ownership and framework handoff → `references/locales.md`
73
+ - Upgrading a React Router app that imports `fimo/react-router/routes` → `references/migrations/react-router-route-ownership.md`
62
74
  - Astro connector and output/adapter contract → `references/frameworks/astro.md`
63
75
  - Framework detection, production routing, and hosting adapters → `references/frameworks/hosting.md`
64
76
  - Major visual work → `references/design.md`
@@ -0,0 +1,12 @@
1
+ import { FimoProviders } from 'fimo/react-router';
2
+ import { Outlet, useParams } from 'react-router';
3
+
4
+ export default function LocaleLayout() {
5
+ const { locale } = useParams();
6
+
7
+ return (
8
+ <FimoProviders locale={locale}>
9
+ <Outlet />
10
+ </FimoProviders>
11
+ );
12
+ }
@@ -1,11 +1,12 @@
1
1
  import type { RouteConfig } from '@react-router/dev/routes';
2
- import { index, route } from '@react-router/dev/routes';
3
- import { fimoRoutes } from 'fimo/react-router/routes';
2
+ import { layout, route } from '@react-router/dev/routes';
4
3
 
5
4
  const routes = [
6
- index('./pages/Index.tsx', { id: 'home' }),
7
- route('pricing', './pages/Pricing.tsx', { id: 'pricing' }),
8
- route('blog/:slug', './pages/BlogPost.tsx', { id: 'blog-post' }),
5
+ layout('./pages/LocaleLayout.tsx', [
6
+ route(':locale?', './pages/Index.tsx', { id: 'home' }),
7
+ route(':locale?/pricing', './pages/Pricing.tsx', { id: 'pricing' }),
8
+ route(':locale?/blog/:slug', './pages/BlogPost.tsx', { id: 'blog-post' }),
9
+ ]),
9
10
  ] satisfies RouteConfig;
10
11
 
11
- export default fimoRoutes(routes) satisfies RouteConfig;
12
+ export default routes;
@@ -0,0 +1,47 @@
1
+ # Astro website best practices
2
+
3
+ Load `references/frameworks/astro.md` first.
4
+
5
+ - Put the document shell, navigation, and shared metadata in a layout.
6
+ - Render the H1, primary copy, canonical, and crawlable links in the initial HTML.
7
+ - Pass tracked Fimo values intact to Fimo components; use `String(value)` only for attributes and URLs. Flattening removes Studio's edit target.
8
+ - Start independent Fimo reads with `Promise.all`; do not repeat page reads in children.
9
+ - Ship no client JavaScript for static content. Use `client:visible` or `client:idle` below the fold; reserve `client:load` for immediately required interaction.
10
+ - Use `server:defer` only for slow, secondary, or personalized UI, with a stable fallback. Keep primary content and metadata outside server islands.
11
+ - Prerender when rebuild freshness is acceptable; render on demand when edits must appear immediately.
12
+ - Give images dimensions; eagerly load only the likely LCP image.
13
+ - Return a real 404 for a missing slug. Build one canonical from the public origin and normalized route, never the preview host.
14
+
15
+ ## Consider incremental static builds
16
+
17
+ For Astro 7.2+ sites with many `getStaticPaths()` pages:
18
+
19
+ ```js
20
+ import { defineConfig } from 'astro/config';
21
+ import { fimo } from 'fimo/astro/config';
22
+
23
+ export default defineConfig({
24
+ integrations: [fimo()],
25
+ experimental: { incrementalBuild: true },
26
+ build: { concurrency: 1 },
27
+ });
28
+ ```
29
+
30
+ ```astro
31
+ export async function getStaticPaths() {
32
+ const { items } = await Story.list({ limit: 100 });
33
+ return items.map((story) => ({
34
+ params: { slug: String(story.slug) },
35
+ props: { story },
36
+ cacheKey: story.updatedAt,
37
+ }));
38
+ }
39
+ ```
40
+
41
+ - The `cacheKey` must change for every rendered data dependency, including shared labels, settings, and related entries. A slug is not an invalidation key.
42
+ - Persist `node_modules/.astro/` between builds. Use `astro build --force` after middleware changes or to ignore the cache.
43
+ - Keep build concurrency at `1`. Pages with server islands also need a stable `ASTRO_KEY`.
44
+
45
+ Verify production HTML, valid and missing slugs, canonical output, shipped scripts, API waterfalls, and image sizing. For incremental builds, prove one unchanged and one invalidated path.
46
+
47
+ Sources: [incremental builds](https://docs.astro.build/en/reference/experimental-flags/incremental-build/) and [server islands](https://docs.astro.build/en/guides/server-islands/).
@@ -0,0 +1,42 @@
1
+ # Next.js website best practices
2
+
3
+ Load `references/frameworks/next.md` and the matching router reference first. Instant Navigations apply only to Next 16.3+ App Router projects.
4
+
5
+ - Use Server Components by default and keep Client Components at interactive leaves.
6
+ - Keep root layouts cheap; put slow page-specific Fimo reads in the page or a nested component.
7
+ - Start independent reads together. Server Components should call generated Fimo modules directly, not application Route Handlers.
8
+ - Keep tracked Fimo values intact in Server Components. Use generated `serialize()`/`hydrate()` at JSON prop boundaries. Generated client hooks are already hydrated; pass their values directly to Fimo components.
9
+ - Render the H1, primary copy, canonical, and crawlable links in the server result. Do not repeat the read after hydration.
10
+ - Give images dimensions; prioritize only the likely LCP image.
11
+
12
+ ## Instant Navigations
13
+
14
+ ```ts
15
+ import type { NextConfig } from 'next';
16
+ import { withFimo } from 'fimo/next/config';
17
+
18
+ const nextConfig: NextConfig = {
19
+ cacheComponents: true,
20
+ partialPrefetching: true,
21
+ };
22
+
23
+ export default withFimo(nextConfig);
24
+ ```
25
+
26
+ Choose per blocking Fimo read:
27
+
28
+ - **Stream:** use `Suspense` for fresh or slow data. Prefer this when Studio edits must appear immediately.
29
+ - **Cache:** use `use cache` only with a publication-aware lifetime and tag invalidation.
30
+ - **Block:** set `instant = false` as low as possible when partial UI is misleading.
31
+
32
+ Keep default `<Link>` prefetching. Use `prefetch={true}` only for a few high-intent links; large lists can overload the content API. Prefetch rendering must be side-effect free.
33
+
34
+ Use `instant = true` to find blocking code, then verify with `next build` and `next start`; development does not prefetch. Inspect the shell and streams with Navigation Inspector.
35
+
36
+ - Call `notFound()` for a missing slug.
37
+ - Build one canonical from `metadataBase` and the normalized route, never the preview host.
38
+ - Avoid duplicate content reads between `generateMetadata` and the page.
39
+
40
+ Verify valid and missing slugs, canonical and initial HTML, shipped JavaScript, duplicate reads, image sizing, instant shell rendering, streaming, freshness, and bounded prefetching.
41
+
42
+ Sources: [Instant Navigations](https://nextjs.org/blog/next-16-3-instant-navigations), [`partialPrefetching`](https://github.com/vercel/next.js/blob/canary/docs/01-app/03-api-reference/05-config/01-next-config-js/partialPrefetching.mdx), and [`instant`](https://github.com/vercel/next.js/blob/canary/docs/01-app/03-api-reference/03-file-conventions/02-route-segment-config/instant.mdx).
@@ -0,0 +1,17 @@
1
+ # SvelteKit website best practices
2
+
3
+ Load `references/frameworks/sveltekit.md` first.
4
+
5
+ - Keep shared navigation, labels, and metadata in layouts; keep slow page data in the narrowest `+page.server.ts` or `+layout.server.ts`.
6
+ - Pass the request `event`. Serialize generated Fimo values at the load boundary and render them with Fimo components, which restore their Studio editing metadata. Do not flatten tracked values first.
7
+ - Start independent reads together. Use `await parent()` only for a real parent-data dependency.
8
+ - Await primary content. Stream only slow, non-essential promises; add a stable `{#await}` fallback, an error branch, and an early rejection handler when the promise does not use SvelteKit's `fetch`.
9
+ - Render the H1, primary copy, canonical, and crawlable links during SSR. Do not disable SSR or repeat the read after hydration.
10
+ - Keep browser JavaScript at interactive leaves.
11
+ - Use request-time loads when edits must appear immediately. Prerender or cache only when rebuild or invalidation behavior is explicit.
12
+ - Give images dimensions; eagerly load only the likely LCP image.
13
+ - Call `error(404, ...)` for a missing slug. Build one canonical from the configured public origin and normalized route, never the preview host.
14
+
15
+ Verify the production server response, valid and missing slugs, canonical output, streamed errors, shipped JavaScript, API waterfalls, and image sizing.
16
+
17
+ Source: [SvelteKit load and streaming](https://svelte.dev/docs/kit/load).
@@ -26,6 +26,11 @@ Marks: `bold`, `italic`, `underline`, `strike`, `code`, and `link`.
26
26
 
27
27
  Use semantic nodes instead of flattening long content into paragraphs. Render the returned value with the framework's `<RichText>` primitive so source metadata survives.
28
28
 
29
+ Richtext and other API values may carry class-backed tracking metadata. Values
30
+ rendered by server Fimo primitives can stay intact. Serialize them before a
31
+ plain-JSON consumer (Markdown, RSS, JSON-LD) or a client prop, then use the
32
+ generated client hydration helper where required.
33
+
29
34
  ## Entry payload
30
35
 
31
36
  CLI entry writes put every value, including the collection slug, under `data`:
@@ -56,12 +56,15 @@ Never declare `id`, `entryId`, `documentId`, `slug`, `locale`, `createdAt`, `upd
56
56
  | `richtext` | Tiptap JSONContent | formatted content |
57
57
  | `number` | number | quantities and ordering fields |
58
58
  | `boolean` | boolean | flags |
59
- | `date` | ISO date string | dates/timestamps |
59
+ | `date` | ISO date string | calendar days; loose about the form |
60
+ | `datetime` | ISO instant with offset | exact moments (`2026-08-13T09:30:00Z`) |
60
61
  | `media` | media object or array | images, video, files |
61
62
  | `json` | JSON | structured metadata |
62
63
  | `reference` | `{ "id": "..." }` or array | links to another schema |
63
64
  | `blocks` | ordered object array | nested/repeatable sections |
64
65
 
66
+ A `datetime` value must carry `Z` or `±HH:MM`; a bare day or a naive local time is rejected. Render it with `<DateTime>`, which keeps the whole instant in the `<time datetime>` attribute, and a `date` with `<Date>`. `unique` is not supported on `datetime`.
67
+
65
68
  An enum string uses `options`; its optional `default` must be one of them:
66
69
 
67
70
  ```json
@@ -73,7 +73,7 @@ const [settings, stories, labels] = await Promise.all([
73
73
  }
74
74
  ```
75
75
 
76
- The native surface is `Text`, `RichText`, `Image`, `StaticImage`, `Video`, `Date`, `Boolean`, and `Json` (component table: `references/ui.md`). Pass tracked values whole so Studio can resolve their source; use `String(value)` only for attributes and URLs.
76
+ The native surface is `Text`, `RichText`, `Image`, `StaticImage`, `Video`, `Date`, `DateTime`, `Boolean`, and `Json` (component table: `references/ui.md`). Pass tracked values whole so Studio can resolve their source; use `String(value)` only for attributes and URLs.
77
77
 
78
78
  ## Forms
79
79
 
@@ -107,11 +107,13 @@ export async function getStaticPaths() {
107
107
 
108
108
  ## Locales
109
109
 
110
- The application resolves the locale — route prefix, middleware, domain, `Astro.currentLocale`, cookie, or its i18n library — and passes it to content reads and `getLabels({ locale })`. When a server read omits `locale`, the Fimo API resolves the project default; do not hardcode a fallback locale in application code. Astro needs no Fimo locale provider. Ownership rules: `references/locales.md`.
110
+ Configure Astro i18n from `.fimo/config.json#i18n` and use `Astro.currentLocale` for content reads, `getLabels({ locale })`, and `<html lang>`. The standard starter keeps the configured default locale unprefixed and prefixes the others. Existing applications may instead resolve locale through middleware, domains, cookies, or another application-owned strategy. Astro needs no Fimo locale provider. Ownership rules: `references/locales.md`.
111
+
112
+ The new-project shell pairs unprefixed default-locale pages with a parallel `[locale]` tree because Astro has no optional single-segment page filename. Add locales in `.fimo/config.json`; Astro's native i18n router validates the prefixed tree. Route metadata uses `/:locale` with `params.locale.optional: true`; Astro page files remain authoritative.
111
113
 
112
114
  ## Studio route catalog
113
115
 
114
- `.fimo/config.json#routes` is an optional catalog of pages for Studio navigation, not router configuration. Never replace or infer Astro's route files, redirects, middleware, or 404 behavior from it. Keep paths canonical and unlocalized, and describe dynamic segments with `params` so Studio can list entries:
116
+ `.fimo/config.json#routes` is an optional catalog of pages for Studio navigation, not router configuration. Never replace or infer Astro's route files, redirects, middleware, or 404 behavior from it. Keep routes without locale ownership canonical and unlocalized. For a locale-aware route, declare the reserved `/:locale` segment and mark it optional in `params`; describe other dynamic segments with `params` so Studio can list entries:
115
117
 
116
118
  ```json
117
119
  {
@@ -4,14 +4,19 @@
4
4
  peer ranges and the executable acceptance fixtures define compatibility; the
5
5
  profile does not promise support for every version of the framework.
6
6
 
7
- | Profile | Application dependency specifier | Fimo surface |
8
- | ------------------------ | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
9
- | `nextjs` | Next 16 is the current acceptance baseline; Fimo's React peer is `^18.2.0 \|\| ^19.0.0` and Next imposes its own React range | `fimo/next`, `fimo/next/client` |
10
- | `react-router` | React `^18.2.0 \|\| ^19.0.0`, React Router `^7.0.0 \|\| ^8.0.0`, Vite `^7.0.0 \|\| ^8.0.0` | `fimo/react-router`, `fimo/ui` |
11
- | `vite` | React `^18.2.0 \|\| ^19.0.0`, Vite `^7.0.0 \|\| ^8.0.0` | `fimo/ui`, `fimo/vite` |
12
- | `astro` | Astro `^5.0.0 \|\| ^6.0.0 \|\| ^7.0.0` | `fimo/astro`, `fimo/astro/components` |
13
- | `sveltekit` | SvelteKit `^2.0.0`, Svelte `^5.0.0`, Vite `^7.0.0 \|\| ^8.0.0` | `fimo/sveltekit`, `fimo/sveltekit/components`, `fimo/sveltekit/config`, `fimo/sveltekit/vite` |
14
- | `nuxtjs`, `remix`, `vue` | Hosting detection only; no Fimo content/runtime adapter yet | `fimo` hosting profile only |
7
+ | Profile | Application dependency specifier | Fimo surface |
8
+ | ------------------------ | -------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
9
+ | `nextjs` | Next 16 is the current acceptance baseline; Fimo's React peer is `^18.2.0 \|\| ^19.0.0` and Next imposes its own React range | `fimo/next`, `fimo/next/client` |
10
+ | `react-router` | React `^18.2.0 \|\| ^19.0.0`, React Router `^7.0.0 \|\| ^8.0.0`, Vite `^7.0.0 \|\| ^8.0.0` | `fimo/react-router`, `fimo/ui` |
11
+ | `vite` | React `^18.2.0 \|\| ^19.0.0`, Vite `^7.0.0 \|\| ^8.0.0` | `fimo/ui`, `fimo/vite` |
12
+ | `astro` | Astro `^5.0.0 \|\| ^6.0.0 \|\| ^7.0.0` | `fimo/astro`, `fimo/astro/components` |
13
+ | `sveltekit` | SvelteKit `^2.0.0`, Svelte `^5.0.0`, Vite `^7.0.0 \|\| ^8.0.0` | `fimo/sveltekit`, `fimo/sveltekit/components`, `fimo/sveltekit/config`, `fimo/sveltekit/vite` |
14
+ | `nuxtjs`, `remix`, `vue` | Hosting detection only; no Fimo content/runtime adapter yet | `fimo` hosting profile only |
15
+ | _(unset)_ | Anything else: a static generator, plain HTML, a custom build script. Declare `runtime.commands.build` and `runtime.outputDirectory` instead | Static output only; no adapter |
16
+
17
+ `runtime.framework` must match a dependency in `package.json`; a profile the
18
+ code does not use fails the production build. Shape and rules: `hosting.md`
19
+ § `runtime`.
15
20
 
16
21
  The exact versions used by acceptance fixtures are test baselines, not values
17
22
  to copy into an application. If a project falls outside a documented range,
@@ -4,20 +4,36 @@ Preserve the application's framework, router, routes, and 404 behavior. Fimo
4
4
  detects supported frameworks for preview and translates only the
5
5
  provider-neutral hosting settings the application explicitly owns.
6
6
 
7
- ## Production framework profile
7
+ ## `runtime`: how Fimo builds and serves the application
8
8
 
9
- Fimo detects conventional projects for preview. Before publishing, commit the
10
- matching profile in `.fimo/config.json`:
9
+ `.fimo/config.json#runtime` is the whole contract. Every key is optional:
11
10
 
12
11
  ```json
13
12
  {
14
- "runtime": { "framework": "nextjs" }
13
+ "runtime": {
14
+ "framework": "nextjs",
15
+ "commands": { "dev": "npm run dev", "build": "npm run build", "install": "npm ci" },
16
+ "outputDirectory": "dist"
17
+ }
15
18
  }
16
19
  ```
17
20
 
18
- Allowed values are `astro`, `nextjs`, `nuxtjs`, `react-router`, `remix`,
19
- `sveltekit`, `vite`, and `vue`. The field remains optional for legacy Fimo
20
- projects, which keep their existing static output contract.
21
+ | Key | Meaning | Resolution when unset |
22
+ | ----------------- | ------------------------------------------------------------------- | ----------------------------------------------------------- |
23
+ | `framework` | Production build profile. Must match a dependency in `package.json` | Preview detects; production uses the static-output profile |
24
+ | `commands.*` | The exact command for `dev`, `build`, `install` | Package script of the same name, then the framework default |
25
+ | `outputDirectory` | Folder the build command fills with the finished site | Framework default; `dist/client` (config v4) or `dist` |
26
+
27
+ `framework` values: `astro`, `nextjs`, `nuxtjs`, `react-router`, `remix`,
28
+ `sveltekit`, `vite`, `vue`. A value the code does not depend on fails the
29
+ production build. If none matches, leave it unset and set `commands.build` and
30
+ `outputDirectory`.
31
+
32
+ Keep `runtime` true to the code. Every `fimo init` shell writes its own
33
+ `framework`; after replacing the shell's code, re-check it. When you rename a
34
+ package script or move the build output, update `commands` and
35
+ `outputDirectory` in the same change. Do not add overrides a conventional
36
+ project does not need.
21
37
 
22
38
  Hosted preview and production inject the tenant API through these aliases:
23
39
 
@@ -33,9 +49,12 @@ Locally, the app derives its env from the **git branch**: `fimo/vite`,
33
49
  API URL from `.fimo/project.json`
34
50
  (`projectId` + `tenantApiBaseUrl`, recorded once at `init`/`clone`/`link`) and
35
51
  expose the Vite, Next and public (`PUBLIC_*`) aliases plus `FIMO_ENV` /
36
- `NEXT_PUBLIC_FIMO_ENV` at startup. No env file is written on a switch, so a plain `git checkout` is a
52
+ `NEXT_PUBLIC_FIMO_ENV` at startup. The Vite connectors derive them during both
53
+ dev and production builds, and `withFimo` derives them in `next dev`, `next
54
+ build`, and `next start`, so a linked project builds and serves locally without
55
+ exporting them by hand. No env file is written on a switch, so a plain `git checkout` is a
37
56
  complete env switch. Never hardcode a tenant URL in application source. One
38
- rule, per variable: a value the user set explicitly (`.env`, shell, their own
57
+ rule, per variable: a non-empty value the user set explicitly (`.env`, shell, their own
39
58
  `define`) is left alone, and Fimo fills the variables they did not set.
40
59
 
41
60
  For a framework whose alias is not in that list yet, preserve or add its normal
@@ -90,14 +109,3 @@ editing an Astro config.
90
109
  `.fimo/config.json#routes` is the Studio page catalog, not deployment routing.
91
110
  Never generate hosting rewrites from it. If a project already has a
92
111
  provider-specific deployment file, preserve it; that file remains authoritative.
93
-
94
- ## Non-standard commands
95
-
96
- Use `runtime.commands.dev|build|install` only when normal package scripts and
97
- framework defaults are insufficient. Do not add overrides to conventional
98
- projects.
99
-
100
- Vite defaults to `dist` and React Router defaults to `dist/client`. If an
101
- existing project deliberately emits somewhere else, preserve that choice with
102
- `runtime.outputDirectory`; do not rewrite the application's build merely to
103
- match a Fimo default.
@@ -76,6 +76,12 @@ This example demonstrates request-time rendering, not a recommended locale polic
76
76
 
77
77
  ## Client Components
78
78
 
79
+ When a Server Component passes Fimo content into a Client Component, it MUST
80
+ serialize with the generated server module and the Client Component MUST
81
+ hydrate with the matching generated `.client` module. Do not pass a raw Fimo
82
+ value merely because its enumerable fields look JSON-safe. No conversion is
83
+ needed while the value stays inside server rendering.
84
+
79
85
  Client Components use the generated `.client` module and `fimo/next/client`:
80
86
 
81
87
  ```tsx
@@ -33,6 +33,16 @@ When labels are not needed at that boundary, use `<FimoProvider locale={locale}>
33
33
  - Pages Router i18n: reuse `context.locale` in data functions and `router.locale`/page props on the client.
34
34
  - Default-only app: omit locale arguments and let Fimo use `.fimo/config.json#i18n.defaultLocale` (fallback `en`).
35
35
 
36
+ ## New-project boundary
37
+
38
+ Choose the primary locale from the user's request before building pages. Put the first explicitly requested locale in `.fimo/config.json#i18n.defaultLocale` and keep all requested locales in `i18n.locales`. That edit is the whole locale setup: `src/locales.ts` reads the file, so the default locale passed to `FimoProvider`, the `<html lang>` of each tree, and the set of prefixed URLs follow it. If the user gives no locale signal, keep `en` and state that choice. Never add `NEXT_PUBLIC_FIMO_DEFAULT_LOCALE` or `FIMO_DEFAULT_LOCALE`; the runtime ignores them by design.
39
+
40
+ The starter keeps default routes in an unprefixed `app/(default)` route group and a native `app/[locale]` tree for the other locales. Only a root layout may render `<html>`, so each tree owns its root layout and renders the shared `src/components/Document.tsx` with its locale: the unprefixed tree with `defaultLocale`, the prefixed tree with `params.locale`. The prefixed layout 404s a locale that is not in `prefixedLocales`, which is why the default locale has exactly one URL. For `/:locale/pricing`, `params.locale.optional: true` means omit the configured default locale: with `i18n.defaultLocale: "en"`, `/pricing` is English and `/fr/pricing` is French. With `optional: false`, both `/en/pricing` and `/fr/pricing` are prefixed. The default locale value chooses the fallback locale; `optional` independently controls URL prefixes. A route without `:locale` remains application-owned.
41
+
42
+ Next.js has no optional single-segment route folder, so mirror localized routes in both existing groups as the site grows. Astro uses the same paired native filesystem-tree shape for this semantic. Do not replace the trees with middleware, rewrites, an optional catch-all that captures the application route tree, or a Fimo route helper. The config route catalog describes the URL shapes for Studio; Next's `app` directory remains authoritative.
43
+
44
+ Keep the starter's client-only `src/components/FimoPreviewBridge.tsx` inside `Document`, so both trees mount it. It reads Next's native pathname/router, reports the settled locale to Studio, and lets Studio navigate through Next; do not move Next imports into Fimo's shared runtime.
45
+
36
46
  With `next-i18next`, keep its routing and translation provider for the strings it owns. Pass the same resolved locale to Fimo; do not replace the library or duplicate its route structure.
37
47
 
38
48
  Before creating non-default Fimo labels or content variants, confirm that those locales are enabled for the linked Fimo project. Load `fimo-cli` with its `locales` reference and run `fimo locales add <locale> --yes --json`; `.fimo/config.json` documents the application's locale policy, but `fimo validate` does not add project locales.
@@ -54,6 +64,6 @@ Fimo owns:
54
64
  - client content/label context after receiving the locale;
55
65
  - editable source metadata.
56
66
 
57
- Do not add `.fimo/config.json#routes` to a Next project yet. The current route-metadata validator expects React Router's `src/routes.ts`; a first-class Next Studio catalog and preview bridge are separate product work. Do not create a fake `src/routes.ts` to satisfy that check.
67
+ The new-project shell includes a small `.fimo/config.json#routes` catalog for Studio. It describes the page URLs but does not configure the App Router. Keep the `app` directory authoritative, and do not create a fake `src/routes.ts` or a universal Fimo route helper.
58
68
 
59
- Do not introduce `[locale]` segments, cookie routing, or domain routing unless the product request requires that URL strategy. Do not add a second locale provider when the existing one can supply the resolved locale to Fimo.
69
+ Do not introduce new locale middleware, cookie routing, or domain routing unless the product request requires that URL strategy. Do not add a second locale provider when the existing one can supply the resolved locale to Fimo.
@@ -82,6 +82,13 @@ Never write the registry by hand and never create alternate `*.schema.json` file
82
82
 
83
83
  ## Server and client boundaries
84
84
 
85
+ Next.js MUST receive generated serialized values across every Server-to-Client
86
+ Component prop boundary. Fimo values may be class-backed even when they look
87
+ JSON-shaped. Values that stay in Server Components may stay intact; values for
88
+ Client Components use the generated server `serialize()` and client
89
+ `hydrate()`. Plain-JSON outputs such as Markdown, RSS, and JSON-LD also use the
90
+ generated serialization rather than `JSON.stringify` as a conversion strategy.
91
+
85
92
  Forms follow the same boundary. Server actions and route handlers import the
86
93
  generated server form module; a Client Component imports its generated
87
94
  `.client.ts` module. Both expose `submitX(data)` and use the shared Fimo form
@@ -85,18 +85,24 @@ Keep the application's existing `Layout` details. Add only the Fimo provider and
85
85
 
86
86
  ## Routes and locales
87
87
 
88
- `fimoRoutes()` is an optional helper for Fimo's path-prefix locale convention:
88
+ React Router owns locale paths. Declare the optional locale segment directly so the default locale stays unprefixed:
89
89
 
90
90
  ```ts
91
91
  import type { RouteConfig } from '@react-router/dev/routes';
92
- import { index } from '@react-router/dev/routes';
93
- import { fimoRoutes } from 'fimo/react-router/routes';
94
-
95
- const routes = [index('./pages/Index.tsx', { id: 'home' })] satisfies RouteConfig;
96
- export default fimoRoutes(routes) satisfies RouteConfig;
92
+ import { layout, route } from '@react-router/dev/routes';
93
+
94
+ export default [
95
+ layout('./pages/LocaleLayout.tsx', [
96
+ route(':locale?', './pages/Index.tsx'),
97
+ route(':locale?/pricing', './pages/Pricing.tsx'),
98
+ route(':locale?/blog/:slug', './pages/BlogPost.tsx'),
99
+ ]),
100
+ ] satisfies RouteConfig;
97
101
  ```
98
102
 
99
- Custom locale routers can skip it and pass their resolved locale to `<FimoProviders locale={locale}>`. Use `FimoLink` only when the application adopts Fimo's locale-aware link behavior; otherwise preserve its links. Copyable path-prefix locale examples live in `assets/react-router-locales/`.
103
+ Read `locale` in an application layout and pass it to `<FimoProviders locale={locale}>`; omission resolves the configured default. Copy `assets/react-router-locales/routes.ts` and `LocaleLayout.tsx` for a complete boundary. For multilingual apps, move the root provider there instead of nesting providers. Preserve an existing locale library, and use `FimoLink` only when its locale-preserving behavior matches the app.
104
+
105
+ If an existing project imports `fimo/react-router/routes`, load `references/migrations/react-router-route-ownership.md` before changing it.
100
106
 
101
107
  ## Content and labels
102
108
 
@@ -122,6 +128,8 @@ Declare the runtime in `.fimo/config.json`:
122
128
 
123
129
  The optional `routes` object is Studio's semantic page catalog. Keep it aligned with application routes when the project uses Studio navigation, but do not treat it as the production router.
124
130
 
131
+ For new projects, apply `references/locales.md`, keep the starter's `:locale?` route, and describe it in Studio metadata as `/:locale` with `params.locale.optional: true`.
132
+
125
133
  ## Boundaries
126
134
 
127
135
  - Route modules and `meta` exports own routing and SEO.
@@ -74,24 +74,27 @@ do not import a Fimo environment variable or hardcode a tenant URL:
74
74
  // src/routes/+layout.server.ts
75
75
  import { getLabels } from 'fimo/sveltekit';
76
76
 
77
- export async function load(event) {
78
- // If the app resolves a locale from its URL or session, pass it:
79
- // const locale = resolveLocale(event.url); // your app's resolver
80
- // return { labels: await getLabels({ event, locale }) };
77
+ import { resolveLocale } from '../locales';
81
78
 
82
- // Otherwise, omit it and use the Fimo project default.
83
- return { labels: await getLabels({ event }) };
79
+ export async function load(event) {
80
+ const locale = resolveLocale(event.params);
81
+ return { locale, labels: await getLabels({ event, locale }) };
84
82
  }
85
83
  ```
86
84
 
87
85
  ```svelte
88
86
  <!-- src/routes/+layout.svelte -->
89
87
  <script lang="ts">
88
+ import { afterNavigate } from '$app/navigation';
90
89
  import { FimoProvider } from 'fimo/sveltekit/components';
91
90
  import type { LayoutData } from './$types';
92
91
  import type { Snippet } from 'svelte';
93
92
 
94
93
  let { data, children }: { data: LayoutData; children: Snippet } = $props();
94
+
95
+ afterNavigate(() => {
96
+ document.documentElement.lang = data.locale;
97
+ });
95
98
  </script>
96
99
 
97
100
  <FimoProvider labels={data.labels}>
@@ -101,7 +104,7 @@ export async function load(event) {
101
104
 
102
105
  Generated values are serialized at a `load` boundary and hydrated in the
103
106
  component that renders them. Use `Text`, `RichText`, `Image`, `Video`, `Date`,
104
- `Boolean`, `Json`, and `Number` from `fimo/sveltekit/components`. `Number`
107
+ `DateTime`, `Boolean`, `Json`, and `Number` from `fimo/sveltekit/components`. `Number`
105
108
  formats plain numeric values for display; numeric fields currently have no
106
109
  source metadata, so it is not a Studio-editable primitive.
107
110
 
@@ -128,7 +131,7 @@ export const actions = {
128
131
  `PUBLIC_FIMO_PREVIEW_SCRIPT_URL` from SvelteKit's dynamic public environment,
129
132
  loads that script once, delegates navigation to SvelteKit's `goto`, and
130
133
  refreshes data with `invalidateAll()`. Without that environment value it does
131
- nothing. Do not add a Fimo server hook or a second preview component.
134
+ nothing. Do not add a second preview component.
132
135
 
133
136
  ## Boundaries
134
137
 
@@ -136,3 +139,7 @@ nothing. Do not add a Fimo server hook or a second preview component.
136
139
  - `fimo/sveltekit/vite` owns dev source tagging only.
137
140
  - `FimoProvider` owns labels and the optional Studio preview bridge.
138
141
  - Do not add React, React Query, or a Vite SPA fallback to a SvelteKit project.
142
+
143
+ The starter uses SvelteKit's native `[[locale=locale]]` boundary and a matcher limited to configured, non-default locales, so unrelated top-level paths are not locales. `src/locales.ts` derives the default and prefixed set from `.fimo/config.json` and owns the shared locale resolver. Keep passing the tracked `event.params` object into that resolver from the root server layout so locale-crossing client navigation reruns labels.
144
+
145
+ For accessibility, SvelteKit's documented multilingual pattern renders `<html lang="%lang%">` through `src/hooks.server.ts#transformPageChunk`. The root layout updates the attribute after client navigation. Keep those seams aligned with the application's locale resolver. Keep `[[locale=locale]]` for an unprefixed default; use `[locale=locale]` only when every locale must be prefixed.