@datocms/cma-client 5.0.1 → 5.1.0

package/dist/types/utilities/structuredText.d.ts

@@ -0,0 +1,177 @@
+/**
+ * Tree manipulation utilities for DatoCMS structured text documents.
+ *
+ * Provides a set of low-level utilities for visiting, transforming, and querying
+ * structured text trees. Works with all tree variants (regular, request, nested).
+ */
+/**
+ * Recursively extract all possible node types that can appear in a tree structure
+ */
+type AllNodesInTree<T, Depth extends number = 10> = Depth extends 0 ? T extends readonly unknown[] ? never : T : T extends readonly (infer U)[] ? AllNodesInTree<U, Prev<Depth>> : T extends {
+    children: infer Children;
+} ? T | AllNodesInTree<Children, Prev<Depth>> : T;
+type Prev<T extends number> = T extends 0 ? 0 : T extends 1 ? 0 : T extends 2 ? 1 : T extends 3 ? 2 : T extends 4 ? 3 : T extends 5 ? 4 : T extends 6 ? 5 : T extends 7 ? 6 : T extends 8 ? 7 : T extends 9 ? 8 : T extends 10 ? 9 : number;
+/**
+ * Path through the Structured Text tree structure
+ */
+export type TreePath = readonly (string | number)[];
+/**
+ * Generic predicate function type for Structured Text tree node filtering
+ */
+export type NodePredicate<T, R> = (node: AllNodesInTree<T>, parent: AllNodesInTree<T> | null, path: TreePath) => R;
+/**
+ * Visit every node in the Structured Text tree, calling the visitor function for each.
+ * Uses pre-order traversal (parent is visited before its children).
+ *
+ * @template T - The type of the root node in the Structured Text tree
+ * @param node - The root node to start visiting from
+ * @param visitor - Synchronous function called for each node. Receives the node, its parent, and path through the Structured Text tree
+ */
+export declare function visitNodes<T>(node: T, visitor: NodePredicate<T, void>, parent?: AllNodesInTree<T> | null, path?: TreePath): void;
+/**
+ * Visit every node in the Structured Text tree, calling the visitor function for each.
+ * Uses pre-order traversal (parent is visited before its children).
+ *
+ * @template T - The type of the root node in the Structured Text tree
+ * @param node - The root node to start visiting from
+ * @param visitor - Asynchronous function called for each node. Receives the node, its parent, and path through the Structured Text tree
+ * @returns Promise that resolves when all nodes have been visited
+ */
+export declare function visitNodesAsync<T>(node: T, visitor: NodePredicate<T, Promise<void>>, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<void>;
+/**
+ * Transform nodes in the Structured Text tree by applying a mapping function.
+ * Creates a new tree structure with transformed nodes while preserving the Structured Text tree hierarchy.
+ *
+ * @template T - The type of nodes in the input Structured Text tree
+ * @template R - The type of nodes in the output tree
+ * @param node - The root node to start mapping from
+ * @param mapper - Synchronous function that transforms each node. Receives the node, its parent, and path
+ * @returns The transformed tree
+ */
+export declare function mapNodes<T, R>(node: T, mapper: NodePredicate<T, R>, parent?: AllNodesInTree<T> | null, path?: TreePath): R;
+/**
+ * Transform nodes in the Structured Text tree by applying a mapping function.
+ * Creates a new tree structure with transformed nodes while preserving the Structured Text tree hierarchy.
+ *
+ * @template T - The type of nodes in the input Structured Text tree
+ * @template R - The type of nodes in the output tree
+ * @param node - The root node to start mapping from
+ * @param mapper - Asynchronous function that transforms each node. Receives the node, its parent, and path
+ * @returns Promise that resolves to the transformed tree
+ */
+export declare function mapNodesAsync<T, R>(node: T, mapper: NodePredicate<T, Promise<R>>, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<R>;
+/**
+ * Find all nodes that match the predicate function using depth-first search.
+ * Returns an array containing all matching nodes along with their paths through the Structured Text tree.
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start searching from
+ * @param predicate - Synchronous function that tests each node. Should return true for desired nodes
+ * @returns Array of objects, each containing a matching node and its path
+ */
+export declare function findAllNodes<T>(node: T, predicate: NodePredicate<T, boolean>, parent?: AllNodesInTree<T> | null, path?: TreePath): Array<{
+    node: AllNodesInTree<T>;
+    path: TreePath;
+}>;
+/**
+ * Find all nodes that match the predicate function using depth-first search.
+ * Returns an array containing all matching nodes along with their paths through the Structured Text tree.
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start searching from
+ * @param predicate - Asynchronous function that tests each node. Should return true for desired nodes
+ * @returns Promise that resolves to an array of objects, each containing a matching node and its path
+ */
+export declare function findAllNodesAsync<T>(node: T, predicate: NodePredicate<T, Promise<boolean>>, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<Array<{
+    node: AllNodesInTree<T>;
+    path: TreePath;
+}>>;
+/**
+ * Filter nodes in the Structured Text tree, removing those that don't match the predicate.
+ * Creates a new tree structure containing only nodes that pass the predicate test.
+ * Maintains the Structured Text tree hierarchy - if a parent node is kept, its structure is preserved.
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start filtering from
+ * @param predicate - Synchronous function that tests each node. Nodes returning false are removed
+ * @returns The filtered tree, or null if root node is filtered out
+ */
+export declare function filterNodes<T>(node: T, predicate: NodePredicate<T, boolean>, parent?: AllNodesInTree<T> | null, path?: TreePath): T | null;
+/**
+ * Filter nodes in the Structured Text tree, removing those that don't match the predicate.
+ * Creates a new tree structure containing only nodes that pass the predicate test.
+ * Maintains the Structured Text tree hierarchy - if a parent node is kept, its structure is preserved.
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start filtering from
+ * @param predicate - Asynchronous function that tests each node. Nodes returning false are removed
+ * @returns Promise that resolves to the filtered tree, or null if root node is filtered out
+ */
+export declare function filterNodesAsync<T>(node: T, predicate: NodePredicate<T, Promise<boolean>>, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<T | null>;
+/**
+ * Reduce the Structured Text tree to a single value by applying a reducer function to each node.
+ * Uses pre-order traversal (parent is processed before its children).
+ * The reducer function is called for each node with the current accumulator value.
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @template R - The type of the accumulated result
+ * @param node - The root node to start reducing from
+ * @param reducer - Synchronous function that processes each node and updates the accumulator
+ * @param initialValue - The initial value for the accumulator
+ * @returns The final accumulated value
+ */
+export declare function reduceNodes<T, R>(node: T, reducer: (accumulator: R, node: AllNodesInTree<T>, parent: AllNodesInTree<T> | null, path: TreePath) => R, initialValue: R, parent?: AllNodesInTree<T> | null, path?: TreePath): R;
+/**
+ * Reduce the Structured Text tree to a single value by applying a reducer function to each node.
+ * Uses pre-order traversal (parent is processed before its children).
+ * The reducer function is called for each node with the current accumulator value.
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @template R - The type of the accumulated result
+ * @param node - The root node to start reducing from
+ * @param reducer - Asynchronous function that processes each node and updates the accumulator
+ * @param initialValue - The initial value for the accumulator
+ * @returns Promise that resolves to the final accumulated value
+ */
+export declare function reduceNodesAsync<T, R>(node: T, reducer: (accumulator: R, node: AllNodesInTree<T>, parent: AllNodesInTree<T> | null, path: TreePath) => Promise<R>, initialValue: R, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<R>;
+/**
+ * Check if any node in the Structured Text tree matches the predicate function.
+ * Returns true as soon as the first matching node is found (short-circuit evaluation).
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start searching from
+ * @param predicate - Synchronous function that tests each node. Should return true for matching nodes
+ * @returns True if any node matches, false otherwise
+ */
+export declare function someNode<T>(node: T, predicate: NodePredicate<T, boolean>, parent?: AllNodesInTree<T> | null, path?: TreePath): boolean;
+/**
+ * Check if any node in the Structured Text tree matches the predicate function.
+ * Returns true as soon as the first matching node is found (short-circuit evaluation).
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start searching from
+ * @param predicate - Asynchronous function that tests each node. Should return true for matching nodes
+ * @returns Promise that resolves to true if any node matches, false otherwise
+ */
+export declare function someNodeAsync<T>(node: T, predicate: NodePredicate<T, Promise<boolean>>, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<boolean>;
+/**
+ * Check if every node in the Structured Text tree matches the predicate function.
+ * Returns false as soon as the first non-matching node is found (short-circuit evaluation).
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start testing from
+ * @param predicate - Synchronous function that tests each node. Should return true for valid nodes
+ * @returns True if all nodes match, false otherwise
+ */
+export declare function everyNode<T>(node: T, predicate: NodePredicate<T, boolean>, parent?: AllNodesInTree<T> | null, path?: TreePath): boolean;
+/**
+ * Check if every node in the Structured Text tree matches the predicate function.
+ * Returns false as soon as the first non-matching node is found (short-circuit evaluation).
+ *
+ * @template T - The type of nodes in the Structured Text tree
+ * @param node - The root node to start testing from
+ * @param predicate - Asynchronous function that tests each node. Should return true for valid nodes
+ * @returns Promise that resolves to true if all nodes match, false otherwise
+ */
+export declare function everyNodeAsync<T>(node: T, predicate: NodePredicate<T, Promise<boolean>>, parent?: AllNodesInTree<T> | null, path?: TreePath): Promise<boolean>;
+export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.0.1",
+  "version": "5.1.0",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -37,12 +37,13 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^5.0.0",
+    "@datocms/rest-client-utils": "^5.1.0",
+    "datocms-structured-text-utils": "^5.0.0",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^5.0.0",
+    "@datocms/dashboard-client": "^5.1.0",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "51532eca9288ec685005e47f6bcc78df9bc20e19"
+  "gitHead": "ccc646f22202e951675e695fd4e5be2cfde4e9a5"
 }

package/resources.json

@@ -1194,7 +1194,7 @@
         "rel": "instances",
         "urlTemplate": "/item-types/${itemTypeId}/fields",
         "method": "GET",
-        "comment": "List all fields",
+        "comment": "List all fields of a model/block",
         "urlPlaceholders": [
           {
             "variableName": "itemTypeId",
@@ -1408,7 +1408,7 @@
         "rel": "instances",
         "urlTemplate": "/item-types/${itemTypeId}/fieldsets",
         "method": "GET",
-        "comment": "List all fieldsets",
+        "comment": "List all fieldsets of a model/block",
         "urlPlaceholders": [
           {
             "variableName": "itemTypeId",

package/src/fieldTypes/appearance/boolean.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for Boolean fields.
+ */
+export type BooleanEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/boolean_radio_group.ts

@@ -0,0 +1,16 @@
+/**
+ * Radio group input for boolean fields.
+ */
+export type BooleanRadioGroupEditorConfigurationRadio = {
+  /** The text shown to the user for this radio option */
+  label: string;
+  /** Optional help text shown alongside the radio option */
+  hint?: string;
+};
+
+export type BooleanRadioGroupEditorConfiguration = {
+  /** Radio input for positive choice (true) */
+  positive_radio: BooleanRadioGroupEditorConfigurationRadio;
+  /** Radio input for negative choice (false) */
+  negative_radio: BooleanRadioGroupEditorConfigurationRadio;
+};

package/src/fieldTypes/appearance/color_picker.ts

@@ -0,0 +1,9 @@
+/**
+ * Built-in editor for Color fields.
+ */
+export type ColorPickerEditorConfiguration = {
+  /** Should the color picker allow to specify the alpha value? */
+  enable_alpha: boolean;
+  /** List of preset colors to offer to the user (hex color strings) */
+  preset_colors: Array<string>;
+};

package/src/fieldTypes/appearance/date_picker.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for Date fields.
+ */
+export type DatePickerEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/date_time_picker.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for Date time fields.
+ */
+export type DateTimePickerEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/file.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for Single-asset fields.
+ */
+export type FileEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/float.ts

@@ -0,0 +1,7 @@
+/**
+ * Built-in editor for Float fields.
+ */
+export type FloatEditorConfiguration = {
+  /** A placeholder that will be shown in the editor's input to provide editors with an example */
+  placeholder?: string;
+};

package/src/fieldTypes/appearance/framed_single_block.ts

@@ -0,0 +1,7 @@
+/**
+ * Built-in editor for Single block fields.
+ */
+export type FramedSingleBlockEditorConfiguration = {
+  /** Whether you want block record collapsed by default or not */
+  start_collapsed?: boolean;
+};

package/src/fieldTypes/appearance/frameless_single_block.ts

@@ -0,0 +1,7 @@
+/**
+ * Built-in editor for Single block fields (frameless variant).
+ */
+export type FramelessSingleBlockEditorConfiguration = {
+  /** Whether you want block record collapsed by default or not */
+  start_collapsed?: boolean;
+};

package/src/fieldTypes/appearance/gallery.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for Asset gallery fields.
+ */
+export type GalleryEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/index.ts

@@ -0,0 +1,30 @@
+export * from './boolean';
+export * from './boolean_radio_group';
+export * from './color_picker';
+export * from './date_picker';
+export * from './date_time_picker';
+export * from './file';
+export * from './float';
+export * from './framed_single_block';
+export * from './frameless_single_block';
+export * from './gallery';
+export * from './integer';
+export * from './json';
+export * from './link_embed';
+export * from './link_select';
+export * from './links_embed';
+export * from './links_select';
+export * from './map';
+export * from './markdown';
+export * from './rich_text';
+export * from './seo';
+export * from './single_line';
+export * from './slug';
+export * from './string_checkbox_group';
+export * from './string_multi_select';
+export * from './string_radio_group';
+export * from './string_select';
+export * from './structured_text';
+export * from './textarea';
+export * from './video';
+export * from './wysiwyg';

package/src/fieldTypes/appearance/integer.ts

@@ -0,0 +1,7 @@
+/**
+ * Built-in editor for Integer fields.
+ */
+export type IntegerEditorConfiguration = {
+  /** A placeholder that will be shown in the editor's input to provide editors with an example */
+  placeholder?: string;
+};

package/src/fieldTypes/appearance/json.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for JSON fields.
+ */
+export type JsonEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/link_embed.ts

@@ -0,0 +1,5 @@
+/**
+ * Use an expanded view with records' image preview to pick the records to reference inside the field.
+ * For Single link fields.
+ */
+export type LinkEmbedEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/link_select.ts

@@ -0,0 +1,5 @@
+/**
+ * Use a select input with auto-completion to pick the records to reference inside the field.
+ * For Single link fields.
+ */
+export type LinkSelectEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/links_embed.ts

@@ -0,0 +1,5 @@
+/**
+ * Use an expanded view with records' image preview to pick the records to reference inside the field.
+ * For Multiple links fields.
+ */
+export type LinksEmbedEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/links_select.ts

@@ -0,0 +1,5 @@
+/**
+ * Use a select input with auto-completion to pick the records to reference inside the field.
+ * For Multiple links fields.
+ */
+export type LinksSelectEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/map.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for Location fields.
+ */
+export type MapEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/markdown.ts

@@ -0,0 +1,19 @@
+/**
+ * Markdown editor for Multiple-paragraph text fields.
+ */
+export type MarkdownEditorConfiguration = {
+  /** Specify which buttons the toolbar should have */
+  toolbar: Array<
+    | 'heading'
+    | 'bold'
+    | 'italic'
+    | 'strikethrough'
+    | 'code'
+    | 'unordered_list'
+    | 'ordered_list'
+    | 'quote'
+    | 'link'
+    | 'image'
+    | 'fullscreen'
+  >;
+};

package/src/fieldTypes/appearance/rich_text.ts

@@ -0,0 +1,7 @@
+/**
+ * Built-in editor for Modular content fields.
+ */
+export type RichTextEditorConfiguration = {
+  /** Whether you want block records collapsed by default or not */
+  start_collapsed?: boolean;
+};

package/src/fieldTypes/appearance/seo.ts

@@ -0,0 +1,19 @@
+/**
+ * Built-in editor for SEO fields.
+ */
+export type SeoEditorConfiguration = {
+  /** Specify which fields of the SEO input should be visible to editors */
+  fields: Array<
+    'title' | 'description' | 'image' | 'no_index' | 'twitter_card'
+  >;
+  /** Specify which previews should be visible to editors */
+  previews: Array<
+    | 'google_search'
+    | 'twitter'
+    | 'slack'
+    | 'whatsapp'
+    | 'telegram'
+    | 'facebook'
+    | 'linkedin'
+  >;
+};

package/src/fieldTypes/appearance/single_line.ts

@@ -0,0 +1,9 @@
+/**
+ * Simple textual input for Single-line string fields.
+ */
+export type SingleLineEditorConfiguration = {
+  /** Indicates if the field should be shown bigger, as a field representing a heading */
+  heading: boolean;
+  /** A placeholder that will be shown in the editor's input to provide editors with an example */
+  placeholder?: string;
+};

package/src/fieldTypes/appearance/slug.ts

@@ -0,0 +1,9 @@
+/**
+ * Built-in editor for Slug fields.
+ */
+export type SlugEditorConfiguration = {
+  /** A prefix that will be shown in the editor's form to give some context to your editors */
+  url_prefix?: string;
+  /** A placeholder that will be shown in the editor's input to provide editors with an example */
+  placeholder?: string;
+};

package/src/fieldTypes/appearance/string_checkbox_group.ts

@@ -0,0 +1,16 @@
+/**
+ * Multiple checkboxes input for JSON fields, to edit an array of strings.
+ */
+export type StringCheckboxGroupEditorConfigurationOption = {
+  /** The text shown to the user for this option */
+  label: string;
+  /** The value that will be stored when this option is selected */
+  value: string;
+  /** Optional help text shown alongside the option */
+  hint?: string;
+};
+
+export type StringCheckboxGroupEditorConfiguration = {
+  /** The different checkbox options */
+  options: Array<StringCheckboxGroupEditorConfigurationOption>;
+};

package/src/fieldTypes/appearance/string_multi_select.ts

@@ -0,0 +1,16 @@
+/**
+ * Select input for JSON fields, to edit an array of strings.
+ */
+export type StringMultiSelectEditorConfigurationOption = {
+  /** The text shown to the user for this option */
+  label: string;
+  /** The value that will be stored when this option is selected */
+  value: string;
+  /** Optional help text shown alongside the option */
+  hint?: string;
+};
+
+export type StringMultiSelectEditorConfiguration = {
+  /** The different select options */
+  options: Array<StringMultiSelectEditorConfigurationOption>;
+};

package/src/fieldTypes/appearance/string_radio_group.ts

@@ -0,0 +1,16 @@
+/**
+ * Radio group input for string fields.
+ */
+export type StringRadioGroupEditorConfigurationRadio = {
+  /** The text shown to the user for this radio option */
+  label: string;
+  /** The value that will be stored when this radio is selected */
+  value: string;
+  /** Optional help text shown alongside the radio option */
+  hint?: string;
+};
+
+export type StringRadioGroupEditorConfiguration = {
+  /** The different radio options */
+  radios: Array<StringRadioGroupEditorConfigurationRadio>;
+};

package/src/fieldTypes/appearance/string_select.ts

@@ -0,0 +1,16 @@
+/**
+ * Select input for string fields.
+ */
+export type StringSelectEditorConfigurationOption = {
+  /** The text shown to the user for this option */
+  label: string;
+  /** The value that will be stored when this option is selected */
+  value: string;
+  /** Optional help text shown alongside the option */
+  hint?: string;
+};
+
+export type StringSelectEditorConfiguration = {
+  /** The different select options */
+  options: Array<StringSelectEditorConfigurationOption>;
+};

package/src/fieldTypes/appearance/structured_text.ts

@@ -0,0 +1,21 @@
+/**
+ * Built-in editor for Structured text fields.
+ */
+export type StructuredTextEditorConfiguration = {
+  /** Specify which nodes the field should allow */
+  nodes: Array<
+    'blockquote' | 'code' | 'heading' | 'link' | 'list' | 'thematicBreak'
+  >;
+  /** Specify which marks the field should allow */
+  marks: Array<
+    'strong' | 'emphasis' | 'underline' | 'strikethrough' | 'code' | 'highlight'
+  >;
+  /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) */
+  heading_levels: Array<1 | 2 | 3 | 4 | 5 | 6>;
+  /** Whether you want block nodes collapsed by default or not */
+  blocks_start_collapsed?: boolean;
+  /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links */
+  show_links_target_blank?: boolean;
+  /** Whether you want to show the complete meta editor for links */
+  show_links_meta_editor?: boolean;
+};

package/src/fieldTypes/appearance/textarea.ts

@@ -0,0 +1,7 @@
+/**
+ * Basic textarea editor for Multiple-paragraph text fields.
+ */
+export type TextareaEditorConfiguration = {
+  /** A placeholder that will be shown in the editor's input to provide editors with an example */
+  placeholder?: string;
+};

package/src/fieldTypes/appearance/video.ts

@@ -0,0 +1,4 @@
+/**
+ * Built-in editor for External video fields.
+ */
+export type VideoEditorConfiguration = Record<string, never>;

package/src/fieldTypes/appearance/wysiwyg.ts

@@ -0,0 +1,29 @@
+/**
+ * HTML editor for Multiple-paragraph text fields.
+ */
+export type WysiwygEditorConfiguration = {
+  /** Specify which buttons the toolbar should have */
+  toolbar: Array<
+    | 'format'
+    | 'bold'
+    | 'italic'
+    | 'strikethrough'
+    | 'code'
+    | 'ordered_list'
+    | 'unordered_list'
+    | 'quote'
+    | 'table'
+    | 'link'
+    | 'image'
+    | 'show_source'
+    | 'undo'
+    | 'redo'
+    | 'align_left'
+    | 'align_center'
+    | 'align_right'
+    | 'align_justify'
+    | 'outdent'
+    | 'indent'
+    | 'fullscreen'
+  >;
+};

package/src/fieldTypes/boolean.ts

@@ -0,0 +1,25 @@
+import type { BooleanEditorConfiguration } from './appearance/boolean';
+import type { BooleanRadioGroupEditorConfiguration } from './appearance/boolean_radio_group';
+
+export type BooleanFieldValue = boolean | null;
+
+export function isBooleanFieldValue(
+  value: unknown,
+): value is BooleanFieldValue {
+  return typeof value === 'boolean' || value === null;
+}
+
+export type BooleanFieldValidators = Record<string, never>;
+
+export type BooleanFieldAppearance =
+  | { editor: 'boolean'; parameters: BooleanEditorConfiguration }
+  | {
+      editor: 'boolean_radio_group';
+      parameters: BooleanRadioGroupEditorConfiguration;
+    }
+  | {
+      /** Plugin ID */
+      editor: string;
+      /** Plugin configuration */
+      parameters: Record<string, unknown>;
+    };