@pinta365/blizzard_api 0.3.9 → 0.5.0

package/script/src/diablo3/community/profile.js

@@ -0,0 +1,67 @@
+"use strict";
+/**
+ * This module provides the Diablo III profile endpoints (account, hero and hero items) using the Blizzard API.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.account = account;
+exports.hero = hero;
+exports.heroItems = heroItems;
+exports.heroFollowerItems = heroFollowerItems;
+/**
+ * The Battle.net APIs address battle tags with a `-` instead of the `#` separator, e.g. `Name#1234` becomes
+ * `Name-1234` in the URL.
+ */
+function battleTagPath(battleTag) {
+    return battleTag.replace("#", "-");
+}
+/**
+ * Returns the account profile of a battle tag, including its heroes.
+ *
+ * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+ * @returns A promise that resolves to an object representing the account profile.
+ */
+async function account(ctx, battleTag) {
+    return await ctx.request({
+        method: "GET",
+        url: `/d3/profile/${battleTagPath(battleTag)}/`,
+    });
+}
+/**
+ * Returns a hero of a battle tag.
+ *
+ * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+ * @param heroId - The unique identifier for the hero.
+ * @returns A promise that resolves to an object representing the hero.
+ */
+async function hero(ctx, battleTag, heroId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/d3/profile/${battleTagPath(battleTag)}/hero/${heroId}`,
+    });
+}
+/**
+ * Returns the equipped items of a hero.
+ *
+ * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+ * @param heroId - The unique identifier for the hero.
+ * @returns A promise that resolves to an object representing the hero's equipped items.
+ */
+async function heroItems(ctx, battleTag, heroId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/d3/profile/${battleTagPath(battleTag)}/hero/${heroId}/items`,
+    });
+}
+/**
+ * Returns the items equipped by a hero's followers.
+ *
+ * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+ * @param heroId - The unique identifier for the hero.
+ * @returns A promise that resolves to an object representing the hero's follower items.
+ */
+async function heroFollowerItems(ctx, battleTag, heroId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/d3/profile/${battleTagPath(battleTag)}/hero/${heroId}/follower-items`,
+    });
+}

package/script/src/diablo3/game_data/d3.d.ts

@@ -0,0 +1,127 @@
+import type { ApiContext } from "../../shared/index.js";
+import type { LinkSelfHref, LocalizedString } from "../../shared/index.js";
+export interface Seasons extends LinkSelfHref {
+    season: {
+        href: string;
+    }[];
+    current_season: number;
+    service_current_season: number;
+    service_season_state: string;
+    last_update_time: string;
+    generated_by: string;
+}
+export interface Season extends LinkSelfHref {
+    leaderboard: {
+        team_size?: number;
+        ladder: {
+            href: string;
+        };
+        hardcore?: boolean;
+        hero_class_string?: LocalizedString;
+    }[];
+    season_id: number;
+    last_update_time: string;
+    generated_by: string;
+}
+export interface LeaderboardData {
+    id: string;
+    string?: string;
+    number?: number;
+    timestamp?: number;
+}
+export interface LeaderboardBase extends LinkSelfHref {
+    row: {
+        player: {
+            key: string;
+            accountId: number;
+            data: LeaderboardData[];
+        }[];
+        order: number;
+        data: LeaderboardData[];
+    }[];
+    key: string;
+    title: LocalizedString;
+    column: {
+        id: string;
+        hidden: boolean;
+        order?: number;
+        label: LocalizedString | null;
+        type: string;
+    }[];
+    last_update_time: string;
+    generated_by: string;
+    hardcore?: boolean;
+}
+export interface SeasonLeaderboard extends LeaderboardBase {
+    achievement_points: boolean;
+    season: number;
+}
+export interface EraLeaderboard extends LeaderboardBase {
+    greater_rift: boolean;
+    greater_rift_solo_class: string;
+    era: number;
+}
+export interface Eras extends LinkSelfHref {
+    era: {
+        href: string;
+    }[];
+    current_era: number;
+    last_update_time: string;
+    generated_by: string;
+}
+export interface Era extends LinkSelfHref {
+    leaderboard: {
+        team_size?: number;
+        ladder: {
+            href: string;
+        };
+        hardcore?: boolean;
+        hero_class_string?: LocalizedString;
+    }[];
+    era_id: number;
+    era_start_date: number;
+    last_update_time: string;
+    generated_by: string;
+}
+/**
+ * Returns an index of available seasons.
+ *
+ * @returns A promise that resolves to an object representing an index of available seasons.
+ */
+export declare function seasons(ctx: ApiContext): Promise<Seasons>;
+/**
+ * Returns an index of available seasons.
+ *
+ * @param seasonId - The season for the leaderboard list.
+ * @returns A promise that resolves to an object representing the data for a league.
+ */
+export declare function season(ctx: ApiContext, seasonId: number): Promise<Season>;
+/**
+ * Returns a the specified leaderboard for the specified season.
+ *
+ * @param seasonId - The season for the leaderboard.
+ * @param leaderboard - The leaderboard to retrieve.
+ * @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified season.
+ */
+export declare function seasonLeaderboard(ctx: ApiContext, seasonId: number, leaderboard: string): Promise<SeasonLeaderboard>;
+/**
+ * Returns an index of available eras.
+ *
+ * @returns A promise that resolves to an object representing an index of available eras.
+ */
+export declare function eras(ctx: ApiContext): Promise<Eras>;
+/**
+ * Returns a leaderboard list for a particular era.
+ *
+ * @param eraId - The era to retrieve.
+ * @returns A promise that resolves to an object representing a leaderboard list for a particular era.
+ */
+export declare function era(ctx: ApiContext, eraId: number): Promise<Era>;
+/**
+ * Returns the specified leaderboard for the specified era.
+ *
+ * @param eraId - The era for the leaderboard.
+ * @param leaderboard - The leaderboard to retrieve.
+ * @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified era.
+ */
+export declare function eraLeaderboard(ctx: ApiContext, eraId: number, leaderboard: string): Promise<EraLeaderboard>;

package/script/src/diablo3/game_data/d3.js

@@ -0,0 +1,80 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.seasons = seasons;
+exports.season = season;
+exports.seasonLeaderboard = seasonLeaderboard;
+exports.eras = eras;
+exports.era = era;
+exports.eraLeaderboard = eraLeaderboard;
+/**
+ * Returns an index of available seasons.
+ *
+ * @returns A promise that resolves to an object representing an index of available seasons.
+ */
+async function seasons(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/d3/season/",
+    });
+}
+/**
+ * Returns an index of available seasons.
+ *
+ * @param seasonId - The season for the leaderboard list.
+ * @returns A promise that resolves to an object representing the data for a league.
+ */
+async function season(ctx, seasonId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/d3/season/${seasonId}`,
+    });
+}
+/**
+ * Returns a the specified leaderboard for the specified season.
+ *
+ * @param seasonId - The season for the leaderboard.
+ * @param leaderboard - The leaderboard to retrieve.
+ * @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified season.
+ */
+async function seasonLeaderboard(ctx, seasonId, leaderboard) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/d3/season/${seasonId}/leaderboard/${leaderboard}`,
+    });
+}
+/**
+ * Returns an index of available eras.
+ *
+ * @returns A promise that resolves to an object representing an index of available eras.
+ */
+async function eras(ctx) {
+    return await ctx.request({
+        method: "GET",
+        url: "/data/d3/era/",
+    });
+}
+/**
+ * Returns a leaderboard list for a particular era.
+ *
+ * @param eraId - The era to retrieve.
+ * @returns A promise that resolves to an object representing a leaderboard list for a particular era.
+ */
+async function era(ctx, eraId) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/d3/era/${eraId}`,
+    });
+}
+/**
+ * Returns the specified leaderboard for the specified era.
+ *
+ * @param eraId - The era for the leaderboard.
+ * @param leaderboard - The leaderboard to retrieve.
+ * @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified era.
+ */
+async function eraLeaderboard(ctx, eraId, leaderboard) {
+    return await ctx.request({
+        method: "GET",
+        url: `/data/d3/era/${eraId}/leaderboard/${leaderboard}`,
+    });
+}

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

@@ -0,0 +1,8 @@
+export { era, eraLeaderboard, eras, season, seasonLeaderboard, seasons } from "./game_data/d3.js";
+export { act, acts } from "./community/act.js";
+export { artisan, artisanRecipe } from "./community/artisan.js";
+export { follower } from "./community/follower.js";
+export { heroClass, heroSkill } from "./community/hero.js";
+export { itemType, itemTypes } from "./community/item_type.js";
+export { item } from "./community/item.js";
+export { account, hero, heroFollowerItems, heroItems } from "./community/profile.js";

package/script/src/diablo3/index.js

@@ -0,0 +1,31 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.heroItems = exports.heroFollowerItems = exports.hero = exports.account = exports.item = exports.itemTypes = exports.itemType = exports.heroSkill = exports.heroClass = exports.follower = exports.artisanRecipe = exports.artisan = exports.acts = exports.act = exports.seasons = exports.seasonLeaderboard = exports.season = exports.eras = exports.eraLeaderboard = exports.era = void 0;
+var d3_js_1 = require("./game_data/d3.js");
+Object.defineProperty(exports, "era", { enumerable: true, get: function () { return d3_js_1.era; } });
+Object.defineProperty(exports, "eraLeaderboard", { enumerable: true, get: function () { return d3_js_1.eraLeaderboard; } });
+Object.defineProperty(exports, "eras", { enumerable: true, get: function () { return d3_js_1.eras; } });
+Object.defineProperty(exports, "season", { enumerable: true, get: function () { return d3_js_1.season; } });
+Object.defineProperty(exports, "seasonLeaderboard", { enumerable: true, get: function () { return d3_js_1.seasonLeaderboard; } });
+Object.defineProperty(exports, "seasons", { enumerable: true, get: function () { return d3_js_1.seasons; } });
+var act_js_1 = require("./community/act.js");
+Object.defineProperty(exports, "act", { enumerable: true, get: function () { return act_js_1.act; } });
+Object.defineProperty(exports, "acts", { enumerable: true, get: function () { return act_js_1.acts; } });
+var artisan_js_1 = require("./community/artisan.js");
+Object.defineProperty(exports, "artisan", { enumerable: true, get: function () { return artisan_js_1.artisan; } });
+Object.defineProperty(exports, "artisanRecipe", { enumerable: true, get: function () { return artisan_js_1.artisanRecipe; } });
+var follower_js_1 = require("./community/follower.js");
+Object.defineProperty(exports, "follower", { enumerable: true, get: function () { return follower_js_1.follower; } });
+var hero_js_1 = require("./community/hero.js");
+Object.defineProperty(exports, "heroClass", { enumerable: true, get: function () { return hero_js_1.heroClass; } });
+Object.defineProperty(exports, "heroSkill", { enumerable: true, get: function () { return hero_js_1.heroSkill; } });
+var item_type_js_1 = require("./community/item_type.js");
+Object.defineProperty(exports, "itemType", { enumerable: true, get: function () { return item_type_js_1.itemType; } });
+Object.defineProperty(exports, "itemTypes", { enumerable: true, get: function () { return item_type_js_1.itemTypes; } });
+var item_js_1 = require("./community/item.js");
+Object.defineProperty(exports, "item", { enumerable: true, get: function () { return item_js_1.item; } });
+var profile_js_1 = require("./community/profile.js");
+Object.defineProperty(exports, "account", { enumerable: true, get: function () { return profile_js_1.account; } });
+Object.defineProperty(exports, "hero", { enumerable: true, get: function () { return profile_js_1.hero; } });
+Object.defineProperty(exports, "heroFollowerItems", { enumerable: true, get: function () { return profile_js_1.heroFollowerItems; } });
+Object.defineProperty(exports, "heroItems", { enumerable: true, get: function () { return profile_js_1.heroItems; } });

package/script/src/diablo3/types.d.ts

@@ -0,0 +1,8 @@
+export type { Act, Acts } from "./community/act.js";
+export type { Artisan, Recipe } from "./community/artisan.js";
+export type { Follower } from "./community/follower.js";
+export type { HeroClass, HeroSkill, HeroSkillDetail, SkillRune } from "./community/hero.js";
+export type { Item } from "./community/item.js";
+export type { ItemType, ItemTypes } from "./community/item_type.js";
+export type { D3Account, D3AccountHero, D3ActProgress, D3Artisan, D3Attributes, D3CraftedBy, D3FallenHero, D3Follower, D3FollowerItems, D3FollowerStats, D3Gem, D3Hero, D3HeroFollowerItems, D3HeroItem, D3HeroItems, D3HeroStats, D3ItemColor, D3ItemRef, D3ItemSet, D3ItemType, D3Kills, D3SeasonalProfile, D3Skill, D3SkillRune, } from "./community/profile.js";
+export type { Era, EraLeaderboard, Eras, LeaderboardBase, LeaderboardData, Season, SeasonLeaderboard, Seasons, } from "./game_data/d3.js";

package/script/src/diablo3/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/src/generated/diablo3_api.d.ts

@@ -0,0 +1,156 @@
+import type { Act, Acts } from "../diablo3/community/act.js";
+import type { Artisan, Recipe } from "../diablo3/community/artisan.js";
+import type { D3Account, D3Hero, D3HeroFollowerItems, D3HeroItems } from "../diablo3/community/profile.js";
+import type { Era, EraLeaderboard, Eras, Season, SeasonLeaderboard, Seasons } from "../diablo3/game_data/d3.js";
+import type { Follower } from "../diablo3/community/follower.js";
+import type { HeroClass, HeroSkillDetail } from "../diablo3/community/hero.js";
+import type { Item } from "../diablo3/community/item.js";
+import type { ItemType, ItemTypes } from "../diablo3/community/item_type.js";
+/**
+ * Diablo III endpoints.
+ */
+export interface Diablo3Api {
+    /**
+     * Returns the account profile of a battle tag, including its heroes.
+     *
+     * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+     * @returns A promise that resolves to an object representing the account profile.
+     */
+    account(battleTag: string): Promise<D3Account>;
+    /**
+     * Returns a single act by ID.
+     *
+     * @param seasonId - The season for the leaderboard list.
+     * @returns A promise that resolves to an object representing the data for a single act by ID.
+     */
+    act(seasonId: number): Promise<Act>;
+    /**
+     * Returns an index of acts.
+     *
+     * @returns A promise that resolves to an object representing an index of acts.
+     */
+    acts(): Promise<Acts>;
+    /**
+     * Returns a single artisan by slug.
+     *
+     * @param artisanSlug - The slug of the artisan to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single artisan by slug.
+     */
+    artisan(artisanSlug: string): Promise<Artisan>;
+    /**
+     * Returns a single recipe by slug for the specified artisan.
+     *
+     * @param artisanSlug - The slug of the artisan to retrieve.
+     * @param recipeSlug - The slug of the recipe to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single recipe by slug for the specified artisan.
+     */
+    artisanRecipe(artisanSlug: string, recipeSlug: string): Promise<Recipe>;
+    /**
+     * Returns a leaderboard list for a particular era.
+     *
+     * @param eraId - The era to retrieve.
+     * @returns A promise that resolves to an object representing a leaderboard list for a particular era.
+     */
+    era(eraId: number): Promise<Era>;
+    /**
+     * Returns the specified leaderboard for the specified era.
+     *
+     * @param eraId - The era for the leaderboard.
+     * @param leaderboard - The leaderboard to retrieve.
+     * @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified era.
+     */
+    eraLeaderboard(eraId: number, leaderboard: string): Promise<EraLeaderboard>;
+    /**
+     * Returns an index of available eras.
+     *
+     * @returns A promise that resolves to an object representing an index of available eras.
+     */
+    eras(): Promise<Eras>;
+    /**
+     * Returns a single follower by slug.
+     *
+     * @param followerSlug - The slug of the follower to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single follower by slug.
+     */
+    follower(followerSlug: string): Promise<Follower>;
+    /**
+     * Returns a hero of a battle tag.
+     *
+     * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+     * @param heroId - The unique identifier for the hero.
+     * @returns A promise that resolves to an object representing the hero.
+     */
+    hero(battleTag: string, heroId: number): Promise<D3Hero>;
+    /**
+     * Returns a single character class by slug.
+     *
+     * @param classSlug - The slug of the character class to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single follower by slug.
+     */
+    heroClass(classSlug: string): Promise<HeroClass>;
+    /**
+     * Returns the items equipped by a hero's followers.
+     *
+     * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+     * @param heroId - The unique identifier for the hero.
+     * @returns A promise that resolves to an object representing the hero's follower items.
+     */
+    heroFollowerItems(battleTag: string, heroId: number): Promise<D3HeroFollowerItems>;
+    /**
+     * Returns the equipped items of a hero.
+     *
+     * @param battleTag - The battle tag, e.g. "Name#1234" (the "#" is sent as "-").
+     * @param heroId - The unique identifier for the hero.
+     * @returns A promise that resolves to an object representing the hero's equipped items.
+     */
+    heroItems(battleTag: string, heroId: number): Promise<D3HeroItems>;
+    /**
+     * Returns a single skill by slug for a specific character class.
+     *
+     * @param classSlug - The slug of the character class to retrieve.
+     * @param skillSlug - The slug of the skill to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single skill by slug for a specific character class.
+     */
+    heroSkill(classSlug: string, skillSlug: string): Promise<HeroSkillDetail>;
+    /**
+     * Returns a single item by item slug and ID.
+     *
+     * @param itemSlugAndId - The slug and ID of the item to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single item by item slug and ID.
+     */
+    item(itemSlugAndId: string): Promise<Item>;
+    /**
+     * Returns a single item type by slug.
+     *
+     * @param itemTypeSlug - The slug of the item type to retrieve.
+     * @returns A promise that resolves to an object representing the data for a single item type by slug.
+     */
+    itemType(itemTypeSlug: string): Promise<ItemType[]>;
+    /**
+     * Returns an index of item types.
+     *
+     * @returns A promise that resolves to an object representing an index of item types.
+     */
+    itemTypes(): Promise<ItemTypes[]>;
+    /**
+     * Returns an index of available seasons.
+     *
+     * @param seasonId - The season for the leaderboard list.
+     * @returns A promise that resolves to an object representing the data for a league.
+     */
+    season(seasonId: number): Promise<Season>;
+    /**
+     * Returns a the specified leaderboard for the specified season.
+     *
+     * @param seasonId - The season for the leaderboard.
+     * @param leaderboard - The leaderboard to retrieve.
+     * @returns A promise that resolves to an object representing the data for a the specified leaderboard for the specified season.
+     */
+    seasonLeaderboard(seasonId: number, leaderboard: string): Promise<SeasonLeaderboard>;
+    /**
+     * Returns an index of available seasons.
+     *
+     * @returns A promise that resolves to an object representing an index of available seasons.
+     */
+    seasons(): Promise<Seasons>;
+}

package/script/src/generated/diablo3_api.js

@@ -0,0 +1,3 @@
+"use strict";
+// Generated by scripts/gen_api.ts from src/diablo3/index.ts. Do not edit; run `deno task gen:api`.
+Object.defineProperty(exports, "__esModule", { value: true });

package/script/src/generated/hearthstone_api.d.ts

@@ -0,0 +1,51 @@
+import type { Card, CardSearch } from "../hearthstone/game_data/cards.js";
+import type { Cardback, CardbackSearch } from "../hearthstone/game_data/card_backs.js";
+import type { Deck, Options } from "../hearthstone/game_data/decks.js";
+import type { MetadataByType, MetaTypes } from "../hearthstone/game_data/metadata.js";
+import type { SearchParameters } from "../hearthstone/search.js";
+/**
+ * Hearthstone endpoints.
+ */
+export interface HearthstoneApi {
+    /**
+     * 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.
+     */
+    fetchCard(idorslug: string, gameMode?: string): Promise<Card>;
+    /**
+     * 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.
+     */
+    fetchCardback(idorslug: string): Promise<Cardback>;
+    /**
+     * 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.
+     */
+    fetchDeck(options?: Options): Promise<Deck>;
+    /**
+     * 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.
+     */
+    metadata<T extends MetaTypes>(type: T): Promise<MetadataByType[T]>;
+    /**
+     * 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.
+     */
+    searchCardbacks(searchParameters: SearchParameters): Promise<CardbackSearch>;
+    /**
+     * 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.
+     */
+    searchCards(searchParameters: SearchParameters): Promise<CardSearch>;
+}

package/script/src/generated/hearthstone_api.js

@@ -0,0 +1,3 @@
+"use strict";
+// Generated by scripts/gen_api.ts from src/hearthstone/index.ts. Do not edit; run `deno task gen:api`.
+Object.defineProperty(exports, "__esModule", { value: true });