@datocms/cma-client 2.2.5 → 3.0.0

package/dist/types/generated/SchemaTypes.d.ts

@@ -19,7 +19,7 @@ export declare type RoleType = 'role';
  */
 export declare type RoleIdentity = string;
 /**
- * ID of item type
+ * RFC 4122 UUID of item type expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `definition` "identity".
@@ -29,7 +29,7 @@ export declare type RoleIdentity = string;
  */
 export declare type ItemTypeIdentity = string;
 /**
- * ID of workflow
+ * RFC 4122 UUID of workflow expressed in URL-safe base64 format
  *
  * This interface was referenced by `Workflow`'s JSON-Schema
  * via the `definition` "identity".
@@ -269,7 +269,7 @@ export declare type SitePlanIdentity = string;
  */
 export declare type MenuItemType = 'menu_item';
 /**
- * ID of menu item
+ * RFC 4122 UUID of menu item expressed in URL-safe base64 format
  *
  * This interface was referenced by `MenuItem`'s JSON-Schema
  * via the `definition` "identity".
@@ -293,7 +293,7 @@ export declare type ItemTypeType = 'item_type';
  */
 export declare type ItemTypeFilterType = 'item_type_filter';
 /**
- * ID of filter
+ * RFC 4122 UUID of filter expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
  * via the `definition` "identity".
@@ -322,7 +322,7 @@ export declare type MenuItemInstancesHrefSchema = {
  */
 export declare type ItemType1 = 'item';
 /**
- * ID of record
+ * RFC 4122 UUID of record expressed in URL-safe base64 format
  *
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `definition` "identity".
@@ -339,7 +339,7 @@ export declare type ItemIdentity = string;
  */
 export declare type FieldType = 'field';
 /**
- * ID of field
+ * RFC 4122 UUID of field expressed in URL-safe base64 format
  *
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `definition` "identity".
@@ -356,7 +356,7 @@ export declare type FieldIdentity = string;
  */
 export declare type FieldsetType = 'fieldset';
 /**
- * ID of fieldset
+ * RFC 4122 UUID of fieldset expressed in URL-safe base64 format
  *
  * This interface was referenced by `Fieldset`'s JSON-Schema
  * via the `definition` "identity".
@@ -436,7 +436,7 @@ export declare type SessionIdentity = string;
  */
 export declare type PluginType = 'plugin';
 /**
- * ID of plugin
+ * RFC 4122 UUID of plugin expressed in URL-safe base64 format
  *
  * This interface was referenced by `Plugin`'s JSON-Schema
  * via the `definition` "identity".
@@ -623,7 +623,7 @@ export declare type ItemSelfHrefSchema = {
  */
 export declare type ItemCurrentVsPublishedStateType = 'item_current_vs_published_state';
 /**
- * ID of record
+ * RFC 4122 UUID of record expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
  * via the `definition` "identity".
@@ -674,7 +674,7 @@ export declare type ScheduledUnpublishingIdentity = string;
  */
 export declare type ItemVersionType = 'item_version';
 /**
- * ID of record version
+ * RFC 4122 UUID of redord version expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemVersion`'s JSON-Schema
  * via the `definition` "identity".
@@ -808,7 +808,7 @@ export declare type ItemUnpublishHrefSchema = {
  */
 export declare type UploadType = 'upload';
 /**
- * ID of upload
+ * RFC 4122 UUID of upload expressed in URL-safe base64 format
  *
  * This interface was referenced by `Upload`'s JSON-Schema
  * via the `definition` "identity".
@@ -1097,7 +1097,7 @@ export declare type WebhookCallInstancesHrefSchema = {
  */
 export declare type UploadFilterType = 'upload_filter';
 /**
- * ID of filter
+ * RFC 4122 UUID of upload filter expressed in URL-safe base64 format
  *
  * This interface was referenced by `UploadFilter`'s JSON-Schema
  * via the `definition` "identity".
@@ -3967,7 +3967,7 @@ export declare type ItemTypeDestroyJobSchema = {
  *
  * Below you'll find a summary of all the validators available for each field type with their settings.
  *
- * Some validators are required for a specific type of field. For example, the _Slug_ field needs to have a `slug_title_field` validator to specify the ID of the _Single-line string_ field that will be used to generate the slug itself.
+ * Some validators are required for a specific type of field. For example, the _Modular Content_ field needs to have a `rich_text_blocks` validator, specifying which types of blocks it can contain.
  *
  * ### Specifying the appearance
  *
@@ -4153,23 +4153,22 @@ export declare type ItemTypeDestroyJobSchema = {
  * <details>
  * <summary>SEO and Social (<code>seo</code>)</summary>
  *
- * | Property                       | Value                                                                                        |
- * | ------------------------------ | -------------------------------------------------------------------------------------------- |
- * | Code                           | `seo`                                                                                        |
- * | Built-in editors for the field | `seo`                                                                                        |
- * | Available validators           | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
+ * | Property                       | Value                                                                                                              |
+ * | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+ * | Code                           | `seo`                                                                                                              |
+ * | Built-in editors for the field | `seo`                                                                                                              |
+ * | Available validators           | `required_seo_fields`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `title_length`, `description_length` |
  *
  * </details>
  *
  * <details>
  * <summary>Slug (<code>slug</code>)</summary>
  *
- * | Property                       | Value                               |
- * | ------------------------------ | ----------------------------------- |
- * | Code                           | `slug`                              |
- * | Built-in editors for the field | `slug`                              |
- * | Required validators            | `slug_title_field`                  |
- * | Other validators available     | `required`, `length`, `slug_format` |
+ * | Property                       | Value                                                   |
+ * | ------------------------------ | ------------------------------------------------------- |
+ * | Code                           | `slug`                                                  |
+ * | Built-in editors for the field | `slug`                                                  |
+ * | Available validators           | `required`, `length`, `slug_format`, `slug_title_field` |
  *
  * </details>
  *
@@ -4187,22 +4186,22 @@ export declare type ItemTypeDestroyJobSchema = {
  * <details>
  * <summary>Single-asset (<code>file</code>)</summary>
  *
- * | Property                       | Value                                                                          |
- * | ------------------------------ | ------------------------------------------------------------------------------ |
- * | Code                           | `file`                                                                         |
- * | Built-in editors for the field | `file`                                                                         |
- * | Available validators           | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
+ * | Property                       | Value                                                                                                |
+ * | ------------------------------ | ---------------------------------------------------------------------------------------------------- |
+ * | Code                           | `file`                                                                                               |
+ * | Built-in editors for the field | `file`                                                                                               |
+ * | Available validators           | `required`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
  *
  * </details>
  *
  * <details>
  * <summary>Asset gallery (<code>gallery</code>)</summary>
  *
- * | Property                       | Value                                                                      |
- * | ------------------------------ | -------------------------------------------------------------------------- |
- * | Code                           | `gallery`                                                                  |
- * | Built-in editors for the field | `gallery`                                                                  |
- * | Available validators           | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
+ * | Property                       | Value                                                                                            |
+ * | ------------------------------ | ------------------------------------------------------------------------------------------------ |
+ * | Code                           | `gallery`                                                                                        |
+ * | Built-in editors for the field | `gallery`                                                                                        |
+ * | Available validators           | `size`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
  *
  * </details>
  *
@@ -4358,7 +4357,7 @@ export declare type ItemTypeDestroyJobSchema = {
  * <details>
  * <summary><code>image_dimensions</code></summary>
  *
- * Accept assets only within a specified height/width range.
+ * Accept assets only within a specified height and width range.
  *
  * | Parameter          | Type      | Required | Description                      |
  * | ------------------ | --------- | -------- | -------------------------------- |
@@ -4367,7 +4366,25 @@ export declare type ItemTypeDestroyJobSchema = {
  * | `height_min_value` | `Integer` |          | Numeric value for minimum width  |
  * | `height_max_value` | `Integer` |          | Numeric value for maximum height |
  *
- * At least one parameter must be specified.
+ * At least one pair of height/width parameters must be specified.
+ *
+ * </details>
+ *
+ * <details>
+ * <summary><code>image_aspect_ratio</code></summary>
+ *
+ * Accept assets only within a specified aspect ratio range.
+ *
+ * | Parameter            | Type      | Required | Description                                    |
+ * | -------------------- | --------- | -------- | ---------------------------------------------- |
+ * | `min_ar_numerator`   | `Integer` |          | Numerator part of the minimum aspect ratio     |
+ * | `min_ar_denominator` | `Integer` |          | Denominator part of the minimum aspect ratio   |
+ * | `eq_ar_numerator`    | `Integer` |          | Numerator part for the required aspect ratio   |
+ * | `eq_ar_denominator`  | `Integer` |          | Denominator part for the required aspect ratio |
+ * | `max_ar_numerator`   | `Integer` |          | Numerator part of the maximum aspect ratio     |
+ * | `max_ar_denominator` | `Integer` |          | Denominator part of the maximum aspect ratio   |
+ *
+ * At least one pair of numerator/denominator must be specified.
  *
  * </details>
  *
@@ -5896,6 +5913,13 @@ export declare type BuildEventSelfTargetSchema = {
 /**
  * DatoCMS stores the individual pieces of content you create from a model as records, which are much like table rows in a database. For backward-compatibility reasons, the API refers to records as "items".
  *
+ * You can learn how the records are structured at the API level, and everything that is necessary to interact with the records through CMA in the following detail sections:
+ *
+ * * [List/filter records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
+ * * [Create new records](https://www.datocms.com/docs/content-management-api/resources/item/create)
+ * * [Update existing records](https://www.datocms.com/docs/content-management-api/resources/item/update)
+ *
+ *
  * This interface was referenced by `DatoApi`'s JSON-Schema
  * via the `definition` "item".
  */

package/dist/types/generated/SimpleSchemaTypes.d.ts

@@ -19,7 +19,7 @@ export declare type RoleIdentity = string;
  */
 export declare type RoleType = 'role';
 /**
- * ID of item type
+ * RFC 4122 UUID of item type expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemType`'s JSON-Schema
  * via the `definition` "identity".
@@ -29,7 +29,7 @@ export declare type RoleType = 'role';
  */
 export declare type ItemTypeIdentity = string;
 /**
- * ID of workflow
+ * RFC 4122 UUID of workflow expressed in URL-safe base64 format
  *
  * This interface was referenced by `Workflow`'s JSON-Schema
  * via the `definition` "identity".
@@ -297,7 +297,7 @@ export declare type SitePlanIdentity = string;
  */
 export declare type SitePlanType = 'site_plan';
 /**
- * ID of menu item
+ * RFC 4122 UUID of menu item expressed in URL-safe base64 format
  *
  * This interface was referenced by `MenuItem`'s JSON-Schema
  * via the `definition` "identity".
@@ -328,7 +328,7 @@ export declare type ItemTypeType = 'item_type';
  */
 export declare type ItemTypeFilterType = 'item_type_filter';
 /**
- * ID of filter
+ * RFC 4122 UUID of filter expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemTypeFilter`'s JSON-Schema
  * via the `definition` "identity".
@@ -362,7 +362,7 @@ export declare type MenuItemInstancesHrefSchema = {
  */
 export declare type ItemType1 = 'item';
 /**
- * ID of record
+ * RFC 4122 UUID of record expressed in URL-safe base64 format
  *
  * This interface was referenced by `Item`'s JSON-Schema
  * via the `definition` "identity".
@@ -379,7 +379,7 @@ export declare type ItemIdentity = string;
  */
 export declare type FieldType = 'field';
 /**
- * ID of field
+ * RFC 4122 UUID of field expressed in URL-safe base64 format
  *
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `definition` "identity".
@@ -396,7 +396,7 @@ export declare type FieldIdentity = string;
  */
 export declare type FieldsetType = 'fieldset';
 /**
- * ID of fieldset
+ * RFC 4122 UUID of fieldset expressed in URL-safe base64 format
  *
  * This interface was referenced by `Fieldset`'s JSON-Schema
  * via the `definition` "identity".
@@ -494,7 +494,7 @@ export declare type SessionIdentity = string;
  */
 export declare type SessionType = 'session';
 /**
- * ID of plugin
+ * RFC 4122 UUID of plugin expressed in URL-safe base64 format
  *
  * This interface was referenced by `Plugin`'s JSON-Schema
  * via the `definition` "identity".
@@ -716,7 +716,7 @@ export declare type ItemSelfHrefSchema = {
     [k: string]: unknown;
 };
 /**
- * ID of record
+ * RFC 4122 UUID of record expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemCurrentVsPublishedState`'s JSON-Schema
  * via the `definition` "identity".
@@ -774,7 +774,7 @@ export declare type ScheduledUnpublishingIdentity = string;
  */
 export declare type ItemVersionType = 'item_version';
 /**
- * ID of record version
+ * RFC 4122 UUID of redord version expressed in URL-safe base64 format
  *
  * This interface was referenced by `ItemVersion`'s JSON-Schema
  * via the `definition` "identity".
@@ -938,7 +938,7 @@ export declare type ItemVersionInstancesHrefSchema = {
     [k: string]: unknown;
 };
 /**
- * ID of upload
+ * RFC 4122 UUID of upload expressed in URL-safe base64 format
  *
  * This interface was referenced by `Upload`'s JSON-Schema
  * via the `definition` "identity".
@@ -1297,7 +1297,7 @@ export declare type BuildTriggerInstancesTargetSchema = BuildTrigger[];
  */
 export declare type ItemTypeFilterInstancesTargetSchema = ItemTypeFilter[];
 /**
- * ID of filter
+ * RFC 4122 UUID of upload filter expressed in URL-safe base64 format
  *
  * This interface was referenced by `UploadFilter`'s JSON-Schema
  * via the `definition` "identity".
@@ -4488,7 +4488,7 @@ export declare type JobData = {
  *
  * Below you'll find a summary of all the validators available for each field type with their settings.
  *
- * Some validators are required for a specific type of field. For example, the _Slug_ field needs to have a `slug_title_field` validator to specify the ID of the _Single-line string_ field that will be used to generate the slug itself.
+ * Some validators are required for a specific type of field. For example, the _Modular Content_ field needs to have a `rich_text_blocks` validator, specifying which types of blocks it can contain.
  *
  * ### Specifying the appearance
  *
@@ -4674,23 +4674,22 @@ export declare type JobData = {
  * <details>
  * <summary>SEO and Social (<code>seo</code>)</summary>
  *
- * | Property                       | Value                                                                                        |
- * | ------------------------------ | -------------------------------------------------------------------------------------------- |
- * | Code                           | `seo`                                                                                        |
- * | Built-in editors for the field | `seo`                                                                                        |
- * | Available validators           | `required_seo_fields`, `file_size`, `image_dimensions`, `title_length`, `description_length` |
+ * | Property                       | Value                                                                                                              |
+ * | ------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
+ * | Code                           | `seo`                                                                                                              |
+ * | Built-in editors for the field | `seo`                                                                                                              |
+ * | Available validators           | `required_seo_fields`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `title_length`, `description_length` |
  *
  * </details>
  *
  * <details>
  * <summary>Slug (<code>slug</code>)</summary>
  *
- * | Property                       | Value                               |
- * | ------------------------------ | ----------------------------------- |
- * | Code                           | `slug`                              |
- * | Built-in editors for the field | `slug`                              |
- * | Required validators            | `slug_title_field`                  |
- * | Other validators available     | `required`, `length`, `slug_format` |
+ * | Property                       | Value                                                   |
+ * | ------------------------------ | ------------------------------------------------------- |
+ * | Code                           | `slug`                                                  |
+ * | Built-in editors for the field | `slug`                                                  |
+ * | Available validators           | `required`, `length`, `slug_format`, `slug_title_field` |
  *
  * </details>
  *
@@ -4708,22 +4707,22 @@ export declare type JobData = {
  * <details>
  * <summary>Single-asset (<code>file</code>)</summary>
  *
- * | Property                       | Value                                                                          |
- * | ------------------------------ | ------------------------------------------------------------------------------ |
- * | Code                           | `file`                                                                         |
- * | Built-in editors for the field | `file`                                                                         |
- * | Available validators           | `required`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
+ * | Property                       | Value                                                                                                |
+ * | ------------------------------ | ---------------------------------------------------------------------------------------------------- |
+ * | Code                           | `file`                                                                                               |
+ * | Built-in editors for the field | `file`                                                                                               |
+ * | Available validators           | `required`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
  *
  * </details>
  *
  * <details>
  * <summary>Asset gallery (<code>gallery</code>)</summary>
  *
- * | Property                       | Value                                                                      |
- * | ------------------------------ | -------------------------------------------------------------------------- |
- * | Code                           | `gallery`                                                                  |
- * | Built-in editors for the field | `gallery`                                                                  |
- * | Available validators           | `size`, `file_size`, `image_dimensions`, `extension`, `required_alt_title` |
+ * | Property                       | Value                                                                                            |
+ * | ------------------------------ | ------------------------------------------------------------------------------------------------ |
+ * | Code                           | `gallery`                                                                                        |
+ * | Built-in editors for the field | `gallery`                                                                                        |
+ * | Available validators           | `size`, `file_size`, `image_dimensions`, `image_aspect_ratio`, `extension`, `required_alt_title` |
  *
  * </details>
  *
@@ -4879,7 +4878,7 @@ export declare type JobData = {
  * <details>
  * <summary><code>image_dimensions</code></summary>
  *
- * Accept assets only within a specified height/width range.
+ * Accept assets only within a specified height and width range.
  *
  * | Parameter          | Type      | Required | Description                      |
  * | ------------------ | --------- | -------- | -------------------------------- |
@@ -4888,7 +4887,25 @@ export declare type JobData = {
  * | `height_min_value` | `Integer` |          | Numeric value for minimum width  |
  * | `height_max_value` | `Integer` |          | Numeric value for maximum height |
  *
- * At least one parameter must be specified.
+ * At least one pair of height/width parameters must be specified.
+ *
+ * </details>
+ *
+ * <details>
+ * <summary><code>image_aspect_ratio</code></summary>
+ *
+ * Accept assets only within a specified aspect ratio range.
+ *
+ * | Parameter            | Type      | Required | Description                                    |
+ * | -------------------- | --------- | -------- | ---------------------------------------------- |
+ * | `min_ar_numerator`   | `Integer` |          | Numerator part of the minimum aspect ratio     |
+ * | `min_ar_denominator` | `Integer` |          | Denominator part of the minimum aspect ratio   |
+ * | `eq_ar_numerator`    | `Integer` |          | Numerator part for the required aspect ratio   |
+ * | `eq_ar_denominator`  | `Integer` |          | Denominator part for the required aspect ratio |
+ * | `max_ar_numerator`   | `Integer` |          | Numerator part of the maximum aspect ratio     |
+ * | `max_ar_denominator` | `Integer` |          | Denominator part of the maximum aspect ratio   |
+ *
+ * At least one pair of numerator/denominator must be specified.
  *
  * </details>
  *
@@ -6330,6 +6347,13 @@ export declare type BuildEventRelationships = {
 /**
  * DatoCMS stores the individual pieces of content you create from a model as records, which are much like table rows in a database. For backward-compatibility reasons, the API refers to records as "items".
  *
+ * You can learn how the records are structured at the API level, and everything that is necessary to interact with the records through CMA in the following detail sections:
+ *
+ * * [List/filter records](https://www.datocms.com/docs/content-management-api/resources/item/instances)
+ * * [Create new records](https://www.datocms.com/docs/content-management-api/resources/item/create)
+ * * [Update existing records](https://www.datocms.com/docs/content-management-api/resources/item/update)
+ *
+ *
  * This interface was referenced by `ScheduledPublication`'s JSON-Schema
  * via the `destroy.targetSchema` link.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "2.2.5",
+  "version": "3.0.0",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -37,10 +37,10 @@
     "url": "https://github.com/datocms/js-rest-api-clients/issues"
   },
   "dependencies": {
-    "@datocms/rest-client-utils": "^1.3.3"
+    "@datocms/rest-client-utils": "^3.0.0"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^2.2.5"
+    "@datocms/dashboard-client": "^3.0.0"
   },
-  "gitHead": "6299a33e17cd1f5add24094fb1860d5296776929"
+  "gitHead": "5a6f58cc816ea526350913a5ad49bf9c5cb968ea"
 }

package/src/generated/Client.ts

@@ -27,6 +27,8 @@ export type ClientConfigOptions = {
   logFn?: (message: string) => void;
   /** Whether to automatically retry failed requests (ie. timeout, rate-limiting, etc.), with a linear incremental backoff. Defaults to `true` */
   autoRetry?: boolean;
+  /** If fetch() is not available in your environment, you can provide it */
+  fetchFn?: Parameters<typeof request>[0]['fetchFn'];
 };
 
 export class Client {
@@ -133,7 +135,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v2.2.5',
+      userAgent: '@datocms/cma-client v3.0.0',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {