@uniformdev/canvas 19.51.1-alpha.10 → 19.51.1-alpha.26

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.ts CHANGED
@@ -171,25 +171,20 @@ interface components$5 {
171
171
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
172
172
  fields?: components$5["schemas"]["ComponentDefinitionParameter"][];
173
173
  /**
174
- * Format: uuid
175
- * @description Reference to the category this component definition belongs to
176
- * @default null
177
- */
178
- categoryId?: string | null;
179
- /**
180
- * @description Description of the component definition
174
+ * @description Description of the content type
181
175
  * @default null
182
176
  */
183
177
  description?: string;
184
178
  /**
185
- * @description Description of the component definition
186
- * @default null
179
+ * @description Icon name for the content type (e.g. 'screen')
180
+ * @default file-document
187
181
  */
188
- previewImageUrl?: string;
182
+ icon?: string;
189
183
  /** @description Created date string for this content type (ignored for writes) */
190
184
  created?: string;
191
185
  /** @description Last modified date string for this content type (ignored for writes) */
192
186
  updated?: string;
187
+ slugSettings?: components$5["schemas"]["ComponentDefinitionSlugSettings"];
193
188
  };
194
189
  /** @description Defines an editable parameter on a component. */
195
190
  ComponentParameter: {
@@ -837,25 +832,20 @@ interface external$c {
837
832
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
838
833
  fields?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
839
834
  /**
840
- * Format: uuid
841
- * @description Reference to the category this component definition belongs to
842
- * @default null
843
- */
844
- categoryId?: string | null;
845
- /**
846
- * @description Description of the component definition
835
+ * @description Description of the content type
847
836
  * @default null
848
837
  */
849
838
  description?: string;
850
839
  /**
851
- * @description Description of the component definition
852
- * @default null
840
+ * @description Icon name for the content type (e.g. 'screen')
841
+ * @default file-document
853
842
  */
854
- previewImageUrl?: string;
843
+ icon?: string;
855
844
  /** @description Created date string for this content type (ignored for writes) */
856
845
  created?: string;
857
846
  /** @description Last modified date string for this content type (ignored for writes) */
858
847
  updated?: string;
848
+ slugSettings?: external$c["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
859
849
  };
860
850
  /** @description Defines an editable parameter on a component. */
861
851
  ComponentParameter: {
@@ -1504,25 +1494,20 @@ interface external$b {
1504
1494
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
1505
1495
  fields?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
1506
1496
  /**
1507
- * Format: uuid
1508
- * @description Reference to the category this component definition belongs to
1509
- * @default null
1510
- */
1511
- categoryId?: string | null;
1512
- /**
1513
- * @description Description of the component definition
1497
+ * @description Description of the content type
1514
1498
  * @default null
1515
1499
  */
1516
1500
  description?: string;
1517
1501
  /**
1518
- * @description Description of the component definition
1519
- * @default null
1502
+ * @description Icon name for the content type (e.g. 'screen')
1503
+ * @default file-document
1520
1504
  */
1521
- previewImageUrl?: string;
1505
+ icon?: string;
1522
1506
  /** @description Created date string for this content type (ignored for writes) */
1523
1507
  created?: string;
1524
1508
  /** @description Last modified date string for this content type (ignored for writes) */
1525
1509
  updated?: string;
1510
+ slugSettings?: external$b["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
1526
1511
  };
1527
1512
  /** @description Defines an editable parameter on a component. */
1528
1513
  ComponentParameter: {
@@ -2180,25 +2165,20 @@ interface external$a {
2180
2165
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
2181
2166
  fields?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2182
2167
  /**
2183
- * Format: uuid
2184
- * @description Reference to the category this component definition belongs to
2185
- * @default null
2186
- */
2187
- categoryId?: string | null;
2188
- /**
2189
- * @description Description of the component definition
2168
+ * @description Description of the content type
2190
2169
  * @default null
2191
2170
  */
2192
2171
  description?: string;
2193
2172
  /**
2194
- * @description Description of the component definition
2195
- * @default null
2173
+ * @description Icon name for the content type (e.g. 'screen')
2174
+ * @default file-document
2196
2175
  */
2197
- previewImageUrl?: string;
2176
+ icon?: string;
2198
2177
  /** @description Created date string for this content type (ignored for writes) */
2199
2178
  created?: string;
2200
2179
  /** @description Last modified date string for this content type (ignored for writes) */
2201
2180
  updated?: string;
2181
+ slugSettings?: external$a["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
2202
2182
  };
2203
2183
  /** @description Defines an editable parameter on a component. */
2204
2184
  ComponentParameter: {
@@ -2550,8 +2530,10 @@ interface paths$8 {
2550
2530
  get: {
2551
2531
  parameters: {
2552
2532
  query: {
2553
- /** Specify multiple entry IDs to fetch. Response type will be a list. */
2533
+ /** Specify multiple entry IDs to fetch. */
2554
2534
  entryIDs?: components$4["parameters"]["entryIDs"];
2535
+ /** Specify a single entry to fetch by slug. */
2536
+ slug?: components$4["parameters"]["slug"];
2555
2537
  /** Filters entry lists by the user who created them. The user is specified by their identity subject. */
2556
2538
  createdBy?: components$4["parameters"]["createdBy"];
2557
2539
  /** Max number of records to return */
@@ -2687,7 +2669,7 @@ interface components$4 {
2687
2669
  _id: string;
2688
2670
  /** @description The name of the entry. */
2689
2671
  _name?: string;
2690
- /** @description The slug of the entry, automatically generated. */
2672
+ /** @description The slug of the entry. */
2691
2673
  _slug?: string;
2692
2674
  /** @description Name of the author of the most recent change. */
2693
2675
  _author?: string;
@@ -2706,6 +2688,8 @@ interface components$4 {
2706
2688
  * @description The public UUID of the entry.
2707
2689
  */
2708
2690
  _id?: string;
2691
+ /** @description The slug of the entry. */
2692
+ _slug?: string;
2709
2693
  /** @description Entry field values. */
2710
2694
  fields?: {
2711
2695
  [key: string]: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
@@ -2747,8 +2731,10 @@ interface components$4 {
2747
2731
  parameters: {
2748
2732
  /** @description The project the entry/entries are on. */
2749
2733
  projectId: string;
2750
- /** @description Specify multiple entry IDs to fetch. Response type will be a list. */
2734
+ /** @description Specify multiple entry IDs to fetch. */
2751
2735
  entryIDs: string[];
2736
+ /** @description Specify a single entry to fetch by slug. */
2737
+ slug: string;
2752
2738
  /** @description The content type ID to filter by. */
2753
2739
  type: string[];
2754
2740
  /** @description Publishing state to fetch. 0 = draft, 64 = published. */
@@ -2992,25 +2978,20 @@ interface external$9 {
2992
2978
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
2993
2979
  fields?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
2994
2980
  /**
2995
- * Format: uuid
2996
- * @description Reference to the category this component definition belongs to
2997
- * @default null
2998
- */
2999
- categoryId?: string | null;
3000
- /**
3001
- * @description Description of the component definition
2981
+ * @description Description of the content type
3002
2982
  * @default null
3003
2983
  */
3004
2984
  description?: string;
3005
2985
  /**
3006
- * @description Description of the component definition
3007
- * @default null
2986
+ * @description Icon name for the content type (e.g. 'screen')
2987
+ * @default file-document
3008
2988
  */
3009
- previewImageUrl?: string;
2989
+ icon?: string;
3010
2990
  /** @description Created date string for this content type (ignored for writes) */
3011
2991
  created?: string;
3012
2992
  /** @description Last modified date string for this content type (ignored for writes) */
3013
2993
  updated?: string;
2994
+ slugSettings?: external$9["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
3014
2995
  };
3015
2996
  /** @description Defines an editable parameter on a component. */
3016
2997
  ComponentParameter: {
@@ -3654,25 +3635,20 @@ interface external$8 {
3654
3635
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
3655
3636
  fields?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
3656
3637
  /**
3657
- * Format: uuid
3658
- * @description Reference to the category this component definition belongs to
3659
- * @default null
3660
- */
3661
- categoryId?: string | null;
3662
- /**
3663
- * @description Description of the component definition
3638
+ * @description Description of the content type
3664
3639
  * @default null
3665
3640
  */
3666
3641
  description?: string;
3667
3642
  /**
3668
- * @description Description of the component definition
3669
- * @default null
3643
+ * @description Icon name for the content type (e.g. 'screen')
3644
+ * @default file-document
3670
3645
  */
3671
- previewImageUrl?: string;
3646
+ icon?: string;
3672
3647
  /** @description Created date string for this content type (ignored for writes) */
3673
3648
  created?: string;
3674
3649
  /** @description Last modified date string for this content type (ignored for writes) */
3675
3650
  updated?: string;
3651
+ slugSettings?: external$8["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
3676
3652
  };
3677
3653
  /** @description Defines an editable parameter on a component. */
3678
3654
  ComponentParameter: {
@@ -4260,25 +4236,20 @@ interface external$7 {
4260
4236
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
4261
4237
  fields?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
4262
4238
  /**
4263
- * Format: uuid
4264
- * @description Reference to the category this component definition belongs to
4265
- * @default null
4266
- */
4267
- categoryId?: string | null;
4268
- /**
4269
- * @description Description of the component definition
4239
+ * @description Description of the content type
4270
4240
  * @default null
4271
4241
  */
4272
4242
  description?: string;
4273
4243
  /**
4274
- * @description Description of the component definition
4275
- * @default null
4244
+ * @description Icon name for the content type (e.g. 'screen')
4245
+ * @default file-document
4276
4246
  */
4277
- previewImageUrl?: string;
4247
+ icon?: string;
4278
4248
  /** @description Created date string for this content type (ignored for writes) */
4279
4249
  created?: string;
4280
4250
  /** @description Last modified date string for this content type (ignored for writes) */
4281
4251
  updated?: string;
4252
+ slugSettings?: external$7["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
4282
4253
  };
4283
4254
  /** @description Defines an editable parameter on a component. */
4284
4255
  ComponentParameter: {
@@ -4901,25 +4872,20 @@ interface external$6 {
4901
4872
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
4902
4873
  fields?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
4903
4874
  /**
4904
- * Format: uuid
4905
- * @description Reference to the category this component definition belongs to
4906
- * @default null
4907
- */
4908
- categoryId?: string | null;
4909
- /**
4910
- * @description Description of the component definition
4875
+ * @description Description of the content type
4911
4876
  * @default null
4912
4877
  */
4913
4878
  description?: string;
4914
4879
  /**
4915
- * @description Description of the component definition
4916
- * @default null
4880
+ * @description Icon name for the content type (e.g. 'screen')
4881
+ * @default file-document
4917
4882
  */
4918
- previewImageUrl?: string;
4883
+ icon?: string;
4919
4884
  /** @description Created date string for this content type (ignored for writes) */
4920
4885
  created?: string;
4921
4886
  /** @description Last modified date string for this content type (ignored for writes) */
4922
4887
  updated?: string;
4888
+ slugSettings?: external$6["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
4923
4889
  };
4924
4890
  /** @description Defines an editable parameter on a component. */
4925
4891
  ComponentParameter: {
@@ -5971,25 +5937,20 @@ interface external$5 {
5971
5937
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
5972
5938
  fields?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
5973
5939
  /**
5974
- * Format: uuid
5975
- * @description Reference to the category this component definition belongs to
5976
- * @default null
5977
- */
5978
- categoryId?: string | null;
5979
- /**
5980
- * @description Description of the component definition
5940
+ * @description Description of the content type
5981
5941
  * @default null
5982
5942
  */
5983
5943
  description?: string;
5984
5944
  /**
5985
- * @description Description of the component definition
5986
- * @default null
5945
+ * @description Icon name for the content type (e.g. 'screen')
5946
+ * @default file-document
5987
5947
  */
5988
- previewImageUrl?: string;
5948
+ icon?: string;
5989
5949
  /** @description Created date string for this content type (ignored for writes) */
5990
5950
  created?: string;
5991
5951
  /** @description Last modified date string for this content type (ignored for writes) */
5992
5952
  updated?: string;
5953
+ slugSettings?: external$5["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
5993
5954
  };
5994
5955
  /** @description Defines an editable parameter on a component. */
5995
5956
  ComponentParameter: {
@@ -6446,24 +6407,37 @@ interface components$1 {
6446
6407
  schemas: {
6447
6408
  CompositionResolvedGetResponse: components$1["schemas"]["EdgehancersResolutionInfo"] & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionApiResponse"];
6448
6409
  CompositionResolvedListResponse: {
6449
- diagnostics?: components$1["schemas"]["CompositionDiagnostics"] & {
6410
+ diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
6450
6411
  data?: {
6451
6412
  [key: string]: components$1["schemas"]["DataDiagnostic"][];
6452
6413
  };
6453
6414
  };
6454
6415
  errors?: {
6455
- [key: string]: components$1["schemas"]["CompositionIssue"][];
6416
+ [key: string]: components$1["schemas"]["DataResolutionIssue"][];
6456
6417
  };
6457
6418
  warnings?: {
6458
- [key: string]: components$1["schemas"]["CompositionIssue"][];
6419
+ [key: string]: components$1["schemas"]["DataResolutionIssue"][];
6459
6420
  };
6460
6421
  } & external$3["../../../lambda/functions/v1-canvas.swagger.yml"]["components"]["schemas"]["CompositionListResponse"];
6422
+ EntryResolvedListResponse: {
6423
+ diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
6424
+ data?: {
6425
+ [key: string]: components$1["schemas"]["DataDiagnostic"][];
6426
+ };
6427
+ };
6428
+ errors?: {
6429
+ [key: string]: components$1["schemas"]["DataResolutionIssue"][];
6430
+ };
6431
+ warnings?: {
6432
+ [key: string]: components$1["schemas"]["DataResolutionIssue"][];
6433
+ };
6434
+ } & external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
6461
6435
  EdgehancersResolutionInfo: {
6462
- diagnostics?: components$1["schemas"]["CompositionDiagnostics"] & {
6436
+ diagnostics?: components$1["schemas"]["EdgehancersDiagnostics"] & {
6463
6437
  [key: string]: unknown;
6464
6438
  };
6465
- errors?: components$1["schemas"]["CompositionIssue"][];
6466
- warnings?: components$1["schemas"]["CompositionIssue"][];
6439
+ errors?: components$1["schemas"]["DataResolutionIssue"][];
6440
+ warnings?: components$1["schemas"]["DataResolutionIssue"][];
6467
6441
  };
6468
6442
  EdgehancersError: {
6469
6443
  message: string;
@@ -6502,36 +6476,36 @@ interface components$1 {
6502
6476
  /**
6503
6477
  * @description Diagnostic information about request processing, including origin/config/data
6504
6478
  * * timings, edge locations, cache statuses and raw data.
6505
- * * Only set when diagnostics=true is passed to the options.
6479
+ * * Only present when diagnostics=true is passed to the options.
6506
6480
  */
6507
- CompositionDiagnostics: {
6481
+ EdgehancersDiagnostics: {
6508
6482
  /** @description Edge location where the request was processed */
6509
6483
  edgeLocation?: string;
6510
- compositionFetch?: {
6511
- /** @description How long it took to fetch the composition (ms) */
6484
+ originFetch?: {
6485
+ /** @description How long it took to fetch from the origin (ms) */
6512
6486
  duration: number;
6513
- /** @description Indicates if the composition was fetched from the cache */
6487
+ /** @description Indicates if the origin response was cached */
6514
6488
  cacheHit: boolean;
6515
- /** @description Indicates if the request results in a valid composition */
6516
- hasValidComposition: boolean;
6489
+ /** @description Indicates if the request results in a valid response */
6490
+ isValid: boolean;
6517
6491
  /**
6518
- * @description Cache from which the composition was resolved
6492
+ * @description Source cache used
6519
6493
  * @enum {string}
6520
6494
  */
6521
6495
  sourceCache?: "edge-cdn-cache" | "long-term-cache" | "api-cache";
6522
6496
  /** @description Edge cache location used */
6523
6497
  cacheLocation?: string;
6524
- /** @description Uniform-specifc request identifiers */
6498
+ /** @description Uniform-specifc request identifier */
6525
6499
  requestId?: string;
6526
6500
  };
6527
6501
  configRetrieval?: {
6528
- /** @description How long it took to retrieve the config (ms, in parallel to composition fetch) */
6502
+ /** @description How long it took to retrieve the config (ms, in parallel to origin fetch) */
6529
6503
  duration: number;
6530
6504
  /** @description How many data type configs were retrieved */
6531
6505
  dataTypeCount: number;
6532
6506
  };
6533
6507
  };
6534
- CompositionIssue: {
6508
+ DataResolutionIssue: {
6535
6509
  componentPath?: string;
6536
6510
  componentType?: string;
6537
6511
  message: string;
@@ -6805,25 +6779,20 @@ interface external$3 {
6805
6779
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
6806
6780
  fields?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
6807
6781
  /**
6808
- * Format: uuid
6809
- * @description Reference to the category this component definition belongs to
6810
- * @default null
6811
- */
6812
- categoryId?: string | null;
6813
- /**
6814
- * @description Description of the component definition
6782
+ * @description Description of the content type
6815
6783
  * @default null
6816
6784
  */
6817
6785
  description?: string;
6818
6786
  /**
6819
- * @description Description of the component definition
6820
- * @default null
6787
+ * @description Icon name for the content type (e.g. 'screen')
6788
+ * @default file-document
6821
6789
  */
6822
- previewImageUrl?: string;
6790
+ icon?: string;
6823
6791
  /** @description Created date string for this content type (ignored for writes) */
6824
6792
  created?: string;
6825
6793
  /** @description Last modified date string for this content type (ignored for writes) */
6826
6794
  updated?: string;
6795
+ slugSettings?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
6827
6796
  };
6828
6797
  /** @description Defines an editable parameter on a component. */
6829
6798
  ComponentParameter: {
@@ -7635,6 +7604,252 @@ interface external$3 {
7635
7604
  };
7636
7605
  operations: {};
7637
7606
  };
7607
+ "../../../lambda/functions/v1-entries.swagger.yml": {
7608
+ paths: {
7609
+ "/api/v1/entries": {
7610
+ get: {
7611
+ parameters: {
7612
+ query: {
7613
+ /** Specify multiple entry IDs to fetch. */
7614
+ entryIDs?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["entryIDs"];
7615
+ /** Specify a single entry to fetch by slug. */
7616
+ slug?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["slug"];
7617
+ /** Filters entry lists by the user who created them. The user is specified by their identity subject. */
7618
+ createdBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["createdBy"];
7619
+ /** Max number of records to return */
7620
+ limit?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["limit"];
7621
+ /** Number of records to skip */
7622
+ offset?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["offset"];
7623
+ /** Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
7624
+ orderBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["orderBy"];
7625
+ /** The project the entry/entries are on. */
7626
+ projectId: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["projectId"];
7627
+ /** Publishing state to fetch. 0 = draft, 64 = published. */
7628
+ state?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["state"];
7629
+ /** The content type ID to filter by. */
7630
+ type?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["type"];
7631
+ /**
7632
+ * @deprecated Filters entries lists by the UI status of the entry.
7633
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
7634
+ */
7635
+ uiStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["uiStatus"];
7636
+ /** Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
7637
+ updatedBy?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["updatedBy"];
7638
+ /**
7639
+ * Controls whether the total count of results will be returned along with the current results page in a list.
7640
+ * Has no effect when not fetching a list. This does impact performance when enabled.
7641
+ */
7642
+ withTotalCount?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withTotalCount"];
7643
+ /**
7644
+ * @deprecated Returns the UI status string of the entry.
7645
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
7646
+ */
7647
+ withUIStatus?: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["parameters"]["withUIStatus"];
7648
+ };
7649
+ };
7650
+ responses: {
7651
+ /** OK */
7652
+ 200: {
7653
+ content: {
7654
+ "application/json": external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryListResponse"];
7655
+ };
7656
+ };
7657
+ 400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
7658
+ 401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
7659
+ 403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
7660
+ /** Entry not found */
7661
+ 404: {
7662
+ content: {
7663
+ "text/plain": string;
7664
+ };
7665
+ };
7666
+ 429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
7667
+ 500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
7668
+ };
7669
+ };
7670
+ /** Upserts an entry */
7671
+ put: {
7672
+ responses: {
7673
+ /** OK */
7674
+ 204: never;
7675
+ 400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
7676
+ 401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
7677
+ 403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
7678
+ 429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
7679
+ 500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
7680
+ };
7681
+ requestBody: {
7682
+ content: {
7683
+ "application/json": {
7684
+ /**
7685
+ * Format: uuid
7686
+ * @description The project ID to upsert the entry to
7687
+ */
7688
+ projectId: string;
7689
+ /** @description The publishing state to upsert into. 0 = draft, 64 = published */
7690
+ state: number;
7691
+ entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryInput"];
7692
+ /** @description Ignored if present */
7693
+ created?: string;
7694
+ /** @description Ignored if present */
7695
+ modified?: string;
7696
+ };
7697
+ };
7698
+ };
7699
+ };
7700
+ /** Deletes or unpublishes an entry */
7701
+ delete: {
7702
+ responses: {
7703
+ /** OK */
7704
+ 204: never;
7705
+ 400: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["BadRequestError"];
7706
+ 401: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["UnauthorizedError"];
7707
+ 403: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["ForbiddenError"];
7708
+ 429: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["RateLimitError"];
7709
+ 500: external$3["../../../lambda/functions/swagger.yml"]["components"]["responses"]["InternalServerError"];
7710
+ };
7711
+ requestBody: {
7712
+ content: {
7713
+ "application/json": {
7714
+ /**
7715
+ * Format: uuid
7716
+ * @description The ID of the entry to delete
7717
+ */
7718
+ entryId: string;
7719
+ /**
7720
+ * Format: uuid
7721
+ * @description The ID of the project the entry to delete belongs to
7722
+ */
7723
+ projectId: string;
7724
+ /** @description The state to delete (0 = draft, 64 = published [causes unpublishing], unspecified = all) */
7725
+ state?: number;
7726
+ };
7727
+ };
7728
+ };
7729
+ };
7730
+ /** Handles preflight requests. This endpoint allows CORS. */
7731
+ options: {
7732
+ responses: {
7733
+ /** OK */
7734
+ 204: never;
7735
+ };
7736
+ };
7737
+ };
7738
+ };
7739
+ components: {
7740
+ schemas: {
7741
+ /** @description Defines the shape of the entry */
7742
+ Entry: {
7743
+ /** @description Content type of the entry. */
7744
+ type: string;
7745
+ /**
7746
+ * Format: uuid
7747
+ * @description The public UUID of the entry.
7748
+ */
7749
+ _id: string;
7750
+ /** @description The name of the entry. */
7751
+ _name?: string;
7752
+ /** @description The slug of the entry. */
7753
+ _slug?: string;
7754
+ /** @description Name of the author of the most recent change. */
7755
+ _author?: string;
7756
+ /** @description Entry field values. */
7757
+ fields?: {
7758
+ [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
7759
+ };
7760
+ _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
7761
+ };
7762
+ /** @description Defines the shape of the entry input */
7763
+ EntryInput: {
7764
+ /** @description Content type of the entry. */
7765
+ type: string;
7766
+ /**
7767
+ * Format: uuid
7768
+ * @description The public UUID of the entry.
7769
+ */
7770
+ _id?: string;
7771
+ /** @description The slug of the entry. */
7772
+ _slug?: string;
7773
+ /** @description Entry field values. */
7774
+ fields?: {
7775
+ [key: string]: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentParameter"];
7776
+ };
7777
+ _dataResources?: external$3["../../../lambda/functions/uniform-canvas-types.swagger.yml"]["components"]["schemas"]["DataResourceDefinitions"];
7778
+ };
7779
+ EntryApiResponse: {
7780
+ /** @description Publishing state to fetch. 0 = draft, 64 = published. */
7781
+ state: number;
7782
+ /**
7783
+ * @deprecated
7784
+ * @description UI status value. Subject to change without notice; do not rely on this value. Only present when `withUIStatus` option is true.
7785
+ * @enum {string}
7786
+ */
7787
+ uiStatus?: "Draft" | "Modified" | "Published" | "Orphan" | "Previous";
7788
+ /**
7789
+ * Format: uuid
7790
+ * @description The project ID that this layout data is part of
7791
+ */
7792
+ projectId: string;
7793
+ /**
7794
+ * Format: date-time,
7795
+ * @description Created date string for this definition
7796
+ */
7797
+ created: string;
7798
+ /**
7799
+ * Format: date-time,
7800
+ * @description Modified date string for this definition
7801
+ */
7802
+ modified: string;
7803
+ entry: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["Entry"];
7804
+ };
7805
+ EntryListResponse: {
7806
+ entries: external$3["../../../lambda/functions/v1-entries.swagger.yml"]["components"]["schemas"]["EntryApiResponse"][];
7807
+ /** @description Total number of entries that match the query. Only present when `withTotalCount` option is true. */
7808
+ totalCount?: number;
7809
+ };
7810
+ };
7811
+ parameters: {
7812
+ /** @description The project the entry/entries are on. */
7813
+ projectId: string;
7814
+ /** @description Specify multiple entry IDs to fetch. */
7815
+ entryIDs: string[];
7816
+ /** @description Specify a single entry to fetch by slug. */
7817
+ slug: string;
7818
+ /** @description The content type ID to filter by. */
7819
+ type: string[];
7820
+ /** @description Publishing state to fetch. 0 = draft, 64 = published. */
7821
+ state: number;
7822
+ /** @description Number of records to skip */
7823
+ offset: number;
7824
+ /** @description Max number of records to return */
7825
+ limit: number;
7826
+ /** @description Sets the sorting of the results. If unspecified, results are sorted by name ascending. */
7827
+ orderBy: ("updated_at_DESC" | "updated_at_ASC" | "created_at_DESC" | "created_at_ASC" | "name_DESC" | "name_ASC")[];
7828
+ /**
7829
+ * @deprecated
7830
+ * @description Returns the UI status string of the entry.
7831
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
7832
+ */
7833
+ withUIStatus: boolean;
7834
+ /**
7835
+ * @deprecated
7836
+ * @description Filters entries lists by the UI status of the entry.
7837
+ * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data.
7838
+ */
7839
+ uiStatus: ("Draft" | "Modified" | "Published" | "Orphan")[];
7840
+ /** @description Filters entry lists by the user who created them. The user is specified by their identity subject. */
7841
+ createdBy: string;
7842
+ /** @description Filters entry lists by the user who last updated them. The user is specified by their identity subject. */
7843
+ updatedBy: string;
7844
+ /**
7845
+ * @description Controls whether the total count of results will be returned along with the current results page in a list.
7846
+ * Has no effect when not fetching a list. This does impact performance when enabled.
7847
+ */
7848
+ withTotalCount: boolean;
7849
+ };
7850
+ };
7851
+ operations: {};
7852
+ };
7638
7853
  "../../../lambda/functions/v1-redirect.swagger.yml": {
7639
7854
  paths: {
7640
7855
  "/api/v1/redirect": {
@@ -8332,25 +8547,20 @@ interface external$2 {
8332
8547
  /** @description The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
8333
8548
  fields?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionParameter"][];
8334
8549
  /**
8335
- * Format: uuid
8336
- * @description Reference to the category this component definition belongs to
8337
- * @default null
8338
- */
8339
- categoryId?: string | null;
8340
- /**
8341
- * @description Description of the component definition
8550
+ * @description Description of the content type
8342
8551
  * @default null
8343
8552
  */
8344
8553
  description?: string;
8345
8554
  /**
8346
- * @description Description of the component definition
8347
- * @default null
8555
+ * @description Icon name for the content type (e.g. 'screen')
8556
+ * @default file-document
8348
8557
  */
8349
- previewImageUrl?: string;
8558
+ icon?: string;
8350
8559
  /** @description Created date string for this content type (ignored for writes) */
8351
8560
  created?: string;
8352
8561
  /** @description Last modified date string for this content type (ignored for writes) */
8353
8562
  updated?: string;
8563
+ slugSettings?: external$2["uniform-canvas-types.swagger.yml"]["components"]["schemas"]["ComponentDefinitionSlugSettings"];
8354
8564
  };
8355
8565
  /** @description Defines an editable parameter on a component. */
8356
8566
  ComponentParameter: {
@@ -9480,21 +9690,25 @@ type DataResolutionParameters = {
9480
9690
  diagnostics?: boolean;
9481
9691
  };
9482
9692
  /** Types of issue that can occur when fetching composition data */
9483
- type CompositionIssue = CompositionPatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
9484
- type CompositionIssueCore = components$1['schemas']['CompositionIssue'];
9693
+ type DataResolutionIssue = PatternIssue | DataResourceIssue | DataElementBindingIssue | DynamicInputIssue | DataResolutionConfigIssue;
9694
+ /** @deprecated use DataResolutionIssue instead */
9695
+ type CompositionIssue = DataResolutionIssue;
9696
+ type DataResolutionIssueCore = components$1['schemas']['DataResolutionIssue'];
9485
9697
  /** An error that occured resolving a pattern that is referenced on the composition */
9486
- type CompositionPatternIssue = CompositionIssueCore & {
9698
+ type PatternIssue = DataResolutionIssueCore & {
9487
9699
  type: 'pattern';
9488
9700
  code: NonNullable<ComponentInstance['_patternError']>;
9489
9701
  };
9702
+ /** @deprecated use PatternIssue instead */
9703
+ type CompositionPatternIssue = PatternIssue;
9490
9704
  /** An error while binding a dynamic token from a data resource to a component parameter (i.e. a missing property in the data resource) */
9491
- type DataElementBindingIssue = CompositionIssueCore & {
9705
+ type DataElementBindingIssue = DataResolutionIssueCore & {
9492
9706
  type: 'binding';
9493
9707
  parameterName: string;
9494
9708
  expression?: DataElementConnectionDefinition;
9495
9709
  };
9496
9710
  /** An error that occurred fetching a data defined on the composition or a pattern within */
9497
- type DataResourceIssue = CompositionIssueCore & {
9711
+ type DataResourceIssue = DataResolutionIssueCore & {
9498
9712
  type: 'data';
9499
9713
  dataName: string;
9500
9714
  dataType: string;
@@ -9503,7 +9717,7 @@ type DataResourceIssue = CompositionIssueCore & {
9503
9717
  * An issue that occurred while binding dynamic inputs to composition data resources,
9504
9718
  * specifically when an expected dynamic input did not have a value.
9505
9719
  */
9506
- type DynamicInputIssue = CompositionIssueCore & {
9720
+ type DynamicInputIssue = DataResolutionIssueCore & {
9507
9721
  type: 'input';
9508
9722
  };
9509
9723
  /** Error in data resolution configuration (internal error) */
@@ -9512,9 +9726,13 @@ type DataResolutionConfigIssue = {
9512
9726
  type: 'config';
9513
9727
  };
9514
9728
  /** Diagnostics about edge request processing */
9515
- type CompositionDiagnostics = components$1['schemas']['CompositionDiagnostics'];
9729
+ type EdgehancersDiagnostics = components$1['schemas']['EdgehancersDiagnostics'];
9730
+ /** @deprecated use EdgehancersDiagnostics instead */
9731
+ type CompositionDiagnostics = EdgehancersDiagnostics;
9516
9732
  /** Diagnostic data about the load performance of attached composition datas */
9517
- type CompositionDataDiagnostic = components$1['schemas']['DataDiagnostic'];
9733
+ type DataDiagnostic = components$1['schemas']['DataDiagnostic'];
9734
+ /** @deprecated use DataDiagnostic instead */
9735
+ type CompositionDataDiagnostic = DataDiagnostic;
9518
9736
  /** Response as it comes from uniform.global/api/v1/composition */
9519
9737
  type CompositionResolvedGetResponse = components$1['schemas']['CompositionResolvedGetResponse'];
9520
9738
  type CompositionResolvedListResponse = components$1['schemas']['CompositionResolvedListResponse'];
@@ -9530,6 +9748,7 @@ type RouteDynamicInputs = components['schemas']['RouteDynamicInputs'];
9530
9748
  /** The GET response from /api/v1/entries */
9531
9749
  type EntriesGetParameters = paths$8['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
9532
9750
  type EntriesGetResponse = components$4['schemas']['EntryListResponse'];
9751
+ type EntriesResolvedListResponse = components$1['schemas']['EntryResolvedListResponse'];
9533
9752
  /** GET response from uniform.global/api/v1/route when result is a composition */
9534
9753
  type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
9535
9754
  compositionApiResponse: CompositionResolvedGetResponse;
@@ -10104,15 +10323,24 @@ type PreviewPanelSettings = {
10104
10323
  isInteractive: boolean;
10105
10324
  };
10106
10325
  type ContextualEditingComponentReference = {
10107
- elements: HTMLElement[];
10108
10326
  id: string;
10109
- slotName?: string;
10110
- componentIndex?: number;
10111
- totalComponents?: number;
10112
- componentName?: string;
10113
- componentTitle?: string;
10327
+ icon?: string;
10328
+ type?: string;
10329
+ title?: string;
10330
+ name?: string;
10331
+ parameters?: Record<string, {
10332
+ id: string;
10333
+ type: string;
10334
+ name?: string;
10335
+ isReadOnly?: boolean;
10336
+ }>;
10114
10337
  parentId?: string;
10115
10338
  parentType?: string;
10339
+ parentSlot?: {
10340
+ id?: string;
10341
+ componentIndex?: number;
10342
+ totalComponents?: number;
10343
+ };
10116
10344
  isLocalized?: boolean;
10117
10345
  isReadOnly?: boolean | undefined;
10118
10346
  };
@@ -10546,8 +10774,8 @@ type SelectComponentMessage = {
10546
10774
  };
10547
10775
  type SelectParameterMessage = {
10548
10776
  type: 'select-parameter';
10549
- parameterId: string;
10550
- componentId: string;
10777
+ parameterId?: string;
10778
+ componentId?: string;
10551
10779
  };
10552
10780
  type ReadyMessage = {
10553
10781
  type: 'ready';
@@ -10555,6 +10783,15 @@ type ReadyMessage = {
10555
10783
  /** A non-semantic version of the contextual editing SDK. */
10556
10784
  version?: number;
10557
10785
  };
10786
+ type TriggerComponentActionMessage = {
10787
+ type: 'trigger-component-action';
10788
+ actionType: 'insert-before' | 'insert-after' | 'duplicate' | 'delete';
10789
+ componentReference: Omit<ContextualEditingComponentReference, 'elements'>;
10790
+ };
10791
+ type UpdateComponentReferencesMessage = {
10792
+ type: 'update-component-references';
10793
+ referencesById: Record<string, ContextualEditingComponentReference>;
10794
+ };
10558
10795
  type UpdateCompositionMessage = {
10559
10796
  type: 'update-composition';
10560
10797
  composition: RootComponentInstance;
@@ -10578,6 +10815,11 @@ type MoveComponentMessage = {
10578
10815
  index: number;
10579
10816
  direction: 'up' | 'down';
10580
10817
  };
10818
+ type OpenParameterEditorMessage = {
10819
+ type: 'open-parameter-editor';
10820
+ componentId: string;
10821
+ parameterId: string;
10822
+ };
10581
10823
  type UpdateComponentParameterMessage = {
10582
10824
  type: 'update-component-parameter';
10583
10825
  componentId: string;
@@ -10600,7 +10842,18 @@ type UpdatePreviewSettingsMessage = {
10600
10842
  type UpdateContextualEditingStateInternalMessage = {
10601
10843
  type: 'update-contextual-editing-state-internal';
10602
10844
  state: {
10603
- selectedComponentReference?: Omit<ContextualEditingComponentReference, 'elements'>;
10845
+ selectedComponentReference?: {
10846
+ id: string;
10847
+ slotName?: string;
10848
+ componentIndex?: number;
10849
+ totalComponents?: number;
10850
+ componentName?: string;
10851
+ componentTitle?: string;
10852
+ parentId?: string;
10853
+ parentType?: string;
10854
+ isLocalized?: boolean;
10855
+ isReadOnly?: boolean | undefined;
10856
+ };
10604
10857
  };
10605
10858
  };
10606
10859
  type ReportRenderedCompositionsMessage = {
@@ -10611,9 +10864,10 @@ type ReportRenderedCompositionsMessage = {
10611
10864
  type EditorStateUpdatedMessage = {
10612
10865
  type: 'editor-state-updated';
10613
10866
  };
10614
- type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | EditorStateUpdatedMessage;
10867
+ type ChannelMessage = SelectComponentMessage | ReadyMessage | UpdateCompositionMessage | UpdateCompositionInternalMessage | TriggerComponentActionMessage | AddComponentMessage | MoveComponentMessage | TriggerCompositionActionMessage | UpdatePreviewSettingsMessage | ReportRenderedCompositionsMessage | UpdateComponentParameterMessage | UpdateContextualEditingStateInternalMessage | SelectParameterMessage | DismissPlaceholderMessage | UpdateComponentReferencesMessage | OpenParameterEditorMessage | EditorStateUpdatedMessage;
10615
10868
  declare const isSelectComponentMessage: (message: ChannelMessage) => message is SelectComponentMessage;
10616
10869
  declare const isReadyMessage: (message: ChannelMessage) => message is ReadyMessage;
10870
+ declare const isComponentActionMessage: (message: ChannelMessage) => message is TriggerComponentActionMessage;
10617
10871
  declare const isUpdateCompositionMessage: (message: ChannelMessage) => message is UpdateCompositionMessage;
10618
10872
  declare const isUpdateCompositionInternalMessage: (message: ChannelMessage) => message is UpdateCompositionInternalMessage;
10619
10873
  declare const isAddComponentMessage: (message: ChannelMessage) => message is AddComponentMessage;
@@ -10625,13 +10879,17 @@ declare const isUpdatePreviewSettingsMessage: (message: ChannelMessage) => messa
10625
10879
  declare const isUpdateContextualEditingStateInternalMessage: (message: ChannelMessage) => message is UpdateContextualEditingStateInternalMessage;
10626
10880
  declare const isReportRenderedCompositionsMessage: (message: ChannelMessage) => message is ReportRenderedCompositionsMessage;
10627
10881
  declare const isSelectParameterMessage: (message: ChannelMessage) => message is SelectParameterMessage;
10882
+ declare const isOpenParameterEditorMessage: (message: ChannelMessage) => message is OpenParameterEditorMessage;
10883
+ declare const isUpdateComponentReferencesMessage: (message: ChannelMessage) => message is UpdateComponentReferencesMessage;
10628
10884
  type MessageHandler = (message: ChannelMessage, originalEvent: MessageEvent) => void;
10629
10885
  type Channel = {
10630
10886
  on: (types: ChannelMessage['type'][] | ChannelMessage['type'], handler: MessageHandler) => () => void;
10631
10887
  ready: () => void;
10632
10888
  destroy: () => void;
10889
+ triggerComponentAction: (options: Omit<TriggerComponentActionMessage, 'type'>) => void;
10633
10890
  selectComponent: (id: string) => void;
10634
10891
  selectParameter: (options: Omit<SelectParameterMessage, 'type'>) => void;
10892
+ openParameterEditor: (options: Omit<OpenParameterEditorMessage, 'type'>) => void;
10635
10893
  updateComposition: (composition: RootComponentInstance, secret?: string) => void;
10636
10894
  updateCompositionInternal: (composition: RootComponentInstance, hash?: number) => void;
10637
10895
  addComponent: (options: Omit<AddComponentMessage, 'type'>) => void;
@@ -10642,6 +10900,7 @@ type Channel = {
10642
10900
  updatePreviewSettings: (options: Omit<UpdatePreviewSettingsMessage, 'type'>) => void;
10643
10901
  updateContextualEditingStateInternal: (options: Omit<UpdateContextualEditingStateInternalMessage, 'type'>) => void;
10644
10902
  reportRenderedCompositions: (options: Omit<ReportRenderedCompositionsMessage, 'type'>) => void;
10903
+ updateComponentReferences: (options: Omit<UpdateComponentReferencesMessage, 'type'>) => void;
10645
10904
  editorStateUpdated: () => void;
10646
10905
  };
10647
10906
  declare const createCanvasChannel: ({ listenTo, broadcastTo, }: {
@@ -10943,6 +11202,12 @@ declare const generateHash: ({ composition, secret, }: {
10943
11202
  secret: string | undefined;
10944
11203
  }) => number | undefined;
10945
11204
 
11205
+ /**
11206
+ * Checks if page is opened from inside Uniform Canvas Editor.
11207
+ * So if you open preview in incognito or via copy/paste link, it will return false.
11208
+ */
11209
+ declare const isAllowedReferrer: (referrer: string | undefined) => boolean;
11210
+
10946
11211
  /** Determines if a given Canvas component type is a system-defined type */
10947
11212
  declare const isSystemComponentDefinition: (componentType: string) => boolean;
10948
11213
 
@@ -10958,6 +11223,9 @@ declare function mapSlotToPersonalizedVariations(slot: ComponentInstance[] | und
10958
11223
  */
10959
11224
  declare function mapSlotToTestVariations(slot: ComponentInstance[] | undefined): Array<ComponentInstance & TestVariant>;
10960
11225
 
11226
+ declare const isComponentPlaceholderId: (id: string | undefined) => boolean | undefined;
11227
+ declare const generateComponentPlaceholderId: (randomId: string) => string;
11228
+
10961
11229
  type BindVariablesResult<TValue> = {
10962
11230
  /** Number of dynamic expressions that attempted to be bound (regardless of the success of the binding) */
10963
11231
  boundCount: number;
@@ -11017,4 +11285,4 @@ declare function parseVariableExpression(serialized: string, onToken?: (token: s
11017
11285
 
11018
11286
  declare const CanvasClientError: typeof ApiClientError;
11019
11287
 
11020
- export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, 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, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, Entry, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, 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, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OverrideOptions, PLACEHOLDER_ID, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isDismissPlaceholderMessage, isMovingComponentMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };
11288
+ export { ATTRIBUTE_COMPONENT_ID, ATTRIBUTE_MULTILINE, ATTRIBUTE_PARAMETER_ID, ATTRIBUTE_PARAMETER_TYPE, ATTRIBUTE_PARAMETER_VALUE, ATTRIBUTE_PLACEHOLDER, AddComponentMessage, BatchEnhancer, BatchEntry, BatchInvalidationPayload, BindVariablesOptions, BindVariablesResult, BindVariablesToObjectOptions, 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, CanvasDefinitions, CategoriesDeleteParameters, CategoriesGetParameters, CategoriesGetResponse, CategoriesPutParameters, Category, CategoryClient, Channel, ChannelMessage, ChannelSubscription, ChildEnhancerBuilder, ComponentDefinition, ComponentDefinitionDeleteParameters, ComponentDefinitionGetParameters, ComponentDefinitionGetResponse, ComponentDefinitionParameter, ComponentDefinitionPermission, ComponentDefinitionPutParameters, ComponentDefinitionSlot, ComponentDefinitionSlugSettings, ComponentDefinitionVariant, ComponentEnhancer, ComponentEnhancerFunction, ComponentEnhancerOptions, ComponentInstance, ComponentInstanceContextualEditing, ComponentInstanceHistoryEntry, ComponentInstanceHistoryGetParameters, ComponentInstanceHistoryGetResponse, ComponentLocationReference, ComponentOverridability, ComponentOverride, ComponentOverrides, ComponentParameter, ComponentParameterContextualEditing, ComponentParameterEnhancer, ComponentParameterEnhancerFunction, ComponentParameterEnhancerOptions, CompositionDataDiagnostic, CompositionDeleteParameters, CompositionDiagnostics, CompositionGetByComponentIdParameters, CompositionGetByIdParameters, CompositionGetByNodeIdParameters, CompositionGetByNodePathParameters, CompositionGetBySlugParameters, CompositionGetListResponse, CompositionGetOrderBy, CompositionGetParameters, CompositionGetResponse, CompositionGetValidResponses, CompositionIssue, CompositionPatternIssue, CompositionPutParameters, CompositionRelationshipsClientOptions, CompositionRelationshipsDDefinitionGetResponse, CompositionRelationshipsDefinitionApi, CompositionRelationshipsDefinitionGetParameters, CompositionResolvedGetResponse, CompositionResolvedListResponse, CompositionUIStatus, ContentClient, ContentType, ContentTypeField, ContextualEditingComponentReference, DataDiagnostic, DataElementBindingIssue, DataElementConnectionDefinition, DataResolutionConfigIssue, DataResolutionIssue, DataResolutionOption, DataResolutionOptionNegative, DataResolutionOptionPositive, DataResolutionParameters, DataResourceDefinition, DataResourceDefinitions, DataResourceIssue, DataResourceVariables, DataSource, DataSourceClient, DataSourceDeleteParameters, DataSourceGetParameters, DataSourceGetResponse, DataSourcePutParameters, DataSourcesGetParameters, DataSourcesGetResponse, DataType, DataTypeClient, DataTypeDeleteParameters, DataTypeGetParameters, DataTypeGetResponse, DataTypePutParameters, DataVariableDefinition, DeleteContentTypeOptions, DeleteEntryOptions, DismissPlaceholderMessage, DynamicInputIssue, EDGE_CACHE_DISABLED, EDGE_DEFAULT_CACHE_TTL, EDGE_DEFAULT_L2_CACHE_TTL_IN_HOURS, EDGE_MAX_CACHE_TTL, EDGE_MAX_L2_CACHE_TTL_IN_HOURS, EDGE_MIN_CACHE_TTL, EDGE_MIN_L2_CACHE_TTL_IN_HOURS, EMPTY_COMPOSITION, EdgehancersDiagnostics, EditorStateUpdatedMessage, EnhancerBuilder, EnhancerContext, EnhancerError, EntriesGetParameters, EntriesGetResponse, EntriesResolvedListResponse, Entry, EventNames, GetContentTypesOptions, GetContentTypesResponse, GetEntriesOptions, GetEntriesResponse, 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, InvalidationPayload, LimitPolicy, LinkComponentParameterValue, LinkParamConfiguration, LinkParamValue, LinkParameterType, LinkTypeConfiguration, MessageHandler, MoveComponentMessage, NonProjectMapLinkParamValue, OpenParameterEditorMessage, OverrideOptions, PLACEHOLDER_ID, PatternIssue, PreviewEventBus, PreviewPanelSettings, ProjectMapLinkComponentParameterValue, ProjectMapLinkParamValue, PutContentTypeBody, PutEntryBody, ReadyMessage, ReportRenderedCompositionsMessage, ResolvedRouteGetResponse, RichTextBuiltInElement, RichTextBuiltInFormat, RichTextParamConfiguration, RichTextParamValue, RootComponentInstance, RouteClient, RouteDynamicInputs, RouteGetParameters, RouteGetResponse, RouteGetResponseComposition, RouteGetResponseEdgehancedComposition, RouteGetResponseNotFound, RouteGetResponseRedirect, SelectComponentMessage, SelectParameterMessage, SpecificProjectMap, SubscribeToCompositionOptions, TriggerComponentActionMessage, TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UniqueBatchEntries, UnsubscribeCallback, UpdateComponentParameterMessage, UpdateComponentReferencesMessage, UpdateCompositionInternalMessage, UpdateCompositionMessage, UpdateContextualEditingStateInternalMessage, UpdatePreviewSettingsMessage, UsageTrackingApi, UsageTrackingGetParameters, UsageTrackingGetResponse, UsageTrackingPostParameters, UsageTrackingPostResponse, WalkComponentTreeActions, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, createBatchEnhancer, createCanvasChannel, createEventBus, createLimitPolicy, createUniformApiEnhancer, createVariableReference, enhance, extractLocales, generateComponentPlaceholderId, generateHash, getChannelName, getComponentJsonPointer, getComponentPath, getParameterAttributes, isAddComponentMessage, isAllowedReferrer, isComponentActionMessage, isComponentPlaceholderId, isDismissPlaceholderMessage, isMovingComponentMessage, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isSelectComponentMessage, isSelectParameterMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, nullLimitPolicy, parseVariableExpression, subscribeToComposition, unstable_CompositionRelationshipClient, walkComponentTree };