@forge/manifest 3.5.0-next.3 → 3.5.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.
Files changed (4) hide show
  1. package/CHANGELOG.md +6 -0
  2. package/out/schema/manifest-schema.json +84 -65
  3. package/out/schema/manifest.d.ts +54 -30
  4. package/package.json +1 -1
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # @forge/manifest
2
2
 
3
+ ## 3.5.0-next.4
4
+
5
+ ### Patch Changes
6
+
7
+ - e411a29: Update manifest definitions
8
+
3
9
  ## 3.5.0-next.3
4
10
 
5
11
  ### Minor Changes
package/out/schema/manifest-schema.json CHANGED
@@ -1116,6 +1116,11 @@
1116
1116
  "default": false,
1117
1117
  "description": "A flag indicating whether this settings instance will be used as the app's configuration"
1118
1118
  },
1119
+ "useAsGetStarted": {
1120
+ "type": "boolean",
1121
+ "default": false,
1122
+ "description": "A flag indicating whether this settings instance will be used as the app's \"Get Started\""
1123
+ },
1119
1124
  "key": {
1120
1125
  "$ref": "#/definitions/ModuleKeySchema"
1121
1126
  }
@@ -1168,6 +1173,11 @@
1168
1173
  "default": false,
1169
1174
  "description": "A flag indicating whether this settings instance will be used as the app's configuration"
1170
1175
  },
1176
+ "useAsGetStarted": {
1177
+ "type": "boolean",
1178
+ "default": false,
1179
+ "description": "A flag indicating whether this settings instance will be used as the app's \"Get Started\""
1180
+ },
1171
1181
  "key": {
1172
1182
  "$ref": "#/definitions/ModuleKeySchema"
1173
1183
  }
@@ -1315,7 +1325,22 @@
1315
1325
  "type": "string"
1316
1326
  },
1317
1327
  "errorMessage": {
1318
- "type": "string"
1328
+ "anyOf": [
1329
+ {
1330
+ "type": "object",
1331
+ "properties": {
1332
+ "expression": {
1333
+ "type": "string"
1334
+ }
1335
+ },
1336
+ "required": [
1337
+ "expression"
1338
+ ]
1339
+ },
1340
+ {
1341
+ "type": "string"
1342
+ }
1343
+ ]
1319
1344
  },
1320
1345
  "view": {
1321
1346
  "type": "object",
@@ -2779,63 +2804,64 @@
2779
2804
  {
2780
2805
  "type": "object",
2781
2806
  "properties": {
2807
+ "function": {
2808
+ "type": "string",
2809
+ "minLength": 1,
2810
+ "maxLength": 255,
2811
+ "pattern": "^[a-zA-Z0-9-_]+$"
2812
+ },
2813
+ "edit": {
2814
+ "type": "object",
2815
+ "properties": {
2816
+ "function": {
2817
+ "type": "string",
2818
+ "minLength": 1,
2819
+ "maxLength": 255,
2820
+ "pattern": "^[a-zA-Z0-9-_]+$"
2821
+ }
2822
+ },
2823
+ "required": [
2824
+ "function"
2825
+ ]
2826
+ },
2782
2827
  "title": {
2783
- "oneOf": [
2828
+ "minLength": 1,
2829
+ "maxLength": 255,
2830
+ "anyOf": [
2784
2831
  {
2785
2832
  "type": "object",
2786
2833
  "properties": {
2787
2834
  "text": {
2788
- "type": "string",
2789
2835
  "minLength": 1,
2790
- "maxLength": 255
2836
+ "maxLength": 255,
2837
+ "type": "string"
2791
2838
  },
2792
2839
  "href": {
2793
- "type": "string",
2794
2840
  "minLength": 1,
2795
- "maxLength": 1000
2841
+ "maxLength": 1000,
2842
+ "type": "string"
2796
2843
  }
2797
2844
  },
2798
2845
  "required": [
2846
+ "href",
2799
2847
  "text"
2800
2848
  ]
2801
2849
  },
2802
2850
  {
2803
- "type": "string",
2804
- "minLength": 1,
2805
- "maxLength": 255
2851
+ "type": "string"
2806
2852
  }
2807
2853
  ]
2808
2854
  },
2809
2855
  "description": {
2810
- "type": "string",
2811
2856
  "minLength": 1,
2812
- "maxLength": 255
2857
+ "maxLength": 255,
2858
+ "type": "string"
2813
2859
  },
2814
2860
  "thumbnail": {
2815
2861
  "type": "string",
2816
2862
  "minLength": 1,
2817
2863
  "maxLength": 255
2818
2864
  },
2819
- "function": {
2820
- "type": "string",
2821
- "minLength": 1,
2822
- "maxLength": 255,
2823
- "pattern": "^[a-zA-Z0-9-_]+$"
2824
- },
2825
- "edit": {
2826
- "type": "object",
2827
- "properties": {
2828
- "function": {
2829
- "type": "string",
2830
- "minLength": 1,
2831
- "maxLength": 255,
2832
- "pattern": "^[a-zA-Z0-9-_]+$"
2833
- }
2834
- },
2835
- "required": [
2836
- "function"
2837
- ]
2838
- },
2839
2865
  "displayConditions": {
2840
2866
  "type": "object",
2841
2867
  "properties": {}
@@ -2845,10 +2871,9 @@
2845
2871
  }
2846
2872
  },
2847
2873
  "required": [
2848
- "title",
2849
2874
  "description",
2850
- "thumbnail",
2851
2875
  "function",
2876
+ "title",
2852
2877
  "key"
2853
2878
  ]
2854
2879
  },
@@ -2876,63 +2901,58 @@
2876
2901
  "function"
2877
2902
  ]
2878
2903
  },
2904
+ "edit": {
2905
+ "type": "object",
2906
+ "properties": {
2907
+ "resource": {
2908
+ "type": "string",
2909
+ "minLength": 1,
2910
+ "maxLength": 23,
2911
+ "pattern": "^[a-zA-Z0-9_\\-]+$"
2912
+ }
2913
+ },
2914
+ "required": [
2915
+ "resource"
2916
+ ]
2917
+ },
2879
2918
  "title": {
2880
- "oneOf": [
2919
+ "minLength": 1,
2920
+ "maxLength": 255,
2921
+ "anyOf": [
2881
2922
  {
2882
2923
  "type": "object",
2883
2924
  "properties": {
2884
2925
  "text": {
2885
- "type": "string",
2886
2926
  "minLength": 1,
2887
- "maxLength": 255
2927
+ "maxLength": 255,
2928
+ "type": "string"
2888
2929
  },
2889
2930
  "href": {
2890
- "type": "string",
2891
2931
  "minLength": 1,
2892
- "maxLength": 1000
2932
+ "maxLength": 1000,
2933
+ "type": "string"
2893
2934
  }
2894
2935
  },
2895
2936
  "required": [
2937
+ "href",
2896
2938
  "text"
2897
2939
  ]
2898
2940
  },
2899
2941
  {
2900
- "type": "string",
2901
- "minLength": 1,
2902
- "maxLength": 255
2942
+ "type": "string"
2903
2943
  }
2904
2944
  ]
2905
2945
  },
2906
2946
  "description": {
2907
- "type": "string",
2908
2947
  "minLength": 1,
2909
- "maxLength": 255
2948
+ "maxLength": 255,
2949
+ "type": "string"
2910
2950
  },
2911
2951
  "thumbnail": {
2912
2952
  "type": "string",
2913
2953
  "minLength": 1,
2914
2954
  "maxLength": 255
2915
2955
  },
2916
- "function": {
2917
- "type": "string",
2918
- "minLength": 1,
2919
- "maxLength": 255,
2920
- "pattern": "^[a-zA-Z0-9-_]+$"
2921
- },
2922
- "edit": {
2923
- "type": "object",
2924
- "properties": {
2925
- "resource": {
2926
- "type": "string",
2927
- "minLength": 1,
2928
- "maxLength": 23,
2929
- "pattern": "^[a-zA-Z0-9_\\-]+$"
2930
- }
2931
- },
2932
- "required": [
2933
- "resource"
2934
- ]
2935
- },
2936
2956
  "displayConditions": {
2937
2957
  "type": "object",
2938
2958
  "properties": {}
@@ -2942,10 +2962,9 @@
2942
2962
  }
2943
2963
  },
2944
2964
  "required": [
2945
- "title",
2946
2965
  "description",
2947
- "thumbnail",
2948
2966
  "resource",
2967
+ "title",
2949
2968
  "key"
2950
2969
  ]
2951
2970
  }
package/out/schema/manifest.d.ts CHANGED
@@ -667,6 +667,10 @@ export interface Modules {
667
667
  * A flag indicating whether this settings instance will be used as the app's configuration
668
668
  */
669
669
  useAsConfig?: boolean;
670
+ /**
671
+ * A flag indicating whether this settings instance will be used as the app's "Get Started"
672
+ */
673
+ useAsGetStarted?: boolean;
670
674
  key: ModuleKeySchema;
671
675
  [k: string]: unknown;
672
676
  }
@@ -684,6 +688,10 @@ export interface Modules {
684
688
  * A flag indicating whether this settings instance will be used as the app's configuration
685
689
  */
686
690
  useAsConfig?: boolean;
691
+ /**
692
+ * A flag indicating whether this settings instance will be used as the app's "Get Started"
693
+ */
694
+ useAsGetStarted?: boolean;
687
695
  key: ModuleKeySchema;
688
696
  [k: string]: unknown;
689
697
  }
@@ -699,6 +707,10 @@ export interface Modules {
699
707
  * A flag indicating whether this settings instance will be used as the app's configuration
700
708
  */
701
709
  useAsConfig?: boolean;
710
+ /**
711
+ * A flag indicating whether this settings instance will be used as the app's "Get Started"
712
+ */
713
+ useAsGetStarted?: boolean;
702
714
  key: ModuleKeySchema;
703
715
  [k: string]: unknown;
704
716
  }
@@ -716,6 +728,10 @@ export interface Modules {
716
728
  * A flag indicating whether this settings instance will be used as the app's configuration
717
729
  */
718
730
  useAsConfig?: boolean;
731
+ /**
732
+ * A flag indicating whether this settings instance will be used as the app's "Get Started"
733
+ */
734
+ useAsGetStarted?: boolean;
719
735
  key: ModuleKeySchema;
720
736
  [k: string]: unknown;
721
737
  }
@@ -781,7 +797,12 @@ export interface Modules {
781
797
  description: string;
782
798
  function?: string;
783
799
  expression?: string;
784
- errorMessage?: string;
800
+ errorMessage?:
801
+ | {
802
+ expression: string;
803
+ [k: string]: unknown;
804
+ }
805
+ | string;
785
806
  view?: {
786
807
  resource: string;
787
808
  [k: string]: unknown;
@@ -802,7 +823,12 @@ export interface Modules {
802
823
  description: string;
803
824
  function?: string;
804
825
  expression?: string;
805
- errorMessage?: string;
826
+ errorMessage?:
827
+ | {
828
+ expression: string;
829
+ [k: string]: unknown;
830
+ }
831
+ | string;
806
832
  view?: {
807
833
  resource: string;
808
834
  [k: string]: unknown;
@@ -1584,20 +1610,20 @@ export interface Modules {
1584
1610
  'jira:dashboardGadget'?: [
1585
1611
  (
1586
1612
  | {
1613
+ function: string;
1614
+ edit?: {
1615
+ function: string;
1616
+ [k: string]: unknown;
1617
+ };
1587
1618
  title:
1588
1619
  | {
1589
1620
  text: string;
1590
- href?: string;
1621
+ href: string;
1591
1622
  [k: string]: unknown;
1592
1623
  }
1593
1624
  | string;
1594
1625
  description: string;
1595
- thumbnail: string;
1596
- function: string;
1597
- edit?: {
1598
- function: string;
1599
- [k: string]: unknown;
1600
- };
1626
+ thumbnail?: string;
1601
1627
  displayConditions?: {
1602
1628
  [k: string]: unknown;
1603
1629
  };
@@ -1609,20 +1635,19 @@ export interface Modules {
1609
1635
  resolver?: {
1610
1636
  function: string;
1611
1637
  };
1638
+ edit?: {
1639
+ resource: string;
1640
+ [k: string]: unknown;
1641
+ };
1612
1642
  title:
1613
1643
  | {
1614
1644
  text: string;
1615
- href?: string;
1645
+ href: string;
1616
1646
  [k: string]: unknown;
1617
1647
  }
1618
1648
  | string;
1619
1649
  description: string;
1620
- thumbnail: string;
1621
- function?: string;
1622
- edit?: {
1623
- resource: string;
1624
- [k: string]: unknown;
1625
- };
1650
+ thumbnail?: string;
1626
1651
  displayConditions?: {
1627
1652
  [k: string]: unknown;
1628
1653
  };
@@ -1632,20 +1657,20 @@ export interface Modules {
1632
1657
  ),
1633
1658
  ...(
1634
1659
  | {
1660
+ function: string;
1661
+ edit?: {
1662
+ function: string;
1663
+ [k: string]: unknown;
1664
+ };
1635
1665
  title:
1636
1666
  | {
1637
1667
  text: string;
1638
- href?: string;
1668
+ href: string;
1639
1669
  [k: string]: unknown;
1640
1670
  }
1641
1671
  | string;
1642
1672
  description: string;
1643
- thumbnail: string;
1644
- function: string;
1645
- edit?: {
1646
- function: string;
1647
- [k: string]: unknown;
1648
- };
1673
+ thumbnail?: string;
1649
1674
  displayConditions?: {
1650
1675
  [k: string]: unknown;
1651
1676
  };
@@ -1657,20 +1682,19 @@ export interface Modules {
1657
1682
  resolver?: {
1658
1683
  function: string;
1659
1684
  };
1685
+ edit?: {
1686
+ resource: string;
1687
+ [k: string]: unknown;
1688
+ };
1660
1689
  title:
1661
1690
  | {
1662
1691
  text: string;
1663
- href?: string;
1692
+ href: string;
1664
1693
  [k: string]: unknown;
1665
1694
  }
1666
1695
  | string;
1667
1696
  description: string;
1668
- thumbnail: string;
1669
- function?: string;
1670
- edit?: {
1671
- resource: string;
1672
- [k: string]: unknown;
1673
- };
1697
+ thumbnail?: string;
1674
1698
  displayConditions?: {
1675
1699
  [k: string]: unknown;
1676
1700
  };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@forge/manifest",
3
- "version": "3.5.0-next.3",
3
+ "version": "3.5.0-next.4",
4
4
  "description": "Definitions and validations of the Forge manifest",
5
5
  "main": "out/index.js",
6
6
  "scripts": {