@seamlet/astro 0.12.1 → 1.1.0

package/dist/site.d.ts

@@ -1,7 +1,7 @@
 import { ImageMetadata } from 'astro';
 import { AstroComponentFactory } from 'astro/runtime/server/index.js';
-import { F as Fields, C as ContentOf } from './parse-content-Eg8yRq_t.js';
-import { S as SiteDescription } from './site-description-Cg5KNhhG.js';
+import { C as Content, F as Fields, b as ContentOf } from './parse-content-IOJxgKLB.js';
+import { a as SiteRecordPageDescription, S as SiteDescription } from './site-description-BuEpga8p.js';
 
 /** A page of the site: how the editor names it, and the component that renders it. */
 interface SeamletPage {
@@ -11,6 +11,36 @@ interface SeamletPage {
     /** Where the content holds the page's title and description for search engines (`seo.menu`). */
     readonly searchTexts?: string;
 }
+/** The pages of the records of a collection, and the component that renders each of them. */
+interface SeamletRecordPage {
+    /** Which records have pages and where: `recordPages(schema, { collection, path })`. */
+    readonly pages: SiteRecordPageDescription;
+    /**
+     * A component that takes the site's content, the record and its place in its collection as its
+     * `content`, `record` and `index` props.
+     */
+    readonly component: AstroComponentFactory;
+}
+/** What renders a page: its component, and the props to give it. */
+interface RenderedPage {
+    readonly component: AstroComponentFactory;
+    readonly props: PageProps;
+}
+type PageProps = {
+    readonly content: Content;
+} | {
+    readonly content: Content;
+    readonly record: Content;
+    readonly index: number;
+};
+/** A page that `getStaticPaths` of a site's `[...page]` route builds. */
+interface StaticPage {
+    readonly params: {
+        readonly page: string | undefined;
+    };
+    readonly props: RenderedPage;
+}
+
 /** The site's content and pages; its id and title come from `seamlet.json`. */
 interface SeamletSiteDefinition<F extends Fields> {
     readonly schema: F;
@@ -18,6 +48,11 @@ interface SeamletSiteDefinition<F extends Fields> {
     readonly initialContent: ContentOf<F>;
     /** The pages of the site by their address (`/`, `/menu`); the home page `/` comes first. */
     readonly pages: Readonly<Record<string, SeamletPage>>;
+    /**
+     * A page of every record of a collection, each kind with the component that renders it:
+     * `[{ pages: recordPages(schema, { collection: "menu", path: "/menu/[record]" }), component }]`.
+     */
+    readonly recordPages?: readonly SeamletRecordPage[];
     /**
      * The site's own photo at the address its content gives it (`/menu/cafe/01.jpg`), so the CMS's
      * editor can show it in the photo's field. A site without own photos leaves it out.
@@ -27,8 +62,18 @@ interface SeamletSiteDefinition<F extends Fields> {
 interface SeamletSite<F extends Fields = Fields> {
     readonly id: string;
     readonly schema: F;
-    /** The page at the rest of an address: nothing is the first page, `menu` the page at /menu. */
+    /**
+     * The page at the rest of an address: nothing is the first page, `menu` the page at /menu.
+     * @deprecated The site's own pages only: `pageOf` renders the pages of records too.
+     */
     readonly pageAt: (rest: string | undefined) => AstroComponentFactory | undefined;
+    /**
+     * What renders the page at the rest of an address (`[...page]`) with the content: nothing is the
+     * first page, `menu/latte` the page of the record at /menu/latte. Undefined when there is none.
+     */
+    readonly pageOf: (rest: string | undefined, content: ContentOf<F>) => RenderedPage | undefined;
+    /** Every page of the site with the content, for `getStaticPaths` of a `[...page]` route. */
+    readonly staticPaths: (content: ContentOf<F>) => readonly StaticPage[];
     /** What the CMS published: the site's initial content until the first publication. */
     readonly loadPublishedContent: () => Promise<ContentOf<F>>;
     /** The site's own photo at an address its content gives it, if it has one there. */
@@ -45,4 +90,4 @@ declare function defineSeamletSite<F extends Fields>(definition: SeamletSiteDefi
  */
 declare function loadPublishedContent<F extends Fields>(schema: F): Promise<ContentOf<F>>;
 
-export { type SeamletPage, type SeamletSite, type SeamletSiteDefinition, defineSeamletSite, loadPublishedContent };
+export { type PageProps, type RenderedPage, type SeamletPage, type SeamletRecordPage, type SeamletSite, type SeamletSiteDefinition, type StaticPage, defineSeamletSite, loadPublishedContent };

package/dist/site.js

@@ -1,12 +1,16 @@
 import {
-  HOME_PAGE_PATH,
+  SITE_MODULE_FILE
+} from "./chunk-QCVWHHJC.js";
+import {
+  pagePathOf,
+  renderedPageAt,
+  staticPagesOf
+} from "./chunk-G6Z44LGA.js";
+import {
   checkSiteDescription,
   formatFieldPath,
   parseContent
-} from "./chunk-ZS32CW5F.js";
-import {
-  SITE_MODULE_FILE
-} from "./chunk-QCVWHHJC.js";
+} from "./chunk-I3HOJE3S.js";
 
 // src/site.ts
 import { cmsOrigin, siteId, siteTitle } from "virtual:seamlet/config";
@@ -56,12 +60,22 @@ function describeSite(identity, definition) {
       ...page.searchTexts === void 0 ? {} : { searchTexts: page.searchTexts }
     })
   );
+  const recordPages = (definition.recordPages ?? []).map(
+    ({
+      pages: { path, collection, searchTexts }
+    }) => ({
+      path,
+      collection,
+      ...searchTexts === void 0 ? {} : { searchTexts }
+    })
+  );
   const description = {
     id: identity.id,
     title: identity.title,
     schema: definition.schema,
     initialContent: definition.initialContent,
-    pages
+    pages,
+    ...recordPages.length === 0 ? {} : { recordPages }
   };
   const asSent = JSON.parse(JSON.stringify(description));
   const reading = checkSiteDescription(asSent);
@@ -100,6 +114,18 @@ function problemText(problem) {
       return 'the first of the pages is not the home page "/"';
     case "repeated-page-path":
       return `the page "${problem.path}" is named twice`;
+    case "invalid-record-pages":
+      return "recordPages is not a list";
+    case "invalid-record-page":
+      return `record pages ${String(problem.index + 1)}: ${RECORD_PAGE_PROBLEM_TEXTS[problem.reason]}`;
+    case "repeated-record-pages":
+      return `the records of "${problem.collection}" have pages twice: a record has one page`;
+    case "page-among-record-pages":
+      return `the page "${problem.path}" is where the pages of records are: give it another address`;
+    case "record-without-address":
+      return `record ${String(problem.index + 1)} of "${problem.collection}" in the initial content has neither a slug nor an id for its page`;
+    case "repeated-record-address":
+      return `two records of "${problem.collection}" in the initial content have their pages at "${problem.address}": give them other ids or slugs`;
   }
 }
 var SCHEMA_PROBLEM_TEXTS = {
@@ -111,7 +137,8 @@ var SCHEMA_PROBLEM_TEXTS = {
   "invalid-choice-options": "its options are not a list of { value, label }",
   "record-id-field": "a record has its own id: name the field otherwise",
   "invalid-item-title": "itemTitle names no text or link field of the record",
-  "unknown-collection": "it refers to a collection the schema does not have"
+  "unknown-collection": "it refers to a collection the schema does not have",
+  "misplaced-slug": "a slug is a field of a record of a collection, one per record"
 };
 var PAGE_PROBLEM_TEXTS = {
   "not-a-page": "not a page",
@@ -119,17 +146,34 @@ var PAGE_PROBLEM_TEXTS = {
   "invalid-title": "its title is empty",
   "invalid-search-texts": "searchTexts names no group of a title and a description text"
 };
+var RECORD_PAGE_PROBLEM_TEXTS = {
+  "not-a-page": "not pages of records",
+  "invalid-path": 'its address is not lower-case segments, then "/[record]", such as "/menu/[record]"',
+  "unknown-collection": "it names a collection the schema does not have",
+  "invalid-search-texts": "searchTexts names no group of a title and a description text of the record"
+};
 function issueText(issue) {
   return `"${formatFieldPath(issue.path)}" is ${issue.code}`;
 }
 
 // src/site.ts
 function defineSeamletSite(definition) {
-  const pages = new Map(Object.entries(definition.pages));
+  const sitePages = {
+    schema: definition.schema,
+    pages: definition.pages,
+    recordPages: definition.recordPages ?? []
+  };
+  const contentOf = (content) => content;
   return {
     id: siteId,
     schema: definition.schema,
-    pageAt: (rest) => pages.get(rest === void 0 ? HOME_PAGE_PATH : `/${rest}`)?.component,
+    pageAt: (rest) => {
+      const path = pagePathOf(rest);
+      const page = Object.hasOwn(definition.pages, path) ? definition.pages[path] : void 0;
+      return page?.component;
+    },
+    pageOf: (rest, content) => renderedPageAt(sitePages, pagePathOf(rest), contentOf(content)),
+    staticPaths: (content) => staticPagesOf(sitePages, contentOf(content)),
     loadPublishedContent: () => loadPublishedContent(definition.schema),
     ownPhotoAt: (src) => definition.photos?.(src),
     description: describeSite({ id: siteId, title: siteTitle }, definition)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamlet/astro",
-  "version": "0.12.1",
+  "version": "1.1.0",
   "description": "Connects an Astro site to the Seamlet CMS: the schema of its content, the preview the editor frames, and its published content.",
   "license": "MIT",
   "type": "module",
@@ -59,7 +59,8 @@
   "files": [
     "dist",
     "routes",
-    "components"
+    "components",
+    "CHANGELOG.md"
   ],
   "scripts": {
     "build": "tsup"

package/routes/preview.astro

@@ -1,10 +1,15 @@
 ---
 // The preview the CMS's editor frames: a page of the site with the bridge to the editor.
-// `/preview` is the first page, `/preview/menu` the page at /menu. GET shows the published
-// content; POST shows the content in its JSON body, never saved: the bridge renders the editor's
-// draft this way.
+// `/preview` is the first page, `/preview/menu` the page at /menu, `/preview/menu/latte` the page of
+// a record. GET shows the published content; POST shows the content in its JSON body, never saved:
+// the bridge renders the editor's draft this way.
 import { parseContent } from "@seamlet/astro/schema";
-import { previewHeadersOf, readDraft } from "@seamlet/astro/preview-requests";
+import {
+  isPageAddress,
+  previewContentAt,
+  previewHeadersOf,
+  readDraft,
+} from "@seamlet/astro/preview-requests";
 import { cmsOrigin } from "virtual:seamlet/config";
 import site from "virtual:seamlet/site";
 
@@ -15,11 +20,10 @@ for (const [name, value] of Object.entries(headers)) {
   Astro.response.headers.set(name, value);
 }
 
-const Page = site.pageAt(Astro.params.page);
-if (Page === undefined) {
+const rest = Astro.params.page;
+if (!isPageAddress(site.description, rest)) {
   return new Response(null, { status: NOT_FOUND, headers });
 }
-
 const reading =
   Astro.request.method === "POST" ? await readDraft(Astro.request) : undefined;
 if (reading !== undefined && !reading.isRead) {
@@ -27,8 +31,18 @@ if (reading !== undefined && !reading.isRead) {
 }
 const content =
   reading === undefined
-    ? await site.loadPublishedContent()
+    ? previewContentAt(
+        site.description,
+        await site.loadPublishedContent(),
+        rest,
+      )
     : parseContent(site.schema, reading.draft).content;
+
+const page = site.pageOf(rest, content);
+if (page === undefined) {
+  return new Response(null, { status: NOT_FOUND, headers });
+}
+const { component: Page, props } = page;
 ---
 
-<Page content={content} />
+<Page {...props} />

package/dist/site-description-Cg5KNhhG.d.ts

@@ -1,112 +0,0 @@
-import { F as Fields, a as Content, c as ContentIssue } from './parse-content-Eg8yRq_t.js';
-
-/** Why a schema cannot be read. */
-type SchemaProblemReason = 
-/** Not an object of fields, or a field that is not an object. */
-"not-fields"
-/** A name that is empty, holds the separator of paths (`.`) or is a number, which a path reads as a record. */
- | "invalid-name" | "invalid-label" | "unknown-kind"
-/** An option of the field (`maxLength`, `inline`…) is there but not of its kind. */
- | "invalid-option" | "invalid-choice-options"
-/** A record has a field named `id`, which is the record's own. */
- | "record-id-field"
-/** `itemTitle` names no text or link field of the record. */
- | "invalid-item-title"
-/** A reference names a collection the schema does not have. */
- | "unknown-collection";
-interface SchemaProblem {
-    /** The names of the fields down to the field with the problem; empty for the schema itself. */
-    readonly path: readonly string[];
-    readonly reason: SchemaProblemReason;
-}
-type FieldsReading = {
-    readonly status: "read";
-    readonly fields: Fields;
-} | {
-    readonly status: "invalid";
-    readonly problem: SchemaProblem;
-};
-/** The schema the input describes, or undefined when it is not one. */
-declare function readFields(input: unknown): Fields | undefined;
-/** The schema the input describes, or the first problem that keeps it from being one. */
-declare function checkFields(input: unknown): FieldsReading;
-
-/** Where a site hands out its description, on the origin of its preview. */
-declare const SITE_DESCRIPTION_PATH = "/seamlet/site.json";
-/** A page of a site, which the site renders itself. */
-interface SitePageDescription {
-    /** The address of the page on the site: `/` for the first page, `/menu` for others. */
-    readonly path: string;
-    /** How the editor names the page in its list of pages. */
-    readonly title: string;
-    /**
-     * Where the content holds what search engines and link previews show for the page
-     * (`seo.menu`): a group of a `title` and a `description` text.
-     */
-    readonly searchTexts?: string;
-}
-interface SiteDescription {
-    /** The address of the site in the CMS (`/sites/<id>`). */
-    readonly id: string;
-    /** How the CMS names the site. */
-    readonly title: string;
-    readonly schema: Fields;
-    /** The content shown and edited until the first save. */
-    readonly initialContent: Content;
-    /** The pages of the site; the first is the home page at `/`. */
-    readonly pages: readonly [SitePageDescription, ...SitePageDescription[]];
-}
-/** Why a site's description cannot be read: what to fix in the site. */
-type SiteDescriptionProblem = {
-    readonly code: "not-a-description";
-} | {
-    readonly code: "invalid-id";
-} | {
-    readonly code: "invalid-title";
-} | {
-    readonly code: "invalid-schema";
-    readonly problem: SchemaProblem;
-}
-/** The initial content is not content the CMS could save. */
- | {
-    readonly code: "invalid-initial-content";
-    readonly issues: readonly ContentIssue[];
-} | {
-    readonly code: "no-pages";
-}
-/** The page at this place of the list is not a page, or its path or title is not one. */
- | {
-    readonly code: "invalid-page";
-    readonly index: number;
-    readonly reason: PageProblemReason;
-} | {
-    readonly code: "home-page-not-first";
-} | {
-    readonly code: "repeated-page-path";
-    readonly path: string;
-};
-type PageProblemReason = "not-a-page"
-/** Not `/`, or not lower-case segments without a trailing slash, such as `/menu`. */
- | "invalid-path" | "invalid-title"
-/** Not where the content holds a group of a `title` and a `description` text. */
- | "invalid-search-texts";
-type SiteDescriptionReading = {
-    readonly status: "read";
-    readonly description: SiteDescription;
-} | {
-    readonly status: "invalid";
-    readonly problems: readonly SiteDescriptionProblem[];
-};
-/** The first page of every site. */
-declare const HOME_PAGE_PATH = "/";
-/**
- * The description the input gives, or undefined when it is not a whole and sound one: a known
- * schema, an initial content with nothing to fix, the home page first, each page once.
- */
-declare function readSiteDescription(input: unknown): SiteDescription | undefined;
-/** The description the input gives, or every problem that keeps it from being whole and sound. */
-declare function checkSiteDescription(input: unknown): SiteDescriptionReading;
-/** Whether the path names a group of a `title` and a `description` text. */
-declare function isSearchTextsGroup(schema: Fields, path: string): boolean;
-
-export { type FieldsReading as F, HOME_PAGE_PATH as H, type PageProblemReason as P, type SiteDescription as S, SITE_DESCRIPTION_PATH as a, type SchemaProblem as b, type SchemaProblemReason as c, type SiteDescriptionProblem as d, type SiteDescriptionReading as e, type SitePageDescription as f, checkFields as g, checkSiteDescription as h, isSearchTextsGroup as i, readSiteDescription as j, readFields as r };