@valiantys/atlassian-app-frontend 3.0.0-alpha-4 → 3.0.0-alpha-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 (11) hide show
  1. package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js +1 -1
  2. package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js +10 -2
  3. package/data-access-issue/atlassian-app-frontend-data-access-issue.api.json +3 -2
  4. package/data-access-issue/atlassian-app-frontend.api.md +3 -1
  5. package/data-access-issue/index.d.ts +22 -26
  6. package/package.json +1 -1
  7. package/util-jira-v3-api/atlassian-app-frontend-util-jira-v3-api.api.json +567 -32
  8. package/util-jira-v3-api/atlassian-app-frontend.api.md +53 -26
  9. package/util-jira-v3-api/index.cjs.js +1 -1
  10. package/util-jira-v3-api/index.d.ts +35 -25
  11. package/util-jira-v3-api/index.es.js +4 -2
package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="fixVersions";exports.FIX_VERSIONS_FIELD=e;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a="fixVersions";function e(t){return t.type==="paragraph"}function o(t){return t.type==="text"}exports.FIX_VERSIONS_FIELD=a;exports.isAtlassianDocumentFormatParagraphNode=e;exports.isAtlassianDocumentFormatTextNode=o;
package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js CHANGED
@@ -1,4 +1,12 @@
1
- const o = "fixVersions";
1
+ const a = "fixVersions";
2
+ function e(t) {
3
+ return t.type === "paragraph";
4
+ }
5
+ function n(t) {
6
+ return t.type === "text";
7
+ }
2
8
  export {
3
- o as FIX_VERSIONS_FIELD
9
+ a as FIX_VERSIONS_FIELD,
10
+ e as isAtlassianDocumentFormatParagraphNode,
11
+ n as isAtlassianDocumentFormatTextNode
4
12
  };
package/data-access-issue/atlassian-app-frontend-data-access-issue.api.json CHANGED
@@ -243,8 +243,9 @@
243
243
  "text": ", body: "
244
244
  },
245
245
  {
246
- "kind": "Content",
247
- "text": "any"
246
+ "kind": "Reference",
247
+ "text": "AtlassianDocumentFormat",
248
+ "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianDocumentFormat:interface"
248
249
  },
249
250
  {
250
251
  "kind": "Content",
package/data-access-issue/atlassian-app-frontend.api.md CHANGED
@@ -8,8 +8,10 @@
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
+ // Warning: (ae-forgotten-export) The symbol "AtlassianDocumentFormat" needs to be exported by the entry point data-access-issue.d.ts
12
+ //
11
13
  // (undocumented)
12
- addIssueComment(issueIdOrKey: string, body: any): Promise<IssueComment>;
14
+ addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
13
15
  // Warning: (ae-forgotten-export) The symbol "WorklogCreateRequest" needs to be exported by the entry point data-access-issue.d.ts
14
16
  // Warning: (ae-forgotten-export) The symbol "Worklog" needs to be exported by the entry point data-access-issue.d.ts
15
17
  //
package/data-access-issue/index.d.ts CHANGED
@@ -1,5 +1,22 @@
1
1
  declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
2
2
 
3
+ declare interface AtlassianDocumentFormat {
4
+ type: 'doc';
5
+ version: number;
6
+ content: AtlassianDocumentFormatNode[];
7
+ }
8
+
9
+ declare interface AtlassianDocumentFormatBlockNode {
10
+ type: string;
11
+ content: AtlassianDocumentFormatNode[];
12
+ }
13
+
14
+ declare interface AtlassianDocumentFormatInlineNode {
15
+ type: string;
16
+ }
17
+
18
+ declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
19
+
3
20
  declare interface AtlassianProductFetchService<P extends Product> {
4
21
  productType: P;
5
22
  fetch: FetchSignature;
@@ -15,13 +32,6 @@ declare interface AvatarUrls {
15
32
  '32x32': string;
16
33
  }
17
34
 
18
- declare type CommentAuthor = {
19
- accountId: string;
20
- active: boolean;
21
- displayName: string;
22
- self: string;
23
- };
24
-
25
35
  declare interface CreatedIssue {
26
36
  id: string;
27
37
  key: string;
@@ -112,16 +122,12 @@ declare interface Issue {
112
122
  }
113
123
 
114
124
  declare type IssueComment = {
115
- author: CommentAuthor;
116
- body: {
117
- type: string;
118
- version: number;
119
- content: unknown[];
120
- };
125
+ author: User;
126
+ body: AtlassianDocumentFormat;
121
127
  created: string;
122
128
  id: string;
123
129
  self: string;
124
- updateAuthor: CommentAuthor;
130
+ updateAuthor: User;
125
131
  updated: string;
126
132
  visibility: Visibility;
127
133
  };
@@ -170,7 +176,7 @@ export declare class JiraIssueService {
170
176
  updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
171
177
  getIssueComments(issueIdOrKey: string, startAt?: number): Promise<IssueComment[] | undefined>;
172
178
  getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
173
- addIssueComment(issueIdOrKey: string, body: any): Promise<IssueComment>;
179
+ addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
174
180
  }
175
181
 
176
182
  declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
@@ -229,17 +235,7 @@ declare interface StaticIssueFields {
229
235
  };
230
236
  created?: string;
231
237
  updated?: string;
232
- description?: {
233
- type: 'doc';
234
- version: 1;
235
- content: {
236
- type: 'paragraph';
237
- content: {
238
- type: 'text';
239
- text: string;
240
- }[];
241
- }[];
242
- };
238
+ description?: AtlassianDocumentFormat;
243
239
  timetracking?: {
244
240
  remainingEstimate: string;
245
241
  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-4",
3
+ "version": "3.0.0-alpha-5",
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
@@ -174,31 +174,36 @@
174
174
  "members": [
175
175
  {
176
176
  "kind": "Interface",
177
- "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls:interface",
177
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat:interface",
178
178
  "docComment": "",
179
179
  "excerptTokens": [
180
180
  {
181
181
  "kind": "Content",
182
- "text": "export interface AvatarUrls "
182
+ "text": "export interface AtlassianDocumentFormat "
183
183
  }
184
184
  ],
185
- "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/avatar.d.ts",
185
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
186
186
  "releaseTag": "Public",
187
- "name": "AvatarUrls",
187
+ "name": "AtlassianDocumentFormat",
188
188
  "preserveMemberOrder": false,
189
189
  "members": [
190
190
  {
191
191
  "kind": "PropertySignature",
192
- "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"16x16\":member",
192
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat#content:member",
193
193
  "docComment": "",
194
194
  "excerptTokens": [
195
195
  {
196
196
  "kind": "Content",
197
- "text": "'16x16': "
197
+ "text": "content: "
198
+ },
199
+ {
200
+ "kind": "Reference",
201
+ "text": "AtlassianDocumentFormatNode",
202
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatNode:type"
198
203
  },
199
204
  {
200
205
  "kind": "Content",
201
- "text": "string"
206
+ "text": "[]"
202
207
  },
203
208
  {
204
209
  "kind": "Content",
@@ -208,7 +213,34 @@
208
213
  "isReadonly": false,
209
214
  "isOptional": false,
210
215
  "releaseTag": "Public",
211
- "name": "\"16x16\"",
216
+ "name": "content",
217
+ "propertyTypeTokenRange": {
218
+ "startIndex": 1,
219
+ "endIndex": 3
220
+ }
221
+ },
222
+ {
223
+ "kind": "PropertySignature",
224
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat#type:member",
225
+ "docComment": "",
226
+ "excerptTokens": [
227
+ {
228
+ "kind": "Content",
229
+ "text": "type: "
230
+ },
231
+ {
232
+ "kind": "Content",
233
+ "text": "'doc'"
234
+ },
235
+ {
236
+ "kind": "Content",
237
+ "text": ";"
238
+ }
239
+ ],
240
+ "isReadonly": false,
241
+ "isOptional": false,
242
+ "releaseTag": "Public",
243
+ "name": "type",
212
244
  "propertyTypeTokenRange": {
213
245
  "startIndex": 1,
214
246
  "endIndex": 2
@@ -216,16 +248,16 @@
216
248
  },
217
249
  {
218
250
  "kind": "PropertySignature",
219
- "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"24x24\":member",
251
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat#version:member",
220
252
  "docComment": "",
221
253
  "excerptTokens": [
222
254
  {
223
255
  "kind": "Content",
224
- "text": "'24x24': "
256
+ "text": "version: "
225
257
  },
226
258
  {
227
259
  "kind": "Content",
228
- "text": "string"
260
+ "text": "number"
229
261
  },
230
262
  {
231
263
  "kind": "Content",
@@ -235,20 +267,70 @@
235
267
  "isReadonly": false,
236
268
  "isOptional": false,
237
269
  "releaseTag": "Public",
238
- "name": "\"24x24\"",
270
+ "name": "version",
239
271
  "propertyTypeTokenRange": {
240
272
  "startIndex": 1,
241
273
  "endIndex": 2
242
274
  }
275
+ }
276
+ ],
277
+ "extendsTokenRanges": []
278
+ },
279
+ {
280
+ "kind": "Interface",
281
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatBlockNode:interface",
282
+ "docComment": "",
283
+ "excerptTokens": [
284
+ {
285
+ "kind": "Content",
286
+ "text": "export interface AtlassianDocumentFormatBlockNode "
287
+ }
288
+ ],
289
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
290
+ "releaseTag": "Public",
291
+ "name": "AtlassianDocumentFormatBlockNode",
292
+ "preserveMemberOrder": false,
293
+ "members": [
294
+ {
295
+ "kind": "PropertySignature",
296
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatBlockNode#content:member",
297
+ "docComment": "",
298
+ "excerptTokens": [
299
+ {
300
+ "kind": "Content",
301
+ "text": "content: "
302
+ },
303
+ {
304
+ "kind": "Reference",
305
+ "text": "AtlassianDocumentFormatNode",
306
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatNode:type"
307
+ },
308
+ {
309
+ "kind": "Content",
310
+ "text": "[]"
311
+ },
312
+ {
313
+ "kind": "Content",
314
+ "text": ";"
315
+ }
316
+ ],
317
+ "isReadonly": false,
318
+ "isOptional": false,
319
+ "releaseTag": "Public",
320
+ "name": "content",
321
+ "propertyTypeTokenRange": {
322
+ "startIndex": 1,
323
+ "endIndex": 3
324
+ }
243
325
  },
244
326
  {
245
327
  "kind": "PropertySignature",
246
- "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"32x32\":member",
328
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatBlockNode#type:member",
247
329
  "docComment": "",
248
330
  "excerptTokens": [
249
331
  {
250
332
  "kind": "Content",
251
- "text": "'32x32': "
333
+ "text": "type: "
252
334
  },
253
335
  {
254
336
  "kind": "Content",
@@ -262,20 +344,38 @@
262
344
  "isReadonly": false,
263
345
  "isOptional": false,
264
346
  "releaseTag": "Public",
265
- "name": "\"32x32\"",
347
+ "name": "type",
266
348
  "propertyTypeTokenRange": {
267
349
  "startIndex": 1,
268
350
  "endIndex": 2
269
351
  }
270
- },
352
+ }
353
+ ],
354
+ "extendsTokenRanges": []
355
+ },
356
+ {
357
+ "kind": "Interface",
358
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatInlineNode:interface",
359
+ "docComment": "",
360
+ "excerptTokens": [
361
+ {
362
+ "kind": "Content",
363
+ "text": "export interface AtlassianDocumentFormatInlineNode "
364
+ }
365
+ ],
366
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
367
+ "releaseTag": "Public",
368
+ "name": "AtlassianDocumentFormatInlineNode",
369
+ "preserveMemberOrder": false,
370
+ "members": [
271
371
  {
272
372
  "kind": "PropertySignature",
273
- "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"48x48\":member",
373
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatInlineNode#type:member",
274
374
  "docComment": "",
275
375
  "excerptTokens": [
276
376
  {
277
377
  "kind": "Content",
278
- "text": "'48x48': "
378
+ "text": "type: "
279
379
  },
280
380
  {
281
381
  "kind": "Content",
@@ -289,7 +389,7 @@
289
389
  "isReadonly": false,
290
390
  "isOptional": false,
291
391
  "releaseTag": "Public",
292
- "name": "\"48x48\"",
392
+ "name": "type",
293
393
  "propertyTypeTokenRange": {
294
394
  "startIndex": 1,
295
395
  "endIndex": 2
@@ -300,16 +400,26 @@
300
400
  },
301
401
  {
302
402
  "kind": "TypeAlias",
303
- "canonicalReference": "@valiantys/atlassian-app-frontend!CommentAuthor:type",
403
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatNode:type",
304
404
  "docComment": "",
305
405
  "excerptTokens": [
306
406
  {
307
407
  "kind": "Content",
308
- "text": "export type CommentAuthor = "
408
+ "text": "export type AtlassianDocumentFormatNode = "
409
+ },
410
+ {
411
+ "kind": "Reference",
412
+ "text": "AtlassianDocumentFormatInlineNode",
413
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatInlineNode:interface"
309
414
  },
310
415
  {
311
416
  "kind": "Content",
312
- "text": "{\n accountId: string;\n active: boolean;\n displayName: string;\n self: string;\n}"
417
+ "text": " | "
418
+ },
419
+ {
420
+ "kind": "Reference",
421
+ "text": "AtlassianDocumentFormatBlockNode",
422
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatBlockNode:interface"
313
423
  },
314
424
  {
315
425
  "kind": "Content",
@@ -318,12 +428,315 @@
318
428
  ],
319
429
  "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
320
430
  "releaseTag": "Public",
321
- "name": "CommentAuthor",
431
+ "name": "AtlassianDocumentFormatNode",
322
432
  "typeTokenRange": {
323
433
  "startIndex": 1,
324
- "endIndex": 2
434
+ "endIndex": 4
325
435
  }
326
436
  },
437
+ {
438
+ "kind": "Interface",
439
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatParagraphNode:interface",
440
+ "docComment": "",
441
+ "excerptTokens": [
442
+ {
443
+ "kind": "Content",
444
+ "text": "export interface AtlassianDocumentFormatParagraphNode extends "
445
+ },
446
+ {
447
+ "kind": "Reference",
448
+ "text": "AtlassianDocumentFormatBlockNode",
449
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatBlockNode:interface"
450
+ },
451
+ {
452
+ "kind": "Content",
453
+ "text": " "
454
+ }
455
+ ],
456
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
457
+ "releaseTag": "Public",
458
+ "name": "AtlassianDocumentFormatParagraphNode",
459
+ "preserveMemberOrder": false,
460
+ "members": [
461
+ {
462
+ "kind": "PropertySignature",
463
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatParagraphNode#content:member",
464
+ "docComment": "",
465
+ "excerptTokens": [
466
+ {
467
+ "kind": "Content",
468
+ "text": "content: "
469
+ },
470
+ {
471
+ "kind": "Reference",
472
+ "text": "AtlassianDocumentFormatInlineNode",
473
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatInlineNode:interface"
474
+ },
475
+ {
476
+ "kind": "Content",
477
+ "text": "[]"
478
+ },
479
+ {
480
+ "kind": "Content",
481
+ "text": ";"
482
+ }
483
+ ],
484
+ "isReadonly": false,
485
+ "isOptional": false,
486
+ "releaseTag": "Public",
487
+ "name": "content",
488
+ "propertyTypeTokenRange": {
489
+ "startIndex": 1,
490
+ "endIndex": 3
491
+ }
492
+ },
493
+ {
494
+ "kind": "PropertySignature",
495
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatParagraphNode#type:member",
496
+ "docComment": "",
497
+ "excerptTokens": [
498
+ {
499
+ "kind": "Content",
500
+ "text": "type: "
501
+ },
502
+ {
503
+ "kind": "Content",
504
+ "text": "'paragraph'"
505
+ },
506
+ {
507
+ "kind": "Content",
508
+ "text": ";"
509
+ }
510
+ ],
511
+ "isReadonly": false,
512
+ "isOptional": false,
513
+ "releaseTag": "Public",
514
+ "name": "type",
515
+ "propertyTypeTokenRange": {
516
+ "startIndex": 1,
517
+ "endIndex": 2
518
+ }
519
+ }
520
+ ],
521
+ "extendsTokenRanges": [
522
+ {
523
+ "startIndex": 1,
524
+ "endIndex": 2
525
+ }
526
+ ]
527
+ },
528
+ {
529
+ "kind": "Interface",
530
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatTextNode:interface",
531
+ "docComment": "",
532
+ "excerptTokens": [
533
+ {
534
+ "kind": "Content",
535
+ "text": "export interface AtlassianDocumentFormatTextNode extends "
536
+ },
537
+ {
538
+ "kind": "Reference",
539
+ "text": "AtlassianDocumentFormatInlineNode",
540
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatInlineNode:interface"
541
+ },
542
+ {
543
+ "kind": "Content",
544
+ "text": " "
545
+ }
546
+ ],
547
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
548
+ "releaseTag": "Public",
549
+ "name": "AtlassianDocumentFormatTextNode",
550
+ "preserveMemberOrder": false,
551
+ "members": [
552
+ {
553
+ "kind": "PropertySignature",
554
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatTextNode#text:member",
555
+ "docComment": "",
556
+ "excerptTokens": [
557
+ {
558
+ "kind": "Content",
559
+ "text": "text: "
560
+ },
561
+ {
562
+ "kind": "Content",
563
+ "text": "string"
564
+ },
565
+ {
566
+ "kind": "Content",
567
+ "text": ";"
568
+ }
569
+ ],
570
+ "isReadonly": false,
571
+ "isOptional": false,
572
+ "releaseTag": "Public",
573
+ "name": "text",
574
+ "propertyTypeTokenRange": {
575
+ "startIndex": 1,
576
+ "endIndex": 2
577
+ }
578
+ },
579
+ {
580
+ "kind": "PropertySignature",
581
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatTextNode#type:member",
582
+ "docComment": "",
583
+ "excerptTokens": [
584
+ {
585
+ "kind": "Content",
586
+ "text": "type: "
587
+ },
588
+ {
589
+ "kind": "Content",
590
+ "text": "'text'"
591
+ },
592
+ {
593
+ "kind": "Content",
594
+ "text": ";"
595
+ }
596
+ ],
597
+ "isReadonly": false,
598
+ "isOptional": false,
599
+ "releaseTag": "Public",
600
+ "name": "type",
601
+ "propertyTypeTokenRange": {
602
+ "startIndex": 1,
603
+ "endIndex": 2
604
+ }
605
+ }
606
+ ],
607
+ "extendsTokenRanges": [
608
+ {
609
+ "startIndex": 1,
610
+ "endIndex": 2
611
+ }
612
+ ]
613
+ },
614
+ {
615
+ "kind": "Interface",
616
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls:interface",
617
+ "docComment": "",
618
+ "excerptTokens": [
619
+ {
620
+ "kind": "Content",
621
+ "text": "export interface AvatarUrls "
622
+ }
623
+ ],
624
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/avatar.d.ts",
625
+ "releaseTag": "Public",
626
+ "name": "AvatarUrls",
627
+ "preserveMemberOrder": false,
628
+ "members": [
629
+ {
630
+ "kind": "PropertySignature",
631
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"16x16\":member",
632
+ "docComment": "",
633
+ "excerptTokens": [
634
+ {
635
+ "kind": "Content",
636
+ "text": "'16x16': "
637
+ },
638
+ {
639
+ "kind": "Content",
640
+ "text": "string"
641
+ },
642
+ {
643
+ "kind": "Content",
644
+ "text": ";"
645
+ }
646
+ ],
647
+ "isReadonly": false,
648
+ "isOptional": false,
649
+ "releaseTag": "Public",
650
+ "name": "\"16x16\"",
651
+ "propertyTypeTokenRange": {
652
+ "startIndex": 1,
653
+ "endIndex": 2
654
+ }
655
+ },
656
+ {
657
+ "kind": "PropertySignature",
658
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"24x24\":member",
659
+ "docComment": "",
660
+ "excerptTokens": [
661
+ {
662
+ "kind": "Content",
663
+ "text": "'24x24': "
664
+ },
665
+ {
666
+ "kind": "Content",
667
+ "text": "string"
668
+ },
669
+ {
670
+ "kind": "Content",
671
+ "text": ";"
672
+ }
673
+ ],
674
+ "isReadonly": false,
675
+ "isOptional": false,
676
+ "releaseTag": "Public",
677
+ "name": "\"24x24\"",
678
+ "propertyTypeTokenRange": {
679
+ "startIndex": 1,
680
+ "endIndex": 2
681
+ }
682
+ },
683
+ {
684
+ "kind": "PropertySignature",
685
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"32x32\":member",
686
+ "docComment": "",
687
+ "excerptTokens": [
688
+ {
689
+ "kind": "Content",
690
+ "text": "'32x32': "
691
+ },
692
+ {
693
+ "kind": "Content",
694
+ "text": "string"
695
+ },
696
+ {
697
+ "kind": "Content",
698
+ "text": ";"
699
+ }
700
+ ],
701
+ "isReadonly": false,
702
+ "isOptional": false,
703
+ "releaseTag": "Public",
704
+ "name": "\"32x32\"",
705
+ "propertyTypeTokenRange": {
706
+ "startIndex": 1,
707
+ "endIndex": 2
708
+ }
709
+ },
710
+ {
711
+ "kind": "PropertySignature",
712
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AvatarUrls#\"48x48\":member",
713
+ "docComment": "",
714
+ "excerptTokens": [
715
+ {
716
+ "kind": "Content",
717
+ "text": "'48x48': "
718
+ },
719
+ {
720
+ "kind": "Content",
721
+ "text": "string"
722
+ },
723
+ {
724
+ "kind": "Content",
725
+ "text": ";"
726
+ }
727
+ ],
728
+ "isReadonly": false,
729
+ "isOptional": false,
730
+ "releaseTag": "Public",
731
+ "name": "\"48x48\"",
732
+ "propertyTypeTokenRange": {
733
+ "startIndex": 1,
734
+ "endIndex": 2
735
+ }
736
+ }
737
+ ],
738
+ "extendsTokenRanges": []
739
+ },
327
740
  {
328
741
  "kind": "Interface",
329
742
  "canonicalReference": "@valiantys/atlassian-app-frontend!CreatedIssue:interface",
@@ -1274,6 +1687,118 @@
1274
1687
  ],
1275
1688
  "extendsTokenRanges": []
1276
1689
  },
1690
+ {
1691
+ "kind": "Function",
1692
+ "canonicalReference": "@valiantys/atlassian-app-frontend!isAtlassianDocumentFormatParagraphNode:function(1)",
1693
+ "docComment": "",
1694
+ "excerptTokens": [
1695
+ {
1696
+ "kind": "Content",
1697
+ "text": "export declare function isAtlassianDocumentFormatParagraphNode(node: "
1698
+ },
1699
+ {
1700
+ "kind": "Reference",
1701
+ "text": "AtlassianDocumentFormatNode",
1702
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatNode:type"
1703
+ },
1704
+ {
1705
+ "kind": "Content",
1706
+ "text": "): "
1707
+ },
1708
+ {
1709
+ "kind": "Reference",
1710
+ "text": "node",
1711
+ "canonicalReference": "@valiantys/atlassian-app-frontend!~node"
1712
+ },
1713
+ {
1714
+ "kind": "Content",
1715
+ "text": " is "
1716
+ },
1717
+ {
1718
+ "kind": "Reference",
1719
+ "text": "AtlassianDocumentFormatParagraphNode",
1720
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatParagraphNode:interface"
1721
+ },
1722
+ {
1723
+ "kind": "Content",
1724
+ "text": ";"
1725
+ }
1726
+ ],
1727
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
1728
+ "returnTypeTokenRange": {
1729
+ "startIndex": 3,
1730
+ "endIndex": 6
1731
+ },
1732
+ "releaseTag": "Public",
1733
+ "overloadIndex": 1,
1734
+ "parameters": [
1735
+ {
1736
+ "parameterName": "node",
1737
+ "parameterTypeTokenRange": {
1738
+ "startIndex": 1,
1739
+ "endIndex": 2
1740
+ },
1741
+ "isOptional": false
1742
+ }
1743
+ ],
1744
+ "name": "isAtlassianDocumentFormatParagraphNode"
1745
+ },
1746
+ {
1747
+ "kind": "Function",
1748
+ "canonicalReference": "@valiantys/atlassian-app-frontend!isAtlassianDocumentFormatTextNode:function(1)",
1749
+ "docComment": "",
1750
+ "excerptTokens": [
1751
+ {
1752
+ "kind": "Content",
1753
+ "text": "export declare function isAtlassianDocumentFormatTextNode(node: "
1754
+ },
1755
+ {
1756
+ "kind": "Reference",
1757
+ "text": "AtlassianDocumentFormatNode",
1758
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatNode:type"
1759
+ },
1760
+ {
1761
+ "kind": "Content",
1762
+ "text": "): "
1763
+ },
1764
+ {
1765
+ "kind": "Reference",
1766
+ "text": "node",
1767
+ "canonicalReference": "@valiantys/atlassian-app-frontend!~node"
1768
+ },
1769
+ {
1770
+ "kind": "Content",
1771
+ "text": " is "
1772
+ },
1773
+ {
1774
+ "kind": "Reference",
1775
+ "text": "AtlassianDocumentFormatTextNode",
1776
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormatTextNode:interface"
1777
+ },
1778
+ {
1779
+ "kind": "Content",
1780
+ "text": ";"
1781
+ }
1782
+ ],
1783
+ "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
1784
+ "returnTypeTokenRange": {
1785
+ "startIndex": 3,
1786
+ "endIndex": 6
1787
+ },
1788
+ "releaseTag": "Public",
1789
+ "overloadIndex": 1,
1790
+ "parameters": [
1791
+ {
1792
+ "parameterName": "node",
1793
+ "parameterTypeTokenRange": {
1794
+ "startIndex": 1,
1795
+ "endIndex": 2
1796
+ },
1797
+ "isOptional": false
1798
+ }
1799
+ ],
1800
+ "name": "isAtlassianDocumentFormatTextNode"
1801
+ },
1277
1802
  {
1278
1803
  "kind": "Interface",
1279
1804
  "canonicalReference": "@valiantys/atlassian-app-frontend!Issue:interface",
@@ -1443,17 +1968,26 @@
1443
1968
  },
1444
1969
  {
1445
1970
  "kind": "Reference",
1446
- "text": "CommentAuthor",
1447
- "canonicalReference": "@valiantys/atlassian-app-frontend!CommentAuthor:type"
1971
+ "text": "User",
1972
+ "canonicalReference": "@valiantys/atlassian-app-frontend!User:interface"
1448
1973
  },
1449
1974
  {
1450
1975
  "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: "
1976
+ "text": ";\n body: "
1452
1977
  },
1453
1978
  {
1454
1979
  "kind": "Reference",
1455
- "text": "CommentAuthor",
1456
- "canonicalReference": "@valiantys/atlassian-app-frontend!CommentAuthor:type"
1980
+ "text": "AtlassianDocumentFormat",
1981
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat:interface"
1982
+ },
1983
+ {
1984
+ "kind": "Content",
1985
+ "text": ";\n created: string;\n id: string;\n self: string;\n updateAuthor: "
1986
+ },
1987
+ {
1988
+ "kind": "Reference",
1989
+ "text": "User",
1990
+ "canonicalReference": "@valiantys/atlassian-app-frontend!User:interface"
1457
1991
  },
1458
1992
  {
1459
1993
  "kind": "Content",
@@ -1478,7 +2012,7 @@
1478
2012
  "name": "IssueComment",
1479
2013
  "typeTokenRange": {
1480
2014
  "startIndex": 1,
1481
- "endIndex": 8
2015
+ "endIndex": 10
1482
2016
  }
1483
2017
  },
1484
2018
  {
@@ -3087,8 +3621,9 @@
3087
3621
  "text": "description?: "
3088
3622
  },
3089
3623
  {
3090
- "kind": "Content",
3091
- "text": "{\n type: 'doc';\n version: 1;\n content: {\n type: 'paragraph';\n content: {\n type: 'text';\n text: string;\n }[];\n }[];\n }"
3624
+ "kind": "Reference",
3625
+ "text": "AtlassianDocumentFormat",
3626
+ "canonicalReference": "@valiantys/atlassian-app-frontend!AtlassianDocumentFormat:interface"
3092
3627
  },
3093
3628
  {
3094
3629
  "kind": "Content",
package/util-jira-v3-api/atlassian-app-frontend.api.md CHANGED
@@ -4,6 +4,49 @@
4
4
 
5
5
  ```ts
6
6
 
7
+ // @public (undocumented)
8
+ export interface AtlassianDocumentFormat {
9
+ // (undocumented)
10
+ content: AtlassianDocumentFormatNode[];
11
+ // (undocumented)
12
+ type: 'doc';
13
+ // (undocumented)
14
+ version: number;
15
+ }
16
+
17
+ // @public (undocumented)
18
+ export interface AtlassianDocumentFormatBlockNode {
19
+ // (undocumented)
20
+ content: AtlassianDocumentFormatNode[];
21
+ // (undocumented)
22
+ type: string;
23
+ }
24
+
25
+ // @public (undocumented)
26
+ export interface AtlassianDocumentFormatInlineNode {
27
+ // (undocumented)
28
+ type: string;
29
+ }
30
+
31
+ // @public (undocumented)
32
+ export type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
33
+
34
+ // @public (undocumented)
35
+ export interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
36
+ // (undocumented)
37
+ content: AtlassianDocumentFormatInlineNode[];
38
+ // (undocumented)
39
+ type: 'paragraph';
40
+ }
41
+
42
+ // @public (undocumented)
43
+ export interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
44
+ // (undocumented)
45
+ text: string;
46
+ // (undocumented)
47
+ type: 'text';
48
+ }
49
+
7
50
  // @public (undocumented)
8
51
  export interface AvatarUrls {
9
52
  // (undocumented)
@@ -16,14 +59,6 @@ export interface AvatarUrls {
16
59
  '48x48': string;
17
60
  }
18
61
 
19
- // @public (undocumented)
20
- export type CommentAuthor = {
21
- accountId: string;
22
- active: boolean;
23
- displayName: string;
24
- self: string;
25
- };
26
-
27
62
  // @public (undocumented)
28
63
  export interface CreatedIssue {
29
64
  // (undocumented)
@@ -128,6 +163,12 @@ export interface HistoryMetadataParticipant {
128
163
  url: string;
129
164
  }
130
165
 
166
+ // @public (undocumented)
167
+ export function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
168
+
169
+ // @public (undocumented)
170
+ export function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
171
+
131
172
  // @public (undocumented)
132
173
  export interface Issue {
133
174
  // (undocumented)
@@ -144,16 +185,12 @@ export interface Issue {
144
185
 
145
186
  // @public (undocumented)
146
187
  export type IssueComment = {
147
- author: CommentAuthor;
148
- body: {
149
- type: string;
150
- version: number;
151
- content: unknown[];
152
- };
188
+ author: User;
189
+ body: AtlassianDocumentFormat;
153
190
  created: string;
154
191
  id: string;
155
192
  self: string;
156
- updateAuthor: CommentAuthor;
193
+ updateAuthor: User;
157
194
  updated: string;
158
195
  visibility: Visibility;
159
196
  };
@@ -342,17 +379,7 @@ export interface StaticIssueFields {
342
379
  // (undocumented)
343
380
  creator?: User;
344
381
  // (undocumented)
345
- description?: {
346
- type: 'doc';
347
- version: 1;
348
- content: {
349
- type: 'paragraph';
350
- content: {
351
- type: 'text';
352
- text: string;
353
- }[];
354
- }[];
355
- };
382
+ description?: AtlassianDocumentFormat;
356
383
  // (undocumented)
357
384
  fixVersions?: FixVersions;
358
385
  // (undocumented)
package/util-jira-v3-api/index.cjs.js CHANGED
@@ -1 +1 @@
1
- "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js");exports.FIX_VERSIONS_FIELD=e.FIX_VERSIONS_FIELD;
1
+ "use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const t=require("../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js");exports.FIX_VERSIONS_FIELD=t.FIX_VERSIONS_FIELD;exports.isAtlassianDocumentFormatParagraphNode=t.isAtlassianDocumentFormatParagraphNode;exports.isAtlassianDocumentFormatTextNode=t.isAtlassianDocumentFormatTextNode;
package/util-jira-v3-api/index.d.ts CHANGED
@@ -1,3 +1,30 @@
1
+ export declare interface AtlassianDocumentFormat {
2
+ type: 'doc';
3
+ version: number;
4
+ content: AtlassianDocumentFormatNode[];
5
+ }
6
+
7
+ export declare interface AtlassianDocumentFormatBlockNode {
8
+ type: string;
9
+ content: AtlassianDocumentFormatNode[];
10
+ }
11
+
12
+ export declare interface AtlassianDocumentFormatInlineNode {
13
+ type: string;
14
+ }
15
+
16
+ export declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
17
+
18
+ export declare interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
19
+ type: 'paragraph';
20
+ content: AtlassianDocumentFormatInlineNode[];
21
+ }
22
+
23
+ export declare interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
24
+ type: 'text';
25
+ text: string;
26
+ }
27
+
1
28
  export declare interface AvatarUrls {
2
29
  '48x48': string;
3
30
  '24x24': string;
@@ -5,13 +32,6 @@ export declare interface AvatarUrls {
5
32
  '32x32': string;
6
33
  }
7
34
 
8
- export declare type CommentAuthor = {
9
- accountId: string;
10
- active: boolean;
11
- displayName: string;
12
- self: string;
13
- };
14
-
15
35
  export declare interface CreatedIssue {
16
36
  id: string;
17
37
  key: string;
@@ -80,6 +100,10 @@ export declare interface HistoryMetadataParticipant {
80
100
  url: string;
81
101
  }
82
102
 
103
+ export declare function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
104
+
105
+ export declare function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
106
+
83
107
  export declare interface Issue {
84
108
  id: string;
85
109
  expand?: string;
@@ -89,16 +113,12 @@ export declare interface Issue {
89
113
  }
90
114
 
91
115
  export declare type IssueComment = {
92
- author: CommentAuthor;
93
- body: {
94
- type: string;
95
- version: number;
96
- content: unknown[];
97
- };
116
+ author: User;
117
+ body: AtlassianDocumentFormat;
98
118
  created: string;
99
119
  id: string;
100
120
  self: string;
101
- updateAuthor: CommentAuthor;
121
+ updateAuthor: User;
102
122
  updated: string;
103
123
  visibility: Visibility;
104
124
  };
@@ -261,17 +281,7 @@ export declare interface StaticIssueFields {
261
281
  };
262
282
  created?: string;
263
283
  updated?: string;
264
- description?: {
265
- type: 'doc';
266
- version: 1;
267
- content: {
268
- type: 'paragraph';
269
- content: {
270
- type: 'text';
271
- text: string;
272
- }[];
273
- }[];
274
- };
284
+ description?: AtlassianDocumentFormat;
275
285
  timetracking?: {
276
286
  remainingEstimate: string;
277
287
  timeSpent: string;
package/util-jira-v3-api/index.es.js CHANGED
@@ -1,4 +1,6 @@
1
- import { FIX_VERSIONS_FIELD as r } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js";
1
+ import { FIX_VERSIONS_FIELD as t, isAtlassianDocumentFormatParagraphNode as e, isAtlassianDocumentFormatTextNode as r } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js";
2
2
  export {
3
- r as FIX_VERSIONS_FIELD
3
+ t as FIX_VERSIONS_FIELD,
4
+ e as isAtlassianDocumentFormatParagraphNode,
5
+ r as isAtlassianDocumentFormatTextNode
4
6
  };