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

package/atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.cjs.js

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

package/atlassian/jira/shared/data-access-issue/src/lib/jira-issue-service/index.es.js

@@ -73,9 +73,30 @@ const i = class i {
       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
+    );
+  }
 };
 i.issueUrl = "/rest/api/3/issue";
-let r = i;
+let o = i;
 export {
-  r as JiraIssueService
+  o as JiraIssueService
 };

package/atlassian/jira/shared/util-jira-v3-api/src/lib/issue/index.cjs.js

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e="fixVersions";exports.FIX_VERSIONS_FIELD=e;
+"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

@@ -1,4 +1,12 @@
-const o = "fixVersions";
+const a = "fixVersions";
+function e(t) {
+  return t.type === "paragraph";
+}
+function n(t) {
+  return t.type === "text";
+}
 export {
-  o as FIX_VERSIONS_FIELD
+  a as FIX_VERSIONS_FIELD,
+  e as isAtlassianDocumentFormatParagraphNode,
+  n as isAtlassianDocumentFormatTextNode
 };

package/data-access-issue/atlassian-app-frontend-data-access-issue.api.json

@@ -225,6 +225,85 @@
                 }
               ]
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#addIssueComment:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "addIssueComment(issueIdOrKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", body: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianDocumentFormat",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianDocumentFormat:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IssueComment",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~IssueComment:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "issueIdOrKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "body",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "addIssueComment"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#addWorklog:member(1)",
@@ -445,6 +524,162 @@
               "isAbstract": false,
               "name": "getIssue"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#getIssueCommentById:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getIssueCommentById(issueIdOrKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", commentId: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IssueComment",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~IssueComment:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | undefined>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "issueIdOrKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "commentId",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getIssueCommentById"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#getIssueComments:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getIssueComments(issueIdOrKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", startAt?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IssueComment",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~IssueComment:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[] | undefined>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "issueIdOrKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "startAt",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getIssueComments"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#getIssueField:member(1)",

package/data-access-issue/atlassian-app-frontend.api.md

@@ -8,6 +8,10 @@
 export class JiraIssueService {
     // Warning: (ae-forgotten-export) The symbol "AtlassianProductFetchService" needs to be exported by the entry point data-access-issue.d.ts
     constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    // Warning: (ae-forgotten-export) The symbol "AtlassianDocumentFormat" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
     // Warning: (ae-forgotten-export) The symbol "WorklogCreateRequest" needs to be exported by the entry point data-access-issue.d.ts
     // Warning: (ae-forgotten-export) The symbol "Worklog" needs to be exported by the entry point data-access-issue.d.ts
     //
@@ -23,6 +27,12 @@ export class JiraIssueService {
     // (undocumented)
     getIssue(issueIdOrKey: string, fields?: string[]): Promise<Issue | undefined>;
     // (undocumented)
+    getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
+    // Warning: (ae-forgotten-export) The symbol "IssueComment" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    getIssueComments(issueIdOrKey: string, startAt?: number): Promise<IssueComment[] | undefined>;
+    // (undocumented)
     getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
     // 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

@@ -1,5 +1,22 @@
 declare type APIResponse = Pick<Response, 'json' | 'text' | 'ok' | 'status' | 'statusText' | 'headers'>;
 
+declare interface AtlassianDocumentFormat {
+    type: 'doc';
+    version: number;
+    content: AtlassianDocumentFormatNode[];
+}
+
+declare interface AtlassianDocumentFormatBlockNode {
+    type: string;
+    content: AtlassianDocumentFormatNode[];
+}
+
+declare interface AtlassianDocumentFormatInlineNode {
+    type: string;
+}
+
+declare type AtlassianDocumentFormatNode = AtlassianDocumentFormatInlineNode | AtlassianDocumentFormatBlockNode;
+
 declare interface AtlassianProductFetchService<P extends Product> {
     productType: P;
     fetch: FetchSignature;
@@ -104,6 +121,17 @@ declare interface Issue {
     fields: IssueFields;
 }
 
+declare type IssueComment = {
+    author: User;
+    body: AtlassianDocumentFormat;
+    created: string;
+    id: string;
+    self: string;
+    updateAuthor: User;
+    updated: string;
+    visibility: Visibility;
+};
+
 declare type IssueFields = CustomFields & StaticIssueFields;
 
 declare interface IssueLink {
@@ -146,6 +174,9 @@ export declare class JiraIssueService {
     queryForIssuesInProjects(projectIds: number[]): Promise<Issue[]>;
     createIssue(body: CreateIssue): Promise<CreatedIssue>;
     updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
+    getIssueComments(issueIdOrKey: string, startAt?: number): Promise<IssueComment[] | undefined>;
+    getIssueCommentById(issueIdOrKey: string, commentId: string): Promise<IssueComment | undefined>;
+    addIssueComment(issueIdOrKey: string, body: AtlassianDocumentFormat): Promise<IssueComment>;
 }
 
 declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
@@ -204,17 +235,7 @@ 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;
@@ -242,6 +263,12 @@ declare interface User {
     self?: string;
 }
 
+declare type Visibility = {
+    identifier: string;
+    type: string;
+    value: string;
+};
+
 declare interface Worklog extends WorklogCreateRequest {
     self: string;
     id: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app-frontend",
-  "version": "3.0.0-alpha-3",
+  "version": "3.0.0-alpha-5",
   "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",
   "exports": {
     "./atlassian-app": {

package/shared/frontend-ui-load-data-hook/src/lib/load-data-hook/index.cjs.js

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

package/shared/frontend-ui-load-data-hook/src/lib/load-data-hook/index.es.js

@@ -1,29 +1,30 @@
-import { useState as o, useCallback as i, useEffect as d } from "react";
+import { useState as n, useCallback as d, useEffect as f } from "react";
 function g(r) {
   return console.error(r), `Error Occurred: ${r.message || r}`;
 }
-function m(r, c = g) {
-  const [u, n] = o(), [l, a] = o(!0), [f, s] = o(), e = i(async () => {
-    a(!0);
+function m(r, s = g) {
+  const [u, a] = n(), [i, o] = n(!0), [l, e] = n(), c = d(async () => {
+    o(!0);
     try {
+      e(void 0);
       const t = await r();
-      return n(t), t;
+      return a(t), t;
     } catch (t) {
-      s(c(t));
+      e(s(t)), a(void 0);
     } finally {
-      a(!1);
+      o(!1);
     }
-  }, [r, c]);
-  return d(() => {
-    e();
-  }, [e]), {
+  }, [r, s]);
+  return f(() => {
+    c();
+  }, [c]), {
     data: u,
-    loading: l,
-    error: f,
-    setData: n,
-    setLoading: a,
-    setError: s,
-    manualTrigger: () => e()
+    loading: i,
+    error: l,
+    setData: a,
+    setLoading: o,
+    setError: e,
+    manualTrigger: () => c()
   };
 }
 export {