forge-atlas-fetch

Forge Atlas Fetch - Documentation

Getting started

The client lets you interact with the main Atlassian products:

• Confluence
• Jira

And interact either:

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

Installation

Install via:

• npm

npm install --save 'forge-atlas-fetch'

• yarn

yarn add 'forge-atlas-fetch'

Update your existing Forge app config

• install webpack

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

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

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:

"build": "webpack",

Usage in your Forge app

Forge Confluence client

Sample query

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

const fetchContent = async (contentId): Promise<Content> => {
    const response = await confluence(api).asApp().content().getContentById({ id: 'sample' });
    return response.results;
};

Full documentation available here

Forge Jira client

Sample query

import { jiraSoftware } from 'forge-atlas-fetch';

const fetchContent = async (contentId): Promise<any> => {
    const response = await jiraSoftware().asUser().epic().getEpic({ epicIdOrKey: 'XEN-123' });
    return response.results;
};

Full documentation available here