@shapio/schema 0.3.0 → 0.4.0

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
 /**
@@ -1151,5 +1152,73 @@ 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
-export { RichTextDocument, RichTextNode, RichTextProblem, RichTextResult, isEmptyRichText, richTextMediaIds, validateRichText };
+//#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
+ * dark variant or both. One list, shared by the admin's stylesheets (and their tests) and the API, which
+ * validates themes declared by extensions (`shapio.config` `themes`).
+ */
+/** The UI tokens: every theme variant sets all of them. */
+export declare const THEME_SEMANTIC_TOKENS: readonly ["background", "foreground", "card", "card-foreground", "popover", "popover-foreground", "primary", "primary-foreground", "primary-hover", "secondary", "secondary-foreground", "muted", "muted-foreground", "accent", "accent-foreground", "destructive", "destructive-foreground", "destructive-muted", "success", "success-muted", "warning", "warning-muted", "info", "info-muted", "border", "input", "ring", "link", "overlay", "sidebar", "sidebar-foreground", "sidebar-primary", "sidebar-primary-foreground", "sidebar-accent", "sidebar-accent-foreground", "sidebar-border", "sidebar-ring"];
+/**
+ * The logo (tile, S, letters) and the signed-out screens' brand panel. Built-in themes set them all; an
+ * extension theme may leave them out and gets Shapio's for that variant.
+ */
+export declare const THEME_BRAND_TOKENS: readonly ["brand-logo", "brand-logo-foreground", "brand-letters", "brand-panel-from", "brand-panel-to", "brand-panel-foreground", "brand-panel-mark"];
+export declare const THEME_TOKENS: readonly ["background", "foreground", "card", "card-foreground", "popover", "popover-foreground", "primary", "primary-foreground", "primary-hover", "secondary", "secondary-foreground", "muted", "muted-foreground", "accent", "accent-foreground", "destructive", "destructive-foreground", "destructive-muted", "success", "success-muted", "warning", "warning-muted", "info", "info-muted", "border", "input", "ring", "link", "overlay", "sidebar", "sidebar-foreground", "sidebar-primary", "sidebar-primary-foreground", "sidebar-accent", "sidebar-accent-foreground", "sidebar-border", "sidebar-ring", "brand-logo", "brand-logo-foreground", "brand-letters", "brand-panel-from", "brand-panel-to", "brand-panel-foreground", "brand-panel-mark"];
+export type ThemeToken = (typeof THEME_TOKENS)[number];
+export declare const THEME_VARIANTS: readonly ["light", "dark"];
+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", "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
+ * 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;
+//#endregion
+//#region src/themes/contrast.d.ts
+/**
+ * WCAG 2.1 AA contrast of a theme's tokens: text pairs need 4.5:1 (1.4.3); what identifies a control or the
+ * focus (input borders, unchecked switches, focus rings, primary buttons against the page) needs 3:1 (1.4.11).
+ * The admin's built-in themes are gated on this by a unit test; extension themes get warnings from
+ * `shapio extensions check`. axe checks rendered text only, not these pairs.
+ */
+export type ContrastPair = readonly [foreground: string, background: string];
+export declare const THEME_TEXT_PAIRS: readonly ContrastPair[];
+export declare const THEME_UI_PAIRS: readonly ContrastPair[];
+/**
+ * Dark only: control borders on the selection surface. In light, selected table rows use accent/40, which
+ * 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. */
+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). */
+  ratio: number | undefined;
+};
+/** 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
+//#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