@datocms/cma-client 5.0.1 → 5.1.0

package/src/generated/SchemaTypes.ts

@@ -1,3 +1,641 @@
+import type {
+  BooleanFieldAppearance,
+  BooleanFieldValidators,
+  BooleanFieldValue,
+  ColorFieldAppearance,
+  ColorFieldValidators,
+  ColorFieldValue,
+  DateFieldAppearance,
+  DateFieldValidators,
+  DateFieldValue,
+  DateTimeFieldAppearance,
+  DateTimeFieldValidators,
+  DateTimeFieldValue,
+  FileFieldAppearance,
+  FileFieldValidators,
+  FloatFieldAppearance,
+  FloatFieldValidators,
+  FloatFieldValue,
+  GalleryFieldAppearance,
+  GalleryFieldValidators,
+  IntegerFieldAppearance,
+  IntegerFieldValidators,
+  IntegerFieldValue,
+  JsonFieldAppearance,
+  JsonFieldValidators,
+  JsonFieldValue,
+  LinkFieldAppearance,
+  LinkFieldValidators,
+  LinksFieldAppearance,
+  LinksFieldValidators,
+  LocationFieldAppearance,
+  LocationFieldValidators,
+  LocationFieldValue,
+  RichTextFieldAppearance,
+  RichTextFieldValidators,
+  SeoFieldAppearance,
+  SeoFieldValidators,
+  SingleBlockFieldAppearance,
+  SingleBlockFieldValidators,
+  SlugFieldAppearance,
+  SlugFieldValidators,
+  StringFieldAppearance,
+  StringFieldValidators,
+  StringFieldValue,
+  StructuredTextFieldAppearance,
+  StructuredTextFieldValidators,
+  TextFieldAppearance,
+  TextFieldValidators,
+  TextFieldValue,
+  VideoFieldAppearance,
+  VideoFieldValidators,
+} from '../fieldTypes';
+
+/**
+ * Enhanced appearance configuration with field-specific types and addon support
+ */
+type FieldAppearanceConfig<TAppearance> = TAppearance &
+  Omit<RawFieldAttributes['appearance'], keyof TAppearance>;
+
+/**
+ * Base field configuration for attributes (non-localized), extending the original SchemaTypes
+ */
+type NonLocalizedFieldAttributesForFieldType<
+  SourceType,
+  FieldType extends RawFieldAttributes['field_type'],
+  FieldValue,
+  FieldValidators,
+  FieldAppearance,
+> = Omit<
+  SourceType,
+  'field_type' | 'default_value' | 'validators' | 'appearance' | 'localized'
+> & {
+  field_type: FieldType;
+  localized: false;
+  default_value: FieldValue;
+  validators: FieldValidators;
+  appearance: FieldAppearanceConfig<FieldAppearance>;
+};
+
+/**
+ * Base field configuration for attributes (localized), extending the original SchemaTypes
+ */
+type LocalizedFieldAttributesForFieldType<
+  SourceType,
+  FieldType extends RawFieldAttributes['field_type'],
+  FieldValue,
+  FieldValidators,
+  FieldAppearance,
+> = Omit<
+  SourceType,
+  'field_type' | 'default_value' | 'validators' | 'appearance' | 'localized'
+> & {
+  field_type: FieldType;
+  localized: true;
+  default_value: FieldValue | Record<string, FieldValue>;
+  validators: FieldValidators;
+  appearance: FieldAppearanceConfig<FieldAppearance>;
+};
+
+/**
+ * Union of localized and non-localized field configurations for attributes
+ */
+type FieldAttributesForFieldType<
+  SourceType,
+  FieldType extends RawFieldAttributes['field_type'],
+  FieldValue,
+  FieldValidators,
+  FieldAppearance,
+> =
+  | NonLocalizedFieldAttributesForFieldType<
+      SourceType,
+      FieldType,
+      FieldValue,
+      FieldValidators,
+      FieldAppearance
+    >
+  | LocalizedFieldAttributesForFieldType<
+      SourceType,
+      FieldType,
+      FieldValue,
+      FieldValidators,
+      FieldAppearance
+    >;
+
+type GenericFieldAttributes<SourceType> =
+  | FieldAttributesForFieldType<
+      SourceType,
+      'boolean',
+      BooleanFieldValue,
+      BooleanFieldValidators,
+      BooleanFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'color',
+      ColorFieldValue,
+      ColorFieldValidators,
+      ColorFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'date',
+      DateFieldValue,
+      DateFieldValidators,
+      DateFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'date_time',
+      DateTimeFieldValue,
+      DateTimeFieldValidators,
+      DateTimeFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'file',
+      // this field type does not support default values
+      null,
+      FileFieldValidators,
+      FileFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'float',
+      FloatFieldValue,
+      FloatFieldValidators,
+      FloatFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'gallery',
+      // this field type does not support default values
+      null,
+      GalleryFieldValidators,
+      GalleryFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'integer',
+      IntegerFieldValue,
+      IntegerFieldValidators,
+      IntegerFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'json',
+      JsonFieldValue,
+      JsonFieldValidators,
+      JsonFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'lat_lon',
+      LocationFieldValue,
+      LocationFieldValidators,
+      LocationFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'link',
+      // this field type does not support default values
+      null,
+      LinkFieldValidators,
+      LinkFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'links',
+      // this field type does not support default values
+      null,
+      LinksFieldValidators,
+      LinksFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'rich_text',
+      // this field type does not support default values
+      null,
+      RichTextFieldValidators,
+      RichTextFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'seo',
+      // this field type does not support default values
+      null,
+      SeoFieldValidators,
+      SeoFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'single_block',
+      // this field type does not support default values
+      null,
+      SingleBlockFieldValidators,
+      SingleBlockFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'slug',
+      // this field type does not support default values
+      null,
+      SlugFieldValidators,
+      SlugFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'string',
+      StringFieldValue,
+      StringFieldValidators,
+      StringFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'structured_text',
+      // this field type does not support default values
+      null,
+      StructuredTextFieldValidators,
+      StructuredTextFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'text',
+      TextFieldValue,
+      TextFieldValidators,
+      TextFieldAppearance
+    >
+  | FieldAttributesForFieldType<
+      SourceType,
+      'video',
+      // this field type does not support default values
+      null,
+      VideoFieldValidators,
+      VideoFieldAppearance
+    >;
+
+export type FieldAttributes = GenericFieldAttributes<RawFieldAttributes>;
+
+export type Field = RawField;
+
+/**
+ * Helper type to conditionally handle default values based on localization for field creation
+ */
+type FieldCreateDefaultValue<T> = T | Record<string, T> | undefined;
+
+type FieldCreateConfigForFieldType<
+  SourceType,
+  FieldType extends RawFieldAttributes['field_type'],
+  FieldValue,
+  FieldValidators,
+  FieldAppearance,
+> = Omit<
+  SourceType,
+  'field_type' | 'default_value' | 'validators' | 'appearance'
+> & {
+  field_type: FieldType;
+  default_value?: FieldCreateDefaultValue<FieldValue>;
+  validators?: FieldValidators;
+  appearance?: FieldAppearanceConfig<FieldAppearance>;
+};
+
+type FieldCreateConfig<SourceType> =
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'boolean',
+      BooleanFieldValue,
+      BooleanFieldValidators,
+      BooleanFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'color',
+      ColorFieldValue,
+      ColorFieldValidators,
+      ColorFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'date',
+      DateFieldValue,
+      DateFieldValidators,
+      DateFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'date_time',
+      DateTimeFieldValue,
+      DateTimeFieldValidators,
+      DateTimeFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'file',
+      // this field type does not support default values
+      null,
+      FileFieldValidators,
+      FileFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'float',
+      FloatFieldValue,
+      FloatFieldValidators,
+      FloatFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'gallery',
+      // this field type does not support default values
+      null,
+      GalleryFieldValidators,
+      GalleryFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'integer',
+      IntegerFieldValue,
+      IntegerFieldValidators,
+      IntegerFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'json',
+      JsonFieldValue,
+      JsonFieldValidators,
+      JsonFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'lat_lon',
+      LocationFieldValue,
+      LocationFieldValidators,
+      LocationFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'link',
+      // this field type does not support default values
+      null,
+      LinkFieldValidators,
+      LinkFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'links',
+      // this field type does not support default values
+      null,
+      LinksFieldValidators,
+      LinksFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'rich_text',
+      // this field type does not support default values
+      null,
+      RichTextFieldValidators,
+      RichTextFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'seo',
+      // this field type does not support default values
+      null,
+      SeoFieldValidators,
+      SeoFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'single_block',
+      // this field type does not support default values
+      null,
+      SingleBlockFieldValidators,
+      SingleBlockFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'slug',
+      // this field type does not support default values
+      null,
+      SlugFieldValidators,
+      SlugFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'string',
+      StringFieldValue,
+      StringFieldValidators,
+      StringFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'structured_text',
+      // this field type does not support default values
+      null,
+      StructuredTextFieldValidators,
+      StructuredTextFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'text',
+      TextFieldValue,
+      TextFieldValidators,
+      TextFieldAppearance
+    >
+  | FieldCreateConfigForFieldType<
+      SourceType,
+      'video',
+      // this field type does not support default values
+      null,
+      VideoFieldValidators,
+      VideoFieldAppearance
+    >;
+
+export type FieldCreateSchema = Omit<RawFieldCreateSchema, 'data'> & {
+  data: Omit<RawFieldCreateSchema['data'], 'attributes'> & {
+    attributes: FieldCreateConfig<RawFieldCreateSchema['data']['attributes']>;
+  };
+};
+
+/**
+ * Helper type to conditionally handle default values based on localization for field updates
+ */
+type FieldUpdateDefaultValue<T> = T | Record<string, T> | undefined;
+
+type FieldUpdateConfigForFieldType<
+  SourceType,
+  FieldType extends RawFieldAttributes['field_type'],
+  FieldValue,
+  FieldValidators,
+  FieldAppearance,
+> = Omit<
+  SourceType,
+  'field_type' | 'default_value' | 'validators' | 'appearance'
+> & {
+  field_type?: FieldType;
+  default_value?: FieldUpdateDefaultValue<FieldValue>;
+  validators?: FieldValidators;
+  appearance?: FieldAppearanceConfig<FieldAppearance>;
+};
+
+type FieldUpdateConfig<SourceType> =
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'boolean',
+      BooleanFieldValue,
+      BooleanFieldValidators,
+      BooleanFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'color',
+      ColorFieldValue,
+      ColorFieldValidators,
+      ColorFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'date',
+      DateFieldValue,
+      DateFieldValidators,
+      DateFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'date_time',
+      DateTimeFieldValue,
+      DateTimeFieldValidators,
+      DateTimeFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'file',
+      // this field type does not support default values
+      null,
+      FileFieldValidators,
+      FileFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'float',
+      FloatFieldValue,
+      FloatFieldValidators,
+      FloatFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'gallery',
+      // this field type does not support default values
+      null,
+      GalleryFieldValidators,
+      GalleryFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'integer',
+      IntegerFieldValue,
+      IntegerFieldValidators,
+      IntegerFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'json',
+      JsonFieldValue,
+      JsonFieldValidators,
+      JsonFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'lat_lon',
+      LocationFieldValue,
+      LocationFieldValidators,
+      LocationFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'link',
+      // this field type does not support default values
+      null,
+      LinkFieldValidators,
+      LinkFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'links',
+      // this field type does not support default values
+      null,
+      LinksFieldValidators,
+      LinksFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'rich_text',
+      // this field type does not support default values
+      null,
+      RichTextFieldValidators,
+      RichTextFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'seo',
+      // this field type does not support default values
+      null,
+      SeoFieldValidators,
+      SeoFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'single_block',
+      // this field type does not support default values
+      null,
+      SingleBlockFieldValidators,
+      SingleBlockFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'slug',
+      // this field type does not support default values
+      null,
+      SlugFieldValidators,
+      SlugFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'string',
+      StringFieldValue,
+      StringFieldValidators,
+      StringFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'structured_text',
+      // this field type does not support default values
+      null,
+      StructuredTextFieldValidators,
+      StructuredTextFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'text',
+      TextFieldValue,
+      TextFieldValidators,
+      TextFieldAppearance
+    >
+  | FieldUpdateConfigForFieldType<
+      SourceType,
+      'video',
+      // this field type does not support default values
+      null,
+      VideoFieldValidators,
+      VideoFieldAppearance
+    >;
+
+export type FieldUpdateSchema = Omit<RawFieldUpdateSchema, 'data'> & {
+  data: Omit<RawFieldUpdateSchema['data'], 'attributes'> & {
+    attributes: FieldUpdateConfig<RawFieldUpdateSchema['data']['attributes']>;
+  };
+};
+
 /* tslint:disable */
 /**
  * This file was automatically generated by hyperschema-to-ts: DO NOT MODIFY IT BY HAND.
@@ -5891,7 +6529,7 @@ export type ItemTypeReorderFieldsAndFieldsetsJobSchema = {
  * This interface was referenced by `DatoApi`'s JSON-Schema
  * via the `definition` "field".
  */
-export type Field = {
+export type RawField = {
   type: FieldType;
   id: FieldIdentity;
   attributes: FieldAttributes;
@@ -5904,7 +6542,7 @@ export type Field = {
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `definition` "attributes".
  */
-export type FieldAttributes = {
+export type RawFieldAttributes = {
   /**
    * The label of the field
    */
@@ -6044,7 +6682,7 @@ export type FieldRelationships = {
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `create.schema` link.
  */
-export type FieldCreateSchema = {
+export type RawFieldCreateSchema = {
   data: {
     id?: FieldIdentity;
     type: FieldType;
@@ -6200,7 +6838,7 @@ export type FieldCreateJobSchema = {
  * This interface was referenced by `Field`'s JSON-Schema
  * via the `update.schema` link.
  */
-export type FieldUpdateSchema = {
+export type RawFieldUpdateSchema = {
   data: {
     type: FieldType;
     id: FieldIdentity;