@getquick/content 0.3.1 → 0.4.0

package/dist/descriptor-x8kHFQ79.js

@@ -0,0 +1,205 @@
+//#region frontend/src/forms/descriptor.ts
+/** The Site path the forms handler answers under: `/gq/forms/<formId>`. */
+const FORMS_PATH = "/gq/forms";
+/** The descriptor's wire version; another version doesn't parse. */
+const FORM_DESCRIPTOR_SCHEMA = 1;
+/** The Gravity Forms block a Site's dispatcher routes to the renderer. */
+const GRAVITY_FORMS_BLOCK = "gravityforms/form";
+/** Field types this release renders and submits. */
+const SUPPORTED_FIELD_TYPES = [
+	"text",
+	"textarea",
+	"email",
+	"phone",
+	"number",
+	"website",
+	"select",
+	"radio",
+	"checkbox",
+	"consent",
+	"name",
+	"hidden",
+	"html",
+	"section"
+];
+function isRecord(value) {
+	return typeof value === "object" && value !== null && !Array.isArray(value);
+}
+const text = (value) => typeof value === "string" ? value : "";
+const optionalText = (value) => typeof value === "string" && value !== "" ? value : void 0;
+const finite = (value) => typeof value === "number" && Number.isFinite(value) ? value : void 0;
+const INPUT_NAME = /^input_\d+(?:_\d+)?$/;
+const DIAGNOSTIC_CODES = /* @__PURE__ */ new Set([
+	"unavailable",
+	"unsupported-captcha",
+	"unsupported-file-upload",
+	"unsupported-payment",
+	"unsupported-multi-page",
+	"unsupported-field",
+	"unsupported-conditional-logic",
+	"requires-login"
+]);
+function parseInput(value) {
+	if (!isRecord(value)) return null;
+	const id = text(value.id);
+	const name = text(value.name);
+	if (!/^\d+(?:\.\d+)?$/.test(id) || !INPUT_NAME.test(name)) return null;
+	return {
+		id,
+		name,
+		label: text(value.label),
+		...typeof value.value === "string" ? { value: value.value } : {},
+		...optionalText(value.placeholder) ? { placeholder: text(value.placeholder) } : {},
+		...optionalText(value.autocomplete) ? { autocomplete: text(value.autocomplete) } : {}
+	};
+}
+function parseField(value) {
+	if (!isRecord(value)) return null;
+	const id = value.id;
+	const type = value.type;
+	if (typeof id !== "number" || !Number.isInteger(id) || id < 1) return null;
+	if (!SUPPORTED_FIELD_TYPES.includes(type)) return null;
+	const inputs = Array.isArray(value.inputs) ? value.inputs.map(parseInput).filter((input) => input !== null) : [];
+	const field = {
+		id,
+		type,
+		label: text(value.label),
+		description: text(value.description),
+		required: value.required === true,
+		visibility: value.visibility === "hidden" ? "hidden" : "visible",
+		inputs
+	};
+	if (optionalText(value.placeholder)) field.placeholder = text(value.placeholder);
+	const maxLength = finite(value.maxLength);
+	if (maxLength !== void 0 && maxLength > 0) field.maxLength = Math.floor(maxLength);
+	if (typeof value.defaultValue === "string") field.defaultValue = value.defaultValue;
+	if (optionalText(value.cssClass)) field.cssClass = text(value.cssClass);
+	if (Array.isArray(value.choices)) field.choices = value.choices.filter(isRecord).map((choice) => ({
+		text: text(choice.text),
+		value: text(choice.value),
+		selected: choice.selected === true
+	}));
+	if (isRecord(value.consent)) field.consent = {
+		checkboxLabel: text(value.consent.checkboxLabel),
+		description: text(value.consent.description),
+		revisionId: text(value.consent.revisionId)
+	};
+	if (typeof value.content === "string") field.content = value.content;
+	if (isRecord(value.range)) {
+		const min = finite(value.range.min);
+		const max = finite(value.range.max);
+		field.range = {
+			...min !== void 0 ? { min } : {},
+			...max !== void 0 ? { max } : {}
+		};
+	}
+	return field;
+}
+function parseConfirmation(value) {
+	if (isRecord(value) && value.type === "redirect" && typeof value.url === "string") try {
+		const url = new URL(value.url);
+		if (url.protocol === "https:" || url.protocol === "http:") return {
+			type: "redirect",
+			url: url.href
+		};
+	} catch {}
+	return {
+		type: "message",
+		message: isRecord(value) ? text(value.message) : ""
+	};
+}
+/**
+* A descriptor as the CMS delivered it, keeping only the public fields above,
+* or null when it isn't one. Fields of a type this release doesn't support
+* are left out; the CMS reports them as diagnostics.
+*/
+function parseFormDescriptor(value) {
+	if (!isRecord(value) || value.schema !== 1) return null;
+	const id = value.id;
+	if (typeof id !== "number" || !Number.isInteger(id) || id < 1) return null;
+	const fields = Array.isArray(value.fields) ? value.fields.map(parseField).filter((field) => field !== null) : [];
+	const honeypotName = isRecord(value.honeypot) ? text(value.honeypot.name) : "";
+	const diagnostics = Array.isArray(value.diagnostics) ? value.diagnostics.filter(isRecord).flatMap((diagnostic) => {
+		const code = diagnostic.code;
+		if (!DIAGNOSTIC_CODES.has(code)) return [];
+		const fieldId = finite(diagnostic.fieldId);
+		return [{
+			code,
+			...fieldId !== void 0 ? { fieldId } : {},
+			...optionalText(diagnostic.type) ? { type: text(diagnostic.type) } : {},
+			message: text(diagnostic.message)
+		}];
+	}) : [];
+	return {
+		schema: 1,
+		id,
+		available: value.available === true,
+		title: text(value.title),
+		description: text(value.description),
+		submitLabel: text(value.submitLabel),
+		fields,
+		honeypot: INPUT_NAME.test(honeypotName) ? { name: honeypotName } : null,
+		confirmation: parseConfirmation(value.confirmation),
+		diagnostics
+	};
+}
+/**
+* The descriptors a publication carries (the CMS's `getquickForms`, as JSON
+* text or data), dropping any that don't parse. Undefined for no value.
+*/
+function parseFormDescriptors(value) {
+	let parsed = value;
+	if (typeof parsed === "string") try {
+		parsed = JSON.parse(parsed);
+	} catch {
+		return;
+	}
+	if (!Array.isArray(parsed)) return void 0;
+	return parsed.map(parseFormDescriptor).filter((descriptor) => descriptor !== null);
+}
+/** The form a `gravityforms/form` block shows, from its attributes (`formId`). */
+function blockFormId(attributes) {
+	const raw = attributes?.formId;
+	const id = typeof raw === "string" ? Number(raw) : raw;
+	return typeof id === "number" && Number.isInteger(id) && id > 0 ? id : null;
+}
+/** A form's descriptor among a publication's, or null. */
+function findForm(forms, formId) {
+	return forms?.find((form) => form.id === formId) ?? null;
+}
+/** The path a form posts to on the Site's own origin. */
+const formAction = (formId) => `${FORMS_PATH}/${formId}`;
+/** Everything readiness must fail for: an unavailable form, and each unsupported field or setting. */
+function formDiagnostics(descriptor) {
+	const diagnostics = [...descriptor.diagnostics];
+	if (!descriptor.available && !diagnostics.some((each) => each.code === "unavailable")) diagnostics.unshift({
+		code: "unavailable",
+		message: `Form ${descriptor.id} is missing, inactive or in the trash.`
+	});
+	return diagnostics;
+}
+/**
+* Readiness over the forms a Site's published content references: fails for
+* any diagnostic. `spam` is the Site's declared controls; declaring the
+* honeypot for a form that doesn't enable it is reported as a warning.
+*/
+function formsReadiness(descriptors, options = {}) {
+	const forms = [...new Map(descriptors.map((descriptor) => [descriptor.id, descriptor])).values()].map((descriptor) => {
+		const diagnostics = formDiagnostics(descriptor);
+		return {
+			id: descriptor.id,
+			title: descriptor.title,
+			ok: diagnostics.length === 0,
+			diagnostics,
+			honeypot: descriptor.honeypot !== null
+		};
+	});
+	const warnings = options.spam?.includes("honeypot") ? forms.filter((form) => !form.honeypot).map((form) => `Form ${form.id} doesn't enable Gravity Forms' anti-spam honeypot.`) : [];
+	return {
+		ok: forms.every((form) => form.ok),
+		forms,
+		warnings
+	};
+}
+//#endregion
+export { blockFormId as a, formDiagnostics as c, parseFormDescriptors as d, SUPPORTED_FIELD_TYPES as i, formsReadiness as l, FORM_DESCRIPTOR_SCHEMA as n, findForm as o, GRAVITY_FORMS_BLOCK as r, formAction as s, FORMS_PATH as t, parseFormDescriptor as u };

package/dist/design-client.d.ts

@@ -0,0 +1,19 @@
+//#region frontend/src/carousel-client.d.ts
+/** Mount each Carousel once. Sites invoke on page load and call cleanup before
+ * client navigation replaces the page. DOM APIs are read only on invocation. */
+export declare function mountDesignCarousels(root?: ParentNode): () => void;
+//#endregion
+/** Enhance only decorative media; nested content keeps its native interaction. */
+export declare function mountVideoHero(hero: HTMLElement): () => void;
+//#endregion
+//#region frontend/src/navigation-client.d.ts
+/** Mount the adapter's navigation markup once; cleanup restores server state.
+ * Native links retain ordinary Tab order (this is navigation, not an ARIA menu).
+ * Install navigationStyleSheet alongside the canonical presentation stylesheet. */
+export declare function mountDesignNavigation(root?: ParentNode): () => void;
+//#endregion
+//#region frontend/src/cover-video-client.d.ts
+/** Mount decorative native Cover backgrounds in neutral, saved or delivered HTML.
+ * No DOM access occurs until invocation. The Site owns mounting and cleanup. */
+export declare function mountDesignCoverVideos(root?: ParentNode): () => void;
+//#endregion