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

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

@@ -521,6 +521,14 @@
                   "kind": "Content",
                   "text": "string[]"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", rendered?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "boolean"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -550,8 +558,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 5,
-                "endIndex": 9
+                "startIndex": 7,
+                "endIndex": 11
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -572,6 +580,14 @@
                     "endIndex": 4
                   },
                   "isOptional": true
+                },
+                {
+                  "parameterName": "rendered",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
                 }
               ],
               "isOptional": false,
@@ -943,7 +959,16 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "[]>"
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianDocumentFormat",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianDocumentFormat:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">[]>"
                 },
                 {
                   "kind": "Content",
@@ -953,7 +978,7 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 7,
-                "endIndex": 11
+                "endIndex": 13
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -988,6 +1013,116 @@
               "isAbstract": false,
               "name": "issueSearch"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#issueSearchByPage:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "issueSearchByPage(jql: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", fields: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", nextPageToken?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", maxResults?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "number"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<{\n        issues: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Issue",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~Issue:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[];\n        nextPageToken?: string;\n    }>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 9,
+                "endIndex": 13
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "jql",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "fields",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "nextPageToken",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": true
+                },
+                {
+                  "parameterName": "maxResults",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 7,
+                    "endIndex": 8
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "issueSearchByPage"
+            },
             {
               "kind": "Property",
               "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService.issueUrl:member",
@@ -1029,11 +1164,11 @@
               "excerptTokens": [
                 {
                   "kind": "Content",
-                  "text": "queryForIssuesInProjects(projectIds: "
+                  "text": "queryForIssuesInProjects(projectIdsOrKeys: "
                 },
                 {
                   "kind": "Content",
-                  "text": "number[]"
+                  "text": "string[]"
                 },
                 {
                   "kind": "Content",
@@ -1055,7 +1190,16 @@
                 },
                 {
                   "kind": "Content",
-                  "text": "[]>"
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianDocumentFormat",
+                  "canonicalReference": "@valiantys/atlassian-app-frontend!~AtlassianDocumentFormat:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">[]>"
                 },
                 {
                   "kind": "Content",
@@ -1065,14 +1209,14 @@
               "isStatic": false,
               "returnTypeTokenRange": {
                 "startIndex": 3,
-                "endIndex": 7
+                "endIndex": 9
               },
               "releaseTag": "Public",
               "isProtected": false,
               "overloadIndex": 1,
               "parameters": [
                 {
-                  "parameterName": "projectIds",
+                  "parameterName": "projectIdsOrKeys",
                   "parameterTypeTokenRange": {
                     "startIndex": 1,
                     "endIndex": 2
@@ -1382,6 +1526,91 @@
               "isOptional": false,
               "isAbstract": false,
               "name": "updateIssue"
+            },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app-frontend!JiraIssueService#updateProperty:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "updateProperty(issueIdOrKey: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", propertyName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", value: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<void>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 7,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "issueIdOrKey",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "propertyName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "value",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 5,
+                    "endIndex": 6
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "updateProperty"
             }
           ],
           "implementsTokenRanges": []

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

@@ -8,8 +8,6 @@
 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
@@ -29,7 +27,7 @@ export class JiraIssueService {
     // Warning: (ae-forgotten-export) The symbol "Issue" needs to be exported by the entry point data-access-issue.d.ts
     //
     // (undocumented)
-    getIssue(issueIdOrKey: string, fields?: string[]): Promise<Issue | undefined>;
+    getIssue(issueIdOrKey: string, fields?: string[], rendered?: boolean): Promise<Issue | undefined>;
     // Warning: (ae-forgotten-export) The symbol "IssueComment" needs to be exported by the entry point data-access-issue.d.ts
     //
     // (undocumented)
@@ -44,12 +42,19 @@ export class JiraIssueService {
     //
     // (undocumented)
     getIssueFields(issueIdOrKey: string, fields: string[]): Promise<IssueFields | undefined>;
+    // Warning: (ae-forgotten-export) The symbol "AtlassianDocumentFormat" needs to be exported by the entry point data-access-issue.d.ts
+    //
+    // (undocumented)
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
     // (undocumented)
-    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue[]>;
+    issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
+        issues: Issue[];
+        nextPageToken?: string;
+    }>;
     // (undocumented)
     static readonly issueUrl = "/rest/api/3/issue";
     // (undocumented)
-    queryForIssuesInProjects(projectIds: number[]): Promise<Issue[]>;
+    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AtlassianDocumentFormat>[]>;
     // Warning: (ae-forgotten-export) The symbol "TransitionIssueRequest" needs to be exported by the entry point data-access-issue.d.ts
     //
     // (undocumented)
@@ -62,6 +67,8 @@ export class JiraIssueService {
     //
     // (undocumented)
     updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
+    // (undocumented)
+    updateProperty(issueIdOrKey: string, propertyName: string, value: any): Promise<void>;
 }
 
 // (No @packageDocumentation comment for this package)

package/data-access-issue/index.d.ts

@@ -49,7 +49,7 @@ declare interface CreatedIssue {
 }
 
 declare interface CreateIssue {
-    fields: IssueFields<string>;
+    fields: IssueFields<AtlassianDocumentFormat | string>;
     properties?: {
         key: string;
         value: unknown;
@@ -79,16 +79,18 @@ declare type FetchRoute = {
     readonly value: string;
 };
 
-declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
-declare type FixVersions = {
-    description: string;
+declare interface FixVersion {
+    description?: string;
     id: string;
     name: string;
     releaseDate?: string;
-    released: boolean;
-    self: string;
-}[];
+    released?: boolean;
+    self?: string;
+}
+
+declare type FixVersions = FixVersion[];
 
 declare interface HistoryMetadata {
     activityDescription?: string;
@@ -113,12 +115,13 @@ declare interface HistoryMetadataParticipant {
     url: string;
 }
 
-declare interface Issue {
+declare interface Issue<T = AtlassianDocumentFormat> {
     id: string;
     expand?: string;
     key: string;
     self?: string;
-    fields: IssueFields;
+    fields: IssueFields<T>;
+    renderedFields?: IssueFields<string>;
 }
 
 declare type IssueComment = {
@@ -186,17 +189,22 @@ declare type JiraCommentResponse = {
 };
 
 export declare class JiraIssueService {
-    private fetchSvc;
+    private readonly fetchSvc;
     static readonly issueUrl = "/rest/api/3/issue";
     constructor(fetchSvc: AtlassianProductFetchService<'jira'>);
+    updateProperty(issueIdOrKey: string, propertyName: string, value: any): Promise<void>;
     updateField(issueIdOrKey: string, fieldName: string, value: unknown): Promise<void>;
     updateFields(issueIdOrKey: string, fields: Record<string, unknown>): Promise<void>;
     getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
     getIssueFields(issueIdOrKey: string, fields: string[]): Promise<IssueFields | undefined>;
-    getIssue(issueIdOrKey: string, fields?: string[]): Promise<Issue | undefined>;
-    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue[]>;
+    getIssue(issueIdOrKey: string, fields?: string[], rendered?: boolean): Promise<Issue | undefined>;
+    issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
+    issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
+        issues: Issue[];
+        nextPageToken?: string;
+    }>;
     addWorklog(issueIdOrKey: string, worklog: WorklogCreateRequest): Promise<Worklog>;
-    queryForIssuesInProjects(projectIds: number[]): Promise<Issue[]>;
+    queryForIssuesInProjects(projectIdsOrKeys: string[]): Promise<Issue<AtlassianDocumentFormat>[]>;
     createIssue(body: CreateIssue): Promise<CreatedIssue>;
     updateIssue(issueIdOrKey: string, body: UpdateIssue): Promise<void>;
     getIssueComments(issueIdOrKey: string, startAt?: number): Promise<JiraCommentResponse>;
@@ -217,6 +225,7 @@ declare interface Project {
     simplified?: boolean;
     avatarUrls?: AvatarUrls;
     archived?: boolean;
+    lead?: User;
 }
 
 declare type RequestProductMethod = (url: FetchRoute, init: RequestInit) => Promise<APIResponse>;
@@ -231,7 +240,7 @@ declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
         maxResults: number;
         worklogs: Worklog[];
     };
-    issuetype: {
+    issuetype?: {
         self?: string;
         id: string;
         description?: string;
@@ -242,7 +251,7 @@ declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
         hierarchyLevel?: number;
     };
     timespent?: number;
-    project: Project;
+    project?: Project;
     aggregatetimespent?: number;
     resolutiondate?: string;
     lastViewed?: string;
@@ -269,12 +278,16 @@ declare interface StaticIssueFields<T = AtlassianDocumentFormat> {
         remainingEstimateSeconds: number;
         timeSpentSeconds: number;
     };
-    summary: string;
+    summary?: string;
     status?: IssueStatus;
     creator?: User;
     assignee?: User;
     reporter?: User;
     issuelinks?: IssueLink[];
+    components?: {
+        id: string;
+        name: string;
+    }[];
 }
 
 declare interface TransitionIssueRequest {
@@ -285,7 +298,7 @@ declare interface TransitionIssueRequest {
     update?: any;
 }
 
-declare type UpdateIssue = CreatedIssue;
+declare type UpdateIssue = CreateIssue;
 
 declare interface User {
     accountId: string;
@@ -296,6 +309,16 @@ declare interface User {
     avatarUrls?: AvatarUrls;
     accountType?: string;
     self?: string;
+    groups?: {
+        items?: UserGroupName[];
+        size?: number;
+    };
+}
+
+declare interface UserGroupName {
+    groupId: string;
+    name: string;
+    self: string;
 }
 
 declare type Visibility = {

package/data-access-jql/index.d.ts

@@ -21,7 +21,7 @@ declare type FetchRoute = {
     readonly value: string;
 };
 
-declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 export declare class JqlPrecomputationService {
     private fetchSvc;

package/data-access-workspaces/index.d.ts

@@ -33,7 +33,7 @@ declare type FetchRoute = {
     readonly value: string;
 };
 
-declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app-frontend",
-  "version": "3.0.0-alpha-10",
+  "version": "3.0.0-alpha-17",
   "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/util-fetch/src/lib/shared-util-fetch/index.cjs.js

@@ -1,2 +1,2 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class h extends Error{constructor(t,e,a=t){super(a),this.statusText=t,this.statusCode=e,this.statusCode=e,this.statusText=t}toJSON(){return{statusCode:this.statusCode,statusText:this.statusText}}}function c(s,t){const e={Authorization:s.startsWith("Bearer ")?s:`Bearer ${s}`};return t?{...t,...e}:e}async function l(s,t,e){const a=c(s,e.headers||{});return fetch(t,{...e,headers:a})}async function j(s,t,e,a,o="json",n={}){return d(t,e,c(s,n),a,o)}async function d(s,t,e,a,o="json"){const n={...e||{},Accept:o==="json"?"application/json":"text/html","Content-Type":o==="json"?"application/json":"text/html"},f=a?JSON.stringify(a):void 0,r=await fetch(s,{method:t,headers:n,body:f});if(r.ok)return t==="DELETE"||r.status===204?void 0:o==="text"?await r.text():await r.json();{let i="";try{i=await r.text()}catch{}const u=`${r.status} ${r.statusText} - ${t} ${s}
- ${i}`;throw console.error(u),new h(r.statusText,r.status,u)}}exports.FetchError=h;exports.addAuthHeader=c;exports.bearerAuthFetch=j;exports.bearerAuthFetchRaw=l;exports.jsonFetch=d;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});class h extends Error{constructor(t,e,a=t){super(a),this.statusText=t,this.statusCode=e,this.statusCode=e,this.statusText=t}toJSON(){return{statusCode:this.statusCode,statusText:this.statusText}}}function c(r,t){const e={Authorization:r.startsWith("Bearer ")?r:`Bearer ${r}`};return t?{...t,...e}:e}async function j(r,t,e){const a=c(r,e.headers||{});return fetch(t,{...e,headers:a})}async function x(r,t,e,a,n="json",o={}){return d(t,e,c(r,o),a,n)}async function d(r,t,e,a,n="json",o){const f={...e??{},Accept:n==="json"?"application/json":"text/html","Content-Type":n==="json"?"application/json":"text/html"},l=a?JSON.stringify(a):void 0,s=await fetch(r,{method:t,headers:f,body:l,credentials:o});if(s.ok)return t==="DELETE"||s.status===204?void 0:n==="text"?await s.text():await s.json();{let u="";try{u=await s.text()}catch{}const i=`${s.status} ${s.statusText} - ${t} ${r}
+ ${u}`;throw console.error(i),new h(s.statusText,s.status,i)}}exports.FetchError=h;exports.addAuthHeader=c;exports.bearerAuthFetch=x;exports.bearerAuthFetchRaw=j;exports.jsonFetch=d;

package/shared/util-fetch/src/lib/shared-util-fetch/index.es.js

@@ -1,6 +1,6 @@
 class f extends Error {
-  constructor(t, s, o = t) {
-    super(o), this.statusText = t, this.statusCode = s, this.statusCode = s, this.statusText = t;
+  constructor(t, e, a = t) {
+    super(a), this.statusText = t, this.statusCode = e, this.statusCode = e, this.statusText = t;
   }
   toJSON() {
     return {
@@ -9,37 +9,38 @@ class f extends Error {
     };
   }
 }
-function u(e, t) {
-  const s = {
-    Authorization: e.startsWith("Bearer ") ? e : `Bearer ${e}`
+function u(s, t) {
+  const e = {
+    Authorization: s.startsWith("Bearer ") ? s : `Bearer ${s}`
   };
-  return t ? { ...t, ...s } : s;
+  return t ? { ...t, ...e } : e;
 }
-async function l(e, t, s) {
-  const o = u(
-    e,
-    s.headers || {}
+async function l(s, t, e) {
+  const a = u(
+    s,
+    e.headers || {}
   );
-  return fetch(t, { ...s, headers: o });
+  return fetch(t, { ...e, headers: a });
 }
-async function j(e, t, s, o, n = "json", a = {}) {
-  return d(
+async function j(s, t, e, a, n = "json", o = {}) {
+  return x(
     t,
-    s,
-    u(e, a),
-    o,
+    e,
+    u(s, o),
+    a,
     n
   );
 }
-async function d(e, t, s, o, n = "json") {
-  const a = {
-    ...s || {},
+async function x(s, t, e, a, n = "json", o) {
+  const h = {
+    ...e ?? {},
     Accept: n === "json" ? "application/json" : "text/html",
     "Content-Type": n === "json" ? "application/json" : "text/html"
-  }, h = o ? JSON.stringify(o) : void 0, r = await fetch(e, {
+  }, d = a ? JSON.stringify(a) : void 0, r = await fetch(s, {
     method: t,
-    headers: a,
-    body: h
+    headers: h,
+    body: d,
+    credentials: o
   });
   if (r.ok)
     return t === "DELETE" || r.status === 204 ? void 0 : n === "text" ? await r.text() : await r.json();
@@ -49,7 +50,7 @@ async function d(e, t, s, o, n = "json") {
       c = await r.text();
     } catch {
     }
-    const i = `${r.status} ${r.statusText} - ${t} ${e}
+    const i = `${r.status} ${r.statusText} - ${t} ${s}
  ${c}`;
     throw console.error(i), new f(r.statusText, r.status, i);
   }
@@ -59,5 +60,5 @@ export {
   u as addAuthHeader,
   j as bearerAuthFetch,
   l as bearerAuthFetchRaw,
-  d as jsonFetch
+  x as jsonFetch
 };

package/ui-atlassian-product-fetch/index.d.ts

@@ -24,7 +24,7 @@ declare type FetchRoute = {
     readonly value: string;
 };
 
-declare type FetchSignature = <T>(request: FetchRequest, body?: Record<string, any>) => Promise<T>;
+declare type FetchSignature = <T>(request: FetchRequest, body?: any) => Promise<T>;
 
 declare type Product = 'jira' | 'bitbucket' | 'confluence' | 'connected-data';