@datocms/cma-client 5.5.0-alpha.0 → 5.5.0-alpha.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -7747,17 +7747,14 @@ export type Upload = {
7747
7747
  */
7748
7748
  mux_mp4_highest_res: null | 'high' | 'medium' | 'low';
7749
7749
  /**
7750
- * Per-asset default metadata applied when no record-level overrides are present. `alt`, `title`, and `custom_data` are objects keyed by locale; `focal_point` is non-localized — a single value per asset, applied across every locale (only meaningful for image assets).
7751
- *
7752
- * > [!PROTIP] 📘 Requires the `non_localized_focal_points` environment opt-in
7753
- * > This shape is returned and accepted in environments where the opt-in is active. The opt-in is the path forward and will become the default for all projects. Environments where it is still inactive use a legacy locale-keyed shape under the hood (kept working for compatibility) — opt in to align with this documentation.
7750
+ * Per-asset default metadata applied when no record-level overrides are present. `alt`, `title`, and `custom_data` are objects keyed by locale; `focal_point` is a single value per asset (only meaningful for image assets). See [non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) for more info.
7754
7751
  */
7755
7752
  default_field_metadata: {
7756
7753
  alt: LocalizedAlt;
7757
7754
  title: LocalizedTitle;
7758
7755
  custom_data: LocalizedCustomData;
7759
7756
  /**
7760
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
7757
+ * Focal point (only for image assets)
7761
7758
  */
7762
7759
  focal_point: {
7763
7760
  /**
@@ -7982,17 +7979,14 @@ export type UploadAttributes = {
7982
7979
  */
7983
7980
  mux_mp4_highest_res: null | 'high' | 'medium' | 'low';
7984
7981
  /**
7985
- * Per-asset default metadata applied when no record-level overrides are present. `alt`, `title`, and `custom_data` are objects keyed by locale; `focal_point` is non-localized — a single value per asset, applied across every locale (only meaningful for image assets).
7986
- *
7987
- * > [!PROTIP] 📘 Requires the `non_localized_focal_points` environment opt-in
7988
- * > This shape is returned and accepted in environments where the opt-in is active. The opt-in is the path forward and will become the default for all projects. Environments where it is still inactive use a legacy locale-keyed shape under the hood (kept working for compatibility) — opt in to align with this documentation.
7982
+ * Per-asset default metadata applied when no record-level overrides are present. `alt`, `title`, and `custom_data` are objects keyed by locale; `focal_point` is a single value per asset (only meaningful for image assets). See [non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) for more info.
7989
7983
  */
7990
7984
  default_field_metadata: {
7991
7985
  alt: LocalizedAlt;
7992
7986
  title: LocalizedTitle;
7993
7987
  custom_data: LocalizedCustomData;
7994
7988
  /**
7995
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
7989
+ * Focal point (only for image assets)
7996
7990
  */
7997
7991
  focal_point: {
7998
7992
  /**
@@ -8098,7 +8092,7 @@ export type UploadCreateSchema = {
8098
8092
  title?: LocalizedTitle;
8099
8093
  custom_data?: LocalizedCustomData;
8100
8094
  /**
8101
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
8095
+ * Focal point (only for image assets)
8102
8096
  */
8103
8097
  focal_point?: {
8104
8098
  /**
@@ -8156,7 +8150,7 @@ export type UploadUpdateSchema = {
8156
8150
  title?: LocalizedTitle;
8157
8151
  custom_data?: LocalizedCustomData;
8158
8152
  /**
8159
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
8153
+ * Focal point (only for image assets)
8160
8154
  */
8161
8155
  focal_point?: {
8162
8156
  /**
@@ -10311,32 +10305,125 @@ export type PublicInfo = {
10311
10305
  */
10312
10306
  custom_i18n_messages_template_url: null | string;
10313
10307
  /**
10314
- * Specifies the color-scheme for the project
10308
+ * Specifies the color-scheme for the project. For monochromatic themes the response only includes type and hue — frontends must derive the palette from the hue. For custom themes the primary_color, light_color, accent_color, and dark_color fields are returned.
10315
10309
  */
10316
10310
  theme: {
10317
- primary_color: {
10311
+ /**
10312
+ * Whether the project is using a custom color palette or a monochromatic one derived from a hue.
10313
+ */
10314
+ type: 'custom' | 'monochromatic';
10315
+ /**
10316
+ * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
10317
+ */
10318
+ hue: number | null;
10319
+ /**
10320
+ * An integer color channel value (0-255)
10321
+ */
10322
+ color_channel?: number;
10323
+ /**
10324
+ * An RGBA color value
10325
+ */
10326
+ color?: {
10327
+ /**
10328
+ * An integer color channel value (0-255)
10329
+ */
10318
10330
  red: number;
10331
+ /**
10332
+ * An integer color channel value (0-255)
10333
+ */
10319
10334
  green: number;
10335
+ /**
10336
+ * An integer color channel value (0-255)
10337
+ */
10320
10338
  blue: number;
10339
+ /**
10340
+ * An integer color channel value (0-255)
10341
+ */
10321
10342
  alpha: number;
10322
10343
  [k: string]: unknown;
10323
10344
  };
10324
- light_color: {
10345
+ /**
10346
+ * An RGBA color value
10347
+ */
10348
+ primary_color?: {
10349
+ /**
10350
+ * An integer color channel value (0-255)
10351
+ */
10325
10352
  red: number;
10353
+ /**
10354
+ * An integer color channel value (0-255)
10355
+ */
10326
10356
  green: number;
10357
+ /**
10358
+ * An integer color channel value (0-255)
10359
+ */
10327
10360
  blue: number;
10361
+ /**
10362
+ * An integer color channel value (0-255)
10363
+ */
10328
10364
  alpha: number;
10329
10365
  };
10330
- accent_color: {
10366
+ /**
10367
+ * An RGBA color value
10368
+ */
10369
+ light_color?: {
10370
+ /**
10371
+ * An integer color channel value (0-255)
10372
+ */
10331
10373
  red: number;
10374
+ /**
10375
+ * An integer color channel value (0-255)
10376
+ */
10332
10377
  green: number;
10378
+ /**
10379
+ * An integer color channel value (0-255)
10380
+ */
10333
10381
  blue: number;
10382
+ /**
10383
+ * An integer color channel value (0-255)
10384
+ */
10334
10385
  alpha: number;
10335
10386
  };
10336
- dark_color: {
10387
+ /**
10388
+ * An RGBA color value
10389
+ */
10390
+ accent_color?: {
10391
+ /**
10392
+ * An integer color channel value (0-255)
10393
+ */
10337
10394
  red: number;
10395
+ /**
10396
+ * An integer color channel value (0-255)
10397
+ */
10338
10398
  green: number;
10399
+ /**
10400
+ * An integer color channel value (0-255)
10401
+ */
10339
10402
  blue: number;
10403
+ /**
10404
+ * An integer color channel value (0-255)
10405
+ */
10406
+ alpha: number;
10407
+ };
10408
+ /**
10409
+ * An RGBA color value
10410
+ */
10411
+ dark_color?: {
10412
+ /**
10413
+ * An integer color channel value (0-255)
10414
+ */
10415
+ red: number;
10416
+ /**
10417
+ * An integer color channel value (0-255)
10418
+ */
10419
+ green: number;
10420
+ /**
10421
+ * An integer color channel value (0-255)
10422
+ */
10423
+ blue: number;
10424
+ /**
10425
+ * An integer color channel value (0-255)
10426
+ */
10340
10427
  alpha: number;
10341
10428
  };
10342
10429
  };
@@ -10389,32 +10476,125 @@ export type PublicInfoAttributes = {
10389
10476
  */
10390
10477
  custom_i18n_messages_template_url: null | string;
10391
10478
  /**
10392
- * Specifies the color-scheme for the project
10479
+ * Specifies the color-scheme for the project. For monochromatic themes the response only includes type and hue — frontends must derive the palette from the hue. For custom themes the primary_color, light_color, accent_color, and dark_color fields are returned.
10393
10480
  */
10394
10481
  theme: {
10395
- primary_color: {
10482
+ /**
10483
+ * Whether the project is using a custom color palette or a monochromatic one derived from a hue.
10484
+ */
10485
+ type: 'custom' | 'monochromatic';
10486
+ /**
10487
+ * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
10488
+ */
10489
+ hue: number | null;
10490
+ /**
10491
+ * An integer color channel value (0-255)
10492
+ */
10493
+ color_channel?: number;
10494
+ /**
10495
+ * An RGBA color value
10496
+ */
10497
+ color?: {
10498
+ /**
10499
+ * An integer color channel value (0-255)
10500
+ */
10396
10501
  red: number;
10502
+ /**
10503
+ * An integer color channel value (0-255)
10504
+ */
10397
10505
  green: number;
10506
+ /**
10507
+ * An integer color channel value (0-255)
10508
+ */
10398
10509
  blue: number;
10510
+ /**
10511
+ * An integer color channel value (0-255)
10512
+ */
10399
10513
  alpha: number;
10400
10514
  [k: string]: unknown;
10401
10515
  };
10402
- light_color: {
10516
+ /**
10517
+ * An RGBA color value
10518
+ */
10519
+ primary_color?: {
10520
+ /**
10521
+ * An integer color channel value (0-255)
10522
+ */
10403
10523
  red: number;
10524
+ /**
10525
+ * An integer color channel value (0-255)
10526
+ */
10404
10527
  green: number;
10528
+ /**
10529
+ * An integer color channel value (0-255)
10530
+ */
10405
10531
  blue: number;
10532
+ /**
10533
+ * An integer color channel value (0-255)
10534
+ */
10406
10535
  alpha: number;
10407
10536
  };
10408
- accent_color: {
10537
+ /**
10538
+ * An RGBA color value
10539
+ */
10540
+ light_color?: {
10541
+ /**
10542
+ * An integer color channel value (0-255)
10543
+ */
10409
10544
  red: number;
10545
+ /**
10546
+ * An integer color channel value (0-255)
10547
+ */
10410
10548
  green: number;
10549
+ /**
10550
+ * An integer color channel value (0-255)
10551
+ */
10411
10552
  blue: number;
10553
+ /**
10554
+ * An integer color channel value (0-255)
10555
+ */
10412
10556
  alpha: number;
10413
10557
  };
10414
- dark_color: {
10558
+ /**
10559
+ * An RGBA color value
10560
+ */
10561
+ accent_color?: {
10562
+ /**
10563
+ * An integer color channel value (0-255)
10564
+ */
10415
10565
  red: number;
10566
+ /**
10567
+ * An integer color channel value (0-255)
10568
+ */
10416
10569
  green: number;
10570
+ /**
10571
+ * An integer color channel value (0-255)
10572
+ */
10417
10573
  blue: number;
10574
+ /**
10575
+ * An integer color channel value (0-255)
10576
+ */
10577
+ alpha: number;
10578
+ };
10579
+ /**
10580
+ * An RGBA color value
10581
+ */
10582
+ dark_color?: {
10583
+ /**
10584
+ * An integer color channel value (0-255)
10585
+ */
10586
+ red: number;
10587
+ /**
10588
+ * An integer color channel value (0-255)
10589
+ */
10590
+ green: number;
10591
+ /**
10592
+ * An integer color channel value (0-255)
10593
+ */
10594
+ blue: number;
10595
+ /**
10596
+ * An integer color channel value (0-255)
10597
+ */
10418
10598
  alpha: number;
10419
10599
  };
10420
10600
  };
@@ -10762,7 +10942,7 @@ export type Site = {
10762
10942
  };
10763
10943
  };
10764
10944
  /**
10765
- * Specifies the theme to use in administrative area
10945
+ * Specifies the theme to use in administrative area. For monochromatic themes the response only includes type, hue, and logo — frontends must derive the palette from the hue. For custom themes the primary_color, light_color, accent_color, and dark_color fields are returned.
10766
10946
  */
10767
10947
  theme: {
10768
10948
  /**
@@ -10773,28 +10953,113 @@ export type Site = {
10773
10953
  * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
10774
10954
  */
10775
10955
  hue: number | null;
10776
- primary_color: {
10956
+ /**
10957
+ * An integer color channel value (0-255)
10958
+ */
10959
+ color_channel?: number;
10960
+ /**
10961
+ * An RGBA color value
10962
+ */
10963
+ color?: {
10964
+ /**
10965
+ * An integer color channel value (0-255)
10966
+ */
10967
+ red: number;
10968
+ /**
10969
+ * An integer color channel value (0-255)
10970
+ */
10971
+ green: number;
10972
+ /**
10973
+ * An integer color channel value (0-255)
10974
+ */
10975
+ blue: number;
10976
+ /**
10977
+ * An integer color channel value (0-255)
10978
+ */
10979
+ alpha: number;
10980
+ };
10981
+ /**
10982
+ * An RGBA color value
10983
+ */
10984
+ primary_color?: {
10985
+ /**
10986
+ * An integer color channel value (0-255)
10987
+ */
10777
10988
  red: number;
10989
+ /**
10990
+ * An integer color channel value (0-255)
10991
+ */
10778
10992
  green: number;
10993
+ /**
10994
+ * An integer color channel value (0-255)
10995
+ */
10779
10996
  blue: number;
10997
+ /**
10998
+ * An integer color channel value (0-255)
10999
+ */
10780
11000
  alpha: number;
10781
11001
  };
10782
- light_color: {
11002
+ /**
11003
+ * An RGBA color value
11004
+ */
11005
+ light_color?: {
11006
+ /**
11007
+ * An integer color channel value (0-255)
11008
+ */
10783
11009
  red: number;
11010
+ /**
11011
+ * An integer color channel value (0-255)
11012
+ */
10784
11013
  green: number;
11014
+ /**
11015
+ * An integer color channel value (0-255)
11016
+ */
10785
11017
  blue: number;
11018
+ /**
11019
+ * An integer color channel value (0-255)
11020
+ */
10786
11021
  alpha: number;
10787
11022
  };
10788
- accent_color: {
11023
+ /**
11024
+ * An RGBA color value
11025
+ */
11026
+ accent_color?: {
11027
+ /**
11028
+ * An integer color channel value (0-255)
11029
+ */
10789
11030
  red: number;
11031
+ /**
11032
+ * An integer color channel value (0-255)
11033
+ */
10790
11034
  green: number;
11035
+ /**
11036
+ * An integer color channel value (0-255)
11037
+ */
10791
11038
  blue: number;
11039
+ /**
11040
+ * An integer color channel value (0-255)
11041
+ */
10792
11042
  alpha: number;
10793
11043
  };
10794
- dark_color: {
11044
+ /**
11045
+ * An RGBA color value
11046
+ */
11047
+ dark_color?: {
11048
+ /**
11049
+ * An integer color channel value (0-255)
11050
+ */
10795
11051
  red: number;
11052
+ /**
11053
+ * An integer color channel value (0-255)
11054
+ */
10796
11055
  green: number;
11056
+ /**
11057
+ * An integer color channel value (0-255)
11058
+ */
10797
11059
  blue: number;
11060
+ /**
11061
+ * An integer color channel value (0-255)
11062
+ */
10798
11063
  alpha: number;
10799
11064
  };
10800
11065
  /**
@@ -10857,6 +11122,7 @@ export type SiteActivateImprovedValidationAtPublishingTargetSchema = Site;
10857
11122
  export type SiteActivateImprovedExposureOfInlineBlocksInCdaTargetSchema = Site;
10858
11123
  export type SiteActivateImprovedItemsListingTargetSchema = Site;
10859
11124
  export type SiteActivateMillisecondsInDatetimeTargetSchema = Site;
11125
+ export type SiteActivateNonLocalizedFocalPointsTargetSchema = Site;
10860
11126
  export type SiteUpdateAssetsCdnDefaultSettingsTargetSchema = Site;
10861
11127
  /**
10862
11128
  * Meta attributes
@@ -10914,7 +11180,7 @@ export type SiteMeta = {
10914
11180
  */
10915
11181
  milliseconds_in_datetime: boolean;
10916
11182
  /**
10917
- * Whether the non-localized focal points opt-in is active for the environment. When active, an upload's `focal_point` is stored once per asset rather than once per locale, and the CMA `default_field_metadata` attribute is exposed in its field-keyed shape (with `alt`/`title`/`custom_data` keyed by locale and a single top-level `focal_point`). When inactive, the CMA continues to accept and return the legacy locale-keyed shape — the single stored focal_point is replicated into every locale entry on read. The CDA's behavior is unaffected: it already returns a single `focalPoint` value.
11183
+ * Whether the [Non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) opt-in product update is active or not
10918
11184
  */
10919
11185
  non_localized_focal_points: boolean;
10920
11186
  };
@@ -11019,7 +11285,7 @@ export type SiteAttributes = {
11019
11285
  };
11020
11286
  };
11021
11287
  /**
11022
- * Specifies the theme to use in administrative area
11288
+ * Specifies the theme to use in administrative area. For monochromatic themes the response only includes type, hue, and logo — frontends must derive the palette from the hue. For custom themes the primary_color, light_color, accent_color, and dark_color fields are returned.
11023
11289
  */
11024
11290
  theme: {
11025
11291
  /**
@@ -11030,28 +11296,113 @@ export type SiteAttributes = {
11030
11296
  * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
11031
11297
  */
11032
11298
  hue: number | null;
11033
- primary_color: {
11299
+ /**
11300
+ * An integer color channel value (0-255)
11301
+ */
11302
+ color_channel?: number;
11303
+ /**
11304
+ * An RGBA color value
11305
+ */
11306
+ color?: {
11307
+ /**
11308
+ * An integer color channel value (0-255)
11309
+ */
11034
11310
  red: number;
11311
+ /**
11312
+ * An integer color channel value (0-255)
11313
+ */
11035
11314
  green: number;
11315
+ /**
11316
+ * An integer color channel value (0-255)
11317
+ */
11036
11318
  blue: number;
11319
+ /**
11320
+ * An integer color channel value (0-255)
11321
+ */
11037
11322
  alpha: number;
11038
11323
  };
11039
- light_color: {
11324
+ /**
11325
+ * An RGBA color value
11326
+ */
11327
+ primary_color?: {
11328
+ /**
11329
+ * An integer color channel value (0-255)
11330
+ */
11040
11331
  red: number;
11332
+ /**
11333
+ * An integer color channel value (0-255)
11334
+ */
11041
11335
  green: number;
11336
+ /**
11337
+ * An integer color channel value (0-255)
11338
+ */
11042
11339
  blue: number;
11340
+ /**
11341
+ * An integer color channel value (0-255)
11342
+ */
11043
11343
  alpha: number;
11044
11344
  };
11045
- accent_color: {
11345
+ /**
11346
+ * An RGBA color value
11347
+ */
11348
+ light_color?: {
11349
+ /**
11350
+ * An integer color channel value (0-255)
11351
+ */
11046
11352
  red: number;
11353
+ /**
11354
+ * An integer color channel value (0-255)
11355
+ */
11356
+ green: number;
11357
+ /**
11358
+ * An integer color channel value (0-255)
11359
+ */
11360
+ blue: number;
11361
+ /**
11362
+ * An integer color channel value (0-255)
11363
+ */
11364
+ alpha: number;
11365
+ };
11366
+ /**
11367
+ * An RGBA color value
11368
+ */
11369
+ accent_color?: {
11370
+ /**
11371
+ * An integer color channel value (0-255)
11372
+ */
11373
+ red: number;
11374
+ /**
11375
+ * An integer color channel value (0-255)
11376
+ */
11047
11377
  green: number;
11378
+ /**
11379
+ * An integer color channel value (0-255)
11380
+ */
11048
11381
  blue: number;
11382
+ /**
11383
+ * An integer color channel value (0-255)
11384
+ */
11049
11385
  alpha: number;
11050
11386
  };
11051
- dark_color: {
11387
+ /**
11388
+ * An RGBA color value
11389
+ */
11390
+ dark_color?: {
11391
+ /**
11392
+ * An integer color channel value (0-255)
11393
+ */
11052
11394
  red: number;
11395
+ /**
11396
+ * An integer color channel value (0-255)
11397
+ */
11053
11398
  green: number;
11399
+ /**
11400
+ * An integer color channel value (0-255)
11401
+ */
11054
11402
  blue: number;
11403
+ /**
11404
+ * An integer color channel value (0-255)
11405
+ */
11055
11406
  alpha: number;
11056
11407
  };
11057
11408
  /**
@@ -11186,28 +11537,88 @@ export type SiteUpdateSchema = {
11186
11537
  * The upload ID that is used as the logo for the project
11187
11538
  */
11188
11539
  logo: string | null;
11540
+ /**
11541
+ * An RGBA color value
11542
+ */
11189
11543
  primary_color: {
11544
+ /**
11545
+ * An integer color channel value (0-255)
11546
+ */
11190
11547
  red: number;
11548
+ /**
11549
+ * An integer color channel value (0-255)
11550
+ */
11191
11551
  green: number;
11552
+ /**
11553
+ * An integer color channel value (0-255)
11554
+ */
11192
11555
  blue: number;
11556
+ /**
11557
+ * An integer color channel value (0-255)
11558
+ */
11193
11559
  alpha: number;
11194
11560
  };
11561
+ /**
11562
+ * An RGBA color value
11563
+ */
11195
11564
  light_color: {
11565
+ /**
11566
+ * An integer color channel value (0-255)
11567
+ */
11196
11568
  red: number;
11569
+ /**
11570
+ * An integer color channel value (0-255)
11571
+ */
11197
11572
  green: number;
11573
+ /**
11574
+ * An integer color channel value (0-255)
11575
+ */
11198
11576
  blue: number;
11577
+ /**
11578
+ * An integer color channel value (0-255)
11579
+ */
11199
11580
  alpha: number;
11200
11581
  };
11582
+ /**
11583
+ * An RGBA color value
11584
+ */
11201
11585
  accent_color: {
11586
+ /**
11587
+ * An integer color channel value (0-255)
11588
+ */
11202
11589
  red: number;
11590
+ /**
11591
+ * An integer color channel value (0-255)
11592
+ */
11203
11593
  green: number;
11594
+ /**
11595
+ * An integer color channel value (0-255)
11596
+ */
11204
11597
  blue: number;
11598
+ /**
11599
+ * An integer color channel value (0-255)
11600
+ */
11205
11601
  alpha: number;
11206
11602
  };
11603
+ /**
11604
+ * An RGBA color value
11605
+ */
11207
11606
  dark_color?: {
11607
+ /**
11608
+ * An integer color channel value (0-255)
11609
+ */
11208
11610
  red: number;
11611
+ /**
11612
+ * An integer color channel value (0-255)
11613
+ */
11209
11614
  green: number;
11615
+ /**
11616
+ * An integer color channel value (0-255)
11617
+ */
11210
11618
  blue: number;
11619
+ /**
11620
+ * An integer color channel value (0-255)
11621
+ */
11211
11622
  alpha: number;
11212
11623
  };
11213
11624
  [k: string]: unknown;
@@ -11279,7 +11690,7 @@ export type SiteUpdateSchema = {
11279
11690
  */
11280
11691
  milliseconds_in_datetime?: boolean;
11281
11692
  /**
11282
- * Whether the non-localized focal points opt-in is active for the environment. When active, an upload's `focal_point` is stored once per asset rather than once per locale, and the CMA `default_field_metadata` attribute is exposed in its field-keyed shape (with `alt`/`title`/`custom_data` keyed by locale and a single top-level `focal_point`). When inactive, the CMA continues to accept and return the legacy locale-keyed shape — the single stored focal_point is replicated into every locale entry on read. The CDA's behavior is unaffected: it already returns a single `focalPoint` value.
11693
+ * Whether the [Non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) opt-in product update is active or not
11283
11694
  */
11284
11695
  non_localized_focal_points?: boolean;
11285
11696
  };