@shapio/schema 0.3.1 → 0.4.1

package/dist/index.d.ts

@@ -1,4 +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 { Static, TSchema, Type } from "typebox";
 //#region src/ids.d.ts
 /**
@@ -584,15 +585,27 @@ export declare const listCompatibleEditors: (field: FieldDefinition) => EditorCa
 //#endregion
 //#region src/display/layout.d.ts
 /**
- * Data types that can be blocks in the entry document's canvas. Components must also be repeatable and
- * media must hold several files (`isCanvasEligible`); a single component or file is a property.
+ * Data types that are blocks of the entry document's canvas by default. Components must also be repeatable
+ * and media must hold several files (`isCanvasEligible`); a single component or file is a property unless
+ * `display.canvasFieldIds` places it in the document.
  */
 export declare const CANVAS_ELIGIBLE: ReadonlySet<DataType>;
 /** Title types that the document edits inline as its H1; any other title type stays a property. */
 export declare const INLINE_TITLE_TYPES: ReadonlySet<DataType>;
 /** How many properties the strip shows when `display.stripFieldIds` is not set. */
 export declare const STRIP_DEFAULT_COUNT = 5;
+/**
+ * The automatic rule: the fields written in the document while `display.canvasFieldIds` is unset (rich
+ * text, dynamic zones, repeatable components, media with several files). Also what a canvas field can take
+ * between blocks: only these hold blocks.
+ */
 export declare const isCanvasEligible: (field: FieldDefinition) => boolean;
+/**
+ * Whether `display.canvasFieldIds` may list the field: any field but the entry's title (`effectiveTitleField`),
+ * which the document shows as its heading. A configured cover is refused by the validator; an automatically
+ * chosen one placed in the document simply stops being the cover.
+ */
+export declare const isDocumentPlaceable: (field: FieldDefinition, title: FieldDefinition | undefined) => boolean;
 /** A single `media` field that may hold an image. */
 export declare const isCoverEligible: (field: FieldDefinition) => boolean;
 /** Properties under one of the model's `display.groups` (`label` undefined for ungrouped fields). */
@@ -607,7 +620,10 @@ export type DocumentLayout = {
   /** The title is edited inline as the H1 (string/text); otherwise it is shown read-only and is a property. */
   titleInline: boolean;
   cover: FieldDefinition | undefined;
-  /** Canvas blocks, in order. */
+  /**
+   * The fields written in the document, in order: block fields (`isCanvasEligible`) and any other field
+   * that `display.canvasFieldIds` places there, each under its heading.
+   */
   canvas: FieldDefinition[];
   /** Every other live field, ordered by `display.groups`, then field order. */
   properties: FieldDefinition[];
@@ -620,10 +636,10 @@ export type DocumentLayout = {
   strip: FieldDefinition[] | null;
 };
 /**
- * The entry document's layout: title, cover, canvas blocks and properties. Configured `display` ids win
- * when they point at live, eligible fields; anything else falls back to the defaults (canvas: every
- * eligible field in field order; cover: the first single image field). Deprecated and ineligible ids are
- * skipped, so a stale definition never breaks the editor. Pure: no values, no I/O.
+ * The entry document's layout: title, cover, document fields and properties. Configured `display` ids win
+ * when they point at live, eligible fields; anything else falls back to the defaults (canvas: every block
+ * field in field order; cover: the first single image field not in the canvas). Deprecated, unknown ids and
+ * the title are skipped, so a stale definition never breaks the editor. Pure: no values, no I/O.
  */
 export declare const effectiveLayout: (model: ModelDefinition) => DocumentLayout;
 /** The strip's properties: the configured ones, or the first `limit` that `hasValue` says are non-empty. */
@@ -1171,7 +1187,7 @@ export type ThemeVariant = (typeof THEME_VARIANTS)[number];
 /** A theme key: used in `data-theme` and in CSS selectors, so deliberately narrow. */
 export declare const THEME_KEY_PATTERN: RegExp;
 /** The themes the admin ships; an extension theme may not reuse these keys. */
-export declare const BUILT_IN_THEME_KEYS: readonly ["shapio", "classic", "murdered-out", "snowed"];
+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
@@ -1208,5 +1224,16 @@ export type ContrastCheck = {
 /** Every pair the variant must meet, with its ratio. Missing tokens report an undefined ratio. */
 export declare const checkThemeContrast: (tokens: Readonly<Record<string, string>>, variant: ThemeVariant) => ContrastCheck[];
 //#endregion
-export { RichTextDocument, RichTextNode, RichTextProblem, RichTextResult, isEmptyRichText, richTextMediaIds, validateRichText };
+//#region src/seo/field.d.ts
+/** Whether a field holds the built-in SEO component (by stable ID, whatever its API ID or editor). */
+export declare const isSeoField: (field: FieldDefinition) => boolean;
+//#endregion
+//#region src/seo/definition.d.ts
+/**
+ * The built-in SEO component as first created. All fields are public and none has a length limit: the 70 and
+ * 160 character marks are admin-only counters (`SEO_TITLE_SOFT_MAX`), never validation.
+ */
+export declare const seoComponentDefinition: () => ComponentDefinition;
+//#endregion
+export { DEFAULT_SEO_KEYS, EMPTY_SEO_DEFAULTS, ResolveSeoContext, RichTextDocument, RichTextNode, RichTextProblem, RichTextResult, 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, SeoDefaults, SeoDefaultsSchema, SeoFieldKey, SeoKeys, SeoLocaleDefaults, SeoLocaleDefaultsSchema, applyTitleTemplate, isEmptyRichText, isValidTitleTemplate, resolveSeo, richTextMediaIds, seoDefaultsForLocale, validateRichText };
 //# sourceMappingURL=index.d.ts.map