@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.
@@ -8616,17 +8616,14 @@ export type UploadAttributes = {
8616
8616
  */
8617
8617
  mux_mp4_highest_res: null | 'high' | 'medium' | 'low';
8618
8618
  /**
8619
- * 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).
8620
- *
8621
- * > [!PROTIP] 📘 Requires the `non_localized_focal_points` environment opt-in
8622
- * > 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.
8619
+ * 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.
8623
8620
  */
8624
8621
  default_field_metadata: {
8625
8622
  alt: LocalizedAlt;
8626
8623
  title: LocalizedTitle;
8627
8624
  custom_data: LocalizedCustomData;
8628
8625
  /**
8629
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
8626
+ * Focal point (only for image assets)
8630
8627
  */
8631
8628
  focal_point: {
8632
8629
  /**
@@ -8822,7 +8819,7 @@ export type UploadCreateSchema = {
8822
8819
  title?: LocalizedTitle;
8823
8820
  custom_data?: LocalizedCustomData;
8824
8821
  /**
8825
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
8822
+ * Focal point (only for image assets)
8826
8823
  */
8827
8824
  focal_point?: {
8828
8825
  /**
@@ -8930,7 +8927,7 @@ export type UploadUpdateSchema = {
8930
8927
  title?: LocalizedTitle;
8931
8928
  custom_data?: LocalizedCustomData;
8932
8929
  /**
8933
- * Focal point — non-localized; a single value applies across every locale (only meaningful for image assets)
8930
+ * Focal point (only for image assets)
8934
8931
  */
8935
8932
  focal_point?: {
8936
8933
  /**
@@ -11547,32 +11544,125 @@ export type PublicInfoAttributes = {
11547
11544
  */
11548
11545
  custom_i18n_messages_template_url: null | string;
11549
11546
  /**
11550
- * Specifies the color-scheme for the project
11547
+ * 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.
11551
11548
  */
11552
11549
  theme: {
11553
- primary_color: {
11550
+ /**
11551
+ * Whether the project is using a custom color palette or a monochromatic one derived from a hue.
11552
+ */
11553
+ type: 'custom' | 'monochromatic';
11554
+ /**
11555
+ * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
11556
+ */
11557
+ hue: number | null;
11558
+ /**
11559
+ * An integer color channel value (0-255)
11560
+ */
11561
+ color_channel?: number;
11562
+ /**
11563
+ * An RGBA color value
11564
+ */
11565
+ color?: {
11566
+ /**
11567
+ * An integer color channel value (0-255)
11568
+ */
11554
11569
  red: number;
11570
+ /**
11571
+ * An integer color channel value (0-255)
11572
+ */
11555
11573
  green: number;
11574
+ /**
11575
+ * An integer color channel value (0-255)
11576
+ */
11556
11577
  blue: number;
11578
+ /**
11579
+ * An integer color channel value (0-255)
11580
+ */
11557
11581
  alpha: number;
11558
11582
  [k: string]: unknown;
11559
11583
  };
11560
- light_color: {
11584
+ /**
11585
+ * An RGBA color value
11586
+ */
11587
+ primary_color?: {
11588
+ /**
11589
+ * An integer color channel value (0-255)
11590
+ */
11591
+ red: number;
11592
+ /**
11593
+ * An integer color channel value (0-255)
11594
+ */
11595
+ green: number;
11596
+ /**
11597
+ * An integer color channel value (0-255)
11598
+ */
11599
+ blue: number;
11600
+ /**
11601
+ * An integer color channel value (0-255)
11602
+ */
11603
+ alpha: number;
11604
+ };
11605
+ /**
11606
+ * An RGBA color value
11607
+ */
11608
+ light_color?: {
11609
+ /**
11610
+ * An integer color channel value (0-255)
11611
+ */
11561
11612
  red: number;
11613
+ /**
11614
+ * An integer color channel value (0-255)
11615
+ */
11562
11616
  green: number;
11617
+ /**
11618
+ * An integer color channel value (0-255)
11619
+ */
11563
11620
  blue: number;
11621
+ /**
11622
+ * An integer color channel value (0-255)
11623
+ */
11564
11624
  alpha: number;
11565
11625
  };
11566
- accent_color: {
11626
+ /**
11627
+ * An RGBA color value
11628
+ */
11629
+ accent_color?: {
11630
+ /**
11631
+ * An integer color channel value (0-255)
11632
+ */
11567
11633
  red: number;
11634
+ /**
11635
+ * An integer color channel value (0-255)
11636
+ */
11568
11637
  green: number;
11638
+ /**
11639
+ * An integer color channel value (0-255)
11640
+ */
11569
11641
  blue: number;
11642
+ /**
11643
+ * An integer color channel value (0-255)
11644
+ */
11570
11645
  alpha: number;
11571
11646
  };
11572
- dark_color: {
11647
+ /**
11648
+ * An RGBA color value
11649
+ */
11650
+ dark_color?: {
11651
+ /**
11652
+ * An integer color channel value (0-255)
11653
+ */
11573
11654
  red: number;
11655
+ /**
11656
+ * An integer color channel value (0-255)
11657
+ */
11574
11658
  green: number;
11659
+ /**
11660
+ * An integer color channel value (0-255)
11661
+ */
11575
11662
  blue: number;
11663
+ /**
11664
+ * An integer color channel value (0-255)
11665
+ */
11576
11666
  alpha: number;
11577
11667
  };
11578
11668
  };
@@ -11937,7 +12027,7 @@ export type SiteAttributes = {
11937
12027
  };
11938
12028
  };
11939
12029
  /**
11940
- * Specifies the theme to use in administrative area
12030
+ * 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.
11941
12031
  */
11942
12032
  theme: {
11943
12033
  /**
@@ -11948,28 +12038,113 @@ export type SiteAttributes = {
11948
12038
  * If the type is monochromatic, the value will fall between 0 and 359. If it's not, the value will be null.
11949
12039
  */
11950
12040
  hue: number | null;
11951
- primary_color: {
12041
+ /**
12042
+ * An integer color channel value (0-255)
12043
+ */
12044
+ color_channel?: number;
12045
+ /**
12046
+ * An RGBA color value
12047
+ */
12048
+ color?: {
12049
+ /**
12050
+ * An integer color channel value (0-255)
12051
+ */
11952
12052
  red: number;
12053
+ /**
12054
+ * An integer color channel value (0-255)
12055
+ */
11953
12056
  green: number;
12057
+ /**
12058
+ * An integer color channel value (0-255)
12059
+ */
11954
12060
  blue: number;
12061
+ /**
12062
+ * An integer color channel value (0-255)
12063
+ */
11955
12064
  alpha: number;
11956
12065
  };
11957
- light_color: {
12066
+ /**
12067
+ * An RGBA color value
12068
+ */
12069
+ primary_color?: {
12070
+ /**
12071
+ * An integer color channel value (0-255)
12072
+ */
11958
12073
  red: number;
12074
+ /**
12075
+ * An integer color channel value (0-255)
12076
+ */
11959
12077
  green: number;
12078
+ /**
12079
+ * An integer color channel value (0-255)
12080
+ */
11960
12081
  blue: number;
12082
+ /**
12083
+ * An integer color channel value (0-255)
12084
+ */
11961
12085
  alpha: number;
11962
12086
  };
11963
- accent_color: {
12087
+ /**
12088
+ * An RGBA color value
12089
+ */
12090
+ light_color?: {
12091
+ /**
12092
+ * An integer color channel value (0-255)
12093
+ */
12094
+ red: number;
12095
+ /**
12096
+ * An integer color channel value (0-255)
12097
+ */
12098
+ green: number;
12099
+ /**
12100
+ * An integer color channel value (0-255)
12101
+ */
12102
+ blue: number;
12103
+ /**
12104
+ * An integer color channel value (0-255)
12105
+ */
12106
+ alpha: number;
12107
+ };
12108
+ /**
12109
+ * An RGBA color value
12110
+ */
12111
+ accent_color?: {
12112
+ /**
12113
+ * An integer color channel value (0-255)
12114
+ */
11964
12115
  red: number;
12116
+ /**
12117
+ * An integer color channel value (0-255)
12118
+ */
11965
12119
  green: number;
12120
+ /**
12121
+ * An integer color channel value (0-255)
12122
+ */
11966
12123
  blue: number;
12124
+ /**
12125
+ * An integer color channel value (0-255)
12126
+ */
11967
12127
  alpha: number;
11968
12128
  };
11969
- dark_color: {
12129
+ /**
12130
+ * An RGBA color value
12131
+ */
12132
+ dark_color?: {
12133
+ /**
12134
+ * An integer color channel value (0-255)
12135
+ */
11970
12136
  red: number;
12137
+ /**
12138
+ * An integer color channel value (0-255)
12139
+ */
11971
12140
  green: number;
12141
+ /**
12142
+ * An integer color channel value (0-255)
12143
+ */
11972
12144
  blue: number;
12145
+ /**
12146
+ * An integer color channel value (0-255)
12147
+ */
11973
12148
  alpha: number;
11974
12149
  };
11975
12150
  /**
@@ -12089,7 +12264,7 @@ export type SiteMeta = {
12089
12264
  */
12090
12265
  milliseconds_in_datetime: boolean;
12091
12266
  /**
12092
- * 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.
12267
+ * Whether the [Non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) opt-in product update is active or not
12093
12268
  */
12094
12269
  non_localized_focal_points: boolean;
12095
12270
  };
@@ -12192,28 +12367,88 @@ export type SiteUpdateSchema = {
12192
12367
  * The upload ID that is used as the logo for the project
12193
12368
  */
12194
12369
  logo: string | null;
12370
+ /**
12371
+ * An RGBA color value
12372
+ */
12195
12373
  primary_color: {
12374
+ /**
12375
+ * An integer color channel value (0-255)
12376
+ */
12196
12377
  red: number;
12378
+ /**
12379
+ * An integer color channel value (0-255)
12380
+ */
12197
12381
  green: number;
12382
+ /**
12383
+ * An integer color channel value (0-255)
12384
+ */
12198
12385
  blue: number;
12386
+ /**
12387
+ * An integer color channel value (0-255)
12388
+ */
12199
12389
  alpha: number;
12200
12390
  };
12391
+ /**
12392
+ * An RGBA color value
12393
+ */
12201
12394
  light_color: {
12395
+ /**
12396
+ * An integer color channel value (0-255)
12397
+ */
12202
12398
  red: number;
12399
+ /**
12400
+ * An integer color channel value (0-255)
12401
+ */
12203
12402
  green: number;
12403
+ /**
12404
+ * An integer color channel value (0-255)
12405
+ */
12204
12406
  blue: number;
12407
+ /**
12408
+ * An integer color channel value (0-255)
12409
+ */
12205
12410
  alpha: number;
12206
12411
  };
12412
+ /**
12413
+ * An RGBA color value
12414
+ */
12207
12415
  accent_color: {
12416
+ /**
12417
+ * An integer color channel value (0-255)
12418
+ */
12208
12419
  red: number;
12420
+ /**
12421
+ * An integer color channel value (0-255)
12422
+ */
12209
12423
  green: number;
12424
+ /**
12425
+ * An integer color channel value (0-255)
12426
+ */
12210
12427
  blue: number;
12428
+ /**
12429
+ * An integer color channel value (0-255)
12430
+ */
12211
12431
  alpha: number;
12212
12432
  };
12433
+ /**
12434
+ * An RGBA color value
12435
+ */
12213
12436
  dark_color?: {
12437
+ /**
12438
+ * An integer color channel value (0-255)
12439
+ */
12214
12440
  red: number;
12441
+ /**
12442
+ * An integer color channel value (0-255)
12443
+ */
12215
12444
  green: number;
12445
+ /**
12446
+ * An integer color channel value (0-255)
12447
+ */
12216
12448
  blue: number;
12449
+ /**
12450
+ * An integer color channel value (0-255)
12451
+ */
12217
12452
  alpha: number;
12218
12453
  };
12219
12454
  [k: string]: unknown;
@@ -12285,7 +12520,7 @@ export type SiteUpdateSchema = {
12285
12520
  */
12286
12521
  milliseconds_in_datetime?: boolean;
12287
12522
  /**
12288
- * 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.
12523
+ * Whether the [Non-localized focal points](https://www.datocms.com/product-updates/non-localized-focal-points) opt-in product update is active or not
12289
12524
  */
12290
12525
  non_localized_focal_points?: boolean;
12291
12526
  };
@@ -12387,6 +12622,13 @@ export type SiteActivateImprovedItemsListingTargetSchema = {
12387
12622
  export type SiteActivateMillisecondsInDatetimeTargetSchema = {
12388
12623
  data: Site;
12389
12624
  };
12625
+ /**
12626
+ * This interface was referenced by `Site`'s JSON-Schema
12627
+ * via the `activate_non_localized_focal_points.targetSchema` link.
12628
+ */
12629
+ export type SiteActivateNonLocalizedFocalPointsTargetSchema = {
12630
+ data: Site;
12631
+ };
12390
12632
  /**
12391
12633
  * This interface was referenced by `Site`'s JSON-Schema
12392
12634
  * via the `update_assets_cdn_default_settings.schema` link.
@@ -47,4 +47,35 @@ export default class Session extends BaseResource {
47
47
  body,
48
48
  });
49
49
  }
50
+
51
+ /**
52
+ * Destroy the current session
53
+ *
54
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/session/destroy
55
+ *
56
+ * @throws {ApiError}
57
+ * @throws {TimeoutError}
58
+ *
59
+ * @deprecated This API call is to be considered private and might change without notice
60
+ */
61
+ destroy() {
62
+ return this.rawDestroy();
63
+ }
64
+
65
+ /**
66
+ * Destroy the current session
67
+ *
68
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/session/destroy
69
+ *
70
+ * @throws {ApiError}
71
+ * @throws {TimeoutError}
72
+ *
73
+ * @deprecated This API call is to be considered private and might change without notice
74
+ */
75
+ rawDestroy(): Promise<void> {
76
+ return this.client.request<void>({
77
+ method: 'DELETE',
78
+ url: '/session',
79
+ });
80
+ }
50
81
  }
@@ -457,6 +457,43 @@ export default class Site extends BaseResource {
457
457
  );
458
458
  }
459
459
 
460
+ /**
461
+ * Activate non-localized focal points
462
+ *
463
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_non_localized_focal_points
464
+ *
465
+ * @throws {ApiError}
466
+ * @throws {TimeoutError}
467
+ *
468
+ * @deprecated This API call is to be considered private and might change without notice
469
+ */
470
+ activateNonLocalizedFocalPoints() {
471
+ return this.rawActivateNonLocalizedFocalPoints().then((body) =>
472
+ Utils.deserializeResponseBody<ApiTypes.SiteActivateNonLocalizedFocalPointsTargetSchema>(
473
+ body,
474
+ ),
475
+ );
476
+ }
477
+
478
+ /**
479
+ * Activate non-localized focal points
480
+ *
481
+ * Read more: https://www.datocms.com/docs/content-management-api/resources/site/activate_non_localized_focal_points
482
+ *
483
+ * @throws {ApiError}
484
+ * @throws {TimeoutError}
485
+ *
486
+ * @deprecated This API call is to be considered private and might change without notice
487
+ */
488
+ rawActivateNonLocalizedFocalPoints(): Promise<RawApiTypes.SiteActivateNonLocalizedFocalPointsTargetSchema> {
489
+ return this.client.request<RawApiTypes.SiteActivateNonLocalizedFocalPointsTargetSchema>(
490
+ {
491
+ method: 'PUT',
492
+ url: '/site/activate-non-localized-focal-points',
493
+ },
494
+ );
495
+ }
496
+
460
497
  /**
461
498
  * Update CDN settings default assets
462
499
  *
@@ -76,7 +76,7 @@ export function isValidId(id: string) {
76
76
  }
77
77
 
78
78
  export function generateId() {
79
- const bytes = v4(null, new Uint8Array(16));
79
+ const bytes = v4(undefined, new Uint8Array(16));
80
80
 
81
81
  // Here we unset the first bit to ensure [A-Za-f] as the first char.
82
82
  //