Forge Atlas Fetch - Documentation

Integrate with any Atlassian Product API using simple and typed javascript / typescript commands.


Getting started

The client lets you interact with the following Atlassian products:

- Confluence
- Jira

And interact either:

- as the logged-in User
- as the App itself

$3

Install via:

- npm

``shell
npm install --save forge-atlas-fetch
`

- yarn

`shell
yarn add forge-atlas-fetch
`

$3

- install webpack

`shell
yarn add --dev ts-loader webpack webpack-cli
`

- add the following webpack.config.js at the root of your Forge app:

`js
const path = require('path');

module.exports = {
entry: './src/index.tsx',
target: 'node',
module: {
rules: [
{
test: /\.tsx?$/,
use: 'ts-loader',
exclude: /node_modules/
}
]
},
resolve: {
extensions: [ '.tsx', '.ts', '.js' ]
},
output: {
filename: 'index.js',
library: '',
libraryTarget: 'commonjs',
path: path.resolve(__dirname, 'dist')
}
};
`

- change your package.json build step to:

`text
"build": "webpack",
`

Usage in your Forge app

$3

Sample query

`js
import { confluence } from 'forge-atlas-fetch';
import { Content } from 'fetch-confluence';

const fetchContent = async (contentId): Promise => {
return await confluence(api).asApp().content().getContentById({ id: contentId }).results;
};
`

Full documentation available here

$3

Sample query

`js
import { jira } from 'forge-atlas-fetch';
import { IssueBean } from 'fetch-jira';

const fetchIssue = async (issueKey): Promise => {
return await jira().asApp().issues().getIssue({ issueIdOrKey: issueKey });
};
``

Full documentation available here