@getquick/content 0.3.2 → 0.4.0

package/dist/state-CsMFLUUO.d.ts

@@ -0,0 +1,66 @@
+//#region frontend/src/forms/copy.d.ts
+type FormsCopyLanguage = "en" | "pt-PT";
+type FormErrorCode = "required" | "email" | "email-mismatch" | "number" | "range" | "url" | "choice" | "too-long";
+interface FormsCopy {
+  required: string;
+  requiredFields: string;
+  errorSummary: string;
+  errors: Record<FormErrorCode, string>;
+  /** The submission was refused before reaching the CMS, or the CMS failed. */
+  failed: string;
+  /** Turnstile failed or was missing. */
+  verification: string;
+  /** A submission arrived too fast or too often. */
+  tooMany: string;
+  sent: string;
+  unavailable: string;
+  submit: string;
+  privacyPolicy: string;
+  /** Visible to assistive technology only, on the honeypot (Gravity Forms' wording). */
+  honeypot: string;
+  /** With Turnstile and no JavaScript. */
+  needsJavaScript: string;
+}
+declare const FORMS_COPY: Record<FormsCopyLanguage, FormsCopy>;
+/** The copy language for a page's `lang`: Portuguese for `pt*`, else English. */
+declare function formsCopyLanguage(language: string | null | undefined): FormsCopyLanguage;
+//#endregion
+//#region frontend/src/forms/state.d.ts
+type FormStatus = "sent" | "invalid" | "failed" | "verification" | "too-many";
+interface FormState {
+  formId: number;
+  status: FormStatus;
+  /** Field errors by field id: the descriptor check's codes. */
+  errors: Record<number, FormErrorCode>;
+  /** Gravity Forms' own messages by field id, when it refused the submission. */
+  messages: Record<number, string>;
+  /** What the visitor typed, by input name (left out when too large to keep). */
+  values: Record<string, string>;
+  /** Gravity Forms' confirmation message as text, after a submission it accepted. */
+  confirmation?: string;
+}
+/** The query parameter that marks the redirect back after a post. */
+declare const FORM_STATE_PARAM = "gq-form";
+/** Seconds the outcome is kept for the page after the redirect. */
+declare const FORM_STATE_MAX_AGE = 300;
+declare const formStateCookieName: (formId: number) => string;
+/** The Set-Cookie header that carries a form's outcome to the page. */
+declare function formStateCookie(state: FormState, options: {
+  secure: boolean;
+}): string;
+/** The Set-Cookie header that removes a form's outcome once the page has shown it. */
+declare function clearFormStateCookie(formId: number, options: {
+  secure: boolean;
+}): string;
+/**
+ * A form's outcome for the page: present only on the redirect back after a
+ * post to it (`?gq-form=<id>`), from its cookie. Null otherwise.
+ */
+declare function readFormState(request: {
+  url: string | URL;
+  cookie: string | null | undefined;
+}, formId: number): FormState | null;
+/** Where the handler sends the visitor back to: the page, marked for the form. */
+declare function formStateLocation(source: string, formId: number): string;
+//#endregion
+export { clearFormStateCookie as a, formStateLocation as c, FormErrorCode as d, FormsCopy as f, FormStatus as i, readFormState as l, formsCopyLanguage as m, FORM_STATE_PARAM as n, formStateCookie as o, FormsCopyLanguage as p, FormState as r, formStateCookieName as s, FORM_STATE_MAX_AGE as t, FORMS_COPY as u };

package/dist/validate-wRgYUNxN.js

@@ -0,0 +1,130 @@
+//#region frontend/src/forms/validate.ts
+/** No single value is longer (characters). */
+const MAX_VALUE_LENGTH = 1e4;
+const EMAIL = /^[^\s@<>()[\]\\,;:"]+@[^\s@<>()[\]\\,;:"]+\.[^\s@<>()[\]\\,;:"]+$/;
+function webAddress(value) {
+	try {
+		const url = new URL(value);
+		return (url.protocol === "https:" || url.protocol === "http:") && url.hostname.includes(".");
+	} catch {
+		return false;
+	}
+}
+/**
+* A number as visitors type it in either convention (1234.5, 1,234.5, 1.234,5,
+* 1 234,5): the last separator is the decimal one when both appear. NaN when
+* it isn't one; Gravity Forms checks its own number format again.
+*/
+function parseNumber(value) {
+	let text = value.replace(/[\s\u00a0']/g, "");
+	const dot = text.lastIndexOf(".");
+	const comma = text.lastIndexOf(",");
+	if (dot >= 0 && comma >= 0) text = dot > comma ? text.replaceAll(",", "") : text.replaceAll(".", "").replace(",", ".");
+	else if (comma >= 0) text = text.indexOf(",") === comma ? text.replace(",", ".") : text.replaceAll(",", "");
+	else if ((text.match(/\./g) ?? []).length > 1) text = text.replaceAll(".", "");
+	return /^-?\d+(\.\d+)?$/.test(text) ? Number(text) : NaN;
+}
+/** A posted value, without surrounding whitespace, bounded. */
+function read(values, name) {
+	return (values.get(name) ?? "").trim().slice(0, MAX_VALUE_LENGTH);
+}
+function check(field, values, input, shown) {
+	const take = (name) => {
+		const value = read(values, name);
+		input[name] = value;
+		if (field.visibility === "visible" && field.type !== "hidden") shown[name] = value;
+		return value;
+	};
+	const first = field.inputs[0];
+	switch (field.type) {
+		case "html":
+		case "section": return null;
+		case "hidden": {
+			if (!first) return null;
+			const value = values.get(first.name) === null ? field.defaultValue ?? "" : take(first.name);
+			input[first.name] = value;
+			return null;
+		}
+		case "checkbox": {
+			const chosen = field.inputs.filter((each) => {
+				const value = read(values, each.name);
+				if (value === "") return false;
+				input[each.name] = value;
+				shown[each.name] = value;
+				return true;
+			});
+			if (chosen.some((each) => read(values, each.name) !== each.value)) return "choice";
+			return field.required && chosen.length === 0 ? "required" : null;
+		}
+		case "consent": {
+			if (!first) return null;
+			const checked = read(values, first.name) === "1";
+			if (field.required && !checked) return "required";
+			if (checked) {
+				input[first.name] = "1";
+				shown[first.name] = "1";
+				const [, label, revision] = field.inputs;
+				if (label) input[label.name] = field.consent?.checkboxLabel ?? "";
+				if (revision) input[revision.name] = field.consent?.revisionId ?? "";
+			}
+			return null;
+		}
+		case "name": {
+			const given = field.inputs.map((each) => ({
+				each,
+				value: take(each.name)
+			}));
+			if (!field.required) return null;
+			const essential = given.filter(({ each }) => given.length === 1 || /\.(3|6)$/.test(each.id));
+			return (essential.length ? essential : given).some(({ value }) => value === "") ? "required" : null;
+		}
+		default: {
+			if (!first) return null;
+			const value = take(first.name);
+			if (value === "") {
+				if (field.type === "email" && field.inputs[1]) take(field.inputs[1].name);
+				return field.required ? "required" : null;
+			}
+			if (field.maxLength !== void 0 && Array.from(value).length > field.maxLength) return "too-long";
+			if (field.type === "email") {
+				if (!EMAIL.test(value)) return "email";
+				const confirmation = field.inputs[1];
+				if (confirmation && take(confirmation.name) !== value) return "email-mismatch";
+			}
+			if (field.type === "website" && !webAddress(value)) return "url";
+			if (field.type === "number") {
+				const number = parseNumber(value);
+				if (!Number.isFinite(number)) return "number";
+				if (field.range?.min !== void 0 && number < field.range.min || field.range?.max !== void 0 && number > field.range.max) return "range";
+			}
+			if ((field.type === "select" || field.type === "radio") && !(field.choices ?? []).some((choice) => choice.value === value)) return "choice";
+			return null;
+		}
+	}
+}
+/**
+* Checks a submission against the descriptor: required fields, formats,
+* choices and lengths. Only the descriptor's inputs are kept; the honeypot is
+* passed through, empty, for Gravity Forms' own check.
+*/
+function validateSubmission(descriptor, values) {
+	const input = {};
+	const shown = {};
+	const errors = {};
+	for (const field of descriptor.fields) {
+		const error = check(field, values, input, shown);
+		if (error) errors[field.id] = error;
+	}
+	if (descriptor.honeypot) input[descriptor.honeypot.name] = "";
+	return {
+		input,
+		errors,
+		values: shown
+	};
+}
+/** Whether the honeypot was filled in: a bot. Such a submission never reaches the CMS. */
+function honeypotFilled(descriptor, values) {
+	return descriptor.honeypot !== null && (values.get(descriptor.honeypot.name) ?? "") !== "";
+}
+//#endregion
+export { honeypotFilled as n, validateSubmission as r, MAX_VALUE_LENGTH as t };

package/dist/{version-DkpQm85L.js → version-D81MsCZU.js}

@@ -1,6 +1,6 @@
 //#endregion
 //#region frontend/src/consent/version.ts
 /** The UI/adapter version recorded with each decision (CN-R7). */
-const CONSENT_UI_VERSION = `gq-content@0.3.2`;
+const CONSENT_UI_VERSION = `gq-content@0.4.0`;
 //#endregion
 export { CONSENT_UI_VERSION as t };

package/dist/{wordpress-C1xs3xHN.d.ts → wordpress-BvkTDMA0.d.ts}

@@ -1,5 +1,6 @@
 import { r as ConsentConfiguration, t as AnalyticsSettings } from "./configuration-C_JGygQI.js";
 import { r as LegalLanguage } from "./legal-C5Xiq59W.js";
+import { o as FormDescriptor } from "./descriptor-B-e7gHi1.js";
 //#endregion
 //#region frontend/src/design-text.d.ts
 /** Already loaded, authorized values. No lookup, fetching or query selection.
@@ -118,7 +119,7 @@ type DesignThemeOverrides = { [K in keyof DesignTheme]?: DesignTheme[K] extends
 declare function resolveDesignTheme(overrides?: unknown): DesignTheme;
 /** Complete theme declarations for every supported value, independent of CMS content scanning. */
 declare function designThemeVariables(overrides?: DesignThemeOverrides): Record<string, string>;
-/** Exact pinned Preflight, deliberately scoped away from inspectors and wp-admin. */
+/** Scoped Preflight; the Gutenberg canvas retains native and authored spacing. */
 declare function designThemeStyleSheet(overrides?: DesignThemeOverrides, scope?: string): string;
 /** Color/font extension for the shared presentation parser; never raw utility strings. */
 declare function resolvePresentationToken(kind: string, value: unknown): string | undefined;
@@ -140,6 +141,15 @@ interface PresentationModel {
     default?: string;
   }>>;
   defaults: Record<string, Record<string, string | number>>;
+  /**
+   * Frontend flow rhythm: listed blocks space themselves from a preceding
+   * sibling; layout blocks only from a preceding flow block in body content.
+   */
+  flow?: {
+    blocks: string[];
+    layout?: string[];
+    gap: string;
+  };
 }
 interface PresentationTargets {
   selector?: string;
@@ -215,6 +225,7 @@ declare function presentationVariables(name: string, presentation?: unknown, opt
 /** Static, complete CSS: content first authored after a production build still works. */
 declare function presentationStyleSheet(theme?: PresentationTheme, options?: {
   model?: PresentationModel;
+  editor?: boolean;
 }): string;
 declare namespace content_types_d_exports {
   export { Archives, CmsFailure, CmsFailureReason, CollectionMembership, CollectionTerm, Delivery, DesignPresets, EntryContent, Extended, Found, HomeContent, Missing, PublishedEntry, SiteChrome, Translation, Unavailable, WordPressImage, WordPressMenuItem, WordPressPost, WordPressSettings };
@@ -226,6 +237,11 @@ interface WordPressImage {
 interface WordPressPost {
   databaseId?: number;
   designBlocks?: DesignBlock[];
+  /**
+   * The public descriptors of the Gravity Forms forms it references, on a
+   * Site with `forms` (ADR 0009): what `gravityforms/form` blocks render.
+   */
+  forms?: FormDescriptor[];
   id: string;
   title: string;
   excerpt: string;
@@ -276,6 +292,8 @@ interface HomeContent<X = unknown> extends DesignPresets {
     hasVideoHero: boolean;
     databaseId?: number;
     designBlocks?: DesignBlock[];
+    /** Its Gravity Forms forms' descriptors, on a Site with `forms`. */
+    forms?: FormDescriptor[];
   } & Extended<X>;
   /** WordPress failed on the blocks, so this is the page without them. */
   blocksOmitted: boolean;
@@ -650,6 +668,36 @@ type CollectionTermListing = {
   kind: "found";
   terms: CollectionTermCount[];
 } | NotServed;
+/** Search public content already delivered to this Site's publication store. */
+interface SearchQuery {
+  /** Text to find in titles, excerpts or bodies, ignoring case and accents. Blank finds nothing. */
+  search: string;
+  /** Page from 1; defaults to 1. URL strings are accepted. */
+  page?: number | string;
+  /** Results per page, 1–100; defaults to 12. URL strings are accepted. */
+  perPage?: number | string;
+  /** Configured language slug; defaults to the Site's default language. */
+  language?: string;
+}
+interface SearchItem {
+  /** Canonical path on this Site. */
+  uri: string;
+  /** Plain text, suitable for escaped text rendering. */
+  title: string;
+  /** Plain text excerpt, or a bounded body-text fallback. */
+  excerpt: string;
+  /** Configured language slug, including on monolingual Sites. */
+  language: string;
+}
+interface SearchPage {
+  items: SearchItem[];
+  total: number;
+  page: number;
+  perPage: number;
+  /** Zero when nothing matches. */
+  totalPages: number;
+}
+type SearchDelivery = Found<SearchPage> | NotServed;
 //#endregion
 //#region frontend/src/server.d.ts
 interface ContentConfig<X = never> {
@@ -674,6 +722,14 @@ interface ContentConfig<X = never> {
    * delivery; absent, bodies are delivered as published.
    */
   consent?: ContentConsentConfig;
+  /**
+   * Headless Gravity Forms (ADR 0009). True, each front page, page, post and
+   * item is read with the public descriptors of the forms it references
+   * (gq-content's CMS forms module, active with Gravity Forms), stored with it
+   * as `forms`, and `publishedForm` finds them for the form endpoint. Absent,
+   * reads and stored bodies are unchanged.
+   */
+  forms?: boolean;
   /**
    * The Site's own content on its pages and posts: GraphQL fields the runtime
    * reads with each of them, and the value the Site makes of them, stored with
@@ -773,6 +829,15 @@ declare function createContentRuntime<X = never>(input: ContentConfig<X>): {
   }) => Promise<Response>;
   publishedHome: (siteOrigin?: string, language?: SiteLanguage) => Promise<HomeDelivery<X>>;
   publishedEntry: (path: string, siteOrigin?: string) => Promise<EntryDelivery<X>>;
+  /**
+   * A Gravity Forms form's descriptor as published with the page at a path
+   * (the publication store's, as the page is served), for the form endpoint
+   * (`createFormsServer`'s `descriptor`). Null when the page isn't served,
+   * doesn't reference the form, or the Site doesn't opt in to `forms`.
+   */
+  publishedForm: (path: string, formId: number, siteOrigin?: string) => Promise<FormDescriptor | null>;
+  /** Site-wide text search over delivered public content; never reads WordPress. */
+  search: (query: SearchQuery) => Promise<SearchDelivery>;
   /**
    * A page of a collection's items, from the publication store alone (never
    * WordPress), newest first: those with the given terms and text, in the
@@ -841,4 +906,4 @@ interface WordPressClient<X = unknown> {
   }): Promise<Found<SiteChrome> | Unavailable>;
 }
 //#endregion
-export { Found as $, htmlLang as A, DesignQueryRenderContext as At, designMenuItems as B, Moved as C, designThemeVariables as Ct, SqlStatement as D, DesignPostRecord as Dt, SqlDatabase as E, DesignPostContext as Et, DesignBlock as F, renderDesignPostBlock as Ft, CmsFailure as G, parseDesignBlocks as H, DesignBlockRenderer as I, renderDesignQuery as It, CollectionTerm as J, CmsFailureReason as K, DesignPattern as L, DesignTextContext as Lt, languageSubject as M, designPostContext as Mt, routeLanguage as N, designQueryItems as Nt, SiteLanguage as O, DesignPreloadedPosts as Ot, siteLanguages as P, preloadDesignQueryPosts as Pt, Extended as Q, DesignRenderContext as R, renderDesignText as Rt, HomePublication as S, designThemeStyleSheet as St, ContentBindings as T, resolvePresentationToken as Tt, renderDesignPattern as U, escapeHtml as V, Archives as W, DesignPresets as X, Delivery as Y, EntryContent as Z, EntryDelivery as _, presentationModel as _t, ContentExtension as a, Unavailable as at, HomeDelivery as b, DesignTheme as bt, createContentRuntime as c, WordPressPost as ct, CollectionListing as d, PresentationBreakpoint as dt, HomeContent as et, CollectionPage as f, PresentationModel as ft, DeliveryFailureReason as g, createPresentationModel as gt, CollectionTermListing as h, Property as ht, ContentConsentConfig as i, Translation as it, isLanguageHome as j, DesignQueryResolverOptions as jt, WordPressLanguages as k, DesignQueryItem as kt, Alternate as l, WordPressSettings as lt, CollectionTermCount as m, PresentationTheme as mt, CollectionConfig as n, PublishedEntry as nt, ContentRuntime as o, WordPressImage as ot, CollectionQuery as p, PresentationTargets as pt, CollectionMembership as q, ContentConfig as r, SiteChrome as rt, ExtensionNode as s, WordPressMenuItem as st, WordPressClient as t, Missing as tt, CollectionItem as u, Presentation as ut, EntryPage as v, presentationStyleSheet as vt, NotServed as w, resolveDesignTheme as wt, HomePage as x, DesignThemeOverrides as xt, EntryPublication as y, presentationVariables as yt, DesignRenderOptions as z, safeDesignRichText as zt };
+export { Delivery as $, SqlDatabase as A, DesignPostContext as At, DesignBlockRenderer as B, renderDesignQuery as Bt, Moved as C, presentationVariables as Ct, SearchPage as D, designThemeVariables as Dt, SearchItem as E, designThemeStyleSheet as Et, isLanguageHome as F, DesignQueryResolverOptions as Ft, escapeHtml as G, DesignRenderContext as H, renderDesignText as Ht, languageSubject as I, designPostContext as It, Archives as J, parseDesignBlocks as K, routeLanguage as L, designQueryItems as Lt, SiteLanguage as M, DesignPreloadedPosts as Mt, WordPressLanguages as N, DesignQueryItem as Nt, SearchQuery as O, resolveDesignTheme as Ot, htmlLang as P, DesignQueryRenderContext as Pt, CollectionTerm as Q, siteLanguages as R, preloadDesignQueryPosts as Rt, HomePublication as S, presentationStyleSheet as St, SearchDelivery as T, DesignThemeOverrides as Tt, DesignRenderOptions as U, safeDesignRichText as Ut, DesignPattern as V, DesignTextContext as Vt, designMenuItems as W, CmsFailureReason as X, CmsFailure as Y, CollectionMembership as Z, EntryDelivery as _, PresentationTargets as _t, ContentExtension as a, Missing as at, HomeDelivery as b, createPresentationModel as bt, createContentRuntime as c, Translation as ct, CollectionListing as d, WordPressMenuItem as dt, DesignPresets as et, CollectionPage as f, WordPressPost as ft, DeliveryFailureReason as g, PresentationModel as gt, CollectionTermListing as h, PresentationBreakpoint as ht, ContentConsentConfig as i, HomeContent as it, SqlStatement as j, DesignPostRecord as jt, ContentBindings as k, resolvePresentationToken as kt, Alternate as l, Unavailable as lt, CollectionTermCount as m, Presentation as mt, CollectionConfig as n, Extended as nt, ContentRuntime as o, PublishedEntry as ot, CollectionQuery as p, WordPressSettings as pt, renderDesignPattern as q, ContentConfig as r, Found as rt, ExtensionNode as s, SiteChrome as st, WordPressClient as t, EntryContent as tt, CollectionItem as u, WordPressImage as ut, EntryPage as v, PresentationTheme as vt, NotServed as w, DesignTheme as wt, HomePage as x, presentationModel as xt, EntryPublication as y, Property as yt, DesignBlock as z, renderDesignPostBlock as zt };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@getquick/content",
-  "version": "0.3.2",
+  "version": "0.4.0",
   "license": "UNLICENSED",
   "files": [
     "dist",
@@ -61,6 +61,22 @@
     "./design/client": {
       "types": "./dist/design-client.d.ts",
       "import": "./dist/design-client.js"
+    },
+    "./forms": {
+      "types": "./dist/forms.d.ts",
+      "import": "./dist/forms.js"
+    },
+    "./forms/astro": {
+      "types": "./dist/forms-astro.d.ts",
+      "import": "./dist/forms-astro.js"
+    },
+    "./forms/server": {
+      "types": "./dist/forms-server.d.ts",
+      "import": "./dist/forms-server.js"
+    },
+    "./forms/testing": {
+      "types": "./dist/forms-testing.d.ts",
+      "import": "./dist/forms-testing.js"
     }
   },
   "publishConfig": {