1.7.3 release candidat (#87)

Author: MrRefactoring

CHANGELOG.md

@@ -1,5 +1,11 @@
 # Jira.js changelog
 
+### 1.7.3
+
+- DEPENDENCIES: `atlassian-jwt` installed from npm instead git
+- DEPENDENCIES: Updated dependencies versions
+- README: Contributors section added, small redesign
+
 ### 1.7.2
 
 - FIX: console.log removed

README.md

@@ -1,6 +1,6 @@
-# JavaScript JIRA API Client
+# JavaScript / TypeScript JIRA API Client
 
-A JavaScript/TypeScript wrapper for the JIRA REST API
+A JavaScript / TypeScript wrapper for the JIRA REST API
 
 [![npm](https://img.shields.io/npm/v/jira.js.svg?style=flat-square)](https://www.npmjs.com/package/jira.js)
 [![Downloads](https://img.shields.io/npm/dm/jira.js.svg?style=flat-square)](https://npmjs.com/jira.js)
@@ -28,21 +28,27 @@ yarn add jira.js
 ### Create the JIRA client
 
 ```js
-// ES5
-var { Client } = require("jira.js");
-
-// ES6
 import { Client } from "jira.js";
 
 // Initialize
-var client = new Client({
+const client = new Client({
   host: "https://jira.somehost.com"
 });
 ```
 
-### Get all projects
+### Working with API (How to get a list of all projects, for example)
 
 ```js
+// Callbacks
+client.projects.getAllProjects({}, (err, data) => {
+  if (err) {
+    throw err;
+  }
+
+  console.log(data);
+});
+
+
 // ES5/ES6
 client.projects
   .getAllProjects()
@@ -165,15 +171,29 @@ const client = new Client({
 
 ## Documentation
 
+Library based on [Jira API v2](https://developer.atlassian.com/cloud/jira/platform/rest/v2) and [Jira Agile API](https://developer.atlassian.com/cloud/jira/software/rest)
+
 Can't find what you need in the readme? Check out our documentation here: https://mrrefactoring.github.io/jira.js/
 
+## Contributors
+
+[<img alt="MrRefactoring" src="https://avatars0.githubusercontent.com/u/10329528?v=4&s=117 width=117">](https://github.com/MrRefactoring) |[<img alt="Swapnull" src="https://avatars0.githubusercontent.com/u/4456346?v=4&s=117 width=117">](https://github.com/Swapnull) |[<img alt="violine1101" src="https://avatars0.githubusercontent.com/u/12451842?v=4&s=117 width=117">](https://github.com/violine1101) |
+:---:|:---:|:---:|
+[MrRefactoring](https://github.com/MrRefactoring)|[Swapnull](https://github.com/Swapnull)|[violine1101](https://github.com/violine1101)|
+
 ## Road map
 
-- Response models
-- Method names reducing
+- Response models ([Check 2.0 version PR](https://github.com/MrRefactoring/jira.js/pull/76))
+- Method names reducing ([Check 2.0 version PR](https://github.com/MrRefactoring/jira.js/pull/76))
 
 ## Latest version changelog
 
+### 1.7.3
+
+- DEPENDENCIES: `atlassian-jwt` installed from npm instead git
+- DEPENDENCIES: Updated dependencies versions
+- README: Contributors section added, small redesign
+
 ### 1.7.2
 
 - FIX: console.log removed

package.json

@@ -1,6 +1,6 @@
 {
   "name": "jira.js",
-  "version": "1.7.2",
+  "version": "1.7.3",
   "main": "out/index.js",
   "types": "out/index.d.ts",
   "repository": "https://github.com/MrRefactoring/jira.js.git",
@@ -26,23 +26,24 @@
     "preset": "ts-jest"
   },
   "devDependencies": {
-    "@types/jest": "^26.0.14",
-    "@types/node": "^14.11.2",
-    "@types/sinon": "^9.0.7",
-    "@typescript-eslint/eslint-plugin": "^4.3.0",
-    "@typescript-eslint/parser": "^4.3.0",
-    "eslint": "^7.10.0",
-    "eslint-config-airbnb-typescript": "^11.0.0",
+    "@types/express": "^4.17.8",
+    "@types/jest": "^26.0.15",
+    "@types/node": "^14.14.5",
+    "@types/sinon": "^9.0.8",
+    "@typescript-eslint/eslint-plugin": "^4.6.0",
+    "@typescript-eslint/parser": "^4.6.0",
+    "eslint": "^7.12.1",
+    "eslint-config-airbnb-typescript": "^12.0.0",
     "eslint-import-resolver-typescript": "^2.3.0",
     "eslint-plugin-import": "^2.22.1",
-    "jest": "^26.4.2",
-    "sinon": "^9.1.0",
-    "ts-jest": "^26.4.1",
+    "jest": "^26.6.1",
+    "sinon": "^9.2.1",
+    "ts-jest": "^26.4.3",
     "typedoc": "^0.19.2",
-    "typescript": "^4.0.3"
+    "typescript": "^4.0.5"
   },
   "dependencies": {
-    "atlassian-jwt": "https://github.com/MrRefactoring/atlassian-jwt.git#dist",
-    "axios": "^0.20.0"
+    "atlassian-jwt": "^1.0.3",
+    "axios": "^0.21.0"
   }
 }

src/sender.ts

@@ -1,7 +1,7 @@
-import { AxiosRequestConfig } from 'axios';
+import { Config } from './config';
 import { Callback } from './callback';
 
 export type Sender = {
   [key: string]: any;
-  sendRequest: (request: AxiosRequestConfig, callback?: Callback) => Promise<any>;
+  sendRequest: (request: Config.BaseRequestConfig, callback?: Callback) => Promise<any>;
 };