@resolution/jira-api-client 0.3.0 → 0.4.2

package/CHANGELOG.md

@@ -3,6 +3,51 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [0.4.2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.1...v0.4.2) (2024-06-11)
+
+
+### Bug Fixes
+
+* add links to JIRA/Confluence documentation ([64c19b2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/64c19b2b0d1685c0d64639c6a44314a253ad5529))
+* operations with all arguments optional can be called without arguments ([2daea7f](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/2daea7f656dde7e36a75777f0bbb63b494971284))
+
+
+
+
+
+## [0.4.1](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/v0.4.0...v0.4.1) (2024-06-10)
+
+
+### Bug Fixes
+
+* remove previous file versions when building ([3ff3a0a](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/3ff3a0a8dde8376aa551fd66d0b4ed1ac040ac79))
+
+
+
+
+
+# 0.4.0 (2024-06-10)
+
+
+### Bug Fixes
+
+* automatic publishing ([65c6149](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/65c61497b5e52294203d893229fc6ddbef9f8bb0))
+* correct entry point ([9c6289f](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/9c6289ff7f1cd429383ad92d0c67fe89c2531344))
+* exclude codegen from build ([ad5a787](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/ad5a787f59002450cf411cdf928453c548a0370f))
+* make ChangeDetails fields to and toString nullable ([097e8b0](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/097e8b0189a2bc23601dc193998d22bf5628eea9))
+* remove unnecessary files from the package ([78f2d55](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/78f2d55adfcd5a2db5f5e14faa1598ce5e80cadf))
+
+
+### Features
+
+* first confluence API version ([d580ceb](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/d580cebbab7334f2290c08a307bea5eed8a372a5))
+* first version with JiraSoftwareApi ([e941fd3](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/e941fd304be3eb7fa59232cb13722c81b0a9c202))
+* initial version ([5c1e2d2](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/commits/5c1e2d295fb3efe134ae9629fd6b5f00dc83d151))
+
+
+
+
+
 # [0.3.0](https://bitbucket.org/resolutiongmbh/atlassian-api-clients/compare/@resolution/jira-api-client@0.2.0...@resolution/jira-api-client@0.3.0) (2024-06-07)
 
 

package/README.md

@@ -9,4 +9,126 @@ Compatible with the following request/fetch Atlassian libraries:
  * [@forge/api](https://developer.atlassian.com/cloud/jira/platform/forge/)
  * [@forge/bridge](https://developer.atlassian.com/cloud/jira/platform/forge/)
 
-More details will follow.
+## Installation
+
+Install using npm
+
+```bash
+npm add @resolution/jira-api-client
+```
+
+Or using yarn
+
+```bash
+yarn add @resolution/jira-api-client
+```
+
+## Usage
+
+### Connect
+
+Inside Connect iframe:
+
+```typescript
+import { JiraPlatformApi, JiraSoftwareApi } from '@resolution/jira-api-client';
+
+async function test() {
+  const jiraPlatformApi = new JiraPlatform({ AP: window.AP });
+  const issue = await api.issues.getIssue({ issueIdOrKey: "PROJ-1" });
+  console.log('Issue:', issue);
+
+  const jiraSoftwareApi = new JiraSoftware({ AP: window.AP });
+  const boards = await jiraSoftwareApi.boards.getAllBoards();
+  console.log('Boards:', boards);
+}
+
+test().catch(console.error);
+```
+
+On the server side using `atlassian-connect-express`:
+
+```typescript
+import atlassianConnectExpress from 'atlassian-connect-express';
+import { JiraPlatformApi, JiraSoftwareApi } from '@resolution/jira-api-client';
+
+const app = express();
+const ace = atlassianConnectExpress(app);
+
+app.use(ace.authenticate());
+
+app.get('/issue/:issueKey', async () => {
+  const jiraPlatformApi = new JiraPlatform({ ace, clientKey: req.context.clientKey });
+  res.status(200).send(await jiraPlatformApi.issues.getIssue({ issueIdOrKey: req.params.issueKey }));
+});
+
+app.get('/boards', async () => {
+  const jiraSoftwareApi = new JiraSoftware({ ace, clientKey: req.context.clientKey });
+  res.status(200).send(await jiraSoftwareApi.boards.getAllBoards());
+});
+
+app.listen(3000);
+```
+
+### Forge
+
+Inside Forge iframe:
+
+```typescript
+import { JiraPlatformApi, JiraSoftwareApi } from '@resolution/jira-api-client';
+import { requestJira } from '@forge/bridge';
+
+async function test() {
+  const jiraPlatformApi = new JiraPlatform({ requestJira });
+  const issue = await api.issues.getIssue({ issueIdOrKey: "PROJ-1" });
+  console.log('Issue:', issue);
+
+  const jiraSoftwareApi = new JiraSoftware({ requestJira });
+  const boards = await jiraSoftwareApi.boards.getAllBoards();
+  console.log('Boards:', boards);
+}
+
+test().catch(console.error);
+```
+
+On the server side using `@forge/api`:
+
+```typescript
+import { JiraPlatformApi, JiraSoftwareApi } from '@resolution/jira-api-client';
+import * as forgeApi from '@forge/api';
+
+export const handler = async ({ payload }) => {
+  const jiraPlatformApi = new JiraPlatform({ forgeApi });
+  const issue = await api.issues.getIssue({ issueIdOrKey: payload.issueKey });
+
+  const jiraSoftwareApi = new JiraSoftware({ forgeApi });
+  const boards = await jiraSoftwareApi.boards.getAllBoards();
+
+  return { issue, boards };
+};
+```
+
+External fetch on the server side:
+
+```typescript
+import { JiraPlatformApi, JiraSoftwareApi } from '@resolution/jira-api-client';
+import { fetch } from "@forge/api";
+
+const baseUrl = "https://your-jira-instance.atlassian.net";
+
+export const handler = async ({ payload }) => {
+  const jiraPlatformApi = new JiraPlatform({ fetch, baseUrl });
+  const issue = await api.issues.getIssue({ issueIdOrKey: payload.issueKey });
+
+  const jiraSoftwareApi = new JiraSoftware({ fetch, baseUrl });
+  const boards = await jiraSoftwareApi.boards.getAllBoards();
+
+  return { issue, boards };
+};
+```
+
+## References
+
+ * [Jira Platform API](https://developer.atlassian.com/cloud/jira/platform/rest/v3/intro/)
+ * [Jira Software API](https://developer.atlassian.com/cloud/jira/software/rest/intro/)
+ * [Atlassian Connect for JIRA](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-connect/)
+ * [Atlassian Forge for JIRA](https://developer.atlassian.com/cloud/jira/platform/getting-started-with-forge//)