simple-oauth2 - npm Package Compare versions

Comparing version 2.5.1 to 2.5.2

CHANGELOG.md

 # Changelog
 
+## 2.5.2
+
+### Publishing changes
+
+* [#262](https://github.com/lelylan/simple-oauth2/pull/262) Use files package option instead of .npmignore
+
+### Documentation improvements
+
+* [#267](https://github.com/lelylan/simple-oauth2/pull/267) Better document encoding of values for the token exchange process
+
 ## 2.5.1
@@ -4,0 +14,0 @@ ### New examples

lib/encoding.js

@@ -6,2 +6,10 @@ 'use strict';
 module.exports = {
+  /**
+   * Encode a single {value} using the application/x-www-form-urlencoded media type
+   * while also applying some additional rules specified by the spec
+   *
+   * @see https://tools.ietf.org/html/rfc6749#appendix-B
+   *
+   * @param {String} value
+   */
   useFormURLEncode(value) {
@@ -8,0 +16,0 @@ return encodeURIComponent(value).replace(/%20/g, '+');

package.json

 {
   "name": "simple-oauth2",
-  "version": "2.5.1",
+  "version": "2.5.2",
   "description": "Node.js client for OAuth2",
@@ -11,2 +11,5 @@ "author": "Andrea Reginato <[e-mail]>",
   "main": "index.js",
+  "files": [
+    "lib"
+  ],
   "repository": {
@@ -13,0 +16,0 @@ "type": "git",

README.md

@@ -31,19 +31,22 @@ # Simple OAuth2
 
-- [Requirements](#requirements)
-- [Getting started](#getting-started)
-  - [Installation](#installation)
-  - [Options](#options)
-  - [Example of Usage](#example-of-usage)
-- [OAuth2 Supported flows](#oauth2-supported-flows)
-  - [Authorization Code flow](#authorization-code-flow)
-  - [Password Credentials Flow](#password-credentials-flow)
-  - [Client Credentials Flow](#client-credentials-flow)
-- [Helpers](#helpers)
-  - [Access Token object](#access-token-object)
-  - [Errors](#errors)
-- [Contributing](#contributing)
-- [Authors](#authors)
-  - [Contributors](#contributors)
-- [Changelog](#changelog)
-- [License](#license)
+- [Simple OAuth2](#simple-oauth2)
+      - [Thanks to Open Source](#thanks-to-open-source)
+  - [Table of Contents](#table-of-contents)
+  - [Requirements](#requirements)
+  - [Getting started](#getting-started)
+    - [Installation](#installation)
+    - [Options](#options)
+    - [Example of Usage](#example-of-usage)
+  - [OAuth2 Supported flows](#oauth2-supported-flows)
+    - [Authorization Code flow](#authorization-code-flow)
+    - [Password Credentials Flow](#password-credentials-flow)
+    - [Client Credentials Flow](#client-credentials-flow)
+  - [Helpers](#helpers)
+    - [Access Token object](#access-token-object)
+    - [Errors](#errors)
+  - [Contributing](#contributing)
+  - [Authors](#authors)
+    - [Contributors](#contributors)
+  - [Changelog](#changelog)
+  - [License](#license)
 
@@ -73,4 +76,4 @@ <!-- END doctoc generated TOC please keep comment here to allow auto update -->
 * `client` - required object with the following properties:
-  * `id` - Service registered client id. Required.
-  * `secret` - Service registered client secret. Required.
+  * `id` - Service registered client id. When required by the [spec](https://tools.ietf.org/html/rfc6749#appendix-B) this value will be automatically encoded. Required.
+  * `secret` - Service registered client secret. When required by the [spec](https://tools.ietf.org/html/rfc6749#appendix-B) this value will be automatically encoded. Required.
   * `secretParamName` - Parameter name used to send the client secret. Default to **client_secret**.
@@ -87,3 +90,3 @@ * `idParamName` - Parameter name used to send the client id. Default to **client_id**.
 * `http` optional object used to set global options to the internal http library ([wreck](https://github.com/hapijs/wreck)).
-  * All options except **baseUrl** are allowed. Default to `headers.Accept = application/json`.
+  * All options except **baseUrl** are allowed. `headers.authorization` will always be overriden by the library to properly send the required credentials on each scenario. Default to `headers.Accept = application/json`.
 
@@ -90,0 +93,0 @@ * `options` optional object to setup the module.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

328

increased by0.92%

Worsened metrics

Total package byte prevSize

29809

decreased by-89.24%

Number of package files

11

decreased by-77.08%

Lines of code

310

decreased by-61.73%

No dependency changes