@resolution/jira-api-client 0.4.5 → 0.5.0

package/CHANGELOG.md

@@ -3,6 +3,28 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [0.5.0](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.6...v0.5.0) (2024-06-20)
+
+
+### Features
+
+* first version of Jira Service Management API ([67634ea](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/67634ea9bfe37adf30a7d2b124b59f52c4f1ccda))
+
+
+
+
+
+## [0.4.6](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.5...v0.4.6) (2024-06-14)
+
+
+### Bug Fixes
+
+* use more optimized / lightweight api client version ([8c628d3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/8c628d3c80ca6c89572eb003ae6f7cb5c634b4d5))
+
+
+
+
+
 ## [0.4.5](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.4...v0.4.5) (2024-06-14)
 
 

package/README.md

@@ -2,6 +2,8 @@
 
 Atlassian Jira API client based on OpenAPI schema.
 
+Provides Clients for Jira Platform, Jira Software, and Jira Service Management APIs.
+
 Compatible with the following request/fetch Atlassian libraries:
 
  * [atlassian-connect-express](https://bitbucket.org/atlassian/atlassian-connect-express)
@@ -11,16 +13,18 @@ Compatible with the following request/fetch Atlassian libraries:
 
 ## Installation
 
+Note that this package requires `zod` as a peer dependency.
+
 Install using npm
 
 ```bash
-npm add @resolution/jira-api-client
+npm add @resolution/jira-api-client zod
 ```
 
 Or using yarn
 
 ```bash
-yarn add @resolution/jira-api-client
+yarn add @resolution/jira-api-client zod
 ```
 
 ## Usage
@@ -40,6 +44,10 @@ async function test() {
   const jiraSoftwareApi = new JiraSoftware({ AP: window.AP });
   const boards = await jiraSoftwareApi.boards.getAllBoards();
   console.log('Boards:', boards);
+
+  const jiraServiceManagementApi = new JiraServiceManagementApi({ AP: window.AP });
+  const systemInfo = await jiraServiceManagementApi.info.getInfo();
+  console.log('JSM Info:', systemInfo);
 }
 
 test().catch(console.error);
@@ -66,6 +74,11 @@ app.get('/boards', async () => {
   res.status(200).send(await jiraSoftwareApi.boards.getAllBoards());
 });
 
+app.get('/system-info', async () => {
+  const jiraServiceManagementApi = new JiraServiceManagementApi({ ace, clientKey: req.context.clientKey });
+  res.status(200).send(await jiraServiceManagementApi.info.getInfo());
+});
+
 app.listen(3000);
 ```
 
@@ -85,6 +98,10 @@ async function test() {
   const jiraSoftwareApi = new JiraSoftware({ requestJira });
   const boards = await jiraSoftwareApi.boards.getAllBoards();
   console.log('Boards:', boards);
+  
+  const jiraServiceManagementApi = new JiraServiceManagementApi({ requestJira });
+  const systemInfo = await jiraServiceManagementApi.info.getInfo();
+  console.log('JSM Info:', systemInfo);
 }
 
 test().catch(console.error);
@@ -103,7 +120,10 @@ export const handler = async ({ payload }) => {
   const jiraSoftwareApi = new JiraSoftware({ forgeApi });
   const boards = await jiraSoftwareApi.boards.getAllBoards();
 
-  return { issue, boards };
+  const jiraServiceManagementApi = new JiraServiceManagementApi({ forgeApi });
+  const systemInfo = await jiraServiceManagementApi.info.getInfo();
+
+  return { issue, boards, systemInfo };
 };
 ```
 
@@ -122,10 +142,73 @@ export const handler = async ({ payload }) => {
   const jiraSoftwareApi = new JiraSoftware({ fetch, baseUrl });
   const boards = await jiraSoftwareApi.boards.getAllBoards();
 
-  return { issue, boards };
+  const jiraServiceManagementApi = new JiraServiceManagementApi({ fetch, baseUrl });
+  const systemInfo = await jiraServiceManagementApi.info.getInfo();
+
+  return { issue, boards, systemInfo };
+};
+```
+
+### Impersonalization
+
+When using API on the server side, you can impersonalize the API client.
+This is useful when you need to access API resources on behalf of a different user or app.
+
+### `atlassian-connect-express`
+
+By default, `atlassian-connect-express` makes requests on behalf of the app.
+To impersonalize the API client, you need to provide the `userAccountId` to the API client:
+
+```typescript
+// ...
+app.get('/sprint-issues/:sprintId', async () => {
+  const jiraSoftwareApi = new JiraSoftwareApi({
+    ace,
+    clientKey: req.context.clientKey,
+    userAccountId: req.context.userAccountId
+  });
+  res.status(200).send(await jiraSoftwareApi.sprint.getIssuesForSprint({
+    sprintId: 1
+  }));
+});
+// ...
+```
+
+This can also be achieved by calling `asUser` method on the API client:
+
+```typescript
+const jiraSoftwareApi = new JiraSoftwareApi({
+  ace,
+  clientKey: req.context.clientKey
+});
+const issues = await jiraSoftwareApi.sprint.getIssuesForSprint({
+  sprintId: 1
+});
+```
+
+### `@forge/api`
+
+By default, `@forge/api` makes requests on behalf of the current user.
+To perform requests on behalf of the app, you need to provide the `asApp` to the API client:
+
+```typescript
+// ...
+export const handler = async ({ payload }) => {
+  const jiraSoftwareApi = new JiraSoftwareApi({
+    forgeApi,
+    asApp: true
+  });
+  return await jiraSoftwareApi.sprint.getIssuesForSprint({ sprintId: 1 });
 };
 ```
 
+This can also be achieved by calling `asApp` method on the API client:
+
+```typescript
+const jiraSoftwareApi = new JiraSoftwareApi({ forgeApi });
+const issues = await jiraSoftwareApi.sprint.getIssuesForSprint({ sprintId: 1 });
+```
+
 ## References
 
  * [Jira Platform API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)

package/lib/index.d.ts

@@ -1,5 +1,6 @@
 import { type ApiClientAceOptions, type ApiClientApOptions, type ApiClientForgeApiExternalOptions, type ApiClientForgeApiOptions, ApiError, type JiraApiClientForgeBridgeOptions } from "@resolution/atlassian-api-common";
 import { BaseJiraPlatformApiClient } from "./openapi/platform/BaseJiraPlatformApiClient";
+import { BaseJiraServiceManagementApiClient } from "./openapi/serviceManagement/BaseJiraServiceManagementApiClient";
 import { BaseJiraSoftwareApiClient } from "./openapi/software/BaseJiraSoftwareApiClient";
 export * from "./openapi/platform/BaseJiraPlatformApiClient";
 export * from "./openapi/software/BaseJiraSoftwareApiClient";
@@ -34,3 +35,15 @@ export declare class JiraSoftwareApi extends BaseJiraSoftwareApiClient {
      */
     asUser: (userAccountId: string) => JiraSoftwareApi;
 }
+export declare class JiraServiceManagementApi extends BaseJiraServiceManagementApiClient {
+    protected options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions;
+    constructor(options: ApiClientForgeApiOptions | ApiClientForgeApiExternalOptions | JiraApiClientForgeBridgeOptions | ApiClientAceOptions | ApiClientApOptions);
+    /**
+     * Switches the API client to the app context.
+     */
+    asApp: () => JiraServiceManagementApi;
+    /**
+     * Switches the API client to the user context.
+     */
+    asUser: (userAccountId: string) => JiraServiceManagementApi;
+}

package/lib/index.js

@@ -14,10 +14,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.JiraSoftwareApi = exports.JiraPlatformApi = exports.ApiError = void 0;
+exports.JiraServiceManagementApi = exports.JiraSoftwareApi = exports.JiraPlatformApi = exports.ApiError = void 0;
 const atlassian_api_common_1 = require("@resolution/atlassian-api-common");
 Object.defineProperty(exports, "ApiError", { enumerable: true, get: function () { return atlassian_api_common_1.ApiError; } });
 const BaseJiraPlatformApiClient_1 = require("./openapi/platform/BaseJiraPlatformApiClient");
+const BaseJiraServiceManagementApiClient_1 = require("./openapi/serviceManagement/BaseJiraServiceManagementApiClient");
 const BaseJiraSoftwareApiClient_1 = require("./openapi/software/BaseJiraSoftwareApiClient");
 __exportStar(require("./openapi/platform/BaseJiraPlatformApiClient"), exports);
 __exportStar(require("./openapi/software/BaseJiraSoftwareApiClient"), exports);
@@ -61,4 +62,19 @@ class JiraSoftwareApi extends BaseJiraSoftwareApiClient_1.BaseJiraSoftwareApiCli
     }
 }
 exports.JiraSoftwareApi = JiraSoftwareApi;
+class JiraServiceManagementApi extends BaseJiraServiceManagementApiClient_1.BaseJiraServiceManagementApiClient {
+    constructor(options) {
+        super((0, atlassian_api_common_1.getApiClientOptions)(options));
+        this.options = options;
+        /**
+         * Switches the API client to the app context.
+         */
+        this.asApp = (0, atlassian_api_common_1.createAsAppMethod)();
+        /**
+         * Switches the API client to the user context.
+         */
+        this.asUser = (0, atlassian_api_common_1.createAsUserMethod)();
+    }
+}
+exports.JiraServiceManagementApi = JiraServiceManagementApi;
 //# sourceMappingURL=index.js.map

package/lib/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAU0C;AAQjC,yFAbP,+BAAQ,OAaO;AANjB,4FAAyF;AACzF,4FAAyF;AAEzF,+EAA6D;AAC7D,+EAA6D;AAI7D,wFAAwH;AACxH,wFAAwH;AAExH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAKxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IATtD,CAAC;CAUF;AApBD,0CAoBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IARtD,CAAC;CASF;AAnBD,0CAmBC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;;AAAA,2EAU0C;AASjC,yFAdP,+BAAQ,OAcO;AAPjB,4FAAyF;AACzF,uHAAoH;AACpH,4FAAyF;AAEzF,+EAA6D;AAC7D,+EAA6D;AAI7D,wFAAwH;AACxH,wFAAwH;AAExH,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AACxD,iDAA+B,CAAC,aAAa,CAAC,+BAAQ,CAAC,CAAC;AAExD;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAKxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IATtD,CAAC;CAUF;AApBD,0CAoBC;AAED;;GAEG;AACH,MAAa,eAAgB,SAAQ,qDAAyB;IAC5D,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAA0B,CAAC;QACpD;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAA0B,CAAC;IARtD,CAAC;CASF;AAnBD,0CAmBC;AAED,MAAa,wBAAyB,SAAQ,uEAAkC;IAC9E,YACY,OAKY;QAEtB,KAAK,CAAC,IAAA,0CAAmB,EAAC,OAAO,CAAC,CAAC,CAAC;QAP1B,YAAO,GAAP,OAAO,CAKK;QAIxB;;WAEG;QACH,UAAK,GAAG,IAAA,wCAAiB,GAAmC,CAAC;QAC7D;;WAEG;QACH,WAAM,GAAG,IAAA,yCAAkB,GAAmC,CAAC;IAR/D,CAAC;CASF;AAnBD,4DAmBC"}