@datocms/cma-client 5.1.9 → 5.1.11

package/src/utilities/itemDefinition.ts

@@ -4,8 +4,10 @@ import type {
   DateFieldValue,
   DateTimeFieldValue,
   FileFieldValue,
+  FileFieldValueAsRequest,
   FloatFieldValue,
   GalleryFieldValue,
+  GalleryFieldValueAsRequest,
   IntegerFieldValue,
   JsonFieldValue,
   LatLonFieldValue,
@@ -26,7 +28,7 @@ import type {
   TextFieldValue,
   VideoFieldValue,
 } from '../fieldTypes';
-import type { LocalizedFieldValue } from './fieldValue';
+import type { LocalizedFieldValue } from './normalizedFieldValues';
 
 /** Base field definition */
 type BaseFieldDefinition<Type extends string> = {
@@ -94,7 +96,7 @@ export type ItemDefinition<
   fields: FieldValues;
 };
 
-/** Standard field values */
+/** Standard field values (response format) */
 type FieldTypeToValue = {
   boolean: BooleanFieldValue;
   color: ColorFieldValue;
@@ -119,6 +121,31 @@ type FieldTypeToValue = {
   unknown: unknown;
 };
 
+/** Request field values (request format with optional metadata) */
+type FieldTypeToValueAsRequest = {
+  boolean: BooleanFieldValue;
+  color: ColorFieldValue;
+  date: DateFieldValue;
+  date_time: DateTimeFieldValue;
+  file: FileFieldValueAsRequest;
+  float: FloatFieldValue;
+  gallery: GalleryFieldValueAsRequest;
+  integer: IntegerFieldValue;
+  json: JsonFieldValue;
+  lat_lon: LatLonFieldValue;
+  link: LinkFieldValue;
+  links: LinksFieldValue;
+  rich_text: RichTextFieldValueAsRequest;
+  seo: SeoFieldValue;
+  single_block: SingleBlockFieldValueAsRequest;
+  slug: SlugFieldValue;
+  string: StringFieldValue;
+  structured_text: StructuredTextFieldValueAsRequest;
+  text: TextFieldValue;
+  video: VideoFieldValue;
+  unknown: unknown;
+};
+
 /** Localized wrapper */
 type LocalizeIfNeeded<
   T extends FieldDefinition,
@@ -139,33 +166,27 @@ type FieldDefinitionToFieldValueAsRequest<
 > = T extends RichTextFieldDefinition<infer B>
   ? LocalizeIfNeeded<
       T,
-      RichTextFieldValueAsRequest<
-        ItemTypeDefinitionToItemDefinitionAsRequest<B>
-      >,
+      RichTextFieldValueAsRequest<ToItemDefinitionAsRequest<B>>,
       Locales
     >
   : T extends SingleBlockFieldDefinition<infer B>
     ? LocalizeIfNeeded<
         T,
-        SingleBlockFieldValueAsRequest<
-          ItemTypeDefinitionToItemDefinitionAsRequest<B>
-        >,
+        SingleBlockFieldValueAsRequest<ToItemDefinitionAsRequest<B>>,
         Locales
       >
     : T extends StructuredTextFieldDefinition<infer B, infer I>
       ? LocalizeIfNeeded<
           T,
           StructuredTextFieldValueAsRequest<
-            T extends { blocks: any }
-              ? ItemTypeDefinitionToItemDefinitionAsRequest<B>
-              : never,
+            T extends { blocks: any } ? ToItemDefinitionAsRequest<B> : never,
             T extends { inline_blocks: any }
-              ? ItemTypeDefinitionToItemDefinitionAsRequest<I>
+              ? ToItemDefinitionAsRequest<I>
               : never
           >,
           Locales
         >
-      : LocalizeIfNeeded<T, FieldTypeToValue[T['type']], Locales>;
+      : LocalizeIfNeeded<T, FieldTypeToValueAsRequest[T['type']], Locales>;
 
 type FieldDefinitionToFieldValueWithNestedBlocks<
   T extends FieldDefinition,
@@ -173,16 +194,14 @@ type FieldDefinitionToFieldValueWithNestedBlocks<
 > = T extends RichTextFieldDefinition<infer B>
   ? LocalizeIfNeeded<
       T,
-      RichTextFieldValueWithNestedBlocks<
-        ItemTypeDefinitionToItemDefinitionWithNestedBlocks<B>
-      >,
+      RichTextFieldValueWithNestedBlocks<ToItemDefinitionWithNestedBlocks<B>>,
       Locales
     >
   : T extends SingleBlockFieldDefinition<infer B>
     ? LocalizeIfNeeded<
         T,
         SingleBlockFieldValueWithNestedBlocks<
-          ItemTypeDefinitionToItemDefinitionWithNestedBlocks<B>
+          ToItemDefinitionWithNestedBlocks<B>
         >,
         Locales
       >
@@ -191,10 +210,10 @@ type FieldDefinitionToFieldValueWithNestedBlocks<
           T,
           StructuredTextFieldValueWithNestedBlocks<
             T extends { blocks: any }
-              ? ItemTypeDefinitionToItemDefinitionWithNestedBlocks<B>
+              ? ToItemDefinitionWithNestedBlocks<B>
               : never,
             T extends { inline_blocks: any }
-              ? ItemTypeDefinitionToItemDefinitionWithNestedBlocks<I>
+              ? ToItemDefinitionWithNestedBlocks<I>
               : never
           >,
           Locales
@@ -202,22 +221,21 @@ type FieldDefinitionToFieldValueWithNestedBlocks<
       : LocalizeIfNeeded<T, FieldTypeToValue[T['type']], Locales>;
 
 /** Transformers */
-export type ItemTypeDefinitionToItemDefinition<
-  T extends ItemTypeDefinition<any, any, any>,
-> = T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields>
-  ? keyof Fields extends never
-    ? ItemDefinition<ItemTypeId>
-    : ItemDefinition<
-        ItemTypeId,
-        {
-          [K in keyof Fields]: Fields[K] extends FieldDefinition
-            ? FieldDefinitionToFieldValue<Fields[K], Settings['locales']>
-            : never;
-        }
-      >
-  : never;
+export type ToItemDefinition<T extends ItemTypeDefinition<any, any, any>> =
+  T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields>
+    ? keyof Fields extends never
+      ? ItemDefinition<ItemTypeId>
+      : ItemDefinition<
+          ItemTypeId,
+          {
+            [K in keyof Fields]: Fields[K] extends FieldDefinition
+              ? FieldDefinitionToFieldValue<Fields[K], Settings['locales']>
+              : never;
+          }
+        >
+    : never;
 
-export type ItemTypeDefinitionToItemDefinitionAsRequest<
+export type ToItemDefinitionAsRequest<
   T extends ItemTypeDefinition<any, any, any>,
 > = T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields>
   ? keyof Fields extends never
@@ -235,7 +253,7 @@ export type ItemTypeDefinitionToItemDefinitionAsRequest<
       >
   : never;
 
-export type ItemTypeDefinitionToItemDefinitionWithNestedBlocks<
+export type ToItemDefinitionWithNestedBlocks<
   T extends ItemTypeDefinition<any, any, any>,
 > = T extends ItemTypeDefinition<infer Settings, infer ItemTypeId, infer Fields>
   ? keyof Fields extends never