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.

v2.19.1

• setIssueProperty method in IssueProperties API fixed. propertyValue parameter added.
• logo fixed

v2.19.0

• Version 2, Version 3:
  • jqlFunctionsApps API added.
  • A lot of changes in Models.
  • A log of new API added.

v2.18.0

• Agile
  • Fields model added for Issue Model.
• Version 3:
  • Support simple string body (comment) was added to addComment method of issueComments API. Thanks to Michael "Mike" Ferris for releasing feature.
• Version 2, Version 3:
  • putAddonProperty method fixed. Now you can provide property for set.