@forge/manifest 3.2.0 → 3.3.0-next.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -3045,7 +3045,7 @@ export interface Modules {
3045
3045
  fullPage?: boolean;
3046
3046
  cacheable?: boolean;
3047
3047
  location?: string;
3048
- conditions?: (CompositeCondition | SingleCondition)[];
3048
+ conditions?: (SingleCondition | CompositeCondition)[];
3049
3049
  params?: {
3050
3050
  [k: string]: unknown;
3051
3051
  };
@@ -3060,7 +3060,7 @@ export interface Modules {
3060
3060
  fullPage?: boolean;
3061
3061
  cacheable?: boolean;
3062
3062
  location?: string;
3063
- conditions?: (CompositeCondition | SingleCondition)[];
3063
+ conditions?: (SingleCondition | CompositeCondition)[];
3064
3064
  params?: {
3065
3065
  [k: string]: unknown;
3066
3066
  };
@@ -3132,7 +3132,7 @@ export interface Modules {
3132
3132
  weight?: number;
3133
3133
  cacheable?: boolean;
3134
3134
  location?: string;
3135
- conditions?: (CompositeCondition | SingleCondition)[];
3135
+ conditions?: (SingleCondition | CompositeCondition)[];
3136
3136
  params?: {
3137
3137
  [k: string]: unknown;
3138
3138
  };
@@ -3146,7 +3146,7 @@ export interface Modules {
3146
3146
  weight?: number;
3147
3147
  cacheable?: boolean;
3148
3148
  location?: string;
3149
- conditions?: (CompositeCondition | SingleCondition)[];
3149
+ conditions?: (SingleCondition | CompositeCondition)[];
3150
3150
  params?: {
3151
3151
  [k: string]: unknown;
3152
3152
  };
@@ -3188,7 +3188,7 @@ export interface Modules {
3188
3188
  weight?: number;
3189
3189
  cacheable?: boolean;
3190
3190
  location?: string;
3191
- conditions?: (CompositeCondition | SingleCondition)[];
3191
+ conditions?: (SingleCondition | CompositeCondition)[];
3192
3192
  params?: {
3193
3193
  [k: string]: unknown;
3194
3194
  };
@@ -3202,7 +3202,7 @@ export interface Modules {
3202
3202
  weight?: number;
3203
3203
  cacheable?: boolean;
3204
3204
  location?: string;
3205
- conditions?: (CompositeCondition | SingleCondition)[];
3205
+ conditions?: (SingleCondition | CompositeCondition)[];
3206
3206
  params?: {
3207
3207
  [k: string]: unknown;
3208
3208
  };
@@ -3226,7 +3226,7 @@ export interface Modules {
3226
3226
  name?: I18NProperty59;
3227
3227
  location?: string;
3228
3228
  cacheable?: boolean;
3229
- conditions?: (SingleCondition4 | CompositeCondition6)[];
3229
+ conditions?: (CompositeCondition6 | SingleCondition4)[];
3230
3230
  key: ModuleKeySchema;
3231
3231
  [k: string]: unknown;
3232
3232
  },
@@ -3244,7 +3244,7 @@ export interface Modules {
3244
3244
  name?: I18NProperty59;
3245
3245
  location?: string;
3246
3246
  cacheable?: boolean;
3247
- conditions?: (SingleCondition4 | CompositeCondition6)[];
3247
+ conditions?: (CompositeCondition6 | SingleCondition4)[];
3248
3248
  key: ModuleKeySchema;
3249
3249
  [k: string]: unknown;
3250
3250
  }[]
@@ -3257,7 +3257,7 @@ export interface Modules {
3257
3257
  fullPage?: boolean;
3258
3258
  cacheable?: boolean;
3259
3259
  location?: string;
3260
- conditions?: (CompositeCondition | SingleCondition)[];
3260
+ conditions?: (SingleCondition | CompositeCondition)[];
3261
3261
  params?: {
3262
3262
  [k: string]: unknown;
3263
3263
  };
@@ -3272,7 +3272,7 @@ export interface Modules {
3272
3272
  fullPage?: boolean;
3273
3273
  cacheable?: boolean;
3274
3274
  location?: string;
3275
- conditions?: (CompositeCondition | SingleCondition)[];
3275
+ conditions?: (SingleCondition | CompositeCondition)[];
3276
3276
  params?: {
3277
3277
  [k: string]: unknown;
3278
3278
  };
@@ -3322,7 +3322,7 @@ export interface Modules {
3322
3322
  name?: I18NProperty63;
3323
3323
  weight?: number;
3324
3324
  location?: string;
3325
- conditions?: (CompositeCondition7 | SingleCondition5)[];
3325
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
3326
3326
  params?: {
3327
3327
  [k: string]: unknown;
3328
3328
  };
@@ -3334,7 +3334,7 @@ export interface Modules {
3334
3334
  name?: I18NProperty63;
3335
3335
  weight?: number;
3336
3336
  location?: string;
3337
- conditions?: (CompositeCondition7 | SingleCondition5)[];
3337
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
3338
3338
  params?: {
3339
3339
  [k: string]: unknown;
3340
3340
  };
@@ -3530,7 +3530,7 @@ export interface Modules {
3530
3530
  icon?: Icon18;
3531
3531
  name?: I18NProperty91;
3532
3532
  cacheable?: boolean;
3533
- conditions?: (CompositeCondition | SingleCondition)[];
3533
+ conditions?: (SingleCondition | CompositeCondition)[];
3534
3534
  params?: {
3535
3535
  [k: string]: unknown;
3536
3536
  };
@@ -3546,7 +3546,7 @@ export interface Modules {
3546
3546
  icon?: Icon18;
3547
3547
  name?: I18NProperty91;
3548
3548
  cacheable?: boolean;
3549
- conditions?: (CompositeCondition | SingleCondition)[];
3549
+ conditions?: (SingleCondition | CompositeCondition)[];
3550
3550
  params?: {
3551
3551
  [k: string]: unknown;
3552
3552
  };
@@ -3765,7 +3765,7 @@ export interface I18NProperty1 {
3765
3765
  *
3766
3766
  */
3767
3767
  export interface CompositeCondition {
3768
- conditions?: (SingleCondition | ManifestSchema)[];
3768
+ conditions?: (ManifestSchema | SingleCondition)[];
3769
3769
  type?: 'and' | 'AND' | 'or' | 'OR';
3770
3770
  [k: string]: unknown;
3771
3771
  }
@@ -6473,14 +6473,14 @@ export interface Icon10 {
6473
6473
  *
6474
6474
  */
6475
6475
  export interface WebItemTarget1 {
6476
- options?: InlineDialogOptions1 | DialogModuleOptions1 | DialogOptions2;
6476
+ options?: DialogModuleOptions1 | InlineDialogOptions1 | DialogOptions2;
6477
6477
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
6478
6478
  [k: string]: unknown;
6479
6479
  }
6480
6480
  /**
6481
6481
  *
6482
6482
  *
6483
- * Options for an inline dialog target
6483
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
6484
6484
  *
6485
6485
  * <h3>Example</h3>
6486
6486
  *
@@ -6490,11 +6490,9 @@ export interface WebItemTarget1 {
6490
6490
  *
6491
6491
  * {
6492
6492
  * "target": {
6493
- * "type": "inlinedialog",
6493
+ * "type": "dialogmodule",
6494
6494
  * "options": {
6495
- * "onHover": true,
6496
- * "offsetX": "30px",
6497
- * "offsetY": "20px"
6495
+ * "key": "dialog-module-key"
6498
6496
  * }
6499
6497
  * }
6500
6498
  * }
@@ -6502,22 +6500,14 @@ export interface WebItemTarget1 {
6502
6500
  *
6503
6501
  *
6504
6502
  */
6505
- export interface InlineDialogOptions1 {
6506
- offsetX?: string;
6507
- offsetY?: string;
6508
- width?: string;
6509
- onTop?: boolean;
6510
- showDelay?: number;
6511
- closeOthers?: boolean;
6512
- persistent?: boolean;
6513
- onHover?: boolean;
6514
- isRelativeToMouse?: boolean;
6503
+ export interface DialogModuleOptions1 {
6504
+ key: string;
6515
6505
  [k: string]: unknown;
6516
6506
  }
6517
6507
  /**
6518
6508
  *
6519
6509
  *
6520
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
6510
+ * Options for an inline dialog target
6521
6511
  *
6522
6512
  * <h3>Example</h3>
6523
6513
  *
@@ -6527,9 +6517,11 @@ export interface InlineDialogOptions1 {
6527
6517
  *
6528
6518
  * {
6529
6519
  * "target": {
6530
- * "type": "dialogmodule",
6520
+ * "type": "inlinedialog",
6531
6521
  * "options": {
6532
- * "key": "dialog-module-key"
6522
+ * "onHover": true,
6523
+ * "offsetX": "30px",
6524
+ * "offsetY": "20px"
6533
6525
  * }
6534
6526
  * }
6535
6527
  * }
@@ -6537,8 +6529,16 @@ export interface InlineDialogOptions1 {
6537
6529
  *
6538
6530
  *
6539
6531
  */
6540
- export interface DialogModuleOptions1 {
6541
- key: string;
6532
+ export interface InlineDialogOptions1 {
6533
+ offsetX?: string;
6534
+ offsetY?: string;
6535
+ width?: string;
6536
+ onTop?: boolean;
6537
+ showDelay?: number;
6538
+ closeOthers?: boolean;
6539
+ persistent?: boolean;
6540
+ onHover?: boolean;
6541
+ isRelativeToMouse?: boolean;
6542
6542
  [k: string]: unknown;
6543
6543
  }
6544
6544
  /**
@@ -6663,37 +6663,6 @@ export interface I18NProperty59 {
6663
6663
  i18n?: string;
6664
6664
  [k: string]: unknown;
6665
6665
  }
6666
- /**
6667
- *
6668
- *
6669
- * Single Conditions are either provided by the host application. See the complete documentation of
6670
- * [Conditions](../../conditions/) for more information.
6671
- *
6672
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6673
- * This is useful where you want to show the section if a certain condition is not satisfied.
6674
- *
6675
- * <h3>Example</h3>
6676
- *
6677
- *
6678
- *
6679
- *
6680
- *
6681
- * {
6682
- * "condition": "user_is_logged_in",
6683
- * "invert": false
6684
- * }
6685
- *
6686
- *
6687
- *
6688
- */
6689
- export interface SingleCondition4 {
6690
- condition: string;
6691
- invert?: boolean;
6692
- params?: {
6693
- [k: string]: unknown;
6694
- };
6695
- [k: string]: unknown;
6696
- }
6697
6666
  /**
6698
6667
  *
6699
6668
  *
@@ -6731,10 +6700,41 @@ export interface SingleCondition4 {
6731
6700
  *
6732
6701
  */
6733
6702
  export interface CompositeCondition6 {
6734
- conditions?: (ManifestSchema | SingleCondition)[];
6703
+ conditions?: (SingleCondition | ManifestSchema)[];
6735
6704
  type?: 'and' | 'AND' | 'or' | 'OR';
6736
6705
  [k: string]: unknown;
6737
6706
  }
6707
+ /**
6708
+ *
6709
+ *
6710
+ * Single Conditions are either provided by the host application. See the complete documentation of
6711
+ * [Conditions](../../conditions/) for more information.
6712
+ *
6713
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6714
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6715
+ *
6716
+ * <h3>Example</h3>
6717
+ *
6718
+ *
6719
+ *
6720
+ *
6721
+ *
6722
+ * {
6723
+ * "condition": "user_is_logged_in",
6724
+ * "invert": false
6725
+ * }
6726
+ *
6727
+ *
6728
+ *
6729
+ */
6730
+ export interface SingleCondition4 {
6731
+ condition: string;
6732
+ invert?: boolean;
6733
+ params?: {
6734
+ [k: string]: unknown;
6735
+ };
6736
+ [k: string]: unknown;
6737
+ }
6738
6738
  /**
6739
6739
  *
6740
6740
  *
@@ -7089,6 +7089,37 @@ export interface I18NProperty63 {
7089
7089
  i18n?: string;
7090
7090
  [k: string]: unknown;
7091
7091
  }
7092
+ /**
7093
+ *
7094
+ *
7095
+ * Single Conditions are either provided by the host application. See the complete documentation of
7096
+ * [Conditions](../../conditions/) for more information.
7097
+ *
7098
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
7099
+ * This is useful where you want to show the section if a certain condition is not satisfied.
7100
+ *
7101
+ * <h3>Example</h3>
7102
+ *
7103
+ *
7104
+ *
7105
+ *
7106
+ *
7107
+ * {
7108
+ * "condition": "user_is_logged_in",
7109
+ * "invert": false
7110
+ * }
7111
+ *
7112
+ *
7113
+ *
7114
+ */
7115
+ export interface SingleCondition5 {
7116
+ condition: string;
7117
+ invert?: boolean;
7118
+ params?: {
7119
+ [k: string]: unknown;
7120
+ };
7121
+ [k: string]: unknown;
7122
+ }
7092
7123
  /**
7093
7124
  *
7094
7125
  *
@@ -7126,41 +7157,10 @@ export interface I18NProperty63 {
7126
7157
  *
7127
7158
  */
7128
7159
  export interface CompositeCondition7 {
7129
- conditions?: (SingleCondition | ManifestSchema)[];
7160
+ conditions?: (ManifestSchema | SingleCondition)[];
7130
7161
  type?: 'and' | 'AND' | 'or' | 'OR';
7131
7162
  [k: string]: unknown;
7132
7163
  }
7133
- /**
7134
- *
7135
- *
7136
- * Single Conditions are either provided by the host application. See the complete documentation of
7137
- * [Conditions](../../conditions/) for more information.
7138
- *
7139
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
7140
- * This is useful where you want to show the section if a certain condition is not satisfied.
7141
- *
7142
- * <h3>Example</h3>
7143
- *
7144
- *
7145
- *
7146
- *
7147
- *
7148
- * {
7149
- * "condition": "user_is_logged_in",
7150
- * "invert": false
7151
- * }
7152
- *
7153
- *
7154
- *
7155
- */
7156
- export interface SingleCondition5 {
7157
- condition: string;
7158
- invert?: boolean;
7159
- params?: {
7160
- [k: string]: unknown;
7161
- };
7162
- [k: string]: unknown;
7163
- }
7164
7164
  /**
7165
7165
  *
7166
7166
  *
@@ -8580,7 +8580,7 @@ export interface I18NProperty74 {
8580
8580
  *
8581
8581
  */
8582
8582
  export interface MacroPropertyPanel {
8583
- controls?: (TextControl | ToggleGroup | ButtonControl | ControlGroup)[];
8583
+ controls?: (ControlGroup | TextControl | ToggleGroup | ButtonControl1)[];
8584
8584
  cacheable?: boolean;
8585
8585
  url: string;
8586
8586
  [k: string]: unknown;
@@ -8588,35 +8588,7 @@ export interface MacroPropertyPanel {
8588
8588
  /**
8589
8589
  *
8590
8590
  *
8591
- * Defines a text field which may appear in control extension points such as the property panel
8592
- *
8593
- * <p><b>Example</b></p>
8594
- *
8595
- *
8596
- *
8597
- *
8598
- *
8599
- * {
8600
- * "type": "button",
8601
- * "label": {
8602
- * "value": "My Custom Control 0"
8603
- * },
8604
- * "key": "my-custom-control-0"
8605
- * }
8606
- *
8607
- *
8608
- *
8609
- */
8610
- export interface TextControl {
8611
- macroParameter: string;
8612
- type: 'text' | 'TEXT';
8613
- key: string;
8614
- [k: string]: unknown;
8615
- }
8616
- /**
8617
- *
8618
- *
8619
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
8591
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
8620
8592
  *
8621
8593
  * <p><b>Example</b></p>
8622
8594
  *
@@ -8626,24 +8598,21 @@ export interface TextControl {
8626
8598
  *
8627
8599
  * [
8628
8600
  * {
8629
- * "type": "togglegroup",
8630
- * "macroParameter": "toggleGroupMacroParameter",
8601
+ * "type": "group",
8631
8602
  * "controls": [
8632
8603
  * {
8633
- * "type": "togglebutton",
8634
- * "macroParameterValue": "macroParameterValue 0",
8604
+ * "type": "button",
8635
8605
  * "label": {
8636
8606
  * "value": "My Custom Control 0"
8637
8607
  * },
8638
- * "key": "my-custom-toggle-button-0"
8608
+ * "key": "my-custom-control-0"
8639
8609
  * },
8640
8610
  * {
8641
- * "type": "togglebutton",
8642
- * "macroParameterValue": "macroParameterValue 1",
8611
+ * "type": "button",
8643
8612
  * "label": {
8644
8613
  * "value": "My Custom Control 1"
8645
8614
  * },
8646
- * "key": "my-custom-toggle-button-1"
8615
+ * "key": "my-custom-control-1"
8647
8616
  * }
8648
8617
  * ]
8649
8618
  * }
@@ -8652,16 +8621,15 @@ export interface TextControl {
8652
8621
  *
8653
8622
  *
8654
8623
  */
8655
- export interface ToggleGroup {
8656
- controls: ToggleButtonControl[];
8657
- macroParameter: string;
8658
- type: 'togglegroup' | 'TOGGLEGROUP';
8624
+ export interface ControlGroup {
8625
+ controls: ButtonControl[];
8626
+ type: 'group' | 'GROUP';
8659
8627
  [k: string]: unknown;
8660
8628
  }
8661
8629
  /**
8662
8630
  *
8663
8631
  *
8664
- * Defines a toggle button which appears inside a ToggleGroup
8632
+ * Defines a button which may appear in control extension points such as the property panel
8665
8633
  *
8666
8634
  * <p><b>Example</b></p>
8667
8635
  *
@@ -8670,21 +8638,19 @@ export interface ToggleGroup {
8670
8638
  *
8671
8639
  *
8672
8640
  * {
8673
- * "type": "togglebutton",
8674
- * "macroParameterValue": "macroParameterValue 0",
8641
+ * "type": "button",
8675
8642
  * "label": {
8676
8643
  * "value": "My Custom Control 0"
8677
8644
  * },
8678
- * "key": "my-custom-toggle-button-0"
8645
+ * "key": "my-custom-control-0"
8679
8646
  * }
8680
8647
  *
8681
8648
  *
8682
8649
  *
8683
8650
  */
8684
- export interface ToggleButtonControl {
8685
- macroParameterValue: string;
8651
+ export interface ButtonControl {
8686
8652
  label: I18NProperty75;
8687
- type: 'togglebutton' | 'TOGGLEBUTTON';
8653
+ type: 'button' | 'BUTTON';
8688
8654
  key: string;
8689
8655
  [k: string]: unknown;
8690
8656
  }
@@ -8715,7 +8681,7 @@ export interface I18NProperty75 {
8715
8681
  /**
8716
8682
  *
8717
8683
  *
8718
- * Defines a button which may appear in control extension points such as the property panel
8684
+ * Defines a text field which may appear in control extension points such as the property panel
8719
8685
  *
8720
8686
  * <p><b>Example</b></p>
8721
8687
  *
@@ -8734,40 +8700,16 @@ export interface I18NProperty75 {
8734
8700
  *
8735
8701
  *
8736
8702
  */
8737
- export interface ButtonControl {
8738
- label: I18NProperty76;
8739
- type: 'button' | 'BUTTON';
8703
+ export interface TextControl {
8704
+ macroParameter: string;
8705
+ type: 'text' | 'TEXT';
8740
8706
  key: string;
8741
8707
  [k: string]: unknown;
8742
8708
  }
8743
8709
  /**
8744
8710
  *
8745
8711
  *
8746
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
8747
- * and value in multiple places if you like, but identical keys must have identical values.
8748
- *
8749
- * <h3>Example</h3>
8750
- *
8751
- *
8752
- *
8753
- *
8754
- *
8755
- * {
8756
- * "value": "My text"
8757
- * }
8758
- *
8759
- *
8760
- *
8761
- */
8762
- export interface I18NProperty76 {
8763
- value: string;
8764
- i18n?: string;
8765
- [k: string]: unknown;
8766
- }
8767
- /**
8768
- *
8769
- *
8770
- * Defines a ControlGroup which may appear in control extension points such as the property panel
8712
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
8771
8713
  *
8772
8714
  * <p><b>Example</b></p>
8773
8715
  *
@@ -8777,21 +8719,24 @@ export interface I18NProperty76 {
8777
8719
  *
8778
8720
  * [
8779
8721
  * {
8780
- * "type": "group",
8722
+ * "type": "togglegroup",
8723
+ * "macroParameter": "toggleGroupMacroParameter",
8781
8724
  * "controls": [
8782
8725
  * {
8783
- * "type": "button",
8726
+ * "type": "togglebutton",
8727
+ * "macroParameterValue": "macroParameterValue 0",
8784
8728
  * "label": {
8785
8729
  * "value": "My Custom Control 0"
8786
8730
  * },
8787
- * "key": "my-custom-control-0"
8731
+ * "key": "my-custom-toggle-button-0"
8788
8732
  * },
8789
8733
  * {
8790
- * "type": "button",
8734
+ * "type": "togglebutton",
8735
+ * "macroParameterValue": "macroParameterValue 1",
8791
8736
  * "label": {
8792
8737
  * "value": "My Custom Control 1"
8793
8738
  * },
8794
- * "key": "my-custom-control-1"
8739
+ * "key": "my-custom-toggle-button-1"
8795
8740
  * }
8796
8741
  * ]
8797
8742
  * }
@@ -8800,9 +8745,64 @@ export interface I18NProperty76 {
8800
8745
  *
8801
8746
  *
8802
8747
  */
8803
- export interface ControlGroup {
8804
- controls: ButtonControl1[];
8805
- type: 'group' | 'GROUP';
8748
+ export interface ToggleGroup {
8749
+ controls: ToggleButtonControl[];
8750
+ macroParameter: string;
8751
+ type: 'togglegroup' | 'TOGGLEGROUP';
8752
+ [k: string]: unknown;
8753
+ }
8754
+ /**
8755
+ *
8756
+ *
8757
+ * Defines a toggle button which appears inside a ToggleGroup
8758
+ *
8759
+ * <p><b>Example</b></p>
8760
+ *
8761
+ *
8762
+ *
8763
+ *
8764
+ *
8765
+ * {
8766
+ * "type": "togglebutton",
8767
+ * "macroParameterValue": "macroParameterValue 0",
8768
+ * "label": {
8769
+ * "value": "My Custom Control 0"
8770
+ * },
8771
+ * "key": "my-custom-toggle-button-0"
8772
+ * }
8773
+ *
8774
+ *
8775
+ *
8776
+ */
8777
+ export interface ToggleButtonControl {
8778
+ macroParameterValue: string;
8779
+ label: I18NProperty76;
8780
+ type: 'togglebutton' | 'TOGGLEBUTTON';
8781
+ key: string;
8782
+ [k: string]: unknown;
8783
+ }
8784
+ /**
8785
+ *
8786
+ *
8787
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
8788
+ * and value in multiple places if you like, but identical keys must have identical values.
8789
+ *
8790
+ * <h3>Example</h3>
8791
+ *
8792
+ *
8793
+ *
8794
+ *
8795
+ *
8796
+ * {
8797
+ * "value": "My text"
8798
+ * }
8799
+ *
8800
+ *
8801
+ *
8802
+ */
8803
+ export interface I18NProperty76 {
8804
+ value: string;
8805
+ i18n?: string;
8806
8806
  [k: string]: unknown;
8807
8807
  }
8808
8808
  /**
@@ -29779,7 +29779,180 @@ export interface Icon17 {
29779
29779
  *
29780
29780
  *
29781
29781
  */
29782
- export interface I18NProperty83 {
29782
+ export interface I18NProperty83 {
29783
+ value: string;
29784
+ i18n?: string;
29785
+ [k: string]: unknown;
29786
+ }
29787
+ /**
29788
+ *
29789
+ *
29790
+ * Defining a Macro Property panel allows you to add a hidden iframe to your macro's
29791
+ * property panel. The iframe is loaded as soon as the property panel is opened.
29792
+ *
29793
+ * In order to persist custom data using your property panel, use the Javascript
29794
+ * <a href="../../jsapi/confluence/">Confluence API</a>.
29795
+ * For example:
29796
+ *
29797
+ * AP.require(["confluence"], function (confluence) {
29798
+ * var macroParams = {
29799
+ * myParameter: value
29800
+ * };
29801
+ * confluence.saveMacro(macroParams);
29802
+ * });
29803
+ *
29804
+ * In order to retrieve the custom data again when the property panel is opened, use `confluence.getMacroData` (see
29805
+ * <a href="../../jsapi/confluence/">Confluence API</a>):
29806
+ *
29807
+ * AP.require("confluence", function (confluence) {
29808
+ * var macroData = confluence.getMacroData(function(macroParams) {
29809
+ * doSomethingWith(macroParams.myParameter);
29810
+ * });
29811
+ * });
29812
+ *
29813
+ * Dialogs may also be created. Use `dialog.create` (see
29814
+ * <a href="../../jsapi/dialog/">Dialog API</a>):
29815
+ *
29816
+ * AP.require('dialog', function(dialog) {
29817
+ * dialog.create({
29818
+ * key: 'my-module-key',
29819
+ * width: '500px',
29820
+ * height: '200px',
29821
+ * chrome: true
29822
+ * }).on("close", callbackFunc);
29823
+ * });
29824
+ *
29825
+ *
29826
+ */
29827
+ export interface MacroPropertyPanel1 {
29828
+ controls?: (TextControl1 | ToggleGroup1 | ControlGroup1 | ButtonControl3)[];
29829
+ cacheable?: boolean;
29830
+ url: string;
29831
+ [k: string]: unknown;
29832
+ }
29833
+ /**
29834
+ *
29835
+ *
29836
+ * Defines a text field which may appear in control extension points such as the property panel
29837
+ *
29838
+ * <p><b>Example</b></p>
29839
+ *
29840
+ *
29841
+ *
29842
+ *
29843
+ *
29844
+ * {
29845
+ * "type": "button",
29846
+ * "label": {
29847
+ * "value": "My Custom Control 0"
29848
+ * },
29849
+ * "key": "my-custom-control-0"
29850
+ * }
29851
+ *
29852
+ *
29853
+ *
29854
+ */
29855
+ export interface TextControl1 {
29856
+ macroParameter: string;
29857
+ type: 'text' | 'TEXT';
29858
+ key: string;
29859
+ [k: string]: unknown;
29860
+ }
29861
+ /**
29862
+ *
29863
+ *
29864
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
29865
+ *
29866
+ * <p><b>Example</b></p>
29867
+ *
29868
+ *
29869
+ *
29870
+ *
29871
+ *
29872
+ * [
29873
+ * {
29874
+ * "type": "togglegroup",
29875
+ * "macroParameter": "toggleGroupMacroParameter",
29876
+ * "controls": [
29877
+ * {
29878
+ * "type": "togglebutton",
29879
+ * "macroParameterValue": "macroParameterValue 0",
29880
+ * "label": {
29881
+ * "value": "My Custom Control 0"
29882
+ * },
29883
+ * "key": "my-custom-toggle-button-0"
29884
+ * },
29885
+ * {
29886
+ * "type": "togglebutton",
29887
+ * "macroParameterValue": "macroParameterValue 1",
29888
+ * "label": {
29889
+ * "value": "My Custom Control 1"
29890
+ * },
29891
+ * "key": "my-custom-toggle-button-1"
29892
+ * }
29893
+ * ]
29894
+ * }
29895
+ * ]
29896
+ *
29897
+ *
29898
+ *
29899
+ */
29900
+ export interface ToggleGroup1 {
29901
+ controls: ToggleButtonControl1[];
29902
+ macroParameter: string;
29903
+ type: 'togglegroup' | 'TOGGLEGROUP';
29904
+ [k: string]: unknown;
29905
+ }
29906
+ /**
29907
+ *
29908
+ *
29909
+ * Defines a toggle button which appears inside a ToggleGroup
29910
+ *
29911
+ * <p><b>Example</b></p>
29912
+ *
29913
+ *
29914
+ *
29915
+ *
29916
+ *
29917
+ * {
29918
+ * "type": "togglebutton",
29919
+ * "macroParameterValue": "macroParameterValue 0",
29920
+ * "label": {
29921
+ * "value": "My Custom Control 0"
29922
+ * },
29923
+ * "key": "my-custom-toggle-button-0"
29924
+ * }
29925
+ *
29926
+ *
29927
+ *
29928
+ */
29929
+ export interface ToggleButtonControl1 {
29930
+ macroParameterValue: string;
29931
+ label: I18NProperty84;
29932
+ type: 'togglebutton' | 'TOGGLEBUTTON';
29933
+ key: string;
29934
+ [k: string]: unknown;
29935
+ }
29936
+ /**
29937
+ *
29938
+ *
29939
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
29940
+ * and value in multiple places if you like, but identical keys must have identical values.
29941
+ *
29942
+ * <h3>Example</h3>
29943
+ *
29944
+ *
29945
+ *
29946
+ *
29947
+ *
29948
+ * {
29949
+ * "value": "My text"
29950
+ * }
29951
+ *
29952
+ *
29953
+ *
29954
+ */
29955
+ export interface I18NProperty84 {
29783
29956
  value: string;
29784
29957
  i18n?: string;
29785
29958
  [k: string]: unknown;
@@ -29787,53 +29960,7 @@ export interface I18NProperty83 {
29787
29960
  /**
29788
29961
  *
29789
29962
  *
29790
- * Defining a Macro Property panel allows you to add a hidden iframe to your macro's
29791
- * property panel. The iframe is loaded as soon as the property panel is opened.
29792
- *
29793
- * In order to persist custom data using your property panel, use the Javascript
29794
- * <a href="../../jsapi/confluence/">Confluence API</a>.
29795
- * For example:
29796
- *
29797
- * AP.require(["confluence"], function (confluence) {
29798
- * var macroParams = {
29799
- * myParameter: value
29800
- * };
29801
- * confluence.saveMacro(macroParams);
29802
- * });
29803
- *
29804
- * In order to retrieve the custom data again when the property panel is opened, use `confluence.getMacroData` (see
29805
- * <a href="../../jsapi/confluence/">Confluence API</a>):
29806
- *
29807
- * AP.require("confluence", function (confluence) {
29808
- * var macroData = confluence.getMacroData(function(macroParams) {
29809
- * doSomethingWith(macroParams.myParameter);
29810
- * });
29811
- * });
29812
- *
29813
- * Dialogs may also be created. Use `dialog.create` (see
29814
- * <a href="../../jsapi/dialog/">Dialog API</a>):
29815
- *
29816
- * AP.require('dialog', function(dialog) {
29817
- * dialog.create({
29818
- * key: 'my-module-key',
29819
- * width: '500px',
29820
- * height: '200px',
29821
- * chrome: true
29822
- * }).on("close", callbackFunc);
29823
- * });
29824
- *
29825
- *
29826
- */
29827
- export interface MacroPropertyPanel1 {
29828
- controls?: (ToggleGroup1 | TextControl1 | ButtonControl2 | ControlGroup1)[];
29829
- cacheable?: boolean;
29830
- url: string;
29831
- [k: string]: unknown;
29832
- }
29833
- /**
29834
- *
29835
- *
29836
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
29963
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
29837
29964
  *
29838
29965
  * <p><b>Example</b></p>
29839
29966
  *
@@ -29843,24 +29970,21 @@ export interface MacroPropertyPanel1 {
29843
29970
  *
29844
29971
  * [
29845
29972
  * {
29846
- * "type": "togglegroup",
29847
- * "macroParameter": "toggleGroupMacroParameter",
29973
+ * "type": "group",
29848
29974
  * "controls": [
29849
29975
  * {
29850
- * "type": "togglebutton",
29851
- * "macroParameterValue": "macroParameterValue 0",
29976
+ * "type": "button",
29852
29977
  * "label": {
29853
29978
  * "value": "My Custom Control 0"
29854
29979
  * },
29855
- * "key": "my-custom-toggle-button-0"
29980
+ * "key": "my-custom-control-0"
29856
29981
  * },
29857
29982
  * {
29858
- * "type": "togglebutton",
29859
- * "macroParameterValue": "macroParameterValue 1",
29983
+ * "type": "button",
29860
29984
  * "label": {
29861
29985
  * "value": "My Custom Control 1"
29862
29986
  * },
29863
- * "key": "my-custom-toggle-button-1"
29987
+ * "key": "my-custom-control-1"
29864
29988
  * }
29865
29989
  * ]
29866
29990
  * }
@@ -29869,92 +29993,9 @@ export interface MacroPropertyPanel1 {
29869
29993
  *
29870
29994
  *
29871
29995
  */
29872
- export interface ToggleGroup1 {
29873
- controls: ToggleButtonControl1[];
29874
- macroParameter: string;
29875
- type: 'togglegroup' | 'TOGGLEGROUP';
29876
- [k: string]: unknown;
29877
- }
29878
- /**
29879
- *
29880
- *
29881
- * Defines a toggle button which appears inside a ToggleGroup
29882
- *
29883
- * <p><b>Example</b></p>
29884
- *
29885
- *
29886
- *
29887
- *
29888
- *
29889
- * {
29890
- * "type": "togglebutton",
29891
- * "macroParameterValue": "macroParameterValue 0",
29892
- * "label": {
29893
- * "value": "My Custom Control 0"
29894
- * },
29895
- * "key": "my-custom-toggle-button-0"
29896
- * }
29897
- *
29898
- *
29899
- *
29900
- */
29901
- export interface ToggleButtonControl1 {
29902
- macroParameterValue: string;
29903
- label: I18NProperty84;
29904
- type: 'togglebutton' | 'TOGGLEBUTTON';
29905
- key: string;
29906
- [k: string]: unknown;
29907
- }
29908
- /**
29909
- *
29910
- *
29911
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
29912
- * and value in multiple places if you like, but identical keys must have identical values.
29913
- *
29914
- * <h3>Example</h3>
29915
- *
29916
- *
29917
- *
29918
- *
29919
- *
29920
- * {
29921
- * "value": "My text"
29922
- * }
29923
- *
29924
- *
29925
- *
29926
- */
29927
- export interface I18NProperty84 {
29928
- value: string;
29929
- i18n?: string;
29930
- [k: string]: unknown;
29931
- }
29932
- /**
29933
- *
29934
- *
29935
- * Defines a text field which may appear in control extension points such as the property panel
29936
- *
29937
- * <p><b>Example</b></p>
29938
- *
29939
- *
29940
- *
29941
- *
29942
- *
29943
- * {
29944
- * "type": "button",
29945
- * "label": {
29946
- * "value": "My Custom Control 0"
29947
- * },
29948
- * "key": "my-custom-control-0"
29949
- * }
29950
- *
29951
- *
29952
- *
29953
- */
29954
- export interface TextControl1 {
29955
- macroParameter: string;
29956
- type: 'text' | 'TEXT';
29957
- key: string;
29996
+ export interface ControlGroup1 {
29997
+ controls: ButtonControl2[];
29998
+ type: 'group' | 'GROUP';
29958
29999
  [k: string]: unknown;
29959
30000
  }
29960
30001
  /**
@@ -30009,47 +30050,6 @@ export interface I18NProperty85 {
30009
30050
  i18n?: string;
30010
30051
  [k: string]: unknown;
30011
30052
  }
30012
- /**
30013
- *
30014
- *
30015
- * Defines a ControlGroup which may appear in control extension points such as the property panel
30016
- *
30017
- * <p><b>Example</b></p>
30018
- *
30019
- *
30020
- *
30021
- *
30022
- *
30023
- * [
30024
- * {
30025
- * "type": "group",
30026
- * "controls": [
30027
- * {
30028
- * "type": "button",
30029
- * "label": {
30030
- * "value": "My Custom Control 0"
30031
- * },
30032
- * "key": "my-custom-control-0"
30033
- * },
30034
- * {
30035
- * "type": "button",
30036
- * "label": {
30037
- * "value": "My Custom Control 1"
30038
- * },
30039
- * "key": "my-custom-control-1"
30040
- * }
30041
- * ]
30042
- * }
30043
- * ]
30044
- *
30045
- *
30046
- *
30047
- */
30048
- export interface ControlGroup1 {
30049
- controls: ButtonControl3[];
30050
- type: 'group' | 'GROUP';
30051
- [k: string]: unknown;
30052
- }
30053
30053
  /**
30054
30054
  *
30055
30055
  *
@@ -50951,10 +50951,47 @@ export interface I18NProperty91 {
50951
50951
  *
50952
50952
  */
50953
50953
  export interface WebItemTarget2 {
50954
- options?: DialogOptions4 | DialogModuleOptions2 | InlineDialogOptions2;
50954
+ options?: InlineDialogOptions2 | DialogOptions4 | DialogModuleOptions2;
50955
50955
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
50956
50956
  [k: string]: unknown;
50957
50957
  }
50958
+ /**
50959
+ *
50960
+ *
50961
+ * Options for an inline dialog target
50962
+ *
50963
+ * <h3>Example</h3>
50964
+ *
50965
+ *
50966
+ *
50967
+ *
50968
+ *
50969
+ * {
50970
+ * "target": {
50971
+ * "type": "inlinedialog",
50972
+ * "options": {
50973
+ * "onHover": true,
50974
+ * "offsetX": "30px",
50975
+ * "offsetY": "20px"
50976
+ * }
50977
+ * }
50978
+ * }
50979
+ *
50980
+ *
50981
+ *
50982
+ */
50983
+ export interface InlineDialogOptions2 {
50984
+ offsetX?: string;
50985
+ offsetY?: string;
50986
+ width?: string;
50987
+ onTop?: boolean;
50988
+ showDelay?: number;
50989
+ closeOthers?: boolean;
50990
+ persistent?: boolean;
50991
+ onHover?: boolean;
50992
+ isRelativeToMouse?: boolean;
50993
+ [k: string]: unknown;
50994
+ }
50958
50995
  /**
50959
50996
  *
50960
50997
  *
@@ -51080,43 +51117,6 @@ export interface DialogModuleOptions2 {
51080
51117
  key: string;
51081
51118
  [k: string]: unknown;
51082
51119
  }
51083
- /**
51084
- *
51085
- *
51086
- * Options for an inline dialog target
51087
- *
51088
- * <h3>Example</h3>
51089
- *
51090
- *
51091
- *
51092
- *
51093
- *
51094
- * {
51095
- * "target": {
51096
- * "type": "inlinedialog",
51097
- * "options": {
51098
- * "onHover": true,
51099
- * "offsetX": "30px",
51100
- * "offsetY": "20px"
51101
- * }
51102
- * }
51103
- * }
51104
- *
51105
- *
51106
- *
51107
- */
51108
- export interface InlineDialogOptions2 {
51109
- offsetX?: string;
51110
- offsetY?: string;
51111
- width?: string;
51112
- onTop?: boolean;
51113
- showDelay?: number;
51114
- closeOthers?: boolean;
51115
- persistent?: boolean;
51116
- onHover?: boolean;
51117
- isRelativeToMouse?: boolean;
51118
- [k: string]: unknown;
51119
- }
51120
51120
  /**
51121
51121
  *
51122
51122
  *