@datocms/cma-client 5.2.0-alpha.4 → 5.2.0-alpha.5

package/src/generated/resources/ItemType.ts

@@ -7,7 +7,7 @@ export default class ItemType extends BaseResource {
   static readonly TYPE = 'item_type' as const;
 
   /**
-   * Create a new model
+   * Create a new model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
    *
@@ -55,7 +55,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Create a new model
+   * Create a new model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
    *
@@ -75,7 +75,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Update a model
+   * Update a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
    *
@@ -125,7 +125,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Update a model
+   * Update a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
    *
@@ -144,7 +144,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * List all models
+   * List all models/block models
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
    *
@@ -160,7 +160,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * List all models
+   * List all models/block models
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
    *
@@ -175,7 +175,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Retrieve a model
+   * Retrieve a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
    *
@@ -189,7 +189,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Retrieve a model
+   * Retrieve a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
    *
@@ -204,7 +204,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Duplicate model
+   * Duplicate model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
    *
@@ -220,7 +220,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Duplicate model
+   * Duplicate model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
    *
@@ -237,7 +237,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Delete a model
+   * Delete a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
    *
@@ -254,7 +254,7 @@ export default class ItemType extends BaseResource {
   }
 
   /**
-   * Delete a model
+   * Delete a model/block model
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
    *

package/src/generated/resources/SearchIndex.ts

@@ -69,7 +69,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Create search index
+   * Create a search index
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
    *
@@ -80,13 +80,7 @@ export default class SearchIndex extends BaseResource {
     return this.rawCreate(
       Utils.serializeRequestBody<RawApiTypes.SearchIndexCreateSchema>(body, {
         type: 'search_index',
-        attributes: [
-          'name',
-          'enabled',
-          'build_trigger_indexing_enabled',
-          'frontend_url',
-          'user_agent_suffix',
-        ],
+        attributes: ['name', 'enabled', 'frontend_url', 'user_agent_suffix'],
         relationships: ['build_triggers'],
       }),
     ).then((body) =>
@@ -97,7 +91,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Create search index
+   * Create a search index
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
    *
@@ -115,7 +109,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Update search index
+   * Update a search index
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
    *
@@ -131,13 +125,7 @@ export default class SearchIndex extends BaseResource {
       Utils.serializeRequestBody<RawApiTypes.SearchIndexUpdateSchema>(body, {
         id: Utils.toId(searchIndexId),
         type: 'search_index',
-        attributes: [
-          'name',
-          'enabled',
-          'build_trigger_indexing_enabled',
-          'frontend_url',
-          'user_agent_suffix',
-        ],
+        attributes: ['name', 'enabled', 'frontend_url', 'user_agent_suffix'],
         relationships: ['build_triggers'],
       }),
     ).then((body) =>
@@ -148,7 +136,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Update search index
+   * Update a search index
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
    *
@@ -167,7 +155,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Trigger a site search indexing
+   * Trigger the indexing process
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
    *
@@ -179,7 +167,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Trigger a site search indexing
+   * Trigger the indexing process
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
    *
@@ -194,7 +182,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Abort a site search spidering and mark it as failed
+   * Abort a the current indexing process and mark it as failed
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
    *
@@ -206,7 +194,7 @@ export default class SearchIndex extends BaseResource {
   }
 
   /**
-   * Abort a site search spidering and mark it as failed
+   * Abort a the current indexing process and mark it as failed
    *
    * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/abort
    *

package/src/utilities/schemaRepository.ts

@@ -1,7 +1,10 @@
 import { deserializeResponseBody } from '@datocms/rest-client-utils';
 import type * as ApiTypes from '../generated/ApiTypes';
 import type * as RawApiTypes from '../generated/RawApiTypes';
-import { blockModelIdsReferencedInField } from './fieldsContainingReferences';
+import {
+  blockModelIdsReferencedInField,
+  modelIdsReferencedInField,
+} from './fieldsContainingReferences';
 
 interface GenericClient {
   itemTypes: {
@@ -265,9 +268,7 @@ export class SchemaRepository {
   async getItemTypeFields(
     itemType: ApiTypes.ItemType | RawApiTypes.ItemType,
   ): Promise<ApiTypes.Field[]> {
-    const rawResult = await this.getRawItemTypeFields(
-      itemType as RawApiTypes.ItemType,
-    );
+    const rawResult = await this.getRawItemTypeFields(itemType);
     return deserializeResponseBody<ApiTypes.Field[]>({
       data: rawResult,
     });
@@ -280,7 +281,7 @@ export class SchemaRepository {
    * @returns Promise that resolves to an array of fields
    */
   async getRawItemTypeFields(
-    itemType: RawApiTypes.ItemType,
+    itemType: ApiTypes.ItemType | RawApiTypes.ItemType,
   ): Promise<RawApiTypes.Field[]> {
     // Check if we already have the fields cached
     const cachedFields = this.fieldsByItemType.get(itemType.id);
@@ -304,9 +305,7 @@ export class SchemaRepository {
   async getItemTypeFieldsets(
     itemType: ApiTypes.ItemType | RawApiTypes.ItemType,
   ): Promise<ApiTypes.Fieldset[]> {
-    const rawResult = await this.getRawItemTypeFieldsets(
-      itemType as RawApiTypes.ItemType,
-    );
+    const rawResult = await this.getRawItemTypeFieldsets(itemType);
     return deserializeResponseBody<ApiTypes.Fieldset[]>({
       data: rawResult,
     });
@@ -319,7 +318,7 @@ export class SchemaRepository {
    * @returns Promise that resolves to an array of fieldsets
    */
   async getRawItemTypeFieldsets(
-    itemType: RawApiTypes.ItemType,
+    itemType: ApiTypes.ItemType | RawApiTypes.ItemType,
   ): Promise<RawApiTypes.Fieldset[]> {
     // Check if we already have the fieldsets cached
     const cachedFieldsets = this.fieldsetsByItemType.get(itemType.id);
@@ -589,4 +588,163 @@ export class SchemaRepository {
       data: rawResult,
     });
   }
+
+  /**
+   * Gets all block models that are directly or indirectly nested within the given item types.
+   * This method recursively traverses the schema to find all blocks that are nested
+   * within the provided item types, either directly through block fields or indirectly through
+   * other nested block models.
+   *
+   * @param itemTypes - Array of item types to find nested blocks for
+   * @returns Promise that resolves to array of all block models nested in these item types
+   */
+  async getRawNestedBlocks(
+    itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>,
+  ): Promise<Array<RawApiTypes.ItemType>> {
+    await this.prefetchAllModelsAndFields();
+
+    const allItemTypes = await this.getAllRawItemTypes();
+    const visited = new Set<string>();
+    const nestedBlocks: Array<RawApiTypes.ItemType> = [];
+
+    // Helper function to recursively find nested blocks
+    const findNestedBlocks = async (
+      itemType: ApiTypes.ItemType | RawApiTypes.ItemType,
+      alreadyExplored: Set<string> = new Set(),
+    ): Promise<void> => {
+      if (alreadyExplored.has(itemType.id)) {
+        return;
+      }
+
+      alreadyExplored.add(itemType.id);
+
+      const fields = await this.getRawItemTypeFields(itemType);
+
+      for (const field of fields) {
+        const referencedBlockIds = blockModelIdsReferencedInField(field);
+
+        for (const blockId of referencedBlockIds) {
+          if (!visited.has(blockId)) {
+            visited.add(blockId);
+            const nestedBlock = allItemTypes.find((it) => it.id === blockId);
+            if (nestedBlock) {
+              nestedBlocks.push(nestedBlock);
+              // Recursively find blocks nested in this block
+              await findNestedBlocks(nestedBlock, new Set(alreadyExplored));
+            }
+          }
+        }
+      }
+    };
+
+    // Find nested blocks for each provided item type
+    for (const itemType of itemTypes) {
+      await findNestedBlocks(itemType);
+    }
+
+    return nestedBlocks;
+  }
+
+  /**
+   * Gets all block models that are directly or indirectly nested within the given item types.
+   * This method recursively traverses the schema to find all blocks that are nested
+   * within the provided item types, either directly through block fields or indirectly through
+   * other nested block models.
+   *
+   * @param itemTypes - Array of item types to find nested blocks for
+   * @returns Promise that resolves to array of all block models nested in these item types
+   */
+  async getNestedBlocks(
+    itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>,
+  ): Promise<Array<ApiTypes.ItemType>> {
+    const rawResult = await this.getRawNestedBlocks(itemTypes);
+    return deserializeResponseBody<ApiTypes.ItemType[]>({
+      data: rawResult,
+    });
+  }
+
+  /**
+   * Gets all models that are directly or indirectly nested/referenced within the given item types.
+   * This method recursively traverses the schema to find all models that are referenced
+   * by the provided item types through link fields, either directly or indirectly through
+   * other referenced blocks.
+   *
+   * @param itemTypes - Array of item types to find nested models for
+   * @returns Promise that resolves to array of all models nested in these item types
+   */
+  async getRawNestedModels(
+    itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>,
+  ): Promise<Array<RawApiTypes.ItemType>> {
+    await this.prefetchAllModelsAndFields();
+
+    const allItemTypes = await this.getAllRawItemTypes();
+    const visited = new Set<string>();
+    const nestedModels: Array<RawApiTypes.ItemType> = [];
+
+    // Helper function to recursively find nested models
+    const findNestedModels = async (
+      itemType: ApiTypes.ItemType | RawApiTypes.ItemType,
+      alreadyExplored: Set<string> = new Set(),
+    ): Promise<void> => {
+      if (alreadyExplored.has(itemType.id)) {
+        return;
+      }
+
+      alreadyExplored.add(itemType.id);
+
+      const fields = await this.getRawItemTypeFields(itemType);
+
+      for (const field of fields) {
+        // Find models directly referenced via link fields
+        const referencedModelIds = modelIdsReferencedInField(field);
+
+        for (const modelId of referencedModelIds) {
+          if (!visited.has(modelId)) {
+            visited.add(modelId);
+            const nestedModel = allItemTypes.find((it) => it.id === modelId);
+            if (nestedModel) {
+              nestedModels.push(nestedModel);
+              // Do NOT recurse into models, only into blocks
+            }
+          }
+        }
+
+        // Find blocks referenced via block fields, then recursively find models in those blocks
+        const referencedBlockIds = blockModelIdsReferencedInField(field);
+
+        for (const blockId of referencedBlockIds) {
+          const nestedBlock = allItemTypes.find((it) => it.id === blockId);
+          if (nestedBlock) {
+            // Recursively find models nested in this block
+            await findNestedModels(nestedBlock, new Set(alreadyExplored));
+          }
+        }
+      }
+    };
+
+    // Find nested models for each provided item type
+    for (const itemType of itemTypes) {
+      await findNestedModels(itemType);
+    }
+
+    return nestedModels;
+  }
+
+  /**
+   * Gets all models that are directly or indirectly nested/referenced within the given item types.
+   * This method recursively traverses the schema to find all models that are referenced
+   * by the provided item types through link fields, either directly or indirectly through
+   * other referenced blocks.
+   *
+   * @param itemTypes - Array of item types to find nested models for
+   * @returns Promise that resolves to array of all models nested in these item types
+   */
+  async getNestedModels(
+    itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>,
+  ): Promise<Array<ApiTypes.ItemType>> {
+    const rawResult = await this.getRawNestedModels(itemTypes);
+    return deserializeResponseBody<ApiTypes.ItemType[]>({
+      data: rawResult,
+    });
+  }
 }