v5.2.1

Bug Fixes

• Removed ~ alias due to compatibility issues with some build systems. Thanks @ThomasTrepanier, for reporting.

v5.2.0

Build & Distribution Improvements

• Added rollup-plugin-node-externals to transform ESNext import/export syntax to NodeNext format
• Restructured dist files to preserve modules

Documentation Updates

• Updated tree shaking description in README.md
• Redesigned README.md with a new "Getting Started" section

v5.1.1

• Fixing CommonJS requiring. Thanks to solshark (solshark) for reporting this issue (#381)
• Fixing ESM imports in TypeScript declarations. Thanks to Alex Grand (Arilas) for reporting this issue (#383)

---

• Special thanks to GervinFung for the npm package ts-add-js-extension, which helps resolve TypeScript ESM import paths.

v5.1.0

• Version 2 Client
  • Add UserNavProperties API group
  • Add ProjectTemplates API group
  • Add IssueCustomFieldAssociations API group
  • IssueSearch.searchForIssuesUsingJql deprecated. Use IssueSearch.searchForIssuesUsingJqlEnhancedSearch instead
  • IssueSearch.searchForIssuesUsingJqlPost deprecated. Use IssueSearch.searchForIssuesUsingJqlEnhancedSearchPost instead
  • IssueSearch.searchForIssuesIds deprecated
  • Add projectIds property to IssueFields.getFieldsPaginated method
• Version 3 Client
  • Add UserNavProperties API group
  • Add ProjectTemplates API group
  • Add IssueCustomFieldAssociations API group
  • IssueSearch.searchForIssuesUsingJql deprecated. Use IssueSearch.searchForIssuesUsingJqlEnhancedSearch instead
  • IssueSearch.searchForIssuesUsingJqlPost deprecated. Use IssueSearch.searchForIssuesUsingJqlEnhancedSearchPost instead
  • IssueSearch.searchForIssuesIds deprecated
  • Add projectIds property to IssueFields.getFieldsPaginated method
  • Add submitBulkUnwatch, submitBulkWatch methods to IssueBulkOperations API group

v5.0.0

• Added ESM (ECMAScript Modules) support
• Fixed comment generation logic in IssueWorklogs.addWorklog method
• Removed all telemetry-related code and references

v4.1.3

• Fix: Fixed failed issueBulkOperations.getAvailableTransitions method call (problem from jira side with headers). Thanks to Michael "Mike" Ferris (Cellule) for reporting this issue (#374) and fix (#375)

v4.1.2

• Fix: Fixed compilation issues for projects using the Plans.updatePlan method in Version3Client. Thanks to Jakub Gladykowski (gladykov) for reporting this issue (#370).
• Improvement: Added string type support for the projectId property in the Version model for Version3Client. Thanks to Carl Fürstenberg (azatoth) for suggesting this improvement (#371).

Release v4.1.0

• General Improvements: Enhanced JSDoc documentation across the project for better clarity and developer experience.

• Deprecation: Marked the InstanceInformation.getLicense method as deprecated.

• Deprecation: Marked the Issues.getCreateIssueMeta method as deprecated.

• Deprecation: Marked the PageBeanFieldConfigurationDetails class as deprecated. Use Paginated<FieldConfigurationDetails> instead.

• Deprecation: Marked the WorkflowUpdateResponse and WorkflowCreateResponse classes as deprecated.

• New APIs: Added the following classes to support additional Jira APIs:

  • AppDataPolicies: Manage app access rule data policies, allowing developers to set and retrieve rules controlling app access (documentation).
  • ClassificationLevels: Define and manage classification levels for sensitive information in Jira (documentation).
  • IssueBulkOperations: Perform bulk operations on issues, such as moving multiple issues between projects or updating multiple fields in one request. For additional guidance, refer to Bulk operation APIs: additional examples and FAQ (documentation).
  • Plans: Manage advanced roadmaps plans, including creating, duplicating, updating, archiving, and trashing plans (documentation).
  • PrioritySchemes: Create, retrieve, update, and delete issue priority schemes to standardize prioritization across projects (documentation).
  • ProjectClassificationLevels: View and manage classification levels within individual projects to ensure compliance with organizational standards (documentation).
  • ServiceRegistry: Access and manage attributes related to Jira Service Management’s service registry, which helps organize and maintain services (documentation).
  • TeamsInPlan: Configure settings for Atlassian and custom teams within advanced roadmaps plans, including creating, updating, and deleting team configurations (documentation).

• Improvement: Changed the return type of ProjectKeyAndNameValidation.getValidProjectKey and ProjectKeyAndNameValidation.getValidProjectName from unknown to string for improved type safety and usability.

• Improvement: Added the approximateLastUsed parameter to the Filters.createFilter method.

• Improvement: Added the isSubstringMatch parameter to the Filters.getFiltersPaginated method.

• Improvement: Updated the IssueComments.updateComment method to allow passing a plain string for the comment instead of requiring a specific object format.

• Improvement: Added the parentId parameter to the IssueComments.deleteComment method.

• Improvement: Added the releasedProjectKeys property to the Projects.updateProject method.

• Improvement: Added the avatarId parameter to the IssuePriorities.createPriority method. This parameter will replace iconUrl starting March 16, 2025. The iconUrl parameter is now marked as deprecated.

• Improvement: Added the priorityName and expand properties to the IssuePriorities.searchPriorities method.

• Improvement: Added the avatarId parameter to the IssuePriorities.updatePriority method. This parameter will replace iconUrl starting March 16, 2025. The iconUrl parameter is now marked as deprecated.

• Improvement: Added the issueId property to the UserSearch.findAssignableUsers method.

• Improvement: Added the optional skipNotFoundPrecomputations property to the JqlFunctionsApps.updatePrecomputations method.

• Improvement: Added the failFast parameter to the Issues.getIssue method.

• Improvement: Added the failFast parameter to the IssueSearch.searchForIssuesUsingJql method.

• Improvement: Added the ari and metadata parameters to the ProjectComponents.createComponent method.

• Improvement: Added the optional componentSource parameter to the ProjectComponents.getProjectComponentsPaginated method.

• Improvement: Added the optional componentSource parameter to the ProjectComponents.getProjectComponents method.

• Improvement: Added the approvers and driver parameters to the ProjectVersions.createVersion and ProjectVersions.updateVersion methods.

• Improvement: Replaced the maxResults property with maxResult in the UserSearch.findUserKeysByQuery method.

• Improvement: Added the extendAdminPermissions parameter to the following methods in the Dashboard class:

  • Dashboard.createDashboard
  • Dashboard.updateDashboard
  • Dashboard.copyDashboard

• New Method: Added the getCustomFieldsConfigurations method to the IssueCustomFieldConfigurationApps class.

• New Method: Added the replaceCustomFieldOption method to the IssueCustomFieldOptions class.

• New Methods: Added the following methods to the WorkflowSchemes class:

  • readWorkflowSchemes: Retrieve workflow schemes.
  • updateSchemes: Update workflow schemes.
  • updateWorkflowSchemeMappings: Update workflow scheme mappings.

• New Method: Added the getNotificationSchemeForProject method to the Projects class.

• New Method: Added the getBulkScreenTabs method to the ScreenTabs class.

• New Method: Added the deletePriority method to the IssuePriorities class.

• New Method: Added the getPrecomputationsByID method to the JqlFunctionsApps class.

• New Methods: Added the following methods to the Workflows class:

  • readWorkflows: Retrieve workflows.
  • workflowCapabilities: Get workflow capabilities.
  • createWorkflows: Create new workflows.
  • validateCreateWorkflows: Validate workflow creation.
  • updateWorkflows: Update existing workflows.
  • validateUpdateWorkflows: Validate workflow updates.

• New Methods: Added the following methods to the Issues class:

  • getBulkChangelogs: Retrieve changelogs for multiple issues in bulk.
  • bulkFetchIssues: Fetch multiple issues in bulk.
  • getCreateIssueMetaIssueTypes: Retrieve metadata for issue types when creating issues.
  • getCreateIssueMetaIssueTypeId: Retrieve metadata for a specific issue type by ID when creating issues.
  • getIssueLimitReport: Retrieve a report on issue limits.

• New Methods: Added the following methods to the IssueSearch class:

  • countIssues: Count issues matching a query.
  • searchForIssuesIds: Search for issue IDs using a query.
  • searchForIssuesUsingJqlEnhancedSearch: Search and reconcile issues using JQL.
  • searchForIssuesUsingJqlEnhancedSearchPost: Search and reconcile issues using JQL via POST request.

• New Methods: Added the following methods to the IssueWorklogs class:

  • bulkDeleteWorklogs: Delete multiple worklogs in bulk.
  • bulkMoveWorklogs: Move multiple worklogs in bulk.

• New Method: Added the evaluateJiraExpressionUsingEnhancedSearch method to the JiraExpressions class.

• New Method: Added the findComponentsForProjects method to the ProjectComponents class.

• New Methods: Added the following methods to the ProjectVersions class:

  • deleteRelatedWork: Delete related work for a version.
  • updateRelatedWork: Update related work for a version.
  • createRelatedWork: Create related work for a version.
  • getRelatedWork: Retrieve related work for a version.

• New Method: Added the getProjectUsagesForWorkflowScheme method to the WorkflowSchemes class.

• New Method: Added the getWorkflowProjectIssueTypeUsages method to the Workflows class.

• New Methods: Added the following methods to the Status class:

  • getProjectIssueTypeUsagesForStatus
  • getProjectUsagesForStatus
  • getWorkflowUsagesForStatus

• Fix: Updated the following methods in Version2Client and Version3Client to make the parameters argument mandatory (as it should have been initially):

  • IssueFieldConfigurations.createFieldConfiguration
  • IssueFieldConfigurations.createFieldConfigurationScheme
  • IssueLinks.linkIssues
  • IssueTypeSchemes.createIssueTypeScheme
  • IssueTypeSchemes.assignIssueTypeSchemeToProject
  • IssueTypeScreenSchemes.createIssueTypeScreenScheme
  • JQL.parseJqlQueries
  • TimeTracking.setSharedTimeTrackingConfiguration
  • WorkflowSchemeProjectAssociations.assignSchemeToProject
  • IssueTypes.createIssueType
  • IssueSearch.matchIssues
  • IssueSearch.searchForIssuesUsingJql
  • JiraExpressions.evaluateJiraExpression
  • Users.setUserColumns
  • Users.getUser

• Fix: Improved the Avatars.storeAvatar method:

  • Added the mimeType parameter to specify the type of the uploaded avatar.
  • Updated the type of the avatar parameter from any to Buffer | ArrayBuffer | Uint8Array | any for better type safety.
  • Set the default value of the size parameter to 0.

• Fix: Improved the ...

Release v4.0.6

• #347: Fixed an issue with adding attachments of type Readable or ReadableStream (e.g., fs.createReadStream). Thanks to Lunatic174 for reporting the issue.

Release v4.0.5

• #344: Replaced the mime-types library with mime to ensure browser compatibility, as mime-types relies on the path module from Node.js. Thanks to kang for reporting the issue and proposing the fix.