@shapio/schema 0.5.4 → 0.5.6

package/dist/index.d.ts

@@ -181,6 +181,19 @@ export declare const DEFINITION_KINDS: readonly ["collection", "singleton", "com
 export type DefinitionKind = (typeof DEFINITION_KINDS)[number];
 export declare const SORT_DIRECTIONS: readonly ["asc", "desc"];
 export type SortDirection = (typeof SORT_DIRECTIONS)[number];
+/**
+ * How an entry of a model opens: `document` (title typed into the page, blocks in a canvas, properties in
+ * the strip and the settings drawer) or `form` (every field inline at its `width`, sections from
+ * `display.groups`). Unset means `document`; normalizing drops an explicit `document`.
+ */
+export declare const ENTRY_LAYOUTS: readonly ["document", "form"];
+export type EntryLayout = (typeof ENTRY_LAYOUTS)[number];
+/**
+ * A field's width in a form-layout entry, as a share of the row: rows fill in field order and wrap. Unset
+ * means `full`; normalizing drops an explicit `full`.
+ */
+export declare const FIELD_WIDTHS: readonly ["full", "two-thirds", "half", "third"];
+export type FieldWidth = (typeof FIELD_WIDTHS)[number];
 export declare const MAX_FIELDS_PER_DEFINITION = 500;
 export declare const MAX_LABEL_LENGTH = 200;
 export declare const MAX_DESCRIPTION_LENGTH = 2000;
@@ -213,8 +226,15 @@ export declare const FieldInputSchema: Type.TObject<{
     id: Type.TString;
     options: Type.TOptional<Type.TRecord<"^.*$", Type.TUnknown>>;
   }>>;
+  /**
+   * Width in a form-layout entry (`display.layout: 'form'`). Default `full`. Model fields only: the
+   * validator refuses it on a component's field.
+   */
+  width: Type.TOptional<Type.TEnum<["full", "two-thirds", "half", "third"]>>;
 }>;
 export declare const ModelDisplayInputSchema: Type.TObject<{
+  /** How entries open: `document` (default) or `form`. See `ENTRY_LAYOUTS`. */
+  layout: Type.TOptional<Type.TEnum<["document", "form"]>>;
   /** Field whose value labels an entry in lists, pickers and relation summaries. */
   titleFieldId: Type.TOptional<Type.TString>;
   /** Columns of the content list, in order. */
@@ -255,6 +275,8 @@ export declare const ModelDefinitionInputSchema: Type.TObject<{
   /** Entries have separate draft and published states. Default true. */
   draftAndPublish: Type.TOptional<Type.TBoolean>;
   display: Type.TOptional<Type.TObject<{
+    /** How entries open: `document` (default) or `form`. See `ENTRY_LAYOUTS`. */
+    layout: Type.TOptional<Type.TEnum<["document", "form"]>>;
     /** Field whose value labels an entry in lists, pickers and relation summaries. */
     titleFieldId: Type.TOptional<Type.TString>;
     /** Columns of the content list, in order. */
@@ -305,6 +327,11 @@ export declare const ModelDefinitionInputSchema: Type.TObject<{
       id: Type.TString;
       options: Type.TOptional<Type.TRecord<"^.*$", Type.TUnknown>>;
     }>>;
+    /**
+     * Width in a form-layout entry (`display.layout: 'form'`). Default `full`. Model fields only: the
+     * validator refuses it on a component's field.
+     */
+    width: Type.TOptional<Type.TEnum<["full", "two-thirds", "half", "third"]>>;
   }>>;
 }>;
 export declare const ComponentDefinitionInputSchema: Type.TObject<{
@@ -348,6 +375,11 @@ export declare const ComponentDefinitionInputSchema: Type.TObject<{
       id: Type.TString;
       options: Type.TOptional<Type.TRecord<"^.*$", Type.TUnknown>>;
     }>>;
+    /**
+     * Width in a form-layout entry (`display.layout: 'form'`). Default `full`. Model fields only: the
+     * validator refuses it on a component's field.
+     */
+    width: Type.TOptional<Type.TEnum<["full", "two-thirds", "half", "third"]>>;
   }>>;
 }>;
 export declare const DefinitionInputSchema: Type.TUnion<[Type.TObject<{
@@ -361,6 +393,8 @@ export declare const DefinitionInputSchema: Type.TUnion<[Type.TObject<{
   /** Entries have separate draft and published states. Default true. */
   draftAndPublish: Type.TOptional<Type.TBoolean>;
   display: Type.TOptional<Type.TObject<{
+    /** How entries open: `document` (default) or `form`. See `ENTRY_LAYOUTS`. */
+    layout: Type.TOptional<Type.TEnum<["document", "form"]>>;
     /** Field whose value labels an entry in lists, pickers and relation summaries. */
     titleFieldId: Type.TOptional<Type.TString>;
     /** Columns of the content list, in order. */
@@ -411,6 +445,11 @@ export declare const DefinitionInputSchema: Type.TUnion<[Type.TObject<{
       id: Type.TString;
       options: Type.TOptional<Type.TRecord<"^.*$", Type.TUnknown>>;
     }>>;
+    /**
+     * Width in a form-layout entry (`display.layout: 'form'`). Default `full`. Model fields only: the
+     * validator refuses it on a component's field.
+     */
+    width: Type.TOptional<Type.TEnum<["full", "two-thirds", "half", "third"]>>;
   }>>;
 }>, Type.TObject<{
   kind: Type.TLiteral<"component">;
@@ -453,6 +492,11 @@ export declare const DefinitionInputSchema: Type.TUnion<[Type.TObject<{
       id: Type.TString;
       options: Type.TOptional<Type.TRecord<"^.*$", Type.TUnknown>>;
     }>>;
+    /**
+     * Width in a form-layout entry (`display.layout: 'form'`). Default `full`. Model fields only: the
+     * validator refuses it on a component's field.
+     */
+    width: Type.TOptional<Type.TEnum<["full", "two-thirds", "half", "third"]>>;
   }>>;
 }>]>;
 export type FieldInput = Static<typeof FieldInputSchema>;
@@ -477,6 +521,8 @@ type FieldBase = {
   deprecated: boolean;
   defaultValue?: JsonValue;
   editor: EditorChoice;
+  /** Width in a form-layout entry; absent means `full`. */
+  width?: FieldWidth;
 };
 /** A normalized field. Narrow on `type` to get typed `settings`. */
 export type FieldDefinition<T extends DataType = DataType> = { [K in T]: FieldBase & {
@@ -489,6 +535,8 @@ export type FieldGroup = {
   fieldIds: string[];
 };
 export type ModelDisplay = {
+  /** Absent means `document`. */
+  layout?: EntryLayout;
   titleFieldId?: string;
   listFieldIds?: string[];
   defaultSort?: {
@@ -657,6 +705,34 @@ export type DocumentLayout = {
 export declare const effectiveLayout: (model: ModelDefinition) => DocumentLayout;
 /** The strip's properties: the configured ones, or the first `limit` that `hasValue` says are non-empty. */
 export declare const stripFieldsOf: (layout: DocumentLayout, hasValue: (field: FieldDefinition) => boolean, limit?: number) => FieldDefinition[];
+/** How the model's entries open (`display.layout`): `document` unless set to `form`. */
+export declare const entryLayoutOf: (model: ModelDefinition) => EntryLayout;
+/**
+ * One section of a form-layout entry: a `display.groups` group (its `id` and `label`), or a run of
+ * consecutive ungrouped fields (`label` undefined). A run's `id` is `ungrouped-<ID of its first field>`:
+ * stable while that field stays first, and unique because a field starts one run at most. Should a group
+ * be given that very ID, the run's ID gets `~` prefixed until no group has it.
+ */
+export type FieldSection = PropertyGroup;
+export type FormLayout = {
+  /** The field that labels the entry (`effectiveTitleField`): the page heading. It is also in `sections`. */
+  title: FieldDefinition | undefined;
+  /** Every live field, in sections. */
+  sections: FieldSection[];
+};
+/**
+ * The entry form's layout (`display.layout: 'form'`): every live field, the title included, in sections.
+ * Field order decides everything: a group's section sits where its first field appears, with its fields in
+ * field order, and every run of consecutive ungrouped fields is an unlabelled section of its own at its
+ * place. So name, price, sku, description with a Pricing group (price, sku) reads [name], Pricing [price,
+ * sku], [description]. Unknown and deprecated ids are skipped. Pure: no values, no I/O.
+ */
+export declare const effectiveFormLayout: (model: ModelDefinition) => FormLayout;
+/**
+ * The entry's rich-text body, which "Summarize from body" reads: the document's rich-text canvas fields, or
+ * every live rich-text field of a form (a form has no canvas; its fields are all on the page).
+ */
+export declare const richTextBodyOf: (model: ModelDefinition) => FieldDefinition[];
 //#endregion
 //#region src/display/titleField.d.ts
 /** Field types that may label entries: the only types `display.titleFieldId` accepts, and the fallback's. */
@@ -701,8 +777,9 @@ export type DefinitionInputWithIds = (WithIds<ModelDefinitionInput> & {
 /**
  * Applies defaults so that two definitions meaning the same thing are byte-identical once serialized
  * canonically: a hand-written file that omits `public` hashes the same as one that says `public: true`.
- * Empty optional strings and arrays are dropped. A collection without a plural API ID gets the suggested
- * one (`suggestPlural`), so files and definitions from before plural API IDs keep working.
+ * Empty optional strings and arrays are dropped, and so are the defaults of keys added after definitions
+ * were first hashed (`width: 'full'`, `display.layout: 'document'`). A collection without a plural API ID
+ * gets the suggested one (`suggestPlural`), so files and definitions from before plural API IDs keep working.
  */
 export declare const normalizeDefinition: (input: DefinitionInputWithIds) => SchemaDefinition;
 /** Normalizes a definition that is already normalized-shaped (e.g. read back from the database). */
@@ -905,6 +982,7 @@ export declare const diffDefinitions: (before: SchemaDefinition | null, after: S
  * | (plus) type change of a unique field | as its type change               | + checkUnique                 |
  * | (plus) tightened validation rules    | validation                       | validateValues                |
  * | (plus) localized true→false          | conversion (destructive)         | convert                       |
+ * | (plus) type change Shapio can't convert | conversion (destructive, drops) | convert (+ validate/required) |
  */
 export type ChangeCategory = 'metadata' | 'editorSwap' | 'additive' | 'requiredField' | 'validation' | 'conversion' | 'contract' | 'removal' | 'constraint' | 'index';
 /** Work that must succeed before activation. Content-touching kinds run through the content ports. */
@@ -917,8 +995,10 @@ export type ClassifiedChange = SchemaChange & {
   breaking: boolean;
   /** Loses stored information that a schema rollback cannot restore. */
   destructive: boolean;
-  /** False for conversions Shapio cannot perform; the planner refuses them. */
+  /** False for changes Shapio cannot perform; the planner refuses them. None today; kept for future refusals. */
   supported: boolean;
+  /** A type change Shapio cannot convert: every stored value of the field is dropped (destructive). */
+  dropsValues: boolean;
   prerequisites: PrerequisiteKind[];
   cleanup: CleanupKind[];
 };
@@ -926,6 +1006,11 @@ export type ClassifyContext = {
   before: SchemaDefinition | null;
   after: SchemaDefinition | null;
 };
+/**
+ * A type change Shapio cannot convert: the field keeps its stable ID and API ID, and every stored value is
+ * dropped. The planner (`classifyChange`) and the content conversion share this one rule.
+ */
+export declare const typeChangeDropsValues: (from: DataType, to: DataType) => boolean;
 /** Classifies one change in the context of the definitions it was diffed from. */
 export declare const classifyChange: (change: SchemaChange, context: ClassifyContext) => ClassifiedChange;
 export declare const classifyChanges: (changes: readonly SchemaChange[], context: ClassifyContext) => ClassifiedChange[];
@@ -1180,6 +1265,14 @@ export declare const richTextToPlainText: (document: RichTextDocument) => string
 /** Plain text → a document of paragraphs (blank lines split paragraphs; single newlines are hard breaks). */
 export declare const plainTextToRichText: (text: string) => RichTextDocument;
 //#endregion
+//#region src/richtext/plainText.d.ts
+/**
+ * A stored rich text value (`{ format, version, doc }`) as one line of plain text: blocks separated by a
+ * space, whitespace collapsed. For summaries (list cells, collapsed items, review rows), never for delivery.
+ * Anything that is not a valid document (an unconverted value of a field that became rich text) reads as ''.
+ */
+export declare const richTextPlainText: (value: unknown) => string;
+//#endregion
 //#region src/themes/tokens.d.ts
 /**
  * Admin themes (docs/plans/themes.md): a theme is a named, complete set of these tokens for a light variant, a

package/dist/index.js

@@ -110,6 +110,22 @@ const closed$3 = { additionalProperties: false };
 const MODEL_KINDS = ["collection", "singleton"];
 const DEFINITION_KINDS = [...MODEL_KINDS, "component"];
 const SORT_DIRECTIONS = ["asc", "desc"];
+/**
+* How an entry of a model opens: `document` (title typed into the page, blocks in a canvas, properties in
+* the strip and the settings drawer) or `form` (every field inline at its `width`, sections from
+* `display.groups`). Unset means `document`; normalizing drops an explicit `document`.
+*/
+const ENTRY_LAYOUTS = ["document", "form"];
+/**
+* A field's width in a form-layout entry, as a share of the row: rows fill in field order and wrap. Unset
+* means `full`; normalizing drops an explicit `full`.
+*/
+const FIELD_WIDTHS = [
+	"full",
+	"two-thirds",
+	"half",
+	"third"
+];
 const MAX_FIELDS_PER_DEFINITION = 500;
 const MAX_LABEL_LENGTH = 200;
 const MAX_DESCRIPTION_LENGTH = 2e3;
@@ -146,7 +162,12 @@ const FieldInputSchema = Type.Object({
 	defaultValue: Type.Optional(Type.Unknown()),
 	/** Type-specific settings, validated against SETTINGS_SCHEMAS[type]. */
 	settings: Type.Optional(Type.Record(Type.String(), Type.Unknown())),
-	editor: Type.Optional(EditorChoiceInputSchema)
+	editor: Type.Optional(EditorChoiceInputSchema),
+	/**
+	* Width in a form-layout entry (`display.layout: 'form'`). Default `full`. Model fields only: the
+	* validator refuses it on a component's field.
+	*/
+	width: Type.Optional(Type.Enum(FIELD_WIDTHS))
 }, closed$3);
 const FieldGroupSchema = Type.Object({
 	id: Type.String({
@@ -157,6 +178,8 @@ const FieldGroupSchema = Type.Object({
 	fieldIds: Type.Array(Type.String())
 }, closed$3);
 const ModelDisplayInputSchema = Type.Object({
+	/** How entries open: `document` (default) or `form`. See `ENTRY_LAYOUTS`. */
+	layout: Type.Optional(Type.Enum(ENTRY_LAYOUTS)),
 	/** Field whose value labels an entry in lists, pickers and relation summaries. */
 	titleFieldId: Type.Optional(Type.String()),
 	/** Columns of the content list, in order. */
@@ -693,6 +716,66 @@ const effectiveLayout = (model) => {
 };
 /** The strip's properties: the configured ones, or the first `limit` that `hasValue` says are non-empty. */
 const stripFieldsOf = (layout, hasValue, limit = 5) => layout.strip ?? layout.properties.filter(hasValue).slice(0, limit);
+/** How the model's entries open (`display.layout`): `document` unless set to `form`. */
+const entryLayoutOf = (model) => model.display.layout ?? "document";
+const ungroupedSectionId = (first, groupIds) => {
+	let candidate = `ungrouped-${first.id}`;
+	while (groupIds.has(candidate)) candidate = `~${candidate}`;
+	return candidate;
+};
+/**
+* The entry form's layout (`display.layout: 'form'`): every live field, the title included, in sections.
+* Field order decides everything: a group's section sits where its first field appears, with its fields in
+* field order, and every run of consecutive ungrouped fields is an unlabelled section of its own at its
+* place. So name, price, sku, description with a Pricing group (price, sku) reads [name], Pricing [price,
+* sku], [description]. Unknown and deprecated ids are skipped. Pure: no values, no I/O.
+*/
+const effectiveFormLayout = (model) => {
+	const groups = model.display.groups ?? [];
+	const groupIds = new Set(groups.map((group) => group.id));
+	const groupOf = /* @__PURE__ */ new Map();
+	for (const group of groups) for (const fieldId of group.fieldIds) if (!groupOf.has(fieldId)) groupOf.set(fieldId, group);
+	const sections = [];
+	const groupSections = /* @__PURE__ */ new Map();
+	let run;
+	for (const field of model.fields) {
+		if (field.deprecated) continue;
+		const group = groupOf.get(field.id);
+		if (!group) {
+			if (!run) {
+				run = {
+					id: ungroupedSectionId(field, groupIds),
+					label: void 0,
+					fields: []
+				};
+				sections.push(run);
+			}
+			run.fields.push(field);
+			continue;
+		}
+		run = void 0;
+		let section = groupSections.get(group.id);
+		if (!section) {
+			section = {
+				id: group.id,
+				label: group.label,
+				fields: []
+			};
+			groupSections.set(group.id, section);
+			sections.push(section);
+		}
+		section.fields.push(field);
+	}
+	return {
+		title: effectiveTitleField(model),
+		sections
+	};
+};
+/**
+* The entry's rich-text body, which "Summarize from body" reads: the document's rich-text canvas fields, or
+* every live rich-text field of a form (a form has no canvas; its fields are all on the page).
+*/
+const richTextBodyOf = (model) => entryLayoutOf(model) === "form" ? model.fields.filter((field) => field.type === "richtext" && !field.deprecated) : effectiveLayout(model).canvas.filter((field) => field.type === "richtext");
 //#endregion
 //#region src/validators/apiKey.ts
 /**
@@ -796,17 +879,22 @@ const normalizeField = (field) => {
 		editor: {
 			id: field.editor?.id ?? DEFAULT_EDITORS[field.type],
 			options: field.editor?.options ?? {}
-		}
+		},
+		width: field.width === "full" ? void 0 : field.width
 	};
 	return withoutEmpty(normalized);
 };
-const normalizeModelDisplay = (display) => withoutEmpty({ ...display });
+const normalizeModelDisplay = (display) => withoutEmpty({
+	...display,
+	layout: display?.layout === "document" ? void 0 : display?.layout
+});
 const normalizeComponentDisplay = (display) => withoutEmpty({ ...display });
 /**
 * Applies defaults so that two definitions meaning the same thing are byte-identical once serialized
 * canonically: a hand-written file that omits `public` hashes the same as one that says `public: true`.
-* Empty optional strings and arrays are dropped. A collection without a plural API ID gets the suggested
-* one (`suggestPlural`), so files and definitions from before plural API IDs keep working.
+* Empty optional strings and arrays are dropped, and so are the defaults of keys added after definitions
+* were first hashed (`width: 'full'`, `display.layout: 'document'`). A collection without a plural API ID
+* gets the suggested one (`suggestPlural`), so files and definitions from before plural API IDs keep working.
 */
 const normalizeDefinition = (input) => {
 	const fields = input.fields.map(normalizeField);
@@ -1219,6 +1307,7 @@ const checkFlags = (field, path, isComponent) => {
 			"filterable",
 			"sortable"
 		]) if (field[flag]) reject(flag, `fields of a component cannot be ${flag}`);
+		if (field.width !== void 0) reject("width", "fields of a component have no width");
 	}
 	if (field.deprecated && field.required) reject("required", "a deprecated field cannot be required");
 	return issues;
@@ -1672,7 +1761,8 @@ const DEFINITION_METADATA = [
 const FIELD_METADATA = [
 	"label",
 	"description",
-	"defaultValue"
+	"defaultValue",
+	"width"
 ];
 const FIELD_FLAGS = [
 	["required", "field.required"],
@@ -1833,6 +1923,7 @@ const result = (category, extra = {}) => ({
 	breaking: false,
 	destructive: false,
 	supported: true,
+	dropsValues: false,
 	prerequisites: [],
 	cleanup: [],
 	...extra
@@ -1882,27 +1973,54 @@ const hasTextConstraints = (field) => {
 	return settings.minLength !== void 0 || settings.maxLength !== void 0 || settings.pattern !== void 0 || settings.validate === true;
 };
 /**
+* Whether Shapio converts a cross-family type change value by value (the pairs it knows); within one storage
+* family the stored JSON stays as it is.
+*/
+const convertsAcrossFamilies = (from, to) => {
+	const fromFamily = STORAGE_FAMILY[from];
+	const toFamily = STORAGE_FAMILY[to];
+	const numericPair = fromFamily === "jsonNumber" && toFamily === "numericString" || fromFamily === "numericString" && toFamily === "jsonNumber";
+	const toText = SCALAR_FAMILIES.has(fromFamily) && PLAIN_TEXT_TYPES.has(to);
+	const textToRichtext = fromFamily === "jsonString" && from !== "code" && to === "richtext";
+	const richtextToText = from === "richtext" && PLAIN_TEXT_TYPES.has(to);
+	return numericPair || toText || textToRichtext || richtextToText;
+};
+/**
+* A type change Shapio cannot convert: the field keeps its stable ID and API ID, and every stored value is
+* dropped. The planner (`classifyChange`) and the content conversion share this one rule.
+*/
+const typeChangeDropsValues = (from, to) => STORAGE_FAMILY[from] !== STORAGE_FAMILY[to] && !convertsAcrossFamilies(from, to);
+/** A required field whose values are dropped is backfilled from its default, else checked (no silent nulls). */
+const requiredStep = (field) => {
+	if (!field?.required) return [];
+	return [field.defaultValue !== void 0 ? "backfill" : "validateRequired"];
+};
+/**
 * A type change. Within one storage family the stored JSON stays as it is: widening is live, anything else
-* re-validates existing values. Across families Shapio converts values with a job, for the pairs it knows.
+* re-validates existing values. Across families Shapio converts values with a job, for the pairs it knows;
+* any other pair drops the values (destructive, acknowledged in the review).
 */
 const classifyTypeChange = (from, to, after) => {
 	const breaking = API_SCALAR[from] !== API_SCALAR[to] || to === "code" && from !== "code";
 	const fromFamily = STORAGE_FAMILY[from];
-	const toFamily = STORAGE_FAMILY[to];
-	if (fromFamily === toFamily) return fromFamily === "jsonString" && TEXT_TARGETS.has(to) && !hasTextConstraints(after) || from === "integer" && to === "number" || from === "biginteger" && to === "decimal" && after?.type === "decimal" && after.settings.precision === void 0 ? result("additive", { breaking }) : result("validation", {
+	if (fromFamily === STORAGE_FAMILY[to]) return fromFamily === "jsonString" && TEXT_TARGETS.has(to) && !hasTextConstraints(after) || from === "integer" && to === "number" || from === "biginteger" && to === "decimal" && after?.type === "decimal" && after.settings.precision === void 0 ? result("additive", { breaking }) : result("validation", {
 		breaking,
 		prerequisites: ["validateValues"]
 	});
-	const numericPair = fromFamily === "jsonNumber" && toFamily === "numericString" || fromFamily === "numericString" && toFamily === "jsonNumber";
-	const toText = SCALAR_FAMILIES.has(fromFamily) && PLAIN_TEXT_TYPES.has(to);
-	const textToRichtext = fromFamily === "jsonString" && from !== "code" && to === "richtext";
-	const richtextToText = from === "richtext" && PLAIN_TEXT_TYPES.has(to);
-	const supported = numericPair || toText || textToRichtext || richtextToText;
+	if (typeChangeDropsValues(from, to)) return result("conversion", {
+		breaking,
+		destructive: true,
+		dropsValues: true,
+		prerequisites: [
+			"convert",
+			"validateValues",
+			...requiredStep(after)
+		]
+	});
 	return result("conversion", {
 		breaking,
-		supported,
-		destructive: richtextToText,
-		prerequisites: supported ? ["convert", "validateValues"] : []
+		destructive: from === "richtext" && PLAIN_TEXT_TYPES.has(to),
+		prerequisites: ["convert", "validateValues"]
 	});
 };
 const compareValues = (a, b) => {
@@ -2406,6 +2524,17 @@ const plainTextToRichText = (text) => {
 	};
 };
 //#endregion
+//#region src/richtext/plainText.ts
+/**
+* A stored rich text value (`{ format, version, doc }`) as one line of plain text: blocks separated by a
+* space, whitespace collapsed. For summaries (list cells, collapsed items, review rows), never for delivery.
+* Anything that is not a valid document (an unconverted value of a field that became rich text) reads as ''.
+*/
+const richTextPlainText = (value) => {
+	const result = validateRichText(value);
+	return result.ok ? richTextToPlainText(result.document).replace(/\s+/g, " ").trim() : "";
+};
+//#endregion
 //#region src/themes/tokens.ts
 /**
 * Admin themes (docs/plans/themes.md): a theme is a named, complete set of these tokens for a light variant, a
@@ -2672,6 +2801,6 @@ const SeoDefaultsSchema = Type.Object({
 	twitterHandle: Type.Union([Type.String({ pattern: SEO_TWITTER_HANDLE_PATTERN.source }), Type.Null()])
 }, closed);
 //#endregion
-export { API_KEY_PATTERN, BIGINTEGER_PATTERN, BUILT_IN_THEME_KEYS, CANVAS_ELIGIBLE, CHANGE_KINDS, CODE_LANGUAGES, COMPONENT_TYPE_SUFFIXES, CUSTOM_EDITOR_ID_PATTERN, ComponentDefinitionInputSchema, ComponentDisplayInputSchema, DATA_TYPES, DATETIME_PATTERN, DATE_PATTERN, DECIMAL_PATTERN, DEFAULT_EDITORS, DEFAULT_SEO_KEYS, DEFINITION_KINDS, DefinitionInputSchema, EDITOR_CATALOGUE, EMPTY_SEO_DEFAULTS, EditorChoiceInputSchema, EnumValueSchema, FieldInputSchema, INLINE_TITLE_TYPES, LOCALE_CODE_PATTERN, LOCK_FILE_FORMAT_VERSION, LOCK_FILE_PATH, LocaleInputSchema, LockEntrySchema, LockFileError, LockFileSchema, MARK_RULES, MAX_API_KEY_LENGTH, MAX_COMPONENT_DEPTH, MAX_DESCRIPTION_LENGTH, MAX_FALLBACK_CHAIN, MAX_FIELDS_PER_DEFINITION, MAX_LABEL_LENGTH, MAX_RICHTEXT_DEPTH, MEDIA_KINDS, MODEL_KINDS, MODEL_TYPE_SUFFIXES, MUTATION_PREFIXES, ModelDefinitionInputSchema, ModelDisplayInputSchema, NODE_RULES, PLURAL_FALLBACK_SUFFIX, REFERENCE_DATA_TYPES, RELATION_CARDINALITIES, RESERVED_DEFINITION_API_KEYS, RESERVED_FIELD_API_KEYS, RESERVED_QUERY_NAMES, RESERVED_TYPE_NAMES, RICHTEXT_FORMAT, RICHTEXT_FORMAT_VERSION, SAFE_LINK_PATTERN, SCALAR_DATA_TYPES, SCHEMA_KIND_DIRECTORIES, SEO_COMPONENT_API_KEY, SEO_COMPONENT_ID, SEO_DESCRIPTION_SOFT_MAX, SEO_EDITOR_ID, SEO_FIELD_IDS, SEO_TITLE_PLACEHOLDER, SEO_TITLE_SOFT_MAX, SEO_TITLE_TEMPLATE_PATTERN, SEO_TWITTER_HANDLE_PATTERN, SETTINGS_SCHEMAS, SITES_DIRECTORY, SLUG_PATTERN, SORT_DIRECTIONS, STABLE_ID_PATTERN, STORAGE_FAMILY, STRIP_DEFAULT_COUNT, SchemaValidationError, SeoDefaultsSchema, SeoLocaleDefaultsSchema, TEXT_TITLE_FIELD_TYPES, THEME_BRAND_TOKENS, THEME_COLOUR_PATTERN, THEME_DARK_UI_PAIRS, THEME_KEY_PATTERN, THEME_SEMANTIC_TOKENS, THEME_TEXT_PAIRS, THEME_TOKENS, THEME_UI_PAIRS, THEME_VARIANTS, TIME_PATTERN, TITLE_FIELD_TYPES, UID_PATTERN, UNIQUE_CAPABLE_DATA_TYPES, applyTitleTemplate, assignIds, canonicalJson, checkApiKeySyntax, checkDefaultValue, checkThemeContrast, classifyChange, classifyChanges, classifyLocaleChange, collectionQueryName, contrastRatio, createStableId, decideSync, diffDefinitions, effectiveLayout, effectiveTitleField, embeddedComponentIds, escapeHtml, findDependentModels, findReferencingDefinitions, foldApiKey, generatedNames, hashDefinition, isApiKeySyntaxValid, isCanvasEligible, isComponentDefinition, isCoverEligible, isCustomEditorId, isDataType, isDocumentPlaceable, isEmptyRichText, isModelDefinition, isSeoField, isStableId, isValidTitleTemplate, issue, listCompatibleEditors, lockCoversSite, lockEntriesForSite, mergePulledLock, normalizeDefinition, parseDefinition, parseLockFile, plainTextToRichText, renderRichTextHtml, renormalizeDefinition, resolveSeo, richTextMediaIds, richTextToPlainText, routeKeyOf, schemaFilePath, scopeDirectory, scopeOfSchemaFilePath, seoComponentDefinition, seoDefaultsForLocale, serializeDefinition, serializeLockFile, sha256, stripFieldsOf, suggestPlural, summarizeChanges, toTypeName, upgradeLockFile, validateDefinition, validateRichText, validateSchema, withDerivedPlural, withSiteCovered };
+export { API_KEY_PATTERN, BIGINTEGER_PATTERN, BUILT_IN_THEME_KEYS, CANVAS_ELIGIBLE, CHANGE_KINDS, CODE_LANGUAGES, COMPONENT_TYPE_SUFFIXES, CUSTOM_EDITOR_ID_PATTERN, ComponentDefinitionInputSchema, ComponentDisplayInputSchema, DATA_TYPES, DATETIME_PATTERN, DATE_PATTERN, DECIMAL_PATTERN, DEFAULT_EDITORS, DEFAULT_SEO_KEYS, DEFINITION_KINDS, DefinitionInputSchema, EDITOR_CATALOGUE, EMPTY_SEO_DEFAULTS, ENTRY_LAYOUTS, EditorChoiceInputSchema, EnumValueSchema, FIELD_WIDTHS, FieldInputSchema, INLINE_TITLE_TYPES, LOCALE_CODE_PATTERN, LOCK_FILE_FORMAT_VERSION, LOCK_FILE_PATH, LocaleInputSchema, LockEntrySchema, LockFileError, LockFileSchema, MARK_RULES, MAX_API_KEY_LENGTH, MAX_COMPONENT_DEPTH, MAX_DESCRIPTION_LENGTH, MAX_FALLBACK_CHAIN, MAX_FIELDS_PER_DEFINITION, MAX_LABEL_LENGTH, MAX_RICHTEXT_DEPTH, MEDIA_KINDS, MODEL_KINDS, MODEL_TYPE_SUFFIXES, MUTATION_PREFIXES, ModelDefinitionInputSchema, ModelDisplayInputSchema, NODE_RULES, PLURAL_FALLBACK_SUFFIX, REFERENCE_DATA_TYPES, RELATION_CARDINALITIES, RESERVED_DEFINITION_API_KEYS, RESERVED_FIELD_API_KEYS, RESERVED_QUERY_NAMES, RESERVED_TYPE_NAMES, RICHTEXT_FORMAT, RICHTEXT_FORMAT_VERSION, SAFE_LINK_PATTERN, SCALAR_DATA_TYPES, SCHEMA_KIND_DIRECTORIES, SEO_COMPONENT_API_KEY, SEO_COMPONENT_ID, SEO_DESCRIPTION_SOFT_MAX, SEO_EDITOR_ID, SEO_FIELD_IDS, SEO_TITLE_PLACEHOLDER, SEO_TITLE_SOFT_MAX, SEO_TITLE_TEMPLATE_PATTERN, SEO_TWITTER_HANDLE_PATTERN, SETTINGS_SCHEMAS, SITES_DIRECTORY, SLUG_PATTERN, SORT_DIRECTIONS, STABLE_ID_PATTERN, STORAGE_FAMILY, STRIP_DEFAULT_COUNT, SchemaValidationError, SeoDefaultsSchema, SeoLocaleDefaultsSchema, TEXT_TITLE_FIELD_TYPES, THEME_BRAND_TOKENS, THEME_COLOUR_PATTERN, THEME_DARK_UI_PAIRS, THEME_KEY_PATTERN, THEME_SEMANTIC_TOKENS, THEME_TEXT_PAIRS, THEME_TOKENS, THEME_UI_PAIRS, THEME_VARIANTS, TIME_PATTERN, TITLE_FIELD_TYPES, UID_PATTERN, UNIQUE_CAPABLE_DATA_TYPES, applyTitleTemplate, assignIds, canonicalJson, checkApiKeySyntax, checkDefaultValue, checkThemeContrast, classifyChange, classifyChanges, classifyLocaleChange, collectionQueryName, contrastRatio, createStableId, decideSync, diffDefinitions, effectiveFormLayout, effectiveLayout, effectiveTitleField, embeddedComponentIds, entryLayoutOf, escapeHtml, findDependentModels, findReferencingDefinitions, foldApiKey, generatedNames, hashDefinition, isApiKeySyntaxValid, isCanvasEligible, isComponentDefinition, isCoverEligible, isCustomEditorId, isDataType, isDocumentPlaceable, isEmptyRichText, isModelDefinition, isSeoField, isStableId, isValidTitleTemplate, issue, listCompatibleEditors, lockCoversSite, lockEntriesForSite, mergePulledLock, normalizeDefinition, parseDefinition, parseLockFile, plainTextToRichText, renderRichTextHtml, renormalizeDefinition, resolveSeo, richTextBodyOf, richTextMediaIds, richTextPlainText, richTextToPlainText, routeKeyOf, schemaFilePath, scopeDirectory, scopeOfSchemaFilePath, seoComponentDefinition, seoDefaultsForLocale, serializeDefinition, serializeLockFile, sha256, stripFieldsOf, suggestPlural, summarizeChanges, toTypeName, typeChangeDropsValues, upgradeLockFile, validateDefinition, validateRichText, validateSchema, withDerivedPlural, withSiteCovered };
 
 //# sourceMappingURL=index.js.map