@uniformdev/canvas 20.78.0 → 20.79.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -571,6 +571,11 @@ interface components$q {
571
571
  _patternDataResources?: {
572
572
  [key: string]: components$q["schemas"]["DataResourceDefinition"];
573
573
  };
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[];
574
579
  _patternError?: components$q["schemas"]["PatternError"];
575
580
  /**
576
581
  * Defines patch overrides to component IDs that live in the composition.
@@ -644,6 +649,11 @@ interface components$q {
644
649
  _patternDataResources?: {
645
650
  [key: string]: components$q["schemas"]["DataResourceDefinition"];
646
651
  };
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[];
647
657
  _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
648
658
  _patternError?: components$q["schemas"]["PatternError"];
649
659
  /**
@@ -678,6 +688,12 @@ interface components$q {
678
688
  _overridability?: components$q["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.
@@ -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
  /**
@@ -1610,6 +1632,11 @@ interface components$p {
1610
1632
  _patternDataResources?: {
1611
1633
  [key: string]: components$p["schemas"]["DataResourceDefinition"];
1612
1634
  };
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[];
1613
1640
  _patternError?: components$p["schemas"]["PatternError"];
1614
1641
  /**
1615
1642
  * Defines patch overrides to component IDs that live in the composition.
@@ -2414,6 +2441,11 @@ interface components$o {
2414
2441
  _patternDataResources?: {
2415
2442
  [key: string]: components$o["schemas"]["DataResourceDefinition"];
2416
2443
  };
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[];
2417
2449
  _patternError?: components$o["schemas"]["PatternError"];
2418
2450
  /**
2419
2451
  * Defines patch overrides to component IDs that live in the composition.
@@ -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
@@ -3336,6 +3375,12 @@ interface paths$k {
3336
3375
  * Prefer selecting a `format` rather than using this option.
3337
3376
  */
3338
3377
  skipOverridesResolution?: components$m["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$m["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.
@@ -3390,15 +3435,16 @@ interface paths$k {
3390
3435
  editions?: components$m["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
3449
  format?: components$m["parameters"]["format"];
3404
3450
  /**
@@ -3789,6 +3835,11 @@ interface components$m {
3789
3835
  _patternDataResources?: {
3790
3836
  [key: string]: components$m["schemas"]["DataResourceDefinition"];
3791
3837
  };
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[];
3792
3843
  _patternError?: components$m["schemas"]["PatternError"];
3793
3844
  /**
3794
3845
  * Defines patch overrides to component IDs that live in the composition.
@@ -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
  /**
@@ -6222,6 +6280,12 @@ interface components$e {
6222
6280
  value?: string;
6223
6281
  /** Help text for authors who might be setting up a preview value for this query string */
6224
6282
  helpText?: string;
6283
+ /**
6284
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
6285
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
6286
+
6287
+ */
6288
+ editorVisibility?: "opt-in";
6225
6289
  /** Configuration for providing a list of allowed values for this query string */
6226
6290
  optionsSource?: {
6227
6291
  /**
@@ -6311,6 +6375,11 @@ interface components$e {
6311
6375
  _patternDataResources?: {
6312
6376
  [key: string]: components$e["schemas"]["DataResourceDefinition"];
6313
6377
  };
6378
+ /**
6379
+ * Query-string opt-ins coming from a pattern resolved for this component.
6380
+ * Means nothing for PUTs; it will be ignored
6381
+ */
6382
+ _patternOptedInQueryStrings?: string[];
6314
6383
  _patternError?: components$e["schemas"]["PatternError"];
6315
6384
  /**
6316
6385
  * Defines patch overrides to component IDs that live in the composition.
@@ -6474,6 +6543,11 @@ interface components$e {
6474
6543
  _patternDataResources?: {
6475
6544
  [key: string]: components$e["schemas"]["DataResourceDefinition"];
6476
6545
  };
6546
+ /**
6547
+ * Query-string opt-ins coming from a pattern resolved for this component.
6548
+ * Means nothing for PUTs; it will be ignored
6549
+ */
6550
+ _patternOptedInQueryStrings?: string[];
6477
6551
  _dataResources?: components$e["schemas"]["DataResourceDefinitions"];
6478
6552
  _patternError?: components$e["schemas"]["PatternError"];
6479
6553
  /**
@@ -6508,6 +6582,12 @@ interface components$e {
6508
6582
  _overridability?: components$e["schemas"]["ComponentOverridability"];
6509
6583
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
6510
6584
  _locales?: string[];
6585
+ /**
6586
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
6587
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
6588
+ * holds only what was authored here. Omitted whenever overrides are resolved.
6589
+ */
6590
+ _optedInQueryStrings?: string[];
6511
6591
  };
6512
6592
  /** Permissions for a workflow stage */
6513
6593
  WorkflowStagePermission: {
@@ -7593,6 +7673,12 @@ interface components$d {
7593
7673
  value?: string;
7594
7674
  /** Help text for authors who might be setting up a preview value for this query string */
7595
7675
  helpText?: string;
7676
+ /**
7677
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
7678
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
7679
+
7680
+ */
7681
+ editorVisibility?: "opt-in";
7596
7682
  /** Configuration for providing a list of allowed values for this query string */
7597
7683
  optionsSource?: {
7598
7684
  /**
@@ -7682,6 +7768,11 @@ interface components$d {
7682
7768
  _patternDataResources?: {
7683
7769
  [key: string]: components$d["schemas"]["DataResourceDefinition"];
7684
7770
  };
7771
+ /**
7772
+ * Query-string opt-ins coming from a pattern resolved for this component.
7773
+ * Means nothing for PUTs; it will be ignored
7774
+ */
7775
+ _patternOptedInQueryStrings?: string[];
7685
7776
  _patternError?: components$d["schemas"]["PatternError"];
7686
7777
  /**
7687
7778
  * Defines patch overrides to component IDs that live in the composition.
@@ -7845,6 +7936,11 @@ interface components$d {
7845
7936
  _patternDataResources?: {
7846
7937
  [key: string]: components$d["schemas"]["DataResourceDefinition"];
7847
7938
  };
7939
+ /**
7940
+ * Query-string opt-ins coming from a pattern resolved for this component.
7941
+ * Means nothing for PUTs; it will be ignored
7942
+ */
7943
+ _patternOptedInQueryStrings?: string[];
7848
7944
  _dataResources?: components$d["schemas"]["DataResourceDefinitions"];
7849
7945
  _patternError?: components$d["schemas"]["PatternError"];
7850
7946
  /**
@@ -7879,6 +7975,12 @@ interface components$d {
7879
7975
  _overridability?: components$d["schemas"]["ComponentOverridability"];
7880
7976
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
7881
7977
  _locales?: string[];
7978
+ /**
7979
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
7980
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
7981
+ * holds only what was authored here. Omitted whenever overrides are resolved.
7982
+ */
7983
+ _optedInQueryStrings?: string[];
7882
7984
  };
7883
7985
  /** Permissions for a workflow stage */
7884
7986
  WorkflowStagePermission: {
@@ -8701,6 +8803,12 @@ interface components$b {
8701
8803
  value?: string;
8702
8804
  /** Help text for authors who might be setting up a preview value for this query string */
8703
8805
  helpText?: string;
8806
+ /**
8807
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
8808
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
8809
+
8810
+ */
8811
+ editorVisibility?: "opt-in";
8704
8812
  /** Configuration for providing a list of allowed values for this query string */
8705
8813
  optionsSource?: {
8706
8814
  /**
@@ -8790,6 +8898,11 @@ interface components$b {
8790
8898
  _patternDataResources?: {
8791
8899
  [key: string]: components$b["schemas"]["DataResourceDefinition"];
8792
8900
  };
8901
+ /**
8902
+ * Query-string opt-ins coming from a pattern resolved for this component.
8903
+ * Means nothing for PUTs; it will be ignored
8904
+ */
8905
+ _patternOptedInQueryStrings?: string[];
8793
8906
  _patternError?: components$b["schemas"]["PatternError"];
8794
8907
  /**
8795
8908
  * Defines patch overrides to component IDs that live in the composition.
@@ -8953,6 +9066,11 @@ interface components$b {
8953
9066
  _patternDataResources?: {
8954
9067
  [key: string]: components$b["schemas"]["DataResourceDefinition"];
8955
9068
  };
9069
+ /**
9070
+ * Query-string opt-ins coming from a pattern resolved for this component.
9071
+ * Means nothing for PUTs; it will be ignored
9072
+ */
9073
+ _patternOptedInQueryStrings?: string[];
8956
9074
  _dataResources?: components$b["schemas"]["DataResourceDefinitions"];
8957
9075
  _patternError?: components$b["schemas"]["PatternError"];
8958
9076
  /**
@@ -8987,6 +9105,12 @@ interface components$b {
8987
9105
  _overridability?: components$b["schemas"]["ComponentOverridability"];
8988
9106
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
8989
9107
  _locales?: string[];
9108
+ /**
9109
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
9110
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
9111
+ * holds only what was authored here. Omitted whenever overrides are resolved.
9112
+ */
9113
+ _optedInQueryStrings?: string[];
8990
9114
  };
8991
9115
  /** Permissions for a workflow stage */
8992
9116
  WorkflowStagePermission: {
@@ -10141,6 +10265,12 @@ interface components$a {
10141
10265
  value?: string;
10142
10266
  /** Help text for authors who might be setting up a preview value for this query string */
10143
10267
  helpText?: string;
10268
+ /**
10269
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
10270
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
10271
+
10272
+ */
10273
+ editorVisibility?: "opt-in";
10144
10274
  /** Configuration for providing a list of allowed values for this query string */
10145
10275
  optionsSource?: {
10146
10276
  /**
@@ -10230,6 +10360,11 @@ interface components$a {
10230
10360
  _patternDataResources?: {
10231
10361
  [key: string]: components$a["schemas"]["DataResourceDefinition"];
10232
10362
  };
10363
+ /**
10364
+ * Query-string opt-ins coming from a pattern resolved for this component.
10365
+ * Means nothing for PUTs; it will be ignored
10366
+ */
10367
+ _patternOptedInQueryStrings?: string[];
10233
10368
  _patternError?: components$a["schemas"]["PatternError"];
10234
10369
  /**
10235
10370
  * Defines patch overrides to component IDs that live in the composition.
@@ -10393,6 +10528,11 @@ interface components$a {
10393
10528
  _patternDataResources?: {
10394
10529
  [key: string]: components$a["schemas"]["DataResourceDefinition"];
10395
10530
  };
10531
+ /**
10532
+ * Query-string opt-ins coming from a pattern resolved for this component.
10533
+ * Means nothing for PUTs; it will be ignored
10534
+ */
10535
+ _patternOptedInQueryStrings?: string[];
10396
10536
  _dataResources?: components$a["schemas"]["DataResourceDefinitions"];
10397
10537
  _patternError?: components$a["schemas"]["PatternError"];
10398
10538
  /**
@@ -10427,6 +10567,12 @@ interface components$a {
10427
10567
  _overridability?: components$a["schemas"]["ComponentOverridability"];
10428
10568
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
10429
10569
  _locales?: string[];
10570
+ /**
10571
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
10572
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
10573
+ * holds only what was authored here. Omitted whenever overrides are resolved.
10574
+ */
10575
+ _optedInQueryStrings?: string[];
10430
10576
  };
10431
10577
  /** Permissions for a workflow stage */
10432
10578
  WorkflowStagePermission: {
@@ -15418,6 +15564,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
15418
15564
  _patternDataResources?: {
15419
15565
  [key: string]: components$q["schemas"]["DataResourceDefinition"];
15420
15566
  };
15567
+ _patternOptedInQueryStrings?: string[];
15421
15568
  _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
15422
15569
  _patternError?: components$q["schemas"]["PatternError"];
15423
15570
  _overrides?: {
@@ -15428,6 +15575,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
15428
15575
  };
15429
15576
  _overridability?: components$q["schemas"]["ComponentOverridability"];
15430
15577
  _locales?: string[];
15578
+ _optedInQueryStrings?: string[];
15431
15579
  }>;
15432
15580
 
15433
15581
  /**
@@ -15661,7 +15809,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
15661
15809
  */
15662
15810
  declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
15663
15811
 
15664
- declare const version = "20.78.0";
15812
+ declare const version = "20.79.1";
15665
15813
 
15666
15814
  /** API client to enable managing workflow definitions */
15667
15815
  declare class WorkflowClient extends ApiClient {
package/dist/index.d.ts CHANGED
@@ -571,6 +571,11 @@ interface components$q {
571
571
  _patternDataResources?: {
572
572
  [key: string]: components$q["schemas"]["DataResourceDefinition"];
573
573
  };
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[];
574
579
  _patternError?: components$q["schemas"]["PatternError"];
575
580
  /**
576
581
  * Defines patch overrides to component IDs that live in the composition.
@@ -644,6 +649,11 @@ interface components$q {
644
649
  _patternDataResources?: {
645
650
  [key: string]: components$q["schemas"]["DataResourceDefinition"];
646
651
  };
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[];
647
657
  _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
648
658
  _patternError?: components$q["schemas"]["PatternError"];
649
659
  /**
@@ -678,6 +688,12 @@ interface components$q {
678
688
  _overridability?: components$q["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.
@@ -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
  /**
@@ -1610,6 +1632,11 @@ interface components$p {
1610
1632
  _patternDataResources?: {
1611
1633
  [key: string]: components$p["schemas"]["DataResourceDefinition"];
1612
1634
  };
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[];
1613
1640
  _patternError?: components$p["schemas"]["PatternError"];
1614
1641
  /**
1615
1642
  * Defines patch overrides to component IDs that live in the composition.
@@ -2414,6 +2441,11 @@ interface components$o {
2414
2441
  _patternDataResources?: {
2415
2442
  [key: string]: components$o["schemas"]["DataResourceDefinition"];
2416
2443
  };
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[];
2417
2449
  _patternError?: components$o["schemas"]["PatternError"];
2418
2450
  /**
2419
2451
  * Defines patch overrides to component IDs that live in the composition.
@@ -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
@@ -3336,6 +3375,12 @@ interface paths$k {
3336
3375
  * Prefer selecting a `format` rather than using this option.
3337
3376
  */
3338
3377
  skipOverridesResolution?: components$m["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$m["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.
@@ -3390,15 +3435,16 @@ interface paths$k {
3390
3435
  editions?: components$m["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
3449
  format?: components$m["parameters"]["format"];
3404
3450
  /**
@@ -3789,6 +3835,11 @@ interface components$m {
3789
3835
  _patternDataResources?: {
3790
3836
  [key: string]: components$m["schemas"]["DataResourceDefinition"];
3791
3837
  };
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[];
3792
3843
  _patternError?: components$m["schemas"]["PatternError"];
3793
3844
  /**
3794
3845
  * Defines patch overrides to component IDs that live in the composition.
@@ -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
  /**
@@ -6222,6 +6280,12 @@ interface components$e {
6222
6280
  value?: string;
6223
6281
  /** Help text for authors who might be setting up a preview value for this query string */
6224
6282
  helpText?: string;
6283
+ /**
6284
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
6285
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
6286
+
6287
+ */
6288
+ editorVisibility?: "opt-in";
6225
6289
  /** Configuration for providing a list of allowed values for this query string */
6226
6290
  optionsSource?: {
6227
6291
  /**
@@ -6311,6 +6375,11 @@ interface components$e {
6311
6375
  _patternDataResources?: {
6312
6376
  [key: string]: components$e["schemas"]["DataResourceDefinition"];
6313
6377
  };
6378
+ /**
6379
+ * Query-string opt-ins coming from a pattern resolved for this component.
6380
+ * Means nothing for PUTs; it will be ignored
6381
+ */
6382
+ _patternOptedInQueryStrings?: string[];
6314
6383
  _patternError?: components$e["schemas"]["PatternError"];
6315
6384
  /**
6316
6385
  * Defines patch overrides to component IDs that live in the composition.
@@ -6474,6 +6543,11 @@ interface components$e {
6474
6543
  _patternDataResources?: {
6475
6544
  [key: string]: components$e["schemas"]["DataResourceDefinition"];
6476
6545
  };
6546
+ /**
6547
+ * Query-string opt-ins coming from a pattern resolved for this component.
6548
+ * Means nothing for PUTs; it will be ignored
6549
+ */
6550
+ _patternOptedInQueryStrings?: string[];
6477
6551
  _dataResources?: components$e["schemas"]["DataResourceDefinitions"];
6478
6552
  _patternError?: components$e["schemas"]["PatternError"];
6479
6553
  /**
@@ -6508,6 +6582,12 @@ interface components$e {
6508
6582
  _overridability?: components$e["schemas"]["ComponentOverridability"];
6509
6583
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
6510
6584
  _locales?: string[];
6585
+ /**
6586
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
6587
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
6588
+ * holds only what was authored here. Omitted whenever overrides are resolved.
6589
+ */
6590
+ _optedInQueryStrings?: string[];
6511
6591
  };
6512
6592
  /** Permissions for a workflow stage */
6513
6593
  WorkflowStagePermission: {
@@ -7593,6 +7673,12 @@ interface components$d {
7593
7673
  value?: string;
7594
7674
  /** Help text for authors who might be setting up a preview value for this query string */
7595
7675
  helpText?: string;
7676
+ /**
7677
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
7678
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
7679
+
7680
+ */
7681
+ editorVisibility?: "opt-in";
7596
7682
  /** Configuration for providing a list of allowed values for this query string */
7597
7683
  optionsSource?: {
7598
7684
  /**
@@ -7682,6 +7768,11 @@ interface components$d {
7682
7768
  _patternDataResources?: {
7683
7769
  [key: string]: components$d["schemas"]["DataResourceDefinition"];
7684
7770
  };
7771
+ /**
7772
+ * Query-string opt-ins coming from a pattern resolved for this component.
7773
+ * Means nothing for PUTs; it will be ignored
7774
+ */
7775
+ _patternOptedInQueryStrings?: string[];
7685
7776
  _patternError?: components$d["schemas"]["PatternError"];
7686
7777
  /**
7687
7778
  * Defines patch overrides to component IDs that live in the composition.
@@ -7845,6 +7936,11 @@ interface components$d {
7845
7936
  _patternDataResources?: {
7846
7937
  [key: string]: components$d["schemas"]["DataResourceDefinition"];
7847
7938
  };
7939
+ /**
7940
+ * Query-string opt-ins coming from a pattern resolved for this component.
7941
+ * Means nothing for PUTs; it will be ignored
7942
+ */
7943
+ _patternOptedInQueryStrings?: string[];
7848
7944
  _dataResources?: components$d["schemas"]["DataResourceDefinitions"];
7849
7945
  _patternError?: components$d["schemas"]["PatternError"];
7850
7946
  /**
@@ -7879,6 +7975,12 @@ interface components$d {
7879
7975
  _overridability?: components$d["schemas"]["ComponentOverridability"];
7880
7976
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
7881
7977
  _locales?: string[];
7978
+ /**
7979
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
7980
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
7981
+ * holds only what was authored here. Omitted whenever overrides are resolved.
7982
+ */
7983
+ _optedInQueryStrings?: string[];
7882
7984
  };
7883
7985
  /** Permissions for a workflow stage */
7884
7986
  WorkflowStagePermission: {
@@ -8701,6 +8803,12 @@ interface components$b {
8701
8803
  value?: string;
8702
8804
  /** Help text for authors who might be setting up a preview value for this query string */
8703
8805
  helpText?: string;
8806
+ /**
8807
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
8808
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
8809
+
8810
+ */
8811
+ editorVisibility?: "opt-in";
8704
8812
  /** Configuration for providing a list of allowed values for this query string */
8705
8813
  optionsSource?: {
8706
8814
  /**
@@ -8790,6 +8898,11 @@ interface components$b {
8790
8898
  _patternDataResources?: {
8791
8899
  [key: string]: components$b["schemas"]["DataResourceDefinition"];
8792
8900
  };
8901
+ /**
8902
+ * Query-string opt-ins coming from a pattern resolved for this component.
8903
+ * Means nothing for PUTs; it will be ignored
8904
+ */
8905
+ _patternOptedInQueryStrings?: string[];
8793
8906
  _patternError?: components$b["schemas"]["PatternError"];
8794
8907
  /**
8795
8908
  * Defines patch overrides to component IDs that live in the composition.
@@ -8953,6 +9066,11 @@ interface components$b {
8953
9066
  _patternDataResources?: {
8954
9067
  [key: string]: components$b["schemas"]["DataResourceDefinition"];
8955
9068
  };
9069
+ /**
9070
+ * Query-string opt-ins coming from a pattern resolved for this component.
9071
+ * Means nothing for PUTs; it will be ignored
9072
+ */
9073
+ _patternOptedInQueryStrings?: string[];
8956
9074
  _dataResources?: components$b["schemas"]["DataResourceDefinitions"];
8957
9075
  _patternError?: components$b["schemas"]["PatternError"];
8958
9076
  /**
@@ -8987,6 +9105,12 @@ interface components$b {
8987
9105
  _overridability?: components$b["schemas"]["ComponentOverridability"];
8988
9106
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
8989
9107
  _locales?: string[];
9108
+ /**
9109
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
9110
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
9111
+ * holds only what was authored here. Omitted whenever overrides are resolved.
9112
+ */
9113
+ _optedInQueryStrings?: string[];
8990
9114
  };
8991
9115
  /** Permissions for a workflow stage */
8992
9116
  WorkflowStagePermission: {
@@ -10141,6 +10265,12 @@ interface components$a {
10141
10265
  value?: string;
10142
10266
  /** Help text for authors who might be setting up a preview value for this query string */
10143
10267
  helpText?: string;
10268
+ /**
10269
+ * Controls whether a global query string is always shown in Canvas or must be opted into.
10270
+ * This property is ignored on node-level query strings. When omitted, the query string is always shown.
10271
+
10272
+ */
10273
+ editorVisibility?: "opt-in";
10144
10274
  /** Configuration for providing a list of allowed values for this query string */
10145
10275
  optionsSource?: {
10146
10276
  /**
@@ -10230,6 +10360,11 @@ interface components$a {
10230
10360
  _patternDataResources?: {
10231
10361
  [key: string]: components$a["schemas"]["DataResourceDefinition"];
10232
10362
  };
10363
+ /**
10364
+ * Query-string opt-ins coming from a pattern resolved for this component.
10365
+ * Means nothing for PUTs; it will be ignored
10366
+ */
10367
+ _patternOptedInQueryStrings?: string[];
10233
10368
  _patternError?: components$a["schemas"]["PatternError"];
10234
10369
  /**
10235
10370
  * Defines patch overrides to component IDs that live in the composition.
@@ -10393,6 +10528,11 @@ interface components$a {
10393
10528
  _patternDataResources?: {
10394
10529
  [key: string]: components$a["schemas"]["DataResourceDefinition"];
10395
10530
  };
10531
+ /**
10532
+ * Query-string opt-ins coming from a pattern resolved for this component.
10533
+ * Means nothing for PUTs; it will be ignored
10534
+ */
10535
+ _patternOptedInQueryStrings?: string[];
10396
10536
  _dataResources?: components$a["schemas"]["DataResourceDefinitions"];
10397
10537
  _patternError?: components$a["schemas"]["PatternError"];
10398
10538
  /**
@@ -10427,6 +10567,12 @@ interface components$a {
10427
10567
  _overridability?: components$a["schemas"]["ComponentOverridability"];
10428
10568
  /** Array of locales which have data defined on the composition. If empty, the current default locale implicitly has data */
10429
10569
  _locales?: string[];
10570
+ /**
10571
+ * Names of opt-in global query strings surfaced in the Canvas editor for this composition or pattern.
10572
+ * Opt-ins coming from a resolved pattern move to _patternOptedInQueryStrings, so this always
10573
+ * holds only what was authored here. Omitted whenever overrides are resolved.
10574
+ */
10575
+ _optedInQueryStrings?: string[];
10430
10576
  };
10431
10577
  /** Permissions for a workflow stage */
10432
10578
  WorkflowStagePermission: {
@@ -15418,6 +15564,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
15418
15564
  _patternDataResources?: {
15419
15565
  [key: string]: components$q["schemas"]["DataResourceDefinition"];
15420
15566
  };
15567
+ _patternOptedInQueryStrings?: string[];
15421
15568
  _dataResources?: components$q["schemas"]["DataResourceDefinitions"];
15422
15569
  _patternError?: components$q["schemas"]["PatternError"];
15423
15570
  _overrides?: {
@@ -15428,6 +15575,7 @@ declare const createUniformApiEnhancer: ({ apiUrl }: {
15428
15575
  };
15429
15576
  _overridability?: components$q["schemas"]["ComponentOverridability"];
15430
15577
  _locales?: string[];
15578
+ _optedInQueryStrings?: string[];
15431
15579
  }>;
15432
15580
 
15433
15581
  /**
@@ -15661,7 +15809,7 @@ declare function hasReferencedVariables(value: string | undefined): number;
15661
15809
  */
15662
15810
  declare function parseVariableExpression(serialized: string, onToken?: (token: string, type: 'text' | 'variable', offset: number) => void | false): number;
15663
15811
 
15664
- declare const version = "20.78.0";
15812
+ declare const version = "20.79.1";
15665
15813
 
15666
15814
  /** API client to enable managing workflow definitions */
15667
15815
  declare class WorkflowClient extends ApiClient {
package/dist/index.esm.js CHANGED
@@ -1469,7 +1469,8 @@ function walkNodeTree(node, visitor, options) {
1469
1469
  "_dataResources",
1470
1470
  "_overridability",
1471
1471
  "_overrides",
1472
- "_patternDataResources"
1472
+ "_patternDataResources",
1473
+ "_patternOptedInQueryStrings"
1473
1474
  ];
1474
1475
  propertiesToCheck.forEach((property) => {
1475
1476
  if (!replacementComponent[property]) {
@@ -4001,7 +4002,7 @@ function handleRichTextNodeBinding(object, options) {
4001
4002
  import { ApiClientError as ApiClientError5 } from "@uniformdev/context/api";
4002
4003
 
4003
4004
  // src/.version.ts
4004
- var version = "20.78.0";
4005
+ var version = "20.79.1";
4005
4006
 
4006
4007
  // src/WorkflowClient.ts
4007
4008
  import { ApiClient as ApiClient18 } from "@uniformdev/context/api";
package/dist/index.js CHANGED
@@ -1684,7 +1684,8 @@ function walkNodeTree(node, visitor, options) {
1684
1684
  "_dataResources",
1685
1685
  "_overridability",
1686
1686
  "_overrides",
1687
- "_patternDataResources"
1687
+ "_patternDataResources",
1688
+ "_patternOptedInQueryStrings"
1688
1689
  ];
1689
1690
  propertiesToCheck.forEach((property) => {
1690
1691
  if (!replacementComponent[property]) {
@@ -4216,7 +4217,7 @@ function handleRichTextNodeBinding(object, options) {
4216
4217
  var import_api27 = require("@uniformdev/context/api");
4217
4218
 
4218
4219
  // src/.version.ts
4219
- var version = "20.78.0";
4220
+ var version = "20.79.1";
4220
4221
 
4221
4222
  // src/WorkflowClient.ts
4222
4223
  var import_api26 = require("@uniformdev/context/api");
package/dist/index.mjs CHANGED
@@ -1469,7 +1469,8 @@ function walkNodeTree(node, visitor, options) {
1469
1469
  "_dataResources",
1470
1470
  "_overridability",
1471
1471
  "_overrides",
1472
- "_patternDataResources"
1472
+ "_patternDataResources",
1473
+ "_patternOptedInQueryStrings"
1473
1474
  ];
1474
1475
  propertiesToCheck.forEach((property) => {
1475
1476
  if (!replacementComponent[property]) {
@@ -4001,7 +4002,7 @@ function handleRichTextNodeBinding(object, options) {
4001
4002
  import { ApiClientError as ApiClientError5 } from "@uniformdev/context/api";
4002
4003
 
4003
4004
  // src/.version.ts
4004
- var version = "20.78.0";
4005
+ var version = "20.79.1";
4005
4006
 
4006
4007
  // src/WorkflowClient.ts
4007
4008
  import { ApiClient as ApiClient18 } from "@uniformdev/context/api";
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@uniformdev/canvas",
3
- "version": "20.78.0",
3
+ "version": "20.79.1",
4
4
  "description": "Common functionality and types for Uniform Canvas",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "main": "./dist/index.js",
@@ -36,9 +36,9 @@
36
36
  "svix": "1.96.0"
37
37
  },
38
38
  "dependencies": {
39
- "@uniformdev/assets": "20.78.0",
40
- "@uniformdev/context": "20.78.0",
41
- "@uniformdev/richtext": "20.78.0",
39
+ "@uniformdev/assets": "20.79.1",
40
+ "@uniformdev/context": "20.79.1",
41
+ "@uniformdev/richtext": "20.79.1",
42
42
  "immer": "10.2.0",
43
43
  "p-limit": "6.2.0",
44
44
  "p-retry": "6.2.1",
@@ -50,5 +50,5 @@
50
50
  "publishConfig": {
51
51
  "access": "public"
52
52
  },
53
- "gitHead": "22d94ee916bde5e32c96995da69cfe479f87a9c9"
53
+ "gitHead": "a9709918bf00f79101fcc46bda36105626931933"
54
54
  }