@xboxreplay/xboxlive-auth - npm Package Compare versions

Comparing version 4.0.0-beta.5 to 4.0.0

dist/core/live/index.js

@@ -98,2 +98,3 @@ "use strict";
             Accept: 'application/json',
+            'Accept-Encoding': 'identity',
             'Content-Type': 'application/x-www-form-urlencoded'
@@ -153,2 +154,3 @@ }),
         headers: utils_1.getBaseHeaders({
+            'Accept-Encoding': 'identity',
             'Content-Type': 'application/x-www-form-urlencoded',
@@ -155,0 +157,0 @@ Cookie: preAuthResponse.cookie

dist/core/xboxlive/index.js

@@ -40,3 +40,3 @@ "use strict";
 const config_2 = __importDefault(require("../../config"));
-const XBLContractVersion = 0;
+const XBLContractVersion = 2;
 const XBLAdditionalHeaders = {
@@ -43,0 +43,0 @@ Accept: 'application/json',

package.json

 {
 	"name": "@xboxreplay/xboxlive-auth",
 	"description": "A light but advanced Xbox Live authentication module with OAuth2.0 and Electron support",
-	"version": "4.0.0-beta.5",
+	"version": "4.0.0",
 	"keywords": [
@@ -25,3 +25,3 @@ "xboxreplay",
 		"build": "npm run clean && ./node_modules/.bin/tsc",
-		"clean": "rm -rf ./dist",
+		"clean": "./node_modules/.bin/rimraf ./dist",
 		"prepublishOnly": "npm run test && npm run build",
@@ -37,2 +37,3 @@ "touch-test-env": "touch .env.test",
 		"dotenv": "^8.2.0",
+		"rimraf": "^3.0.2",
 		"ts-node": "^9.1.1",
@@ -39,0 +40,0 @@ "typescript": "^4.1.3"

README.md

 # @xboxreplay/xboxlive-auth
 
-A light but advanced Xbox Live authentication module with [OAuth2.0](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/02-Custom_Azure_Application.md) and [Electron](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/examples/electron-app) support.
+A light but advanced Xbox Live authentication module with [OAuth2.0](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/02-Custom_Azure_Application.md) and [Electron](https://github.com/XboxReplay/xboxlive-auth/blob/master/examples/electron-app) support.
 
+## Warning
+Due to security reasons ([CORS](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS) for instance), this library has been designed to only run on a **node.js** environment.
+
+## Breaking Changes
+A lot of breaking changes have been made since the latest **3.3.3** release. Please make sure to take a look and follow each step from the [authenticate](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/01-Authenticate.md) documentation.
+
 ## Installation
 
 ```shell
-$ npm install @xboxreplay/xboxlive-auth@4.0.0-beta.5
+$ npm install @xboxreplay/xboxlive-auth
 ```
@@ -28,3 +34,3 @@
     "xsts_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
-    "display_claims": {
+    "display_claims": { // May vary based on the specified "RelyingParty"
         "gtg": "Zeny IC",
@@ -44,17 +50,17 @@ "xid": "2584878536129841",
 
--   [Basic authentication](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/01-Authenticate.md)
--   [Use a custom Azure Application (OAuth2.0)](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/02-Custom_Azure_Application.md)
--   [Experimental methods, such as "deviceToken" generation](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/03-Experimental.md)
--   [What's a RelyingParty and how to use it](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/04-RelyingParty.md)
--   [Available methods in this library](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/05-Methods.md)
--   [Known issues and possible workarounds](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/06-Known_Issues.md)
--   [How to deal with unauthorized "AgeGroup" authentication](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/07-Detect_Unauthorized_AgeGroup.md)
+-   [Basic authentication](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/01-Authenticate.md)
+-   [Use a custom Azure Application (OAuth2.0)](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/02-Custom_Azure_Application.md)
+-   [Experimental methods, such as "deviceToken" generation](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/03-Experimental.md)
+-   [What's a RelyingParty and how to use it](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/04-RelyingParty.md)
+-   [Available methods in this library](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/05-Methods.md)
+-   [Known issues and possible workarounds](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/06-Known_Issues.md)
+-   [How to deal with unauthorized "AgeGroup" authentication](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/07-Detect_Unauthorized_AgeGroup.md)
 
 ## Available Examples
 
--   [Electron App](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/examples/electron-app)
+-   [Electron App](https://github.com/XboxReplay/xboxlive-auth/blob/master/examples/electron-app)
 
 ## How to interact with the Xbox Live API?
 
-The best way to interact with the API is to use our [@xboxreplay/xboxlive-auth](https://github.com/XboxReplay/xboxlive-api) module. That said, a cURL example is available below.
+The best way to interact with the API is to use our [@xboxreplay/xboxlive-auth](https://github.com/XboxReplay/xboxlive-api) module. That said, a cURL example is available below and can be replicated using `axios` or another HTTP client for node.js.
 
@@ -71,7 +77,7 @@ ##### Example
 
-Exposed `authenticate` and `authenticateWithUserCredentials` methods can not deal with 2FA but a workaround is available with the `authenticateWithUserRefreshToken` one. Please take a look at ["Authenticate" documentation](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/01-Authenticate.md).
+Exposed `authenticate` and `authenticateWithUserCredentials` methods can not deal with 2FA but a workaround may be possible using the `authenticateWithUserRefreshToken` one. Please take a look at [authenticate ](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/01-Authenticate.md) documentation. Additional improvements regarding this issue are not planned.
 
 ## Known Issues
 
-Please refer to the [dedicated documention](https://github.com/XboxReplay/xboxlive-auth/tree/4.0.0/docs/06-Known_Issues.md).
+Please refer to the [dedicated documention](https://github.com/XboxReplay/xboxlive-auth/blob/master/docs/06-Known_Issues.md).
 
@@ -78,0 +84,0 @@ ## Licence

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

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

37607

increased by1.67%

Lines of code

713

increased by0.28%

Number of low quality alerts

1

decreased by-50%

Number of lines in readme file

84

increased by7.69%

Worsened metrics

Dev dependency count

5

increased by25%

Number of package files

19

decreased by-5%

No dependency changes