Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release: v4.1.0 #346

Draft
wants to merge 18 commits into
base: master
Choose a base branch
from
Draft

Release: v4.1.0 #346

wants to merge 18 commits into from

Conversation

MrRefactoring
Copy link
Owner

@MrRefactoring MrRefactoring commented Jan 7, 2025

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

  • 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 extendAdminPermissions parameter to the following methods in the Dashboard class:

    • Dashboard.createDashboard
    • Dashboard.updateDashboard
    • Dashboard.copyDashboard
  • 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.

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

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

  • Change: Renamed JiraExpressionEvaluateContextBean to JiraExpressionEvaluateContext.

  • Plans.updatePlan refined

  • deeplinks fixed (like (#expand) -> (#https://version3.domain/#expand))

  • Add new Version2 classes to README.md with links

  • Add new Version2 classes to the client

  • Sort index.ts files for models and parameters

@MrRefactoring MrRefactoring added this to the v4.1.0 milestone Jan 7, 2025
@MrRefactoring MrRefactoring changed the title Version 3 simple updates Release: v4.1.0 Jan 7, 2025
MrRefactoring and others added 17 commits January 7, 2025 23:28
…nts (#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]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants