2.14.0 RC (#202)

* models index file updated

* dependencies updates

* #199 fixVersion definition fixed

* sorting exports

* Version 2 api updates

* Version 3 api updates

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,15 @@
 # Jira.js changelog
 
+### 2.14.0
+
+- README: Fast jump to basic authentication topic fixed.
+- Version 2 and Version 3:
+  - `fixVersion` type definition fixed (`Issue.Fields` model). Thanks to [Eloy Lafuente](https://github.com/stronk7) for reporting the issue.
+  - `AnnouncementBanner` API added.
+  - `Status` API added.
+  - `groupId` property added to `getDashboardsPaginated` method in `Dashboard` API.
+  - `groupId` property added to `addActorUsers`, `deleteActor`, `addProjectRoleActorsToRole`, `deleteProjectRoleActorsFromRole` methods in `ProjectRoleActors` API.
+
 ### 2.13.0
 
 - Service Desk:

README.md

@@ -21,7 +21,7 @@ Usability, consistency, and performance are key focuses of jira.js, and it also
 - [Documentation](#documentation)
 - [Usage](#usage)
   - [Authentication](#authentication)
-    - [Basic](#basic-authenticationhttpsdeveloperatlassiancomcloudjiraplatformbasic-auth-for-rest-apis)
+    - [Basic](#basic-authentication)
     - [OAuth](#oauth)
     - [OAuth 2.0](#oauth-20)
     - [JWT](#jwt)
@@ -233,6 +233,7 @@ Available groups:
   <details>
     <summary>Version 2 Cloud REST API group</summary>
 
+  - [announcementBanner](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-announcement-banner/#api-group-announcement-banner)
   - [applicationRoles](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-application-roles/#api-group-application-roles)
   - [appMigration](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-app-migration/#api-group-app-migration)
   - [auditRecords](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-audit-records/#api-group-audit-records)
@@ -299,6 +300,7 @@ Available groups:
   - [screenTabFields](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-tab-fields/#api-group-screen-tab-fields)
   - [screenSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-screen-schemes/#api-group-screen-schemes)
   - [serverInfo](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-server-info/#api-group-server-info)
+  - [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)
   - [users](https://developer.atlassian.com/cloud/jira/platform/rest/v2/api-group-users/#api-group-users)
@@ -319,6 +321,7 @@ Available groups:
   <details>
     <summary>Version 3 Cloud REST API group</summary>
 
+  - [announcementBanner](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-announcement-banner/#api-group-announcement-banner)
   - [applicationRoles](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-application-roles/#api-group-application-roles)
   - [appMigration](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-migration/#api-group-app-migration)
   - [auditRecords](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-audit-records/#api-group-audit-records)
@@ -385,6 +388,7 @@ Available groups:
   - [screenTabFields](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-tab-fields/#api-group-screen-tab-fields)
   - [screenSchemes](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-screen-schemes/#api-group-screen-schemes)
   - [serverInfo](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-server-info/#api-group-server-info)
+  - [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)
   - [users](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-users/#api-group-users)

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.13.0",
+  "version": "2.14.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",
@@ -10,6 +10,9 @@
   "keywords": [
     "jira",
     "api",
+    "agile",
+    "cloud",
+    "serviceDesk",
     "wrapper",
     "client",
     "rest"
@@ -47,31 +50,31 @@
     }
   },
   "devDependencies": {
-    "@swc-node/register": "^1.4.2",
+    "@swc-node/register": "^1.5.1",
     "@types/express": "^4.17.13",
-    "@types/node": "^17.0.27",
+    "@types/node": "^17.0.33",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.11",
-    "@typescript-eslint/eslint-plugin": "^5.21.0",
-    "@typescript-eslint/parser": "^5.21.0",
+    "@typescript-eslint/eslint-plugin": "^5.23.0",
+    "@typescript-eslint/parser": "^5.23.0",
     "ava": "^4.2.0",
-    "dotenv": "^16.0.0",
-    "eslint": "^8.14.0",
+    "dotenv": "^16.0.1",
+    "eslint": "^8.15.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-plugin-jsdoc": "^0.3.38",
-    "sinon": "^13.0.2",
+    "sinon": "^14.0.0",
     "typedoc": "^0.22.15",
     "typedoc-plugin-extras": "^2.2.3",
-    "typescript": "^4.6.3"
+    "typescript": "^4.6.4"
   },
   "dependencies": {
     "atlassian-jwt": "^2.0.2",
-    "axios": "^0.27.0",
+    "axios": "^0.27.2",
     "form-data": "^4.0.0",
     "oauth": "^0.9.15",
     "tslib": "^2.4.0"

package.json

@@ -0,0 +1,61 @@
+import * as Models from './models';
+import * as Parameters from './parameters';
+import { Callback } from '../callback';
+import { Client } from '../clients';
+import { RequestConfig } from '../requestConfig';
+
+export class AnnouncementBanner {
+  constructor(private client: Client) {}
+
+  /**
+   * Returns the current announcement banner configuration.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async getBanner<T = Models.AnnouncementBannerConfiguration>(callback: Callback<T>): Promise<void>;
+  /**
+   * Returns the current announcement banner configuration.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async getBanner<T = Models.AnnouncementBannerConfiguration>(callback?: never): Promise<T>;
+  async getBanner<T = Models.AnnouncementBannerConfiguration>(callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/rest/api/2/announcementBanner',
+      method: 'GET',
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+
+  /**
+   * Updates the announcement banner configuration.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async setBanner<T = void>(parameters: Parameters.SetBanner, callback: Callback<T>): Promise<void>;
+  /**
+   * Updates the announcement banner configuration.
+   *
+   * **[Permissions](https://developer.atlassian.com/cloud/jira/platform/rest/v2/intro/#permissions) required:**
+   * _Administer Jira_ [global permission](https://confluence.atlassian.com/x/x4dKLg).
+   */
+  async setBanner<T = void>(parameters: Parameters.SetBanner, callback?: never): Promise<T>;
+  async setBanner<T = void>(parameters: Parameters.SetBanner, callback?: Callback<T>): Promise<void | T> {
+    const config: RequestConfig = {
+      url: '/rest/api/2/announcementBanner',
+      method: 'PUT',
+      data: {
+        message: parameters.message,
+        isDismissible: parameters.isDismissible,
+        isEnabled: parameters.isEnabled,
+        visibility: parameters.visibility,
+      },
+    };
+
+    return this.client.sendRequest(config, callback);
+  }
+}

src/version2/announcementBanner.ts

@@ -1,5 +1,6 @@
 import { BaseClient } from '../../clients';
 import {
+  AnnouncementBanner,
   ApplicationRoles,
   AppMigration,
   AppProperties,
@@ -68,6 +69,7 @@ import {
   ScreenTabFields,
   ScreenTabs,
   ServerInfo,
+  Status,
   Tasks,
   TimeTracking,
   UserProperties,
@@ -85,6 +87,7 @@ import {
 } from '..';
 
 export class Version2Client extends BaseClient {
+  announcementBanner = new AnnouncementBanner(this);
   applicationRoles = new ApplicationRoles(this);
   appMigration = new AppMigration(this);
   appProperties = new AppProperties(this);
@@ -153,6 +156,7 @@ export class Version2Client extends BaseClient {
   screenTabFields = new ScreenTabFields(this);
   screenTabs = new ScreenTabs(this);
   serverInfo = new ServerInfo(this);
+  status = new Status(this);
   tasks = new Tasks(this);
   timeTracking = new TimeTracking(this);
   userProperties = new UserProperties(this);

src/version2/client/version2Client.ts

@@ -161,6 +161,7 @@ export class Dashboards {
         accountId: parameters?.accountId,
         owner: parameters?.owner,
         groupname: parameters?.groupname,
+        groupId: parameters?.groupId,
         projectId: parameters?.projectId,
         orderBy: parameters?.orderBy,
         startAt: parameters?.startAt,

src/version2/dashboards.ts

@@ -1,3 +1,4 @@
+export * from './announcementBanner';
 export * from './appMigration';
 export * from './appProperties';
 export * from './applicationRoles';
@@ -66,6 +67,7 @@ export * from './screenTabFields';
 export * from './screenTabs';
 export * from './screens';
 export * from './serverInfo';
+export * from './status';
 export * from './tasks';
 export * from './timeTracking';
 export * from './userProperties';

src/version2/index.ts

@@ -3,13 +3,20 @@ export type ActorInputBean = ActorInput;
 
 export interface ActorInput {
   /**
-   * The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For example,
-   * `"user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"]`.
+   * The account IDs of the users to add as default actors. This parameter accepts a comma-separated list. For
+   * example, `"user":["5b10a2844c20165700ede21g", "5b109f2e9729b51b54dc274d"]`.
    */
   user?: string[];
   /**
-   * The name of the group to add as a default actor. This parameter accepts a comma-separated list. For example,
-   * `"group":["project-admin", "jira-developers"]`.
+   * The ID of the group to add as a default actor. This parameter cannot be used with the `group` parameter This
+   * parameter accepts a comma-separated list. For example, `"groupId":["77f6ab39-e755-4570-a6ae-2d7a8df0bcb8",
+   * "0c011f85-69ed-49c4-a801-3b18d0f771bc"]`.
+   */
+  groupId?: string[];
+  /**
+   * The name of the group to add as a default actor. This parameter cannot be used with the `groupId` parameter. As a
+   * group's name can change,use of `groupId` is recommended. This parameter accepts a comma-separated list. For
+   * example, `"group":["project-admin", "jira-developers"]`.
    */
   group?: string[];
 }

src/version2/models/actorInput.ts

@@ -1,6 +1,11 @@
 export interface ActorsMap {
   /** The user account ID of the user to add. */
   user?: string[];
-  /** The name of the group to add. */
+  /**
+   * The name of the group to add. This parameter cannot be used with the `groupId` parameter. As a group's name can
+   * change, use of `groupId` is recommended.
+   */
   group?: string[];
+  /** The ID of the group to add. This parameter cannot be used with the `group` parameter. */
+  groupId?: string[];
 }