JavaScript / TypeScript library for Node.JS and browsers to easily interact with Atlassian Confluence API

About

confluence.js is a powerful Node.JS / Browser module that allows you to interact with the Confluence API very easily.

Usability, consistency, and performance are key focuses of confluence.js, and it also has nearly 100% coverage of the Confluence API. It receives new Confluence features shortly after they arrive in the API.

Table of contents

• Installation
• Usage
  • Authentication
    • Basic
    • OAuth 2.0
    • JWT
    • Personal access token
  • Your first request and using algorithm
  • apiPrefix config parameter
• Decreasing Webpack bundle size
• Take a look at our other products
• License

Installation

Node.js 10.0.0 or newer is required.

Install with the npm:

npm install confluence.js

Install with the yarn:

yarn add confluence.js

Usage

Authentication

There are several types of authentication to gain access to the Confluence API. Let's take a look at a few of them below

Basic authentication

Basic authentication allows you to log in with credentials. You can use username and password, but this login method is not supported in the online version, and most standalone versions, so it's better to release API Token, read how to do it here, and use it together with email.

Username and password example:

import { ConfluenceClient } from 'confluence.js';

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    basic: {
      username: 'YOUR_USERNAME',
      password: 'YOUR_PASSWORD',
    },
  },
});

Email and API Token example:

import { ConfluenceClient } from 'confluence.js';

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    basic: {
      email: 'YOUR@EMAIL.ORG',
      apiToken: 'YOUR_API_TOKEN',
    },
  },
});

OAuth 2.0

Only the authorization token is currently supported. To release it, you need to read the documentation and write your own code to get the token.

Example of usage

import { ConfluenceClient } from 'confluence.js';

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    oauth2: {
      accessToken: 'YOUR_ACCESS_TOKEN',
    },
  },
});

JWT

import { ConfluenceClient } from 'confluence.js';

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    jwt: {
      issuer: 'ISSUER',
      secret: 'shhhh',
      expiryTimeSeconds: 180,
    },
  },
});

Personal access token

import { ConfluenceClient } from 'confluence.js';

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    personalAccessToken: 'secrectPAT',
  },
});

Your first request and using algorithm

import { ConfluenceClient } from 'confluence.js'; // Or import ServerClient if using standalone (Server) API

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    basic: {
      email: 'YOUR_EMAIL',
      apiToken: 'YOUR_API_TOKEN',
    },
  },
});

async function main() {
  const space = await client.space.createSpace({
    name: 'My new space',
    key: 'SPACENAME',
  });

  console.log(space);
}

main();

// Expected output:
// {
//   id: 558714,
//   key: 'SPACENAME',
//   name: 'My new space',
//   description: {
//     plain: {
//       value: '',
//       representation: 'plain',
//       embeddedContent: []
//     },
//     _expandable: {view: ''}
//   },
//   homepage: {
//     id: '555312',
//     type: 'page',
//     status: 'current',
//     title: 'My new space Home',
//     macroRenderedOutput: {},
//     extensions: {position: 581},
//     _expandable: {
//       container: '/rest/api/space/SPACENAME',
//       metadata: '',
//       restrictions: '/rest/api/content/555312/restriction/byOperation',
//       history: '/rest/api/content/555312/history',
//       body: '',
//       version: '',
//       descendants: '/rest/api/content/555312/descendant',
//       space: '/rest/api/space/SPACENAME',
//       childTypes: '',
//       operations: '',
//       schedulePublishDate: '',
//       children: '/rest/api/content/555312/child',
//       ancestors: ''
//     },
//     _links: {
//       self: 'https://xxx.atlassian.net/wiki/rest/api/content/555312',
//       tinyui: '/x/qIoI',
//       editui: '/pages/resumedraft.action?draftId=555312',
//       webui: '/spaces/SPACENAME/overview'
//     }
//   },
//   type: 'global',
//   permissions: [...],
//   status: 'current',
//   _expandable: {
//     settings: '/rest/api/space/SPACENAME/settings',
//     metadata: '',
//     operations: '',
//     lookAndFeel: '/rest/api/settings/lookandfeel?spaceKey=SPACENAME',
//     identifiers: '',
//     icon: '',
//     theme: '/rest/api/space/SPACENAME/theme',
//     history: ''
//   },
//   _links: {
//     context: '/wiki',
//     self: 'https://xxx.atlassian.net/wiki/rest/api/space/SPACENAME',
//     collection: '/rest/api/space',
//     webui: '/spaces/SPACENAME',
//     base: 'https://xxx.atlassian.net/wiki'
//   }
// }

The algorithm for using the library:

client.<group>.<methodName>(parametersObject);

Available groups:

• analytics
• audit
• content
• contentAttachments
• contentBody
• contentChildrenAndDescendants
• contentComments
• contentLabels
• contentMacroBody
• contentPermissions
• contentProperties
• contentRestrictions
• contentStates
• contentVersions
• contentWatches
• dynamicModules
• experimental
• group
• inlineTasks
• labelInfo
• longRunningTask
• relation
• search
• settings
• space
• spacePermissions
• spaceProperties
• spaceSettings
• template
• themes
• users

The name of the methods is the name of the endpoint in the group without spaces and in camelCase.

The parameters depend on the specific endpoint. For more information, see here.

apiPrefix config parameter

The apiPrefix parameter is used to specify the prefix for the API. For example, if you use the custom domain https://mydomain.atlassian.net/api for API.

Example of use:

import { ConfluenceClient } from 'confluence.js';

const client = new ConfluenceClient({
  host: 'https://your-domain.atlassian.net',
  apiPrefix: '/api',
});

Decreasing Webpack bundle size

If you use Webpack and need to reduce the size of the assembly, you can create your client with only the groups you use.

import { BaseClient } from 'confluence.js';
import { Api } from 'confluence.js';

export class CustomConfluenceClient extends BaseClient {
  content = new Api.Content(this);
  space = new Api.Space(this);
}

Take a look at our other products

• Jira.js - A JavaScript / TypeScript wrapper for the JIRA REST API
• Trello.js - JavaScript / TypeScript library for Node.JS and browsers to easily interact with Atlassian Trello API

License

Distributed under the MIT License. See LICENSE for more information.