@shapio/schema 0.5.9 → 0.5.10

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { a as isEmptyRichText, i as RichTextResult, n as RichTextNode, o as richTextMediaIds, r as RichTextProblem, s as validateRichText, t as RichTextDocument } from "./validate-Oyo0GJ9j.js";
-import { S as SeoFieldKey, _ as SEO_FIELD_IDS, a as EMPTY_SEO_DEFAULTS, b as SEO_TITLE_TEMPLATE_PATTERN, c as seoDefaultsForLocale, d as SeoLocaleDefaults, f as SeoLocaleDefaultsSchema, g as SEO_EDITOR_ID, h as SEO_DESCRIPTION_SOFT_MAX, i as resolveSeo, l as SeoDefaults, m as SEO_COMPONENT_ID, n as ResolveSeoContext, o as applyTitleTemplate, p as SEO_COMPONENT_API_KEY, r as SeoKeys, s as isValidTitleTemplate, t as DEFAULT_SEO_KEYS, u as SeoDefaultsSchema, v as SEO_TITLE_PLACEHOLDER, x as SEO_TWITTER_HANDLE_PATTERN, y as SEO_TITLE_SOFT_MAX } from "./resolve-7-z9VQqw.js";
+import { S as SeoFieldKey, _ as SEO_FIELD_IDS, a as EMPTY_SEO_DEFAULTS, b as SEO_TITLE_TEMPLATE_PATTERN, c as seoDefaultsForLocale, d as SeoLocaleDefaults, f as SeoLocaleDefaultsSchema, g as SEO_EDITOR_ID, h as SEO_DESCRIPTION_SOFT_MAX, i as resolveSeo, l as SeoDefaults, m as SEO_COMPONENT_ID, n as ResolveSeoContext, o as applyTitleTemplate, p as SEO_COMPONENT_API_KEY, r as SeoKeys, s as isValidTitleTemplate, t as DEFAULT_SEO_KEYS, u as SeoDefaultsSchema, v as SEO_TITLE_PLACEHOLDER, x as SEO_TWITTER_HANDLE_PATTERN, y as SEO_TITLE_SOFT_MAX } from "./resolve-DlXILdG3.js";
 import { Static, TSchema, Type } from "typebox";
 //#region src/ids.d.ts
 /**
@@ -660,28 +660,28 @@ export declare const UID_PATTERN: RegExp;
 export declare const RICHTEXT_FORMAT = "shapio-richtext";
 export declare const RICHTEXT_FORMAT_VERSION = 1;
 //#endregion
-//#region src/editors/catalogue.d.ts
+//#region src/editors/catalog.d.ts
 /**
  * Built-in editors (ADR 0009): which data types each can edit and the schema of its options. The server
- * validates every field's editor choice against this catalogue, so selecting and configuring an editor is
+ * validates every field's editor choice against this catalog, so selecting and configuring an editor is
  * runtime metadata. Custom editors (loaded at runtime from the project) use namespaced IDs containing a dot,
  * e.g. `acme.colorWheel`; their options are free-form JSON here because their schema lives in the project.
  */
-export type EditorCatalogueEntry = {
+export type EditorCatalogEntry = {
   id: string;
   dataTypes: readonly DataType[];
   optionsSchema: TSchema;
   /** Extra compatibility rule beyond the data type (e.g. radio buttons only for single-value enums). */
   supports?: (field: FieldDefinition) => boolean;
 };
-export declare const EDITOR_CATALOGUE: ReadonlyMap<string, EditorCatalogueEntry>;
+export declare const EDITOR_CATALOG: ReadonlyMap<string, EditorCatalogEntry>;
 /** The editor a field gets when its definition names none. */
 export declare const DEFAULT_EDITORS: Readonly<Record<DataType, string>>;
 /** `vendor.name` (letters, digits, `_`, `-`), e.g. `acme.colorWheel`. Built-in IDs never contain a dot. */
 export declare const CUSTOM_EDITOR_ID_PATTERN: RegExp;
 export declare const isCustomEditorId: (id: string) => boolean;
 /** Built-in editors that can edit this field (for the admin's editor picker). */
-export declare const listCompatibleEditors: (field: FieldDefinition) => EditorCatalogueEntry[];
+export declare const listCompatibleEditors: (field: FieldDefinition) => EditorCatalogEntry[];
 //#endregion
 //#region src/display/layout.d.ts
 /**
@@ -762,7 +762,7 @@ export type FormLayout = {
 /**
  * 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
+ * field order, and every run of consecutive ungrouped fields is an unlabeled 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.
  */
@@ -1476,11 +1476,11 @@ export declare const THEME_KEY_PATTERN: RegExp;
 export declare const BUILT_IN_THEME_KEYS: readonly ["shapio", "classic", "murdered-out", "forest", "snowed", "butter"];
 export type BuiltInThemeKey = (typeof BUILT_IN_THEME_KEYS)[number];
 /**
- * A token value an extension may use: a hex colour or a colour function whose arguments are numbers, units
+ * A token value an extension may use: a hex color or a color function whose arguments are numbers, units
  * and separators only (no `;`, quotes, braces or nested functions such as `url()` or `var()`), so a value
  * can never escape its declaration.
  */
-export declare const THEME_COLOUR_PATTERN: RegExp;
+export declare const THEME_COLOR_PATTERN: RegExp;
 //#endregion
 //#region src/themes/contrast.d.ts
 /**
@@ -1497,14 +1497,14 @@ export declare const THEME_UI_PAIRS: readonly ContrastPair[];
  * passes, and other selected surfaces hold no controls.
  */
 export declare const THEME_DARK_UI_PAIRS: readonly ContrastPair[];
-/** The WCAG contrast ratio of two `#rrggbb` colours. */
+/** The WCAG contrast ratio of two `#rrggbb` colors. */
 export declare const contrastRatio: (a: string, b: string) => number;
 export type ContrastCheck = {
   foreground: string;
   background: string;
   /** 4.5 for text, 3 for controls. */
   required: number;
-  /** Undefined when a value is not a `#rrggbb` colour (functions such as `oklch()` are not checked). */
+  /** Undefined when a value is not a `#rrggbb` color (functions such as `oklch()` are not checked). */
   ratio: number | undefined;
 };
 /** Every pair the variant must meet, with its ratio. Missing tokens report an undefined ratio. */

package/dist/index.js

@@ -1,5 +1,5 @@
 import { _ as STABLE_ID_PATTERN, a as MAX_RICHTEXT_DEPTH, c as BIGINTEGER_PATTERN, d as DECIMAL_PATTERN, f as RICHTEXT_FORMAT, g as UID_PATTERN, h as TIME_PATTERN, i as MARK_RULES, l as DATETIME_PATTERN, m as SLUG_PATTERN, n as richTextMediaIds, o as NODE_RULES, p as RICHTEXT_FORMAT_VERSION, r as validateRichText, s as SAFE_LINK_PATTERN, t as isEmptyRichText, u as DATE_PATTERN, v as createStableId, y as isStableId } from "./validate-BQGutaBo.js";
-import { a as isValidTitleTemplate, c as SEO_COMPONENT_ID, d as SEO_FIELD_IDS, f as SEO_TITLE_PLACEHOLDER, h as SEO_TWITTER_HANDLE_PATTERN, i as applyTitleTemplate, l as SEO_DESCRIPTION_SOFT_MAX, m as SEO_TITLE_TEMPLATE_PATTERN, n as resolveSeo, o as seoDefaultsForLocale, p as SEO_TITLE_SOFT_MAX, r as EMPTY_SEO_DEFAULTS, s as SEO_COMPONENT_API_KEY, t as DEFAULT_SEO_KEYS, u as SEO_EDITOR_ID } from "./resolve-viddCEYd.js";
+import { a as isValidTitleTemplate, c as SEO_COMPONENT_ID, d as SEO_FIELD_IDS, f as SEO_TITLE_PLACEHOLDER, h as SEO_TWITTER_HANDLE_PATTERN, i as applyTitleTemplate, l as SEO_DESCRIPTION_SOFT_MAX, m as SEO_TITLE_TEMPLATE_PATTERN, n as resolveSeo, o as seoDefaultsForLocale, p as SEO_TITLE_SOFT_MAX, r as EMPTY_SEO_DEFAULTS, s as SEO_COMPONENT_API_KEY, t as DEFAULT_SEO_KEYS, u as SEO_EDITOR_ID } from "./resolve-Csjpkpue.js";
 import { Type } from "typebox";
 import pluralize from "pluralize";
 import { Value } from "typebox/value";
@@ -414,7 +414,7 @@ const SETTINGS_SCHEMAS = {
 /** Whether a field holds the built-in SEO component (by stable ID, whatever its API ID or editor). */
 const isSeoField = (field) => field.type === "component" && field.settings.component === "f3905a00-d2a3-4c62-899a-c894bfd6cb9b" && !field.settings.repeatable;
 //#endregion
-//#region src/editors/catalogue.ts
+//#region src/editors/catalog.ts
 const closed$1 = { additionalProperties: false };
 const Placeholder = Type.Optional(Type.String({ maxLength: 200 }));
 const isMultipleEnum = (field) => field.type === "enum" && field.settings.multiple;
@@ -568,7 +568,7 @@ const entries = [
 		optionsSchema: Type.Object({ collapsed: Type.Optional(Type.Boolean()) }, closed$1)
 	}
 ];
-const EDITOR_CATALOGUE = new Map(entries.map((entry) => [entry.id, entry]));
+const EDITOR_CATALOG = new Map(entries.map((entry) => [entry.id, entry]));
 /** The editor a field gets when its definition names none. */
 const DEFAULT_EDITORS = {
 	string: "textInput",
@@ -736,7 +736,7 @@ const ungroupedSectionId = (first, groupIds) => {
 /**
 * 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
+* field order, and every run of consecutive ungrouped fields is an unlabeled 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.
 */
@@ -1555,7 +1555,7 @@ const checkFlags = (field, path, isComponent) => {
 const checkEditor = (field, path) => {
 	const { id, options } = field.editor;
 	if (isCustomEditorId(id)) return [];
-	const entry = EDITOR_CATALOGUE.get(id);
+	const entry = EDITOR_CATALOG.get(id);
 	if (!entry) return [issue(`${path}/editor/id`, "UNKNOWN_EDITOR", `"${id}" is not a built-in editor (custom editors use a vendor.name ID)`)];
 	if (!entry.dataTypes.includes(field.type) || !(entry.supports?.(field) ?? true)) return [issue(`${path}/editor/id`, "INCOMPATIBLE_EDITOR", `the ${id} editor cannot edit this ${field.type} field`)];
 	return collectSchemaErrors(entry.optionsSchema, options, `${path}/editor/options`).map((error) => issue(error.path, "INVALID_EDITOR_OPTIONS", error.message));
@@ -2996,11 +2996,11 @@ const BUILT_IN_THEME_KEYS = [
 	"butter"
 ];
 /**
-* A token value an extension may use: a hex colour or a colour function whose arguments are numbers, units
+* A token value an extension may use: a hex color or a color function whose arguments are numbers, units
 * and separators only (no `;`, quotes, braces or nested functions such as `url()` or `var()`), so a value
 * can never escape its declaration.
 */
-const THEME_COLOUR_PATTERN = /^(?:#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})|(?:rgba?|hsla?|oklch|oklab)\([0-9a-z.,%\s/+-]{1,80}\))$/;
+const THEME_COLOR_PATTERN = /^(?:#(?:[0-9a-fA-F]{3,4}|[0-9a-fA-F]{6}|[0-9a-fA-F]{8})|(?:rgba?|hsla?|oklch|oklab)\([0-9a-z.,%\s/+-]{1,80}\))$/;
 //#endregion
 //#region src/themes/contrast.ts
 const SURFACES = [
@@ -3085,7 +3085,7 @@ const luminance = (hex) => {
 	].map((index) => channel(parseInt(hex.slice(index, index + 2), 16)));
 	return .2126 * (r ?? 0) + .7152 * (g ?? 0) + .0722 * (b ?? 0);
 };
-/** The WCAG contrast ratio of two `#rrggbb` colours. */
+/** The WCAG contrast ratio of two `#rrggbb` colors. */
 const contrastRatio = (a, b) => {
 	const [high = 0, low = 0] = [luminance(a), luminance(b)].sort((x, y) => y - x);
 	return (high + .05) / (low + .05);
@@ -3189,6 +3189,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, ENTRY_LAYOUTS, EditorChoiceInputSchema, EnumValueSchema, FIELD_WIDTHS, FieldInputSchema, INLINE_TITLE_TYPES, INTERFACE_TYPE_SUFFIX, INVALID_TEXT_MESSAGE, 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_INHERITANCE_DEPTH, MAX_LABEL_LENGTH, MAX_RICHTEXT_DEPTH, MAX_ROUTE_KEY_LENGTH, 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, ROUTE_KEY_PATTERN, 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, ancestorChain, applyTitleTemplate, assignIds, canonicalJson, changeDropsValues, checkApiKeySyntax, checkDefaultValue, checkDisplay, checkInheritance, checkThemeContrast, classifyChange, classifyChanges, classifyLocaleChange, collectionQueryName, contrastRatio, createDefinitionIndex, createStableId, decideSync, diffDefinitions, effectiveFormLayout, effectiveLayout, effectiveTitleField, embeddedComponentIds, entryLayoutOf, escapeHtml, findChildDefinitions, findDependentModels, findInvalidText, findReferencingDefinitions, foldApiKey, generatedNames, hashDefinition, isApiKeySyntaxValid, isCanvasEligible, isComponentDefinition, isCoverEligible, isCustomEditorId, isDataType, isDocumentPlaceable, isEmptyRichText, isModelDefinition, isSeoField, isStableId, isValidText, isValidTitleTemplate, issue, listCompatibleEditors, lockCoversSite, lockEntriesForSite, mergeDisplay, mergePulledLock, normalizeDefinition, ownFields, parseDefinition, parseLockFile, plainTextToRichText, renderRichTextHtml, renormalizeDefinition, resolveModelDefinition, resolveSeo, richTextBodyOf, richTextMediaIds, richTextPlainText, richTextToPlainText, routeKeyOf, routePathOf, schemaFilePath, scopeDirectory, scopeOfSchemaFilePath, seoComponentDefinition, seoDefaultsForLocale, serializeDefinition, serializeLockFile, sha256, splitRoutePath, storageFamilyOf, stripFieldsOf, suggestPlural, summarizeChanges, toTypeName, typeChangeDropsValues, uniqueFieldsChangingLocalization, 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_CATALOG, EMPTY_SEO_DEFAULTS, ENTRY_LAYOUTS, EditorChoiceInputSchema, EnumValueSchema, FIELD_WIDTHS, FieldInputSchema, INLINE_TITLE_TYPES, INTERFACE_TYPE_SUFFIX, INVALID_TEXT_MESSAGE, 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_INHERITANCE_DEPTH, MAX_LABEL_LENGTH, MAX_RICHTEXT_DEPTH, MAX_ROUTE_KEY_LENGTH, 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, ROUTE_KEY_PATTERN, 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_COLOR_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, ancestorChain, applyTitleTemplate, assignIds, canonicalJson, changeDropsValues, checkApiKeySyntax, checkDefaultValue, checkDisplay, checkInheritance, checkThemeContrast, classifyChange, classifyChanges, classifyLocaleChange, collectionQueryName, contrastRatio, createDefinitionIndex, createStableId, decideSync, diffDefinitions, effectiveFormLayout, effectiveLayout, effectiveTitleField, embeddedComponentIds, entryLayoutOf, escapeHtml, findChildDefinitions, findDependentModels, findInvalidText, findReferencingDefinitions, foldApiKey, generatedNames, hashDefinition, isApiKeySyntaxValid, isCanvasEligible, isComponentDefinition, isCoverEligible, isCustomEditorId, isDataType, isDocumentPlaceable, isEmptyRichText, isModelDefinition, isSeoField, isStableId, isValidText, isValidTitleTemplate, issue, listCompatibleEditors, lockCoversSite, lockEntriesForSite, mergeDisplay, mergePulledLock, normalizeDefinition, ownFields, parseDefinition, parseLockFile, plainTextToRichText, renderRichTextHtml, renormalizeDefinition, resolveModelDefinition, resolveSeo, richTextBodyOf, richTextMediaIds, richTextPlainText, richTextToPlainText, routeKeyOf, routePathOf, schemaFilePath, scopeDirectory, scopeOfSchemaFilePath, seoComponentDefinition, seoDefaultsForLocale, serializeDefinition, serializeLockFile, sha256, splitRoutePath, storageFamilyOf, stripFieldsOf, suggestPlural, summarizeChanges, toTypeName, typeChangeDropsValues, uniqueFieldsChangingLocalization, upgradeLockFile, validateDefinition, validateRichText, validateSchema, withDerivedPlural, withSiteCovered };
 
 //# sourceMappingURL=index.js.map