@datocms/cma-client 5.1.2 → 5.1.3

package/dist/esm/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/esm/index.js

@@ -9,4 +9,5 @@ export * from './utilities/fieldValue';
 export * from './utilities/id';
 export * from './utilities/recursiveBlocks';
 export * from './utilities/schemaRepository';
+export * from './fieldTypes';
 //# sourceMappingURL=index.js.map

package/dist/esm/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC9E,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AACnD,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,QAAQ,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC9E,cAAc,eAAe,CAAC;AAC9B,OAAO,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AAE5C,OAAO,KAAK,SAAS,MAAM,uBAAuB,CAAC;AACnD,cAAc,oBAAoB,CAAC;AACnC,cAAc,8BAA8B,CAAC;AAC7C,cAAc,wCAAwC,CAAC;AACvD,cAAc,wBAAwB,CAAC;AACvC,cAAc,gBAAgB,CAAC;AAC/B,cAAc,6BAA6B,CAAC;AAC5C,cAAc,8BAA8B,CAAC;AAC7C,cAAc,cAAc,CAAC"}

package/dist/esm/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/dist/types/fieldTypes/boolean.d.ts

@@ -1,7 +1,9 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { BooleanEditorConfiguration } from './appearance/boolean';
 import type { BooleanRadioGroupEditorConfiguration } from './appearance/boolean_radio_group';
 export type BooleanFieldValue = boolean | null;
 export declare function isBooleanFieldValue(value: unknown): value is BooleanFieldValue;
+export declare function isLocalizedBooleanFieldValue(value: unknown): value is LocalizedFieldValue<BooleanFieldValue>;
 export type BooleanFieldValidators = Record<string, never>;
 export type BooleanFieldAppearance = {
     editor: 'boolean';

package/dist/types/fieldTypes/color.d.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { ColorPickerEditorConfiguration } from './appearance/color_picker';
 import type { RequiredValidator } from './validators/required';
 export type ColorFieldValue = {
@@ -7,6 +8,7 @@ export type ColorFieldValue = {
     alpha: number;
 } | null;
 export declare function isColorFieldValue(value: unknown): value is ColorFieldValue;
+export declare function isLocalizedColorFieldValue(value: unknown): value is LocalizedFieldValue<ColorFieldValue>;
 export type ColorFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/date.d.ts

@@ -1,8 +1,10 @@
+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';
 export type DateFieldValue = string | null;
 export declare function isDateFieldValue(value: unknown): value is DateFieldValue;
+export declare function isLocalizedDateFieldValue(value: unknown): value is LocalizedFieldValue<DateFieldValue>;
 export type DateFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/date_time.d.ts

@@ -1,8 +1,10 @@
+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';
 export type DateTimeFieldValue = string | null;
 export declare function isDateTimeFieldValue(value: unknown): value is DateTimeFieldValue;
+export declare function isLocalizedDateTimeFieldValue(value: unknown): value is LocalizedFieldValue<DateTimeFieldValue>;
 export type DateTimeFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/file.d.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';
@@ -16,6 +17,7 @@ export type FileFieldValue = {
     } | null;
 } | null;
 export declare function isFileFieldValue(value: unknown): value is FileFieldValue;
+export declare function isLocalizedFileFieldValue(value: unknown): value is LocalizedFieldValue<FileFieldValue>;
 export type FileFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/float.d.ts

@@ -1,8 +1,10 @@
+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';
 export type FloatFieldValue = number | null;
 export declare function isFloatFieldValue(value: unknown): value is FloatFieldValue;
+export declare function isLocalizedFloatFieldValue(value: unknown): value is LocalizedFieldValue<FloatFieldValue>;
 export type FloatFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/gallery.d.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';
@@ -16,6 +17,7 @@ export type GalleryFieldValue = Array<{
     } | null;
 }> | null;
 export declare function isGalleryFieldValue(value: unknown): value is GalleryFieldValue;
+export declare function isLocalizedGalleryFieldValue(value: unknown): value is LocalizedFieldValue<GalleryFieldValue>;
 export type GalleryFieldValidators = {
     /** Only accept a number of items within the specified range */
     size?: SizeValidator;

package/dist/types/fieldTypes/integer.d.ts

@@ -1,8 +1,10 @@
+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';
 export type IntegerFieldValue = number | null;
 export declare function isIntegerFieldValue(value: unknown): value is IntegerFieldValue;
+export declare function isLocalizedIntegerFieldValue(value: unknown): value is LocalizedFieldValue<IntegerFieldValue>;
 export type IntegerFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/json.d.ts

@@ -1,9 +1,11 @@
+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';
 import type { RequiredValidator } from './validators/required';
 export type JsonFieldValue = string | null;
 export declare function isJsonFieldValue(value: unknown): value is JsonFieldValue;
+export declare function isLocalizedJsonFieldValue(value: unknown): value is LocalizedFieldValue<JsonFieldValue>;
 export type JsonFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/lat_lon.d.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { MapEditorConfiguration } from './appearance/map';
 import type { RequiredValidator } from './validators/required';
 export type LocationFieldValue = {
@@ -5,6 +6,7 @@ export type LocationFieldValue = {
     longitude: number;
 } | null;
 export declare function isLocationFieldValue(value: unknown): value is LocationFieldValue;
+export declare function isLocalizedLocationFieldValue(value: unknown): value is LocalizedFieldValue<LocationFieldValue>;
 export type LocationFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/link.d.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';
@@ -5,6 +6,7 @@ import type { RequiredValidator } from './validators/required';
 import type { UniqueValidator } from './validators/unique';
 export type LinkFieldValue = string | null;
 export declare function isLinkFieldValue(value: unknown): value is LinkFieldValue;
+export declare function isLocalizedLinkFieldValue(value: unknown): value is LocalizedFieldValue<LinkFieldValue>;
 export type LinkFieldValidators = {
     /** Only accept references to records of the specified models */
     item_item_type: ItemItemTypeValidator;

package/dist/types/fieldTypes/links.d.ts

@@ -1,9 +1,11 @@
+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';
 import type { SizeValidator } from './validators/size';
 export type LinksFieldValue = string[] | null;
 export declare function isLinksFieldValue(value: unknown): value is LinksFieldValue;
+export declare function isLocalizedLinksFieldValue(value: unknown): value is LocalizedFieldValue<LinksFieldValue>;
 export type LinksFieldValidators = {
     /** Only accept references to records of the specified models */
     items_item_type: ItemsItemTypeValidator;

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

@@ -1,5 +1,9 @@
 import type * as RawApiTypes from '../generated/RawApiTypes';
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import type { RichTextEditorConfiguration } from './appearance/rich_text';
 import { type BlockItemInARequest } from './single_block';
+import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
+import type { SizeValidator } from './validators/size';
 /**
  * MODULAR CONTENT FIELD TYPE SYSTEM FOR DATOCMS
  *
@@ -70,19 +74,19 @@ export type RichTextFieldValueWithNestedBlocks = RawApiTypes.Item[] | null;
  * Checks for array structure and ensures all blocks are string references.
  */
 export declare function isRichTextFieldValue(value: unknown): value is RichTextFieldValue;
+export declare function isLocalizedRichTextFieldValue(value: unknown): value is LocalizedFieldValue<RichTextFieldValue>;
 /**
  * Type guard for Modular Content field values in API request format.
  * Allows blocks as string IDs, full objects with IDs, or objects without IDs.
  */
 export declare function isRichTextFieldValueAsRequest(value: unknown): value is RichTextFieldValueAsRequest;
+export declare function isLocalizedRichTextFieldValueAsRequest(value: unknown): value is LocalizedFieldValue<RichTextFieldValueAsRequest>;
 /**
  * Type guard for Modular Content field values with nested blocks (?nested=true format).
  * Ensures all blocks are full RawApiTypes.Item objects with complete data.
  */
 export declare function isRichTextFieldValueWithNestedBlocks(value: unknown): value is RichTextFieldValueWithNestedBlocks;
-import type { RichTextEditorConfiguration } from './appearance/rich_text';
-import type { RichTextBlocksValidator } from './validators/rich_text_blocks';
-import type { SizeValidator } from './validators/size';
+export declare function isLocalizedRichTextFieldValueWithNestedBlocks(value: unknown): value is LocalizedFieldValue<RichTextFieldValueWithNestedBlocks>;
 export type RichTextFieldValidators = {
     /** Only accept references to block records of the specified block models */
     rich_text_blocks: RichTextBlocksValidator;

package/dist/types/fieldTypes/seo.d.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';
@@ -13,6 +14,7 @@ export type SeoFieldValue = {
     no_index?: boolean;
 } | null;
 export declare function isSeoFieldValue(value: unknown): value is SeoFieldValue;
+export declare function isLocalizedSeoFieldValue(value: unknown): value is LocalizedFieldValue<SeoFieldValue>;
 export type SeoFieldValidators = {
     /** SEO field has to specify one or more properties, or it won't be valid */
     required_seo_fields?: RequiredSeoFieldsValidator;

package/dist/types/fieldTypes/single_block.d.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';
 import type { RequiredValidator } from './validators/required';
@@ -108,16 +109,19 @@ export declare function isItemWithOptionalMeta(block: unknown): block is ItemWit
  * Checks for string structure and ensures block is a string reference.
  */
 export declare function isSingleBlockFieldValue(value: unknown): value is SingleBlockFieldValue;
+export declare function isLocalizedSingleBlockFieldValue(value: unknown): value is LocalizedFieldValue<SingleBlockFieldValue>;
 /**
  * Type guard for Single Block field values in API request format.
  * Allows block as string ID, full object with ID, or object without ID.
  */
 export declare function isSingleBlockFieldValueAsRequest(value: unknown): value is SingleBlockFieldValueAsRequest;
+export declare function isLocalizedSingleBlockFieldValueAsRequest(value: unknown): value is LocalizedFieldValue<SingleBlockFieldValueAsRequest>;
 /**
  * Type guard for Single Block field values with nested blocks (?nested=true format).
  * Ensures block is a full RawApiTypes.Item object with complete data.
  */
 export declare function isSingleBlockFieldValueWithNestedBlocks(value: unknown): value is SingleBlockFieldValueWithNestedBlocks;
+export declare function isLocalizedSingleBlockFieldValueWithNestedBlocks(value: unknown): value is LocalizedFieldValue<SingleBlockFieldValueWithNestedBlocks>;
 export type SingleBlockFieldValidators = {
     /** Only accept references to block records of the specified block models */
     single_block_blocks: SingleBlockBlocksValidator;

package/dist/types/fieldTypes/slug.d.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';
@@ -5,6 +6,7 @@ import type { SlugFormatValidator } from './validators/slug_format';
 import type { SlugTitleFieldValidator } from './validators/slug_title_field';
 export type SlugFieldValue = string | null;
 export declare function isSlugFieldValue(value: unknown): value is SlugFieldValue;
+export declare function isLocalizedSlugFieldValue(value: unknown): value is LocalizedFieldValue<SlugFieldValue>;
 export type SlugFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/string.d.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';
@@ -8,6 +9,7 @@ import type { RequiredValidator } from './validators/required';
 import type { UniqueValidator } from './validators/unique';
 export type StringFieldValue = string | null;
 export declare function isStringFieldValue(value: unknown): value is StringFieldValue;
+export declare function isLocalizedStringFieldValue(value: unknown): value is LocalizedFieldValue<StringFieldValue>;
 export type StringFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/structured_text.d.ts

@@ -1,5 +1,6 @@
 import { type Block, type Document, type InlineBlock } 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 } from './single_block';
 import type { LengthValidator } from './validators/length';
@@ -85,16 +86,19 @@ export type StructuredTextFieldValueWithNestedBlocks = DocumentWithNestedBlocks
  * Checks for the expected structure and ensures all block/inlineBlock nodes have string IDs.
  */
 export declare function isStructuredTextFieldValue(value: unknown): value is StructuredTextFieldValue;
+export declare function isLocalizedStructuredTextFieldValue(value: unknown): value is LocalizedFieldValue<StructuredTextFieldValue>;
 /**
  * Type guard for structured text field values in API request format.
  * Allows blocks as string IDs, full objects with IDs, or objects without IDs.
  */
 export declare function isStructuredTextFieldValueAsRequest(value: unknown): value is StructuredTextFieldValueAsRequest;
+export declare function isLocalizedStructuredTextFieldValueAsRequest(value: unknown): value is LocalizedFieldValue<StructuredTextFieldValueAsRequest>;
 /**
  * Type guard for structured text field values with nested blocks (?nested=true format).
  * Ensures all block/inlineBlock nodes have full RawApiTypes.Item objects.
  */
 export declare function isStructuredTextFieldValueWithNestedBlocks(value: unknown): value is StructuredTextFieldValueWithNestedBlocks;
+export declare function isLocalizedStructuredTextFieldValueWithNestedBlocks(value: unknown): value is LocalizedFieldValue<StructuredTextFieldValueWithNestedBlocks>;
 export type StructuredTextFieldValidators = {
     /** Only accept references to block records of the specified block models */
     structured_text_blocks: StructuredTextBlocksValidator;

package/dist/types/fieldTypes/text.d.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';
@@ -7,6 +8,7 @@ import type { RequiredValidator } from './validators/required';
 import type { SanitizationValidator } from './validators/sanitization';
 export type TextFieldValue = string | null;
 export declare function isTextFieldValue(value: unknown): value is TextFieldValue;
+export declare function isLocalizedTextFieldValue(value: unknown): value is LocalizedFieldValue<TextFieldValue>;
 export type TextFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;

package/dist/types/fieldTypes/video.d.ts

@@ -1,3 +1,4 @@
+import type { LocalizedFieldValue } from '../utilities/fieldValue';
 import type { VideoEditorConfiguration } from './appearance/video';
 import type { RequiredValidator } from './validators/required';
 export type VideoFieldValue = {
@@ -10,6 +11,7 @@ export type VideoFieldValue = {
     title: string;
 } | null;
 export declare function isVideoFieldValue(value: unknown): value is VideoFieldValue;
+export declare function isLocalizedVideoFieldValue(value: unknown): value is LocalizedFieldValue<VideoFieldValue>;
 export type VideoFieldValidators = {
     /** Value must be specified or it won't be valid */
     required?: RequiredValidator;