fimo 2.11.0-staging.2 → 2.11.0-staging.3
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.
- package/assets/skills/fimo-cli/references/content.md +1 -0
- package/assets/skills/fimo-cli/references/media.md +9 -1
- package/assets/skills/fimo-code/references/best-practices/next.md +1 -1
- package/assets/skills/fimo-code/references/content/schema.md +5 -1
- package/assets/skills/fimo-code/references/forms.md +2 -3
- package/assets/skills/fimo-code/references/frameworks/next/app-router.md +4 -1
- package/assets/skills/fimo-code/references/frameworks/next/pages-router.md +2 -0
- package/assets/skills/fimo-code/references/frameworks/next/seo.md +2 -2
- package/assets/skills/fimo-code/references/frameworks/next.md +3 -1
- package/assets/skills/fimo-code/references/frameworks/react-router.md +1 -1
- package/assets/skills/fimo-code/references/frameworks/seo-head.md +1 -0
- package/assets/skills/fimo-code/references/frameworks/sveltekit.md +3 -1
- package/assets/skills/fimo-code/references/frameworks/vite-react.md +1 -1
- package/dist/cli/bundle.json +1 -1
- package/dist/cli/index.js +6 -6
- package/dist/scripts/sync-schemas.js +1 -0
- package/dist/scripts/validate-schemas.js +8 -1
- package/package.json +9 -9
- package/templates/astro/package.json +3 -3
- package/templates/nextjs/package.json +4 -4
- package/templates/nextjs/src/app/globals.css +1 -7
- package/templates/react-router/package.json +5 -5
- package/templates/react-router/src/index.css +1 -8
- package/templates/sveltekit/package.json +3 -3
- package/templates/vite/package.json +5 -5
- package/templates/vite/src/index.css +1 -7
|
@@ -30,6 +30,7 @@ fimo singles get <Type> [--locale es]
|
|
|
30
30
|
fimo singles update <Type> [--locale es] (--body '<json>' | --file <path> | --stdin)
|
|
31
31
|
```
|
|
32
32
|
|
|
33
|
+
- Before you write content of a type, read `fimo schemas get <Type>`. The `description` of the schema and of each field are the rules for that content: make what you write meet them.
|
|
33
34
|
- `--body` is always a `{"data":{...}}` envelope, also for `singles update`. Put `slug` inside `data`.
|
|
34
35
|
- `entries create` and `entries update` require exactly one of `--body '<json>'`, `--file <path>`, or `--stdin`. Files and stdin use the same `{"data":{...}}` envelope.
|
|
35
36
|
- Before you write a body, load fimo-code `content/richtext`. Rich text is Tiptap JSON (`{"type":"doc","content":[...]}`), a reference is `{"id":"<id>"}`, and media has its own shape.
|
|
@@ -69,7 +69,15 @@ fimo image edit \
|
|
|
69
69
|
--aspect-ratio 16:9
|
|
70
70
|
```
|
|
71
71
|
|
|
72
|
-
Repeat `--images` to provide up to five references.
|
|
72
|
+
Repeat `--images` to provide up to five references. To make a new image that matches the ones a content field already holds, pass two or three of them and say what to draw:
|
|
73
|
+
|
|
74
|
+
```bash
|
|
75
|
+
fimo image edit \
|
|
76
|
+
--prompt "a new cover in exactly the style of these images: a lighthouse at night" \
|
|
77
|
+
--images <asset-id-or-url> \
|
|
78
|
+
--images <asset-id-or-url> \
|
|
79
|
+
--aspect-ratio 16:9
|
|
80
|
+
```
|
|
73
81
|
|
|
74
82
|
### Remove a background
|
|
75
83
|
|
|
@@ -12,8 +12,8 @@ Load `references/frameworks/next.md` and the matching router reference first. In
|
|
|
12
12
|
## Instant Navigations
|
|
13
13
|
|
|
14
14
|
```ts
|
|
15
|
-
import type { NextConfig } from 'next';
|
|
16
15
|
import { withFimo } from 'fimo-next/config';
|
|
16
|
+
import type { NextConfig } from 'next';
|
|
17
17
|
|
|
18
18
|
const nextConfig: NextConfig = {
|
|
19
19
|
cacheComponents: true,
|
|
@@ -36,6 +36,10 @@ Design schemas around what content editors need to see and change in Fimo Studio
|
|
|
36
36
|
|
|
37
37
|
Keep routing, layout, computed values, and external system data in code. Load `fimo-cli/references/content.md` for the Single and collection write workflows.
|
|
38
38
|
|
|
39
|
+
## Rules for this content
|
|
40
|
+
|
|
41
|
+
Use `description`, at the root for the whole type or on a field, to say what good content looks like. Fimo agents follow it when they write or generate that content, and Studio shows it to editors. A site-wide rule belongs in the project knowledge.
|
|
42
|
+
|
|
39
43
|
## Group fields in Studio
|
|
40
44
|
|
|
41
45
|
Use optional top-level `groups` when an entry has meaningful editing areas, such as Overview, Tickets, SEO, or Scheduling. They work best for longer forms where editors regularly work on one area at a time. Usually skip groups for short forms, one-field groups, or vague buckets such as General and Other. Prefer two to five groups organized around editor tasks. This is guidance, not a schema limit.
|
|
@@ -155,7 +159,7 @@ Use `targets: ["Post", "Video"]` instead of `target` only for genuinely polymorp
|
|
|
155
159
|
|
|
156
160
|
After writing or changing `src/schemas/<Uid>.json`, run `fimo schemas push <Uid>` before building against that schema. The push validates the JSON, generates its public clients, and updates the linked environment.
|
|
157
161
|
|
|
158
|
-
- Optional additions and label changes preserve entries.
|
|
162
|
+
- Optional additions and label or `description` changes preserve entries.
|
|
159
163
|
- Required additions need a valid default when existing objects require backfill.
|
|
160
164
|
- Removing a field or block variant removes only that value.
|
|
161
165
|
- String/text changes and safe primitive conversions preserve values.
|
|
@@ -47,9 +47,7 @@ After `fimo forms push` and the next validation/build, `src/forms/{name}.ts` exi
|
|
|
47
47
|
|
|
48
48
|
```ts
|
|
49
49
|
export const FORM_ID = '<uuid>';
|
|
50
|
-
export const ContactUsSchema = z.object({
|
|
51
|
-
/* fields */
|
|
52
|
-
});
|
|
50
|
+
export const ContactUsSchema = z.object({/* fields */});
|
|
53
51
|
export type ContactUsData = z.infer<typeof ContactUsSchema>;
|
|
54
52
|
export function parseContactUsFormData(formData: FormData): ContactUsData;
|
|
55
53
|
export function submitContactUs(
|
|
@@ -72,6 +70,7 @@ Always import the generated module. Keep the native form and pending/error state
|
|
|
72
70
|
|
|
73
71
|
```tsx
|
|
74
72
|
import { useState } from 'react';
|
|
73
|
+
|
|
75
74
|
import { ContactUsSchema, parseContactUsFormData, submitContactUs } from '@/forms/contact-us';
|
|
76
75
|
import type { ContactUsData } from '@/forms/contact-us';
|
|
77
76
|
|
|
@@ -31,6 +31,7 @@ Server Components may read generated clients directly. Omit `locale` to use the
|
|
|
31
31
|
|
|
32
32
|
```tsx
|
|
33
33
|
import { createFimo, RichText, Text } from 'fimo-next';
|
|
34
|
+
|
|
34
35
|
import { content } from '@/schemas';
|
|
35
36
|
|
|
36
37
|
export const revalidate = 60;
|
|
@@ -57,8 +58,9 @@ Static builds read Fimo through the same server connection (linked project + bra
|
|
|
57
58
|
Use normal Next request APIs and pass the resulting locale/query values to Fimo:
|
|
58
59
|
|
|
59
60
|
```tsx
|
|
60
|
-
import { headers } from 'next/headers';
|
|
61
61
|
import { createFimo, Text } from 'fimo-next';
|
|
62
|
+
import { headers } from 'next/headers';
|
|
63
|
+
|
|
62
64
|
import { content } from '@/schemas';
|
|
63
65
|
|
|
64
66
|
export const dynamic = 'force-dynamic';
|
|
@@ -87,6 +89,7 @@ Client Components use the generated `.client` module and `fimo-next/client`:
|
|
|
87
89
|
'use client';
|
|
88
90
|
|
|
89
91
|
import { Text, useLabels } from 'fimo-next/client';
|
|
92
|
+
|
|
90
93
|
import * as Article from '@/schemas/Article.client';
|
|
91
94
|
|
|
92
95
|
export function FeaturedArticles() {
|
|
@@ -63,6 +63,7 @@ export default function Page({ article: serialized }: InferGetStaticPropsType<ty
|
|
|
63
63
|
```tsx
|
|
64
64
|
import { getLabels } from 'fimo-next';
|
|
65
65
|
import type { GetServerSideProps, InferGetServerSidePropsType } from 'next';
|
|
66
|
+
|
|
66
67
|
import * as Article from '@/schemas/Article';
|
|
67
68
|
import * as ArticleClient from '@/schemas/Article.client';
|
|
68
69
|
|
|
@@ -87,6 +88,7 @@ Interactive components import hooks and primitives from the client surfaces:
|
|
|
87
88
|
|
|
88
89
|
```tsx
|
|
89
90
|
import { Text, useLabels } from 'fimo-next/client';
|
|
91
|
+
|
|
90
92
|
import * as Article from '@/schemas/Article.client';
|
|
91
93
|
|
|
92
94
|
export function SearchResults() {
|
|
@@ -6,8 +6,8 @@ rendering mode. Fimo supplies editable values, not a router or a merge policy.
|
|
|
6
6
|
## Read, resolve, convert
|
|
7
7
|
|
|
8
8
|
```ts
|
|
9
|
-
import { getFimoSeo } from 'fimo/seo/server';
|
|
10
9
|
import { toNextMetadata, toNextViewport } from 'fimo-next/seo';
|
|
10
|
+
import { getFimoSeo } from 'fimo/seo/server';
|
|
11
11
|
|
|
12
12
|
// Root layout: global defaults, never implicitly Home.
|
|
13
13
|
export const generateMetadata = () => toNextMetadata(getFimoSeo());
|
|
@@ -60,8 +60,8 @@ For bundled data or Edge, supply config yourself to the pure resolver instead
|
|
|
60
60
|
of importing the Node reader:
|
|
61
61
|
|
|
62
62
|
```ts
|
|
63
|
-
import { resolveSeoForPath } from 'fimo/seo';
|
|
64
63
|
import { toNextMetadata } from 'fimo-next/seo';
|
|
64
|
+
import { resolveSeoForPath } from 'fimo/seo';
|
|
65
65
|
|
|
66
66
|
const seo = resolveSeoForPath(pathname, publicSeoConfig, { article });
|
|
67
67
|
const metadata = toNextMetadata(seo);
|
|
@@ -50,8 +50,8 @@ Keep the generated `FimoProvider` and `withFimo` integration to render Fimo
|
|
|
50
50
|
Preview in Fimo Studio and enable Edit Mode. Wrap the existing Next config once:
|
|
51
51
|
|
|
52
52
|
```ts
|
|
53
|
-
import type { NextConfig } from 'next';
|
|
54
53
|
import { withFimo } from 'fimo-next/config';
|
|
54
|
+
import type { NextConfig } from 'next';
|
|
55
55
|
|
|
56
56
|
const nextConfig: NextConfig = {};
|
|
57
57
|
export default withFimo(nextConfig);
|
|
@@ -124,6 +124,7 @@ Server Components, route handlers, `getStaticProps`, and `getServerSideProps` im
|
|
|
124
124
|
|
|
125
125
|
```ts
|
|
126
126
|
import { createFimo, getLabels, Text } from 'fimo-next';
|
|
127
|
+
|
|
127
128
|
import { content } from '@/schemas';
|
|
128
129
|
|
|
129
130
|
const fimo = createFimo({ content, locale });
|
|
@@ -139,6 +140,7 @@ Client Components import from `fimo-next/client` and generated `.client` modules
|
|
|
139
140
|
'use client';
|
|
140
141
|
|
|
141
142
|
import { Text, useLabels } from 'fimo-next/client';
|
|
143
|
+
|
|
142
144
|
import * as Article from '@/schemas/Article.client';
|
|
143
145
|
|
|
144
146
|
export function ArticleList() {
|
|
@@ -21,8 +21,8 @@ Keep the project's React Router Vite plugin explicit:
|
|
|
21
21
|
|
|
22
22
|
```ts
|
|
23
23
|
import { reactRouter } from '@react-router/dev/vite';
|
|
24
|
-
import { defineConfig } from 'vite';
|
|
25
24
|
import { fimo } from 'fimo-react-router/vite';
|
|
25
|
+
import { defineConfig } from 'vite';
|
|
26
26
|
|
|
27
27
|
export default defineConfig({
|
|
28
28
|
plugins: [reactRouter(), fimo({ sitemap: true })],
|
|
@@ -6,6 +6,7 @@ sets framework caching. Use the installed package's exports.
|
|
|
6
6
|
|
|
7
7
|
```ts
|
|
8
8
|
import { resolveSeoForPath, toSeoHead, type FimoSEO } from 'fimo/seo';
|
|
9
|
+
|
|
9
10
|
import config from '../../.fimo/config.json'; // adjust to the actual file
|
|
10
11
|
|
|
11
12
|
const resolved = resolveSeoForPath(pathname, config, { article });
|
|
@@ -59,6 +59,7 @@ SvelteKit's request-aware `fetch`:
|
|
|
59
59
|
```ts
|
|
60
60
|
// src/routes/articles/+page.server.ts
|
|
61
61
|
import { createFimo } from 'fimo-sveltekit';
|
|
62
|
+
|
|
62
63
|
import { content } from '../../../schemas';
|
|
63
64
|
|
|
64
65
|
export async function load(event) {
|
|
@@ -122,6 +123,7 @@ overrides, and returns its complete `seoHead` using `toSeoHead`.
|
|
|
122
123
|
```ts
|
|
123
124
|
// src/routes/+layout.server.ts, or a content page's +page.server.ts
|
|
124
125
|
import { resolveSeoForPath, toSeoHead } from 'fimo/seo';
|
|
126
|
+
|
|
125
127
|
import config from '../../.fimo/config.json';
|
|
126
128
|
|
|
127
129
|
export function load({ url }) {
|
|
@@ -176,8 +178,8 @@ Use a `+page.server` action so SvelteKit owns the request and redirect. Pass its
|
|
|
176
178
|
event to `createFimoFormClient` and use the generated parser/helper:
|
|
177
179
|
|
|
178
180
|
```ts
|
|
179
|
-
import { createFimoFormClient } from 'fimo-sveltekit';
|
|
180
181
|
import { parseContactUsFormData, submitContactUs } from '$lib/forms/contact-us';
|
|
182
|
+
import { createFimoFormClient } from 'fimo-sveltekit';
|
|
181
183
|
|
|
182
184
|
export const actions = {
|
|
183
185
|
default: async (event) => {
|
|
@@ -13,8 +13,8 @@ Add Fimo's Vite plugins without replacing the application's existing plugins:
|
|
|
13
13
|
|
|
14
14
|
```ts
|
|
15
15
|
import react from '@vitejs/plugin-react';
|
|
16
|
-
import { defineConfig } from 'vite';
|
|
17
16
|
import { fimo } from 'fimo-react-router/vite';
|
|
17
|
+
import { defineConfig } from 'vite';
|
|
18
18
|
|
|
19
19
|
export default defineConfig({
|
|
20
20
|
plugins: [react(), ...fimo({ seo: true })],
|