A JavaScript/TypeScript wrapper for the JIRA REST API
Install with the npm:
$ npm install jira.js
Install with the yarn:
$ yarn add jira.js
// ES5
var { Client } = require("jira.js");
// ES6
import { Client } from "jira.js";
// Initialize
var client = new Client({
host: "https://jira.somehost.com"
});
// 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;
}
const client = new Client({
host: "https://jira.somehost.com",
authentication: {
basic: {
username: "MyUsername",
apiToken: "My Password or API Token"
}
}
});
const client = new Client({
host: 'https://jira.somehost.com',
authentication: {
jwt: {
iss: 'id';
secret: 'secret key';
}
}
});
const client = new Client({
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
- FEATURE: New API
IssueTypeScreenSchemes
added - FEATURE: New API
ProjectEmail
added
- FEATURE: Method
bulkGetGroups
added toGroups
- FEATURE: Method
restoreDeletedProject
added toProjects
- FEATURE: Method
createIssueTypeScheme
added toIssueTypeSchemes
- FEATURE: Method
deleteIssueTypeScheme
added toIssueTypeSchemes
- FEATURE: Method
updateIssueTypeScheme
added toIssueTypeSchemes
- FEATURE: Method
addIssueTypesToIssueTypeScheme
added toIssueTypeSchemes
- FEATURE: Method
deleteIssueTypeFromIssueTypeScheme
added toIssueTypeSchemes
- FEATURE: Property
id
added toIssueFieldConfigurations.getAllFieldConfigurations
- FEATURE: Property
sortByOpsBarAndStatus
added toIssues.getTransitions
- FEATURE: Property
accountId
added toPermissions.getBulkPermissions
- DEPRECATION: Method
getIssueTypeScreenSchemes
are deprecated inScreens
- DEPRECATION: Method
getIssueTypeScreenSchemeItems
are deprecated inScreens
- DEPRECATION: Method
getIssueTypeScreenSchemesForProjects
are deprecated inScreens
- FEATURE: Method
getAllFieldConfigurationSchemes
added toIssueFieldConfigurations
- FEATURE: Method
getFieldConfigurationSchemesForProjects
added toIssueFieldConfigurations
- FEATURE: Property
fieldConfigurationSchemeId
added toissueFieldConfigurations.getFieldConfigurationIssueTypeItems
- FEATURE: Method
getIssueSecurityLevelMembers
added toIssueSecurityLevel
- FEATURE: Issue type schemes API added
- FEATURE: Method
getLicensedProjectTypes
added toProjectTypes
- FEATURE: Method
deleteProjectAsynchronously
added toProjects
- FEATURE: Method
getIssueTypeScreenSchemes
added toScreens
- FEATURE: Method
getAllScreenSchemes
renamed togetScreenSchemes
- DEPRECATION:
getAllScreenSchemes
are 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.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 addedincludeUnavailableTransitions
property - DEPRECATION:
issueFields.getFieldConfigurationItems
are deprecated (Removed from official API, useissueFieldConfigurations.getFieldConfigurationItems
). Will be removed in next major version
- FEATURE:
jiraExpressions.analyseJiraExpression
was added - FEATURE:
screens.getIssueTypeScreenSchemeItems
was added - FEATURE: In
projects.getProjectsPaginated
was addedstatus
property - FEATURE: In
projects.deleteProject
was addedenableUndo
property - DEPRECATION:
timeTracking.disableTimeTracking
are deprecated (Removed from official API). Will be removed in next major version
- FEATURE:
issueFields.getAllFieldConfigurations
added as experimental - FEATURE:
issueFields.getFieldConfigurationItems
added as experimental - IMPROVEMENT: dependencies update
- FIX:
strictGDPR
feature fixed - FIX:
Cannot read property 'Authorization' of undefined
fixed
- 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
- DEPRECATION:
permissionsSchemes
andissueAttachment
are 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