@forge/manifest 2.6.0-next.8 → 3.0.1-fix.0

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.
@@ -72,7 +72,7 @@ export type Scopes = string[];
72
72
  export type Scripts = string[];
73
73
  export type Styles = 'unsafe-inline'[];
74
74
  export type Backend = (string | Remote)[];
75
- export type Client = string[];
75
+ export type Client = (string | Remote1)[];
76
76
  export type Fonts = string[];
77
77
  export type Frames = string[];
78
78
  export type Navigation = string[];
@@ -82,6 +82,19 @@ export type Scripts1 = string[];
82
82
  export type Styles1 = string[];
83
83
  export type Resources = HostedResourcesSchema[];
84
84
  export type Remotes = RemotesSchema[];
85
+ export type BearerMethodSchema =
86
+ | ('authorization-header' | 'form-encoded' | 'uri-query')
87
+ | {
88
+ type: 'authorization-header' | 'form-encoded' | 'uri-query';
89
+ /**
90
+ * Custom authorization header prefix
91
+ */
92
+ prefix?: string;
93
+ /**
94
+ * Custom Header name or Parameter name (depending on type)
95
+ */
96
+ parameter?: string;
97
+ };
85
98
  /**
86
99
  * External authentication providers
87
100
  */
@@ -124,6 +137,10 @@ export interface Connect {
124
137
  * 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
138
  */
126
139
  remote?: string;
140
+ /**
141
+ * The type of authentication used to communicate with tenant APIs
142
+ */
143
+ authentication?: 'jwt' | 'oauth2';
127
144
  }
128
145
  export interface ConnectModules {
129
146
  lifecycle?: [
@@ -298,6 +315,9 @@ export interface Modules {
298
315
  | {
299
316
  title: string;
300
317
  function: string;
318
+ displayConditions?: {
319
+ [k: string]: unknown;
320
+ };
301
321
  key: ModuleKeySchema;
302
322
  [k: string]: unknown;
303
323
  }
@@ -309,6 +329,9 @@ export interface Modules {
309
329
  resource: string;
310
330
  resourceUploadId?: string;
311
331
  viewportSize?: 'small' | 'medium' | 'large';
332
+ displayConditions?: {
333
+ [k: string]: unknown;
334
+ };
312
335
  key: ModuleKeySchema;
313
336
  [k: string]: unknown;
314
337
  }
@@ -317,6 +340,9 @@ export interface Modules {
317
340
  | {
318
341
  title: string;
319
342
  function: string;
343
+ displayConditions?: {
344
+ [k: string]: unknown;
345
+ };
320
346
  key: ModuleKeySchema;
321
347
  [k: string]: unknown;
322
348
  }
@@ -328,6 +354,9 @@ export interface Modules {
328
354
  resource: string;
329
355
  resourceUploadId?: string;
330
356
  viewportSize?: 'small' | 'medium' | 'large';
357
+ displayConditions?: {
358
+ [k: string]: unknown;
359
+ };
331
360
  key: ModuleKeySchema;
332
361
  [k: string]: unknown;
333
362
  }
@@ -338,6 +367,9 @@ export interface Modules {
338
367
  | {
339
368
  title: string;
340
369
  function: string;
370
+ displayConditions?: {
371
+ [k: string]: unknown;
372
+ };
341
373
  key: ModuleKeySchema;
342
374
  [k: string]: unknown;
343
375
  }
@@ -349,6 +381,9 @@ export interface Modules {
349
381
  resource: string;
350
382
  resourceUploadId?: string;
351
383
  viewportSize?: 'small' | 'medium' | 'large' | 'xlarge';
384
+ displayConditions?: {
385
+ [k: string]: unknown;
386
+ };
352
387
  key: ModuleKeySchema;
353
388
  [k: string]: unknown;
354
389
  }
@@ -357,6 +392,9 @@ export interface Modules {
357
392
  | {
358
393
  title: string;
359
394
  function: string;
395
+ displayConditions?: {
396
+ [k: string]: unknown;
397
+ };
360
398
  key: ModuleKeySchema;
361
399
  [k: string]: unknown;
362
400
  }
@@ -368,6 +406,9 @@ export interface Modules {
368
406
  resource: string;
369
407
  resourceUploadId?: string;
370
408
  viewportSize?: 'small' | 'medium' | 'large' | 'xlarge';
409
+ displayConditions?: {
410
+ [k: string]: unknown;
411
+ };
371
412
  key: ModuleKeySchema;
372
413
  [k: string]: unknown;
373
414
  }
@@ -450,6 +491,9 @@ export interface Modules {
450
491
  | {
451
492
  title: string;
452
493
  function: string;
494
+ displayConditions?: {
495
+ [k: string]: unknown;
496
+ };
453
497
  key: ModuleKeySchema;
454
498
  [k: string]: unknown;
455
499
  }
@@ -461,6 +505,9 @@ export interface Modules {
461
505
  resource: string;
462
506
  resourceUploadId?: string;
463
507
  viewportSize?: 'small' | 'medium' | 'large' | 'xlarge';
508
+ displayConditions?: {
509
+ [k: string]: unknown;
510
+ };
464
511
  key: ModuleKeySchema;
465
512
  [k: string]: unknown;
466
513
  }
@@ -469,6 +516,9 @@ export interface Modules {
469
516
  | {
470
517
  title: string;
471
518
  function: string;
519
+ displayConditions?: {
520
+ [k: string]: unknown;
521
+ };
472
522
  key: ModuleKeySchema;
473
523
  [k: string]: unknown;
474
524
  }
@@ -480,6 +530,9 @@ export interface Modules {
480
530
  resource: string;
481
531
  resourceUploadId?: string;
482
532
  viewportSize?: 'small' | 'medium' | 'large' | 'xlarge';
533
+ displayConditions?: {
534
+ [k: string]: unknown;
535
+ };
483
536
  key: ModuleKeySchema;
484
537
  [k: string]: unknown;
485
538
  }
@@ -492,6 +545,9 @@ export interface Modules {
492
545
  icon?: string;
493
546
  route: string;
494
547
  function: string;
548
+ displayConditions?: {
549
+ [k: string]: unknown;
550
+ };
495
551
  key: ModuleKeySchema;
496
552
  [k: string]: unknown;
497
553
  }
@@ -504,6 +560,9 @@ export interface Modules {
504
560
  };
505
561
  resource: string;
506
562
  resourceUploadId?: string;
563
+ displayConditions?: {
564
+ [k: string]: unknown;
565
+ };
507
566
  key: ModuleKeySchema;
508
567
  [k: string]: unknown;
509
568
  }
@@ -514,6 +573,9 @@ export interface Modules {
514
573
  icon?: string;
515
574
  route: string;
516
575
  function: string;
576
+ displayConditions?: {
577
+ [k: string]: unknown;
578
+ };
517
579
  key: ModuleKeySchema;
518
580
  [k: string]: unknown;
519
581
  }
@@ -526,6 +588,9 @@ export interface Modules {
526
588
  };
527
589
  resource: string;
528
590
  resourceUploadId?: string;
591
+ displayConditions?: {
592
+ [k: string]: unknown;
593
+ };
529
594
  key: ModuleKeySchema;
530
595
  [k: string]: unknown;
531
596
  }
@@ -536,6 +601,9 @@ export interface Modules {
536
601
  | {
537
602
  title: string;
538
603
  function: string;
604
+ displayConditions?: {
605
+ [k: string]: unknown;
606
+ };
539
607
  key: ModuleKeySchema;
540
608
  [k: string]: unknown;
541
609
  }
@@ -546,6 +614,9 @@ export interface Modules {
546
614
  };
547
615
  resource: string;
548
616
  resourceUploadId?: string;
617
+ displayConditions?: {
618
+ [k: string]: unknown;
619
+ };
549
620
  key: ModuleKeySchema;
550
621
  [k: string]: unknown;
551
622
  }
@@ -554,6 +625,9 @@ export interface Modules {
554
625
  | {
555
626
  title: string;
556
627
  function: string;
628
+ displayConditions?: {
629
+ [k: string]: unknown;
630
+ };
557
631
  key: ModuleKeySchema;
558
632
  [k: string]: unknown;
559
633
  }
@@ -564,6 +638,9 @@ export interface Modules {
564
638
  };
565
639
  resource: string;
566
640
  resourceUploadId?: string;
641
+ displayConditions?: {
642
+ [k: string]: unknown;
643
+ };
567
644
  key: ModuleKeySchema;
568
645
  [k: string]: unknown;
569
646
  }
@@ -574,6 +651,9 @@ export interface Modules {
574
651
  | {
575
652
  title: string;
576
653
  function: string;
654
+ displayConditions?: {
655
+ [k: string]: unknown;
656
+ };
577
657
  key: ModuleKeySchema;
578
658
  [k: string]: unknown;
579
659
  }
@@ -584,6 +664,9 @@ export interface Modules {
584
664
  };
585
665
  resource: string;
586
666
  resourceUploadId?: string;
667
+ displayConditions?: {
668
+ [k: string]: unknown;
669
+ };
587
670
  key: ModuleKeySchema;
588
671
  [k: string]: unknown;
589
672
  }
@@ -592,6 +675,9 @@ export interface Modules {
592
675
  | {
593
676
  title: string;
594
677
  function: string;
678
+ displayConditions?: {
679
+ [k: string]: unknown;
680
+ };
595
681
  key: ModuleKeySchema;
596
682
  [k: string]: unknown;
597
683
  }
@@ -602,11 +688,68 @@ export interface Modules {
602
688
  };
603
689
  resource: string;
604
690
  resourceUploadId?: string;
691
+ displayConditions?: {
692
+ [k: string]: unknown;
693
+ };
605
694
  key: ModuleKeySchema;
606
695
  [k: string]: unknown;
607
696
  }
608
697
  )[]
609
698
  ];
699
+ 'confluence:globalPage'?: [
700
+ (
701
+ | {
702
+ title: string;
703
+ icon?: string;
704
+ route: string;
705
+ function: string;
706
+ displayConditions?: {
707
+ [k: string]: unknown;
708
+ };
709
+ key: ModuleKeySchema;
710
+ }
711
+ | {
712
+ title: string;
713
+ icon?: string;
714
+ route: string;
715
+ resolver?: {
716
+ function: string;
717
+ };
718
+ resource: string;
719
+ resourceUploadId?: string;
720
+ displayConditions?: {
721
+ [k: string]: unknown;
722
+ };
723
+ key: ModuleKeySchema;
724
+ }
725
+ ),
726
+ ...(
727
+ | {
728
+ title: string;
729
+ icon?: string;
730
+ route: string;
731
+ function: string;
732
+ displayConditions?: {
733
+ [k: string]: unknown;
734
+ };
735
+ key: ModuleKeySchema;
736
+ }
737
+ | {
738
+ title: string;
739
+ icon?: string;
740
+ route: string;
741
+ resolver?: {
742
+ function: string;
743
+ };
744
+ resource: string;
745
+ resourceUploadId?: string;
746
+ displayConditions?: {
747
+ [k: string]: unknown;
748
+ };
749
+ key: ModuleKeySchema;
750
+ }
751
+ )[]
752
+ ];
610
753
  'jira:workflowValidator'?: [
611
754
  {
612
755
  name: string;
@@ -1236,44 +1379,108 @@ export interface Modules {
1236
1379
  'jira:adminPage'?: [
1237
1380
  (
1238
1381
  | {
1382
+ function: string;
1239
1383
  title: string;
1240
1384
  icon?: string;
1241
- layout?: 'native' | 'basic';
1242
- function: string;
1385
+ layout?: 'basic' | 'native';
1386
+ pages?: {
1387
+ title: string;
1388
+ route: string;
1389
+ icon?: string;
1390
+ [k: string]: unknown;
1391
+ }[];
1392
+ sections?: {
1393
+ header?: string;
1394
+ pages: {
1395
+ title: string;
1396
+ route: string;
1397
+ icon?: string;
1398
+ [k: string]: unknown;
1399
+ }[];
1400
+ [k: string]: unknown;
1401
+ }[];
1243
1402
  key: ModuleKeySchema;
1244
1403
  [k: string]: unknown;
1245
1404
  }
1246
1405
  | {
1247
- title: string;
1248
- icon?: string;
1249
- layout?: 'native' | 'basic';
1406
+ resource: string;
1407
+ resourceUploadId?: string;
1250
1408
  resolver?: {
1251
1409
  function: string;
1252
1410
  };
1253
- resource: string;
1254
- resourceUploadId?: string;
1411
+ title: string;
1412
+ icon?: string;
1413
+ layout?: 'basic' | 'native';
1414
+ pages?: {
1415
+ title: string;
1416
+ route: string;
1417
+ icon?: string;
1418
+ [k: string]: unknown;
1419
+ }[];
1420
+ sections?: {
1421
+ header?: string;
1422
+ pages: {
1423
+ title: string;
1424
+ route: string;
1425
+ icon?: string;
1426
+ [k: string]: unknown;
1427
+ }[];
1428
+ [k: string]: unknown;
1429
+ }[];
1255
1430
  key: ModuleKeySchema;
1256
1431
  [k: string]: unknown;
1257
1432
  }
1258
1433
  ),
1259
1434
  ...(
1260
1435
  | {
1436
+ function: string;
1261
1437
  title: string;
1262
1438
  icon?: string;
1263
- layout?: 'native' | 'basic';
1264
- function: string;
1439
+ layout?: 'basic' | 'native';
1440
+ pages?: {
1441
+ title: string;
1442
+ route: string;
1443
+ icon?: string;
1444
+ [k: string]: unknown;
1445
+ }[];
1446
+ sections?: {
1447
+ header?: string;
1448
+ pages: {
1449
+ title: string;
1450
+ route: string;
1451
+ icon?: string;
1452
+ [k: string]: unknown;
1453
+ }[];
1454
+ [k: string]: unknown;
1455
+ }[];
1265
1456
  key: ModuleKeySchema;
1266
1457
  [k: string]: unknown;
1267
1458
  }
1268
1459
  | {
1269
- title: string;
1270
- icon?: string;
1271
- layout?: 'native' | 'basic';
1460
+ resource: string;
1461
+ resourceUploadId?: string;
1272
1462
  resolver?: {
1273
1463
  function: string;
1274
1464
  };
1275
- resource: string;
1276
- resourceUploadId?: string;
1465
+ title: string;
1466
+ icon?: string;
1467
+ layout?: 'basic' | 'native';
1468
+ pages?: {
1469
+ title: string;
1470
+ route: string;
1471
+ icon?: string;
1472
+ [k: string]: unknown;
1473
+ }[];
1474
+ sections?: {
1475
+ header?: string;
1476
+ pages: {
1477
+ title: string;
1478
+ route: string;
1479
+ icon?: string;
1480
+ [k: string]: unknown;
1481
+ }[];
1482
+ [k: string]: unknown;
1483
+ }[];
1277
1484
  key: ModuleKeySchema;
1278
1485
  [k: string]: unknown;
1279
1486
  }
@@ -1282,44 +1489,108 @@ export interface Modules {
1282
1489
  'jira:projectPage'?: [
1283
1490
  (
1284
1491
  | {
1492
+ function: string;
1285
1493
  title: string;
1286
1494
  icon?: string;
1287
- layout?: 'native' | 'basic';
1288
- function: string;
1495
+ layout?: 'basic' | 'native';
1496
+ pages?: {
1497
+ title: string;
1498
+ route: string;
1499
+ icon?: string;
1500
+ [k: string]: unknown;
1501
+ }[];
1502
+ sections?: {
1503
+ header?: string;
1504
+ pages: {
1505
+ title: string;
1506
+ route: string;
1507
+ icon?: string;
1508
+ [k: string]: unknown;
1509
+ }[];
1510
+ [k: string]: unknown;
1511
+ }[];
1289
1512
  key: ModuleKeySchema;
1290
1513
  [k: string]: unknown;
1291
1514
  }
1292
1515
  | {
1293
- title: string;
1294
- icon?: string;
1295
- layout?: 'native' | 'basic';
1516
+ resource: string;
1517
+ resourceUploadId?: string;
1296
1518
  resolver?: {
1297
1519
  function: string;
1298
1520
  };
1299
- resource: string;
1300
- resourceUploadId?: string;
1521
+ title: string;
1522
+ icon?: string;
1523
+ layout?: 'basic' | 'native';
1524
+ pages?: {
1525
+ title: string;
1526
+ route: string;
1527
+ icon?: string;
1528
+ [k: string]: unknown;
1529
+ }[];
1530
+ sections?: {
1531
+ header?: string;
1532
+ pages: {
1533
+ title: string;
1534
+ route: string;
1535
+ icon?: string;
1536
+ [k: string]: unknown;
1537
+ }[];
1538
+ [k: string]: unknown;
1539
+ }[];
1301
1540
  key: ModuleKeySchema;
1302
1541
  [k: string]: unknown;
1303
1542
  }
1304
1543
  ),
1305
1544
  ...(
1306
1545
  | {
1546
+ function: string;
1307
1547
  title: string;
1308
1548
  icon?: string;
1309
- layout?: 'native' | 'basic';
1310
- function: string;
1549
+ layout?: 'basic' | 'native';
1550
+ pages?: {
1551
+ title: string;
1552
+ route: string;
1553
+ icon?: string;
1554
+ [k: string]: unknown;
1555
+ }[];
1556
+ sections?: {
1557
+ header?: string;
1558
+ pages: {
1559
+ title: string;
1560
+ route: string;
1561
+ icon?: string;
1562
+ [k: string]: unknown;
1563
+ }[];
1564
+ [k: string]: unknown;
1565
+ }[];
1311
1566
  key: ModuleKeySchema;
1312
1567
  [k: string]: unknown;
1313
1568
  }
1314
1569
  | {
1315
- title: string;
1316
- icon?: string;
1317
- layout?: 'native' | 'basic';
1570
+ resource: string;
1571
+ resourceUploadId?: string;
1318
1572
  resolver?: {
1319
1573
  function: string;
1320
1574
  };
1321
- resource: string;
1322
- resourceUploadId?: string;
1575
+ title: string;
1576
+ icon?: string;
1577
+ layout?: 'basic' | 'native';
1578
+ pages?: {
1579
+ title: string;
1580
+ route: string;
1581
+ icon?: string;
1582
+ [k: string]: unknown;
1583
+ }[];
1584
+ sections?: {
1585
+ header?: string;
1586
+ pages: {
1587
+ title: string;
1588
+ route: string;
1589
+ icon?: string;
1590
+ [k: string]: unknown;
1591
+ }[];
1592
+ [k: string]: unknown;
1593
+ }[];
1323
1594
  key: ModuleKeySchema;
1324
1595
  [k: string]: unknown;
1325
1596
  }
@@ -1332,17 +1603,50 @@ export interface Modules {
1332
1603
  title: string;
1333
1604
  icon?: string;
1334
1605
  layout?: 'basic' | 'native';
1606
+ pages?: {
1607
+ title: string;
1608
+ route: string;
1609
+ icon?: string;
1610
+ [k: string]: unknown;
1611
+ }[];
1612
+ sections?: {
1613
+ header?: string;
1614
+ pages: {
1615
+ title: string;
1616
+ route: string;
1617
+ icon?: string;
1618
+ [k: string]: unknown;
1619
+ }[];
1620
+ [k: string]: unknown;
1621
+ }[];
1335
1622
  key: ModuleKeySchema;
1336
1623
  [k: string]: unknown;
1337
1624
  }
1338
1625
  | {
1339
1626
  resource: string;
1627
+ resourceUploadId?: string;
1340
1628
  resolver?: {
1341
1629
  function: string;
1342
1630
  };
1343
1631
  title: string;
1344
1632
  icon?: string;
1345
1633
  layout?: 'basic' | 'native';
1634
+ pages?: {
1635
+ title: string;
1636
+ route: string;
1637
+ icon?: string;
1638
+ [k: string]: unknown;
1639
+ }[];
1640
+ sections?: {
1641
+ header?: string;
1642
+ pages: {
1643
+ title: string;
1644
+ route: string;
1645
+ icon?: string;
1646
+ [k: string]: unknown;
1647
+ }[];
1648
+ [k: string]: unknown;
1649
+ }[];
1346
1650
  key: ModuleKeySchema;
1347
1651
  [k: string]: unknown;
1348
1652
  }
@@ -1353,17 +1657,50 @@ export interface Modules {
1353
1657
  title: string;
1354
1658
  icon?: string;
1355
1659
  layout?: 'basic' | 'native';
1660
+ pages?: {
1661
+ title: string;
1662
+ route: string;
1663
+ icon?: string;
1664
+ [k: string]: unknown;
1665
+ }[];
1666
+ sections?: {
1667
+ header?: string;
1668
+ pages: {
1669
+ title: string;
1670
+ route: string;
1671
+ icon?: string;
1672
+ [k: string]: unknown;
1673
+ }[];
1674
+ [k: string]: unknown;
1675
+ }[];
1356
1676
  key: ModuleKeySchema;
1357
1677
  [k: string]: unknown;
1358
1678
  }
1359
1679
  | {
1360
1680
  resource: string;
1681
+ resourceUploadId?: string;
1361
1682
  resolver?: {
1362
1683
  function: string;
1363
1684
  };
1364
1685
  title: string;
1365
1686
  icon?: string;
1366
1687
  layout?: 'basic' | 'native';
1688
+ pages?: {
1689
+ title: string;
1690
+ route: string;
1691
+ icon?: string;
1692
+ [k: string]: unknown;
1693
+ }[];
1694
+ sections?: {
1695
+ header?: string;
1696
+ pages: {
1697
+ title: string;
1698
+ route: string;
1699
+ icon?: string;
1700
+ [k: string]: unknown;
1701
+ }[];
1702
+ [k: string]: unknown;
1703
+ }[];
1367
1704
  key: ModuleKeySchema;
1368
1705
  [k: string]: unknown;
1369
1706
  }
@@ -1376,17 +1713,50 @@ export interface Modules {
1376
1713
  title: string;
1377
1714
  icon?: string;
1378
1715
  layout?: 'basic' | 'native';
1716
+ pages?: {
1717
+ title: string;
1718
+ route: string;
1719
+ icon?: string;
1720
+ [k: string]: unknown;
1721
+ }[];
1722
+ sections?: {
1723
+ header?: string;
1724
+ pages: {
1725
+ title: string;
1726
+ route: string;
1727
+ icon?: string;
1728
+ [k: string]: unknown;
1729
+ }[];
1730
+ [k: string]: unknown;
1731
+ }[];
1379
1732
  key: ModuleKeySchema;
1380
1733
  [k: string]: unknown;
1381
1734
  }
1382
1735
  | {
1383
1736
  resource: string;
1737
+ resourceUploadId?: string;
1384
1738
  resolver?: {
1385
1739
  function: string;
1386
1740
  };
1387
1741
  title: string;
1388
1742
  icon?: string;
1389
1743
  layout?: 'basic' | 'native';
1744
+ pages?: {
1745
+ title: string;
1746
+ route: string;
1747
+ icon?: string;
1748
+ [k: string]: unknown;
1749
+ }[];
1750
+ sections?: {
1751
+ header?: string;
1752
+ pages: {
1753
+ title: string;
1754
+ route: string;
1755
+ icon?: string;
1756
+ [k: string]: unknown;
1757
+ }[];
1758
+ [k: string]: unknown;
1759
+ }[];
1390
1760
  key: ModuleKeySchema;
1391
1761
  [k: string]: unknown;
1392
1762
  }
@@ -1397,17 +1767,50 @@ export interface Modules {
1397
1767
  title: string;
1398
1768
  icon?: string;
1399
1769
  layout?: 'basic' | 'native';
1770
+ pages?: {
1771
+ title: string;
1772
+ route: string;
1773
+ icon?: string;
1774
+ [k: string]: unknown;
1775
+ }[];
1776
+ sections?: {
1777
+ header?: string;
1778
+ pages: {
1779
+ title: string;
1780
+ route: string;
1781
+ icon?: string;
1782
+ [k: string]: unknown;
1783
+ }[];
1784
+ [k: string]: unknown;
1785
+ }[];
1400
1786
  key: ModuleKeySchema;
1401
1787
  [k: string]: unknown;
1402
1788
  }
1403
1789
  | {
1404
1790
  resource: string;
1791
+ resourceUploadId?: string;
1405
1792
  resolver?: {
1406
1793
  function: string;
1407
1794
  };
1408
1795
  title: string;
1409
1796
  icon?: string;
1410
1797
  layout?: 'basic' | 'native';
1798
+ pages?: {
1799
+ title: string;
1800
+ route: string;
1801
+ icon?: string;
1802
+ [k: string]: unknown;
1803
+ }[];
1804
+ sections?: {
1805
+ header?: string;
1806
+ pages: {
1807
+ title: string;
1808
+ route: string;
1809
+ icon?: string;
1810
+ [k: string]: unknown;
1811
+ }[];
1812
+ [k: string]: unknown;
1813
+ }[];
1411
1814
  key: ModuleKeySchema;
1412
1815
  [k: string]: unknown;
1413
1816
  }
@@ -1585,7 +1988,7 @@ export interface Modules {
1585
1988
  fullPage?: boolean;
1586
1989
  cacheable?: boolean;
1587
1990
  location?: string;
1588
- conditions?: (SingleCondition | CompositeCondition)[];
1991
+ conditions?: (CompositeCondition | SingleCondition)[];
1589
1992
  params?: {
1590
1993
  [k: string]: unknown;
1591
1994
  };
@@ -1600,7 +2003,7 @@ export interface Modules {
1600
2003
  fullPage?: boolean;
1601
2004
  cacheable?: boolean;
1602
2005
  location?: string;
1603
- conditions?: (SingleCondition | CompositeCondition)[];
2006
+ conditions?: (CompositeCondition | SingleCondition)[];
1604
2007
  params?: {
1605
2008
  [k: string]: unknown;
1606
2009
  };
@@ -1618,7 +2021,7 @@ export interface Modules {
1618
2021
  location?: string;
1619
2022
  cacheable?: boolean;
1620
2023
  supportsNative?: boolean;
1621
- conditions?: (SingleCondition | CompositeCondition)[];
2024
+ conditions?: (CompositeCondition | SingleCondition)[];
1622
2025
  params?: {
1623
2026
  [k: string]: unknown;
1624
2027
  };
@@ -1634,7 +2037,7 @@ export interface Modules {
1634
2037
  location?: string;
1635
2038
  cacheable?: boolean;
1636
2039
  supportsNative?: boolean;
1637
- conditions?: (SingleCondition | CompositeCondition)[];
2040
+ conditions?: (CompositeCondition | SingleCondition)[];
1638
2041
  params?: {
1639
2042
  [k: string]: unknown;
1640
2043
  };
@@ -1648,7 +2051,7 @@ export interface Modules {
1648
2051
  filter?: string;
1649
2052
  excludeBody?: boolean;
1650
2053
  event?: string;
1651
- conditions?: (CompositeCondition | SingleCondition)[];
2054
+ conditions?: (SingleCondition | CompositeCondition)[];
1652
2055
  propertyKeys?: string[];
1653
2056
  url?: string;
1654
2057
  key: ModuleKeySchema;
@@ -1658,7 +2061,7 @@ export interface Modules {
1658
2061
  filter?: string;
1659
2062
  excludeBody?: boolean;
1660
2063
  event?: string;
1661
- conditions?: (CompositeCondition | SingleCondition)[];
2064
+ conditions?: (SingleCondition | CompositeCondition)[];
1662
2065
  propertyKeys?: string[];
1663
2066
  url?: string;
1664
2067
  key: ModuleKeySchema;
@@ -1672,7 +2075,7 @@ export interface Modules {
1672
2075
  weight?: number;
1673
2076
  cacheable?: boolean;
1674
2077
  location?: string;
1675
- conditions?: (CompositeCondition | SingleCondition)[];
2078
+ conditions?: (SingleCondition | CompositeCondition)[];
1676
2079
  params?: {
1677
2080
  [k: string]: unknown;
1678
2081
  };
@@ -1686,7 +2089,7 @@ export interface Modules {
1686
2089
  weight?: number;
1687
2090
  cacheable?: boolean;
1688
2091
  location?: string;
1689
- conditions?: (CompositeCondition | SingleCondition)[];
2092
+ conditions?: (SingleCondition | CompositeCondition)[];
1690
2093
  params?: {
1691
2094
  [k: string]: unknown;
1692
2095
  };
@@ -1728,7 +2131,7 @@ export interface Modules {
1728
2131
  weight?: number;
1729
2132
  cacheable?: boolean;
1730
2133
  location?: string;
1731
- conditions?: (CompositeCondition | SingleCondition)[];
2134
+ conditions?: (SingleCondition | CompositeCondition)[];
1732
2135
  params?: {
1733
2136
  [k: string]: unknown;
1734
2137
  };
@@ -1742,7 +2145,7 @@ export interface Modules {
1742
2145
  weight?: number;
1743
2146
  cacheable?: boolean;
1744
2147
  location?: string;
1745
- conditions?: (CompositeCondition | SingleCondition)[];
2148
+ conditions?: (SingleCondition | CompositeCondition)[];
1746
2149
  params?: {
1747
2150
  [k: string]: unknown;
1748
2151
  };
@@ -1766,7 +2169,7 @@ export interface Modules {
1766
2169
  name?: I18NProperty10;
1767
2170
  location?: string;
1768
2171
  cacheable?: boolean;
1769
- conditions?: (CompositeCondition1 | SingleCondition1)[];
2172
+ conditions?: (SingleCondition1 | CompositeCondition1)[];
1770
2173
  key: ModuleKeySchema;
1771
2174
  [k: string]: unknown;
1772
2175
  },
@@ -1784,7 +2187,7 @@ export interface Modules {
1784
2187
  name?: I18NProperty10;
1785
2188
  location?: string;
1786
2189
  cacheable?: boolean;
1787
- conditions?: (CompositeCondition1 | SingleCondition1)[];
2190
+ conditions?: (SingleCondition1 | CompositeCondition1)[];
1788
2191
  key: ModuleKeySchema;
1789
2192
  [k: string]: unknown;
1790
2193
  }[]
@@ -1797,7 +2200,7 @@ export interface Modules {
1797
2200
  fullPage?: boolean;
1798
2201
  cacheable?: boolean;
1799
2202
  location?: string;
1800
- conditions?: (SingleCondition | CompositeCondition)[];
2203
+ conditions?: (CompositeCondition | SingleCondition)[];
1801
2204
  params?: {
1802
2205
  [k: string]: unknown;
1803
2206
  };
@@ -1812,7 +2215,7 @@ export interface Modules {
1812
2215
  fullPage?: boolean;
1813
2216
  cacheable?: boolean;
1814
2217
  location?: string;
1815
- conditions?: (SingleCondition | CompositeCondition)[];
2218
+ conditions?: (CompositeCondition | SingleCondition)[];
1816
2219
  params?: {
1817
2220
  [k: string]: unknown;
1818
2221
  };
@@ -2022,7 +2425,7 @@ export interface Modules {
2022
2425
  name?: I18NProperty20;
2023
2426
  weight?: number;
2024
2427
  iconUrl?: string;
2025
- conditions?: (CompositeCondition | SingleCondition)[];
2428
+ conditions?: (SingleCondition | CompositeCondition)[];
2026
2429
  url?: string;
2027
2430
  key: ModuleKeySchema;
2028
2431
  [k: string]: unknown;
@@ -2031,7 +2434,7 @@ export interface Modules {
2031
2434
  name?: I18NProperty20;
2032
2435
  weight?: number;
2033
2436
  iconUrl?: string;
2034
- conditions?: (CompositeCondition | SingleCondition)[];
2437
+ conditions?: (SingleCondition | CompositeCondition)[];
2035
2438
  url?: string;
2036
2439
  key: ModuleKeySchema;
2037
2440
  [k: string]: unknown;
@@ -2042,7 +2445,7 @@ export interface Modules {
2042
2445
  name?: I18NProperty21;
2043
2446
  weight?: number;
2044
2447
  description?: I18NProperty22;
2045
- conditions?: (CompositeCondition | SingleCondition)[];
2448
+ conditions?: (SingleCondition | CompositeCondition)[];
2046
2449
  params?: {
2047
2450
  [k: string]: unknown;
2048
2451
  };
@@ -2054,7 +2457,7 @@ export interface Modules {
2054
2457
  name?: I18NProperty21;
2055
2458
  weight?: number;
2056
2459
  description?: I18NProperty22;
2057
- conditions?: (CompositeCondition | SingleCondition)[];
2460
+ conditions?: (SingleCondition | CompositeCondition)[];
2058
2461
  params?: {
2059
2462
  [k: string]: unknown;
2060
2463
  };
@@ -2067,7 +2470,7 @@ export interface Modules {
2067
2470
  {
2068
2471
  name?: I18NProperty23;
2069
2472
  description?: I18NProperty24;
2070
- conditions?: (SingleCondition | CompositeCondition)[];
2473
+ conditions?: (CompositeCondition | SingleCondition)[];
2071
2474
  url?: string;
2072
2475
  configurable?: boolean;
2073
2476
  thumbnailUrl?: string;
@@ -2077,7 +2480,7 @@ export interface Modules {
2077
2480
  ...{
2078
2481
  name?: I18NProperty23;
2079
2482
  description?: I18NProperty24;
2080
- conditions?: (SingleCondition | CompositeCondition)[];
2483
+ conditions?: (CompositeCondition | SingleCondition)[];
2081
2484
  url?: string;
2082
2485
  configurable?: boolean;
2083
2486
  thumbnailUrl?: string;
@@ -2111,7 +2514,7 @@ export interface Modules {
2111
2514
  {
2112
2515
  icon?: Icon5;
2113
2516
  name?: I18NProperty27;
2114
- conditions?: (CompositeCondition | SingleCondition)[];
2517
+ conditions?: (SingleCondition | CompositeCondition)[];
2115
2518
  content?: IssueGlanceContentLabel;
2116
2519
  target?: IssueGlanceTargetWebPanel;
2117
2520
  jiraNativeAppsEnabled?: boolean;
@@ -2121,7 +2524,7 @@ export interface Modules {
2121
2524
  ...{
2122
2525
  icon?: Icon5;
2123
2526
  name?: I18NProperty27;
2124
- conditions?: (CompositeCondition | SingleCondition)[];
2527
+ conditions?: (SingleCondition | CompositeCondition)[];
2125
2528
  content?: IssueGlanceContentLabel;
2126
2529
  target?: IssueGlanceTargetWebPanel;
2127
2530
  jiraNativeAppsEnabled?: boolean;
@@ -2376,7 +2779,7 @@ export interface Modules {
2376
2779
  name?: I18NProperty44;
2377
2780
  weight?: number;
2378
2781
  location?: string;
2379
- conditions?: (SingleCondition | CompositeCondition)[];
2782
+ conditions?: (CompositeCondition | SingleCondition)[];
2380
2783
  params?: {
2381
2784
  [k: string]: unknown;
2382
2785
  };
@@ -2388,7 +2791,7 @@ export interface Modules {
2388
2791
  name?: I18NProperty44;
2389
2792
  weight?: number;
2390
2793
  location?: string;
2391
- conditions?: (SingleCondition | CompositeCondition)[];
2794
+ conditions?: (CompositeCondition | SingleCondition)[];
2392
2795
  params?: {
2393
2796
  [k: string]: unknown;
2394
2797
  };
@@ -2455,6 +2858,7 @@ export interface Modules {
2455
2858
  {
2456
2859
  installed?: string;
2457
2860
  disabled?: string;
2861
+ 'dare-migration'?: string;
2458
2862
  uninstalled?: string;
2459
2863
  enabled?: string;
2460
2864
  key: ModuleKeySchema;
@@ -2463,6 +2867,7 @@ export interface Modules {
2463
2867
  ...{
2464
2868
  installed?: string;
2465
2869
  disabled?: string;
2870
+ 'dare-migration'?: string;
2466
2871
  uninstalled?: string;
2467
2872
  enabled?: string;
2468
2873
  key: ModuleKeySchema;
@@ -2511,7 +2916,7 @@ export interface Modules {
2511
2916
  fullPage?: boolean;
2512
2917
  cacheable?: boolean;
2513
2918
  location?: string;
2514
- conditions?: (SingleCondition | CompositeCondition)[];
2919
+ conditions?: (CompositeCondition | SingleCondition)[];
2515
2920
  params?: {
2516
2921
  [k: string]: unknown;
2517
2922
  };
@@ -2526,7 +2931,7 @@ export interface Modules {
2526
2931
  fullPage?: boolean;
2527
2932
  cacheable?: boolean;
2528
2933
  location?: string;
2529
- conditions?: (SingleCondition | CompositeCondition)[];
2934
+ conditions?: (CompositeCondition | SingleCondition)[];
2530
2935
  params?: {
2531
2936
  [k: string]: unknown;
2532
2937
  };
@@ -2544,7 +2949,7 @@ export interface Modules {
2544
2949
  location?: string;
2545
2950
  cacheable?: boolean;
2546
2951
  supportsNative?: boolean;
2547
- conditions?: (SingleCondition | CompositeCondition)[];
2952
+ conditions?: (CompositeCondition | SingleCondition)[];
2548
2953
  params?: {
2549
2954
  [k: string]: unknown;
2550
2955
  };
@@ -2560,7 +2965,7 @@ export interface Modules {
2560
2965
  location?: string;
2561
2966
  cacheable?: boolean;
2562
2967
  supportsNative?: boolean;
2563
- conditions?: (SingleCondition | CompositeCondition)[];
2968
+ conditions?: (CompositeCondition | SingleCondition)[];
2564
2969
  params?: {
2565
2970
  [k: string]: unknown;
2566
2971
  };
@@ -2574,7 +2979,7 @@ export interface Modules {
2574
2979
  filter?: string;
2575
2980
  excludeBody?: boolean;
2576
2981
  event?: string;
2577
- conditions?: (CompositeCondition | SingleCondition)[];
2982
+ conditions?: (SingleCondition | CompositeCondition)[];
2578
2983
  propertyKeys?: string[];
2579
2984
  url?: string;
2580
2985
  key: ModuleKeySchema;
@@ -2584,7 +2989,7 @@ export interface Modules {
2584
2989
  filter?: string;
2585
2990
  excludeBody?: boolean;
2586
2991
  event?: string;
2587
- conditions?: (CompositeCondition | SingleCondition)[];
2992
+ conditions?: (SingleCondition | CompositeCondition)[];
2588
2993
  propertyKeys?: string[];
2589
2994
  url?: string;
2590
2995
  key: ModuleKeySchema;
@@ -2627,7 +3032,7 @@ export interface Modules {
2627
3032
  name?: I18NProperty55;
2628
3033
  weight?: number;
2629
3034
  location?: string;
2630
- conditions?: (CompositeCondition | SingleCondition)[];
3035
+ conditions?: (SingleCondition | CompositeCondition)[];
2631
3036
  params?: {
2632
3037
  [k: string]: unknown;
2633
3038
  };
@@ -2639,7 +3044,7 @@ export interface Modules {
2639
3044
  name?: I18NProperty55;
2640
3045
  weight?: number;
2641
3046
  location?: string;
2642
- conditions?: (CompositeCondition | SingleCondition)[];
3047
+ conditions?: (SingleCondition | CompositeCondition)[];
2643
3048
  params?: {
2644
3049
  [k: string]: unknown;
2645
3050
  };
@@ -2692,7 +3097,7 @@ export interface Modules {
2692
3097
  name?: I18NProperty59;
2693
3098
  location?: string;
2694
3099
  cacheable?: boolean;
2695
- conditions?: (SingleCondition4 | CompositeCondition6)[];
3100
+ conditions?: (CompositeCondition6 | SingleCondition4)[];
2696
3101
  key: ModuleKeySchema;
2697
3102
  [k: string]: unknown;
2698
3103
  },
@@ -2710,7 +3115,7 @@ export interface Modules {
2710
3115
  name?: I18NProperty59;
2711
3116
  location?: string;
2712
3117
  cacheable?: boolean;
2713
- conditions?: (SingleCondition4 | CompositeCondition6)[];
3118
+ conditions?: (CompositeCondition6 | SingleCondition4)[];
2714
3119
  key: ModuleKeySchema;
2715
3120
  [k: string]: unknown;
2716
3121
  }[]
@@ -2723,7 +3128,7 @@ export interface Modules {
2723
3128
  fullPage?: boolean;
2724
3129
  cacheable?: boolean;
2725
3130
  location?: string;
2726
- conditions?: (SingleCondition | CompositeCondition)[];
3131
+ conditions?: (CompositeCondition | SingleCondition)[];
2727
3132
  params?: {
2728
3133
  [k: string]: unknown;
2729
3134
  };
@@ -2738,7 +3143,7 @@ export interface Modules {
2738
3143
  fullPage?: boolean;
2739
3144
  cacheable?: boolean;
2740
3145
  location?: string;
2741
- conditions?: (SingleCondition | CompositeCondition)[];
3146
+ conditions?: (CompositeCondition | SingleCondition)[];
2742
3147
  params?: {
2743
3148
  [k: string]: unknown;
2744
3149
  };
@@ -2788,7 +3193,7 @@ export interface Modules {
2788
3193
  name?: I18NProperty63;
2789
3194
  weight?: number;
2790
3195
  location?: string;
2791
- conditions?: (CompositeCondition7 | SingleCondition5)[];
3196
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
2792
3197
  params?: {
2793
3198
  [k: string]: unknown;
2794
3199
  };
@@ -2800,7 +3205,7 @@ export interface Modules {
2800
3205
  name?: I18NProperty63;
2801
3206
  weight?: number;
2802
3207
  location?: string;
2803
- conditions?: (CompositeCondition7 | SingleCondition5)[];
3208
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
2804
3209
  params?: {
2805
3210
  [k: string]: unknown;
2806
3211
  };
@@ -2996,7 +3401,7 @@ export interface Modules {
2996
3401
  icon?: Icon18;
2997
3402
  name?: I18NProperty91;
2998
3403
  cacheable?: boolean;
2999
- conditions?: (CompositeCondition | SingleCondition)[];
3404
+ conditions?: (SingleCondition | CompositeCondition)[];
3000
3405
  params?: {
3001
3406
  [k: string]: unknown;
3002
3407
  };
@@ -3012,7 +3417,7 @@ export interface Modules {
3012
3417
  icon?: Icon18;
3013
3418
  name?: I18NProperty91;
3014
3419
  cacheable?: boolean;
3015
- conditions?: (CompositeCondition | SingleCondition)[];
3420
+ conditions?: (SingleCondition | CompositeCondition)[];
3016
3421
  params?: {
3017
3422
  [k: string]: unknown;
3018
3423
  };
@@ -3194,37 +3599,6 @@ export interface I18NProperty1 {
3194
3599
  i18n?: string;
3195
3600
  [k: string]: unknown;
3196
3601
  }
3197
- /**
3198
- *
3199
- *
3200
- * Single Conditions are either provided by the host application. See the complete documentation of
3201
- * [Conditions](../../conditions/) for more information.
3202
- *
3203
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
3204
- * This is useful where you want to show the section if a certain condition is not satisfied.
3205
- *
3206
- * <h3>Example</h3>
3207
- *
3208
- *
3209
- *
3210
- *
3211
- *
3212
- * {
3213
- * "condition": "user_is_logged_in",
3214
- * "invert": false
3215
- * }
3216
- *
3217
- *
3218
- *
3219
- */
3220
- export interface SingleCondition {
3221
- condition: string;
3222
- invert?: boolean;
3223
- params?: {
3224
- [k: string]: unknown;
3225
- };
3226
- [k: string]: unknown;
3227
- }
3228
3602
  /**
3229
3603
  *
3230
3604
  *
@@ -3262,10 +3636,41 @@ export interface SingleCondition {
3262
3636
  *
3263
3637
  */
3264
3638
  export interface CompositeCondition {
3265
- conditions?: (ManifestSchema | SingleCondition)[];
3639
+ conditions?: (SingleCondition | ManifestSchema)[];
3266
3640
  type?: 'and' | 'AND' | 'or' | 'OR';
3267
3641
  [k: string]: unknown;
3268
3642
  }
3643
+ /**
3644
+ *
3645
+ *
3646
+ * Single Conditions are either provided by the host application. See the complete documentation of
3647
+ * [Conditions](../../conditions/) for more information.
3648
+ *
3649
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
3650
+ * This is useful where you want to show the section if a certain condition is not satisfied.
3651
+ *
3652
+ * <h3>Example</h3>
3653
+ *
3654
+ *
3655
+ *
3656
+ *
3657
+ *
3658
+ * {
3659
+ * "condition": "user_is_logged_in",
3660
+ * "invert": false
3661
+ * }
3662
+ *
3663
+ *
3664
+ *
3665
+ */
3666
+ export interface SingleCondition {
3667
+ condition: string;
3668
+ invert?: boolean;
3669
+ params?: {
3670
+ [k: string]: unknown;
3671
+ };
3672
+ [k: string]: unknown;
3673
+ }
3269
3674
  /**
3270
3675
  *
3271
3676
  *
@@ -3609,10 +4014,47 @@ export interface Icon3 {
3609
4014
  *
3610
4015
  */
3611
4016
  export interface WebItemTarget {
3612
- options?: DialogOptions | InlineDialogOptions | DialogModuleOptions;
4017
+ options?: InlineDialogOptions | DialogOptions | DialogModuleOptions;
3613
4018
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
3614
4019
  [k: string]: unknown;
3615
4020
  }
4021
+ /**
4022
+ *
4023
+ *
4024
+ * Options for an inline dialog target
4025
+ *
4026
+ * <h3>Example</h3>
4027
+ *
4028
+ *
4029
+ *
4030
+ *
4031
+ *
4032
+ * {
4033
+ * "target": {
4034
+ * "type": "inlinedialog",
4035
+ * "options": {
4036
+ * "onHover": true,
4037
+ * "offsetX": "30px",
4038
+ * "offsetY": "20px"
4039
+ * }
4040
+ * }
4041
+ * }
4042
+ *
4043
+ *
4044
+ *
4045
+ */
4046
+ export interface InlineDialogOptions {
4047
+ offsetX?: string;
4048
+ offsetY?: string;
4049
+ width?: string;
4050
+ onTop?: boolean;
4051
+ showDelay?: number;
4052
+ closeOthers?: boolean;
4053
+ persistent?: boolean;
4054
+ onHover?: boolean;
4055
+ isRelativeToMouse?: boolean;
4056
+ [k: string]: unknown;
4057
+ }
3616
4058
  /**
3617
4059
  *
3618
4060
  *
@@ -3714,7 +4156,7 @@ export interface I18NProperty9 {
3714
4156
  /**
3715
4157
  *
3716
4158
  *
3717
- * Options for an inline dialog target
4159
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
3718
4160
  *
3719
4161
  * <h3>Example</h3>
3720
4162
  *
@@ -3724,11 +4166,9 @@ export interface I18NProperty9 {
3724
4166
  *
3725
4167
  * {
3726
4168
  * "target": {
3727
- * "type": "inlinedialog",
4169
+ * "type": "dialogmodule",
3728
4170
  * "options": {
3729
- * "onHover": true,
3730
- * "offsetX": "30px",
3731
- * "offsetY": "20px"
4171
+ * "key": "dialog-module-key"
3732
4172
  * }
3733
4173
  * }
3734
4174
  * }
@@ -3736,22 +4176,15 @@ export interface I18NProperty9 {
3736
4176
  *
3737
4177
  *
3738
4178
  */
3739
- export interface InlineDialogOptions {
3740
- offsetX?: string;
3741
- offsetY?: string;
3742
- width?: string;
3743
- onTop?: boolean;
3744
- showDelay?: number;
3745
- closeOthers?: boolean;
3746
- persistent?: boolean;
3747
- onHover?: boolean;
3748
- isRelativeToMouse?: boolean;
4179
+ export interface DialogModuleOptions {
4180
+ key: string;
3749
4181
  [k: string]: unknown;
3750
4182
  }
3751
4183
  /**
3752
4184
  *
3753
4185
  *
3754
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
4186
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
4187
+ * and value in multiple places if you like, but identical keys must have identical values.
3755
4188
  *
3756
4189
  * <h3>Example</h3>
3757
4190
  *
@@ -3760,143 +4193,115 @@ export interface InlineDialogOptions {
3760
4193
  *
3761
4194
  *
3762
4195
  * {
3763
- * "target": {
3764
- * "type": "dialogmodule",
3765
- * "options": {
3766
- * "key": "dialog-module-key"
4196
+ * "value": "My text"
4197
+ * }
4198
+ *
4199
+ *
4200
+ *
4201
+ */
4202
+ export interface I18NProperty10 {
4203
+ value: string;
4204
+ i18n?: string;
4205
+ [k: string]: unknown;
4206
+ }
4207
+ /**
4208
+ *
4209
+ *
4210
+ * Single Conditions are either provided by the host application. See the complete documentation of
4211
+ * [Conditions](../../conditions/) for more information.
4212
+ *
4213
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
4214
+ * This is useful where you want to show the section if a certain condition is not satisfied.
4215
+ *
4216
+ * <h3>Example</h3>
4217
+ *
4218
+ *
4219
+ *
4220
+ *
4221
+ *
4222
+ * {
4223
+ * "condition": "user_is_logged_in",
4224
+ * "invert": false
4225
+ * }
4226
+ *
4227
+ *
4228
+ *
4229
+ */
4230
+ export interface SingleCondition1 {
4231
+ condition: string;
4232
+ invert?: boolean;
4233
+ params?: {
4234
+ [k: string]: unknown;
4235
+ };
4236
+ [k: string]: unknown;
4237
+ }
4238
+ /**
4239
+ *
4240
+ *
4241
+ * Composite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions
4242
+ * and a type attribute.
4243
+ *
4244
+ * <h3>Example</h3>
4245
+ *
4246
+ *
4247
+ *
4248
+ *
4249
+ *
4250
+ * {
4251
+ * "conditions": [
4252
+ * {
4253
+ * "or": [
4254
+ * {
4255
+ * "condition": "can_attach_file_to_issue",
4256
+ * "invert": false
4257
+ * },
4258
+ * {
4259
+ * "condition": "is_issue_assigned_to_current_user",
4260
+ * "invert": false
4261
+ * }
4262
+ * ]
4263
+ * },
4264
+ * {
4265
+ * "condition": "user_is_logged_in",
4266
+ * "invert": false
3767
4267
  * }
4268
+ * ]
4269
+ * }
4270
+ *
4271
+ *
4272
+ *
4273
+ */
4274
+ export interface CompositeCondition1 {
4275
+ conditions?: (SingleCondition | ManifestSchema)[];
4276
+ type?: 'and' | 'AND' | 'or' | 'OR';
4277
+ [k: string]: unknown;
4278
+ }
4279
+ /**
4280
+ *
4281
+ *
4282
+ * Defines an icon to display.
4283
+ *
4284
+ * <h3>Example</h3>
4285
+ *
4286
+ *
4287
+ *
4288
+ *
4289
+ *
4290
+ * {
4291
+ * "icon": {
4292
+ * "width": 16,
4293
+ * "height": 16,
4294
+ * "url": "/my-icon.png"
3768
4295
  * }
3769
4296
  * }
3770
4297
  *
3771
4298
  *
3772
4299
  *
3773
4300
  */
3774
- export interface DialogModuleOptions {
3775
- key: string;
3776
- [k: string]: unknown;
3777
- }
3778
- /**
3779
- *
3780
- *
3781
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
3782
- * and value in multiple places if you like, but identical keys must have identical values.
3783
- *
3784
- * <h3>Example</h3>
3785
- *
3786
- *
3787
- *
3788
- *
3789
- *
3790
- * {
3791
- * "value": "My text"
3792
- * }
3793
- *
3794
- *
3795
- *
3796
- */
3797
- export interface I18NProperty10 {
3798
- value: string;
3799
- i18n?: string;
3800
- [k: string]: unknown;
3801
- }
3802
- /**
3803
- *
3804
- *
3805
- * Composite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions
3806
- * and a type attribute.
3807
- *
3808
- * <h3>Example</h3>
3809
- *
3810
- *
3811
- *
3812
- *
3813
- *
3814
- * {
3815
- * "conditions": [
3816
- * {
3817
- * "or": [
3818
- * {
3819
- * "condition": "can_attach_file_to_issue",
3820
- * "invert": false
3821
- * },
3822
- * {
3823
- * "condition": "is_issue_assigned_to_current_user",
3824
- * "invert": false
3825
- * }
3826
- * ]
3827
- * },
3828
- * {
3829
- * "condition": "user_is_logged_in",
3830
- * "invert": false
3831
- * }
3832
- * ]
3833
- * }
3834
- *
3835
- *
3836
- *
3837
- */
3838
- export interface CompositeCondition1 {
3839
- conditions?: (SingleCondition | ManifestSchema)[];
3840
- type?: 'and' | 'AND' | 'or' | 'OR';
3841
- [k: string]: unknown;
3842
- }
3843
- /**
3844
- *
3845
- *
3846
- * Single Conditions are either provided by the host application. See the complete documentation of
3847
- * [Conditions](../../conditions/) for more information.
3848
- *
3849
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
3850
- * This is useful where you want to show the section if a certain condition is not satisfied.
3851
- *
3852
- * <h3>Example</h3>
3853
- *
3854
- *
3855
- *
3856
- *
3857
- *
3858
- * {
3859
- * "condition": "user_is_logged_in",
3860
- * "invert": false
3861
- * }
3862
- *
3863
- *
3864
- *
3865
- */
3866
- export interface SingleCondition1 {
3867
- condition: string;
3868
- invert?: boolean;
3869
- params?: {
3870
- [k: string]: unknown;
3871
- };
3872
- [k: string]: unknown;
3873
- }
3874
- /**
3875
- *
3876
- *
3877
- * Defines an icon to display.
3878
- *
3879
- * <h3>Example</h3>
3880
- *
3881
- *
3882
- *
3883
- *
3884
- *
3885
- * {
3886
- * "icon": {
3887
- * "width": 16,
3888
- * "height": 16,
3889
- * "url": "/my-icon.png"
3890
- * }
3891
- * }
3892
- *
3893
- *
3894
- *
3895
- */
3896
- export interface Icon4 {
3897
- width?: number;
3898
- url: string;
3899
- height?: number;
4301
+ export interface Icon4 {
4302
+ width?: number;
4303
+ url: string;
4304
+ height?: number;
3900
4305
  [k: string]: unknown;
3901
4306
  }
3902
4307
  /**
@@ -4810,7 +5215,7 @@ export interface I18NProperty33 {
4810
5215
  *
4811
5216
  */
4812
5217
  export interface CompositeCondition2 {
4813
- conditions?: (SingleCondition | CompositeCondition3)[];
5218
+ conditions?: (CompositeCondition3 | SingleCondition)[];
4814
5219
  type?: 'and' | 'AND' | 'or' | 'OR';
4815
5220
  [k: string]: unknown;
4816
5221
  }
@@ -4851,7 +5256,7 @@ export interface CompositeCondition2 {
4851
5256
  *
4852
5257
  */
4853
5258
  export interface CompositeCondition3 {
4854
- conditions?: (SingleCondition | ManifestSchema)[];
5259
+ conditions?: (ManifestSchema | SingleCondition)[];
4855
5260
  type?: 'and' | 'AND' | 'or' | 'OR';
4856
5261
  [k: string]: unknown;
4857
5262
  }
@@ -5115,7 +5520,7 @@ export interface I18NProperty38 {
5115
5520
  *
5116
5521
  */
5117
5522
  export interface CompositeCondition4 {
5118
- conditions?: (SingleCondition | CompositeCondition5)[];
5523
+ conditions?: (CompositeCondition5 | SingleCondition)[];
5119
5524
  type?: 'and' | 'AND' | 'or' | 'OR';
5120
5525
  [k: string]: unknown;
5121
5526
  }
@@ -5156,7 +5561,7 @@ export interface CompositeCondition4 {
5156
5561
  *
5157
5562
  */
5158
5563
  export interface CompositeCondition5 {
5159
- conditions?: (SingleCondition | ManifestSchema)[];
5564
+ conditions?: (ManifestSchema | SingleCondition)[];
5160
5565
  type?: 'and' | 'AND' | 'or' | 'OR';
5161
5566
  [k: string]: unknown;
5162
5567
  }
@@ -5939,74 +6344,10 @@ export interface Icon10 {
5939
6344
  *
5940
6345
  */
5941
6346
  export interface WebItemTarget1 {
5942
- options?: InlineDialogOptions1 | DialogModuleOptions1 | DialogOptions2;
6347
+ options?: DialogOptions2 | InlineDialogOptions1 | DialogModuleOptions1;
5943
6348
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
5944
6349
  [k: string]: unknown;
5945
6350
  }
5946
- /**
5947
- *
5948
- *
5949
- * Options for an inline dialog target
5950
- *
5951
- * <h3>Example</h3>
5952
- *
5953
- *
5954
- *
5955
- *
5956
- *
5957
- * {
5958
- * "target": {
5959
- * "type": "inlinedialog",
5960
- * "options": {
5961
- * "onHover": true,
5962
- * "offsetX": "30px",
5963
- * "offsetY": "20px"
5964
- * }
5965
- * }
5966
- * }
5967
- *
5968
- *
5969
- *
5970
- */
5971
- export interface InlineDialogOptions1 {
5972
- offsetX?: string;
5973
- offsetY?: string;
5974
- width?: string;
5975
- onTop?: boolean;
5976
- showDelay?: number;
5977
- closeOthers?: boolean;
5978
- persistent?: boolean;
5979
- onHover?: boolean;
5980
- isRelativeToMouse?: boolean;
5981
- [k: string]: unknown;
5982
- }
5983
- /**
5984
- *
5985
- *
5986
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
5987
- *
5988
- * <h3>Example</h3>
5989
- *
5990
- *
5991
- *
5992
- *
5993
- *
5994
- * {
5995
- * "target": {
5996
- * "type": "dialogmodule",
5997
- * "options": {
5998
- * "key": "dialog-module-key"
5999
- * }
6000
- * }
6001
- * }
6002
- *
6003
- *
6004
- *
6005
- */
6006
- export interface DialogModuleOptions1 {
6007
- key: string;
6008
- [k: string]: unknown;
6009
- }
6010
6351
  /**
6011
6352
  *
6012
6353
  *
@@ -6108,8 +6449,7 @@ export interface I18NProperty58 {
6108
6449
  /**
6109
6450
  *
6110
6451
  *
6111
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
6112
- * and value in multiple places if you like, but identical keys must have identical values.
6452
+ * Options for an inline dialog target
6113
6453
  *
6114
6454
  * <h3>Example</h3>
6115
6455
  *
@@ -6118,25 +6458,63 @@ export interface I18NProperty58 {
6118
6458
  *
6119
6459
  *
6120
6460
  * {
6121
- * "value": "My text"
6461
+ * "target": {
6462
+ * "type": "inlinedialog",
6463
+ * "options": {
6464
+ * "onHover": true,
6465
+ * "offsetX": "30px",
6466
+ * "offsetY": "20px"
6467
+ * }
6468
+ * }
6122
6469
  * }
6123
6470
  *
6124
6471
  *
6125
6472
  *
6126
6473
  */
6127
- export interface I18NProperty59 {
6128
- value: string;
6129
- i18n?: string;
6474
+ export interface InlineDialogOptions1 {
6475
+ offsetX?: string;
6476
+ offsetY?: string;
6477
+ width?: string;
6478
+ onTop?: boolean;
6479
+ showDelay?: number;
6480
+ closeOthers?: boolean;
6481
+ persistent?: boolean;
6482
+ onHover?: boolean;
6483
+ isRelativeToMouse?: boolean;
6130
6484
  [k: string]: unknown;
6131
6485
  }
6132
6486
  /**
6133
6487
  *
6134
6488
  *
6135
- * Single Conditions are either provided by the host application. See the complete documentation of
6136
- * [Conditions](../../conditions/) for more information.
6489
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
6490
+ *
6491
+ * <h3>Example</h3>
6492
+ *
6137
6493
  *
6138
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6139
- * This is useful where you want to show the section if a certain condition is not satisfied.
6494
+ *
6495
+ *
6496
+ *
6497
+ * {
6498
+ * "target": {
6499
+ * "type": "dialogmodule",
6500
+ * "options": {
6501
+ * "key": "dialog-module-key"
6502
+ * }
6503
+ * }
6504
+ * }
6505
+ *
6506
+ *
6507
+ *
6508
+ */
6509
+ export interface DialogModuleOptions1 {
6510
+ key: string;
6511
+ [k: string]: unknown;
6512
+ }
6513
+ /**
6514
+ *
6515
+ *
6516
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
6517
+ * and value in multiple places if you like, but identical keys must have identical values.
6140
6518
  *
6141
6519
  * <h3>Example</h3>
6142
6520
  *
@@ -6145,19 +6523,15 @@ export interface I18NProperty59 {
6145
6523
  *
6146
6524
  *
6147
6525
  * {
6148
- * "condition": "user_is_logged_in",
6149
- * "invert": false
6526
+ * "value": "My text"
6150
6527
  * }
6151
6528
  *
6152
6529
  *
6153
6530
  *
6154
6531
  */
6155
- export interface SingleCondition4 {
6156
- condition: string;
6157
- invert?: boolean;
6158
- params?: {
6159
- [k: string]: unknown;
6160
- };
6532
+ export interface I18NProperty59 {
6533
+ value: string;
6534
+ i18n?: string;
6161
6535
  [k: string]: unknown;
6162
6536
  }
6163
6537
  /**
@@ -6201,6 +6575,37 @@ export interface CompositeCondition6 {
6201
6575
  type?: 'and' | 'AND' | 'or' | 'OR';
6202
6576
  [k: string]: unknown;
6203
6577
  }
6578
+ /**
6579
+ *
6580
+ *
6581
+ * Single Conditions are either provided by the host application. See the complete documentation of
6582
+ * [Conditions](../../conditions/) for more information.
6583
+ *
6584
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6585
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6586
+ *
6587
+ * <h3>Example</h3>
6588
+ *
6589
+ *
6590
+ *
6591
+ *
6592
+ *
6593
+ * {
6594
+ * "condition": "user_is_logged_in",
6595
+ * "invert": false
6596
+ * }
6597
+ *
6598
+ *
6599
+ *
6600
+ */
6601
+ export interface SingleCondition4 {
6602
+ condition: string;
6603
+ invert?: boolean;
6604
+ params?: {
6605
+ [k: string]: unknown;
6606
+ };
6607
+ [k: string]: unknown;
6608
+ }
6204
6609
  /**
6205
6610
  *
6206
6611
  *
@@ -6555,6 +6960,37 @@ export interface I18NProperty63 {
6555
6960
  i18n?: string;
6556
6961
  [k: string]: unknown;
6557
6962
  }
6963
+ /**
6964
+ *
6965
+ *
6966
+ * Single Conditions are either provided by the host application. See the complete documentation of
6967
+ * [Conditions](../../conditions/) for more information.
6968
+ *
6969
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6970
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6971
+ *
6972
+ * <h3>Example</h3>
6973
+ *
6974
+ *
6975
+ *
6976
+ *
6977
+ *
6978
+ * {
6979
+ * "condition": "user_is_logged_in",
6980
+ * "invert": false
6981
+ * }
6982
+ *
6983
+ *
6984
+ *
6985
+ */
6986
+ export interface SingleCondition5 {
6987
+ condition: string;
6988
+ invert?: boolean;
6989
+ params?: {
6990
+ [k: string]: unknown;
6991
+ };
6992
+ [k: string]: unknown;
6993
+ }
6558
6994
  /**
6559
6995
  *
6560
6996
  *
@@ -6592,41 +7028,10 @@ export interface I18NProperty63 {
6592
7028
  *
6593
7029
  */
6594
7030
  export interface CompositeCondition7 {
6595
- conditions?: (ManifestSchema | SingleCondition)[];
7031
+ conditions?: (SingleCondition | ManifestSchema)[];
6596
7032
  type?: 'and' | 'AND' | 'or' | 'OR';
6597
7033
  [k: string]: unknown;
6598
7034
  }
6599
- /**
6600
- *
6601
- *
6602
- * Single Conditions are either provided by the host application. See the complete documentation of
6603
- * [Conditions](../../conditions/) for more information.
6604
- *
6605
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6606
- * This is useful where you want to show the section if a certain condition is not satisfied.
6607
- *
6608
- * <h3>Example</h3>
6609
- *
6610
- *
6611
- *
6612
- *
6613
- *
6614
- * {
6615
- * "condition": "user_is_logged_in",
6616
- * "invert": false
6617
- * }
6618
- *
6619
- *
6620
- *
6621
- */
6622
- export interface SingleCondition5 {
6623
- condition: string;
6624
- invert?: boolean;
6625
- params?: {
6626
- [k: string]: unknown;
6627
- };
6628
- [k: string]: unknown;
6629
- }
6630
7035
  /**
6631
7036
  *
6632
7037
  *
@@ -8046,7 +8451,7 @@ export interface I18NProperty74 {
8046
8451
  *
8047
8452
  */
8048
8453
  export interface MacroPropertyPanel {
8049
- controls?: (ToggleGroup | TextControl | ButtonControl | ControlGroup)[];
8454
+ controls?: (ButtonControl | ToggleGroup | ControlGroup | TextControl)[];
8050
8455
  cacheable?: boolean;
8051
8456
  url: string;
8052
8457
  [k: string]: unknown;
@@ -8054,52 +8459,7 @@ export interface MacroPropertyPanel {
8054
8459
  /**
8055
8460
  *
8056
8461
  *
8057
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
8058
- *
8059
- * <p><b>Example</b></p>
8060
- *
8061
- *
8062
- *
8063
- *
8064
- *
8065
- * [
8066
- * {
8067
- * "type": "togglegroup",
8068
- * "macroParameter": "toggleGroupMacroParameter",
8069
- * "controls": [
8070
- * {
8071
- * "type": "togglebutton",
8072
- * "macroParameterValue": "macroParameterValue 0",
8073
- * "label": {
8074
- * "value": "My Custom Control 0"
8075
- * },
8076
- * "key": "my-custom-toggle-button-0"
8077
- * },
8078
- * {
8079
- * "type": "togglebutton",
8080
- * "macroParameterValue": "macroParameterValue 1",
8081
- * "label": {
8082
- * "value": "My Custom Control 1"
8083
- * },
8084
- * "key": "my-custom-toggle-button-1"
8085
- * }
8086
- * ]
8087
- * }
8088
- * ]
8089
- *
8090
- *
8091
- *
8092
- */
8093
- export interface ToggleGroup {
8094
- controls: ToggleButtonControl[];
8095
- macroParameter: string;
8096
- type: 'togglegroup' | 'TOGGLEGROUP';
8097
- [k: string]: unknown;
8098
- }
8099
- /**
8100
- *
8101
- *
8102
- * Defines a toggle button which appears inside a ToggleGroup
8462
+ * Defines a button which may appear in control extension points such as the property panel
8103
8463
  *
8104
8464
  * <p><b>Example</b></p>
8105
8465
  *
@@ -8108,21 +8468,19 @@ export interface ToggleGroup {
8108
8468
  *
8109
8469
  *
8110
8470
  * {
8111
- * "type": "togglebutton",
8112
- * "macroParameterValue": "macroParameterValue 0",
8471
+ * "type": "button",
8113
8472
  * "label": {
8114
8473
  * "value": "My Custom Control 0"
8115
8474
  * },
8116
- * "key": "my-custom-toggle-button-0"
8475
+ * "key": "my-custom-control-0"
8117
8476
  * }
8118
8477
  *
8119
8478
  *
8120
8479
  *
8121
8480
  */
8122
- export interface ToggleButtonControl {
8123
- macroParameterValue: string;
8481
+ export interface ButtonControl {
8124
8482
  label: I18NProperty75;
8125
- type: 'togglebutton' | 'TOGGLEBUTTON';
8483
+ type: 'button' | 'BUTTON';
8126
8484
  key: string;
8127
8485
  [k: string]: unknown;
8128
8486
  }
@@ -8153,7 +8511,7 @@ export interface I18NProperty75 {
8153
8511
  /**
8154
8512
  *
8155
8513
  *
8156
- * Defines a text field which may appear in control extension points such as the property panel
8514
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
8157
8515
  *
8158
8516
  * <p><b>Example</b></p>
8159
8517
  *
@@ -8161,27 +8519,44 @@ export interface I18NProperty75 {
8161
8519
  *
8162
8520
  *
8163
8521
  *
8164
- * {
8165
- * "type": "button",
8166
- * "label": {
8167
- * "value": "My Custom Control 0"
8168
- * },
8169
- * "key": "my-custom-control-0"
8170
- * }
8522
+ * [
8523
+ * {
8524
+ * "type": "togglegroup",
8525
+ * "macroParameter": "toggleGroupMacroParameter",
8526
+ * "controls": [
8527
+ * {
8528
+ * "type": "togglebutton",
8529
+ * "macroParameterValue": "macroParameterValue 0",
8530
+ * "label": {
8531
+ * "value": "My Custom Control 0"
8532
+ * },
8533
+ * "key": "my-custom-toggle-button-0"
8534
+ * },
8535
+ * {
8536
+ * "type": "togglebutton",
8537
+ * "macroParameterValue": "macroParameterValue 1",
8538
+ * "label": {
8539
+ * "value": "My Custom Control 1"
8540
+ * },
8541
+ * "key": "my-custom-toggle-button-1"
8542
+ * }
8543
+ * ]
8544
+ * }
8545
+ * ]
8171
8546
  *
8172
8547
  *
8173
8548
  *
8174
8549
  */
8175
- export interface TextControl {
8550
+ export interface ToggleGroup {
8551
+ controls: ToggleButtonControl[];
8176
8552
  macroParameter: string;
8177
- type: 'text' | 'TEXT';
8178
- key: string;
8553
+ type: 'togglegroup' | 'TOGGLEGROUP';
8179
8554
  [k: string]: unknown;
8180
8555
  }
8181
8556
  /**
8182
8557
  *
8183
8558
  *
8184
- * Defines a button which may appear in control extension points such as the property panel
8559
+ * Defines a toggle button which appears inside a ToggleGroup
8185
8560
  *
8186
8561
  * <p><b>Example</b></p>
8187
8562
  *
@@ -8190,19 +8565,21 @@ export interface TextControl {
8190
8565
  *
8191
8566
  *
8192
8567
  * {
8193
- * "type": "button",
8568
+ * "type": "togglebutton",
8569
+ * "macroParameterValue": "macroParameterValue 0",
8194
8570
  * "label": {
8195
8571
  * "value": "My Custom Control 0"
8196
8572
  * },
8197
- * "key": "my-custom-control-0"
8573
+ * "key": "my-custom-toggle-button-0"
8198
8574
  * }
8199
8575
  *
8200
8576
  *
8201
8577
  *
8202
8578
  */
8203
- export interface ButtonControl {
8579
+ export interface ToggleButtonControl {
8580
+ macroParameterValue: string;
8204
8581
  label: I18NProperty76;
8205
- type: 'button' | 'BUTTON';
8582
+ type: 'togglebutton' | 'TOGGLEBUTTON';
8206
8583
  key: string;
8207
8584
  [k: string]: unknown;
8208
8585
  }
@@ -8323,6 +8700,34 @@ export interface I18NProperty77 {
8323
8700
  i18n?: string;
8324
8701
  [k: string]: unknown;
8325
8702
  }
8703
+ /**
8704
+ *
8705
+ *
8706
+ * Defines a text field which may appear in control extension points such as the property panel
8707
+ *
8708
+ * <p><b>Example</b></p>
8709
+ *
8710
+ *
8711
+ *
8712
+ *
8713
+ *
8714
+ * {
8715
+ * "type": "button",
8716
+ * "label": {
8717
+ * "value": "My Custom Control 0"
8718
+ * },
8719
+ * "key": "my-custom-control-0"
8720
+ * }
8721
+ *
8722
+ *
8723
+ *
8724
+ */
8725
+ export interface TextControl {
8726
+ macroParameter: string;
8727
+ type: 'text' | 'TEXT';
8728
+ key: string;
8729
+ [k: string]: unknown;
8730
+ }
8326
8731
  /**
8327
8732
  *
8328
8733
  *
@@ -29245,57 +29650,156 @@ export interface Icon17 {
29245
29650
  *
29246
29651
  *
29247
29652
  */
29248
- export interface I18NProperty83 {
29653
+ export interface I18NProperty83 {
29654
+ value: string;
29655
+ i18n?: string;
29656
+ [k: string]: unknown;
29657
+ }
29658
+ /**
29659
+ *
29660
+ *
29661
+ * Defining a Macro Property panel allows you to add a hidden iframe to your macro's
29662
+ * property panel. The iframe is loaded as soon as the property panel is opened.
29663
+ *
29664
+ * In order to persist custom data using your property panel, use the Javascript
29665
+ * <a href="../../jsapi/confluence/">Confluence API</a>.
29666
+ * For example:
29667
+ *
29668
+ * AP.require(["confluence"], function (confluence) {
29669
+ * var macroParams = {
29670
+ * myParameter: value
29671
+ * };
29672
+ * confluence.saveMacro(macroParams);
29673
+ * });
29674
+ *
29675
+ * In order to retrieve the custom data again when the property panel is opened, use `confluence.getMacroData` (see
29676
+ * <a href="../../jsapi/confluence/">Confluence API</a>):
29677
+ *
29678
+ * AP.require("confluence", function (confluence) {
29679
+ * var macroData = confluence.getMacroData(function(macroParams) {
29680
+ * doSomethingWith(macroParams.myParameter);
29681
+ * });
29682
+ * });
29683
+ *
29684
+ * Dialogs may also be created. Use `dialog.create` (see
29685
+ * <a href="../../jsapi/dialog/">Dialog API</a>):
29686
+ *
29687
+ * AP.require('dialog', function(dialog) {
29688
+ * dialog.create({
29689
+ * key: 'my-module-key',
29690
+ * width: '500px',
29691
+ * height: '200px',
29692
+ * chrome: true
29693
+ * }).on("close", callbackFunc);
29694
+ * });
29695
+ *
29696
+ *
29697
+ */
29698
+ export interface MacroPropertyPanel1 {
29699
+ controls?: (ToggleGroup1 | TextControl1 | ControlGroup1 | ButtonControl3)[];
29700
+ cacheable?: boolean;
29701
+ url: string;
29702
+ [k: string]: unknown;
29703
+ }
29704
+ /**
29705
+ *
29706
+ *
29707
+ * Defines a ToggleGroup which may appear in control extension points such as the property panel
29708
+ *
29709
+ * <p><b>Example</b></p>
29710
+ *
29711
+ *
29712
+ *
29713
+ *
29714
+ *
29715
+ * [
29716
+ * {
29717
+ * "type": "togglegroup",
29718
+ * "macroParameter": "toggleGroupMacroParameter",
29719
+ * "controls": [
29720
+ * {
29721
+ * "type": "togglebutton",
29722
+ * "macroParameterValue": "macroParameterValue 0",
29723
+ * "label": {
29724
+ * "value": "My Custom Control 0"
29725
+ * },
29726
+ * "key": "my-custom-toggle-button-0"
29727
+ * },
29728
+ * {
29729
+ * "type": "togglebutton",
29730
+ * "macroParameterValue": "macroParameterValue 1",
29731
+ * "label": {
29732
+ * "value": "My Custom Control 1"
29733
+ * },
29734
+ * "key": "my-custom-toggle-button-1"
29735
+ * }
29736
+ * ]
29737
+ * }
29738
+ * ]
29739
+ *
29740
+ *
29741
+ *
29742
+ */
29743
+ export interface ToggleGroup1 {
29744
+ controls: ToggleButtonControl1[];
29745
+ macroParameter: string;
29746
+ type: 'togglegroup' | 'TOGGLEGROUP';
29747
+ [k: string]: unknown;
29748
+ }
29749
+ /**
29750
+ *
29751
+ *
29752
+ * Defines a toggle button which appears inside a ToggleGroup
29753
+ *
29754
+ * <p><b>Example</b></p>
29755
+ *
29756
+ *
29757
+ *
29758
+ *
29759
+ *
29760
+ * {
29761
+ * "type": "togglebutton",
29762
+ * "macroParameterValue": "macroParameterValue 0",
29763
+ * "label": {
29764
+ * "value": "My Custom Control 0"
29765
+ * },
29766
+ * "key": "my-custom-toggle-button-0"
29767
+ * }
29768
+ *
29769
+ *
29770
+ *
29771
+ */
29772
+ export interface ToggleButtonControl1 {
29773
+ macroParameterValue: string;
29774
+ label: I18NProperty84;
29775
+ type: 'togglebutton' | 'TOGGLEBUTTON';
29776
+ key: string;
29777
+ [k: string]: unknown;
29778
+ }
29779
+ /**
29780
+ *
29781
+ *
29782
+ * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
29783
+ * and value in multiple places if you like, but identical keys must have identical values.
29784
+ *
29785
+ * <h3>Example</h3>
29786
+ *
29787
+ *
29788
+ *
29789
+ *
29790
+ *
29791
+ * {
29792
+ * "value": "My text"
29793
+ * }
29794
+ *
29795
+ *
29796
+ *
29797
+ */
29798
+ export interface I18NProperty84 {
29249
29799
  value: string;
29250
29800
  i18n?: string;
29251
29801
  [k: string]: unknown;
29252
29802
  }
29253
- /**
29254
- *
29255
- *
29256
- * Defining a Macro Property panel allows you to add a hidden iframe to your macro's
29257
- * property panel. The iframe is loaded as soon as the property panel is opened.
29258
- *
29259
- * In order to persist custom data using your property panel, use the Javascript
29260
- * <a href="../../jsapi/confluence/">Confluence API</a>.
29261
- * For example:
29262
- *
29263
- * AP.require(["confluence"], function (confluence) {
29264
- * var macroParams = {
29265
- * myParameter: value
29266
- * };
29267
- * confluence.saveMacro(macroParams);
29268
- * });
29269
- *
29270
- * In order to retrieve the custom data again when the property panel is opened, use `confluence.getMacroData` (see
29271
- * <a href="../../jsapi/confluence/">Confluence API</a>):
29272
- *
29273
- * AP.require("confluence", function (confluence) {
29274
- * var macroData = confluence.getMacroData(function(macroParams) {
29275
- * doSomethingWith(macroParams.myParameter);
29276
- * });
29277
- * });
29278
- *
29279
- * Dialogs may also be created. Use `dialog.create` (see
29280
- * <a href="../../jsapi/dialog/">Dialog API</a>):
29281
- *
29282
- * AP.require('dialog', function(dialog) {
29283
- * dialog.create({
29284
- * key: 'my-module-key',
29285
- * width: '500px',
29286
- * height: '200px',
29287
- * chrome: true
29288
- * }).on("close", callbackFunc);
29289
- * });
29290
- *
29291
- *
29292
- */
29293
- export interface MacroPropertyPanel1 {
29294
- controls?: (TextControl1 | ButtonControl2 | ToggleGroup1 | ControlGroup1)[];
29295
- cacheable?: boolean;
29296
- url: string;
29297
- [k: string]: unknown;
29298
- }
29299
29803
  /**
29300
29804
  *
29301
29805
  *
@@ -29327,59 +29831,7 @@ export interface TextControl1 {
29327
29831
  /**
29328
29832
  *
29329
29833
  *
29330
- * Defines a button which may appear in control extension points such as the property panel
29331
- *
29332
- * <p><b>Example</b></p>
29333
- *
29334
- *
29335
- *
29336
- *
29337
- *
29338
- * {
29339
- * "type": "button",
29340
- * "label": {
29341
- * "value": "My Custom Control 0"
29342
- * },
29343
- * "key": "my-custom-control-0"
29344
- * }
29345
- *
29346
- *
29347
- *
29348
- */
29349
- export interface ButtonControl2 {
29350
- label: I18NProperty84;
29351
- type: 'button' | 'BUTTON';
29352
- key: string;
29353
- [k: string]: unknown;
29354
- }
29355
- /**
29356
- *
29357
- *
29358
- * Represents a string that can be resolved via a localization properties file. You can use the same `i18n Property` key
29359
- * and value in multiple places if you like, but identical keys must have identical values.
29360
- *
29361
- * <h3>Example</h3>
29362
- *
29363
- *
29364
- *
29365
- *
29366
- *
29367
- * {
29368
- * "value": "My text"
29369
- * }
29370
- *
29371
- *
29372
- *
29373
- */
29374
- export interface I18NProperty84 {
29375
- value: string;
29376
- i18n?: string;
29377
- [k: string]: unknown;
29378
- }
29379
- /**
29380
- *
29381
- *
29382
- * Defines a ToggleGroup which may appear in control extension points such as the property panel
29834
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
29383
29835
  *
29384
29836
  * <p><b>Example</b></p>
29385
29837
  *
@@ -29389,24 +29841,21 @@ export interface I18NProperty84 {
29389
29841
  *
29390
29842
  * [
29391
29843
  * {
29392
- * "type": "togglegroup",
29393
- * "macroParameter": "toggleGroupMacroParameter",
29844
+ * "type": "group",
29394
29845
  * "controls": [
29395
29846
  * {
29396
- * "type": "togglebutton",
29397
- * "macroParameterValue": "macroParameterValue 0",
29847
+ * "type": "button",
29398
29848
  * "label": {
29399
29849
  * "value": "My Custom Control 0"
29400
29850
  * },
29401
- * "key": "my-custom-toggle-button-0"
29851
+ * "key": "my-custom-control-0"
29402
29852
  * },
29403
29853
  * {
29404
- * "type": "togglebutton",
29405
- * "macroParameterValue": "macroParameterValue 1",
29854
+ * "type": "button",
29406
29855
  * "label": {
29407
29856
  * "value": "My Custom Control 1"
29408
29857
  * },
29409
- * "key": "my-custom-toggle-button-1"
29858
+ * "key": "my-custom-control-1"
29410
29859
  * }
29411
29860
  * ]
29412
29861
  * }
@@ -29415,16 +29864,15 @@ export interface I18NProperty84 {
29415
29864
  *
29416
29865
  *
29417
29866
  */
29418
- export interface ToggleGroup1 {
29419
- controls: ToggleButtonControl1[];
29420
- macroParameter: string;
29421
- type: 'togglegroup' | 'TOGGLEGROUP';
29867
+ export interface ControlGroup1 {
29868
+ controls: ButtonControl2[];
29869
+ type: 'group' | 'GROUP';
29422
29870
  [k: string]: unknown;
29423
29871
  }
29424
29872
  /**
29425
29873
  *
29426
29874
  *
29427
- * Defines a toggle button which appears inside a ToggleGroup
29875
+ * Defines a button which may appear in control extension points such as the property panel
29428
29876
  *
29429
29877
  * <p><b>Example</b></p>
29430
29878
  *
@@ -29433,21 +29881,19 @@ export interface ToggleGroup1 {
29433
29881
  *
29434
29882
  *
29435
29883
  * {
29436
- * "type": "togglebutton",
29437
- * "macroParameterValue": "macroParameterValue 0",
29884
+ * "type": "button",
29438
29885
  * "label": {
29439
29886
  * "value": "My Custom Control 0"
29440
29887
  * },
29441
- * "key": "my-custom-toggle-button-0"
29888
+ * "key": "my-custom-control-0"
29442
29889
  * }
29443
29890
  *
29444
29891
  *
29445
29892
  *
29446
29893
  */
29447
- export interface ToggleButtonControl1 {
29448
- macroParameterValue: string;
29894
+ export interface ButtonControl2 {
29449
29895
  label: I18NProperty85;
29450
- type: 'togglebutton' | 'TOGGLEBUTTON';
29896
+ type: 'button' | 'BUTTON';
29451
29897
  key: string;
29452
29898
  [k: string]: unknown;
29453
29899
  }
@@ -29475,47 +29921,6 @@ export interface I18NProperty85 {
29475
29921
  i18n?: string;
29476
29922
  [k: string]: unknown;
29477
29923
  }
29478
- /**
29479
- *
29480
- *
29481
- * Defines a ControlGroup which may appear in control extension points such as the property panel
29482
- *
29483
- * <p><b>Example</b></p>
29484
- *
29485
- *
29486
- *
29487
- *
29488
- *
29489
- * [
29490
- * {
29491
- * "type": "group",
29492
- * "controls": [
29493
- * {
29494
- * "type": "button",
29495
- * "label": {
29496
- * "value": "My Custom Control 0"
29497
- * },
29498
- * "key": "my-custom-control-0"
29499
- * },
29500
- * {
29501
- * "type": "button",
29502
- * "label": {
29503
- * "value": "My Custom Control 1"
29504
- * },
29505
- * "key": "my-custom-control-1"
29506
- * }
29507
- * ]
29508
- * }
29509
- * ]
29510
- *
29511
- *
29512
- *
29513
- */
29514
- export interface ControlGroup1 {
29515
- controls: ButtonControl3[];
29516
- type: 'group' | 'GROUP';
29517
- [k: string]: unknown;
29518
- }
29519
29924
  /**
29520
29925
  *
29521
29926
  *
@@ -50417,47 +50822,10 @@ export interface I18NProperty91 {
50417
50822
  *
50418
50823
  */
50419
50824
  export interface WebItemTarget2 {
50420
- options?: InlineDialogOptions2 | DialogModuleOptions2 | DialogOptions4;
50825
+ options?: DialogModuleOptions2 | DialogOptions4 | InlineDialogOptions2;
50421
50826
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
50422
50827
  [k: string]: unknown;
50423
50828
  }
50424
- /**
50425
- *
50426
- *
50427
- * Options for an inline dialog target
50428
- *
50429
- * <h3>Example</h3>
50430
- *
50431
- *
50432
- *
50433
- *
50434
- *
50435
- * {
50436
- * "target": {
50437
- * "type": "inlinedialog",
50438
- * "options": {
50439
- * "onHover": true,
50440
- * "offsetX": "30px",
50441
- * "offsetY": "20px"
50442
- * }
50443
- * }
50444
- * }
50445
- *
50446
- *
50447
- *
50448
- */
50449
- export interface InlineDialogOptions2 {
50450
- offsetX?: string;
50451
- offsetY?: string;
50452
- width?: string;
50453
- onTop?: boolean;
50454
- showDelay?: number;
50455
- closeOthers?: boolean;
50456
- persistent?: boolean;
50457
- onHover?: boolean;
50458
- isRelativeToMouse?: boolean;
50459
- [k: string]: unknown;
50460
- }
50461
50829
  /**
50462
50830
  *
50463
50831
  *
@@ -50583,6 +50951,43 @@ export interface I18NProperty92 {
50583
50951
  i18n?: string;
50584
50952
  [k: string]: unknown;
50585
50953
  }
50954
+ /**
50955
+ *
50956
+ *
50957
+ * Options for an inline dialog target
50958
+ *
50959
+ * <h3>Example</h3>
50960
+ *
50961
+ *
50962
+ *
50963
+ *
50964
+ *
50965
+ * {
50966
+ * "target": {
50967
+ * "type": "inlinedialog",
50968
+ * "options": {
50969
+ * "onHover": true,
50970
+ * "offsetX": "30px",
50971
+ * "offsetY": "20px"
50972
+ * }
50973
+ * }
50974
+ * }
50975
+ *
50976
+ *
50977
+ *
50978
+ */
50979
+ export interface InlineDialogOptions2 {
50980
+ offsetX?: string;
50981
+ offsetY?: string;
50982
+ width?: string;
50983
+ onTop?: boolean;
50984
+ showDelay?: number;
50985
+ closeOthers?: boolean;
50986
+ persistent?: boolean;
50987
+ onHover?: boolean;
50988
+ isRelativeToMouse?: boolean;
50989
+ [k: string]: unknown;
50990
+ }
50586
50991
  /**
50587
50992
  *
50588
50993
  *
@@ -51369,6 +51774,12 @@ export interface Fetch {
51369
51774
  export interface Remote {
51370
51775
  remote: string;
51371
51776
  }
51777
+ /**
51778
+ * References a Remote
51779
+ */
51780
+ export interface Remote1 {
51781
+ remote: string;
51782
+ }
51372
51783
  export interface HostedResourcesSchema {
51373
51784
  /**
51374
51785
  * A key for the resource, which other modules can refer to. Must be unique within the manifest and have a maximum of 23 characters.
@@ -51396,22 +51807,10 @@ export interface AuthProviderCustom {
51396
51807
  */
51397
51808
  name: string;
51398
51809
  type: 'oauth2';
51399
- bearerMethod?:
51400
- | ('authorization-header' | 'form-encoded' | 'uri-query')
51401
- | {
51402
- type: 'authorization-header' | 'form-encoded' | 'uri-query';
51403
- /**
51404
- * Custom authorization header prefix
51405
- */
51406
- prefix?: string;
51407
- /**
51408
- * Custom Header name or Parameter name (depending on type)
51409
- */
51410
- parameter?: string;
51411
- };
51810
+ bearerMethod: BearerMethodSchema;
51412
51811
  clientId: string;
51413
51812
  scopes?: string[];
51414
- remotes?: ModuleKeySchema[];
51813
+ remotes: ModuleKeySchema[];
51415
51814
  actions: {
51416
51815
  authorization: AuthorizeActionDefinition;
51417
51816
  exchange: ExchangeActionDefinition;
@@ -51491,7 +51890,12 @@ export interface AuthProviderPredefined {
51491
51890
  * Name shown to end users
51492
51891
  */
51493
51892
  name: string;
51893
+ /**
51894
+ * Pre-defined integration name
51895
+ */
51494
51896
  integration: 'adobe' | 'azuredevops' | 'dropbox' | 'google' | 'miro';
51897
+ bearerMethod: BearerMethodSchema;
51495
51898
  clientId: string;
51496
51899
  scopes?: string[];
51900
+ remotes: ModuleKeySchema[];
51497
51901
  }