fimo 2.2.0-staging.10 → 2.2.0-staging.11

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

@@ -0,0 +1,59 @@
+// 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.
+import { createContentClient } from 'fimo-react';
+import type { CollectionContentClient } from 'fimo-react';
+import type { ContentSchema } from 'fimo-react';
+
+import schema from './Article.json';
+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,
+});
+
+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,73 @@
+// AUTO-GENERATED ⚠️ – do not edit by hand
+import {
+  type Fields,
+  type FimoBoolean,
+  type FimoMedia,
+  type FimoPolymorphicReference,
+  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';
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  📄  Type definitions  ────────────             */
+/*───────────────────────────────────────────────────────────────*/
+
+/**
+ * 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;
+}
+
+export interface ArticleInput {
+  slug?: string;
+  documentId?: string;
+  title: string;
+  summary: string;
+  body: FimoRichTextContent;
+  cover: Pick<FimoMedia, 'url' | 'alt' | 'name' | 'mime' | 'width' | 'height'>;
+}
+
+export type ArticleReferences = Record<never, never>;
+
+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/HomePage.json

@@ -0,0 +1,39 @@
+{
+  "uid": "HomePage",
+  "name": "Home page",
+  "isSingleton": true,
+  "i18n": { "enabled": false },
+  "fields": {
+    "title": { "type": "string", "required": true },
+    "intro": { "type": "richtext", "required": true },
+    "heroImage": { "type": "media", "required": true },
+    "heroImageHint": { "type": "string", "required": true },
+    "startLabel": { "type": "string", "required": true },
+    "tourTitle": { "type": "string", "required": true },
+    "tourIntro": { "type": "text", "required": true },
+    "steps": {
+      "type": "blocks",
+      "min": 4,
+      "max": 4,
+      "schema": {
+        "fields": {
+          "number": { "type": "string", "required": true },
+          "title": { "type": "string", "required": true },
+          "body": { "type": "text", "required": true },
+          "highlight": { "type": "text" },
+          "actionLabel": { "type": "string", "required": true },
+          "action": { "type": "string", "required": true }
+        }
+      }
+    },
+    "articlesTitle": { "type": "string", "required": true },
+    "articlesIntro": { "type": "text", "required": true },
+    "migrationTitle": { "type": "string", "required": true },
+    "migrationBody": { "type": "richtext", "required": true },
+    "migrationPrompt": { "type": "text", "required": true },
+    "buildTitle": { "type": "string", "required": true },
+    "buildBody": { "type": "richtext", "required": true },
+    "closingTitle": { "type": "string", "required": true },
+    "closingBody": { "type": "text", "required": true }
+  }
+}

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

@@ -0,0 +1,114 @@
+// AUTO-GENERATED ⚠️ – do not edit by hand
+import {
+  type Fields,
+  type FimoBoolean,
+  type FimoMedia,
+  type FimoPolymorphicReference,
+  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';
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  📄  Type definitions  ────────────             */
+/*───────────────────────────────────────────────────────────────*/
+
+/**
+ * HomePage entity interface
+ */
+export interface HomePageFimoMeta {
+  contentType: 'HomePage';
+}
+
+export interface HomePage extends WithReferences<HomePageReferences> {
+  id: string;
+  entryId: string;
+  documentId: string;
+  slug: FimoString;
+  locale?: string;
+  createdAt: string;
+  updatedAt: string;
+  __fimo: HomePageFimoMeta;
+  title: FimoString;
+  intro: FimoRichText;
+  heroImage: FimoMedia;
+  heroImageHint: FimoString;
+  startLabel: FimoString;
+  tourTitle: FimoString;
+  tourIntro: FimoString;
+  steps: {
+    _key: string;
+    number: FimoString;
+    title: FimoString;
+    body: FimoString;
+    highlight?: FimoString;
+    actionLabel: FimoString;
+    action: FimoString;
+  }[];
+  articlesTitle: FimoString;
+  articlesIntro: FimoString;
+  migrationTitle: FimoString;
+  migrationBody: FimoRichText;
+  migrationPrompt: FimoString;
+  buildTitle: FimoString;
+  buildBody: FimoRichText;
+  closingTitle: FimoString;
+  closingBody: FimoString;
+}
+
+export interface HomePageInput {
+  slug?: string;
+  title: string;
+  intro: FimoRichTextContent;
+  heroImage: Pick<FimoMedia, 'url' | 'alt' | 'name' | 'mime' | 'width' | 'height'>;
+  heroImageHint: string;
+  startLabel: string;
+  tourTitle: string;
+  tourIntro: string;
+  steps: {
+    _key?: string;
+    number: string;
+    title: string;
+    body: string;
+    highlight?: string;
+    actionLabel: string;
+    action: string;
+  }[];
+  articlesTitle: string;
+  articlesIntro: string;
+  migrationTitle: string;
+  migrationBody: FimoRichTextContent;
+  migrationPrompt: string;
+  buildTitle: string;
+  buildBody: FimoRichTextContent;
+  closingTitle: string;
+  closingBody: string;
+}
+
+export type HomePageReferences = Record<never, never>;
+
+export type HomePagePopulate = Populate<HomePage>;
+
+/*───────────────────────────────────────────────────────────────*/
+/*  ────────────  🔎  Query types  ────────────                  */
+/*───────────────────────────────────────────────────────────────*/
+
+export type HomePageWhere = Where<HomePage>;
+export type HomePageSort = Sort<HomePage>;
+export type HomePageFields = Fields<HomePage>;
+export type HomePageQuery<
+  TFields extends HomePageFields | undefined = HomePageFields | undefined,
+  TPopulate extends HomePagePopulate | undefined = HomePagePopulate | undefined,
+> = Query<HomePage, TFields, TPopulate>;
+export type HomePageResult<
+  TFields extends HomePageFields | undefined = undefined,
+  TPopulate extends HomePagePopulate | undefined = undefined,
+> = ProjectedWithPopulate<PopulatedResult<HomePage, TPopulate>, TFields, TPopulate>;