@axis-backstage/plugin-jira-dashboard-backend 6.1.4 → 6.1.5

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 +8 -0
  2. package/config.schema.json +252 -0
  3. package/package.json +11 -11
  4. package/config.d.ts +0 -128
package/CHANGELOG.md CHANGED
@@ -1,5 +1,13 @@
1
1
  # @axis-backstage/plugin-jira-dashboard-backend
2
2
 
3
+ ## 6.1.5
4
+
5
+ ### Patch Changes
6
+
7
+ - b7492ab: Updated to Backstage 1.53.1
8
+ - Updated dependencies [b7492ab]
9
+ - @axis-backstage/plugin-jira-dashboard-common@1.15.3
10
+
3
11
  ## 6.1.4
4
12
 
5
13
  ### Patch Changes
package/config.schema.json ADDED
@@ -0,0 +1,252 @@
1
+ {
2
+ "$schema": "http://json-schema.org/draft-07/schema#",
3
+ "type": "object",
4
+ "properties": {
5
+ "jiraDashboard": {
6
+ "anyOf": [
7
+ {
8
+ "type": "object",
9
+ "properties": {
10
+ "token": {
11
+ "type": "string",
12
+ "description": "The API token to authenticate towards Jira. It can be found by visiting Atlassians page at https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/",
13
+ "visibility": "secret"
14
+ },
15
+ "headers": {
16
+ "type": "object",
17
+ "additionalProperties": {
18
+ "anyOf": [
19
+ {
20
+ "type": "string"
21
+ },
22
+ {
23
+ "not": {}
24
+ }
25
+ ],
26
+ "visibility": "secret"
27
+ },
28
+ "description": "Optional headers to pass the HTTP requests"
29
+ },
30
+ "baseUrl": {
31
+ "type": "string",
32
+ "description": "The base url for Jira in your company, including the API version. For instance: https://jira.se.your-company.com/rest/api/2/'"
33
+ },
34
+ "apiUrl": {
35
+ "type": "string",
36
+ "description": "Optional url for the Jira API, if different from the baseUrl. This can be useful if your Jira instance has a different API endpoint, like if using scoped API tokens. For example: https://api.atlassian.com/ex/jira/7c9c39d8-d07d-43bd-924b-a82397d47f45/rest/api/2/"
37
+ },
38
+ "userEmailSuffix": {
39
+ "type": "string",
40
+ "description": "Optional email suffix used for retrieving a specific Jira user in a company. For instance:"
41
+ },
42
+ "annotationPrefix": {
43
+ "type": "string",
44
+ "description": "Optional annotation prefix for retrieving a custom annotation. Default value is jira.com",
45
+ "visibility": "frontend"
46
+ },
47
+ "defaultFilters": {
48
+ "type": "array",
49
+ "items": {
50
+ "type": "object",
51
+ "properties": {
52
+ "name": {
53
+ "type": "string"
54
+ },
55
+ "query": {
56
+ "type": "string"
57
+ },
58
+ "shortName": {
59
+ "type": "string"
60
+ }
61
+ },
62
+ "required": [
63
+ "name",
64
+ "query",
65
+ "shortName"
66
+ ]
67
+ },
68
+ "description": "Optional default filters for Jira queries"
69
+ },
70
+ "useApiV3": {
71
+ "type": "boolean",
72
+ "description": "Whether to use Jira API v3. Defaults to false for backward compatibility."
73
+ },
74
+ "cacheTtl": {
75
+ "anyOf": [
76
+ {
77
+ "type": "object",
78
+ "properties": {
79
+ "years": {
80
+ "type": "number"
81
+ },
82
+ "months": {
83
+ "type": "number"
84
+ },
85
+ "weeks": {
86
+ "type": "number"
87
+ },
88
+ "days": {
89
+ "type": "number"
90
+ },
91
+ "hours": {
92
+ "type": "number"
93
+ },
94
+ "minutes": {
95
+ "type": "number"
96
+ },
97
+ "seconds": {
98
+ "type": "number"
99
+ },
100
+ "milliseconds": {
101
+ "type": "number"
102
+ }
103
+ },
104
+ "description": "Human friendly durations object."
105
+ },
106
+ {
107
+ "type": "string"
108
+ }
109
+ ],
110
+ "description": "Optional cache TTL, defaults to 1 hour."
111
+ }
112
+ },
113
+ "required": [
114
+ "token",
115
+ "baseUrl"
116
+ ]
117
+ },
118
+ {
119
+ "type": "object",
120
+ "properties": {
121
+ "annotationPrefix": {
122
+ "type": "string",
123
+ "description": "Optional annotation prefix for retrieving a custom annotation. Default value is jira.com",
124
+ "visibility": "frontend"
125
+ },
126
+ "instances": {
127
+ "type": "array",
128
+ "items": {
129
+ "type": "object",
130
+ "properties": {
131
+ "name": {
132
+ "type": "string",
133
+ "description": "Instance name. This is used in entity annotations to refer to the right instance. In entity annotations, this defaults to \"default\"."
134
+ },
135
+ "token": {
136
+ "type": "string",
137
+ "description": "The API token to authenticate towards Jira. It can be found by visiting Atlassians page at https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/",
138
+ "visibility": "secret"
139
+ },
140
+ "headers": {
141
+ "type": "object",
142
+ "additionalProperties": {
143
+ "anyOf": [
144
+ {
145
+ "type": "string"
146
+ },
147
+ {
148
+ "not": {}
149
+ }
150
+ ],
151
+ "visibility": "secret"
152
+ },
153
+ "description": "Optional headers to pass the HTTP requests"
154
+ },
155
+ "baseUrl": {
156
+ "type": "string",
157
+ "description": "The base url for Jira in your company, including the API version. For instance: https://jira.se.your-company.com/rest/api/2/'"
158
+ },
159
+ "apiUrl": {
160
+ "type": "string",
161
+ "description": "Optional url for the Jira API, if different from the baseUrl. This can be useful if your Jira instance has a different API endpoint, like if using scoped API tokens. For example: https://api.atlassian.com/ex/jira/7c9c39d8-d07d-43bd-924b-a82397d47f45/rest/api/2/"
162
+ },
163
+ "userEmailSuffix": {
164
+ "type": "string",
165
+ "description": "Optional email suffix used for retrieving a specific Jira user in a company. For instance:"
166
+ },
167
+ "defaultFilters": {
168
+ "type": "array",
169
+ "items": {
170
+ "type": "object",
171
+ "properties": {
172
+ "name": {
173
+ "type": "string"
174
+ },
175
+ "query": {
176
+ "type": "string"
177
+ },
178
+ "shortName": {
179
+ "type": "string"
180
+ }
181
+ },
182
+ "required": [
183
+ "name",
184
+ "query",
185
+ "shortName"
186
+ ]
187
+ },
188
+ "description": "Optional default filters for Jira queries"
189
+ },
190
+ "useApiV3": {
191
+ "type": "boolean",
192
+ "description": "Whether to use Jira API v3. Defaults to false for backward compatibility."
193
+ },
194
+ "cacheTtl": {
195
+ "anyOf": [
196
+ {
197
+ "type": "object",
198
+ "properties": {
199
+ "years": {
200
+ "type": "number"
201
+ },
202
+ "months": {
203
+ "type": "number"
204
+ },
205
+ "weeks": {
206
+ "type": "number"
207
+ },
208
+ "days": {
209
+ "type": "number"
210
+ },
211
+ "hours": {
212
+ "type": "number"
213
+ },
214
+ "minutes": {
215
+ "type": "number"
216
+ },
217
+ "seconds": {
218
+ "type": "number"
219
+ },
220
+ "milliseconds": {
221
+ "type": "number"
222
+ }
223
+ },
224
+ "description": "Human friendly durations object."
225
+ },
226
+ {
227
+ "type": "string"
228
+ }
229
+ ],
230
+ "description": "Optional cache TTL, defaults to 1 hour."
231
+ }
232
+ },
233
+ "required": [
234
+ "name",
235
+ "token",
236
+ "baseUrl"
237
+ ]
238
+ }
239
+ }
240
+ },
241
+ "required": [
242
+ "instances"
243
+ ]
244
+ }
245
+ ],
246
+ "description": "Configuration options for the Jira Dashboard plugin"
247
+ }
248
+ },
249
+ "required": [
250
+ "jiraDashboard"
251
+ ]
252
+ }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@axis-backstage/plugin-jira-dashboard-backend",
3
- "version": "6.1.4",
3
+ "version": "6.1.5",
4
4
  "main": "dist/index.cjs.js",
5
5
  "types": "dist/index.d.ts",
6
6
  "license": "Apache-2.0",
@@ -32,10 +32,10 @@
32
32
  "postpack": "backstage-cli package postpack"
33
33
  },
34
34
  "dependencies": {
35
- "@axis-backstage/plugin-jira-dashboard-common": "^1.15.2",
36
- "@backstage/backend-defaults": "^0.17.4",
37
- "@backstage/backend-plugin-api": "^1.9.2",
38
- "@backstage/catalog-client": "^1.16.0",
35
+ "@axis-backstage/plugin-jira-dashboard-common": "^1.15.3",
36
+ "@backstage/backend-defaults": "^0.17.6",
37
+ "@backstage/backend-plugin-api": "^1.9.3",
38
+ "@backstage/catalog-client": "^1.16.1",
39
39
  "@backstage/catalog-model": "^1.9.0",
40
40
  "@backstage/config": "^1.3.8",
41
41
  "@backstage/errors": "^1.3.1",
@@ -45,10 +45,10 @@
45
45
  "node-fetch": "^2.6.7"
46
46
  },
47
47
  "devDependencies": {
48
- "@backstage/backend-test-utils": "^1.11.4",
49
- "@backstage/cli": "^0.36.3",
50
- "@backstage/plugin-auth-backend": "^0.29.1",
51
- "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.20",
48
+ "@backstage/backend-test-utils": "^1.11.5",
49
+ "@backstage/cli": "^0.36.4",
50
+ "@backstage/plugin-auth-backend": "^0.29.2",
51
+ "@backstage/plugin-auth-backend-module-guest-provider": "^0.2.21",
52
52
  "@types/express": "*",
53
53
  "@types/supertest": "^2.0.12",
54
54
  "msw": "^2.7.3",
@@ -56,9 +56,9 @@
56
56
  },
57
57
  "files": [
58
58
  "dist",
59
- "config.d.ts"
59
+ "config.schema.json"
60
60
  ],
61
- "configSchema": "config.d.ts",
61
+ "configSchema": "config.schema.json",
62
62
  "typesVersions": {
63
63
  "*": {
64
64
  "package.json": [
package/config.d.ts DELETED
@@ -1,128 +0,0 @@
1
- import { HumanDuration } from '@backstage/types';
2
-
3
- export interface Config {
4
- /**
5
- * Configuration options for the Jira Dashboard plugin
6
- */
7
- jiraDashboard:
8
- | {
9
- /**
10
- * The API token to authenticate towards Jira. It can be found by visiting Atlassians page at https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/
11
- * @visibility secret
12
- */
13
- token: string;
14
-
15
- /**
16
- * Optional headers to pass the HTTP requests
17
- */
18
- headers?: {
19
- /** @visibility secret */
20
- [key: string]: string | undefined;
21
- };
22
-
23
- /**
24
- * The base url for Jira in your company, including the API version. For instance: https://jira.se.your-company.com/rest/api/2/'
25
- */
26
- baseUrl: string;
27
-
28
- /**
29
- * Optional url for the Jira API, if different from the baseUrl. This can be useful if your Jira instance has a different API endpoint, like if using scoped API tokens. For example: https://api.atlassian.com/ex/jira/7c9c39d8-d07d-43bd-924b-a82397d47f45/rest/api/2/
30
- */
31
- apiUrl?: string;
32
-
33
- /**
34
- * Optional email suffix used for retrieving a specific Jira user in a company. For instance: @your-company.com. If not provided, the user entity profile email is used instead.
35
- */
36
- userEmailSuffix?: string;
37
-
38
- /**
39
- * Optional annotation prefix for retrieving a custom annotation. Default value is jira.com
40
- * @visibility frontend
41
- */
42
- annotationPrefix?: string;
43
-
44
- /**
45
- * Optional default filters for Jira queries
46
- */
47
- defaultFilters?: {
48
- name: string;
49
- query: string;
50
- shortName: string;
51
- }[];
52
-
53
- /**
54
- * Whether to use Jira API v3. Defaults to false for backward compatibility.
55
- */
56
- useApiV3?: boolean;
57
-
58
- /**
59
- * Optional cache TTL, defaults to 1 hour.
60
- */
61
- cacheTtl?: HumanDuration | string;
62
-
63
- // Type helper
64
- instances?: never;
65
- }
66
- | {
67
- /**
68
- * Optional annotation prefix for retrieving a custom annotation. Default value is jira.com
69
- * @visibility frontend
70
- */
71
- annotationPrefix?: string;
72
-
73
- instances: {
74
- /**
75
- * Instance name. This is used in entity annotations to refer to the right instance. In entity annotations, this defaults to "default".
76
- */
77
- name: string;
78
-
79
- /**
80
- * The API token to authenticate towards Jira. It can be found by visiting Atlassians page at https://developer.atlassian.com/cloud/jira/platform/basic-auth-for-rest-apis/
81
- * @visibility secret
82
- */
83
- token: string;
84
-
85
- /**
86
- * Optional headers to pass the HTTP requests
87
- */
88
- headers?: {
89
- /** @visibility secret */
90
- [key: string]: string | undefined;
91
- };
92
-
93
- /**
94
- * The base url for Jira in your company, including the API version. For instance: https://jira.se.your-company.com/rest/api/2/'
95
- */
96
- baseUrl: string;
97
-
98
- /**
99
- * Optional url for the Jira API, if different from the baseUrl. This can be useful if your Jira instance has a different API endpoint, like if using scoped API tokens. For example: https://api.atlassian.com/ex/jira/7c9c39d8-d07d-43bd-924b-a82397d47f45/rest/api/2/
100
- */
101
- apiUrl?: string;
102
-
103
- /**
104
- * Optional email suffix used for retrieving a specific Jira user in a company. For instance: @your-company.com. If not provided, the user entity profile email is used instead.
105
- */
106
- userEmailSuffix?: string;
107
-
108
- /**
109
- * Optional default filters for Jira queries
110
- */
111
- defaultFilters?: {
112
- name: string;
113
- query: string;
114
- shortName: string;
115
- }[];
116
-
117
- /**
118
- * Whether to use Jira API v3. Defaults to false for backward compatibility.
119
- */
120
- useApiV3?: boolean;
121
-
122
- /**
123
- * Optional cache TTL, defaults to 1 hour.
124
- */
125
- cacheTtl?: HumanDuration | string;
126
- }[];
127
- };
128
- }