@seamlet/astro 1.2.1 → 1.4.0

package/dist/{site-description-BnHrODQX.d.ts → site-description-cKiFtNHW.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-Bnn6Wa-l.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-CT2cUVL-.js';
 
 /** What a path written on a page points at: a field, or a whole record of a collection. */
 type FieldTarget = {
@@ -56,6 +56,87 @@ 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;
 
+/** A line of words: a name, a city, the model of a car. */
+interface RequestTextField {
+    readonly kind: "text";
+    readonly label: string;
+    readonly required?: boolean;
+    /** In characters as people see them; `DEFAULT_TEXT_LENGTH` when left out. */
+    readonly maxLength?: number;
+}
+/** Words of several lines: a comment, a question, what is to be built. */
+interface RequestLongTextField {
+    readonly kind: "longText";
+    readonly label: string;
+    readonly required?: boolean;
+    /** In characters as people see them; `DEFAULT_LONG_TEXT_LENGTH` when left out. */
+    readonly maxLength?: number;
+}
+/** A phone number to call back. */
+interface RequestPhoneField {
+    readonly kind: "phone";
+    readonly label: string;
+    readonly required?: boolean;
+}
+/** An email address to write back to. */
+interface RequestEmailField {
+    readonly kind: "email";
+    readonly label: string;
+    readonly required?: boolean;
+}
+/** One of the options the form lists: a service, a size, a time to call. */
+interface RequestChoiceField {
+    readonly kind: "choice";
+    readonly label: string;
+    readonly required?: boolean;
+    /** The options as the visitor reads them; the request keeps the one picked, as it reads. */
+    readonly options: readonly string[];
+}
+type RequestField = RequestTextField | RequestLongTextField | RequestPhoneField | RequestEmailField | RequestChoiceField;
+type RequestFieldKind = RequestField["kind"];
+/** The fields of a form by their names, in the order the form shows them. */
+type RequestFields = Readonly<Record<string, RequestField>>;
+interface RequestForm<F extends RequestFields = RequestFields> {
+    /** How the site and the CMS tell the form from the site's other forms: `callback`. */
+    readonly id: string;
+    /** How the CMS names the form's requests to the business: «Обратный звонок». */
+    readonly title: string;
+    readonly fields: F;
+}
+/** A line of words a visitor types without a limit of the site's own. */
+declare const DEFAULT_TEXT_LENGTH = 200;
+/** A comment a visitor types without a limit of the site's own. */
+declare const DEFAULT_LONG_TEXT_LENGTH = 2000;
+/** No field of a request holds more: a request is a message, not a document. */
+declare const MAX_REQUEST_FIELD_LENGTH = 5000;
+/** Declares a form of the site's requests: `requestForm({ id, title, fields })`. */
+declare function requestForm<const F extends RequestFields>(form: RequestForm<F>): RequestForm<F>;
+declare function requestText(options: Omit<RequestTextField, "kind">): RequestTextField;
+declare function requestLongText(options: Omit<RequestLongTextField, "kind">): RequestLongTextField;
+declare function requestPhone(options: Omit<RequestPhoneField, "kind">): RequestPhoneField;
+declare function requestEmail(options: Omit<RequestEmailField, "kind">): RequestEmailField;
+declare function requestChoice(options: Omit<RequestChoiceField, "kind">): RequestChoiceField;
+/** Why a form of a site's description cannot be read. */
+type RequestFormProblemReason = "not-a-form"
+/** Not lower-case Latin letters, digits and hyphens, starting with a letter. */
+ | "invalid-id" | "invalid-title" | "no-fields"
+/** A field's name is not a name of a JavaScript property such as `preferredTime`. */
+ | "invalid-field-name"
+/** A field is not one of the kinds above, or its label, limit or options are not sound. */
+ | "invalid-field";
+type RequestFormReading = {
+    readonly status: "read";
+    readonly form: RequestForm;
+} | {
+    readonly status: "invalid";
+    readonly reason: RequestFormProblemReason;
+};
+/** The form the input describes, read back from JSON, or why it is not one. */
+declare function readRequestForm(input: unknown): RequestFormReading;
+declare function isFormId(value: unknown): value is string;
+/** The longest words the field takes, in characters as people see them. */
+declare function maxLengthOf(field: RequestTextField | RequestLongTextField): number;
+
 /** What stands for the record in the address of its page: `/menu/[record]`. */
 declare const RECORD_PLACEHOLDER = "[record]";
 /** The pages of the records of a collection, as a site describes them to the CMS. */
@@ -162,6 +243,8 @@ interface SiteDescription {
     readonly pages: readonly [SitePageDescription, ...SitePageDescription[]];
     /** The pages of the records of collections; left out when the site has none. */
     readonly recordPages?: readonly SiteRecordPageDescription[];
+    /** The forms of the site's requests; left out when the site has none. */
+    readonly forms?: readonly RequestForm[];
 }
 /** Why a site's description cannot be read: what to fix in the site. */
 type SiteDescriptionProblem = {
@@ -223,6 +306,21 @@ type SiteDescriptionProblem = {
     readonly code: "repeated-record-address";
     readonly collection: string;
     readonly address: string;
+}
+/** The forms are not a list. */
+ | {
+    readonly code: "invalid-forms";
+}
+/** The form at this place of the list is not one. */
+ | {
+    readonly code: "invalid-form";
+    readonly index: number;
+    readonly reason: RequestFormProblemReason;
+}
+/** Two forms with one id: a request names its form by it. */
+ | {
+    readonly code: "repeated-form-id";
+    readonly id: string;
 };
 type PageProblemReason = "not-a-page"
 /** Not `/`, or not lower-case segments without a trailing slash, such as `/menu`. */
@@ -255,4 +353,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 { 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 };
+export { requestLongText as $, type SitePageDescription as A, type SiteRecordPageDescription as B, type CollectionPath as C, DEFAULT_LONG_TEXT_LENGTH as D, checkFields as E, FIELD_PATH_SEPARATOR as F, checkSiteDescription as G, HOME_PAGE_PATH as H, isFormId as I, isRecordPagePath as J, isSearchTextsGroup as K, maxLengthOf as L, MAX_REQUEST_FIELD_LENGTH as M, readFields as N, readRequestForm as O, PAGE_PATH_SEPARATOR as P, readSiteDescription as Q, type RequestForm as R, type SiteDescription as S, recordAddressOf as T, recordAt as U, recordPageAt as V, recordPagePath as W, recordPages as X, requestChoice as Y, requestEmail as Z, requestForm as _, type SiteRecordPages as a, requestPhone as a0, requestText as a1, resolveFieldPath as a2, DEFAULT_TEXT_LENGTH as b, type FieldTarget as c, type FieldsReading as d, type PageProblemReason as e, type PlacedRecord as f, RECORD_PLACEHOLDER as g, type RecordFieldsAt as h, type RecordPagePath as i, type RecordPageProblemReason as j, type RecordPages as k, type RequestChoiceField as l, type RequestEmailField as m, type RequestField as n, type RequestFieldKind as o, type RequestFields as p, type RequestFormProblemReason as q, type RequestFormReading as r, type RequestLongTextField as s, type RequestPhoneField as t, type RequestTextField as u, SITE_DESCRIPTION_PATH as v, type SchemaProblem as w, type SchemaProblemReason as x, type SiteDescriptionProblem as y, type SiteDescriptionReading 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-Bnn6Wa-l.js';
-import { a as SiteRecordPages, S as SiteDescription } from './site-description-BnHrODQX.js';
+import { C as Content, F as Fields, b as ContentOf } from './parse-content-CT2cUVL-.js';
+import { a as SiteRecordPages, S as SiteDescription, R as RequestForm } from './site-description-cKiFtNHW.js';
 
 /** A page of the site: how the editor names it, and the component that renders it. */
 interface SeamletPage {
@@ -58,6 +58,11 @@ interface SeamletSiteDefinition<F extends Fields> {
      * editor can show it in the photo's field. A site without own photos leaves it out.
      */
     readonly photos?: (src: string) => ImageMetadata | undefined;
+    /**
+     * The forms visitors send the business requests with (`requestForm(...)`), rendered with
+     * `RequestForm.astro`: the CMS keeps the requests and passes them on.
+     */
+    readonly forms?: readonly RequestForm[];
 }
 interface SeamletSite<F extends Fields = Fields> {
     readonly id: string;

package/dist/site.js

@@ -6,12 +6,12 @@ import {
   previewedPageAt,
   renderedPageAt,
   staticPagesOf
-} from "./chunk-HFPZVDST.js";
+} from "./chunk-ULOKDC6D.js";
 import {
   checkSiteDescription,
   formatFieldPath,
   parseContent
-} from "./chunk-UL2C2IB2.js";
+} from "./chunk-TMN7KG5M.js";
 
 // src/site.ts
 import { cmsOrigin, siteId, siteTitle } from "virtual:seamlet/config";
@@ -70,13 +70,15 @@ function describeSite(identity, definition) {
       ...searchTexts === void 0 ? {} : { searchTexts }
     })
   );
+  const forms = definition.forms ?? [];
   const description = {
     id: identity.id,
     title: identity.title,
     schema: definition.schema,
     initialContent: definition.initialContent,
     pages,
-    ...recordPages.length === 0 ? {} : { recordPages }
+    ...recordPages.length === 0 ? {} : { recordPages },
+    ...forms.length === 0 ? {} : { forms }
   };
   const asSent = JSON.parse(JSON.stringify(description));
   const reading = checkSiteDescription(asSent);
@@ -127,8 +129,22 @@ function problemText(problem) {
       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`;
+    case "invalid-forms":
+      return "forms is not a list";
+    case "invalid-form":
+      return `form ${String(problem.index + 1)} of forms: ${FORM_PROBLEM_TEXTS[problem.reason]}`;
+    case "repeated-form-id":
+      return `two forms have the id "${problem.id}": a request names its form by it`;
   }
 }
+var FORM_PROBLEM_TEXTS = {
+  "not-a-form": "not a form",
+  "invalid-id": 'its id is not lower-case Latin letters, digits and hyphens, such as "callback"',
+  "invalid-title": "its title is empty",
+  "no-fields": "it has no fields",
+  "invalid-field-name": `a field's name is not a name such as "phone" or "preferredTime"`,
+  "invalid-field": "a field is not a request field, or its label, maxLength or options are not sound"
+};
 var SCHEMA_PROBLEM_TEXTS = {
   "not-fields": "not fields of the schema language",
   "invalid-name": "a field's name must not be empty, hold a dot or be a number",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamlet/astro",
-  "version": "1.2.1",
+  "version": "1.4.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",
@@ -54,7 +54,8 @@
       "types": "./dist/routes/site-description.d.ts",
       "default": "./dist/routes/site-description.js"
     },
-    "./components/RichText.astro": "./components/RichText.astro"
+    "./components/RichText.astro": "./components/RichText.astro",
+    "./components/RequestForm.astro": "./components/RequestForm.astro"
   },
   "files": [
     "dist",