@valiantys/atlassian-app-frontend 3.0.0-alpha-8 → 3.0.0-alpha-10

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 (9) hide show
  1. package/atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.cjs.js +1 -1
  2. package/atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.es.js +39 -39
  3. package/data-access-issue/atlassian-app-frontend-data-access-issue.api.json +2 -2
  4. package/data-access-issue/atlassian-app-frontend.api.md +2 -2
  5. package/data-access-issue/index.d.ts +7 -7
  6. package/package.json +1 -1
  7. package/util-jira-v3-api/atlassian-app-frontend-util-jira-v3-api.api.json +561 -10
  8. package/util-jira-v3-api/atlassian-app-frontend.api.md +47 -5
  9. package/util-jira-v3-api/index.d.ts +28 -5
package/atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.cjs.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const u=class u{constructor(e){this.fetchSvc=e}async updateField(e,s,t){await this.updateFields(e,{[s]:t})}async updateFields(e,s){await this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/issue/${e}`},{fields:s})}async getIssueField(e,s){var t;return(t=await this.getIssueFields(e,[s]))==null?void 0:t[s]}async getIssueFields(e,s){return(await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${s.join(",")}`})).fields}async getIssue(e,s=["*all"]){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${s.join(",")}`})}async issueSearch(e,s,t=50){let c;const h=[];do{const r=await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/search/jql?jql=${e}&fields=${s.join(",")}&maxResults=${t}&${c?"nextPageToken="+c:""}`});h.push(...r.issues),c=r.nextPageToken}while(c!==void 0);return h}async addWorklog(e,s){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/worklog`},s)}async queryForIssuesInProjects(e){const s=`project IN (${e.join(",")})`;return this.issueSearch(s,["key"],5e3)}async createIssue(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/2/issue`},e)}async updateIssue(e,s){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/2/issue/${e}`},s)}async getIssueComments(e,s=0){const t=s?`?startAt=${s}`:"";return await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment${t}`})}async getIssueCommentById(e,s){return await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${s}`})}async addIssueComment(e,s){return await this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment`},s)}async transitionIssue(e,s){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/transitions`},s)}async createIssueLink(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issueLink`},e)}};u.issueUrl="/rest/api/3/issue";let i=u;exports.JiraIssueService=i;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=class h{constructor(e){this.fetchSvc=e}async updateField(e,t,s){await this.updateFields(e,{[t]:s})}async updateFields(e,t){await this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/issue/${e}`},{fields:t})}async getIssueField(e,t){var s;return(s=await this.getIssueFields(e,[t]))==null?void 0:s[t]}async getIssueFields(e,t){return(await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}`})).fields}async getIssue(e,t=["*all"]){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}`})}async issueSearch(e,t,s=50){let c;const r=[];do{const u=await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/search/jql?jql=${e}&fields=${t.join(",")}&maxResults=${s}&${c?"nextPageToken="+c:""}`});r.push(...u.issues),c=u.nextPageToken}while(c!==void 0);return r}async addWorklog(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/worklog`},t)}async queryForIssuesInProjects(e){const t=`project IN (${e.join(",")})`;return this.issueSearch(t,["key"],5e3)}async createIssue(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/2/issue`},e)}async updateIssue(e,t){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/2/issue/${e}`},t)}async getIssueComments(e,t=0){const s=t?`?startAt=${t}`:"";return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment${s}`})}async getIssueCommentById(e,t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${t}`})}async addIssueComment(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment`},{body:t})}async transitionIssue(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/transitions`},t)}async createIssueLink(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issueLink`},e)}};h.issueUrl="/rest/api/3/issue";let i=h;exports.JiraIssueService=i;
package/atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.es.js CHANGED
@@ -1,59 +1,59 @@
1
- const i = class i {
1
+ const h = class h {
2
2
  constructor(e) {
3
3
  this.fetchSvc = e;
4
4
  }
5
- async updateField(e, s, t) {
6
- await this.updateFields(e, { [s]: t });
5
+ async updateField(e, t, s) {
6
+ await this.updateFields(e, { [t]: s });
7
7
  }
8
- async updateFields(e, s) {
8
+ async updateFields(e, t) {
9
9
  await this.fetchSvc.fetch(
10
10
  {
11
11
  method: "PUT",
12
12
  url: this.fetchSvc.route`/rest/api/3/issue/${e}`
13
13
  },
14
- { fields: s }
14
+ { fields: t }
15
15
  );
16
16
  }
17
- async getIssueField(e, s) {
18
- var t;
19
- return (t = await this.getIssueFields(e, [s])) == null ? void 0 : t[s];
17
+ async getIssueField(e, t) {
18
+ var s;
19
+ return (s = await this.getIssueFields(e, [t])) == null ? void 0 : s[t];
20
20
  }
21
- async getIssueFields(e, s) {
21
+ async getIssueFields(e, t) {
22
22
  return (await this.fetchSvc.fetch({
23
23
  method: "GET",
24
- url: this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${s.join(",")}`
24
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}`
25
25
  })).fields;
26
26
  }
27
- async getIssue(e, s = ["*all"]) {
27
+ async getIssue(e, t = ["*all"]) {
28
28
  return this.fetchSvc.fetch({
29
29
  method: "GET",
30
- url: this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${s.join(",")}`
30
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}`
31
31
  });
32
32
  }
33
- async issueSearch(e, s, t = 50) {
33
+ async issueSearch(e, t, s = 50) {
34
34
  let c;
35
- const h = [];
35
+ const i = [];
36
36
  do {
37
- const u = await this.fetchSvc.fetch({
37
+ const r = await this.fetchSvc.fetch({
38
38
  method: "GET",
39
- url: this.fetchSvc.route`/rest/api/3/search/jql?jql=${e}&fields=${s.join(",")}&maxResults=${t}&${c ? "nextPageToken=" + c : ""}`
39
+ url: this.fetchSvc.route`/rest/api/3/search/jql?jql=${e}&fields=${t.join(",")}&maxResults=${s}&${c ? "nextPageToken=" + c : ""}`
40
40
  });
41
- h.push(...u.issues), c = u.nextPageToken;
41
+ i.push(...r.issues), c = r.nextPageToken;
42
42
  } while (c !== void 0);
43
- return h;
43
+ return i;
44
44
  }
45
- async addWorklog(e, s) {
45
+ async addWorklog(e, t) {
46
46
  return this.fetchSvc.fetch(
47
47
  {
48
48
  method: "POST",
49
49
  url: this.fetchSvc.route`/rest/api/3/issue/${e}/worklog`
50
50
  },
51
- s
51
+ t
52
52
  );
53
53
  }
54
54
  async queryForIssuesInProjects(e) {
55
- const s = `project IN (${e.join(",")})`;
56
- return this.issueSearch(s, ["key"], 5e3);
55
+ const t = `project IN (${e.join(",")})`;
56
+ return this.issueSearch(t, ["key"], 5e3);
57
57
  }
58
58
  async createIssue(e) {
59
59
  return this.fetchSvc.fetch(
@@ -64,45 +64,45 @@ const i = class i {
64
64
  e
65
65
  );
66
66
  }
67
- async updateIssue(e, s) {
67
+ async updateIssue(e, t) {
68
68
  return this.fetchSvc.fetch(
69
69
  {
70
70
  method: "PUT",
71
71
  url: this.fetchSvc.route`/rest/api/2/issue/${e}`
72
72
  },
73
- s
73
+ t
74
74
  );
75
75
  }
76
- async getIssueComments(e, s = 0) {
77
- const t = s ? `?startAt=${s}` : "";
78
- return await this.fetchSvc.fetch({
76
+ async getIssueComments(e, t = 0) {
77
+ const s = t ? `?startAt=${t}` : "";
78
+ return this.fetchSvc.fetch({
79
79
  method: "GET",
80
- url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment${t}`
80
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment${s}`
81
81
  });
82
82
  }
83
- async getIssueCommentById(e, s) {
84
- return await this.fetchSvc.fetch({
83
+ async getIssueCommentById(e, t) {
84
+ return this.fetchSvc.fetch({
85
85
  method: "GET",
86
- url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${s}`
86
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${t}`
87
87
  });
88
88
  }
89
- async addIssueComment(e, s) {
90
- return await this.fetchSvc.fetch(
89
+ async addIssueComment(e, t) {
90
+ return this.fetchSvc.fetch(
91
91
  {
92
92
  method: "POST",
93
93
  url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment`
94
94
  },
95
- s
95
+ { body: t }
96
96
  );
97
97
  }
98
98
  // https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issues/#api-rest-api-3-issue-issueidorkey-transitions-post
99
- async transitionIssue(e, s) {
99
+ async transitionIssue(e, t) {
100
100
  return this.fetchSvc.fetch(
101
101
  {
102
102
  method: "POST",
103
103
  url: this.fetchSvc.route`/rest/api/3/issue/${e}/transitions`
104
104
  },
105
- s
105
+ t
106
106
  );
107
107
  }
108
108
  async createIssueLink(e) {
@@ -115,8 +115,8 @@ const i = class i {
115
115
  );
116
116
  }
117
117
  };
118
- i.issueUrl = "/rest/api/3/issue";
119
- let r = i;
118
+ h.issueUrl = "/rest/api/3/issue";
119
+ let u = h;
120
120
  export {
121
- r as JiraIssueService
121
+ u as JiraIssueService
122
122
  };
package/data-access-issue/atlassian-app-frontend-data-access-issue.api.json CHANGED
@@ -619,7 +619,7 @@
619
619
  },
620
620
  {
621
621
  "kind": "Content",
622
- "text": " | undefined>"
622
+ "text": ">"
623
623
  },
624
624
  {
625
625
  "kind": "Content",
@@ -697,7 +697,7 @@
697
697
  },
698
698
  {
699
699
  "kind": "Content",
700
- "text": " | undefined>"
700
+ "text": ">"
701
701
  },
702
702
  {
703
703
  "kind": "Content",
package/data-access-issue/atlassian-app-frontend.api.md CHANGED
@@ -33,11 +33,11 @@ export class JiraIssueService {
33
33
  // Warning: (ae-forgotten-export) The symbol "IssueComment" needs to be exported by the entry point data-access-issue.d.ts
34
34
  //
35
35
  // (undocumented)
36
- getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
36
+ getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment>;
37
37
  // Warning: (ae-forgotten-export) The symbol "JiraCommentResponse" needs to be exported by the entry point data-access-issue.d.ts
38
38
  //
39
39
  // (undocumented)
40
- getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse | undefined>;
40
+ getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse>;
41
41
  // (undocumented)
42
42
  getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
43
43
  // Warning: (ae-forgotten-export) The symbol "IssueFields" needs to be exported by the entry point data-access-issue.d.ts
package/data-access-issue/index.d.ts CHANGED
@@ -49,7 +49,7 @@ declare interface CreatedIssue {
49
49
  }
50
50
 
51
51
  declare interface CreateIssue {
52
- fields: IssueFields;
52
+ fields: IssueFields<string>;
53
53
  properties?: {
54
54
  key: string;
55
55
  value: unknown;
@@ -132,7 +132,7 @@ declare type IssueComment = {
132
132
  visibility: Visibility;
133
133
  };
134
134
 
135
- declare type IssueFields = CustomFields & StaticIssueFields;
135
+ declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
136
136
 
137
137
  declare interface IssueLink {
138
138
  outwardIssue?: Issue;
@@ -175,7 +175,7 @@ declare interface IssueStatus {
175
175
 
176
176
  declare interface IssueTransition {
177
177
  id: string;
178
- looped: boolean;
178
+ looped?: boolean;
179
179
  }
180
180
 
181
181
  declare type JiraCommentResponse = {
@@ -199,8 +199,8 @@ export declare class JiraIssueService {
199
199
  queryForIssuesInProjects(projectIds: number[]): Promise<Issue[]>;
200
200
  createIssue(body: CreateIssue): Promise<CreatedIssue>;
201
201
  updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
202
- getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse | undefined>;
203
- getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
202
+ getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse>;
203
+ getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment>;
204
204
  addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
205
205
  transitionIssue(issueIdOrKey: string, body: TransitionIssueRequest): Promise<void>;
206
206
  createIssueLink(issueLinkRequest: IssueLinkRequest): Promise<void>;
@@ -221,7 +221,7 @@ declare interface Project {
221
221
 
222
222
  declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
223
223
 
224
- declare interface StaticIssueFields {
224
+ declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
225
225
  statuscategorychangedate?: string;
226
226
  fixVersions?: FixVersions;
227
227
  resolution?: unknown;
@@ -262,7 +262,7 @@ declare interface StaticIssueFields {
262
262
  };
263
263
  created?: string;
264
264
  updated?: string;
265
- description?: AtlassianDocumentFormat;
265
+ description?: T;
266
266
  timetracking?: {
267
267
  remainingEstimate: string;
268
268
  timeSpent: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@valiantys/atlassian-app-frontend",
3
- "version": "3.0.0-alpha-8",
3
+ "version": "3.0.0-alpha-10",
4
4
  "description": "This library provides an Atlassian Forge Custom UI wrapper component that handles all the setup necessary to support an app that can run deployed or in standalone mode",
5
5
  "exports": {
6
6
  "./atlassian-app": {
package/util-jira-v3-api/atlassian-app-frontend-util-jira-v3-api.api.json CHANGED
@@ -892,6 +892,10 @@
892
892
  "text": "IssueFields",
893
893
  "canonicalReference": "@valiantys/atlassian-app-frontend!IssueFields:type"
894
894
  },
895
+ {
896
+ "kind": "Content",
897
+ "text": "<string>"
898
+ },
895
899
  {
896
900
  "kind": "Content",
897
901
  "text": ";"
@@ -903,7 +907,7 @@
903
907
  "name": "fields",
904
908
  "propertyTypeTokenRange": {
905
909
  "startIndex": 1,
906
- "endIndex": 2
910
+ "endIndex": 3
907
911
  }
908
912
  },
909
913
  {
@@ -1189,6 +1193,105 @@
1189
1193
  "endIndex": 2
1190
1194
  }
1191
1195
  },
1196
+ {
1197
+ "kind": "Interface",
1198
+ "canonicalReference": "@valiantys/atlassian-app-frontend!HealthCheckResult:interface",
1199
+ "docComment": "",
1200
+ "excerptTokens": [
1201
+ {
1202
+ "kind": "Content",
1203
+ "text": "export interface HealthCheckResult "
1204
+ }
1205
+ ],
1206
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/health-check.d.ts",
1207
+ "releaseTag": "Public",
1208
+ "name": "HealthCheckResult",
1209
+ "preserveMemberOrder": false,
1210
+ "members": [
1211
+ {
1212
+ "kind": "PropertySignature",
1213
+ "canonicalReference": "@valiantys/atlassian-app-frontend!HealthCheckResult#description:member",
1214
+ "docComment": "",
1215
+ "excerptTokens": [
1216
+ {
1217
+ "kind": "Content",
1218
+ "text": "description: "
1219
+ },
1220
+ {
1221
+ "kind": "Content",
1222
+ "text": "string"
1223
+ },
1224
+ {
1225
+ "kind": "Content",
1226
+ "text": ";"
1227
+ }
1228
+ ],
1229
+ "isReadonly": false,
1230
+ "isOptional": false,
1231
+ "releaseTag": "Public",
1232
+ "name": "description",
1233
+ "propertyTypeTokenRange": {
1234
+ "startIndex": 1,
1235
+ "endIndex": 2
1236
+ }
1237
+ },
1238
+ {
1239
+ "kind": "PropertySignature",
1240
+ "canonicalReference": "@valiantys/atlassian-app-frontend!HealthCheckResult#name:member",
1241
+ "docComment": "",
1242
+ "excerptTokens": [
1243
+ {
1244
+ "kind": "Content",
1245
+ "text": "name: "
1246
+ },
1247
+ {
1248
+ "kind": "Content",
1249
+ "text": "string"
1250
+ },
1251
+ {
1252
+ "kind": "Content",
1253
+ "text": ";"
1254
+ }
1255
+ ],
1256
+ "isReadonly": false,
1257
+ "isOptional": false,
1258
+ "releaseTag": "Public",
1259
+ "name": "name",
1260
+ "propertyTypeTokenRange": {
1261
+ "startIndex": 1,
1262
+ "endIndex": 2
1263
+ }
1264
+ },
1265
+ {
1266
+ "kind": "PropertySignature",
1267
+ "canonicalReference": "@valiantys/atlassian-app-frontend!HealthCheckResult#passed:member",
1268
+ "docComment": "",
1269
+ "excerptTokens": [
1270
+ {
1271
+ "kind": "Content",
1272
+ "text": "passed: "
1273
+ },
1274
+ {
1275
+ "kind": "Content",
1276
+ "text": "boolean"
1277
+ },
1278
+ {
1279
+ "kind": "Content",
1280
+ "text": ";"
1281
+ }
1282
+ ],
1283
+ "isReadonly": false,
1284
+ "isOptional": false,
1285
+ "releaseTag": "Public",
1286
+ "name": "passed",
1287
+ "propertyTypeTokenRange": {
1288
+ "startIndex": 1,
1289
+ "endIndex": 2
1290
+ }
1291
+ }
1292
+ ],
1293
+ "extendsTokenRanges": []
1294
+ },
1192
1295
  {
1193
1296
  "kind": "Interface",
1194
1297
  "canonicalReference": "@valiantys/atlassian-app-frontend!HistoryMetadata:interface",
@@ -2022,7 +2125,16 @@
2022
2125
  "excerptTokens": [
2023
2126
  {
2024
2127
  "kind": "Content",
2025
- "text": "export type IssueFields = "
2128
+ "text": "export type IssueFields<T = "
2129
+ },
2130
+ {
2131
+ "kind": "Reference",
2132
+ "text": "AtlassianDocumentFormat",
2133
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat:interface"
2134
+ },
2135
+ {
2136
+ "kind": "Content",
2137
+ "text": "> = "
2026
2138
  },
2027
2139
  {
2028
2140
  "kind": "Reference",
@@ -2038,6 +2150,10 @@
2038
2150
  "text": "StaticIssueFields",
2039
2151
  "canonicalReference": "@valiantys/atlassian-app-frontend!StaticIssueFields:interface"
2040
2152
  },
2153
+ {
2154
+ "kind": "Content",
2155
+ "text": "<T>"
2156
+ },
2041
2157
  {
2042
2158
  "kind": "Content",
2043
2159
  "text": ";"
@@ -2046,9 +2162,22 @@
2046
2162
  "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
2047
2163
  "releaseTag": "Public",
2048
2164
  "name": "IssueFields",
2165
+ "typeParameters": [
2166
+ {
2167
+ "typeParameterName": "T",
2168
+ "constraintTokenRange": {
2169
+ "startIndex": 0,
2170
+ "endIndex": 0
2171
+ },
2172
+ "defaultTypeTokenRange": {
2173
+ "startIndex": 1,
2174
+ "endIndex": 2
2175
+ }
2176
+ }
2177
+ ],
2049
2178
  "typeTokenRange": {
2050
- "startIndex": 1,
2051
- "endIndex": 4
2179
+ "startIndex": 3,
2180
+ "endIndex": 7
2052
2181
  }
2053
2182
  },
2054
2183
  {
@@ -2516,7 +2645,7 @@
2516
2645
  "excerptTokens": [
2517
2646
  {
2518
2647
  "kind": "Content",
2519
- "text": "looped: "
2648
+ "text": "looped?: "
2520
2649
  },
2521
2650
  {
2522
2651
  "kind": "Content",
@@ -2528,7 +2657,7 @@
2528
2657
  }
2529
2658
  ],
2530
2659
  "isReadonly": false,
2531
- "isOptional": false,
2660
+ "isOptional": true,
2532
2661
  "releaseTag": "Public",
2533
2662
  "name": "looped",
2534
2663
  "propertyTypeTokenRange": {
@@ -2808,6 +2937,407 @@
2808
2937
  "endIndex": 4
2809
2938
  }
2810
2939
  },
2940
+ {
2941
+ "kind": "Interface",
2942
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo:interface",
2943
+ "docComment": "",
2944
+ "excerptTokens": [
2945
+ {
2946
+ "kind": "Content",
2947
+ "text": "export interface JiraServerInfo "
2948
+ }
2949
+ ],
2950
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/jira-server-info.d.ts",
2951
+ "releaseTag": "Public",
2952
+ "name": "JiraServerInfo",
2953
+ "preserveMemberOrder": false,
2954
+ "members": [
2955
+ {
2956
+ "kind": "PropertySignature",
2957
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#baseUrl:member",
2958
+ "docComment": "",
2959
+ "excerptTokens": [
2960
+ {
2961
+ "kind": "Content",
2962
+ "text": "baseUrl: "
2963
+ },
2964
+ {
2965
+ "kind": "Content",
2966
+ "text": "string"
2967
+ },
2968
+ {
2969
+ "kind": "Content",
2970
+ "text": ";"
2971
+ }
2972
+ ],
2973
+ "isReadonly": false,
2974
+ "isOptional": false,
2975
+ "releaseTag": "Public",
2976
+ "name": "baseUrl",
2977
+ "propertyTypeTokenRange": {
2978
+ "startIndex": 1,
2979
+ "endIndex": 2
2980
+ }
2981
+ },
2982
+ {
2983
+ "kind": "PropertySignature",
2984
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#buildDate:member",
2985
+ "docComment": "",
2986
+ "excerptTokens": [
2987
+ {
2988
+ "kind": "Content",
2989
+ "text": "buildDate: "
2990
+ },
2991
+ {
2992
+ "kind": "Content",
2993
+ "text": "string"
2994
+ },
2995
+ {
2996
+ "kind": "Content",
2997
+ "text": ";"
2998
+ }
2999
+ ],
3000
+ "isReadonly": false,
3001
+ "isOptional": false,
3002
+ "releaseTag": "Public",
3003
+ "name": "buildDate",
3004
+ "propertyTypeTokenRange": {
3005
+ "startIndex": 1,
3006
+ "endIndex": 2
3007
+ }
3008
+ },
3009
+ {
3010
+ "kind": "PropertySignature",
3011
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#buildNumber:member",
3012
+ "docComment": "",
3013
+ "excerptTokens": [
3014
+ {
3015
+ "kind": "Content",
3016
+ "text": "buildNumber: "
3017
+ },
3018
+ {
3019
+ "kind": "Content",
3020
+ "text": "number"
3021
+ },
3022
+ {
3023
+ "kind": "Content",
3024
+ "text": ";"
3025
+ }
3026
+ ],
3027
+ "isReadonly": false,
3028
+ "isOptional": false,
3029
+ "releaseTag": "Public",
3030
+ "name": "buildNumber",
3031
+ "propertyTypeTokenRange": {
3032
+ "startIndex": 1,
3033
+ "endIndex": 2
3034
+ }
3035
+ },
3036
+ {
3037
+ "kind": "PropertySignature",
3038
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#deploymentType:member",
3039
+ "docComment": "",
3040
+ "excerptTokens": [
3041
+ {
3042
+ "kind": "Content",
3043
+ "text": "deploymentType: "
3044
+ },
3045
+ {
3046
+ "kind": "Content",
3047
+ "text": "string"
3048
+ },
3049
+ {
3050
+ "kind": "Content",
3051
+ "text": ";"
3052
+ }
3053
+ ],
3054
+ "isReadonly": false,
3055
+ "isOptional": false,
3056
+ "releaseTag": "Public",
3057
+ "name": "deploymentType",
3058
+ "propertyTypeTokenRange": {
3059
+ "startIndex": 1,
3060
+ "endIndex": 2
3061
+ }
3062
+ },
3063
+ {
3064
+ "kind": "PropertySignature",
3065
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#displayUrl:member",
3066
+ "docComment": "",
3067
+ "excerptTokens": [
3068
+ {
3069
+ "kind": "Content",
3070
+ "text": "displayUrl: "
3071
+ },
3072
+ {
3073
+ "kind": "Content",
3074
+ "text": "string"
3075
+ },
3076
+ {
3077
+ "kind": "Content",
3078
+ "text": ";"
3079
+ }
3080
+ ],
3081
+ "isReadonly": false,
3082
+ "isOptional": false,
3083
+ "releaseTag": "Public",
3084
+ "name": "displayUrl",
3085
+ "propertyTypeTokenRange": {
3086
+ "startIndex": 1,
3087
+ "endIndex": 2
3088
+ }
3089
+ },
3090
+ {
3091
+ "kind": "PropertySignature",
3092
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#displayUrlConfluence:member",
3093
+ "docComment": "",
3094
+ "excerptTokens": [
3095
+ {
3096
+ "kind": "Content",
3097
+ "text": "displayUrlConfluence: "
3098
+ },
3099
+ {
3100
+ "kind": "Content",
3101
+ "text": "string"
3102
+ },
3103
+ {
3104
+ "kind": "Content",
3105
+ "text": ";"
3106
+ }
3107
+ ],
3108
+ "isReadonly": false,
3109
+ "isOptional": false,
3110
+ "releaseTag": "Public",
3111
+ "name": "displayUrlConfluence",
3112
+ "propertyTypeTokenRange": {
3113
+ "startIndex": 1,
3114
+ "endIndex": 2
3115
+ }
3116
+ },
3117
+ {
3118
+ "kind": "PropertySignature",
3119
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#displayUrlServicedeskHelpCenter:member",
3120
+ "docComment": "",
3121
+ "excerptTokens": [
3122
+ {
3123
+ "kind": "Content",
3124
+ "text": "displayUrlServicedeskHelpCenter: "
3125
+ },
3126
+ {
3127
+ "kind": "Content",
3128
+ "text": "string"
3129
+ },
3130
+ {
3131
+ "kind": "Content",
3132
+ "text": ";"
3133
+ }
3134
+ ],
3135
+ "isReadonly": false,
3136
+ "isOptional": false,
3137
+ "releaseTag": "Public",
3138
+ "name": "displayUrlServicedeskHelpCenter",
3139
+ "propertyTypeTokenRange": {
3140
+ "startIndex": 1,
3141
+ "endIndex": 2
3142
+ }
3143
+ },
3144
+ {
3145
+ "kind": "PropertySignature",
3146
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#healthChecks:member",
3147
+ "docComment": "",
3148
+ "excerptTokens": [
3149
+ {
3150
+ "kind": "Content",
3151
+ "text": "healthChecks: "
3152
+ },
3153
+ {
3154
+ "kind": "Reference",
3155
+ "text": "HealthCheckResult",
3156
+ "canonicalReference": "@valiantys/atlassian-app-frontend!HealthCheckResult:interface"
3157
+ },
3158
+ {
3159
+ "kind": "Content",
3160
+ "text": "[]"
3161
+ },
3162
+ {
3163
+ "kind": "Content",
3164
+ "text": ";"
3165
+ }
3166
+ ],
3167
+ "isReadonly": false,
3168
+ "isOptional": false,
3169
+ "releaseTag": "Public",
3170
+ "name": "healthChecks",
3171
+ "propertyTypeTokenRange": {
3172
+ "startIndex": 1,
3173
+ "endIndex": 3
3174
+ }
3175
+ },
3176
+ {
3177
+ "kind": "PropertySignature",
3178
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#scmInfo:member",
3179
+ "docComment": "",
3180
+ "excerptTokens": [
3181
+ {
3182
+ "kind": "Content",
3183
+ "text": "scmInfo: "
3184
+ },
3185
+ {
3186
+ "kind": "Content",
3187
+ "text": "string"
3188
+ },
3189
+ {
3190
+ "kind": "Content",
3191
+ "text": ";"
3192
+ }
3193
+ ],
3194
+ "isReadonly": false,
3195
+ "isOptional": false,
3196
+ "releaseTag": "Public",
3197
+ "name": "scmInfo",
3198
+ "propertyTypeTokenRange": {
3199
+ "startIndex": 1,
3200
+ "endIndex": 2
3201
+ }
3202
+ },
3203
+ {
3204
+ "kind": "PropertySignature",
3205
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#serverTime:member",
3206
+ "docComment": "",
3207
+ "excerptTokens": [
3208
+ {
3209
+ "kind": "Content",
3210
+ "text": "serverTime: "
3211
+ },
3212
+ {
3213
+ "kind": "Content",
3214
+ "text": "string"
3215
+ },
3216
+ {
3217
+ "kind": "Content",
3218
+ "text": ";"
3219
+ }
3220
+ ],
3221
+ "isReadonly": false,
3222
+ "isOptional": false,
3223
+ "releaseTag": "Public",
3224
+ "name": "serverTime",
3225
+ "propertyTypeTokenRange": {
3226
+ "startIndex": 1,
3227
+ "endIndex": 2
3228
+ }
3229
+ },
3230
+ {
3231
+ "kind": "PropertySignature",
3232
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#serverTimeZone:member",
3233
+ "docComment": "",
3234
+ "excerptTokens": [
3235
+ {
3236
+ "kind": "Content",
3237
+ "text": "serverTimeZone: "
3238
+ },
3239
+ {
3240
+ "kind": "Content",
3241
+ "text": "string"
3242
+ },
3243
+ {
3244
+ "kind": "Content",
3245
+ "text": ";"
3246
+ }
3247
+ ],
3248
+ "isReadonly": false,
3249
+ "isOptional": false,
3250
+ "releaseTag": "Public",
3251
+ "name": "serverTimeZone",
3252
+ "propertyTypeTokenRange": {
3253
+ "startIndex": 1,
3254
+ "endIndex": 2
3255
+ }
3256
+ },
3257
+ {
3258
+ "kind": "PropertySignature",
3259
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#serverTitle:member",
3260
+ "docComment": "",
3261
+ "excerptTokens": [
3262
+ {
3263
+ "kind": "Content",
3264
+ "text": "serverTitle: "
3265
+ },
3266
+ {
3267
+ "kind": "Content",
3268
+ "text": "string"
3269
+ },
3270
+ {
3271
+ "kind": "Content",
3272
+ "text": ";"
3273
+ }
3274
+ ],
3275
+ "isReadonly": false,
3276
+ "isOptional": false,
3277
+ "releaseTag": "Public",
3278
+ "name": "serverTitle",
3279
+ "propertyTypeTokenRange": {
3280
+ "startIndex": 1,
3281
+ "endIndex": 2
3282
+ }
3283
+ },
3284
+ {
3285
+ "kind": "PropertySignature",
3286
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#version:member",
3287
+ "docComment": "",
3288
+ "excerptTokens": [
3289
+ {
3290
+ "kind": "Content",
3291
+ "text": "version: "
3292
+ },
3293
+ {
3294
+ "kind": "Content",
3295
+ "text": "string"
3296
+ },
3297
+ {
3298
+ "kind": "Content",
3299
+ "text": ";"
3300
+ }
3301
+ ],
3302
+ "isReadonly": false,
3303
+ "isOptional": false,
3304
+ "releaseTag": "Public",
3305
+ "name": "version",
3306
+ "propertyTypeTokenRange": {
3307
+ "startIndex": 1,
3308
+ "endIndex": 2
3309
+ }
3310
+ },
3311
+ {
3312
+ "kind": "PropertySignature",
3313
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraServerInfo#versionNumbers:member",
3314
+ "docComment": "",
3315
+ "excerptTokens": [
3316
+ {
3317
+ "kind": "Content",
3318
+ "text": "versionNumbers: "
3319
+ },
3320
+ {
3321
+ "kind": "Content",
3322
+ "text": "number[]"
3323
+ },
3324
+ {
3325
+ "kind": "Content",
3326
+ "text": ";"
3327
+ }
3328
+ ],
3329
+ "isReadonly": false,
3330
+ "isOptional": false,
3331
+ "releaseTag": "Public",
3332
+ "name": "versionNumbers",
3333
+ "propertyTypeTokenRange": {
3334
+ "startIndex": 1,
3335
+ "endIndex": 2
3336
+ }
3337
+ }
3338
+ ],
3339
+ "extendsTokenRanges": []
3340
+ },
2811
3341
  {
2812
3342
  "kind": "TypeAlias",
2813
3343
  "canonicalReference": "@valiantys/atlassian-app-frontend!Precomputation:type",
@@ -3628,11 +4158,33 @@
3628
4158
  "excerptTokens": [
3629
4159
  {
3630
4160
  "kind": "Content",
3631
- "text": "export interface StaticIssueFields "
4161
+ "text": "export interface StaticIssueFields<T = "
4162
+ },
4163
+ {
4164
+ "kind": "Reference",
4165
+ "text": "AtlassianDocumentFormat",
4166
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat:interface"
4167
+ },
4168
+ {
4169
+ "kind": "Content",
4170
+ "text": "> "
3632
4171
  }
3633
4172
  ],
3634
4173
  "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
3635
4174
  "releaseTag": "Public",
4175
+ "typeParameters": [
4176
+ {
4177
+ "typeParameterName": "T",
4178
+ "constraintTokenRange": {
4179
+ "startIndex": 0,
4180
+ "endIndex": 0
4181
+ },
4182
+ "defaultTypeTokenRange": {
4183
+ "startIndex": 1,
4184
+ "endIndex": 2
4185
+ }
4186
+ }
4187
+ ],
3636
4188
  "name": "StaticIssueFields",
3637
4189
  "preserveMemberOrder": false,
3638
4190
  "members": [
@@ -3756,9 +4308,8 @@
3756
4308
  "text": "description?: "
3757
4309
  },
3758
4310
  {
3759
- "kind": "Reference",
3760
- "text": "AtlassianDocumentFormat",
3761
- "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat:interface"
4311
+ "kind": "Content",
4312
+ "text": "T"
3762
4313
  },
3763
4314
  {
3764
4315
  "kind": "Content",
package/util-jira-v3-api/atlassian-app-frontend.api.md CHANGED
@@ -83,7 +83,7 @@ export interface CreatedIssue {
83
83
  // @public (undocumented)
84
84
  export interface CreateIssue {
85
85
  // (undocumented)
86
- fields: IssueFields;
86
+ fields: IssueFields<string>;
87
87
  // (undocumented)
88
88
  historyMetadata?: HistoryMetadata;
89
89
  // (undocumented)
@@ -121,6 +121,16 @@ export type FixVersions = {
121
121
  self: string;
122
122
  }[];
123
123
 
124
+ // @public (undocumented)
125
+ export interface HealthCheckResult {
126
+ // (undocumented)
127
+ description: string;
128
+ // (undocumented)
129
+ name: string;
130
+ // (undocumented)
131
+ passed: boolean;
132
+ }
133
+
124
134
  // @public (undocumented)
125
135
  export interface HistoryMetadata {
126
136
  // (undocumented)
@@ -196,7 +206,7 @@ export type IssueComment = {
196
206
  };
197
207
 
198
208
  // @public (undocumented)
199
- export type IssueFields = CustomFields & StaticIssueFields;
209
+ export type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
200
210
 
201
211
  // @public (undocumented)
202
212
  export interface IssueLink {
@@ -258,7 +268,7 @@ export interface IssueTransition {
258
268
  // (undocumented)
259
269
  id: string;
260
270
  // (undocumented)
261
- looped: boolean;
271
+ looped?: boolean;
262
272
  }
263
273
 
264
274
  // @public (undocumented)
@@ -289,6 +299,38 @@ export type JiraCommentResponse = {
289
299
  total: number;
290
300
  };
291
301
 
302
+ // @public (undocumented)
303
+ export interface JiraServerInfo {
304
+ // (undocumented)
305
+ baseUrl: string;
306
+ // (undocumented)
307
+ buildDate: string;
308
+ // (undocumented)
309
+ buildNumber: number;
310
+ // (undocumented)
311
+ deploymentType: string;
312
+ // (undocumented)
313
+ displayUrl: string;
314
+ // (undocumented)
315
+ displayUrlConfluence: string;
316
+ // (undocumented)
317
+ displayUrlServicedeskHelpCenter: string;
318
+ // (undocumented)
319
+ healthChecks: HealthCheckResult[];
320
+ // (undocumented)
321
+ scmInfo: string;
322
+ // (undocumented)
323
+ serverTime: string;
324
+ // (undocumented)
325
+ serverTimeZone: string;
326
+ // (undocumented)
327
+ serverTitle: string;
328
+ // (undocumented)
329
+ version: string;
330
+ // (undocumented)
331
+ versionNumbers: number[];
332
+ }
333
+
292
334
  // @public (undocumented)
293
335
  export type Precomputation = {
294
336
  id: string;
@@ -392,7 +434,7 @@ export interface ProjectVersion {
392
434
  }
393
435
 
394
436
  // @public (undocumented)
395
- export interface StaticIssueFields {
437
+ export interface StaticIssueFields<T = AtlassianDocumentFormat> {
396
438
  // (undocumented)
397
439
  aggregatetimespent?: number;
398
440
  // (undocumented)
@@ -402,7 +444,7 @@ export interface StaticIssueFields {
402
444
  // (undocumented)
403
445
  creator?: User;
404
446
  // (undocumented)
405
- description?: AtlassianDocumentFormat;
447
+ description?: T;
406
448
  // (undocumented)
407
449
  fixVersions?: FixVersions;
408
450
  // (undocumented)
package/util-jira-v3-api/index.d.ts CHANGED
@@ -49,7 +49,7 @@ export declare interface CreatedIssue {
49
49
  }
50
50
 
51
51
  export declare interface CreateIssue {
52
- fields: IssueFields;
52
+ fields: IssueFields<string>;
53
53
  properties?: {
54
54
  key: string;
55
55
  value: unknown;
@@ -77,6 +77,12 @@ export declare type FixVersions = {
77
77
  self: string;
78
78
  }[];
79
79
 
80
+ export declare interface HealthCheckResult {
81
+ description: string;
82
+ name: string;
83
+ passed: boolean;
84
+ }
85
+
80
86
  export declare interface HistoryMetadata {
81
87
  activityDescription?: string;
82
88
  activityDescriptionKey?: string;
@@ -123,7 +129,7 @@ export declare type IssueComment = {
123
129
  visibility: Visibility;
124
130
  };
125
131
 
126
- export declare type IssueFields = CustomFields & StaticIssueFields;
132
+ export declare type IssueFields<T = AtlassianDocumentFormat> = CustomFields & StaticIssueFields<T>;
127
133
 
128
134
  export declare interface IssueLink {
129
135
  outwardIssue?: Issue;
@@ -166,7 +172,7 @@ export declare interface IssueStatus {
166
172
 
167
173
  export declare interface IssueTransition {
168
174
  id: string;
169
- looped: boolean;
175
+ looped?: boolean;
170
176
  }
171
177
 
172
178
  export declare interface IssueTypeDetails {
@@ -187,6 +193,23 @@ export declare type JiraCommentResponse = {
187
193
  total: number;
188
194
  };
189
195
 
196
+ export declare interface JiraServerInfo {
197
+ baseUrl: string;
198
+ buildDate: string;
199
+ buildNumber: number;
200
+ deploymentType: string;
201
+ displayUrl: string;
202
+ displayUrlConfluence: string;
203
+ displayUrlServicedeskHelpCenter: string;
204
+ healthChecks: HealthCheckResult[];
205
+ scmInfo: string;
206
+ serverTime: string;
207
+ serverTimeZone: string;
208
+ serverTitle: string;
209
+ version: string;
210
+ versionNumbers: number[];
211
+ }
212
+
190
213
  export declare type Precomputation = {
191
214
  id: string;
192
215
  value: string;
@@ -258,7 +281,7 @@ export declare interface ProjectVersion {
258
281
  userReleaseDate?: string;
259
282
  }
260
283
 
261
- export declare interface StaticIssueFields {
284
+ export declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
262
285
  statuscategorychangedate?: string;
263
286
  fixVersions?: FixVersions;
264
287
  resolution?: unknown;
@@ -299,7 +322,7 @@ export declare interface StaticIssueFields {
299
322
  };
300
323
  created?: string;
301
324
  updated?: string;
302
- description?: AtlassianDocumentFormat;
325
+ description?: T;
303
326
  timetracking?: {
304
327
  remainingEstimate: string;
305
328
  timeSpent: string;