@datocms/cma-client 5.4.14 → 5.4.15

package/dist/cjs/generated/Client.js

@@ -90,7 +90,7 @@ class Client {
         return this.config.baseUrl || Client.defaultBaseUrl;
     }
     request(options) {
-        return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.14', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
+        return (0, rest_client_utils_1.request)(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.15', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
                 ? { 'X-Environment': this.config.environment }
                 : {})), { 'X-API-Version': '3' }), fetchJobResult: (jobId) => {
                 return this.jobResultsFetcher

package/dist/esm/fieldTypes/appearance/color_picker.d.ts

@@ -2,8 +2,8 @@
  * 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>;
+    /** Should the color picker allow to specify the alpha value? (default: false) */
+    enable_alpha?: boolean;
+    /** List of preset colors to offer to the user (hex color strings) (default: []) */
+    preset_colors?: Array<string>;
 };

package/dist/esm/fieldTypes/appearance/framed_single_block.d.ts

@@ -2,6 +2,6 @@
  * Built-in editor for Single block fields.
  */
 export type FramedSingleBlockEditorConfiguration = {
-    /** Whether you want block record collapsed by default or not */
+    /** Whether you want block record collapsed by default or not (default: false) */
     start_collapsed?: boolean;
 };

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

@@ -2,6 +2,6 @@
  * 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'>;
+    /** Specify which buttons the toolbar should have (default: all allowed values) */
+    toolbar?: Array<'heading' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'unordered_list' | 'ordered_list' | 'quote' | 'link' | 'image' | 'fullscreen'>;
 };

package/dist/esm/fieldTypes/appearance/rich_text.d.ts

@@ -2,6 +2,6 @@
  * Built-in editor for Modular content fields.
  */
 export type RichTextEditorConfiguration = {
-    /** Whether you want block records collapsed by default or not */
+    /** Whether you want block records collapsed by default or not (default: false) */
     start_collapsed?: boolean;
 };

package/dist/esm/fieldTypes/appearance/seo.d.ts

@@ -2,8 +2,8 @@
  * 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' | 'twitter' | 'slack' | 'whatsapp' | 'telegram' | 'facebook' | 'linkedin'>;
+    /** Specify which fields of the SEO input should be visible to editors (default: all allowed values) */
+    fields?: Array<'title' | 'description' | 'image' | 'no_index' | 'twitter_card'>;
+    /** Specify which previews should be visible to editors (default: all allowed values) */
+    previews?: Array<'google' | 'twitter' | 'slack' | 'whatsapp' | 'telegram' | 'facebook' | 'linkedin'>;
 };

package/dist/esm/fieldTypes/appearance/single_line.d.ts

@@ -2,8 +2,8 @@
  * 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;
+    /** Indicates if the field should be shown bigger, as a field representing a heading (default: false) */
+    heading?: boolean;
     /** A placeholder that will be shown in the editor's input to provide editors with an example */
     placeholder?: string;
 };

package/dist/esm/fieldTypes/appearance/structured_text.d.ts

@@ -2,16 +2,16 @@
  * Built-in editor for Structured text fields.
  */
 export type StructuredTextEditorConfiguration = {
-    /** Specify which nodes the field should allow */
-    nodes: Array<'blockquote' | 'code' | 'heading' | 'link' | 'list' | 'thematicBreak'>;
-    /** Specify which marks the field should allow */
-    marks: Array<'strong' | 'emphasis' | 'underline' | 'strikethrough' | 'code' | 'highlight'>;
-    /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) */
-    heading_levels: Array<1 | 2 | 3 | 4 | 5 | 6>;
-    /** Whether you want block nodes collapsed by default or not */
+    /** Specify which nodes the field should allow (default: all allowed values) */
+    nodes?: Array<'blockquote' | 'code' | 'heading' | 'link' | 'list' | 'thematicBreak'>;
+    /** Specify which marks the field should allow (default: all allowed values) */
+    marks?: Array<'strong' | 'emphasis' | 'underline' | 'strikethrough' | 'code' | 'highlight'>;
+    /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) (default: all allowed values) */
+    heading_levels?: Array<1 | 2 | 3 | 4 | 5 | 6>;
+    /** Whether you want block nodes collapsed by default or not (default: false) */
     blocks_start_collapsed?: boolean;
-    /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links */
+    /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links (default: true) */
     show_links_target_blank?: boolean;
-    /** Whether you want to show the complete meta editor for links */
+    /** Whether you want to show the complete meta editor for links (default: false) */
     show_links_meta_editor?: boolean;
 };

package/dist/esm/fieldTypes/appearance/wysiwyg.d.ts

@@ -2,6 +2,6 @@
  * HTML editor for Multiple-paragraph text fields.
  */
 export type WysiwygEditorConfiguration = {
-    /** Specify which buttons the toolbar should have */
-    toolbar: Array<'format' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'ordered_list' | 'unordered_list' | 'quote' | 'table' | 'link' | 'image' | 'show_source' | 'undo' | 'redo' | 'align_left' | 'align_center' | 'align_right' | 'align_justify' | 'outdent' | 'indent' | 'fullscreen'>;
+    /** Specify which buttons the toolbar should have (default: ['format', 'bold', 'italic', 'strikethrough', 'ordered_list', 'unordered_list', 'quote', 'table', 'link', 'image', 'show_source', 'fullscreen']) */
+    toolbar?: Array<'format' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'ordered_list' | 'unordered_list' | 'quote' | 'table' | 'link' | 'image' | 'show_source' | 'undo' | 'redo' | 'align_left' | 'align_center' | 'align_right' | 'align_justify' | 'outdent' | 'indent' | 'fullscreen'>;
 };

package/dist/esm/fieldTypes/validators/sanitized_html.d.ts

@@ -3,5 +3,5 @@
  */
 export type SanitizedHtmlValidator = {
     /** Content is actively sanitized before applying the validation */
-    sanitize_before_validation: boolean;
+    sanitize_before_validation?: boolean;
 };

package/dist/esm/generated/Client.js

@@ -64,7 +64,7 @@ export class Client {
         return this.config.baseUrl || Client.defaultBaseUrl;
     }
     request(options) {
-        return request(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.14', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
+        return request(Object.assign(Object.assign(Object.assign({}, this.config), options), { logFn: this.config.logFn || console.log, userAgent: '@datocms/cma-client v5.4.15', baseUrl: this.baseUrl, preCallStack: new Error().stack, extraHeaders: Object.assign(Object.assign(Object.assign({}, (this.config.extraHeaders || {})), (this.config.environment
                 ? { 'X-Environment': this.config.environment }
                 : {})), { 'X-API-Version': '3' }), fetchJobResult: (jobId) => {
                 return this.jobResultsFetcher

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

@@ -2,8 +2,8 @@
  * 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>;
+    /** Should the color picker allow to specify the alpha value? (default: false) */
+    enable_alpha?: boolean;
+    /** List of preset colors to offer to the user (hex color strings) (default: []) */
+    preset_colors?: Array<string>;
 };

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

@@ -2,6 +2,6 @@
  * Built-in editor for Single block fields.
  */
 export type FramedSingleBlockEditorConfiguration = {
-    /** Whether you want block record collapsed by default or not */
+    /** Whether you want block record collapsed by default or not (default: false) */
     start_collapsed?: boolean;
 };

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

@@ -2,6 +2,6 @@
  * 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'>;
+    /** Specify which buttons the toolbar should have (default: all allowed values) */
+    toolbar?: Array<'heading' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'unordered_list' | 'ordered_list' | 'quote' | 'link' | 'image' | 'fullscreen'>;
 };

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

@@ -2,6 +2,6 @@
  * Built-in editor for Modular content fields.
  */
 export type RichTextEditorConfiguration = {
-    /** Whether you want block records collapsed by default or not */
+    /** Whether you want block records collapsed by default or not (default: false) */
     start_collapsed?: boolean;
 };

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

@@ -2,8 +2,8 @@
  * 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' | 'twitter' | 'slack' | 'whatsapp' | 'telegram' | 'facebook' | 'linkedin'>;
+    /** Specify which fields of the SEO input should be visible to editors (default: all allowed values) */
+    fields?: Array<'title' | 'description' | 'image' | 'no_index' | 'twitter_card'>;
+    /** Specify which previews should be visible to editors (default: all allowed values) */
+    previews?: Array<'google' | 'twitter' | 'slack' | 'whatsapp' | 'telegram' | 'facebook' | 'linkedin'>;
 };

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

@@ -2,8 +2,8 @@
  * 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;
+    /** Indicates if the field should be shown bigger, as a field representing a heading (default: false) */
+    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/structured_text.d.ts

@@ -2,16 +2,16 @@
  * Built-in editor for Structured text fields.
  */
 export type StructuredTextEditorConfiguration = {
-    /** Specify which nodes the field should allow */
-    nodes: Array<'blockquote' | 'code' | 'heading' | 'link' | 'list' | 'thematicBreak'>;
-    /** Specify which marks the field should allow */
-    marks: Array<'strong' | 'emphasis' | 'underline' | 'strikethrough' | 'code' | 'highlight'>;
-    /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) */
-    heading_levels: Array<1 | 2 | 3 | 4 | 5 | 6>;
-    /** Whether you want block nodes collapsed by default or not */
+    /** Specify which nodes the field should allow (default: all allowed values) */
+    nodes?: Array<'blockquote' | 'code' | 'heading' | 'link' | 'list' | 'thematicBreak'>;
+    /** Specify which marks the field should allow (default: all allowed values) */
+    marks?: Array<'strong' | 'emphasis' | 'underline' | 'strikethrough' | 'code' | 'highlight'>;
+    /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) (default: all allowed values) */
+    heading_levels?: Array<1 | 2 | 3 | 4 | 5 | 6>;
+    /** Whether you want block nodes collapsed by default or not (default: false) */
     blocks_start_collapsed?: boolean;
-    /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links */
+    /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links (default: true) */
     show_links_target_blank?: boolean;
-    /** Whether you want to show the complete meta editor for links */
+    /** Whether you want to show the complete meta editor for links (default: false) */
     show_links_meta_editor?: boolean;
 };

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

@@ -2,6 +2,6 @@
  * HTML editor for Multiple-paragraph text fields.
  */
 export type WysiwygEditorConfiguration = {
-    /** Specify which buttons the toolbar should have */
-    toolbar: Array<'format' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'ordered_list' | 'unordered_list' | 'quote' | 'table' | 'link' | 'image' | 'show_source' | 'undo' | 'redo' | 'align_left' | 'align_center' | 'align_right' | 'align_justify' | 'outdent' | 'indent' | 'fullscreen'>;
+    /** Specify which buttons the toolbar should have (default: ['format', 'bold', 'italic', 'strikethrough', 'ordered_list', 'unordered_list', 'quote', 'table', 'link', 'image', 'show_source', 'fullscreen']) */
+    toolbar?: Array<'format' | 'bold' | 'italic' | 'strikethrough' | 'code' | 'ordered_list' | 'unordered_list' | 'quote' | 'table' | 'link' | 'image' | 'show_source' | 'undo' | 'redo' | 'align_left' | 'align_center' | 'align_right' | 'align_justify' | 'outdent' | 'indent' | 'fullscreen'>;
 };

package/dist/types/fieldTypes/validators/sanitized_html.d.ts

@@ -3,5 +3,5 @@
  */
 export type SanitizedHtmlValidator = {
     /** Content is actively sanitized before applying the validation */
-    sanitize_before_validation: boolean;
+    sanitize_before_validation?: boolean;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.4.14",
+  "version": "5.4.15",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "@datocms/dashboard-client": "^5.4.9",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "aad77038aa0c91a6439c46f836199d129f88f70f"
+  "gitHead": "c368fd252a0ba33c3b22759b5619781c7a8aba7b"
 }

package/src/fieldTypes/appearance/color_picker.ts

@@ -2,8 +2,8 @@
  * 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>;
+  /** Should the color picker allow to specify the alpha value? (default: false) */
+  enable_alpha?: boolean;
+  /** List of preset colors to offer to the user (hex color strings) (default: []) */
+  preset_colors?: Array<string>;
 };

package/src/fieldTypes/appearance/framed_single_block.ts

@@ -2,6 +2,6 @@
  * Built-in editor for Single block fields.
  */
 export type FramedSingleBlockEditorConfiguration = {
-  /** Whether you want block record collapsed by default or not */
+  /** Whether you want block record collapsed by default or not (default: false) */
   start_collapsed?: boolean;
 };

package/src/fieldTypes/appearance/markdown.ts

@@ -2,8 +2,8 @@
  * Markdown editor for Multiple-paragraph text fields.
  */
 export type MarkdownEditorConfiguration = {
-  /** Specify which buttons the toolbar should have */
-  toolbar: Array<
+  /** Specify which buttons the toolbar should have (default: all allowed values) */
+  toolbar?: Array<
     | 'heading'
     | 'bold'
     | 'italic'

package/src/fieldTypes/appearance/rich_text.ts

@@ -2,6 +2,6 @@
  * Built-in editor for Modular content fields.
  */
 export type RichTextEditorConfiguration = {
-  /** Whether you want block records collapsed by default or not */
+  /** Whether you want block records collapsed by default or not (default: false) */
   start_collapsed?: boolean;
 };

package/src/fieldTypes/appearance/seo.ts

@@ -2,12 +2,12 @@
  * Built-in editor for SEO fields.
  */
 export type SeoEditorConfiguration = {
-  /** Specify which fields of the SEO input should be visible to editors */
-  fields: Array<
+  /** Specify which fields of the SEO input should be visible to editors (default: all allowed values) */
+  fields?: Array<
     'title' | 'description' | 'image' | 'no_index' | 'twitter_card'
   >;
-  /** Specify which previews should be visible to editors */
-  previews: Array<
+  /** Specify which previews should be visible to editors (default: all allowed values) */
+  previews?: Array<
     | 'google'
     | 'twitter'
     | 'slack'

package/src/fieldTypes/appearance/single_line.ts

@@ -2,8 +2,8 @@
  * 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;
+  /** Indicates if the field should be shown bigger, as a field representing a heading (default: false) */
+  heading?: boolean;
   /** A placeholder that will be shown in the editor's input to provide editors with an example */
   placeholder?: string;
 };

package/src/fieldTypes/appearance/structured_text.ts

@@ -2,20 +2,20 @@
  * Built-in editor for Structured text fields.
  */
 export type StructuredTextEditorConfiguration = {
-  /** Specify which nodes the field should allow */
-  nodes: Array<
+  /** Specify which nodes the field should allow (default: all allowed values) */
+  nodes?: Array<
     'blockquote' | 'code' | 'heading' | 'link' | 'list' | 'thematicBreak'
   >;
-  /** Specify which marks the field should allow */
-  marks: Array<
+  /** Specify which marks the field should allow (default: all allowed values) */
+  marks?: Array<
     'strong' | 'emphasis' | 'underline' | 'strikethrough' | 'code' | 'highlight'
   >;
-  /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) */
-  heading_levels: Array<1 | 2 | 3 | 4 | 5 | 6>;
-  /** Whether you want block nodes collapsed by default or not */
+  /** If nodes includes "heading", specify which heading levels the field should allow (numbers between 1 and 6) (default: all allowed values) */
+  heading_levels?: Array<1 | 2 | 3 | 4 | 5 | 6>;
+  /** Whether you want block nodes collapsed by default or not (default: false) */
   blocks_start_collapsed?: boolean;
-  /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links */
+  /** Whether you want to show the "Open this link in a new tab?" checkbox, that fills in the target: "_blank" meta attribute for links (default: true) */
   show_links_target_blank?: boolean;
-  /** Whether you want to show the complete meta editor for links */
+  /** Whether you want to show the complete meta editor for links (default: false) */
   show_links_meta_editor?: boolean;
 };

package/src/fieldTypes/appearance/wysiwyg.ts

@@ -2,8 +2,8 @@
  * HTML editor for Multiple-paragraph text fields.
  */
 export type WysiwygEditorConfiguration = {
-  /** Specify which buttons the toolbar should have */
-  toolbar: Array<
+  /** Specify which buttons the toolbar should have (default: ['format', 'bold', 'italic', 'strikethrough', 'ordered_list', 'unordered_list', 'quote', 'table', 'link', 'image', 'show_source', 'fullscreen']) */
+  toolbar?: Array<
     | 'format'
     | 'bold'
     | 'italic'

package/src/fieldTypes/validators/sanitized_html.ts

@@ -3,5 +3,5 @@
  */
 export type SanitizedHtmlValidator = {
   /** Content is actively sanitized before applying the validation */
-  sanitize_before_validation: boolean;
+  sanitize_before_validation?: boolean;
 };

package/src/generated/Client.ts

@@ -151,7 +151,7 @@ export class Client {
       ...this.config,
       ...options,
       logFn: this.config.logFn || console.log,
-      userAgent: '@datocms/cma-client v5.4.14',
+      userAgent: '@datocms/cma-client v5.4.15',
       baseUrl: this.baseUrl,
       preCallStack: new Error().stack,
       extraHeaders: {