@blizzard-api/wow 2.0.2 → 2.1.0-next.0

package/dist/creature/types.d.ts

@@ -0,0 +1,107 @@
+import { BaseSearchParameters, Locales } from '@blizzard-api/core';
+import { ResponseBase, NameIdKey, MediaAsset, KeyBase } from '../base.js';
+
+/**
+ * The response for creature display media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureDisplayMediaResponse extends ResponseBase {
+    assets: Array<DisplayMediaAsset>;
+    id: number;
+}
+/**
+ * The response for a creature family index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureFamilyIndexResponse extends ResponseBase {
+    creature_families: Array<NameIdKey>;
+}
+/**
+ * The response for creature family media.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureFamilyMediaResponse extends ResponseBase {
+    assets: Array<MediaAsset>;
+    id: number;
+}
+/**
+ * The response for a creature family.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureFamilyResponse extends ResponseBase {
+    id: number;
+    media: Media;
+    name: string;
+    specialization: NameIdKey;
+}
+/**
+ * The response for a creature.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureResponse extends ResponseBase {
+    creature_displays: Array<CreatureDisplay>;
+    family: NameIdKey;
+    id: number;
+    is_tameable: boolean;
+    name: string;
+    type: NameIdKey;
+}
+/**
+ * The search parameters for a creature.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface CreatureSearchParameters extends BaseSearchParameters {
+    locale: Locales;
+    name: string;
+}
+/**
+ * The response for a creature search.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/guides/search}
+ */
+interface CreatureSearchResponseItem extends KeyBase {
+    data: {
+        creature_displays: Array<{
+            id: number;
+        }>;
+        family?: {
+            id: number;
+            name: Record<Locales, string | undefined>;
+        };
+        id: number;
+        is_tameable: boolean;
+        name: Record<Locales, string | undefined>;
+        type: {
+            id: number;
+            name: Record<Locales, string | undefined>;
+        };
+    };
+}
+/**
+ * The response for a creature type index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureTypeIndexResponse extends ResponseBase {
+    creature_types: Array<NameIdKey>;
+}
+/**
+ * The response for a creature type.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface CreatureTypeResponse extends ResponseBase {
+    id: number;
+    name: string;
+}
+interface CreatureDisplay extends KeyBase {
+    id: number;
+}
+interface DisplayMediaAsset {
+    key: string;
+    value: string;
+}
+interface Media extends KeyBase {
+    id: number;
+}
+
+export type { CreatureDisplayMediaResponse, CreatureFamilyIndexResponse, CreatureFamilyMediaResponse, CreatureFamilyResponse, CreatureResponse, CreatureSearchParameters, CreatureSearchResponseItem, CreatureTypeIndexResponse, CreatureTypeResponse };

package/dist/creature/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/creature/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/guild/guild.d.ts

@@ -0,0 +1,30 @@
+import { Resource } from '@blizzard-api/core';
+import { GuildResponse, GuildAchievementsResponse, GuildActivityResponse, GuildRosterResponse } from './types.js';
+import '../base.js';
+
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild by its name and realm.
+ */
+declare function guild(realmSlug: string, nameSlug: string): Resource<GuildResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's achievements by name and realm.
+ */
+declare function guildAchievements(realmSlug: string, nameSlug: string): Resource<GuildAchievementsResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's activity by name and realm.
+ */
+declare function guildActivity(realmSlug: string, nameSlug: string): Resource<GuildActivityResponse>;
+/**
+ * @param realmSlug The slug of the realm.
+ * @param nameSlug The lowercase name of the guild.
+ * @returns a single guild's roster by its name and realm.
+ */
+declare function guildRoster(realmSlug: string, nameSlug: string): Resource<GuildRosterResponse>;
+
+export { guild, guildAchievements, guildActivity, guildRoster };

package/dist/guild/guild.js

@@ -0,0 +1,3 @@
+export { guild, guildAchievements, guildActivity, guildRoster } from '../chunk-3W2TUGVY.js';
+//# sourceMappingURL=guild.js.map
+//# sourceMappingURL=guild.js.map

package/dist/guild/guild.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"guild.js"}

package/dist/guild/types.d.ts

@@ -0,0 +1,100 @@
+import { ResponseBase, Href, Faction, Realm, NameIdKey, Character, Color, KeyBase } from '../base.js';
+
+interface GuildAchievementsResponse extends ResponseBase {
+    achievements: Array<Achievement>;
+    category_progress: Array<CategoryProgress>;
+    guild: Guild;
+    recent_events: Array<RecentEvent>;
+    total_points: number;
+    total_quantity: number;
+}
+interface GuildActivityResponse extends ResponseBase {
+    activities: Array<ActivityElement>;
+    guild: Guild;
+}
+interface GuildResponse extends ResponseBase {
+    achievement_points: number;
+    achievements: Href;
+    activity: Href;
+    created_timestamp: number;
+    crest: Crest;
+    faction: Faction;
+    id: number;
+    member_count: number;
+    name: string;
+    name_search: string;
+    realm: Realm;
+    roster: Href;
+}
+interface GuildRosterResponse extends ResponseBase {
+    guild: Guild;
+    members: Array<Member>;
+}
+interface Achievement {
+    achievement: NameIdKey;
+    completed_timestamp?: number;
+    criteria?: Criteria;
+    id: number;
+}
+interface ActivityElement {
+    activity: {
+        type: string;
+    };
+    character_achievement: CharacterAchievement;
+    timestamp: number;
+}
+interface Border {
+    color: RgbWithId;
+    id: number;
+    media: KeyBase & {
+        id: number;
+    };
+}
+interface CategoryProgress {
+    category: NameIdKey;
+    points: number;
+    quantity: number;
+}
+interface CharacterAchievement {
+    achievement: NameIdKey;
+    character: Character;
+}
+interface Crest {
+    background: {
+        color: RgbWithId;
+    };
+    border: Border;
+    emblem: Border;
+}
+interface Criteria {
+    amount?: number;
+    child_criteria?: Array<Criteria>;
+    id: number;
+    is_completed: boolean;
+}
+interface Guild extends NameIdKey {
+    faction: Faction;
+    realm: Realm;
+}
+interface Member {
+    character: RosterMemberCharacter;
+    rank: number;
+}
+interface Playable extends KeyBase {
+    id: number;
+}
+interface RecentEvent {
+    achievement: NameIdKey;
+    timestamp: number;
+}
+interface RgbWithId {
+    id: number;
+    rgba: Color;
+}
+interface RosterMemberCharacter extends Character {
+    level: number;
+    playable_class: Playable;
+    playable_race: Playable;
+}
+
+export type { GuildAchievementsResponse, GuildActivityResponse, GuildResponse, GuildRosterResponse };

package/dist/guild/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/guild/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/guild-crest/guild-crest.d.ts

@@ -0,0 +1,23 @@
+import { Resource } from '@blizzard-api/core';
+import { GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Get a guild crest border by ID.
+ * @param borderId The guild crest border ID.
+ * @returns The guild crest border. See {@link GuildCrestBorderEmblemResponse}.
+ */
+declare function guildCrestBorder(borderId: number): Resource<GuildCrestBorderEmblemResponse>;
+/**
+ * Get the guild crest components index.
+ * @returns The guild crest components index. See {@link GuildCrestComponentsIndexResponse}.
+ */
+declare function guildCrestComponentsIndex(): Resource<GuildCrestComponentsIndexResponse>;
+/**
+ * Get a guild crest emblem by ID.
+ * @param emblemId The guild crest emblem ID.
+ * @returns The guild crest emblem. See {@link GuildCrestBorderEmblemResponse}.
+ */
+declare function guildCrestEmblem(emblemId: number): Resource<GuildCrestBorderEmblemResponse>;
+
+export { guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem };

package/dist/guild-crest/guild-crest.js

@@ -0,0 +1,4 @@
+export { guildCrestBorder, guildCrestComponentsIndex, guildCrestEmblem } from '../chunk-24236PHF.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=guild-crest.js.map
+//# sourceMappingURL=guild-crest.js.map

package/dist/guild-crest/guild-crest.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"guild-crest.js"}

package/dist/guild-crest/types.d.ts

@@ -0,0 +1,47 @@
+import { ResponseBase, KeyBase } from '../base.js';
+
+/**
+ * The response for a guild crest border or emblem.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface GuildCrestBorderEmblemResponse extends ResponseBase {
+    assets: Array<GuildCrestAsset>;
+    id: number;
+}
+/**
+ * The response for the guild crest components index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface GuildCrestComponentsIndexResponse extends ResponseBase {
+    borders: Array<Border>;
+    colors: Colors;
+    emblems: Array<Border>;
+}
+interface Background {
+    id: number;
+    rgba: RGBA;
+}
+interface Border {
+    id: number;
+    media: Media;
+}
+interface Colors {
+    backgrounds: Array<Background>;
+    borders: Array<Background>;
+    emblems: Array<Background>;
+}
+interface GuildCrestAsset {
+    key: string;
+    value: string;
+}
+interface Media extends KeyBase {
+    id: number;
+}
+interface RGBA {
+    a: number;
+    b: number;
+    g: number;
+    r: number;
+}
+
+export type { GuildCrestBorderEmblemResponse, GuildCrestComponentsIndexResponse };

package/dist/guild-crest/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/guild-crest/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}

package/dist/heirloom/heirloom.d.ts

@@ -0,0 +1,17 @@
+import { Resource } from '@blizzard-api/core';
+import { HeirloomResponse, HeirloomIndexResponse } from './types.js';
+import '../base.js';
+
+/**
+ * Get a heirloom by ID.
+ * @param heirloomId The heirloom ID.
+ * @returns The heirloom. See {@link HeirloomResponse}.
+ */
+declare function heirloom(heirloomId: number): Resource<HeirloomResponse>;
+/**
+ * Get the heirloom index.
+ * @returns The heirloom index. See {@link HeirloomIndexResponse}.
+ */
+declare function heirloomIndex(): Resource<HeirloomIndexResponse>;
+
+export { heirloom, heirloomIndex };

package/dist/heirloom/heirloom.js

@@ -0,0 +1,4 @@
+export { heirloom, heirloomIndex } from '../chunk-DEHA3454.js';
+import '../chunk-LTJAQT2G.js';
+//# sourceMappingURL=heirloom.js.map
+//# sourceMappingURL=heirloom.js.map

package/dist/heirloom/heirloom.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"heirloom.js"}

package/dist/heirloom/types.d.ts

@@ -0,0 +1,87 @@
+import { ResponseBase, NameIdKey, KeyBase, Color } from '../base.js';
+
+/**
+ * The response for the heirloom index.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface HeirloomIndexResponse extends ResponseBase {
+    heirlooms: Array<NameIdKey>;
+}
+/**
+ * The response for a heirloom.
+ * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
+ */
+interface HeirloomResponse extends ResponseBase {
+    id: number;
+    item: NameIdKey;
+    media: Media;
+    source: Source;
+    source_description: string;
+    upgrades: Array<Upgrade>;
+}
+interface AttackSpeedClass {
+    display_string: string;
+    value: number;
+}
+interface Damage {
+    damage_class: Source;
+    display_string: string;
+    max_value: number;
+    min_value: number;
+}
+interface Display {
+    color: Color;
+    display_string: string;
+}
+interface Media extends KeyBase {
+    id: number;
+}
+interface Requirements {
+    level: RequirementsLevel;
+}
+interface RequirementsLevel {
+    display_string: string;
+}
+interface Source {
+    name: string;
+    type: string;
+}
+interface Stat {
+    display: Display;
+    is_equip_bonus?: boolean;
+    type: Source;
+    value: number;
+}
+interface Upgrade {
+    item: UpgradeItem;
+    level: number;
+}
+interface UpgradeItem {
+    binding: Source;
+    bonus_list: Array<number>;
+    context: number;
+    inventory_type: Source;
+    item: Media;
+    item_class: NameIdKey;
+    item_subclass: NameIdKey;
+    level: AttackSpeedClass;
+    media: Media;
+    name: string;
+    quality: Source;
+    requirements: Requirements;
+    stats: Array<Stat>;
+    upgrades: Upgrades;
+    weapon: Weapon;
+}
+interface Upgrades {
+    display_string: string;
+    max_value: number;
+    value: number;
+}
+interface Weapon {
+    attack_speed: AttackSpeedClass;
+    damage: Damage;
+    dps: AttackSpeedClass;
+}
+
+export type { HeirloomIndexResponse, HeirloomResponse };

package/dist/heirloom/types.js

@@ -0,0 +1,3 @@
+
+//# sourceMappingURL=types.js.map
+//# sourceMappingURL=types.js.map

package/dist/heirloom/types.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"names":[],"mappings":"","file":"types.js"}