@phtngyn/cms 0.2.0-beta.8 → 0.3.0

package/src/contracts-rprW3ZOB.js

@@ -0,0 +1,130 @@
+import { l as DocumentId } from "./Document-CKXMSEf1.js";
+import { Schema } from "effect";
+//#region ../model/src/internal/forms/contracts.ts
+const FORM_SUBMISSION_MAX_BYTES = 131072;
+const FORM_REVISION_MAX_BYTES = 6e4;
+const FormFieldType = Schema.Literals([
+	"text",
+	"email",
+	"textarea",
+	"number",
+	"checkbox",
+	"select"
+]);
+const FormRule = Schema.Literals([
+	"required",
+	"minLength",
+	"maxLength",
+	"min",
+	"max"
+]);
+const FormCapabilities = Schema.Struct({
+	label: Schema.NonEmptyString,
+	fieldTypes: Schema.Array(FormFieldType).check(Schema.isMinLength(1)),
+	rules: Schema.Array(FormRule)
+});
+const FormOption = Schema.Struct({
+	id: Schema.NonEmptyString,
+	label: Schema.NonEmptyString
+});
+const fieldBase = {
+	id: Schema.NonEmptyString,
+	label: Schema.NonEmptyString,
+	answerKey: Schema.optionalKey(Schema.NonEmptyString),
+	help: Schema.optionalKey(Schema.String),
+	required: Schema.optionalKey(Schema.Boolean)
+};
+const textField = (type) => Schema.Struct({
+	...fieldBase,
+	type: Schema.Literals([type]),
+	minLength: Schema.optionalKey(Schema.Int.check(Schema.isGreaterThanOrEqualTo(0))),
+	maxLength: Schema.optionalKey(Schema.Int.check(Schema.isGreaterThanOrEqualTo(0)))
+});
+const FormField = Schema.Union([
+	textField("text"),
+	textField("email"),
+	textField("textarea"),
+	Schema.Struct({
+		...fieldBase,
+		type: Schema.Literal("number"),
+		min: Schema.optionalKey(Schema.Finite),
+		max: Schema.optionalKey(Schema.Finite)
+	}),
+	Schema.Struct({
+		...fieldBase,
+		type: Schema.Literal("checkbox")
+	}),
+	Schema.Struct({
+		...fieldBase,
+		type: Schema.Literal("select"),
+		options: Schema.NonEmptyArray(FormOption)
+	})
+]);
+const FormStep = Schema.Struct({
+	id: Schema.NonEmptyString,
+	title: Schema.NonEmptyString,
+	fields: Schema.Array(FormField).check(Schema.isMinLength(1), Schema.isMaxLength(100))
+});
+const FormSteps = Schema.Array(FormStep).check(Schema.isMinLength(1), Schema.isMaxLength(20));
+const referenceFields = {
+	documentId: DocumentId,
+	locale: Schema.optionalKey(Schema.String),
+	blockId: Schema.String.check(Schema.isUUID()),
+	revision: Schema.String.check(Schema.isMaxLength(FORM_REVISION_MAX_BYTES))
+};
+const FormReference = Schema.Struct(referenceFields);
+const FormValues = Schema.Record(Schema.String, Schema.Union([
+	Schema.String,
+	Schema.Finite,
+	Schema.Boolean,
+	Schema.Null
+]));
+const FormSubmission = Schema.Struct({
+	...referenceFields,
+	values: FormValues
+});
+const FormIssue = Schema.Union([
+	Schema.Struct({ code: Schema.Literals([
+		"required",
+		"unchecked",
+		"boolean",
+		"number",
+		"text",
+		"option",
+		"email",
+		"unknownAnswers",
+		"rejected"
+	]) }),
+	Schema.Struct({
+		code: Schema.Literals(["min", "max"]),
+		limit: Schema.Finite
+	}),
+	Schema.Struct({
+		code: Schema.Literals(["minLength", "maxLength"]),
+		limit: Schema.Int.check(Schema.isGreaterThanOrEqualTo(0))
+	}),
+	Schema.Struct({
+		code: Schema.Literal("custom"),
+		message: Schema.NonEmptyString
+	})
+]);
+const FormErrors = Schema.Record(Schema.String, FormIssue);
+const FormResult = Schema.Union([
+	Schema.Struct({
+		status: Schema.Literal("accepted"),
+		reference: Schema.optionalKey(Schema.NonEmptyString)
+	}),
+	Schema.Struct({
+		status: Schema.Literal("invalid"),
+		errors: FormErrors
+	}),
+	Schema.Struct({ status: Schema.Literal("stale") }),
+	Schema.Struct({ status: Schema.Literal("unavailable") }),
+	Schema.Struct({ status: Schema.Literal("failed") })
+]);
+/** The submission name is independent of the question's authoring identity. */
+function formAnswerKey(field) {
+	return field.answerKey ?? field.id;
+}
+//#endregion
+export { FormOption as a, FormSteps as c, FormFieldType as i, FormSubmission as l, FORM_SUBMISSION_MAX_BYTES as n, FormReference as o, FormCapabilities as r, FormResult as s, FORM_REVISION_MAX_BYTES as t, formAnswerKey as u };

package/src/forms-3xuf0Ym7.d.ts

@@ -0,0 +1,206 @@
+import { n as FormDefinition } from "./Forms-BuKAXQxr.js";
+import "./Fields-BegSgYhj.js";
+import { i as RevisionRenderNode, r as PublishedDocument } from "./Document-TgwYKJZM.js";
+import { n as DocumentQueryItem, r as DocumentQueryPage } from "./Query-C0kGJF5_.js";
+import { Schema } from "effect";
+//#region ../model/src/RevisionPreview.d.ts
+declare const RevisionPreviewDocument: Schema.Struct<{
+  readonly mode: Schema.Literal<"revision">;
+  readonly primary: Schema.Boolean;
+  readonly identity: Schema.Struct<{
+    readonly documentId: Schema.brand<Schema.String, "DocumentId">;
+    readonly collection: Schema.NonEmptyString;
+  }>;
+  readonly revision: Schema.Struct<{
+    readonly id: Schema.brand<Schema.String, "RevisionId">;
+    readonly number: Schema.Int;
+    readonly savedAt: Schema.String;
+  }>;
+  readonly expiresAt: Schema.NullOr<Schema.String>;
+  readonly previewPath: Schema.Literal<"/_cms/revision-preview">;
+  readonly logicalPath: Schema.NullOr<Schema.String>;
+  readonly livePath: Schema.NullOr<Schema.String>;
+  readonly locale: Schema.optionalKey<Schema.NonEmptyString>;
+  readonly requestedLocale: Schema.optionalKey<Schema.NonEmptyString>;
+  readonly settings: Schema.Struct<{
+    readonly placement: Schema.Union<readonly [Schema.Struct<{
+      readonly kind: Schema.Literal<"home">;
+    }>, Schema.Struct<{
+      readonly kind: Schema.Literal<"entry">;
+      readonly parentDocumentId: Schema.brand<Schema.String, "DocumentId">;
+      readonly slug: Schema.NonEmptyString;
+    }>]>;
+    readonly seo: Schema.optionalKey<Schema.Struct<{
+      readonly title: Schema.optionalKey<Schema.String>;
+      readonly description: Schema.optionalKey<Schema.String>;
+      readonly socialTitle: Schema.optionalKey<Schema.String>;
+      readonly socialDescription: Schema.optionalKey<Schema.String>;
+      readonly socialImage: Schema.optionalKey<Schema.Struct<{
+        readonly mediaId: Schema.brand<Schema.String, "MediaId">;
+        readonly alt: Schema.String;
+      }>>;
+      readonly index: Schema.optionalKey<Schema.Boolean>;
+      readonly follow: Schema.optionalKey<Schema.Boolean>;
+      readonly canonicalUrl: Schema.optionalKey<Schema.String>;
+      readonly structuredData: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literal<"WebPage">;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literal<"Article">;
+        readonly headline: Schema.optionalKey<Schema.String>;
+        readonly datePublished: Schema.optionalKey<Schema.String>;
+        readonly dateModified: Schema.optionalKey<Schema.String>;
+      }>]>>;
+    }>>;
+    readonly translatedSeo: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Struct<{
+      readonly title: Schema.optionalKey<Schema.String>;
+      readonly description: Schema.optionalKey<Schema.String>;
+      readonly socialTitle: Schema.optionalKey<Schema.String>;
+      readonly socialDescription: Schema.optionalKey<Schema.String>;
+      readonly socialImage: Schema.optionalKey<Schema.Struct<{
+        readonly mediaId: Schema.brand<Schema.String, "MediaId">;
+        readonly alt: Schema.String;
+      }>>;
+      readonly index: Schema.optionalKey<Schema.Boolean>;
+      readonly follow: Schema.optionalKey<Schema.Boolean>;
+      readonly canonicalUrl: Schema.optionalKey<Schema.String>;
+      readonly structuredData: Schema.optionalKey<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literal<"WebPage">;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literal<"Article">;
+        readonly headline: Schema.optionalKey<Schema.String>;
+        readonly datePublished: Schema.optionalKey<Schema.String>;
+        readonly dateModified: Schema.optionalKey<Schema.String>;
+      }>]>>;
+    }>>>;
+  }>;
+  readonly content: Schema.Struct<{
+    readonly fields: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    readonly body: Schema.Struct<{
+      readonly type: Schema.Literal<"doc">;
+      readonly content: Schema.$Array<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
+    }>;
+  }>;
+  readonly renderPlan: Schema.Struct<{
+    readonly fields: Schema.Struct<{
+      readonly mode: Schema.Literals<readonly ["current", "readable"]>;
+      readonly values: Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>;
+    }>;
+    readonly body: Schema.$Array<Schema.Codec<RevisionRenderNode, RevisionRenderNode, never, never>>;
+  }>;
+  readonly issues: Schema.$Array<Schema.Struct<{
+    readonly severity: Schema.Literal<"warning">;
+    readonly recovery: Schema.Literals<readonly ["render", "readable", "placeholder", "disabled"]>;
+    readonly code: Schema.String;
+    readonly location: Schema.Union<readonly [Schema.Struct<{
+      readonly kind: Schema.Literal<"field">;
+      readonly path: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Int]>>;
+    }>, Schema.Struct<{
+      readonly kind: Schema.Literal<"block">;
+      readonly blockId: Schema.optionalKey<Schema.String>;
+      readonly path: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Int]>>;
+    }>, Schema.Struct<{
+      readonly kind: Schema.Literal<"seo">;
+      readonly path: Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Int]>>;
+    }>, Schema.Struct<{
+      readonly kind: Schema.Literal<"placement">;
+    }>, Schema.Struct<{
+      readonly kind: Schema.Literal<"body">;
+      readonly path: Schema.optionalKey<Schema.$Array<Schema.Union<readonly [Schema.String, Schema.Int]>>>;
+    }>, Schema.Struct<{
+      readonly kind: Schema.Literal<"document">;
+    }>]>;
+    readonly message: Schema.String;
+    readonly details: Schema.optionalKey<Schema.$Record<Schema.String, Schema.Codec<Schema.Json, Schema.Json, never, never>>>;
+    readonly locale: Schema.optionalKey<Schema.String>;
+  }>>;
+  /** null explicitly disables a destination; a renderer must never fall back to its stored old path. */
+  readonly referencePaths: Schema.$Record<Schema.String, Schema.NullOr<Schema.String>>;
+  readonly forms: Schema.$Array<Schema.Struct<{
+    readonly name: Schema.String;
+    readonly steps: Schema.$Array<Schema.Struct<{
+      readonly id: Schema.NonEmptyString;
+      readonly title: Schema.NonEmptyString;
+      readonly fields: Schema.$Array<Schema.Union<readonly [Schema.Struct<{
+        readonly type: Schema.Literals<readonly ["text"]>;
+        readonly minLength: Schema.optionalKey<Schema.Int>;
+        readonly maxLength: Schema.optionalKey<Schema.Int>;
+        readonly id: Schema.NonEmptyString;
+        readonly label: Schema.NonEmptyString;
+        readonly answerKey: Schema.optionalKey<Schema.NonEmptyString>;
+        readonly help: Schema.optionalKey<Schema.String>;
+        readonly required: Schema.optionalKey<Schema.Boolean>;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literals<readonly ["email"]>;
+        readonly minLength: Schema.optionalKey<Schema.Int>;
+        readonly maxLength: Schema.optionalKey<Schema.Int>;
+        readonly id: Schema.NonEmptyString;
+        readonly label: Schema.NonEmptyString;
+        readonly answerKey: Schema.optionalKey<Schema.NonEmptyString>;
+        readonly help: Schema.optionalKey<Schema.String>;
+        readonly required: Schema.optionalKey<Schema.Boolean>;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literals<readonly ["textarea"]>;
+        readonly minLength: Schema.optionalKey<Schema.Int>;
+        readonly maxLength: Schema.optionalKey<Schema.Int>;
+        readonly id: Schema.NonEmptyString;
+        readonly label: Schema.NonEmptyString;
+        readonly answerKey: Schema.optionalKey<Schema.NonEmptyString>;
+        readonly help: Schema.optionalKey<Schema.String>;
+        readonly required: Schema.optionalKey<Schema.Boolean>;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literal<"number">;
+        readonly min: Schema.optionalKey<Schema.Finite>;
+        readonly max: Schema.optionalKey<Schema.Finite>;
+        readonly id: Schema.NonEmptyString;
+        readonly label: Schema.NonEmptyString;
+        readonly answerKey: Schema.optionalKey<Schema.NonEmptyString>;
+        readonly help: Schema.optionalKey<Schema.String>;
+        readonly required: Schema.optionalKey<Schema.Boolean>;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literal<"checkbox">;
+        readonly id: Schema.NonEmptyString;
+        readonly label: Schema.NonEmptyString;
+        readonly answerKey: Schema.optionalKey<Schema.NonEmptyString>;
+        readonly help: Schema.optionalKey<Schema.String>;
+        readonly required: Schema.optionalKey<Schema.Boolean>;
+      }>, Schema.Struct<{
+        readonly type: Schema.Literal<"select">;
+        readonly options: Schema.NonEmptyArray<Schema.Struct<{
+          readonly id: Schema.NonEmptyString;
+          readonly label: Schema.NonEmptyString;
+        }>>;
+        readonly id: Schema.NonEmptyString;
+        readonly label: Schema.NonEmptyString;
+        readonly answerKey: Schema.optionalKey<Schema.NonEmptyString>;
+        readonly help: Schema.optionalKey<Schema.String>;
+        readonly required: Schema.optionalKey<Schema.Boolean>;
+      }>]>>;
+    }>>;
+    readonly preview: Schema.Literal<true>;
+    readonly documentId: Schema.brand<Schema.String, "DocumentId">;
+    readonly locale: Schema.optionalKey<Schema.String>;
+    readonly blockId: Schema.String;
+    readonly revision: Schema.String;
+  }>>;
+}>;
+interface RevisionPreviewDocument extends Schema.Schema.Type<typeof RevisionPreviewDocument> {}
+//#endregion
+//#region src/internal/forms.d.ts
+interface RevisionRendering extends Pick<RevisionPreviewDocument, 'expiresAt' | 'primary' | 'livePath'> {}
+interface DeliveredDocument extends PublishedDocument {
+  readonly forms?: ReadonlyArray<FormDefinition>;
+  readonly revisionPreview?: RevisionRendering;
+  /** SSR recovery is serialized so hydration renders the same readable regions. */
+  renderFailures?: string[];
+}
+interface DeliveredQueryItem extends DocumentQueryItem {
+  readonly forms?: ReadonlyArray<FormDefinition>;
+  readonly revisionPreview?: RevisionRendering;
+  /** SSR recovery is serialized so hydration renders the same readable regions. */
+  renderFailures?: string[];
+}
+interface DeliveredDocumentPage extends Omit<DocumentQueryPage, 'items'> {
+  readonly items: ReadonlyArray<DeliveredQueryItem>;
+}
+//#endregion
+export { DeliveredDocumentPage as n, DeliveredQueryItem as r, DeliveredDocument as t };

package/src/localeConfiguration-BPbkLi7-.js

@@ -0,0 +1,32 @@
+import { l as DocumentId } from "./Document-CKXMSEf1.js";
+import { n as LocaleConfiguration } from "./Locales-Ch7a5xuA.js";
+import { Option, Schema } from "effect";
+//#region ../model/src/PreviewRoute.ts
+const previewDocumentQueryKey = "__cms_preview";
+/** A query marker chooses working delivery, never authorization. */
+function previewDocumentId(value) {
+	const decoded = Schema.decodeUnknownOption(DocumentId)(value);
+	return Option.isSome(decoded) ? decoded.value : null;
+}
+/** Keep the browser on the site's route while Studio opens a working preview. */
+function previewRouteLocation(path, documentId, version, browse) {
+	const url = new URL(path, "https://cms.invalid");
+	if (url.origin !== "https://cms.invalid") throw new Error("Preview path must belong to this site.");
+	url.searchParams.set(previewDocumentQueryKey, documentId);
+	url.searchParams.set("v", String(version));
+	if (browse) url.searchParams.set("mode", "browse");
+	return `${url.pathname}${url.search}${url.hash}`;
+}
+//#endregion
+//#region src/internal/localeConfiguration.ts
+/** Public runtime configuration is an external boundary; language registries remain strict objects. */
+function decodeLocaleConfiguration(configured) {
+	if (configured === void 0) return void 0;
+	try {
+		return Schema.decodeUnknownSync(LocaleConfiguration)(configured);
+	} catch (cause) {
+		throw new Error("Invalid CMS locale configuration in public.cmsLocales.", { cause });
+	}
+}
+//#endregion
+export { previewRouteLocation as i, previewDocumentId as n, previewDocumentQueryKey as r, decodeLocaleConfiguration as t };

package/src/localeContext-DhF3SPvM.js

@@ -0,0 +1,59 @@
+import { a as resolveLocale, t as Locale } from "./Locales-Ch7a5xuA.js";
+import { l as revisionPreviewNavigationLocation } from "./RevisionPreview-IVwbJ9Wy.js";
+import { n as previewDocumentId, r as previewDocumentQueryKey } from "./localeConfiguration-BPbkLi7-.js";
+import { i as localePath, o as switchLocalePath, r as localeFromPath, s as unlocalizedPath } from "./Routes-BaZvm2LE.js";
+import { Schema } from "effect";
+import { computed, toValue } from "vue";
+//#region src/runtime/delivery/internal/localeContext.ts
+function revisionPreviewLocale(route) {
+	return route.path === "/_cms/revision-preview" && Object.hasOwn(route.query, "locale") ? Schema.decodeUnknownSync(Locale)(route.query.locale) : void 0;
+}
+/** Content URLs select language; the reserved preview address can select a retained translation. */
+function createLocaleContext(route, configuration) {
+	const locales = configuration?.supported.map((definition) => resolveLocale(definition.code, configuration)) ?? [];
+	const defaultLocale = configuration?.defaultLocale;
+	const locale = computed(() => {
+		const current = toValue(route);
+		return revisionPreviewLocale(current) ?? localeFromPath(current.path, configuration);
+	});
+	const direction = computed(() => locale.value ? resolveLocale(locale.value, configuration).dir : "ltr");
+	const sitePath = computed(() => unlocalizedPath(toValue(route).path, configuration));
+	function localePath$1(path, code = locales.some((definition) => definition.code === locale.value) ? locale.value : defaultLocale) {
+		return code ? localePath(path, code, configuration) : path;
+	}
+	function switchLocalePath$1(code, destination) {
+		const current = toValue(route);
+		if (current.path === "/_cms/revision-preview" && destination === void 0) {
+			Schema.decodeSync(Locale)(code);
+			return revisionPreviewNavigationLocation(current.fullPath, current, code) ?? current.fullPath;
+		}
+		const path = destination === void 0 ? switchLocalePath(current.fullPath, code, configuration) : localePath(destination, code, configuration);
+		const saved = revisionPreviewNavigationLocation(path, current);
+		if (saved) return saved;
+		if (destination !== void 0 && previewDocumentId(current.query["__cms_preview"])) {
+			const target = new URL(path, "https://cms.invalid");
+			const source = new URL(current.fullPath, "https://cms.invalid");
+			for (const key of [
+				previewDocumentQueryKey,
+				"v",
+				"mode"
+			]) {
+				target.searchParams.delete(key);
+				for (const value of source.searchParams.getAll(key)) target.searchParams.append(key, value);
+			}
+			return `${target.pathname}${target.search}${target.hash}`;
+		}
+		return path;
+	}
+	return {
+		locale,
+		locales,
+		defaultLocale,
+		direction,
+		sitePath,
+		localePath: localePath$1,
+		switchLocalePath: switchLocalePath$1
+	};
+}
+//#endregion
+export { revisionPreviewLocale as n, createLocaleContext as t };

package/src/locales-6OD4XGIZ.js

@@ -0,0 +1,12 @@
+import { a as resolveLocale } from "./Locales-Ch7a5xuA.js";
+//#region src/internal/locales.ts
+const localeConfigurationKey = Symbol("CMS locales");
+/** Delivered language describes the content, which can differ from the surrounding site's requested language. */
+function contentLanguageAttributes(locale, configuration) {
+	return locale ? {
+		lang: locale,
+		dir: resolveLocale(locale, configuration).dir
+	} : void 0;
+}
+//#endregion
+export { localeConfigurationKey as n, contentLanguageAttributes as t };