@valiantys/atlassian-app-frontend 3.0.0-alpha-3 → 3.0.0-alpha-5

package/util-jira-v3-api/atlassian-app-frontend.api.md

@@ -4,6 +4,49 @@
 
 ```ts
 
+// @public (undocumented)
+export interface AtlassianDocumentFormat {
+    // (undocumented)
+    content: AtlassianDocumentFormatNode[];
+    // (undocumented)
+    type: 'doc';
+    // (undocumented)
+    version: number;
+}
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatBlockNode {
+    // (undocumented)
+    content: AtlassianDocumentFormatNode[];
+    // (undocumented)
+    type: string;
+}
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatInlineNode {
+    // (undocumented)
+    type: string;
+}
+
+// @public (undocumented)
+export type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
+    // (undocumented)
+    content: AtlassianDocumentFormatInlineNode[];
+    // (undocumented)
+    type: 'paragraph';
+}
+
+// @public (undocumented)
+export interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
+    // (undocumented)
+    text: string;
+    // (undocumented)
+    type: 'text';
+}
+
 // @public (undocumented)
 export interface AvatarUrls {
     // (undocumented)
@@ -120,6 +163,12 @@ export interface HistoryMetadataParticipant {
     url: string;
 }
 
+// @public (undocumented)
+export function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
+
+// @public (undocumented)
+export function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
+
 // @public (undocumented)
 export interface Issue {
     // (undocumented)
@@ -134,6 +183,18 @@ export interface Issue {
     self?: string;
 }
 
+// @public (undocumented)
+export type IssueComment = {
+    author: User;
+    body: AtlassianDocumentFormat;
+    created: string;
+    id: string;
+    self: string;
+    updateAuthor: User;
+    updated: string;
+    visibility: Visibility;
+};
+
 // @public (undocumented)
 export type IssueFields = CustomFields & StaticIssueFields;
 
@@ -197,6 +258,14 @@ export interface IssueTypeDetails {
     subtask: boolean;
 }
 
+// @public (undocumented)
+export type JiraCommentResponse = {
+    comments: IssueComment[];
+    maxResults: number;
+    startAt: number;
+    total: number;
+};
+
 // @public (undocumented)
 export type Precomputation = {
     id: string;
@@ -310,17 +379,7 @@ export interface StaticIssueFields {
     // (undocumented)
     creator?: User;
     // (undocumented)
-    description?: {
-        type: 'doc';
-        version: 1;
-        content: {
-            type: 'paragraph';
-            content: {
-                type: 'text';
-                text: string;
-            }[];
-        }[];
-    };
+    description?: AtlassianDocumentFormat;
     // (undocumented)
     fixVersions?: FixVersions;
     // (undocumented)
@@ -436,6 +495,13 @@ export interface UserPickerUser {
     html?: string;
 }
 
+// @public (undocumented)
+export type Visibility = {
+    identifier: string;
+    type: string;
+    value: string;
+};
+
 // @public (undocumented)
 export interface Worklog extends WorklogCreateRequest {
     // (undocumented)

package/util-jira-v3-api/index.cjs.js

@@ -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;
+"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

@@ -1,3 +1,30 @@
+export declare interface AtlassianDocumentFormat {
+    type: 'doc';
+    version: number;
+    content: AtlassianDocumentFormatNode[];
+}
+
+export declare interface AtlassianDocumentFormatBlockNode {
+    type: string;
+    content: AtlassianDocumentFormatNode[];
+}
+
+export declare interface AtlassianDocumentFormatInlineNode {
+    type: string;
+}
+
+export declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+
+export declare interface AtlassianDocumentFormatParagraphNode extends AtlassianDocumentFormatBlockNode {
+    type: 'paragraph';
+    content: AtlassianDocumentFormatInlineNode[];
+}
+
+export declare interface AtlassianDocumentFormatTextNode extends AtlassianDocumentFormatInlineNode {
+    type: 'text';
+    text: string;
+}
+
 export declare interface AvatarUrls {
     '48x48': string;
     '24x24': string;
@@ -73,6 +100,10 @@ export declare interface HistoryMetadataParticipant {
     url: string;
 }
 
+export declare function isAtlassianDocumentFormatParagraphNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatParagraphNode;
+
+export declare function isAtlassianDocumentFormatTextNode(node: AtlassianDocumentFormatNode): node is AtlassianDocumentFormatTextNode;
+
 export declare interface Issue {
     id: string;
     expand?: string;
@@ -81,6 +112,17 @@ export declare interface Issue {
     fields: IssueFields;
 }
 
+export declare type IssueComment = {
+    author: User;
+    body: AtlassianDocumentFormat;
+    created: string;
+    id: string;
+    self: string;
+    updateAuthor: User;
+    updated: string;
+    visibility: Visibility;
+};
+
 export declare type IssueFields = CustomFields & StaticIssueFields;
 
 export declare interface IssueLink {
@@ -120,6 +162,13 @@ export declare interface IssueTypeDetails {
     subtask: boolean;
 }
 
+export declare type JiraCommentResponse = {
+    comments: IssueComment[];
+    maxResults: number;
+    startAt: number;
+    total: number;
+};
+
 export declare type Precomputation = {
     id: string;
     value: string;
@@ -232,17 +281,7 @@ export declare interface StaticIssueFields {
     };
     created?: string;
     updated?: string;
-    description?: {
-        type: 'doc';
-        version: 1;
-        content: {
-            type: 'paragraph';
-            content: {
-                type: 'text';
-                text: string;
-            }[];
-        }[];
-    };
+    description?: AtlassianDocumentFormat;
     timetracking?: {
         remainingEstimate: string;
         timeSpent: string;
@@ -283,6 +322,12 @@ export declare interface UserPickerUser {
     html?: string;
 }
 
+export declare type Visibility = {
+    identifier: string;
+    type: string;
+    value: string;
+};
+
 export declare interface Worklog extends WorklogCreateRequest {
     self: string;
     id: string;

package/util-jira-v3-api/index.es.js

@@ -1,4 +1,6 @@
-import { FIX_VERSIONS_FIELD as r } from "../atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.es.js";
+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";
 export {
-  r as FIX_VERSIONS_FIELD
+  t as FIX_VERSIONS_FIELD,
+  e as isAtlassianDocumentFormatParagraphNode,
+  r as isAtlassianDocumentFormatTextNode
 };