@forge/manifest 2.6.0-next.12 → 2.6.0-next.16

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.
@@ -124,6 +124,10 @@ export interface Connect {
124
124
  * A key for the remote, which other modules can refer to. Must be unique within the manifest and have a maximum of 23 characters.
125
125
  */
126
126
  remote?: string;
127
+ /**
128
+ * The type of authentication used to communicate with tenant APIs
129
+ */
130
+ authentication?: 'jwt' | 'oauth2';
127
131
  }
128
132
  export interface ConnectModules {
129
133
  lifecycle?: [
@@ -1278,44 +1282,124 @@ export interface Modules {
1278
1282
  'jira:adminPage'?: [
1279
1283
  (
1280
1284
  | {
1285
+ function: string;
1281
1286
  title: string;
1282
1287
  icon?: string;
1283
- layout?: 'native' | 'basic';
1284
- function: string;
1288
+ layout?: 'basic' | 'native';
1285
1289
  key: ModuleKeySchema;
1286
1290
  [k: string]: unknown;
1287
1291
  }
1288
1292
  | {
1293
+ resource: string;
1294
+ resourceUploadId?: string;
1295
+ resolver?: {
1296
+ function: string;
1297
+ };
1289
1298
  title: string;
1290
1299
  icon?: string;
1291
- layout?: 'native' | 'basic';
1300
+ layout?: 'basic' | 'native';
1301
+ key: ModuleKeySchema;
1302
+ [k: string]: unknown;
1303
+ }
1304
+ | {
1305
+ pages: {
1306
+ title: string;
1307
+ route: string;
1308
+ icon?: string;
1309
+ [k: string]: unknown;
1310
+ }[];
1311
+ resource: string;
1312
+ resourceUploadId?: string;
1292
1313
  resolver?: {
1293
1314
  function: string;
1294
1315
  };
1316
+ title: string;
1317
+ icon?: string;
1318
+ layout?: 'basic' | 'native';
1319
+ key: ModuleKeySchema;
1320
+ [k: string]: unknown;
1321
+ }
1322
+ | {
1323
+ sections: {
1324
+ header?: string;
1325
+ pages: {
1326
+ title: string;
1327
+ route: string;
1328
+ icon?: string;
1329
+ [k: string]: unknown;
1330
+ }[];
1331
+ [k: string]: unknown;
1332
+ }[];
1295
1333
  resource: string;
1296
1334
  resourceUploadId?: string;
1335
+ resolver?: {
1336
+ function: string;
1337
+ };
1338
+ title: string;
1339
+ icon?: string;
1340
+ layout?: 'basic' | 'native';
1297
1341
  key: ModuleKeySchema;
1298
1342
  [k: string]: unknown;
1299
1343
  }
1300
1344
  ),
1301
1345
  ...(
1302
1346
  | {
1347
+ function: string;
1303
1348
  title: string;
1304
1349
  icon?: string;
1305
- layout?: 'native' | 'basic';
1306
- function: string;
1350
+ layout?: 'basic' | 'native';
1307
1351
  key: ModuleKeySchema;
1308
1352
  [k: string]: unknown;
1309
1353
  }
1310
1354
  | {
1355
+ resource: string;
1356
+ resourceUploadId?: string;
1357
+ resolver?: {
1358
+ function: string;
1359
+ };
1311
1360
  title: string;
1312
1361
  icon?: string;
1313
- layout?: 'native' | 'basic';
1362
+ layout?: 'basic' | 'native';
1363
+ key: ModuleKeySchema;
1364
+ [k: string]: unknown;
1365
+ }
1366
+ | {
1367
+ pages: {
1368
+ title: string;
1369
+ route: string;
1370
+ icon?: string;
1371
+ [k: string]: unknown;
1372
+ }[];
1373
+ resource: string;
1374
+ resourceUploadId?: string;
1314
1375
  resolver?: {
1315
1376
  function: string;
1316
1377
  };
1378
+ title: string;
1379
+ icon?: string;
1380
+ layout?: 'basic' | 'native';
1381
+ key: ModuleKeySchema;
1382
+ [k: string]: unknown;
1383
+ }
1384
+ | {
1385
+ sections: {
1386
+ header?: string;
1387
+ pages: {
1388
+ title: string;
1389
+ route: string;
1390
+ icon?: string;
1391
+ [k: string]: unknown;
1392
+ }[];
1393
+ [k: string]: unknown;
1394
+ }[];
1317
1395
  resource: string;
1318
1396
  resourceUploadId?: string;
1397
+ resolver?: {
1398
+ function: string;
1399
+ };
1400
+ title: string;
1401
+ icon?: string;
1402
+ layout?: 'basic' | 'native';
1319
1403
  key: ModuleKeySchema;
1320
1404
  [k: string]: unknown;
1321
1405
  }
@@ -1324,44 +1408,124 @@ export interface Modules {
1324
1408
  'jira:projectPage'?: [
1325
1409
  (
1326
1410
  | {
1411
+ function: string;
1327
1412
  title: string;
1328
1413
  icon?: string;
1329
- layout?: 'native' | 'basic';
1330
- function: string;
1414
+ layout?: 'basic' | 'native';
1331
1415
  key: ModuleKeySchema;
1332
1416
  [k: string]: unknown;
1333
1417
  }
1334
1418
  | {
1419
+ resource: string;
1420
+ resourceUploadId?: string;
1421
+ resolver?: {
1422
+ function: string;
1423
+ };
1335
1424
  title: string;
1336
1425
  icon?: string;
1337
- layout?: 'native' | 'basic';
1426
+ layout?: 'basic' | 'native';
1427
+ key: ModuleKeySchema;
1428
+ [k: string]: unknown;
1429
+ }
1430
+ | {
1431
+ pages: {
1432
+ title: string;
1433
+ route: string;
1434
+ icon?: string;
1435
+ [k: string]: unknown;
1436
+ }[];
1437
+ resource: string;
1438
+ resourceUploadId?: string;
1338
1439
  resolver?: {
1339
1440
  function: string;
1340
1441
  };
1442
+ title: string;
1443
+ icon?: string;
1444
+ layout?: 'basic' | 'native';
1445
+ key: ModuleKeySchema;
1446
+ [k: string]: unknown;
1447
+ }
1448
+ | {
1449
+ sections: {
1450
+ header?: string;
1451
+ pages: {
1452
+ title: string;
1453
+ route: string;
1454
+ icon?: string;
1455
+ [k: string]: unknown;
1456
+ }[];
1457
+ [k: string]: unknown;
1458
+ }[];
1341
1459
  resource: string;
1342
1460
  resourceUploadId?: string;
1461
+ resolver?: {
1462
+ function: string;
1463
+ };
1464
+ title: string;
1465
+ icon?: string;
1466
+ layout?: 'basic' | 'native';
1343
1467
  key: ModuleKeySchema;
1344
1468
  [k: string]: unknown;
1345
1469
  }
1346
1470
  ),
1347
1471
  ...(
1348
1472
  | {
1473
+ function: string;
1349
1474
  title: string;
1350
1475
  icon?: string;
1351
- layout?: 'native' | 'basic';
1352
- function: string;
1476
+ layout?: 'basic' | 'native';
1353
1477
  key: ModuleKeySchema;
1354
1478
  [k: string]: unknown;
1355
1479
  }
1356
1480
  | {
1481
+ resource: string;
1482
+ resourceUploadId?: string;
1483
+ resolver?: {
1484
+ function: string;
1485
+ };
1357
1486
  title: string;
1358
1487
  icon?: string;
1359
- layout?: 'native' | 'basic';
1488
+ layout?: 'basic' | 'native';
1489
+ key: ModuleKeySchema;
1490
+ [k: string]: unknown;
1491
+ }
1492
+ | {
1493
+ pages: {
1494
+ title: string;
1495
+ route: string;
1496
+ icon?: string;
1497
+ [k: string]: unknown;
1498
+ }[];
1499
+ resource: string;
1500
+ resourceUploadId?: string;
1360
1501
  resolver?: {
1361
1502
  function: string;
1362
1503
  };
1504
+ title: string;
1505
+ icon?: string;
1506
+ layout?: 'basic' | 'native';
1507
+ key: ModuleKeySchema;
1508
+ [k: string]: unknown;
1509
+ }
1510
+ | {
1511
+ sections: {
1512
+ header?: string;
1513
+ pages: {
1514
+ title: string;
1515
+ route: string;
1516
+ icon?: string;
1517
+ [k: string]: unknown;
1518
+ }[];
1519
+ [k: string]: unknown;
1520
+ }[];
1363
1521
  resource: string;
1364
1522
  resourceUploadId?: string;
1523
+ resolver?: {
1524
+ function: string;
1525
+ };
1526
+ title: string;
1527
+ icon?: string;
1528
+ layout?: 'basic' | 'native';
1365
1529
  key: ModuleKeySchema;
1366
1530
  [k: string]: unknown;
1367
1531
  }
@@ -1379,6 +1543,47 @@ export interface Modules {
1379
1543
  }
1380
1544
  | {
1381
1545
  resource: string;
1546
+ resourceUploadId?: string;
1547
+ resolver?: {
1548
+ function: string;
1549
+ };
1550
+ title: string;
1551
+ icon?: string;
1552
+ layout?: 'basic' | 'native';
1553
+ key: ModuleKeySchema;
1554
+ [k: string]: unknown;
1555
+ }
1556
+ | {
1557
+ pages: {
1558
+ title: string;
1559
+ route: string;
1560
+ icon?: string;
1561
+ [k: string]: unknown;
1562
+ }[];
1563
+ resource: string;
1564
+ resourceUploadId?: string;
1565
+ resolver?: {
1566
+ function: string;
1567
+ };
1568
+ title: string;
1569
+ icon?: string;
1570
+ layout?: 'basic' | 'native';
1571
+ key: ModuleKeySchema;
1572
+ [k: string]: unknown;
1573
+ }
1574
+ | {
1575
+ sections: {
1576
+ header?: string;
1577
+ pages: {
1578
+ title: string;
1579
+ route: string;
1580
+ icon?: string;
1581
+ [k: string]: unknown;
1582
+ }[];
1583
+ [k: string]: unknown;
1584
+ }[];
1585
+ resource: string;
1586
+ resourceUploadId?: string;
1382
1587
  resolver?: {
1383
1588
  function: string;
1384
1589
  };
@@ -1400,6 +1605,47 @@ export interface Modules {
1400
1605
  }
1401
1606
  | {
1402
1607
  resource: string;
1608
+ resourceUploadId?: string;
1609
+ resolver?: {
1610
+ function: string;
1611
+ };
1612
+ title: string;
1613
+ icon?: string;
1614
+ layout?: 'basic' | 'native';
1615
+ key: ModuleKeySchema;
1616
+ [k: string]: unknown;
1617
+ }
1618
+ | {
1619
+ pages: {
1620
+ title: string;
1621
+ route: string;
1622
+ icon?: string;
1623
+ [k: string]: unknown;
1624
+ }[];
1625
+ resource: string;
1626
+ resourceUploadId?: string;
1627
+ resolver?: {
1628
+ function: string;
1629
+ };
1630
+ title: string;
1631
+ icon?: string;
1632
+ layout?: 'basic' | 'native';
1633
+ key: ModuleKeySchema;
1634
+ [k: string]: unknown;
1635
+ }
1636
+ | {
1637
+ sections: {
1638
+ header?: string;
1639
+ pages: {
1640
+ title: string;
1641
+ route: string;
1642
+ icon?: string;
1643
+ [k: string]: unknown;
1644
+ }[];
1645
+ [k: string]: unknown;
1646
+ }[];
1647
+ resource: string;
1648
+ resourceUploadId?: string;
1403
1649
  resolver?: {
1404
1650
  function: string;
1405
1651
  };
@@ -1423,6 +1669,47 @@ export interface Modules {
1423
1669
  }
1424
1670
  | {
1425
1671
  resource: string;
1672
+ resourceUploadId?: string;
1673
+ resolver?: {
1674
+ function: string;
1675
+ };
1676
+ title: string;
1677
+ icon?: string;
1678
+ layout?: 'basic' | 'native';
1679
+ key: ModuleKeySchema;
1680
+ [k: string]: unknown;
1681
+ }
1682
+ | {
1683
+ pages: {
1684
+ title: string;
1685
+ route: string;
1686
+ icon?: string;
1687
+ [k: string]: unknown;
1688
+ }[];
1689
+ resource: string;
1690
+ resourceUploadId?: string;
1691
+ resolver?: {
1692
+ function: string;
1693
+ };
1694
+ title: string;
1695
+ icon?: string;
1696
+ layout?: 'basic' | 'native';
1697
+ key: ModuleKeySchema;
1698
+ [k: string]: unknown;
1699
+ }
1700
+ | {
1701
+ sections: {
1702
+ header?: string;
1703
+ pages: {
1704
+ title: string;
1705
+ route: string;
1706
+ icon?: string;
1707
+ [k: string]: unknown;
1708
+ }[];
1709
+ [k: string]: unknown;
1710
+ }[];
1711
+ resource: string;
1712
+ resourceUploadId?: string;
1426
1713
  resolver?: {
1427
1714
  function: string;
1428
1715
  };
@@ -1444,6 +1731,47 @@ export interface Modules {
1444
1731
  }
1445
1732
  | {
1446
1733
  resource: string;
1734
+ resourceUploadId?: string;
1735
+ resolver?: {
1736
+ function: string;
1737
+ };
1738
+ title: string;
1739
+ icon?: string;
1740
+ layout?: 'basic' | 'native';
1741
+ key: ModuleKeySchema;
1742
+ [k: string]: unknown;
1743
+ }
1744
+ | {
1745
+ pages: {
1746
+ title: string;
1747
+ route: string;
1748
+ icon?: string;
1749
+ [k: string]: unknown;
1750
+ }[];
1751
+ resource: string;
1752
+ resourceUploadId?: string;
1753
+ resolver?: {
1754
+ function: string;
1755
+ };
1756
+ title: string;
1757
+ icon?: string;
1758
+ layout?: 'basic' | 'native';
1759
+ key: ModuleKeySchema;
1760
+ [k: string]: unknown;
1761
+ }
1762
+ | {
1763
+ sections: {
1764
+ header?: string;
1765
+ pages: {
1766
+ title: string;
1767
+ route: string;
1768
+ icon?: string;
1769
+ [k: string]: unknown;
1770
+ }[];
1771
+ [k: string]: unknown;
1772
+ }[];
1773
+ resource: string;
1774
+ resourceUploadId?: string;
1447
1775
  resolver?: {
1448
1776
  function: string;
1449
1777
  };
@@ -2555,7 +2883,7 @@ export interface Modules {
2555
2883
  fullPage?: boolean;
2556
2884
  cacheable?: boolean;
2557
2885
  location?: string;
2558
- conditions?: (CompositeCondition | SingleCondition)[];
2886
+ conditions?: (SingleCondition | CompositeCondition)[];
2559
2887
  params?: {
2560
2888
  [k: string]: unknown;
2561
2889
  };
@@ -2570,7 +2898,7 @@ export interface Modules {
2570
2898
  fullPage?: boolean;
2571
2899
  cacheable?: boolean;
2572
2900
  location?: string;
2573
- conditions?: (CompositeCondition | SingleCondition)[];
2901
+ conditions?: (SingleCondition | CompositeCondition)[];
2574
2902
  params?: {
2575
2903
  [k: string]: unknown;
2576
2904
  };
@@ -2642,7 +2970,7 @@ export interface Modules {
2642
2970
  weight?: number;
2643
2971
  cacheable?: boolean;
2644
2972
  location?: string;
2645
- conditions?: (CompositeCondition | SingleCondition)[];
2973
+ conditions?: (SingleCondition | CompositeCondition)[];
2646
2974
  params?: {
2647
2975
  [k: string]: unknown;
2648
2976
  };
@@ -2656,7 +2984,7 @@ export interface Modules {
2656
2984
  weight?: number;
2657
2985
  cacheable?: boolean;
2658
2986
  location?: string;
2659
- conditions?: (CompositeCondition | SingleCondition)[];
2987
+ conditions?: (SingleCondition | CompositeCondition)[];
2660
2988
  params?: {
2661
2989
  [k: string]: unknown;
2662
2990
  };
@@ -2671,7 +2999,7 @@ export interface Modules {
2671
2999
  name?: I18NProperty55;
2672
3000
  weight?: number;
2673
3001
  location?: string;
2674
- conditions?: (SingleCondition | CompositeCondition)[];
3002
+ conditions?: (CompositeCondition | SingleCondition)[];
2675
3003
  params?: {
2676
3004
  [k: string]: unknown;
2677
3005
  };
@@ -2683,7 +3011,7 @@ export interface Modules {
2683
3011
  name?: I18NProperty55;
2684
3012
  weight?: number;
2685
3013
  location?: string;
2686
- conditions?: (SingleCondition | CompositeCondition)[];
3014
+ conditions?: (CompositeCondition | SingleCondition)[];
2687
3015
  params?: {
2688
3016
  [k: string]: unknown;
2689
3017
  };
@@ -2698,7 +3026,7 @@ export interface Modules {
2698
3026
  weight?: number;
2699
3027
  cacheable?: boolean;
2700
3028
  location?: string;
2701
- conditions?: (CompositeCondition | SingleCondition)[];
3029
+ conditions?: (SingleCondition | CompositeCondition)[];
2702
3030
  params?: {
2703
3031
  [k: string]: unknown;
2704
3032
  };
@@ -2712,7 +3040,7 @@ export interface Modules {
2712
3040
  weight?: number;
2713
3041
  cacheable?: boolean;
2714
3042
  location?: string;
2715
- conditions?: (CompositeCondition | SingleCondition)[];
3043
+ conditions?: (SingleCondition | CompositeCondition)[];
2716
3044
  params?: {
2717
3045
  [k: string]: unknown;
2718
3046
  };
@@ -2736,7 +3064,7 @@ export interface Modules {
2736
3064
  name?: I18NProperty59;
2737
3065
  location?: string;
2738
3066
  cacheable?: boolean;
2739
- conditions?: (CompositeCondition6 | SingleCondition4)[];
3067
+ conditions?: (SingleCondition4 | CompositeCondition6)[];
2740
3068
  key: ModuleKeySchema;
2741
3069
  [k: string]: unknown;
2742
3070
  },
@@ -2754,7 +3082,7 @@ export interface Modules {
2754
3082
  name?: I18NProperty59;
2755
3083
  location?: string;
2756
3084
  cacheable?: boolean;
2757
- conditions?: (CompositeCondition6 | SingleCondition4)[];
3085
+ conditions?: (SingleCondition4 | CompositeCondition6)[];
2758
3086
  key: ModuleKeySchema;
2759
3087
  [k: string]: unknown;
2760
3088
  }[]
@@ -2767,7 +3095,7 @@ export interface Modules {
2767
3095
  fullPage?: boolean;
2768
3096
  cacheable?: boolean;
2769
3097
  location?: string;
2770
- conditions?: (CompositeCondition | SingleCondition)[];
3098
+ conditions?: (SingleCondition | CompositeCondition)[];
2771
3099
  params?: {
2772
3100
  [k: string]: unknown;
2773
3101
  };
@@ -2782,7 +3110,7 @@ export interface Modules {
2782
3110
  fullPage?: boolean;
2783
3111
  cacheable?: boolean;
2784
3112
  location?: string;
2785
- conditions?: (CompositeCondition | SingleCondition)[];
3113
+ conditions?: (SingleCondition | CompositeCondition)[];
2786
3114
  params?: {
2787
3115
  [k: string]: unknown;
2788
3116
  };
@@ -2832,7 +3160,7 @@ export interface Modules {
2832
3160
  name?: I18NProperty63;
2833
3161
  weight?: number;
2834
3162
  location?: string;
2835
- conditions?: (SingleCondition5 | CompositeCondition7)[];
3163
+ conditions?: (CompositeCondition7 | SingleCondition5)[];
2836
3164
  params?: {
2837
3165
  [k: string]: unknown;
2838
3166
  };
@@ -2844,7 +3172,7 @@ export interface Modules {
2844
3172
  name?: I18NProperty63;
2845
3173
  weight?: number;
2846
3174
  location?: string;
2847
- conditions?: (SingleCondition5 | CompositeCondition7)[];
3175
+ conditions?: (CompositeCondition7 | SingleCondition5)[];
2848
3176
  params?: {
2849
3177
  [k: string]: unknown;
2850
3178
  };
@@ -3040,7 +3368,7 @@ export interface Modules {
3040
3368
  icon?: Icon18;
3041
3369
  name?: I18NProperty91;
3042
3370
  cacheable?: boolean;
3043
- conditions?: (SingleCondition | CompositeCondition)[];
3371
+ conditions?: (CompositeCondition | SingleCondition)[];
3044
3372
  params?: {
3045
3373
  [k: string]: unknown;
3046
3374
  };
@@ -3056,7 +3384,7 @@ export interface Modules {
3056
3384
  icon?: Icon18;
3057
3385
  name?: I18NProperty91;
3058
3386
  cacheable?: boolean;
3059
- conditions?: (SingleCondition | CompositeCondition)[];
3387
+ conditions?: (CompositeCondition | SingleCondition)[];
3060
3388
  params?: {
3061
3389
  [k: string]: unknown;
3062
3390
  };
@@ -5983,10 +6311,47 @@ export interface Icon10 {
5983
6311
  *
5984
6312
  */
5985
6313
  export interface WebItemTarget1 {
5986
- options?: DialogModuleOptions1 | DialogOptions2 | InlineDialogOptions1;
6314
+ options?: InlineDialogOptions1 | DialogModuleOptions1 | DialogOptions2;
5987
6315
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
5988
6316
  [k: string]: unknown;
5989
6317
  }
6318
+ /**
6319
+ *
6320
+ *
6321
+ * Options for an inline dialog target
6322
+ *
6323
+ * <h3>Example</h3>
6324
+ *
6325
+ *
6326
+ *
6327
+ *
6328
+ *
6329
+ * {
6330
+ * "target": {
6331
+ * "type": "inlinedialog",
6332
+ * "options": {
6333
+ * "onHover": true,
6334
+ * "offsetX": "30px",
6335
+ * "offsetY": "20px"
6336
+ * }
6337
+ * }
6338
+ * }
6339
+ *
6340
+ *
6341
+ *
6342
+ */
6343
+ export interface InlineDialogOptions1 {
6344
+ offsetX?: string;
6345
+ offsetY?: string;
6346
+ width?: string;
6347
+ onTop?: boolean;
6348
+ showDelay?: number;
6349
+ closeOthers?: boolean;
6350
+ persistent?: boolean;
6351
+ onHover?: boolean;
6352
+ isRelativeToMouse?: boolean;
6353
+ [k: string]: unknown;
6354
+ }
5990
6355
  /**
5991
6356
  *
5992
6357
  *
@@ -6115,7 +6480,8 @@ export interface I18NProperty58 {
6115
6480
  /**
6116
6481
  *
6117
6482
  *
6118
- * Options for an inline dialog target
6483
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
6484
+ * and value in multiple places if you like, but identical keys must have identical values.
6119
6485
  *
6120
6486
  * <h3>Example</h3>
6121
6487
  *
@@ -6124,36 +6490,25 @@ export interface I18NProperty58 {
6124
6490
  *
6125
6491
  *
6126
6492
  * {
6127
- * "target": {
6128
- * "type": "inlinedialog",
6129
- * "options": {
6130
- * "onHover": true,
6131
- * "offsetX": "30px",
6132
- * "offsetY": "20px"
6133
- * }
6134
- * }
6493
+ * "value": "My text"
6135
6494
  * }
6136
6495
  *
6137
6496
  *
6138
6497
  *
6139
6498
  */
6140
- export interface InlineDialogOptions1 {
6141
- offsetX?: string;
6142
- offsetY?: string;
6143
- width?: string;
6144
- onTop?: boolean;
6145
- showDelay?: number;
6146
- closeOthers?: boolean;
6147
- persistent?: boolean;
6148
- onHover?: boolean;
6149
- isRelativeToMouse?: boolean;
6499
+ export interface I18NProperty59 {
6500
+ value: string;
6501
+ i18n?: string;
6150
6502
  [k: string]: unknown;
6151
6503
  }
6152
6504
  /**
6153
6505
  *
6154
6506
  *
6155
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
6156
- * and value in multiple places if you like, but identical keys must have identical values.
6507
+ * Single Conditions are either provided by the host application. See the complete documentation of
6508
+ * [Conditions](../../conditions/) for more information.
6509
+ *
6510
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6511
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6157
6512
  *
6158
6513
  * <h3>Example</h3>
6159
6514
  *
@@ -6162,15 +6517,19 @@ export interface InlineDialogOptions1 {
6162
6517
  *
6163
6518
  *
6164
6519
  * {
6165
- * "value": "My text"
6520
+ * "condition": "user_is_logged_in",
6521
+ * "invert": false
6166
6522
  * }
6167
6523
  *
6168
6524
  *
6169
6525
  *
6170
6526
  */
6171
- export interface I18NProperty59 {
6172
- value: string;
6173
- i18n?: string;
6527
+ export interface SingleCondition4 {
6528
+ condition: string;
6529
+ invert?: boolean;
6530
+ params?: {
6531
+ [k: string]: unknown;
6532
+ };
6174
6533
  [k: string]: unknown;
6175
6534
  }
6176
6535
  /**
@@ -6210,41 +6569,10 @@ export interface I18NProperty59 {
6210
6569
  *
6211
6570
  */
6212
6571
  export interface CompositeCondition6 {
6213
- conditions?: (ManifestSchema | SingleCondition)[];
6572
+ conditions?: (SingleCondition | ManifestSchema)[];
6214
6573
  type?: 'and' | 'AND' | 'or' | 'OR';
6215
6574
  [k: string]: unknown;
6216
6575
  }
6217
- /**
6218
- *
6219
- *
6220
- * Single Conditions are either provided by the host application. See the complete documentation of
6221
- * [Conditions](../../conditions/) for more information.
6222
- *
6223
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6224
- * This is useful where you want to show the section if a certain condition is not satisfied.
6225
- *
6226
- * <h3>Example</h3>
6227
- *
6228
- *
6229
- *
6230
- *
6231
- *
6232
- * {
6233
- * "condition": "user_is_logged_in",
6234
- * "invert": false
6235
- * }
6236
- *
6237
- *
6238
- *
6239
- */
6240
- export interface SingleCondition4 {
6241
- condition: string;
6242
- invert?: boolean;
6243
- params?: {
6244
- [k: string]: unknown;
6245
- };
6246
- [k: string]: unknown;
6247
- }
6248
6576
  /**
6249
6577
  *
6250
6578
  *
@@ -6599,37 +6927,6 @@ export interface I18NProperty63 {
6599
6927
  i18n?: string;
6600
6928
  [k: string]: unknown;
6601
6929
  }
6602
- /**
6603
- *
6604
- *
6605
- * Single Conditions are either provided by the host application. See the complete documentation of
6606
- * [Conditions](../../conditions/) for more information.
6607
- *
6608
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6609
- * This is useful where you want to show the section if a certain condition is not satisfied.
6610
- *
6611
- * <h3>Example</h3>
6612
- *
6613
- *
6614
- *
6615
- *
6616
- *
6617
- * {
6618
- * "condition": "user_is_logged_in",
6619
- * "invert": false
6620
- * }
6621
- *
6622
- *
6623
- *
6624
- */
6625
- export interface SingleCondition5 {
6626
- condition: string;
6627
- invert?: boolean;
6628
- params?: {
6629
- [k: string]: unknown;
6630
- };
6631
- [k: string]: unknown;
6632
- }
6633
6930
  /**
6634
6931
  *
6635
6932
  *
@@ -6671,6 +6968,37 @@ export interface CompositeCondition7 {
6671
6968
  type?: 'and' | 'AND' | 'or' | 'OR';
6672
6969
  [k: string]: unknown;
6673
6970
  }
6971
+ /**
6972
+ *
6973
+ *
6974
+ * Single Conditions are either provided by the host application. See the complete documentation of
6975
+ * [Conditions](../../conditions/) for more information.
6976
+ *
6977
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6978
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6979
+ *
6980
+ * <h3>Example</h3>
6981
+ *
6982
+ *
6983
+ *
6984
+ *
6985
+ *
6986
+ * {
6987
+ * "condition": "user_is_logged_in",
6988
+ * "invert": false
6989
+ * }
6990
+ *
6991
+ *
6992
+ *
6993
+ */
6994
+ export interface SingleCondition5 {
6995
+ condition: string;
6996
+ invert?: boolean;
6997
+ params?: {
6998
+ [k: string]: unknown;
6999
+ };
7000
+ [k: string]: unknown;
7001
+ }
6674
7002
  /**
6675
7003
  *
6676
7004
  *
@@ -8090,7 +8418,7 @@ export interface I18NProperty74 {
8090
8418
  *
8091
8419
  */
8092
8420
  export interface MacroPropertyPanel {
8093
- controls?: (ButtonControl | ControlGroup | TextControl | ToggleGroup)[];
8421
+ controls?: (TextControl | ControlGroup | ToggleGroup | ButtonControl1)[];
8094
8422
  cacheable?: boolean;
8095
8423
  url: string;
8096
8424
  [k: string]: unknown;
@@ -8098,7 +8426,7 @@ export interface MacroPropertyPanel {
8098
8426
  /**
8099
8427
  *
8100
8428
  *
8101
- * Defines a button which may appear in control extension points such as the property panel
8429
+ * Defines a text field which may appear in control extension points such as the property panel
8102
8430
  *
8103
8431
  * <p><b>Example</b></p>
8104
8432
  *
@@ -8117,36 +8445,12 @@ export interface MacroPropertyPanel {
8117
8445
  *
8118
8446
  *
8119
8447
  */
8120
- export interface ButtonControl {
8121
- label: I18NProperty75;
8122
- type: 'button' | 'BUTTON';
8448
+ export interface TextControl {
8449
+ macroParameter: string;
8450
+ type: 'text' | 'TEXT';
8123
8451
  key: string;
8124
8452
  [k: string]: unknown;
8125
8453
  }
8126
- /**
8127
- *
8128
- *
8129
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
8130
- * and value in multiple places if you like, but identical keys must have identical values.
8131
- *
8132
- * <h3>Example</h3>
8133
- *
8134
- *
8135
- *
8136
- *
8137
- *
8138
- * {
8139
- * "value": "My text"
8140
- * }
8141
- *
8142
- *
8143
- *
8144
- */
8145
- export interface I18NProperty75 {
8146
- value: string;
8147
- i18n?: string;
8148
- [k: string]: unknown;
8149
- }
8150
8454
  /**
8151
8455
  *
8152
8456
  *
@@ -8184,7 +8488,7 @@ export interface I18NProperty75 {
8184
8488
  *
8185
8489
  */
8186
8490
  export interface ControlGroup {
8187
- controls: ButtonControl1[];
8491
+ controls: ButtonControl[];
8188
8492
  type: 'group' | 'GROUP';
8189
8493
  [k: string]: unknown;
8190
8494
  }
@@ -8210,8 +8514,8 @@ export interface ControlGroup {
8210
8514
  *
8211
8515
  *
8212
8516
  */
8213
- export interface ButtonControl1 {
8214
- label: I18NProperty76;
8517
+ export interface ButtonControl {
8518
+ label: I18NProperty75;
8215
8519
  type: 'button' | 'BUTTON';
8216
8520
  key: string;
8217
8521
  [k: string]: unknown;
@@ -8235,39 +8539,11 @@ export interface ButtonControl1 {
8235
8539
  *
8236
8540
  *
8237
8541
  */
8238
- export interface I18NProperty76 {
8542
+ export interface I18NProperty75 {
8239
8543
  value: string;
8240
8544
  i18n?: string;
8241
8545
  [k: string]: unknown;
8242
8546
  }
8243
- /**
8244
- *
8245
- *
8246
- * Defines a text field which may appear in control extension points such as the property panel
8247
- *
8248
- * <p><b>Example</b></p>
8249
- *
8250
- *
8251
- *
8252
- *
8253
- *
8254
- * {
8255
- * "type": "button",
8256
- * "label": {
8257
- * "value": "My Custom Control 0"
8258
- * },
8259
- * "key": "my-custom-control-0"
8260
- * }
8261
- *
8262
- *
8263
- *
8264
- */
8265
- export interface TextControl {
8266
- macroParameter: string;
8267
- type: 'text' | 'TEXT';
8268
- key: string;
8269
- [k: string]: unknown;
8270
- }
8271
8547
  /**
8272
8548
  *
8273
8549
  *
@@ -8338,11 +8614,63 @@ export interface ToggleGroup {
8338
8614
  */
8339
8615
  export interface ToggleButtonControl {
8340
8616
  macroParameterValue: string;
8341
- label: I18NProperty77;
8617
+ label: I18NProperty76;
8342
8618
  type: 'togglebutton' | 'TOGGLEBUTTON';
8343
8619
  key: string;
8344
8620
  [k: string]: unknown;
8345
8621
  }
8622
+ /**
8623
+ *
8624
+ *
8625
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
8626
+ * and value in multiple places if you like, but identical keys must have identical values.
8627
+ *
8628
+ * <h3>Example</h3>
8629
+ *
8630
+ *
8631
+ *
8632
+ *
8633
+ *
8634
+ * {
8635
+ * "value": "My text"
8636
+ * }
8637
+ *
8638
+ *
8639
+ *
8640
+ */
8641
+ export interface I18NProperty76 {
8642
+ value: string;
8643
+ i18n?: string;
8644
+ [k: string]: unknown;
8645
+ }
8646
+ /**
8647
+ *
8648
+ *
8649
+ * Defines a button which may appear in control extension points such as the property panel
8650
+ *
8651
+ * <p><b>Example</b></p>
8652
+ *
8653
+ *
8654
+ *
8655
+ *
8656
+ *
8657
+ * {
8658
+ * "type": "button",
8659
+ * "label": {
8660
+ * "value": "My Custom Control 0"
8661
+ * },
8662
+ * "key": "my-custom-control-0"
8663
+ * }
8664
+ *
8665
+ *
8666
+ *
8667
+ */
8668
+ export interface ButtonControl1 {
8669
+ label: I18NProperty77;
8670
+ type: 'button' | 'BUTTON';
8671
+ key: string;
8672
+ [k: string]: unknown;
8673
+ }
8346
8674
  /**
8347
8675
  *
8348
8676
  *
@@ -29335,7 +29663,7 @@ export interface I18NProperty83 {
29335
29663
  *
29336
29664
  */
29337
29665
  export interface MacroPropertyPanel1 {
29338
- controls?: (TextControl1 | ButtonControl2 | ControlGroup1 | ToggleGroup1)[];
29666
+ controls?: (ToggleGroup1 | ControlGroup1 | TextControl1 | ButtonControl3)[];
29339
29667
  cacheable?: boolean;
29340
29668
  url: string;
29341
29669
  [k: string]: unknown;
@@ -29343,7 +29671,7 @@ export interface MacroPropertyPanel1 {
29343
29671
  /**
29344
29672
  *
29345
29673
  *
29346
- * Defines a text field which may appear in control extension points such as the property panel
29674
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
29347
29675
  *
29348
29676
  * <p><b>Example</b></p>
29349
29677
  *
@@ -29351,27 +29679,44 @@ export interface MacroPropertyPanel1 {
29351
29679
  *
29352
29680
  *
29353
29681
  *
29354
- * {
29355
- * "type": "button",
29356
- * "label": {
29357
- * "value": "My Custom Control 0"
29358
- * },
29359
- * "key": "my-custom-control-0"
29360
- * }
29682
+ * [
29683
+ * {
29684
+ * "type": "togglegroup",
29685
+ * "macroParameter": "toggleGroupMacroParameter",
29686
+ * "controls": [
29687
+ * {
29688
+ * "type": "togglebutton",
29689
+ * "macroParameterValue": "macroParameterValue 0",
29690
+ * "label": {
29691
+ * "value": "My Custom Control 0"
29692
+ * },
29693
+ * "key": "my-custom-toggle-button-0"
29694
+ * },
29695
+ * {
29696
+ * "type": "togglebutton",
29697
+ * "macroParameterValue": "macroParameterValue 1",
29698
+ * "label": {
29699
+ * "value": "My Custom Control 1"
29700
+ * },
29701
+ * "key": "my-custom-toggle-button-1"
29702
+ * }
29703
+ * ]
29704
+ * }
29705
+ * ]
29361
29706
  *
29362
29707
  *
29363
29708
  *
29364
29709
  */
29365
- export interface TextControl1 {
29710
+ export interface ToggleGroup1 {
29711
+ controls: ToggleButtonControl1[];
29366
29712
  macroParameter: string;
29367
- type: 'text' | 'TEXT';
29368
- key: string;
29713
+ type: 'togglegroup' | 'TOGGLEGROUP';
29369
29714
  [k: string]: unknown;
29370
29715
  }
29371
29716
  /**
29372
29717
  *
29373
29718
  *
29374
- * Defines a button which may appear in control extension points such as the property panel
29719
+ * Defines a toggle button which appears inside a ToggleGroup
29375
29720
  *
29376
29721
  * <p><b>Example</b></p>
29377
29722
  *
@@ -29380,19 +29725,21 @@ export interface TextControl1 {
29380
29725
  *
29381
29726
  *
29382
29727
  * {
29383
- * "type": "button",
29728
+ * "type": "togglebutton",
29729
+ * "macroParameterValue": "macroParameterValue 0",
29384
29730
  * "label": {
29385
29731
  * "value": "My Custom Control 0"
29386
29732
  * },
29387
- * "key": "my-custom-control-0"
29733
+ * "key": "my-custom-toggle-button-0"
29388
29734
  * }
29389
29735
  *
29390
29736
  *
29391
29737
  *
29392
29738
  */
29393
- export interface ButtonControl2 {
29739
+ export interface ToggleButtonControl1 {
29740
+ macroParameterValue: string;
29394
29741
  label: I18NProperty84;
29395
- type: 'button' | 'BUTTON';
29742
+ type: 'togglebutton' | 'TOGGLEBUTTON';
29396
29743
  key: string;
29397
29744
  [k: string]: unknown;
29398
29745
  }
@@ -29457,7 +29804,7 @@ export interface I18NProperty84 {
29457
29804
  *
29458
29805
  */
29459
29806
  export interface ControlGroup1 {
29460
- controls: ButtonControl3[];
29807
+ controls: ButtonControl2[];
29461
29808
  type: 'group' | 'GROUP';
29462
29809
  [k: string]: unknown;
29463
29810
  }
@@ -29483,7 +29830,7 @@ export interface ControlGroup1 {
29483
29830
  *
29484
29831
  *
29485
29832
  */
29486
- export interface ButtonControl3 {
29833
+ export interface ButtonControl2 {
29487
29834
  label: I18NProperty85;
29488
29835
  type: 'button' | 'BUTTON';
29489
29836
  key: string;
@@ -29516,7 +29863,7 @@ export interface I18NProperty85 {
29516
29863
  /**
29517
29864
  *
29518
29865
  *
29519
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
29866
+ * Defines a text field which may appear in control extension points such as the property panel
29520
29867
  *
29521
29868
  * <p><b>Example</b></p>
29522
29869
  *
@@ -29524,44 +29871,27 @@ export interface I18NProperty85 {
29524
29871
  *
29525
29872
  *
29526
29873
  *
29527
- * [
29528
- * {
29529
- * "type": "togglegroup",
29530
- * "macroParameter": "toggleGroupMacroParameter",
29531
- * "controls": [
29532
- * {
29533
- * "type": "togglebutton",
29534
- * "macroParameterValue": "macroParameterValue 0",
29535
- * "label": {
29536
- * "value": "My Custom Control 0"
29537
- * },
29538
- * "key": "my-custom-toggle-button-0"
29539
- * },
29540
- * {
29541
- * "type": "togglebutton",
29542
- * "macroParameterValue": "macroParameterValue 1",
29543
- * "label": {
29544
- * "value": "My Custom Control 1"
29545
- * },
29546
- * "key": "my-custom-toggle-button-1"
29547
- * }
29548
- * ]
29549
- * }
29550
- * ]
29874
+ * {
29875
+ * "type": "button",
29876
+ * "label": {
29877
+ * "value": "My Custom Control 0"
29878
+ * },
29879
+ * "key": "my-custom-control-0"
29880
+ * }
29551
29881
  *
29552
29882
  *
29553
29883
  *
29554
29884
  */
29555
- export interface ToggleGroup1 {
29556
- controls: ToggleButtonControl1[];
29885
+ export interface TextControl1 {
29557
29886
  macroParameter: string;
29558
- type: 'togglegroup' | 'TOGGLEGROUP';
29887
+ type: 'text' | 'TEXT';
29888
+ key: string;
29559
29889
  [k: string]: unknown;
29560
29890
  }
29561
29891
  /**
29562
29892
  *
29563
29893
  *
29564
- * Defines a toggle button which appears inside a ToggleGroup
29894
+ * Defines a button which may appear in control extension points such as the property panel
29565
29895
  *
29566
29896
  * <p><b>Example</b></p>
29567
29897
  *
@@ -29570,21 +29900,19 @@ export interface ToggleGroup1 {
29570
29900
  *
29571
29901
  *
29572
29902
  * {
29573
- * "type": "togglebutton",
29574
- * "macroParameterValue": "macroParameterValue 0",
29903
+ * "type": "button",
29575
29904
  * "label": {
29576
29905
  * "value": "My Custom Control 0"
29577
29906
  * },
29578
- * "key": "my-custom-toggle-button-0"
29907
+ * "key": "my-custom-control-0"
29579
29908
  * }
29580
29909
  *
29581
29910
  *
29582
29911
  *
29583
29912
  */
29584
- export interface ToggleButtonControl1 {
29585
- macroParameterValue: string;
29913
+ export interface ButtonControl3 {
29586
29914
  label: I18NProperty86;
29587
- type: 'togglebutton' | 'TOGGLEBUTTON';
29915
+ type: 'button' | 'BUTTON';
29588
29916
  key: string;
29589
29917
  [k: string]: unknown;
29590
29918
  }
@@ -50461,14 +50789,14 @@ export interface I18NProperty91 {
50461
50789
  *
50462
50790
  */
50463
50791
  export interface WebItemTarget2 {
50464
- options?: DialogModuleOptions2 | InlineDialogOptions2 | DialogOptions4;
50792
+ options?: InlineDialogOptions2 | DialogModuleOptions2 | DialogOptions4;
50465
50793
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
50466
50794
  [k: string]: unknown;
50467
50795
  }
50468
50796
  /**
50469
50797
  *
50470
50798
  *
50471
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
50799
+ * Options for an inline dialog target
50472
50800
  *
50473
50801
  * <h3>Example</h3>
50474
50802
  *
@@ -50478,9 +50806,11 @@ export interface WebItemTarget2 {
50478
50806
  *
50479
50807
  * {
50480
50808
  * "target": {
50481
- * "type": "dialogmodule",
50809
+ * "type": "inlinedialog",
50482
50810
  * "options": {
50483
- * "key": "dialog-module-key"
50811
+ * "onHover": true,
50812
+ * "offsetX": "30px",
50813
+ * "offsetY": "20px"
50484
50814
  * }
50485
50815
  * }
50486
50816
  * }
@@ -50488,14 +50818,22 @@ export interface WebItemTarget2 {
50488
50818
  *
50489
50819
  *
50490
50820
  */
50491
- export interface DialogModuleOptions2 {
50492
- key: string;
50821
+ export interface InlineDialogOptions2 {
50822
+ offsetX?: string;
50823
+ offsetY?: string;
50824
+ width?: string;
50825
+ onTop?: boolean;
50826
+ showDelay?: number;
50827
+ closeOthers?: boolean;
50828
+ persistent?: boolean;
50829
+ onHover?: boolean;
50830
+ isRelativeToMouse?: boolean;
50493
50831
  [k: string]: unknown;
50494
50832
  }
50495
50833
  /**
50496
50834
  *
50497
50835
  *
50498
- * Options for an inline dialog target
50836
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
50499
50837
  *
50500
50838
  * <h3>Example</h3>
50501
50839
  *
@@ -50505,11 +50843,9 @@ export interface DialogModuleOptions2 {
50505
50843
  *
50506
50844
  * {
50507
50845
  * "target": {
50508
- * "type": "inlinedialog",
50846
+ * "type": "dialogmodule",
50509
50847
  * "options": {
50510
- * "onHover": true,
50511
- * "offsetX": "30px",
50512
- * "offsetY": "20px"
50848
+ * "key": "dialog-module-key"
50513
50849
  * }
50514
50850
  * }
50515
50851
  * }
@@ -50517,16 +50853,8 @@ export interface DialogModuleOptions2 {
50517
50853
  *
50518
50854
  *
50519
50855
  */
50520
- export interface InlineDialogOptions2 {
50521
- offsetX?: string;
50522
- offsetY?: string;
50523
- width?: string;
50524
- onTop?: boolean;
50525
- showDelay?: number;
50526
- closeOthers?: boolean;
50527
- persistent?: boolean;
50528
- onHover?: boolean;
50529
- isRelativeToMouse?: boolean;
50856
+ export interface DialogModuleOptions2 {
50857
+ key: string;
50530
50858
  [k: string]: unknown;
50531
50859
  }
50532
50860
  /**