v5.3.1

Bug Fixes

• #416: Fixed mime.getType is not a function when using the CommonJS build. Replaced the ESM-only mime dependency with mime-types, which supports both ESM and CJS. Thanks to Alxs39 for reporting this issue.

v5.3.0

5.3.0

General

• Updated dependencies
• Improved JSDoc coverage and quality
• Refactored integration tests to use global setup/teardown for better performance and reliability
• Wrapped all integration tests in describe blocks for better organization

Bug Fixes

• #410: Fixed getWorkflowSchemeProjectAssociations to properly serialize multiple project IDs as separate query parameters (projectId=10000&projectId=10001) instead of comma-separated values. Thanks to konrad-garus for reporting this issue.
• #411: Added missing url field to Webhook model. Thanks to vrmiguel for reporting this issue.

Version 2 Client

New Endpoints

• Api
  • Added Api endpoints for bulk worklog operations
• FieldSchemes
  • Added FieldSchemes endpoints for field association scheme management
• IssueRedaction
  • Added IssueRedaction endpoints for issue field data redaction
• MigrationOfConnectModulesToForge
  • Added MigrationOfConnectModulesToForge endpoints for Connect to Forge migration
• AppProperties
  • Added AppProperties.getForgeAppPropertyKeys
  • Added AppProperties.getForgeAppProperty
• IssueFields
  • Added IssueFields.getProjectFields
• ProjectTemplates
  • Added ProjectTemplates.editTemplate
  • Added ProjectTemplates.liveTemplate
  • Added ProjectTemplates.removeTemplate
  • Added ProjectTemplates.saveTemplate
• Status
  • Added Status.getStatusesByName
• Workflows
  • Added Workflows.readWorkflowFromHistory
  • Added Workflows.listWorkflowHistory
  • Added Workflows.getDefaultEditor
  • Added Workflows.readWorkflowPreviews
• WorkflowSchemes
  • Added WorkflowSchemes.switchWorkflowSchemeForProject

Enhancements

• IssueComments
  • Added parentId parameter to IssueComments.addComment to support threaded comment replies. Thanks to lukiffer for requesting this feature (#407).

Deprecations

• Marked JiraExpressions.evaluateJiraExpression as deprecated
• Marked Workflows.createWorkflow as deprecated
• Marked Workflows.getWorkflowsPaginated as deprecated
• Marked the following under WorkflowTransitionProperties as deprecated:
  • getWorkflowTransitionProperties
  • createWorkflowTransitionProperty
  • updateWorkflowTransitionProperty
  • deleteWorkflowTransitionProperty

Version 3 Client

New Endpoints

• Api
  • Added Api endpoints
• FieldSchemes
  • Added FieldSchemes endpoints
• IssueRedaction
  • Added IssueRedaction endpoints
• MigrationOfConnectModulesToForge
  • Added MigrationOfConnectModulesToForge endpoints
• AppProperties
  • Added AppProperties.getForgeAppPropertyKeys
  • Added AppProperties.getForgeAppProperty
• IssueFields
  • Added IssueFields.getProjectFields
• Issues
  • Added appType param to Issues.assignIssue
• ProjectTemplates
  • Added ProjectTemplates.editTemplate
  • Added ProjectTemplates.liveTemplate
  • Added ProjectTemplates.removeTemplate
  • Added ProjectTemplates.saveTemplate
• Status
  • Added Status.getStatusesByName
  • Migrated Status.search endpoint to use zod-based response schemas (PoC) and added integration tests
• Workflows
  • Added Workflows.readWorkflowFromHistory
  • Added Workflows.listWorkflowHistory
  • Added Workflows.getDefaultEditor
  • Added Workflows.readWorkflowPreviews
• WorkflowSchemes
  • Added WorkflowSchemes.switchWorkflowSchemeForProject

Enhancements

• IssueComments
  • Added parentId parameter to IssueComments.addComment to support threaded comment replies. Thanks to lukiffer for requesting this feature (#407).

Deprecations

• Marked JiraExpressions.evaluateJiraExpression as deprecated
• Marked Workflows.createWorkflow as deprecated
• Marked Workflows.getWorkflowsPaginated as deprecated
• Marked the following under WorkflowTransitionProperties as deprecated:
  • getWorkflowTransitionProperties
  • createWorkflowTransitionProperty
  • updateWorkflowTransitionProperty
  • deleteWorkflowTransitionProperty

v5.2.2

• Fixed url for version2.issues.bulkFetchIssues. Thanks @genio, for reporting.

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).