@seamlet/astro 1.1.0 → 1.2.1

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 1.2.1
+
+- `site.staticPaths(content)` is what Astro's `GetStaticPaths` takes: a static site's `[...page]` route may write `satisfies GetStaticPaths` and read its props with `InferGetStaticPropsType`. `StaticPage` and `RenderedPage` became type aliases, and `staticPaths` returns a mutable array.
+
+## 1.2.0
+
+- `productFields()`: the fields of a product of a catalog, for the record of a collection, with its address, photos, a short and a whole description, the price with a word about it, characteristics as pairs of a name and a value, the switch that hides it and what search engines show.
+- `recordPages(…, { shows })` leaves the pages of some records off the site: `site.pageOf` and `site.staticPaths` leave them out, `pathOf` gives them no address, and the preview shows them (`site.previewPageOf`), so the owner prepares a hidden record in the editor.
+
 ## 1.1.0
 
 - Pages of records: `recordPages(schema, { collection, path: "/menu/[record]" })` gives every record of a collection a page, rendered by one component with `content`, `record` and `index`; `defineSeamletSite` takes them as `recordPages`, the site's description tells the CMS about them, and the preview shows them, a record the editor has just added too.

package/README.md

@@ -230,6 +230,33 @@ Sets of fields almost every site has, edited the same way everywhere; they are p
 
 Each takes `{ label }` to name it otherwise.
 
+`productFields()` is the fields of a product of a catalog, for the record of a collection: `name`, `slug` (the address of its page), `photos` (records of one `photo`, the first is the main one), `summary` (one line for a card), `description`, `price` with `priceNote` («от», «за м²»), `characteristics` (records of a `name` and a `value`, so the owner adds a property without code: «Площадь» — «36 м²»), `isHidden` and `seo`. A site adds its own fields beside them, a category for one:
+
+```ts
+export const schema = defineSchema({
+  categories: collection({
+    label: "Категории",
+    itemTitle: "name",
+    item: { name: text({ label: "Название" }) },
+  }),
+  products: collection({
+    label: "Товары",
+    itemTitle: "name",
+    item: {
+      ...productFields(),
+      category: reference({ label: "Категория", collection: "categories" }),
+    },
+  }),
+});
+
+export const productPages = recordPages(schema, {
+  collection: "products",
+  path: "/catalog/[record]",
+  searchTexts: "seo",
+  shows: (product) => !product.isHidden,
+});
+```
+
 ## Records and references
 
 Every record of a collection has an `id` of its own, which never changes when records move, so a record has no field named `id`. The CMS gives ids to records that have none (`withRecordIds`), so a site's initial content may leave them out, unless something refers to those records.
@@ -317,6 +344,8 @@ const edit = editable<Content>();
 <h1 {...edit("menu", index, "name")}>{record.name}</h1>
 ```
 
+`shows` leaves the pages of some records off the site, a hidden product's for one: `site.pageOf` and `site.staticPaths` leave them out and `pathOf` gives them no address, while the preview shows them, so the owner prepares a product before showing it.
+
 `drinkPages.pathOf(drink)` gives the address of a record's page for a link to it: `/menu/latte`. The address is the record's `slug` when it has one, a field the owner fills in (lower-case Latin letters, digits and hyphens; the CMS spells it from the record's name), and its id otherwise, so a record has its page from the moment it is added, and keeps it when it is renamed or moved. A slug another record of the collection has, as its slug or as its id, is the issue `taken-slug`; a slug with other characters, `invalid-slug`. A collection is `catalog.products` through groups, its pages have one segment more than a page of the site (`/catalog/[record]`, never `/[record]`), a record has one page, and no page of the site may stand among the pages of records (`/menu/specials` beside `/menu/[record]`). `searchTexts` names a group of the record with a `title` and a `description` text for its page.
 
 Every record of the initial content needs an address of its own, a slug or an id, since its page is built before the CMS saves anything. The preview shows a page of a record the owner has just added, so the editor opens it before it is saved or published: under the pages of records, an address that could be an id and names no record shows a blank record, which the editor's draft replaces at once.
@@ -335,7 +364,7 @@ What was opened stays open while the page is rendered anew after every edit: a p
 
 ## What the integration adds
 
-- `/preview` and `/preview/<page>`: the preview the CMS's editor frames, the pages of records too (at their address or at the record's id). `GET` shows the published content; `POST` with the content as JSON shows that content without saving it, which is how the editor shows every edit at once. Only the CMS may frame it (`Content-Security-Policy: frame-ancestors`), and it is never indexed or cached; its refusals (an address of no page, a record a draft does not have, a draft that is not JSON or is over 1 MB) say the same.
+- `/preview` and `/preview/<page>`: the preview the CMS's editor frames, the pages of records too (at their address or at the record's id, a page the site does not show too). `GET` shows the published content; `POST` with the content as JSON shows that content without saving it, which is how the editor shows every edit at once. Only the CMS may frame it (`Content-Security-Policy: frame-ancestors`), and it is never indexed or cached; its refusals (an address of no page, a record a draft does not have, a draft that is not JSON or is over 1 MB) say the same.
 - The bridge on the preview: it tells the editor where the marked elements are and what a person does on the page, and types texts in place, formatted ones too.
 - `/seamlet/site.json`: what the site tells the CMS about itself (`SITE_DESCRIPTION_PATH`): its id and name from `seamlet.json`, its schema, the content it starts with and its pages. The CMS reads it with `readSiteDescription` whenever the site is opened in its editor.
 - `/seamlet-photos/<address>`: the site's own photo at an address its content gives it, found by `photos` of `defineSeamletSite`, for the CMS's editor.

package/dist/bridge.d.ts

@@ -1,5 +1,5 @@
-import { F as Fields } from './parse-content-IOJxgKLB.js';
-import { P as PageMessage, E as EditorMessage } from './messages-Bqgs_mic.js';
+import { F as Fields } from './parse-content-Bnn6Wa-l.js';
+import { P as PageMessage, E as EditorMessage } from './messages-C2OjqFmy.js';
 
 interface BridgeOptions {
     /** The origin of the CMS whose editor may frame the page, such as `https://cms.example.com`. */

package/dist/bridge.js

@@ -18,7 +18,7 @@ import {
   shortcutOf,
   toggleList,
   toggleMark
-} from "./chunk-PLNPM2D3.js";
+} from "./chunk-Y4R4YV5O.js";
 import {
   FIELD_PATH_ATTRIBUTE,
   REVEALED_ATTRIBUTE,
@@ -28,7 +28,7 @@ import {
   readRichText,
   resolveFieldPath,
   safeHref
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/bridge/typed-fields.ts
 function typedKindAt(schema, path) {

package/dist/{chunk-G6Z44LGA.js → chunk-HFPZVDST.js}

@@ -6,7 +6,7 @@ import {
   recordAt,
   recordPageAt,
   recordPagePath
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/site-pages.ts
 function pagePathOf(rest) {
@@ -15,12 +15,13 @@ function pagePathOf(rest) {
 function pageParameterOf(path) {
   return path === HOME_PAGE_PATH ? void 0 : path.slice(PAGE_PATH_SEPARATOR.length);
 }
+var SHOWN_ON_SITE = (recordPage, record) => recordPage.pages.isShown?.(record) ?? true;
+var EVERY_RECORD = () => true;
 function renderedPageAt(site, path, content) {
-  const page = Object.hasOwn(site.pages, path) ? site.pages[path] : void 0;
-  if (page !== void 0) {
-    return { component: page.component, props: { content } };
-  }
-  return renderedRecordPageAt(site, path, content);
+  return ownPageAt(site, path, content) ?? renderedRecordPageAt(site, { path, content, isShown: SHOWN_ON_SITE });
+}
+function previewedPageAt(site, path, content) {
+  return ownPageAt(site, path, content) ?? renderedRecordPageAt(site, { path, content, isShown: EVERY_RECORD });
 }
 function staticPagesOf(site, content) {
   const ownPages = Object.entries(site.pages).map(
@@ -31,26 +32,35 @@ function staticPagesOf(site, content) {
   );
   return [...ownPages, ...recordPages];
 }
-function renderedRecordPageAt(site, path, content) {
-  const described = site.recordPages.map((recordPage) => ({
-    ...recordPage.pages,
-    component: recordPage.component
+function ownPageAt(site, path, content) {
+  const page = Object.hasOwn(site.pages, path) ? site.pages[path] : void 0;
+  return page === void 0 ? void 0 : { component: page.component, props: { content } };
+}
+function renderedRecordPageAt(site, request) {
+  const { path, content, isShown } = request;
+  const described = site.recordPages.map((recordPage2) => ({
+    ...recordPage2.pages,
+    recordPage: recordPage2
   }));
   const found = recordPageAt(described, path);
   if (found === void 0) return void 0;
   const records = collectionAt(site.schema, content, found.page.collection);
   if (records === void 0) return void 0;
   const placed = recordAt(records.collection, records.records, found.address);
-  if (placed === void 0) return void 0;
+  const { recordPage } = found.page;
+  if (placed === void 0 || !isShown(recordPage, placed.record)) {
+    return void 0;
+  }
   const props = { content, record: placed.record, index: placed.index };
-  return { component: found.page.component, props };
+  return { component: recordPage.component, props };
 }
 function staticRecordPagesOf(schema, recordPage, content) {
   const found = collectionAt(schema, content, recordPage.pages.collection);
   if (found === void 0) return [];
   return found.records.flatMap((record, index) => {
     const address = recordAddressOf(found.collection, record);
-    if (address === void 0) return [];
+    const hasPage = address !== void 0 && SHOWN_ON_SITE(recordPage, record);
+    if (!hasPage) return [];
     const path = recordPagePath(recordPage.pages.path, address);
     const props = { content, record, index };
     return [staticPage(path, { component: recordPage.component, props })];
@@ -63,5 +73,6 @@ function staticPage(path, page) {
 export {
   pagePathOf,
   renderedPageAt,
+  previewedPageAt,
   staticPagesOf
 };

package/dist/{chunk-QXPXIMIM.js → chunk-OCA2WYK3.js}

@@ -1,6 +1,6 @@
 import {
   pagePathOf
-} from "./chunk-G6Z44LGA.js";
+} from "./chunk-HFPZVDST.js";
 import {
   FIELD_PATH_SEPARATOR,
   collectionAt,
@@ -9,7 +9,7 @@ import {
   newRecord,
   recordAt,
   recordPageAt
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/preview-requests.ts
 var MAX_DRAFT_BYTES = 1024 * 1024;

package/dist/{chunk-I3HOJE3S.js → chunk-UL2C2IB2.js}

@@ -1026,6 +1026,30 @@ function openingHoursField(options = {}) {
     }
   });
 }
+function productFields() {
+  return {
+    name: text({ label: "\u041D\u0430\u0437\u0432\u0430\u043D\u0438\u0435", maxLength: 120 }),
+    slug: slug({ label: "\u0410\u0434\u0440\u0435\u0441 \u0441\u0442\u0440\u0430\u043D\u0438\u0446\u044B" }),
+    photos: collection({
+      label: "\u0424\u043E\u0442\u043E",
+      item: { photo: image({ label: "\u0424\u043E\u0442\u043E" }) }
+    }),
+    summary: richText({ label: "\u041A\u0440\u0430\u0442\u043A\u043E", inline: true, maxLength: 200 }),
+    description: richText({ label: "\u041E\u043F\u0438\u0441\u0430\u043D\u0438\u0435" }),
+    price: number({ label: "\u0426\u0435\u043D\u0430, \u20BD", min: 0 }),
+    priceNote: text({ label: "\u0423\u0442\u043E\u0447\u043D\u0435\u043D\u0438\u0435 \u0446\u0435\u043D\u044B", maxLength: 40 }),
+    characteristics: collection({
+      label: "\u0425\u0430\u0440\u0430\u043A\u0442\u0435\u0440\u0438\u0441\u0442\u0438\u043A\u0438",
+      itemTitle: "name",
+      item: {
+        name: text({ label: "\u041D\u0430\u0437\u0432\u0430\u043D\u0438\u0435", maxLength: 60 }),
+        value: text({ label: "\u0417\u043D\u0430\u0447\u0435\u043D\u0438\u0435", maxLength: 120 })
+      }
+    }),
+    isHidden: toggle({ label: "\u0421\u043A\u0440\u044B\u0442\u044C \u0441 \u0441\u0430\u0439\u0442\u0430" }),
+    seo: seoFields()
+  };
+}
 
 // src/schema/read-fields.ts
 var TITLE_KINDS = /* @__PURE__ */ new Set([
@@ -1310,17 +1334,19 @@ var RECORD_PAGE_PATH = new RegExp(
 var PAGE_PATH_SEPARATOR = "/";
 var NOT_FOUND = -1;
 function recordPages(schema, options) {
-  const collection2 = collectionFieldAt(schema, options.collection);
+  const { shows, ...described } = options;
+  const collection2 = collectionFieldAt(schema, described.collection);
   if (collection2 === void 0) {
     throw new Error(
-      `@seamlet/astro: the schema has no collection "${options.collection}" for the pages at "${options.path}"`
+      `@seamlet/astro: the schema has no collection "${described.collection}" for the pages at "${described.path}"`
     );
   }
+  const isShown = (record) => shows === void 0 || shows(record);
   const pathOf = (record) => {
-    const address = recordAddressOf(collection2, record);
-    return address === void 0 ? void 0 : recordPagePath(options.path, address);
+    const address = isShown(record) ? recordAddressOf(collection2, record) : void 0;
+    return address === void 0 ? void 0 : recordPagePath(described.path, address);
   };
-  return { ...options, pathOf };
+  return { ...described, isShown, pathOf };
 }
 function isRecordPagePath(path) {
   return typeof path === "string" && RECORD_PAGE_PATH.test(path);
@@ -1586,6 +1612,7 @@ export {
   contactsFields,
   WEEKDAYS,
   openingHoursField,
+  productFields,
   readFields,
   checkFields,
   SITE_CONFIG_FILE,

package/dist/{chunk-PLNPM2D3.js → chunk-Y4R4YV5O.js}

@@ -6,7 +6,7 @@ import {
   readRichText,
   resolveFieldPath,
   safeHref
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/bridge/editor-shortcuts.ts
 function shortcutOf(event) {

package/dist/cli.js

@@ -6,7 +6,7 @@ import {
   SITE_CONFIG_FILE,
   isSiteId,
   readSiteConfig
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/cli.ts
 import process from "process";

package/dist/index.js

@@ -8,14 +8,14 @@ import {
 } from "./chunk-QCVWHHJC.js";
 import {
   isUploadedPhoto
-} from "./chunk-QXPXIMIM.js";
-import "./chunk-G6Z44LGA.js";
+} from "./chunk-OCA2WYK3.js";
+import "./chunk-HFPZVDST.js";
 import {
   SITE_CONFIG_FILE,
   SITE_DESCRIPTION_PATH,
   isJsonObject,
   readSiteConfig
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/index.ts
 import process from "process";

package/dist/{messages-Bqgs_mic.d.ts → messages-C2OjqFmy.d.ts}

@@ -1,4 +1,4 @@
-import { R as RichText, F as Fields, C as Content, a as FieldPath } from './parse-content-IOJxgKLB.js';
+import { R as RichText, F as Fields, C as Content, a as FieldPath } from './parse-content-Bnn6Wa-l.js';
 
 interface Box {
     readonly top: number;

package/dist/{parse-content-IOJxgKLB.d.ts → parse-content-Bnn6Wa-l.d.ts}

@@ -300,4 +300,4 @@ declare function countCharacters(text: string): number;
  */
 declare function parseContent<F extends Fields>(schema: F, input: unknown): ParsedContent<ContentOf<F>>;
 
-export { parseContent as $, collection as A, countCharacters as B, type Content as C, type DateField as D, date as E, type Fields as F, type GroupField as G, defaultContent as H, type ImageField as I, defaultValue as J, defineSchema as K, type LinkValue as L, formatFieldPath as M, type NumberField as N, type OptionValue as O, type ParsedContent as P, group as Q, type RichText as R, type SlugField as S, type TextField as T, type UrlField as U, type ValueOf as V, image as W, linesOf as X, link as Y, normalizedLine as Z, number as _, type FieldPath as a, plainTextOf as a0, readRichText as a1, reference as a2, references as a3, richText as a4, richTextOf as a5, slug as a6, text as a7, time as a8, toggle as a9, url as aa, type ContentOf as b, type Field as c, type CollectionField as d, type RecordFields as e, type RecordOf as f, type ContentIssue as g, type ImageValue as h, type LinkField as i, type ChoicesField as j, type TimeField as k, type ChoiceField as l, type ChoiceOption as m, type FieldKind as n, type FieldValue as o, type ImageFocus as p, type ReferenceField as q, type ReferencesField as r, type RichBlock as s, type RichLine as t, type RichSpan as u, type RichTextField as v, type ToggleField as w, asOneParagraph as x, choice as y, choices as z };
+export { parseContent as $, collection as A, countCharacters as B, type Content as C, type DateField as D, date as E, type Fields as F, type GroupField as G, defaultContent as H, type ImageField as I, defaultValue as J, defineSchema as K, type LinkValue as L, formatFieldPath as M, type NumberField as N, type OptionValue as O, type ParsedContent as P, group as Q, type RichText as R, type SlugField as S, type TextField as T, type UrlField as U, type ValueOf as V, image as W, linesOf as X, link as Y, normalizedLine as Z, number as _, type FieldPath as a, plainTextOf as a0, readRichText as a1, reference as a2, references as a3, richText as a4, richTextOf as a5, slug as a6, text as a7, time as a8, toggle as a9, url as aa, type ContentOf as b, type Field as c, type CollectionField as d, type RecordFields as e, type RecordOf as f, type ContentIssue as g, type ImageValue as h, type LinkField as i, type ChoicesField as j, type TimeField as k, type RichTextField as l, type ToggleField as m, type ChoiceField as n, type ChoiceOption as o, type FieldKind as p, type FieldValue as q, type ImageFocus as r, type ReferenceField as s, type ReferencesField as t, type RichBlock as u, type RichLine as v, type RichSpan as w, asOneParagraph as x, choice as y, choices as z };

package/dist/preview-requests.d.ts

@@ -1,5 +1,5 @@
-import { C as Content } from './parse-content-IOJxgKLB.js';
-import { S as SiteDescription } from './site-description-BuEpga8p.js';
+import { C as Content } from './parse-content-Bnn6Wa-l.js';
+import { S as SiteDescription } from './site-description-BnHrODQX.js';
 
 /** Far more than the content of a site ever takes; a bigger body is not a draft. */
 declare const MAX_DRAFT_BYTES: number;

package/dist/preview-requests.js

@@ -5,9 +5,9 @@ import {
   previewContentAt,
   previewHeadersOf,
   readDraft
-} from "./chunk-QXPXIMIM.js";
-import "./chunk-G6Z44LGA.js";
-import "./chunk-I3HOJE3S.js";
+} from "./chunk-OCA2WYK3.js";
+import "./chunk-HFPZVDST.js";
+import "./chunk-UL2C2IB2.js";
 export {
   MAX_DRAFT_BYTES,
   isPageAddress,

package/dist/protocol.d.ts

@@ -1,6 +1,6 @@
-import { S as Shortcut, T as TextFormats } from './messages-Bqgs_mic.js';
-export { B as Box, a as EditorKey, E as EditorMessage, I as InlineEditingOutcome, L as LinkBox, M as MarkerBox, b as PROTOCOL_VERSION, c as PageLayout, P as PageMessage, d as Point, e as TextFormat, f as TypedSelection, V as Viewport, r as readEditorMessage, g as readPageMessage } from './messages-Bqgs_mic.js';
-import { F as Fields, a as FieldPath, I as ImageField, R as RichText } from './parse-content-IOJxgKLB.js';
+import { S as Shortcut, T as TextFormats } from './messages-C2OjqFmy.js';
+export { B as Box, a as EditorKey, E as EditorMessage, I as InlineEditingOutcome, L as LinkBox, M as MarkerBox, b as PROTOCOL_VERSION, c as PageLayout, P as PageMessage, d as Point, e as TextFormat, f as TypedSelection, V as Viewport, r as readEditorMessage, g as readPageMessage } from './messages-C2OjqFmy.js';
+import { F as Fields, a as FieldPath, I as ImageField, R as RichText } from './parse-content-Bnn6Wa-l.js';
 
 declare function shortcutOf(event: KeyboardEvent): Shortcut | undefined;
 

package/dist/protocol.js

@@ -22,9 +22,9 @@ import {
   shortcutOf,
   toggleList,
   toggleMark
-} from "./chunk-PLNPM2D3.js";
+} from "./chunk-Y4R4YV5O.js";
 import "./chunk-QCVWHHJC.js";
-import "./chunk-I3HOJE3S.js";
+import "./chunk-UL2C2IB2.js";
 export {
   OWN_PHOTOS_PATH,
   PROTOCOL_VERSION,

package/dist/routes/media.js

@@ -3,9 +3,9 @@ import {
 } from "../chunk-QCVWHHJC.js";
 import {
   isUploadedPhoto
-} from "../chunk-QXPXIMIM.js";
-import "../chunk-G6Z44LGA.js";
-import "../chunk-I3HOJE3S.js";
+} from "../chunk-OCA2WYK3.js";
+import "../chunk-HFPZVDST.js";
+import "../chunk-UL2C2IB2.js";
 
 // src/routes/media.ts
 import { cmsOrigin } from "virtual:seamlet/config";

package/dist/schema.d.ts

@@ -1,6 +1,6 @@
-import { h as ImageValue, L as LinkValue, d as CollectionField, C as Content, F as Fields, e as RecordFields, b as ContentOf, G as GroupField, i as LinkField, T as TextField, U as UrlField, j as ChoicesField, k as TimeField, I as ImageField } from './parse-content-IOJxgKLB.js';
-export { l as ChoiceField, m as ChoiceOption, g as ContentIssue, D as DateField, c as Field, n as FieldKind, a as FieldPath, o as FieldValue, p as ImageFocus, N as NumberField, O as OptionValue, P as ParsedContent, f as RecordOf, q as ReferenceField, r as ReferencesField, s as RichBlock, t as RichLine, u as RichSpan, R as RichText, v as RichTextField, S as SlugField, w as ToggleField, V as ValueOf, x as asOneParagraph, y as choice, z as choices, A as collection, B as countCharacters, E as date, H as defaultContent, J as defaultValue, K as defineSchema, M as formatFieldPath, Q as group, W as image, X as linesOf, Y as link, Z as normalizedLine, _ as number, $ as parseContent, a0 as plainTextOf, a1 as readRichText, a2 as reference, a3 as references, a4 as richText, a5 as richTextOf, a6 as slug, a7 as text, a8 as time, a9 as toggle, aa as url } from './parse-content-IOJxgKLB.js';
-export { C as CollectionPath, F as FIELD_PATH_SEPARATOR, b as FieldTarget, c as FieldsReading, H as HOME_PAGE_PATH, P as PAGE_PATH_SEPARATOR, d as PageProblemReason, e as PlacedRecord, R as RECORD_PLACEHOLDER, f as RecordFieldsAt, g as RecordPagePath, h as RecordPageProblemReason, i as RecordPages, j as SITE_DESCRIPTION_PATH, k as SchemaProblem, l as SchemaProblemReason, S as SiteDescription, m as SiteDescriptionProblem, n as SiteDescriptionReading, o as SitePageDescription, a as SiteRecordPageDescription, p as checkFields, q as checkSiteDescription, r as isRecordPagePath, s as isSearchTextsGroup, t as readFields, u as readSiteDescription, v as recordAddressOf, w as recordAt, x as recordPageAt, y as recordPagePath, z as recordPages, A as resolveFieldPath } from './site-description-BuEpga8p.js';
+import { h as ImageValue, L as LinkValue, d as CollectionField, C as Content, F as Fields, e as RecordFields, b as ContentOf, G as GroupField, i as LinkField, T as TextField, U as UrlField, j as ChoicesField, k as TimeField, S as SlugField, I as ImageField, l as RichTextField, N as NumberField, m as ToggleField } from './parse-content-Bnn6Wa-l.js';
+export { n as ChoiceField, o as ChoiceOption, g as ContentIssue, D as DateField, c as Field, p as FieldKind, a as FieldPath, q as FieldValue, r as ImageFocus, O as OptionValue, P as ParsedContent, f as RecordOf, s as ReferenceField, t as ReferencesField, u as RichBlock, v as RichLine, w as RichSpan, R as RichText, V as ValueOf, x as asOneParagraph, y as choice, z as choices, A as collection, B as countCharacters, E as date, H as defaultContent, J as defaultValue, K as defineSchema, M as formatFieldPath, Q as group, W as image, X as linesOf, Y as link, Z as normalizedLine, _ as number, $ as parseContent, a0 as plainTextOf, a1 as readRichText, a2 as reference, a3 as references, a4 as richText, a5 as richTextOf, a6 as slug, a7 as text, a8 as time, a9 as toggle, aa as url } from './parse-content-Bnn6Wa-l.js';
+export { C as CollectionPath, F as FIELD_PATH_SEPARATOR, b as FieldTarget, c as FieldsReading, H as HOME_PAGE_PATH, P as PAGE_PATH_SEPARATOR, d as PageProblemReason, e as PlacedRecord, R as RECORD_PLACEHOLDER, f as RecordFieldsAt, g as RecordPagePath, h as RecordPageProblemReason, i as RecordPages, j as SITE_DESCRIPTION_PATH, k as SchemaProblem, l as SchemaProblemReason, S as SiteDescription, m as SiteDescriptionProblem, n as SiteDescriptionReading, o as SitePageDescription, p as SiteRecordPageDescription, a as SiteRecordPages, q as checkFields, r as checkSiteDescription, s as isRecordPagePath, t as isSearchTextsGroup, u as readFields, v as readSiteDescription, w as recordAddressOf, x as recordAt, y as recordPageAt, z as recordPagePath, A as recordPages, B as resolveFieldPath } from './site-description-BnHrODQX.js';
 
 declare const FIELD_PATH_ATTRIBUTE = "data-cms-path";
 interface FieldMarker {
@@ -159,6 +159,35 @@ declare function openingHoursField(options?: {
     closes: TimeField;
     note: TextField;
 }>;
+/**
+ * The fields of a product of a catalog: its name and the address of its page, its photos (the first
+ * is the main one), a short line for a card and a whole description for its page, the price and a
+ * word about it («от», «за м²»), characteristics as pairs of a name and a value, so the owner adds a
+ * property without code, the switch that hides it, and what search engines show for its page. A
+ * site puts them into its collection and adds its own fields beside them:
+ * `item: { ...productFields(), category: reference({ label: "Категория", collection: "categories" }) }`.
+ */
+declare function productFields(): {
+    name: TextField;
+    slug: SlugField;
+    photos: CollectionField<{
+        photo: ImageField;
+    }>;
+    summary: RichTextField;
+    description: RichTextField;
+    price: NumberField;
+    priceNote: TextField;
+    characteristics: CollectionField<{
+        name: TextField;
+        value: TextField;
+    }>;
+    isHidden: ToggleField;
+    seo: GroupField<{
+        title: TextField;
+        description: TextField;
+        image: ImageField;
+    }>;
+};
 
 /** An object of named values: not null, not a list. */
 type JsonObject = Readonly<Record<string, unknown>>;
@@ -205,4 +234,4 @@ declare function slugOf(words: string): string;
 /** The name of the slug of a record of the collection, if its records have one. */
 declare function slugFieldOf(item: RecordFields): string | undefined;
 
-export { ChoicesField, CollectionField, type CollectionRecords, Content, ContentOf, type ContentPath, FIELD_PATH_ATTRIBUTE, type FieldMarker, Fields, GroupField, ImageField, ImageValue, type JsonObject, LinkField, type LinkKind, type LinkTarget, LinkValue, MAX_SLUG_LENGTH, RECORD_ID_KEY, REVEALED_ATTRIBUTE, REVEAL_ATTRIBUTE, REVEAL_EVENT, RecordFields, SITE_CONFIG_FILE, type SiteConfig, type SiteConfigField, type SiteConfigReading, TextField, TimeField, UrlField, WEEKDAYS, collectionAt, collectionFieldAt, contactsFields, editable, findRecord, hrefOf, imagePosition, isContentObject, isJsonObject, isRecordId, isSiteId, isSlug, linkTargetOf, newRecord, openingHoursField, readSiteConfig, safeHref, seoFields, slugFieldOf, slugOf, withRecordIds };
+export { ChoicesField, CollectionField, type CollectionRecords, Content, ContentOf, type ContentPath, FIELD_PATH_ATTRIBUTE, type FieldMarker, Fields, GroupField, ImageField, ImageValue, type JsonObject, LinkField, type LinkKind, type LinkTarget, LinkValue, MAX_SLUG_LENGTH, NumberField, RECORD_ID_KEY, REVEALED_ATTRIBUTE, REVEAL_ATTRIBUTE, REVEAL_EVENT, RecordFields, RichTextField, SITE_CONFIG_FILE, type SiteConfig, type SiteConfigField, type SiteConfigReading, SlugField, TextField, TimeField, ToggleField, UrlField, WEEKDAYS, collectionAt, collectionFieldAt, contactsFields, editable, findRecord, hrefOf, imagePosition, isContentObject, isJsonObject, isRecordId, isSiteId, isSlug, linkTargetOf, newRecord, openingHoursField, productFields, readSiteConfig, safeHref, seoFields, slugFieldOf, slugOf, withRecordIds };

package/dist/schema.js

@@ -49,6 +49,7 @@ import {
   openingHoursField,
   parseContent,
   plainTextOf,
+  productFields,
   readFields,
   readRichText,
   readSiteConfig,
@@ -73,7 +74,7 @@ import {
   toggle,
   url,
   withRecordIds
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 export {
   FIELD_PATH_ATTRIBUTE,
   FIELD_PATH_SEPARATOR,
@@ -125,6 +126,7 @@ export {
   openingHoursField,
   parseContent,
   plainTextOf,
+  productFields,
   readFields,
   readRichText,
   readSiteConfig,

package/dist/{site-description-BuEpga8p.d.ts → site-description-BnHrODQX.d.ts}

@@ -1,4 +1,4 @@
-import { a as FieldPath, c as Field, d as CollectionField, F as Fields, G as GroupField, C as Content, e as RecordFields, f as RecordOf, g as ContentIssue } from './parse-content-IOJxgKLB.js';
+import { a as FieldPath, c as Field, d as CollectionField, F as Fields, G as GroupField, C as Content, e as RecordFields, f as RecordOf, g as ContentIssue } from './parse-content-Bnn6Wa-l.js';
 
 /** What a path written on a page points at: a field, or a whole record of a collection. */
 type FieldTarget = {
@@ -75,9 +75,20 @@ interface PlacedRecord {
     readonly record: Content;
     readonly index: number;
 }
+/** The pages of the records of a collection as the site renders them. */
+interface SiteRecordPages extends SiteRecordPageDescription {
+    /**
+     * Whether the site shows the record's page; every record's when left out. The preview shows the
+     * page of every record, a hidden one too, so the owner prepares it before showing it.
+     */
+    readonly isShown?: (record: Content) => boolean;
+}
 /** The pages of the records of a collection, with the address of each record's page. */
-interface RecordPages<R> extends SiteRecordPageDescription {
-    /** The address of the record's page: `/menu/latte`; none for a record with neither slug nor id. */
+interface RecordPages<R> extends SiteRecordPages {
+    /**
+     * The address of the record's page: `/menu/latte`; none for a record whose page the site does
+     * not show, or with neither slug nor id.
+     */
     readonly pathOf: (record: R) => string | undefined;
 }
 /** The address of a record's page with `[record]` in place of the record. */
@@ -96,12 +107,14 @@ declare const PAGE_PATH_SEPARATOR = "/";
  * A page of every record of a collection of the schema at the address with `[record]`:
  * `recordPages(schema, { collection: "menu", path: "/menu/[record]" })`. A site gives it to
  * `defineSeamletSite` with the component that renders a record, and links to a record's page with
- * its `pathOf`.
+ * its `pathOf`. `shows` leaves the pages of some records off the site, such as hidden ones:
+ * `shows: (product) => !product.isHidden`.
  */
 declare function recordPages<F extends Fields, const P extends CollectionPath<F>>(schema: F, options: {
     readonly collection: P;
     readonly path: RecordPagePath;
     readonly searchTexts?: string;
+    readonly shows?: (record: RecordOf<RecordFieldsAt<F, P>>) => boolean;
 }): RecordPages<RecordOf<RecordFieldsAt<F, P>>>;
 /** Whether the path can be the address of the pages of records: `/menu/[record]`. */
 declare function isRecordPagePath(path: unknown): path is string;
@@ -242,4 +255,4 @@ 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 { resolveFieldPath as A, type CollectionPath as C, FIELD_PATH_SEPARATOR as F, HOME_PAGE_PATH as H, PAGE_PATH_SEPARATOR as P, RECORD_PLACEHOLDER as R, type SiteDescription as S, type SiteRecordPageDescription as a, type FieldTarget as b, type FieldsReading as c, type PageProblemReason as d, type PlacedRecord as e, type RecordFieldsAt as f, type RecordPagePath as g, type RecordPageProblemReason as h, type RecordPages as i, SITE_DESCRIPTION_PATH as j, type SchemaProblem as k, type SchemaProblemReason as l, type SiteDescriptionProblem as m, type SiteDescriptionReading as n, type SitePageDescription as o, checkFields as p, checkSiteDescription as q, isRecordPagePath as r, isSearchTextsGroup as s, readFields as t, readSiteDescription as u, recordAddressOf as v, recordAt as w, recordPageAt as x, recordPagePath as y, recordPages as z };
+export { recordPages as A, resolveFieldPath as B, type CollectionPath as C, FIELD_PATH_SEPARATOR as F, HOME_PAGE_PATH as H, PAGE_PATH_SEPARATOR as P, RECORD_PLACEHOLDER as R, type SiteDescription as S, type SiteRecordPages as a, type FieldTarget as b, type FieldsReading as c, type PageProblemReason as d, type PlacedRecord as e, type RecordFieldsAt as f, type RecordPagePath as g, type RecordPageProblemReason as h, type RecordPages as i, SITE_DESCRIPTION_PATH as j, type SchemaProblem as k, type SchemaProblemReason as l, type SiteDescriptionProblem as m, type SiteDescriptionReading as n, type SitePageDescription as o, type SiteRecordPageDescription as p, checkFields as q, checkSiteDescription as r, isRecordPagePath as s, isSearchTextsGroup as t, readFields as u, readSiteDescription as v, recordAddressOf as w, recordAt as x, recordPageAt as y, recordPagePath as z };

package/dist/site.d.ts

@@ -1,7 +1,7 @@
 import { ImageMetadata } from 'astro';
 import { AstroComponentFactory } from 'astro/runtime/server/index.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';
+import { C as Content, F as Fields, b as ContentOf } from './parse-content-Bnn6Wa-l.js';
+import { a as SiteRecordPages, S as SiteDescription } from './site-description-BnHrODQX.js';
 
 /** A page of the site: how the editor names it, and the component that renders it. */
 interface SeamletPage {
@@ -14,7 +14,7 @@ interface SeamletPage {
 /** 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;
+    readonly pages: SiteRecordPages;
     /**
      * A component that takes the site's content, the record and its place in its collection as its
      * `content`, `record` and `index` props.
@@ -22,10 +22,10 @@ interface SeamletRecordPage {
     readonly component: AstroComponentFactory;
 }
 /** What renders a page: its component, and the props to give it. */
-interface RenderedPage {
+type RenderedPage = {
     readonly component: AstroComponentFactory;
     readonly props: PageProps;
-}
+};
 type PageProps = {
     readonly content: Content;
 } | {
@@ -34,12 +34,12 @@ type PageProps = {
     readonly index: number;
 };
 /** A page that `getStaticPaths` of a site's `[...page]` route builds. */
-interface StaticPage {
+type 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> {
@@ -72,8 +72,13 @@ interface SeamletSite<F extends Fields = Fields> {
      * 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;
+    /**
+     * What the preview renders at the rest of an address with the content: as `pageOf`, and the page
+     * of a record the site does not show, so the owner prepares it in the editor.
+     */
+    readonly previewPageOf: (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[];
+    readonly staticPaths: (content: ContentOf<F>) => 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. */

package/dist/site.js

@@ -3,14 +3,15 @@ import {
 } from "./chunk-QCVWHHJC.js";
 import {
   pagePathOf,
+  previewedPageAt,
   renderedPageAt,
   staticPagesOf
-} from "./chunk-G6Z44LGA.js";
+} from "./chunk-HFPZVDST.js";
 import {
   checkSiteDescription,
   formatFieldPath,
   parseContent
-} from "./chunk-I3HOJE3S.js";
+} from "./chunk-UL2C2IB2.js";
 
 // src/site.ts
 import { cmsOrigin, siteId, siteTitle } from "virtual:seamlet/config";
@@ -173,6 +174,7 @@ function defineSeamletSite(definition) {
       return page?.component;
     },
     pageOf: (rest, content) => renderedPageAt(sitePages, pagePathOf(rest), contentOf(content)),
+    previewPageOf: (rest, content) => previewedPageAt(sitePages, pagePathOf(rest), contentOf(content)),
     staticPaths: (content) => staticPagesOf(sitePages, contentOf(content)),
     loadPublishedContent: () => loadPublishedContent(definition.schema),
     ownPhotoAt: (src) => definition.photos?.(src),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamlet/astro",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "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",

package/routes/preview.astro

@@ -38,7 +38,7 @@ const content =
       )
     : parseContent(site.schema, reading.draft).content;
 
-const page = site.pageOf(rest, content);
+const page = site.previewPageOf(rest, content);
 if (page === undefined) {
   return new Response(null, { status: NOT_FOUND, headers });
 }