@uniformdev/canvas 20.78.0 → 20.78.1-alpha.20.sha-fc102eb30c

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.
Files changed (6) hide show
  1. package/dist/index.d.mts +1000 -567
  2. package/dist/index.d.ts +1000 -567
  3. package/dist/index.esm.js +2 -1
  4. package/dist/index.js +2 -1
  5. package/dist/index.mjs +2 -1
  6. package/package.json +5 -5
package/dist/index.d.mts CHANGED
@@ -8,7 +8,7 @@ import { Options as Options$1 } from 'p-retry';
8
8
  import { Options } from 'p-throttle';
9
9
  import { LinkAttributesConfiguration, RichTextBuiltInElement as RichTextBuiltInElement$1, RichTextBuiltInFormat as RichTextBuiltInFormat$1, RichTextParamConfiguration as RichTextParamConfiguration$1, ParameterRichTextValue } from '@uniformdev/richtext';
10
10
 
11
- interface paths$n {
11
+ interface paths$o {
12
12
  "/api/v1/categories": {
13
13
  parameters: {
14
14
  query?: never;
@@ -34,15 +34,15 @@ interface paths$n {
34
34
  };
35
35
  content: {
36
36
  "application/json": {
37
- categories: components$r["schemas"]["Category"][];
37
+ categories: components$s["schemas"]["Category"][];
38
38
  };
39
39
  };
40
40
  };
41
- 400: components$r["responses"]["BadRequestError"];
42
- 401: components$r["responses"]["UnauthorizedError"];
43
- 403: components$r["responses"]["ForbiddenError"];
44
- 429: components$r["responses"]["RateLimitError"];
45
- 500: components$r["responses"]["InternalServerError"];
41
+ 400: components$s["responses"]["BadRequestError"];
42
+ 401: components$s["responses"]["UnauthorizedError"];
43
+ 403: components$s["responses"]["ForbiddenError"];
44
+ 429: components$s["responses"]["RateLimitError"];
45
+ 500: components$s["responses"]["InternalServerError"];
46
46
  };
47
47
  };
48
48
  put: {
@@ -57,7 +57,7 @@ interface paths$n {
57
57
  "application/json": {
58
58
  /** Format: uuid */
59
59
  projectId: string;
60
- categories: components$r["schemas"]["Category"][];
60
+ categories: components$s["schemas"]["Category"][];
61
61
  };
62
62
  };
63
63
  };
@@ -69,11 +69,11 @@ interface paths$n {
69
69
  };
70
70
  content?: never;
71
71
  };
72
- 400: components$r["responses"]["BadRequestError"];
73
- 401: components$r["responses"]["UnauthorizedError"];
74
- 403: components$r["responses"]["ForbiddenError"];
75
- 429: components$r["responses"]["RateLimitError"];
76
- 500: components$r["responses"]["InternalServerError"];
72
+ 400: components$s["responses"]["BadRequestError"];
73
+ 401: components$s["responses"]["UnauthorizedError"];
74
+ 403: components$s["responses"]["ForbiddenError"];
75
+ 429: components$s["responses"]["RateLimitError"];
76
+ 500: components$s["responses"]["InternalServerError"];
77
77
  };
78
78
  };
79
79
  post?: never;
@@ -102,11 +102,11 @@ interface paths$n {
102
102
  };
103
103
  content?: never;
104
104
  };
105
- 400: components$r["responses"]["BadRequestError"];
106
- 401: components$r["responses"]["UnauthorizedError"];
107
- 403: components$r["responses"]["ForbiddenError"];
108
- 429: components$r["responses"]["RateLimitError"];
109
- 500: components$r["responses"]["InternalServerError"];
105
+ 400: components$s["responses"]["BadRequestError"];
106
+ 401: components$s["responses"]["UnauthorizedError"];
107
+ 403: components$s["responses"]["ForbiddenError"];
108
+ 429: components$s["responses"]["RateLimitError"];
109
+ 500: components$s["responses"]["InternalServerError"];
110
110
  };
111
111
  };
112
112
  options?: never;
@@ -115,7 +115,7 @@ interface paths$n {
115
115
  trace?: never;
116
116
  };
117
117
  }
118
- interface components$r {
118
+ interface components$s {
119
119
  schemas: {
120
120
  /** Category for tagging canvas entities */
121
121
  Category: {
@@ -144,7 +144,7 @@ interface components$r {
144
144
  [name: string]: unknown;
145
145
  };
146
146
  content: {
147
- "application/json": components$r["schemas"]["Error"];
147
+ "application/json": components$s["schemas"]["Error"];
148
148
  };
149
149
  };
150
150
  /** API key or token was not valid */
@@ -153,7 +153,7 @@ interface components$r {
153
153
  [name: string]: unknown;
154
154
  };
155
155
  content: {
156
- "application/json": components$r["schemas"]["Error"];
156
+ "application/json": components$s["schemas"]["Error"];
157
157
  };
158
158
  };
159
159
  /** Permission was denied */
@@ -162,7 +162,7 @@ interface components$r {
162
162
  [name: string]: unknown;
163
163
  };
164
164
  content: {
165
- "application/json": components$r["schemas"]["Error"];
165
+ "application/json": components$s["schemas"]["Error"];
166
166
  };
167
167
  };
168
168
  /** Too many requests in allowed time period */
@@ -186,13 +186,13 @@ interface components$r {
186
186
  pathItems: never;
187
187
  }
188
188
 
189
- interface components$q {
189
+ interface components$r {
190
190
  schemas: {
191
191
  /** Public ID (used in code). Do not change after creation */
192
192
  PublicIdProperty: string;
193
193
  /** The definition of a component parameter */
194
194
  ComponentDefinitionParameter: {
195
- id: components$q["schemas"]["PublicIdProperty"];
195
+ id: components$r["schemas"]["PublicIdProperty"];
196
196
  /** Friendly name of the parameter */
197
197
  name: string;
198
198
  /** Appears next to the parameter in the Composition editor */
@@ -226,7 +226,7 @@ interface components$q {
226
226
  };
227
227
  /** The definition of a named component slot that can contain other components */
228
228
  ComponentDefinitionSlot: {
229
- id: components$q["schemas"]["PublicIdProperty"];
229
+ id: components$r["schemas"]["PublicIdProperty"];
230
230
  /** Friendly name of the slot */
231
231
  name: string;
232
232
  /** A list of component definition public IDs that are allowed in this named slot */
@@ -281,13 +281,13 @@ interface components$q {
281
281
  };
282
282
  /** The definition of a component variant */
283
283
  ComponentDefinitionVariant: {
284
- id: components$q["schemas"]["PublicIdProperty"];
284
+ id: components$r["schemas"]["PublicIdProperty"];
285
285
  /** Friendly name of the variant */
286
286
  name: string;
287
287
  };
288
288
  /** Permission set for a component definition */
289
289
  ComponentDefinitionPermission: {
290
- roleId: components$q["schemas"]["PublicIdProperty"];
290
+ roleId: components$r["schemas"]["PublicIdProperty"];
291
291
  /**
292
292
  * Permission type for this permission ComponentDefinition:
293
293
  * read | write | create | delete
@@ -299,7 +299,7 @@ interface components$q {
299
299
  };
300
300
  /** Defines a component type that can live on a Composition */
301
301
  ComponentDefinition: {
302
- id: components$q["schemas"]["PublicIdProperty"];
302
+ id: components$r["schemas"]["PublicIdProperty"];
303
303
  /** Friendly name of the component definition */
304
304
  name: string;
305
305
  /**
@@ -324,7 +324,7 @@ interface components$q {
324
324
  */
325
325
  canBeComposition?: boolean;
326
326
  /** The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
327
- parameters?: components$q["schemas"]["ComponentDefinitionParameter"][];
327
+ parameters?: components$r["schemas"]["ComponentDefinitionParameter"][];
328
328
  /**
329
329
  * Format: uuid
330
330
  * Reference to the category this component definition belongs to
@@ -341,14 +341,14 @@ interface components$q {
341
341
  */
342
342
  useTeamPermissions?: boolean;
343
343
  /** Custom role permissions for this component definition */
344
- permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
344
+ permissions?: components$r["schemas"]["ComponentDefinitionPermission"][];
345
345
  /** The named slots for this component; placement areas where arrays of other components can be added */
346
- slots?: components$q["schemas"]["ComponentDefinitionSlot"][];
347
- slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
346
+ slots?: components$r["schemas"]["ComponentDefinitionSlot"][];
347
+ slugSettings?: components$r["schemas"]["ComponentDefinitionSlugSettings"];
348
348
  /** Default component instance value */
349
- defaults?: components$q["schemas"]["ComponentInstance"] | null;
349
+ defaults?: components$r["schemas"]["ComponentInstance"] | null;
350
350
  /** Named variants for this component; enables the creation of visual variants that use the same parameter data */
351
- variants?: components$q["schemas"]["ComponentDefinitionVariant"][];
351
+ variants?: components$r["schemas"]["ComponentDefinitionVariant"][];
352
352
  /** Created date string for this definition (ignored for writes) */
353
353
  created?: string;
354
354
  /** Last modified date string for this definition (ignored for writes) */
@@ -361,7 +361,7 @@ interface components$q {
361
361
  };
362
362
  /** Defines a content type */
363
363
  ContentType: {
364
- id: components$q["schemas"]["PublicIdProperty"];
364
+ id: components$r["schemas"]["PublicIdProperty"];
365
365
  /** Friendly name of the content type */
366
366
  name: string;
367
367
  /**
@@ -375,7 +375,7 @@ interface components$q {
375
375
  */
376
376
  thumbnailField?: string | null;
377
377
  /** The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
378
- fields?: components$q["schemas"]["ComponentDefinitionParameter"][];
378
+ fields?: components$r["schemas"]["ComponentDefinitionParameter"][];
379
379
  /** Description of the content type */
380
380
  description?: string;
381
381
  /**
@@ -387,7 +387,7 @@ interface components$q {
387
387
  created?: string;
388
388
  /** Last modified date string for this content type (ignored for writes) */
389
389
  updated?: string;
390
- slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
390
+ slugSettings?: components$r["schemas"]["ComponentDefinitionSlugSettings"];
391
391
  /**
392
392
  * The definition type of this content type (block or content type)
393
393
  * @defaultValue contentType
@@ -400,14 +400,14 @@ interface components$q {
400
400
  */
401
401
  useTeamPermissions?: boolean;
402
402
  /** Custom role permissions for this content type */
403
- permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
403
+ permissions?: components$r["schemas"]["ComponentDefinitionPermission"][];
404
404
  /**
405
405
  * Format: uuid
406
406
  * ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
407
407
  */
408
408
  workflowId?: string;
409
409
  /** Configurations for previewing an entry on a consuming pattern or composition. */
410
- previewConfigurations?: components$q["schemas"]["ContentTypePreviewConfiguration"][];
410
+ previewConfigurations?: components$r["schemas"]["ContentTypePreviewConfiguration"][];
411
411
  };
412
412
  /** Defines a configuration for previewing an entry on a consuming pattern or composition. */
413
413
  ContentTypePreviewConfiguration: {
@@ -435,7 +435,7 @@ interface components$q {
435
435
  /** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
436
436
  type: string;
437
437
  /** @deprecated */
438
- connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
438
+ connectedData?: components$r["schemas"]["DataElementConnectionDefinition"];
439
439
  /**
440
440
  * Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
441
441
  * Note that locales must be registered on the entry/composition `_locales` before being used
@@ -443,10 +443,10 @@ interface components$q {
443
443
  locales?: {
444
444
  [key: string]: unknown;
445
445
  };
446
- conditions?: components$q["schemas"]["ComponentParameterConditions"];
446
+ conditions?: components$r["schemas"]["ComponentParameterConditions"];
447
447
  /** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
448
448
  localesConditions?: {
449
- [key: string]: components$q["schemas"]["ComponentParameterConditions"];
449
+ [key: string]: components$r["schemas"]["ComponentParameterConditions"];
450
450
  };
451
451
  };
452
452
  /**
@@ -459,10 +459,10 @@ interface components$q {
459
459
  *
460
460
  * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
461
461
  */
462
- ComponentParameterConditions: components$q["schemas"]["ComponentParameterConditionalValue"][];
462
+ ComponentParameterConditions: components$r["schemas"]["ComponentParameterConditionalValue"][];
463
463
  /** Defines a conditional value for a component parameter */
464
464
  ComponentParameterConditionalValue: {
465
- when: components$q["schemas"]["VisibilityCriteriaGroup"];
465
+ when: components$r["schemas"]["VisibilityCriteriaGroup"];
466
466
  /**
467
467
  * The value of the parameter. Any JSON-serializable value is acceptable.
468
468
  * A value of `null` will cause the parameter value to be removed, if it matches.
@@ -484,7 +484,7 @@ interface components$q {
484
484
 
485
485
  */
486
486
  op?: "&" | "|";
487
- clauses: (components$q["schemas"]["VisibilityCriteria"] | components$q["schemas"]["VisibilityCriteriaGroup"])[];
487
+ clauses: (components$r["schemas"]["VisibilityCriteria"] | components$r["schemas"]["VisibilityCriteriaGroup"])[];
488
488
  };
489
489
  /**
490
490
  * @deprecated
@@ -546,13 +546,13 @@ interface components$q {
546
546
  type: string;
547
547
  /** Component parameter values for the component instance */
548
548
  parameters?: {
549
- [key: string]: components$q["schemas"]["ComponentParameter"];
549
+ [key: string]: components$r["schemas"]["ComponentParameter"];
550
550
  };
551
551
  /** Public ID of alternate visual appearance for this component, if any selected */
552
552
  variant?: string;
553
553
  /** Slots containing any child components */
554
554
  slots?: {
555
- [key: string]: components$q["schemas"]["ComponentInstance"][];
555
+ [key: string]: components$r["schemas"]["ComponentInstance"][];
556
556
  };
557
557
  /**
558
558
  * Unique identifier of the component within the composition.
@@ -563,15 +563,20 @@ interface components$q {
563
563
  _id?: string;
564
564
  /** Indicates this component instance should be sourced from a pattern library pattern */
565
565
  _pattern?: string;
566
- _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
566
+ _dataResources?: components$r["schemas"]["DataResourceDefinitions"];
567
567
  /**
568
568
  * Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
569
569
  * Means nothing for PUTs; it will be ignored
570
570
  */
571
571
  _patternDataResources?: {
572
- [key: string]: components$q["schemas"]["DataResourceDefinition"];
572
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
573
573
  };
574
- _patternError?: components$q["schemas"]["PatternError"];
574
+ /**
575
+ * Query-string opt-ins coming from a pattern resolved for this component.
576
+ * Means nothing for PUTs; it will be ignored
577
+ */
578
+ _patternOptedInQueryStrings?: string[];
579
+ _patternError?: components$r["schemas"]["PatternError"];
575
580
  /**
576
581
  * Defines patch overrides to component IDs that live in the composition.
577
582
  * This can be used to override parameters that are defined on patterns,
@@ -585,14 +590,14 @@ interface components$q {
585
590
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
586
591
  */
587
592
  _overrides?: {
588
- [key: string]: components$q["schemas"]["ComponentOverride"];
593
+ [key: string]: components$r["schemas"]["ComponentOverride"];
589
594
  };
590
595
  /**
591
596
  * Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
592
597
  * Means nothing for PUTs; it will be ignored
593
598
  */
594
599
  _patternOverrides?: {
595
- [key: string]: components$q["schemas"]["ComponentOverride"];
600
+ [key: string]: components$r["schemas"]["ComponentOverride"];
596
601
  };
597
602
  /**
598
603
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -601,7 +606,7 @@ interface components$q {
601
606
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
602
607
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
603
608
  */
604
- _overridability?: components$q["schemas"]["ComponentOverridability"];
609
+ _overridability?: components$r["schemas"]["ComponentOverridability"];
605
610
  /** Array of locales that have data defined. Only set for pattern references or composition defaults */
606
611
  _locales?: string[];
607
612
  };
@@ -611,15 +616,15 @@ interface components$q {
611
616
  type: string;
612
617
  /** Component parameter values for the component instance */
613
618
  parameters?: {
614
- [key: string]: components$q["schemas"]["ComponentParameter"];
619
+ [key: string]: components$r["schemas"]["ComponentParameter"];
615
620
  };
616
621
  /** Public ID of alternate visual appearance for this component, if any selected */
617
622
  variant?: string;
618
623
  /** Project map nodes associated with this component. Must pass withProjectMapNodes parameter to be populated */
619
- projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
624
+ projectMapNodes?: components$r["schemas"]["CompositionProjectMapNodeInfo"][];
620
625
  /** Slots containing any child components */
621
626
  slots?: {
622
- [key: string]: components$q["schemas"]["ComponentInstance"][];
627
+ [key: string]: components$r["schemas"]["ComponentInstance"][];
623
628
  };
624
629
  /** The ID of the composition */
625
630
  _id: string;
@@ -642,10 +647,15 @@ interface components$q {
642
647
  * Means nothing for PUTs; it will be ignored
643
648
  */
644
649
  _patternDataResources?: {
645
- [key: string]: components$q["schemas"]["DataResourceDefinition"];
650
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
646
651
  };
647
- _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
648
- _patternError?: components$q["schemas"]["PatternError"];
652
+ /**
653
+ * Query-string opt-ins coming from a pattern resolved for this component.
654
+ * Means nothing for PUTs; it will be ignored
655
+ */
656
+ _patternOptedInQueryStrings?: string[];
657
+ _dataResources?: components$r["schemas"]["DataResourceDefinitions"];
658
+ _patternError?: components$r["schemas"]["PatternError"];
649
659
  /**
650
660
  * Defines patch overrides to component IDs that live in the composition.
651
661
  * This can be used to override parameters that are defined on patterns,
@@ -659,14 +669,14 @@ interface components$q {
659
669
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
660
670
  */
661
671
  _overrides?: {
662
- [key: string]: components$q["schemas"]["ComponentOverride"];
672
+ [key: string]: components$r["schemas"]["ComponentOverride"];
663
673
  };
664
674
  /**
665
675
  * Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
666
676
  * Means nothing for PUTs; it will be ignored
667
677
  */
668
678
  _patternOverrides?: {
669
- [key: string]: components$q["schemas"]["ComponentOverride"];
679
+ [key: string]: components$r["schemas"]["ComponentOverride"];
670
680
  };
671
681
  /**
672
682
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -675,9 +685,15 @@ interface components$q {
675
685
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
676
686
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
677
687
  */
678
- _overridability?: components$q["schemas"]["ComponentOverridability"];
688
+ _overridability?: components$r["schemas"]["ComponentOverridability"];
679
689
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
680
690
  _locales?: string[];
691
+ /**
692
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
693
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
694
+ * holds only what was authored here. Omitted whenever overrides are resolved.
695
+ */
696
+ _optedInQueryStrings?: string[];
681
697
  };
682
698
  /**
683
699
  * Defines how to override a specific component.
@@ -687,10 +703,10 @@ interface components$q {
687
703
  */
688
704
  ComponentOverride: {
689
705
  parameters?: {
690
- [key: string]: components$q["schemas"]["ComponentParameter"];
706
+ [key: string]: components$r["schemas"]["ComponentParameter"];
691
707
  };
692
708
  slots?: {
693
- [key: string]: components$q["schemas"]["ComponentInstance"][];
709
+ [key: string]: components$r["schemas"]["ComponentInstance"][];
694
710
  };
695
711
  variant?: string;
696
712
  /**
@@ -699,7 +715,7 @@ interface components$q {
699
715
  * Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
700
716
  */
701
717
  dataResources?: {
702
- [key: string]: components$q["schemas"]["DataResourceDefinition"];
718
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
703
719
  };
704
720
  };
705
721
  /**
@@ -712,7 +728,7 @@ interface components$q {
712
728
  ComponentOverridability: {
713
729
  /** Defines component parameter value overrides. Keys are the parameter public ID */
714
730
  parameters?: {
715
- [key: string]: components$q["schemas"]["OverrideOptions"];
731
+ [key: string]: components$r["schemas"]["OverrideOptions"];
716
732
  };
717
733
  /** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
718
734
  variants?: boolean;
@@ -749,7 +765,7 @@ interface components$q {
749
765
  }[];
750
766
  /** Variables needed to make calls to the data source */
751
767
  variables?: {
752
- [key: string]: components$q["schemas"]["DataVariableDefinition"];
768
+ [key: string]: components$r["schemas"]["DataVariableDefinition"];
753
769
  };
754
770
  };
755
771
  /**
@@ -779,7 +795,7 @@ interface components$q {
779
795
  }[];
780
796
  /** Variables needed to make calls to the data source */
781
797
  variables?: {
782
- [key: string]: components$q["schemas"]["DataVariableDefinition"];
798
+ [key: string]: components$r["schemas"]["DataVariableDefinition"];
783
799
  };
784
800
  /**
785
801
  * Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
@@ -803,7 +819,7 @@ interface components$q {
803
819
  };
804
820
  /** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
805
821
  variants?: {
806
- unpublished?: components$q["schemas"]["AlternativeDataSourceData"];
822
+ unpublished?: components$r["schemas"]["AlternativeDataSourceData"];
807
823
  };
808
824
  /** Created date of the data source in ISO 8601 format (ignored for writes) */
809
825
  created?: string;
@@ -859,7 +875,7 @@ interface components$q {
859
875
  method: "GET" | "POST" | "HEAD";
860
876
  /** Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
861
877
  variables?: {
862
- [key: string]: components$q["schemas"]["DataVariableDefinition"];
878
+ [key: string]: components$r["schemas"]["DataVariableDefinition"];
863
879
  };
864
880
  /** Custom configuration specific to the data source being defined */
865
881
  custom?: {
@@ -900,7 +916,7 @@ interface components$q {
900
916
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
901
917
  */
902
918
  DataResourceDefinitions: {
903
- [key: string]: components$q["schemas"]["DataResourceDefinition"];
919
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
904
920
  };
905
921
  /** Defines a data resource, which is a named JSON document, usually from an API response, which may be projected onto parameters */
906
922
  DataResourceDefinition: {
@@ -919,7 +935,7 @@ interface components$q {
919
935
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
920
936
  */
921
937
  optionalPatternParameter?: boolean;
922
- variables?: components$q["schemas"]["DataResourceVariables"];
938
+ variables?: components$r["schemas"]["DataResourceVariables"];
923
939
  };
924
940
  /** Variable values for a data resource */
925
941
  DataResourceVariables: {
@@ -942,7 +958,7 @@ interface components$q {
942
958
  /** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
943
959
  truncated?: boolean;
944
960
  /** Version history entries */
945
- results?: components$q["schemas"]["HistoryEntry"][];
961
+ results?: components$r["schemas"]["HistoryEntry"][];
946
962
  };
947
963
  HistoryEntry: {
948
964
  /** The version ID of the entity. This can be used to fetch the version's data via the entity API */
@@ -989,7 +1005,7 @@ interface components$q {
989
1005
  * Unique identifier for the project map that this node belongs to
990
1006
  */
991
1007
  projectMapId: string;
992
- data?: components$q["schemas"]["ProjectMapNodeData"];
1008
+ data?: components$r["schemas"]["ProjectMapNodeData"];
993
1009
  /**
994
1010
  * Locale-specific paths of the project map node.
995
1011
  * Keys are locale codes
@@ -1043,7 +1059,7 @@ interface components$q {
1043
1059
  initialStage: string;
1044
1060
  /** All stages of the workflow */
1045
1061
  stages: {
1046
- [key: string]: components$q["schemas"]["WorkflowStage"];
1062
+ [key: string]: components$r["schemas"]["WorkflowStage"];
1047
1063
  };
1048
1064
  /** Last modified ISO date string for this definition (ignored for writes) */
1049
1065
  modified?: string;
@@ -1073,7 +1089,7 @@ interface components$q {
1073
1089
  * listed here, the stage is read-only and publishing is disabled
1074
1090
  */
1075
1091
  permissions: {
1076
- [key: string]: components$q["schemas"]["WorkflowStagePermission"];
1092
+ [key: string]: components$r["schemas"]["WorkflowStagePermission"];
1077
1093
  };
1078
1094
  /**
1079
1095
  * When true, transitioning into this stage from a different stage will automatically publish the entity.
@@ -1093,7 +1109,7 @@ interface components$q {
1093
1109
  * Every stage must define at least one transition, to avoid creating a workflow that
1094
1110
  * has a stage that can never be escaped
1095
1111
  */
1096
- transitions: components$q["schemas"]["WorkflowStageTransition"][];
1112
+ transitions: components$r["schemas"]["WorkflowStageTransition"][];
1097
1113
  /**
1098
1114
  * Icon name for the stage (e.g. 'chevron-double-right-o')
1099
1115
  * @defaultValue chevron-double-right-o
@@ -1119,7 +1135,7 @@ interface components$q {
1119
1135
  * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
1120
1136
  */
1121
1137
  permissions: {
1122
- [key: string]: components$q["schemas"]["WorkflowStageTransitionPermission"];
1138
+ [key: string]: components$r["schemas"]["WorkflowStageTransitionPermission"];
1123
1139
  };
1124
1140
  };
1125
1141
  /** Permissions for a workflow stage */
@@ -1145,6 +1161,12 @@ interface components$q {
1145
1161
  value?: string;
1146
1162
  /** Help text for authors who might be setting up a preview value for this query string */
1147
1163
  helpText?: string;
1164
+ /**
1165
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
1166
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
1167
+
1168
+ */
1169
+ editorVisibility?: "opt-in";
1148
1170
  /** Configuration for providing a list of allowed values for this query string */
1149
1171
  optionsSource?: {
1150
1172
  /**
@@ -1164,7 +1186,7 @@ interface components$q {
1164
1186
  /** While performing a search if a node is a hit, this property will return true. If it's supporting structure, like a parent of a search hit, it will return false */
1165
1187
  isSearchHit?: boolean;
1166
1188
  /** Query strings that are allowed to be passed to the node */
1167
- queryStrings?: components$q["schemas"]["ProjectMapNodeAllowedQueryString"][];
1189
+ queryStrings?: components$r["schemas"]["ProjectMapNodeAllowedQueryString"][];
1168
1190
  /**
1169
1191
  * For dynamic nodes, this is the preview value for the dynamic value.
1170
1192
  * The preview value is used when editing a connected composition, and is the default
@@ -1180,8 +1202,8 @@ interface components$q {
1180
1202
  pathItems: never;
1181
1203
  }
1182
1204
 
1183
- type SharedComponents$3 = components$q['schemas'];
1184
- type Api$2 = paths$n['/api/v1/categories'];
1205
+ type SharedComponents$3 = components$r['schemas'];
1206
+ type Api$2 = paths$o['/api/v1/categories'];
1185
1207
  /** Shape of the GET response from /api/v1/category */
1186
1208
  type CategoriesGetResponse = Api$2['get']['responses']['200']['content']['application/json'];
1187
1209
  /** Shape of the PUT request body for /api/v1/category */
@@ -1197,11 +1219,11 @@ declare class CategoryClient extends ApiClient {
1197
1219
  constructor(options: ClientOptions);
1198
1220
  /** Fetches a list of categories created in given project */
1199
1221
  list(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
1200
- categories: components$r["schemas"]["Category"][];
1222
+ categories: components$s["schemas"]["Category"][];
1201
1223
  }>;
1202
1224
  /** @deprecated Use {@link list} instead. */
1203
1225
  getCategories(options?: Omit<CategoriesGetParameters, 'projectId'>): Promise<{
1204
- categories: components$r["schemas"]["Category"][];
1226
+ categories: components$s["schemas"]["Category"][];
1205
1227
  }>;
1206
1228
  /** Updates or creates a category, also used to re-order them */
1207
1229
  save(categories: CategoriesPutParameters['categories']): Promise<unknown>;
@@ -1217,7 +1239,7 @@ declare class UncachedCategoryClient extends CategoryClient {
1217
1239
  constructor(options: Omit<ClientOptions, 'bypassCache'>);
1218
1240
  }
1219
1241
 
1220
- interface paths$m {
1242
+ interface paths$n {
1221
1243
  "/api/v1/canvas-definitions": {
1222
1244
  parameters: {
1223
1245
  query?: never;
@@ -1255,15 +1277,15 @@ interface paths$m {
1255
1277
  content: {
1256
1278
  "application/json": {
1257
1279
  /** Component definitions that match the query */
1258
- componentDefinitions: components$p["schemas"]["ComponentDefinition"][];
1280
+ componentDefinitions: components$q["schemas"]["ComponentDefinition"][];
1259
1281
  };
1260
1282
  };
1261
1283
  };
1262
- 400: components$p["responses"]["BadRequestError"];
1263
- 401: components$p["responses"]["UnauthorizedError"];
1264
- 403: components$p["responses"]["ForbiddenError"];
1265
- 429: components$p["responses"]["RateLimitError"];
1266
- 500: components$p["responses"]["InternalServerError"];
1284
+ 400: components$q["responses"]["BadRequestError"];
1285
+ 401: components$q["responses"]["UnauthorizedError"];
1286
+ 403: components$q["responses"]["ForbiddenError"];
1287
+ 429: components$q["responses"]["RateLimitError"];
1288
+ 500: components$q["responses"]["InternalServerError"];
1267
1289
  };
1268
1290
  };
1269
1291
  /** Upserts a component definition */
@@ -1282,7 +1304,7 @@ interface paths$m {
1282
1304
  * The project ID to upsert the component definition to
1283
1305
  */
1284
1306
  projectId: string;
1285
- componentDefinition: components$p["schemas"]["ComponentDefinition"];
1307
+ componentDefinition: components$q["schemas"]["ComponentDefinition"];
1286
1308
  };
1287
1309
  };
1288
1310
  };
@@ -1294,11 +1316,11 @@ interface paths$m {
1294
1316
  };
1295
1317
  content?: never;
1296
1318
  };
1297
- 400: components$p["responses"]["BadRequestError"];
1298
- 401: components$p["responses"]["UnauthorizedError"];
1299
- 403: components$p["responses"]["ForbiddenError"];
1300
- 429: components$p["responses"]["RateLimitError"];
1301
- 500: components$p["responses"]["InternalServerError"];
1319
+ 400: components$q["responses"]["BadRequestError"];
1320
+ 401: components$q["responses"]["UnauthorizedError"];
1321
+ 403: components$q["responses"]["ForbiddenError"];
1322
+ 429: components$q["responses"]["RateLimitError"];
1323
+ 500: components$q["responses"]["InternalServerError"];
1302
1324
  };
1303
1325
  };
1304
1326
  post?: never;
@@ -1331,11 +1353,11 @@ interface paths$m {
1331
1353
  };
1332
1354
  content?: never;
1333
1355
  };
1334
- 400: components$p["responses"]["BadRequestError"];
1335
- 401: components$p["responses"]["UnauthorizedError"];
1336
- 403: components$p["responses"]["ForbiddenError"];
1337
- 429: components$p["responses"]["RateLimitError"];
1338
- 500: components$p["responses"]["InternalServerError"];
1356
+ 400: components$q["responses"]["BadRequestError"];
1357
+ 401: components$q["responses"]["UnauthorizedError"];
1358
+ 403: components$q["responses"]["ForbiddenError"];
1359
+ 429: components$q["responses"]["RateLimitError"];
1360
+ 500: components$q["responses"]["InternalServerError"];
1339
1361
  };
1340
1362
  };
1341
1363
  /** Handles preflight requests. This endpoint allows CORS */
@@ -1362,13 +1384,13 @@ interface paths$m {
1362
1384
  trace?: never;
1363
1385
  };
1364
1386
  }
1365
- interface components$p {
1387
+ interface components$q {
1366
1388
  schemas: {
1367
1389
  /** Public ID (used in code). Do not change after creation */
1368
1390
  PublicIdProperty: string;
1369
1391
  /** The definition of a component parameter */
1370
1392
  ComponentDefinitionParameter: {
1371
- id: components$p["schemas"]["PublicIdProperty"];
1393
+ id: components$q["schemas"]["PublicIdProperty"];
1372
1394
  /** Friendly name of the parameter */
1373
1395
  name: string;
1374
1396
  /** Appears next to the parameter in the Composition editor */
@@ -1402,7 +1424,7 @@ interface components$p {
1402
1424
  };
1403
1425
  /** Permission set for a component definition */
1404
1426
  ComponentDefinitionPermission: {
1405
- roleId: components$p["schemas"]["PublicIdProperty"];
1427
+ roleId: components$q["schemas"]["PublicIdProperty"];
1406
1428
  /**
1407
1429
  * Permission type for this permission ComponentDefinition:
1408
1430
  * read | write | create | delete
@@ -1414,7 +1436,7 @@ interface components$p {
1414
1436
  };
1415
1437
  /** The definition of a named component slot that can contain other components */
1416
1438
  ComponentDefinitionSlot: {
1417
- id: components$p["schemas"]["PublicIdProperty"];
1439
+ id: components$q["schemas"]["PublicIdProperty"];
1418
1440
  /** Friendly name of the slot */
1419
1441
  name: string;
1420
1442
  /** A list of component definition public IDs that are allowed in this named slot */
@@ -1531,11 +1553,11 @@ interface components$p {
1531
1553
 
1532
1554
  */
1533
1555
  op?: "&" | "|";
1534
- clauses: (components$p["schemas"]["VisibilityCriteria"] | components$p["schemas"]["VisibilityCriteriaGroup"])[];
1556
+ clauses: (components$q["schemas"]["VisibilityCriteria"] | components$q["schemas"]["VisibilityCriteriaGroup"])[];
1535
1557
  };
1536
1558
  /** Defines a conditional value for a component parameter */
1537
1559
  ComponentParameterConditionalValue: {
1538
- when: components$p["schemas"]["VisibilityCriteriaGroup"];
1560
+ when: components$q["schemas"]["VisibilityCriteriaGroup"];
1539
1561
  /**
1540
1562
  * The value of the parameter. Any JSON-serializable value is acceptable.
1541
1563
  * A value of `null` will cause the parameter value to be removed, if it matches.
@@ -1557,7 +1579,7 @@ interface components$p {
1557
1579
  *
1558
1580
  * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
1559
1581
  */
1560
- ComponentParameterConditions: components$p["schemas"]["ComponentParameterConditionalValue"][];
1582
+ ComponentParameterConditions: components$q["schemas"]["ComponentParameterConditionalValue"][];
1561
1583
  /** Defines an editable parameter on a component */
1562
1584
  ComponentParameter: {
1563
1585
  /** The value of the parameter. Any JSON-serializable value is acceptable */
@@ -1565,7 +1587,7 @@ interface components$p {
1565
1587
  /** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
1566
1588
  type: string;
1567
1589
  /** @deprecated */
1568
- connectedData?: components$p["schemas"]["DataElementConnectionDefinition"];
1590
+ connectedData?: components$q["schemas"]["DataElementConnectionDefinition"];
1569
1591
  /**
1570
1592
  * Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
1571
1593
  * Note that locales must be registered on the entry/composition `_locales` before being used
@@ -1573,10 +1595,10 @@ interface components$p {
1573
1595
  locales?: {
1574
1596
  [key: string]: unknown;
1575
1597
  };
1576
- conditions?: components$p["schemas"]["ComponentParameterConditions"];
1598
+ conditions?: components$q["schemas"]["ComponentParameterConditions"];
1577
1599
  /** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
1578
1600
  localesConditions?: {
1579
- [key: string]: components$p["schemas"]["ComponentParameterConditions"];
1601
+ [key: string]: components$q["schemas"]["ComponentParameterConditions"];
1580
1602
  };
1581
1603
  };
1582
1604
  /** Defines the shape of a component instance served by the composition API */
@@ -1585,13 +1607,13 @@ interface components$p {
1585
1607
  type: string;
1586
1608
  /** Component parameter values for the component instance */
1587
1609
  parameters?: {
1588
- [key: string]: components$p["schemas"]["ComponentParameter"];
1610
+ [key: string]: components$q["schemas"]["ComponentParameter"];
1589
1611
  };
1590
1612
  /** Public ID of alternate visual appearance for this component, if any selected */
1591
1613
  variant?: string;
1592
1614
  /** Slots containing any child components */
1593
1615
  slots?: {
1594
- [key: string]: components$p["schemas"]["ComponentInstance"][];
1616
+ [key: string]: components$q["schemas"]["ComponentInstance"][];
1595
1617
  };
1596
1618
  /**
1597
1619
  * Unique identifier of the component within the composition.
@@ -1602,15 +1624,20 @@ interface components$p {
1602
1624
  _id?: string;
1603
1625
  /** Indicates this component instance should be sourced from a pattern library pattern */
1604
1626
  _pattern?: string;
1605
- _dataResources?: components$p["schemas"]["DataResourceDefinitions"];
1627
+ _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
1606
1628
  /**
1607
1629
  * Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
1608
1630
  * Means nothing for PUTs; it will be ignored
1609
1631
  */
1610
1632
  _patternDataResources?: {
1611
- [key: string]: components$p["schemas"]["DataResourceDefinition"];
1633
+ [key: string]: components$q["schemas"]["DataResourceDefinition"];
1612
1634
  };
1613
- _patternError?: components$p["schemas"]["PatternError"];
1635
+ /**
1636
+ * Query-string opt-ins coming from a pattern resolved for this component.
1637
+ * Means nothing for PUTs; it will be ignored
1638
+ */
1639
+ _patternOptedInQueryStrings?: string[];
1640
+ _patternError?: components$q["schemas"]["PatternError"];
1614
1641
  /**
1615
1642
  * Defines patch overrides to component IDs that live in the composition.
1616
1643
  * This can be used to override parameters that are defined on patterns,
@@ -1624,14 +1651,14 @@ interface components$p {
1624
1651
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
1625
1652
  */
1626
1653
  _overrides?: {
1627
- [key: string]: components$p["schemas"]["ComponentOverride"];
1654
+ [key: string]: components$q["schemas"]["ComponentOverride"];
1628
1655
  };
1629
1656
  /**
1630
1657
  * Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
1631
1658
  * Means nothing for PUTs; it will be ignored
1632
1659
  */
1633
1660
  _patternOverrides?: {
1634
- [key: string]: components$p["schemas"]["ComponentOverride"];
1661
+ [key: string]: components$q["schemas"]["ComponentOverride"];
1635
1662
  };
1636
1663
  /**
1637
1664
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -1640,7 +1667,7 @@ interface components$p {
1640
1667
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
1641
1668
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
1642
1669
  */
1643
- _overridability?: components$p["schemas"]["ComponentOverridability"];
1670
+ _overridability?: components$q["schemas"]["ComponentOverridability"];
1644
1671
  /** Array of locales that have data defined. Only set for pattern references or composition defaults */
1645
1672
  _locales?: string[];
1646
1673
  };
@@ -1665,14 +1692,14 @@ interface components$p {
1665
1692
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
1666
1693
  */
1667
1694
  optionalPatternParameter?: boolean;
1668
- variables?: components$p["schemas"]["DataResourceVariables"];
1695
+ variables?: components$q["schemas"]["DataResourceVariables"];
1669
1696
  };
1670
1697
  /**
1671
1698
  * Data definitions attached to this component. The property name is the key of the data in the data document.
1672
1699
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
1673
1700
  */
1674
1701
  DataResourceDefinitions: {
1675
- [key: string]: components$p["schemas"]["DataResourceDefinition"];
1702
+ [key: string]: components$q["schemas"]["DataResourceDefinition"];
1676
1703
  };
1677
1704
  /**
1678
1705
  * Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -1690,10 +1717,10 @@ interface components$p {
1690
1717
  */
1691
1718
  ComponentOverride: {
1692
1719
  parameters?: {
1693
- [key: string]: components$p["schemas"]["ComponentParameter"];
1720
+ [key: string]: components$q["schemas"]["ComponentParameter"];
1694
1721
  };
1695
1722
  slots?: {
1696
- [key: string]: components$p["schemas"]["ComponentInstance"][];
1723
+ [key: string]: components$q["schemas"]["ComponentInstance"][];
1697
1724
  };
1698
1725
  variant?: string;
1699
1726
  /**
@@ -1702,7 +1729,7 @@ interface components$p {
1702
1729
  * Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
1703
1730
  */
1704
1731
  dataResources?: {
1705
- [key: string]: components$p["schemas"]["DataResourceDefinition"];
1732
+ [key: string]: components$q["schemas"]["DataResourceDefinition"];
1706
1733
  };
1707
1734
  };
1708
1735
  /**
@@ -1723,7 +1750,7 @@ interface components$p {
1723
1750
  ComponentOverridability: {
1724
1751
  /** Defines component parameter value overrides. Keys are the parameter public ID */
1725
1752
  parameters?: {
1726
- [key: string]: components$p["schemas"]["OverrideOptions"];
1753
+ [key: string]: components$q["schemas"]["OverrideOptions"];
1727
1754
  };
1728
1755
  /** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
1729
1756
  variants?: boolean;
@@ -1736,13 +1763,13 @@ interface components$p {
1736
1763
  };
1737
1764
  /** The definition of a component variant */
1738
1765
  ComponentDefinitionVariant: {
1739
- id: components$p["schemas"]["PublicIdProperty"];
1766
+ id: components$q["schemas"]["PublicIdProperty"];
1740
1767
  /** Friendly name of the variant */
1741
1768
  name: string;
1742
1769
  };
1743
1770
  /** Defines a component type that can live on a Composition */
1744
1771
  ComponentDefinition: {
1745
- id: components$p["schemas"]["PublicIdProperty"];
1772
+ id: components$q["schemas"]["PublicIdProperty"];
1746
1773
  /** Friendly name of the component definition */
1747
1774
  name: string;
1748
1775
  /**
@@ -1767,7 +1794,7 @@ interface components$p {
1767
1794
  */
1768
1795
  canBeComposition?: boolean;
1769
1796
  /** The parameters for this component. Parameters are key-value pairs that can be anything from text values to links to CMS entries */
1770
- parameters?: components$p["schemas"]["ComponentDefinitionParameter"][];
1797
+ parameters?: components$q["schemas"]["ComponentDefinitionParameter"][];
1771
1798
  /**
1772
1799
  * Format: uuid
1773
1800
  * Reference to the category this component definition belongs to
@@ -1784,14 +1811,14 @@ interface components$p {
1784
1811
  */
1785
1812
  useTeamPermissions?: boolean;
1786
1813
  /** Custom role permissions for this component definition */
1787
- permissions?: components$p["schemas"]["ComponentDefinitionPermission"][];
1814
+ permissions?: components$q["schemas"]["ComponentDefinitionPermission"][];
1788
1815
  /** The named slots for this component; placement areas where arrays of other components can be added */
1789
- slots?: components$p["schemas"]["ComponentDefinitionSlot"][];
1790
- slugSettings?: components$p["schemas"]["ComponentDefinitionSlugSettings"];
1816
+ slots?: components$q["schemas"]["ComponentDefinitionSlot"][];
1817
+ slugSettings?: components$q["schemas"]["ComponentDefinitionSlugSettings"];
1791
1818
  /** Default component instance value */
1792
- defaults?: components$p["schemas"]["ComponentInstance"] | null;
1819
+ defaults?: components$q["schemas"]["ComponentInstance"] | null;
1793
1820
  /** Named variants for this component; enables the creation of visual variants that use the same parameter data */
1794
- variants?: components$p["schemas"]["ComponentDefinitionVariant"][];
1821
+ variants?: components$q["schemas"]["ComponentDefinitionVariant"][];
1795
1822
  /** Created date string for this definition (ignored for writes) */
1796
1823
  created?: string;
1797
1824
  /** Last modified date string for this definition (ignored for writes) */
@@ -1814,7 +1841,7 @@ interface components$p {
1814
1841
  [name: string]: unknown;
1815
1842
  };
1816
1843
  content: {
1817
- "application/json": components$p["schemas"]["Error"];
1844
+ "application/json": components$q["schemas"]["Error"];
1818
1845
  };
1819
1846
  };
1820
1847
  /** API key or token was not valid */
@@ -1823,7 +1850,7 @@ interface components$p {
1823
1850
  [name: string]: unknown;
1824
1851
  };
1825
1852
  content: {
1826
- "application/json": components$p["schemas"]["Error"];
1853
+ "application/json": components$q["schemas"]["Error"];
1827
1854
  };
1828
1855
  };
1829
1856
  /** Permission was denied */
@@ -1832,7 +1859,7 @@ interface components$p {
1832
1859
  [name: string]: unknown;
1833
1860
  };
1834
1861
  content: {
1835
- "application/json": components$p["schemas"]["Error"];
1862
+ "application/json": components$q["schemas"]["Error"];
1836
1863
  };
1837
1864
  };
1838
1865
  /** Too many requests in allowed time period */
@@ -1856,8 +1883,8 @@ interface components$p {
1856
1883
  pathItems: never;
1857
1884
  }
1858
1885
 
1859
- type SharedComponents$2 = components$q['schemas'];
1860
- type Api$1 = paths$m['/api/v1/canvas-definitions'];
1886
+ type SharedComponents$2 = components$r['schemas'];
1887
+ type Api$1 = paths$n['/api/v1/canvas-definitions'];
1861
1888
  /** Shape of the GET response from /api/v1/canvas-definitions */
1862
1889
  type ComponentDefinitionGetResponse = Api$1['get']['responses']['200']['content']['application/json'];
1863
1890
  /** Shape of the PUT request body for /api/v1/canvas-definitions */
@@ -1867,7 +1894,7 @@ type ComponentDefinitionDeleteParameters = Api$1['delete']['requestBody']['conte
1867
1894
  /** Query parameter options for GET /api/v1/canvas-definitions */
1868
1895
  type ComponentDefinitionGetParameters = Api$1['get']['parameters']['query'];
1869
1896
  /** The definition of a component parameter */
1870
- type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$q['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
1897
+ type ComponentDefinitionParameter<TConfig = unknown> = Omit<components$r['schemas']['ComponentDefinitionParameter'], 'typeConfig'> & {
1871
1898
  typeConfig?: TConfig;
1872
1899
  };
1873
1900
  /** The definition of a component visual variant */
@@ -2018,7 +2045,7 @@ declare const ASSETS_SOURCE_CUSTOM_URL = "custom-url";
2018
2045
  /** The data type ID for internal content references (entry-to-entry relationships) */
2019
2046
  declare const REFERENCE_DATA_TYPE_ID = "uniformContentInternalReference";
2020
2047
 
2021
- interface components$o {
2048
+ interface components$p {
2022
2049
  schemas: {
2023
2050
  /** Defines the shape of the entry */
2024
2051
  Entry: {
@@ -2049,15 +2076,15 @@ interface components$o {
2049
2076
  _locales?: string[];
2050
2077
  /** Entry field values */
2051
2078
  fields?: {
2052
- [key: string]: components$o["schemas"]["ComponentParameter"];
2079
+ [key: string]: components$p["schemas"]["ComponentParameter"];
2053
2080
  };
2054
- _dataResources?: components$o["schemas"]["DataResourceDefinitions"];
2081
+ _dataResources?: components$p["schemas"]["DataResourceDefinitions"];
2055
2082
  /**
2056
2083
  * Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
2057
2084
  * Means nothing for PUTs; it will be ignored
2058
2085
  */
2059
2086
  _patternDataResources?: {
2060
- [key: string]: components$o["schemas"]["DataResourceDefinition"];
2087
+ [key: string]: components$p["schemas"]["DataResourceDefinition"];
2061
2088
  };
2062
2089
  /**
2063
2090
  * Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -2080,7 +2107,7 @@ interface components$o {
2080
2107
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
2081
2108
  */
2082
2109
  _overrides?: {
2083
- [key: string]: components$o["schemas"]["ComponentOverride"];
2110
+ [key: string]: components$p["schemas"]["ComponentOverride"];
2084
2111
  };
2085
2112
  /**
2086
2113
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -2089,7 +2116,7 @@ interface components$o {
2089
2116
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2090
2117
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
2091
2118
  */
2092
- _overridability?: components$o["schemas"]["ComponentOverridability"];
2119
+ _overridability?: components$p["schemas"]["ComponentOverridability"];
2093
2120
  };
2094
2121
  /** Defines the shape of the entry input */
2095
2122
  EntryInput: {
@@ -2116,9 +2143,9 @@ interface components$o {
2116
2143
  _creatorSubject?: string;
2117
2144
  /** Entry field values */
2118
2145
  fields?: {
2119
- [key: string]: components$o["schemas"]["ComponentParameter"];
2146
+ [key: string]: components$p["schemas"]["ComponentParameter"];
2120
2147
  };
2121
- _dataResources?: components$o["schemas"]["DataResourceDefinitions"];
2148
+ _dataResources?: components$p["schemas"]["DataResourceDefinitions"];
2122
2149
  /** Indicates this content entry should be sourced from a pattern library pattern */
2123
2150
  _pattern?: string;
2124
2151
  /**
@@ -2126,7 +2153,7 @@ interface components$o {
2126
2153
  * Means nothing for PUTs; it will be ignored
2127
2154
  */
2128
2155
  _patternDataResources?: {
2129
- [key: string]: components$o["schemas"]["DataResourceDefinition"];
2156
+ [key: string]: components$p["schemas"]["DataResourceDefinition"];
2130
2157
  };
2131
2158
  /**
2132
2159
  * Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -2144,7 +2171,7 @@ interface components$o {
2144
2171
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
2145
2172
  */
2146
2173
  _overrides?: {
2147
- [key: string]: components$o["schemas"]["ComponentOverride"];
2174
+ [key: string]: components$p["schemas"]["ComponentOverride"];
2148
2175
  };
2149
2176
  /**
2150
2177
  * When used on a pattern, defines how the pattern's fields may be overridden
@@ -2153,7 +2180,7 @@ interface components$o {
2153
2180
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2154
2181
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
2155
2182
  */
2156
- _overridability?: components$o["schemas"]["ComponentOverridability"];
2183
+ _overridability?: components$p["schemas"]["ComponentOverridability"];
2157
2184
  /** Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
2158
2185
  _locales?: string[];
2159
2186
  };
@@ -2196,7 +2223,7 @@ interface components$o {
2196
2223
  * @defaultValue false
2197
2224
  */
2198
2225
  pattern?: boolean;
2199
- entry: components$o["schemas"]["Entry"];
2226
+ entry: components$p["schemas"]["Entry"];
2200
2227
  /**
2201
2228
  * Format: uuid
2202
2229
  * The workflow ID that this entry is assigned. Normally comes from the content type
@@ -2208,7 +2235,7 @@ interface components$o {
2208
2235
  */
2209
2236
  workflowStageId?: string;
2210
2237
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
2211
- workflowDefinition?: components$o["schemas"]["WorkflowDefinition"];
2238
+ workflowDefinition?: components$p["schemas"]["WorkflowDefinition"];
2212
2239
  /**
2213
2240
  * Only present if an incomplete entry is returned; indicates reason for stubbing
2214
2241
 
@@ -2231,7 +2258,7 @@ interface components$o {
2231
2258
  editionPriority?: number;
2232
2259
  };
2233
2260
  EntryListResponse: {
2234
- entries: components$o["schemas"]["EntryApiResponse"][];
2261
+ entries: components$p["schemas"]["EntryApiResponse"][];
2235
2262
  /** Total number of entries that match the query. Only present when `withTotalCount` option is true */
2236
2263
  totalCount?: number;
2237
2264
  /** Per-field counts for distinct values */
@@ -2305,11 +2332,11 @@ interface components$o {
2305
2332
 
2306
2333
  */
2307
2334
  op?: "&" | "|";
2308
- clauses: (components$o["schemas"]["VisibilityCriteria"] | components$o["schemas"]["VisibilityCriteriaGroup"])[];
2335
+ clauses: (components$p["schemas"]["VisibilityCriteria"] | components$p["schemas"]["VisibilityCriteriaGroup"])[];
2309
2336
  };
2310
2337
  /** Defines a conditional value for a component parameter */
2311
2338
  ComponentParameterConditionalValue: {
2312
- when: components$o["schemas"]["VisibilityCriteriaGroup"];
2339
+ when: components$p["schemas"]["VisibilityCriteriaGroup"];
2313
2340
  /**
2314
2341
  * The value of the parameter. Any JSON-serializable value is acceptable.
2315
2342
  * A value of `null` will cause the parameter value to be removed, if it matches.
@@ -2331,7 +2358,7 @@ interface components$o {
2331
2358
  *
2332
2359
  * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
2333
2360
  */
2334
- ComponentParameterConditions: components$o["schemas"]["ComponentParameterConditionalValue"][];
2361
+ ComponentParameterConditions: components$p["schemas"]["ComponentParameterConditionalValue"][];
2335
2362
  /** Defines an editable parameter on a component */
2336
2363
  ComponentParameter: {
2337
2364
  /** The value of the parameter. Any JSON-serializable value is acceptable */
@@ -2339,7 +2366,7 @@ interface components$o {
2339
2366
  /** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
2340
2367
  type: string;
2341
2368
  /** @deprecated */
2342
- connectedData?: components$o["schemas"]["DataElementConnectionDefinition"];
2369
+ connectedData?: components$p["schemas"]["DataElementConnectionDefinition"];
2343
2370
  /**
2344
2371
  * Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
2345
2372
  * Note that locales must be registered on the entry/composition `_locales` before being used
@@ -2347,10 +2374,10 @@ interface components$o {
2347
2374
  locales?: {
2348
2375
  [key: string]: unknown;
2349
2376
  };
2350
- conditions?: components$o["schemas"]["ComponentParameterConditions"];
2377
+ conditions?: components$p["schemas"]["ComponentParameterConditions"];
2351
2378
  /** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
2352
2379
  localesConditions?: {
2353
- [key: string]: components$o["schemas"]["ComponentParameterConditions"];
2380
+ [key: string]: components$p["schemas"]["ComponentParameterConditions"];
2354
2381
  };
2355
2382
  };
2356
2383
  /** Variable values for a data resource */
@@ -2374,14 +2401,14 @@ interface components$o {
2374
2401
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
2375
2402
  */
2376
2403
  optionalPatternParameter?: boolean;
2377
- variables?: components$o["schemas"]["DataResourceVariables"];
2404
+ variables?: components$p["schemas"]["DataResourceVariables"];
2378
2405
  };
2379
2406
  /**
2380
2407
  * Data definitions attached to this component. The property name is the key of the data in the data document.
2381
2408
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
2382
2409
  */
2383
2410
  DataResourceDefinitions: {
2384
- [key: string]: components$o["schemas"]["DataResourceDefinition"];
2411
+ [key: string]: components$p["schemas"]["DataResourceDefinition"];
2385
2412
  };
2386
2413
  /** Defines the shape of a component instance served by the composition API */
2387
2414
  ComponentInstance: {
@@ -2389,13 +2416,13 @@ interface components$o {
2389
2416
  type: string;
2390
2417
  /** Component parameter values for the component instance */
2391
2418
  parameters?: {
2392
- [key: string]: components$o["schemas"]["ComponentParameter"];
2419
+ [key: string]: components$p["schemas"]["ComponentParameter"];
2393
2420
  };
2394
2421
  /** Public ID of alternate visual appearance for this component, if any selected */
2395
2422
  variant?: string;
2396
2423
  /** Slots containing any child components */
2397
2424
  slots?: {
2398
- [key: string]: components$o["schemas"]["ComponentInstance"][];
2425
+ [key: string]: components$p["schemas"]["ComponentInstance"][];
2399
2426
  };
2400
2427
  /**
2401
2428
  * Unique identifier of the component within the composition.
@@ -2406,15 +2433,20 @@ interface components$o {
2406
2433
  _id?: string;
2407
2434
  /** Indicates this component instance should be sourced from a pattern library pattern */
2408
2435
  _pattern?: string;
2409
- _dataResources?: components$o["schemas"]["DataResourceDefinitions"];
2436
+ _dataResources?: components$p["schemas"]["DataResourceDefinitions"];
2410
2437
  /**
2411
2438
  * Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
2412
2439
  * Means nothing for PUTs; it will be ignored
2413
2440
  */
2414
2441
  _patternDataResources?: {
2415
- [key: string]: components$o["schemas"]["DataResourceDefinition"];
2442
+ [key: string]: components$p["schemas"]["DataResourceDefinition"];
2416
2443
  };
2417
- _patternError?: components$o["schemas"]["PatternError"];
2444
+ /**
2445
+ * Query-string opt-ins coming from a pattern resolved for this component.
2446
+ * Means nothing for PUTs; it will be ignored
2447
+ */
2448
+ _patternOptedInQueryStrings?: string[];
2449
+ _patternError?: components$p["schemas"]["PatternError"];
2418
2450
  /**
2419
2451
  * Defines patch overrides to component IDs that live in the composition.
2420
2452
  * This can be used to override parameters that are defined on patterns,
@@ -2428,14 +2460,14 @@ interface components$o {
2428
2460
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
2429
2461
  */
2430
2462
  _overrides?: {
2431
- [key: string]: components$o["schemas"]["ComponentOverride"];
2463
+ [key: string]: components$p["schemas"]["ComponentOverride"];
2432
2464
  };
2433
2465
  /**
2434
2466
  * Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
2435
2467
  * Means nothing for PUTs; it will be ignored
2436
2468
  */
2437
2469
  _patternOverrides?: {
2438
- [key: string]: components$o["schemas"]["ComponentOverride"];
2470
+ [key: string]: components$p["schemas"]["ComponentOverride"];
2439
2471
  };
2440
2472
  /**
2441
2473
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -2444,7 +2476,7 @@ interface components$o {
2444
2476
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
2445
2477
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
2446
2478
  */
2447
- _overridability?: components$o["schemas"]["ComponentOverridability"];
2479
+ _overridability?: components$p["schemas"]["ComponentOverridability"];
2448
2480
  /** Array of locales that have data defined. Only set for pattern references or composition defaults */
2449
2481
  _locales?: string[];
2450
2482
  };
@@ -2464,10 +2496,10 @@ interface components$o {
2464
2496
  */
2465
2497
  ComponentOverride: {
2466
2498
  parameters?: {
2467
- [key: string]: components$o["schemas"]["ComponentParameter"];
2499
+ [key: string]: components$p["schemas"]["ComponentParameter"];
2468
2500
  };
2469
2501
  slots?: {
2470
- [key: string]: components$o["schemas"]["ComponentInstance"][];
2502
+ [key: string]: components$p["schemas"]["ComponentInstance"][];
2471
2503
  };
2472
2504
  variant?: string;
2473
2505
  /**
@@ -2476,7 +2508,7 @@ interface components$o {
2476
2508
  * Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
2477
2509
  */
2478
2510
  dataResources?: {
2479
- [key: string]: components$o["schemas"]["DataResourceDefinition"];
2511
+ [key: string]: components$p["schemas"]["DataResourceDefinition"];
2480
2512
  };
2481
2513
  };
2482
2514
  /**
@@ -2497,7 +2529,7 @@ interface components$o {
2497
2529
  ComponentOverridability: {
2498
2530
  /** Defines component parameter value overrides. Keys are the parameter public ID */
2499
2531
  parameters?: {
2500
- [key: string]: components$o["schemas"]["OverrideOptions"];
2532
+ [key: string]: components$p["schemas"]["OverrideOptions"];
2501
2533
  };
2502
2534
  /** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
2503
2535
  variants?: boolean;
@@ -2537,7 +2569,7 @@ interface components$o {
2537
2569
  * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
2538
2570
  */
2539
2571
  permissions: {
2540
- [key: string]: components$o["schemas"]["WorkflowStageTransitionPermission"];
2572
+ [key: string]: components$p["schemas"]["WorkflowStageTransitionPermission"];
2541
2573
  };
2542
2574
  };
2543
2575
  /** Definition of a stage in a workflow */
@@ -2551,7 +2583,7 @@ interface components$o {
2551
2583
  * listed here, the stage is read-only and publishing is disabled
2552
2584
  */
2553
2585
  permissions: {
2554
- [key: string]: components$o["schemas"]["WorkflowStagePermission"];
2586
+ [key: string]: components$p["schemas"]["WorkflowStagePermission"];
2555
2587
  };
2556
2588
  /**
2557
2589
  * When true, transitioning into this stage from a different stage will automatically publish the entity.
@@ -2571,7 +2603,7 @@ interface components$o {
2571
2603
  * Every stage must define at least one transition, to avoid creating a workflow that
2572
2604
  * has a stage that can never be escaped
2573
2605
  */
2574
- transitions: components$o["schemas"]["WorkflowStageTransition"][];
2606
+ transitions: components$p["schemas"]["WorkflowStageTransition"][];
2575
2607
  /**
2576
2608
  * Icon name for the stage (e.g. 'chevron-double-right-o')
2577
2609
  * @defaultValue chevron-double-right-o
@@ -2596,7 +2628,7 @@ interface components$o {
2596
2628
  initialStage: string;
2597
2629
  /** All stages of the workflow */
2598
2630
  stages: {
2599
- [key: string]: components$o["schemas"]["WorkflowStage"];
2631
+ [key: string]: components$p["schemas"]["WorkflowStage"];
2600
2632
  };
2601
2633
  /** Last modified ISO date string for this definition (ignored for writes) */
2602
2634
  modified?: string;
@@ -2685,17 +2717,24 @@ interface components$o {
2685
2717
  keyword: string;
2686
2718
  /**
2687
2719
  * Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
2688
- * skipOverridesResolution, withComponentIDs) overrides this alias.
2720
+ * skipOverridesResolution, withComponentIDs, skipContentTypeResolution) overrides this alias.
2689
2721
  * - `canonical`: PUT-safe structure — patterns and overrides left
2690
2722
  * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
2691
2723
  * (skipPatternResolution=true, skipOverridesResolution=true,
2692
- * withComponentIDs=true).
2724
+ * withComponentIDs=true, skipContentTypeResolution=false).
2693
2725
  * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
2694
2726
  * the expanded pattern nodes.
2695
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
2696
- * and component `_id`s removed.
2727
+ * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved,
2728
+ * component `_id`s removed, and each entry returned as stored
2729
+ * (skipContentTypeResolution=true).
2697
2730
  */
2698
2731
  format: "canonical" | "editor" | "delivery";
2732
+ /**
2733
+ * Improves performance by skipping dynamic data revalidations; appropriate for content delivery.
2734
+ * Default: true when `format` is delivery. False otherwise.
2735
+ * Prefer selecting a `format` rather than using this option.
2736
+ */
2737
+ skipContentTypeResolution: boolean;
2699
2738
  /**
2700
2739
  * If true, any pattern references in the composition will be left unresolved.
2701
2740
  * This is appropriate if you intend to serialize the composition without patterns
@@ -2790,7 +2829,7 @@ interface components$o {
2790
2829
  pathItems: never;
2791
2830
  }
2792
2831
 
2793
- interface paths$l {
2832
+ interface paths$m {
2794
2833
  "/api/v1/content-types": {
2795
2834
  parameters: {
2796
2835
  query?: never;
@@ -2826,15 +2865,15 @@ interface paths$l {
2826
2865
  content: {
2827
2866
  "application/json": {
2828
2867
  /** Content types that match the query */
2829
- contentTypes: components$n["schemas"]["ContentType"][];
2868
+ contentTypes: components$o["schemas"]["ContentType"][];
2830
2869
  };
2831
2870
  };
2832
2871
  };
2833
- 400: components$n["responses"]["BadRequestError"];
2834
- 401: components$n["responses"]["UnauthorizedError"];
2835
- 403: components$n["responses"]["ForbiddenError"];
2836
- 429: components$n["responses"]["RateLimitError"];
2837
- 500: components$n["responses"]["InternalServerError"];
2872
+ 400: components$o["responses"]["BadRequestError"];
2873
+ 401: components$o["responses"]["UnauthorizedError"];
2874
+ 403: components$o["responses"]["ForbiddenError"];
2875
+ 429: components$o["responses"]["RateLimitError"];
2876
+ 500: components$o["responses"]["InternalServerError"];
2838
2877
  };
2839
2878
  };
2840
2879
  /** Upserts a content type */
@@ -2853,7 +2892,7 @@ interface paths$l {
2853
2892
  * The project ID to upsert the content type to
2854
2893
  */
2855
2894
  projectId: string;
2856
- contentType: components$n["schemas"]["ContentType"];
2895
+ contentType: components$o["schemas"]["ContentType"];
2857
2896
  };
2858
2897
  };
2859
2898
  };
@@ -2865,11 +2904,11 @@ interface paths$l {
2865
2904
  };
2866
2905
  content?: never;
2867
2906
  };
2868
- 400: components$n["responses"]["BadRequestError"];
2869
- 401: components$n["responses"]["UnauthorizedError"];
2870
- 403: components$n["responses"]["ForbiddenError"];
2871
- 429: components$n["responses"]["RateLimitError"];
2872
- 500: components$n["responses"]["InternalServerError"];
2907
+ 400: components$o["responses"]["BadRequestError"];
2908
+ 401: components$o["responses"]["UnauthorizedError"];
2909
+ 403: components$o["responses"]["ForbiddenError"];
2910
+ 429: components$o["responses"]["RateLimitError"];
2911
+ 500: components$o["responses"]["InternalServerError"];
2873
2912
  };
2874
2913
  };
2875
2914
  post?: never;
@@ -2902,11 +2941,11 @@ interface paths$l {
2902
2941
  };
2903
2942
  content?: never;
2904
2943
  };
2905
- 400: components$n["responses"]["BadRequestError"];
2906
- 401: components$n["responses"]["UnauthorizedError"];
2907
- 403: components$n["responses"]["ForbiddenError"];
2908
- 429: components$n["responses"]["RateLimitError"];
2909
- 500: components$n["responses"]["InternalServerError"];
2944
+ 400: components$o["responses"]["BadRequestError"];
2945
+ 401: components$o["responses"]["UnauthorizedError"];
2946
+ 403: components$o["responses"]["ForbiddenError"];
2947
+ 429: components$o["responses"]["RateLimitError"];
2948
+ 500: components$o["responses"]["InternalServerError"];
2910
2949
  };
2911
2950
  };
2912
2951
  /** Handles preflight requests. This endpoint allows CORS */
@@ -2933,13 +2972,13 @@ interface paths$l {
2933
2972
  trace?: never;
2934
2973
  };
2935
2974
  }
2936
- interface components$n {
2975
+ interface components$o {
2937
2976
  schemas: {
2938
2977
  /** Public ID (used in code). Do not change after creation */
2939
2978
  PublicIdProperty: string;
2940
2979
  /** The definition of a component parameter */
2941
2980
  ComponentDefinitionParameter: {
2942
- id: components$n["schemas"]["PublicIdProperty"];
2981
+ id: components$o["schemas"]["PublicIdProperty"];
2943
2982
  /** Friendly name of the parameter */
2944
2983
  name: string;
2945
2984
  /** Appears next to the parameter in the Composition editor */
@@ -3000,7 +3039,7 @@ interface components$n {
3000
3039
  };
3001
3040
  /** Permission set for a component definition */
3002
3041
  ComponentDefinitionPermission: {
3003
- roleId: components$n["schemas"]["PublicIdProperty"];
3042
+ roleId: components$o["schemas"]["PublicIdProperty"];
3004
3043
  /**
3005
3044
  * Permission type for this permission ComponentDefinition:
3006
3045
  * read | write | create | delete
@@ -3031,7 +3070,7 @@ interface components$n {
3031
3070
  };
3032
3071
  /** Defines a content type */
3033
3072
  ContentType: {
3034
- id: components$n["schemas"]["PublicIdProperty"];
3073
+ id: components$o["schemas"]["PublicIdProperty"];
3035
3074
  /** Friendly name of the content type */
3036
3075
  name: string;
3037
3076
  /**
@@ -3045,7 +3084,7 @@ interface components$n {
3045
3084
  */
3046
3085
  thumbnailField?: string | null;
3047
3086
  /** The fields for this content type. Fields are key-value pairs that can be text, numbers, JSON objects, etc. */
3048
- fields?: components$n["schemas"]["ComponentDefinitionParameter"][];
3087
+ fields?: components$o["schemas"]["ComponentDefinitionParameter"][];
3049
3088
  /** Description of the content type */
3050
3089
  description?: string;
3051
3090
  /**
@@ -3057,7 +3096,7 @@ interface components$n {
3057
3096
  created?: string;
3058
3097
  /** Last modified date string for this content type (ignored for writes) */
3059
3098
  updated?: string;
3060
- slugSettings?: components$n["schemas"]["ComponentDefinitionSlugSettings"];
3099
+ slugSettings?: components$o["schemas"]["ComponentDefinitionSlugSettings"];
3061
3100
  /**
3062
3101
  * The definition type of this content type (block or content type)
3063
3102
  * @defaultValue contentType
@@ -3070,14 +3109,14 @@ interface components$n {
3070
3109
  */
3071
3110
  useTeamPermissions?: boolean;
3072
3111
  /** Custom role permissions for this content type */
3073
- permissions?: components$n["schemas"]["ComponentDefinitionPermission"][];
3112
+ permissions?: components$o["schemas"]["ComponentDefinitionPermission"][];
3074
3113
  /**
3075
3114
  * Format: uuid
3076
3115
  * ID of the workflow that instances of this content type will use by default. When not set, no workflow is attached
3077
3116
  */
3078
3117
  workflowId?: string;
3079
3118
  /** Configurations for previewing an entry on a consuming pattern or composition. */
3080
- previewConfigurations?: components$n["schemas"]["ContentTypePreviewConfiguration"][];
3119
+ previewConfigurations?: components$o["schemas"]["ContentTypePreviewConfiguration"][];
3081
3120
  };
3082
3121
  Error: {
3083
3122
  /** Error message(s) that occurred while processing the request */
@@ -3091,7 +3130,7 @@ interface components$n {
3091
3130
  [name: string]: unknown;
3092
3131
  };
3093
3132
  content: {
3094
- "application/json": components$n["schemas"]["Error"];
3133
+ "application/json": components$o["schemas"]["Error"];
3095
3134
  };
3096
3135
  };
3097
3136
  /** API key or token was not valid */
@@ -3100,7 +3139,7 @@ interface components$n {
3100
3139
  [name: string]: unknown;
3101
3140
  };
3102
3141
  content: {
3103
- "application/json": components$n["schemas"]["Error"];
3142
+ "application/json": components$o["schemas"]["Error"];
3104
3143
  };
3105
3144
  };
3106
3145
  /** Permission was denied */
@@ -3109,7 +3148,7 @@ interface components$n {
3109
3148
  [name: string]: unknown;
3110
3149
  };
3111
3150
  content: {
3112
- "application/json": components$n["schemas"]["Error"];
3151
+ "application/json": components$o["schemas"]["Error"];
3113
3152
  };
3114
3153
  };
3115
3154
  /** Too many requests in allowed time period */
@@ -3133,7 +3172,7 @@ interface components$n {
3133
3172
  pathItems: never;
3134
3173
  }
3135
3174
 
3136
- interface paths$k {
3175
+ interface paths$l {
3137
3176
  "/api/v1/entries": {
3138
3177
  parameters: {
3139
3178
  query?: never;
@@ -3248,73 +3287,73 @@ interface paths$k {
3248
3287
  * When `editions=raw`, this matches on edition IDs or entry IDs and edition resolution is disabled.
3249
3288
  * When `versionId` is passed, this parameter is required and must contain only one entry ID.
3250
3289
  */
3251
- entryIDs?: components$m["parameters"]["entryIDs"];
3290
+ entryIDs?: components$n["parameters"]["entryIDs"];
3252
3291
  /**
3253
3292
  * Specify a historical entry version ID to fetch (retrieved from the entries-history API).
3254
3293
  * Must be used with the `entryIDs` parameter, and there must be only one entryID passed
3255
3294
  */
3256
- versionId?: components$m["parameters"]["versionId"];
3295
+ versionId?: components$n["parameters"]["versionId"];
3257
3296
  /** Specify a single entry to fetch by slug */
3258
- slug?: components$m["parameters"]["slug"];
3297
+ slug?: components$n["parameters"]["slug"];
3259
3298
  /** Filters entry lists by the user who created them. The user is specified by their identity subject */
3260
- createdBy?: components$m["parameters"]["createdBy"];
3299
+ createdBy?: components$n["parameters"]["createdBy"];
3261
3300
  /** Max number of records to return */
3262
- limit?: components$m["parameters"]["limit"];
3301
+ limit?: components$n["parameters"]["limit"];
3263
3302
  /** Number of records to skip */
3264
- offset?: components$m["parameters"]["offset"];
3303
+ offset?: components$n["parameters"]["offset"];
3265
3304
  /**
3266
3305
  * Sets the sorting of the results. If unspecified, results are sorted by modification date descending.
3267
3306
  * Allowed values are: updated_at_DESC, updated_at_ASC, created_at_DESC, created_at_ASC, name_DESC, name_ASC, slug_DESC, slug_ASC
3268
3307
  */
3269
- orderBy?: components$m["parameters"]["orderBy"];
3308
+ orderBy?: components$n["parameters"]["orderBy"];
3270
3309
  /**
3271
3310
  * @deprecated
3272
3311
  * Returns counts for distinct values of the specified field or fields (provided as comma-separated IDs).
3273
3312
  */
3274
- facetBy?: components$m["parameters"]["facetBy"];
3313
+ facetBy?: components$n["parameters"]["facetBy"];
3275
3314
  /**
3276
3315
  * Matches entries based on whether they are pattern entries or regular entries.
3277
3316
  * If true, only pattern entries will be returned.
3278
3317
  * If false (default), only regular entries will be returned.
3279
3318
  * If 'any', both pattern and regular entries will be returned (useful for ID lookups).
3280
3319
  */
3281
- pattern?: components$m["parameters"]["pattern"];
3320
+ pattern?: components$n["parameters"]["pattern"];
3282
3321
  /** The project the entry/entries are on */
3283
- projectId: components$m["parameters"]["projectId"];
3322
+ projectId: components$n["parameters"]["projectId"];
3284
3323
  /** Publishing state to fetch. 0 = draft, 64 = published */
3285
- state?: components$m["parameters"]["state"];
3324
+ state?: components$n["parameters"]["state"];
3286
3325
  /** The content type ID to filter by */
3287
- type?: components$m["parameters"]["type"];
3326
+ type?: components$n["parameters"]["type"];
3288
3327
  /**
3289
3328
  * @deprecated
3290
3329
  * Filters entries lists by the UI status of the entry.
3291
3330
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
3292
3331
  */
3293
- uiStatus?: components$m["parameters"]["uiStatus"];
3332
+ uiStatus?: components$n["parameters"]["uiStatus"];
3294
3333
  /** Filters entry lists by the user who last updated them. The user is specified by their identity subject */
3295
- updatedBy?: components$m["parameters"]["updatedBy"];
3334
+ updatedBy?: components$n["parameters"]["updatedBy"];
3296
3335
  /**
3297
3336
  * Controls whether the total count of results will be returned along with the current results page in a list.
3298
3337
  * Has no effect when not fetching a list. This does impact performance when enabled
3299
3338
  */
3300
- withTotalCount?: components$m["parameters"]["withTotalCount"];
3339
+ withTotalCount?: components$n["parameters"]["withTotalCount"];
3301
3340
  /**
3302
3341
  * @deprecated
3303
3342
  * Returns the UI status string of the entry.
3304
3343
  * This internal status is subject to change without notice, and is thus marked deprecated to discourage use of internal data
3305
3344
  */
3306
- withUIStatus?: components$m["parameters"]["withUIStatus"];
3345
+ withUIStatus?: components$n["parameters"]["withUIStatus"];
3307
3346
  /** Returns the definition of any attached workflow along with the entry data */
3308
- withWorkflowDefinition?: components$m["parameters"]["withWorkflowDefinition"];
3347
+ withWorkflowDefinition?: components$n["parameters"]["withWorkflowDefinition"];
3309
3348
  /**
3310
3349
  * If true the `_id` unique identifier of blocks will be part of the response data.
3311
3350
  * If false, the `_id` will not be present in the API response.
3312
3351
  * Note: the default value depends on the `format`: true for editor or canonical, false for delivery or when no format is specified.
3313
3352
  * Prefer selecting a `format` rather than using this option.
3314
3353
  */
3315
- withComponentIDs?: components$m["parameters"]["withComponentIDs"];
3354
+ withComponentIDs?: components$n["parameters"]["withComponentIDs"];
3316
3355
  /** Performs keyword search on the entries */
3317
- keyword?: components$m["parameters"]["keyword"];
3356
+ keyword?: components$n["parameters"]["keyword"];
3318
3357
  /**
3319
3358
  * If true, any pattern references in the composition will be left unresolved.
3320
3359
  * This is appropriate if you intend to serialize the composition without patterns
@@ -3322,12 +3361,12 @@ interface paths$k {
3322
3361
  * Default: true when `format` is canonical. False otherwise
3323
3362
  * Prefer selecting a `format` rather than using this option.
3324
3363
  */
3325
- skipPatternResolution?: components$m["parameters"]["skipPatternResolution"];
3364
+ skipPatternResolution?: components$n["parameters"]["skipPatternResolution"];
3326
3365
  /**
3327
3366
  * @deprecated
3328
3367
  * This parameter is unused and has no effect. Passing this parameter will become an error in the future
3329
3368
  */
3330
- skipParameterResolution?: components$m["parameters"]["skipParameterResolution"];
3369
+ skipParameterResolution?: components$n["parameters"]["skipParameterResolution"];
3331
3370
  /**
3332
3371
  * If true, any pattern override data is not resolved by the API.
3333
3372
  * This is intended for internal use in the Canvas editor, and should not be used.
@@ -3335,7 +3374,13 @@ interface paths$k {
3335
3374
  * Default: true when `format` is canonical or editor. False otherwise.
3336
3375
  * Prefer selecting a `format` rather than using this option.
3337
3376
  */
3338
- skipOverridesResolution?: components$m["parameters"]["skipOverridesResolution"];
3377
+ skipOverridesResolution?: components$n["parameters"]["skipOverridesResolution"];
3378
+ /**
3379
+ * Improves performance by skipping dynamic data revalidations; appropriate for content delivery.
3380
+ * Default: true when `format` is delivery. False otherwise.
3381
+ * Prefer selecting a `format` rather than using this option.
3382
+ */
3383
+ skipContentTypeResolution?: components$n["parameters"]["skipContentTypeResolution"];
3339
3384
  /**
3340
3385
  * One or more locales to filter and localize by.
3341
3386
  * Only entries that enable one of the specified locales _or enable no locales_ will be returned.
@@ -3348,7 +3393,7 @@ interface paths$k {
3348
3393
  *
3349
3394
  * When this parameter is not passed, all locales' data will be returned
3350
3395
  */
3351
- locale?: components$m["parameters"]["locale"];
3396
+ locale?: components$n["parameters"]["locale"];
3352
3397
  /**
3353
3398
  * The ID of a release to fetch the content for.
3354
3399
  *
@@ -3357,7 +3402,7 @@ interface paths$k {
3357
3402
  *
3358
3403
  * Content copied to a release can be differentiated from base content by the `releaseId` property on the content. If the content is not copied to the release, this property will be null
3359
3404
  */
3360
- releaseId?: components$m["parameters"]["releaseId"];
3405
+ releaseId?: components$n["parameters"]["releaseId"];
3361
3406
  /**
3362
3407
  * Search on textual fields of an entry.
3363
3408
  * Matches against fully rendered content including resolved pattern content.
@@ -3365,7 +3410,7 @@ interface paths$k {
3365
3410
  * Note: For long text fields, the tail of the text is not guaranteed to be searchable.
3366
3411
  * Example: ?search=hello
3367
3412
  */
3368
- search?: components$m["parameters"]["search"];
3413
+ search?: components$n["parameters"]["search"];
3369
3414
  /**
3370
3415
  * @deprecated
3371
3416
  * BETA: Semantic search using vector similarity to find content by meaning.
@@ -3373,7 +3418,7 @@ interface paths$k {
3373
3418
  * Use this for "where is this content defined" queries.
3374
3419
  * Requires AI credits.
3375
3420
  */
3376
- searchSemantic?: components$m["parameters"]["searchSemantic"];
3421
+ searchSemantic?: components$n["parameters"]["searchSemantic"];
3377
3422
  /**
3378
3423
  * Controls the edition resolution behavior.
3379
3424
  *
@@ -3387,20 +3432,21 @@ interface paths$k {
3387
3432
  * entryIDs MUST be provided with this option.
3388
3433
  * If versionId is passed, this is always enabled.
3389
3434
  */
3390
- editions?: components$m["parameters"]["editions"];
3435
+ editions?: components$n["parameters"]["editions"];
3391
3436
  /**
3392
3437
  * Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
3393
- * skipOverridesResolution, withComponentIDs) overrides this alias.
3438
+ * skipOverridesResolution, withComponentIDs, skipContentTypeResolution) overrides this alias.
3394
3439
  * - `canonical`: PUT-safe structure — patterns and overrides left
3395
3440
  * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
3396
3441
  * (skipPatternResolution=true, skipOverridesResolution=true,
3397
- * withComponentIDs=true).
3442
+ * withComponentIDs=true, skipContentTypeResolution=false).
3398
3443
  * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
3399
3444
  * the expanded pattern nodes.
3400
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
3401
- * and component `_id`s removed.
3445
+ * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved,
3446
+ * component `_id`s removed, and each entry returned as stored
3447
+ * (skipContentTypeResolution=true).
3402
3448
  */
3403
- format?: components$m["parameters"]["format"];
3449
+ format?: components$n["parameters"]["format"];
3404
3450
  /**
3405
3451
  * Controls filtering of trashed items.
3406
3452
  *
@@ -3408,7 +3454,7 @@ interface paths$k {
3408
3454
  * only: Only return trashed items (for trash view).
3409
3455
  * include: Return both trashed and non-trashed items.
3410
3456
  */
3411
- deleted?: components$m["parameters"]["deleted"];
3457
+ deleted?: components$n["parameters"]["deleted"];
3412
3458
  };
3413
3459
  header?: never;
3414
3460
  path?: never;
@@ -3422,12 +3468,12 @@ interface paths$k {
3422
3468
  [name: string]: unknown;
3423
3469
  };
3424
3470
  content: {
3425
- "application/json": components$m["schemas"]["EntryListResponse"];
3471
+ "application/json": components$n["schemas"]["EntryListResponse"];
3426
3472
  };
3427
3473
  };
3428
- 400: components$m["responses"]["BadRequestError"];
3429
- 401: components$m["responses"]["UnauthorizedError"];
3430
- 403: components$m["responses"]["ForbiddenError"];
3474
+ 400: components$n["responses"]["BadRequestError"];
3475
+ 401: components$n["responses"]["UnauthorizedError"];
3476
+ 403: components$n["responses"]["ForbiddenError"];
3431
3477
  /** Entry not found */
3432
3478
  404: {
3433
3479
  headers: {
@@ -3437,8 +3483,8 @@ interface paths$k {
3437
3483
  "text/plain": string;
3438
3484
  };
3439
3485
  };
3440
- 429: components$m["responses"]["RateLimitError"];
3441
- 500: components$m["responses"]["InternalServerError"];
3486
+ 429: components$n["responses"]["RateLimitError"];
3487
+ 500: components$n["responses"]["InternalServerError"];
3442
3488
  };
3443
3489
  };
3444
3490
  /** Upserts an entry */
@@ -3466,7 +3512,7 @@ interface paths$k {
3466
3512
  projectId: string;
3467
3513
  /** The publishing state to upsert into. 0 = draft, 64 = published */
3468
3514
  state: number;
3469
- entry: components$m["schemas"]["EntryInput"];
3515
+ entry: components$n["schemas"]["EntryInput"];
3470
3516
  /** Ignored if present */
3471
3517
  created?: string;
3472
3518
  /** Ignored if present */
@@ -3517,9 +3563,9 @@ interface paths$k {
3517
3563
  };
3518
3564
  content?: never;
3519
3565
  };
3520
- 400: components$m["responses"]["BadRequestError"];
3521
- 401: components$m["responses"]["UnauthorizedError"];
3522
- 403: components$m["responses"]["ForbiddenError"];
3566
+ 400: components$n["responses"]["BadRequestError"];
3567
+ 401: components$n["responses"]["UnauthorizedError"];
3568
+ 403: components$n["responses"]["ForbiddenError"];
3523
3569
  /** Conflict - Entry has been changed since being loaded */
3524
3570
  409: {
3525
3571
  headers: {
@@ -3529,8 +3575,8 @@ interface paths$k {
3529
3575
  "text/plain": string;
3530
3576
  };
3531
3577
  };
3532
- 429: components$m["responses"]["RateLimitError"];
3533
- 500: components$m["responses"]["InternalServerError"];
3578
+ 429: components$n["responses"]["RateLimitError"];
3579
+ 500: components$n["responses"]["InternalServerError"];
3534
3580
  };
3535
3581
  };
3536
3582
  post?: never;
@@ -3583,11 +3629,11 @@ interface paths$k {
3583
3629
  };
3584
3630
  content?: never;
3585
3631
  };
3586
- 400: components$m["responses"]["BadRequestError"];
3587
- 401: components$m["responses"]["UnauthorizedError"];
3588
- 403: components$m["responses"]["ForbiddenError"];
3589
- 429: components$m["responses"]["RateLimitError"];
3590
- 500: components$m["responses"]["InternalServerError"];
3632
+ 400: components$n["responses"]["BadRequestError"];
3633
+ 401: components$n["responses"]["UnauthorizedError"];
3634
+ 403: components$n["responses"]["ForbiddenError"];
3635
+ 429: components$n["responses"]["RateLimitError"];
3636
+ 500: components$n["responses"]["InternalServerError"];
3591
3637
  };
3592
3638
  };
3593
3639
  /** Handles preflight requests. This endpoint allows CORS */
@@ -3614,7 +3660,7 @@ interface paths$k {
3614
3660
  trace?: never;
3615
3661
  };
3616
3662
  }
3617
- interface components$m {
3663
+ interface components$n {
3618
3664
  schemas: {
3619
3665
  /** Defines a connection to a dynamic token on a data resource */
3620
3666
  DataElementConnectionDefinition: {
@@ -3680,11 +3726,11 @@ interface components$m {
3680
3726
 
3681
3727
  */
3682
3728
  op?: "&" | "|";
3683
- clauses: (components$m["schemas"]["VisibilityCriteria"] | components$m["schemas"]["VisibilityCriteriaGroup"])[];
3729
+ clauses: (components$n["schemas"]["VisibilityCriteria"] | components$n["schemas"]["VisibilityCriteriaGroup"])[];
3684
3730
  };
3685
3731
  /** Defines a conditional value for a component parameter */
3686
3732
  ComponentParameterConditionalValue: {
3687
- when: components$m["schemas"]["VisibilityCriteriaGroup"];
3733
+ when: components$n["schemas"]["VisibilityCriteriaGroup"];
3688
3734
  /**
3689
3735
  * The value of the parameter. Any JSON-serializable value is acceptable.
3690
3736
  * A value of `null` will cause the parameter value to be removed, if it matches.
@@ -3706,7 +3752,7 @@ interface components$m {
3706
3752
  *
3707
3753
  * When no locale is passed to a non-route API, conditions are not processed and all conditions are returned.
3708
3754
  */
3709
- ComponentParameterConditions: components$m["schemas"]["ComponentParameterConditionalValue"][];
3755
+ ComponentParameterConditions: components$n["schemas"]["ComponentParameterConditionalValue"][];
3710
3756
  /** Defines an editable parameter on a component */
3711
3757
  ComponentParameter: {
3712
3758
  /** The value of the parameter. Any JSON-serializable value is acceptable */
@@ -3714,7 +3760,7 @@ interface components$m {
3714
3760
  /** The type of the parameter. Determines how it is displayed when editing and tells the consumer how to process it */
3715
3761
  type: string;
3716
3762
  /** @deprecated */
3717
- connectedData?: components$m["schemas"]["DataElementConnectionDefinition"];
3763
+ connectedData?: components$n["schemas"]["DataElementConnectionDefinition"];
3718
3764
  /**
3719
3765
  * Locale-specific values for this parameter. Keys are locale codes, and values are the `value` in that locale.
3720
3766
  * Note that locales must be registered on the entry/composition `_locales` before being used
@@ -3722,10 +3768,10 @@ interface components$m {
3722
3768
  locales?: {
3723
3769
  [key: string]: unknown;
3724
3770
  };
3725
- conditions?: components$m["schemas"]["ComponentParameterConditions"];
3771
+ conditions?: components$n["schemas"]["ComponentParameterConditions"];
3726
3772
  /** Locale-specific conditional values for this parameter. Keys are locale codes, and values are the `conditions` for that locale. */
3727
3773
  localesConditions?: {
3728
- [key: string]: components$m["schemas"]["ComponentParameterConditions"];
3774
+ [key: string]: components$n["schemas"]["ComponentParameterConditions"];
3729
3775
  };
3730
3776
  };
3731
3777
  /** Variable values for a data resource */
@@ -3749,14 +3795,14 @@ interface components$m {
3749
3795
  * If isPatternParameter is false or undefined, or if ignorePatternParameterDefault is false, this has no meaning
3750
3796
  */
3751
3797
  optionalPatternParameter?: boolean;
3752
- variables?: components$m["schemas"]["DataResourceVariables"];
3798
+ variables?: components$n["schemas"]["DataResourceVariables"];
3753
3799
  };
3754
3800
  /**
3755
3801
  * Data definitions attached to this component. The property name is the key of the data in the data document.
3756
3802
  * Note: data definitions are inherited from ancestors at runtime (and may be overridden by descendants that use the same key)
3757
3803
  */
3758
3804
  DataResourceDefinitions: {
3759
- [key: string]: components$m["schemas"]["DataResourceDefinition"];
3805
+ [key: string]: components$n["schemas"]["DataResourceDefinition"];
3760
3806
  };
3761
3807
  /** Defines the shape of a component instance served by the composition API */
3762
3808
  ComponentInstance: {
@@ -3764,13 +3810,13 @@ interface components$m {
3764
3810
  type: string;
3765
3811
  /** Component parameter values for the component instance */
3766
3812
  parameters?: {
3767
- [key: string]: components$m["schemas"]["ComponentParameter"];
3813
+ [key: string]: components$n["schemas"]["ComponentParameter"];
3768
3814
  };
3769
3815
  /** Public ID of alternate visual appearance for this component, if any selected */
3770
3816
  variant?: string;
3771
3817
  /** Slots containing any child components */
3772
3818
  slots?: {
3773
- [key: string]: components$m["schemas"]["ComponentInstance"][];
3819
+ [key: string]: components$n["schemas"]["ComponentInstance"][];
3774
3820
  };
3775
3821
  /**
3776
3822
  * Unique identifier of the component within the composition.
@@ -3781,15 +3827,20 @@ interface components$m {
3781
3827
  _id?: string;
3782
3828
  /** Indicates this component instance should be sourced from a pattern library pattern */
3783
3829
  _pattern?: string;
3784
- _dataResources?: components$m["schemas"]["DataResourceDefinitions"];
3830
+ _dataResources?: components$n["schemas"]["DataResourceDefinitions"];
3785
3831
  /**
3786
3832
  * Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3787
3833
  * Means nothing for PUTs; it will be ignored
3788
3834
  */
3789
3835
  _patternDataResources?: {
3790
- [key: string]: components$m["schemas"]["DataResourceDefinition"];
3836
+ [key: string]: components$n["schemas"]["DataResourceDefinition"];
3791
3837
  };
3792
- _patternError?: components$m["schemas"]["PatternError"];
3838
+ /**
3839
+ * Query-string opt-ins coming from a pattern resolved for this component.
3840
+ * Means nothing for PUTs; it will be ignored
3841
+ */
3842
+ _patternOptedInQueryStrings?: string[];
3843
+ _patternError?: components$n["schemas"]["PatternError"];
3793
3844
  /**
3794
3845
  * Defines patch overrides to component IDs that live in the composition.
3795
3846
  * This can be used to override parameters that are defined on patterns,
@@ -3803,14 +3854,14 @@ interface components$m {
3803
3854
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
3804
3855
  */
3805
3856
  _overrides?: {
3806
- [key: string]: components$m["schemas"]["ComponentOverride"];
3857
+ [key: string]: components$n["schemas"]["ComponentOverride"];
3807
3858
  };
3808
3859
  /**
3809
3860
  * Overrides coming from a pattern resolved for this component. Merged with _overrides during resolution.
3810
3861
  * Means nothing for PUTs; it will be ignored
3811
3862
  */
3812
3863
  _patternOverrides?: {
3813
- [key: string]: components$m["schemas"]["ComponentOverride"];
3864
+ [key: string]: components$n["schemas"]["ComponentOverride"];
3814
3865
  };
3815
3866
  /**
3816
3867
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -3819,7 +3870,7 @@ interface components$m {
3819
3870
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3820
3871
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
3821
3872
  */
3822
- _overridability?: components$m["schemas"]["ComponentOverridability"];
3873
+ _overridability?: components$n["schemas"]["ComponentOverridability"];
3823
3874
  /** Array of locales that have data defined. Only set for pattern references or composition defaults */
3824
3875
  _locales?: string[];
3825
3876
  };
@@ -3839,10 +3890,10 @@ interface components$m {
3839
3890
  */
3840
3891
  ComponentOverride: {
3841
3892
  parameters?: {
3842
- [key: string]: components$m["schemas"]["ComponentParameter"];
3893
+ [key: string]: components$n["schemas"]["ComponentParameter"];
3843
3894
  };
3844
3895
  slots?: {
3845
- [key: string]: components$m["schemas"]["ComponentInstance"][];
3896
+ [key: string]: components$n["schemas"]["ComponentInstance"][];
3846
3897
  };
3847
3898
  variant?: string;
3848
3899
  /**
@@ -3851,7 +3902,7 @@ interface components$m {
3851
3902
  * Overrides defined here replace values in either _dataResources or _patternDataResources on the target component.
3852
3903
  */
3853
3904
  dataResources?: {
3854
- [key: string]: components$m["schemas"]["DataResourceDefinition"];
3905
+ [key: string]: components$n["schemas"]["DataResourceDefinition"];
3855
3906
  };
3856
3907
  };
3857
3908
  /**
@@ -3872,7 +3923,7 @@ interface components$m {
3872
3923
  ComponentOverridability: {
3873
3924
  /** Defines component parameter value overrides. Keys are the parameter public ID */
3874
3925
  parameters?: {
3875
- [key: string]: components$m["schemas"]["OverrideOptions"];
3926
+ [key: string]: components$n["schemas"]["OverrideOptions"];
3876
3927
  };
3877
3928
  /** Allows overriding a display variant is allowed if it is defined on the component the pattern is derived from. Default = false */
3878
3929
  variants?: boolean;
@@ -3912,15 +3963,15 @@ interface components$m {
3912
3963
  _locales?: string[];
3913
3964
  /** Entry field values */
3914
3965
  fields?: {
3915
- [key: string]: components$m["schemas"]["ComponentParameter"];
3966
+ [key: string]: components$n["schemas"]["ComponentParameter"];
3916
3967
  };
3917
- _dataResources?: components$m["schemas"]["DataResourceDefinitions"];
3968
+ _dataResources?: components$n["schemas"]["DataResourceDefinitions"];
3918
3969
  /**
3919
3970
  * Data definitions coming from a pattern resolved for this component. Merged with _dataResources during resolution.
3920
3971
  * Means nothing for PUTs; it will be ignored
3921
3972
  */
3922
3973
  _patternDataResources?: {
3923
- [key: string]: components$m["schemas"]["DataResourceDefinition"];
3974
+ [key: string]: components$n["schemas"]["DataResourceDefinition"];
3924
3975
  };
3925
3976
  /**
3926
3977
  * Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -3943,7 +3994,7 @@ interface components$m {
3943
3994
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
3944
3995
  */
3945
3996
  _overrides?: {
3946
- [key: string]: components$m["schemas"]["ComponentOverride"];
3997
+ [key: string]: components$n["schemas"]["ComponentOverride"];
3947
3998
  };
3948
3999
  /**
3949
4000
  * When used on a pattern, defines how the pattern's parameters may be overridden
@@ -3952,7 +4003,7 @@ interface components$m {
3952
4003
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
3953
4004
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
3954
4005
  */
3955
- _overridability?: components$m["schemas"]["ComponentOverridability"];
4006
+ _overridability?: components$n["schemas"]["ComponentOverridability"];
3956
4007
  };
3957
4008
  /** Permissions for a workflow stage */
3958
4009
  WorkflowStagePermission: {
@@ -3983,7 +4034,7 @@ interface components$m {
3983
4034
  * NOTE: Users without membership in any role listed here will be unable to execute the transition unless they are team admins
3984
4035
  */
3985
4036
  permissions: {
3986
- [key: string]: components$m["schemas"]["WorkflowStageTransitionPermission"];
4037
+ [key: string]: components$n["schemas"]["WorkflowStageTransitionPermission"];
3987
4038
  };
3988
4039
  };
3989
4040
  /** Definition of a stage in a workflow */
@@ -3997,7 +4048,7 @@ interface components$m {
3997
4048
  * listed here, the stage is read-only and publishing is disabled
3998
4049
  */
3999
4050
  permissions: {
4000
- [key: string]: components$m["schemas"]["WorkflowStagePermission"];
4051
+ [key: string]: components$n["schemas"]["WorkflowStagePermission"];
4001
4052
  };
4002
4053
  /**
4003
4054
  * When true, transitioning into this stage from a different stage will automatically publish the entity.
@@ -4017,7 +4068,7 @@ interface components$m {
4017
4068
  * Every stage must define at least one transition, to avoid creating a workflow that
4018
4069
  * has a stage that can never be escaped
4019
4070
  */
4020
- transitions: components$m["schemas"]["WorkflowStageTransition"][];
4071
+ transitions: components$n["schemas"]["WorkflowStageTransition"][];
4021
4072
  /**
4022
4073
  * Icon name for the stage (e.g. 'chevron-double-right-o')
4023
4074
  * @defaultValue chevron-double-right-o
@@ -4042,7 +4093,7 @@ interface components$m {
4042
4093
  initialStage: string;
4043
4094
  /** All stages of the workflow */
4044
4095
  stages: {
4045
- [key: string]: components$m["schemas"]["WorkflowStage"];
4096
+ [key: string]: components$n["schemas"]["WorkflowStage"];
4046
4097
  };
4047
4098
  /** Last modified ISO date string for this definition (ignored for writes) */
4048
4099
  modified?: string;
@@ -4100,7 +4151,7 @@ interface components$m {
4100
4151
  * @defaultValue false
4101
4152
  */
4102
4153
  pattern?: boolean;
4103
- entry: components$m["schemas"]["Entry"];
4154
+ entry: components$n["schemas"]["Entry"];
4104
4155
  /**
4105
4156
  * Format: uuid
4106
4157
  * The workflow ID that this entry is assigned. Normally comes from the content type
@@ -4112,7 +4163,7 @@ interface components$m {
4112
4163
  */
4113
4164
  workflowStageId?: string;
4114
4165
  /** The full definition of the assigned workflow, if any, including stages, permissions, etc. Only returned when `withWorkflowDefinition` is true */
4115
- workflowDefinition?: components$m["schemas"]["WorkflowDefinition"];
4166
+ workflowDefinition?: components$n["schemas"]["WorkflowDefinition"];
4116
4167
  /**
4117
4168
  * Only present if an incomplete entry is returned; indicates reason for stubbing
4118
4169
 
@@ -4135,7 +4186,7 @@ interface components$m {
4135
4186
  editionPriority?: number;
4136
4187
  };
4137
4188
  EntryListResponse: {
4138
- entries: components$m["schemas"]["EntryApiResponse"][];
4189
+ entries: components$n["schemas"]["EntryApiResponse"][];
4139
4190
  /** Total number of entries that match the query. Only present when `withTotalCount` option is true */
4140
4191
  totalCount?: number;
4141
4192
  /** Per-field counts for distinct values */
@@ -4174,9 +4225,9 @@ interface components$m {
4174
4225
  _creatorSubject?: string;
4175
4226
  /** Entry field values */
4176
4227
  fields?: {
4177
- [key: string]: components$m["schemas"]["ComponentParameter"];
4228
+ [key: string]: components$n["schemas"]["ComponentParameter"];
4178
4229
  };
4179
- _dataResources?: components$m["schemas"]["DataResourceDefinitions"];
4230
+ _dataResources?: components$n["schemas"]["DataResourceDefinitions"];
4180
4231
  /** Indicates this content entry should be sourced from a pattern library pattern */
4181
4232
  _pattern?: string;
4182
4233
  /**
@@ -4184,7 +4235,7 @@ interface components$m {
4184
4235
  * Means nothing for PUTs; it will be ignored
4185
4236
  */
4186
4237
  _patternDataResources?: {
4187
- [key: string]: components$m["schemas"]["DataResourceDefinition"];
4238
+ [key: string]: components$n["schemas"]["DataResourceDefinition"];
4188
4239
  };
4189
4240
  /**
4190
4241
  * Describes why the pattern could not be resolved, if a pattern could not be resolved. For PUTs, this is allowed but ignored.
@@ -4202,7 +4253,7 @@ interface components$m {
4202
4253
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
4203
4254
  */
4204
4255
  _overrides?: {
4205
- [key: string]: components$m["schemas"]["ComponentOverride"];
4256
+ [key: string]: components$n["schemas"]["ComponentOverride"];
4206
4257
  };
4207
4258
  /**
4208
4259
  * When used on a pattern, defines how the pattern's fields may be overridden
@@ -4211,7 +4262,7 @@ interface components$m {
4211
4262
  * NOTE: This is considered an internal data structure and is not guaranteed to be stable.
4212
4263
  * Future updates that do not break the overrides-applied state of a composition may be made without notice
4213
4264
  */
4214
- _overridability?: components$m["schemas"]["ComponentOverridability"];
4265
+ _overridability?: components$n["schemas"]["ComponentOverridability"];
4215
4266
  /** Array of locales which have data defined on the entry. If empty, the current default locale implicitly has data */
4216
4267
  _locales?: string[];
4217
4268
  };
@@ -4223,7 +4274,7 @@ interface components$m {
4223
4274
  [name: string]: unknown;
4224
4275
  };
4225
4276
  content: {
4226
- "application/json": components$m["schemas"]["Error"];
4277
+ "application/json": components$n["schemas"]["Error"];
4227
4278
  };
4228
4279
  };
4229
4280
  /** API key or token was not valid */
@@ -4232,7 +4283,7 @@ interface components$m {
4232
4283
  [name: string]: unknown;
4233
4284
  };
4234
4285
  content: {
4235
- "application/json": components$m["schemas"]["Error"];
4286
+ "application/json": components$n["schemas"]["Error"];
4236
4287
  };
4237
4288
  };
4238
4289
  /** Permission was denied */
@@ -4241,7 +4292,7 @@ interface components$m {
4241
4292
  [name: string]: unknown;
4242
4293
  };
4243
4294
  content: {
4244
- "application/json": components$m["schemas"]["Error"];
4295
+ "application/json": components$n["schemas"]["Error"];
4245
4296
  };
4246
4297
  };
4247
4298
  /** Too many requests in allowed time period */
@@ -4353,6 +4404,12 @@ interface components$m {
4353
4404
  * Prefer selecting a `format` rather than using this option.
4354
4405
  */
4355
4406
  skipOverridesResolution: boolean;
4407
+ /**
4408
+ * Improves performance by skipping dynamic data revalidations; appropriate for content delivery.
4409
+ * Default: true when `format` is delivery. False otherwise.
4410
+ * Prefer selecting a `format` rather than using this option.
4411
+ */
4412
+ skipContentTypeResolution: boolean;
4356
4413
  /**
4357
4414
  * One or more locales to filter and localize by.
4358
4415
  * Only entries that enable one of the specified locales _or enable no locales_ will be returned.
@@ -4407,15 +4464,16 @@ interface components$m {
4407
4464
  editions: "auto" | "all" | "raw";
4408
4465
  /**
4409
4466
  * Specify a format you want the results in. Any explicit shaping flag (skipPatternResolution,
4410
- * skipOverridesResolution, withComponentIDs) overrides this alias.
4467
+ * skipOverridesResolution, withComponentIDs, skipContentTypeResolution) overrides this alias.
4411
4468
  * - `canonical`: PUT-safe structure — patterns and overrides left
4412
4469
  * unresolved and component `_id`s included. This is the format the Uniform CLI uses when syncing.
4413
4470
  * (skipPatternResolution=true, skipOverridesResolution=true,
4414
- * withComponentIDs=true).
4471
+ * withComponentIDs=true, skipContentTypeResolution=false).
4415
4472
  * - `editor`: For loading into a Uniform editor - same as canonical, but with patterns expanded (skipPatternResolution=false). Still PUT-safe — the PUT ignores
4416
4473
  * the expanded pattern nodes.
4417
- * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved
4418
- * and component `_id`s removed.
4474
+ * - `delivery`: default structure for serving to a frontend — patterns and overrides resolved,
4475
+ * component `_id`s removed, and each entry returned as stored
4476
+ * (skipContentTypeResolution=true).
4419
4477
  */
4420
4478
  format: "canonical" | "editor" | "delivery";
4421
4479
  /**
@@ -4432,7 +4490,7 @@ interface components$m {
4432
4490
  pathItems: never;
4433
4491
  }
4434
4492
 
4435
- interface paths$j {
4493
+ interface paths$k {
4436
4494
  "/api/v1/entries-history": {
4437
4495
  parameters: {
4438
4496
  query?: never;
@@ -4469,12 +4527,12 @@ interface paths$j {
4469
4527
  [name: string]: unknown;
4470
4528
  };
4471
4529
  content: {
4472
- "application/json": components$l["schemas"]["HistoryApiResponse"];
4530
+ "application/json": components$m["schemas"]["HistoryApiResponse"];
4473
4531
  };
4474
4532
  };
4475
- 400: components$l["responses"]["BadRequestError"];
4476
- 401: components$l["responses"]["UnauthorizedError"];
4477
- 403: components$l["responses"]["ForbiddenError"];
4533
+ 400: components$m["responses"]["BadRequestError"];
4534
+ 401: components$m["responses"]["UnauthorizedError"];
4535
+ 403: components$m["responses"]["ForbiddenError"];
4478
4536
  /** Entry not found */
4479
4537
  404: {
4480
4538
  headers: {
@@ -4484,8 +4542,8 @@ interface paths$j {
4484
4542
  "text/plain": string;
4485
4543
  };
4486
4544
  };
4487
- 429: components$l["responses"]["RateLimitError"];
4488
- 500: components$l["responses"]["InternalServerError"];
4545
+ 429: components$m["responses"]["RateLimitError"];
4546
+ 500: components$m["responses"]["InternalServerError"];
4489
4547
  };
4490
4548
  };
4491
4549
  put?: never;
@@ -4497,7 +4555,7 @@ interface paths$j {
4497
4555
  trace?: never;
4498
4556
  };
4499
4557
  }
4500
- interface components$l {
4558
+ interface components$m {
4501
4559
  schemas: {
4502
4560
  HistoryEntry: {
4503
4561
  /** The version ID of the entity. This can be used to fetch the version's data via the entity API */
@@ -4521,7 +4579,7 @@ interface components$l {
4521
4579
  /** If more history is available than your plan allows, and additional entries are available by upgrading, this will be true */
4522
4580
  truncated?: boolean;
4523
4581
  /** Version history entries */
4524
- results?: components$l["schemas"]["HistoryEntry"][];
4582
+ results?: components$m["schemas"]["HistoryEntry"][];
4525
4583
  };
4526
4584
  Error: {
4527
4585
  /** Error message(s) that occurred while processing the request */
@@ -4535,7 +4593,7 @@ interface components$l {
4535
4593
  [name: string]: unknown;
4536
4594
  };
4537
4595
  content: {
4538
- "application/json": components$l["schemas"]["Error"];
4596
+ "application/json": components$m["schemas"]["Error"];
4539
4597
  };
4540
4598
  };
4541
4599
  /** API key or token was not valid */
@@ -4544,7 +4602,7 @@ interface components$l {
4544
4602
  [name: string]: unknown;
4545
4603
  };
4546
4604
  content: {
4547
- "application/json": components$l["schemas"]["Error"];
4605
+ "application/json": components$m["schemas"]["Error"];
4548
4606
  };
4549
4607
  };
4550
4608
  /** Permission was denied */
@@ -4553,7 +4611,7 @@ interface components$l {
4553
4611
  [name: string]: unknown;
4554
4612
  };
4555
4613
  content: {
4556
- "application/json": components$l["schemas"]["Error"];
4614
+ "application/json": components$m["schemas"]["Error"];
4557
4615
  };
4558
4616
  };
4559
4617
  /** Too many requests in allowed time period */
@@ -4577,27 +4635,27 @@ interface components$l {
4577
4635
  pathItems: never;
4578
4636
  }
4579
4637
 
4580
- type HistoryApi$1 = paths$j['/api/v1/entries-history'];
4581
- type ContentType = components$q['schemas']['ContentType'];
4582
- type ContentTypePreviewConfiguration = components$q['schemas']['ContentTypePreviewConfiguration'];
4638
+ type HistoryApi$1 = paths$k['/api/v1/entries-history'];
4639
+ type ContentType = components$r['schemas']['ContentType'];
4640
+ type ContentTypePreviewConfiguration = components$r['schemas']['ContentTypePreviewConfiguration'];
4583
4641
  type ContentTypeField = Exclude<ContentType['fields'], undefined>[number];
4584
- type GetContentTypesOptions = paths$l['/api/v1/content-types']['get']['parameters']['query'];
4585
- type DeleteContentTypeOptions = paths$l['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
4586
- type PutContentTypeBody = paths$l['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
4587
- type GetContentTypesResponse = paths$l['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
4588
- type Entry = components$o['schemas']['EntryApiResponse'];
4589
- type EntryList = components$o['schemas']['EntryListResponse'];
4642
+ type GetContentTypesOptions = paths$m['/api/v1/content-types']['get']['parameters']['query'];
4643
+ type DeleteContentTypeOptions = paths$m['/api/v1/content-types']['delete']['requestBody']['content']['application/json'];
4644
+ type PutContentTypeBody = paths$m['/api/v1/content-types']['put']['requestBody']['content']['application/json'];
4645
+ type GetContentTypesResponse = paths$m['/api/v1/content-types']['get']['responses']['200']['content']['application/json'];
4646
+ type Entry = components$p['schemas']['EntryApiResponse'];
4647
+ type EntryList = components$p['schemas']['EntryListResponse'];
4590
4648
  type EntryData = Entry['entry'];
4591
- type GetEntriesOptions = paths$k['/api/v1/entries']['get']['parameters']['query'];
4592
- type GetEntriesResponse = paths$k['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
4593
- type DeleteEntryOptions = paths$k['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
4594
- type PutEntryBody = paths$k['/api/v1/entries']['put']['requestBody']['content']['application/json'];
4649
+ type GetEntriesOptions = paths$l['/api/v1/entries']['get']['parameters']['query'];
4650
+ type GetEntriesResponse = paths$l['/api/v1/entries']['get']['responses']['200']['content']['application/json'];
4651
+ type DeleteEntryOptions = paths$l['/api/v1/entries']['delete']['requestBody']['content']['application/json'];
4652
+ type PutEntryBody = paths$l['/api/v1/entries']['put']['requestBody']['content']['application/json'];
4595
4653
  /** The GET response from /api/v1/entries-history (history for one entry) */
4596
4654
  type EntriesHistoryGetParameters = HistoryApi$1['get']['parameters']['query'];
4597
4655
  /** The GET response from /api/v1/entries-history */
4598
- type EntriesHistoryGetResponse = components$q['schemas']['HistoryApiResponse'];
4656
+ type EntriesHistoryGetResponse = components$r['schemas']['HistoryApiResponse'];
4599
4657
 
4600
- interface paths$i {
4658
+ interface paths$j {
4601
4659
  "/api/v1/data-source": {
4602
4660
  parameters: {
4603
4661
  query?: never;
@@ -4624,15 +4682,15 @@ interface paths$i {
4624
4682
  };
4625
4683
  content: {
4626
4684
  "application/json": {
4627
- result: components$k["schemas"]["DataSource"];
4685
+ result: components$l["schemas"]["DataSource"];
4628
4686
  };
4629
4687
  };
4630
4688
  };
4631
- 400: components$k["responses"]["BadRequestError"];
4632
- 401: components$k["responses"]["UnauthorizedError"];
4633
- 403: components$k["responses"]["ForbiddenError"];
4634
- 429: components$k["responses"]["RateLimitError"];
4635
- 500: components$k["responses"]["InternalServerError"];
4689
+ 400: components$l["responses"]["BadRequestError"];
4690
+ 401: components$l["responses"]["UnauthorizedError"];
4691
+ 403: components$l["responses"]["ForbiddenError"];
4692
+ 429: components$l["responses"]["RateLimitError"];
4693
+ 500: components$l["responses"]["InternalServerError"];
4636
4694
  };
4637
4695
  };
4638
4696
  put: {
@@ -4645,7 +4703,7 @@ interface paths$i {
4645
4703
  requestBody: {
4646
4704
  content: {
4647
4705
  "application/json": {
4648
- data: components$k["schemas"]["DataSource"];
4706
+ data: components$l["schemas"]["DataSource"];
4649
4707
  /** Format: uuid */
4650
4708
  projectId: string;
4651
4709
  /**
@@ -4667,11 +4725,11 @@ interface paths$i {
4667
4725
  };
4668
4726
  content?: never;
4669
4727
  };
4670
- 400: components$k["responses"]["BadRequestError"];
4671
- 401: components$k["responses"]["UnauthorizedError"];
4672
- 403: components$k["responses"]["ForbiddenError"];
4673
- 429: components$k["responses"]["RateLimitError"];
4674
- 500: components$k["responses"]["InternalServerError"];
4728
+ 400: components$l["responses"]["BadRequestError"];
4729
+ 401: components$l["responses"]["UnauthorizedError"];
4730
+ 403: components$l["responses"]["ForbiddenError"];
4731
+ 429: components$l["responses"]["RateLimitError"];
4732
+ 500: components$l["responses"]["InternalServerError"];
4675
4733
  };
4676
4734
  };
4677
4735
  post?: never;
@@ -4699,11 +4757,11 @@ interface paths$i {
4699
4757
  };
4700
4758
  content?: never;
4701
4759
  };
4702
- 400: components$k["responses"]["BadRequestError"];
4703
- 401: components$k["responses"]["UnauthorizedError"];
4704
- 403: components$k["responses"]["ForbiddenError"];
4705
- 429: components$k["responses"]["RateLimitError"];
4706
- 500: components$k["responses"]["InternalServerError"];
4760
+ 400: components$l["responses"]["BadRequestError"];
4761
+ 401: components$l["responses"]["UnauthorizedError"];
4762
+ 403: components$l["responses"]["ForbiddenError"];
4763
+ 429: components$l["responses"]["RateLimitError"];
4764
+ 500: components$l["responses"]["InternalServerError"];
4707
4765
  };
4708
4766
  };
4709
4767
  options?: never;
@@ -4712,7 +4770,7 @@ interface paths$i {
4712
4770
  trace?: never;
4713
4771
  };
4714
4772
  }
4715
- interface components$k {
4773
+ interface components$l {
4716
4774
  schemas: {
4717
4775
  /** Defines the shape of a data variable on a Data Source or Data Type */
4718
4776
  DataVariableDefinition: {
@@ -4753,7 +4811,7 @@ interface components$k {
4753
4811
  }[];
4754
4812
  /** Variables needed to make calls to the data source */
4755
4813
  variables?: {
4756
- [key: string]: components$k["schemas"]["DataVariableDefinition"];
4814
+ [key: string]: components$l["schemas"]["DataVariableDefinition"];
4757
4815
  };
4758
4816
  };
4759
4817
  /**
@@ -4783,7 +4841,7 @@ interface components$k {
4783
4841
  }[];
4784
4842
  /** Variables needed to make calls to the data source */
4785
4843
  variables?: {
4786
- [key: string]: components$k["schemas"]["DataVariableDefinition"];
4844
+ [key: string]: components$l["schemas"]["DataVariableDefinition"];
4787
4845
  };
4788
4846
  /**
4789
4847
  * Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
@@ -4807,7 +4865,7 @@ interface components$k {
4807
4865
  };
4808
4866
  /** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
4809
4867
  variants?: {
4810
- unpublished?: components$k["schemas"]["AlternativeDataSourceData"];
4868
+ unpublished?: components$l["schemas"]["AlternativeDataSourceData"];
4811
4869
  };
4812
4870
  /** Created date of the data source in ISO 8601 format (ignored for writes) */
4813
4871
  created?: string;
@@ -4830,7 +4888,7 @@ interface components$k {
4830
4888
  [name: string]: unknown;
4831
4889
  };
4832
4890
  content: {
4833
- "application/json": components$k["schemas"]["Error"];
4891
+ "application/json": components$l["schemas"]["Error"];
4834
4892
  };
4835
4893
  };
4836
4894
  /** API key or token was not valid */
@@ -4839,7 +4897,7 @@ interface components$k {
4839
4897
  [name: string]: unknown;
4840
4898
  };
4841
4899
  content: {
4842
- "application/json": components$k["schemas"]["Error"];
4900
+ "application/json": components$l["schemas"]["Error"];
4843
4901
  };
4844
4902
  };
4845
4903
  /** Permission was denied */
@@ -4848,7 +4906,7 @@ interface components$k {
4848
4906
  [name: string]: unknown;
4849
4907
  };
4850
4908
  content: {
4851
- "application/json": components$k["schemas"]["Error"];
4909
+ "application/json": components$l["schemas"]["Error"];
4852
4910
  };
4853
4911
  };
4854
4912
  /** Too many requests in allowed time period */
@@ -4872,7 +4930,7 @@ interface components$k {
4872
4930
  pathItems: never;
4873
4931
  }
4874
4932
 
4875
- interface paths$h {
4933
+ interface paths$i {
4876
4934
  "/api/v1/data-sources": {
4877
4935
  parameters: {
4878
4936
  query?: never;
@@ -4903,15 +4961,15 @@ interface paths$h {
4903
4961
  };
4904
4962
  content: {
4905
4963
  "application/json": {
4906
- results: components$j["schemas"]["DataSource"][];
4964
+ results: components$k["schemas"]["DataSource"][];
4907
4965
  };
4908
4966
  };
4909
4967
  };
4910
- 400: components$j["responses"]["BadRequestError"];
4911
- 401: components$j["responses"]["UnauthorizedError"];
4912
- 403: components$j["responses"]["ForbiddenError"];
4913
- 429: components$j["responses"]["RateLimitError"];
4914
- 500: components$j["responses"]["InternalServerError"];
4968
+ 400: components$k["responses"]["BadRequestError"];
4969
+ 401: components$k["responses"]["UnauthorizedError"];
4970
+ 403: components$k["responses"]["ForbiddenError"];
4971
+ 429: components$k["responses"]["RateLimitError"];
4972
+ 500: components$k["responses"]["InternalServerError"];
4915
4973
  };
4916
4974
  };
4917
4975
  put?: never;
@@ -4923,7 +4981,7 @@ interface paths$h {
4923
4981
  trace?: never;
4924
4982
  };
4925
4983
  }
4926
- interface components$j {
4984
+ interface components$k {
4927
4985
  schemas: {
4928
4986
  /** Defines the shape of a data variable on a Data Source or Data Type */
4929
4987
  DataVariableDefinition: {
@@ -4964,7 +5022,7 @@ interface components$j {
4964
5022
  }[];
4965
5023
  /** Variables needed to make calls to the data source */
4966
5024
  variables?: {
4967
- [key: string]: components$j["schemas"]["DataVariableDefinition"];
5025
+ [key: string]: components$k["schemas"]["DataVariableDefinition"];
4968
5026
  };
4969
5027
  };
4970
5028
  /**
@@ -4994,7 +5052,7 @@ interface components$j {
4994
5052
  }[];
4995
5053
  /** Variables needed to make calls to the data source */
4996
5054
  variables?: {
4997
- [key: string]: components$j["schemas"]["DataVariableDefinition"];
5055
+ [key: string]: components$k["schemas"]["DataVariableDefinition"];
4998
5056
  };
4999
5057
  /**
5000
5058
  * Mapping of locale codes to data source locale codes. Keys are Uniform locale codes, values are data source locale codes.
@@ -5018,7 +5076,7 @@ interface components$j {
5018
5076
  };
5019
5077
  /** Different connector detail variants to use in the different contexts like e.g. Unpublished Data */
5020
5078
  variants?: {
5021
- unpublished?: components$j["schemas"]["AlternativeDataSourceData"];
5079
+ unpublished?: components$k["schemas"]["AlternativeDataSourceData"];
5022
5080
  };
5023
5081
  /** Created date of the data source in ISO 8601 format (ignored for writes) */
5024
5082
  created?: string;
@@ -5041,7 +5099,7 @@ interface components$j {
5041
5099
  [name: string]: unknown;
5042
5100
  };
5043
5101
  content: {
5044
- "application/json": components$j["schemas"]["Error"];
5102
+ "application/json": components$k["schemas"]["Error"];
5045
5103
  };
5046
5104
  };
5047
5105
  /** API key or token was not valid */
@@ -5050,7 +5108,7 @@ interface components$j {
5050
5108
  [name: string]: unknown;
5051
5109
  };
5052
5110
  content: {
5053
- "application/json": components$j["schemas"]["Error"];
5111
+ "application/json": components$k["schemas"]["Error"];
5054
5112
  };
5055
5113
  };
5056
5114
  /** Permission was denied */
@@ -5059,7 +5117,7 @@ interface components$j {
5059
5117
  [name: string]: unknown;
5060
5118
  };
5061
5119
  content: {
5062
- "application/json": components$j["schemas"]["Error"];
5120
+ "application/json": components$k["schemas"]["Error"];
5063
5121
  };
5064
5122
  };
5065
5123
  /** Too many requests in allowed time period */
@@ -5083,7 +5141,7 @@ interface components$j {
5083
5141
  pathItems: never;
5084
5142
  }
5085
5143
 
5086
- interface paths$g {
5144
+ interface paths$h {
5087
5145
  "/api/v1/data-types": {
5088
5146
  parameters: {
5089
5147
  query?: never;
@@ -5109,15 +5167,15 @@ interface paths$g {
5109
5167
  };
5110
5168
  content: {
5111
5169
  "application/json": {
5112
- results: components$i["schemas"]["DataType"][];
5170
+ results: components$j["schemas"]["DataType"][];
5113
5171
  };
5114
5172
  };
5115
5173
  };
5116
- 400: components$i["responses"]["BadRequestError"];
5117
- 401: components$i["responses"]["UnauthorizedError"];
5118
- 403: components$i["responses"]["ForbiddenError"];
5119
- 429: components$i["responses"]["RateLimitError"];
5120
- 500: components$i["responses"]["InternalServerError"];
5174
+ 400: components$j["responses"]["BadRequestError"];
5175
+ 401: components$j["responses"]["UnauthorizedError"];
5176
+ 403: components$j["responses"]["ForbiddenError"];
5177
+ 429: components$j["responses"]["RateLimitError"];
5178
+ 500: components$j["responses"]["InternalServerError"];
5121
5179
  };
5122
5180
  };
5123
5181
  put: {
@@ -5130,7 +5188,7 @@ interface paths$g {
5130
5188
  requestBody: {
5131
5189
  content: {
5132
5190
  "application/json": {
5133
- data: components$i["schemas"]["DataType"];
5191
+ data: components$j["schemas"]["DataType"];
5134
5192
  /** Format: uuid */
5135
5193
  projectId: string;
5136
5194
  };
@@ -5144,11 +5202,11 @@ interface paths$g {
5144
5202
  };
5145
5203
  content?: never;
5146
5204
  };
5147
- 400: components$i["responses"]["BadRequestError"];
5148
- 401: components$i["responses"]["UnauthorizedError"];
5149
- 403: components$i["responses"]["ForbiddenError"];
5150
- 429: components$i["responses"]["RateLimitError"];
5151
- 500: components$i["responses"]["InternalServerError"];
5205
+ 400: components$j["responses"]["BadRequestError"];
5206
+ 401: components$j["responses"]["UnauthorizedError"];
5207
+ 403: components$j["responses"]["ForbiddenError"];
5208
+ 429: components$j["responses"]["RateLimitError"];
5209
+ 500: components$j["responses"]["InternalServerError"];
5152
5210
  };
5153
5211
  };
5154
5212
  post?: never;
@@ -5176,11 +5234,11 @@ interface paths$g {
5176
5234
  };
5177
5235
  content?: never;
5178
5236
  };
5179
- 400: components$i["responses"]["BadRequestError"];
5180
- 401: components$i["responses"]["UnauthorizedError"];
5181
- 403: components$i["responses"]["ForbiddenError"];
5182
- 429: components$i["responses"]["RateLimitError"];
5183
- 500: components$i["responses"]["InternalServerError"];
5237
+ 400: components$j["responses"]["BadRequestError"];
5238
+ 401: components$j["responses"]["UnauthorizedError"];
5239
+ 403: components$j["responses"]["ForbiddenError"];
5240
+ 429: components$j["responses"]["RateLimitError"];
5241
+ 500: components$j["responses"]["InternalServerError"];
5184
5242
  };
5185
5243
  };
5186
5244
  options?: never;
@@ -5189,7 +5247,7 @@ interface paths$g {
5189
5247
  trace?: never;
5190
5248
  };
5191
5249
  }
5192
- interface components$i {
5250
+ interface components$j {
5193
5251
  schemas: {
5194
5252
  /** Defines the shape of a data variable on a Data Source or Data Type */
5195
5253
  DataVariableDefinition: {
@@ -5257,7 +5315,7 @@ interface components$i {
5257
5315
  method: "GET" | "POST" | "HEAD";
5258
5316
  /** Variables needed to make calls to the data type. Merged with variables from the data source, overriding identical keys */
5259
5317
  variables?: {
5260
- [key: string]: components$i["schemas"]["DataVariableDefinition"];
5318
+ [key: string]: components$j["schemas"]["DataVariableDefinition"];
5261
5319
  };
5262
5320
  /** Custom configuration specific to the data source being defined */
5263
5321
  custom?: {
@@ -5284,7 +5342,7 @@ interface components$i {
5284
5342
  [name: string]: unknown;
5285
5343
  };
5286
5344
  content: {
5287
- "application/json": components$i["schemas"]["Error"];
5345
+ "application/json": components$j["schemas"]["Error"];
5288
5346
  };
5289
5347
  };
5290
5348
  /** API key or token was not valid */
@@ -5293,7 +5351,7 @@ interface components$i {
5293
5351
  [name: string]: unknown;
5294
5352
  };
5295
5353
  content: {
5296
- "application/json": components$i["schemas"]["Error"];
5354
+ "application/json": components$j["schemas"]["Error"];
5297
5355
  };
5298
5356
  };
5299
5357
  /** Permission was denied */
@@ -5302,7 +5360,7 @@ interface components$i {
5302
5360
  [name: string]: unknown;
5303
5361
  };
5304
5362
  content: {
5305
- "application/json": components$i["schemas"]["Error"];
5363
+ "application/json": components$j["schemas"]["Error"];
5306
5364
  };
5307
5365
  };
5308
5366
  /** Too many requests in allowed time period */
@@ -5326,7 +5384,7 @@ interface components$i {
5326
5384
  pathItems: never;
5327
5385
  }
5328
5386
 
5329
- interface paths$f {
5387
+ interface paths$g {
5330
5388
  "/api/v1/prompts": {
5331
5389
  parameters: {
5332
5390
  query?: never;
@@ -5353,14 +5411,14 @@ interface paths$f {
5353
5411
  [name: string]: unknown;
5354
5412
  };
5355
5413
  content: {
5356
- "application/json": components$h["schemas"]["Prompt"] | components$h["schemas"]["Prompt"][];
5414
+ "application/json": components$i["schemas"]["Prompt"] | components$i["schemas"]["Prompt"][];
5357
5415
  };
5358
5416
  };
5359
- 400: components$h["responses"]["BadRequestError"];
5360
- 401: components$h["responses"]["UnauthorizedError"];
5361
- 403: components$h["responses"]["ForbiddenError"];
5362
- 429: components$h["responses"]["RateLimitError"];
5363
- 500: components$h["responses"]["InternalServerError"];
5417
+ 400: components$i["responses"]["BadRequestError"];
5418
+ 401: components$i["responses"]["UnauthorizedError"];
5419
+ 403: components$i["responses"]["ForbiddenError"];
5420
+ 429: components$i["responses"]["RateLimitError"];
5421
+ 500: components$i["responses"]["InternalServerError"];
5364
5422
  };
5365
5423
  };
5366
5424
  /** @deprecated */
@@ -5374,7 +5432,7 @@ interface paths$f {
5374
5432
  requestBody: {
5375
5433
  content: {
5376
5434
  "application/json": {
5377
- data: components$h["schemas"]["Prompt"];
5435
+ data: components$i["schemas"]["Prompt"];
5378
5436
  /** Format: uuid */
5379
5437
  projectId: string;
5380
5438
  };
@@ -5388,11 +5446,11 @@ interface paths$f {
5388
5446
  };
5389
5447
  content?: never;
5390
5448
  };
5391
- 400: components$h["responses"]["BadRequestError"];
5392
- 401: components$h["responses"]["UnauthorizedError"];
5393
- 403: components$h["responses"]["ForbiddenError"];
5394
- 429: components$h["responses"]["RateLimitError"];
5395
- 500: components$h["responses"]["InternalServerError"];
5449
+ 400: components$i["responses"]["BadRequestError"];
5450
+ 401: components$i["responses"]["UnauthorizedError"];
5451
+ 403: components$i["responses"]["ForbiddenError"];
5452
+ 429: components$i["responses"]["RateLimitError"];
5453
+ 500: components$i["responses"]["InternalServerError"];
5396
5454
  };
5397
5455
  };
5398
5456
  post?: never;
@@ -5422,11 +5480,11 @@ interface paths$f {
5422
5480
  };
5423
5481
  content?: never;
5424
5482
  };
5425
- 400: components$h["responses"]["BadRequestError"];
5426
- 401: components$h["responses"]["UnauthorizedError"];
5427
- 403: components$h["responses"]["ForbiddenError"];
5428
- 429: components$h["responses"]["RateLimitError"];
5429
- 500: components$h["responses"]["InternalServerError"];
5483
+ 400: components$i["responses"]["BadRequestError"];
5484
+ 401: components$i["responses"]["UnauthorizedError"];
5485
+ 403: components$i["responses"]["ForbiddenError"];
5486
+ 429: components$i["responses"]["RateLimitError"];
5487
+ 500: components$i["responses"]["InternalServerError"];
5430
5488
  };
5431
5489
  };
5432
5490
  options?: never;
@@ -5435,7 +5493,7 @@ interface paths$f {
5435
5493
  trace?: never;
5436
5494
  };
5437
5495
  }
5438
- interface components$h {
5496
+ interface components$i {
5439
5497
  schemas: {
5440
5498
  /** AI Prompt definition */
5441
5499
  Prompt: {
@@ -5473,7 +5531,7 @@ interface components$h {
5473
5531
  [name: string]: unknown;
5474
5532
  };
5475
5533
  content: {
5476
- "application/json": components$h["schemas"]["Error"];
5534
+ "application/json": components$i["schemas"]["Error"];
5477
5535
  };
5478
5536
  };
5479
5537
  /** API key or token was not valid */
@@ -5482,7 +5540,7 @@ interface components$h {
5482
5540
  [name: string]: unknown;
5483
5541
  };
5484
5542
  content: {
5485
- "application/json": components$h["schemas"]["Error"];
5543
+ "application/json": components$i["schemas"]["Error"];
5486
5544
  };
5487
5545
  };
5488
5546
  /** Permission was denied */
@@ -5491,7 +5549,7 @@ interface components$h {
5491
5549
  [name: string]: unknown;
5492
5550
  };
5493
5551
  content: {
5494
- "application/json": components$h["schemas"]["Error"];
5552
+ "application/json": components$i["schemas"]["Error"];
5495
5553
  };
5496
5554
  };
5497
5555
  /** Too many requests in allowed time period */
@@ -5515,10 +5573,10 @@ interface components$h {
5515
5573
  pathItems: never;
5516
5574
  }
5517
5575
 
5518
- type PromptsApi = paths$f['/api/v1/prompts'];
5519
- type DataTypeApi = paths$g['/api/v1/data-types'];
5520
- type DataSourcesApi = paths$h['/api/v1/data-sources'];
5521
- type DataSourceApi = paths$i['/api/v1/data-source'];
5576
+ type PromptsApi = paths$g['/api/v1/prompts'];
5577
+ type DataTypeApi = paths$h['/api/v1/data-types'];
5578
+ type DataSourcesApi = paths$i['/api/v1/data-sources'];
5579
+ type DataSourceApi = paths$j['/api/v1/data-source'];
5522
5580
  /** Query parameter options for GET /api/v1/data-types */
5523
5581
  type DataTypeGetParameters = DataTypeApi['get']['parameters']['query'];
5524
5582
  /** The GET response from /api/v1/data-types */
@@ -5547,14 +5605,14 @@ type PromptsGetResponse = PromptsApi['get']['responses']['200']['content']['appl
5547
5605
  type PromptsPutParameters = PromptsApi['put']['requestBody']['content']['application/json'];
5548
5606
  /** Shape of the DELETE request body for /api/v1/prompts */
5549
5607
  type PromptsDeleteParameters = PromptsApi['delete']['requestBody']['content']['application/json'];
5550
- type DataType = components$q['schemas']['DataType'];
5551
- type DataSource = components$q['schemas']['DataSource'];
5552
- type DataVariableDefinition = components$q['schemas']['DataVariableDefinition'];
5553
- type Prompt = components$q['schemas']['Prompt'];
5608
+ type DataType = components$r['schemas']['DataType'];
5609
+ type DataSource = components$r['schemas']['DataSource'];
5610
+ type DataVariableDefinition = components$r['schemas']['DataVariableDefinition'];
5611
+ type Prompt = components$r['schemas']['Prompt'];
5554
5612
  type DataSourceVariantsKeys = keyof NonNullable<DataSource['variants']>;
5555
5613
  type DataSourceVariantData = NonNullable<DataSource['variants']>['unpublished'];
5556
5614
 
5557
- interface paths$e {
5615
+ interface paths$f {
5558
5616
  "/api/v1/labels": {
5559
5617
  parameters: {
5560
5618
  query?: never;
@@ -5625,11 +5683,11 @@ interface paths$e {
5625
5683
  };
5626
5684
  };
5627
5685
  };
5628
- 400: components$g["responses"]["BadRequestError"];
5629
- 401: components$g["responses"]["UnauthorizedError"];
5630
- 403: components$g["responses"]["ForbiddenError"];
5631
- 429: components$g["responses"]["RateLimitError"];
5632
- 500: components$g["responses"]["InternalServerError"];
5686
+ 400: components$h["responses"]["BadRequestError"];
5687
+ 401: components$h["responses"]["UnauthorizedError"];
5688
+ 403: components$h["responses"]["ForbiddenError"];
5689
+ 429: components$h["responses"]["RateLimitError"];
5690
+ 500: components$h["responses"]["InternalServerError"];
5633
5691
  };
5634
5692
  };
5635
5693
  /** Creates or updates a label */
@@ -5669,11 +5727,11 @@ interface paths$e {
5669
5727
  "application/json": string;
5670
5728
  };
5671
5729
  };
5672
- 400: components$g["responses"]["BadRequestError"];
5673
- 401: components$g["responses"]["UnauthorizedError"];
5674
- 403: components$g["responses"]["ForbiddenError"];
5675
- 429: components$g["responses"]["RateLimitError"];
5676
- 500: components$g["responses"]["InternalServerError"];
5730
+ 400: components$h["responses"]["BadRequestError"];
5731
+ 401: components$h["responses"]["UnauthorizedError"];
5732
+ 403: components$h["responses"]["ForbiddenError"];
5733
+ 429: components$h["responses"]["RateLimitError"];
5734
+ 500: components$h["responses"]["InternalServerError"];
5677
5735
  };
5678
5736
  };
5679
5737
  post?: never;
@@ -5705,6 +5763,185 @@ interface paths$e {
5705
5763
  "application/json": string;
5706
5764
  };
5707
5765
  };
5766
+ 400: components$h["responses"]["BadRequestError"];
5767
+ 401: components$h["responses"]["UnauthorizedError"];
5768
+ 403: components$h["responses"]["ForbiddenError"];
5769
+ 429: components$h["responses"]["RateLimitError"];
5770
+ 500: components$h["responses"]["InternalServerError"];
5771
+ };
5772
+ };
5773
+ /** Handles preflight requests. This endpoint allows CORS. */
5774
+ options: {
5775
+ parameters: {
5776
+ query?: never;
5777
+ header?: never;
5778
+ path?: never;
5779
+ cookie?: never;
5780
+ };
5781
+ requestBody?: never;
5782
+ responses: {
5783
+ /** ok */
5784
+ 204: {
5785
+ headers: {
5786
+ [name: string]: unknown;
5787
+ };
5788
+ content?: never;
5789
+ };
5790
+ };
5791
+ };
5792
+ head?: never;
5793
+ patch?: never;
5794
+ trace?: never;
5795
+ };
5796
+ }
5797
+ interface components$h {
5798
+ schemas: {
5799
+ Error: {
5800
+ /** Error message(s) that occurred while processing the request */
5801
+ errorMessage?: string[] | string;
5802
+ };
5803
+ };
5804
+ responses: {
5805
+ /** Request input validation failed */
5806
+ BadRequestError: {
5807
+ headers: {
5808
+ [name: string]: unknown;
5809
+ };
5810
+ content: {
5811
+ "application/json": components$h["schemas"]["Error"];
5812
+ };
5813
+ };
5814
+ /** API key or token was not valid */
5815
+ UnauthorizedError: {
5816
+ headers: {
5817
+ [name: string]: unknown;
5818
+ };
5819
+ content: {
5820
+ "application/json": components$h["schemas"]["Error"];
5821
+ };
5822
+ };
5823
+ /** Permission was denied */
5824
+ ForbiddenError: {
5825
+ headers: {
5826
+ [name: string]: unknown;
5827
+ };
5828
+ content: {
5829
+ "application/json": components$h["schemas"]["Error"];
5830
+ };
5831
+ };
5832
+ /** Too many requests in allowed time period */
5833
+ RateLimitError: {
5834
+ headers: {
5835
+ [name: string]: unknown;
5836
+ };
5837
+ content?: never;
5838
+ };
5839
+ /** Execution error occurred */
5840
+ InternalServerError: {
5841
+ headers: {
5842
+ [name: string]: unknown;
5843
+ };
5844
+ content?: never;
5845
+ };
5846
+ };
5847
+ parameters: never;
5848
+ requestBodies: never;
5849
+ headers: never;
5850
+ pathItems: never;
5851
+ }
5852
+
5853
+ type LabelsApi = paths$f['/api/v1/labels'];
5854
+ type LabelsQuery = LabelsApi['get']['parameters']['query'];
5855
+ type LabelPut = LabelsApi['put']['requestBody']['content']['application/json'];
5856
+ type LabelDelete = LabelsApi['delete']['requestBody']['content']['application/json'];
5857
+ type LabelsResponse = LabelsApi['get']['responses']['200']['content']['application/json'];
5858
+ type Label = LabelsResponse['labels'][number];
5859
+
5860
+ interface paths$e {
5861
+ "/api/v1/locales": {
5862
+ parameters: {
5863
+ query?: never;
5864
+ header?: never;
5865
+ path?: never;
5866
+ cookie?: never;
5867
+ };
5868
+ get: {
5869
+ parameters: {
5870
+ query: {
5871
+ projectId: string;
5872
+ };
5873
+ header?: never;
5874
+ path?: never;
5875
+ cookie?: never;
5876
+ };
5877
+ requestBody?: never;
5878
+ responses: {
5879
+ /** Gets a list of all defined locales for a project */
5880
+ 200: {
5881
+ headers: {
5882
+ [name: string]: unknown;
5883
+ };
5884
+ content: {
5885
+ "application/json": {
5886
+ results: components$g["schemas"]["Locale"][];
5887
+ };
5888
+ };
5889
+ };
5890
+ 400: components$g["responses"]["BadRequestError"];
5891
+ 401: components$g["responses"]["UnauthorizedError"];
5892
+ 403: components$g["responses"]["ForbiddenError"];
5893
+ 429: components$g["responses"]["RateLimitError"];
5894
+ 500: components$g["responses"]["InternalServerError"];
5895
+ };
5896
+ };
5897
+ put: {
5898
+ parameters: {
5899
+ query?: never;
5900
+ header?: never;
5901
+ path?: never;
5902
+ cookie?: never;
5903
+ };
5904
+ requestBody: {
5905
+ content: {
5906
+ "application/json": components$g["schemas"]["LocalePutBody"];
5907
+ };
5908
+ };
5909
+ responses: {
5910
+ /** OK */
5911
+ 204: {
5912
+ headers: {
5913
+ [name: string]: unknown;
5914
+ };
5915
+ content?: never;
5916
+ };
5917
+ 400: components$g["responses"]["BadRequestError"];
5918
+ 401: components$g["responses"]["UnauthorizedError"];
5919
+ 403: components$g["responses"]["ForbiddenError"];
5920
+ 429: components$g["responses"]["RateLimitError"];
5921
+ 500: components$g["responses"]["InternalServerError"];
5922
+ };
5923
+ };
5924
+ post?: never;
5925
+ delete: {
5926
+ parameters: {
5927
+ query?: never;
5928
+ header?: never;
5929
+ path?: never;
5930
+ cookie?: never;
5931
+ };
5932
+ requestBody: {
5933
+ content: {
5934
+ "application/json": components$g["schemas"]["LocaleDeleteBody"];
5935
+ };
5936
+ };
5937
+ responses: {
5938
+ /** OK */
5939
+ 204: {
5940
+ headers: {
5941
+ [name: string]: unknown;
5942
+ };
5943
+ content?: never;
5944
+ };
5708
5945
  400: components$g["responses"]["BadRequestError"];
5709
5946
  401: components$g["responses"]["UnauthorizedError"];
5710
5947
  403: components$g["responses"]["ForbiddenError"];
@@ -5712,32 +5949,68 @@ interface paths$e {
5712
5949
  500: components$g["responses"]["InternalServerError"];
5713
5950
  };
5714
5951
  };
5715
- /** Handles preflight requests. This endpoint allows CORS. */
5716
- options: {
5717
- parameters: {
5718
- query?: never;
5719
- header?: never;
5720
- path?: never;
5721
- cookie?: never;
5722
- };
5723
- requestBody?: never;
5724
- responses: {
5725
- /** ok */
5726
- 204: {
5727
- headers: {
5728
- [name: string]: unknown;
5729
- };
5730
- content?: never;
5731
- };
5732
- };
5952
+ options?: never;
5953
+ head?: never;
5954
+ patch?: never;
5955
+ trace?: never;
5956
+ };
5957
+ }
5958
+ interface components$g {
5959
+ schemas: {
5960
+ Locale: {
5961
+ /**
5962
+ * The locale code
5963
+ * @example en-US
5964
+ */
5965
+ locale: string;
5966
+ /**
5967
+ * The locale's display name in the UI
5968
+ * @example English (United States)
5969
+ */
5970
+ displayName: string;
5971
+ /**
5972
+ * Whether this is the default locale
5973
+ * @example true
5974
+ */
5975
+ isDefault?: boolean;
5976
+ /**
5977
+ * Primary grouping to place the locale in, i.e. region or other business-specific grouping type.
5978
+ * When not set, the locale is not placed in any grouping.
5979
+ * Used only for display purposes.
5980
+ * @example EMEA, Belgium, North America, etc.
5981
+ */
5982
+ group?: string;
5983
+ /**
5984
+ * Arbitrary tags to associate with the locale. Used to create locale selection presets.
5985
+ * @example [
5986
+ * "all-english",
5987
+ * "english-emea",
5988
+ * "core"
5989
+ * ]
5990
+ */
5991
+ tags?: string[];
5992
+ /**
5993
+ * Order in which the locale should be displayed in the UI.
5994
+ * Lower numbers are displayed first.
5995
+ */
5996
+ order?: number;
5997
+ };
5998
+ LocalePutBody: {
5999
+ locale: components$g["schemas"]["Locale"];
6000
+ /**
6001
+ * Format: uuid
6002
+ * The project ID
6003
+ */
6004
+ projectId: string;
6005
+ };
6006
+ LocaleDeleteBody: {
6007
+ locale: string;
6008
+ /**
6009
+ * Format: uuid
6010
+ * The project ID
6011
+ */
6012
+ projectId: string;
5733
6013
  };
5734
- head?: never;
5735
- patch?: never;
5736
- trace?: never;
5737
- };
5738
- }
5739
- interface components$g {
5740
- schemas: {
5741
6014
  Error: {
5742
6015
  /** Error message(s) that occurred while processing the request */
5743
6016
  errorMessage?: string[] | string;
@@ -5792,25 +6065,39 @@ interface components$g {
5792
6065
  pathItems: never;
5793
6066
  }
5794
6067
 
5795
- type LabelsApi = paths$e['/api/v1/labels'];
5796
- type LabelsQuery = LabelsApi['get']['parameters']['query'];
5797
- type LabelPut = LabelsApi['put']['requestBody']['content']['application/json'];
5798
- type LabelDelete = LabelsApi['delete']['requestBody']['content']['application/json'];
5799
- type LabelsResponse = LabelsApi['get']['responses']['200']['content']['application/json'];
5800
- type Label = LabelsResponse['labels'][number];
6068
+ type LocalesApi = paths$e['/api/v1/locales'];
6069
+ /** A locale definition */
6070
+ type Locale = components$g['schemas']['Locale'];
6071
+ /** Query parameter options for GET /api/v1/locales */
6072
+ type LocalesGetParameters = LocalesApi['get']['parameters']['query'];
6073
+ /** The GET response from /api/v1/locales */
6074
+ type LocalesGetResponse = LocalesApi['get']['responses']['200']['content']['application/json'];
6075
+ /** The PUT request body for /api/v1/locales */
6076
+ type LocalePutParameters = LocalesApi['put']['requestBody']['content']['application/json'];
6077
+ /** Shape of the DELETE request body for /api/v1/locales */
6078
+ type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
6079
+ declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
5801
6080
 
5802
6081
  interface paths$d {
5803
- "/api/v1/locales": {
6082
+ "/api/v1/views": {
5804
6083
  parameters: {
5805
6084
  query?: never;
5806
6085
  header?: never;
5807
6086
  path?: never;
5808
6087
  cookie?: never;
5809
6088
  };
6089
+ /** Lists saved views for a project + resource type. */
5810
6090
  get: {
5811
6091
  parameters: {
5812
6092
  query: {
6093
+ /** Project the views belong to. */
5813
6094
  projectId: string;
6095
+ /** Resource type these views apply to (e.g. "entry"). */
6096
+ resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
6097
+ /** Number of records to skip. */
6098
+ offset?: number | null;
6099
+ /** Maximum number of records to return. */
6100
+ limit?: number;
5814
6101
  };
5815
6102
  header?: never;
5816
6103
  path?: never;
@@ -5818,14 +6105,37 @@ interface paths$d {
5818
6105
  };
5819
6106
  requestBody?: never;
5820
6107
  responses: {
5821
- /** Gets a list of all defined locales for a project */
6108
+ /** OK */
5822
6109
  200: {
5823
6110
  headers: {
5824
6111
  [name: string]: unknown;
5825
6112
  };
5826
6113
  content: {
5827
6114
  "application/json": {
5828
- results: components$f["schemas"]["Locale"][];
6115
+ views: {
6116
+ name: string;
6117
+ description?: string;
6118
+ searchTerm?: string;
6119
+ filters: {
6120
+ field: string;
6121
+ dynamicField?: string;
6122
+ operator: string;
6123
+ value: string | string[];
6124
+ }[];
6125
+ sort?: string[];
6126
+ shared: boolean;
6127
+ icon?: string;
6128
+ id: string;
6129
+ projectId: string;
6130
+ /** @enum {string} */
6131
+ resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
6132
+ createdBy: string | null;
6133
+ /** Format: date-time */
6134
+ created: string;
6135
+ /** Format: date-time */
6136
+ modified: string;
6137
+ }[];
6138
+ totalCount: number;
5829
6139
  };
5830
6140
  };
5831
6141
  };
@@ -5836,6 +6146,7 @@ interface paths$d {
5836
6146
  500: components$f["responses"]["InternalServerError"];
5837
6147
  };
5838
6148
  };
6149
+ /** Create-or-replace a saved view by id. The caller mints the UUID. Omitted optional fields are cleared. `shared` may only be promoted (personal → shared); demotion returns 400. `projectId` and `resourceType` are immutable after create. */
5839
6150
  put: {
5840
6151
  parameters: {
5841
6152
  query?: never;
@@ -5845,25 +6156,81 @@ interface paths$d {
5845
6156
  };
5846
6157
  requestBody: {
5847
6158
  content: {
5848
- "application/json": components$f["schemas"]["LocalePutBody"];
6159
+ "application/json": {
6160
+ name: string;
6161
+ description?: string;
6162
+ searchTerm?: string;
6163
+ filters: {
6164
+ field: string;
6165
+ dynamicField?: string;
6166
+ operator: string;
6167
+ value: string | string[];
6168
+ }[];
6169
+ sort?: string[];
6170
+ shared: boolean;
6171
+ icon?: string;
6172
+ id: string;
6173
+ projectId: string;
6174
+ /** @enum {string} */
6175
+ resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
6176
+ };
5849
6177
  };
5850
6178
  };
5851
6179
  responses: {
5852
6180
  /** OK */
5853
- 204: {
6181
+ 200: {
5854
6182
  headers: {
5855
6183
  [name: string]: unknown;
5856
6184
  };
5857
- content?: never;
6185
+ content: {
6186
+ "application/json": {
6187
+ name: string;
6188
+ description?: string;
6189
+ searchTerm?: string;
6190
+ filters: {
6191
+ field: string;
6192
+ dynamicField?: string;
6193
+ operator: string;
6194
+ value: string | string[];
6195
+ }[];
6196
+ sort?: string[];
6197
+ shared: boolean;
6198
+ icon?: string;
6199
+ id: string;
6200
+ projectId: string;
6201
+ /** @enum {string} */
6202
+ resourceType: "composition" | "compositionPattern" | "component" | "componentPattern" | "entry" | "entryPattern" | "contentType" | "blockType" | "release" | "signal" | "intent" | "audience" | "asset";
6203
+ createdBy: string | null;
6204
+ /** Format: date-time */
6205
+ created: string;
6206
+ /** Format: date-time */
6207
+ modified: string;
6208
+ };
6209
+ };
5858
6210
  };
5859
6211
  400: components$f["responses"]["BadRequestError"];
5860
6212
  401: components$f["responses"]["UnauthorizedError"];
5861
6213
  403: components$f["responses"]["ForbiddenError"];
6214
+ /** View not found (or belongs to another project). */
6215
+ 404: {
6216
+ headers: {
6217
+ [name: string]: unknown;
6218
+ };
6219
+ content?: never;
6220
+ };
6221
+ /** Quota exceeded: at most 100 saved views allowed for this project + resource type + user. Remove an existing view before creating a new one. */
6222
+ 409: {
6223
+ headers: {
6224
+ [name: string]: unknown;
6225
+ };
6226
+ content?: never;
6227
+ };
5862
6228
  429: components$f["responses"]["RateLimitError"];
5863
6229
  500: components$f["responses"]["InternalServerError"];
5864
6230
  };
5865
6231
  };
5866
6232
  post?: never;
6233
+ /** Deletes a saved view by id. */
5867
6234
  delete: {
5868
6235
  parameters: {
5869
6236
  query?: never;
@@ -5873,25 +6240,55 @@ interface paths$d {
5873
6240
  };
5874
6241
  requestBody: {
5875
6242
  content: {
5876
- "application/json": components$f["schemas"]["LocaleDeleteBody"];
6243
+ "application/json": {
6244
+ id: string;
6245
+ projectId: string;
6246
+ };
5877
6247
  };
5878
6248
  };
5879
6249
  responses: {
5880
- /** OK */
6250
+ /** No Content */
5881
6251
  204: {
5882
6252
  headers: {
5883
6253
  [name: string]: unknown;
5884
6254
  };
5885
- content?: never;
6255
+ content: {
6256
+ "application/json": string;
6257
+ };
5886
6258
  };
5887
6259
  400: components$f["responses"]["BadRequestError"];
5888
6260
  401: components$f["responses"]["UnauthorizedError"];
5889
6261
  403: components$f["responses"]["ForbiddenError"];
6262
+ /** View not found. */
6263
+ 404: {
6264
+ headers: {
6265
+ [name: string]: unknown;
6266
+ };
6267
+ content?: never;
6268
+ };
5890
6269
  429: components$f["responses"]["RateLimitError"];
5891
6270
  500: components$f["responses"]["InternalServerError"];
5892
6271
  };
5893
6272
  };
5894
- options?: never;
6273
+ /** Handles preflight requests. This endpoint allows CORS. */
6274
+ options: {
6275
+ parameters: {
6276
+ query?: never;
6277
+ header?: never;
6278
+ path?: never;
6279
+ cookie?: never;
6280
+ };
6281
+ requestBody?: never;
6282
+ responses: {
6283
+ /** ok */
6284
+ 204: {
6285
+ headers: {
6286
+ [name: string]: unknown;
6287
+ };
6288
+ content?: never;
6289
+ };
6290
+ };
6291
+ };
5895
6292
  head?: never;
5896
6293
  patch?: never;
5897
6294
  trace?: never;
@@ -5899,60 +6296,6 @@ interface paths$d {
5899
6296
  }
5900
6297
  interface components$f {
5901
6298
  schemas: {
5902
- Locale: {
5903
- /**
5904
- * The locale code
5905
- * @example en-US
5906
- */
5907
- locale: string;
5908
- /**
5909
- * The locale's display name in the UI
5910
- * @example English (United States)
5911
- */
5912
- displayName: string;
5913
- /**
5914
- * Whether this is the default locale
5915
- * @example true
5916
- */
5917
- isDefault?: boolean;
5918
- /**
5919
- * Primary grouping to place the locale in, i.e. region or other business-specific grouping type.
5920
- * When not set, the locale is not placed in any grouping.
5921
- * Used only for display purposes.
5922
- * @example EMEA, Belgium, North America, etc.
5923
- */
5924
- group?: string;
5925
- /**
5926
- * Arbitrary tags to associate with the locale. Used to create locale selection presets.
5927
- * @example [
5928
- * "all-english",
5929
- * "english-emea",
5930
- * "core"
5931
- * ]
5932
- */
5933
- tags?: string[];
5934
- /**
5935
- * Order in which the locale should be displayed in the UI.
5936
- * Lower numbers are displayed first.
5937
- */
5938
- order?: number;
5939
- };
5940
- LocalePutBody: {
5941
- locale: components$f["schemas"]["Locale"];
5942
- /**
5943
- * Format: uuid
5944
- * The project ID
5945
- */
5946
- projectId: string;
5947
- };
5948
- LocaleDeleteBody: {
5949
- locale: string;
5950
- /**
5951
- * Format: uuid
5952
- * The project ID
5953
- */
5954
- projectId: string;
5955
- };
5956
6299
  Error: {
5957
6300
  /** Error message(s) that occurred while processing the request */
5958
6301
  errorMessage?: string[] | string;
@@ -6007,18 +6350,17 @@ interface components$f {
6007
6350
  pathItems: never;
6008
6351
  }
6009
6352
 
6010
- type LocalesApi = paths$d['/api/v1/locales'];
6011
- /** A locale definition */
6012
- type Locale = components$f['schemas']['Locale'];
6013
- /** Query parameter options for GET /api/v1/locales */
6014
- type LocalesGetParameters = LocalesApi['get']['parameters']['query'];
6015
- /** The GET response from /api/v1/locales */
6016
- type LocalesGetResponse = LocalesApi['get']['responses']['200']['content']['application/json'];
6017
- /** The PUT request body for /api/v1/locales */
6018
- type LocalePutParameters = LocalesApi['put']['requestBody']['content']['application/json'];
6019
- /** Shape of the DELETE request body for /api/v1/locales */
6020
- type LocaleDeleteParameters = LocalesApi['delete']['requestBody']['content']['application/json'];
6021
- declare const LOCALE_DYNAMIC_INPUT_NAME = "locale";
6353
+ type ViewsApi = paths$d['/api/v1/views'];
6354
+ type ViewsQuery = ViewsApi['get']['parameters']['query'];
6355
+ type ViewPut = ViewsApi['put']['requestBody']['content']['application/json'];
6356
+ type ViewDelete = ViewsApi['delete']['requestBody']['content']['application/json'];
6357
+ type ViewsResponse = ViewsApi['get']['responses']['200']['content']['application/json'];
6358
+ type View = ViewsResponse['views'][number];
6359
+ /**
6360
+ * File/sync shape for a shared custom view. Audit fields and `projectId` are
6361
+ * stripped on pull; `id` is kept so PUT is create-or-replace across projects.
6362
+ */
6363
+ type SerializedCustomView = Omit<View, 'projectId' | 'createdBy' | 'created' | 'modified'>;
6022
6364
 
6023
6365
  interface components$e {
6024
6366
  schemas: {
@@ -6222,6 +6564,12 @@ interface components$e {
6222
6564
  value?: string;
6223
6565
  /** Help text for authors who might be setting up a preview value for this query string */
6224
6566
  helpText?: string;
6567
+ /**
6568
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
6569
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
6570
+
6571
+ */
6572
+ editorVisibility?: "opt-in";
6225
6573
  /** Configuration for providing a list of allowed values for this query string */
6226
6574
  optionsSource?: {
6227
6575
  /**
@@ -6311,6 +6659,11 @@ interface components$e {
6311
6659
  _patternDataResources?: {
6312
6660
  [key: string]: components$e["schemas"]["DataResourceDefinition"];
6313
6661
  };
6662
+ /**
6663
+ * Query-string opt-ins coming from a pattern resolved for this component.
6664
+ * Means nothing for PUTs; it will be ignored
6665
+ */
6666
+ _patternOptedInQueryStrings?: string[];
6314
6667
  _patternError?: components$e["schemas"]["PatternError"];
6315
6668
  /**
6316
6669
  * Defines patch overrides to component IDs that live in the composition.
@@ -6474,6 +6827,11 @@ interface components$e {
6474
6827
  _patternDataResources?: {
6475
6828
  [key: string]: components$e["schemas"]["DataResourceDefinition"];
6476
6829
  };
6830
+ /**
6831
+ * Query-string opt-ins coming from a pattern resolved for this component.
6832
+ * Means nothing for PUTs; it will be ignored
6833
+ */
6834
+ _patternOptedInQueryStrings?: string[];
6477
6835
  _dataResources?: components$e["schemas"]["DataResourceDefinitions"];
6478
6836
  _patternError?: components$e["schemas"]["PatternError"];
6479
6837
  /**
@@ -6508,6 +6866,12 @@ interface components$e {
6508
6866
  _overridability?: components$e["schemas"]["ComponentOverridability"];
6509
6867
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
6510
6868
  _locales?: string[];
6869
+ /**
6870
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
6871
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
6872
+ * holds only what was authored here. Omitted whenever overrides are resolved.
6873
+ */
6874
+ _optedInQueryStrings?: string[];
6511
6875
  };
6512
6876
  /** Permissions for a workflow stage */
6513
6877
  WorkflowStagePermission: {
@@ -7593,6 +7957,12 @@ interface components$d {
7593
7957
  value?: string;
7594
7958
  /** Help text for authors who might be setting up a preview value for this query string */
7595
7959
  helpText?: string;
7960
+ /**
7961
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
7962
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
7963
+
7964
+ */
7965
+ editorVisibility?: "opt-in";
7596
7966
  /** Configuration for providing a list of allowed values for this query string */
7597
7967
  optionsSource?: {
7598
7968
  /**
@@ -7682,6 +8052,11 @@ interface components$d {
7682
8052
  _patternDataResources?: {
7683
8053
  [key: string]: components$d["schemas"]["DataResourceDefinition"];
7684
8054
  };
8055
+ /**
8056
+ * Query-string opt-ins coming from a pattern resolved for this component.
8057
+ * Means nothing for PUTs; it will be ignored
8058
+ */
8059
+ _patternOptedInQueryStrings?: string[];
7685
8060
  _patternError?: components$d["schemas"]["PatternError"];
7686
8061
  /**
7687
8062
  * Defines patch overrides to component IDs that live in the composition.
@@ -7845,6 +8220,11 @@ interface components$d {
7845
8220
  _patternDataResources?: {
7846
8221
  [key: string]: components$d["schemas"]["DataResourceDefinition"];
7847
8222
  };
8223
+ /**
8224
+ * Query-string opt-ins coming from a pattern resolved for this component.
8225
+ * Means nothing for PUTs; it will be ignored
8226
+ */
8227
+ _patternOptedInQueryStrings?: string[];
7848
8228
  _dataResources?: components$d["schemas"]["DataResourceDefinitions"];
7849
8229
  _patternError?: components$d["schemas"]["PatternError"];
7850
8230
  /**
@@ -7879,6 +8259,12 @@ interface components$d {
7879
8259
  _overridability?: components$d["schemas"]["ComponentOverridability"];
7880
8260
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
7881
8261
  _locales?: string[];
8262
+ /**
8263
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
8264
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
8265
+ * holds only what was authored here. Omitted whenever overrides are resolved.
8266
+ */
8267
+ _optedInQueryStrings?: string[];
7882
8268
  };
7883
8269
  /** Permissions for a workflow stage */
7884
8270
  WorkflowStagePermission: {
@@ -8701,6 +9087,12 @@ interface components$b {
8701
9087
  value?: string;
8702
9088
  /** Help text for authors who might be setting up a preview value for this query string */
8703
9089
  helpText?: string;
9090
+ /**
9091
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
9092
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
9093
+
9094
+ */
9095
+ editorVisibility?: "opt-in";
8704
9096
  /** Configuration for providing a list of allowed values for this query string */
8705
9097
  optionsSource?: {
8706
9098
  /**
@@ -8790,6 +9182,11 @@ interface components$b {
8790
9182
  _patternDataResources?: {
8791
9183
  [key: string]: components$b["schemas"]["DataResourceDefinition"];
8792
9184
  };
9185
+ /**
9186
+ * Query-string opt-ins coming from a pattern resolved for this component.
9187
+ * Means nothing for PUTs; it will be ignored
9188
+ */
9189
+ _patternOptedInQueryStrings?: string[];
8793
9190
  _patternError?: components$b["schemas"]["PatternError"];
8794
9191
  /**
8795
9192
  * Defines patch overrides to component IDs that live in the composition.
@@ -8953,6 +9350,11 @@ interface components$b {
8953
9350
  _patternDataResources?: {
8954
9351
  [key: string]: components$b["schemas"]["DataResourceDefinition"];
8955
9352
  };
9353
+ /**
9354
+ * Query-string opt-ins coming from a pattern resolved for this component.
9355
+ * Means nothing for PUTs; it will be ignored
9356
+ */
9357
+ _patternOptedInQueryStrings?: string[];
8956
9358
  _dataResources?: components$b["schemas"]["DataResourceDefinitions"];
8957
9359
  _patternError?: components$b["schemas"]["PatternError"];
8958
9360
  /**
@@ -8987,6 +9389,12 @@ interface components$b {
8987
9389
  _overridability?: components$b["schemas"]["ComponentOverridability"];
8988
9390
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
8989
9391
  _locales?: string[];
9392
+ /**
9393
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
9394
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
9395
+ * holds only what was authored here. Omitted whenever overrides are resolved.
9396
+ */
9397
+ _optedInQueryStrings?: string[];
8990
9398
  };
8991
9399
  /** Permissions for a workflow stage */
8992
9400
  WorkflowStagePermission: {
@@ -10141,6 +10549,12 @@ interface components$a {
10141
10549
  value?: string;
10142
10550
  /** Help text for authors who might be setting up a preview value for this query string */
10143
10551
  helpText?: string;
10552
+ /**
10553
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
10554
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
10555
+
10556
+ */
10557
+ editorVisibility?: "opt-in";
10144
10558
  /** Configuration for providing a list of allowed values for this query string */
10145
10559
  optionsSource?: {
10146
10560
  /**
@@ -10230,6 +10644,11 @@ interface components$a {
10230
10644
  _patternDataResources?: {
10231
10645
  [key: string]: components$a["schemas"]["DataResourceDefinition"];
10232
10646
  };
10647
+ /**
10648
+ * Query-string opt-ins coming from a pattern resolved for this component.
10649
+ * Means nothing for PUTs; it will be ignored
10650
+ */
10651
+ _patternOptedInQueryStrings?: string[];
10233
10652
  _patternError?: components$a["schemas"]["PatternError"];
10234
10653
  /**
10235
10654
  * Defines patch overrides to component IDs that live in the composition.
@@ -10393,6 +10812,11 @@ interface components$a {
10393
10812
  _patternDataResources?: {
10394
10813
  [key: string]: components$a["schemas"]["DataResourceDefinition"];
10395
10814
  };
10815
+ /**
10816
+ * Query-string opt-ins coming from a pattern resolved for this component.
10817
+ * Means nothing for PUTs; it will be ignored
10818
+ */
10819
+ _patternOptedInQueryStrings?: string[];
10396
10820
  _dataResources?: components$a["schemas"]["DataResourceDefinitions"];
10397
10821
  _patternError?: components$a["schemas"]["PatternError"];
10398
10822
  /**
@@ -10427,6 +10851,12 @@ interface components$a {
10427
10851
  _overridability?: components$a["schemas"]["ComponentOverridability"];
10428
10852
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
10429
10853
  _locales?: string[];
10854
+ /**
10855
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
10856
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
10857
+ * holds only what was authored here. Omitted whenever overrides are resolved.
10858
+ */
10859
+ _optedInQueryStrings?: string[];
10430
10860
  };
10431
10861
  /** Permissions for a workflow stage */
10432
10862
  WorkflowStagePermission: {
@@ -10777,7 +11207,7 @@ interface components$a {
10777
11207
  }
10778
11208
 
10779
11209
  type Components = components$d['schemas'];
10780
- type SharedComponents$1 = components$q['schemas'];
11210
+ type SharedComponents$1 = components$r['schemas'];
10781
11211
  type Api = paths$c['/api/v1/canvas'];
10782
11212
  type HistoryApi = paths$b['/api/v1/canvas-history'];
10783
11213
  /** Query parameter options for GET /api/v1/canvas */
@@ -10925,6 +11355,7 @@ type CanvasDefinitions = {
10925
11355
  previewUrls?: Array<PreviewUrl>;
10926
11356
  previewViewports?: Array<PreviewViewport>;
10927
11357
  webhooks?: Array<WebhookDefinition>;
11358
+ customViews?: Array<SerializedCustomView>;
10928
11359
  };
10929
11360
  /** Defines shared parameters for requests getting a single composition */
10930
11361
  type CompositionGetOneSharedParameters = Pick<CompositionGetParameters, 'state' | 'skipEnhance' | 'skipPatternResolution' | 'withComponentIDs' | 'withUIStatus' | 'withWorkflowDefinition' | 'withProjectMapNodes' | 'withTotalCount' | 'skipOverridesResolution' | 'withContentSourceMap' | 'versionId' | 'locale' | 'releaseId' | 'editions' | 'deleted' | 'pattern' | 'withPatternType'>;
@@ -11038,8 +11469,8 @@ type RouteGetResponseRedirect = components$e['schemas']['RouteResponseRedirect']
11038
11469
  type RouteGetResponseNotFound = components$e['schemas']['RouteResponseNotFound'];
11039
11470
  type RouteDynamicInputs = components$e['schemas']['RouteDynamicInputs'];
11040
11471
  /** The GET response from /api/v1/entries */
11041
- type EntriesGetParameters = paths$k['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
11042
- type EntriesGetResponse = components$o['schemas']['EntryListResponse'];
11472
+ type EntriesGetParameters = paths$l['/api/v1/entries']['get']['parameters']['query'] & DataResolutionParameters;
11473
+ type EntriesGetResponse = components$p['schemas']['EntryListResponse'];
11043
11474
  type EntriesResolvedListResponse = components$b['schemas']['EntryResolvedListResponse'];
11044
11475
  /** GET response from uniform.global/api/v1/route when result is a composition */
11045
11476
  type RouteGetResponseEdgehancedComposition = Omit<RouteGetResponseComposition, 'compositionApiResponse'> & {
@@ -13190,7 +13621,7 @@ interface components$3 {
13190
13621
  }
13191
13622
 
13192
13623
  type WorkflowsApi = paths$3['/api/v1/workflows'];
13193
- type SharedComponents = components$q['schemas'];
13624
+ type SharedComponents = components$r['schemas'];
13194
13625
  type WorkflowDefinition = SharedComponents['WorkflowDefinition'];
13195
13626
  type WorkflowStage = SharedComponents['WorkflowStage'];
13196
13627
  type WorkflowStagePermission = SharedComponents['WorkflowStagePermission'];
@@ -13513,7 +13944,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
13513
13944
  getCompositionHistory(options: ExceptProject<ComponentInstanceHistoryGetParameters>): Promise<{
13514
13945
  cursor?: string;
13515
13946
  truncated?: boolean;
13516
- results?: components$q["schemas"]["HistoryEntry"][];
13947
+ results?: components$r["schemas"]["HistoryEntry"][];
13517
13948
  }>;
13518
13949
  private getOneComposition;
13519
13950
  /** Updates or creates a Canvas component definition */
@@ -13524,7 +13955,7 @@ declare class CanvasClient extends ApiClient<CanvasClientOptions> {
13524
13955
  removeComposition(body: Omit<CompositionDeleteParameters, 'projectId'>): Promise<void>;
13525
13956
  /** Fetches all Canvas component definitions */
13526
13957
  getComponentDefinitions(options?: Omit<ComponentDefinitionGetParameters, 'projectId'>): Promise<{
13527
- componentDefinitions: components$p["schemas"]["ComponentDefinition"][];
13958
+ componentDefinitions: components$q["schemas"]["ComponentDefinition"][];
13528
13959
  }>;
13529
13960
  /** Updates or creates a Canvas component definition */
13530
13961
  updateComponentDefinition(body: Omit<ComponentDefinitionPutParameters, 'projectId'>): Promise<void>;
@@ -13566,7 +13997,7 @@ declare class ContentClient extends ApiClient<ContentClientOptions> {
13566
13997
  getEntryHistory(options: ExceptProject<EntriesHistoryGetParameters>): Promise<{
13567
13998
  cursor?: string;
13568
13999
  truncated?: boolean;
13569
- results?: components$q["schemas"]["HistoryEntry"][];
14000
+ results?: components$r["schemas"]["HistoryEntry"][];
13570
14001
  }>;
13571
14002
  upsertContentType(body: ExceptProject<PutContentTypeBody>, opts?: {
13572
14003
  autogenerateDataTypes?: boolean;
@@ -13591,15 +14022,15 @@ declare class DataSourceClient extends ApiClient {
13591
14022
  constructor(options: ClientOptions);
13592
14023
  /** Fetches a single DataSource by id (with decrypted secrets). */
13593
14024
  get(options?: ExceptProject<DataSourceGetParameters>): Promise<{
13594
- result: components$k["schemas"]["DataSource"];
14025
+ result: components$l["schemas"]["DataSource"];
13595
14026
  }>;
13596
14027
  /** Fetches the list of DataSources for a project (secrets masked). */
13597
14028
  list(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
13598
- results: components$j["schemas"]["DataSource"][];
14029
+ results: components$k["schemas"]["DataSource"][];
13599
14030
  }>;
13600
14031
  /** @deprecated Use {@link list} instead. */
13601
14032
  getList(options?: ExceptProject<DataSourcesGetParameters>): Promise<{
13602
- results: components$j["schemas"]["DataSource"][];
14033
+ results: components$k["schemas"]["DataSource"][];
13603
14034
  }>;
13604
14035
  /** Updates or creates (based on id) a DataSource */
13605
14036
  save(body: ExceptProject<DataSourcePutParameters>): Promise<void>;
@@ -13976,9 +14407,9 @@ type VisibilityParameterValue = {
13976
14407
  /** Criteria for the visibility of the component. If these evaluate to false, the component is hidden. */
13977
14408
  criteria?: VisibilityCriteriaGroup;
13978
14409
  };
13979
- type VisibilityCriteriaGroup = components$q['schemas']['VisibilityCriteriaGroup'];
13980
- type VisibilityCriteria = components$q['schemas']['VisibilityCriteria'];
13981
- type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$q['schemas']['ComponentParameterConditionalValue'], 'value'> & {
14410
+ type VisibilityCriteriaGroup = components$r['schemas']['VisibilityCriteriaGroup'];
14411
+ type VisibilityCriteria = components$r['schemas']['VisibilityCriteria'];
14412
+ type ComponentParameterConditionalValue<TValue = unknown> = Omit<components$r['schemas']['ComponentParameterConditionalValue'], 'value'> & {
13982
14413
  value: TValue;
13983
14414
  };
13984
14415
  /**
@@ -14242,11 +14673,11 @@ declare class LocaleClient extends ApiClient {
14242
14673
  constructor(options: ClientOptions);
14243
14674
  /** Fetches a list of locales for a project */
14244
14675
  list(options?: ExceptProject<LocalesGetParameters>): Promise<{
14245
- results: components$f["schemas"]["Locale"][];
14676
+ results: components$g["schemas"]["Locale"][];
14246
14677
  }>;
14247
14678
  /** @deprecated Use {@link list} instead. */
14248
14679
  get(options?: ExceptProject<LocalesGetParameters>): Promise<{
14249
- results: components$f["schemas"]["Locale"][];
14680
+ results: components$g["schemas"]["Locale"][];
14250
14681
  }>;
14251
14682
  /** Updates or creates (based on id) a locale */
14252
14683
  save(body: ExceptProject<LocalePutParameters>): Promise<void>;
@@ -15400,12 +15831,12 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
15400
15831
  }) => (message: Pick<UpdateCompositionMessage, "composition" | "hash">) => Promise<{
15401
15832
  type: string;
15402
15833
  parameters?: {
15403
- [key: string]: components$q["schemas"]["ComponentParameter"];
15834
+ [key: string]: components$r["schemas"]["ComponentParameter"];
15404
15835
  };
15405
15836
  variant?: string;
15406
- projectMapNodes?: components$q["schemas"]["CompositionProjectMapNodeInfo"][];
15837
+ projectMapNodes?: components$r["schemas"]["CompositionProjectMapNodeInfo"][];
15407
15838
  slots?: {
15408
- [key: string]: components$q["schemas"]["ComponentInstance"][];
15839
+ [key: string]: components$r["schemas"]["ComponentInstance"][];
15409
15840
  };
15410
15841
  _id: string;
15411
15842
  _slug?: string | null;
@@ -15416,18 +15847,20 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
15416
15847
  _creatorSubject?: string;
15417
15848
  _pattern?: string;
15418
15849
  _patternDataResources?: {
15419
- [key: string]: components$q["schemas"]["DataResourceDefinition"];
15850
+ [key: string]: components$r["schemas"]["DataResourceDefinition"];
15420
15851
  };
15421
- _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
15422
- _patternError?: components$q["schemas"]["PatternError"];
15852
+ _patternOptedInQueryStrings?: string[];
15853
+ _dataResources?: components$r["schemas"]["DataResourceDefinitions"];
15854
+ _patternError?: components$r["schemas"]["PatternError"];
15423
15855
  _overrides?: {
15424
- [key: string]: components$q["schemas"]["ComponentOverride"];
15856
+ [key: string]: components$r["schemas"]["ComponentOverride"];
15425
15857
  };
15426
15858
  _patternOverrides?: {
15427
- [key: string]: components$q["schemas"]["ComponentOverride"];
15859
+ [key: string]: components$r["schemas"]["ComponentOverride"];
15428
15860
  };
15429
- _overridability?: components$q["schemas"]["ComponentOverridability"];
15861
+ _overridability?: components$r["schemas"]["ComponentOverridability"];
15430
15862
  _locales?: string[];
15863
+ _optedInQueryStrings?: string[];
15431
15864
  }>;
15432
15865
 
15433
15866
  /**
@@ -15684,4 +16117,4 @@ declare class WorkflowClient extends ApiClient {
15684
16117
 
15685
16118
  declare const CanvasClientError: typeof ApiClientError;
15686
16119
 
15687
- 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 AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, 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 ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, 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 DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, 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 EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, 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, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, 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 RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };
16120
+ 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 AiAction, type AssetParamConfig, type AwaitingReadyMessage, type BatchEnhancer, BatchEntry, type BatchInvalidationPayload, type BindVariablesOptions, type BindVariablesResult, type BindVariablesToObjectOptions, BlockFormatError, type BlockLocationReference, type BlockValue, CANVAS_BLOCK_PARAM_TYPE, CANVAS_COMPONENT_DISPLAY_NAME_PARAM, CANVAS_CONTEXTUAL_EDITING_PARAM, CANVAS_DRAFT_STATE, CANVAS_EDITOR_STATE, CANVAS_ENRICHMENT_TAG_PARAM, CANVAS_HYPOTHESIS_PARAM, CANVAS_INTENT_TAG_PARAM, CANVAS_INTERNAL_PARAM_PREFIX, CANVAS_LOCALE_TAG_PARAM, CANVAS_LOCALIZATION_SLOT, CANVAS_LOCALIZATION_TYPE, CANVAS_PERSONALIZATION_ALGORITHM_PARAM, CANVAS_PERSONALIZATION_ALGORITHM_TYPE, CANVAS_PERSONALIZATION_EVENT_NAME_PARAM, CANVAS_PERSONALIZATION_PARAM, CANVAS_PERSONALIZATION_TAKE_PARAM, CANVAS_PERSONALIZE_SLOT, CANVAS_PERSONALIZE_TYPE, CANVAS_PUBLISHED_STATE, CANVAS_SLOT_SECTION_GROUP_TYPE_PARAM, CANVAS_SLOT_SECTION_MAX_PARAM, CANVAS_SLOT_SECTION_MIN_PARAM, CANVAS_SLOT_SECTION_NAME_PARAM, CANVAS_SLOT_SECTION_SLOT, CANVAS_SLOT_SECTION_SPECIFIC_PARAM, CANVAS_SLOT_SECTION_TYPE, CANVAS_TEST_SLOT, CANVAS_TEST_TYPE, CANVAS_TEST_VARIANT_PARAM, CANVAS_VIZ_CONTROL_PARAM, CANVAS_VIZ_DI_RULE, CANVAS_VIZ_DYNAMIC_TOKEN_RULE, CANVAS_VIZ_LOCALE_RULE, CANVAS_VIZ_QUIRKS_RULE, CanvasClient, CanvasClientError, type CanvasDefinitions, type CategoriesDeleteParameters, type CategoriesGetParameters, type CategoriesGetResponse, type CategoriesPutParameters, type Category, CategoryClient, type Channel, type ChannelMessage, ChildEnhancerBuilder, type ComponentDefinition, ComponentDefinitionClient, 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 ComponentOverridability, type ComponentOverride, type ComponentOverrides, type ComponentParameter, type ComponentParameterBlock, type ComponentParameterConditionalValue, type ComponentParameterContextualEditing, type ComponentParameterEnhancer, type ComponentParameterEnhancerFunction, type ComponentParameterEnhancerOptions, type CompositionDeleteParameters, CompositionDeliveryClient, type CompositionDeliveryListQuery, type CompositionDeliveryReadOptions, type CompositionDeliverySelector, type CompositionFilters, type CompositionGetByComponentIdParameters, type CompositionGetByIdParameters, type CompositionGetByNodeIdParameters, type CompositionGetByNodePathParameters, type CompositionGetBySlugParameters, type CompositionGetListResponse, type CompositionGetParameters, type CompositionGetResponse, type CompositionGetValidResponses, type CompositionListQuery, CompositionManagementClient, type CompositionManagementListQuery, type CompositionManagementReadOptions, type CompositionManagementSelector, type CompositionPutParameters, type CompositionReadOptions, type CompositionResolvedGetResponse, type CompositionResolvedListResponse, type CompositionUIStatus, type CompositionWriteSelector, ContentClient, type ContentType, ContentTypeClient, type ContentTypeField, type ContentTypePreviewConfiguration, type ContextStorageUpdatedMessage, type ContextualEditingComponentReference, type ContextualEditingValue, type CopiedComponentSubtree, type DataDiagnostic, type DataElementBindingIssue, type DataElementConnectionDefinition, type DataElementConnectionFailureAction, type DataElementConnectionFailureLogLevel, 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 DataSourceVariantData, type DataSourceVariantsKeys, type DataSourcesGetParameters, type DataSourcesGetResponse, type DataType, DataTypeClient, type DataTypeDeleteParameters, type DataTypeGetParameters, type DataTypeGetResponse, type DataTypePutParameters, type DataVariableDefinition, type DataWithProperties, type DateParamConfig, type DateParamValue, type DatetimeParamConfig, 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 EdgehancersWholeResponseCacheDiagnostics, type EditorStateUpdatedMessage, EnhancerBuilder, type EnhancerContext, type EnhancerError, EntityReleasesClient, type EntityReleasesGetParameters, type EntityReleasesGetResponse, type EntriesGetParameters, type EntriesGetResponse, type EntriesHistoryGetParameters, type EntriesHistoryGetResponse, type EntriesResolvedListResponse, type Entry, type EntryData, EntryDeliveryClient, type EntryDeliveryListQuery, type EntryDeliveryReadOptions, type EntryFilters, type EntryList, type EntryListQuery, EntryManagementClient, type EntryManagementListQuery, type EntryManagementReadOptions, type EntryReadOptions, type EntrySelector, type EntryWriteSelector, type EvaluateCriteriaGroupOptions, type EvaluateNodeTreeVisibilityOptions, type EvaluateNodeVisibilityParameterOptions, type EvaluatePropertyCriteriaOptions, type EvaluateWalkTreePropertyCriteriaOptions, type FieldTypesProjection, type FieldsProjection, type Filters, type FindInNodeTreeReference, type FlattenProperty, type FlattenValues, type FlattenValuesOptions, type GetContentTypesOptions, type GetContentTypesResponse, type GetEffectivePropertyValueOptions, 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, IntegrationPropertyEditorsClient, type IntegrationPropertyEditorsDeleteParameters, type IntegrationPropertyEditorsGetParameters, type IntegrationPropertyEditorsGetResponse, type paths$9 as IntegrationPropertyEditorsPaths, type IntegrationPropertyEditorsPutParameters, type InvalidationPayload, LOCALE_DYNAMIC_INPUT_NAME, type Label, LabelClient, type LabelDelete, type LabelPut, type LabelsQuery, type LabelsResponse, type LimitPolicy, type LinkParamConfiguration, type LinkParamValue, type LinkParameterType, type LinkTypeConfiguration, type ListEditions, type Locale, LocaleClient, type LocaleDeleteParameters, type LocalePutParameters, type LocalesGetParameters, type LocalesGetResponse, type LocalizeOptions, type ManagementEditionsOverride, type ManagementFormat, type MaxDepthExceededIssue, type MessageHandler, type MoveComponentMessage, type MultiSelectParamConfiguration, type MultiSelectParamEditorType, type MultiSelectParamValue, type NodeLocationReference, type NonProjectMapLinkParamValue, type NumberParamConfig, type NumberParamEditorType, type NumberParamValue, type OpenParameterEditorMessage, type OverrideOptions, PLACEHOLDER_ID, type ParamTypeConfigConventions, type PatternIssue, PreviewClient, type PreviewPanelSettings, type PreviewUrl, type PreviewUrlDeleteParameters, type PreviewUrlDeleteResponse, type PreviewUrlPutParameters, type PreviewUrlPutResponse, type PreviewUrlsGetParameters, type PreviewUrlsGetResponse, type PreviewViewport, type PreviewViewportDeleteParameters, type PreviewViewportDeleteResponse, type PreviewViewportPutParameters, type PreviewViewportPutResponse, type PreviewViewportsGetParameters, type PreviewViewportsGetResponse, type Project, ProjectClient, type ProjectDeleteParameters, type ProjectGetParameters, type ProjectGetResponse, type ProjectMapLinkParamValue, type ProjectPutParameters, type ProjectPutResponse, type Projection, type ProjectionSpec, type ProjectsGetParameters, type ProjectsGetProject, type ProjectsGetResponse, type ProjectsGetTeam, type Prompt, PromptClient, type PromptsDeleteParameters, type PromptsGetParameters, type PromptsGetResponse, type PromptsPutParameters, type PropertyCriteriaMatch, type PropertyValue, type PutContentTypeBody, type PutEntryBody, REFERENCE_DATA_TYPE_ID, type ReadyMessage, RelationshipClient, type RelationshipResultInstance, type Release, ReleaseClient, type ReleaseContent, ReleaseContentsClient, type ReleaseContentsDeleteBody, type ReleaseContentsGetParameters, type ReleaseContentsGetResponse, type ReleaseDeleteParameters, type ReleasePatchParameters, type ReleasePutParameters, type ReleaseState, type ReleasesGetParameters, type ReleasesGetResponse, type ReportRenderedCompositionsMessage, type RequestComponentSuggestionMessage, type RequestPageHtmlMessage, 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 RouteGetResponseEdgehancedNotFound, type RouteGetResponseNotFound, type RouteGetResponseRedirect, SECRET_QUERY_STRING_PARAM, SELECT_QUERY_PREFIX, type SaveOptions, type SaveResult, type SelectComponentMessage, type SelectParamConfiguration, type SelectParamEditorType, type SelectParamOption, type SelectParamValue, type SelectParameterMessage, type SendPageHtmlMessage, type SerializedCustomView, type SessionPendingMessage, type SlotsProjection, type SpecificProjectMap, type StringOperators, type SuggestComponentMessage, type TextParamConfig, type TextParamValue, type TreeNodeInfoTypes, type TriggerComponentActionMessage, type TriggerCompositionActionMessage, UncachedCanvasClient, UncachedCategoryClient, UncachedContentClient, UncachedLabelClient, UniqueBatchEntries, type UpdateAiActionsMessage, type UpdateComponentParameterMessage, type UpdateComponentReferencesMessage, type UpdateCompositionInternalMessage, type UpdateCompositionMessage, type UpdateCompositionOptions, type UpdateContextualEditingStateInternalMessage, type UpdateFeatureFlagsMessage, type UpdatePreviewSettingsMessage, type UpsertEntryOptions, type View, type ViewDelete, type ViewPut, type ViewsQuery, type ViewsResponse, type VisibilityCriteria, type VisibilityCriteriaEvaluationResult, type VisibilityCriteriaGroup, type VisibilityParameterValue, type VisibilityRule, type VisibilityRules, type WalkNodeTreeActions, type WalkNodeTreeOptions, type WebhookDefinition, WorkflowClient, type WorkflowDefinition, type WorkflowStage, type WorkflowStagePermission, type WorkflowStageTransition, type WorkflowStageTransitionPermission, type WorkflowsDeleteParameters, type WorkflowsGetParameters, type WorkflowsGetResponse, type WorkflowsPutParameters, autoFixParameterGroups, bindExpressionEscapeChars, bindExpressionPrefix, bindVariables, bindVariablesToObject, compose, convertEntryToPutEntry, convertToBindExpression, createBatchEnhancer, createCanvasChannel, createDynamicInputVisibilityRule, createDynamicTokenVisibilityRule, createLimitPolicy, createLocaleVisibilityRule, createQuirksVisibilityRule, createUniformApiEnhancer, createVariableReference, enhance, escapeBindExpressionDefaultValue, evaluateNodeVisibilityParameter, evaluatePropertyCriteria, evaluateVisibilityCriteriaGroup, evaluateWalkTreeNodeVisibility, evaluateWalkTreePropertyCriteria, extractLocales, findParameterInNodeTree, flattenValues, generateComponentPlaceholderId, generateHash, getBlockValue, getComponentJsonPointer, getComponentPath, getDataSourceVariantFromRouteGetParams, getEffectivePropertyValue, getLocalizedPropertyValues, getNounForLocation, getNounForNode, getParameterAttributes, getPropertiesValue, hasReferencedVariables, isAddComponentMessage, isAllowedReferrer, isAssetParamValue, isAssetParamValueItem, isAwaitingReadyMessage, isComponentActionMessage, isComponentPlaceholderId, isContextStorageUpdatedMessage, isDismissPlaceholderMessage, isEntryData, isLinkParamValue, isMovingComponentMessage, isNestedNodeType, isOpenParameterEditorMessage, isReadyMessage, isReportRenderedCompositionsMessage, isRequestComponentSuggestionMessage, isRootEntryReference, isSelectComponentMessage, isSelectParameterMessage, isSessionPendingMessage, isSuggestComponentMessage, isSystemComponentDefinition, isTriggerCompositionActionMessage, isUpdateAiActionsMessage, isUpdateComponentParameterMessage, isUpdateComponentReferencesMessage, isUpdateCompositionInternalMessage, isUpdateCompositionMessage, isUpdateContextualEditingStateInternalMessage, isUpdateFeatureFlagsMessage, isUpdatePreviewSettingsMessage, localize, mapSlotToPersonalizedVariations, mapSlotToTestVariations, matchesProjectionPattern, mergeAssetConfigWithDefaults, nullLimitPolicy, parseComponentPlaceholderId, parseVariableExpression, projectionToQuery, queryToProjection, version, walkNodeTree, walkPropertyValues };