v2.15.0 RC (#209)

* 2.15.0 Version 2 API updates

* #206 issueWorklogs.addWorklog comment can be added now (#208)

* #205 Max content length was increased for attachments (#207)

* #205 maxContentLength was increased for attachments

* package-lock.json reverted

* 2.15.0 Version 3 API updates

* 2.15.0 build fixes, improvements

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Jira.js changelog
 
+### 2.15.0
+
+- Version 3: addWorklog and updateWorklog comment field type fixed. Thanks to [RealBuddy](https://github.com/RealBuddy) for reporting the issue.
+- Version 3: maxContentLength was increased for attachments upload. Thanks to [RealBuddy](https://github.com/RealBuddy) for reporting the issue.
+- Version 2, Version 3:
+  - `uiModificationsApps` API added.
+  - `query` property added to `getProjectsForIssueTypeScreenScheme` method `IssueTypeScreenSchemes` API.
+  - `commentId` property added to `getMyPermissions` method `Permissions` API.
+  - `createPriority`, `searchPriorities`, `updatePriority`  methods added to `IssuePriorities` API.
+
 ### 2.14.0
 
 - README: Fast jump to basic authentication topic fixed.

README.md

@@ -303,6 +303,7 @@ Available groups:
   - [status](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-status/#api-group-status)
   - [tasks](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-tasks/#api-group-tasks)
   - [timeTracking](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-time-tracking/#api-group-time-tracking)
+  - [uiModificationsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-ui-modifications--apps-/#api-group-ui-modifications--apps-)
   - [users](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-users/#api-group-users)
   - [userProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-user-properties/#api-group-user-properties)
   - [userSearch](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-user-search/#api-group-user-search)
@@ -391,6 +392,7 @@ Available groups:
   - [status](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-status/#api-group-status)
   - [tasks](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-tasks/#api-group-tasks)
   - [timeTracking](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-time-tracking/#api-group-time-tracking)
+  - [uiModificationsApps](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-ui-modifications--apps-/#api-group-ui-modifications--apps-)
   - [users](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-group-users)
   - [userProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-properties/#api-group-user-properties)
   - [userSearch](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-user-search/#api-group-user-search)

package-lock.json

@@ -1,13 +1,14 @@
 {
   "name": "jira.js",
-  "version": "2.14.0",
+  "version": "2.15.0",
   "description": "jira.js is a powerful Node.JS/Browser module that allows you to interact with the Jira API very easily",
   "main": "out/index.js",
   "types": "out/index.d.ts",
   "repository": "https://github.com/MrRefactoring/jira.js.git",
   "author": "Vladislav Tupikin <mrrefactoring@yandex.ru>",
   "license": "MIT",
   "keywords": [
+    "atlassian",
     "jira",
     "api",
     "agile",
@@ -52,25 +53,25 @@
   "devDependencies": {
     "@swc-node/register": "^1.5.1",
     "@types/express": "^4.17.13",
-    "@types/node": "^17.0.33",
+    "@types/node": "^17.0.42",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.23.0",
-    "@typescript-eslint/parser": "^5.23.0",
-    "ava": "^4.2.0",
+    "@typescript-eslint/eslint-plugin": "^5.28.0",
+    "@typescript-eslint/parser": "^5.28.0",
+    "ava": "^4.3.0",
     "dotenv": "^16.0.1",
-    "eslint": "^8.15.0",
+    "eslint": "^8.17.0",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-typescript": "^17.0.0",
     "eslint-import-resolver-typescript": "^2.7.1",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-sort-exports": "^0.6.0",
-    "prettier": "^2.6.2",
+    "prettier": "^2.7.0",
     "prettier-plugin-jsdoc": "^0.3.38",
     "sinon": "^14.0.0",
-    "typedoc": "^0.22.15",
+    "typedoc": "^0.22.17",
     "typedoc-plugin-extras": "^2.2.3",
-    "typescript": "^4.6.4"
+    "typescript": "^4.7.3"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",

package.json

@@ -72,6 +72,7 @@ import {
   Status,
   Tasks,
   TimeTracking,
+  UIModificationsApps,
   UserProperties,
   Users,
   UserSearch,
@@ -159,6 +160,7 @@ export class Version2Client extends BaseClient {
   status = new Status(this);
   tasks = new Tasks(this);
   timeTracking = new TimeTracking(this);
+  uiModificationsApps = new UIModificationsApps(this);
   userProperties = new UserProperties(this);
   users = new Users(this);
   userSearch = new UserSearch(this);

src/version2/client/version2Client.ts

@@ -70,6 +70,7 @@ export * from './serverInfo';
 export * from './status';
 export * from './tasks';
 export * from './timeTracking';
+export * from './uIModificationsApps';
 export * from './userProperties';
 export * from './userSearch';
 export * from './users';

src/version2/index.ts

@@ -8,18 +8,18 @@ export class IssueAdjustmentsApps {
   constructor(private client: Client) {}
 
   /**
-   * Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps.
+   * @deprecated Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
    */
   async getIssueAdjustments<T = Models.PageIssueAdjustmentDetails>(
     parameters: Parameters.GetIssueAdjustments | undefined,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps.
+   * @deprecated Gets issue adjustments. Issue adjustments can only be retrieved by Forge apps.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
    */
   async getIssueAdjustments<T = Models.PageIssueAdjustmentDetails>(
     parameters?: Parameters.GetIssueAdjustments,
@@ -43,30 +43,30 @@ export class IssueAdjustmentsApps {
   }
 
   /**
-   * Creates an issue adjustment. Issue adjustment can only be created by Forge apps.
+   * @deprecated Creates an issue adjustment. Issue adjustment can only be created by Forge apps.
    *
-   * Each app can define up to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts.
+   *   Each app can define up to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
    *
-   * - _None_ if the issue adjustment is created without contexts.
-   * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
-   *   issue adjustment is created with contexts.
+   *   - _None_ if the issue adjustment is created without contexts.
+   *   - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
+   *       issue adjustment is created with contexts.
    */
   async createIssueAdjustment<T = Models.IssueAdjustmentIdentifiers>(
     parameters: Parameters.CreateIssueAdjustment | undefined,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Creates an issue adjustment. Issue adjustment can only be created by Forge apps.
+   * @deprecated Creates an issue adjustment. Issue adjustment can only be created by Forge apps.
    *
-   * Each app can define up to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts.
+   *   Each app can define up to 100 issue adjustments. Each issue adjustment can define up to 1000 contexts.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
    *
-   * - _None_ if the issue adjustment is created without contexts.
-   * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
-   *   issue adjustment is created with contexts.
+   *   - _None_ if the issue adjustment is created without contexts.
+   *   - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
+   *       issue adjustment is created with contexts.
    */
   async createIssueAdjustment<T = Models.IssueAdjustmentIdentifiers>(
     parameters?: Parameters.CreateIssueAdjustment,
@@ -91,30 +91,30 @@ export class IssueAdjustmentsApps {
   }
 
   /**
-   * Updates an issue adjustment. Issue adjustment can only be updated by Forge apps.
+   * @deprecated Updates an issue adjustment. Issue adjustment can only be updated by Forge apps.
    *
-   * Each issue adjustment can define up to 1000 contexts.
+   *   Each issue adjustment can define up to 1000 contexts.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
    *
-   * - _None_ if the issue adjustment is created without contexts.
-   * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
-   *   issue adjustment is created with contexts.
+   *   - _None_ if the issue adjustment is created without contexts.
+   *   - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
+   *       issue adjustment is created with contexts.
    */
   async updateIssueAdjustment<T = void>(
     parameters: Parameters.UpdateIssueAdjustment,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Updates an issue adjustment. Issue adjustment can only be updated by Forge apps.
+   * @deprecated Updates an issue adjustment. Issue adjustment can only be updated by Forge apps.
    *
-   * Each issue adjustment can define up to 1000 contexts.
+   *   Each issue adjustment can define up to 1000 contexts.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
    *
-   * - _None_ if the issue adjustment is created without contexts.
-   * - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
-   *   issue adjustment is created with contexts.
+   *   - _None_ if the issue adjustment is created without contexts.
+   *   - _Browse projects_ [project permission](https://confluence.atlassian.com/x/yodKLg) for one or more projects, if the
+   *       issue adjustment is created with contexts.
    */
   async updateIssueAdjustment<T = void>(parameters: Parameters.UpdateIssueAdjustment, callback?: never): Promise<T>;
   async updateIssueAdjustment<T = void>(
@@ -136,20 +136,20 @@ export class IssueAdjustmentsApps {
   }
 
   /**
-   * Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too. Issue adjustment
-   * can only be deleted by Forge apps.
+   * @deprecated Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too.
+   *   Issue adjustment can only be deleted by Forge apps.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
    */
   async deleteIssueAdjustment<T = void>(
     parameters: Parameters.DeleteIssueAdjustment,
     callback: Callback<T>
   ): Promise<void>;
   /**
-   * Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too. Issue adjustment
-   * can only be deleted by Forge apps.
+   * @deprecated Deletes an issue adjustment. All the contexts that belong to the issue adjustment are deleted too.
+   *   Issue adjustment can only be deleted by Forge apps.
    *
-   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
+   *   **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:** None.
    */
   async deleteIssueAdjustment<T = void>(parameters: Parameters.DeleteIssueAdjustment, callback?: never): Promise<T>;
   async deleteIssueAdjustment<T = void>(

src/version2/issueAdjustmentsApps.ts

@@ -419,6 +419,8 @@ export class IssueAttachments {
         ...formData.getHeaders?.(),
       },
       data: formData,
+      maxBodyLength: Infinity,
+      maxContentLength: Infinity,
     };
 
     return this.client.sendRequest(config, callback);

src/version2/issueAttachments.ts

@@ -30,6 +30,89 @@ export class IssuePriorities {
     return this.client.sendRequest(config, callback);
   }
 
+  /**
+   * Creates an issue priority.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async createPriority<T = Models.PriorityId>(
+    parameters: Parameters.CreatePriority | undefined,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Creates an issue priority.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async createPriority<T = Models.PriorityId>(parameters?: Parameters.CreatePriority, callback?: never): Promise<T>;
+  async createPriority<T = Models.PriorityId>(
+    parameters?: Parameters.CreatePriority,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/rest/api/2/priority',
+      method: 'POST',
+      data: {
+        name: parameters?.name,
+        description: parameters?.description,
+        iconUrl: parameters?.iconUrl,
+        statusColor: parameters?.statusColor,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of
+   * priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
+   *
+   * - A list of priority IDs. Any invalid priority IDs are ignored.
+   * - Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only,
+   *   as there is no concept of default priorities in team-managed projects.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * Permission to access Jira.
+   */
+  async searchPriorities<T = Models.PagePriority>(
+    parameters: Parameters.SearchPriorities | undefined,
+    callback: Callback<T>
+  ): Promise<void>;
+  /**
+   * Returns a [paginated](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#pagination) list of
+   * priorities. The list can contain all priorities or a subset determined by any combination of these criteria:
+   *
+   * - A list of priority IDs. Any invalid priority IDs are ignored.
+   * - Whether the field configuration is a default. This returns priorities from company-managed (classic) projects only,
+   *   as there is no concept of default priorities in team-managed projects.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * Permission to access Jira.
+   */
+  async searchPriorities<T = Models.PagePriority>(
+    parameters?: Parameters.SearchPriorities,
+    callback?: never
+  ): Promise<T>;
+  async searchPriorities<T = Models.PagePriority>(
+    parameters?: Parameters.SearchPriorities,
+    callback?: Callback<T>,
+  ): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/rest/api/2/priority/search',
+      method: 'GET',
+      params: {
+        startAt: parameters?.startAt,
+        maxResults: parameters?.maxResults,
+        id: parameters?.id,
+        onlyDefault: parameters?.onlyDefault,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
   /**
    * Returns an issue priority.
    *
@@ -55,4 +138,33 @@ export class IssuePriorities {
 
     return this.client.sendRequest(config, callback);
   }
+
+  /**
+   * Updates an issue priority.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async updatePriority<T = void>(parameters: Parameters.UpdatePriority, callback: Callback<T>): Promise<void>;
+  /**
+   * Updates an issue priority.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async updatePriority<T = void>(parameters: Parameters.UpdatePriority, callback?: never): Promise<T>;
+  async updatePriority<T = void>(parameters: Parameters.UpdatePriority, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: `/rest/api/2/priority/${parameters.id}`,
+      method: 'PUT',
+      data: {
+        name: parameters.name,
+        description: parameters.description,
+        iconUrl: parameters.iconUrl,
+        statusColor: parameters.statusColor,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
 }

src/version2/issuePriorities.ts

@@ -427,6 +427,7 @@ export class IssueTypeScreenSchemes {
       params: {
         startAt: parameters.startAt,
         maxResults: parameters.maxResults,
+        query: parameters.query,
       },
     };