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.

Release v4.0.4

• #320: Resolved a tree-shaking issue where importing a single client would still include all clients in the output bundle when using bundlers. Now, only the required client code is included. Thanks to Nao Yonashiro for reporting the issue and proposing a fix.

• #327: Replaced the form-data library with formdata-node to enable compatibility with ESM projects when adding attachments via the issueAttachment.addAttachment method. Thanks to Paweł Król for reporting the issue and Matyáš Kroupa for implementing the fix.

• Improvement: The type of the projectIdOrKey property was updated from string to number | string for project update operations. This enhancement improves type safety and flexibility when handling project identifiers.

• Enhancement: Added a mimeType property to the version2.issueAttachments.addAttachment, version3.issueAttachments.addAttachment, and serviceDesk.serviceDesk.attachTemporaryFile methods. This allows specifying the file type. If mimeType is not provided, a default type is inferred from the filename.

  Examples:

  👎 Before:

  const client = new Version2Client() || new Version3Client() || new ServiceDeskClient();
  
  const attachment = await client.issueAttachments.addAttachment({
      issueIdOrKey: issue.key,
      attachment: {
          filename: 'issueAttachments.test.ts',
          file: fs.readFileSync('./tests/integration/version2/issueAttachments.test.ts'),
      },
  });
  
  console.log(attachment[0].mimeType); // Will be 'video/mp2t'

  👍 Now:

  const client = new Version2Client() || new Version3Client() || new ServiceDeskClient();
  
  const attachment = await client.issueAttachments.addAttachment({
      issueIdOrKey: issue.key,
      attachment: {
          filename: 'issueAttachments.test.ts',
          file: fs.readFileSync('./tests/integration/version2/issueAttachments.test.ts'),
          mimeType: 'application/typescript',
      },
  });
  
  console.log(attachment[0].mimeType); // Will be 'application/typescript'

Release v4.0.3

4.0.3

• Bug Fix: Fixed an issue with the Users.createUser method by adding the required products property. Thanks to Appelberg-s for the fix.
• Documentation Update: Corrected an error in README.md. Thanks to Maurice de Bruyn for the contribution.
• Dependencies: Updated all dependencies to their latest versions.

Release v4.0.2

• getAllProjects in README and examples replaced to searchProjects. Thanks to Alexander Pivovarov for reporting the issue.
• Personal access token link changed to actual in README.
• The test platform has been changed from ava to vitest, thanks to Nato Boram and his reference PR.
• Dependencies updated.
• Vulnerabilities fixes.

Release v4.0.1

4.0.1

• Vulnerabilities fixes

v4.0.0

4.0.0

• #309 - Added rate limiting headers. Thanks to Chalenge Masekera.
• #308 - Implemented a new error handling mechanism. Thanks to Dmitry Shilov.

Breaking changes

• The new error handling mechanism may affect your library usage.

v3.0.1

Dependencies upgraded

v3.0.0

Breaking Changes:

• Avatar Endpoints Updates:

  • Methods avatar.getAvatarImageByID, getAvatarImageByType, and getAvatarImageByOwner have an updated return type. Avatars will now be returned as binary data.
  • storeAvatar endpoint has been fixed. It now both accepts and sends the avatar property.

• Authentication Changes:

  • Removed OAuth and JWT authentication. This might be reintroduced with proper testing support in the future.

• API Clean-Up:

  • Deprecated and unused components from Agile, ServiceDesk, Version2, and Version3 APIs have been removed.

Enhancements:

• Improved browser capability.
• Enhanced parameter typings.