fimo 2.2.0-staging.8 → 2.2.0

package/templates/welcome/template/src/pages/fallback-content.ts

@@ -0,0 +1,152 @@
+import type { HomePage } from '@/schemas/HomePage';
+
+import type { TutorialArticle } from './SiteContent';
+
+// Generated from the starter seed (../../manifest.json): the loading
+// fallback renders the real TutorialPage with this data so the live CMS
+// values swap in without any visible change. Regenerate when the seed
+// copy changes — a drifted fallback flashes different text on load.
+// Rich-text values carry { content: <tiptap doc> } like FimoRichText;
+// the missing source symbol simply disables inline editing until the
+// live values arrive.
+
+export const FALLBACK_PAGE = {
+  title: 'Welcome to the Fimo onboarding!',
+  intro: {
+    content: {
+      type: 'doc',
+      content: [
+        {
+          type: 'paragraph',
+          content: [
+            {
+              type: 'text',
+              text: 'This is a tutorial project, made for you to practice.',
+            },
+            { type: 'hardBreak' },
+            {
+              type: 'text',
+              text: 'Four actions, five minutes, and nothing you change here can break anything.',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  startLabel: 'Start the 5-minute tour',
+  tourTitle: 'Try the essentials in five minutes',
+  tourIntro: 'Follow these steps in order. Every change is safe to make in this tutorial project.',
+  steps: [
+    {
+      _key: 'fallback-step-1',
+      number: '1',
+      title: 'Edit this page',
+      body: 'Edit mode lets you change text and images directly on the website.\n- Select the big title and replace it with “Welcome, [your name]”.',
+      actionLabel: 'Activate Edit mode',
+      action: 'toggleEditMode',
+    },
+    {
+      _key: 'fallback-step-2',
+      number: '2',
+      title: 'Open the CMS',
+      body: 'The website content also lives in the CMS, as structured data.\n- Change “Title” and watch the site update.',
+      actionLabel: 'Jump to the Home page',
+      action: 'openHomePage',
+    },
+    {
+      _key: 'fallback-step-3',
+      number: '3',
+      title: 'Explore branches',
+      body: 'Branches let people and agents work without touching the live site.\n- Create “tutorial/first-change” from the branch menu and change the page title there.',
+      actionLabel: 'Show the branch menu',
+      action: 'openBranches',
+    },
+    {
+      _key: 'fallback-step-4',
+      number: '4',
+      title: 'Meet your agent',
+      body: 'Your agent maintains this website on a schedule.\n- Open its latest run, read the report, and accept the proposed change.',
+      actionLabel: 'Meet your first agent',
+      action: 'openAgents',
+    },
+  ],
+  articlesTitle: 'Continue learning in the CMS',
+  articlesIntro:
+    'These are real entries in the Articles collection. Open Content to edit their titles, summaries, bodies, and cover images.',
+  migrationTitle: 'Migrate my existing website',
+  migrationBody: {
+    content: {
+      type: 'doc',
+      content: [
+        {
+          type: 'paragraph',
+          content: [
+            {
+              type: 'text',
+              text: 'Open your existing local project with Codex, Claude Code, Cursor, or another coding agent. Copy the prompt below so the agent connects the website you already trust to Fimo, with a recoverable backup first.',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  migrationPrompt:
+    'Before changing anything, create a recoverable backup of this website. If it uses Git, create a branch and commit the current state. If it does not use Git, duplicate the entire project folder and confirm the copy opens. Then inspect the existing codebase and migrate this website to Fimo in place. Preserve every route, visible piece of content, media asset, form, SEO field, redirect, and locale. Connect the existing implementation to Fimo rather than generating a new empty site. Report any item you cannot migrate safely before changing it.',
+  buildTitle: 'Create my website',
+  buildBody: {
+    content: {
+      type: 'doc',
+      content: [
+        {
+          type: 'paragraph',
+          content: [
+            {
+              type: 'text',
+              text: 'Use your Codex, Claude Code, Cursor, or other coding-agent subscription to design and build the first version in a local repository. Connect it to Fimo when the foundation is ready. Fimo starts where the first build ends: content, visual editing, environments, agents, and hosting.',
+            },
+          ],
+        },
+      ],
+    },
+  },
+  closingTitle: 'Fimo keeps finished websites autonomous',
+  closingBody:
+    'Fimo Credits are designed for the agents that maintain your website and for teammates who use Studio chat without a local coding tool.',
+  footerNote: 'This tutorial website is looked after by your Fimo agent.',
+} as unknown as HomePage;
+
+// Covers are omitted: the card's image box keeps its own aspect ratio, so
+// the live images arrive without shifting the layout.
+// The author and category shapes mirror a populated read: the cards render
+// them during the loading window too, so a fallback without them would
+// crash the very first paint.
+// Ordered the way the live read returns them (newest entry first), not the
+// way the manifest seeds them: the fallback exists to be replaced without a
+// visible change, and a different order is a visible change.
+export const FALLBACK_ARTICLES = [
+  {
+    id: 'fallback-article-1',
+    slug: 'discover-the-analytics',
+    title: 'Discover the analytics',
+    summary: 'What your traffic numbers mean, and how an agent can use them to improve your pages every week.',
+    author: { name: 'Fimo Product', role: 'Product team' },
+    category: { name: 'Automation' },
+  },
+  {
+    id: 'fallback-article-2',
+    slug: 'branches-and-environments',
+    title: 'How branches and environments work',
+    summary: 'What a branch is, why it keeps your live site safe, and how changes come back together.',
+    author: { name: 'Fimo Engineering', role: 'Engineering team' },
+    category: { name: 'Concepts' },
+  },
+  {
+    id: 'fallback-article-3',
+    slug: 'create-your-first-agent',
+    title: 'Create your first agent',
+    summary:
+      'Build a weekly SEO agent with one prompt: full audit, safe fixes applied to the CMS, and a report you can trust.',
+    author: { name: 'Fimo Engineering', role: 'Engineering team' },
+    category: { name: 'Automation' },
+  },
+] as unknown as TutorialArticle[];

package/templates/welcome/template/src/routes.ts

@@ -0,0 +1,9 @@
+import type { RouteConfig } from '@react-router/dev/routes';
+import { layout, route } from '@react-router/dev/routes';
+
+export default [
+  layout('./pages/LocaleLayout.tsx', [
+    route(':locale?', './pages/Index.tsx', { id: 'home' }),
+    route(':locale?/articles/:slug', './pages/ArticleDetail.tsx', { id: 'article' }),
+  ]),
+] satisfies RouteConfig;

package/templates/welcome/template/src/schemas/Article.json

@@ -0,0 +1,34 @@
+{
+  "uid": "Article",
+  "name": "Articles",
+  "isSingleton": false,
+  "i18n": {
+    "enabled": false
+  },
+  "fields": {
+    "title": {
+      "type": "string",
+      "required": true
+    },
+    "summary": {
+      "type": "text",
+      "required": true
+    },
+    "body": {
+      "type": "richtext",
+      "required": true
+    },
+    "cover": {
+      "type": "media",
+      "required": true
+    },
+    "author": {
+      "type": "reference",
+      "target": "Author"
+    },
+    "category": {
+      "type": "reference",
+      "target": "Category"
+    }
+  }
+}

package/templates/welcome/template/src/schemas/Article.ts

@@ -0,0 +1,54 @@
+// AUTO-GENERATED by `fimo` from src/schemas/Article.json - DO NOT EDIT.
+// Change content fields in the schema, then run `fimo validate`.
+// Runtime implementation lives in the project-local fimo-react package export.
+import { createContentClient } from "fimo-react";
+import type { CollectionContentClient } from "fimo-react";
+import type { ContentSchema } from "fimo-react";
+
+import schema from "./Article.json";
+import * as Author from "./Author";
+import * as Category from "./Category";
+import type { Article, ArticleFields, ArticleInput, ArticlePopulate, ArticleQuery } from "./Article.types";
+
+export type { Article, ArticleFields, ArticleFimoMeta, ArticleInput, ArticlePopulate, ArticleQuery, ArticleReferences, ArticleResult, ArticleSort, ArticleWhere } from "./Article.types";
+export type { CollectionPage, CollectionPageInfo, InfiniteListResult } from "fimo-react";
+export type InfiniteListQuery<
+  TFields extends ArticleFields | undefined = undefined,
+  TPopulate extends ArticlePopulate | undefined = undefined,
+> = Omit<ArticleQuery<TFields, TPopulate>, "offset">;
+
+const client: CollectionContentClient<Article, ArticleInput> = createContentClient<
+  Article,
+  ArticleInput
+>({
+  schema: schema as unknown as ContentSchema,
+  references: { Author, Category },
+});
+
+export const {
+  wrapWithSource,
+  meta,
+  getById,
+  getBySlug,
+  getByField,
+  list,
+  get,
+  create,
+  update,
+  remove,
+  useGetById,
+  useGetBySlug,
+  useGetByField,
+  useList,
+  useInfiniteList,
+  useGet,
+  useSuspenseGetById,
+  useSuspenseGet,
+  useSuspenseGetByField,
+  useSuspenseGetBySlug,
+  useCreate,
+  useUpdate,
+  useRemove,
+} = client;
+
+export default client;

package/templates/welcome/template/src/schemas/Article.types.ts

@@ -0,0 +1,93 @@
+// AUTO-GENERATED ⚠️ – do not edit by hand
+import { type Fields, type FimoMedia, type FimoReference, type FimoRichText, type FimoRichTextContent, type FimoString, type Populate, type PopulatedResult, type ProjectedWithPopulate, type Query, type Sort, type Where, type WithReferences } from "fimo-react";
+import type { Author } from "./Author.types";
+import type { Category } from "./Category.types";
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  📄  Type definitions  ────────────             */
+/*───────────────────────────────────────────────────────────────*/
+
+/**
+ * What a media field stores: a reference to a media-library asset. Point at the
+ * asset by `id`, or by the `url` an upload returned and Fimo resolves the `id`
+ * for you. `alt` belongs to the entry, so it survives replacing the asset. The
+ * facts the asset owns are never copied in, so they cannot go stale.
+ */
+export type FimoMediaRef = ({ id: string; url?: string } | { id?: string; url: string }) & {
+  alt?: string;
+  source?: "local" | "external";
+};
+
+/**
+ * What a read returns for a media field it named in `populate`: the reference
+ * plus the facts the asset owns as of that read. `name`, `mime`, `width`, and
+ * `height` remain optional when the asset is external, missing, or incomplete.
+ * A read that did not name the field returns `FimoMedia` with those facts absent.
+ */
+export type FimoPopulatedMedia = FimoMedia & { name?: string; mime?: string };
+
+/**
+ * Article entity interface
+ */
+export interface ArticleFimoMeta {
+  contentType: "Article";
+}
+
+export interface Article extends WithReferences<ArticleReferences> {
+  id: string;
+  entryId: string;
+  documentId: string;
+  slug: FimoString;
+  locale: string;
+  createdAt: string;
+  updatedAt: string;
+  __fimo: ArticleFimoMeta;
+  title: FimoString;
+  summary: FimoString;
+  body: FimoRichText;
+  cover: FimoMedia;
+  author: FimoReference | null;
+  category: FimoReference | null;
+}
+
+export interface ArticleInput {
+  slug?: string;
+  documentId?: string;
+  title: string;
+  summary: string;
+  body: FimoRichTextContent;
+  cover: FimoMediaRef;
+  author?: FimoReference | null;
+  category?: FimoReference | null;
+}
+
+
+/**
+ * What each populatable field returns when a read names it in `populate`: a
+ * reference field resolves to its target entry, a media field to the asset's
+ * current facts, a blocks field to the same items with every media value
+ * inside them filled. Fields absent here are returned as stored.
+ */
+export interface ArticleReferences {
+  author: Author | null;
+  category: Category | null;
+  cover: FimoPopulatedMedia;
+}
+
+export type ArticlePopulate = Populate<Article>;
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  🔎  Query types  ────────────                  */
+/*───────────────────────────────────────────────────────────────*/
+
+export type ArticleWhere = Where<Article>;
+export type ArticleSort = Sort<Article>;
+export type ArticleFields = Fields<Article>;
+export type ArticleQuery<
+  TFields extends ArticleFields | undefined = ArticleFields | undefined,
+  TPopulate extends ArticlePopulate | undefined = ArticlePopulate | undefined,
+> = Query<Article, TFields, TPopulate>;
+export type ArticleResult<
+  TFields extends ArticleFields | undefined = undefined,
+  TPopulate extends ArticlePopulate | undefined = undefined,
+> = ProjectedWithPopulate<PopulatedResult<Article, TPopulate>, TFields, TPopulate>;

package/templates/welcome/template/src/schemas/Author.json

@@ -0,0 +1,17 @@
+{
+  "uid": "Author",
+  "name": "Authors",
+  "isSingleton": false,
+  "i18n": {
+    "enabled": false
+  },
+  "fields": {
+    "name": {
+      "type": "string",
+      "required": true
+    },
+    "role": {
+      "type": "string"
+    }
+  }
+}

package/templates/welcome/template/src/schemas/Author.ts

@@ -0,0 +1,51 @@
+// AUTO-GENERATED by `fimo` from src/schemas/Author.json - DO NOT EDIT.
+// Change content fields in the schema, then run `fimo validate`.
+// Runtime implementation lives in the project-local fimo-react package export.
+import { createContentClient } from "fimo-react";
+import type { CollectionContentClient } from "fimo-react";
+import type { ContentSchema } from "fimo-react";
+
+import schema from "./Author.json";
+import type { Author, AuthorFields, AuthorInput, AuthorPopulate, AuthorQuery } from "./Author.types";
+
+export type { Author, AuthorFields, AuthorFimoMeta, AuthorInput, AuthorPopulate, AuthorQuery, AuthorReferences, AuthorResult, AuthorSort, AuthorWhere } from "./Author.types";
+export type { CollectionPage, CollectionPageInfo, InfiniteListResult } from "fimo-react";
+export type InfiniteListQuery<
+  TFields extends AuthorFields | undefined = undefined,
+  TPopulate extends AuthorPopulate | undefined = undefined,
+> = Omit<AuthorQuery<TFields, TPopulate>, "offset">;
+
+const client: CollectionContentClient<Author, AuthorInput> = createContentClient<
+  Author,
+  AuthorInput
+>({
+  schema: schema as unknown as ContentSchema,
+});
+
+export const {
+  wrapWithSource,
+  meta,
+  getById,
+  getBySlug,
+  getByField,
+  list,
+  get,
+  create,
+  update,
+  remove,
+  useGetById,
+  useGetBySlug,
+  useGetByField,
+  useList,
+  useInfiniteList,
+  useGet,
+  useSuspenseGetById,
+  useSuspenseGet,
+  useSuspenseGetByField,
+  useSuspenseGetBySlug,
+  useCreate,
+  useUpdate,
+  useRemove,
+} = client;
+
+export default client;

package/templates/welcome/template/src/schemas/Author.types.ts

@@ -0,0 +1,54 @@
+// AUTO-GENERATED ⚠️ – do not edit by hand
+import { type Fields, type FimoString, type Populate, type PopulatedResult, type ProjectedWithPopulate, type Query, type Sort, type Where, type WithReferences } from "fimo-react";
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  📄  Type definitions  ────────────             */
+/*───────────────────────────────────────────────────────────────*/
+
+/**
+ * Author entity interface
+ */
+export interface AuthorFimoMeta {
+  contentType: "Author";
+}
+
+export interface Author extends WithReferences<AuthorReferences> {
+  id: string;
+  entryId: string;
+  documentId: string;
+  slug: FimoString;
+  locale: string;
+  createdAt: string;
+  updatedAt: string;
+  __fimo: AuthorFimoMeta;
+  name: FimoString;
+  role: FimoString;
+}
+
+export interface AuthorInput {
+  slug?: string;
+  documentId?: string;
+  name: string;
+  role?: string;
+}
+
+
+export type AuthorReferences = Record<never, never>;
+
+export type AuthorPopulate = Populate<Author>;
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  🔎  Query types  ────────────                  */
+/*───────────────────────────────────────────────────────────────*/
+
+export type AuthorWhere = Where<Author>;
+export type AuthorSort = Sort<Author>;
+export type AuthorFields = Fields<Author>;
+export type AuthorQuery<
+  TFields extends AuthorFields | undefined = AuthorFields | undefined,
+  TPopulate extends AuthorPopulate | undefined = AuthorPopulate | undefined,
+> = Query<Author, TFields, TPopulate>;
+export type AuthorResult<
+  TFields extends AuthorFields | undefined = undefined,
+  TPopulate extends AuthorPopulate | undefined = undefined,
+> = ProjectedWithPopulate<PopulatedResult<Author, TPopulate>, TFields, TPopulate>;

package/templates/welcome/template/src/schemas/Category.json

@@ -0,0 +1,17 @@
+{
+  "uid": "Category",
+  "name": "Categories",
+  "isSingleton": false,
+  "i18n": {
+    "enabled": false
+  },
+  "fields": {
+    "name": {
+      "type": "string",
+      "required": true
+    },
+    "description": {
+      "type": "text"
+    }
+  }
+}

package/templates/welcome/template/src/schemas/Category.ts

@@ -0,0 +1,51 @@
+// AUTO-GENERATED by `fimo` from src/schemas/Category.json - DO NOT EDIT.
+// Change content fields in the schema, then run `fimo validate`.
+// Runtime implementation lives in the project-local fimo-react package export.
+import { createContentClient } from "fimo-react";
+import type { CollectionContentClient } from "fimo-react";
+import type { ContentSchema } from "fimo-react";
+
+import schema from "./Category.json";
+import type { Category, CategoryFields, CategoryInput, CategoryPopulate, CategoryQuery } from "./Category.types";
+
+export type { Category, CategoryFields, CategoryFimoMeta, CategoryInput, CategoryPopulate, CategoryQuery, CategoryReferences, CategoryResult, CategorySort, CategoryWhere } from "./Category.types";
+export type { CollectionPage, CollectionPageInfo, InfiniteListResult } from "fimo-react";
+export type InfiniteListQuery<
+  TFields extends CategoryFields | undefined = undefined,
+  TPopulate extends CategoryPopulate | undefined = undefined,
+> = Omit<CategoryQuery<TFields, TPopulate>, "offset">;
+
+const client: CollectionContentClient<Category, CategoryInput> = createContentClient<
+  Category,
+  CategoryInput
+>({
+  schema: schema as unknown as ContentSchema,
+});
+
+export const {
+  wrapWithSource,
+  meta,
+  getById,
+  getBySlug,
+  getByField,
+  list,
+  get,
+  create,
+  update,
+  remove,
+  useGetById,
+  useGetBySlug,
+  useGetByField,
+  useList,
+  useInfiniteList,
+  useGet,
+  useSuspenseGetById,
+  useSuspenseGet,
+  useSuspenseGetByField,
+  useSuspenseGetBySlug,
+  useCreate,
+  useUpdate,
+  useRemove,
+} = client;
+
+export default client;

package/templates/welcome/template/src/schemas/Category.types.ts

@@ -0,0 +1,54 @@
+// AUTO-GENERATED ⚠️ – do not edit by hand
+import { type Fields, type FimoString, type Populate, type PopulatedResult, type ProjectedWithPopulate, type Query, type Sort, type Where, type WithReferences } from "fimo-react";
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  📄  Type definitions  ────────────             */
+/*───────────────────────────────────────────────────────────────*/
+
+/**
+ * Category entity interface
+ */
+export interface CategoryFimoMeta {
+  contentType: "Category";
+}
+
+export interface Category extends WithReferences<CategoryReferences> {
+  id: string;
+  entryId: string;
+  documentId: string;
+  slug: FimoString;
+  locale: string;
+  createdAt: string;
+  updatedAt: string;
+  __fimo: CategoryFimoMeta;
+  name: FimoString;
+  description: FimoString;
+}
+
+export interface CategoryInput {
+  slug?: string;
+  documentId?: string;
+  name: string;
+  description?: string;
+}
+
+
+export type CategoryReferences = Record<never, never>;
+
+export type CategoryPopulate = Populate<Category>;
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  🔎  Query types  ────────────                  */
+/*───────────────────────────────────────────────────────────────*/
+
+export type CategoryWhere = Where<Category>;
+export type CategorySort = Sort<Category>;
+export type CategoryFields = Fields<Category>;
+export type CategoryQuery<
+  TFields extends CategoryFields | undefined = CategoryFields | undefined,
+  TPopulate extends CategoryPopulate | undefined = CategoryPopulate | undefined,
+> = Query<Category, TFields, TPopulate>;
+export type CategoryResult<
+  TFields extends CategoryFields | undefined = undefined,
+  TPopulate extends CategoryPopulate | undefined = undefined,
+> = ProjectedWithPopulate<PopulatedResult<Category, TPopulate>, TFields, TPopulate>;