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

package/dist/guild/guild.d.ts

@@ -1,30 +0,0 @@
-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

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

package/dist/guild/guild.js.map

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

package/dist/guild/types.d.ts

@@ -1,100 +0,0 @@
-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

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

package/dist/guild/types.js.map

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

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

@@ -1,23 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

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

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

@@ -1,47 +0,0 @@
-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

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

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

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

package/dist/heirloom/heirloom.d.ts

@@ -1,17 +0,0 @@
-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

@@ -1,4 +0,0 @@
-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

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

package/dist/heirloom/types.d.ts

@@ -1,87 +0,0 @@
-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

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

package/dist/heirloom/types.js.map

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

package/dist/item/item.d.ts

@@ -1,53 +0,0 @@
-import { Resource, SearchResponse } from '@blizzard-api/core';
-import { ItemResponse, ItemClassResponse, ItemClassIndexResponse, ItemMediaResponse, ItemSearchParameters, ItemSearchResponseItem, ItemSetResponse, ItemSetIndexResponse, ItemSubClassResponse } from './types.js';
-import '../base.js';
-
-/**
- * Get an item by ID.
- * @param itemId The item ID.
- * @returns The item. See {@link ItemResponse}.
- */
-declare function item(itemId: number): Resource<ItemResponse>;
-/**
- * Get an item class by ID.
- * @param itemClassId The item class ID.
- * @returns The item class. See {@link ItemClassResponse}.
- */
-declare function itemClass(itemClassId: number): Resource<ItemClassResponse>;
-/**
- * Get an item class index.
- * @returns The item class index. See {@link ItemClassIndexResponse}.
- */
-declare function itemClassIndex(): Resource<ItemClassIndexResponse>;
-/**
- * Get item media by ID.
- * @param itemId The item ID.
- * @returns The item media. See {@link ItemMediaResponse}.
- */
-declare function itemMedia(itemId: number): Resource<ItemMediaResponse>;
-/**
- * Search for items.
- * @param options The search parameters. See {@link ItemSearchParameters}.
- * @returns The search results. See {@link SearchResponse}.
- */
-declare function itemSearch(options: ItemSearchParameters): Resource<SearchResponse<ItemSearchResponseItem>, Omit<ItemSearchParameters, 'locale' | 'name'>>;
-/**
- * Get an item set by ID.
- * @param itemSetId The item set ID.
- * @returns The item set. See {@link ItemSetResponse}.
- */
-declare function itemSet(itemSetId: number): Resource<ItemSetResponse>;
-/**
- * Get an item set index.
- * @returns The item set index. See {@link ItemSetIndexResponse}.
- */
-declare function itemSetIndex(): Resource<ItemSetIndexResponse>;
-/**
- * Get an item subclass by ID.
- * @param itemClassId The item class ID.
- * @param itemSubclassId The item subclass ID.
- * @returns The item subclass. See {@link ItemSubClassResponse}.
- */
-declare function itemSubClass(itemClassId: number, itemSubclassId: number): Resource<ItemSubClassResponse>;
-
-export { item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass };

package/dist/item/item.js

@@ -1,4 +0,0 @@
-export { item, itemClass, itemClassIndex, itemMedia, itemSearch, itemSet, itemSetIndex, itemSubClass } from '../chunk-RYBCDOQV.js';
-import '../chunk-LTJAQT2G.js';
-//# sourceMappingURL=item.js.map
-//# sourceMappingURL=item.js.map

package/dist/item/item.js.map

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

package/dist/item/types.d.ts

@@ -1,244 +0,0 @@
-import { BaseSearchParameters, Locales } from '@blizzard-api/core';
-import { ResponseBase, NameIdKey, MediaAsset, NameId, KeyBase, Color } from '../base.js';
-
-/**
- * The response for an item class index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemClassIndexResponse extends ResponseBase {
-    item_classes: Array<NameIdKey>;
-}
-/**
- * The response for an item class.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemClassResponse extends ResponseBase {
-    class_id: number;
-    item_subclasses: Array<NameIdKey>;
-    name: string;
-}
-/**
- * The response for an item media.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemMediaResponse extends ResponseBase {
-    assets: Array<MediaAsset>;
-    id: number;
-}
-/**
- * The response for an item.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemResponse extends NameId, ResponseBase {
-    description?: string;
-    inventory_type: InventoryType;
-    is_equippable: boolean;
-    is_stackable: boolean;
-    item_class: NameIdKey;
-    item_subclass: NameIdKey;
-    level: number;
-    max_count: number;
-    media: Media;
-    preview_item: PreviewItem;
-    purchase_price: number;
-    purchase_quantity: number;
-    quality: ItemQuality;
-    required_level: number;
-    sell_price: number;
-}
-/**
- * The parameters for an item 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 ItemSearchParameters extends BaseSearchParameters {
-    locale: Locales;
-    name: string;
-}
-/**
- * The response for an item 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 ItemSearchResponseItem extends KeyBase {
-    data: {
-        id: number;
-        inventory_type: InventoryType;
-        is_equippable: boolean;
-        is_stackable: boolean;
-        item_class: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-        item_subclass: {
-            id: number;
-            name: Record<Locales, string | undefined>;
-        };
-        level: number;
-        max_count: number;
-        media: {
-            id: number;
-        };
-        name: Record<Locales, string | undefined>;
-        purchase_price: number;
-        purchase_quantity: number;
-        quality: ItemQuality;
-        required_level: number;
-        sell_price: number;
-    };
-}
-/**
- * The response for an item set index.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemSetIndexResponse extends ResponseBase {
-    item_sets: Array<NameIdKey>;
-}
-/**
- * The response for an item set.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemSetResponse extends ResponseBase {
-    effects: Array<Effect>;
-    id: number;
-    items: Array<NameIdKey>;
-    name: string;
-}
-/**
- * The response for an item subclass.
- * @see {@link https://develop.battle.net/documentation/world-of-warcraft/game-data-apis}
- */
-interface ItemSubClassResponse extends ResponseBase {
-    class_id: number;
-    display_name: string;
-    hide_subclass_in_tooltips: boolean;
-    subclass_id: number;
-    verbose_name: string;
-}
-interface Armor {
-    display: Display;
-    value: number;
-}
-interface Damage {
-    damage_class: {
-        name: string;
-        type: string;
-    };
-    display_string: string;
-    max_value: number;
-    min_value: number;
-}
-interface Display {
-    color: Color;
-    display_string: string;
-}
-interface Durability {
-    display_string: string;
-    value: number;
-}
-interface Effect {
-    display_string: string;
-    required_count: number;
-}
-interface InventoryType {
-    name: Record<Locales, string | undefined>;
-    type: 'BACK' | 'BAG' | 'CHEST' | 'FEET' | 'FINGER' | 'HANDS' | 'HEAD' | 'LEGS' | 'NECK' | 'NON_EQUIP' | 'SHIRT' | 'SHOULDER' | 'TABARD' | 'TRINKET' | 'TWOHWEAPON' | 'WAIST' | 'WRIST';
-}
-interface ItemQuality {
-    name: Record<Locales, string | undefined>;
-    type: 'ARTIFACT' | 'COMMON' | 'EPIC' | 'HEIRLOOM' | 'LEGENDARY' | 'POOR' | 'RARE' | 'UNCOMMON';
-}
-interface Media extends KeyBase {
-    id: number;
-}
-interface PreviewItem {
-    armor?: Armor;
-    binding?: {
-        name: string;
-        type: string;
-    };
-    bonus_list?: Array<number>;
-    container_slots?: Durability;
-    context?: number;
-    crafting_reagent?: string;
-    description?: string;
-    durability?: Durability;
-    inventory_type: InventoryType;
-    is_subclass_hidden?: boolean;
-    item: Media;
-    item_class: NameIdKey;
-    item_subclass: NameIdKey;
-    level?: Durability;
-    media: Media;
-    name: string;
-    quality: ItemQuality;
-    recipe?: Recipe;
-    requirements?: Requirements;
-    sell_price?: number;
-    shield_block?: Armor;
-    spells?: Array<Spell>;
-    stats?: Array<Stat>;
-    unique_equipped?: 'Unique';
-    weapon?: Weapon;
-}
-interface Recipe {
-    item: RecipeItem;
-    reagents: Array<NameIdKey & {
-        quantity: number;
-    }>;
-    reagents_display_string: string;
-}
-interface RecipeItem {
-    armor?: Armor;
-    binding: {
-        name: string;
-        type: string;
-    };
-    durability: Durability;
-    inventory_type: InventoryType;
-    item: Media;
-    item_class: NameIdKey;
-    item_subclass: NameIdKey;
-    level: Durability;
-    media: Media;
-    name: string;
-    quality: ItemQuality;
-    requirements: Requirements;
-    sell_price: {
-        display_strings: RecipeItemDisplayStrings;
-        value: number;
-    };
-    stats: Array<Stat>;
-    weapon?: Weapon;
-}
-interface RecipeItemDisplayStrings {
-    copper: string;
-    gold: string;
-    header: string;
-    silver: string;
-}
-interface Requirements {
-    level: Durability;
-}
-interface Spell {
-    description: string;
-    spell: NameIdKey;
-}
-interface Stat {
-    display: Display;
-    is_negated?: boolean;
-    type: {
-        name: StatType;
-        type: StatTypeCapitalized;
-    };
-    value: number;
-}
-type StatType = 'Agility' | 'Critical Strike' | 'Haste' | 'Intellect' | 'Mastery' | 'Stamina' | 'Strength' | 'Versatility';
-type StatTypeCapitalized = 'AGILITY' | 'CRIT_RATING' | 'HASTE_RATING' | 'INTELLECT' | 'MASTERY' | 'STAMINA' | 'STRENGTH' | 'VERSATILITY';
-interface Weapon {
-    attack_speed: Durability;
-    damage: Damage;
-    dps: Durability;
-}
-
-export type { ItemClassIndexResponse, ItemClassResponse, ItemMediaResponse, ItemResponse, ItemSearchParameters, ItemSearchResponseItem, ItemSetIndexResponse, ItemSetResponse, ItemSubClassResponse };

package/dist/item/types.js

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

package/dist/item/types.js.map

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