@valiantys/atlassian-app-frontend 3.0.0-alpha-2 → 3.0.0-alpha-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.
@@ -1 +1 @@
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)}};h.issueUrl="/rest/api/3/issue";let i=h;exports.JiraIssueService=i;
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 o=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(...o.issues),c=o.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){return(await this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment?startAt=${s}`})).comments}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)}};u.issueUrl="/rest/api/3/issue";let i=u;exports.JiraIssueService=i;
@@ -73,9 +73,30 @@ const i = class i {
73
73
  s
74
74
  );
75
75
  }
76
+ async getIssueComments(e, s = 0) {
77
+ return (await this.fetchSvc.fetch({
78
+ method: "GET",
79
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment?startAt=${s}`
80
+ })).comments;
81
+ }
82
+ async getIssueCommentById(e, s) {
83
+ return await this.fetchSvc.fetch({
84
+ method: "GET",
85
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${s}`
86
+ });
87
+ }
88
+ async addIssueComment(e, s) {
89
+ return await this.fetchSvc.fetch(
90
+ {
91
+ method: "POST",
92
+ url: this.fetchSvc.route`/rest/api/3/issue/${e}/comment`
93
+ },
94
+ s
95
+ );
96
+ }
76
97
  };
77
98
  i.issueUrl = "/rest/api/3/issue";
78
- let r = i;
99
+ let o = i;
79
100
  export {
80
- r as JiraIssueService
101
+ o as JiraIssueService
81
102
  };
@@ -225,6 +225,84 @@
225
225
  }
226
226
  ]
227
227
  },
228
+ {
229
+ "kind": "Method",
230
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#addIssueComment:member(1)",
231
+ "docComment": "",
232
+ "excerptTokens": [
233
+ {
234
+ "kind": "Content",
235
+ "text": "addIssueComment(issueIdOrKey: "
236
+ },
237
+ {
238
+ "kind": "Content",
239
+ "text": "string"
240
+ },
241
+ {
242
+ "kind": "Content",
243
+ "text": ", body: "
244
+ },
245
+ {
246
+ "kind": "Content",
247
+ "text": "any"
248
+ },
249
+ {
250
+ "kind": "Content",
251
+ "text": "): "
252
+ },
253
+ {
254
+ "kind": "Reference",
255
+ "text": "Promise",
256
+ "canonicalReference": "!Promise:interface"
257
+ },
258
+ {
259
+ "kind": "Content",
260
+ "text": "<"
261
+ },
262
+ {
263
+ "kind": "Reference",
264
+ "text": "IssueComment",
265
+ "canonicalReference": "@valiantys/atlassian-app-frontend!~IssueComment:type"
266
+ },
267
+ {
268
+ "kind": "Content",
269
+ "text": ">"
270
+ },
271
+ {
272
+ "kind": "Content",
273
+ "text": ";"
274
+ }
275
+ ],
276
+ "isStatic": false,
277
+ "returnTypeTokenRange": {
278
+ "startIndex": 5,
279
+ "endIndex": 9
280
+ },
281
+ "releaseTag": "Public",
282
+ "isProtected": false,
283
+ "overloadIndex": 1,
284
+ "parameters": [
285
+ {
286
+ "parameterName": "issueIdOrKey",
287
+ "parameterTypeTokenRange": {
288
+ "startIndex": 1,
289
+ "endIndex": 2
290
+ },
291
+ "isOptional": false
292
+ },
293
+ {
294
+ "parameterName": "body",
295
+ "parameterTypeTokenRange": {
296
+ "startIndex": 3,
297
+ "endIndex": 4
298
+ },
299
+ "isOptional": false
300
+ }
301
+ ],
302
+ "isOptional": false,
303
+ "isAbstract": false,
304
+ "name": "addIssueComment"
305
+ },
228
306
  {
229
307
  "kind": "Method",
230
308
  "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#addWorklog:member(1)",
@@ -445,6 +523,162 @@
445
523
  "isAbstract": false,
446
524
  "name": "getIssue"
447
525
  },
526
+ {
527
+ "kind": "Method",
528
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#getIssueCommentById:member(1)",
529
+ "docComment": "",
530
+ "excerptTokens": [
531
+ {
532
+ "kind": "Content",
533
+ "text": "getIssueCommentById(issueIdOrKey: "
534
+ },
535
+ {
536
+ "kind": "Content",
537
+ "text": "string"
538
+ },
539
+ {
540
+ "kind": "Content",
541
+ "text": ", commentId: "
542
+ },
543
+ {
544
+ "kind": "Content",
545
+ "text": "string"
546
+ },
547
+ {
548
+ "kind": "Content",
549
+ "text": "): "
550
+ },
551
+ {
552
+ "kind": "Reference",
553
+ "text": "Promise",
554
+ "canonicalReference": "!Promise:interface"
555
+ },
556
+ {
557
+ "kind": "Content",
558
+ "text": "<"
559
+ },
560
+ {
561
+ "kind": "Reference",
562
+ "text": "IssueComment",
563
+ "canonicalReference": "@valiantys/atlassian-app-frontend!~IssueComment:type"
564
+ },
565
+ {
566
+ "kind": "Content",
567
+ "text": " | undefined>"
568
+ },
569
+ {
570
+ "kind": "Content",
571
+ "text": ";"
572
+ }
573
+ ],
574
+ "isStatic": false,
575
+ "returnTypeTokenRange": {
576
+ "startIndex": 5,
577
+ "endIndex": 9
578
+ },
579
+ "releaseTag": "Public",
580
+ "isProtected": false,
581
+ "overloadIndex": 1,
582
+ "parameters": [
583
+ {
584
+ "parameterName": "issueIdOrKey",
585
+ "parameterTypeTokenRange": {
586
+ "startIndex": 1,
587
+ "endIndex": 2
588
+ },
589
+ "isOptional": false
590
+ },
591
+ {
592
+ "parameterName": "commentId",
593
+ "parameterTypeTokenRange": {
594
+ "startIndex": 3,
595
+ "endIndex": 4
596
+ },
597
+ "isOptional": false
598
+ }
599
+ ],
600
+ "isOptional": false,
601
+ "isAbstract": false,
602
+ "name": "getIssueCommentById"
603
+ },
604
+ {
605
+ "kind": "Method",
606
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#getIssueComments:member(1)",
607
+ "docComment": "",
608
+ "excerptTokens": [
609
+ {
610
+ "kind": "Content",
611
+ "text": "getIssueComments(issueIdOrKey: "
612
+ },
613
+ {
614
+ "kind": "Content",
615
+ "text": "string"
616
+ },
617
+ {
618
+ "kind": "Content",
619
+ "text": ", startAt?: "
620
+ },
621
+ {
622
+ "kind": "Content",
623
+ "text": "number"
624
+ },
625
+ {
626
+ "kind": "Content",
627
+ "text": "): "
628
+ },
629
+ {
630
+ "kind": "Reference",
631
+ "text": "Promise",
632
+ "canonicalReference": "!Promise:interface"
633
+ },
634
+ {
635
+ "kind": "Content",
636
+ "text": "<"
637
+ },
638
+ {
639
+ "kind": "Reference",
640
+ "text": "IssueComment",
641
+ "canonicalReference": "@valiantys/atlassian-app-frontend!~IssueComment:type"
642
+ },
643
+ {
644
+ "kind": "Content",
645
+ "text": "[] | undefined>"
646
+ },
647
+ {
648
+ "kind": "Content",
649
+ "text": ";"
650
+ }
651
+ ],
652
+ "isStatic": false,
653
+ "returnTypeTokenRange": {
654
+ "startIndex": 5,
655
+ "endIndex": 9
656
+ },
657
+ "releaseTag": "Public",
658
+ "isProtected": false,
659
+ "overloadIndex": 1,
660
+ "parameters": [
661
+ {
662
+ "parameterName": "issueIdOrKey",
663
+ "parameterTypeTokenRange": {
664
+ "startIndex": 1,
665
+ "endIndex": 2
666
+ },
667
+ "isOptional": false
668
+ },
669
+ {
670
+ "parameterName": "startAt",
671
+ "parameterTypeTokenRange": {
672
+ "startIndex": 3,
673
+ "endIndex": 4
674
+ },
675
+ "isOptional": true
676
+ }
677
+ ],
678
+ "isOptional": false,
679
+ "isAbstract": false,
680
+ "name": "getIssueComments"
681
+ },
448
682
  {
449
683
  "kind": "Method",
450
684
  "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#getIssueField:member(1)",
@@ -8,6 +8,8 @@
8
8
  export class JiraIssueService {
9
9
  // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-issue.d.ts
10
10
  constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
11
+ // (undocumented)
12
+ addIssueComment(issueIdOrKey: string, body: any): Promise<IssueComment>;
11
13
  // Warning: (ae-forgotten-export) The symbol "WorklogCreateRequest" needs to be exported by the entry point data-access-issue.d.ts
12
14
  // Warning: (ae-forgotten-export) The symbol "Worklog" needs to be exported by the entry point data-access-issue.d.ts
13
15
  //
@@ -23,6 +25,12 @@ export class JiraIssueService {
23
25
  // (undocumented)
24
26
  getIssue(issueIdOrKey: string, fields?: string[]): Promise<Issue | undefined>;
25
27
  // (undocumented)
28
+ getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
29
+ // Warning: (ae-forgotten-export) The symbol "IssueComment" needs to be exported by the entry point data-access-issue.d.ts
30
+ //
31
+ // (undocumented)
32
+ getIssueComments(issueIdOrKey: string, startAt?: number): Promise<IssueComment[] | undefined>;
33
+ // (undocumented)
26
34
  getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
27
35
  // Warning: (ae-forgotten-export) The symbol "IssueFields" needs to be exported by the entry point data-access-issue.d.ts
28
36
  //
@@ -15,6 +15,13 @@ declare interface AvatarUrls {
15
15
  '32x32': string;
16
16
  }
17
17
 
18
+ declare type CommentAuthor = {
19
+ accountId: string;
20
+ active: boolean;
21
+ displayName: string;
22
+ self: string;
23
+ };
24
+
18
25
  declare interface CreatedIssue {
19
26
  id: string;
20
27
  key: string;
@@ -104,6 +111,21 @@ declare interface Issue {
104
111
  fields: IssueFields;
105
112
  }
106
113
 
114
+ declare type IssueComment = {
115
+ author: CommentAuthor;
116
+ body: {
117
+ type: string;
118
+ version: number;
119
+ content: unknown[];
120
+ };
121
+ created: string;
122
+ id: string;
123
+ self: string;
124
+ updateAuthor: CommentAuthor;
125
+ updated: string;
126
+ visibility: Visibility;
127
+ };
128
+
107
129
  declare type IssueFields = CustomFields & StaticIssueFields;
108
130
 
109
131
  declare interface IssueLink {
@@ -146,6 +168,9 @@ export declare class JiraIssueService {
146
168
  queryForIssuesInProjects(projectIds: number[]): Promise<Issue[]>;
147
169
  createIssue(body: CreateIssue): Promise<CreatedIssue>;
148
170
  updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
171
+ getIssueComments(issueIdOrKey: string, startAt?: number): Promise<IssueComment[] | undefined>;
172
+ getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
173
+ addIssueComment(issueIdOrKey: string, body: any): Promise<IssueComment>;
149
174
  }
150
175
 
151
176
  declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
@@ -242,6 +267,12 @@ declare interface User {
242
267
  self?: string;
243
268
  }
244
269
 
270
+ declare type Visibility = {
271
+ identifier: string;
272
+ type: string;
273
+ value: string;
274
+ };
275
+
245
276
  declare interface Worklog extends WorklogCreateRequest {
246
277
  self: string;
247
278
  id: string;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@valiantys/atlassian-app-frontend",
3
- "version": "3.0.0-alpha-2",
3
+ "version": "3.0.0-alpha-4",
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": {
@@ -83,6 +83,11 @@
83
83
  "require": "./ui-host-router/index.cjs.js",
84
84
  "types": "./ui-host-router/index.d.ts"
85
85
  },
86
+ "./ui-iframe": {
87
+ "import": "./ui-iframe/index.es.js",
88
+ "require": "./ui-iframe/index.cjs.js",
89
+ "types": "./ui-iframe/index.d.ts"
90
+ },
86
91
  "./ui-modal": {
87
92
  "import": "./ui-modal/index.es.js",
88
93
  "require": "./ui-modal/index.cjs.js",
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react");function i(t){return console.error(t),`Error Occurred: ${t.message||t}`}function d(t,c=i){const[u,s]=e.useState(),[l,r]=e.useState(!0),[f,n]=e.useState(),o=e.useCallback(async()=>{r(!0);try{const a=await t();return s(a),a}catch(a){n(c(a))}finally{r(!1)}},[t,c]);return e.useEffect(()=>{o()},[o]),{data:u,loading:l,error:f,setData:s,setLoading:r,setError:n,manualTrigger:()=>o()}}exports.useLoadDataEffect=d;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("react");function d(t){return console.error(t),`Error Occurred: ${t.message||t}`}function f(t,n=d){const[u,r]=e.useState(),[i,o]=e.useState(!0),[l,c]=e.useState(),s=e.useCallback(async()=>{o(!0);try{c(void 0);const a=await t();return r(a),a}catch(a){c(n(a)),r(void 0)}finally{o(!1)}},[t,n]);return e.useEffect(()=>{s()},[s]),{data:u,loading:i,error:l,setData:r,setLoading:o,setError:c,manualTrigger:()=>s()}}exports.useLoadDataEffect=f;
@@ -1,29 +1,30 @@
1
- import { useState as o, useCallback as i, useEffect as d } from "react";
1
+ import { useState as n, useCallback as d, useEffect as f } from "react";
2
2
  function g(r) {
3
3
  return console.error(r), `Error Occurred: ${r.message || r}`;
4
4
  }
5
- function m(r, c = g) {
6
- const [u, n] = o(), [l, a] = o(!0), [f, s] = o(), e = i(async () => {
7
- a(!0);
5
+ function m(r, s = g) {
6
+ const [u, a] = n(), [i, o] = n(!0), [l, e] = n(), c = d(async () => {
7
+ o(!0);
8
8
  try {
9
+ e(void 0);
9
10
  const t = await r();
10
- return n(t), t;
11
+ return a(t), t;
11
12
  } catch (t) {
12
- s(c(t));
13
+ e(s(t)), a(void 0);
13
14
  } finally {
14
- a(!1);
15
+ o(!1);
15
16
  }
16
- }, [r, c]);
17
- return d(() => {
18
- e();
19
- }, [e]), {
17
+ }, [r, s]);
18
+ return f(() => {
19
+ c();
20
+ }, [c]), {
20
21
  data: u,
21
- loading: l,
22
- error: f,
23
- setData: n,
24
- setLoading: a,
25
- setError: s,
26
- manualTrigger: () => e()
22
+ loading: i,
23
+ error: l,
24
+ setData: a,
25
+ setLoading: o,
26
+ setError: e,
27
+ manualTrigger: () => c()
27
28
  };
28
29
  }
29
30
  export {
@@ -0,0 +1,376 @@
1
+ {
2
+ "metadata": {
3
+ "toolPackage": "@microsoft/api-extractor",
4
+ "toolVersion": "7.52.8",
5
+ "schemaVersion": 1011,
6
+ "oldestForwardsCompatibleVersion": 1001,
7
+ "tsdocConfig": {
8
+ "$schema": "https://developer.microsoft.com/json-schemas/tsdoc/v0/tsdoc.schema.json",
9
+ "noStandardTags": true,
10
+ "tagDefinitions": [
11
+ {
12
+ "tagName": "@alpha",
13
+ "syntaxKind": "modifier"
14
+ },
15
+ {
16
+ "tagName": "@beta",
17
+ "syntaxKind": "modifier"
18
+ },
19
+ {
20
+ "tagName": "@defaultValue",
21
+ "syntaxKind": "block"
22
+ },
23
+ {
24
+ "tagName": "@decorator",
25
+ "syntaxKind": "block",
26
+ "allowMultiple": true
27
+ },
28
+ {
29
+ "tagName": "@deprecated",
30
+ "syntaxKind": "block"
31
+ },
32
+ {
33
+ "tagName": "@eventProperty",
34
+ "syntaxKind": "modifier"
35
+ },
36
+ {
37
+ "tagName": "@example",
38
+ "syntaxKind": "block",
39
+ "allowMultiple": true
40
+ },
41
+ {
42
+ "tagName": "@experimental",
43
+ "syntaxKind": "modifier"
44
+ },
45
+ {
46
+ "tagName": "@inheritDoc",
47
+ "syntaxKind": "inline"
48
+ },
49
+ {
50
+ "tagName": "@internal",
51
+ "syntaxKind": "modifier"
52
+ },
53
+ {
54
+ "tagName": "@label",
55
+ "syntaxKind": "inline"
56
+ },
57
+ {
58
+ "tagName": "@link",
59
+ "syntaxKind": "inline",
60
+ "allowMultiple": true
61
+ },
62
+ {
63
+ "tagName": "@override",
64
+ "syntaxKind": "modifier"
65
+ },
66
+ {
67
+ "tagName": "@packageDocumentation",
68
+ "syntaxKind": "modifier"
69
+ },
70
+ {
71
+ "tagName": "@param",
72
+ "syntaxKind": "block",
73
+ "allowMultiple": true
74
+ },
75
+ {
76
+ "tagName": "@privateRemarks",
77
+ "syntaxKind": "block"
78
+ },
79
+ {
80
+ "tagName": "@public",
81
+ "syntaxKind": "modifier"
82
+ },
83
+ {
84
+ "tagName": "@readonly",
85
+ "syntaxKind": "modifier"
86
+ },
87
+ {
88
+ "tagName": "@remarks",
89
+ "syntaxKind": "block"
90
+ },
91
+ {
92
+ "tagName": "@returns",
93
+ "syntaxKind": "block"
94
+ },
95
+ {
96
+ "tagName": "@sealed",
97
+ "syntaxKind": "modifier"
98
+ },
99
+ {
100
+ "tagName": "@see",
101
+ "syntaxKind": "block"
102
+ },
103
+ {
104
+ "tagName": "@throws",
105
+ "syntaxKind": "block",
106
+ "allowMultiple": true
107
+ },
108
+ {
109
+ "tagName": "@typeParam",
110
+ "syntaxKind": "block",
111
+ "allowMultiple": true
112
+ },
113
+ {
114
+ "tagName": "@virtual",
115
+ "syntaxKind": "modifier"
116
+ },
117
+ {
118
+ "tagName": "@betaDocumentation",
119
+ "syntaxKind": "modifier"
120
+ },
121
+ {
122
+ "tagName": "@internalRemarks",
123
+ "syntaxKind": "block"
124
+ },
125
+ {
126
+ "tagName": "@preapproved",
127
+ "syntaxKind": "modifier"
128
+ }
129
+ ],
130
+ "supportForTags": {
131
+ "@alpha": true,
132
+ "@beta": true,
133
+ "@defaultValue": true,
134
+ "@decorator": true,
135
+ "@deprecated": true,
136
+ "@eventProperty": true,
137
+ "@example": true,
138
+ "@experimental": true,
139
+ "@inheritDoc": true,
140
+ "@internal": true,
141
+ "@label": true,
142
+ "@link": true,
143
+ "@override": true,
144
+ "@packageDocumentation": true,
145
+ "@param": true,
146
+ "@privateRemarks": true,
147
+ "@public": true,
148
+ "@readonly": true,
149
+ "@remarks": true,
150
+ "@returns": true,
151
+ "@sealed": true,
152
+ "@see": true,
153
+ "@throws": true,
154
+ "@typeParam": true,
155
+ "@virtual": true,
156
+ "@betaDocumentation": true,
157
+ "@internalRemarks": true,
158
+ "@preapproved": true
159
+ },
160
+ "reportUnsupportedHtmlElements": false
161
+ }
162
+ },
163
+ "kind": "Package",
164
+ "canonicalReference": "@valiantys/atlassian-app-frontend!",
165
+ "docComment": "",
166
+ "name": "@valiantys/atlassian-app-frontend",
167
+ "preserveMemberOrder": false,
168
+ "members": [
169
+ {
170
+ "kind": "EntryPoint",
171
+ "canonicalReference": "@valiantys/atlassian-app-frontend!",
172
+ "name": "",
173
+ "preserveMemberOrder": false,
174
+ "members": [
175
+ {
176
+ "kind": "Interface",
177
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeProps:interface",
178
+ "docComment": "",
179
+ "excerptTokens": [
180
+ {
181
+ "kind": "Content",
182
+ "text": "export interface IframeProps "
183
+ }
184
+ ],
185
+ "fileUrlPath": "../../shared/frontend-ui-iframe/src/lib/iframe-wrapper.d.ts",
186
+ "releaseTag": "Public",
187
+ "name": "IframeProps",
188
+ "preserveMemberOrder": false,
189
+ "members": [
190
+ {
191
+ "kind": "PropertySignature",
192
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeProps#height:member",
193
+ "docComment": "",
194
+ "excerptTokens": [
195
+ {
196
+ "kind": "Content",
197
+ "text": "height?: "
198
+ },
199
+ {
200
+ "kind": "Content",
201
+ "text": "string"
202
+ },
203
+ {
204
+ "kind": "Content",
205
+ "text": ";"
206
+ }
207
+ ],
208
+ "isReadonly": false,
209
+ "isOptional": true,
210
+ "releaseTag": "Public",
211
+ "name": "height",
212
+ "propertyTypeTokenRange": {
213
+ "startIndex": 1,
214
+ "endIndex": 2
215
+ }
216
+ },
217
+ {
218
+ "kind": "PropertySignature",
219
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeProps#link:member",
220
+ "docComment": "",
221
+ "excerptTokens": [
222
+ {
223
+ "kind": "Content",
224
+ "text": "link: "
225
+ },
226
+ {
227
+ "kind": "Content",
228
+ "text": "string"
229
+ },
230
+ {
231
+ "kind": "Content",
232
+ "text": ";"
233
+ }
234
+ ],
235
+ "isReadonly": false,
236
+ "isOptional": false,
237
+ "releaseTag": "Public",
238
+ "name": "link",
239
+ "propertyTypeTokenRange": {
240
+ "startIndex": 1,
241
+ "endIndex": 2
242
+ }
243
+ },
244
+ {
245
+ "kind": "PropertySignature",
246
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeProps#title:member",
247
+ "docComment": "",
248
+ "excerptTokens": [
249
+ {
250
+ "kind": "Content",
251
+ "text": "title?: "
252
+ },
253
+ {
254
+ "kind": "Content",
255
+ "text": "string"
256
+ },
257
+ {
258
+ "kind": "Content",
259
+ "text": ";"
260
+ }
261
+ ],
262
+ "isReadonly": false,
263
+ "isOptional": true,
264
+ "releaseTag": "Public",
265
+ "name": "title",
266
+ "propertyTypeTokenRange": {
267
+ "startIndex": 1,
268
+ "endIndex": 2
269
+ }
270
+ },
271
+ {
272
+ "kind": "PropertySignature",
273
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeProps#width:member",
274
+ "docComment": "",
275
+ "excerptTokens": [
276
+ {
277
+ "kind": "Content",
278
+ "text": "width?: "
279
+ },
280
+ {
281
+ "kind": "Content",
282
+ "text": "string"
283
+ },
284
+ {
285
+ "kind": "Content",
286
+ "text": ";"
287
+ }
288
+ ],
289
+ "isReadonly": false,
290
+ "isOptional": true,
291
+ "releaseTag": "Public",
292
+ "name": "width",
293
+ "propertyTypeTokenRange": {
294
+ "startIndex": 1,
295
+ "endIndex": 2
296
+ }
297
+ }
298
+ ],
299
+ "extendsTokenRanges": []
300
+ },
301
+ {
302
+ "kind": "Function",
303
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeWrapper:function(1)",
304
+ "docComment": "",
305
+ "excerptTokens": [
306
+ {
307
+ "kind": "Content",
308
+ "text": "export declare function IframeWrapper<T>({ iframeProps, messageCallback, onMouseOut, }: "
309
+ },
310
+ {
311
+ "kind": "Content",
312
+ "text": "{\n iframeProps: "
313
+ },
314
+ {
315
+ "kind": "Reference",
316
+ "text": "IframeProps",
317
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IframeProps:interface"
318
+ },
319
+ {
320
+ "kind": "Content",
321
+ "text": ";\n messageCallback?: (eventData: T) => void;\n onMouseOut?: () => void;\n}"
322
+ },
323
+ {
324
+ "kind": "Content",
325
+ "text": "): "
326
+ },
327
+ {
328
+ "kind": "Content",
329
+ "text": "import(\"react/jsx-runtime\")."
330
+ },
331
+ {
332
+ "kind": "Reference",
333
+ "text": "JSX.Element",
334
+ "canonicalReference": "@types/react!JSX.Element:interface"
335
+ },
336
+ {
337
+ "kind": "Content",
338
+ "text": ";"
339
+ }
340
+ ],
341
+ "fileUrlPath": "../../shared/frontend-ui-iframe/src/lib/iframe-wrapper.d.ts",
342
+ "returnTypeTokenRange": {
343
+ "startIndex": 5,
344
+ "endIndex": 7
345
+ },
346
+ "releaseTag": "Public",
347
+ "overloadIndex": 1,
348
+ "parameters": [
349
+ {
350
+ "parameterName": "{ iframeProps, messageCallback, onMouseOut, }",
351
+ "parameterTypeTokenRange": {
352
+ "startIndex": 1,
353
+ "endIndex": 4
354
+ },
355
+ "isOptional": false
356
+ }
357
+ ],
358
+ "typeParameters": [
359
+ {
360
+ "typeParameterName": "T",
361
+ "constraintTokenRange": {
362
+ "startIndex": 0,
363
+ "endIndex": 0
364
+ },
365
+ "defaultTypeTokenRange": {
366
+ "startIndex": 0,
367
+ "endIndex": 0
368
+ }
369
+ }
370
+ ],
371
+ "name": "IframeWrapper"
372
+ }
373
+ ]
374
+ }
375
+ ]
376
+ }
@@ -0,0 +1,30 @@
1
+ ## API Report File for "@valiantys/atlassian-app-frontend"
2
+
3
+ > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
+
5
+ ```ts
6
+
7
+ import { JSX as JSX_2 } from 'react/jsx-runtime';
8
+
9
+ // @public (undocumented)
10
+ export interface IframeProps {
11
+ // (undocumented)
12
+ height?: string;
13
+ // (undocumented)
14
+ link: string;
15
+ // (undocumented)
16
+ title?: string;
17
+ // (undocumented)
18
+ width?: string;
19
+ }
20
+
21
+ // @public (undocumented)
22
+ export function IframeWrapper<T>({ iframeProps, messageCallback, onMouseOut, }: {
23
+ iframeProps: IframeProps;
24
+ messageCallback?: (eventData: T) => void;
25
+ onMouseOut?: () => void;
26
+ }): JSX_2.Element;
27
+
28
+ // (No @packageDocumentation comment for this package)
29
+
30
+ ```
@@ -0,0 +1 @@
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/shared/frontend-ui-iframe/src/lib/iframe-wrapper/index.cjs.js");exports.IframeWrapper=e.IframeWrapper;
@@ -0,0 +1,16 @@
1
+ import { JSX as JSX_2 } from 'react/jsx-runtime';
2
+
3
+ export declare interface IframeProps {
4
+ link: string;
5
+ title?: string;
6
+ width?: string;
7
+ height?: string;
8
+ }
9
+
10
+ export declare function IframeWrapper<T>({ iframeProps, messageCallback, onMouseOut, }: {
11
+ iframeProps: IframeProps;
12
+ messageCallback?: (eventData: T) => void;
13
+ onMouseOut?: () => void;
14
+ }): JSX_2.Element;
15
+
16
+ export { }
@@ -0,0 +1,4 @@
1
+ import { IframeWrapper as p } from "../atlassian/shared/frontend-ui-iframe/src/lib/iframe-wrapper/index.es.js";
2
+ export {
3
+ p as IframeWrapper
4
+ };
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.52.8"
9
+ }
10
+ ]
11
+ }
@@ -298,6 +298,32 @@
298
298
  ],
299
299
  "extendsTokenRanges": []
300
300
  },
301
+ {
302
+ "kind": "TypeAlias",
303
+ "canonicalReference": "@valiantys/atlassian-app-frontend!CommentAuthor:type",
304
+ "docComment": "",
305
+ "excerptTokens": [
306
+ {
307
+ "kind": "Content",
308
+ "text": "export type CommentAuthor = "
309
+ },
310
+ {
311
+ "kind": "Content",
312
+ "text": "{\n accountId: string;\n active: boolean;\n displayName: string;\n self: string;\n}"
313
+ },
314
+ {
315
+ "kind": "Content",
316
+ "text": ";"
317
+ }
318
+ ],
319
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
320
+ "releaseTag": "Public",
321
+ "name": "CommentAuthor",
322
+ "typeTokenRange": {
323
+ "startIndex": 1,
324
+ "endIndex": 2
325
+ }
326
+ },
301
327
  {
302
328
  "kind": "Interface",
303
329
  "canonicalReference": "@valiantys/atlassian-app-frontend!CreatedIssue:interface",
@@ -1402,6 +1428,59 @@
1402
1428
  ],
1403
1429
  "extendsTokenRanges": []
1404
1430
  },
1431
+ {
1432
+ "kind": "TypeAlias",
1433
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IssueComment:type",
1434
+ "docComment": "",
1435
+ "excerptTokens": [
1436
+ {
1437
+ "kind": "Content",
1438
+ "text": "export type IssueComment = "
1439
+ },
1440
+ {
1441
+ "kind": "Content",
1442
+ "text": "{\n author: "
1443
+ },
1444
+ {
1445
+ "kind": "Reference",
1446
+ "text": "CommentAuthor",
1447
+ "canonicalReference": "@valiantys/atlassian-app-frontend!CommentAuthor:type"
1448
+ },
1449
+ {
1450
+ "kind": "Content",
1451
+ "text": ";\n body: {\n type: string;\n version: number;\n content: unknown[];\n };\n created: string;\n id: string;\n self: string;\n updateAuthor: "
1452
+ },
1453
+ {
1454
+ "kind": "Reference",
1455
+ "text": "CommentAuthor",
1456
+ "canonicalReference": "@valiantys/atlassian-app-frontend!CommentAuthor:type"
1457
+ },
1458
+ {
1459
+ "kind": "Content",
1460
+ "text": ";\n updated: string;\n visibility: "
1461
+ },
1462
+ {
1463
+ "kind": "Reference",
1464
+ "text": "Visibility",
1465
+ "canonicalReference": "@valiantys/atlassian-app-frontend!Visibility:type"
1466
+ },
1467
+ {
1468
+ "kind": "Content",
1469
+ "text": ";\n}"
1470
+ },
1471
+ {
1472
+ "kind": "Content",
1473
+ "text": ";"
1474
+ }
1475
+ ],
1476
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
1477
+ "releaseTag": "Public",
1478
+ "name": "IssueComment",
1479
+ "typeTokenRange": {
1480
+ "startIndex": 1,
1481
+ "endIndex": 8
1482
+ }
1483
+ },
1405
1484
  {
1406
1485
  "kind": "TypeAlias",
1407
1486
  "canonicalReference": "@valiantys/atlassian-app-frontend!IssueFields:type",
@@ -2025,6 +2104,41 @@
2025
2104
  ],
2026
2105
  "extendsTokenRanges": []
2027
2106
  },
2107
+ {
2108
+ "kind": "TypeAlias",
2109
+ "canonicalReference": "@valiantys/atlassian-app-frontend!JiraCommentResponse:type",
2110
+ "docComment": "",
2111
+ "excerptTokens": [
2112
+ {
2113
+ "kind": "Content",
2114
+ "text": "export type JiraCommentResponse = "
2115
+ },
2116
+ {
2117
+ "kind": "Content",
2118
+ "text": "{\n comments: "
2119
+ },
2120
+ {
2121
+ "kind": "Reference",
2122
+ "text": "IssueComment",
2123
+ "canonicalReference": "@valiantys/atlassian-app-frontend!IssueComment:type"
2124
+ },
2125
+ {
2126
+ "kind": "Content",
2127
+ "text": "[];\n maxResults: number;\n startAt: number;\n total: number;\n}"
2128
+ },
2129
+ {
2130
+ "kind": "Content",
2131
+ "text": ";"
2132
+ }
2133
+ ],
2134
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
2135
+ "releaseTag": "Public",
2136
+ "name": "JiraCommentResponse",
2137
+ "typeTokenRange": {
2138
+ "startIndex": 1,
2139
+ "endIndex": 4
2140
+ }
2141
+ },
2028
2142
  {
2029
2143
  "kind": "TypeAlias",
2030
2144
  "canonicalReference": "@valiantys/atlassian-app-frontend!Precomputation:type",
@@ -4043,6 +4157,32 @@
4043
4157
  ],
4044
4158
  "extendsTokenRanges": []
4045
4159
  },
4160
+ {
4161
+ "kind": "TypeAlias",
4162
+ "canonicalReference": "@valiantys/atlassian-app-frontend!Visibility:type",
4163
+ "docComment": "",
4164
+ "excerptTokens": [
4165
+ {
4166
+ "kind": "Content",
4167
+ "text": "export type Visibility = "
4168
+ },
4169
+ {
4170
+ "kind": "Content",
4171
+ "text": "{\n identifier: string;\n type: string;\n value: string;\n}"
4172
+ },
4173
+ {
4174
+ "kind": "Content",
4175
+ "text": ";"
4176
+ }
4177
+ ],
4178
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
4179
+ "releaseTag": "Public",
4180
+ "name": "Visibility",
4181
+ "typeTokenRange": {
4182
+ "startIndex": 1,
4183
+ "endIndex": 2
4184
+ }
4185
+ },
4046
4186
  {
4047
4187
  "kind": "Interface",
4048
4188
  "canonicalReference": "@valiantys/atlassian-app-frontend!Worklog:interface",
@@ -16,6 +16,14 @@ export interface AvatarUrls {
16
16
  '48x48': string;
17
17
  }
18
18
 
19
+ // @public (undocumented)
20
+ export type CommentAuthor = {
21
+ accountId: string;
22
+ active: boolean;
23
+ displayName: string;
24
+ self: string;
25
+ };
26
+
19
27
  // @public (undocumented)
20
28
  export interface CreatedIssue {
21
29
  // (undocumented)
@@ -134,6 +142,22 @@ export interface Issue {
134
142
  self?: string;
135
143
  }
136
144
 
145
+ // @public (undocumented)
146
+ export type IssueComment = {
147
+ author: CommentAuthor;
148
+ body: {
149
+ type: string;
150
+ version: number;
151
+ content: unknown[];
152
+ };
153
+ created: string;
154
+ id: string;
155
+ self: string;
156
+ updateAuthor: CommentAuthor;
157
+ updated: string;
158
+ visibility: Visibility;
159
+ };
160
+
137
161
  // @public (undocumented)
138
162
  export type IssueFields = CustomFields & StaticIssueFields;
139
163
 
@@ -197,6 +221,14 @@ export interface IssueTypeDetails {
197
221
  subtask: boolean;
198
222
  }
199
223
 
224
+ // @public (undocumented)
225
+ export type JiraCommentResponse = {
226
+ comments: IssueComment[];
227
+ maxResults: number;
228
+ startAt: number;
229
+ total: number;
230
+ };
231
+
200
232
  // @public (undocumented)
201
233
  export type Precomputation = {
202
234
  id: string;
@@ -436,6 +468,13 @@ export interface UserPickerUser {
436
468
  html?: string;
437
469
  }
438
470
 
471
+ // @public (undocumented)
472
+ export type Visibility = {
473
+ identifier: string;
474
+ type: string;
475
+ value: string;
476
+ };
477
+
439
478
  // @public (undocumented)
440
479
  export interface Worklog extends WorklogCreateRequest {
441
480
  // (undocumented)
@@ -5,6 +5,13 @@ export declare interface AvatarUrls {
5
5
  '32x32': string;
6
6
  }
7
7
 
8
+ export declare type CommentAuthor = {
9
+ accountId: string;
10
+ active: boolean;
11
+ displayName: string;
12
+ self: string;
13
+ };
14
+
8
15
  export declare interface CreatedIssue {
9
16
  id: string;
10
17
  key: string;
@@ -81,6 +88,21 @@ export declare interface Issue {
81
88
  fields: IssueFields;
82
89
  }
83
90
 
91
+ export declare type IssueComment = {
92
+ author: CommentAuthor;
93
+ body: {
94
+ type: string;
95
+ version: number;
96
+ content: unknown[];
97
+ };
98
+ created: string;
99
+ id: string;
100
+ self: string;
101
+ updateAuthor: CommentAuthor;
102
+ updated: string;
103
+ visibility: Visibility;
104
+ };
105
+
84
106
  export declare type IssueFields = CustomFields & StaticIssueFields;
85
107
 
86
108
  export declare interface IssueLink {
@@ -120,6 +142,13 @@ export declare interface IssueTypeDetails {
120
142
  subtask: boolean;
121
143
  }
122
144
 
145
+ export declare type JiraCommentResponse = {
146
+ comments: IssueComment[];
147
+ maxResults: number;
148
+ startAt: number;
149
+ total: number;
150
+ };
151
+
123
152
  export declare type Precomputation = {
124
153
  id: string;
125
154
  value: string;
@@ -283,6 +312,12 @@ export declare interface UserPickerUser {
283
312
  html?: string;
284
313
  }
285
314
 
315
+ export declare type Visibility = {
316
+ identifier: string;
317
+ type: string;
318
+ value: string;
319
+ };
320
+
286
321
  export declare interface Worklog extends WorklogCreateRequest {
287
322
  self: string;
288
323
  id: string;