@uniformdev/canvas 19.96.1-alpha.0 → 19.99.0

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.
package/dist/index.d.mts CHANGED
@@ -122,6 +122,12 @@ interface components$5 {
122
122
  * @default null
123
123
  */
124
124
  titleParameter?: string | null;
125
+ /**
126
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
127
+ *
128
+ * @default null
129
+ */
130
+ thumbnailParameter?: string | null;
125
131
  /**
126
132
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
127
133
  * @default false
@@ -174,6 +180,12 @@ interface components$5 {
174
180
  * The field type must support being used as an entry name for this to work.
175
181
  */
176
182
  entryName?: string | null;
183
+ /**
184
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
185
+ *
186
+ * @default null
187
+ */
188
+ thumbnailField?: string | null;
177
189
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
178
190
  fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
179
191
  /**
@@ -197,6 +209,13 @@ interface components$5 {
197
209
  * @enum {string}
198
210
  */
199
211
  type?: "contentType" | "block";
212
+ /**
213
+ * @description if this content type uses team permissions or custom permissions
214
+ * @default true
215
+ */
216
+ useTeamPermissions?: boolean;
217
+ /** @description Custom role permissions for this content type */
218
+ permissions?: components$5["schemas"]["ComponentDefinitionPermission"][];
200
219
  };
201
220
  /** @description Defines an editable parameter on a component. */
202
221
  ComponentParameter: {
@@ -858,6 +877,12 @@ interface external$f {
858
877
  * @default null
859
878
  */
860
879
  titleParameter?: string | null;
880
+ /**
881
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
882
+ *
883
+ * @default null
884
+ */
885
+ thumbnailParameter?: string | null;
861
886
  /**
862
887
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
863
888
  * @default false
@@ -910,6 +935,12 @@ interface external$f {
910
935
  * The field type must support being used as an entry name for this to work.
911
936
  */
912
937
  entryName?: string | null;
938
+ /**
939
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
940
+ *
941
+ * @default null
942
+ */
943
+ thumbnailField?: string | null;
913
944
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
914
945
  fields?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
915
946
  /**
@@ -933,6 +964,13 @@ interface external$f {
933
964
  * @enum {string}
934
965
  */
935
966
  type?: "contentType" | "block";
967
+ /**
968
+ * @description if this content type uses team permissions or custom permissions
969
+ * @default true
970
+ */
971
+ useTeamPermissions?: boolean;
972
+ /** @description Custom role permissions for this content type */
973
+ permissions?: external$f["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
936
974
  };
937
975
  /** @description Defines an editable parameter on a component. */
938
976
  ComponentParameter: {
@@ -1403,6 +1441,8 @@ declare const SECRET_QUERY_STRING_PARAM = "secret";
1403
1441
  declare const IN_CONTEXT_EDITOR_QUERY_STRING_PARAM = "is_incontext_editing_mode";
1404
1442
  /** The name of the query string used to indicate that we want to use the playground for preview */
1405
1443
  declare const IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM = "is_incontext_editing_playground";
1444
+ /** The name of the query string used to detect if we are in contextual editing mode */
1445
+ declare const IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM = "is_incontext_editing_forced_settings";
1406
1446
  /** The name of the query string used to get the config from the preview url */
1407
1447
  declare const IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM = "is_config_check";
1408
1448
  /** The value of "data-role" in the component start `<script>` tag */
@@ -1670,6 +1710,12 @@ interface external$e {
1670
1710
  * @default null
1671
1711
  */
1672
1712
  titleParameter?: string | null;
1713
+ /**
1714
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
1715
+ *
1716
+ * @default null
1717
+ */
1718
+ thumbnailParameter?: string | null;
1673
1719
  /**
1674
1720
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
1675
1721
  * @default false
@@ -1722,6 +1768,12 @@ interface external$e {
1722
1768
  * The field type must support being used as an entry name for this to work.
1723
1769
  */
1724
1770
  entryName?: string | null;
1771
+ /**
1772
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
1773
+ *
1774
+ * @default null
1775
+ */
1776
+ thumbnailField?: string | null;
1725
1777
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
1726
1778
  fields?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1727
1779
  /**
@@ -1745,6 +1797,13 @@ interface external$e {
1745
1797
  * @enum {string}
1746
1798
  */
1747
1799
  type?: "contentType" | "block";
1800
+ /**
1801
+ * @description if this content type uses team permissions or custom permissions
1802
+ * @default true
1803
+ */
1804
+ useTeamPermissions?: boolean;
1805
+ /** @description Custom role permissions for this content type */
1806
+ permissions?: external$e["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
1748
1807
  };
1749
1808
  /** @description Defines an editable parameter on a component. */
1750
1809
  ComponentParameter: {
@@ -2418,6 +2477,12 @@ interface external$d {
2418
2477
  * @default null
2419
2478
  */
2420
2479
  titleParameter?: string | null;
2480
+ /**
2481
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
2482
+ *
2483
+ * @default null
2484
+ */
2485
+ thumbnailParameter?: string | null;
2421
2486
  /**
2422
2487
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
2423
2488
  * @default false
@@ -2470,6 +2535,12 @@ interface external$d {
2470
2535
  * The field type must support being used as an entry name for this to work.
2471
2536
  */
2472
2537
  entryName?: string | null;
2538
+ /**
2539
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
2540
+ *
2541
+ * @default null
2542
+ */
2543
+ thumbnailField?: string | null;
2473
2544
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
2474
2545
  fields?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2475
2546
  /**
@@ -2493,6 +2564,13 @@ interface external$d {
2493
2564
  * @enum {string}
2494
2565
  */
2495
2566
  type?: "contentType" | "block";
2567
+ /**
2568
+ * @description if this content type uses team permissions or custom permissions
2569
+ * @default true
2570
+ */
2571
+ useTeamPermissions?: boolean;
2572
+ /** @description Custom role permissions for this content type */
2573
+ permissions?: external$d["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
2496
2574
  };
2497
2575
  /** @description Defines an editable parameter on a component. */
2498
2576
  ComponentParameter: {
@@ -3090,7 +3168,7 @@ interface components$4 {
3090
3168
  schemas: {
3091
3169
  /** @description Defines the shape of the entry */
3092
3170
  Entry: {
3093
- /** @description Content type of the entry. */
3171
+ /** @description Content type public ID of the entry. */
3094
3172
  type: string;
3095
3173
  /**
3096
3174
  * Format: uuid
@@ -3498,6 +3576,12 @@ interface external$c {
3498
3576
  * @default null
3499
3577
  */
3500
3578
  titleParameter?: string | null;
3579
+ /**
3580
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
3581
+ *
3582
+ * @default null
3583
+ */
3584
+ thumbnailParameter?: string | null;
3501
3585
  /**
3502
3586
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
3503
3587
  * @default false
@@ -3550,6 +3634,12 @@ interface external$c {
3550
3634
  * The field type must support being used as an entry name for this to work.
3551
3635
  */
3552
3636
  entryName?: string | null;
3637
+ /**
3638
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
3639
+ *
3640
+ * @default null
3641
+ */
3642
+ thumbnailField?: string | null;
3553
3643
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
3554
3644
  fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
3555
3645
  /**
@@ -3573,6 +3663,13 @@ interface external$c {
3573
3663
  * @enum {string}
3574
3664
  */
3575
3665
  type?: "contentType" | "block";
3666
+ /**
3667
+ * @description if this content type uses team permissions or custom permissions
3668
+ * @default true
3669
+ */
3670
+ useTeamPermissions?: boolean;
3671
+ /** @description Custom role permissions for this content type */
3672
+ permissions?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
3576
3673
  };
3577
3674
  /** @description Defines an editable parameter on a component. */
3578
3675
  ComponentParameter: {
@@ -4178,6 +4275,12 @@ interface external$b {
4178
4275
  * @default null
4179
4276
  */
4180
4277
  titleParameter?: string | null;
4278
+ /**
4279
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
4280
+ *
4281
+ * @default null
4282
+ */
4283
+ thumbnailParameter?: string | null;
4181
4284
  /**
4182
4285
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
4183
4286
  * @default false
@@ -4230,6 +4333,12 @@ interface external$b {
4230
4333
  * The field type must support being used as an entry name for this to work.
4231
4334
  */
4232
4335
  entryName?: string | null;
4336
+ /**
4337
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
4338
+ *
4339
+ * @default null
4340
+ */
4341
+ thumbnailField?: string | null;
4233
4342
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
4234
4343
  fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
4235
4344
  /**
@@ -4253,6 +4362,13 @@ interface external$b {
4253
4362
  * @enum {string}
4254
4363
  */
4255
4364
  type?: "contentType" | "block";
4365
+ /**
4366
+ * @description if this content type uses team permissions or custom permissions
4367
+ * @default true
4368
+ */
4369
+ useTeamPermissions?: boolean;
4370
+ /** @description Custom role permissions for this content type */
4371
+ permissions?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
4256
4372
  };
4257
4373
  /** @description Defines an editable parameter on a component. */
4258
4374
  ComponentParameter: {
@@ -4917,6 +5033,12 @@ interface external$a {
4917
5033
  * @default null
4918
5034
  */
4919
5035
  titleParameter?: string | null;
5036
+ /**
5037
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
5038
+ *
5039
+ * @default null
5040
+ */
5041
+ thumbnailParameter?: string | null;
4920
5042
  /**
4921
5043
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
4922
5044
  * @default false
@@ -4969,6 +5091,12 @@ interface external$a {
4969
5091
  * The field type must support being used as an entry name for this to work.
4970
5092
  */
4971
5093
  entryName?: string | null;
5094
+ /**
5095
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
5096
+ *
5097
+ * @default null
5098
+ */
5099
+ thumbnailField?: string | null;
4972
5100
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
4973
5101
  fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
4974
5102
  /**
@@ -4992,6 +5120,13 @@ interface external$a {
4992
5120
  * @enum {string}
4993
5121
  */
4994
5122
  type?: "contentType" | "block";
5123
+ /**
5124
+ * @description if this content type uses team permissions or custom permissions
5125
+ * @default true
5126
+ */
5127
+ useTeamPermissions?: boolean;
5128
+ /** @description Custom role permissions for this content type */
5129
+ permissions?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
4995
5130
  };
4996
5131
  /** @description Defines an editable parameter on a component. */
4997
5132
  ComponentParameter: {
@@ -5593,6 +5728,12 @@ interface external$9 {
5593
5728
  * @default null
5594
5729
  */
5595
5730
  titleParameter?: string | null;
5731
+ /**
5732
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
5733
+ *
5734
+ * @default null
5735
+ */
5736
+ thumbnailParameter?: string | null;
5596
5737
  /**
5597
5738
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
5598
5739
  * @default false
@@ -5645,6 +5786,12 @@ interface external$9 {
5645
5786
  * The field type must support being used as an entry name for this to work.
5646
5787
  */
5647
5788
  entryName?: string | null;
5789
+ /**
5790
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
5791
+ *
5792
+ * @default null
5793
+ */
5794
+ thumbnailField?: string | null;
5648
5795
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
5649
5796
  fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
5650
5797
  /**
@@ -5668,6 +5815,13 @@ interface external$9 {
5668
5815
  * @enum {string}
5669
5816
  */
5670
5817
  type?: "contentType" | "block";
5818
+ /**
5819
+ * @description if this content type uses team permissions or custom permissions
5820
+ * @default true
5821
+ */
5822
+ useTeamPermissions?: boolean;
5823
+ /** @description Custom role permissions for this content type */
5824
+ permissions?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
5671
5825
  };
5672
5826
  /** @description Defines an editable parameter on a component. */
5673
5827
  ComponentParameter: {
@@ -6304,6 +6458,12 @@ interface external$8 {
6304
6458
  * @default null
6305
6459
  */
6306
6460
  titleParameter?: string | null;
6461
+ /**
6462
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
6463
+ *
6464
+ * @default null
6465
+ */
6466
+ thumbnailParameter?: string | null;
6307
6467
  /**
6308
6468
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
6309
6469
  * @default false
@@ -6356,6 +6516,12 @@ interface external$8 {
6356
6516
  * The field type must support being used as an entry name for this to work.
6357
6517
  */
6358
6518
  entryName?: string | null;
6519
+ /**
6520
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
6521
+ *
6522
+ * @default null
6523
+ */
6524
+ thumbnailField?: string | null;
6359
6525
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
6360
6526
  fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
6361
6527
  /**
@@ -6379,6 +6545,13 @@ interface external$8 {
6379
6545
  * @enum {string}
6380
6546
  */
6381
6547
  type?: "contentType" | "block";
6548
+ /**
6549
+ * @description if this content type uses team permissions or custom permissions
6550
+ * @default true
6551
+ */
6552
+ useTeamPermissions?: boolean;
6553
+ /** @description Custom role permissions for this content type */
6554
+ permissions?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
6382
6555
  };
6383
6556
  /** @description Defines an editable parameter on a component. */
6384
6557
  ComponentParameter: {
@@ -7015,6 +7188,12 @@ interface external$7 {
7015
7188
  * @default null
7016
7189
  */
7017
7190
  titleParameter?: string | null;
7191
+ /**
7192
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
7193
+ *
7194
+ * @default null
7195
+ */
7196
+ thumbnailParameter?: string | null;
7018
7197
  /**
7019
7198
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
7020
7199
  * @default false
@@ -7067,6 +7246,12 @@ interface external$7 {
7067
7246
  * The field type must support being used as an entry name for this to work.
7068
7247
  */
7069
7248
  entryName?: string | null;
7249
+ /**
7250
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
7251
+ *
7252
+ * @default null
7253
+ */
7254
+ thumbnailField?: string | null;
7070
7255
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
7071
7256
  fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
7072
7257
  /**
@@ -7090,6 +7275,13 @@ interface external$7 {
7090
7275
  * @enum {string}
7091
7276
  */
7092
7277
  type?: "contentType" | "block";
7278
+ /**
7279
+ * @description if this content type uses team permissions or custom permissions
7280
+ * @default true
7281
+ */
7282
+ useTeamPermissions?: boolean;
7283
+ /** @description Custom role permissions for this content type */
7284
+ permissions?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
7093
7285
  };
7094
7286
  /** @description Defines an editable parameter on a component. */
7095
7287
  ComponentParameter: {
@@ -8350,6 +8542,12 @@ interface external$5 {
8350
8542
  * @default null
8351
8543
  */
8352
8544
  titleParameter?: string | null;
8545
+ /**
8546
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
8547
+ *
8548
+ * @default null
8549
+ */
8550
+ thumbnailParameter?: string | null;
8353
8551
  /**
8354
8552
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
8355
8553
  * @default false
@@ -8402,6 +8600,12 @@ interface external$5 {
8402
8600
  * The field type must support being used as an entry name for this to work.
8403
8601
  */
8404
8602
  entryName?: string | null;
8603
+ /**
8604
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
8605
+ *
8606
+ * @default null
8607
+ */
8608
+ thumbnailField?: string | null;
8405
8609
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
8406
8610
  fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
8407
8611
  /**
@@ -8425,6 +8629,13 @@ interface external$5 {
8425
8629
  * @enum {string}
8426
8630
  */
8427
8631
  type?: "contentType" | "block";
8632
+ /**
8633
+ * @description if this content type uses team permissions or custom permissions
8634
+ * @default true
8635
+ */
8636
+ useTeamPermissions?: boolean;
8637
+ /** @description Custom role permissions for this content type */
8638
+ permissions?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
8428
8639
  };
8429
8640
  /** @description Defines an editable parameter on a component. */
8430
8641
  ComponentParameter: {
@@ -9030,6 +9241,12 @@ interface external$4 {
9030
9241
  * @default null
9031
9242
  */
9032
9243
  titleParameter?: string | null;
9244
+ /**
9245
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
9246
+ *
9247
+ * @default null
9248
+ */
9249
+ thumbnailParameter?: string | null;
9033
9250
  /**
9034
9251
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
9035
9252
  * @default false
@@ -9082,6 +9299,12 @@ interface external$4 {
9082
9299
  * The field type must support being used as an entry name for this to work.
9083
9300
  */
9084
9301
  entryName?: string | null;
9302
+ /**
9303
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
9304
+ *
9305
+ * @default null
9306
+ */
9307
+ thumbnailField?: string | null;
9085
9308
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
9086
9309
  fields?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
9087
9310
  /**
@@ -9105,6 +9328,13 @@ interface external$4 {
9105
9328
  * @enum {string}
9106
9329
  */
9107
9330
  type?: "contentType" | "block";
9331
+ /**
9332
+ * @description if this content type uses team permissions or custom permissions
9333
+ * @default true
9334
+ */
9335
+ useTeamPermissions?: boolean;
9336
+ /** @description Custom role permissions for this content type */
9337
+ permissions?: external$4["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
9108
9338
  };
9109
9339
  /** @description Defines an editable parameter on a component. */
9110
9340
  ComponentParameter: {
@@ -9838,6 +10068,12 @@ interface external$3 {
9838
10068
  * @default null
9839
10069
  */
9840
10070
  titleParameter?: string | null;
10071
+ /**
10072
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
10073
+ *
10074
+ * @default null
10075
+ */
10076
+ thumbnailParameter?: string | null;
9841
10077
  /**
9842
10078
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
9843
10079
  * @default false
@@ -9890,6 +10126,12 @@ interface external$3 {
9890
10126
  * The field type must support being used as an entry name for this to work.
9891
10127
  */
9892
10128
  entryName?: string | null;
10129
+ /**
10130
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
10131
+ *
10132
+ * @default null
10133
+ */
10134
+ thumbnailField?: string | null;
9893
10135
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
9894
10136
  fields?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
9895
10137
  /**
@@ -9913,6 +10155,13 @@ interface external$3 {
9913
10155
  * @enum {string}
9914
10156
  */
9915
10157
  type?: "contentType" | "block";
10158
+ /**
10159
+ * @description if this content type uses team permissions or custom permissions
10160
+ * @default true
10161
+ */
10162
+ useTeamPermissions?: boolean;
10163
+ /** @description Custom role permissions for this content type */
10164
+ permissions?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
9916
10165
  };
9917
10166
  /** @description Defines an editable parameter on a component. */
9918
10167
  ComponentParameter: {
@@ -11004,7 +11253,7 @@ interface external$3 {
11004
11253
  schemas: {
11005
11254
  /** @description Defines the shape of the entry */
11006
11255
  Entry: {
11007
- /** @description Content type of the entry. */
11256
+ /** @description Content type public ID of the entry. */
11008
11257
  type: string;
11009
11258
  /**
11010
11259
  * Format: uuid
@@ -11969,6 +12218,12 @@ interface external$2 {
11969
12218
  * @default null
11970
12219
  */
11971
12220
  titleParameter?: string | null;
12221
+ /**
12222
+ * @description The public ID of the parameter whose value should be used as a thumbnail for compositions of this component in the UI.
12223
+ *
12224
+ * @default null
12225
+ */
12226
+ thumbnailParameter?: string | null;
11972
12227
  /**
11973
12228
  * @description Whether this component type can be the root of a composition. If false, this component is only used within slots on other components.
11974
12229
  * @default false
@@ -12021,6 +12276,12 @@ interface external$2 {
12021
12276
  * The field type must support being used as an entry name for this to work.
12022
12277
  */
12023
12278
  entryName?: string | null;
12279
+ /**
12280
+ * @description The public ID of the field whose value should be used as a thumbnail for entries of this content type in the UI.
12281
+ *
12282
+ * @default null
12283
+ */
12284
+ thumbnailField?: string | null;
12024
12285
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
12025
12286
  fields?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
12026
12287
  /**
@@ -12044,6 +12305,13 @@ interface external$2 {
12044
12305
  * @enum {string}
12045
12306
  */
12046
12307
  type?: "contentType" | "block";
12308
+ /**
12309
+ * @description if this content type uses team permissions or custom permissions
12310
+ * @default true
12311
+ */
12312
+ useTeamPermissions?: boolean;
12313
+ /** @description Custom role permissions for this content type */
12314
+ permissions?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionPermission"][];
12047
12315
  };
12048
12316
  /** @description Defines an editable parameter on a component. */
12049
12317
  ComponentParameter: {
@@ -13396,6 +13664,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
13396
13664
  name: string;
13397
13665
  icon?: string | undefined;
13398
13666
  titleParameter?: string | null | undefined;
13667
+ thumbnailParameter?: string | null | undefined;
13399
13668
  canBeComposition?: boolean | undefined;
13400
13669
  parameters?: {
13401
13670
  id: string;
@@ -13535,7 +13804,12 @@ declare class UncachedCategoryClient extends CategoryClient {
13535
13804
  }
13536
13805
 
13537
13806
  type PreviewPanelSettings = {
13538
- isInteractive: boolean;
13807
+ /**
13808
+ * @deprecated To be deleted with the cleanup of the `canvas-preview-mode` feature flag.
13809
+ * use `isVisualEditingDisabled` instead.
13810
+ */
13811
+ isInteractive?: boolean;
13812
+ isVisualEditingDisabled?: boolean;
13539
13813
  };
13540
13814
  type ContextualEditingComponentReference = {
13541
13815
  id: string;
@@ -15081,4 +15355,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
15081
15355
 
15082
15356
  declare const CanvasClientError: typeof ApiClientError;
15083
15357
 
15084
- export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type ReportRenderedCompositionsMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };
15358
+ export { ASSETS_SOURCE_CUSTOM_URL, ASSETS_SOURCE_UNIFORM, ASSET_PARAMETER_TYPE, ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, type AddComponentMessage, type AssetParamValue, type AssetParamValueItem, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, type ChannelSubscription, ChildEnhancerBuilder, type ComponentDefinition, type ComponentDefinitionDeleteParameters, type ComponentDefinitionGetParameters, type ComponentDefinitionGetResponse, type ComponentDefinitionParameter, type ComponentDefinitionPermission, type ComponentDefinitionPutParameters, type ComponentDefinitionSlot, type ComponentDefinitionSlugSettings, type ComponentDefinitionVariant, type ComponentEnhancer, type ComponentEnhancerFunction, type ComponentEnhancerOptions, type ComponentInstance, type ComponentInstanceContextualEditing, type ComponentInstanceHistoryEntry, type ComponentInstanceHistoryGetParameters, type ComponentInstanceHistoryGetResponse, type ComponentLocationReference, type ComponentLocationReferenceV2, type ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDataDiagnostic, type CompositionDeleteParameters, type CompositionDiagnostics, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetOrderBy, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionIssue, type CompositionPatternIssue, type CompositionPutParameters, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, ContentClient, type ContentType, type ContentTypeField, type ContextualEditingComponentReference, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataResolutionConfigIssue, type DataResolutionIssue, type DataResolutionOption, type DataResolutionOptionNegative, type DataResolutionOptionPositive, type DataResolutionParameters, type DataResourceDefinition, type DataResourceDefinitions, type DataResourceIssue, type DataResourceVariables, type DataSource, DataSourceClient, type DataSourceDeleteParameters, type DataSourceGetParameters, type DataSourceGetResponse, type DataSourcePutParameters, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DeleteContentTypeOptions, type DeleteEntryOptions, type DismissPlaceholderMessage, type DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_MAX_CACHE_TTL, EDGE_MIN_CACHE_TTL, EMPTY_COMPOSITION, type EdgehancersDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, type EntryList, type EventNames, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEntriesOptions, type GetEntriesResponse, type GetParameterAttributesProps, IN_CONTEXT_EDITOR_COMPONENT_END_ROLE, IN_CONTEXT_EDITOR_COMPONENT_START_ROLE, IN_CONTEXT_EDITOR_CONFIG_CHECK_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_EMBED_SCRIPT_ID, IN_CONTEXT_EDITOR_FORCED_SETTINGS_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_PLAYGROUND_QUERY_STRING_PARAM, IN_CONTEXT_EDITOR_QUERY_STRING_PARAM, IS_RENDERED_BY_UNIFORM_ATTRIBUTE, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type LimitPolicy, type LinkComponentParameterValue, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeDeprecatedOptions, type LocalizeModernOptions, type MessageHandler, type MoveComponentMessage, type NodeLocationReference, type NonProjectMapLinkParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type PatternIssue, type PreviewEventBus, type PreviewPanelSettings, type ProjectMapLinkComponentParameterValue, type ProjectMapLinkParamValue, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PutContentTypeBody, type PutEntryBody, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type ReportRenderedCompositionsMessage, type ResolvedRouteGetResponse, type RichTextBuiltInElement, type RichTextBuiltInFormat, type RichTextParamConfiguration, type RichTextParamValue, type RootComponentInstance, type RootEntryReference, type RootLocationReference, RouteClient, type RouteDynamicInputs, type RouteGetParameters, type RouteGetResponse, type RouteGetResponseComposition, type RouteGetResponseEdgehancedComposition, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, type SelectComponentMessage, type SelectParameterMessage, type SpecificProjectMap, type SubscribeToCompositionOptions, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, type UnsubscribeCallback, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type WalkComponentTreeActions, type WalkNodeTreeActions, type WalkNodeTreeOptions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getChannelName, getComponentJsonPointer, getComponentPath, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, getPropertyValue, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isEntryData, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, walkComponentTree, walkNodeTree };