@forge/manifest 3.4.0-next.5 → 3.4.0-next.6

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.4.0-next.6
4
+
5
+ ### Patch Changes
6
+
7
+ - 1ca8bbc9: Update manifest definitions
8
+
3
9
  ## 3.4.0-next.5
4
10
 
5
11
  ### Patch Changes
@@ -5242,10 +5242,10 @@
5242
5242
  "type": "object",
5243
5243
  "anyOf": [
5244
5244
  {
5245
- "$ref": "#/definitions/compositeCondition"
5245
+ "$ref": "#/definitions/singleCondition"
5246
5246
  },
5247
5247
  {
5248
- "$ref": "#/definitions/singleCondition"
5248
+ "$ref": "#/definitions/compositeCondition"
5249
5249
  }
5250
5250
  ]
5251
5251
  },
@@ -5313,10 +5313,10 @@
5313
5313
  "type": "object",
5314
5314
  "anyOf": [
5315
5315
  {
5316
- "$ref": "#/definitions/singleCondition"
5316
+ "$ref": "#/definitions/compositeCondition"
5317
5317
  },
5318
5318
  {
5319
- "$ref": "#/definitions/compositeCondition"
5319
+ "$ref": "#/definitions/singleCondition"
5320
5320
  }
5321
5321
  ]
5322
5322
  },
@@ -5368,10 +5368,10 @@
5368
5368
  "type": "object",
5369
5369
  "anyOf": [
5370
5370
  {
5371
- "$ref": "#/definitions/compositeCondition"
5371
+ "$ref": "#/definitions/singleCondition"
5372
5372
  },
5373
5373
  {
5374
- "$ref": "#/definitions/singleCondition"
5374
+ "$ref": "#/definitions/compositeCondition"
5375
5375
  }
5376
5376
  ]
5377
5377
  },
@@ -5621,6 +5621,51 @@
5621
5621
  "type": "object",
5622
5622
  "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",
5623
5623
  "anyOf": [
5624
+ {
5625
+ "properties": {
5626
+ "size": {
5627
+ "enum": [
5628
+ "small",
5629
+ "SMALL",
5630
+ "medium",
5631
+ "MEDIUM",
5632
+ "large",
5633
+ "LARGE",
5634
+ "x-large",
5635
+ "X-LARGE",
5636
+ "fullscreen",
5637
+ "FULLSCREEN",
5638
+ "maximum",
5639
+ "MAXIMUM"
5640
+ ],
5641
+ "type": "string",
5642
+ "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"
5643
+ },
5644
+ "chrome": {
5645
+ "type": "boolean",
5646
+ "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
5647
+ "defaultValue": "true"
5648
+ },
5649
+ "width": {
5650
+ "maxLength": 10,
5651
+ "type": "string",
5652
+ "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5653
+ },
5654
+ "header": {
5655
+ "$ref": "#/definitions/i18nProperty",
5656
+ "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
5657
+ },
5658
+ "height": {
5659
+ "maxLength": 10,
5660
+ "type": "string",
5661
+ "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
5662
+ }
5663
+ },
5664
+ "shortClassName": "dialogOptions",
5665
+ "type": "object",
5666
+ "title": "Dialog Options",
5667
+ "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"
5668
+ },
5624
5669
  {
5625
5670
  "properties": {
5626
5671
  "offsetX": {
@@ -5668,51 +5713,6 @@
5668
5713
  "title": "Inline Dialog Options",
5669
5714
  "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"
5670
5715
  },
5671
- {
5672
- "properties": {
5673
- "size": {
5674
- "enum": [
5675
- "small",
5676
- "SMALL",
5677
- "medium",
5678
- "MEDIUM",
5679
- "large",
5680
- "LARGE",
5681
- "x-large",
5682
- "X-LARGE",
5683
- "fullscreen",
5684
- "FULLSCREEN",
5685
- "maximum",
5686
- "MAXIMUM"
5687
- ],
5688
- "type": "string",
5689
- "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"
5690
- },
5691
- "chrome": {
5692
- "type": "boolean",
5693
- "fieldDescription": "\n\nWhether the dialog should contain the AUI header and buttons.\n\n",
5694
- "defaultValue": "true"
5695
- },
5696
- "width": {
5697
- "maxLength": 10,
5698
- "type": "string",
5699
- "fieldDescription": "\n\nSets how wide the dialog is in pixels.\n\n"
5700
- },
5701
- "header": {
5702
- "$ref": "#/definitions/i18nProperty",
5703
- "fieldDescription": "\n\nThe header text for the dialog, if chrome is enabled.\n\n"
5704
- },
5705
- "height": {
5706
- "maxLength": 10,
5707
- "type": "string",
5708
- "fieldDescription": "\n\nSets how high the dialog is in pixels\n\n"
5709
- }
5710
- },
5711
- "shortClassName": "dialogOptions",
5712
- "type": "object",
5713
- "title": "Dialog Options",
5714
- "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"
5715
- },
5716
5716
  {
5717
5717
  "properties": {
5718
5718
  "key": {
@@ -5791,10 +5791,10 @@
5791
5791
  "type": "object",
5792
5792
  "anyOf": [
5793
5793
  {
5794
- "$ref": "#/definitions/singleCondition"
5794
+ "$ref": "#"
5795
5795
  },
5796
5796
  {
5797
- "$ref": "#"
5797
+ "$ref": "#/definitions/singleCondition"
5798
5798
  }
5799
5799
  ]
5800
5800
  },
@@ -5896,10 +5896,10 @@
5896
5896
  "type": "object",
5897
5897
  "anyOf": [
5898
5898
  {
5899
- "$ref": "#/definitions/compositeCondition"
5899
+ "$ref": "#/definitions/singleCondition"
5900
5900
  },
5901
5901
  {
5902
- "$ref": "#/definitions/singleCondition"
5902
+ "$ref": "#/definitions/compositeCondition"
5903
5903
  }
5904
5904
  ]
5905
5905
  },
@@ -11040,6 +11040,33 @@
11040
11040
  "title": "Icon",
11041
11041
  "description": "\n\nDefines an icon to display.\n\n <h3>Example</h3>\n\n\n\n\n\n {\n \"icon\": {\n \"width\": 16,\n \"height\": 16,\n \"url\": \"/my-icon.png\"\n }\n }\n\n\n"
11042
11042
  },
11043
+ "singleCondition": {
11044
+ "properties": {
11045
+ "condition": {
11046
+ "maxLength": 100,
11047
+ "type": "string",
11048
+ "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
11049
+ },
11050
+ "invert": {
11051
+ "type": "boolean",
11052
+ "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
11053
+ "defaultValue": "false"
11054
+ },
11055
+ "params": {
11056
+ "additionalProperties": true,
11057
+ "type": "object",
11058
+ "fieldTitle": "Object",
11059
+ "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"
11060
+ }
11061
+ },
11062
+ "required": [
11063
+ "condition"
11064
+ ],
11065
+ "shortClassName": "singleConditionBean",
11066
+ "type": "object",
11067
+ "title": "Single Condition",
11068
+ "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"
11069
+ },
11043
11070
  "compositeCondition": {
11044
11071
  "properties": {
11045
11072
  "conditions": {
@@ -11073,33 +11100,6 @@
11073
11100
  "title": "Composite Condition",
11074
11101
  "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"
11075
11102
  },
11076
- "singleCondition": {
11077
- "properties": {
11078
- "condition": {
11079
- "maxLength": 100,
11080
- "type": "string",
11081
- "fieldDescription": "\n\nA string indicating the name of the condition\n\n"
11082
- },
11083
- "invert": {
11084
- "type": "boolean",
11085
- "fieldDescription": "\n\nA flag indicating whether to invert the boolean result of the condition.\n\n",
11086
- "defaultValue": "false"
11087
- },
11088
- "params": {
11089
- "additionalProperties": true,
11090
- "type": "object",
11091
- "fieldTitle": "Object",
11092
- "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"
11093
- }
11094
- },
11095
- "required": [
11096
- "condition"
11097
- ],
11098
- "shortClassName": "singleConditionBean",
11099
- "type": "object",
11100
- "title": "Single Condition",
11101
- "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"
11102
- },
11103
11103
  "webPanelLayout": {
11104
11104
  "properties": {
11105
11105
  "width": {
@@ -2799,7 +2799,7 @@ export interface Modules {
2799
2799
  fullPage?: boolean;
2800
2800
  cacheable?: boolean;
2801
2801
  location?: string;
2802
- conditions?: (CompositeCondition | SingleCondition)[];
2802
+ conditions?: (SingleCondition | CompositeCondition)[];
2803
2803
  params?: {
2804
2804
  [k: string]: unknown;
2805
2805
  };
@@ -2814,7 +2814,7 @@ export interface Modules {
2814
2814
  fullPage?: boolean;
2815
2815
  cacheable?: boolean;
2816
2816
  location?: string;
2817
- conditions?: (CompositeCondition | SingleCondition)[];
2817
+ conditions?: (SingleCondition | CompositeCondition)[];
2818
2818
  params?: {
2819
2819
  [k: string]: unknown;
2820
2820
  };
@@ -2832,7 +2832,7 @@ export interface Modules {
2832
2832
  location?: string;
2833
2833
  cacheable?: boolean;
2834
2834
  supportsNative?: boolean;
2835
- conditions?: (SingleCondition | CompositeCondition)[];
2835
+ conditions?: (CompositeCondition | SingleCondition)[];
2836
2836
  params?: {
2837
2837
  [k: string]: unknown;
2838
2838
  };
@@ -2848,7 +2848,7 @@ export interface Modules {
2848
2848
  location?: string;
2849
2849
  cacheable?: boolean;
2850
2850
  supportsNative?: boolean;
2851
- conditions?: (SingleCondition | CompositeCondition)[];
2851
+ conditions?: (CompositeCondition | SingleCondition)[];
2852
2852
  params?: {
2853
2853
  [k: string]: unknown;
2854
2854
  };
@@ -2862,7 +2862,7 @@ export interface Modules {
2862
2862
  filter?: string;
2863
2863
  excludeBody?: boolean;
2864
2864
  event?: string;
2865
- conditions?: (CompositeCondition | SingleCondition)[];
2865
+ conditions?: (SingleCondition | CompositeCondition)[];
2866
2866
  propertyKeys?: string[];
2867
2867
  url?: string;
2868
2868
  key: ModuleKeySchema;
@@ -2872,7 +2872,7 @@ export interface Modules {
2872
2872
  filter?: string;
2873
2873
  excludeBody?: boolean;
2874
2874
  event?: string;
2875
- conditions?: (CompositeCondition | SingleCondition)[];
2875
+ conditions?: (SingleCondition | CompositeCondition)[];
2876
2876
  propertyKeys?: string[];
2877
2877
  url?: string;
2878
2878
  key: ModuleKeySchema;
@@ -3011,7 +3011,7 @@ export interface Modules {
3011
3011
  fullPage?: boolean;
3012
3012
  cacheable?: boolean;
3013
3013
  location?: string;
3014
- conditions?: (CompositeCondition | SingleCondition)[];
3014
+ conditions?: (SingleCondition | CompositeCondition)[];
3015
3015
  params?: {
3016
3016
  [k: string]: unknown;
3017
3017
  };
@@ -3026,7 +3026,7 @@ export interface Modules {
3026
3026
  fullPage?: boolean;
3027
3027
  cacheable?: boolean;
3028
3028
  location?: string;
3029
- conditions?: (CompositeCondition | SingleCondition)[];
3029
+ conditions?: (SingleCondition | CompositeCondition)[];
3030
3030
  params?: {
3031
3031
  [k: string]: unknown;
3032
3032
  };
@@ -4410,6 +4410,37 @@ export interface I18NProperty1 {
4410
4410
  i18n?: string;
4411
4411
  [k: string]: unknown;
4412
4412
  }
4413
+ /**
4414
+ *
4415
+ *
4416
+ * Single Conditions are either provided by the host application. See the complete documentation of
4417
+ * [Conditions](../../conditions/) for more information.
4418
+ *
4419
+ * To invert a condition, add the attribute ``invert="true"`` to the condition element.
4420
+ * This is useful where you want to show the section if a certain condition is not satisfied.
4421
+ *
4422
+ * <h3>Example</h3>
4423
+ *
4424
+ *
4425
+ *
4426
+ *
4427
+ *
4428
+ * {
4429
+ * "condition": "user_is_logged_in",
4430
+ * "invert": false
4431
+ * }
4432
+ *
4433
+ *
4434
+ *
4435
+ */
4436
+ export interface SingleCondition {
4437
+ condition: string;
4438
+ invert?: boolean;
4439
+ params?: {
4440
+ [k: string]: unknown;
4441
+ };
4442
+ [k: string]: unknown;
4443
+ }
4413
4444
  /**
4414
4445
  *
4415
4446
  *
@@ -4451,37 +4482,6 @@ export interface CompositeCondition {
4451
4482
  type?: 'and' | 'AND' | 'or' | 'OR';
4452
4483
  [k: string]: unknown;
4453
4484
  }
4454
- /**
4455
- *
4456
- *
4457
- * Single Conditions are either provided by the host application. See the complete documentation of
4458
- * [Conditions](../../conditions/) for more information.
4459
- *
4460
- * To invert a condition, add the attribute ``invert="true"`` to the condition element.
4461
- * This is useful where you want to show the section if a certain condition is not satisfied.
4462
- *
4463
- * <h3>Example</h3>
4464
- *
4465
- *
4466
- *
4467
- *
4468
- *
4469
- * {
4470
- * "condition": "user_is_logged_in",
4471
- * "invert": false
4472
- * }
4473
- *
4474
- *
4475
- *
4476
- */
4477
- export interface SingleCondition {
4478
- condition: string;
4479
- invert?: boolean;
4480
- params?: {
4481
- [k: string]: unknown;
4482
- };
4483
- [k: string]: unknown;
4484
- }
4485
4485
  /**
4486
4486
  *
4487
4487
  *
@@ -4825,47 +4825,10 @@ export interface Icon3 {
4825
4825
  *
4826
4826
  */
4827
4827
  export interface WebItemTarget {
4828
- options?: InlineDialogOptions | DialogOptions | DialogModuleOptions;
4828
+ options?: DialogOptions | InlineDialogOptions | DialogModuleOptions;
4829
4829
  type?: 'page' | 'PAGE' | 'dialog' | 'DIALOG' | 'inlinedialog' | 'INLINEDIALOG' | 'dialogmodule' | 'DIALOGMODULE';
4830
4830
  [k: string]: unknown;
4831
4831
  }
4832
- /**
4833
- *
4834
- *
4835
- * Options for an inline dialog target
4836
- *
4837
- * <h3>Example</h3>
4838
- *
4839
- *
4840
- *
4841
- *
4842
- *
4843
- * {
4844
- * "target": {
4845
- * "type": "inlinedialog",
4846
- * "options": {
4847
- * "onHover": true,
4848
- * "offsetX": "30px",
4849
- * "offsetY": "20px"
4850
- * }
4851
- * }
4852
- * }
4853
- *
4854
- *
4855
- *
4856
- */
4857
- export interface InlineDialogOptions {
4858
- offsetX?: string;
4859
- offsetY?: string;
4860
- width?: string;
4861
- onTop?: boolean;
4862
- showDelay?: number;
4863
- closeOthers?: boolean;
4864
- persistent?: boolean;
4865
- onHover?: boolean;
4866
- isRelativeToMouse?: boolean;
4867
- [k: string]: unknown;
4868
- }
4869
4832
  /**
4870
4833
  *
4871
4834
  *
@@ -4964,6 +4927,43 @@ export interface I18NProperty9 {
4964
4927
  i18n?: string;
4965
4928
  [k: string]: unknown;
4966
4929
  }
4930
+ /**
4931
+ *
4932
+ *
4933
+ * Options for an inline dialog target
4934
+ *
4935
+ * <h3>Example</h3>
4936
+ *
4937
+ *
4938
+ *
4939
+ *
4940
+ *
4941
+ * {
4942
+ * "target": {
4943
+ * "type": "inlinedialog",
4944
+ * "options": {
4945
+ * "onHover": true,
4946
+ * "offsetX": "30px",
4947
+ * "offsetY": "20px"
4948
+ * }
4949
+ * }
4950
+ * }
4951
+ *
4952
+ *
4953
+ *
4954
+ */
4955
+ export interface InlineDialogOptions {
4956
+ offsetX?: string;
4957
+ offsetY?: string;
4958
+ width?: string;
4959
+ onTop?: boolean;
4960
+ showDelay?: number;
4961
+ closeOthers?: boolean;
4962
+ persistent?: boolean;
4963
+ onHover?: boolean;
4964
+ isRelativeToMouse?: boolean;
4965
+ [k: string]: unknown;
4966
+ }
4967
4967
  /**
4968
4968
  *
4969
4969
  *
@@ -5052,7 +5052,7 @@ export interface I18NProperty10 {
5052
5052
  *
5053
5053
  */
5054
5054
  export interface CompositeCondition1 {
5055
- conditions?: (SingleCondition | ManifestSchema)[];
5055
+ conditions?: (ManifestSchema | SingleCondition)[];
5056
5056
  type?: 'and' | 'AND' | 'or' | 'OR';
5057
5057
  [k: string]: unknown;
5058
5058
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/manifest",
3
- "version": "3.4.0-next.5",
3
+ "version": "3.4.0-next.6",
4
4
  "description": "Definitions and validations of the Forge manifest",
5
5
  "main": "out/index.js",
6
6
  "scripts": {