@datocms/cma-client 5.1.2 → 5.1.3

package/dist/types/index.d.ts

@@ -10,6 +10,7 @@ export * from './utilities/fieldValue';
 export * from './utilities/id';
 export * from './utilities/recursiveBlocks';
 export * from './utilities/schemaRepository';
+export * from './fieldTypes';
 export type { ApiTypes, RawApiTypes };
 export type { ApiTypes as SchemaTypes, RawApiTypes as SimpleSchemaTypes };
 import type * as ApiTypes from './generated/ApiTypes';

package/dist/types/utilities/fieldValue.d.ts

@@ -7,7 +7,7 @@ import type * as RawApiTypes from '../generated/RawApiTypes';
  * for various locales structured as an object, such as
  * `{ "en": "Hello", "it": "Ciao" }`
  */
-export type LocalizedFieldValue = Record<string, unknown>;
+export type LocalizedFieldValue<T = unknown> = Record<string, T>;
 /**
  * Determines whether a DatoCMS field is localized or not.
  *

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.1.2",
+  "version": "5.1.3",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -45,5 +45,5 @@
     "@datocms/dashboard-client": "^5.1.2",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "f4f7e2dcb5508f3d4680d242a9805c826706b855"
+  "gitHead": "69bf5360c450dc20913dbafd63c12e1306c230b3"
 }

package/src/fieldTypes/boolean.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { BooleanEditorConfiguration } from './appearance/boolean';
 import type { BooleanRadioGroupEditorConfiguration } from './appearance/boolean_radio_group';
 
@@ -9,6 +10,16 @@ export function isBooleanFieldValue(
   return typeof value === 'boolean' || value === null;
 }
 
+export function isLocalizedBooleanFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<BooleanFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isBooleanFieldValue)
+  );
+}
+
 export type BooleanFieldValidators = Record<string, never>;
 
 export type BooleanFieldAppearance =

package/src/fieldTypes/color.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { ColorPickerEditorConfiguration } from './appearance/color_picker';
 import type { RequiredValidator } from './validators/required';
 
@@ -20,6 +21,16 @@ export function isColorFieldValue(value: unknown): value is ColorFieldValue {
   );
 }
 
+export function isLocalizedColorFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<ColorFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isColorFieldValue)
+  );
+}
+
 export type ColorFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/date.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { DatePickerEditorConfiguration } from './appearance/date_picker';
 import type { DateRangeValidator } from './validators/date_range';
 import type { RequiredValidator } from './validators/required';
@@ -9,6 +10,16 @@ export function isDateFieldValue(value: unknown): value is DateFieldValue {
   return typeof value === 'string' && /^\d{4}-\d{2}-\d{2}$/.test(value);
 }
 
+export function isLocalizedDateFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<DateFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isDateFieldValue)
+  );
+}
+
 export type DateFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/date_time.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { DateTimePickerEditorConfiguration } from './appearance/date_time_picker';
 import type { DateTimeRangeValidator } from './validators/date_time_range';
 import type { RequiredValidator } from './validators/required';
@@ -14,6 +15,16 @@ export function isDateTimeFieldValue(
   );
 }
 
+export function isLocalizedDateTimeFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<DateTimeFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isDateTimeFieldValue)
+  );
+}
+
 export type DateTimeFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/file.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { FileEditorConfiguration } from './appearance/file';
 import type { ExtensionValidator } from './validators/extension';
 import type { FileSizeValidator } from './validators/file_size';
@@ -22,6 +23,16 @@ export function isFileFieldValue(value: unknown): value is FileFieldValue {
   return typeof value === 'object' && value !== null && 'upload_id' in value;
 }
 
+export function isLocalizedFileFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<FileFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isFileFieldValue)
+  );
+}
+
 export type FileFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/float.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { FloatEditorConfiguration } from './appearance/float';
 import type { NumberRangeValidator } from './validators/number_range';
 import type { RequiredValidator } from './validators/required';
@@ -8,6 +9,16 @@ export function isFloatFieldValue(value: unknown): value is FloatFieldValue {
   return typeof value === 'number' || value === null;
 }
 
+export function isLocalizedFloatFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<FloatFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isFloatFieldValue)
+  );
+}
+
 export type FloatFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/gallery.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { GalleryEditorConfiguration } from './appearance/gallery';
 import type { ExtensionValidator } from './validators/extension';
 import type { FileSizeValidator } from './validators/file_size';
@@ -30,6 +31,16 @@ export function isGalleryFieldValue(
   );
 }
 
+export function isLocalizedGalleryFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<GalleryFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isGalleryFieldValue)
+  );
+}
+
 export type GalleryFieldValidators = {
   /** Only accept a number of items within the specified range */
   size?: SizeValidator;

package/src/fieldTypes/integer.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { IntegerEditorConfiguration } from './appearance/integer';
 import type { NumberRangeValidator } from './validators/number_range';
 import type { RequiredValidator } from './validators/required';
@@ -10,6 +11,16 @@ export function isIntegerFieldValue(
   return typeof value === 'number' || value === null;
 }
 
+export function isLocalizedIntegerFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<IntegerFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isIntegerFieldValue)
+  );
+}
+
 export type IntegerFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/json.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { JsonEditorConfiguration } from './appearance/json';
 import type { StringCheckboxGroupEditorConfiguration } from './appearance/string_checkbox_group';
 import type { StringMultiSelectEditorConfiguration } from './appearance/string_multi_select';
@@ -16,6 +17,16 @@ export function isJsonFieldValue(value: unknown): value is JsonFieldValue {
   }
 }
 
+export function isLocalizedJsonFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<JsonFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isJsonFieldValue)
+  );
+}
+
 export type JsonFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/lat_lon.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { MapEditorConfiguration } from './appearance/map';
 import type { RequiredValidator } from './validators/required';
 
@@ -18,6 +19,16 @@ export function isLocationFieldValue(
   );
 }
 
+export function isLocalizedLocationFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<LocationFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isLocationFieldValue)
+  );
+}
+
 export type LocationFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/link.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { LinkEmbedEditorConfiguration } from './appearance/link_embed';
 import type { LinkSelectEditorConfiguration } from './appearance/link_select';
 import type { ItemItemTypeValidator } from './validators/item_item_type';
@@ -10,6 +11,16 @@ export function isLinkFieldValue(value: unknown): value is LinkFieldValue {
   return typeof value === 'string' || value === null;
 }
 
+export function isLocalizedLinkFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<LinkFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isLinkFieldValue)
+  );
+}
+
 export type LinkFieldValidators = {
   /** Only accept references to records of the specified models */
   item_item_type: ItemItemTypeValidator;

package/src/fieldTypes/links.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { LinksEmbedEditorConfiguration } from './appearance/links_embed';
 import type { LinksSelectEditorConfiguration } from './appearance/links_select';
 import type { ItemsItemTypeValidator } from './validators/items_item_type';
@@ -12,6 +13,16 @@ export function isLinksFieldValue(value: unknown): value is LinksFieldValue {
   );
 }
 
+export function isLocalizedLinksFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<LinksFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isLinksFieldValue)
+  );
+}
+
 export type LinksFieldValidators = {
   /** Only accept references to records of the specified models */
   items_item_type: ItemsItemTypeValidator;

package/src/fieldTypes/rich_text.ts

@@ -1,10 +1,14 @@
 import type * as RawApiTypes from '../generated/RawApiTypes';
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import type { RichTextEditorConfiguration } from './appearance/rich_text';
 import {
   type BlockItemInARequest,
   isItemId,
   isItemWithOptionalIdAndMeta,
   isItemWithOptionalMeta,
 } from './single_block';
+import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
+import type { SizeValidator } from './validators/size';
 
 /**
  * MODULAR CONTENT FIELD TYPE SYSTEM FOR DATOCMS
@@ -93,6 +97,16 @@ export function isRichTextFieldValue(
   );
 }
 
+export function isLocalizedRichTextFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<RichTextFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isRichTextFieldValue)
+  );
+}
+
 /**
  * Type guard for Modular Content field values in API request format.
  * Allows blocks as string IDs, full objects with IDs, or objects without IDs.
@@ -113,6 +127,16 @@ export function isRichTextFieldValueAsRequest(
   });
 }
 
+export function isLocalizedRichTextFieldValueAsRequest(
+  value: unknown,
+): value is LocalizedFieldValue<RichTextFieldValueAsRequest> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isRichTextFieldValueAsRequest)
+  );
+}
+
 /**
  * Type guard for Modular Content field values with nested blocks (?nested=true format).
  * Ensures all blocks are full RawApiTypes.Item objects with complete data.
@@ -130,9 +154,15 @@ export function isRichTextFieldValueWithNestedBlocks(
   });
 }
 
-import type { RichTextEditorConfiguration } from './appearance/rich_text';
-import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
-import type { SizeValidator } from './validators/size';
+export function isLocalizedRichTextFieldValueWithNestedBlocks(
+  value: unknown,
+): value is LocalizedFieldValue<RichTextFieldValueWithNestedBlocks> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isRichTextFieldValueWithNestedBlocks)
+  );
+}
 
 export type RichTextFieldValidators = {
   /** Only accept references to block records of the specified block models */

package/src/fieldTypes/seo.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { SeoEditorConfiguration } from './appearance/seo';
 import type { DescriptionLengthValidator } from './validators/description_length';
 import type { FileSizeValidator } from './validators/file_size';
@@ -27,6 +28,16 @@ export function isSeoFieldValue(value: unknown): value is SeoFieldValue {
   );
 }
 
+export function isLocalizedSeoFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<SeoFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isSeoFieldValue)
+  );
+}
+
 export type SeoFieldValidators = {
   /** SEO field has to specify one or more properties, or it won't be valid */
   required_seo_fields?: RequiredSeoFieldsValidator;

package/src/fieldTypes/single_block.ts

@@ -1,4 +1,5 @@
 import type * as RawApiTypes from '../generated/RawApiTypes';
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 
 import type { FramedSingleBlockEditorConfiguration } from './appearance/framed_single_block';
 import type { FramelessSingleBlockEditorConfiguration } from './appearance/frameless_single_block';
@@ -159,6 +160,16 @@ export function isSingleBlockFieldValue(
   return typeof value === 'string' || value === null;
 }
 
+export function isLocalizedSingleBlockFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<SingleBlockFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isSingleBlockFieldValue)
+  );
+}
+
 /**
  * Type guard for Single Block field values in API request format.
  * Allows block as string ID, full object with ID, or object without ID.
@@ -175,6 +186,16 @@ export function isSingleBlockFieldValueAsRequest(
   return isItemWithOptionalIdAndMeta(value);
 }
 
+export function isLocalizedSingleBlockFieldValueAsRequest(
+  value: unknown,
+): value is LocalizedFieldValue<SingleBlockFieldValueAsRequest> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isSingleBlockFieldValueAsRequest)
+  );
+}
+
 /**
  * Type guard for Single Block field values with nested blocks (?nested=true format).
  * Ensures block is a full RawApiTypes.Item object with complete data.
@@ -188,6 +209,16 @@ export function isSingleBlockFieldValueWithNestedBlocks(
   return isItemWithOptionalMeta(value);
 }
 
+export function isLocalizedSingleBlockFieldValueWithNestedBlocks(
+  value: unknown,
+): value is LocalizedFieldValue<SingleBlockFieldValueWithNestedBlocks> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isSingleBlockFieldValueWithNestedBlocks)
+  );
+}
+
 export type SingleBlockFieldValidators = {
   /** Only accept references to block records of the specified block models */
   single_block_blocks: SingleBlockBlocksValidator;

package/src/fieldTypes/slug.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { SlugEditorConfiguration } from './appearance/slug';
 import type { LengthValidator } from './validators/length';
 import type { RequiredValidator } from './validators/required';
@@ -8,7 +9,17 @@ export type SlugFieldValue = string | null;
 
 export function isSlugFieldValue(value: unknown): value is SlugFieldValue {
   if (value === null) return true;
-  return typeof value === 'string' && /^[a-z0-9_]+(?:-[a-z0-9]+)*$/.test(value);
+  return typeof value === 'string';
+}
+
+export function isLocalizedSlugFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<SlugFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isSlugFieldValue)
+  );
 }
 
 export type SlugFieldValidators = {

package/src/fieldTypes/string.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { SingleLineEditorConfiguration } from './appearance/single_line';
 import type { StringRadioGroupEditorConfiguration } from './appearance/string_radio_group';
 import type { StringSelectEditorConfiguration } from './appearance/string_select';
@@ -13,6 +14,16 @@ export function isStringFieldValue(value: unknown): value is StringFieldValue {
   return typeof value === 'string' || value === null;
 }
 
+export function isLocalizedStringFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<StringFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isStringFieldValue)
+  );
+}
+
 export type StringFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/structured_text.ts

@@ -9,6 +9,7 @@ import {
   isInlineBlock,
 } from 'datocms-structured-text-utils';
 import type * as RawApiTypes from '../generated/RawApiTypes';
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { StructuredTextEditorConfiguration } from './appearance/structured_text';
 import {
   type BlockItemInARequest,
@@ -144,6 +145,16 @@ export function isStructuredTextFieldValue(
   });
 }
 
+export function isLocalizedStructuredTextFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<StructuredTextFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isStructuredTextFieldValue)
+  );
+}
+
 /**
  * Type guard for structured text field values in API request format.
  * Allows blocks as string IDs, full objects with IDs, or objects without IDs.
@@ -169,6 +180,16 @@ export function isStructuredTextFieldValueAsRequest(
   });
 }
 
+export function isLocalizedStructuredTextFieldValueAsRequest(
+  value: unknown,
+): value is LocalizedFieldValue<StructuredTextFieldValueAsRequest> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isStructuredTextFieldValueAsRequest)
+  );
+}
+
 /**
  * Type guard for structured text field values with nested blocks (?nested=true format).
  * Ensures all block/inlineBlock nodes have full RawApiTypes.Item objects.
@@ -191,6 +212,16 @@ export function isStructuredTextFieldValueWithNestedBlocks(
   });
 }
 
+export function isLocalizedStructuredTextFieldValueWithNestedBlocks(
+  value: unknown,
+): value is LocalizedFieldValue<StructuredTextFieldValueWithNestedBlocks> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isStructuredTextFieldValueWithNestedBlocks)
+  );
+}
+
 export type StructuredTextFieldValidators = {
   /** Only accept references to block records of the specified block models */
   structured_text_blocks: StructuredTextBlocksValidator;

package/src/fieldTypes/text.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { MarkdownEditorConfiguration } from './appearance/markdown';
 import type { TextareaEditorConfiguration } from './appearance/textarea';
 import type { WysiwygEditorConfiguration } from './appearance/wysiwyg';
@@ -12,6 +13,16 @@ export function isTextFieldValue(value: unknown): value is TextFieldValue {
   return typeof value === 'string' || value === null;
 }
 
+export function isLocalizedTextFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<TextFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isTextFieldValue)
+  );
+}
+
 export type TextFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/fieldTypes/video.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { VideoEditorConfiguration } from './appearance/video';
 import type { RequiredValidator } from './validators/required';
 
@@ -22,6 +23,16 @@ export function isVideoFieldValue(value: unknown): value is VideoFieldValue {
   );
 }
 
+export function isLocalizedVideoFieldValue(
+  value: unknown,
+): value is LocalizedFieldValue<VideoFieldValue> {
+  return (
+    typeof value === 'object' &&
+    value !== null &&
+    Object.values(value).every(isVideoFieldValue)
+  );
+}
+
 export type VideoFieldValidators = {
   /** Value must be specified or it won't be valid */
   required?: RequiredValidator;

package/src/generated/Client.ts

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

package/src/index.ts

@@ -10,6 +10,7 @@ export * from './utilities/fieldValue';
 export * from './utilities/id';
 export * from './utilities/recursiveBlocks';
 export * from './utilities/schemaRepository';
+export * from './fieldTypes';
 export type { ApiTypes, RawApiTypes };
 // Legacy names
 export type { ApiTypes as SchemaTypes, RawApiTypes as SimpleSchemaTypes };

package/src/utilities/fieldValue.ts

@@ -27,7 +27,7 @@ import type * as RawApiTypes from '../generated/RawApiTypes';
  * for various locales structured as an object, such as
  * `{ "en": "Hello", "it": "Ciao" }`
  */
-export type LocalizedFieldValue = Record<string, unknown>;
+export type LocalizedFieldValue<T = unknown> = Record<string, T>;
 
 /**
  * Determines whether a DatoCMS field is localized or not.