@datocms/cma-client 5.0.1 → 5.1.0

package/dist/esm/utilities/structuredText.js

@@ -0,0 +1,354 @@
+/**
+ * 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).
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+/**
+ * Check if a value has children property that is an array
+ */
+function hasChildren(node) {
+    return (typeof node === 'object' &&
+        node !== null &&
+        'children' in node &&
+        Array.isArray(node.children));
+}
+/**
+ * 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 function visitNodes(node, visitor, parent = null, path = []) {
+    // Visit current node
+    visitor(node, parent, path);
+    // Recursively visit children
+    if (hasChildren(node)) {
+        for (let index = 0; index < node.children.length; index++) {
+            const child = node.children[index];
+            visitNodes(child, visitor, node, [
+                ...path,
+                'children',
+                index,
+            ]);
+        }
+    }
+}
+/**
+ * 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 function visitNodesAsync(node, visitor, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Visit current node
+        yield visitor(node, parent, path);
+        // Recursively visit children
+        if (hasChildren(node)) {
+            for (let index = 0; index < node.children.length; index++) {
+                const child = node.children[index];
+                yield visitNodesAsync(child, visitor, node, [
+                    ...path,
+                    'children',
+                    index,
+                ]);
+            }
+        }
+    });
+}
+/**
+ * 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 function mapNodes(node, mapper, parent = null, path = []) {
+    // Transform current node
+    const transformedNode = mapper(node, parent, path);
+    // If the original node has children, recursively transform them
+    if (hasChildren(node) &&
+        typeof transformedNode === 'object' &&
+        transformedNode !== null) {
+        const transformedChildren = node.children.map((child, index) => mapNodes(child, mapper, node, [
+            ...path,
+            'children',
+            index,
+        ]));
+        return Object.assign(Object.assign({}, transformedNode), { children: transformedChildren });
+    }
+    return transformedNode;
+}
+/**
+ * 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 function mapNodesAsync(node, mapper, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Transform current node
+        const transformedNode = yield mapper(node, parent, path);
+        // If the original node has children, recursively transform them
+        if (hasChildren(node) &&
+            typeof transformedNode === 'object' &&
+            transformedNode !== null) {
+            const transformedChildren = yield Promise.all(node.children.map((child, index) => mapNodesAsync(child, mapper, node, [
+                ...path,
+                'children',
+                index,
+            ])));
+            return Object.assign(Object.assign({}, transformedNode), { children: transformedChildren });
+        }
+        return transformedNode;
+    });
+}
+/**
+ * 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 function findAllNodes(node, predicate, parent = null, path = []) {
+    const results = [];
+    visitNodes(node, (currentNode, currentParent, currentPath) => {
+        if (predicate(currentNode, currentParent, currentPath)) {
+            results.push({ node: currentNode, path: currentPath });
+        }
+    }, parent, path);
+    return results;
+}
+/**
+ * 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 function findAllNodesAsync(node, predicate, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        const results = [];
+        yield visitNodesAsync(node, (currentNode, currentParent, currentPath) => __awaiter(this, void 0, void 0, function* () {
+            if (yield predicate(currentNode, currentParent, currentPath)) {
+                results.push({ node: currentNode, path: currentPath });
+            }
+        }), parent, path);
+        return results;
+    });
+}
+/**
+ * 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 function filterNodes(node, predicate, parent = null, path = []) {
+    // If current node doesn't match predicate, return null
+    if (!predicate(node, parent, path)) {
+        return null;
+    }
+    // If node has no children, return it as-is
+    if (!hasChildren(node)) {
+        return node;
+    }
+    // Filter children recursively
+    const childrenResults = node.children.map((child, index) => filterNodes(child, predicate, node, [
+        ...path,
+        'children',
+        index,
+    ]));
+    const filteredChildren = childrenResults.filter((child) => child !== null);
+    return Object.assign(Object.assign({}, node), { children: filteredChildren });
+}
+/**
+ * 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 function filterNodesAsync(node, predicate, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // If current node doesn't match predicate, return null
+        if (!(yield predicate(node, parent, path))) {
+            return null;
+        }
+        // If node has no children, return it as-is
+        if (!hasChildren(node)) {
+            return node;
+        }
+        // Filter children recursively
+        const childrenResults = yield Promise.all(node.children.map((child, index) => filterNodesAsync(child, predicate, node, [
+            ...path,
+            'children',
+            index,
+        ])));
+        const filteredChildren = childrenResults.filter((child) => child !== null);
+        return Object.assign(Object.assign({}, node), { children: filteredChildren });
+    });
+}
+/**
+ * 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 function reduceNodes(node, reducer, initialValue, parent = null, path = []) {
+    let accumulator = initialValue;
+    visitNodes(node, (currentNode, currentParent, currentPath) => {
+        accumulator = reducer(accumulator, currentNode, currentParent, currentPath);
+    }, parent, path);
+    return accumulator;
+}
+/**
+ * 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 function reduceNodesAsync(node, reducer, initialValue, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        let accumulator = initialValue;
+        yield visitNodesAsync(node, (currentNode, currentParent, currentPath) => __awaiter(this, void 0, void 0, function* () {
+            accumulator = yield reducer(accumulator, currentNode, currentParent, currentPath);
+        }), parent, path);
+        return accumulator;
+    });
+}
+/**
+ * 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 function someNode(node, predicate, parent = null, path = []) {
+    // Check current node
+    if (predicate(node, parent, path)) {
+        return true;
+    }
+    // Recursively check children
+    if (hasChildren(node)) {
+        for (let index = 0; index < node.children.length; index++) {
+            const child = node.children[index];
+            if (someNode(child, predicate, node, [
+                ...path,
+                'children',
+                index,
+            ])) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+/**
+ * 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 function someNodeAsync(node, predicate, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        // Check current node
+        if (yield predicate(node, parent, path)) {
+            return true;
+        }
+        // Recursively check children
+        if (hasChildren(node)) {
+            for (let index = 0; index < node.children.length; index++) {
+                const child = node.children[index];
+                if (yield someNodeAsync(child, predicate, node, [
+                    ...path,
+                    'children',
+                    index,
+                ])) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    });
+}
+/**
+ * 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 function everyNode(node, predicate, parent = null, path = []) {
+    return !someNode(node, (currentNode, currentParent, currentPath) => {
+        return !predicate(currentNode, currentParent, currentPath);
+    }, parent, path);
+}
+/**
+ * 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 function everyNodeAsync(node, predicate, parent = null, path = []) {
+    return __awaiter(this, void 0, void 0, function* () {
+        return !(yield someNodeAsync(node, (currentNode, currentParent, currentPath) => __awaiter(this, void 0, void 0, function* () {
+            return !(yield predicate(currentNode, currentParent, currentPath));
+        }), parent, path));
+    });
+}
+//# sourceMappingURL=structuredText.js.map

package/dist/esm/utilities/structuredText.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"structuredText.js","sourceRoot":"","sources":["../../../src/utilities/structuredText.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;;;;;;;;;;AAqDH;;GAEG;AACH,SAAS,WAAW,CAAC,IAAa;IAChC,OAAO,CACL,OAAO,IAAI,KAAK,QAAQ;QACxB,IAAI,KAAK,IAAI;QACb,UAAU,IAAI,IAAI;QAClB,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,CAC7B,CAAC;AACJ,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,UAAU,CACxB,IAAO,EACP,OAA+B,EAC/B,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,qBAAqB;IACrB,OAAO,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAEjD,6BAA6B;IAC7B,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;QACrB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACzD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACnC,UAAU,CAAC,KAAU,EAAE,OAAO,EAAE,IAAyB,EAAE;gBACzD,GAAG,IAAI;gBACP,UAAU;gBACV,KAAK;aACN,CAAC,CAAC;SACJ;KACF;AACH,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,eAAe,CACnC,IAAO,EACP,OAAwC,EACxC,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,qBAAqB;QACrB,MAAM,OAAO,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAEvD,6BAA6B;QAC7B,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;YACrB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACzD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACnC,MAAM,eAAe,CAAC,KAAU,EAAE,OAAO,EAAE,IAAyB,EAAE;oBACpE,GAAG,IAAI;oBACP,UAAU;oBACV,KAAK;iBACN,CAAC,CAAC;aACJ;SACF;IACH,CAAC;CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,QAAQ,CACtB,IAAO,EACP,MAA2B,EAC3B,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,yBAAyB;IACzB,MAAM,eAAe,GAAG,MAAM,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;IAExE,gEAAgE;IAChE,IACE,WAAW,CAAC,IAAI,CAAC;QACjB,OAAO,eAAe,KAAK,QAAQ;QACnC,eAAe,KAAK,IAAI,EACxB;QACA,MAAM,mBAAmB,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CAC7D,QAAQ,CAAC,KAAU,EAAE,MAAM,EAAE,IAAyB,EAAE;YACtD,GAAG,IAAI;YACP,UAAU;YACV,KAAK;SACN,CAAC,CACH,CAAC;QAEF,OAAO,gCACF,eAAe,KAClB,QAAQ,EAAE,mBAAmB,GACzB,CAAC;KACR;IAED,OAAO,eAAe,CAAC;AACzB,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAgB,aAAa,CACjC,IAAO,EACP,MAAoC,EACpC,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,yBAAyB;QACzB,MAAM,eAAe,GAAG,MAAM,MAAM,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC;QAE9E,gEAAgE;QAChE,IACE,WAAW,CAAC,IAAI,CAAC;YACjB,OAAO,eAAe,KAAK,QAAQ;YACnC,eAAe,KAAK,IAAI,EACxB;YACA,MAAM,mBAAmB,GAAG,MAAM,OAAO,CAAC,GAAG,CAC3C,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACjC,aAAa,CAAC,KAAU,EAAE,MAAM,EAAE,IAAyB,EAAE;gBAC3D,GAAG,IAAI;gBACP,UAAU;gBACV,KAAK;aACN,CAAC,CACH,CACF,CAAC;YAEF,OAAO,gCACF,eAAe,KAClB,QAAQ,EAAE,mBAAmB,GACzB,CAAC;SACR;QAED,OAAO,eAAe,CAAC;IACzB,CAAC;CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,YAAY,CAC1B,IAAO,EACP,SAAoC,EACpC,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,MAAM,OAAO,GAAuD,EAAE,CAAC;IAEvE,UAAU,CACR,IAAI,EACJ,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,EAAE;QAC1C,IAAI,SAAS,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE;YACtD,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;SACxD;IACH,CAAC,EACD,MAAM,EACN,IAAI,CACL,CAAC;IAEF,OAAO,OAAO,CAAC;AACjB,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,iBAAiB,CACrC,IAAO,EACP,SAA6C,EAC7C,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,MAAM,OAAO,GAAuD,EAAE,CAAC;QAEvE,MAAM,eAAe,CACnB,IAAI,EACJ,CAAO,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,EAAE;YAChD,IAAI,MAAM,SAAS,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,EAAE;gBAC5D,OAAO,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,WAAW,EAAE,CAAC,CAAC;aACxD;QACH,CAAC,CAAA,EACD,MAAM,EACN,IAAI,CACL,CAAC;QAEF,OAAO,OAAO,CAAC;IACjB,CAAC;CAAA;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,WAAW,CACzB,IAAO,EACP,SAAoC,EACpC,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,uDAAuD;IACvD,IAAI,CAAC,SAAS,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QACvD,OAAO,IAAI,CAAC;KACb;IAED,2CAA2C;IAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;QACtB,OAAO,IAAI,CAAC;KACb;IAED,8BAA8B;IAC9B,MAAM,eAAe,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACzD,WAAW,CAAC,KAAU,EAAE,SAAS,EAAE,IAAyB,EAAE;QAC5D,GAAG,IAAI;QACP,UAAU;QACV,KAAK;KACN,CAAC,CACH,CAAC;IACF,MAAM,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAC7C,CAAC,KAAK,EAAsC,EAAE,CAAC,KAAK,KAAK,IAAI,CAC9D,CAAC;IAEF,OAAO,gCACF,IAAI,KACP,QAAQ,EAAE,gBAAgB,GACtB,CAAC;AACT,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAgB,gBAAgB,CACpC,IAAO,EACP,SAA6C,EAC7C,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,uDAAuD;QACvD,IAAI,CAAC,CAAC,MAAM,SAAS,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,EAAE;YAC/D,OAAO,IAAI,CAAC;SACb;QAED,2CAA2C;QAC3C,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE;YACtB,OAAO,IAAI,CAAC;SACb;QAED,8BAA8B;QAC9B,MAAM,eAAe,GAAG,MAAM,OAAO,CAAC,GAAG,CACvC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,KAAK,EAAE,EAAE,CACjC,gBAAgB,CAAC,KAAU,EAAE,SAAS,EAAE,IAAyB,EAAE;YACjE,GAAG,IAAI;YACP,UAAU;YACV,KAAK;SACN,CAAC,CACH,CACF,CAAC;QACF,MAAM,gBAAgB,GAAG,eAAe,CAAC,MAAM,CAC7C,CAAC,KAAK,EAAsC,EAAE,CAAC,KAAK,KAAK,IAAI,CAC9D,CAAC;QAEF,OAAO,gCACF,IAAI,KACP,QAAQ,EAAE,gBAAgB,GACtB,CAAC;IACT,CAAC;CAAA;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,WAAW,CACzB,IAAO,EACP,OAKM,EACN,YAAe,EACf,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,IAAI,WAAW,GAAG,YAAY,CAAC;IAE/B,UAAU,CACR,IAAI,EACJ,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,EAAE;QAC1C,WAAW,GAAG,OAAO,CACnB,WAAW,EACX,WAAW,EACX,aAAa,EACb,WAAW,CACZ,CAAC;IACJ,CAAC,EACD,MAAM,EACN,IAAI,CACL,CAAC;IAEF,OAAO,WAAW,CAAC;AACrB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAgB,gBAAgB,CACpC,IAAO,EACP,OAKe,EACf,YAAe,EACf,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,IAAI,WAAW,GAAG,YAAY,CAAC;QAE/B,MAAM,eAAe,CACnB,IAAI,EACJ,CAAO,WAAW,EAAE,aAAa,EAAE,WAAW,EAAE,EAAE;YAChD,WAAW,GAAG,MAAM,OAAO,CACzB,WAAW,EACX,WAAW,EACX,aAAa,EACb,WAAW,CACZ,CAAC;QACJ,CAAC,CAAA,EACD,MAAM,EACN,IAAI,CACL,CAAC;QAEF,OAAO,WAAW,CAAC;IACrB,CAAC;CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,QAAQ,CACtB,IAAO,EACP,SAAoC,EACpC,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,qBAAqB;IACrB,IAAI,SAAS,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;QACtD,OAAO,IAAI,CAAC;KACb;IAED,6BAA6B;IAC7B,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;QACrB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;YACzD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;YACnC,IACE,QAAQ,CAAC,KAAU,EAAE,SAAS,EAAE,IAAyB,EAAE;gBACzD,GAAG,IAAI;gBACP,UAAU;gBACV,KAAK;aACN,CAAC,EACF;gBACA,OAAO,IAAI,CAAC;aACb;SACF;KACF;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,aAAa,CACjC,IAAO,EACP,SAA6C,EAC7C,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,qBAAqB;QACrB,IAAI,MAAM,SAAS,CAAC,IAAyB,EAAE,MAAM,EAAE,IAAI,CAAC,EAAE;YAC5D,OAAO,IAAI,CAAC;SACb;QAED,6BAA6B;QAC7B,IAAI,WAAW,CAAC,IAAI,CAAC,EAAE;YACrB,KAAK,IAAI,KAAK,GAAG,CAAC,EAAE,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,MAAM,EAAE,KAAK,EAAE,EAAE;gBACzD,MAAM,KAAK,GAAG,IAAI,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;gBACnC,IACE,MAAM,aAAa,CAAC,KAAU,EAAE,SAAS,EAAE,IAAyB,EAAE;oBACpE,GAAG,IAAI;oBACP,UAAU;oBACV,KAAK;iBACN,CAAC,EACF;oBACA,OAAO,IAAI,CAAC;iBACb;aACF;SACF;QAED,OAAO,KAAK,CAAC;IACf,CAAC;CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CACvB,IAAO,EACP,SAAoC,EACpC,SAAmC,IAAI,EACvC,OAAiB,EAAE;IAEnB,OAAO,CAAC,QAAQ,CACd,IAAI,EACJ,CACE,WAA8B,EAC9B,aAAuC,EACvC,WAAqB,EACrB,EAAE;QACF,OAAO,CAAC,SAAS,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC;IAC7D,CAAC,EACD,MAAM,EACN,IAAI,CACL,CAAC;AACJ,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAgB,cAAc,CAClC,IAAO,EACP,SAA6C,EAC7C,SAAmC,IAAI,EACvC,OAAiB,EAAE;;QAEnB,OAAO,CAAC,CAAC,MAAM,aAAa,CAC1B,IAAI,EACJ,CACE,WAA8B,EAC9B,aAAuC,EACvC,WAAqB,EACrB,EAAE;YACF,OAAO,CAAC,CAAC,MAAM,SAAS,CAAC,WAAW,EAAE,aAAa,EAAE,WAAW,CAAC,CAAC,CAAC;QACrE,CAAC,CAAA,EACD,MAAM,EACN,IAAI,CACL,CAAC,CAAC;IACL,CAAC;CAAA"}

package/dist/types/fieldTypes/appearance/boolean.d.ts

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

package/dist/types/fieldTypes/appearance/boolean_radio_group.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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/dist/types/fieldTypes/appearance/color_picker.d.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/dist/types/fieldTypes/appearance/date_picker.d.ts

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

package/dist/types/fieldTypes/appearance/date_time_picker.d.ts

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

package/dist/types/fieldTypes/appearance/file.d.ts

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

package/dist/types/fieldTypes/appearance/float.d.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/dist/types/fieldTypes/appearance/framed_single_block.d.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/dist/types/fieldTypes/appearance/frameless_single_block.d.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/dist/types/fieldTypes/appearance/gallery.d.ts

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

package/dist/types/fieldTypes/appearance/index.d.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/dist/types/fieldTypes/appearance/integer.d.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/dist/types/fieldTypes/appearance/json.d.ts

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

package/dist/types/fieldTypes/appearance/link_embed.d.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/dist/types/fieldTypes/appearance/link_select.d.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/dist/types/fieldTypes/appearance/links_embed.d.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/dist/types/fieldTypes/appearance/links_select.d.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/dist/types/fieldTypes/appearance/map.d.ts

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

package/dist/types/fieldTypes/appearance/markdown.d.ts

@@ -0,0 +1,7 @@
+/**
+ * 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/dist/types/fieldTypes/appearance/rich_text.d.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/dist/types/fieldTypes/appearance/seo.d.ts

@@ -0,0 +1,9 @@
+/**
+ * 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/dist/types/fieldTypes/appearance/single_line.d.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/dist/types/fieldTypes/appearance/slug.d.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/dist/types/fieldTypes/appearance/string_checkbox_group.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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/dist/types/fieldTypes/appearance/string_multi_select.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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/dist/types/fieldTypes/appearance/string_radio_group.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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/dist/types/fieldTypes/appearance/string_select.d.ts

@@ -0,0 +1,15 @@
+/**
+ * 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>;
+};