@forge/manifest 2.4.0 → 2.5.0-next.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +25 -0
- package/out/mapping/product-event-to-scope-mapping.json +18 -0
- package/out/schema/display-conditions-schema.json +42 -0
- package/out/schema/manifest-schema.json +325 -135
- package/out/schema/manifest.d.ts +238 -150
- package/out/types/display-condition-types.d.ts +8 -0
- package/out/types/display-condition-types.d.ts.map +1 -1
- package/out/types/module-types.d.ts +2 -0
- package/out/types/module-types.d.ts.map +1 -1
- package/out/types/module-types.js +2 -0
- package/out/validators/modules-validator.d.ts.map +1 -1
- package/out/validators/modules-validator.js +6 -1
- package/package.json +1 -1
|
@@ -2488,6 +2488,196 @@
|
|
|
2488
2488
|
},
|
|
2489
2489
|
"minItems": 1
|
|
2490
2490
|
},
|
|
2491
|
+
"jira:globalPage": {
|
|
2492
|
+
"type": "array",
|
|
2493
|
+
"items": {
|
|
2494
|
+
"oneOf": [
|
|
2495
|
+
{
|
|
2496
|
+
"type": "object",
|
|
2497
|
+
"properties": {
|
|
2498
|
+
"function": {
|
|
2499
|
+
"type": "string",
|
|
2500
|
+
"minLength": 1,
|
|
2501
|
+
"maxLength": 255,
|
|
2502
|
+
"pattern": "^[a-zA-Z0-9-_]+$"
|
|
2503
|
+
},
|
|
2504
|
+
"title": {
|
|
2505
|
+
"minLength": 1,
|
|
2506
|
+
"maxLength": 255,
|
|
2507
|
+
"type": "string"
|
|
2508
|
+
},
|
|
2509
|
+
"icon": {
|
|
2510
|
+
"type": "string",
|
|
2511
|
+
"minLength": 1,
|
|
2512
|
+
"maxLength": 255
|
|
2513
|
+
},
|
|
2514
|
+
"layout": {
|
|
2515
|
+
"enum": [
|
|
2516
|
+
"basic",
|
|
2517
|
+
"native"
|
|
2518
|
+
],
|
|
2519
|
+
"type": "string"
|
|
2520
|
+
},
|
|
2521
|
+
"key": {
|
|
2522
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
2523
|
+
}
|
|
2524
|
+
},
|
|
2525
|
+
"required": [
|
|
2526
|
+
"function",
|
|
2527
|
+
"title",
|
|
2528
|
+
"key"
|
|
2529
|
+
]
|
|
2530
|
+
},
|
|
2531
|
+
{
|
|
2532
|
+
"type": "object",
|
|
2533
|
+
"properties": {
|
|
2534
|
+
"resource": {
|
|
2535
|
+
"type": "string",
|
|
2536
|
+
"minLength": 1,
|
|
2537
|
+
"maxLength": 23,
|
|
2538
|
+
"pattern": "^[a-zA-Z0-9_\\-]+$"
|
|
2539
|
+
},
|
|
2540
|
+
"resolver": {
|
|
2541
|
+
"additionalProperties": false,
|
|
2542
|
+
"type": "object",
|
|
2543
|
+
"properties": {
|
|
2544
|
+
"function": {
|
|
2545
|
+
"type": "string",
|
|
2546
|
+
"minLength": 1,
|
|
2547
|
+
"maxLength": 255,
|
|
2548
|
+
"pattern": "^[a-zA-Z0-9-_]+$"
|
|
2549
|
+
}
|
|
2550
|
+
},
|
|
2551
|
+
"required": [
|
|
2552
|
+
"function"
|
|
2553
|
+
]
|
|
2554
|
+
},
|
|
2555
|
+
"title": {
|
|
2556
|
+
"minLength": 1,
|
|
2557
|
+
"maxLength": 255,
|
|
2558
|
+
"type": "string"
|
|
2559
|
+
},
|
|
2560
|
+
"icon": {
|
|
2561
|
+
"type": "string",
|
|
2562
|
+
"minLength": 1,
|
|
2563
|
+
"maxLength": 255
|
|
2564
|
+
},
|
|
2565
|
+
"layout": {
|
|
2566
|
+
"enum": [
|
|
2567
|
+
"basic",
|
|
2568
|
+
"native"
|
|
2569
|
+
],
|
|
2570
|
+
"type": "string"
|
|
2571
|
+
},
|
|
2572
|
+
"key": {
|
|
2573
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
2574
|
+
}
|
|
2575
|
+
},
|
|
2576
|
+
"required": [
|
|
2577
|
+
"resource",
|
|
2578
|
+
"title",
|
|
2579
|
+
"key"
|
|
2580
|
+
]
|
|
2581
|
+
}
|
|
2582
|
+
]
|
|
2583
|
+
},
|
|
2584
|
+
"minItems": 1
|
|
2585
|
+
},
|
|
2586
|
+
"jira:projectSettingsPage": {
|
|
2587
|
+
"type": "array",
|
|
2588
|
+
"items": {
|
|
2589
|
+
"oneOf": [
|
|
2590
|
+
{
|
|
2591
|
+
"type": "object",
|
|
2592
|
+
"properties": {
|
|
2593
|
+
"function": {
|
|
2594
|
+
"type": "string",
|
|
2595
|
+
"minLength": 1,
|
|
2596
|
+
"maxLength": 255,
|
|
2597
|
+
"pattern": "^[a-zA-Z0-9-_]+$"
|
|
2598
|
+
},
|
|
2599
|
+
"title": {
|
|
2600
|
+
"minLength": 1,
|
|
2601
|
+
"maxLength": 255,
|
|
2602
|
+
"type": "string"
|
|
2603
|
+
},
|
|
2604
|
+
"icon": {
|
|
2605
|
+
"type": "string",
|
|
2606
|
+
"minLength": 1,
|
|
2607
|
+
"maxLength": 255
|
|
2608
|
+
},
|
|
2609
|
+
"layout": {
|
|
2610
|
+
"enum": [
|
|
2611
|
+
"basic",
|
|
2612
|
+
"native"
|
|
2613
|
+
],
|
|
2614
|
+
"type": "string"
|
|
2615
|
+
},
|
|
2616
|
+
"key": {
|
|
2617
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
2618
|
+
}
|
|
2619
|
+
},
|
|
2620
|
+
"required": [
|
|
2621
|
+
"function",
|
|
2622
|
+
"title",
|
|
2623
|
+
"key"
|
|
2624
|
+
]
|
|
2625
|
+
},
|
|
2626
|
+
{
|
|
2627
|
+
"type": "object",
|
|
2628
|
+
"properties": {
|
|
2629
|
+
"resource": {
|
|
2630
|
+
"type": "string",
|
|
2631
|
+
"minLength": 1,
|
|
2632
|
+
"maxLength": 23,
|
|
2633
|
+
"pattern": "^[a-zA-Z0-9_\\-]+$"
|
|
2634
|
+
},
|
|
2635
|
+
"resolver": {
|
|
2636
|
+
"additionalProperties": false,
|
|
2637
|
+
"type": "object",
|
|
2638
|
+
"properties": {
|
|
2639
|
+
"function": {
|
|
2640
|
+
"type": "string",
|
|
2641
|
+
"minLength": 1,
|
|
2642
|
+
"maxLength": 255,
|
|
2643
|
+
"pattern": "^[a-zA-Z0-9-_]+$"
|
|
2644
|
+
}
|
|
2645
|
+
},
|
|
2646
|
+
"required": [
|
|
2647
|
+
"function"
|
|
2648
|
+
]
|
|
2649
|
+
},
|
|
2650
|
+
"title": {
|
|
2651
|
+
"minLength": 1,
|
|
2652
|
+
"maxLength": 255,
|
|
2653
|
+
"type": "string"
|
|
2654
|
+
},
|
|
2655
|
+
"icon": {
|
|
2656
|
+
"type": "string",
|
|
2657
|
+
"minLength": 1,
|
|
2658
|
+
"maxLength": 255
|
|
2659
|
+
},
|
|
2660
|
+
"layout": {
|
|
2661
|
+
"enum": [
|
|
2662
|
+
"basic",
|
|
2663
|
+
"native"
|
|
2664
|
+
],
|
|
2665
|
+
"type": "string"
|
|
2666
|
+
},
|
|
2667
|
+
"key": {
|
|
2668
|
+
"$ref": "#/definitions/ModuleKeySchema"
|
|
2669
|
+
}
|
|
2670
|
+
},
|
|
2671
|
+
"required": [
|
|
2672
|
+
"resource",
|
|
2673
|
+
"title",
|
|
2674
|
+
"key"
|
|
2675
|
+
]
|
|
2676
|
+
}
|
|
2677
|
+
]
|
|
2678
|
+
},
|
|
2679
|
+
"minItems": 1
|
|
2680
|
+
},
|
|
2491
2681
|
"compass:adminPage": {
|
|
2492
2682
|
"type": "array",
|
|
2493
2683
|
"items": {
|
|
@@ -5292,10 +5482,10 @@
|
|
|
5292
5482
|
"type": "object",
|
|
5293
5483
|
"anyOf": [
|
|
5294
5484
|
{
|
|
5295
|
-
"$ref": "#/definitions/
|
|
5485
|
+
"$ref": "#/definitions/compositeCondition"
|
|
5296
5486
|
},
|
|
5297
5487
|
{
|
|
5298
|
-
"$ref": "#/definitions/
|
|
5488
|
+
"$ref": "#/definitions/singleCondition"
|
|
5299
5489
|
}
|
|
5300
5490
|
]
|
|
5301
5491
|
},
|
|
@@ -5545,6 +5735,22 @@
|
|
|
5545
5735
|
"type": "object",
|
|
5546
5736
|
"fieldDescription": "\n\n<p>An object containing options which vary based on the type of web item target you are implementing.</p>\n\n <p>Currently-allowed options are:</p>\n <ul>\n <li><a href=\"../inline-dialog-options/\">Inline Dialog Options</a> when type is \"inlinedialog\", and</li>\n <li><a href=\"../dialog-options/\">Dialog Options</a> when type is \"dialog\"</li>\n <li><a href=\"../dialog-module-options/\">Dialog Module Options</a> when type is \"dialogmodule\"</li>\n </ul>\n\n",
|
|
5547
5737
|
"anyOf": [
|
|
5738
|
+
{
|
|
5739
|
+
"properties": {
|
|
5740
|
+
"key": {
|
|
5741
|
+
"maxLength": 100,
|
|
5742
|
+
"type": "string",
|
|
5743
|
+
"fieldDescription": "\n\n<p>The key of a <a href=\"../dialog/\">Dialog</a> module declared in this Connect add-on.</p>\n\n <p>\n The dialog module will include the <a href=\"../dialog-options/\">Dialog Options</a>\n that would otherwise need to be specified directly in this options object.\n </p>\n\n"
|
|
5744
|
+
}
|
|
5745
|
+
},
|
|
5746
|
+
"required": [
|
|
5747
|
+
"key"
|
|
5748
|
+
],
|
|
5749
|
+
"shortClassName": "dialogModuleOptions",
|
|
5750
|
+
"type": "object",
|
|
5751
|
+
"title": "Dialog Module Options",
|
|
5752
|
+
"description": "\n\nOptions for a web-item targeting a common <a href=\"../dialog/\">dialog module</a>.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n"
|
|
5753
|
+
},
|
|
5548
5754
|
{
|
|
5549
5755
|
"properties": {
|
|
5550
5756
|
"size": {
|
|
@@ -5636,22 +5842,6 @@
|
|
|
5636
5842
|
"type": "object",
|
|
5637
5843
|
"title": "Inline Dialog Options",
|
|
5638
5844
|
"description": "\n\nOptions for an inline dialog target\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"inlinedialog\",\n \"options\": {\n \"onHover\": true,\n \"offsetX\": \"30px\",\n \"offsetY\": \"20px\"\n }\n }\n }\n\n\n"
|
|
5639
|
-
},
|
|
5640
|
-
{
|
|
5641
|
-
"properties": {
|
|
5642
|
-
"key": {
|
|
5643
|
-
"maxLength": 100,
|
|
5644
|
-
"type": "string",
|
|
5645
|
-
"fieldDescription": "\n\n<p>The key of a <a href=\"../dialog/\">Dialog</a> module declared in this Connect add-on.</p>\n\n <p>\n The dialog module will include the <a href=\"../dialog-options/\">Dialog Options</a>\n that would otherwise need to be specified directly in this options object.\n </p>\n\n"
|
|
5646
|
-
}
|
|
5647
|
-
},
|
|
5648
|
-
"required": [
|
|
5649
|
-
"key"
|
|
5650
|
-
],
|
|
5651
|
-
"shortClassName": "dialogModuleOptions",
|
|
5652
|
-
"type": "object",
|
|
5653
|
-
"title": "Dialog Module Options",
|
|
5654
|
-
"description": "\n\nOptions for a web-item targeting a common <a href=\"../dialog/\">dialog module</a>.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n"
|
|
5655
5845
|
}
|
|
5656
5846
|
]
|
|
5657
5847
|
},
|
|
@@ -6303,38 +6493,6 @@
|
|
|
6303
6493
|
"items": {
|
|
6304
6494
|
"type": "object",
|
|
6305
6495
|
"anyOf": [
|
|
6306
|
-
{
|
|
6307
|
-
"properties": {
|
|
6308
|
-
"macroParameter": {
|
|
6309
|
-
"maxLength": 100,
|
|
6310
|
-
"type": "string",
|
|
6311
|
-
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6312
|
-
},
|
|
6313
|
-
"type": {
|
|
6314
|
-
"enum": [
|
|
6315
|
-
"text",
|
|
6316
|
-
"TEXT"
|
|
6317
|
-
],
|
|
6318
|
-
"type": "string",
|
|
6319
|
-
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6320
|
-
},
|
|
6321
|
-
"key": {
|
|
6322
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6323
|
-
"maxLength": 100,
|
|
6324
|
-
"type": "string",
|
|
6325
|
-
"fieldDescription": "\n\nA key to identify this module.\n\n This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be\n globally unique.\n\n Keys must only contain alphanumeric characters and dashes.\n\n The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on\n key and module key. For example, an add-on which looks like:\n\n {\n \"key\": \"my-addon\",\n \"modules\": {\n \"configurePage\": {\n \"key\": \"configure-me\",\n }\n }\n }\n\n Will have a configuration page module with a URL of `/plugins/servlet/ac/my-addon/configure-me`.\n\n"
|
|
6326
|
-
}
|
|
6327
|
-
},
|
|
6328
|
-
"required": [
|
|
6329
|
-
"macroParameter",
|
|
6330
|
-
"type",
|
|
6331
|
-
"key"
|
|
6332
|
-
],
|
|
6333
|
-
"shortClassName": "textControlBean",
|
|
6334
|
-
"type": "object",
|
|
6335
|
-
"title": "TextControl",
|
|
6336
|
-
"description": "\n\nDefines a text field which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
|
|
6337
|
-
},
|
|
6338
6496
|
{
|
|
6339
6497
|
"properties": {
|
|
6340
6498
|
"controls": {
|
|
@@ -6423,6 +6581,38 @@
|
|
|
6423
6581
|
"title": "ButtonControl",
|
|
6424
6582
|
"description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
|
|
6425
6583
|
},
|
|
6584
|
+
{
|
|
6585
|
+
"properties": {
|
|
6586
|
+
"macroParameter": {
|
|
6587
|
+
"maxLength": 100,
|
|
6588
|
+
"type": "string",
|
|
6589
|
+
"fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
|
|
6590
|
+
},
|
|
6591
|
+
"type": {
|
|
6592
|
+
"enum": [
|
|
6593
|
+
"text",
|
|
6594
|
+
"TEXT"
|
|
6595
|
+
],
|
|
6596
|
+
"type": "string",
|
|
6597
|
+
"fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
|
|
6598
|
+
},
|
|
6599
|
+
"key": {
|
|
6600
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6601
|
+
"maxLength": 100,
|
|
6602
|
+
"type": "string",
|
|
6603
|
+
"fieldDescription": "\n\nA key to identify this module.\n\n This key must be unique relative to the add on, with the exception of Confluence macros: Their keys need to be\n globally unique.\n\n Keys must only contain alphanumeric characters and dashes.\n\n The key is used to generate the url to your add-on's module. The url is generated as a combination of your add-on\n key and module key. For example, an add-on which looks like:\n\n {\n \"key\": \"my-addon\",\n \"modules\": {\n \"configurePage\": {\n \"key\": \"configure-me\",\n }\n }\n }\n\n Will have a configuration page module with a URL of `/plugins/servlet/ac/my-addon/configure-me`.\n\n"
|
|
6604
|
+
}
|
|
6605
|
+
},
|
|
6606
|
+
"required": [
|
|
6607
|
+
"macroParameter",
|
|
6608
|
+
"type",
|
|
6609
|
+
"key"
|
|
6610
|
+
],
|
|
6611
|
+
"shortClassName": "textControlBean",
|
|
6612
|
+
"type": "object",
|
|
6613
|
+
"title": "TextControl",
|
|
6614
|
+
"description": "\n\nDefines a text field which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
|
|
6615
|
+
},
|
|
6426
6616
|
{
|
|
6427
6617
|
"properties": {
|
|
6428
6618
|
"controls": {
|
|
@@ -6817,6 +7007,75 @@
|
|
|
6817
7007
|
"title": "ButtonControl",
|
|
6818
7008
|
"description": "\n\nDefines a button which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n }\n\n\n"
|
|
6819
7009
|
},
|
|
7010
|
+
{
|
|
7011
|
+
"properties": {
|
|
7012
|
+
"controls": {
|
|
7013
|
+
"items": {
|
|
7014
|
+
"properties": {
|
|
7015
|
+
"macroParameterValue": {
|
|
7016
|
+
"maxLength": 10000,
|
|
7017
|
+
"type": "string",
|
|
7018
|
+
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
7019
|
+
},
|
|
7020
|
+
"label": {
|
|
7021
|
+
"$ref": "#/definitions/i18nProperty",
|
|
7022
|
+
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
7023
|
+
},
|
|
7024
|
+
"type": {
|
|
7025
|
+
"enum": [
|
|
7026
|
+
"togglebutton",
|
|
7027
|
+
"TOGGLEBUTTON"
|
|
7028
|
+
],
|
|
7029
|
+
"type": "string",
|
|
7030
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
7031
|
+
},
|
|
7032
|
+
"key": {
|
|
7033
|
+
"pattern": "^[a-zA-Z0-9-]+$",
|
|
7034
|
+
"maxLength": 100,
|
|
7035
|
+
"type": "string",
|
|
7036
|
+
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
7037
|
+
}
|
|
7038
|
+
},
|
|
7039
|
+
"required": [
|
|
7040
|
+
"macroParameterValue",
|
|
7041
|
+
"label",
|
|
7042
|
+
"type",
|
|
7043
|
+
"key"
|
|
7044
|
+
],
|
|
7045
|
+
"additionalProperties": true,
|
|
7046
|
+
"shortClassName": "macroToggleButtonControlBean",
|
|
7047
|
+
"type": "object",
|
|
7048
|
+
"title": "ToggleButtonControl",
|
|
7049
|
+
"description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
|
|
7050
|
+
},
|
|
7051
|
+
"type": "array",
|
|
7052
|
+
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
7053
|
+
},
|
|
7054
|
+
"macroParameter": {
|
|
7055
|
+
"pattern": "[-_a-z0-9\\.]+",
|
|
7056
|
+
"maxLength": 100,
|
|
7057
|
+
"type": "string",
|
|
7058
|
+
"fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
|
|
7059
|
+
},
|
|
7060
|
+
"type": {
|
|
7061
|
+
"enum": [
|
|
7062
|
+
"togglegroup",
|
|
7063
|
+
"TOGGLEGROUP"
|
|
7064
|
+
],
|
|
7065
|
+
"type": "string",
|
|
7066
|
+
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
7067
|
+
}
|
|
7068
|
+
},
|
|
7069
|
+
"required": [
|
|
7070
|
+
"controls",
|
|
7071
|
+
"macroParameter",
|
|
7072
|
+
"type"
|
|
7073
|
+
],
|
|
7074
|
+
"shortClassName": "macroToggleGroupBean",
|
|
7075
|
+
"type": "object",
|
|
7076
|
+
"title": "ToggleGroup",
|
|
7077
|
+
"description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"togglegroup\",\n \"macroParameter\": \"toggleGroupMacroParameter\",\n \"controls\": [\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n },\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 1\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-toggle-button-1\"\n }\n ]\n }\n ]\n\n\n"
|
|
7078
|
+
},
|
|
6820
7079
|
{
|
|
6821
7080
|
"properties": {
|
|
6822
7081
|
"macroParameter": {
|
|
@@ -6904,75 +7163,6 @@
|
|
|
6904
7163
|
"type": "object",
|
|
6905
7164
|
"title": "ControlGroup",
|
|
6906
7165
|
"description": "\n\nDefines a ControlGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"group\",\n \"controls\": [\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-control-0\"\n },\n {\n \"type\": \"button\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-control-1\"\n }\n ]\n }\n ]\n\n\n"
|
|
6907
|
-
},
|
|
6908
|
-
{
|
|
6909
|
-
"properties": {
|
|
6910
|
-
"controls": {
|
|
6911
|
-
"items": {
|
|
6912
|
-
"properties": {
|
|
6913
|
-
"macroParameterValue": {
|
|
6914
|
-
"maxLength": 10000,
|
|
6915
|
-
"type": "string",
|
|
6916
|
-
"fieldDescription": "\n\nThe value that will be assigned to a macro parameter when this toggle is clicked\n\n"
|
|
6917
|
-
},
|
|
6918
|
-
"label": {
|
|
6919
|
-
"$ref": "#/definitions/i18nProperty",
|
|
6920
|
-
"fieldDescription": "\n\nText which will appear inside the button\n\n"
|
|
6921
|
-
},
|
|
6922
|
-
"type": {
|
|
6923
|
-
"enum": [
|
|
6924
|
-
"togglebutton",
|
|
6925
|
-
"TOGGLEBUTTON"
|
|
6926
|
-
],
|
|
6927
|
-
"type": "string",
|
|
6928
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglebutton'\n\n"
|
|
6929
|
-
},
|
|
6930
|
-
"key": {
|
|
6931
|
-
"pattern": "^[a-zA-Z0-9-]+$",
|
|
6932
|
-
"maxLength": 100,
|
|
6933
|
-
"type": "string",
|
|
6934
|
-
"fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
|
|
6935
|
-
}
|
|
6936
|
-
},
|
|
6937
|
-
"required": [
|
|
6938
|
-
"macroParameterValue",
|
|
6939
|
-
"label",
|
|
6940
|
-
"type",
|
|
6941
|
-
"key"
|
|
6942
|
-
],
|
|
6943
|
-
"additionalProperties": true,
|
|
6944
|
-
"shortClassName": "macroToggleButtonControlBean",
|
|
6945
|
-
"type": "object",
|
|
6946
|
-
"title": "ToggleButtonControl",
|
|
6947
|
-
"description": "\n\nDefines a toggle button which appears inside a ToggleGroup\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n }\n\n\n"
|
|
6948
|
-
},
|
|
6949
|
-
"type": "array",
|
|
6950
|
-
"fieldDescription": "\n\nToggle buttons which will appear in the toggle group\n\n"
|
|
6951
|
-
},
|
|
6952
|
-
"macroParameter": {
|
|
6953
|
-
"pattern": "[-_a-z0-9\\.]+",
|
|
6954
|
-
"maxLength": 100,
|
|
6955
|
-
"type": "string",
|
|
6956
|
-
"fieldDescription": "\n\nThe macro parameter identifier used to store the toggle state.\n It must only contain lowercase alphanumeric characters, dashes, underscores, dots and must not contain any spaces.\n\n"
|
|
6957
|
-
},
|
|
6958
|
-
"type": {
|
|
6959
|
-
"enum": [
|
|
6960
|
-
"togglegroup",
|
|
6961
|
-
"TOGGLEGROUP"
|
|
6962
|
-
],
|
|
6963
|
-
"type": "string",
|
|
6964
|
-
"fieldDescription": "\n\nThe type field must be set to 'togglegroup'\n\n"
|
|
6965
|
-
}
|
|
6966
|
-
},
|
|
6967
|
-
"required": [
|
|
6968
|
-
"controls",
|
|
6969
|
-
"macroParameter",
|
|
6970
|
-
"type"
|
|
6971
|
-
],
|
|
6972
|
-
"shortClassName": "macroToggleGroupBean",
|
|
6973
|
-
"type": "object",
|
|
6974
|
-
"title": "ToggleGroup",
|
|
6975
|
-
"description": "\n\nDefines a ToggleGroup which may appear in control extension points such as the property panel\n\n <p><b>Example</b></p>\n\n\n\n\n\n [\n {\n \"type\": \"togglegroup\",\n \"macroParameter\": \"toggleGroupMacroParameter\",\n \"controls\": [\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 0\",\n \"label\": {\n \"value\": \"My Custom Control 0\"\n },\n \"key\": \"my-custom-toggle-button-0\"\n },\n {\n \"type\": \"togglebutton\",\n \"macroParameterValue\": \"macroParameterValue 1\",\n \"label\": {\n \"value\": \"My Custom Control 1\"\n },\n \"key\": \"my-custom-toggle-button-1\"\n }\n ]\n }\n ]\n\n\n"
|
|
6976
7166
|
}
|
|
6977
7167
|
]
|
|
6978
7168
|
},
|
|
@@ -7208,22 +7398,6 @@
|
|
|
7208
7398
|
"type": "object",
|
|
7209
7399
|
"fieldDescription": "\n\n<p>An object containing options which vary based on the type of web item target you are implementing.</p>\n\n <p>Currently-allowed options are:</p>\n <ul>\n <li><a href=\"../inline-dialog-options/\">Inline Dialog Options</a> when type is \"inlinedialog\", and</li>\n <li><a href=\"../dialog-options/\">Dialog Options</a> when type is \"dialog\"</li>\n <li><a href=\"../dialog-module-options/\">Dialog Module Options</a> when type is \"dialogmodule\"</li>\n </ul>\n\n",
|
|
7210
7400
|
"anyOf": [
|
|
7211
|
-
{
|
|
7212
|
-
"properties": {
|
|
7213
|
-
"key": {
|
|
7214
|
-
"maxLength": 100,
|
|
7215
|
-
"type": "string",
|
|
7216
|
-
"fieldDescription": "\n\n<p>The key of a <a href=\"../dialog/\">Dialog</a> module declared in this Connect add-on.</p>\n\n <p>\n The dialog module will include the <a href=\"../dialog-options/\">Dialog Options</a>\n that would otherwise need to be specified directly in this options object.\n </p>\n\n"
|
|
7217
|
-
}
|
|
7218
|
-
},
|
|
7219
|
-
"required": [
|
|
7220
|
-
"key"
|
|
7221
|
-
],
|
|
7222
|
-
"shortClassName": "dialogModuleOptions",
|
|
7223
|
-
"type": "object",
|
|
7224
|
-
"title": "Dialog Module Options",
|
|
7225
|
-
"description": "\n\nOptions for a web-item targeting a common <a href=\"../dialog/\">dialog module</a>.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n"
|
|
7226
|
-
},
|
|
7227
7401
|
{
|
|
7228
7402
|
"properties": {
|
|
7229
7403
|
"size": {
|
|
@@ -7315,6 +7489,22 @@
|
|
|
7315
7489
|
"type": "object",
|
|
7316
7490
|
"title": "Inline Dialog Options",
|
|
7317
7491
|
"description": "\n\nOptions for an inline dialog target\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"inlinedialog\",\n \"options\": {\n \"onHover\": true,\n \"offsetX\": \"30px\",\n \"offsetY\": \"20px\"\n }\n }\n }\n\n\n"
|
|
7492
|
+
},
|
|
7493
|
+
{
|
|
7494
|
+
"properties": {
|
|
7495
|
+
"key": {
|
|
7496
|
+
"maxLength": 100,
|
|
7497
|
+
"type": "string",
|
|
7498
|
+
"fieldDescription": "\n\n<p>The key of a <a href=\"../dialog/\">Dialog</a> module declared in this Connect add-on.</p>\n\n <p>\n The dialog module will include the <a href=\"../dialog-options/\">Dialog Options</a>\n that would otherwise need to be specified directly in this options object.\n </p>\n\n"
|
|
7499
|
+
}
|
|
7500
|
+
},
|
|
7501
|
+
"required": [
|
|
7502
|
+
"key"
|
|
7503
|
+
],
|
|
7504
|
+
"shortClassName": "dialogModuleOptions",
|
|
7505
|
+
"type": "object",
|
|
7506
|
+
"title": "Dialog Module Options",
|
|
7507
|
+
"description": "\n\nOptions for a web-item targeting a common <a href=\"../dialog/\">dialog module</a>.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialogmodule\",\n \"options\": {\n \"key\": \"dialog-module-key\"\n }\n }\n }\n\n\n"
|
|
7318
7508
|
}
|
|
7319
7509
|
]
|
|
7320
7510
|
},
|