guildwars2-ts 1.5.0 → 1.7.0

package/LICENSE

@@ -1,7 +1,6 @@
 ISC License
 
-Copyright (c) 2023 Ivan Sosnov
-Copyright (c) 2021 Julio Sansossio (parts of request base code)
+Copyright (c) 2022 Ivan Sosnov
  
 Permission to use, copy, modify, and/or distribute this software for any
 purpose with or without fee is hereby granted, provided that the above

package/README.md

@@ -17,14 +17,19 @@ Full support of all endpoints listed in the [API:2 Wiki](https://wiki.guildwars2
 import { GW2Api, ApiLanguage, setLogLevel, LogLevel } from "guildwars2-ts";
 
 const api: GW2Api = new GW2Api({
-	// Token is not required for all of the endpoints
+	// Some endpoints require authentication
 	token: "YOUR-TOKEN-HERE",
 	language: ApiLanguage.English,
+	// Optional, but recommended
 	rateLimitRetry: true
+	// When using guildwars2-ts in a browser, setting this is required to avoid CORS errors. Can be omitted otherwise
+	inBrowser: true
 });
 
 // Set to error by default, so you can set it to info for extra verbosity
 setLogLevel(LogLevel.info); 
+// Set to true by default, but recommended to be turned off, if your log does not render correctly
+enableLogColors(false);
 
 (async () => {
 	// Obtain names of all characters on the account
@@ -35,6 +40,11 @@ setLogLevel(LogLevel.info);
 			await api.characters.getCore(character).then(console.log);
 		});
 	});
+
+	// Types are automatically inferred for any function calls, like shown above
+	// If explicit types are preferred, it can be done as well
+	// Zod@^4 is required for this. In the future, this will be simplified
+	const emblems: z.infer<typeof EmblemDTO> = await api.emblem.get("foregrounds", [1, 2, 3]);
 })();
 ```
 
@@ -44,6 +54,12 @@ If you encounter any kinds of errors, or wish to add/update the functionality pr
 
 Otherwise, please check open [issue reports](https://gitlab.com/dinckelman/guildwars2-ts/-/issues/), to see if there is an existing discussion on the issue, or open a new request. In case of runtime errors, request validation error logs are extremely helpful, so please include them in the report, as guided by the template.
 
+## Planned features
+
+* Request caching (under consideration)
+* Support for pagination
+* Support for different/older schema version
+
 [npm-image]: https://img.shields.io/npm/v/guildwars2-ts
 [npm-link]: https://www.npmjs.com/package/guildwars2-ts
 [license]: https://img.shields.io/gitlab/license/dinckelman%2Fguildwars2-ts

package/dist/api.d.ts

@@ -0,0 +1,118 @@
+import { AccountApi, AchievementsApi, BackstoryApi, BuildApi, CharactersApi, ColorsApi, CommerceApi, ContinentsApi, CurrenciesApi, DailyCraftingApi, DungeonsApi, EmblemApi, EmotesApi, FilesApi, FinishersApi, GlidersApi, GuildApi, HomeApi, HomesteadApi, ItemStatsApi, ItemsApi, JadebotsApi, LegendaryArmoryApi, LegendsApi, LogosApi, MailCarriersApi, MapChestsApi, MapsApi, MasteriesApi, MaterialsApi, MinisApi, MountsApi, NoveltiesApi, OutfitsApi, PetsApi, ProfessionsApi, PvPApi, QuaggansApi, QuestsApi, RacesApi, RaidsApi, RecipesApi, SkiffsApi, SkillsApi, SkinsApi, SpecializationsApi, StoriesApi, SubtokenApi, TitlesApi, TokenInfoApi, TraitsApi, WizardsVaultApi, WorldBossesApi, WorldsApi, WorldVsWorldApi } from './apis';
+import { ApiBase } from './base/apiBase';
+/**
+ * Entrypoint for the API
+ */
+export declare class GW2Api extends ApiBase {
+    private readonly _params;
+    /** /v2/account Api */
+    readonly account: AccountApi;
+    /** /v2/achievements Api */
+    readonly achievements: AchievementsApi;
+    /** /v2/backstory Api */
+    readonly backstory: BackstoryApi;
+    /** /v2/build Api */
+    readonly build: BuildApi;
+    /** /v2/characters Api */
+    readonly characters: CharactersApi;
+    /** /v2/colors Api */
+    readonly colors: ColorsApi;
+    /** /v2/commerce Api */
+    readonly commerce: CommerceApi;
+    /** /v2/continents Api */
+    readonly continents: ContinentsApi;
+    /** /v2/currencies Api */
+    readonly currencies: CurrenciesApi;
+    /** /v2/dailycrafting Api */
+    readonly dailyCrafting: DailyCraftingApi;
+    /** /v2/dungeons Api */
+    readonly dungeons: DungeonsApi;
+    /** /v2/emblem Api */
+    readonly emblem: EmblemApi;
+    /** /v2/emotes Api */
+    readonly emotes: EmotesApi;
+    /** /v2/files Api */
+    readonly files: FilesApi;
+    /** /v2/finishers Api */
+    readonly finishers: FinishersApi;
+    /** /v2/gliders Api */
+    readonly gliders: GlidersApi;
+    /** /v2/guild Api */
+    readonly guild: GuildApi;
+    /** /v2/home Api */
+    readonly home: HomeApi;
+    /** /v2/homestead Api */
+    readonly homestead: HomesteadApi;
+    /** /v2/items Api */
+    readonly items: ItemsApi;
+    /** /v2/itemstats Api */
+    readonly itemstats: ItemStatsApi;
+    /** /v2/logos Api */
+    readonly logos: LogosApi;
+    /** /v2/jadebots Api */
+    readonly jadebots: JadebotsApi;
+    /** /v2/legendaryarmory Api */
+    readonly legendaryArmory: LegendaryArmoryApi;
+    /** /v2/legends Api */
+    readonly legends: LegendsApi;
+    /** /v2/mailcarriers Api */
+    readonly mailCarriers: MailCarriersApi;
+    /** /v2/mapchests Api */
+    readonly mapChests: MapChestsApi;
+    /** /v2/maps Api */
+    readonly maps: MapsApi;
+    /** /v2/masteries Api */
+    readonly masteries: MasteriesApi;
+    /** /v2/materials Api */
+    readonly materials: MaterialsApi;
+    /** /v2/minis Api */
+    readonly minis: MinisApi;
+    /** /v2/mounts Api */
+    readonly mounts: MountsApi;
+    /** /v2/novelties Api */
+    readonly novelties: NoveltiesApi;
+    /** /v2/outfits Api */
+    readonly outfits: OutfitsApi;
+    /** /v2/pets Api */
+    readonly pets: PetsApi;
+    /** /v2/professions Api */
+    readonly professions: ProfessionsApi;
+    /** /v2/pvp Api */
+    readonly pvp: PvPApi;
+    /** /v2/quaggans Api */
+    readonly quaggans: QuaggansApi;
+    /** /v2/quests Api */
+    readonly quests: QuestsApi;
+    /** /v2/races Api */
+    readonly races: RacesApi;
+    /** /v2/raids Api */
+    readonly raids: RaidsApi;
+    /** /v2/recipes Api */
+    readonly recipes: RecipesApi;
+    /** /v2/skiffs Api */
+    readonly skiffs: SkiffsApi;
+    /** /v2/skills Api */
+    readonly skills: SkillsApi;
+    /** /v2/skins Api */
+    readonly skins: SkinsApi;
+    /** /v2/specializations Api */
+    readonly specializations: SpecializationsApi;
+    /** /v2/stories Api */
+    readonly stories: StoriesApi;
+    /** /v2/subtoken Api */
+    readonly subtoken: SubtokenApi;
+    /** /v2/titles Api */
+    readonly titles: TitlesApi;
+    /** /v2/tokeninfo Api */
+    readonly tokenInfo: TokenInfoApi;
+    /** /v2/traits Api */
+    readonly traits: TraitsApi;
+    /** /v2/wizardsvault Api */
+    readonly wizardsVault: WizardsVaultApi;
+    /** /v2/worldbosses Api */
+    readonly worldBosses: WorldBossesApi;
+    /** /v2/worlds Api */
+    readonly worlds: WorldsApi;
+    /** /v2/wvw Api */
+    readonly wvw: WorldVsWorldApi;
+}

package/dist/apis/account/account.d.ts

@@ -0,0 +1,389 @@
+import { ApiBase } from '../../base/apiBase';
+/**
+ * /v2/account Api
+ */
+export declare class AccountApi extends ApiBase {
+    /**
+     * Returns information about player accounts.
+     */
+    get(): Promise<{
+        id: string;
+        age: number;
+        name: string;
+        world: number;
+        guilds: string[];
+        guild_leader: string[];
+        created: string;
+        access: string[];
+        commander: boolean;
+        fractal_level: number;
+        daily_ap: number;
+        monthly_ap: number;
+        wvw_rank: number;
+        last_modified?: string | undefined;
+        build_storage_slots?: number | undefined;
+    }>;
+    /**
+     * Returns an account's progress towards all their achievements.
+     */
+    getAchievements(): Promise<{
+        id: number;
+        current: number;
+        done: boolean;
+        bits?: number[] | undefined;
+        max?: number | undefined;
+        repeated?: number | undefined;
+        unlocked?: boolean | undefined;
+    }[]>;
+    /**
+     * Returns the items stored in a player's vault (not including material storage).
+     * If null, the slot is empty.
+     */
+    getBank(): Promise<({
+        id: number;
+        count: number;
+        charges?: number | undefined;
+        skin?: number | undefined;
+        dyes?: number[] | undefined;
+        upgrades?: number[] | undefined;
+        upgrade_slot_indices?: number[] | undefined;
+        infusions?: number[] | undefined;
+        stats?: {
+            id: number;
+            attributes: {
+                AgonyResistance?: number | undefined;
+                BoonDuration?: number | undefined;
+                ConditionDamage?: number | undefined;
+                ConditionDuration?: number | undefined;
+                CritDamage?: number | undefined;
+                Healing?: number | undefined;
+                Power?: number | undefined;
+                Precision?: number | undefined;
+                Toughness?: number | undefined;
+                Vitality?: number | undefined;
+            };
+        } | undefined;
+    } | {
+        id: number;
+        count: number;
+        binding: "Character";
+        bound_to: string;
+        charges?: number | undefined;
+        skin?: number | undefined;
+        dyes?: number[] | undefined;
+        upgrades?: number[] | undefined;
+        upgrade_slot_indices?: number[] | undefined;
+        infusions?: number[] | undefined;
+        stats?: {
+            id: number;
+            attributes: {
+                AgonyResistance?: number | undefined;
+                BoonDuration?: number | undefined;
+                ConditionDamage?: number | undefined;
+                ConditionDuration?: number | undefined;
+                CritDamage?: number | undefined;
+                Healing?: number | undefined;
+                Power?: number | undefined;
+                Precision?: number | undefined;
+                Toughness?: number | undefined;
+                Vitality?: number | undefined;
+            };
+        } | undefined;
+    } | {
+        id: number;
+        count: number;
+        binding: "Account";
+        charges?: number | undefined;
+        skin?: number | undefined;
+        dyes?: number[] | undefined;
+        upgrades?: number[] | undefined;
+        upgrade_slot_indices?: number[] | undefined;
+        infusions?: number[] | undefined;
+        stats?: {
+            id: number;
+            attributes: {
+                AgonyResistance?: number | undefined;
+                BoonDuration?: number | undefined;
+                ConditionDamage?: number | undefined;
+                ConditionDuration?: number | undefined;
+                CritDamage?: number | undefined;
+                Healing?: number | undefined;
+                Power?: number | undefined;
+                Precision?: number | undefined;
+                Toughness?: number | undefined;
+                Vitality?: number | undefined;
+            };
+        } | undefined;
+    } | null)[]>;
+    /**
+     * Returns the templates stored in a player's build storage.
+     */
+    getBuildStorage(): Promise<{
+        name: string;
+        profession: string;
+        specializations: {
+            id: number;
+            traits: (number | null)[];
+        }[];
+        skills?: {
+            heal: number | null;
+            utilities: (number | null)[];
+            elite: number | null;
+        } | undefined;
+        aquatic_skills?: {
+            heal: number | null;
+            utilities: (number | null)[];
+            elite: number | null;
+        } | undefined;
+        legends?: (string | null)[] | undefined;
+        aquatic_legends?: (string | null)[] | undefined;
+    }[]>;
+    /**
+     * Returns information about time-gated recipes that have been crafted by the account since daily-reset.
+     */
+    getDailyCrafts(): Promise<string[]>;
+    /**
+     * Returns the dungeons completed since daily dungeon reset.
+     */
+    getDungeons(): Promise<string[]>;
+    /**
+     * Returns the unlocked dyes of the account.
+     */
+    getDyes(): Promise<number[]>;
+    /**
+     * Returns the player's unlocked emotes.
+     */
+    getEmotes(): Promise<string[]>;
+    /**
+     * Returns information about finishers that are unlocked for an account.
+     */
+    getFinishers(): Promise<{
+        id: number;
+        permanent: boolean;
+        quantity?: number | undefined;
+    }[]>;
+    /**
+     * Returns information about gliders that are unlocked for an account.
+     */
+    getGliders(): Promise<number[]>;
+    /**
+     * Returns information about unlocked home instance nodes.
+     */
+    getHomeNodes(): Promise<string[]>;
+    /**
+     * Returns information about unlocked home instance cats.
+     */
+    getHomeCats(): Promise<number[]>;
+    /**
+     * Returns information about unlocked homestead decorations.
+     */
+    getHomesteadDecorations(): Promise<{
+        id: number;
+        count: number;
+    }[]>;
+    /**
+     * Returns information about glyphs stored in homestead collection boxes.
+     */
+    getHomesteadGlyphs(): Promise<string[]>;
+    /**
+     * Returns the shared inventory slots in an account.
+     * If null, the slot is empty
+     */
+    getInventory(): Promise<({
+        id: number;
+        count: number;
+        charges?: number | undefined;
+        skin?: number | undefined;
+        upgrades?: number[] | undefined;
+        infusions?: number[] | undefined;
+        binding?: "Account" | undefined;
+    } | null)[]>;
+    /**
+     * Returns the unlocked Jade Bot skins of the account.
+     */
+    getJadebots(): Promise<number[]>;
+    /**
+     * Returns information about the Legendary Armory items that are unlocked for an account.
+     */
+    getLegendaryArmory(): Promise<{
+        id: number;
+        count: number;
+    }[]>;
+    /**
+     * Returns the total amount of luck consumed on an account.
+     */
+    getLuck(): Promise<{
+        id: "luck";
+        value: number;
+    }[]>;
+    /**
+     * Returns information about mail carriers that are unlocked for an account.
+     */
+    getMailCarriers(): Promise<number[]>;
+    /**
+     * Returns information about Hero's Choice Chests acquired by the account since daily-reset.
+     */
+    getMapChests(): Promise<string[]>;
+    /**
+     * Returns information about masteries that are unlocked for an account.
+     * A tallied up total of the account's mastery points can be found at /v2/account/mastery/points.
+     */
+    getMasteries(): Promise<{
+        id: number;
+        level: number;
+    }[]>;
+    /**
+     * Returns information about the total amount of mastery points that are unlocked for an account.
+     * A detailed mastery track completion break down is available at /v2/account/masteries.
+     */
+    getMasteryPoints(): Promise<{
+        totals: {
+            region: string;
+            spent: number;
+            earned: number;
+        }[];
+        unlocked: number[];
+    }>;
+    /**
+     * Returns the materials stored in a player's vault.
+     */
+    getMaterials(): Promise<{
+        id: number;
+        category: number;
+        count: number;
+        binding?: "Account" | undefined;
+    }[]>;
+    /**
+     * Returns the unlocked miniatures of the account.
+     */
+    getMinis(): Promise<number[]>;
+    /**
+     * Returns the unlocked mount skins of the account.
+     */
+    getMountSkins(): Promise<number[]>;
+    /**
+     * Returns the unlocked mounts of the account.
+     */
+    getMountTypes(): Promise<string[]>;
+    /**
+     * Returns information about novelties that are unlocked for an account.
+     */
+    getNovelties(): Promise<number[]>;
+    /**
+     * Returns information about outfits that are unlocked for an account.
+     */
+    getOutfits(): Promise<number[]>;
+    /**
+     * Returns account-wide progression for Fractals's Account Augmentation and Luck.
+     */
+    getProgression(): Promise<{
+        id: string;
+        value: number;
+    }[]>;
+    /**
+     * Returns information about pvp heroes that are unlocked for an account.
+     */
+    getPvpHeroes(): Promise<number[]>;
+    /**
+     * Returns the completed raid encounters since weekly raid reset.
+     */
+    getRaids(): Promise<string[]>;
+    /**
+     * Returns information about recipes that are unlocked for an account.
+     */
+    getRecipes(): Promise<number[]>;
+    /**
+     * Returns the unlocked Skiff skins of the account.
+     */
+    getSkiffs(): Promise<number[]>;
+    /**
+     * Returns the unlocked skins of the account.
+     */
+    getSkins(): Promise<number[]>;
+    /**
+     * Returns information about titles that are unlocked for an account.
+     */
+    getTitles(): Promise<number[]>;
+    /**
+     * Returns the currencies of the account
+     */
+    getWallet(): Promise<{
+        id: number;
+        value: number;
+    }[]>;
+    /**
+     * Returns the current set of daily Wizard's Vault achievements for the account.
+     */
+    getWizardsVaultDaily(): Promise<{
+        meta_progress_current: number;
+        meta_progress_complete: number;
+        meta_reward_item_id: number;
+        meta_reward_astral: number;
+        meta_reward_claimed: boolean;
+        objectives: {
+            id: number;
+            title: string;
+            track: string;
+            acclaim: number;
+            progress_current: number;
+            progress_complete: number;
+            claimed: boolean;
+        }[];
+    }>;
+    /**
+     * Returns the current set of Wizard's Vault rewards, along with details about which have already been purchased by the account, and in what quantity.
+     */
+    getWizardsVaultListings(): Promise<{
+        id: number;
+        item_id: number;
+        item_count: number;
+        type: "Featured" | "Normal" | "Legacy";
+        cost: number;
+        purchased?: number | undefined;
+        purchase_limit?: number | undefined;
+    }[]>;
+    /**
+     * Returns the current set of special Wizard's Vault achievements for the account.
+     */
+    getWizardsVaultSpecial(): Promise<{
+        objectives: {
+            id: number;
+            title: string;
+            track: string;
+            acclaim: number;
+            progress_current: number;
+            progress_complete: number;
+            claimed: boolean;
+        }[];
+    }>;
+    /**
+     * Returns the current set of weekly Wizard's Vault achievements for the account.
+     */
+    getWizardsVaultWeekly(): Promise<{
+        meta_progress_current: number;
+        meta_progress_complete: number;
+        meta_reward_item_id: number;
+        meta_reward_astral: number;
+        meta_reward_claimed: boolean;
+        objectives: {
+            id: number;
+            title: string;
+            track: string;
+            acclaim: number;
+            progress_current: number;
+            progress_complete: number;
+            claimed: boolean;
+        }[];
+    }>;
+    /**
+     * Returns information about which world bosses have been killed by the account since daily-reset.
+     */
+    getWorldBosses(): Promise<string[]>;
+    /**
+     * Returns information about an account's allocated wvw guild, and identifies the matchmaking team.
+     */
+    getWvW(): Promise<{
+        team: number;
+        guild: string;
+    }>;
+}

package/dist/apis/account/index.d.ts

@@ -0,0 +1 @@
+export * from './account';

package/dist/apis/achievements/achievements.d.ts

@@ -0,0 +1,39 @@
+import type { z } from 'zod';
+import { ApiBase } from '../../base/apiBase';
+import { AchievementCategoriesDTO, AchievementGroupsDTO, AchievementsDTO } from '../../models/';
+import { numberArrayType, stringArrayType } from '../v2apiUtils';
+/**
+ * /v2/achievements api
+ */
+export declare class AchievementsApi extends ApiBase {
+    /**
+     * Returns all (whitelisted) achievements in the game, including localized names and icons.
+     */
+    get(): Promise<z.infer<typeof numberArrayType>>;
+    /**
+     * Returns all (whitelisted) achievements in the game, including localized names and icons.
+     *
+     * @param ids - List of achievement ids
+     */
+    get(ids: number[]): Promise<z.infer<typeof AchievementsDTO>>;
+    /**
+     * Returns all the categories for achievements.
+     */
+    getCategories(): Promise<z.infer<typeof numberArrayType>>;
+    /**
+     * Returns all the categories for achievements.
+     *
+     * @param ids - (optional) List of category ids, or "all".
+     */
+    getCategories(ids: number[] | 'all'): Promise<z.infer<typeof AchievementCategoriesDTO>>;
+    /**
+     * Returns all the top-level groups for achievements.
+     */
+    getGroups(): Promise<z.infer<typeof stringArrayType>>;
+    /**
+     * Returns all the top-level groups for achievements.
+     *
+     * @param id - (optional) Group id.
+     */
+    getGroups(id: string): Promise<z.infer<typeof AchievementGroupsDTO>>;
+}

package/dist/apis/achievements/index.d.ts

@@ -0,0 +1 @@
+export * from './achievements';