@forge/manifest 3.2.0-next.3 → 3.2.0-next.4

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
+ ## 3.2.0-next.4
4
+
5
+ ### Patch Changes
6
+
7
+ - 254b2397: Update manifest definitions
8
+
3
9
  ## 3.2.0-next.3
4
10
 
5
11
  ### Patch Changes
@@ -6205,10 +6205,10 @@
6205
6205
  "type": "object",
6206
6206
  "anyOf": [
6207
6207
  {
6208
- "$ref": "#/definitions/compositeCondition"
6208
+ "$ref": "#/definitions/singleCondition"
6209
6209
  },
6210
6210
  {
6211
- "$ref": "#/definitions/singleCondition"
6211
+ "$ref": "#/definitions/compositeCondition"
6212
6212
  }
6213
6213
  ]
6214
6214
  },
@@ -6276,10 +6276,10 @@
6276
6276
  "type": "object",
6277
6277
  "anyOf": [
6278
6278
  {
6279
- "$ref": "#/definitions/compositeCondition"
6279
+ "$ref": "#/definitions/singleCondition"
6280
6280
  },
6281
6281
  {
6282
- "$ref": "#/definitions/singleCondition"
6282
+ "$ref": "#/definitions/compositeCondition"
6283
6283
  }
6284
6284
  ]
6285
6285
  },
@@ -6331,10 +6331,10 @@
6331
6331
  "type": "object",
6332
6332
  "anyOf": [
6333
6333
  {
6334
- "$ref": "#/definitions/compositeCondition"
6334
+ "$ref": "#/definitions/singleCondition"
6335
6335
  },
6336
6336
  {
6337
- "$ref": "#/definitions/singleCondition"
6337
+ "$ref": "#/definitions/compositeCondition"
6338
6338
  }
6339
6339
  ]
6340
6340
  },
@@ -6584,51 +6584,6 @@
6584
6584
  "type": "object",
6585
6585
  "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",
6586
6586
  "anyOf": [
6587
- {
6588
- "properties": {
6589
- "size": {
6590
- "enum": [
6591
- "small",
6592
- "SMALL",
6593
- "medium",
6594
- "MEDIUM",
6595
- "large",
6596
- "LARGE",
6597
- "x-large",
6598
- "X-LARGE",
6599
- "fullscreen",
6600
- "FULLSCREEN",
6601
- "maximum",
6602
- "MAXIMUM"
6603
- ],
6604
- "type": "string",
6605
- "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"
6606
- },
6607
- "chrome": {
6608
- "type": "boolean",
6609
- "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
6610
- "defaultValue": "true"
6611
- },
6612
- "width": {
6613
- "maxLength": 10,
6614
- "type": "string",
6615
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
6616
- },
6617
- "header": {
6618
- "$ref": "#/definitions/i18nProperty",
6619
- "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
6620
- },
6621
- "height": {
6622
- "maxLength": 10,
6623
- "type": "string",
6624
- "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
6625
- }
6626
- },
6627
- "shortClassName": "dialogOptions",
6628
- "type": "object",
6629
- "title": "Dialog Options",
6630
- "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"
6631
- },
6632
6587
  {
6633
6588
  "properties": {
6634
6589
  "offsetX": {
@@ -6676,6 +6631,51 @@
6676
6631
  "title": "Inline Dialog Options",
6677
6632
  "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"
6678
6633
  },
6634
+ {
6635
+ "properties": {
6636
+ "size": {
6637
+ "enum": [
6638
+ "small",
6639
+ "SMALL",
6640
+ "medium",
6641
+ "MEDIUM",
6642
+ "large",
6643
+ "LARGE",
6644
+ "x-large",
6645
+ "X-LARGE",
6646
+ "fullscreen",
6647
+ "FULLSCREEN",
6648
+ "maximum",
6649
+ "MAXIMUM"
6650
+ ],
6651
+ "type": "string",
6652
+ "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"
6653
+ },
6654
+ "chrome": {
6655
+ "type": "boolean",
6656
+ "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
6657
+ "defaultValue": "true"
6658
+ },
6659
+ "width": {
6660
+ "maxLength": 10,
6661
+ "type": "string",
6662
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
6663
+ },
6664
+ "header": {
6665
+ "$ref": "#/definitions/i18nProperty",
6666
+ "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
6667
+ },
6668
+ "height": {
6669
+ "maxLength": 10,
6670
+ "type": "string",
6671
+ "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
6672
+ }
6673
+ },
6674
+ "shortClassName": "dialogOptions",
6675
+ "type": "object",
6676
+ "title": "Dialog Options",
6677
+ "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"
6678
+ },
6679
6679
  {
6680
6680
  "properties": {
6681
6681
  "key": {
@@ -6781,10 +6781,10 @@
6781
6781
  "type": "object",
6782
6782
  "anyOf": [
6783
6783
  {
6784
- "$ref": "#"
6784
+ "$ref": "#/definitions/singleCondition"
6785
6785
  },
6786
6786
  {
6787
- "$ref": "#/definitions/singleCondition"
6787
+ "$ref": "#"
6788
6788
  }
6789
6789
  ]
6790
6790
  },
@@ -6859,10 +6859,10 @@
6859
6859
  "type": "object",
6860
6860
  "anyOf": [
6861
6861
  {
6862
- "$ref": "#/definitions/compositeCondition"
6862
+ "$ref": "#/definitions/singleCondition"
6863
6863
  },
6864
6864
  {
6865
- "$ref": "#/definitions/singleCondition"
6865
+ "$ref": "#/definitions/compositeCondition"
6866
6866
  }
6867
6867
  ]
6868
6868
  },
@@ -7010,6 +7010,33 @@
7010
7010
  "items": {
7011
7011
  "type": "object",
7012
7012
  "anyOf": [
7013
+ {
7014
+ "properties": {
7015
+ "condition": {
7016
+ "maxLength": 100,
7017
+ "type": "string",
7018
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
7019
+ },
7020
+ "invert": {
7021
+ "type": "boolean",
7022
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
7023
+ "defaultValue": "false"
7024
+ },
7025
+ "params": {
7026
+ "additionalProperties": true,
7027
+ "type": "object",
7028
+ "fieldTitle": "Object",
7029
+ "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"
7030
+ }
7031
+ },
7032
+ "required": [
7033
+ "condition"
7034
+ ],
7035
+ "shortClassName": "singleConditionBean",
7036
+ "type": "object",
7037
+ "title": "Single Condition",
7038
+ "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"
7039
+ },
7013
7040
  {
7014
7041
  "properties": {
7015
7042
  "conditions": {
@@ -7017,10 +7044,10 @@
7017
7044
  "type": "object",
7018
7045
  "anyOf": [
7019
7046
  {
7020
- "$ref": "#/definitions/singleCondition"
7047
+ "$ref": "#"
7021
7048
  },
7022
7049
  {
7023
- "$ref": "#"
7050
+ "$ref": "#/definitions/singleCondition"
7024
7051
  }
7025
7052
  ]
7026
7053
  },
@@ -7042,33 +7069,6 @@
7042
7069
  "type": "object",
7043
7070
  "title": "Composite Condition",
7044
7071
  "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"
7045
- },
7046
- {
7047
- "properties": {
7048
- "condition": {
7049
- "maxLength": 100,
7050
- "type": "string",
7051
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
7052
- },
7053
- "invert": {
7054
- "type": "boolean",
7055
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
7056
- "defaultValue": "false"
7057
- },
7058
- "params": {
7059
- "additionalProperties": true,
7060
- "type": "object",
7061
- "fieldTitle": "Object",
7062
- "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"
7063
- }
7064
- },
7065
- "required": [
7066
- "condition"
7067
- ],
7068
- "shortClassName": "singleConditionBean",
7069
- "type": "object",
7070
- "title": "Single Condition",
7071
- "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"
7072
7072
  }
7073
7073
  ]
7074
7074
  },
@@ -7342,6 +7342,38 @@
7342
7342
  "items": {
7343
7343
  "type": "object",
7344
7344
  "anyOf": [
7345
+ {
7346
+ "properties": {
7347
+ "macroParameter": {
7348
+ "maxLength": 100,
7349
+ "type": "string",
7350
+ "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7351
+ },
7352
+ "type": {
7353
+ "enum": [
7354
+ "text",
7355
+ "TEXT"
7356
+ ],
7357
+ "type": "string",
7358
+ "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7359
+ },
7360
+ "key": {
7361
+ "pattern": "^[a-zA-Z0-9-]+$",
7362
+ "maxLength": 100,
7363
+ "type": "string",
7364
+ "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"
7365
+ }
7366
+ },
7367
+ "required": [
7368
+ "macroParameter",
7369
+ "type",
7370
+ "key"
7371
+ ],
7372
+ "shortClassName": "textControlBean",
7373
+ "type": "object",
7374
+ "title": "TextControl",
7375
+ "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"
7376
+ },
7345
7377
  {
7346
7378
  "properties": {
7347
7379
  "controls": {
@@ -7467,38 +7499,6 @@
7467
7499
  "title": "ToggleGroup",
7468
7500
  "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"
7469
7501
  },
7470
- {
7471
- "properties": {
7472
- "macroParameter": {
7473
- "maxLength": 100,
7474
- "type": "string",
7475
- "fieldDescription": "\n\nThe Macro Parameter identifier used to store the text\n\n"
7476
- },
7477
- "type": {
7478
- "enum": [
7479
- "text",
7480
- "TEXT"
7481
- ],
7482
- "type": "string",
7483
- "fieldDescription": "\n\nThe type field must be set to 'text'\n\n"
7484
- },
7485
- "key": {
7486
- "pattern": "^[a-zA-Z0-9-]+$",
7487
- "maxLength": 100,
7488
- "type": "string",
7489
- "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"
7490
- }
7491
- },
7492
- "required": [
7493
- "macroParameter",
7494
- "type",
7495
- "key"
7496
- ],
7497
- "shortClassName": "textControlBean",
7498
- "type": "object",
7499
- "title": "TextControl",
7500
- "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"
7501
- },
7502
7502
  {
7503
7503
  "properties": {
7504
7504
  "label": {
@@ -8292,22 +8292,6 @@
8292
8292
  "title": "Dialog Options",
8293
8293
  "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"
8294
8294
  },
8295
- {
8296
- "properties": {
8297
- "key": {
8298
- "maxLength": 100,
8299
- "type": "string",
8300
- "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"
8301
- }
8302
- },
8303
- "required": [
8304
- "key"
8305
- ],
8306
- "shortClassName": "dialogModuleOptions",
8307
- "type": "object",
8308
- "title": "Dialog Module Options",
8309
- "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"
8310
- },
8311
8295
  {
8312
8296
  "properties": {
8313
8297
  "offsetX": {
@@ -8354,6 +8338,22 @@
8354
8338
  "type": "object",
8355
8339
  "title": "Inline Dialog Options",
8356
8340
  "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"
8341
+ },
8342
+ {
8343
+ "properties": {
8344
+ "key": {
8345
+ "maxLength": 100,
8346
+ "type": "string",
8347
+ "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"
8348
+ }
8349
+ },
8350
+ "required": [
8351
+ "key"
8352
+ ],
8353
+ "shortClassName": "dialogModuleOptions",
8354
+ "type": "object",
8355
+ "title": "Dialog Module Options",
8356
+ "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"
8357
8357
  }
8358
8358
  ]
8359
8359
  },
@@ -9651,10 +9651,10 @@
9651
9651
  "type": "object",
9652
9652
  "anyOf": [
9653
9653
  {
9654
- "$ref": "#/definitions/singleCondition"
9654
+ "$ref": "#"
9655
9655
  },
9656
9656
  {
9657
- "$ref": "#"
9657
+ "$ref": "#/definitions/singleCondition"
9658
9658
  }
9659
9659
  ]
9660
9660
  },
@@ -3036,7 +3036,7 @@ export interface Modules {
3036
3036
  fullPage?: boolean;
3037
3037
  cacheable?: boolean;
3038
3038
  location?: string;
3039
- conditions?: (CompositeCondition | SingleCondition)[];
3039
+ conditions?: (SingleCondition | CompositeCondition)[];
3040
3040
  params?: {
3041
3041
  [k: string]: unknown;
3042
3042
  };
@@ -3051,7 +3051,7 @@ export interface Modules {
3051
3051
  fullPage?: boolean;
3052
3052
  cacheable?: boolean;
3053
3053
  location?: string;
3054
- conditions?: (CompositeCondition | SingleCondition)[];
3054
+ conditions?: (SingleCondition | CompositeCondition)[];
3055
3055
  params?: {
3056
3056
  [k: string]: unknown;
3057
3057
  };
@@ -3069,7 +3069,7 @@ export interface Modules {
3069
3069
  location?: string;
3070
3070
  cacheable?: boolean;
3071
3071
  supportsNative?: boolean;
3072
- conditions?: (CompositeCondition | SingleCondition)[];
3072
+ conditions?: (SingleCondition | CompositeCondition)[];
3073
3073
  params?: {
3074
3074
  [k: string]: unknown;
3075
3075
  };
@@ -3085,7 +3085,7 @@ export interface Modules {
3085
3085
  location?: string;
3086
3086
  cacheable?: boolean;
3087
3087
  supportsNative?: boolean;
3088
- conditions?: (CompositeCondition | SingleCondition)[];
3088
+ conditions?: (SingleCondition | CompositeCondition)[];
3089
3089
  params?: {
3090
3090
  [k: string]: unknown;
3091
3091
  };
@@ -3099,7 +3099,7 @@ export interface Modules {
3099
3099
  filter?: string;
3100
3100
  excludeBody?: boolean;
3101
3101
  event?: string;
3102
- conditions?: (CompositeCondition | SingleCondition)[];
3102
+ conditions?: (SingleCondition | CompositeCondition)[];
3103
3103
  propertyKeys?: string[];
3104
3104
  url?: string;
3105
3105
  key: ModuleKeySchema;
@@ -3109,7 +3109,7 @@ export interface Modules {
3109
3109
  filter?: string;
3110
3110
  excludeBody?: boolean;
3111
3111
  event?: string;
3112
- conditions?: (CompositeCondition | SingleCondition)[];
3112
+ conditions?: (SingleCondition | CompositeCondition)[];
3113
3113
  propertyKeys?: string[];
3114
3114
  url?: string;
3115
3115
  key: ModuleKeySchema;
@@ -3248,7 +3248,7 @@ export interface Modules {
3248
3248
  fullPage?: boolean;
3249
3249
  cacheable?: boolean;
3250
3250
  location?: string;
3251
- conditions?: (CompositeCondition | SingleCondition)[];
3251
+ conditions?: (SingleCondition | CompositeCondition)[];
3252
3252
  params?: {
3253
3253
  [k: string]: unknown;
3254
3254
  };
@@ -3263,7 +3263,7 @@ export interface Modules {
3263
3263
  fullPage?: boolean;
3264
3264
  cacheable?: boolean;
3265
3265
  location?: string;
3266
- conditions?: (CompositeCondition | SingleCondition)[];
3266
+ conditions?: (SingleCondition | CompositeCondition)[];
3267
3267
  params?: {
3268
3268
  [k: string]: unknown;
3269
3269
  };
@@ -3313,7 +3313,7 @@ export interface Modules {
3313
3313
  name?: I18NProperty63;
3314
3314
  weight?: number;
3315
3315
  location?: string;
3316
- conditions?: (CompositeCondition7 | SingleCondition5)[];
3316
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
3317
3317
  params?: {
3318
3318
  [k: string]: unknown;
3319
3319
  };
@@ -3325,7 +3325,7 @@ export interface Modules {
3325
3325
  name?: I18NProperty63;
3326
3326
  weight?: number;
3327
3327
  location?: string;
3328
- conditions?: (CompositeCondition7 | SingleCondition5)[];
3328
+ conditions?: (SingleCondition5 | CompositeCondition7)[];
3329
3329
  params?: {
3330
3330
  [k: string]: unknown;
3331
3331
  };
@@ -3756,7 +3756,7 @@ export interface I18NProperty1 {
3756
3756
  *
3757
3757
  */
3758
3758
  export interface CompositeCondition {
3759
- conditions?: (SingleCondition | ManifestSchema)[];
3759
+ conditions?: (ManifestSchema | SingleCondition)[];
3760
3760
  type?: 'and' | 'AND' | 'or' | 'OR';
3761
3761
  [k: string]: unknown;
3762
3762
  }
@@ -6464,10 +6464,47 @@ export interface Icon10 {
6464
6464
  *
6465
6465
  */
6466
6466
  export interface WebItemTarget1 {
6467
- options?: DialogOptions2 | InlineDialogOptions1 | DialogModuleOptions1;
6467
+ options?: InlineDialogOptions1 | DialogOptions2 | DialogModuleOptions1;
6468
6468
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
6469
6469
  [k: string]: unknown;
6470
6470
  }
6471
+ /**
6472
+ *
6473
+ *
6474
+ * Options for an inline dialog target
6475
+ *
6476
+ * <h3>Example</h3>
6477
+ *
6478
+ *
6479
+ *
6480
+ *
6481
+ *
6482
+ * {
6483
+ * "target": {
6484
+ * "type": "inlinedialog",
6485
+ * "options": {
6486
+ * "onHover": true,
6487
+ * "offsetX": "30px",
6488
+ * "offsetY": "20px"
6489
+ * }
6490
+ * }
6491
+ * }
6492
+ *
6493
+ *
6494
+ *
6495
+ */
6496
+ export interface InlineDialogOptions1 {
6497
+ offsetX?: string;
6498
+ offsetY?: string;
6499
+ width?: string;
6500
+ onTop?: boolean;
6501
+ showDelay?: number;
6502
+ closeOthers?: boolean;
6503
+ persistent?: boolean;
6504
+ onHover?: boolean;
6505
+ isRelativeToMouse?: boolean;
6506
+ [k: string]: unknown;
6507
+ }
6471
6508
  /**
6472
6509
  *
6473
6510
  *
@@ -6566,43 +6603,6 @@ export interface I18NProperty58 {
6566
6603
  i18n?: string;
6567
6604
  [k: string]: unknown;
6568
6605
  }
6569
- /**
6570
- *
6571
- *
6572
- * Options for an inline dialog target
6573
- *
6574
- * <h3>Example</h3>
6575
- *
6576
- *
6577
- *
6578
- *
6579
- *
6580
- * {
6581
- * "target": {
6582
- * "type": "inlinedialog",
6583
- * "options": {
6584
- * "onHover": true,
6585
- * "offsetX": "30px",
6586
- * "offsetY": "20px"
6587
- * }
6588
- * }
6589
- * }
6590
- *
6591
- *
6592
- *
6593
- */
6594
- export interface InlineDialogOptions1 {
6595
- offsetX?: string;
6596
- offsetY?: string;
6597
- width?: string;
6598
- onTop?: boolean;
6599
- showDelay?: number;
6600
- closeOthers?: boolean;
6601
- persistent?: boolean;
6602
- onHover?: boolean;
6603
- isRelativeToMouse?: boolean;
6604
- [k: string]: unknown;
6605
- }
6606
6606
  /**
6607
6607
  *
6608
6608
  *
@@ -6722,7 +6722,7 @@ export interface SingleCondition4 {
6722
6722
  *
6723
6723
  */
6724
6724
  export interface CompositeCondition6 {
6725
- conditions?: (ManifestSchema | SingleCondition)[];
6725
+ conditions?: (SingleCondition | ManifestSchema)[];
6726
6726
  type?: 'and' | 'AND' | 'or' | 'OR';
6727
6727
  [k: string]: unknown;
6728
6728
  }
@@ -7080,6 +7080,37 @@ export interface I18NProperty63 {
7080
7080
  i18n?: string;
7081
7081
  [k: string]: unknown;
7082
7082
  }
7083
+ /**
7084
+ *
7085
+ *
7086
+ * Single Conditions are either provided by the host application. See the complete documentation of
7087
+ * [Conditions](../../conditions/) for more information.
7088
+ *
7089
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
7090
+ * This is useful where you want to show the section if a certain condition is not satisfied.
7091
+ *
7092
+ * <h3>Example</h3>
7093
+ *
7094
+ *
7095
+ *
7096
+ *
7097
+ *
7098
+ * {
7099
+ * "condition": "user_is_logged_in",
7100
+ * "invert": false
7101
+ * }
7102
+ *
7103
+ *
7104
+ *
7105
+ */
7106
+ export interface SingleCondition5 {
7107
+ condition: string;
7108
+ invert?: boolean;
7109
+ params?: {
7110
+ [k: string]: unknown;
7111
+ };
7112
+ [k: string]: unknown;
7113
+ }
7083
7114
  /**
7084
7115
  *
7085
7116
  *
@@ -7117,41 +7148,10 @@ export interface I18NProperty63 {
7117
7148
  *
7118
7149
  */
7119
7150
  export interface CompositeCondition7 {
7120
- conditions?: (SingleCondition | ManifestSchema)[];
7151
+ conditions?: (ManifestSchema | SingleCondition)[];
7121
7152
  type?: 'and' | 'AND' | 'or' | 'OR';
7122
7153
  [k: string]: unknown;
7123
7154
  }
7124
- /**
7125
- *
7126
- *
7127
- * Single Conditions are either provided by the host application. See the complete documentation of
7128
- * [Conditions](../../conditions/) for more information.
7129
- *
7130
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
7131
- * This is useful where you want to show the section if a certain condition is not satisfied.
7132
- *
7133
- * <h3>Example</h3>
7134
- *
7135
- *
7136
- *
7137
- *
7138
- *
7139
- * {
7140
- * "condition": "user_is_logged_in",
7141
- * "invert": false
7142
- * }
7143
- *
7144
- *
7145
- *
7146
- */
7147
- export interface SingleCondition5 {
7148
- condition: string;
7149
- invert?: boolean;
7150
- params?: {
7151
- [k: string]: unknown;
7152
- };
7153
- [k: string]: unknown;
7154
- }
7155
7155
  /**
7156
7156
  *
7157
7157
  *
@@ -8571,11 +8571,39 @@ export interface I18NProperty74 {
8571
8571
  *
8572
8572
  */
8573
8573
  export interface MacroPropertyPanel {
8574
- controls?: (ControlGroup | ToggleGroup | TextControl | ButtonControl1)[];
8574
+ controls?: (TextControl | ControlGroup | ToggleGroup | ButtonControl1)[];
8575
8575
  cacheable?: boolean;
8576
8576
  url: string;
8577
8577
  [k: string]: unknown;
8578
8578
  }
8579
+ /**
8580
+ *
8581
+ *
8582
+ * Defines a text field which may appear in control extension points such as the property panel
8583
+ *
8584
+ * <p><b>Example</b></p>
8585
+ *
8586
+ *
8587
+ *
8588
+ *
8589
+ *
8590
+ * {
8591
+ * "type": "button",
8592
+ * "label": {
8593
+ * "value": "My Custom Control 0"
8594
+ * },
8595
+ * "key": "my-custom-control-0"
8596
+ * }
8597
+ *
8598
+ *
8599
+ *
8600
+ */
8601
+ export interface TextControl {
8602
+ macroParameter: string;
8603
+ type: 'text' | 'TEXT';
8604
+ key: string;
8605
+ [k: string]: unknown;
8606
+ }
8579
8607
  /**
8580
8608
  *
8581
8609
  *
@@ -8768,34 +8796,6 @@ export interface I18NProperty76 {
8768
8796
  i18n?: string;
8769
8797
  [k: string]: unknown;
8770
8798
  }
8771
- /**
8772
- *
8773
- *
8774
- * Defines a text field which may appear in control extension points such as the property panel
8775
- *
8776
- * <p><b>Example</b></p>
8777
- *
8778
- *
8779
- *
8780
- *
8781
- *
8782
- * {
8783
- * "type": "button",
8784
- * "label": {
8785
- * "value": "My Custom Control 0"
8786
- * },
8787
- * "key": "my-custom-control-0"
8788
- * }
8789
- *
8790
- *
8791
- *
8792
- */
8793
- export interface TextControl {
8794
- macroParameter: string;
8795
- type: 'text' | 'TEXT';
8796
- key: string;
8797
- [k: string]: unknown;
8798
- }
8799
8799
  /**
8800
8800
  *
8801
8801
  *
@@ -50942,7 +50942,7 @@ export interface I18NProperty91 {
50942
50942
  *
50943
50943
  */
50944
50944
  export interface WebItemTarget2 {
50945
- options?: DialogOptions4 | DialogModuleOptions2 | InlineDialogOptions2;
50945
+ options?: DialogOptions4 | InlineDialogOptions2 | DialogModuleOptions2;
50946
50946
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
50947
50947
  [k: string]: unknown;
50948
50948
  }
@@ -51047,7 +51047,7 @@ export interface I18NProperty92 {
51047
51047
  /**
51048
51048
  *
51049
51049
  *
51050
- * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
51050
+ * Options for an inline dialog target
51051
51051
  *
51052
51052
  * <h3>Example</h3>
51053
51053
  *
@@ -51057,9 +51057,11 @@ export interface I18NProperty92 {
51057
51057
  *
51058
51058
  * {
51059
51059
  * "target": {
51060
- * "type": "dialogmodule",
51060
+ * "type": "inlinedialog",
51061
51061
  * "options": {
51062
- * "key": "dialog-module-key"
51062
+ * "onHover": true,
51063
+ * "offsetX": "30px",
51064
+ * "offsetY": "20px"
51063
51065
  * }
51064
51066
  * }
51065
51067
  * }
@@ -51067,14 +51069,22 @@ export interface I18NProperty92 {
51067
51069
  *
51068
51070
  *
51069
51071
  */
51070
- export interface DialogModuleOptions2 {
51071
- key: string;
51072
+ export interface InlineDialogOptions2 {
51073
+ offsetX?: string;
51074
+ offsetY?: string;
51075
+ width?: string;
51076
+ onTop?: boolean;
51077
+ showDelay?: number;
51078
+ closeOthers?: boolean;
51079
+ persistent?: boolean;
51080
+ onHover?: boolean;
51081
+ isRelativeToMouse?: boolean;
51072
51082
  [k: string]: unknown;
51073
51083
  }
51074
51084
  /**
51075
51085
  *
51076
51086
  *
51077
- * Options for an inline dialog target
51087
+ * Options for a web-item targeting a common <a href="../dialog/">dialog module</a>.
51078
51088
  *
51079
51089
  * <h3>Example</h3>
51080
51090
  *
@@ -51084,11 +51094,9 @@ export interface DialogModuleOptions2 {
51084
51094
  *
51085
51095
  * {
51086
51096
  * "target": {
51087
- * "type": "inlinedialog",
51097
+ * "type": "dialogmodule",
51088
51098
  * "options": {
51089
- * "onHover": true,
51090
- * "offsetX": "30px",
51091
- * "offsetY": "20px"
51099
+ * "key": "dialog-module-key"
51092
51100
  * }
51093
51101
  * }
51094
51102
  * }
@@ -51096,16 +51104,8 @@ export interface DialogModuleOptions2 {
51096
51104
  *
51097
51105
  *
51098
51106
  */
51099
- export interface InlineDialogOptions2 {
51100
- offsetX?: string;
51101
- offsetY?: string;
51102
- width?: string;
51103
- onTop?: boolean;
51104
- showDelay?: number;
51105
- closeOthers?: boolean;
51106
- persistent?: boolean;
51107
- onHover?: boolean;
51108
- isRelativeToMouse?: boolean;
51107
+ export interface DialogModuleOptions2 {
51108
+ key: string;
51109
51109
  [k: string]: unknown;
51110
51110
  }
51111
51111
  /**
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/manifest",
3
- "version": "3.2.0-next.3",
3
+ "version": "3.2.0-next.4",
4
4
  "description": "Definitions and validations of the Forge manifest",
5
5
  "main": "out/index.js",
6
6
  "scripts": {