magr0s/jira.js

A JavaScript/TypeScript wrapper for the JIRA REST API

JavaScript / TypeScript JIRA API Client

A JavaScript / TypeScript wrapper for the JIRA REST API

Installation

Install with the npm:

npm install jira.js

Install with the yarn:

yarn add jira.js

Examples

Create the JIRA client

import { Client } from "jira.js";

// Initialize
const client = new Client({
  host: "https://jira.somehost.com"
});

Working with API (How to get a list of all projects, for example)

// Callbacks
client.projects.getAllProjects({}, (err, data) => {
  if (err) {
    throw err;
  }

  console.log(data);
});


// ES5/ES6
client.projects
  .getAllProjects()
  .then(projects => console.log(projects))
  .catch(error => console.log(error));

// ES7
async function getProjects() {
  const projects = await client.projects.getAllProjects();

  console.log(projects);

  return projects;
}

Authorization

Basic authorization

With API token

const client = new Client({
  host: "https://jira.somehost.com",
  authentication: {
    basic: {
      username: "MyUsername",
      apiToken: "API_Token"
    }
  }
});

With password

const client = new Client({
  host: "https://jira.somehost.com",
  authentication: {
    basic: {
      username: "MyUsername",
      password: "MyPassword"
    }
  }
});

JWT authentication

const client = new Client({
  host: 'https://jira.somehost.com',
  authentication: {
    jwt: {
      iss: 'id',
      secret: 'secret key'
    }
  }
});

OAuth1.0 authentication

const client = new Client({
  host: "https://jira.somehost.com",
  authentication: {
    oauth1: {
      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"
    }
  }
});

OAuth2.0 authentication

const client = new Client({
  host: "https://jira.somehost.com",
  authentication: {
    accessToken: "my access token"
  }
});

Base request config

If you want to add headers, timeout, withCredentials or other data for each of the requests that will be called, then pass them to baseRequestConfig.

Full list of properties for baseRequestConfig you can find here: https://github.com/axios/axios#request-config

import { Client } from "jira.js";

const client = new Client({
  host: 'https://jira.somehost.com',
  baseRequestConfig: {
    timeout: 20000,
    headers: {
      'Content-Type': 'application/json',
    },
    timeoutErrorMessage: 'Error message',
    withCredentials: false,
    responseType: 'arraybuffer',
    maxContentLength: 100,
    // and others properties
  },
});

Set middleware for Jira's responses and errors

import { Client } from "jira.js";

const client = new Client({
  host: "https://jira.somehost.com",
  middlewares: {
    onError: (error) => {
      console.error(error);
      throw error;
    },
    onResponse: (data) => {
      console.log(data);
      return data;
    }
  }
});

Documentation

Library based on Jira API v2 and Jira Agile API

Can't find what you need in the readme? Check out our documentation here: https://mrrefactoring.github.io/jira.js/

Contributors

MrRefactoring	jayree	Swapnull	violine1101

Road map

• Response models (Check 2.0 version PR)
• Method names reducing (Check 2.0 version PR)

Latest version changelog

1.8.0

• Authentication: Added OAuth 1.0 authentication method
• CI: Migrated from Travis CI to Github CI