@datocms/cma-client 5.0.1 → 5.1.0

package/dist/esm/utilities/schemaRepository.js

@@ -0,0 +1,350 @@
+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());
+    });
+};
+import { deserializeResponseBody } from '@datocms/rest-client-utils';
+/**
+ * Repository for DatoCMS schema entities including item types, fields, and plugins.
+ * Provides caching and efficient lookup functionality for schema-related operations.
+ */
+export class SchemaRepository {
+    /**
+     * Creates a new SchemaRepository instance.
+     * @param client - The DatoCMS client instance
+     */
+    constructor(client) {
+        this.itemTypesPromise = null;
+        this.itemTypesByApiKey = new Map();
+        this.itemTypesById = new Map();
+        this.fieldsByItemType = new Map();
+        this.fieldsetsByItemType = new Map();
+        this.pluginsPromise = null;
+        this.pluginsById = new Map();
+        this.pluginsByPackageName = new Map();
+        this.client = client;
+    }
+    /**
+     * Loads and caches all item types from the DatoCMS API.
+     * This method is called lazily and caches the result for subsequent calls.
+     * @returns Promise that resolves to an array of item types
+     */
+    loadItemTypes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.itemTypesPromise) {
+                this.itemTypesPromise = (() => __awaiter(this, void 0, void 0, function* () {
+                    const { data: itemTypes } = yield this.client.itemTypes.rawList();
+                    // Populate the lookup maps
+                    for (const itemType of itemTypes) {
+                        this.itemTypesByApiKey.set(itemType.attributes.api_key, itemType);
+                        this.itemTypesById.set(itemType.id, itemType);
+                    }
+                    return itemTypes;
+                }))();
+            }
+            return this.itemTypesPromise;
+        });
+    }
+    /**
+     * Gets all item types from the DatoCMS project.
+     * @returns Promise that resolves to an array of all item types
+     */
+    getAllItemTypes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getAllRawItemTypes();
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets all item types from the DatoCMS project.
+     * @returns Promise that resolves to an array of all item types
+     */
+    getAllRawItemTypes() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const itemTypes = yield this.loadItemTypes();
+            return itemTypes;
+        });
+    }
+    /**
+     * Gets all item types that are models (not modular blocks).
+     * @returns Promise that resolves to an array of model item types
+     */
+    getAllModels() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getAllRawModels();
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets all item types that are models (not modular blocks).
+     * @returns Promise that resolves to an array of model item types
+     */
+    getAllRawModels() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const itemTypes = yield this.loadItemTypes();
+            return itemTypes.filter((it) => !it.attributes.modular_block);
+        });
+    }
+    /**
+     * Gets all item types that are modular blocks.
+     * @returns Promise that resolves to an array of block model item types
+     */
+    getAllBlockModels() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getAllRawBlockModels();
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets all item types that are modular blocks.
+     * @returns Promise that resolves to an array of block model item types
+     */
+    getAllRawBlockModels() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const itemTypes = yield this.loadItemTypes();
+            return itemTypes.filter((it) => it.attributes.modular_block);
+        });
+    }
+    /**
+     * Gets an item type by its API key.
+     * @param apiKey - The API key of the item type to retrieve
+     * @returns Promise that resolves to the item type
+     * @throws Error if the item type is not found
+     */
+    getItemTypeByApiKey(apiKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getRawItemTypeByApiKey(apiKey);
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets an item type by its API key.
+     * @param apiKey - The API key of the item type to retrieve
+     * @returns Promise that resolves to the item type
+     * @throws Error if the item type is not found
+     */
+    getRawItemTypeByApiKey(apiKey) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadItemTypes();
+            const itemType = this.itemTypesByApiKey.get(apiKey);
+            if (!itemType) {
+                throw new Error(`Item type with API key '${apiKey}' not found`);
+            }
+            return itemType;
+        });
+    }
+    /**
+     * Gets an item type by its ID.
+     * @param id - The ID of the item type to retrieve
+     * @returns Promise that resolves to the item type
+     * @throws Error if the item type is not found
+     */
+    getItemTypeById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getRawItemTypeById(id);
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets an item type by its ID.
+     * @param id - The ID of the item type to retrieve
+     * @returns Promise that resolves to the item type
+     * @throws Error if the item type is not found
+     */
+    getRawItemTypeById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadItemTypes();
+            const itemType = this.itemTypesById.get(id);
+            if (!itemType) {
+                throw new Error(`Item type with ID '${id}' not found`);
+            }
+            return itemType;
+        });
+    }
+    /**
+     * Gets all fields for a given item type.
+     * Fields are cached after the first request for performance.
+     * @param itemType - The item type to get fields for
+     * @returns Promise that resolves to an array of fields
+     */
+    getItemTypeFields(itemType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getRawItemTypeFields(itemType);
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets all fields for a given item type.
+     * Fields are cached after the first request for performance.
+     * @param itemType - The item type to get fields for
+     * @returns Promise that resolves to an array of fields
+     */
+    getRawItemTypeFields(itemType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Check if we already have the fields cached
+            const cachedFields = this.fieldsByItemType.get(itemType.id);
+            if (cachedFields) {
+                return cachedFields;
+            }
+            // Fetch and cache the fields
+            const { data: fields } = yield this.client.fields.rawList(itemType.id);
+            this.fieldsByItemType.set(itemType.id, fields);
+            return fields;
+        });
+    }
+    /**
+     * Gets all fieldsets for a given item type.
+     * Fieldsets are cached after the first request for performance.
+     * @param itemType - The item type to get fieldsets for
+     * @returns Promise that resolves to an array of fieldsets
+     */
+    getItemTypeFieldsets(itemType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getRawItemTypeFieldsets(itemType);
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets all fieldsets for a given item type.
+     * Fieldsets are cached after the first request for performance.
+     * @param itemType - The item type to get fieldsets for
+     * @returns Promise that resolves to an array of fieldsets
+     */
+    getRawItemTypeFieldsets(itemType) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // Check if we already have the fieldsets cached
+            const cachedFieldsets = this.fieldsetsByItemType.get(itemType.id);
+            if (cachedFieldsets) {
+                return cachedFieldsets;
+            }
+            // Fetch and cache the fieldsets
+            const { data: fieldsets } = yield this.client.fieldsets.rawList(itemType.id);
+            this.fieldsetsByItemType.set(itemType.id, fieldsets);
+            return fieldsets;
+        });
+    }
+    /**
+     * Loads and caches all plugins from the DatoCMS API.
+     * This method is called lazily and caches the result for subsequent calls.
+     * @returns Promise that resolves to an array of plugins
+     */
+    loadPlugins() {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (!this.pluginsPromise) {
+                this.pluginsPromise = (() => __awaiter(this, void 0, void 0, function* () {
+                    const { data: plugins } = yield this.client.plugins.rawList();
+                    // Populate the lookup maps
+                    for (const plugin of plugins) {
+                        this.pluginsById.set(plugin.id, plugin);
+                        if (plugin.attributes.package_name) {
+                            this.pluginsByPackageName.set(plugin.attributes.package_name, plugin);
+                        }
+                    }
+                    return plugins;
+                }))();
+            }
+            return this.pluginsPromise;
+        });
+    }
+    /**
+     * Gets all plugins from the DatoCMS project.
+     * @returns Promise that resolves to an array of all plugins
+     */
+    getAllPlugins() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getAllRawPlugins();
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets all plugins from the DatoCMS project.
+     * @returns Promise that resolves to an array of all plugins
+     */
+    getAllRawPlugins() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const plugins = yield this.loadPlugins();
+            return plugins;
+        });
+    }
+    /**
+     * Gets a plugin by its ID.
+     * @param id - The ID of the plugin to retrieve
+     * @returns Promise that resolves to the plugin
+     * @throws Error if the plugin is not found
+     */
+    getPluginById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getRawPluginById(id);
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets a plugin by its ID.
+     * @param id - The ID of the plugin to retrieve
+     * @returns Promise that resolves to the plugin
+     * @throws Error if the plugin is not found
+     */
+    getRawPluginById(id) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadPlugins();
+            const plugin = this.pluginsById.get(id);
+            if (!plugin) {
+                throw new Error(`Plugin with ID '${id}' not found`);
+            }
+            return plugin;
+        });
+    }
+    /**
+     * Gets a plugin by its package name.
+     * @param packageName - The package name of the plugin to retrieve
+     * @returns Promise that resolves to the plugin
+     * @throws Error if the plugin is not found
+     */
+    getPluginByPackageName(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const rawResult = yield this.getRawPluginByPackageName(packageName);
+            return deserializeResponseBody({
+                data: rawResult,
+            });
+        });
+    }
+    /**
+     * Gets a plugin by its package name.
+     * @param packageName - The package name of the plugin to retrieve
+     * @returns Promise that resolves to the plugin
+     * @throws Error if the plugin is not found
+     */
+    getRawPluginByPackageName(packageName) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.loadPlugins();
+            const plugin = this.pluginsByPackageName.get(packageName);
+            if (!plugin) {
+                throw new Error(`Plugin with package name '${packageName}' not found`);
+            }
+            return plugin;
+        });
+    }
+}
+//# sourceMappingURL=schemaRepository.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"schemaRepository.js","sourceRoot":"","sources":["../../../src/utilities/schemaRepository.ts"],"names":[],"mappings":";;;;;;;;;AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,4BAA4B,CAAC;AAmBrE;;;GAGG;AACH,MAAM,OAAO,gBAAgB;IAW3B;;;OAGG;IACH,YAAY,MAAqB;QAbzB,qBAAgB,GAA2C,IAAI,CAAC;QAChE,sBAAiB,GAAsC,IAAI,GAAG,EAAE,CAAC;QACjE,kBAAa,GAAsC,IAAI,GAAG,EAAE,CAAC;QAC7D,qBAAgB,GAAqC,IAAI,GAAG,EAAE,CAAC;QAC/D,wBAAmB,GAAwC,IAAI,GAAG,EAAE,CAAC;QACrE,mBAAc,GAAyC,IAAI,CAAC;QAC5D,gBAAW,GAAoC,IAAI,GAAG,EAAE,CAAC;QACzD,yBAAoB,GAAoC,IAAI,GAAG,EAAE,CAAC;QAOxE,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;IACvB,CAAC;IAED;;;;OAIG;IACW,aAAa;;YACzB,IAAI,CAAC,IAAI,CAAC,gBAAgB,EAAE;gBAC1B,IAAI,CAAC,gBAAgB,GAAG,CAAC,GAAS,EAAE;oBAClC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,EAAE,CAAC;oBAElE,2BAA2B;oBAC3B,KAAK,MAAM,QAAQ,IAAI,SAAS,EAAE;wBAChC,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,QAAQ,CAAC,UAAU,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;wBAClE,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,QAAQ,CAAC,CAAC;qBAC/C;oBAED,OAAO,SAAS,CAAC;gBACnB,CAAC,CAAA,CAAC,EAAE,CAAC;aACN;YAED,OAAO,IAAI,CAAC,gBAAgB,CAAC;QAC/B,CAAC;KAAA;IAED;;;OAGG;IACG,eAAe;;YACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,EAAE,CAAC;YAClD,OAAO,uBAAuB,CAA+B;gBAC3D,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,kBAAkB;;YACtB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;;OAGG;IACG,YAAY;;YAChB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,eAAe,EAAE,CAAC;YAC/C,OAAO,uBAAuB,CAA+B;gBAC3D,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,eAAe;;YACnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAChE,CAAC;KAAA;IAED;;;OAGG;IACG,iBAAiB;;YACrB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,EAAE,CAAC;YACpD,OAAO,uBAAuB,CAA+B;gBAC3D,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,oBAAoB;;YACxB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAC7C,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;QAC/D,CAAC;KAAA;IAED;;;;;OAKG;IACG,mBAAmB,CACvB,MAAc;;YAEd,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC;YAC5D,OAAO,uBAAuB,CAA6B;gBACzD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,sBAAsB,CAAC,MAAc;;YACzC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,iBAAiB,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;YACpD,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,2BAA2B,MAAM,aAAa,CAAC,CAAC;aACjE;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAED;;;;;OAKG;IACG,eAAe,CAAC,EAAU;;YAC9B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAAC,EAAE,CAAC,CAAC;YACpD,OAAO,uBAAuB,CAA6B;gBACzD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,kBAAkB,CAAC,EAAU;;YACjC,MAAM,IAAI,CAAC,aAAa,EAAE,CAAC;YAE3B,MAAM,QAAQ,GAAG,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC5C,IAAI,CAAC,QAAQ,EAAE;gBACb,MAAM,IAAI,KAAK,CAAC,sBAAsB,EAAE,aAAa,CAAC,CAAC;aACxD;YAED,OAAO,QAAQ,CAAC;QAClB,CAAC;KAAA;IAED;;;;;OAKG;IACG,iBAAiB,CACrB,QAA2D;;YAE3D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,oBAAoB,CAC/C,QAAgC,CACjC,CAAC;YACF,OAAO,uBAAuB,CAA4B;gBACxD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,oBAAoB,CACxB,QAA8B;;YAE9B,6CAA6C;YAC7C,MAAM,YAAY,GAAG,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAC5D,IAAI,YAAY,EAAE;gBAChB,OAAO,YAAY,CAAC;aACrB;YAED,6BAA6B;YAC7B,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YACvE,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;YAE/C,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IAED;;;;;OAKG;IACG,oBAAoB,CACxB,QAA2D;;YAE3D,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAClD,QAAgC,CACjC,CAAC;YACF,OAAO,uBAAuB,CAA+B;gBAC3D,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,uBAAuB,CAC3B,QAA8B;;YAE9B,gDAAgD;YAChD,MAAM,eAAe,GAAG,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC;YAClE,IAAI,eAAe,EAAE;gBACnB,OAAO,eAAe,CAAC;aACxB;YAED,gCAAgC;YAChC,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,OAAO,CAC7D,QAAQ,CAAC,EAAE,CACZ,CAAC;YACF,IAAI,CAAC,mBAAmB,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE,EAAE,SAAS,CAAC,CAAC;YAErD,OAAO,SAAS,CAAC;QACnB,CAAC;KAAA;IAED;;;;OAIG;IACW,WAAW;;YACvB,IAAI,CAAC,IAAI,CAAC,cAAc,EAAE;gBACxB,IAAI,CAAC,cAAc,GAAG,CAAC,GAAS,EAAE;oBAChC,MAAM,EAAE,IAAI,EAAE,OAAO,EAAE,GAAG,MAAM,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,OAAO,EAAE,CAAC;oBAE9D,2BAA2B;oBAC3B,KAAK,MAAM,MAAM,IAAI,OAAO,EAAE;wBAC5B,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE,EAAE,MAAM,CAAC,CAAC;wBACxC,IAAI,MAAM,CAAC,UAAU,CAAC,YAAY,EAAE;4BAClC,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAC3B,MAAM,CAAC,UAAU,CAAC,YAAY,EAC9B,MAAM,CACP,CAAC;yBACH;qBACF;oBAED,OAAO,OAAO,CAAC;gBACjB,CAAC,CAAA,CAAC,EAAE,CAAC;aACN;YAED,OAAO,IAAI,CAAC,cAAc,CAAC;QAC7B,CAAC;KAAA;IAED;;;OAGG;IACG,aAAa;;YACjB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;YAChD,OAAO,uBAAuB,CAA6B;gBACzD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;OAGG;IACG,gBAAgB;;YACpB,MAAM,OAAO,GAAG,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YACzC,OAAO,OAAO,CAAC;QACjB,CAAC;KAAA;IAED;;;;;OAKG;IACG,aAAa,CAAC,EAAU;;YAC5B,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC,CAAC;YAClD,OAAO,uBAAuB,CAA2B;gBACvD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,gBAAgB,CAAC,EAAU;;YAC/B,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YACxC,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,mBAAmB,EAAE,aAAa,CAAC,CAAC;aACrD;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;IAED;;;;;OAKG;IACG,sBAAsB,CAC1B,WAAmB;;YAEnB,MAAM,SAAS,GAAG,MAAM,IAAI,CAAC,yBAAyB,CAAC,WAAW,CAAC,CAAC;YACpE,OAAO,uBAAuB,CAA2B;gBACvD,IAAI,EAAE,SAAS;aAChB,CAAC,CAAC;QACL,CAAC;KAAA;IAED;;;;;OAKG;IACG,yBAAyB,CAC7B,WAAmB;;YAEnB,MAAM,IAAI,CAAC,WAAW,EAAE,CAAC;YAEzB,MAAM,MAAM,GAAG,IAAI,CAAC,oBAAoB,CAAC,GAAG,CAAC,WAAW,CAAC,CAAC;YAC1D,IAAI,CAAC,MAAM,EAAE;gBACX,MAAM,IAAI,KAAK,CAAC,6BAA6B,WAAW,aAAa,CAAC,CAAC;aACxE;YAED,OAAO,MAAM,CAAC;QAChB,CAAC;KAAA;CACF"}

package/dist/esm/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 {};