Release: v4.1.0 (#346)

* Version 3 simple updates

* CHANGELOG updated

* New API classes added to version3 client

* `Avatar.storeAvatar` method fixed

* Few increment improvements

* Few incremental improvements

* Few incremental improvements

* Few incremental improvements

* Few incremental improvements

* Few incremental improvements

* Feature/#354 deprecation of jql search and evaluate expression endpoints (#355)

* chore: Vulnerability fix

`npm fix audit`

* chore: fix error when running vitest

RangeError: options.minThreads and options.maxThreads must not conflict

Fixed by adding `--minWorkers=8` to `test:unit` in package.json

* test: define unit test for v3 enhanced search

* feat: implement v3 enhanced search

* chore: fix broken anchor

* test: define unit test for v2 enhanced search

* feat: implement v2 enhanced search

* chore: fix typo in v2

* chore: fix wrong interface name

* test: define unit test for v3 jiraExpressions

Only implemented unit test for the newly added function evaluateJiraExpressionUsingEnhancedSearch()

* feat: implement v3 jiraExpressions

Implemented new function evaluateJiraExpressionUsingEnhancedSearch()

* test: define unit test for v2 jiraExpressions

Only implemented unit test for the newly added function evaluateJiraExpressionUsingEnhancedSearch()

* feat: implement v2 jiraExpressions

Implemented new function evaluateJiraExpressionUsingEnhancedSearch()

* chore: change minWorkers to 1 for vitest

---------

Co-authored-by: Vladislav Tupikin <[email protected]>

* Few incremental improvements

* Few incremental improvements

* Few incremental improvements

* The latest Jira Cloud API changes pulled

* Build fixes

* Plans.updatePlan refined

* Wrong types for projectId (#356)

* fix: accept number for all projectIdOrKey

* fix: accept string for projectId

`projectId` is `int64` on Jira API. The API accepts both number string and number.

* fix: duplicate key

* fix: CreateProjectAvatar discrepancy

* CHANGELOG.md updated

* Add new API in `Version2Client` (#357)

* Add boilerplate for new API in Version2Client

* Check and apply changes in Version3Client to Version2Client (#359)

* fix: build error

* chore: update unit test

* fix: missing failFast in SearchAndReconcileRequest

* fix: improvement to updateComment

Forgot to clone the same improvement as addComment.

* feat: v2 IssueBulkOperations

* fix: apply the same improvement to v2 prioritySchemes

* chore: remove unused import

* fix: apply the same improvement as v3

`ProjectKeyAndNameValidation.getValidProjectName` from `unknown` to `string` for improved type safety and usability.

* fix: Apply the same fix as v3

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.

* fix: apply the same fix as v3

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.

* fix: apply the same fix as v3

Fix: Improved the Avatars.storeAvatar method

* fix: apply the same fix as v3

Fix: Improved the IssueTypes.createIssueTypeAvatar method

* fix: apply the same deprecation notes as v3

* fix: align v3 naming to v2

issueSearch and jiraExpression with enhanced search

* Update readme.md

1. moved API token like to API token section
2. added description and link to PAT
3. moved Basic auth to bottom as it's the least preferred way to auth

* fix: rollback changes on v2

Copied v3 feat to v2 by mistake

* Update src/version2/parameters/getAvailableTransitions.ts

add number support to issue ids or keys

Co-authored-by: Vladislav Tupikin <[email protected]>

* Update src/version2/parameters/getBulkEditableFields.ts

add number support to issueIdsOrKeys

Co-authored-by: Vladislav Tupikin <[email protected]>

* fix: startAt and maxResults should be number

* fix: wrong link to v3 in version 2

* fix: incorrect version in anchor

* fix: revert changes on adding v3 only model

* Update src/version3/parameters/searchWorkflows.ts

Co-authored-by: Vladislav Tupikin <[email protected]>

* Update src/version3/parameters/searchWorkflows.ts

Co-authored-by: Vladislav Tupikin <[email protected]>

* chore: revert changes on README.md

move it to another PR

* fix: update *DTO in v3

---------

Co-authored-by: Vladislav Tupikin <[email protected]>

* `bulkFetchIssues` returned back for version2 client

* Clients added to Version2Client

* Clients added to README.md

* Integration test fixes

* Build fix

* Fixes

* Incremental improvements

* Incremental improvements

---------

Co-authored-by: Ness Li <[email protected]>

* Unused code removed

* Incremental improvements

---------

Co-authored-by: Ness Li <[email protected]>

Author: MrRefactoring

.eslintrc.yml

@@ -6,11 +6,13 @@ parserOptions:
   project: ./tsconfig.lint.json
 plugins:
   - import
+  - "@typescript-eslint"
 env:
   node: true
   browser: true
 rules:
   "@typescript-eslint/lines-between-class-members": off
+  "@typescript-eslint/no-unnecessary-condition": [ error, { allowConstantLoopConditions: false } ]
   arrow-parens:
     - error
     - as-needed

CHANGELOG.md

@@ -1,5 +1,169 @@
 # Jira.js changelog
 
+### 4.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](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-app-data-policies/#api-group-app-data-policies)).
+  - **`ClassificationLevels`**: Define and manage classification levels for sensitive information in Jira ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-classification-levels/#api-group-classification-levels)).
+  - **`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](https://developer.atlassian.com/cloud/jira/platform/bulk-operation-additional-examples-and-faqs/) ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-issue-bulk-operations/#api-group-issue-bulk-operations)).
+  - **`Plans`**: Manage advanced roadmaps plans, including creating, duplicating, updating, archiving, and trashing plans ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-plans/#api-group-plans)).
+  - **`PrioritySchemes`**: Create, retrieve, update, and delete issue priority schemes to standardize prioritization across projects ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-priority-schemes/#api-group-priority-schemes)).
+  - **`ProjectClassificationLevels`**: View and manage classification levels within individual projects to ensure compliance with organizational standards ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-project-classification-levels/#api-group-project-classification-levels)).
+  - **`ServiceRegistry`**: Access and manage attributes related to Jira Service Management’s service registry, which helps organize and maintain services ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-service-registry/#api-group-service-registry)).
+  - **`TeamsInPlan`**: Configure settings for Atlassian and custom teams within advanced roadmaps plans, including creating, updating, and deleting team configurations ([documentation](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-teams-in-plan/#api-group-teams-in-plan)).
+
+- **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 `IssueTypes.createIssueTypeAvatar` method:
+  - Added the `mimeType` parameter to specify the type of the uploaded avatar.
+  - Added the `avatar` parameter with the type `Buffer | ArrayBuffer | Uint8Array`.
+  - Set the default value of the `size` parameter to `0`.
+- **Fix:** Improved the `ProjectAvatars.createProjectAvatar` 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`.
+  - Set the default value of the `size` parameter to `0`.
+
+- **Change:** Removed the `filter` parameter from the `JqlFunctionsApps.getPrecomputations` method (experimental method, not a breaking change).
+- **Change:** Renamed `JiraExpressionEvaluateContextBean` to `JiraExpressionEvaluateContext`.
+
+- **Improvement:** Added type `string` for properties `projectId` in parameters and models:
+  - Model `Version`
+  - Parameter `GetFieldConfigurationSchemeProjectMapping`
+  - Parameter `GetHierarchy`
+  - Parameter `GetIssueTypeSchemeForProjects`
+  - Parameter `GetIssueTypeScreenSchemeProjectAssociations`
+  - Parameter `GetIssueTypesForProject`
+  - Parameter `GetProjectEmail`
+  - Parameter `GetWorkflowSchemeProjectAssociations`
+  - Parameter `UpdateProjectEmail`
+- **Improvement:** Added type `number` for properties `projectIdOrKey` in parameters and models:
+  - Parameter `AddActorUsers`
+  - Parameter `ArchiveProject`
+  - Parameter `CreateProjectAvatar`
+  - Parameter `DeleteActor`
+  - Parameter `DeleteProject`
+  - Parameter `DeleteProjectAsynchronously`
+  - Parameter `DeleteProjectAvatar`
+  - Parameter `DeleteProjectProperty`
+  - Parameter `GetAllProjectAvatars`
+  - Parameter `GetAllStatuses`
+  - Parameter `GetFeaturesForProject`
+  - Parameter `GetProjectComponents`
+  - Parameter `GetProjectComponentsPaginated`
+  - Parameter `GetProjectProperty`
+  - Parameter `GetProjectPropertyKeys`
+  - Parameter `GetProjectRole`
+  - Parameter `GetProjectRoleDetails`
+  - Parameter `GetProjectRoles`
+  - Parameter `GetProjectVersions`
+  - Parameter `GetProjectVersionsPaginated`
+  - Parameter `Restore`
+  - Parameter `SetActors`
+  - Parameter `SetProjectProperty`
+  - Parameter `ToggleFeatureForProject`
+  - Parameter `UpdateProject`
+  - Parameter `UpdateProjectAvatar`
+
+---
+
+- **Special thanks to Ness Li ([nessgor](https://github.com/nessgor)) for implementing the changes above. PR: [#356](https://github.com/MrRefactoring/jira.js/pull/356).**
+- **Thanks to Niklas Correnz ([uncaught](https://github.com/uncaught)) for reporting the issue: [#352](https://github.com/MrRefactoring/jira.js/issues/352).**
+
+---
+
 ### 4.0.6
 
 - **#347:** Fixed an issue with adding attachments of type `Readable` or `ReadableStream` (e.g., `fs.createReadStream`). Thanks to [Lunatic174](https://github.com/Lunatic174) for [reporting the issue](https://github.com/MrRefactoring/jira.js/issues/347).