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

About

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

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

Table of contents

• Installation
• Telemetry information collection agreement
  • Customizing telemetry collection data example
  • Disabling telemetry collection example
• Usage
  • Authentication
    • Basic
    • OAuth
    • OAuth 2.0
    • JWT
  • Your first request and using algorithm
• 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 jira.js

Install with the yarn:

yarn add jira.js

Telemetry information collection agreement

The use of this library may collect, record and transmit data about the operation of the library and related data, as well as potentially personal data, including ip address from which the request is made, user agent from the device from which the request is made, version of the library used, version of the telemetry sending library, name of the invoked method, authorization type information (can be configured), base configuration request usage information, callback information, onResponse middleware usage information, onError middleware usage information, queries usage information, body usage information in request, headers usage information in request, strict GDPR flag enabling information, HTTP response code (can be configured), request start date and time and response receipt date and time (can be configured), No check atlassian token flag enabling information.

The type and amount of data may vary with the version of the libraries and can be changed at any time without notice.

Telemetry data collection is enabled by default.

The following tracking parameters can be configured:

• Authentication type
• Request status code
• Request timings

Customizing telemetry collection data example

import { Config } from 'jira.js';

const config: Config = {
  host: 'https://your-domain.atlassian.net',
  telemetry: {
    allowedToPassAuthenticationType: false,  // true by default
    allowedToPassRequestStatusCode: true,  // true by default
    allowedToPassRequestTimings: false,  // true by default
  },
};

If you want to disable telemetry, set the telemetry field to false.

Disabling telemetry collection example

import { Config } from 'jira.js';

const config: Config = {
  host: 'https://your-domain.atlassian.net',
  telemetry: false, // Telemetry will not be collected
};

Usage

Authentication

There are several types of authentication to gain access to the Jira 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 { Version2Client } from 'jira.js';

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

Email and API Token example:

import { Version2Client } from 'jira.js';

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

OAuth

import { Version2Client } from 'jira.js';

const client = new Version2Client({
  host: 'https://your-domain.atlassian.net',
  authentication: {
    oauth: {
      consumerKey: 'your consumer key',
      consumerSecret: '-----BEGIN RSA PRIVATE KEY-----\n" + "some private key\n" + "-----END RSA PRIVATE KEY-----',
      accessToken: 'your access token',
      tokenSecret: 'your token secret',
    },
  },
});

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 { Version2Client } from 'jira.js';

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

JWT

import { Version2Client } from 'jira.js';

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

Your first request and using algorithm

import { Version2Client } from 'jira.js';

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

async function main() {
  const projects = await client.projects.getAllProjects();

  console.log(projects);
}

main();

// Expected output:
// [
//   {
//     expand: 'description,lead,issueTypes,url,projectKeys,permissions,insight',
//     self: 'https://your-domain.atlassian.net/rest/api/2/project/10000',
//     id: '10000',
//     key: 'TEST',
//     name: 'test',
//     avatarUrls: {
//       '48x48': 'https://your-domain.atlassian.net/secure/projectavatar?pid=10000&avatarId=10425',
//       '24x24': 'https://your-domain.atlassian.net/secure/projectavatar?size=small&s=small&pid=10000&avatarId=10425',
//       '16x16': 'https://your-domain.atlassian.net/secure/projectavatar?size=xsmall&s=xsmall&pid=10000&avatarId=10425',
//       '32x32': 'https://your-domain.atlassian.net/secure/projectavatar?size=medium&s=medium&pid=10000&avatarId=10425'
//     },
//     projectTypeKey: 'software',
//     simplified: true,
//     style: 'next-gen',
//     isPrivate: false,
//     properties: {},
//     entityId: 'e0a412bd-1510-4841-bdbc-84180db3ee3b',
//     uuid: 'e0a412bd-1510-4841-bdbc-84180db3ee3b'
//   }
// ]

The algorithm for using the library:

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

Available groups:

• Agile group:
  • backlog
  • board
  • epic
  • issue
  • sprint
  • developmentInformation
  • featureFlags
  • deployments
  • builds
  • remoteLinks
  • otherOperations
• Version 2 group:
  • applicationRoles
  • auditRecords
  • avatars
  • dashboards
  • filters
  • filterSharing
  • groupAndUserPicker
  • groups
  • instanceInformation
  • issues
  • issueAttachments
  • issueComments
  • issueCustomFieldConfigurationApps
  • issueCommentProperties
  • issueFields
  • issueFieldConfigurations
  • issueCustomFieldContexts
  • issueCustomFieldOptions
  • issueCustomFieldOptionsApps
  • issueCustomFieldValuesApps
  • issueLinks
  • issueLinkTypes
  • issueNavigatorSettings
  • issueNotificationSchemes
  • issuePriorities
  • issueProperties
  • issueRemoteLinks
  • issueResolutions
  • issueSearch
  • issueSecurityLevel
  • issueSecuritySchemes
  • issueTypes
  • issueTypeSchemes
  • issueTypeScreenSchemes
  • issueTypeProperties
  • issueVotes
  • issueWatchers
  • issueWorklogs
  • issueWorklogProperties
  • jiraExpressions
  • jiraSettings
  • jql
  • labels
  • myself
  • permissions
  • permissionSchemes
  • projects
  • projectAvatars
  • projectCategories
  • projectComponents
  • projectEmail
  • projectFeatures
  • projectKeyAndNameValidation
  • projectPermissionSchemes
  • projectProperties
  • projectRoles
  • projectRoleActors
  • projectTypes
  • projectVersions
  • screens
  • screenTabs
  • screenTabFields
  • screenSchemes
  • serverInfo
  • tasks
  • timeTracking
  • users
  • userProperties
  • userSearch
  • webhooks
  • workflows
  • workflowTransitionRules
  • workflowSchemes
  • workflowSchemeProjectAssociations
  • workflowSchemeDrafts
  • workflowStatuses
  • workflowStatusCategories
  • workflowTransitionProperties
  • appProperties
  • dynamicModules
• Version 3 group:
  • applicationRoles
  • auditRecords
  • avatars
  • dashboards
  • filters
  • filterSharing
  • groupAndUserPicker
  • groups
  • instanceInformation
  • issues
  • issueAttachments
  • issueComments
  • issueCustomFieldConfigurationApps
  • issueCommentProperties
  • issueFields
  • issueFieldConfigurations
  • issueCustomFieldContexts
  • issueCustomFieldOptions
  • issueCustomFieldOptionsApps
  • issueCustomFieldValuesApps
  • issueLinks
  • issueLinkTypes
  • issueNavigatorSettings
  • issueNotificationSchemes
  • issuePriorities
  • issueProperties
  • issueRemoteLinks
  • issueResolutions
  • issueSearch
  • issueSecurityLevel
  • issueSecuritySchemes
  • issueTypes
  • issueTypeSchemes
  • issueTypeScreenSchemes
  • issueTypeProperties
  • issueVotes
  • issueWatchers
  • issueWorklogs
  • issueWorklogProperties
  • jiraExpressions
  • jiraSettings
  • jql
  • labels
  • myself
  • permissions
  • permissionSchemes
  • projects
  • projectAvatars
  • projectCategories
  • projectComponents
  • projectEmail
  • projectFeatures
  • projectKeyAndNameValidation
  • projectPermissionSchemes
  • projectProperties
  • projectRoles
  • projectRoleActors
  • projectTypes
  • projectVersions
  • screens
  • screenTabs
  • screenTabFields
  • screenSchemes
  • serverInfo
  • tasks
  • timeTracking
  • users
  • userProperties
  • userSearch
  • webhooks
  • workflows
  • workflowTransitionRules
  • workflowSchemes
  • workflowSchemeProjectAssociations
  • workflowSchemeDrafts
  • workflowStatuses
  • workflowStatusCategories
  • workflowTransitionProperties
  • appProperties
  • dynamicModules

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.

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 'jira.js';
import { Board } from 'jira.js/out/agile';
import { Groups } from 'jira.js/out/version2';
import { Issues } from 'jira.js/out/version3';

export class CustomJiraClient extends BaseClient {
  board = new Board(this);
  groups = new Groups(this);
  issues = new Issues(this);
}

Take a look at our other products

• Confluence.js - confluence.js is a powerful Node.JS / Browser module that allows you to interact with the Confluence API very easily
• 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.