JSPM

jira.js

1.5.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 114061
  • Score
    100M100P100Q166204F
  • License MIT

Package Exports

  • jira.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (jira.js) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

JavaScript JIRA API Client

npm Downloads Minizipped size dependencies Status devDependencies Status Build Status

A JavaScript 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

// ES5
var { Client } = require("jira.js");

// ES6
import { Client } from "jira.js";

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

Get all projects

// 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

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

JWT authentication

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

OAuth2.0 authentication

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

Documentation

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

Road map

  • Response models
  • Method names reducing

Changelog

1.5.0

  • FEATURE: Method getAllFieldConfigurationSchemes added to IssueFieldConfigurations
  • FEATURE: Method getFieldConfigurationSchemesForProjects added to IssueFieldConfigurations
  • FEATURE: Property fieldConfigurationSchemeId added to issueFieldConfigurations.getFieldConfigurationIssueTypeItems
  • FEATURE: Method getIssueSecurityLevelMembers added to IssueSecurityLevel
  • FEATURE: Issue type schemes API added
  • FEATURE: Method getLicensedProjectTypes added to ProjectTypes
  • FEATURE: Method deleteProjectAsynchronously added to Projects
  • FEATURE: Method getIssueTypeScreenSchemes added to Screens
  • FEATURE: Method getAllScreenSchemes renamed to getScreenSchemes
  • DEPRECATION: getAllScreenSchemes are deprecated (Renamed to getScreenSchemes)

1.4.0

  • FEATURE: Now requests where there are no required parameters do not have to pass an empty object to make a request
  • FEATURE: dashboards.createDashboard was added
  • FEATURE: dashboards.updateDashboard was added
  • FEATURE: dashboards.deleteDashboard was added
  • FEATURE: dashboards.copyDashboard was added
  • FEATURE: screens.getIssueTypeScreenSchemesForProjects was added
  • FEATURE: issueFieldConfigurations.getAllFieldConfiguration was added
  • FEATURE: issueFieldConfigurations.getFieldConfigurationItems was added
  • FEATURE: issueFieldConfigurations.getFieldConfigurationIssueTypeItems was added
  • FEATURE: In issues.getTransitions was added includeUnavailableTransitions property
  • DEPRECATION: issueFields.getFieldConfigurationItems are deprecated (Removed from official API, use issueFieldConfigurations.getFieldConfigurationItems). Will be removed in next major version

1.3.0

  • FEATURE: jiraExpressions.analyseJiraExpression was added
  • FEATURE: screens.getIssueTypeScreenSchemeItems was added
  • FEATURE: In projects.getProjectsPaginated was added status property
  • FEATURE: In projects.deleteProject was added enableUndo property
  • DEPRECATION: timeTracking.disableTimeTracking are deprecated (Removed from official API). Will be removed in next major version

1.2.0

  • FEATURE: issueFields.getAllFieldConfigurations added as experimental
  • FEATURE: issueFields.getFieldConfigurationItems added as experimental
  • IMPROVEMENT: dependencies update

1.1.1

  • FIX: strictGDPR feature fixed
  • FIX: Cannot read property 'Authorization' of undefined fixed

1.1.0

  • FEATURE: strictGDPR property added to Config. Allows use only GDPR-compliant functionality
  • FEATURE: users.getAllUsersDefault added
  • FEATURE: issueCustomFieldOptions.updateCustomFieldOptions added as experimental
  • DEPRECATION: projectRoleActors.getActorsCountForProjectRole are deprecated (Removed from official API). Will be removed in next major version

1.0.3

  • DEPRECATION: permissionsSchemes and issueAttachment are deprecated
  • IMPROVEMENT: agile api typings improved
  • IMPROVEMENT: dependencies update
  • FIX: Authorization parameter excluded for agile API in the request body

1.0.2

  • FIX: JWT Authentication default expire time added
  • IMPROVEMENT: modified atlassian-jwt (removed lodash from dependencies, bundle size decreased)
  • IMPROVEMENT: small tests for authentication added

1.0.1

  • FIX: documentation link fixed

1.0.0

  • RELEASE