@xboxreplay/xboxlive-auth
Version:
A lightweight, zero-dependency Xbox Network (Xbox Live) authentication library for Node.js with OAuth 2.0 support.
117 lines (116 loc) • 5.29 kB
JavaScript
;
/**
* Copyright 2025 Alexis Bize
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
const __1 = __importDefault(require(".."));
/**
* Specialized fetch client for Xbox Network API requests
* Extends the base FetchClient with Xbox-specific functionality
*/
class XSAPIFetchClient extends __1.default {
/**
* Makes a GET request to an Xbox Network API endpoint
* @template T - The expected response data type
* @param {string} url - The URL to make the request to
* @param {Omit<XSAPIFetchRequestConfig, 'method' | 'body'>} [config={}] - Request config excluding method and body
* @returns {Promise<FetchResponse<T>>} A promise that resolves to the response data
* @throws {FetchClientException} If the request fails
*
* @example
* const response = await XSAPIFetchClient.get('https://xbl.xboxlive.com/resource');
*/
static async get(url, config = {}) {
return this.fetch(url, { ...config, method: 'GET' });
}
/**
* Makes a POST request to an Xbox Network API endpoint
* @template T - The expected response data type
* @param {string} url - The URL to make the request to
* @param {any} [body] - The request body (will be automatically stringified if an object)
* @param {Omit<XSAPIFetchRequestConfig, 'method' | 'body'>} [config={}] - Request config excluding method and body
* @returns {Promise<FetchResponse<T>>} A promise that resolves to the response data
* @throws {FetchClientException} If the request fails
*
* @example
* const response = await XSAPIFetchClient.post('https://service.xboxlive.com/resource', { foo: 'bar' });
*/
static async post(url, body, config = {}) {
return this.fetch(url, { ...config, method: 'POST', body });
}
/**
* Makes a PUT request to an Xbox Network API endpoint
* @template T - The expected response data type
* @param {string} url - The URL to make the request to
* @param {any} [body] - The request body (will be automatically stringified if an object)
* @param {Omit<XSAPIFetchRequestConfig, 'method' | 'body'>} [config={}] - Request config excluding method and body
* @returns {Promise<FetchResponse<T>>} A promise that resolves to the response data
* @throws {FetchClientException} If the request fails
*
* @example
* const response = await XSAPIFetchClient.put('https://service.xboxlive.com/resource', { foo: 'bar' });
*/
static async put(url, body, config = {}) {
return this.fetch(url, { ...config, method: 'PUT', body });
}
/**
* Makes a DELETE request to an Xbox Network API endpoint
* @template T - The expected response data type
* @param {string} url - The URL to make the request to
* @param {Omit<XSAPIFetchRequestConfig, 'method'>} [config={}] - Request config excluding method
* @returns {Promise<FetchResponse<T>>} A promise that resolves to the response data
* @throws {FetchClientException} If the request fails
*
* @example
* const response = await XSAPIFetchClient.delete('https://service.xboxlive.com/resource');
*/
static async delete(url, config = {}) {
return this.fetch(url, { ...config, method: 'DELETE' });
}
/**
* Merges provided options with defaults, adding Xbox-specific defaults
* @param {XSAPIFetchRequestConfig["options"]} [options={}] - The options to merge
* @returns {XSAPIFetchRequestConfig["options"]} Merged options
* @protected
*/
static mergeOptions(options = {}) {
return { ...super.mergeOptions(options) };
}
/**
* Creates headers for the request, adding Xbox-specific headers
* @param {XSAPIFetchRequestConfig} config - The request config
* @returns {Headers} The headers object
* @protected
*/
static createHeaders(config) {
const headers = super.createHeaders(config);
headers.set('Accept', 'application/json');
headers.set('X-XBL-Contract-Version', String(config.options?.contractVersion || '0'));
if (config.options?.XSTSToken !== void 0) {
headers.set('Authorization', `XBL3.0 x=${config.options?.userHash || '*'};${config.options?.XSTSToken}`);
}
if (config.options?.signature !== void 0) {
headers.set('Signature', config.options?.signature);
}
if (config.options?.mscv !== void 0) {
headers.set('MS-CV', config.options?.mscv);
}
return headers;
}
}
exports.default = XSAPIFetchClient;