npm - halo-infinite-api - Versions diffs - 2.1.0 → 3.0.0 - Mend

halo-infinite-api 2.1.0 → 3.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (10) hide show

package/README.md CHANGED Viewed

@@ -1,17 +1,21 @@
 # Halo Infinite API
-This is a simple typescript wrapper around 343's official Halo Infinite API (the same API that powers both the game and [halowaypoint.com](https://www.halowaypoint.com/)).I based it off the work of the now mysteriously deleted C# Grunt API (a defunct fork of which remains [here](https://github.com/seth-skocelas/grunt/)).
+This is a simple typescript wrapper around 343's official Halo Infinite API (the same API that powers both the game and [halowaypoint.com](https://www.halowaypoint.com/)). I based it off the work of the now mysteriously deleted C# Grunt API (a defunct fork of which remains [here](https://github.com/seth-skocelas/grunt/)).
 The package is currently limited to the endpoints I've needed to use in other projects, however I do take requests (create an [issue](/issues)) and I welcome [PRs to extend the functionality](/pulls).
 ### Currently Supported Endpoints
 - GET https://profile.svc.halowaypoint.com/users/{gamerTag}
+- GET https://profile.svc.halowaypoint.com/users?xuids={xuids}
 - GET https://skill.svc.halowaypoint.com/hi/playlist/{playlistId}/csrs?players={playerIds}
 - GET https://gamecms-hacs.svc.halowaypoint.com/hi/multiplayer/file/playlists/assets/{playlistId}.json
 - GET https://halostats.svc.halowaypoint.com/hi/playlist/{playlistId}/csrs?players={playerIds}
 - GET https://halostats.svc.halowaypoint.com/hi/players/xuid({playerId})/matches
 - GET https://skill.svc.halowaypoint.com/hi/matches/{matchId}/skill
+- GET https://halostats.svc.halowaypoint.com/hi/matches/{matchId}/stats
+- GET https://discovery-infiniteugc.svc.halowaypoint.com/hi/{assetType}/{assetId}
+- GET https://discovery-infiniteugc.svc.halowaypoint.com/hi/{assetType}/{assetId}/versions/{versionId}
 ### Getting Started
@@ -19,46 +23,42 @@ The core requirement to use the endpoints in the library is to have a Spartan to
 > **⚠️ WARNING**
 >
-> The Spartan token is associated with _your identity_ and _your account_. **Do not share it** with anyone, under any circumstances. The API wrapper does not explicitly store it anywhere. It's your responsibility to make sure that it's secure and not available to anyone else.
+> The Spartan token is associated with _your identity_ and _your account_. **Do not share it** with anyone, under any circumstances. The API wrapper does not explicitly store it anywhere (though you can configure it to store it somewhere of your choosing). It's your responsibility to make sure that it's secure and not available to anyone else.
-If you want to automatically generate the Spartan token, you can do so with the help of this package without having to worry about doing any of the REST API calls yourself. Before you get started, make sure that you [register an Azure Active Directory application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app). You will need it in order to log in with your Microsoft account, that will be used to generate the token. Because this is just for you, you can use `https://localhost` as the redirect URI when you create the application, unless you're thinking of productizing whatever you're building.
+This library does not provide a way to perform the first step of generating a spartan token, which is to get an Oauth2 access token from Microsoft. Microsoft provides a great set of npm packages for this purpose, [@azure/msal-node](https://www.npmjs.com/package/@azure/msal-node), [@azure/msal-browser](https://www.npmjs.com/package/@azure/msal-browser), [@azure/msal-react](https://www.npmjs.com/package/@azure/msal-react), etc. depending on the flavor of your application.
-Once you have the application registered, you can use the following code to automatically generate the token and call endpoints:
+Make sure that you [register an Azure Active Directory application](https://docs.microsoft.com/azure/active-directory/develop/quickstart-register-app), as that is how you will make use of the @azure/msal packages.
+Below is a simple example of how this library might be used in a console application to get a user's profile:
 ```typescript
-import { HaloInfiniteClient } from "halo-infinite-api";
+import open from "open"; // An npm package that opens a browser window
+import * as msal from "@azure/msal-node";
+import { HaloInfiniteClient, AutoXstsSpartanTokenProvider } from "halo-infinite-api";
+const oauthApplication = new msal.PublicClientApplication({
+  auth: {
+    clientId: "42081d3d-4465-4c86-89ba-ea546f825335",
+    authority: "https://login.live.com", // Override the default authority with the xbox one
+    knownAuthorities: ["login.live.com"],
+    protocolMode: "OIDC", // Shit, I actually have no idea what this does, but Microsoft says I need it
+  },
+});
 const client = new HaloInfiniteClient(
-  "<YOUR_CLIENT_ID_FROM_AAD>",
-  "<YOUR_REDIRECT_URI_FROM_AAD>",
-  async (authorizeUrl: string) => {
-    // A function that transforms the authorization URL into an authorization code.
-    // The implementation will vary depending on your use case. This example is how
-    // a firefox addon would accomplish the task
-    const activeAuthUrl = await browser.identity.launchWebAuthFlow({
-      url: authorizeUrl,
-      interactive: true,
+  // Other choice for token providers is the StaticXstsTicketTokenSpartanTokenProvider,
+  // which uses a preset spartan token
+  new AutoXstsSpartanTokenProvider(async () => {
+    const token = await oauthApplication.acquireTokenInteractive({
+      // offline_access gives us a refresh token which we can use to continually
+      // get new credentials from Microsoft as the old ones expire.
+      scopes: ["Xboxlive.signin", "Xboxlive.offline_access"],
+      openBrowser: async (url) => {
+        await open(url);
+      },
     });
-    return new URL(activeAuthUrl).searchParams.get("code")!;
-  },
-  // This final parameter is optional, but it allows your HaloInfiniteClient
-  // to save tokens somewhere so that you don't need to refetch them every time
-  // you restart your application.
-  // Again, this is an example for a firefox addon using browser storage.
-  {
-    load: async (tokenName) => {
-      const storageResponse = await browser.storage.local.get(tokenName);
-      if (!storageResponse[tokenName]) {
-        return null;
-      } else {
-        return storageResponse[tokenName];
-      }
-    },
-    save: async (tokenName, token) => {
-      await browser.storage.local.set({ [tokenName]: token });
-    },
-  }
+    return token.accessToken;
+  })
 );
 const user = await client.getUser("GravlLift");

package/dist/authentication/xbox-authentication-client.d.ts CHANGED Viewed

@@ -10,19 +10,11 @@ export interface XboxAuthenticationToken {
     refreshToken: string;
 }
 export declare class XboxAuthenticationClient {
-    private readonly clientId;
-    private readonly redirectUri;
-    private readonly getAuthCode;
     private readonly tokenPersister?;
-    private accessTokenPromise;
     private userTokenCache;
     private xstsTicketCache;
     private readonly httpClient;
-    constructor(clientId: string, redirectUri: string, getAuthCode: (authorizeUrl: string) => Promise<string>, tokenPersister?: TokenPersister | undefined);
-    private getPkce;
-    getAccessToken(): Promise<string>;
-    private fetchOauth2Token;
-    private refreshOAuth2Token;
+    constructor(tokenPersister?: TokenPersister | undefined);
     getUserToken(accessToken: string): Promise<string>;
     getXstsTicket(userToken: string, relyingParty: RelyingParty): Promise<{
         expiresAt: DateTime;

package/dist/authentication/xbox-authentication-client.js CHANGED Viewed

@@ -1,21 +1,14 @@
 import axios from "axios";
-import pkceChallenge from "pkce-challenge";
 import { DateTime } from "luxon";
 import { coalesceDateTime } from "../util/date-time";
-import { ResolvablePromise } from "../util/resolvable-promise";
 import { ExpiryTokenCache } from "../util/expiry-token-cache";
-const SCOPES = ["Xboxlive.signin", "Xboxlive.offline_access"];
 export var RelyingParty;
 (function (RelyingParty) {
     RelyingParty["Xbox"] = "http://xboxlive.com";
     RelyingParty["Halo"] = "https://prod.xsts.halowaypoint.com/";
 })(RelyingParty || (RelyingParty = {}));
 export class XboxAuthenticationClient {
-    clientId;
-    redirectUri;
-    getAuthCode;
     tokenPersister;
-    accessTokenPromise = undefined;
     userTokenCache = new ExpiryTokenCache(async (accessToken) => {
         const persistedToken = await this.tokenPersister?.load("xbox.userToken");
         if (persistedToken?.expiresAt) {
@@ -76,121 +69,10 @@ export class XboxAuthenticationClient {
         return result;
     });
     httpClient;
-    constructor(clientId, redirectUri, getAuthCode, tokenPersister) {
-        this.clientId = clientId;
-        this.redirectUri = redirectUri;
-        this.getAuthCode = getAuthCode;
+    constructor(tokenPersister) {
         this.tokenPersister = tokenPersister;
         this.httpClient = axios.create();
     }
-    getPkce() {
-        if (typeof pkceChallenge === "function") {
-            return pkceChallenge(43);
-        }
-        else {
-            return pkceChallenge.default(43);
-        }
-    }
-    async getAccessToken() {
-        if (this.accessTokenPromise) {
-            // Someone either already has a token or is in the process of getting one
-            // Wait for them to finish, then check for validity
-            const currentToken = await this.accessTokenPromise;
-            if (currentToken.expiresAt > DateTime.now()) {
-                // Current token is valid, return it
-                return currentToken.token;
-            }
-            else {
-                // Current token expired, start a new promise
-                this.accessTokenPromise =
-                    new ResolvablePromise();
-                try {
-                    const newToken = await this.refreshOAuth2Token(currentToken.refreshToken);
-                    this.accessTokenPromise.resolve(newToken);
-                    await this.tokenPersister?.save("xbox.accessToken", newToken);
-                    return newToken.token;
-                }
-                catch (e) {
-                    this.accessTokenPromise.reject(e);
-                    throw e;
-                }
-            }
-        }
-        else {
-            // We are the first caller, create a promise to block subsequent callers
-            this.accessTokenPromise =
-                new ResolvablePromise();
-            try {
-                const loadedToken = await this.tokenPersister?.load("xbox.accessToken");
-                const currentToken = {
-                    ...loadedToken,
-                    token: loadedToken?.token ?? "",
-                    expiresAt: coalesceDateTime(loadedToken?.expiresAt),
-                };
-                if (currentToken.expiresAt && currentToken.expiresAt > DateTime.now()) {
-                    // Current token is valid, return it and alert other callers if applicable
-                    this.accessTokenPromise.resolve(currentToken);
-                    return currentToken.token;
-                }
-                else {
-                    const newToken = await this.fetchOauth2Token();
-                    this.accessTokenPromise.resolve(newToken);
-                    await this.tokenPersister?.save("xbox.accessToken", newToken);
-                    return newToken.token;
-                }
-            }
-            catch (e) {
-                this.accessTokenPromise.reject(e);
-                throw e;
-            }
-        }
-    }
-    async fetchOauth2Token() {
-        const { code_verifier, code_challenge } = this.getPkce();
-        const authorizeUrl = `https://login.live.com/oauth20_authorize.srf?${new URLSearchParams({
-            client_id: this.clientId,
-            response_type: "code",
-            redirect_uri: this.redirectUri,
-            scope: SCOPES.join(" "),
-            code_challenge_method: "S256",
-            code_challenge,
-        })}`;
-        const code = await this.getAuthCode(authorizeUrl);
-        const requestStart = DateTime.now();
-        const response = await this.httpClient.post("https://login.live.com/oauth20_token.srf", new URLSearchParams({
-            grant_type: "authorization_code",
-            code,
-            approval_prompt: "auto",
-            scope: SCOPES.join(" "),
-            redirect_uri: this.redirectUri,
-            client_id: this.clientId,
-            code_verifier,
-        }), {
-            headers: { "Content-Type": "application/x-www-form-urlencoded" },
-        });
-        return {
-            token: response.data.access_token,
-            expiresAt: requestStart.plus({ seconds: response.data.expires_in }),
-            refreshToken: response.data.refresh_token,
-        };
-    }
-    async refreshOAuth2Token(refreshToken) {
-        const requestStart = DateTime.now();
-        const response = await this.httpClient.post("https://login.live.com/oauth20_token.srf", new URLSearchParams({
-            grant_type: "refresh_token",
-            refresh_token: refreshToken,
-            scope: SCOPES.join(" "),
-            redirect_uri: this.redirectUri,
-            client_id: this.clientId,
-        }), {
-            headers: { "Content-Type": "application/x-www-form-urlencoded" },
-        });
-        return {
-            token: response.data.access_token,
-            expiresAt: requestStart.plus({ seconds: response.data.expires_in }),
-            refreshToken: response.data.refresh_token,
-        };
-    }
     async getUserToken(accessToken) {
         const { Token } = await this.userTokenCache.getToken(accessToken);
         return Token;

package/dist/authentication/xbox-authentication-client.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"xbox-authentication-client.js","sourceRoot":"","sources":["../../src/authentication/xbox-authentication-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAwB,MAAM,OAAO,CAAC;AAC7C,OAAO,~~aAAa,MAAM,gBAAgB,CAAC;AAC3C,OAAO,~~EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;~~AAEjC~~,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,~~iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAC/D,OAAO,EAAE,~~gBAAgB,EAAE,MAAM,4BAA4B,CAAC;~~AAG9D,MAAM,MAAM,GAAG,CAAC,iBAAiB,EAAE,yBAAyB,CAAC,CAAC;~~AAE9D,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,4CAA4B,CAAA;IAC5B,4DAA4C,CAAA;AAC9C,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAQD,MAAM,OAAO,wBAAwB;~~IAuFhB~~;~~IACA;IACA;IACA;IAzFX~~,~~kBAAkB,GAEV,SAAS,CAAC;IAClB,~~cAAc,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,WAAmB,EAAE,EAAE;QAC1E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAEpD,gBAAgB,CAAC,CAAC;QAEpB,IAAI,cAAc,EAAE,SAAS,EAAE;YAC7B,MAAM,SAAS,GAAG,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC7D,IAAI,SAAS,IAAI,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE;gBAC3C,OAAO,EAAE,GAAG,cAAc,EAAE,SAAS,EAAE,CAAC;aACzC;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACzC,kDAAkD,EAClD;YACE,YAAY,EAAE,0BAA0B;YACxC,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE,wBAAwB;gBAClC,SAAS,EAAE,KAAK,WAAW,EAAE;aAC9B;SACF,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,wBAAwB,EAAE,GAAG;aAC9B;SACF,CACF,CAAC;QAEF,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ,CAAC,IAAI;YAChB,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;SACpD,CAAC;QACF,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IACK,eAAe,GAAG,IAAI,gBAAgB,CAC5C,KAAK,EAAE,SAAiB,EAAE,YAA0B,EAAE,EAAE;QACtD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAEpD,iBAAiB,CAAC,CAAC;QAErB,IAAI,cAAc,EAAE,SAAS,EAAE;YAC7B,MAAM,SAAS,GAAG,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC7D,IAAI,SAAS,IAAI,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE;gBAC3C,OAAO,EAAE,GAAG,cAAc,EAAE,SAAS,EAAE,CAAC;aACzC;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACzC,+CAA+C,EAC/C;YACE,YAAY,EAAE,YAAY;YAC1B,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE;gBACV,SAAS,EAAE,QAAQ;gBACnB,UAAU,EAAE,CAAC,SAAS,CAAC;aACxB;SACF,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,wBAAwB,EAAE,GAAG;aAC9B;SACF,CACF,CAAC;QAEF,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ,CAAC,IAAI;YAChB,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;SACpD,CAAC;QACF,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QAC3D,OAAO,MAAM,CAAC;IAChB,CAAC,CACF,CAAC;IAEe,UAAU,CAAgB;IAE3C,~~YACmB~~,~~QAAgB,EAChB,WAAmB,EACnB,WAAsD,EACtD,~~cAA+B;~~QAH~~/B,~~aAAQ,GAAR,QAAQ,CAAQ;QAChB,gBAAW,GAAX,WAAW,CAAQ;QACnB,gBAAW,GAAX,WAAW,CAA2C;QACtD,~~mBAAc,GAAd,cAAc,CAAiB;~~QAEhD~~,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;~~IAEO,OAAO;QAGb,IAAI,OAAO,aAAa,KAAK,UAAU,EAAE;YACvC,OAAO,aAAa,CAAC,EAAE,CAAC,CAAC;SAC1B;aAAM;YACL,OAAQ,aAA4C,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;SAClE;IACH,CAAC;~~IAEM,KAAK,CAAC,~~cAAc;QACzB,IAAI,IAAI,CAAC,kBAAkB,EAAE;YAC3B,yEAAyE;YACzE,mDAAmD;YACnD,MAAM,~~YAAY,~~GAAG,MAAM,IAAI,~~CAAC,kBAAkB,CAAC;YAEnD,IAAI,YAAY,CAAC,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE;gBAC3C,oCAAoC;gBACpC,OAAO,YAAY,CAAC,KAAK,CAAC;aAC3B;iBAAM;gBACL,6CAA6C;gBAC7C,IAAI,CAAC,kBAAkB;oBACrB,IAAI,iBAAiB,EAA2B,CAAC;gBAEnD,IAAI;oBACF,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,kBAAkB,CAC5C,YAAY,CAAC,YAAY,CAC1B,CAAC;oBACF,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC1C,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;oBAC9D,OAAO,QAAQ,CAAC,KAAK,CAAC;iBACvB;gBAAC,OAAO,CAAC,EAAE;oBACV,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;oBAClC,MAAM,CAAC,CAAC;iBACT;aACF;SACF;aAAM;YACL,wEAAwE;YACxE,IAAI,CAAC,kBAAkB;gBACrB,IAAI,iBAAiB,EAA2B,CAAC;YAEnD,IAAI;gBACF,MAAM,WAAW,GACf,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAC7B,kBAAkB,CACnB,CAAC;gBACJ,MAAM,YAAY,GAAG;oBACnB,GAAG,WAAW;oBACd,KAAK,EAAE,WAAW,EAAE,KAAK,IAAI,EAAE;oBAC/B,SAAS,EAAE,gBAAgB,CAAC,WAAW,EAAE,SAAS,CAAC;iBACpD,CAAC;gBAEF,IAAI,YAAY,CAAC,SAAS,IAAI,YAAY,CAAC,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE;oBACrE,0EAA0E;oBAC1E,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAC7B,YAAuC,CACxC,CAAC;oBACF,OAAO,YAAY,CAAC,KAAK,CAAC;iBAC3B;qBAAM;oBACL,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,gBAAgB,EAAE,CAAC;oBAC/C,IAAI,CAAC,kBAAkB,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;oBAC1C,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,kBAAkB,EAAE,QAAQ,CAAC,CAAC;oBAC9D,OAAO,QAAQ,CAAC,KAAK,CAAC;iBACvB;aACF;YAAC,OAAO,CAAC,EAAE;gBACV,IAAI,CAAC,kBAAkB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;gBAClC,MAAM,CAAC,CAAC;aACT;SACF;IACH,CAAC;IAEO,KAAK,CAAC,gBAAgB;QAC5B,MAAM,EAAE,aAAa,EAAE,cAAc,EAAE,GAAG,IAAI,CAAC,OAAO,EAAE,CAAC;QAEzD,MAAM,YAAY,GAAG,gDAAgD,IAAI,eAAe,CACtF;YACE,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,aAAa,EAAE,MAAM;YACrB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACvB,qBAAqB,EAAE,MAAM;YAC7B,cAAc;SACf,CACF,EAAE,CAAC;QAEJ,MAAM,IAAI,GAAG,MAAM,IAAI,CAAC,WAAW,CAAC,YAAY,CAAC,CAAC;QAElD,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAQzC,0CAA0C,EAC1C,IAAI,eAAe,CAAC;YAClB,UAAU,EAAE,oBAAoB;YAChC,IAAI;YACJ,eAAe,EAAE,MAAM;YACvB,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACvB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,SAAS,EAAE,IAAI,CAAC,QAAQ;YACxB,aAAa;SACd,CAAC,EACF;YACE,OAAO,EAAE,EAAE,cAAc,EAAE,mCAAmC,EAAE;SACjE,CACF,CAAC;QAEF,OAAO;YACL,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY;YACjC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnE,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAa;SAC1C,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,kBAAkB,CAC9B,YAAoB;QAEpB,MAAM,YAAY,GAAG,QAAQ,CAAC,GAAG,EAAE,CAAC;QACpC,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CAQzC,0CAA0C,EAC1C,IAAI,eAAe,CAAC;YAClB,UAAU,EAAE,eAAe;YAC3B,aAAa,EAAE,YAAY;YAC3B,KAAK,EAAE,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC;YACvB,YAAY,EAAE,IAAI,CAAC,WAAW;YAC9B,SAAS,EAAE,IAAI,CAAC,QAAQ;SACzB,CAAC,EACF;YACE,OAAO,EAAE,EAAE,cAAc,EAAE,mCAAmC,EAAE;SACjE,CACF,CAAC;QACF,OAAO;YACL,KAAK,EAAE,QAAQ,CAAC,IAAI,CAAC,YAAY;YACjC,SAAS,EAAE,YAAY,CAAC,IAAI,CAAC,EAAE,OAAO,EAAE,QAAQ,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACnE,YAAY,EAAE,QAAQ,CAAC,IAAI,CAAC,aAAa;SAC1C,CAAC;IACJ,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,WAAmB;QAC3C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,aAAa,CAAC,SAAiB,EAAE,YAA0B;QAChE,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAChE,CAAC;IAEM,kBAAkB,GAAG,CAAC,QAAgB,EAAE,SAAiB,EAAE,EAAE,CAClE,YAAY,QAAQ,IAAI,SAAS,EAAE,CAAC;CACvC"}
1	+ {"version":3,"file":"xbox-authentication-client.js","sourceRoot":"","sources":["../../src/authentication/xbox-authentication-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAwB,MAAM,OAAO,CAAC;AAC7C,OAAO,EAAE,QAAQ,EAAE,MAAM,OAAO,CAAC;AAGjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,mBAAmB,CAAC;AACrD,OAAO,EAAE,gBAAgB,EAAE,MAAM,4BAA4B,CAAC;AAE9D,MAAM,CAAN,IAAY,YAGX;AAHD,WAAY,YAAY;IACtB,4CAA4B,CAAA;IAC5B,4DAA4C,CAAA;AAC9C,CAAC,EAHW,YAAY,KAAZ,YAAY,QAGvB;AAQD,MAAM,OAAO,wBAAwB;IAmFN;IAlFrB,cAAc,GAAG,IAAI,gBAAgB,CAAC,KAAK,EAAE,WAAmB,EAAE,EAAE;QAC1E,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAEpD,gBAAgB,CAAC,CAAC;QAEpB,IAAI,cAAc,EAAE,SAAS,EAAE;YAC7B,MAAM,SAAS,GAAG,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC7D,IAAI,SAAS,IAAI,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE;gBAC3C,OAAO,EAAE,GAAG,cAAc,EAAE,SAAS,EAAE,CAAC;aACzC;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACzC,kDAAkD,EAClD;YACE,YAAY,EAAE,0BAA0B;YACxC,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE;gBACV,UAAU,EAAE,KAAK;gBACjB,QAAQ,EAAE,wBAAwB;gBAClC,SAAS,EAAE,KAAK,WAAW,EAAE;aAC9B;SACF,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,wBAAwB,EAAE,GAAG;aAC9B;SACF,CACF,CAAC;QAEF,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ,CAAC,IAAI;YAChB,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;SACpD,CAAC;QACF,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;QAC1D,OAAO,MAAM,CAAC;IAChB,CAAC,CAAC,CAAC;IACK,eAAe,GAAG,IAAI,gBAAgB,CAC5C,KAAK,EAAE,SAAiB,EAAE,YAA0B,EAAE,EAAE;QACtD,MAAM,cAAc,GAAG,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAEpD,iBAAiB,CAAC,CAAC;QAErB,IAAI,cAAc,EAAE,SAAS,EAAE;YAC7B,MAAM,SAAS,GAAG,gBAAgB,CAAC,cAAc,CAAC,SAAS,CAAC,CAAC;YAC7D,IAAI,SAAS,IAAI,SAAS,GAAG,QAAQ,CAAC,GAAG,EAAE,EAAE;gBAC3C,OAAO,EAAE,GAAG,cAAc,EAAE,SAAS,EAAE,CAAC;aACzC;SACF;QAED,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,UAAU,CAAC,IAAI,CACzC,+CAA+C,EAC/C;YACE,YAAY,EAAE,YAAY;YAC1B,SAAS,EAAE,KAAK;YAChB,UAAU,EAAE;gBACV,SAAS,EAAE,QAAQ;gBACnB,UAAU,EAAE,CAAC,SAAS,CAAC;aACxB;SACF,EACD;YACE,OAAO,EAAE;gBACP,cAAc,EAAE,kBAAkB;gBAClC,MAAM,EAAE,kBAAkB;gBAC1B,wBAAwB,EAAE,GAAG;aAC9B;SACF,CACF,CAAC;QAEF,MAAM,MAAM,GAAG;YACb,GAAG,QAAQ,CAAC,IAAI;YAChB,SAAS,EAAE,QAAQ,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,QAAQ,CAAC;SACpD,CAAC;QACF,MAAM,IAAI,CAAC,cAAc,EAAE,IAAI,CAAC,iBAAiB,EAAE,MAAM,CAAC,CAAC;QAC3D,OAAO,MAAM,CAAC;IAChB,CAAC,CACF,CAAC;IAEe,UAAU,CAAgB;IAE3C,YAA6B,cAA+B;QAA/B,mBAAc,GAAd,cAAc,CAAiB;QAC1D,IAAI,CAAC,UAAU,GAAG,KAAK,CAAC,MAAM,EAAE,CAAC;IACnC,CAAC;IAEM,KAAK,CAAC,YAAY,CAAC,WAAmB;QAC3C,MAAM,EAAE,KAAK,EAAE,GAAG,MAAM,IAAI,CAAC,cAAc,CAAC,QAAQ,CAAC,WAAW,CAAC,CAAC;QAClE,OAAO,KAAK,CAAC;IACf,CAAC;IAEM,aAAa,CAAC,SAAiB,EAAE,YAA0B;QAChE,OAAO,IAAI,CAAC,eAAe,CAAC,QAAQ,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC;IAChE,CAAC;IAEM,kBAAkB,GAAG,CAAC,QAAgB,EAAE,SAAiB,EAAE,EAAE,CAClE,YAAY,QAAQ,IAAI,SAAS,EAAE,CAAC;CACvC"}

package/dist/core/spartan-token-providers/auto-xsts-spartan-token-provider.d.ts CHANGED Viewed

@@ -7,5 +7,5 @@ import { SpartanTokenProvider } from ".";
  */
 export declare class AutoXstsSpartanTokenProvider implements SpartanTokenProvider {
     readonly getSpartanToken: () => Promise<string>;
-    constructor(clientId: string, redirectUri: string, getAuthCode: (authorizeUrl: string) => Promise<string>, tokenPersister?: TokenPersister);
+    constructor(getOauth2AccessToken: () => Promise<string>, tokenPersister?: TokenPersister);
 }

package/dist/core/spartan-token-providers/auto-xsts-spartan-token-provider.js CHANGED Viewed

@@ -8,7 +8,7 @@ import { inMemoryTokenPersister } from "../token-persisters/in-memory-token-pers
  */
 export class AutoXstsSpartanTokenProvider {
     getSpartanToken;
-    constructor(clientId, redirectUri, getAuthCode, tokenPersister) {
+    constructor(getOauth2AccessToken, tokenPersister) {
         let actualTokenPersister;
         if (tokenPersister) {
             actualTokenPersister = tokenPersister;
@@ -16,10 +16,9 @@ export class AutoXstsSpartanTokenProvider {
         else {
             actualTokenPersister = inMemoryTokenPersister;
         }
-        const xboxAuthClient = new XboxAuthenticationClient(clientId, redirectUri, getAuthCode, tokenPersister);
+        const xboxAuthClient = new XboxAuthenticationClient(tokenPersister);
         const haloAuthClient = new HaloAuthenticationClient(async () => {
-            const accessToken = await xboxAuthClient.getAccessToken();
-            const userToken = await xboxAuthClient.getUserToken(accessToken);
+            const userToken = await xboxAuthClient.getUserToken(await getOauth2AccessToken());
             const xstsTicket = await xboxAuthClient.getXstsTicket(userToken, RelyingParty.Halo);
             return xstsTicket.Token;
         }, async () => await actualTokenPersister.load("halo.authToken"), async (token) => {

package/dist/core/spartan-token-providers/auto-xsts-spartan-token-provider.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"file":"auto-xsts-spartan-token-provider.js","sourceRoot":"","sources":["../../../src/core/spartan-token-providers/auto-xsts-spartan-token-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,wBAAwB,GACzB,MAAM,iDAAiD,CAAC;AAEzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAC;AAE3F,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAC;AAEvF;;;;GAIG;AACH,MAAM,OAAO,4BAA4B;IACvB,eAAe,CAAwB;IAEvD,YACE,~~QAAgB~~,~~EAChB~~,~~WAAmB,EACnB,WAAsD,EACtD,~~cAA+B;QAE/B,IAAI,oBAAoC,CAAC;QACzC,IAAI,cAAc,EAAE;YAClB,oBAAoB,GAAG,cAAc,CAAC;SACvC;aAAM;YACL,oBAAoB,GAAG,sBAAsB,CAAC;SAC/C;QACD,MAAM,cAAc,GAAG,IAAI,wBAAwB,~~CACjD~~,~~QAAQ,EACR,WAAW,EACX,WAAW,EACX,~~cAAc,~~CACf~~,CAAC;~~QACF~~,MAAM,cAAc,GAAG,IAAI,wBAAwB,CACjD,KAAK,IAAI,EAAE;YACT,MAAM,~~WAAW~~,GAAG,MAAM,cAAc,CAAC,~~cAAc~~,~~EAAE~~,~~CAAC;YAC1D,~~MAAM,~~SAAS~~,~~GAAG~~,~~MAAM~~,~~cAAc,~~CAAC~~,YAAY,CAAC,WAAW,CAAC,CAAC~~;~~YACjE~~,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,CACnD,SAAS,EACT,YAAY,CAAC,IAAI,CAClB,CAAC;YACF,OAAO,UAAU,CAAC,KAAK,CAAC;QAC1B,CAAC,EACD,KAAK,IAAI,EAAE,CAAC,MAAM,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAC7D,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;IAChE,CAAC;CACF"}
1	+ {"version":3,"file":"auto-xsts-spartan-token-provider.js","sourceRoot":"","sources":["../../../src/core/spartan-token-providers/auto-xsts-spartan-token-provider.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,YAAY,EACZ,wBAAwB,GACzB,MAAM,iDAAiD,CAAC;AAEzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,iDAAiD,CAAC;AAE3F,OAAO,EAAE,sBAAsB,EAAE,MAAM,+CAA+C,CAAC;AAEvF;;;;GAIG;AACH,MAAM,OAAO,4BAA4B;IACvB,eAAe,CAAwB;IAEvD,YACE,oBAA2C,EAC3C,cAA+B;QAE/B,IAAI,oBAAoC,CAAC;QACzC,IAAI,cAAc,EAAE;YAClB,oBAAoB,GAAG,cAAc,CAAC;SACvC;aAAM;YACL,oBAAoB,GAAG,sBAAsB,CAAC;SAC/C;QACD,MAAM,cAAc,GAAG,IAAI,wBAAwB,CAAC,cAAc,CAAC,CAAC;QACpE,MAAM,cAAc,GAAG,IAAI,wBAAwB,CACjD,KAAK,IAAI,EAAE;YACT,MAAM,SAAS,GAAG,MAAM,cAAc,CAAC,YAAY,CACjD,MAAM,oBAAoB,EAAE,CAC7B,CAAC;YACF,MAAM,UAAU,GAAG,MAAM,cAAc,CAAC,aAAa,CACnD,SAAS,EACT,YAAY,CAAC,IAAI,CAClB,CAAC;YACF,OAAO,UAAU,CAAC,KAAK,CAAC;QAC1B,CAAC,EACD,KAAK,IAAI,EAAE,CAAC,MAAM,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAC7D,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,MAAM,oBAAoB,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;QAC3D,CAAC,CACF,CAAC;QAEF,IAAI,CAAC,eAAe,GAAG,GAAG,EAAE,CAAC,cAAc,CAAC,eAAe,EAAE,CAAC;IAChE,CAAC;CACF"}

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "halo-infinite-api",
   "type": "module",
-  "version": "2.1.0",
+  "version": "3.0.0",
   "description": "An NPM package for accessing the official Halo Infinite API.",
   "main": "dist/index.js",
   "scripts": {
@@ -33,6 +33,7 @@
     "yargs": "^17.7.1"
   },
   "dependencies": {
+    "@azure/msal-node": "^2.2.0",
     "axios": "^1.3.5",
     "expiry-map": "^2.0.0",
     "luxon": "^3.3.0",

package/src/authentication/xbox-authentication-client.ts CHANGED Viewed

@@ -1,13 +1,9 @@
 import axios, { AxiosInstance } from "axios";
-import pkceChallenge from "pkce-challenge";
 import { DateTime } from "luxon";
+import { TokenPersister } from "../core/token-persisters";
 import { XboxTicket } from "../models/xbox-ticket";
 import { coalesceDateTime } from "../util/date-time";
-import { ResolvablePromise } from "../util/resolvable-promise";
 import { ExpiryTokenCache } from "../util/expiry-token-cache";
-import { TokenPersister } from "../core/token-persisters";
-const SCOPES = ["Xboxlive.signin", "Xboxlive.offline_access"];
 export enum RelyingParty {
   Xbox = "http://xboxlive.com",
@@ -21,9 +17,6 @@ export interface XboxAuthenticationToken {
 }
 export class XboxAuthenticationClient {
-  private accessTokenPromise:
-    | ResolvablePromise<XboxAuthenticationToken>
-    | undefined = undefined;
   private userTokenCache = new ExpiryTokenCache(async (accessToken: string) => {
     const persistedToken = await this.tokenPersister?.load<
       XboxTicket & { expiresAt?: unknown }
@@ -106,164 +99,10 @@ export class XboxAuthenticationClient {
   private readonly httpClient: AxiosInstance;
-  constructor(
-    private readonly clientId: string,
-    private readonly redirectUri: string,
-    private readonly getAuthCode: (authorizeUrl: string) => Promise<string>,
-    private readonly tokenPersister?: TokenPersister
-  ) {
+  constructor(private readonly tokenPersister?: TokenPersister) {
     this.httpClient = axios.create();
   }
-  private getPkce() {
-    // Some sort of module issue here, we work around it
-    type PkceChallenge = typeof pkceChallenge;
-    if (typeof pkceChallenge === "function") {
-      return pkceChallenge(43);
-    } else {
-      return (pkceChallenge as { default: PkceChallenge }).default(43);
-    }
-  }
-  public async getAccessToken() {
-    if (this.accessTokenPromise) {
-      // Someone either already has a token or is in the process of getting one
-      // Wait for them to finish, then check for validity
-      const currentToken = await this.accessTokenPromise;
-      if (currentToken.expiresAt > DateTime.now()) {
-        // Current token is valid, return it
-        return currentToken.token;
-      } else {
-        // Current token expired, start a new promise
-        this.accessTokenPromise =
-          new ResolvablePromise<XboxAuthenticationToken>();
-        try {
-          const newToken = await this.refreshOAuth2Token(
-            currentToken.refreshToken
-          );
-          this.accessTokenPromise.resolve(newToken);
-          await this.tokenPersister?.save("xbox.accessToken", newToken);
-          return newToken.token;
-        } catch (e) {
-          this.accessTokenPromise.reject(e);
-          throw e;
-        }
-      }
-    } else {
-      // We are the first caller, create a promise to block subsequent callers
-      this.accessTokenPromise =
-        new ResolvablePromise<XboxAuthenticationToken>();
-      try {
-        const loadedToken =
-          await this.tokenPersister?.load<XboxAuthenticationToken>(
-            "xbox.accessToken"
-          );
-        const currentToken = {
-          ...loadedToken,
-          token: loadedToken?.token ?? "",
-          expiresAt: coalesceDateTime(loadedToken?.expiresAt),
-        };
-        if (currentToken.expiresAt && currentToken.expiresAt > DateTime.now()) {
-          // Current token is valid, return it and alert other callers if applicable
-          this.accessTokenPromise.resolve(
-            currentToken as XboxAuthenticationToken
-          );
-          return currentToken.token;
-        } else {
-          const newToken = await this.fetchOauth2Token();
-          this.accessTokenPromise.resolve(newToken);
-          await this.tokenPersister?.save("xbox.accessToken", newToken);
-          return newToken.token;
-        }
-      } catch (e) {
-        this.accessTokenPromise.reject(e);
-        throw e;
-      }
-    }
-  }
-  private async fetchOauth2Token(): Promise<XboxAuthenticationToken> {
-    const { code_verifier, code_challenge } = this.getPkce();
-    const authorizeUrl = `https://login.live.com/oauth20_authorize.srf?${new URLSearchParams(
-      {
-        client_id: this.clientId,
-        response_type: "code",
-        redirect_uri: this.redirectUri,
-        scope: SCOPES.join(" "),
-        code_challenge_method: "S256",
-        code_challenge,
-      }
-    )}`;
-    const code = await this.getAuthCode(authorizeUrl);
-    const requestStart = DateTime.now();
-    const response = await this.httpClient.post<{
-      access_token: string;
-      expires_in: number;
-      scope: string;
-      token_type: string;
-      user_id: string;
-      refresh_token: string;
-    }>(
-      "https://login.live.com/oauth20_token.srf",
-      new URLSearchParams({
-        grant_type: "authorization_code",
-        code,
-        approval_prompt: "auto",
-        scope: SCOPES.join(" "),
-        redirect_uri: this.redirectUri,
-        client_id: this.clientId,
-        code_verifier,
-      }),
-      {
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
-      }
-    );
-    return {
-      token: response.data.access_token,
-      expiresAt: requestStart.plus({ seconds: response.data.expires_in }),
-      refreshToken: response.data.refresh_token,
-    };
-  }
-  private async refreshOAuth2Token(
-    refreshToken: string
-  ): Promise<XboxAuthenticationToken> {
-    const requestStart = DateTime.now();
-    const response = await this.httpClient.post<{
-      access_token: string;
-      expires_in: number;
-      scope: string;
-      token_type: string;
-      user_id: string;
-      refresh_token: string;
-    }>(
-      "https://login.live.com/oauth20_token.srf",
-      new URLSearchParams({
-        grant_type: "refresh_token",
-        refresh_token: refreshToken,
-        scope: SCOPES.join(" "),
-        redirect_uri: this.redirectUri,
-        client_id: this.clientId,
-      }),
-      {
-        headers: { "Content-Type": "application/x-www-form-urlencoded" },
-      }
-    );
-    return {
-      token: response.data.access_token,
-      expiresAt: requestStart.plus({ seconds: response.data.expires_in }),
-      refreshToken: response.data.refresh_token,
-    };
-  }
   public async getUserToken(accessToken: string) {
     const { Token } = await this.userTokenCache.getToken(accessToken);
     return Token;

package/src/core/spartan-token-providers/auto-xsts-spartan-token-provider.ts CHANGED Viewed

@@ -16,9 +16,7 @@ export class AutoXstsSpartanTokenProvider implements SpartanTokenProvider {
   public readonly getSpartanToken: () => Promise<string>;
   constructor(
-    clientId: string,
-    redirectUri: string,
-    getAuthCode: (authorizeUrl: string) => Promise<string>,
+    getOauth2AccessToken: () => Promise<string>,
     tokenPersister?: TokenPersister
   ) {
     let actualTokenPersister: TokenPersister;
@@ -27,16 +25,12 @@ export class AutoXstsSpartanTokenProvider implements SpartanTokenProvider {
     } else {
       actualTokenPersister = inMemoryTokenPersister;
     }
-    const xboxAuthClient = new XboxAuthenticationClient(
-      clientId,
-      redirectUri,
-      getAuthCode,
-      tokenPersister
-    );
+    const xboxAuthClient = new XboxAuthenticationClient(tokenPersister);
     const haloAuthClient = new HaloAuthenticationClient(
       async () => {
-        const accessToken = await xboxAuthClient.getAccessToken();
-        const userToken = await xboxAuthClient.getUserToken(accessToken);
+        const userToken = await xboxAuthClient.getUserToken(
+          await getOauth2AccessToken()
+        );
         const xstsTicket = await xboxAuthClient.getXstsTicket(
           userToken,
           RelyingParty.Halo