Skip to content

alvin/jira.js

Repository files navigation

JavaScript JIRA API Client

npmDownloadsMinizipped sizedependencies StatusdevDependencies StatusBuild Status

Installation

Install with the npm:

$ npm install jira.js

Install with the yarn:

$ yarn add jira.js

Examples

Create the JIRA client

// ES5var{ Client }=require("jira.js");// ES6import{Client}from"jira.js";// Initializevarclient=newClient({host: "https://jira.somehost.com"});

Get all projects

// ES5/ES6client.projects.getAllProjects().then(projects=>console.log(projects)).catch(error=>console.log(error));// ES7asyncfunctiongetProjects(){constprojects=awaitclient.projects.getAllProjects();console.log(projects);returnprojects;}

Authorization

Basic authorization

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

JWT authentication

constclient=newClient({host: 'https://jira.somehost.com',authentication: {jwt: {iss: 'id';secret: 'secret key';}}});

OAuth2.0 authentication

constclient=newClient({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.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

About

A JavaScript wrapper for the JIRA REST API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript100.0%