@valiantys/atlassian-app 3.2.0-alpha-6 → 3.2.0-alpha-8

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 a=class a{constructor(e){this.fetchSvc=e}async updateProperty(e,t,s){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/issue/${e}/properties/${t}`},s)}async updateField(e,t,s){await this.updateFields(e,{[t]:s})}async updateFields(e,t){await this.updateIssue(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"],s=!1){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}&expand=${s?"renderedFields":""}`})}async issueSearch(e,t,s=50){let c;const r=[];do{const h=await this.issueSearchByPage(e,t,c,s);r.push(...h.issues),c=h.nextPageToken}while(c!==void 0);return r}async issueSearchByPage(e,t,s,c=50){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/search/jql`},{fields:t,jql:e,maxResults:c,nextPageToken:s})}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","project"],5e3)}async createIssue(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue`},e)}async updateIssue(e,t){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/issue/${e}`},t)}async getIssueComments(e,t=0){const s=t?`?startAt=${t}`:"";return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment${s}`})}async getIssueCommentById(e,t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${t}`})}async addIssueComment(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment`},{body:t})}async transitionIssue(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/transitions`},t)}async createIssueLink(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issueLink`},e)}async getIssueTypes(){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetype`})}async getIssueTypeSchemes({maxResults:e,orderBy:t,startAt:s,expand:c,id:r,queryString:h}={}){const i=new URLSearchParams;return c&&i.append("expand",c),e&&i.append("maxResults",e.toString()),t&&i.append("orderBy",t),s&&i.append("startAt",s.toString()),r&&r.forEach(n=>i.append("id",n)),h&&i.append("queryString",h),this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetypescheme?${i}`})}async getIssueTypeSchemesForProject({maxResults:e,startAt:t,projectId:s}={}){const c=new URLSearchParams;return e&&c.append("maxResults",e.toString()),t&&c.append("startAt",t.toString()),s&&s.forEach(r=>c.append("projectId",r)),this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetypescheme/project?${c}`})}};a.issueUrl="/rest/api/3/issue";let u=a;exports.JiraIssueService=u;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const a=class a{constructor(e){this.fetchSvc=e}async updateProperty(e,t,s){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/issue/${e}/properties/${t}`},s)}async updateField(e,t,s){await this.updateFields(e,{[t]:s})}async updateFields(e,t){await this.updateIssue(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"],s=!1){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}&expand=${s?"renderedFields":""}`})}async getBulkIssues(e,t=["*all"]){return(await this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/bulkfetch`},{issueIdsOrKeys:e,fields:t})).issues}async issueSearch(e,t,s=50){let c;const r=[];do{const h=await this.issueSearchByPage(e,t,c,s);r.push(...h.issues),c=h.nextPageToken}while(c!==void 0);return r}async issueSearchByPage(e,t,s,c=50){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/search/jql`},{fields:t,jql:e,maxResults:c,nextPageToken:s})}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","project"],5e3)}async createIssue(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue`},e)}async updateIssue(e,t){return this.fetchSvc.fetch({method:"PUT",url:this.fetchSvc.route`/rest/api/3/issue/${e}`},t)}async getIssueComments(e,t=0){const s=t?`?startAt=${t}`:"";return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment${s}`})}async getIssueCommentById(e,t){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment/${t}`})}async addIssueComment(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/comment`},{body:t})}async transitionIssue(e,t){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issue/${e}/transitions`},t)}async createIssueLink(e){return this.fetchSvc.fetch({method:"POST",url:this.fetchSvc.route`/rest/api/3/issueLink`},e)}async getIssueTypes(){return this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetype`})}async getIssueTypeSchemes({maxResults:e,orderBy:t,startAt:s,expand:c,id:r,queryString:h}={}){const i=new URLSearchParams;return c&&i.append("expand",c),e&&i.append("maxResults",e.toString()),t&&i.append("orderBy",t),s&&i.append("startAt",s.toString()),r&&r.forEach(n=>i.append("id",n)),h&&i.append("queryString",h),this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetypescheme?${i}`})}async getIssueTypeSchemesForProject({maxResults:e,startAt:t,projectId:s}={}){const c=new URLSearchParams;return e&&c.append("maxResults",e.toString()),t&&c.append("startAt",t.toString()),s&&s.forEach(r=>c.append("projectId",r)),this.fetchSvc.fetch({method:"GET",url:this.fetchSvc.route`/rest/api/3/issuetypescheme/project?${c}`})}};a.issueUrl="/rest/api/3/issue";let u=a;exports.JiraIssueService=u;

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

@@ -33,6 +33,15 @@ const u = class u {
       url: this.fetchSvc.route`/rest/api/3/issue/${e}?fields=${t.join(",")}&expand=${s ? "renderedFields" : ""}`
     });
   }
+  async getBulkIssues(e, t = ["*all"]) {
+    return (await this.fetchSvc.fetch(
+      {
+        method: "POST",
+        url: this.fetchSvc.route`/rest/api/3/issue/bulkfetch`
+      },
+      { issueIdsOrKeys: e, fields: t }
+    )).issues;
+  }
   async issueSearch(e, t, s = 50) {
     let c;
     const r = [];

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

@@ -500,6 +500,84 @@
               "isAbstract": false,
               "name": "createIssueLink"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@valiantys/atlassian-app!JiraIssueService#getBulkIssues:member(1)",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "getBulkIssues(issueIdsOrKeys: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", fields?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Promise",
+                  "canonicalReference": "!Promise:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Issue",
+                  "canonicalReference": "@valiantys/atlassian-app!~Issue:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": "[]>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 5,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "issueIdsOrKeys",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "fields",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 4
+                  },
+                  "isOptional": true
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "getBulkIssues"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@valiantys/atlassian-app!JiraIssueService#getIssue:member(1)",
@@ -1664,7 +1742,7 @@
                 {
                   "kind": "Reference",
                   "text": "UpdateIssue",
-                  "canonicalReference": "@valiantys/atlassian-app!~UpdateIssue:type"
+                  "canonicalReference": "@valiantys/atlassian-app!~UpdateIssue:interface"
                 },
                 {
                   "kind": "Content",

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

@@ -24,6 +24,8 @@ export class JiraIssueService {
     //
     // (undocumented)
     createIssueLink(issueLinkRequest: IssueLinkRequest): Promise<void>;
+    // (undocumented)
+    getBulkIssues(issueIdsOrKeys: string[], fields?: string[]): Promise<Issue[]>;
     // Warning: (ae-forgotten-export) The symbol "Issue" needs to be exported by the entry point data-access-issue.d.ts
     //
     // (undocumented)

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

@@ -236,6 +236,7 @@ export declare class JiraIssueService {
     getIssueField<T>(issueIdOrKey: string, field: string): Promise<T | undefined>;
     getIssueFields(issueIdOrKey: string, fields: string[]): Promise<IssueFields | undefined>;
     getIssue(issueIdOrKey: string, fields?: string[], rendered?: boolean): Promise<Issue | undefined>;
+    getBulkIssues(issueIdsOrKeys: string[], fields?: string[]): Promise<Issue[]>;
     issueSearch(jql: string, fields: string[], maxResults?: number): Promise<Issue<AtlassianDocumentFormat>[]>;
     issueSearchByPage(jql: string, fields: string[], nextPageToken?: string, maxResults?: number): Promise<{
         issues: Issue[];
@@ -397,7 +398,16 @@ declare interface TransitionIssueRequest {
     update?: any;
 }
 
-declare type UpdateIssue = CreateIssue;
+declare interface UpdateIssue {
+    fields?: IssueFields<AtlassianDocumentFormat | string>;
+    properties?: {
+        key: string;
+        value: unknown;
+    }[];
+    transition?: IssueTransition;
+    update?: Record<string, Record<string, unknown>[]>;
+    historyMetadata?: HistoryMetadata;
+}
 
 declare interface User {
     accountId: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@valiantys/atlassian-app",
-  "version": "3.2.0-alpha-6",
+  "version": "3.2.0-alpha-8",
   "description": "This library provides Atlassian Forge components, wrappers, and utilities to support writing Forge apps that can run deployed or in standalone mode",
   "exports": {
     "./frontend-app": {

package/util-jira-v3-api/atlassian-app-util-jira-v3-api.api.json

@@ -2308,6 +2308,32 @@
           ],
           "extendsTokenRanges": []
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@valiantys/atlassian-app!IssueAssetFieldValue:type",
+          "docComment": "",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type IssueAssetFieldValue = "
+            },
+            {
+              "kind": "Content",
+              "text": "{\n    workspaceId: string;\n    id: string;\n    objectId: string;\n}[]"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
+          "releaseTag": "Public",
+          "name": "IssueAssetFieldValue",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@valiantys/atlassian-app!IssueComment:type",
@@ -6265,31 +6291,187 @@
           "extendsTokenRanges": []
         },
         {
-          "kind": "TypeAlias",
-          "canonicalReference": "@valiantys/atlassian-app!UpdateIssue:type",
+          "kind": "Interface",
+          "canonicalReference": "@valiantys/atlassian-app!UpdateIssue:interface",
           "docComment": "",
           "excerptTokens": [
             {
               "kind": "Content",
-              "text": "export type UpdateIssue = "
+              "text": "export interface UpdateIssue "
+            }
+          ],
+          "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
+          "releaseTag": "Public",
+          "name": "UpdateIssue",
+          "preserveMemberOrder": false,
+          "members": [
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!UpdateIssue#fields:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "fields?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IssueFields",
+                  "canonicalReference": "@valiantys/atlassian-app!IssueFields:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "AtlassianDocumentFormat",
+                  "canonicalReference": "@valiantys/atlassian-app!AtlassianDocumentFormat:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": " | string>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "fields",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
             },
             {
-              "kind": "Reference",
-              "text": "CreateIssue",
-              "canonicalReference": "@valiantys/atlassian-app!CreateIssue:interface"
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!UpdateIssue#historyMetadata:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "historyMetadata?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "HistoryMetadata",
+                  "canonicalReference": "@valiantys/atlassian-app!HistoryMetadata:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "historyMetadata",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
             },
             {
-              "kind": "Content",
-              "text": ";"
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!UpdateIssue#properties:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "properties?: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "{\n        key: string;\n        value: unknown;\n    }[]"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "properties",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!UpdateIssue#transition:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "transition?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "IssueTransition",
+                  "canonicalReference": "@valiantys/atlassian-app!IssueTransition:interface"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "transition",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 2
+              }
+            },
+            {
+              "kind": "PropertySignature",
+              "canonicalReference": "@valiantys/atlassian-app!UpdateIssue#update:member",
+              "docComment": "",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "update?: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Record",
+                  "canonicalReference": "!Record:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<string, unknown>[]>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isReadonly": false,
+              "isOptional": true,
+              "releaseTag": "Public",
+              "name": "update",
+              "propertyTypeTokenRange": {
+                "startIndex": 1,
+                "endIndex": 5
+              }
             }
           ],
-          "fileUrlPath": "../../jira/shared/util-jira-v3-api/src/lib/issue.d.ts",
-          "releaseTag": "Public",
-          "name": "UpdateIssue",
-          "typeTokenRange": {
-            "startIndex": 1,
-            "endIndex": 2
-          }
+          "extendsTokenRanges": []
         },
         {
           "kind": "Interface",

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

@@ -204,6 +204,13 @@ export interface Issue<T = AtlassianDocumentFormat> {
     self?: string;
 }
 
+// @public (undocumented)
+export type IssueAssetFieldValue = {
+    workspaceId: string;
+    id: string;
+    objectId: string;
+}[];
+
 // @public (undocumented)
 export type IssueComment = {
     author: User;
@@ -648,7 +655,21 @@ export interface TransitionIssueRequest {
 }
 
 // @public (undocumented)
-export type UpdateIssue = CreateIssue;
+export interface UpdateIssue {
+    // (undocumented)
+    fields?: IssueFields<AtlassianDocumentFormat | string>;
+    // (undocumented)
+    historyMetadata?: HistoryMetadata;
+    // (undocumented)
+    properties?: {
+        key: string;
+        value: unknown;
+    }[];
+    // (undocumented)
+    transition?: IssueTransition;
+    // (undocumented)
+    update?: Record<string, Record<string, unknown>[]>;
+}
 
 // @public (undocumented)
 export interface User {

package/util-jira-v3-api/index.d.ts

@@ -121,6 +121,12 @@ export declare interface Issue<T = AtlassianDocumentFormat> {
     renderedFields?: IssueFields<string>;
 }
 
+export declare type IssueAssetFieldValue = {
+    workspaceId: string;
+    id: string;
+    objectId: string;
+}[];
+
 export declare type IssueComment = {
     author: User;
     body: AtlassianDocumentFormat;
@@ -423,7 +429,16 @@ export declare interface TransitionIssueRequest {
     update?: any;
 }
 
-export declare type UpdateIssue = CreateIssue;
+export declare interface UpdateIssue {
+    fields?: IssueFields<AtlassianDocumentFormat | string>;
+    properties?: {
+        key: string;
+        value: unknown;
+    }[];
+    transition?: IssueTransition;
+    update?: Record<string, Record<string, unknown>[]>;
+    historyMetadata?: HistoryMetadata;
+}
 
 export declare interface User {
     accountId: string;