@forge/manifest 2.5.0-next.6 → 2.5.0-next.7

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 CHANGED
@@ -1,5 +1,11 @@
1
1
  # @forge/manifest
2
2
 
3
+ ## 2.5.0-next.7
4
+
5
+ ### Patch Changes
6
+
7
+ - cc8799c: Update manifest definitions
8
+
3
9
  ## 2.5.0-next.6
4
10
 
5
11
  ### Patch Changes
@@ -5427,10 +5427,10 @@
5427
5427
  "type": "object",
5428
5428
  "anyOf": [
5429
5429
  {
5430
- "$ref": "#/definitions/compositeCondition"
5430
+ "$ref": "#/definitions/singleCondition"
5431
5431
  },
5432
5432
  {
5433
- "$ref": "#/definitions/singleCondition"
5433
+ "$ref": "#/definitions/compositeCondition"
5434
5434
  }
5435
5435
  ]
5436
5436
  },
@@ -5482,10 +5482,10 @@
5482
5482
  "type": "object",
5483
5483
  "anyOf": [
5484
5484
  {
5485
- "$ref": "#/definitions/singleCondition"
5485
+ "$ref": "#/definitions/compositeCondition"
5486
5486
  },
5487
5487
  {
5488
- "$ref": "#/definitions/compositeCondition"
5488
+ "$ref": "#/definitions/singleCondition"
5489
5489
  }
5490
5490
  ]
5491
5491
  },
@@ -5735,6 +5735,67 @@
5735
5735
  "type": "object",
5736
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",
5737
5737
  "anyOf": [
5738
+ {
5739
+ "properties": {
5740
+ "size": {
5741
+ "enum": [
5742
+ "small",
5743
+ "SMALL",
5744
+ "medium",
5745
+ "MEDIUM",
5746
+ "large",
5747
+ "LARGE",
5748
+ "x-large",
5749
+ "X-LARGE",
5750
+ "fullscreen",
5751
+ "FULLSCREEN",
5752
+ "maximum",
5753
+ "MAXIMUM"
5754
+ ],
5755
+ "type": "string",
5756
+ "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
5757
+ },
5758
+ "chrome": {
5759
+ "type": "boolean",
5760
+ "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
5761
+ "defaultValue": "true"
5762
+ },
5763
+ "width": {
5764
+ "maxLength": 10,
5765
+ "type": "string",
5766
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5767
+ },
5768
+ "header": {
5769
+ "$ref": "#/definitions/i18nProperty",
5770
+ "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
5771
+ },
5772
+ "height": {
5773
+ "maxLength": 10,
5774
+ "type": "string",
5775
+ "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
5776
+ }
5777
+ },
5778
+ "shortClassName": "dialogOptions",
5779
+ "type": "object",
5780
+ "title": "Dialog Options",
5781
+ "description": "\n\nOptions for a modal dialog <a href=\"../web-item-target/\">web item target</a> or <a href=\"../dialog/\">common module</a>.\n\n <p>\n These options are a subset of those available via the <a href=\"../../jsapi/dialog/\">JavaScript API</a>.\n </p>\n\n <h2>Web Item Example</h2>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialog\",\n \"options\": {\n \"height\": \"100px\",\n \"width\": \"200px\"\n }\n }\n }\n\n\n\n\n <h2>Dialog Example</h2>\n\n\n\n\n\n {\n \"modules\": {\n \"dialogs\": [\n {\n \"url\": \"/my-dialog-content\",\n \"options\": {\n \"size\": \"fullscreen\",\n \"header\": {\n \"value\": \"Example Dialog\"\n }\n },\n \"key\": \"dialog-module-key\"\n }\n ]\n }\n }\n\n\n"
5782
+ },
5783
+ {
5784
+ "properties": {
5785
+ "key": {
5786
+ "maxLength": 100,
5787
+ "type": "string",
5788
+ "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"
5789
+ }
5790
+ },
5791
+ "required": [
5792
+ "key"
5793
+ ],
5794
+ "shortClassName": "dialogModuleOptions",
5795
+ "type": "object",
5796
+ "title": "Dialog Module Options",
5797
+ "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"
5798
+ },
5738
5799
  {
5739
5800
  "properties": {
5740
5801
  "offsetX": {
@@ -5781,67 +5842,6 @@
5781
5842
  "type": "object",
5782
5843
  "title": "Inline Dialog Options",
5783
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"
5784
- },
5785
- {
5786
- "properties": {
5787
- "key": {
5788
- "maxLength": 100,
5789
- "type": "string",
5790
- "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"
5791
- }
5792
- },
5793
- "required": [
5794
- "key"
5795
- ],
5796
- "shortClassName": "dialogModuleOptions",
5797
- "type": "object",
5798
- "title": "Dialog Module Options",
5799
- "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"
5800
- },
5801
- {
5802
- "properties": {
5803
- "size": {
5804
- "enum": [
5805
- "small",
5806
- "SMALL",
5807
- "medium",
5808
- "MEDIUM",
5809
- "large",
5810
- "LARGE",
5811
- "x-large",
5812
- "X-LARGE",
5813
- "fullscreen",
5814
- "FULLSCREEN",
5815
- "maximum",
5816
- "MAXIMUM"
5817
- ],
5818
- "type": "string",
5819
- "fieldDescription": "\n\nSets the size of the dialog.\n\n <p>\n This option is used instead of the 'height' and 'width' options.\n </p>\n\n"
5820
- },
5821
- "chrome": {
5822
- "type": "boolean",
5823
- "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
5824
- "defaultValue": "true"
5825
- },
5826
- "width": {
5827
- "maxLength": 10,
5828
- "type": "string",
5829
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5830
- },
5831
- "header": {
5832
- "$ref": "#/definitions/i18nProperty",
5833
- "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
5834
- },
5835
- "height": {
5836
- "maxLength": 10,
5837
- "type": "string",
5838
- "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
5839
- }
5840
- },
5841
- "shortClassName": "dialogOptions",
5842
- "type": "object",
5843
- "title": "Dialog Options",
5844
- "description": "\n\nOptions for a modal dialog <a href=\"../web-item-target/\">web item target</a> or <a href=\"../dialog/\">common module</a>.\n\n <p>\n These options are a subset of those available via the <a href=\"../../jsapi/dialog/\">JavaScript API</a>.\n </p>\n\n <h2>Web Item Example</h2>\n\n\n\n\n\n {\n \"target\": {\n \"type\": \"dialog\",\n \"options\": {\n \"height\": \"100px\",\n \"width\": \"200px\"\n }\n }\n }\n\n\n\n\n <h2>Dialog Example</h2>\n\n\n\n\n\n {\n \"modules\": {\n \"dialogs\": [\n {\n \"url\": \"/my-dialog-content\",\n \"options\": {\n \"size\": \"fullscreen\",\n \"header\": {\n \"value\": \"Example Dialog\"\n }\n },\n \"key\": \"dialog-module-key\"\n }\n ]\n }\n }\n\n\n"
5845
5845
  }
5846
5846
  ]
5847
5847
  },
@@ -5932,10 +5932,10 @@
5932
5932
  "type": "object",
5933
5933
  "anyOf": [
5934
5934
  {
5935
- "$ref": "#/definitions/singleCondition"
5935
+ "$ref": "#"
5936
5936
  },
5937
5937
  {
5938
- "$ref": "#"
5938
+ "$ref": "#/definitions/singleCondition"
5939
5939
  }
5940
5940
  ]
5941
5941
  },
@@ -6161,33 +6161,6 @@
6161
6161
  "items": {
6162
6162
  "type": "object",
6163
6163
  "anyOf": [
6164
- {
6165
- "properties": {
6166
- "condition": {
6167
- "maxLength": 100,
6168
- "type": "string",
6169
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6170
- },
6171
- "invert": {
6172
- "type": "boolean",
6173
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6174
- "defaultValue": "false"
6175
- },
6176
- "params": {
6177
- "additionalProperties": true,
6178
- "type": "object",
6179
- "fieldTitle": "Object",
6180
- "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
6181
- }
6182
- },
6183
- "required": [
6184
- "condition"
6185
- ],
6186
- "shortClassName": "singleConditionBean",
6187
- "type": "object",
6188
- "title": "Single Condition",
6189
- "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
6190
- },
6191
6164
  {
6192
6165
  "properties": {
6193
6166
  "conditions": {
@@ -6220,6 +6193,33 @@
6220
6193
  "type": "object",
6221
6194
  "title": "Composite Condition",
6222
6195
  "description": "\n\nComposite Conditions are composed of a collection of [Single Condition](../single-condition/) / Composite Conditions\n and a type attribute.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"conditions\": [\n {\n \"or\": [\n {\n \"condition\": \"can_attach_file_to_issue\",\n \"invert\": false\n },\n {\n \"condition\": \"is_issue_assigned_to_current_user\",\n \"invert\": false\n }\n ]\n },\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n ]\n }\n\n\n"
6196
+ },
6197
+ {
6198
+ "properties": {
6199
+ "condition": {
6200
+ "maxLength": 100,
6201
+ "type": "string",
6202
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
6203
+ },
6204
+ "invert": {
6205
+ "type": "boolean",
6206
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
6207
+ "defaultValue": "false"
6208
+ },
6209
+ "params": {
6210
+ "additionalProperties": true,
6211
+ "type": "object",
6212
+ "fieldTitle": "Object",
6213
+ "fieldDescription": "\n\nThis object represents a map of key/value pairs, where each property name and value corresponds to the parameter name and value respectively.\n\n <p><b>Example</b></p>\n\n\n\n\n\n {\n \"params\": {\n \"someOtherProperty\": \"someValue\",\n \"myCustomProperty\": \"myValue\"\n }\n }\n\n\n"
6214
+ }
6215
+ },
6216
+ "required": [
6217
+ "condition"
6218
+ ],
6219
+ "shortClassName": "singleConditionBean",
6220
+ "type": "object",
6221
+ "title": "Single Condition",
6222
+ "description": "\n\nSingle Conditions are either provided by the host application. See the complete documentation of\n [Conditions](../../conditions/) for more information.\n\n To invert a condition, add the attribute ``invert=\"true\"`` to the condition element.\n This is useful where you want to show the section if a certain condition is not satisfied.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"condition\": \"user_is_logged_in\",\n \"invert\": false\n }\n\n\n"
6223
6223
  }
6224
6224
  ]
6225
6225
  },
@@ -6493,38 +6493,6 @@
6493
6493
  "items": {
6494
6494
  "type": "object",
6495
6495
  "anyOf": [
6496
- {
6497
- "properties": {
6498
- "label": {
6499
- "$ref": "#/definitions/i18nProperty",
6500
- "fieldDescription": "\n\nText which will appear inside the button\n\n"
6501
- },
6502
- "type": {
6503
- "enum": [
6504
- "button",
6505
- "BUTTON"
6506
- ],
6507
- "type": "string",
6508
- "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6509
- },
6510
- "key": {
6511
- "pattern": "^[a-zA-Z0-9-]+$",
6512
- "maxLength": 100,
6513
- "type": "string",
6514
- "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6515
- }
6516
- },
6517
- "required": [
6518
- "label",
6519
- "type",
6520
- "key"
6521
- ],
6522
- "additionalProperties": true,
6523
- "shortClassName": "buttonControlBean",
6524
- "type": "object",
6525
- "title": "ButtonControl",
6526
- "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"
6527
- },
6528
6496
  {
6529
6497
  "properties": {
6530
6498
  "controls": {
@@ -6581,6 +6549,38 @@
6581
6549
  "title": "ControlGroup",
6582
6550
  "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"
6583
6551
  },
6552
+ {
6553
+ "properties": {
6554
+ "label": {
6555
+ "$ref": "#/definitions/i18nProperty",
6556
+ "fieldDescription": "\n\nText which will appear inside the button\n\n"
6557
+ },
6558
+ "type": {
6559
+ "enum": [
6560
+ "button",
6561
+ "BUTTON"
6562
+ ],
6563
+ "type": "string",
6564
+ "fieldDescription": "\n\nThe type field must be set to 'button'\n\n"
6565
+ },
6566
+ "key": {
6567
+ "pattern": "^[a-zA-Z0-9-]+$",
6568
+ "maxLength": 100,
6569
+ "type": "string",
6570
+ "fieldDescription": "\n\nA key to identify the control. Keys must only contain alphanumeric characters and dashes, and must be unique\n\n"
6571
+ }
6572
+ },
6573
+ "required": [
6574
+ "label",
6575
+ "type",
6576
+ "key"
6577
+ ],
6578
+ "additionalProperties": true,
6579
+ "shortClassName": "buttonControlBean",
6580
+ "type": "object",
6581
+ "title": "ButtonControl",
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"
6583
+ },
6584
6584
  {
6585
6585
  "properties": {
6586
6586
  "controls": {
@@ -6975,6 +6975,38 @@
6975
6975
  "items": {
6976
6976
  "type": "object",
6977
6977
  "anyOf": [
6978
+ {
6979
+ "properties": {
6980
+ "macroParameter": {
6981
+ "maxLength": 100,
6982
+ "type": "string",
6983
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
6984
+ },
6985
+ "type": {
6986
+ "enum": [
6987
+ "text",
6988
+ "TEXT"
6989
+ ],
6990
+ "type": "string",
6991
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
6992
+ },
6993
+ "key": {
6994
+ "pattern": "^[a-zA-Z0-9-]+$",
6995
+ "maxLength": 100,
6996
+ "type": "string",
6997
+ "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"
6998
+ }
6999
+ },
7000
+ "required": [
7001
+ "macroParameter",
7002
+ "type",
7003
+ "key"
7004
+ ],
7005
+ "shortClassName": "textControlBean",
7006
+ "type": "object",
7007
+ "title": "TextControl",
7008
+ "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"
7009
+ },
6978
7010
  {
6979
7011
  "properties": {
6980
7012
  "label": {
@@ -7063,38 +7095,6 @@
7063
7095
  "title": "ControlGroup",
7064
7096
  "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"
7065
7097
  },
7066
- {
7067
- "properties": {
7068
- "macroParameter": {
7069
- "maxLength": 100,
7070
- "type": "string",
7071
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7072
- },
7073
- "type": {
7074
- "enum": [
7075
- "text",
7076
- "TEXT"
7077
- ],
7078
- "type": "string",
7079
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7080
- },
7081
- "key": {
7082
- "pattern": "^[a-zA-Z0-9-]+$",
7083
- "maxLength": 100,
7084
- "type": "string",
7085
- "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"
7086
- }
7087
- },
7088
- "required": [
7089
- "macroParameter",
7090
- "type",
7091
- "key"
7092
- ],
7093
- "shortClassName": "textControlBean",
7094
- "type": "object",
7095
- "title": "TextControl",
7096
- "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"
7097
- },
7098
7098
  {
7099
7099
  "properties": {
7100
7100
  "controls": {
@@ -7365,10 +7365,10 @@
7365
7365
  "type": "object",
7366
7366
  "anyOf": [
7367
7367
  {
7368
- "$ref": "#/definitions/singleCondition"
7368
+ "$ref": "#/definitions/compositeCondition"
7369
7369
  },
7370
7370
  {
7371
- "$ref": "#/definitions/compositeCondition"
7371
+ "$ref": "#/definitions/singleCondition"
7372
7372
  }
7373
7373
  ]
7374
7374
  },
@@ -7398,53 +7398,6 @@
7398
7398
  "type": "object",
7399
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",
7400
7400
  "anyOf": [
7401
- {
7402
- "properties": {
7403
- "offsetX": {
7404
- "maxLength": 10,
7405
- "type": "string",
7406
- "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
7407
- },
7408
- "offsetY": {
7409
- "maxLength": 10,
7410
- "type": "string",
7411
- "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
7412
- },
7413
- "width": {
7414
- "maxLength": 10,
7415
- "type": "string",
7416
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7417
- },
7418
- "onTop": {
7419
- "type": "boolean",
7420
- "fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
7421
- },
7422
- "showDelay": {
7423
- "type": "integer",
7424
- "fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
7425
- },
7426
- "closeOthers": {
7427
- "type": "boolean",
7428
- "fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
7429
- },
7430
- "persistent": {
7431
- "type": "boolean",
7432
- "fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
7433
- },
7434
- "onHover": {
7435
- "type": "boolean",
7436
- "fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
7437
- },
7438
- "isRelativeToMouse": {
7439
- "type": "boolean",
7440
- "fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
7441
- }
7442
- },
7443
- "shortClassName": "inlineDialogOptions",
7444
- "type": "object",
7445
- "title": "Inline Dialog Options",
7446
- "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"
7447
- },
7448
7401
  {
7449
7402
  "properties": {
7450
7403
  "size": {
@@ -7505,6 +7458,53 @@
7505
7458
  "type": "object",
7506
7459
  "title": "Dialog Module Options",
7507
7460
  "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"
7461
+ },
7462
+ {
7463
+ "properties": {
7464
+ "offsetX": {
7465
+ "maxLength": 10,
7466
+ "type": "string",
7467
+ "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the x-axis in pixels\n\n"
7468
+ },
7469
+ "offsetY": {
7470
+ "maxLength": 10,
7471
+ "type": "string",
7472
+ "fieldDescription": "\n\nSets an offset distance of the inline-dialog from the trigger element along the y-axis in pixels\n\n"
7473
+ },
7474
+ "width": {
7475
+ "maxLength": 10,
7476
+ "type": "string",
7477
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
7478
+ },
7479
+ "onTop": {
7480
+ "type": "boolean",
7481
+ "fieldDescription": "\n\nDetermines if the dialog should be shown above the trigger or not. If this option is true but there is insufficient room above the trigger the inline-dialog will be flipped to display below it\n\n"
7482
+ },
7483
+ "showDelay": {
7484
+ "type": "integer",
7485
+ "fieldDescription": "\n\nDetermines how long in milliseconds after a show trigger is fired (such as a trigger click) until the dialog is shown\n\n"
7486
+ },
7487
+ "closeOthers": {
7488
+ "type": "boolean",
7489
+ "fieldDescription": "\n\nDetermines if all other dialogs on the screen are closed when this one is opened\n\n"
7490
+ },
7491
+ "persistent": {
7492
+ "type": "boolean",
7493
+ "fieldDescription": "\n\nThis option, ignores the 'closeOthers' option\n\n"
7494
+ },
7495
+ "onHover": {
7496
+ "type": "boolean",
7497
+ "fieldDescription": "\n\nDetermines whether the inline-Dialog will show on a mouseOver or mouseClick of the trigger\n\n"
7498
+ },
7499
+ "isRelativeToMouse": {
7500
+ "type": "boolean",
7501
+ "fieldDescription": "\n\nDetermines if the dialog should be shown relative to where the mouse is at the time of the event trigger (normally a click) if set to false the dialog will show aligned to the left of the trigger with the arrow showing at the center\n\n"
7502
+ }
7503
+ },
7504
+ "shortClassName": "inlineDialogOptions",
7505
+ "type": "object",
7506
+ "title": "Inline Dialog Options",
7507
+ "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"
7508
7508
  }
7509
7509
  ]
7510
7510
  },
@@ -2506,7 +2506,7 @@ export interface Modules {
2506
2506
  location?: string;
2507
2507
  cacheable?: boolean;
2508
2508
  supportsNative?: boolean;
2509
- conditions?: (CompositeCondition | SingleCondition)[];
2509
+ conditions?: (SingleCondition | CompositeCondition)[];
2510
2510
  params?: {
2511
2511
  [k: string]: unknown;
2512
2512
  };
@@ -2522,7 +2522,7 @@ export interface Modules {
2522
2522
  location?: string;
2523
2523
  cacheable?: boolean;
2524
2524
  supportsNative?: boolean;
2525
- conditions?: (CompositeCondition | SingleCondition)[];
2525
+ conditions?: (SingleCondition | CompositeCondition)[];
2526
2526
  params?: {
2527
2527
  [k: string]: unknown;
2528
2528
  };
@@ -2536,7 +2536,7 @@ export interface Modules {
2536
2536
  filter?: string;
2537
2537
  excludeBody?: boolean;
2538
2538
  event?: string;
2539
- conditions?: (SingleCondition | CompositeCondition)[];
2539
+ conditions?: (CompositeCondition | SingleCondition)[];
2540
2540
  propertyKeys?: string[];
2541
2541
  url?: string;
2542
2542
  key: ModuleKeySchema;
@@ -2546,7 +2546,7 @@ export interface Modules {
2546
2546
  filter?: string;
2547
2547
  excludeBody?: boolean;
2548
2548
  event?: string;
2549
- conditions?: (SingleCondition | CompositeCondition)[];
2549
+ conditions?: (CompositeCondition | SingleCondition)[];
2550
2550
  propertyKeys?: string[];
2551
2551
  url?: string;
2552
2552
  key: ModuleKeySchema;
@@ -2750,7 +2750,7 @@ export interface Modules {
2750
2750
  name?: I18NProperty63;
2751
2751
  weight?: number;
2752
2752
  location?: string;
2753
- conditions?: (SingleCondition5 | CompositeCondition7)[];
2753
+ conditions?: (CompositeCondition7 | SingleCondition5)[];
2754
2754
  params?: {
2755
2755
  [k: string]: unknown;
2756
2756
  };
@@ -2762,7 +2762,7 @@ export interface Modules {
2762
2762
  name?: I18NProperty63;
2763
2763
  weight?: number;
2764
2764
  location?: string;
2765
- conditions?: (SingleCondition5 | CompositeCondition7)[];
2765
+ conditions?: (CompositeCondition7 | SingleCondition5)[];
2766
2766
  params?: {
2767
2767
  [k: string]: unknown;
2768
2768
  };
@@ -2958,7 +2958,7 @@ export interface Modules {
2958
2958
  icon?: Icon18;
2959
2959
  name?: I18NProperty91;
2960
2960
  cacheable?: boolean;
2961
- conditions?: (SingleCondition | CompositeCondition)[];
2961
+ conditions?: (CompositeCondition | SingleCondition)[];
2962
2962
  params?: {
2963
2963
  [k: string]: unknown;
2964
2964
  };
@@ -2974,7 +2974,7 @@ export interface Modules {
2974
2974
  icon?: Icon18;
2975
2975
  name?: I18NProperty91;
2976
2976
  cacheable?: boolean;
2977
- conditions?: (SingleCondition | CompositeCondition)[];
2977
+ conditions?: (CompositeCondition | SingleCondition)[];
2978
2978
  params?: {
2979
2979
  [k: string]: unknown;
2980
2980
  };
@@ -5899,74 +5899,10 @@ export interface Icon10 {
5899
5899
  *
5900
5900
  */
5901
5901
  export interface WebItemTarget1 {
5902
- options?: InlineDialogOptions1 | DialogModuleOptions1 | DialogOptions2;
5902
+ options?: DialogOptions2 | DialogModuleOptions1 | InlineDialogOptions1;
5903
5903
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
5904
5904
  [k: string]: unknown;
5905
5905
  }
5906
- /**
5907
- *
5908
- *
5909
- * Options for an inline dialog target
5910
- *
5911
- * <h3>Example</h3>
5912
- *
5913
- *
5914
- *
5915
- *
5916
- *
5917
- * {
5918
- * "target": {
5919
- * "type": "inlinedialog",
5920
- * "options": {
5921
- * "onHover": true,
5922
- * "offsetX": "30px",
5923
- * "offsetY": "20px"
5924
- * }
5925
- * }
5926
- * }
5927
- *
5928
- *
5929
- *
5930
- */
5931
- export interface InlineDialogOptions1 {
5932
- offsetX?: string;
5933
- offsetY?: string;
5934
- width?: string;
5935
- onTop?: boolean;
5936
- showDelay?: number;
5937
- closeOthers?: boolean;
5938
- persistent?: boolean;
5939
- onHover?: boolean;
5940
- isRelativeToMouse?: boolean;
5941
- [k: string]: unknown;
5942
- }
5943
- /**
5944
- *
5945
- *
5946
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
5947
- *
5948
- * <h3>Example</h3>
5949
- *
5950
- *
5951
- *
5952
- *
5953
- *
5954
- * {
5955
- * "target": {
5956
- * "type": "dialogmodule",
5957
- * "options": {
5958
- * "key": "dialog-module-key"
5959
- * }
5960
- * }
5961
- * }
5962
- *
5963
- *
5964
- *
5965
- */
5966
- export interface DialogModuleOptions1 {
5967
- key: string;
5968
- [k: string]: unknown;
5969
- }
5970
5906
  /**
5971
5907
  *
5972
5908
  *
@@ -6065,6 +6001,70 @@ export interface I18NProperty58 {
6065
6001
  i18n?: string;
6066
6002
  [k: string]: unknown;
6067
6003
  }
6004
+ /**
6005
+ *
6006
+ *
6007
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
6008
+ *
6009
+ * <h3>Example</h3>
6010
+ *
6011
+ *
6012
+ *
6013
+ *
6014
+ *
6015
+ * {
6016
+ * "target": {
6017
+ * "type": "dialogmodule",
6018
+ * "options": {
6019
+ * "key": "dialog-module-key"
6020
+ * }
6021
+ * }
6022
+ * }
6023
+ *
6024
+ *
6025
+ *
6026
+ */
6027
+ export interface DialogModuleOptions1 {
6028
+ key: string;
6029
+ [k: string]: unknown;
6030
+ }
6031
+ /**
6032
+ *
6033
+ *
6034
+ * Options for an inline dialog target
6035
+ *
6036
+ * <h3>Example</h3>
6037
+ *
6038
+ *
6039
+ *
6040
+ *
6041
+ *
6042
+ * {
6043
+ * "target": {
6044
+ * "type": "inlinedialog",
6045
+ * "options": {
6046
+ * "onHover": true,
6047
+ * "offsetX": "30px",
6048
+ * "offsetY": "20px"
6049
+ * }
6050
+ * }
6051
+ * }
6052
+ *
6053
+ *
6054
+ *
6055
+ */
6056
+ export interface InlineDialogOptions1 {
6057
+ offsetX?: string;
6058
+ offsetY?: string;
6059
+ width?: string;
6060
+ onTop?: boolean;
6061
+ showDelay?: number;
6062
+ closeOthers?: boolean;
6063
+ persistent?: boolean;
6064
+ onHover?: boolean;
6065
+ isRelativeToMouse?: boolean;
6066
+ [k: string]: unknown;
6067
+ }
6068
6068
  /**
6069
6069
  *
6070
6070
  *
@@ -6157,7 +6157,7 @@ export interface SingleCondition4 {
6157
6157
  *
6158
6158
  */
6159
6159
  export interface CompositeCondition6 {
6160
- conditions?: (SingleCondition | ManifestSchema)[];
6160
+ conditions?: (ManifestSchema | SingleCondition)[];
6161
6161
  type?: 'and' | 'AND' | 'or' | 'OR';
6162
6162
  [k: string]: unknown;
6163
6163
  }
@@ -6515,37 +6515,6 @@ export interface I18NProperty63 {
6515
6515
  i18n?: string;
6516
6516
  [k: string]: unknown;
6517
6517
  }
6518
- /**
6519
- *
6520
- *
6521
- * Single Conditions are either provided by the host application. See the complete documentation of
6522
- * [Conditions](../../conditions/) for more information.
6523
- *
6524
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6525
- * This is useful where you want to show the section if a certain condition is not satisfied.
6526
- *
6527
- * <h3>Example</h3>
6528
- *
6529
- *
6530
- *
6531
- *
6532
- *
6533
- * {
6534
- * "condition": "user_is_logged_in",
6535
- * "invert": false
6536
- * }
6537
- *
6538
- *
6539
- *
6540
- */
6541
- export interface SingleCondition5 {
6542
- condition: string;
6543
- invert?: boolean;
6544
- params?: {
6545
- [k: string]: unknown;
6546
- };
6547
- [k: string]: unknown;
6548
- }
6549
6518
  /**
6550
6519
  *
6551
6520
  *
@@ -6587,6 +6556,37 @@ export interface CompositeCondition7 {
6587
6556
  type?: 'and' | 'AND' | 'or' | 'OR';
6588
6557
  [k: string]: unknown;
6589
6558
  }
6559
+ /**
6560
+ *
6561
+ *
6562
+ * Single Conditions are either provided by the host application. See the complete documentation of
6563
+ * [Conditions](../../conditions/) for more information.
6564
+ *
6565
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
6566
+ * This is useful where you want to show the section if a certain condition is not satisfied.
6567
+ *
6568
+ * <h3>Example</h3>
6569
+ *
6570
+ *
6571
+ *
6572
+ *
6573
+ *
6574
+ * {
6575
+ * "condition": "user_is_logged_in",
6576
+ * "invert": false
6577
+ * }
6578
+ *
6579
+ *
6580
+ *
6581
+ */
6582
+ export interface SingleCondition5 {
6583
+ condition: string;
6584
+ invert?: boolean;
6585
+ params?: {
6586
+ [k: string]: unknown;
6587
+ };
6588
+ [k: string]: unknown;
6589
+ }
6590
6590
  /**
6591
6591
  *
6592
6592
  *
@@ -8006,11 +8006,52 @@ export interface I18NProperty74 {
8006
8006
  *
8007
8007
  */
8008
8008
  export interface MacroPropertyPanel {
8009
- controls?: (ButtonControl | ControlGroup | ToggleGroup | TextControl)[];
8009
+ controls?: (ControlGroup | ButtonControl1 | ToggleGroup | TextControl)[];
8010
8010
  cacheable?: boolean;
8011
8011
  url: string;
8012
8012
  [k: string]: unknown;
8013
8013
  }
8014
+ /**
8015
+ *
8016
+ *
8017
+ * Defines a ControlGroup which may appear in control extension points such as the property panel
8018
+ *
8019
+ * <p><b>Example</b></p>
8020
+ *
8021
+ *
8022
+ *
8023
+ *
8024
+ *
8025
+ * [
8026
+ * {
8027
+ * "type": "group",
8028
+ * "controls": [
8029
+ * {
8030
+ * "type": "button",
8031
+ * "label": {
8032
+ * "value": "My Custom Control 0"
8033
+ * },
8034
+ * "key": "my-custom-control-0"
8035
+ * },
8036
+ * {
8037
+ * "type": "button",
8038
+ * "label": {
8039
+ * "value": "My Custom Control 1"
8040
+ * },
8041
+ * "key": "my-custom-control-1"
8042
+ * }
8043
+ * ]
8044
+ * }
8045
+ * ]
8046
+ *
8047
+ *
8048
+ *
8049
+ */
8050
+ export interface ControlGroup {
8051
+ controls: ButtonControl[];
8052
+ type: 'group' | 'GROUP';
8053
+ [k: string]: unknown;
8054
+ }
8014
8055
  /**
8015
8056
  *
8016
8057
  *
@@ -8063,47 +8104,6 @@ export interface I18NProperty75 {
8063
8104
  i18n?: string;
8064
8105
  [k: string]: unknown;
8065
8106
  }
8066
- /**
8067
- *
8068
- *
8069
- * Defines a ControlGroup which may appear in control extension points such as the property panel
8070
- *
8071
- * <p><b>Example</b></p>
8072
- *
8073
- *
8074
- *
8075
- *
8076
- *
8077
- * [
8078
- * {
8079
- * "type": "group",
8080
- * "controls": [
8081
- * {
8082
- * "type": "button",
8083
- * "label": {
8084
- * "value": "My Custom Control 0"
8085
- * },
8086
- * "key": "my-custom-control-0"
8087
- * },
8088
- * {
8089
- * "type": "button",
8090
- * "label": {
8091
- * "value": "My Custom Control 1"
8092
- * },
8093
- * "key": "my-custom-control-1"
8094
- * }
8095
- * ]
8096
- * }
8097
- * ]
8098
- *
8099
- *
8100
- *
8101
- */
8102
- export interface ControlGroup {
8103
- controls: ButtonControl1[];
8104
- type: 'group' | 'GROUP';
8105
- [k: string]: unknown;
8106
- }
8107
8107
  /**
8108
8108
  *
8109
8109
  *
@@ -29251,11 +29251,39 @@ export interface I18NProperty83 {
29251
29251
  *
29252
29252
  */
29253
29253
  export interface MacroPropertyPanel1 {
29254
- controls?: (ButtonControl2 | ControlGroup1 | TextControl1 | ToggleGroup1)[];
29254
+ controls?: (TextControl1 | ButtonControl2 | ControlGroup1 | ToggleGroup1)[];
29255
29255
  cacheable?: boolean;
29256
29256
  url: string;
29257
29257
  [k: string]: unknown;
29258
29258
  }
29259
+ /**
29260
+ *
29261
+ *
29262
+ * Defines a text field which may appear in control extension points such as the property panel
29263
+ *
29264
+ * <p><b>Example</b></p>
29265
+ *
29266
+ *
29267
+ *
29268
+ *
29269
+ *
29270
+ * {
29271
+ * "type": "button",
29272
+ * "label": {
29273
+ * "value": "My Custom Control 0"
29274
+ * },
29275
+ * "key": "my-custom-control-0"
29276
+ * }
29277
+ *
29278
+ *
29279
+ *
29280
+ */
29281
+ export interface TextControl1 {
29282
+ macroParameter: string;
29283
+ type: 'text' | 'TEXT';
29284
+ key: string;
29285
+ [k: string]: unknown;
29286
+ }
29259
29287
  /**
29260
29288
  *
29261
29289
  *
@@ -29401,34 +29429,6 @@ export interface I18NProperty85 {
29401
29429
  i18n?: string;
29402
29430
  [k: string]: unknown;
29403
29431
  }
29404
- /**
29405
- *
29406
- *
29407
- * Defines a text field which may appear in control extension points such as the property panel
29408
- *
29409
- * <p><b>Example</b></p>
29410
- *
29411
- *
29412
- *
29413
- *
29414
- *
29415
- * {
29416
- * "type": "button",
29417
- * "label": {
29418
- * "value": "My Custom Control 0"
29419
- * },
29420
- * "key": "my-custom-control-0"
29421
- * }
29422
- *
29423
- *
29424
- *
29425
- */
29426
- export interface TextControl1 {
29427
- macroParameter: string;
29428
- type: 'text' | 'TEXT';
29429
- key: string;
29430
- [k: string]: unknown;
29431
- }
29432
29432
  /**
29433
29433
  *
29434
29434
  *
@@ -50377,47 +50377,10 @@ export interface I18NProperty91 {
50377
50377
  *
50378
50378
  */
50379
50379
  export interface WebItemTarget2 {
50380
- options?: InlineDialogOptions2 | DialogOptions4 | DialogModuleOptions2;
50380
+ options?: DialogOptions4 | DialogModuleOptions2 | InlineDialogOptions2;
50381
50381
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
50382
50382
  [k: string]: unknown;
50383
50383
  }
50384
- /**
50385
- *
50386
- *
50387
- * Options for an inline dialog target
50388
- *
50389
- * <h3>Example</h3>
50390
- *
50391
- *
50392
- *
50393
- *
50394
- *
50395
- * {
50396
- * "target": {
50397
- * "type": "inlinedialog",
50398
- * "options": {
50399
- * "onHover": true,
50400
- * "offsetX": "30px",
50401
- * "offsetY": "20px"
50402
- * }
50403
- * }
50404
- * }
50405
- *
50406
- *
50407
- *
50408
- */
50409
- export interface InlineDialogOptions2 {
50410
- offsetX?: string;
50411
- offsetY?: string;
50412
- width?: string;
50413
- onTop?: boolean;
50414
- showDelay?: number;
50415
- closeOthers?: boolean;
50416
- persistent?: boolean;
50417
- onHover?: boolean;
50418
- isRelativeToMouse?: boolean;
50419
- [k: string]: unknown;
50420
- }
50421
50384
  /**
50422
50385
  *
50423
50386
  *
@@ -50543,6 +50506,43 @@ export interface DialogModuleOptions2 {
50543
50506
  key: string;
50544
50507
  [k: string]: unknown;
50545
50508
  }
50509
+ /**
50510
+ *
50511
+ *
50512
+ * Options for an inline dialog target
50513
+ *
50514
+ * <h3>Example</h3>
50515
+ *
50516
+ *
50517
+ *
50518
+ *
50519
+ *
50520
+ * {
50521
+ * "target": {
50522
+ * "type": "inlinedialog",
50523
+ * "options": {
50524
+ * "onHover": true,
50525
+ * "offsetX": "30px",
50526
+ * "offsetY": "20px"
50527
+ * }
50528
+ * }
50529
+ * }
50530
+ *
50531
+ *
50532
+ *
50533
+ */
50534
+ export interface InlineDialogOptions2 {
50535
+ offsetX?: string;
50536
+ offsetY?: string;
50537
+ width?: string;
50538
+ onTop?: boolean;
50539
+ showDelay?: number;
50540
+ closeOthers?: boolean;
50541
+ persistent?: boolean;
50542
+ onHover?: boolean;
50543
+ isRelativeToMouse?: boolean;
50544
+ [k: string]: unknown;
50545
+ }
50546
50546
  /**
50547
50547
  *
50548
50548
  *
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/manifest",
3
- "version": "2.5.0-next.6",
3
+ "version": "2.5.0-next.7",
4
4
  "description": "Definitions and validations of the Forge manifest",
5
5
  "main": "out/index.js",
6
6
  "scripts": {