@datocms/cma-client 5.1.10 → 5.1.12

package/dist/{esm/utilities/fieldValue.d.ts → types/utilities/normalizedFieldValues.d.ts}

@@ -18,6 +18,7 @@ export type LocalizedFieldValue<T = unknown, L extends string = string> = Partia
  * @returns true if the field is localized, false otherwise
  */
 export declare function isLocalized(field: RawApiTypes.Field | ApiTypes.Field): boolean;
+export declare function isLocalizedFieldValue<T = unknown, L extends string = string>(value: unknown): value is LocalizedFieldValue<T, L>;
 /**
  * A normalized entry that represents a single value from either a localized or non-localized field.
  *
@@ -26,7 +27,7 @@ export declare function isLocalized(field: RawApiTypes.Field | ApiTypes.Field):
  *
  * This uniform structure allows the same processing logic to work with both field types.
  */
-export type FieldValueEntry<T = unknown, L extends string = string> = {
+export type NormalizedFieldValueEntry<T = unknown, L extends string = string> = {
     locale: L | undefined;
     value: T;
 };
@@ -40,11 +41,11 @@ export type FieldValueEntry<T = unknown, L extends string = string> = {
  * @param value - The field value to convert (either a localized object or direct value)
  * @returns Array of entries where each entry contains a locale (string for localized, undefined for non-localized) and the corresponding value
  */
-export declare function fieldValueToEntries<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>): FieldValueEntry<T, L>[];
+export declare function toNormalizedFieldValueEntries<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>): NormalizedFieldValueEntry<T, L>[];
 /**
  * Converts an array of possibly localized entries back into the appropriate field value format.
  *
- * This function is the inverse of `fieldValueToEntries`. It takes a uniform
+ * This function is the inverse of `toNormalizedFieldValueEntries`. It takes a uniform
  * array of entries and converts them back to either a localized object or a direct value,
  * depending on the field's localization setting.
  *
@@ -52,7 +53,7 @@ export declare function fieldValueToEntries<T = unknown, L extends string = stri
  * @param entries - Array of entries to convert back to field value format
  * @returns Either a localized object (for localized fields) or the direct value (for non-localized fields)
  */
-export declare function entriesToFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, entries: FieldValueEntry<T, L>[]): T | LocalizedFieldValue<T, L>;
+export declare function fromNormalizedFieldValueEntries<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, entries: NormalizedFieldValueEntry<T, L>[]): T | LocalizedFieldValue<T, L>;
 /**
  * Maps field values using a provided mapping function.
  * For localized fields, applies the mapping function to each locale value.
@@ -64,7 +65,7 @@ export declare function entriesToFieldValue<T = unknown, L extends string = stri
  * @param mapFn - The function to apply to each locale value or the direct value
  * @returns The mapped value with the same structure as the input
  */
-export declare function mapFieldValue<TInput = unknown, TOutput = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: TInput | LocalizedFieldValue<TInput, L>, mapFn: (locale: L | undefined, localeValue: TInput) => TOutput): TOutput | LocalizedFieldValue<TOutput, L>;
+export declare function mapNormalizedFieldValues<TInput = unknown, TOutput = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: TInput | LocalizedFieldValue<TInput, L>, mapFn: (locale: L | undefined, localeValue: TInput) => TOutput): TOutput | LocalizedFieldValue<TOutput, L>;
 /**
  * Maps field values using a provided mapping function (async version).
  * For localized fields, applies the mapping function to each locale value.
@@ -76,7 +77,7 @@ export declare function mapFieldValue<TInput = unknown, TOutput = unknown, L ext
  * @param mapFn - The function to apply to each locale value or the direct value
  * @returns The mapped value with the same structure as the input
  */
-export declare function mapFieldValueAsync<TInput = unknown, TOutput = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: TInput | LocalizedFieldValue<TInput, L>, mapFn: (locale: L | undefined, localeValue: TInput) => Promise<TOutput>): Promise<TOutput | LocalizedFieldValue<TOutput, L>>;
+export declare function mapNormalizedFieldValuesAsync<TInput = unknown, TOutput = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: TInput | LocalizedFieldValue<TInput, L>, mapFn: (locale: L | undefined, localeValue: TInput) => Promise<TOutput>): Promise<TOutput | LocalizedFieldValue<TOutput, L>>;
 /**
  * Filters field values using a provided filter function.
  * For localized fields, filters each locale value.
@@ -87,7 +88,7 @@ export declare function mapFieldValueAsync<TInput = unknown, TOutput = unknown,
  * @param filterFn - The function to test each locale value or the direct value
  * @returns The filtered value with the same structure as the input
  */
-export declare function filterFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, filterFn: (locale: L | undefined, localeValue: T) => boolean): T | LocalizedFieldValue<T, L> | undefined;
+export declare function filterNormalizedFieldValues<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, filterFn: (locale: L | undefined, localeValue: T) => boolean): T | LocalizedFieldValue<T, L> | undefined;
 /**
  * Filters field values using a provided filter function (async version).
  * For localized fields, filters each locale value.
@@ -98,7 +99,7 @@ export declare function filterFieldValue<T = unknown, L extends string = string>
  * @param filterFn - The function to test each locale value or the direct value
  * @returns The filtered value with the same structure as the input
  */
-export declare function filterFieldValueAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, filterFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<T | LocalizedFieldValue<T, L> | undefined>;
+export declare function filterNormalizedFieldValuesAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, filterFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<T | LocalizedFieldValue<T, L> | undefined>;
 /**
  * Tests whether at least one field value passes the test implemented by the provided function.
  * For localized fields, tests each locale value.
@@ -109,7 +110,7 @@ export declare function filterFieldValueAsync<T = unknown, L extends string = st
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if at least one value passes the test, false otherwise
  */
-export declare function someFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
+export declare function someNormalizedFieldValues<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
 /**
  * Tests whether at least one field value passes the test implemented by the provided function (async version).
  * For localized fields, tests each locale value.
@@ -120,7 +121,7 @@ export declare function someFieldValue<T = unknown, L extends string = string>(f
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if at least one value passes the test, false otherwise
  */
-export declare function someFieldValueAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
+export declare function someNormalizedFieldValuesAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
 /**
  * Tests whether all field values pass the test implemented by the provided function.
  * For localized fields, tests each locale value.
@@ -131,7 +132,7 @@ export declare function someFieldValueAsync<T = unknown, L extends string = stri
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if all values pass the test, false otherwise
  */
-export declare function everyFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
+export declare function everyNormalizedFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => boolean): boolean;
 /**
  * Tests whether all field values pass the test implemented by the provided function (async version).
  * For localized fields, tests each locale value.
@@ -142,7 +143,7 @@ export declare function everyFieldValue<T = unknown, L extends string = string>(
  * @param testFn - The function to test each locale value or the direct value
  * @returns true if all values pass the test, false otherwise
  */
-export declare function everyFieldValueAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
+export declare function everyNormalizedFieldValueAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, testFn: (locale: L | undefined, localeValue: T) => Promise<boolean>): Promise<boolean>;
 /**
  * Visits each field value with the provided function.
  * For localized fields, visits each locale value.
@@ -152,7 +153,7 @@ export declare function everyFieldValueAsync<T = unknown, L extends string = str
  * @param value - The field value (either localized object or direct value)
  * @param visitFn - The function to call for each locale value or the direct value
  */
-export declare function visitFieldValue<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, visitFn: (locale: L | undefined, localeValue: T) => void): void;
+export declare function visitNormalizedFieldValues<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, visitFn: (locale: L | undefined, localeValue: T) => void): void;
 /**
  * Visits each field value with the provided function (async version).
  * For localized fields, visits each locale value.
@@ -162,4 +163,4 @@ export declare function visitFieldValue<T = unknown, L extends string = string>(
  * @param value - The field value (either localized object or direct value)
  * @param visitFn - The function to call for each locale value or the direct value
  */
-export declare function visitFieldValueAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, visitFn: (locale: L | undefined, localeValue: T) => Promise<void>): Promise<void>;
+export declare function visitNormalizedFieldValuesAsync<T = unknown, L extends string = string>(field: RawApiTypes.Field | ApiTypes.Field, value: T | LocalizedFieldValue<T, L>, visitFn: (locale: L | undefined, localeValue: T) => Promise<void>): Promise<void>;

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

@@ -1,18 +1,131 @@
-import { type BlockItemInARequest } from '../fieldTypes';
+import { type BlockInRequest, type RichTextFieldValue, type RichTextFieldValueInNestedResponse, type RichTextFieldValueInRequest, type SingleBlockFieldValue, type SingleBlockFieldValueInNestedResponse, type SingleBlockFieldValueInRequest, type StructuredTextFieldValue, type StructuredTextFieldValueInNestedResponse, type StructuredTextFieldValueInRequest } from '../fieldTypes';
 import type * as ApiTypes from '../generated/ApiTypes';
-import type * as RawApiTypes from '../generated/RawApiTypes';
+import type { ExtractNestedBlocksFromFieldValue } from './itemDefinition';
 import type { SchemaRepository } from './schemaRepository';
+type RecognizableFieldValue = RichTextFieldValueInNestedResponse | SingleBlockFieldValueInNestedResponse | StructuredTextFieldValueInNestedResponse | RichTextFieldValueInRequest | SingleBlockFieldValueInRequest | StructuredTextFieldValueInRequest | RichTextFieldValue | SingleBlockFieldValue | StructuredTextFieldValue;
 /**
- * Path through a field value (ie. ['content', 0, 'attributes', 'title'])
+ * Path through a non-localized field value (ie. ['content', 0, 'attributes', 'title'])
  */
 export type TreePath = readonly (string | number)[];
-export declare function visitBlocksInFieldValues(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, visitor: (item: BlockItemInARequest, path: TreePath) => void | Promise<void>, path?: TreePath): Promise<void>;
-export declare function findAllBlocksInFieldValues(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, predicate: (item: BlockItemInARequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<Array<{
-    item: BlockItemInARequest;
+/**
+ * Traversal direction for recursive operations
+ */
+export type TraversalDirection = 'top-down' | 'bottom-up';
+/**
+ * Recursively visit every block in a non-localized field value and all nested blocks within those blocks.
+ * This function traverses not only the direct blocks in the non-localized field value but also recursively
+ * visits blocks contained within the attributes of each block, creating a complete traversal
+ * of the entire block hierarchy.
+ *
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to visit
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param visitor - Asynchronous function called for each block found, including nested blocks
+ * @returns Promise that resolves when all blocks and nested blocks have been visited
+ */
+export declare function visitBlocksInNonLocalizedFieldValue<T extends RecognizableFieldValue>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, visitor: (item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => void | Promise<void>, path?: TreePath): Promise<void>;
+export declare function visitBlocksInNonLocalizedFieldValue(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, visitor: (item: BlockInRequest, path: TreePath) => void | Promise<void>, path?: TreePath): Promise<void>;
+/**
+ * Recursively find all blocks that match the predicate function in a non-localized field value.
+ * Searches through all direct blocks and recursively through nested blocks within
+ * the attributes of each block, returning all matches found throughout the hierarchy.
+ *
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to search
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param predicate - Asynchronous function that tests each block, including nested ones
+ * @returns Promise that resolves to an array of objects, each containing a matching block and its full path
+ */
+export declare function findAllBlocksInNonLocalizedFieldValue<T extends RecognizableFieldValue>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<Array<{
+    item: ExtractNestedBlocksFromFieldValue<T>;
+    path: TreePath;
+}>>;
+export declare function findAllBlocksInNonLocalizedFieldValue(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: BlockInRequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<Array<{
+    item: BlockInRequest;
     path: TreePath;
 }>>;
-export declare function filterBlocksInFieldValues(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, predicate: (item: BlockItemInARequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<unknown>;
-export declare function reduceBlocksInFieldValues<R>(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, reducer: (accumulator: R, item: BlockItemInARequest, path: TreePath) => R | Promise<R>, initialValue: R, path?: TreePath): Promise<R>;
-export declare function someBlocksInFieldValues(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, predicate: (item: BlockItemInARequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<boolean>;
-export declare function everyBlockInFieldValues(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, predicate: (item: BlockItemInARequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<boolean>;
-export declare function mapBlocksInFieldValues(schemaRepository: SchemaRepository, field: RawApiTypes.Field | ApiTypes.Field, value: unknown, mapper: (item: BlockItemInARequest, path: TreePath) => BlockItemInARequest | Promise<BlockItemInARequest>, path?: TreePath): Promise<unknown>;
+/**
+ * Recursively filter blocks in a non-localized field value, removing those that don't match the predicate.
+ * Creates a new non-localized field value structure containing only blocks that pass the predicate test,
+ * including recursive filtering of nested blocks within block attributes. The filtering
+ * preserves the original non-localized field value structure and hierarchy.
+ *
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to filter
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param predicate - Asynchronous function that tests each block, including nested ones
+ * @param options - Optional configuration object
+ * @param options.traversalDirection - Direction of traversal: 'top-down' (default) applies predicate before processing children, 'bottom-up' processes children first
+ * @returns Promise that resolves to the new non-localized field value with recursively filtered blocks
+ */
+export declare function filterBlocksInNonLocalizedFieldValue<T extends RecognizableFieldValue>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => boolean | Promise<boolean>, options?: {
+    traversalDirection?: TraversalDirection;
+}, path?: TreePath): Promise<T>;
+export declare function filterBlocksInNonLocalizedFieldValue(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: BlockInRequest, path: TreePath) => boolean | Promise<boolean>, options?: {
+    traversalDirection?: TraversalDirection;
+}, path?: TreePath): Promise<unknown>;
+/**
+ * Recursively reduce all blocks in a non-localized field value to a single value by applying a reducer function.
+ * Processes each direct block and recursively processes nested blocks within block attributes,
+ * accumulating results from the entire block hierarchy into a single value.
+ *
+ * @template R - The type of the accumulated result
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to reduce
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param reducer - Asynchronous function that processes each block and updates the accumulator
+ * @param initialNonLocalizedFieldValue - The initial value for the accumulator
+ * @returns Promise that resolves to the final accumulated value from all blocks in the hierarchy
+ */
+export declare function reduceBlocksInNonLocalizedFieldValue<T, R>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, reducer: (accumulator: R, item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => R | Promise<R>, initialValue: R, path?: TreePath): Promise<R>;
+export declare function reduceBlocksInNonLocalizedFieldValue<R>(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, reducer: (accumulator: R, item: BlockInRequest, path: TreePath) => R | Promise<R>, initialValue: R, path?: TreePath): Promise<R>;
+/**
+ * Recursively check if any block in the non-localized field value matches the predicate function.
+ * Tests both direct blocks and recursively tests nested blocks within block attributes.
+ * Returns true as soon as the first matching block is found anywhere in the hierarchy
+ * (short-circuit evaluation).
+ *
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to test
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param predicate - Asynchronous function that tests each block, including nested ones
+ * @returns Promise that resolves to true if any block in the hierarchy matches, false otherwise
+ */
+export declare function someBlocksInNonLocalizedFieldValue<T extends RecognizableFieldValue>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<boolean>;
+export declare function someBlocksInNonLocalizedFieldValue(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: BlockInRequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<boolean>;
+/**
+ * Recursively check if every block in the non-localized field value matches the predicate function.
+ * Tests both direct blocks and recursively tests nested blocks within block attributes.
+ * Returns false as soon as the first non-matching block is found anywhere in the hierarchy
+ * (short-circuit evaluation).
+ *
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to test
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param predicate - Asynchronous function that tests each block, including nested ones
+ * @returns Promise that resolves to true if all blocks in the hierarchy match, false otherwise
+ */
+export declare function everyBlockInNonLocalizedFieldValue<T extends RecognizableFieldValue>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<boolean>;
+export declare function everyBlockInNonLocalizedFieldValue(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, predicate: (item: BlockInRequest, path: TreePath) => boolean | Promise<boolean>, path?: TreePath): Promise<boolean>;
+type FieldValueInRequest<T> = T extends RichTextFieldValueInNestedResponse<infer D> ? RichTextFieldValueInRequest<D> : T extends SingleBlockFieldValueInNestedResponse<infer D> ? SingleBlockFieldValueInRequest<D> : T extends StructuredTextFieldValueInNestedResponse<infer DB, infer DI> ? StructuredTextFieldValueInRequest<DB, DI> : T extends StructuredTextFieldValueInNestedResponse<infer DB> ? StructuredTextFieldValueInRequest<DB> : T;
+/**
+ * Recursively transform blocks in a non-localized field value by applying a mapping function to each block.
+ * Creates a new non-localized field value structure with transformed blocks while preserving the original
+ * structure. Applies the mapping function to both direct blocks and recursively to nested
+ * blocks within block attributes throughout the entire hierarchy.
+ *
+ * @param nonLocalizedFieldValue - The non-localized field value containing blocks to transform
+ * @param fieldType - The type field (determines how the value is processed)
+ * @param schemaRepository - Repository for accessing DatoCMS schema information (to resolve block structures)
+ * @param mapper - Asynchronous function that transforms each block, including nested ones
+ * @param options - Optional configuration object
+ * @param options.traversalDirection - Direction of traversal: 'top-down' (default) applies mapper before processing children, 'bottom-up' processes children first
+ * @returns Promise that resolves to the new non-localized field value with recursively transformed blocks
+ */
+export declare function mapBlocksInNonLocalizedFieldValue<T extends RecognizableFieldValue>(nonLocalizedFieldValue: T, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, mapper: (item: ExtractNestedBlocksFromFieldValue<T>, path: TreePath) => BlockInRequest | Promise<BlockInRequest>, options?: {
+    traversalDirection?: TraversalDirection;
+}, path?: TreePath): Promise<FieldValueInRequest<T>>;
+export declare function mapBlocksInNonLocalizedFieldValue(nonLocalizedFieldValue: unknown, fieldType: ApiTypes.Field['field_type'], schemaRepository: SchemaRepository, mapper: (item: BlockInRequest, path: TreePath) => BlockInRequest | Promise<BlockInRequest>, options?: {
+    traversalDirection?: TraversalDirection;
+}, path?: TreePath): Promise<unknown>;
+export {};

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

@@ -41,7 +41,7 @@ interface GenericClient {
  * - **Caching schema entities**: Automatically caches item types, fields, fieldsets,
  *   and plugins after the first API request, returning cached results on subsequent calls
  * - **Complex traversal operations**: Essential when using utilities like
- *   `mapBlocksInFieldValues()` that need to repeatedly lookup block models and fields
+ *   `mapBlocksInNonLocalizedFieldValue()` that need to repeatedly lookup block models and fields
  *   while traversing nested content structures
  * - **Bulk operations**: Ideal for scripts that process multiple records of different
  *   types and need efficient access to schema information
@@ -73,7 +73,7 @@ interface GenericClient {
  * const sameBlogPost = await schemaRepository.getItemTypeByApiKey('blog_post');
  *
  * // Pass the repository to utilities that need schema information
- * await mapBlocksInFieldValues(schemaRepository, record, (block) => {
+ * await mapBlocksInNonLocalizedFieldValue(schemaRepository, record, (block) => {
  *   // The utility will use the cached schema data internally
  * });
  * ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@datocms/cma-client",
-  "version": "5.1.10",
+  "version": "5.1.12",
   "description": "JS client for DatoCMS REST Content Management API",
   "keywords": [
     "datocms",
@@ -38,12 +38,12 @@
   },
   "dependencies": {
     "@datocms/rest-client-utils": "^5.1.6",
-    "datocms-structured-text-utils": "^5.1.2",
+    "datocms-structured-text-utils": "^5.1.4",
     "uuid": "^9.0.1"
   },
   "devDependencies": {
-    "@datocms/dashboard-client": "^5.1.10",
+    "@datocms/dashboard-client": "^5.1.12",
     "@types/uuid": "^9.0.7"
   },
-  "gitHead": "3f5298b6aa1592b9425d92bd2e4ca0ad052a0bf0"
+  "gitHead": "20ef29ad11049203a14461a9565e0f7833593867"
 }

package/src/fieldTypes/boolean.ts

@@ -1,4 +1,7 @@
-import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import {
+  type LocalizedFieldValue,
+  isLocalizedFieldValue,
+} from '../utilities/normalizedFieldValues';
 import type { BooleanEditorConfiguration } from './appearance/boolean';
 import type { BooleanRadioGroupEditorConfiguration } from './appearance/boolean_radio_group';
 
@@ -14,8 +17,7 @@ export function isLocalizedBooleanFieldValue(
   value: unknown,
 ): value is LocalizedFieldValue<BooleanFieldValue> {
   return (
-    typeof value === 'object' &&
-    value !== null &&
+    isLocalizedFieldValue(value) &&
     Object.values(value).every(isBooleanFieldValue)
   );
 }

package/src/fieldTypes/color.ts

@@ -1,4 +1,7 @@
-import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import {
+  type LocalizedFieldValue,
+  isLocalizedFieldValue,
+} from '../utilities/normalizedFieldValues';
 import type { ColorPickerEditorConfiguration } from './appearance/color_picker';
 import type { RequiredValidator } from './validators/required';
 
@@ -25,8 +28,7 @@ export function isLocalizedColorFieldValue(
   value: unknown,
 ): value is LocalizedFieldValue<ColorFieldValue> {
   return (
-    typeof value === 'object' &&
-    value !== null &&
+    isLocalizedFieldValue(value) &&
     Object.values(value).every(isColorFieldValue)
   );
 }

package/src/fieldTypes/date.ts

@@ -1,4 +1,7 @@
-import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import {
+  type LocalizedFieldValue,
+  isLocalizedFieldValue,
+} from '../utilities/normalizedFieldValues';
 import type { DatePickerEditorConfiguration } from './appearance/date_picker';
 import type { DateRangeValidator } from './validators/date_range';
 import type { RequiredValidator } from './validators/required';
@@ -14,9 +17,7 @@ export function isLocalizedDateFieldValue(
   value: unknown,
 ): value is LocalizedFieldValue<DateFieldValue> {
   return (
-    typeof value === 'object' &&
-    value !== null &&
-    Object.values(value).every(isDateFieldValue)
+    isLocalizedFieldValue(value) && Object.values(value).every(isDateFieldValue)
   );
 }
 

package/src/fieldTypes/date_time.ts

@@ -1,4 +1,7 @@
-import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import {
+  type LocalizedFieldValue,
+  isLocalizedFieldValue,
+} from '../utilities/normalizedFieldValues';
 import type { DateTimePickerEditorConfiguration } from './appearance/date_time_picker';
 import type { DateTimeRangeValidator } from './validators/date_time_range';
 import type { RequiredValidator } from './validators/required';
@@ -19,8 +22,7 @@ export function isLocalizedDateTimeFieldValue(
   value: unknown,
 ): value is LocalizedFieldValue<DateTimeFieldValue> {
   return (
-    typeof value === 'object' &&
-    value !== null &&
+    isLocalizedFieldValue(value) &&
     Object.values(value).every(isDateTimeFieldValue)
   );
 }

package/src/fieldTypes/file.ts

@@ -1,4 +1,7 @@
-import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import {
+  type LocalizedFieldValue,
+  isLocalizedFieldValue,
+} from '../utilities/normalizedFieldValues';
 import type { FileEditorConfiguration } from './appearance/file';
 import type { ExtensionValidator } from './validators/extension';
 import type { FileSizeValidator } from './validators/file_size';
@@ -7,7 +10,63 @@ import type { ImageDimensionsValidator } from './validators/image_dimensions';
 import type { RequiredValidator } from './validators/required';
 import type { RequiredAltTitleValidator } from './validators/required_alt_title';
 
+/**
+ * FILE FIELD TYPE SYSTEM FOR DATOCMS
+ *
+ * This module defines a comprehensive type system for handling DatoCMS File fields,
+ * which contain file uploads with optional metadata like alt text, title, custom data, and focal points.
+ *
+ * The challenge we're solving:
+ * - DatoCMS File fields can have optional metadata fields (alt, title, custom_data, focal_point)
+ * - For API requests, all these fields are optional and can be omitted
+ * - For API responses, DatoCMS provides default values for missing fields:
+ *   - alt: null
+ *   - title: null
+ *   - custom_data: {}
+ *   - focal_point: null
+ * - This creates a need for different type variants for the same conceptual data structure
+ *
+ * This module provides separate types for:
+ * 1. API request format (optional metadata fields)
+ * 2. API response format (all fields present with defaults)
+ */
+
+/**
+ * =============================================================================
+ * BASIC FILE TYPE - Default API response format
+ * =============================================================================
+ *
+ * The standard File field value with all metadata fields present and default values applied.
+ * This is what you get from API responses where DatoCMS has applied default values.
+ */
+
+/**
+ * Basic File field value - all metadata fields present with defaults applied
+ */
 export type FileFieldValue = {
+  upload_id: string;
+  alt: string | null;
+  title: string | null;
+  custom_data: Record<string, unknown>;
+  focal_point: {
+    x: number;
+    y: number;
+  } | null;
+} | null;
+
+/**
+ * =============================================================================
+ * REQUEST VARIANT - Type for sending data TO the DatoCMS API
+ * =============================================================================
+ *
+ * When making API requests, metadata fields are optional and can be omitted.
+ * DatoCMS will apply default values for any missing fields in the response.
+ */
+
+/**
+ * File field value for API requests - metadata fields are optional
+ */
+export type FileFieldValueInRequest = {
   upload_id: string;
   alt?: string | null;
   title?: string | null;
@@ -18,7 +77,35 @@ export type FileFieldValue = {
   } | null;
 } | null;
 
+/**
+ * =============================================================================
+ * TYPE GUARDS - Runtime validation functions
+ * =============================================================================
+ */
+
+/**
+ * Type guard for basic File field values (response format with all fields present).
+ * Validates that all required metadata fields are present.
+ */
 export function isFileFieldValue(value: unknown): value is FileFieldValue {
+  if (value === null) return true;
+  return (
+    isLocalizedFieldValue(value) &&
+    'upload_id' in value &&
+    'alt' in value &&
+    'title' in value &&
+    'custom_data' in value &&
+    'focal_point' in value
+  );
+}
+
+/**
+ * Type guard for File field values in API request format.
+ * Allows metadata fields to be optional or omitted.
+ */
+export function isFileFieldValueInRequest(
+  value: unknown,
+): value is FileFieldValueInRequest {
   if (value === null) return true;
   return typeof value === 'object' && value !== null && 'upload_id' in value;
 }
@@ -27,9 +114,16 @@ export function isLocalizedFileFieldValue(
   value: unknown,
 ): value is LocalizedFieldValue<FileFieldValue> {
   return (
-    typeof value === 'object' &&
-    value !== null &&
-    Object.values(value).every(isFileFieldValue)
+    isLocalizedFieldValue(value) && Object.values(value).every(isFileFieldValue)
+  );
+}
+
+export function isLocalizedFileFieldValueInRequest(
+  value: unknown,
+): value is LocalizedFieldValue<FileFieldValueInRequest> {
+  return (
+    isLocalizedFieldValue(value) &&
+    Object.values(value).every(isFileFieldValueInRequest)
   );
 }
 

package/src/fieldTypes/float.ts

@@ -1,4 +1,7 @@
-import type { LocalizedFieldValue } from '../utilities/fieldValue';
+import {
+  type LocalizedFieldValue,
+  isLocalizedFieldValue,
+} from '../utilities/normalizedFieldValues';
 import type { FloatEditorConfiguration } from './appearance/float';
 import type { NumberRangeValidator } from './validators/number_range';
 import type { RequiredValidator } from './validators/required';
@@ -13,8 +16,7 @@ export function isLocalizedFloatFieldValue(
   value: unknown,
 ): value is LocalizedFieldValue<FloatFieldValue> {
   return (
-    typeof value === 'object' &&
-    value !== null &&
+    isLocalizedFieldValue(value) &&
     Object.values(value).every(isFloatFieldValue)
   );
 }