JSDoc improvements for Agile Cloud Client, AppMigration added (#146)

* JSDoc improvements for Agile Cloud client

* deprecation notes added for some agile models

* appMigration added

* lint fixes

* CHANGELOG for new version added

* version2 api updated. appMigration added

* CHANGELOG for new version added

* 2.5.0

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,48 @@
 # Jira.js changelog
 
+### 2.5.0
+
+- Agile:
+  - JSDoc descriptions improved.
+  - `BoardFeatureBean` are deprecated. Use `Feature` instead.
+  - `BoardFeatureResponseBean` are deprecated. Use `FeatureResponse` instead.
+  - `BoardFeatureToggleRequestBean` are deprecated. Use `FeatureToggleRequest` instead.
+  - Other minor improvements
+
+
+- Version 3:
+  - JSDoc descriptions improved.
+  - `AppMigration` API support added.
+  - `generateChangelog` property added to `IssueCustomFieldValuesApps.updateCustomFieldValue` request parameters.
+  - `hierarchyLevel` property added to `IssueTypes.createIssueType`.
+  - `getChangeLogsByIds` method added to `Issues`.
+  - New models added:
+    - `ConnectCustomFieldValue`
+    - `ConnectCustomFieldValues`
+    - `EntityPropertyDetails`
+    - `IssueChangelogIds`
+    - `GetChangeLogsByIds`
+  - Mistake in `CrateWorkflowStatusDetails` fixed. Current name is correct: `CreateWorkflowStatusDetails`.
+  - `fieldIdsFilter`, `issuePropertyKeysFilter` properties added to `Webhook` and `WebhookDetails` models.
+  - Other minor improvements
+
+- Version 2:
+  - JSDoc descriptions improved.
+  - `AppMigration` API support added.
+  - `generateChangelog` property added to `IssueCustomFieldValuesApps.updateCustomFieldValue` request parameters.
+  - `hierarchyLevel` property added to `IssueTypes.createIssueType`.
+  - `getChangeLogsByIds` method added to `Issues`.
+  - New models added:
+    - `ConnectCustomFieldValue`
+    - `ConnectCustomFieldValues`
+    - `EntityPropertyDetails`
+    - `IssueChangelogIds`
+    - `PageBeanContextualConfiguration`
+    - `GetChangeLogsByIds`
+  - Mistake in `CrateWorkflowStatusDetails` fixed. Current name is correct: `CreateWorkflowStatusDetails`.
+  - `fieldIdsFilter`, `issuePropertyKeysFilter` properties added to `Webhook` and `WebhookDetails` models.
+  - Other minor improvements
+
 ### 2.4.2
 
 - [#144](https://github.com/MrRefactoring/jira.js/issues/144) Fixed error when tried vote issue. Thanks [João Lopes](https://github.com/lopis)!

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "2.4.2",
+  "version": "2.5.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",
@@ -44,11 +44,11 @@
   "devDependencies": {
     "@types/express": "^4.17.13",
     "@types/jest": "^26.0.24",
-    "@types/node": "^16.0.1",
+    "@types/node": "^16.3.3",
     "@types/oauth": "^0.9.1",
     "@types/sinon": "^10.0.2",
-    "@typescript-eslint/eslint-plugin": "^4.28.2",
-    "@typescript-eslint/parser": "^4.28.2",
+    "@typescript-eslint/eslint-plugin": "^4.28.3",
+    "@typescript-eslint/parser": "^4.28.3",
     "dotenv": "^10.0.0",
     "eslint": "^7.30.0",
     "eslint-config-airbnb-typescript": "^12.3.1",
@@ -59,7 +59,7 @@
     "prettier-plugin-jsdoc": "^0.3.23",
     "sinon": "^11.1.1",
     "ts-jest": "^26.5.6",
-    "typedoc": "^0.21.2",
+    "typedoc": "^0.21.4",
     "typescript": "^4.3.5"
   },
   "dependencies": {

package.json

@@ -1,5 +1,4 @@
-/**
- * Details about the avatars for an item. */
+/** Details about the avatars for an item. */
 export interface AvatarUrls {
   /** The URL of the item's 16x16 pixel avatar. */
   '16x16'?: string;

src/agile/models/avatarUrls.ts

@@ -1,17 +1,38 @@
 /**
- * Details of a user's active status, identifiers, name, and avatars as permitted by the user's Atlassian Account privacy settings. However, be aware of these exceptions:<ul><li>User record deleted from Atlassian: This occurs as the result of a right to be forgotten request. In this case, <code>displayName</code> provides an indication and other parameters have default values or are blank (for example, email is blank).</li><li>User record corrupted: This occurs as a results of events such as a server import and can only happen to deleted users. In this case, <code>accountId</code> returns <em>unknown</em> and all other parameters have fallback values.</li><li>User record unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback values.</li></ul> */
+ * Details of a user's active status, identifiers, name, and avatars as permitted by the user's Atlassian Account
+ * privacy settings. However, be aware of these exceptions:<ul><li>User record deleted from Atlassian: This occurs as
+ * the result of a right to be forgotten request. In this case, <code>displayName</code> provides an indication and
+ * other parameters have default values or are blank (for example, email is blank).</li><li>User record corrupted: This
+ * occurs as a results of events such as a server import and can only happen to deleted users. In this case,
+ * <code>accountId</code> returns <em>unknown</em> and all other parameters have fallback values.</li><li>User record
+ * unavailable: This usually occurs due to an internal service outage. In this case, all parameters have fallback
+ * values.</li></ul>
+ */
 export interface BasicUser {
-  /** This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration guide</a> for details. <br>The key of the user. */
+  /**
+   * @deprecated
+   * This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a
+   * href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration
+   * guide</a> for details. <br>The key of the user.
+   */
   key?: string;
   /** The URL of the user. */
   self?: string;
-  /** This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration guide</a> for details. <br>The username of the user. */
+  /**
+   * @deprecated
+   * This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a
+   * href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration
+   * guide</a> for details. <br>The username of the user.
+   */
   name?: string;
   /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
   displayName?: string;
   /** Whether the user is active. */
   active?: boolean;
-  /** The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, <em>5b10ac8d82e05b22cc7d4ef5</em>. */
+  /**
+   * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
+   * <em>5b10ac8d82e05b22cc7d4ef5</em>.
+   */
   accountId?: string;
   /** Details of a user's avatars. */
   avatarUrls?: {

src/agile/models/basicUser.ts

@@ -1,16 +1,29 @@
 export interface BoardAdminsBean {
   users?: {
-    /** This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration guide</a> for details. <br>The key of the user. */
+    /**
+     * @deprecated
+     * This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a
+     * href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration
+     * guide</a> for details. <br>The key of the user.
+     */
     key?: string;
     /** The URL of the user. */
     self?: string;
-    /** This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration guide</a> for details. <br>The username of the user. */
+    /**
+     * @deprecated
+     * This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a
+     * href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration
+     * guide</a> for details. <br>The username of the user.
+     */
     name?: string;
     /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
     displayName?: string;
     /** Whether the user is active. */
     active?: boolean;
-    /** The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, <em>5b10ac8d82e05b22cc7d4ef5</em>. */
+    /**
+     * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
+     * <em>5b10ac8d82e05b22cc7d4ef5</em>.
+     */
     accountId?: string;
     /** Details of a user's avatars. */
     avatarUrls?: {

src/agile/models/boardAdminsBean.ts

@@ -5,17 +5,30 @@ export interface BoardBean {
   type?: string;
   admins?: {
     users?: {
-      /** This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration guide</a> for details. <br>The key of the user. */
+      /**
+       * @deprecated
+       * This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a
+       * href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration
+       * guide</a> for details. <br>The key of the user.
+       */
       key?: string;
       /** The URL of the user. */
       self?: string;
-      /** This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration guide</a> for details. <br>The username of the user. */
+      /**
+       * @deprecated
+       * This property is deprecated in favor of <code>accountId</code> because of privacy changes. See the <a
+       * href="https://developer.atlassian.com/cloud/jira/platform/deprecation-notice-user-privacy-api-migration-guide/">migration
+       * guide</a> for details. <br>The username of the user.
+       */
       name?: string;
       /** The display name of the user. Depending on the user’s privacy setting, this may return an alternative value. */
       displayName?: string;
       /** Whether the user is active. */
       active?: boolean;
-      /** The account ID of the user, which uniquely identifies the user across all Atlassian products. For example, <em>5b10ac8d82e05b22cc7d4ef5</em>. */
+      /**
+       * The account ID of the user, which uniquely identifies the user across all Atlassian products. For example,
+       * <em>5b10ac8d82e05b22cc7d4ef5</em>.
+       */
       accountId?: string;
       /** Details of a user's avatars. */
       avatarUrls?: {

src/agile/models/boardBean.ts

@@ -1,3 +1,4 @@
+/** @deprecated Use *Feature* model instead. */
 export interface BoardFeatureBean {
   boardFeature?: string;
   boardId?: number;

src/agile/models/boardFeatureBean.ts

@@ -1,3 +1,4 @@
+/** @deprecated Use *FeatureResponse* model instead. */
 export interface BoardFeatureResponseBean {
   features?: {
     boardFeature?: string;

src/agile/models/boardFeatureResponseBean.ts

@@ -1,3 +1,4 @@
+/** @deprecated Use *FeatureToggleRequest* model instead. */
 export interface BoardFeatureToggleRequestBean {
   boardId?: number;
   feature?: string;