halo-infinite-api 1.1.1 → 1.2.0

package/dist/core/halo-infinite-client.d.ts

@@ -6,11 +6,11 @@ import { Playlist } from "../models/halo-infinite/playlist";
 import { PlaylistCsrContainer } from "../models/halo-infinite/playlist-csr-container";
 import { ServiceRecord } from "../models/halo-infinite/service-record";
 import { UserInfo } from "../models/halo-infinite/user-info";
-import { MapAsset, UgcGameVariantAsset } from "../models/halo-infinite/asset";
+import { MapAsset, PlaylistAsset, UgcGameVariantAsset } from "../models/halo-infinite/asset";
 import { AssetKind } from "../models/halo-infinite/asset-kind";
 interface ResultContainer<TValue> {
     Id: string;
-    ResultCode: number;
+    ResultCode: 0 | 1;
     Result: TValue;
 }
 interface TokenPersister {
@@ -20,6 +20,7 @@ interface TokenPersister {
 type AssetKindTypeMap = {
     [AssetKind.Map]: MapAsset;
     [AssetKind.UgcGameVariant]: UgcGameVariantAsset;
+    [AssetKind.Playlist]: PlaylistAsset;
 };
 export declare class HaloInfiniteClient {
     private readonly haloAuthClient;
@@ -46,7 +47,7 @@ export declare class HaloInfiniteClient {
     getPlaylist: (playlistId: string) => Promise<Playlist>;
     getPlayerMatches: (playerXuid: string, type?: MatchType, count?: number, start?: number) => Promise<PlayerMatchHistory[]>;
     getMatchStats: (matchId: string) => Promise<MatchStats<import("..").GameVariantCategory>>;
-    getMatchSkill: (matchId: string, playerIds: string[]) => Promise<ResultContainer<MatchSkill>[]>;
+    getMatchSkill: (matchId: string, playerIds: string[]) => Promise<ResultContainer<MatchSkill<0>>[]>;
     /** Gets authoring metadata about a specific asset. */
     getAsset: <TAssetType extends keyof AssetKindTypeMap>(assetType: TAssetType, assetId: string) => Promise<AssetKindTypeMap[TAssetType]>;
     /** Gets metadata related to a concrete version of a specified asset. */

package/dist/core/halo-infinite-client.js

@@ -1,4 +1,4 @@
-import axios, { AxiosHeaders } from "axios";
+import axios, { AxiosError, AxiosHeaders } from "axios";
 import { HaloAuthenticationClient } from "../authentication/halo-authentication-client";
 import { RelyingParty, XboxAuthenticationClient, } from "../authentication/xbox-authentication-client";
 import { HaloCoreEndpoints } from "../endpoints/halo-core-endpoints";
@@ -8,6 +8,7 @@ import { AssetKind } from "../models/halo-infinite/asset-kind";
 const assetKindUrlMap = {
     [AssetKind.Map]: "Maps",
     [AssetKind.UgcGameVariant]: "UgcGameVariants",
+    [AssetKind.Playlist]: "Playlists",
 };
 function wrapPlayerId(playerId) {
     if (/^\w+(\d+)/) {
@@ -51,7 +52,7 @@ export class HaloInfiniteClient {
             }
         });
     }
-    async executeRequest(url, method, useSpartanToken = true, useClearance = false, userAgent = GlobalConstants.HALO_WAYPOINT_USER_AGENT, throwOn404 = true) {
+    async executeRequest(url, method, useSpartanToken = true, useClearance = false, userAgent = GlobalConstants.HALO_WAYPOINT_USER_AGENT) {
         const headers = new AxiosHeaders({
             "User-Agent": userAgent,
             Accept: "application/json",
@@ -66,12 +67,11 @@ export class HaloInfiniteClient {
             url,
             method,
             headers,
-            validateStatus: (status) => status < 400 || (status === 404 && !throwOn404),
         });
         return response.data;
     }
-    async executeResultsRequest(url, method, useSpartanToken = true, useClearance = false, userAgent = GlobalConstants.HALO_WAYPOINT_USER_AGENT) {
-        const result = await this.executeRequest(url, method, useSpartanToken, useClearance, userAgent, false);
+    async executeResultsRequest(...args) {
+        const result = await this.executeRequest(...args);
         return result.Value;
     }
     async executePaginationRequest(count, start, queryParameters, ...args) {
@@ -110,9 +110,21 @@ export class HaloInfiniteClient {
         return this.executePaginationRequest(count, start, params, `https://${HaloCoreEndpoints.StatsOrigin}.${HaloCoreEndpoints.ServiceDomain}/hi/players/xuid(${wrapPlayerId(playerXuid)})/matches`, "get");
     };
     getMatchStats = (matchId) => this.executeRequest(`https://${HaloCoreEndpoints.StatsOrigin}.${HaloCoreEndpoints.ServiceDomain}/hi/matches/${matchId}/stats`, "get");
-    getMatchSkill = (matchId, playerIds) => this.executeResultsRequest(`https://${HaloCoreEndpoints.SkillOrigin}.${HaloCoreEndpoints.ServiceDomain}/hi/matches/${matchId}/skill?players=${playerIds
-        .map(wrapPlayerId)
-        .join(",")}`, "get");
+    getMatchSkill = async (matchId, playerIds) => {
+        try {
+            return await this.executeResultsRequest(`https://${HaloCoreEndpoints.SkillOrigin}.${HaloCoreEndpoints.ServiceDomain}/hi/matches/${matchId}/skill?players=${playerIds
+                .map(wrapPlayerId)
+                .join(",")}`, "get");
+        }
+        catch (e) {
+            if (e instanceof AxiosError && e.status === 404 && e.response?.data) {
+                return e.response.data.Value;
+            }
+            else {
+                throw e;
+            }
+        }
+    };
     /** Gets authoring metadata about a specific asset. */
     getAsset = (assetType, assetId) => this.executeRequest(`https://${HaloCoreEndpoints.DiscoveryOrigin}.${HaloCoreEndpoints.ServiceDomain}/hi/${assetKindUrlMap[assetType]}/${assetId}`, "get");
     /** Gets metadata related to a concrete version of a specified asset. */

package/dist/core/halo-infinite-client.js.map

@@ -1 +1 @@
-{"version":3,"file":"halo-infinite-client.js","sourceRoot":"","sources":["../../src/core/halo-infinite-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,YAAY,EAAU,MAAM,OAAO,CAAC;AACpD,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EACL,YAAY,EACZ,wBAAwB,GACzB,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAGrE,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAM/D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAE1D,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AA6B/D,MAAM,eAAe,GAAG;IACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM;IACvB,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,iBAAiB;CAG9C,CAAC;AAEF,SAAS,YAAY,CAAC,QAAgB;IACpC,IAAI,WAAW,EAAE;QACf,OAAO,QAAQ,CAAC;KACjB;SAAM;QACL,cAAc;QACd,OAAO,QAAQ,QAAQ,GAAG,CAAC;KAC5B;AACH,CAAC;AAED,MAAM,OAAO,kBAAkB;IACZ,cAAc,CAA2B;IAE1D,YACE,QAAgB,EAChB,WAAmB,EACnB,WAAsD,EACtD,cAA+B;QAE/B,MAAM,cAAc,GAAG,IAAI,wBAAwB,CACjD,QAAQ,EACR,WAAW,EACX,WAAW,EACX,KAAK,IAAI,EAAE;YACT,IAAI,cAAc,EAAE;gBAClB,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACpD;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,cAAc,EAAE;gBAClB,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;aACpD;QACH,CAAC,CACF,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,IAAI,wBAAwB,CAChD,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;YACT,IAAI,cAAc,EAAE;gBAClB,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACpD;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,cAAc,EAAE;gBAClB,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;aACpD;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,GAAW,EACX,MAAc,EACd,eAAe,GAAG,IAAI,EACtB,YAAY,GAAG,KAAK,EACpB,YAAoB,eAAe,CAAC,wBAAwB,EAC5D,aAAsB,IAAI;QAE1B,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC;YAC/B,YAAY,EAAE,SAAS;YACvB,MAAM,EAAE,kBAAkB;SAC3B,CAAC,CAAC;QAEH,IAAI,eAAe,EAAE;YACnB,OAAO,CAAC,GAAG,CACT,6BAA6B,EAC7B,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAC5C,CAAC;SACH;QAED,IAAI,YAAY,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAI;YACtC,GAAG;YACH,MAAM;YACN,OAAO;YACP,cAAc,EAAE,CAAC,MAAM,EAAE,EAAE,CACzB,MAAM,GAAG,GAAG,IAAI,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC;SAClD,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,qBAAqB,CACjC,GAAW,EACX,MAAc,EACd,eAAe,GAAG,IAAI,EACtB,YAAY,GAAG,KAAK,EACpB,YAAoB,eAAe,CAAC,wBAAwB;QAE5D,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CACtC,GAAG,EACH,MAAM,EACN,eAAe,EACf,YAAY,EACZ,SAAS,EACT,KAAK,CACN,CAAC;QAEF,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,KAAa,EACb,KAAa,EACb,eAAuC,EACvC,GAAG,IAAsD;QAEzD,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAC5B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CACtC,GAAG,GAAG,IAAI,IAAI,eAAe,CAAC;YAC5B,GAAG,eAAe;YAClB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;SACxB,CAAC,EAAE,EACJ,GAAG,IAAI,CACR,CAAC;QAEF,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,cAAc,GAAG,CAAC,UAAkB,EAAE,SAAmB,EAAE,EAAE,CAClE,IAAI,CAAC,qBAAqB,CACxB,WAAW,iBAAiB,CAAC,WAAW,IACtC,iBAAiB,CAAC,aACpB,gBAAgB,UAAU,iBAAiB,SAAS;SACjD,GAAG,CAAC,YAAY,CAAC;SACjB,IAAI,CAAC,GAAG,CAAC,EAAE,EACd,KAAK,CACN,CAAC;IAEJ;;OAEG;IACI,OAAO,GAAG,CAAC,QAAgB,EAAE,EAAE,CACpC,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,OAAO,IAAI,iBAAiB,CAAC,aAAa,aAAa,QAAQ,GAAG,EAC/F,KAAK,CACN,CAAC;IAEJ;;OAEG;IACI,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE,CACjD,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,WAAW,IAAI,iBAAiB,CAAC,aAAa,eAAe,QAAQ,0BAA0B,EAC5H,KAAK,CACN,CAAC;IAEJ;;OAEG;IACI,WAAW,GAAG,CAAC,UAAkB,EAAE,EAAE,CAC1C,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,aAAa,IAAI,iBAAiB,CAAC,aAAa,yCAAyC,UAAU,OAAO,EACvI,KAAK,CACN,CAAC;IAEG,gBAAgB,GAAG,CACxB,UAAkB,EAClB,OAAkB,SAAS,CAAC,GAAG,EAC/B,QAAgB,EAAE,EAClB,QAAgB,CAAC,EACjB,EAAE;QACF,IAAI,MAAM,GAA2B,EAAE,CAAC;QACxC,IAAI,IAAI,KAAK,SAAS,CAAC,GAAG,EAAE;YAC1B,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC,wBAAwB,CAClC,KAAK,EACL,KAAK,EACL,MAAM,EACN,WAAW,iBAAiB,CAAC,WAAW,IACtC,iBAAiB,CAAC,aACpB,oBAAoB,YAAY,CAAC,UAAU,CAAC,WAAW,EACvD,KAAK,CACN,CAAC;IACJ,CAAC,CAAC;IAEK,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE,CACzC,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,WAAW,IAAI,iBAAiB,CAAC,aAAa,eAAe,OAAO,QAAQ,EACzG,KAAK,CACN,CAAC;IAEG,aAAa,GAAG,CAAC,OAAe,EAAE,SAAmB,EAAE,EAAE,CAC9D,IAAI,CAAC,qBAAqB,CACxB,WAAW,iBAAiB,CAAC,WAAW,IACtC,iBAAiB,CAAC,aACpB,eAAe,OAAO,kBAAkB,SAAS;SAC9C,GAAG,CAAC,YAAY,CAAC;SACjB,IAAI,CAAC,GAAG,CAAC,EAAE,EACd,KAAK,CACN,CAAC;IAEJ,sDAAsD;IAC/C,QAAQ,GAAG,CAChB,SAAqB,EACrB,OAAe,EACf,EAAE,CACF,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,eAAe,IAAI,iBAAiB,CAAC,aAAa,OAAO,eAAe,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,EAC7H,KAAK,CACN,CAAC;IAEJ,wEAAwE;IACjE,uBAAuB,GAAG,CAC/B,SAAqB,EACrB,OAAe,EACf,SAAiB,EACjB,EAAE,CACF,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,eAAe,IAAI,iBAAiB,CAAC,aAAa,OAAO,eAAe,CAAC,SAAS,CAAC,IAAI,OAAO,aAAa,SAAS,EAAE,EACnJ,KAAK,CACN,CAAC;CACL"}
+{"version":3,"file":"halo-infinite-client.js","sourceRoot":"","sources":["../../src/core/halo-infinite-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAAE,UAAU,EAAE,YAAY,EAAU,MAAM,OAAO,CAAC;AAChE,OAAO,EAAE,wBAAwB,EAAE,MAAM,8CAA8C,CAAC;AACxF,OAAO,EACL,YAAY,EACZ,wBAAwB,GACzB,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,iBAAiB,EAAE,MAAM,kCAAkC,CAAC;AAGrE,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AAM/D,OAAO,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAM1D,OAAO,EAAE,SAAS,EAAE,MAAM,oCAAoC,CAAC;AA8B/D,MAAM,eAAe,GAAG;IACtB,CAAC,SAAS,CAAC,GAAG,CAAC,EAAE,MAAM;IACvB,CAAC,SAAS,CAAC,cAAc,CAAC,EAAE,iBAAiB;IAC7C,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,WAAW;CAGlC,CAAC;AAEF,SAAS,YAAY,CAAC,QAAgB;IACpC,IAAI,WAAW,EAAE;QACf,OAAO,QAAQ,CAAC;KACjB;SAAM;QACL,cAAc;QACd,OAAO,QAAQ,QAAQ,GAAG,CAAC;KAC5B;AACH,CAAC;AAED,MAAM,OAAO,kBAAkB;IACZ,cAAc,CAA2B;IAE1D,YACE,QAAgB,EAChB,WAAmB,EACnB,WAAsD,EACtD,cAA+B;QAE/B,MAAM,cAAc,GAAG,IAAI,wBAAwB,CACjD,QAAQ,EACR,WAAW,EACX,WAAW,EACX,KAAK,IAAI,EAAE;YACT,IAAI,cAAc,EAAE;gBAClB,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACpD;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,cAAc,EAAE;gBAClB,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;aACpD;QACH,CAAC,CACF,CAAC;QACF,IAAI,CAAC,cAAc,GAAG,IAAI,wBAAwB,CAChD,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;YACT,IAAI,cAAc,EAAE;gBAClB,OAAO,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;aACpD;iBAAM;gBACL,OAAO,IAAI,CAAC;aACb;QACH,CAAC,EACD,KAAK,EAAE,KAAK,EAAE,EAAE;YACd,IAAI,cAAc,EAAE;gBAClB,MAAM,cAAc,CAAC,IAAI,CAAC,gBAAgB,EAAE,KAAK,CAAC,CAAC;aACpD;QACH,CAAC,CACF,CAAC;IACJ,CAAC;IAEO,KAAK,CAAC,cAAc,CAC1B,GAAW,EACX,MAAc,EACd,eAAe,GAAG,IAAI,EACtB,YAAY,GAAG,KAAK,EACpB,YAAoB,eAAe,CAAC,wBAAwB;QAE5D,MAAM,OAAO,GAAG,IAAI,YAAY,CAAC;YAC/B,YAAY,EAAE,SAAS;YACvB,MAAM,EAAE,kBAAkB;SAC3B,CAAC,CAAC;QAEH,IAAI,eAAe,EAAE;YACnB,OAAO,CAAC,GAAG,CACT,6BAA6B,EAC7B,MAAM,IAAI,CAAC,cAAc,CAAC,eAAe,EAAE,CAC5C,CAAC;SACH;QAED,IAAI,YAAY,EAAE;YAChB,MAAM,IAAI,KAAK,CAAC,2BAA2B,CAAC,CAAC;SAC9C;QAED,MAAM,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAI;YACtC,GAAG;YACH,MAAM;YACN,OAAO;SACR,CAAC,CAAC;QAEH,OAAO,QAAQ,CAAC,IAAI,CAAC;IACvB,CAAC;IAEO,KAAK,CAAC,qBAAqB,CACjC,GAAG,IAAsD;QAEzD,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CAAsB,GAAG,IAAI,CAAC,CAAC;QAEvE,OAAO,MAAM,CAAC,KAAK,CAAC;IACtB,CAAC;IAEO,KAAK,CAAC,wBAAwB,CACpC,KAAa,EACb,KAAa,EACb,eAAuC,EACvC,GAAG,IAAsD;QAEzD,MAAM,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,GAAG,IAAI,CAAC;QAC5B,MAAM,MAAM,GAAG,MAAM,IAAI,CAAC,cAAc,CACtC,GAAG,GAAG,IAAI,IAAI,eAAe,CAAC;YAC5B,GAAG,eAAe;YAClB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;YACvB,KAAK,EAAE,KAAK,CAAC,QAAQ,EAAE;SACxB,CAAC,EAAE,EACJ,GAAG,IAAI,CACR,CAAC;QAEF,OAAO,MAAM,CAAC,OAAO,CAAC;IACxB,CAAC;IAED;;;OAGG;IACI,cAAc,GAAG,CAAC,UAAkB,EAAE,SAAmB,EAAE,EAAE,CAClE,IAAI,CAAC,qBAAqB,CACxB,WAAW,iBAAiB,CAAC,WAAW,IACtC,iBAAiB,CAAC,aACpB,gBAAgB,UAAU,iBAAiB,SAAS;SACjD,GAAG,CAAC,YAAY,CAAC;SACjB,IAAI,CAAC,GAAG,CAAC,EAAE,EACd,KAAK,CACN,CAAC;IAEJ;;OAEG;IACI,OAAO,GAAG,CAAC,QAAgB,EAAE,EAAE,CACpC,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,OAAO,IAAI,iBAAiB,CAAC,aAAa,aAAa,QAAQ,GAAG,EAC/F,KAAK,CACN,CAAC;IAEJ;;OAEG;IACI,oBAAoB,GAAG,CAAC,QAAgB,EAAE,EAAE,CACjD,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,WAAW,IAAI,iBAAiB,CAAC,aAAa,eAAe,QAAQ,0BAA0B,EAC5H,KAAK,CACN,CAAC;IAEJ;;OAEG;IACI,WAAW,GAAG,CAAC,UAAkB,EAAE,EAAE,CAC1C,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,aAAa,IAAI,iBAAiB,CAAC,aAAa,yCAAyC,UAAU,OAAO,EACvI,KAAK,CACN,CAAC;IAEG,gBAAgB,GAAG,CACxB,UAAkB,EAClB,OAAkB,SAAS,CAAC,GAAG,EAC/B,QAAgB,EAAE,EAClB,QAAgB,CAAC,EACjB,EAAE;QACF,IAAI,MAAM,GAA2B,EAAE,CAAC;QACxC,IAAI,IAAI,KAAK,SAAS,CAAC,GAAG,EAAE;YAC1B,MAAM,CAAC,IAAI,GAAG,IAAI,CAAC,QAAQ,EAAE,CAAC;SAC/B;QACD,OAAO,IAAI,CAAC,wBAAwB,CAClC,KAAK,EACL,KAAK,EACL,MAAM,EACN,WAAW,iBAAiB,CAAC,WAAW,IACtC,iBAAiB,CAAC,aACpB,oBAAoB,YAAY,CAAC,UAAU,CAAC,WAAW,EACvD,KAAK,CACN,CAAC;IACJ,CAAC,CAAC;IAEK,aAAa,GAAG,CAAC,OAAe,EAAE,EAAE,CACzC,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,WAAW,IAAI,iBAAiB,CAAC,aAAa,eAAe,OAAO,QAAQ,EACzG,KAAK,CACN,CAAC;IAEG,aAAa,GAAG,KAAK,EAAE,OAAe,EAAE,SAAmB,EAAE,EAAE;QACpE,IAAI;YACF,OAAO,MAAM,IAAI,CAAC,qBAAqB,CACrC,WAAW,iBAAiB,CAAC,WAAW,IACtC,iBAAiB,CAAC,aACpB,eAAe,OAAO,kBAAkB,SAAS;iBAC9C,GAAG,CAAC,YAAY,CAAC;iBACjB,IAAI,CAAC,GAAG,CAAC,EAAE,EACd,KAAK,CACN,CAAC;SACH;QAAC,OAAO,CAAC,EAAE;YACV,IAAI,CAAC,YAAY,UAAU,IAAI,CAAC,CAAC,MAAM,KAAK,GAAG,IAAI,CAAC,CAAC,QAAQ,EAAE,IAAI,EAAE;gBACnE,OAAQ,CAAC,CAAC,QAAQ,CAAC,IAA4C,CAAC,KAAK,CAAC;aACvE;iBAAM;gBACL,MAAM,CAAC,CAAC;aACT;SACF;IACH,CAAC,CAAC;IAEF,sDAAsD;IAC/C,QAAQ,GAAG,CAChB,SAAqB,EACrB,OAAe,EACf,EAAE,CACF,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,eAAe,IAAI,iBAAiB,CAAC,aAAa,OAAO,eAAe,CAAC,SAAS,CAAC,IAAI,OAAO,EAAE,EAC7H,KAAK,CACN,CAAC;IAEJ,wEAAwE;IACjE,uBAAuB,GAAG,CAC/B,SAAqB,EACrB,OAAe,EACf,SAAiB,EACjB,EAAE,CACF,IAAI,CAAC,cAAc,CACjB,WAAW,iBAAiB,CAAC,eAAe,IAAI,iBAAiB,CAAC,aAAa,OAAO,eAAe,CAAC,SAAS,CAAC,IAAI,OAAO,aAAa,SAAS,EAAE,EACnJ,KAAK,CACN,CAAC;CACL"}

package/dist/index.d.ts

@@ -10,3 +10,4 @@ export { PlayerMatchHistory } from "./models/halo-infinite/player-match-history"
 export { Stats } from "./models/halo-infinite/stats";
 export { MapAsset, UgcGameVariantAsset } from "./models/halo-infinite/asset";
 export { AssetKind } from "./models/halo-infinite/asset-kind";
+export { MatchOutcome } from "./models/halo-infinite/match-outcome";

package/dist/index.js

@@ -2,4 +2,5 @@ export { HaloInfiniteClient } from "./core/halo-infinite-client";
 export { MatchType } from "./models/halo-infinite/match-type";
 export { GameVariantCategory } from "./models/halo-infinite/game-variant-category";
 export { AssetKind } from "./models/halo-infinite/asset-kind";
+export { MatchOutcome } from "./models/halo-infinite/match-outcome";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAKjE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AAKnF,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,MAAM,6BAA6B,CAAC;AAKjE,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,mBAAmB,EAAE,MAAM,8CAA8C,CAAC;AAKnF,OAAO,EAAE,SAAS,EAAE,MAAM,mCAAmC,CAAC;AAC9D,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC"}

package/dist/models/halo-infinite/asset.d.ts

@@ -54,3 +54,31 @@ export interface UgcGameVariantAsset extends Asset {
     };
     EngineGameVariantLink?: Asset;
 }
+export interface PlaylistAsset extends Asset {
+    CustomData: {
+        PlaylistEntries: Array<{
+            MapModePairAssetId: string;
+            Metadata: {
+                Weight: number;
+            };
+        }>;
+        Strategy: number;
+        MinTeams: number;
+        MinTeamSize: number;
+        MaxTeams: number;
+        MaxTeamSize: number;
+        MaxTeamImbalance: number;
+        MaxSplitscreenPlayersAllowed: number;
+        AllowFriendJoinInProgress: boolean;
+        AllowMatchmakingJoinInProgress: boolean;
+        AllowBotJoinInProgress: boolean;
+        ExitExperienceDurationSec: number;
+        FireteamLeaderKickAllowed: boolean;
+        DisableMidgameChat: boolean;
+        AllowedDeviceInputs: Array<number>;
+        BotDifficulty: number;
+        MinFireteamSize: number;
+        MaxFireteamSize: number;
+    };
+    RotationEntries: Asset[];
+}

package/dist/models/halo-infinite/match-info.d.ts

@@ -1,7 +1,7 @@
 import { AssetVersionLink } from "./asset-version-link";
 import { GameVariantCategory } from "./game-variant-category";
 import { PlaylistExperience } from "./playlist-experience";
-export interface MatchInfo<TCategory extends GameVariantCategory = GameVariantCategory> {
+export interface MatchInfo<TCategory extends GameVariantCategory = GameVariantCategory, TResult extends 1 | 0 = 0> {
     StartTime: string;
     EndTime: string;
     Duration: string;
@@ -11,10 +11,10 @@ export interface MatchInfo<TCategory extends GameVariantCategory = GameVariantCa
     MapVariant: AssetVersionLink;
     UgcGameVariant: AssetVersionLink;
     ClearanceId: string;
-    Playlist: AssetVersionLink;
-    PlaylistExperience: PlaylistExperience;
-    PlaylistMapModePair: AssetVersionLink;
-    SeasonId: string;
+    Playlist: AssetVersionLink | null;
+    PlaylistExperience: TResult extends 0 ? PlaylistExperience : null;
+    PlaylistMapModePair: TResult extends 0 ? AssetVersionLink : null;
+    SeasonId: TResult extends 0 ? string : null;
     PlayableDuration: string;
     TeamsEnabled: boolean;
     TeamScoringEnabled: boolean;

package/dist/models/halo-infinite/match-skill.d.ts

@@ -17,7 +17,7 @@ interface Counterfactual {
     Kills: number;
     Deaths: number;
 }
-export interface MatchSkill {
+export interface MatchSkill<TResult extends 1 | 0 = 0> {
     TeamId: number;
     TeamMmr: number;
     TeamMmrs: {
@@ -27,11 +27,11 @@ export interface MatchSkill {
         PreMatchCsr: CsrObject;
         PostMatchCsr: CsrObject;
     };
-    StatPerformances: {
+    StatPerformances: TResult extends 0 ? {
         Kills: StatPerformance;
         Deaths: StatPerformance;
-    };
-    Counterfactuals: {
+    } : {};
+    Counterfactuals: TResult extends 0 ? {
         SelfCounterfactuals: Counterfactual;
         TierCounterfactuals: {
             Bronze: Counterfactual;
@@ -41,6 +41,6 @@ export interface MatchSkill {
             Diamond: Counterfactual;
             Onyx: Counterfactual;
         };
-    };
+    } : null;
 }
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "halo-infinite-api",
   "type": "module",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "description": "An NPM package for accessing the official Halo Infinite API.",
   "main": "dist/index.js",
   "scripts": {

package/src/core/halo-infinite-client.ts

@@ -1,4 +1,4 @@
-import axios, { AxiosHeaders, Method } from "axios";
+import axios, { AxiosError, AxiosHeaders, Method } from "axios";
 import { HaloAuthenticationClient } from "../authentication/halo-authentication-client";
 import {
   RelyingParty,
@@ -14,12 +14,16 @@ import { PlaylistCsrContainer } from "../models/halo-infinite/playlist-csr-conta
 import { ServiceRecord } from "../models/halo-infinite/service-record";
 import { UserInfo } from "../models/halo-infinite/user-info";
 import { GlobalConstants } from "../util/global-contants";
-import { MapAsset, UgcGameVariantAsset } from "../models/halo-infinite/asset";
+import {
+  MapAsset,
+  PlaylistAsset,
+  UgcGameVariantAsset,
+} from "../models/halo-infinite/asset";
 import { AssetKind } from "../models/halo-infinite/asset-kind";
 
 interface ResultContainer<TValue> {
   Id: string;
-  ResultCode: number;
+  ResultCode: 0 | 1;
   Result: TValue;
 }
 
@@ -42,11 +46,13 @@ interface TokenPersister {
 type AssetKindTypeMap = {
   [AssetKind.Map]: MapAsset;
   [AssetKind.UgcGameVariant]: UgcGameVariantAsset;
+  [AssetKind.Playlist]: PlaylistAsset;
 };
 
 const assetKindUrlMap = {
   [AssetKind.Map]: "Maps",
   [AssetKind.UgcGameVariant]: "UgcGameVariants",
+  [AssetKind.Playlist]: "Playlists",
 } satisfies {
   [key in keyof AssetKindTypeMap]: string;
 };
@@ -116,8 +122,7 @@ export class HaloInfiniteClient {
     method: Method,
     useSpartanToken = true,
     useClearance = false,
-    userAgent: string = GlobalConstants.HALO_WAYPOINT_USER_AGENT,
-    throwOn404: boolean = true
+    userAgent: string = GlobalConstants.HALO_WAYPOINT_USER_AGENT
   ) {
     const headers = new AxiosHeaders({
       "User-Agent": userAgent,
@@ -139,28 +144,15 @@ export class HaloInfiniteClient {
       url,
       method,
       headers,
-      validateStatus: (status) =>
-        status < 400 || (status === 404 && !throwOn404),
     });
 
     return response.data;
   }
 
   private async executeResultsRequest<T>(
-    url: string,
-    method: Method,
-    useSpartanToken = true,
-    useClearance = false,
-    userAgent: string = GlobalConstants.HALO_WAYPOINT_USER_AGENT
+    ...args: Parameters<HaloInfiniteClient["executeRequest"]>
   ) {
-    const result = await this.executeRequest<ResultsContainer<T>>(
-      url,
-      method,
-      useSpartanToken,
-      useClearance,
-      userAgent,
-      false
-    );
+    const result = await this.executeRequest<ResultsContainer<T>>(...args);
 
     return result.Value;
   }
@@ -252,15 +244,24 @@ export class HaloInfiniteClient {
       "get"
     );
 
-  public getMatchSkill = (matchId: string, playerIds: string[]) =>
-    this.executeResultsRequest<MatchSkill>(
-      `https://${HaloCoreEndpoints.SkillOrigin}.${
-        HaloCoreEndpoints.ServiceDomain
-      }/hi/matches/${matchId}/skill?players=${playerIds
-        .map(wrapPlayerId)
-        .join(",")}`,
-      "get"
-    );
+  public getMatchSkill = async (matchId: string, playerIds: string[]) => {
+    try {
+      return await this.executeResultsRequest<MatchSkill>(
+        `https://${HaloCoreEndpoints.SkillOrigin}.${
+          HaloCoreEndpoints.ServiceDomain
+        }/hi/matches/${matchId}/skill?players=${playerIds
+          .map(wrapPlayerId)
+          .join(",")}`,
+        "get"
+      );
+    } catch (e) {
+      if (e instanceof AxiosError && e.status === 404 && e.response?.data) {
+        return (e.response.data as ResultsContainer<MatchSkill<0 | 1>>).Value;
+      } else {
+        throw e;
+      }
+    }
+  };
 
   /** Gets authoring metadata about a specific asset. */
   public getAsset = <TAssetType extends keyof AssetKindTypeMap>(

package/src/index.ts

@@ -10,3 +10,4 @@ export { PlayerMatchHistory } from "./models/halo-infinite/player-match-history"
 export { Stats } from "./models/halo-infinite/stats";
 export { MapAsset, UgcGameVariantAsset } from "./models/halo-infinite/asset";
 export { AssetKind } from "./models/halo-infinite/asset-kind";
+export { MatchOutcome } from "./models/halo-infinite/match-outcome";

package/src/models/halo-infinite/asset.ts

@@ -57,3 +57,32 @@ export interface UgcGameVariantAsset extends Asset {
   };
   EngineGameVariantLink?: Asset;
 }
+
+export interface PlaylistAsset extends Asset {
+  CustomData: {
+    PlaylistEntries: Array<{
+      MapModePairAssetId: string;
+      Metadata: {
+        Weight: number;
+      };
+    }>;
+    Strategy: number;
+    MinTeams: number;
+    MinTeamSize: number;
+    MaxTeams: number;
+    MaxTeamSize: number;
+    MaxTeamImbalance: number;
+    MaxSplitscreenPlayersAllowed: number;
+    AllowFriendJoinInProgress: boolean;
+    AllowMatchmakingJoinInProgress: boolean;
+    AllowBotJoinInProgress: boolean;
+    ExitExperienceDurationSec: number;
+    FireteamLeaderKickAllowed: boolean;
+    DisableMidgameChat: boolean;
+    AllowedDeviceInputs: Array<number>;
+    BotDifficulty: number;
+    MinFireteamSize: number;
+    MaxFireteamSize: number;
+  };
+  RotationEntries: Asset[]; // TODO: Some sort of map-mode pair asset
+}

package/src/models/halo-infinite/match-info.ts

@@ -2,7 +2,8 @@ import { AssetVersionLink } from "./asset-version-link";
 import { GameVariantCategory } from "./game-variant-category";
 import { PlaylistExperience } from "./playlist-experience";
 export interface MatchInfo<
-  TCategory extends GameVariantCategory = GameVariantCategory
+  TCategory extends GameVariantCategory = GameVariantCategory,
+  TResult extends 1 | 0 = 0
 > {
   StartTime: string;
   EndTime: string;
@@ -13,10 +14,10 @@ export interface MatchInfo<
   MapVariant: AssetVersionLink;
   UgcGameVariant: AssetVersionLink;
   ClearanceId: string;
-  Playlist: AssetVersionLink;
-  PlaylistExperience: PlaylistExperience;
-  PlaylistMapModePair: AssetVersionLink;
-  SeasonId: string;
+  Playlist: AssetVersionLink | null;
+  PlaylistExperience: TResult extends 0 ? PlaylistExperience : null;
+  PlaylistMapModePair: TResult extends 0 ? AssetVersionLink : null;
+  SeasonId: TResult extends 0 ? string : null;
   PlayableDuration: string;
   TeamsEnabled: boolean;
   TeamScoringEnabled: boolean;

package/src/models/halo-infinite/match-skill.ts

@@ -20,7 +20,7 @@ interface Counterfactual {
   Deaths: number;
 }
 
-export interface MatchSkill {
+export interface MatchSkill<TResult extends 1 | 0 = 0> {
   TeamId: number;
   TeamMmr: number;
   TeamMmrs: {
@@ -30,19 +30,23 @@ export interface MatchSkill {
     PreMatchCsr: CsrObject;
     PostMatchCsr: CsrObject;
   };
-  StatPerformances: {
-    Kills: StatPerformance;
-    Deaths: StatPerformance;
-  };
-  Counterfactuals: {
-    SelfCounterfactuals: Counterfactual;
-    TierCounterfactuals: {
-      Bronze: Counterfactual;
-      Silver: Counterfactual;
-      Gold: Counterfactual;
-      Platinum: Counterfactual;
-      Diamond: Counterfactual;
-      Onyx: Counterfactual;
-    };
-  };
+  StatPerformances: TResult extends 0
+    ? {
+        Kills: StatPerformance;
+        Deaths: StatPerformance;
+      }
+    : {};
+  Counterfactuals: TResult extends 0
+    ? {
+        SelfCounterfactuals: Counterfactual;
+        TierCounterfactuals: {
+          Bronze: Counterfactual;
+          Silver: Counterfactual;
+          Gold: Counterfactual;
+          Platinum: Counterfactual;
+          Diamond: Counterfactual;
+          Onyx: Counterfactual;
+        };
+      }
+    : null;
 }