@pinta365/blizzard_api 0.3.7 → 0.3.9

package/esm/src/shared/errors.js

@@ -1,83 +0,0 @@
-/**
- * Custom error class representing an API error.
- * @class
- * @extends {Error}
- */
-export class APIError extends Error {
-    constructor(message, statusCode, responseBody) {
-        super(message);
-        Object.defineProperty(this, "statusCode", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "responseBody", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "APIError";
-        this.statusCode = statusCode;
-        this.responseBody = responseBody;
-    }
-}
-/**
- * Custom error class representing an Authentication error.
- * @class
- * @extends {Error}
- */
-export class AuthenticationError extends Error {
-    constructor(message, statusCode, responseBody) {
-        super(message);
-        Object.defineProperty(this, "statusCode", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        Object.defineProperty(this, "responseBody", {
-            enumerable: true,
-            configurable: true,
-            writable: true,
-            value: void 0
-        });
-        this.name = "AuthenticationError";
-        this.statusCode = statusCode;
-        this.responseBody = responseBody;
-    }
-}
-/**
- * Custom error class representing a missing client id error.
- * @class
- * @extends {Error}
- */
-export class MissingClientIdError extends Error {
-    constructor() {
-        super("Client Id must be setup. Check documentation");
-        this.name = "MissingClientIdError";
-    }
-}
-/**
- * Custom error class representing a missing client secret error.
- * @class
- * @extends {Error}
- */
-export class MissingClientSecretError extends Error {
-    constructor() {
-        super("Client Secret must be setup. Check documentation");
-        this.name = "MissingClientSecretError";
-    }
-}
-/**
- * Custom error class representing a missing api region error.
- * @class
- * @extends {Error}
- */
-export class MissingRegionError extends Error {
-    constructor() {
-        super("Api region must be setup. Check documentation");
-        this.name = "MissingRegionError";
-    }
-}

package/esm/src/shared/index.d.ts

@@ -1,4 +0,0 @@
-export { setup } from "./config.js";
-export { authenticate } from "./auth.js";
-export { request } from "./request.js";
-export type { Asset, Character, Href, KeyId, KeyName, KeyNameId, LinkSelfHref, LocalizedString, NameId, Namespaces, RequestOptions, TypeName, } from "./types.js";

package/esm/src/shared/index.js

@@ -1,3 +0,0 @@
-export { setup } from "./config.js";
-export { authenticate } from "./auth.js";
-export { request } from "./request.js";

package/esm/src/shared/request.d.ts

@@ -1,13 +0,0 @@
-import type { RequestOptions } from "./types.js";
-/**
- * Makes an authenticated request to the API and handles potential errors.
- * @param {RequestOptions} requestOptions - An object containing the following:
- *      * method: The HTTP method (e.g., "GET", "POST")
- *      * url:  The API endpoint path.
- *      * namespace (optional):  The Battlenet namespace for the request.
- *      * qs (optional): An object representing query string parameters.
- * @returns {Promise<any>} The parsed JSON response from the API.
- * @throws {APIError} If there is a problem fetching or the response is not successful.
- * @throws {AuthenticationError} (Potentially) If authentication fails during the process.
- */
-export declare function request(requestOptions: RequestOptions): Promise<unknown>;

package/esm/src/shared/request.js

@@ -1,46 +0,0 @@
-import { apiBaseUrl, getSetup } from "./config.js";
-import { authenticate, getauthConfig } from "./auth.js";
-import { APIError } from "./errors.js";
-/**
- * Makes an authenticated request to the API and handles potential errors.
- * @param {RequestOptions} requestOptions - An object containing the following:
- *      * method: The HTTP method (e.g., "GET", "POST")
- *      * url:  The API endpoint path.
- *      * namespace (optional):  The Battlenet namespace for the request.
- *      * qs (optional): An object representing query string parameters.
- * @returns {Promise<any>} The parsed JSON response from the API.
- * @throws {APIError} If there is a problem fetching or the response is not successful.
- * @throws {AuthenticationError} (Potentially) If authentication fails during the process.
- */
-export async function request(requestOptions) {
-    if (!getauthConfig().accessToken || (getauthConfig().accessToken && getauthConfig().tokenExpiration &&
-        new Date() < new Date(getauthConfig().tokenExpiration))) {
-        await authenticate(true);
-    }
-    const { method, url, namespace } = requestOptions;
-    let { qs } = requestOptions;
-    if (getSetup().locale) {
-        qs = { ...{ locale: getSetup().locale }, ...qs };
-    }
-    const qsString = qs
-        ? Object.fromEntries(Object.entries(qs).filter(([, value]) => value !== undefined).map(([key, value]) => [key, value.toString()]))
-        : {};
-    const params = new URLSearchParams(qsString);
-    const headers = {
-        "Authorization": "Bearer " + getauthConfig().accessToken,
-    };
-    if (namespace) {
-        headers["Battlenet-Namespace"] = `${namespace}-${getSetup().region}`;
-    }
-    const response = await fetch(apiBaseUrl(getSetup().region) + encodeURI(url) + (qsString ? "?" + params.toString() : ""), {
-        method: method,
-        headers: headers,
-    });
-    if (response.ok) {
-        return await response.json();
-    }
-    const errorData = await response.json();
-    const statusCode = errorData.code || response.status;
-    const errorMessage = JSON.stringify(errorData) || "Problem fetching data from API";
-    throw new APIError(errorMessage, statusCode, response.statusText);
-}

package/esm/src/shared/types.d.ts

@@ -1,120 +0,0 @@
-/**
- * Represents the configuration options for an API request.
- * @property {string} method - The HTTP method to use (currently restricted to "GET").
- * @property {string} url - The API endpoint path.
- * @property {Namespaces} [namespace] - The optional Battle.net namespace for the request.
- * @property {Record<string, string | number>} [qs] - An optional object for query string parameters.
- */
-export interface RequestOptions {
-    method: "GET";
-    url: string;
-    namespace?: Namespaces;
-    qs?: Record<string, string | number>;
-}
-/**
- * Supported Battle.net regions.
- */
-export type Regions = "us" | "eu" | "kr" | "tw" | "cn";
-/**
- * Supported locales for data.
- */
-export type Locales = "en_US" | "es_MX" | "pt_BR" | "en_GB" | "es_ES" | "fr_FR" | "ru_RU" | "de_DE" | "pt_PT" | "it_IT" | "ko_KR" | "zh_TW" | "zh_CN";
-/**
- * Available Battle.net namespaces.
- */
-export type Namespaces = "static" | "dynamic" | "profile";
-/**
- * Represents a reference (link) with a URL.
- */
-export interface Href {
-    /**
-     * The URL or address of the reference.
-     */
-    href: string;
-}
-/**
- * Represents a self-referential link structure commonly found in API responses.
- */
-export interface LinkSelfHref {
-    self: Href;
-}
-/**
- * Represents localized text. It can be either a string (if no locale was used) or a key-value object for multiple locales.
- */
-export interface LocalizedString {
-    name: string | Record<Locales, string>;
-}
-/**
- * Represents an object with a key (link), ID and LocalizedString name.
- */
-export interface KeyNameId {
-    key: {
-        href: string;
-    };
-    name: LocalizedString;
-    id: number;
-}
-/**
- * Represents an object with a key (link) and LocalizedString name.
- */
-export interface KeyName {
-    key: {
-        href: string;
-    };
-    name: LocalizedString;
-}
-/**
- * Represents an object with a key (link) and ID.
- */
-export interface KeyId {
-    key: {
-        href: string;
-    };
-    id: number;
-}
-/**
- * Represents an object with LocalizedString name and ID.
- */
-export interface NameId {
-    name: LocalizedString;
-    id: number;
-}
-/**
- * Represents an object with a type and a LocalizedString name.
- */
-export interface TypeName {
-    type: string;
-    name: LocalizedString;
-}
-/**
- * Represents a character profile.
- */
-export interface Character {
-    key?: {
-        href: string;
-    };
-    name: string;
-    id: number;
-    realm: {
-        key: {
-            href: string;
-        };
-        name: LocalizedString;
-        id: number;
-        slug: string;
-    };
-    level?: number;
-    playable_class?: KeyId;
-    playable_race?: KeyId;
-}
-/**
- * Represents a generic asset within a system.
- * @property {string} key - A unique identifier for the asset.
- * @property {string} value - The value associated with the asset.
- * @property {number} [file_data_id] - (Optional) The ID of the file data associated with the asset (if any).
- */
-export interface Asset {
-    key: string;
-    value: string;
-    file_data_id?: number;
-}

package/esm/src/shared/types.js

@@ -1,2 +0,0 @@
-//types.ts
-export {};

package/esm/src/starcraft2/game_data/league.d.ts

@@ -1,32 +0,0 @@
-import type { LinkSelfHref } from "../../shared/index.js";
-export interface League extends LinkSelfHref {
-    key: {
-        league_id: number;
-        season_id: number;
-        queue_id: number;
-        team_type: number;
-    };
-    tier: {
-        id: number;
-        division: {
-            id: number;
-            ladder_id: number;
-            member_count: number;
-        }[];
-    }[];
-}
-/**
- * Returns data for the specified season, queue, team, and league.
- *
- * Notes from the battle.net docs:
- * queueId: the standard available queueIds are: 1=WoL 1v1, 2=WoL 2v2, 3=WoL 3v3, 4=WoL 4v4, 101=HotS 1v1, 102=HotS 2v2, 103=HotS 3v3, 104=HotS 4v4, 201=LotV 1v1, 202=LotV 2v2, 203=LotV 3v3, 204=LotV 4v4, 206=LotV Archon. Note that other available queues may not be listed here.
- * teamType: there are two available teamTypes: 0=arranged, 1=random.
- * leagueId: available leagueIds are: 0=Bronze, 1=Silver, 2=Gold, 3=Platinum, 4=Diamond, 5=Master, 6=Grandmaster.
- *
- * @param seasonId - The season ID of the data to retrieve.
- * @param queueId - The queue ID of the data to retrieve.
- * @param teamType - The team type of the data to retrieve.
- * @param leagueId - The league ID of the data to retrieve.
- * @returns A promise that resolves to an object representing the data for a league.
- */
-export declare function leagueData(seasonId: number, queueId: number, teamType: number, leagueId: number): Promise<League>;

package/esm/src/starcraft2/game_data/league.js

@@ -1,21 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * Returns data for the specified season, queue, team, and league.
- *
- * Notes from the battle.net docs:
- * queueId: the standard available queueIds are: 1=WoL 1v1, 2=WoL 2v2, 3=WoL 3v3, 4=WoL 4v4, 101=HotS 1v1, 102=HotS 2v2, 103=HotS 3v3, 104=HotS 4v4, 201=LotV 1v1, 202=LotV 2v2, 203=LotV 3v3, 204=LotV 4v4, 206=LotV Archon. Note that other available queues may not be listed here.
- * teamType: there are two available teamTypes: 0=arranged, 1=random.
- * leagueId: available leagueIds are: 0=Bronze, 1=Silver, 2=Gold, 3=Platinum, 4=Diamond, 5=Master, 6=Grandmaster.
- *
- * @param seasonId - The season ID of the data to retrieve.
- * @param queueId - The queue ID of the data to retrieve.
- * @param teamType - The team type of the data to retrieve.
- * @param leagueId - The league ID of the data to retrieve.
- * @returns A promise that resolves to an object representing the data for a league.
- */
-export async function leagueData(seasonId, queueId, teamType, leagueId) {
-    return await request({
-        method: "GET",
-        url: `/data/sc2/league/${seasonId}/${queueId}/${teamType}/${leagueId}`,
-    });
-}

package/esm/src/starcraft2/index.d.ts

@@ -1 +0,0 @@
-export { leagueData } from "./game_data/league.js";

package/esm/src/starcraft2/index.js

@@ -1 +0,0 @@
-export { leagueData } from "./game_data/league.js";

package/esm/src/wow/game_data/achievement.d.ts

@@ -1,84 +0,0 @@
-/**
- * This module provides interfaces and API function definitions for fetching World of Warcraft achievement data using the Blizzard API.
- *
- * @author Pinta <https://github.com/Pinta365>
- */
-import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-export interface AchievementCategories extends LinkSelfHref {
-    categories: KeyNameId[];
-}
-export interface AggregatesByFaction {
-    alliance: {
-        quantity: number;
-        points: number;
-    };
-    horde: {
-        quantity: number;
-        points: number;
-    };
-}
-export interface AchievementCategory extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    achievements: KeyNameId[];
-    parent_category: KeyNameId;
-    is_guild_category: boolean;
-    aggregates_by_faction: AggregatesByFaction;
-    display_order: number;
-}
-export interface Achievements extends LinkSelfHref {
-    achievements: KeyNameId[];
-}
-export interface Achievement extends LinkSelfHref {
-    id: number;
-    category: KeyNameId;
-    name: LocalizedString;
-    description: LocalizedString;
-    points: number;
-    is_account_wide: boolean;
-    criteria: {
-        id: number;
-        description: LocalizedString;
-        amount: number;
-    };
-    next_achievement: KeyNameId;
-    media: KeyId;
-    display_order: number;
-}
-export interface AchievementMedia extends LinkSelfHref {
-    assets: Asset[];
-    id: number;
-}
-/**
- * Fetches and returns an index of achievement categories.
- *
- * @returns A promise that resolves to an object representing the index of achievement categories.
- */
-export declare function achievementCategories(): Promise<AchievementCategories>;
-/**
- * Fetches and returns details of a specific achievement category identified by its ID.
- *
- * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
- * @returns A promise that resolves to an object representing the achievement category details.
- */
-export declare function achievementCategory(achievementCategoryId: number): Promise<AchievementCategory>;
-/**
- * Fetches and returns an index of achievements.
- *
- * @returns A promise that resolves to an object representing the index of achievements.
- */
-export declare function achievements(): Promise<Achievements>;
-/**
- * Fetches and returns details of a specific achievement identified by its ID.
- *
- * @param achievementId - The unique identifier of the achievement to retrieve.
- * @returns A promise that resolves to an object representing the achievement details.
- */
-export declare function achievement(achievementId: number): Promise<Achievement>;
-/**
- * Fetches and returns media details for a specific achievement identified by its ID.
- *
- * @param achievementId - The unique identifier of the achievement to retrieve media details for.
- * @returns A promise that resolves to an object representing the achievement media details.
- */
-export declare function achievementMedia(achievementId: number): Promise<AchievementMedia>;

package/esm/src/wow/game_data/achievement.js

@@ -1,69 +0,0 @@
-/**
- * This module provides interfaces and API function definitions for fetching World of Warcraft achievement data using the Blizzard API.
- *
- * @author Pinta <https://github.com/Pinta365>
- */
-import { request } from "../../shared/index.js";
-/**
- * Fetches and returns an index of achievement categories.
- *
- * @returns A promise that resolves to an object representing the index of achievement categories.
- */
-export async function achievementCategories() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/achievement-category/index",
-        namespace: "static",
-    });
-}
-/**
- * Fetches and returns details of a specific achievement category identified by its ID.
- *
- * @param achievementCategoryId - The unique identifier of the achievement category to retrieve.
- * @returns A promise that resolves to an object representing the achievement category details.
- */
-export async function achievementCategory(achievementCategoryId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/achievement-category/${achievementCategoryId}`,
-        namespace: "static",
-    });
-}
-/**
- * Fetches and returns an index of achievements.
- *
- * @returns A promise that resolves to an object representing the index of achievements.
- */
-export async function achievements() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/achievement/index",
-        namespace: "static",
-    });
-}
-/**
- * Fetches and returns details of a specific achievement identified by its ID.
- *
- * @param achievementId - The unique identifier of the achievement to retrieve.
- * @returns A promise that resolves to an object representing the achievement details.
- */
-export async function achievement(achievementId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/achievement/${achievementId}`,
-        namespace: "static",
-    });
-}
-/**
- * Fetches and returns media details for a specific achievement identified by its ID.
- *
- * @param achievementId - The unique identifier of the achievement to retrieve media details for.
- * @returns A promise that resolves to an object representing the achievement media details.
- */
-export async function achievementMedia(achievementId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/media/achievement/${achievementId}`,
-        namespace: "static",
-    });
-}

package/esm/src/wow/game_data/auction_house.d.ts

@@ -1,64 +0,0 @@
-import type { LinkSelfHref } from "../../shared/index.js";
-export interface AuctionItem {
-    id: number;
-    modifiers?: {
-        type: number;
-        value: number;
-    }[];
-    pet_breed_id?: number;
-    pet_level?: number;
-    pet_quality_id?: number;
-    pet_species_id?: number;
-    bonus_lists?: number[];
-    context?: number;
-}
-export interface AuctionListing {
-    id: number;
-    item: AuctionItem;
-    bid?: number;
-    buyout?: number;
-    quantity: number;
-    time_left: "SHORT" | "MEDIUM" | "LONG" | "VERY_LONG";
-}
-export interface Auctions extends LinkSelfHref {
-    connected_realm: {
-        href: string;
-    };
-    auctions: AuctionListing[];
-    commodities: {
-        href: string;
-    };
-}
-export interface commodity {
-    "id": number;
-    "item": {
-        "id": number;
-    };
-    "quantity": number;
-    "unit_price": number;
-    "time_left": "SHORT" | "MEDIUM" | "LONG" | "VERY_LONG";
-}
-export interface Commodities extends LinkSelfHref {
-    auctions: commodity[];
-}
-/**
- * Returns all active auctions for a connected realm.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
- *
- * @param connectedRealmId - The id of the connected realm to return auctions from.
- * @returns A promise that resolves to an object representing the auctions being listed.
- */
-export declare function auctions(connectedRealmId: number): Promise<Auctions>;
-/**
- * Returns all active auctions for commodity items for the entire game region.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
- *
- * @returns A promise that resolves to an object representing the commodities being listed.
- */
-export declare function commodities(): Promise<Commodities>;

package/esm/src/wow/game_data/auction_house.js

@@ -1,34 +0,0 @@
-import { request } from "../../shared/index.js";
-/**
- * Returns all active auctions for a connected realm.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified connected realm, the response from this endpoint may be rather large.
- *
- * @param connectedRealmId - The id of the connected realm to return auctions from.
- * @returns A promise that resolves to an object representing the auctions being listed.
- */
-export async function auctions(connectedRealmId) {
-    return await request({
-        method: "GET",
-        url: `/data/wow/connected-realm/${connectedRealmId}/auctions`,
-        namespace: "dynamic",
-    });
-}
-/**
- * Returns all active auctions for commodity items for the entire game region.
- *
- * Auction house data updates at a set interval. The value was initially set at 1 hour; however, it might change over time without notice.
- *
- * NOTE: Depending on the number of active auctions on the specified region, the response from this endpoint may be rather large.
- *
- * @returns A promise that resolves to an object representing the commodities being listed.
- */
-export async function commodities() {
-    return await request({
-        method: "GET",
-        url: "/data/wow/auctions/commodities",
-        namespace: "dynamic",
-    });
-}

package/esm/src/wow/game_data/azerite_essence.d.ts

@@ -1,49 +0,0 @@
-import type { Asset, KeyId, KeyNameId, LinkSelfHref, LocalizedString } from "../../shared/index.js";
-import type { Search, SearchParameters } from "../search.js";
-export interface AzeriteEssences extends LinkSelfHref {
-    azerite_essences: KeyNameId[];
-}
-export interface AzeritePower {
-    id: number;
-    rank: number;
-    main_power_spell: KeyNameId;
-    passive_power_spell: KeyNameId;
-}
-export interface AzeriteEssenceDetails extends LinkSelfHref {
-    id: number;
-    name: LocalizedString;
-    allowed_specializations: KeyNameId[];
-    powers: AzeritePower[];
-    media: KeyId;
-}
-export interface AzeritEessenceMedia extends LinkSelfHref {
-    assets: Asset[];
-    id: number;
-}
-/**
- * Returns Azerite Essences Index
- *
- * @returns A promise that resolves to an object representing a list of all Azerite Essences.
- */
-export declare function azeriteEssences(): Promise<AzeriteEssences>;
-/**
- * Returns details about a specific Azerite Essence Id
- *
- * @param azeriteEssenceId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing details about an Azerite Essences.
- */
-export declare function azeriteEssence(azeriteEssenceId: number): Promise<AzeriteEssenceDetails>;
-/**
- * Performs a search of azerite essences.
- *
- * @param SearchParameters - Object containing search parameters.
- * @returns A promise that resolves to an object representing details about a Azerite Essences search.
- */
-export declare function searchAzeriteEssence(searchParameters: SearchParameters): Promise<Search>;
-/**
- * Returns media details about a specific Azerite Essence Id
- *
- * @param azeriteEssenceId - The unique identifier Azerite Essence.
- * @returns A promise that resolves to an object representing media details about an Azerite Essences.
- */
-export declare function azeriteEssenceMedia(azeriteEssenceId: number): Promise<AzeritEessenceMedia>;