@pinta365/blizzard_api 0.3.5

package/esm/src/wow/profile/guild.d.ts

@@ -0,0 +1,117 @@
+import type { Character, Href, KeyId, KeyNameId, LinkSelfHref, LocalizedString, TypeName } from "../../shared/index.js";
+export interface Rgba {
+    r: number;
+    g: number;
+    b: number;
+    a: number;
+}
+export interface CrestAsset {
+    id?: number;
+    media?: KeyId;
+    color: {
+        id: number;
+        rgba: Rgba;
+    };
+}
+export interface Guild extends LinkSelfHref {
+    key?: Href;
+    id: number;
+    name: string;
+    faction: TypeName;
+    achievement_points?: number;
+    member_count?: number;
+    realm: {
+        key: Href;
+        name: LocalizedString;
+        id: number;
+        slug: string;
+    };
+    crest?: {
+        emblem: CrestAsset;
+        border: CrestAsset;
+        background: CrestAsset;
+    };
+    roster?: Href;
+    achievements?: Href;
+    created_timestamp?: number;
+    activity?: Href;
+    name_search: string;
+}
+export interface GuildActivity extends LinkSelfHref {
+    guild: Guild;
+    activities: {
+        character_achievement: {
+            character: Character;
+            achievement: KeyNameId;
+        };
+        activity: {
+            type: string;
+        };
+        timestamp: number;
+    }[];
+}
+export interface Critiera {
+    id: number;
+    amount?: number;
+    is_completed: boolean;
+    child_criteria?: Critiera[];
+}
+export interface GuildAchievements extends LinkSelfHref {
+    guild: Guild;
+    total_quantity: number;
+    total_points: number;
+    achievements: {
+        id: number;
+        achievement: KeyNameId;
+        criteria: Critiera;
+        completed_timestamp: number;
+    }[];
+    category_progress: {
+        category: KeyNameId;
+        quantity: number;
+        points: number;
+    }[];
+    recent_events: {
+        achievement: KeyNameId;
+        timestamp: number;
+    }[];
+}
+export interface GuildRoster extends LinkSelfHref {
+    guild: Guild;
+    members: {
+        character: Character;
+        rank: number;
+    }[];
+}
+/**
+ * Returns a single guild by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild by its name and realm.
+ */
+export declare function guild(realmSlug: string, nameSlug: string): Promise<Guild>;
+/**
+ * Returns a single guild's activity by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's activity by its name and realm.
+ */
+export declare function guildActivity(realmSlug: string, nameSlug: string): Promise<GuildActivity>;
+/**
+ * Returns a single guild's achievements by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's achievements by its name and realm.
+ */
+export declare function guildAchievements(realmSlug: string, nameSlug: string): Promise<GuildAchievements>;
+/**
+ * Returns a single guild's roster by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's roster by its name and realm.
+ */
+export declare function guildRoster(realmSlug: string, nameSlug: string): Promise<GuildRoster>;

package/esm/src/wow/profile/guild.js

@@ -0,0 +1,57 @@
+import { request } from "../../shared/index.js";
+/**
+ * Returns a single guild by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild by its name and realm.
+ */
+export async function guild(realmSlug, nameSlug) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a single guild's activity by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's activity by its name and realm.
+ */
+export async function guildActivity(realmSlug, nameSlug) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/activity`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a single guild's achievements by name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's achievements by its name and realm.
+ */
+export async function guildAchievements(realmSlug, nameSlug) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/achievements`,
+        namespace: "profile",
+    });
+}
+/**
+ * Returns a single guild's roster by its name and realm.
+ *
+ * @param realmSlug - The slug of the realm.
+ * @param nameSlug - The slug of the guild.
+ * @returns A promise that resolves to an object representing a single guild's roster by its name and realm.
+ */
+export async function guildRoster(realmSlug, nameSlug) {
+    return await request({
+        method: "GET",
+        url: `/data/wow/guild/${realmSlug}/${nameSlug}/roster`,
+        namespace: "profile",
+    });
+}

package/esm/src/wow/search.d.ts

@@ -0,0 +1,21 @@
+import type { Namespaces } from "../shared/index.js";
+export interface SearchParameters {
+    searchFields?: Record<string | symbol, string | number>;
+    orderBy?: string;
+    page?: number;
+    pageSize?: number;
+}
+export interface Search {
+    page: number;
+    pageSize: number;
+    maxPageSize: number;
+    pageCount: number;
+    results: unknown[];
+}
+/**
+ * Performs a search.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about the search.
+ */
+export declare function search(url: string, namespace: Namespaces, searchParameters: SearchParameters): Promise<Search>;

package/esm/src/wow/search.js

@@ -0,0 +1,30 @@
+import { request } from "../shared/index.js";
+/**
+ * Performs a search.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing details about the search.
+ */
+export async function search(url, namespace, searchParameters) {
+    const searchFields = searchParameters.searchFields
+        ? Object.fromEntries(Object.entries(searchParameters.searchFields).map(([key, value]) => [key, value.toString()]))
+        : undefined;
+    const qs = {
+        ...searchFields,
+    };
+    if (searchParameters.orderBy) {
+        qs.orderby = searchParameters.orderBy;
+    }
+    if (searchParameters.page !== undefined) {
+        qs._page = searchParameters.page;
+    }
+    if (searchParameters.pageSize !== undefined) {
+        qs._pageSize = searchParameters.pageSize;
+    }
+    return await request({
+        method: "GET",
+        url: `/data/wow/search${url}`,
+        qs,
+        namespace,
+    });
+}

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@pinta365/blizzard_api",
+  "version": "0.3.5",
+  "description": "TS library to interact with the Blizzard Battle.net API. World of Warcraft, World of Warcraft Classic, StarCraft 2, Diablo 3, Hearthstone.",
+  "keywords": [
+    "blizzard",
+    "battlenet",
+    "battle.net",
+    "bnet",
+    "World of Warcraft",
+    "StarCraft",
+    "Diablo",
+    "Hearthstone"
+  ],
+  "author": "Pinta <https://github.com/Pinta365>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Pinta365/blizzard_api.git"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/Pinta365/blizzard_api/issues"
+  },
+  "main": "./script/mod.js",
+  "module": "./esm/mod.js",
+  "exports": {
+    ".": {
+      "import": "./esm/mod.js",
+      "require": "./script/mod.js"
+    }
+  },
+  "devDependencies": {
+    "@types/node": "^20.9.0"
+  },
+  "_generatedBy": "dnt@0.40.0"
+}

package/script/mod.d.ts

@@ -0,0 +1,5 @@
+import { authenticate, setup } from "./src/shared/index.js";
+import * as wow from "./src/wow/index.js";
+import * as hearthstone from "./src/hearthstone/index.js";
+import * as sc2 from "./src/starcraft2/index.js";
+export { authenticate, hearthstone, sc2, setup, wow };

package/script/mod.js

@@ -0,0 +1,35 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.wow = exports.setup = exports.sc2 = exports.hearthstone = exports.authenticate = void 0;
+const index_js_1 = require("./src/shared/index.js");
+Object.defineProperty(exports, "authenticate", { enumerable: true, get: function () { return index_js_1.authenticate; } });
+Object.defineProperty(exports, "setup", { enumerable: true, get: function () { return index_js_1.setup; } });
+const wow = __importStar(require("./src/wow/index.js"));
+exports.wow = wow;
+const hearthstone = __importStar(require("./src/hearthstone/index.js"));
+exports.hearthstone = hearthstone;
+const sc2 = __importStar(require("./src/starcraft2/index.js"));
+exports.sc2 = sc2;

package/script/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

package/script/src/hearthstone/game_data/card_backs.d.ts

@@ -0,0 +1,22 @@
+import type { LocalizedString } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface Cardback {
+    id: number;
+    sortCategory: number;
+    text: LocalizedString;
+    name: LocalizedString;
+}
+/**
+ * Returns an up-to-date list of all card backs matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all card backs matching the search criteria.
+ */
+export declare function searchCardbacks(searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns the card back with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card back by slug.
+ * @returns A promise that resolves to an object representing details about a card back.
+ */
+export declare function fetchCardback(idorslug: string): Promise<Cardback>;

package/script/src/hearthstone/game_data/card_backs.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCardback = exports.searchCardbacks = void 0;
+const index_js_1 = require("../../shared/index.js");
+const search_js_1 = require("../search.js");
+/**
+ * Returns an up-to-date list of all card backs matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all card backs matching the search criteria.
+ */
+async function searchCardbacks(searchParameters) {
+    return await (0, search_js_1.search)("/cardback", searchParameters);
+}
+exports.searchCardbacks = searchCardbacks;
+/**
+ * Returns the card back with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card back by slug.
+ * @returns A promise that resolves to an object representing details about a card back.
+ */
+async function fetchCardback(idorslug) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/hearthstone/cardback/${idorslug}`,
+    });
+}
+exports.fetchCardback = fetchCardback;

package/script/src/hearthstone/game_data/cards.d.ts

@@ -0,0 +1,37 @@
+import type { LocalizedString } from "../../shared/index.js";
+import type { Search, SearchParameters } from "../search.js";
+export interface Card {
+    id: number;
+    collectible: number;
+    slug: string;
+    classId: number;
+    multiClassIds: number[];
+    cardTypeId: number;
+    cardSetId: number;
+    rarityId: number;
+    artistName: string;
+    health: number;
+    attack: number;
+    manaCost: number;
+    name: LocalizedString;
+    text: LocalizedString;
+    image: string;
+    imageGold: string;
+    flavorText: LocalizedString;
+    cropImage: string;
+    keywordIds: number[];
+}
+/**
+ * Returns an up-to-date list of all cards matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all cards matching the search criteria.
+ */
+export declare function searchCards(searchParameters: SearchParameters): Promise<Search>;
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card by slug.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+export declare function fetchCard(idorslug: string, gameMode?: string): Promise<Card>;

package/script/src/hearthstone/game_data/cards.js

@@ -0,0 +1,32 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchCard = exports.searchCards = void 0;
+const index_js_1 = require("../../shared/index.js");
+const search_js_1 = require("../search.js");
+/**
+ * Returns an up-to-date list of all cards matching the search criteria.
+ *
+ * @param SearchParameters - Object containing search parameters.
+ * @returns A promise that resolves to an object representing an up-to-date list of all cards matching the search criteria.
+ */
+async function searchCards(searchParameters) {
+    return await (0, search_js_1.search)("/cards", searchParameters);
+}
+exports.searchCards = searchCards;
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param idorslug - The unique identifier for the card by slug.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+async function fetchCard(idorslug, gameMode) {
+    const reqOptions = {
+        method: "GET",
+        url: `/hearthstone/cards/${idorslug}`,
+    };
+    if (gameMode) {
+        reqOptions["qs"] = { gameMode };
+    }
+    return await (0, index_js_1.request)(reqOptions);
+}
+exports.fetchCard = fetchCard;

package/script/src/hearthstone/game_data/decks.d.ts

@@ -0,0 +1,88 @@
+import type { LocalizedString } from "../../shared/index.js";
+export interface Options {
+    code?: string;
+    ids?: string;
+    hero?: string;
+}
+export interface Deck {
+    deckCode: string;
+    version: number;
+    format: string;
+    hero: {
+        id: number;
+        collectible: number;
+        slug: string;
+        classId: number;
+        multiClassIds: number[];
+        cardTypeId: number;
+        cardSetId: number;
+        rarityId: number;
+        artistName: string;
+        health: number;
+        manaCost: number;
+        name: LocalizedString;
+        text: LocalizedString;
+        image: string;
+        imageGold: string;
+        flavorText: LocalizedString;
+        cropImage: string;
+        childIds: number[];
+    };
+    heroPower: {
+        id: number;
+        collectible: number;
+        slug: string;
+        classId: number;
+        multiClassIds: number[];
+        cardTypeId: number;
+        cardSetId: number;
+        rarityId: number;
+        artistName: null;
+        manaCost: number;
+        name: LocalizedString;
+        text: LocalizedString;
+        image: string;
+        imageGold: string;
+        flavorText: LocalizedString;
+        cropImage: string;
+        parentId: number;
+    };
+    class: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    };
+    cards: {
+        id: number;
+        collectible: number;
+        slug: string;
+        classId: number;
+        multiClassIds: number[];
+        cardTypeId: number;
+        cardSetId: number;
+        rarityId: number;
+        artistName: string;
+        health: number;
+        attack: number;
+        manaCost: number;
+        name: LocalizedString;
+        text: LocalizedString;
+        image: string;
+        imageGold: string;
+        flavorText: LocalizedString;
+        cropImage: string;
+        copyOfCardId: number;
+        duels: {
+            relevant: boolean;
+            constructed: boolean;
+        };
+    }[];
+    cardCount: number;
+}
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param options - find parameters fort the search.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+export declare function fetchDeck(options?: Options): Promise<Deck>;

package/script/src/hearthstone/game_data/decks.js

@@ -0,0 +1,18 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.fetchDeck = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * Returns the card with an ID or slug that matches the one you specify.
+ *
+ * @param options - find parameters fort the search.
+ * @returns A promise that resolves to an object representing details about a card.
+ */
+async function fetchDeck(options) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/hearthstone/deck`,
+        qs: options,
+    });
+}
+exports.fetchDeck = fetchDeck;

package/script/src/hearthstone/game_data/metadata.d.ts

@@ -0,0 +1,95 @@
+import type { LocalizedString } from "../../shared/index.js";
+export interface Metadata {
+    sets: {
+        id: number;
+        name: LocalizedString;
+        slug: string;
+        aliasSetIds?: number[];
+        type: string;
+        collectibleCount: number;
+        collectibleRevealedCount: number;
+        nonCollectibleCount: number;
+        nonCollectibleRevealedCount: number;
+    }[];
+    setGroups: {
+        slug: string;
+        year?: number;
+        svg?: string;
+        cardSets: string[];
+        name: LocalizedString;
+        standard?: boolean;
+        yearRange?: string;
+        icon?: string;
+    }[];
+    gameModes: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    }[];
+    arenaIds: number[];
+    types: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+        gameModes: number[];
+    }[];
+    rarities: {
+        slug: string;
+        id: number;
+        craftingCost: number[];
+        dustValue: number[];
+        name: LocalizedString;
+    }[];
+    classes: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+        cardId?: number;
+        heroPowerCardId?: number;
+        alternateHeroCardIds?: number[];
+    }[];
+    minionTypes: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+        gameModes: number[];
+    }[];
+    spellSchools: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    }[];
+    mercenaryRoles: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    }[];
+    mercenaryFactions: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    }[];
+    keywords: {
+        id: number;
+        slug: string;
+        name: LocalizedString;
+        refText: LocalizedString;
+        text: LocalizedString;
+        gameModes: number[];
+    }[];
+    filterableFields: string[];
+    numericFields: string[];
+    cardBackCategories: {
+        slug: string;
+        id: number;
+        name: LocalizedString;
+    }[];
+}
+type MetaTypes = "sets" | "setGroups" | "types" | "rarities" | "classes" | "minionTypes" | "keywords";
+/**
+ * Returns information about the categorization of cards. Metadata includes the card set, set group (for example, Standard or Year of the Dragon), rarity, class, card type, minion type, and keywords.
+ *
+ * @returns A promise that resolves to an object representing the Metadata.
+ */
+export declare function metadata(type: MetaTypes): Promise<Partial<Metadata>>;
+export {};

package/script/src/hearthstone/game_data/metadata.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.metadata = void 0;
+const index_js_1 = require("../../shared/index.js");
+/**
+ * Returns information about the categorization of cards. Metadata includes the card set, set group (for example, Standard or Year of the Dragon), rarity, class, card type, minion type, and keywords.
+ *
+ * @returns A promise that resolves to an object representing the Metadata.
+ */
+async function metadata(type) {
+    return await (0, index_js_1.request)({
+        method: "GET",
+        url: `/hearthstone/metadata/${type}`,
+    });
+}
+exports.metadata = metadata;

package/script/src/hearthstone/index.d.ts

@@ -0,0 +1,4 @@
+export { fetchCard, searchCards } from "./game_data/cards.js";
+export { fetchCardback, searchCardbacks } from "./game_data/card_backs.js";
+export { fetchDeck } from "./game_data/decks.js";
+export { metadata } from "./game_data/metadata.js";

package/script/src/hearthstone/index.js

@@ -0,0 +1,13 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.metadata = exports.fetchDeck = exports.searchCardbacks = exports.fetchCardback = exports.searchCards = exports.fetchCard = void 0;
+var cards_js_1 = require("./game_data/cards.js");
+Object.defineProperty(exports, "fetchCard", { enumerable: true, get: function () { return cards_js_1.fetchCard; } });
+Object.defineProperty(exports, "searchCards", { enumerable: true, get: function () { return cards_js_1.searchCards; } });
+var card_backs_js_1 = require("./game_data/card_backs.js");
+Object.defineProperty(exports, "fetchCardback", { enumerable: true, get: function () { return card_backs_js_1.fetchCardback; } });
+Object.defineProperty(exports, "searchCardbacks", { enumerable: true, get: function () { return card_backs_js_1.searchCardbacks; } });
+var decks_js_1 = require("./game_data/decks.js");
+Object.defineProperty(exports, "fetchDeck", { enumerable: true, get: function () { return decks_js_1.fetchDeck; } });
+var metadata_js_1 = require("./game_data/metadata.js");
+Object.defineProperty(exports, "metadata", { enumerable: true, get: function () { return metadata_js_1.metadata; } });