@forge/manifest 2.5.0-next.4 → 2.5.0-next.5

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.
@@ -2536,7 +2536,7 @@ export interface Modules {
2536
2536
  filter?: string;
2537
2537
  excludeBody?: boolean;
2538
2538
  event?: string;
2539
- conditions?: (CompositeCondition | SingleCondition)[];
2539
+ conditions?: (SingleCondition | CompositeCondition)[];
2540
2540
  propertyKeys?: string[];
2541
2541
  url?: string;
2542
2542
  key: ModuleKeySchema;
@@ -2546,7 +2546,7 @@ export interface Modules {
2546
2546
  filter?: string;
2547
2547
  excludeBody?: boolean;
2548
2548
  event?: string;
2549
- conditions?: (CompositeCondition | SingleCondition)[];
2549
+ conditions?: (SingleCondition | CompositeCondition)[];
2550
2550
  propertyKeys?: string[];
2551
2551
  url?: string;
2552
2552
  key: ModuleKeySchema;
@@ -2589,7 +2589,7 @@ export interface Modules {
2589
2589
  name?: I18NProperty55;
2590
2590
  weight?: number;
2591
2591
  location?: string;
2592
- conditions?: (CompositeCondition | SingleCondition)[];
2592
+ conditions?: (SingleCondition | CompositeCondition)[];
2593
2593
  params?: {
2594
2594
  [k: string]: unknown;
2595
2595
  };
@@ -2601,7 +2601,7 @@ export interface Modules {
2601
2601
  name?: I18NProperty55;
2602
2602
  weight?: number;
2603
2603
  location?: string;
2604
- conditions?: (CompositeCondition | SingleCondition)[];
2604
+ conditions?: (SingleCondition | CompositeCondition)[];
2605
2605
  params?: {
2606
2606
  [k: string]: unknown;
2607
2607
  };
@@ -2750,7 +2750,7 @@ export interface Modules {
2750
2750
  name?: I18NProperty63;
2751
2751
  weight?: number;
2752
2752
  location?: string;
2753
- conditions?: (CompositeCondition7 | SingleCondition5)[];
2753
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
2754
2754
  params?: {
2755
2755
  [k: string]: unknown;
2756
2756
  };
@@ -2762,7 +2762,7 @@ export interface Modules {
2762
2762
  name?: I18NProperty63;
2763
2763
  weight?: number;
2764
2764
  location?: string;
2765
- conditions?: (CompositeCondition7 | SingleCondition5)[];
2765
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
2766
2766
  params?: {
2767
2767
  [k: string]: unknown;
2768
2768
  };
@@ -5899,10 +5899,47 @@ export interface Icon10 {
5899
5899
  *
5900
5900
  */
5901
5901
  export interface WebItemTarget1 {
5902
- options?: DialogModuleOptions1 | DialogOptions2 | InlineDialogOptions1;
5902
+ options?: InlineDialogOptions1 | DialogModuleOptions1 | DialogOptions2;
5903
5903
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
5904
5904
  [k: string]: unknown;
5905
5905
  }
5906
+ /**
5907
+ *
5908
+ *
5909
+ * Options for an inline dialog target
5910
+ *
5911
+ * <h3>Example</h3>
5912
+ *
5913
+ *
5914
+ *
5915
+ *
5916
+ *
5917
+ * {
5918
+ * "target": {
5919
+ * "type": "inlinedialog",
5920
+ * "options": {
5921
+ * "onHover": true,
5922
+ * "offsetX": "30px",
5923
+ * "offsetY": "20px"
5924
+ * }
5925
+ * }
5926
+ * }
5927
+ *
5928
+ *
5929
+ *
5930
+ */
5931
+ export interface InlineDialogOptions1 {
5932
+ offsetX?: string;
5933
+ offsetY?: string;
5934
+ width?: string;
5935
+ onTop?: boolean;
5936
+ showDelay?: number;
5937
+ closeOthers?: boolean;
5938
+ persistent?: boolean;
5939
+ onHover?: boolean;
5940
+ isRelativeToMouse?: boolean;
5941
+ [k: string]: unknown;
5942
+ }
5906
5943
  /**
5907
5944
  *
5908
5945
  *
@@ -6028,43 +6065,6 @@ export interface I18NProperty58 {
6028
6065
  i18n?: string;
6029
6066
  [k: string]: unknown;
6030
6067
  }
6031
- /**
6032
- *
6033
- *
6034
- * Options for an inline dialog target
6035
- *
6036
- * <h3>Example</h3>
6037
- *
6038
- *
6039
- *
6040
- *
6041
- *
6042
- * {
6043
- * "target": {
6044
- * "type": "inlinedialog",
6045
- * "options": {
6046
- * "onHover": true,
6047
- * "offsetX": "30px",
6048
- * "offsetY": "20px"
6049
- * }
6050
- * }
6051
- * }
6052
- *
6053
- *
6054
- *
6055
- */
6056
- export interface InlineDialogOptions1 {
6057
- offsetX?: string;
6058
- offsetY?: string;
6059
- width?: string;
6060
- onTop?: boolean;
6061
- showDelay?: number;
6062
- closeOthers?: boolean;
6063
- persistent?: boolean;
6064
- onHover?: boolean;
6065
- isRelativeToMouse?: boolean;
6066
- [k: string]: unknown;
6067
- }
6068
6068
  /**
6069
6069
  *
6070
6070
  *
@@ -6515,6 +6515,37 @@ export interface I18NProperty63 {
6515
6515
  i18n?: string;
6516
6516
  [k: string]: unknown;
6517
6517
  }
6518
+ /**
6519
+ *
6520
+ *
6521
+ * Single Conditions are either provided by the host application. See the complete documentation of
6522
+ * [Conditions](../../conditions/) for more information.
6523
+ *
6524
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6525
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6526
+ *
6527
+ * <h3>Example</h3>
6528
+ *
6529
+ *
6530
+ *
6531
+ *
6532
+ *
6533
+ * {
6534
+ * "condition": "user_is_logged_in",
6535
+ * "invert": false
6536
+ * }
6537
+ *
6538
+ *
6539
+ *
6540
+ */
6541
+ export interface SingleCondition5 {
6542
+ condition: string;
6543
+ invert?: boolean;
6544
+ params?: {
6545
+ [k: string]: unknown;
6546
+ };
6547
+ [k: string]: unknown;
6548
+ }
6518
6549
  /**
6519
6550
  *
6520
6551
  *
@@ -6556,37 +6587,6 @@ export interface CompositeCondition7 {
6556
6587
  type?: 'and' | 'AND' | 'or' | 'OR';
6557
6588
  [k: string]: unknown;
6558
6589
  }
6559
- /**
6560
- *
6561
- *
6562
- * Single Conditions are either provided by the host application. See the complete documentation of
6563
- * [Conditions](../../conditions/) for more information.
6564
- *
6565
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6566
- * This is useful where you want to show the section if a certain condition is not satisfied.
6567
- *
6568
- * <h3>Example</h3>
6569
- *
6570
- *
6571
- *
6572
- *
6573
- *
6574
- * {
6575
- * "condition": "user_is_logged_in",
6576
- * "invert": false
6577
- * }
6578
- *
6579
- *
6580
- *
6581
- */
6582
- export interface SingleCondition5 {
6583
- condition: string;
6584
- invert?: boolean;
6585
- params?: {
6586
- [k: string]: unknown;
6587
- };
6588
- [k: string]: unknown;
6589
- }
6590
6590
  /**
6591
6591
  *
6592
6592
  *
@@ -8006,52 +8006,11 @@ export interface I18NProperty74 {
8006
8006
  *
8007
8007
  */
8008
8008
  export interface MacroPropertyPanel {
8009
- controls?: (ControlGroup | ButtonControl1 | TextControl | ToggleGroup)[];
8009
+ controls?: (ButtonControl | ControlGroup | ToggleGroup | TextControl)[];
8010
8010
  cacheable?: boolean;
8011
8011
  url: string;
8012
8012
  [k: string]: unknown;
8013
8013
  }
8014
- /**
8015
- *
8016
- *
8017
- * Defines a ControlGroup which may appear in control extension points such as the property panel
8018
- *
8019
- * <p><b>Example</b></p>
8020
- *
8021
- *
8022
- *
8023
- *
8024
- *
8025
- * [
8026
- * {
8027
- * "type": "group",
8028
- * "controls": [
8029
- * {
8030
- * "type": "button",
8031
- * "label": {
8032
- * "value": "My Custom Control 0"
8033
- * },
8034
- * "key": "my-custom-control-0"
8035
- * },
8036
- * {
8037
- * "type": "button",
8038
- * "label": {
8039
- * "value": "My Custom Control 1"
8040
- * },
8041
- * "key": "my-custom-control-1"
8042
- * }
8043
- * ]
8044
- * }
8045
- * ]
8046
- *
8047
- *
8048
- *
8049
- */
8050
- export interface ControlGroup {
8051
- controls: ButtonControl[];
8052
- type: 'group' | 'GROUP';
8053
- [k: string]: unknown;
8054
- }
8055
8014
  /**
8056
8015
  *
8057
8016
  *
@@ -8104,6 +8063,47 @@ export interface I18NProperty75 {
8104
8063
  i18n?: string;
8105
8064
  [k: string]: unknown;
8106
8065
  }
8066
+ /**
8067
+ *
8068
+ *
8069
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
8070
+ *
8071
+ * <p><b>Example</b></p>
8072
+ *
8073
+ *
8074
+ *
8075
+ *
8076
+ *
8077
+ * [
8078
+ * {
8079
+ * "type": "group",
8080
+ * "controls": [
8081
+ * {
8082
+ * "type": "button",
8083
+ * "label": {
8084
+ * "value": "My Custom Control 0"
8085
+ * },
8086
+ * "key": "my-custom-control-0"
8087
+ * },
8088
+ * {
8089
+ * "type": "button",
8090
+ * "label": {
8091
+ * "value": "My Custom Control 1"
8092
+ * },
8093
+ * "key": "my-custom-control-1"
8094
+ * }
8095
+ * ]
8096
+ * }
8097
+ * ]
8098
+ *
8099
+ *
8100
+ *
8101
+ */
8102
+ export interface ControlGroup {
8103
+ controls: ButtonControl1[];
8104
+ type: 'group' | 'GROUP';
8105
+ [k: string]: unknown;
8106
+ }
8107
8107
  /**
8108
8108
  *
8109
8109
  *
@@ -8156,34 +8156,6 @@ export interface I18NProperty76 {
8156
8156
  i18n?: string;
8157
8157
  [k: string]: unknown;
8158
8158
  }
8159
- /**
8160
- *
8161
- *
8162
- * Defines a text field which may appear in control extension points such as the property panel
8163
- *
8164
- * <p><b>Example</b></p>
8165
- *
8166
- *
8167
- *
8168
- *
8169
- *
8170
- * {
8171
- * "type": "button",
8172
- * "label": {
8173
- * "value": "My Custom Control 0"
8174
- * },
8175
- * "key": "my-custom-control-0"
8176
- * }
8177
- *
8178
- *
8179
- *
8180
- */
8181
- export interface TextControl {
8182
- macroParameter: string;
8183
- type: 'text' | 'TEXT';
8184
- key: string;
8185
- [k: string]: unknown;
8186
- }
8187
8159
  /**
8188
8160
  *
8189
8161
  *
@@ -8283,6 +8255,34 @@ export interface I18NProperty77 {
8283
8255
  i18n?: string;
8284
8256
  [k: string]: unknown;
8285
8257
  }
8258
+ /**
8259
+ *
8260
+ *
8261
+ * Defines a text field which may appear in control extension points such as the property panel
8262
+ *
8263
+ * <p><b>Example</b></p>
8264
+ *
8265
+ *
8266
+ *
8267
+ *
8268
+ *
8269
+ * {
8270
+ * "type": "button",
8271
+ * "label": {
8272
+ * "value": "My Custom Control 0"
8273
+ * },
8274
+ * "key": "my-custom-control-0"
8275
+ * }
8276
+ *
8277
+ *
8278
+ *
8279
+ */
8280
+ export interface TextControl {
8281
+ macroParameter: string;
8282
+ type: 'text' | 'TEXT';
8283
+ key: string;
8284
+ [k: string]: unknown;
8285
+ }
8286
8286
  /**
8287
8287
  *
8288
8288
  *
@@ -29251,7 +29251,7 @@ export interface I18NProperty83 {
29251
29251
  *
29252
29252
  */
29253
29253
  export interface MacroPropertyPanel1 {
29254
- controls?: (ButtonControl2 | ToggleGroup1 | TextControl1 | ControlGroup1)[];
29254
+ controls?: (ButtonControl2 | ControlGroup1 | TextControl1 | ToggleGroup1)[];
29255
29255
  cacheable?: boolean;
29256
29256
  url: string;
29257
29257
  [k: string]: unknown;
@@ -29311,7 +29311,7 @@ export interface I18NProperty84 {
29311
29311
  /**
29312
29312
  *
29313
29313
  *
29314
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
29314
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
29315
29315
  *
29316
29316
  * <p><b>Example</b></p>
29317
29317
  *
@@ -29321,24 +29321,21 @@ export interface I18NProperty84 {
29321
29321
  *
29322
29322
  * [
29323
29323
  * {
29324
- * "type": "togglegroup",
29325
- * "macroParameter": "toggleGroupMacroParameter",
29324
+ * "type": "group",
29326
29325
  * "controls": [
29327
29326
  * {
29328
- * "type": "togglebutton",
29329
- * "macroParameterValue": "macroParameterValue 0",
29327
+ * "type": "button",
29330
29328
  * "label": {
29331
29329
  * "value": "My Custom Control 0"
29332
29330
  * },
29333
- * "key": "my-custom-toggle-button-0"
29331
+ * "key": "my-custom-control-0"
29334
29332
  * },
29335
29333
  * {
29336
- * "type": "togglebutton",
29337
- * "macroParameterValue": "macroParameterValue 1",
29334
+ * "type": "button",
29338
29335
  * "label": {
29339
29336
  * "value": "My Custom Control 1"
29340
29337
  * },
29341
- * "key": "my-custom-toggle-button-1"
29338
+ * "key": "my-custom-control-1"
29342
29339
  * }
29343
29340
  * ]
29344
29341
  * }
@@ -29347,16 +29344,15 @@ export interface I18NProperty84 {
29347
29344
  *
29348
29345
  *
29349
29346
  */
29350
- export interface ToggleGroup1 {
29351
- controls: ToggleButtonControl1[];
29352
- macroParameter: string;
29353
- type: 'togglegroup' | 'TOGGLEGROUP';
29347
+ export interface ControlGroup1 {
29348
+ controls: ButtonControl3[];
29349
+ type: 'group' | 'GROUP';
29354
29350
  [k: string]: unknown;
29355
29351
  }
29356
29352
  /**
29357
29353
  *
29358
29354
  *
29359
- * Defines a toggle button which appears inside a ToggleGroup
29355
+ * Defines a button which may appear in control extension points such as the property panel
29360
29356
  *
29361
29357
  * <p><b>Example</b></p>
29362
29358
  *
@@ -29365,21 +29361,19 @@ export interface ToggleGroup1 {
29365
29361
  *
29366
29362
  *
29367
29363
  * {
29368
- * "type": "togglebutton",
29369
- * "macroParameterValue": "macroParameterValue 0",
29364
+ * "type": "button",
29370
29365
  * "label": {
29371
29366
  * "value": "My Custom Control 0"
29372
29367
  * },
29373
- * "key": "my-custom-toggle-button-0"
29368
+ * "key": "my-custom-control-0"
29374
29369
  * }
29375
29370
  *
29376
29371
  *
29377
29372
  *
29378
29373
  */
29379
- export interface ToggleButtonControl1 {
29380
- macroParameterValue: string;
29374
+ export interface ButtonControl3 {
29381
29375
  label: I18NProperty85;
29382
- type: 'togglebutton' | 'TOGGLEBUTTON';
29376
+ type: 'button' | 'BUTTON';
29383
29377
  key: string;
29384
29378
  [k: string]: unknown;
29385
29379
  }
@@ -29438,7 +29432,7 @@ export interface TextControl1 {
29438
29432
  /**
29439
29433
  *
29440
29434
  *
29441
- * Defines a ControlGroup which may appear in control extension points such as the property panel
29435
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
29442
29436
  *
29443
29437
  * <p><b>Example</b></p>
29444
29438
  *
@@ -29448,21 +29442,24 @@ export interface TextControl1 {
29448
29442
  *
29449
29443
  * [
29450
29444
  * {
29451
- * "type": "group",
29445
+ * "type": "togglegroup",
29446
+ * "macroParameter": "toggleGroupMacroParameter",
29452
29447
  * "controls": [
29453
29448
  * {
29454
- * "type": "button",
29449
+ * "type": "togglebutton",
29450
+ * "macroParameterValue": "macroParameterValue 0",
29455
29451
  * "label": {
29456
29452
  * "value": "My Custom Control 0"
29457
29453
  * },
29458
- * "key": "my-custom-control-0"
29454
+ * "key": "my-custom-toggle-button-0"
29459
29455
  * },
29460
29456
  * {
29461
- * "type": "button",
29457
+ * "type": "togglebutton",
29458
+ * "macroParameterValue": "macroParameterValue 1",
29462
29459
  * "label": {
29463
29460
  * "value": "My Custom Control 1"
29464
29461
  * },
29465
- * "key": "my-custom-control-1"
29462
+ * "key": "my-custom-toggle-button-1"
29466
29463
  * }
29467
29464
  * ]
29468
29465
  * }
@@ -29471,15 +29468,16 @@ export interface TextControl1 {
29471
29468
  *
29472
29469
  *
29473
29470
  */
29474
- export interface ControlGroup1 {
29475
- controls: ButtonControl3[];
29476
- type: 'group' | 'GROUP';
29471
+ export interface ToggleGroup1 {
29472
+ controls: ToggleButtonControl1[];
29473
+ macroParameter: string;
29474
+ type: 'togglegroup' | 'TOGGLEGROUP';
29477
29475
  [k: string]: unknown;
29478
29476
  }
29479
29477
  /**
29480
29478
  *
29481
29479
  *
29482
- * Defines a button which may appear in control extension points such as the property panel
29480
+ * Defines a toggle button which appears inside a ToggleGroup
29483
29481
  *
29484
29482
  * <p><b>Example</b></p>
29485
29483
  *
@@ -29488,19 +29486,21 @@ export interface ControlGroup1 {
29488
29486
  *
29489
29487
  *
29490
29488
  * {
29491
- * "type": "button",
29489
+ * "type": "togglebutton",
29490
+ * "macroParameterValue": "macroParameterValue 0",
29492
29491
  * "label": {
29493
29492
  * "value": "My Custom Control 0"
29494
29493
  * },
29495
- * "key": "my-custom-control-0"
29494
+ * "key": "my-custom-toggle-button-0"
29496
29495
  * }
29497
29496
  *
29498
29497
  *
29499
29498
  *
29500
29499
  */
29501
- export interface ButtonControl3 {
29500
+ export interface ToggleButtonControl1 {
29501
+ macroParameterValue: string;
29502
29502
  label: I18NProperty86;
29503
- type: 'button' | 'BUTTON';
29503
+ type: 'togglebutton' | 'TOGGLEBUTTON';
29504
29504
  key: string;
29505
29505
  [k: string]: unknown;
29506
29506
  }
@@ -50377,10 +50377,47 @@ export interface I18NProperty91 {
50377
50377
  *
50378
50378
  */
50379
50379
  export interface WebItemTarget2 {
50380
- options?: DialogOptions4 | InlineDialogOptions2 | DialogModuleOptions2;
50380
+ options?: InlineDialogOptions2 | DialogOptions4 | DialogModuleOptions2;
50381
50381
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
50382
50382
  [k: string]: unknown;
50383
50383
  }
50384
+ /**
50385
+ *
50386
+ *
50387
+ * Options for an inline dialog target
50388
+ *
50389
+ * <h3>Example</h3>
50390
+ *
50391
+ *
50392
+ *
50393
+ *
50394
+ *
50395
+ * {
50396
+ * "target": {
50397
+ * "type": "inlinedialog",
50398
+ * "options": {
50399
+ * "onHover": true,
50400
+ * "offsetX": "30px",
50401
+ * "offsetY": "20px"
50402
+ * }
50403
+ * }
50404
+ * }
50405
+ *
50406
+ *
50407
+ *
50408
+ */
50409
+ export interface InlineDialogOptions2 {
50410
+ offsetX?: string;
50411
+ offsetY?: string;
50412
+ width?: string;
50413
+ onTop?: boolean;
50414
+ showDelay?: number;
50415
+ closeOthers?: boolean;
50416
+ persistent?: boolean;
50417
+ onHover?: boolean;
50418
+ isRelativeToMouse?: boolean;
50419
+ [k: string]: unknown;
50420
+ }
50384
50421
  /**
50385
50422
  *
50386
50423
  *
@@ -50479,43 +50516,6 @@ export interface I18NProperty92 {
50479
50516
  i18n?: string;
50480
50517
  [k: string]: unknown;
50481
50518
  }
50482
- /**
50483
- *
50484
- *
50485
- * Options for an inline dialog target
50486
- *
50487
- * <h3>Example</h3>
50488
- *
50489
- *
50490
- *
50491
- *
50492
- *
50493
- * {
50494
- * "target": {
50495
- * "type": "inlinedialog",
50496
- * "options": {
50497
- * "onHover": true,
50498
- * "offsetX": "30px",
50499
- * "offsetY": "20px"
50500
- * }
50501
- * }
50502
- * }
50503
- *
50504
- *
50505
- *
50506
- */
50507
- export interface InlineDialogOptions2 {
50508
- offsetX?: string;
50509
- offsetY?: string;
50510
- width?: string;
50511
- onTop?: boolean;
50512
- showDelay?: number;
50513
- closeOthers?: boolean;
50514
- persistent?: boolean;
50515
- onHover?: boolean;
50516
- isRelativeToMouse?: boolean;
50517
- [k: string]: unknown;
50518
- }
50519
50519
  /**
50520
50520
  *
50521
50521
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/manifest",
3
- "version": "2.5.0-next.4",
3
+ "version": "2.5.0-next.5",
4
4
  "description": "Definitions and validations of the Forge manifest",
5
5
  "main": "out/index.js",
6
6
  "scripts": {