A JavaScript/TypeScript wrapper for the JIRA REST API
Install with the npm:
$ npm install jira.jsInstall with the yarn:
$ yarn add jira.js// ES5var{ Client }=require("jira.js");// ES6import{Client}from"jira.js";// Initializevarclient=newClient({host: "https://jira.somehost.com"});// ES5/ES6client.projects.getAllProjects().then(projects=>console.log(projects)).catch(error=>console.log(error));// ES7asyncfunctiongetProjects(){constprojects=awaitclient.projects.getAllProjects();console.log(projects);returnprojects;}constclient=newClient({host: "https://jira.somehost.com",authentication: {basic: {username: "MyUsername",apiToken: "My Password or API Token"}}});constclient=newClient({host: 'https://jira.somehost.com',authentication: {jwt: {iss: 'id';secret: 'secret key';}}});constclient=newClient({host: "https://jira.somehost.com",authentication: {accessToken: "my access token"}});Can't find what you need in the readme? Check out our documentation here: https://mrrefactoring.github.io/jira.js/
- Response models
- Method names reducing
- FIX: Added the ability to use the library without authorization #75
- FEATURE: New API
IssueTypeScreenSchemesadded - FEATURE: New API
ProjectEmailadded
- FEATURE: Method
bulkGetGroupsadded toGroups - FEATURE: Method
restoreDeletedProjectadded toProjects - FEATURE: Method
createIssueTypeSchemeadded toIssueTypeSchemes - FEATURE: Method
deleteIssueTypeSchemeadded toIssueTypeSchemes - FEATURE: Method
updateIssueTypeSchemeadded toIssueTypeSchemes - FEATURE: Method
addIssueTypesToIssueTypeSchemeadded toIssueTypeSchemes - FEATURE: Method
deleteIssueTypeFromIssueTypeSchemeadded toIssueTypeSchemes
- FEATURE: Property
idadded toIssueFieldConfigurations.getAllFieldConfigurations - FEATURE: Property
sortByOpsBarAndStatusadded toIssues.getTransitions - FEATURE: Property
accountIdadded toPermissions.getBulkPermissions
- DEPRECATION: Method
getIssueTypeScreenSchemesare deprecated inScreens - DEPRECATION: Method
getIssueTypeScreenSchemeItemsare deprecated inScreens - DEPRECATION: Method
getIssueTypeScreenSchemesForProjectsare deprecated inScreens
- FEATURE: Method
getAllFieldConfigurationSchemesadded toIssueFieldConfigurations - FEATURE: Method
getFieldConfigurationSchemesForProjectsadded toIssueFieldConfigurations - FEATURE: Property
fieldConfigurationSchemeIdadded toissueFieldConfigurations.getFieldConfigurationIssueTypeItems - FEATURE: Method
getIssueSecurityLevelMembersadded toIssueSecurityLevel - FEATURE: Issue type schemes API added
- FEATURE: Method
getLicensedProjectTypesadded toProjectTypes - FEATURE: Method
deleteProjectAsynchronouslyadded toProjects - FEATURE: Method
getIssueTypeScreenSchemesadded toScreens - FEATURE: Method
getAllScreenSchemesrenamed togetScreenSchemes - DEPRECATION:
getAllScreenSchemesare deprecated (Renamed togetScreenSchemes)
- FEATURE: Now requests where there are no required parameters do not have to pass an empty object to make a request
- FEATURE:
dashboards.createDashboardwas added - FEATURE:
dashboards.updateDashboardwas added - FEATURE:
dashboards.deleteDashboardwas added - FEATURE:
dashboards.copyDashboardwas added - FEATURE:
screens.getIssueTypeScreenSchemesForProjectswas added - FEATURE:
issueFieldConfigurations.getAllFieldConfigurationwas added - FEATURE:
issueFieldConfigurations.getFieldConfigurationItemswas added - FEATURE:
issueFieldConfigurations.getFieldConfigurationIssueTypeItemswas added - FEATURE: In
issues.getTransitionswas addedincludeUnavailableTransitionsproperty - DEPRECATION:
issueFields.getFieldConfigurationItemsare deprecated (Removed from official API, useissueFieldConfigurations.getFieldConfigurationItems). Will be removed in next major version
- FEATURE:
jiraExpressions.analyseJiraExpressionwas added - FEATURE:
screens.getIssueTypeScreenSchemeItemswas added - FEATURE: In
projects.getProjectsPaginatedwas addedstatusproperty - FEATURE: In
projects.deleteProjectwas addedenableUndoproperty - DEPRECATION:
timeTracking.disableTimeTrackingare deprecated (Removed from official API). Will be removed in next major version
- FEATURE:
issueFields.getAllFieldConfigurationsadded as experimental - FEATURE:
issueFields.getFieldConfigurationItemsadded as experimental - IMPROVEMENT: dependencies update
- FIX:
strictGDPRfeature fixed - FIX:
Cannot read property 'Authorization' of undefinedfixed
- FEATURE:
strictGDPRproperty added to Config. Allows use only GDPR-compliant functionality - FEATURE:
users.getAllUsersDefaultadded - FEATURE:
issueCustomFieldOptions.updateCustomFieldOptionsadded as experimental - DEPRECATION:
projectRoleActors.getActorsCountForProjectRoleare deprecated (Removed from official API). Will be removed in next major version
- DEPRECATION:
permissionsSchemesandissueAttachmentare deprecated - IMPROVEMENT: agile api typings improved
- IMPROVEMENT: dependencies update
- FIX: Authorization parameter excluded for agile API in the request body
- FIX: JWT Authentication default expire time added
- IMPROVEMENT: modified
atlassian-jwt(removed lodash from dependencies, bundle size decreased) - IMPROVEMENT: small tests for authentication added
- FIX: documentation link fixed
- RELEASE