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

package/dist/types/generated/resources/ItemType.d.ts

@@ -4,7 +4,7 @@ import type * as RawApiTypes from '../RawApiTypes';
 export default class ItemType extends BaseResource {
     static readonly TYPE: "item_type";
     /**
-     * Create a new model
+     * Create a new model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
      *
@@ -13,7 +13,7 @@ export default class ItemType extends BaseResource {
      */
     create(body: ApiTypes.ItemTypeCreateSchema, queryParams?: ApiTypes.ItemTypeCreateHrefSchema): Promise<ApiTypes.ItemType>;
     /**
-     * Create a new model
+     * Create a new model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/create
      *
@@ -22,7 +22,7 @@ export default class ItemType extends BaseResource {
      */
     rawCreate(body: RawApiTypes.ItemTypeCreateSchema, queryParams?: RawApiTypes.ItemTypeCreateHrefSchema): Promise<RawApiTypes.ItemTypeCreateTargetSchema>;
     /**
-     * Update a model
+     * Update a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
      *
@@ -31,7 +31,7 @@ export default class ItemType extends BaseResource {
      */
     update(itemTypeId: string | ApiTypes.ItemTypeData, body: ApiTypes.ItemTypeUpdateSchema): Promise<ApiTypes.ItemType>;
     /**
-     * Update a model
+     * Update a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/update
      *
@@ -40,7 +40,7 @@ export default class ItemType extends BaseResource {
      */
     rawUpdate(itemTypeId: string, body: RawApiTypes.ItemTypeUpdateSchema): Promise<RawApiTypes.ItemTypeUpdateJobSchema>;
     /**
-     * List all models
+     * List all models/block models
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
      *
@@ -49,7 +49,7 @@ export default class ItemType extends BaseResource {
      */
     list(): Promise<ApiTypes.ItemTypeInstancesTargetSchema>;
     /**
-     * List all models
+     * List all models/block models
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/instances
      *
@@ -58,7 +58,7 @@ export default class ItemType extends BaseResource {
      */
     rawList(): Promise<RawApiTypes.ItemTypeInstancesTargetSchema>;
     /**
-     * Retrieve a model
+     * Retrieve a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
      *
@@ -67,7 +67,7 @@ export default class ItemType extends BaseResource {
      */
     find(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemType>;
     /**
-     * Retrieve a model
+     * Retrieve a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/self
      *
@@ -76,7 +76,7 @@ export default class ItemType extends BaseResource {
      */
     rawFind(itemTypeId: string): Promise<RawApiTypes.ItemTypeSelfTargetSchema>;
     /**
-     * Duplicate model
+     * Duplicate model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
      *
@@ -85,7 +85,7 @@ export default class ItemType extends BaseResource {
      */
     duplicate(itemTypeId: string | ApiTypes.ItemTypeData): Promise<ApiTypes.ItemType>;
     /**
-     * Duplicate model
+     * Duplicate model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/duplicate
      *
@@ -94,7 +94,7 @@ export default class ItemType extends BaseResource {
      */
     rawDuplicate(itemTypeId: string): Promise<RawApiTypes.ItemTypeDuplicateTargetSchema>;
     /**
-     * Delete a model
+     * Delete a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
      *
@@ -103,7 +103,7 @@ export default class ItemType extends BaseResource {
      */
     destroy(itemTypeId: string | ApiTypes.ItemTypeData, queryParams?: ApiTypes.ItemTypeDestroyHrefSchema): Promise<ApiTypes.ItemType>;
     /**
-     * Delete a model
+     * Delete a model/block model
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/item-type/destroy
      *

package/dist/types/generated/resources/SearchIndex.d.ts

@@ -40,7 +40,7 @@ export default class SearchIndex extends BaseResource {
      */
     rawFind(searchIndexId: string): Promise<RawApiTypes.SearchIndexSelfTargetSchema>;
     /**
-     * Create search index
+     * Create a search index
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
      *
@@ -49,7 +49,7 @@ export default class SearchIndex extends BaseResource {
      */
     create(body: ApiTypes.SearchIndexCreateSchema): Promise<ApiTypes.SearchIndex>;
     /**
-     * Create search index
+     * Create a search index
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/create
      *
@@ -58,7 +58,7 @@ export default class SearchIndex extends BaseResource {
      */
     rawCreate(body: RawApiTypes.SearchIndexCreateSchema): Promise<RawApiTypes.SearchIndexCreateTargetSchema>;
     /**
-     * Update search index
+     * Update a search index
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
      *
@@ -67,7 +67,7 @@ export default class SearchIndex extends BaseResource {
      */
     update(searchIndexId: string | ApiTypes.SearchIndexData, body: ApiTypes.SearchIndexUpdateSchema): Promise<ApiTypes.SearchIndex>;
     /**
-     * Update search index
+     * Update a search index
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/update
      *
@@ -76,7 +76,7 @@ export default class SearchIndex extends BaseResource {
      */
     rawUpdate(searchIndexId: string, body: RawApiTypes.SearchIndexUpdateSchema): Promise<RawApiTypes.SearchIndexUpdateTargetSchema>;
     /**
-     * Trigger a site search indexing
+     * Trigger the indexing process
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
      *
@@ -85,7 +85,7 @@ export default class SearchIndex extends BaseResource {
      */
     trigger(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
     /**
-     * Trigger a site search indexing
+     * Trigger the indexing process
      *
      * Read more: https://www.datocms.com/docs/content-management-api/resources/search-index/trigger
      *
@@ -94,7 +94,7 @@ export default class SearchIndex extends BaseResource {
      */
     rawTrigger(searchIndexId: string): Promise<void>;
     /**
-     * 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
      *
@@ -103,7 +103,7 @@ export default class SearchIndex extends BaseResource {
      */
     abort(searchIndexId: string | ApiTypes.SearchIndexData): Promise<void>;
     /**
-     * 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/dist/types/utilities/schemaRepository.d.ts

@@ -194,7 +194,7 @@ export declare class SchemaRepository {
      * @param itemType - The item type to get fields for
      * @returns Promise that resolves to an array of fields
      */
-    getRawItemTypeFields(itemType: RawApiTypes.ItemType): Promise<RawApiTypes.Field[]>;
+    getRawItemTypeFields(itemType: ApiTypes.ItemType | RawApiTypes.ItemType): Promise<RawApiTypes.Field[]>;
     /**
      * Gets all fieldsets for a given item type.
      * Fieldsets are cached after the first request for performance.
@@ -208,7 +208,7 @@ export declare class SchemaRepository {
      * @param itemType - The item type to get fieldsets for
      * @returns Promise that resolves to an array of fieldsets
      */
-    getRawItemTypeFieldsets(itemType: RawApiTypes.ItemType): Promise<RawApiTypes.Fieldset[]>;
+    getRawItemTypeFieldsets(itemType: ApiTypes.ItemType | RawApiTypes.ItemType): Promise<RawApiTypes.Fieldset[]>;
     /**
      * Loads and caches all plugins from the DatoCMS API.
      * This method is called lazily and caches the result for subsequent calls.
@@ -285,5 +285,45 @@ export declare class SchemaRepository {
      * @returns Promise that resolves to array of models that embed these blocks
      */
     getModelsEmbeddingBlocks(blocks: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<ApiTypes.ItemType>>;
+    /**
+     * 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
+     */
+    getRawNestedBlocks(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<RawApiTypes.ItemType>>;
+    /**
+     * 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
+     */
+    getNestedBlocks(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<ApiTypes.ItemType>>;
+    /**
+     * 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
+     */
+    getRawNestedModels(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<RawApiTypes.ItemType>>;
+    /**
+     * 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
+     */
+    getNestedModels(itemTypes: Array<ApiTypes.ItemType | RawApiTypes.ItemType>): Promise<Array<ApiTypes.ItemType>>;
 }
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.2.0-alpha.4",
+  "version": "5.2.0-alpha.5",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -42,8 +42,8 @@
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^5.2.0-alpha.4",
+    "@datocms/dashboard-client": "^5.2.0-alpha.5",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "319efa216e04297104dc7278ef514c7a8ab10355"
+  "gitHead": "9f4282b559889e0e27011246d4ebe42d9c0f8cb8"
 }

package/resources.json

@@ -959,7 +959,7 @@
         "rel": "create",
         "urlTemplate": "/item-types",
         "method": "POST",
-        "comment": "Create a new model",
+        "comment": "Create a new model/block model",
         "urlPlaceholders": [],
         "requestBodyType": "ItemTypeCreateSchema",
         "optionalRequestBody": false,
@@ -1006,7 +1006,7 @@
         "rel": "update",
         "urlTemplate": "/item-types/${itemTypeId}",
         "method": "PUT",
-        "comment": "Update a model",
+        "comment": "Update a model/block model",
         "urlPlaceholders": [
           {
             "variableName": "itemTypeId",
@@ -1065,7 +1065,7 @@
         "rel": "instances",
         "urlTemplate": "/item-types",
         "method": "GET",
-        "comment": "List all models",
+        "comment": "List all models/block models",
         "urlPlaceholders": [],
         "optionalRequestBody": false,
         "queryParamsRequired": false,
@@ -1081,7 +1081,7 @@
         "rel": "self",
         "urlTemplate": "/item-types/${itemTypeId}",
         "method": "GET",
-        "comment": "Retrieve a model",
+        "comment": "Retrieve a model/block model",
         "urlPlaceholders": [
           {
             "variableName": "itemTypeId",
@@ -1108,7 +1108,7 @@
         "rel": "duplicate",
         "urlTemplate": "/item-types/${itemTypeId}/duplicate",
         "method": "POST",
-        "comment": "Duplicate model",
+        "comment": "Duplicate model/block model",
         "urlPlaceholders": [
           {
             "variableName": "itemTypeId",
@@ -1135,7 +1135,7 @@
         "rel": "destroy",
         "urlTemplate": "/item-types/${itemTypeId}",
         "method": "DELETE",
-        "comment": "Delete a model",
+        "comment": "Delete a model/block model",
         "urlPlaceholders": [
           {
             "variableName": "itemTypeId",
@@ -4053,7 +4053,7 @@
         "rel": "create",
         "urlTemplate": "/search-indexes",
         "method": "POST",
-        "comment": "Create search index",
+        "comment": "Create a search index",
         "urlPlaceholders": [],
         "requestBodyType": "SearchIndexCreateSchema",
         "optionalRequestBody": false,
@@ -4062,7 +4062,6 @@
           "attributes": [
             "name",
             "enabled",
-            "build_trigger_indexing_enabled",
             "frontend_url",
             "user_agent_suffix"
           ],
@@ -4081,7 +4080,7 @@
         "rel": "update",
         "urlTemplate": "/search-indexes/${searchIndexId}",
         "method": "PUT",
-        "comment": "Update search index",
+        "comment": "Update a search index",
         "urlPlaceholders": [
           {
             "variableName": "searchIndexId",
@@ -4102,7 +4101,6 @@
           "attributes": [
             "name",
             "enabled",
-            "build_trigger_indexing_enabled",
             "frontend_url",
             "user_agent_suffix"
           ],
@@ -4121,7 +4119,7 @@
         "rel": "trigger",
         "urlTemplate": "/search-indexes/${searchIndexId}/trigger",
         "method": "POST",
-        "comment": "Trigger a site search indexing",
+        "comment": "Trigger the indexing process",
         "urlPlaceholders": [
           {
             "variableName": "searchIndexId",
@@ -4147,7 +4145,7 @@
         "rel": "abort",
         "urlTemplate": "/search-indexes/${searchIndexId}/abort",
         "method": "DELETE",
-        "comment": "Abort a site search spidering and mark it as failed",
+        "comment": "Abort a the current indexing process and mark it as failed",
         "urlPlaceholders": [
           {
             "variableName": "searchIndexId",