guildwars2-ts 1.0.4 → 1.1.1

package/LICENSE

@@ -1,16 +1,16 @@
-ISC License
-
-Copyright (c) 2023 Ivan Sosnov
-Copyright (c) 2021 Julio Sansossio (parts of request base code)
- 
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
-REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
-AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
-INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
-LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
-OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
-PERFORMANCE OF THIS SOFTWARE.
+ISC License
+
+Copyright (c) 2023 Ivan Sosnov
+Copyright (c) 2021 Julio Sansossio (parts of request base code)
+ 
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH
+REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
+AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,
+INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM
+LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR
+OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR
+PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -51,4 +51,4 @@ If you find any kinds of errors in the program code, or wish to add/update any o
 [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
-[license-file]: ./LICENSE
+[license-file]: LICENSE

package/dist/index.d.mts

@@ -50,8 +50,6 @@ declare class ApiBase {
     constructor(apiParams?: ApiParams);
     /**
      * Parameters for the api response, at top level
-     *
-     * @returns Api parameters
      */
     protected getParams(): ApiParams;
     /**
@@ -64,22 +62,20 @@ declare class ApiBase {
     protected buildRequest<T extends z.ZodType>(endpoint: Endpoint, apiParams: UrlParams, responseType: T): Promise<z.infer<T>>;
     /**
      * Retries failed requests
-     * TODO: Fix logic. Rate-limits are almost impossible hit, but other generic requests will fail and loop forever
      *
      * @param endpoint - Endpoint to which a request was originally made
      * @param prevOptions - Axios request options
      * @param responseType - Originally requested schema
      * @param apiParams - Query string
+     * @param rateLimitAttempt - Current rate-limit retry counter
      * @param prevError - Error that caused a retry
-     * @returns Successful request, or error
      */
-    protected retryRequest<T extends z.ZodType>(endpoint: Endpoint, prevOptions: RawAxiosRequestConfig, responseType: T, apiParams: UrlParams, prevError?: unknown): Promise<T>;
+    protected retryRequest<T extends z.ZodType>(endpoint: Endpoint, prevOptions: RawAxiosRequestConfig, responseType: T, apiParams: UrlParams, rateLimitAttempt?: number, prevError?: unknown): Promise<T>;
     /**
      * Builds final Api url from the endpoint and provided parameters
      *
      * @param endpoint - Api endpoint
      * @param urlParams - Parameters
-     * @returns Finalized endpoint Url
      */
     private _getApiUrl;
 }
@@ -6291,7 +6287,7 @@ declare const ProfessionsDTO: z.ZodArray<z.ZodObject<{
             /** The skill id. Can be resolved against /v2/skills. */
             id: z.ZodNumber;
             /** The skill bar slot that this weapon skill can be used in. */
-            slot: z.ZodEnum<["Profession_1", "Weapon_1", "Weapon_2", "Weapon_3", "Weapon_4", "Weapon_5", "Utility", "Heal", "Elite"]>;
+            slot: z.ZodUnion<[z.ZodEnum<["Profession_1", "Utility", "Heal", "Elite"]>, z.ZodType<`Weapon_${number}`, z.ZodTypeDef, `Weapon_${number}`>]>;
             /** The name of the offhand weapon this skill requires to be equipped. This field is usually only present for Thief skills. */
             offhand: z.ZodOptional<z.ZodString>;
             /** The Elementalist attunement that this skill requires. This field is usually only present for Elementalist skills. */
@@ -6300,13 +6296,13 @@ declare const ProfessionsDTO: z.ZodArray<z.ZodObject<{
             source: z.ZodOptional<z.ZodString>;
         }, "strip", z.ZodTypeAny, {
             id: number;
-            slot: "Utility" | "Profession_1" | "Weapon_1" | "Weapon_2" | "Weapon_3" | "Weapon_4" | "Weapon_5" | "Heal" | "Elite";
+            slot: "Utility" | "Profession_1" | "Heal" | "Elite" | `Weapon_${number}`;
             offhand?: string | undefined;
             attunement?: string | undefined;
             source?: string | undefined;
         }, {
             id: number;
-            slot: "Utility" | "Profession_1" | "Weapon_1" | "Weapon_2" | "Weapon_3" | "Weapon_4" | "Weapon_5" | "Heal" | "Elite";
+            slot: "Utility" | "Profession_1" | "Heal" | "Elite" | `Weapon_${number}`;
             offhand?: string | undefined;
             attunement?: string | undefined;
             source?: string | undefined;
@@ -6314,7 +6310,7 @@ declare const ProfessionsDTO: z.ZodArray<z.ZodObject<{
     }, "strip", z.ZodTypeAny, {
         skills: {
             id: number;
-            slot: "Utility" | "Profession_1" | "Weapon_1" | "Weapon_2" | "Weapon_3" | "Weapon_4" | "Weapon_5" | "Heal" | "Elite";
+            slot: "Utility" | "Profession_1" | "Heal" | "Elite" | `Weapon_${number}`;
             offhand?: string | undefined;
             attunement?: string | undefined;
             source?: string | undefined;
@@ -6324,7 +6320,7 @@ declare const ProfessionsDTO: z.ZodArray<z.ZodObject<{
     }, {
         skills: {
             id: number;
-            slot: "Utility" | "Profession_1" | "Weapon_1" | "Weapon_2" | "Weapon_3" | "Weapon_4" | "Weapon_5" | "Heal" | "Elite";
+            slot: "Utility" | "Profession_1" | "Heal" | "Elite" | `Weapon_${number}`;
             offhand?: string | undefined;
             attunement?: string | undefined;
             source?: string | undefined;
@@ -6361,7 +6357,7 @@ declare const ProfessionsDTO: z.ZodArray<z.ZodObject<{
     weapons: Partial<Record<"Axe" | "Dagger" | "Focus" | "Greatsword" | "Hammer" | "Mace" | "Pistol" | "Rifle" | "Scepter" | "Shield" | "Speargun" | "Staff" | "Sword" | "Torch" | "Trident" | "Warhorn" | "Longbow" | "Shortbow" | "Spear", {
         skills: {
             id: number;
-            slot: "Utility" | "Profession_1" | "Weapon_1" | "Weapon_2" | "Weapon_3" | "Weapon_4" | "Weapon_5" | "Heal" | "Elite";
+            slot: "Utility" | "Profession_1" | "Heal" | "Elite" | `Weapon_${number}`;
             offhand?: string | undefined;
             attunement?: string | undefined;
             source?: string | undefined;
@@ -6395,7 +6391,7 @@ declare const ProfessionsDTO: z.ZodArray<z.ZodObject<{
     weapons: Partial<Record<"Axe" | "Dagger" | "Focus" | "Greatsword" | "Hammer" | "Mace" | "Pistol" | "Rifle" | "Scepter" | "Shield" | "Speargun" | "Staff" | "Sword" | "Torch" | "Trident" | "Warhorn" | "Longbow" | "Shortbow" | "Spear", {
         skills: {
             id: number;
-            slot: "Utility" | "Profession_1" | "Weapon_1" | "Weapon_2" | "Weapon_3" | "Weapon_4" | "Weapon_5" | "Heal" | "Elite";
+            slot: "Utility" | "Profession_1" | "Heal" | "Elite" | `Weapon_${number}`;
             offhand?: string | undefined;
             attunement?: string | undefined;
             source?: string | undefined;
@@ -11098,12 +11094,6 @@ declare class GuildApi extends ApiBase {
             name: string;
             role: "Member" | "Captain";
         }[];
-        seasons: {
-            id: string;
-            rating: number;
-            wins: number;
-            losses: number;
-        }[];
         id: number;
         name: string;
         aggregate: {
@@ -11114,20 +11104,20 @@ declare class GuildApi extends ApiBase {
             forfeits: number;
         };
         ladders: {
-            ranked: {
+            ranked?: {
                 wins: number;
                 losses: number;
                 desertions: number;
                 byes: number;
                 forfeits: number;
-            };
-            unranked: {
+            } | undefined;
+            unranked?: {
                 wins: number;
                 losses: number;
                 desertions: number;
                 byes: number;
                 forfeits: number;
-            };
+            } | undefined;
         };
         games: {
             id: string;
@@ -11143,6 +11133,12 @@ declare class GuildApi extends ApiBase {
             rating_change: number;
             season?: string | undefined;
         }[];
+        seasons?: {
+            id: string;
+            rating: number;
+            wins: number;
+            losses: number;
+        }[] | undefined;
     }[]>;
     /**
      * Returns information about the items in a guild's treasury.
@@ -11858,7 +11854,7 @@ declare class SkillsApi extends ApiBase {
         type: "Weapon" | "Utility" | "Heal" | "Elite" | "Bundle" | "Monster" | "Pet" | "Profession" | "Toolbelt" | "Transform";
         description: string;
         icon: string;
-        slot: ("Utility" | "Elite" | "Pet" | `Downed_${number}` | `Profession_${number}` | `Weapon_${number}`) & ("Utility" | "Elite" | "Pet" | `Downed_${number}` | `Profession_${number}` | `Weapon_${number}` | undefined);
+        slot: ("Utility" | "Elite" | `Weapon_${number}` | "Pet" | `Downed_${number}` | `Profession_${number}`) & ("Utility" | "Elite" | `Weapon_${number}` | "Pet" | `Downed_${number}` | `Profession_${number}` | undefined);
         chat_link: string;
         flags: ("NoUnderwater" | "GroundTargeted")[];
         weapon_type: string;
@@ -12423,213 +12419,109 @@ declare class WorldVsWorldApi extends ApiBase {
 }
 
 declare class GW2Api extends ApiBase {
-    /**
-     * /v2/account Api
-     */
+    /** /v2/account Api */
     readonly account: AccountApi;
-    /**
-     * /v2/achievements Api
-     */
+    /** /v2/achievements Api */
     readonly achievements: AchievementsApi;
-    /**
-     * /v2/backstory Api
-     */
+    /** /v2/backstory Api */
     readonly backstory: BackstoryApi;
-    /**
-     * /v2/build Api
-     */
+    /** /v2/build Api */
     readonly build: BuildApi;
-    /**
-     * /v2/characters Api
-     */
+    /** /v2/characters Api */
     readonly characters: CharactersApi;
-    /**
-     * /v2/colors Api
-     */
+    /** /v2/colors Api */
     readonly colors: ColorsApi;
-    /**
-     * /v2/commerce Api
-     */
+    /** /v2/commerce Api */
     readonly commerce: CommerceApi;
-    /**
-     * /v2/continents Api
-     */
+    /** /v2/continents Api */
     readonly continents: ContinentsApi;
-    /**
-     * /v2/currencies Api
-     */
+    /** /v2/currencies Api */
     readonly currencies: CurrenciesApi;
-    /**
-     * /v2/dailycrafting Api
-     */
+    /** /v2/dailycrafting Api */
     readonly dailyCrafting: DailyCraftingApi;
-    /**
-     * /v2/dungeons Api
-     */
+    /** /v2/dungeons Api */
     readonly dungeons: DungeonsApi;
-    /**
-     * /v2/emblem Api
-     */
+    /** /v2/emblem Api */
     readonly emblem: EmblemApi;
-    /**
-     * /v2/emotes Api
-     */
+    /** /v2/emotes Api */
     readonly emotes: EmotesApi;
-    /**
-     * /v2/files Api
-     */
+    /** /v2/files Api */
     readonly files: FilesApi;
-    /**
-     * /v2/finishers Api
-     */
+    /** /v2/finishers Api */
     readonly finishers: FinishersApi;
-    /**
-     * /v2/gliders Api
-     */
+    /** /v2/gliders Api */
     readonly gliders: GlidersApi;
-    /**
-     * /v2/guild Api
-     */
+    /** /v2/guild Api */
     readonly guild: GuildApi;
-    /**
-     * /v2/home Api
-     */
+    /** /v2/home Api */
     readonly home: HomeApi;
-    /**
-     * /v2/items Api
-     */
+    /** /v2/items Api */
     readonly items: ItemsApi;
-    /**
-     * /v2/itemstats Api
-     */
+    /** /v2/itemstats Api */
     readonly itemstats: ItemStatsApi;
-    /**
-     * /v2/jadebots Api
-     */
+    /** /v2/jadebots Api */
     readonly jadebots: JadebotsApi;
-    /**
-     * /v2/legendaryarmory Api
-     */
+    /** /v2/legendaryarmory Api */
     readonly legendaryArmory: LegendaryArmoryApi;
-    /**
-     * /v2/legends Api
-     */
+    /** /v2/legends Api */
     readonly legends: LegendsApi;
-    /**
-     * /v2/mailcarriers Api
-     */
+    /** /v2/mailcarriers Api */
     readonly mailCarriers: MailCarriersApi;
-    /**
-     * /v2/mapchests Api
-     */
+    /** /v2/mapchests Api */
     readonly mapChests: MapChestsApi;
-    /**
-     * /v2/maps Api
-     */
+    /** /v2/maps Api */
     readonly maps: MapsApi;
-    /**
-     * /v2/masteries Api
-     */
+    /** /v2/masteries Api */
     readonly masteries: MasteriesApi;
-    /**
-     * /v2/materials Api
-     */
+    /** /v2/materials Api */
     readonly materials: MaterialsApi;
-    /**
-     * /v2/minis Api
-     */
+    /** /v2/minis Api */
     readonly minis: MinisApi;
-    /**
-     * /v2/mounts Api
-     */
+    /** /v2/mounts Api */
     readonly mounts: MountsApi;
-    /**
-     * /v2/novelties Api
-     */
+    /** /v2/novelties Api */
     readonly novelties: NoveltiesApi;
-    /**
-     * /v2/outfits Api
-     */
+    /** /v2/outfits Api */
     readonly outfits: OutfitsApi;
-    /**
-     * /v2/pets Api
-     */
+    /** /v2/pets Api */
     readonly pets: PetsApi;
-    /**
-     * /v2/professions Api
-     */
+    /** /v2/professions Api */
     readonly professions: ProfessionsApi;
-    /**
-     * /v2/pvp Api
-     */
+    /** /v2/pvp Api */
     readonly pvp: PvPApi;
-    /**
-     * /v2/quaggans Api
-     */
+    /** /v2/quaggans Api */
     readonly quaggans: QuaggansApi;
-    /**
-     * /v2/quests Api
-     */
+    /** /v2/quests Api */
     readonly quests: QuestsApi;
-    /**
-     * /v2/races Api
-     */
+    /** /v2/races Api */
     readonly races: RacesApi;
-    /**
-     * /v2/raids Api
-     */
+    /** /v2/raids Api */
     readonly raids: RaidsApi;
-    /**
-     * /v2/recipes Api
-     */
+    /** /v2/recipes Api */
     readonly recipes: RecipesApi;
-    /**
-     * /v2/skiffs Api
-     */
+    /** /v2/skiffs Api */
     readonly skiffs: SkiffsApi;
-    /**
-     * /v2/skills Api
-     */
+    /** /v2/skills Api */
     readonly skills: SkillsApi;
-    /**
-     * /v2/skins Api
-     */
+    /** /v2/skins Api */
     readonly skins: SkinsApi;
-    /**
-     * /v2/specializations Api
-     */
+    /** /v2/specializations Api */
     readonly specializations: SpecializationsApi;
-    /**
-     * /v2/stories Api
-     */
+    /** /v2/stories Api */
     readonly stories: StoriesApi;
-    /**
-     * /v2/subtoken Api
-     */
+    /** /v2/subtoken Api */
     readonly subtoken: SubtokenApi;
-    /**
-     * /v2/titles Api
-     */
+    /** /v2/titles Api */
     readonly titles: TitlesApi;
-    /**
-     * /v2/tokeninfo Api
-     */
+    /** /v2/tokeninfo Api */
     readonly tokenInfo: TokenInfoApi;
-    /**
-     * /v2/traits Api
-     */
+    /** /v2/traits Api */
     readonly traits: TraitsApi;
-    /**
-     * /v2/worldbosses Api
-     */
+    /** /v2/worldbosses Api */
     readonly worldBosses: WorldBossesApi;
-    /**
-     * /v2/worlds Api
-     */
+    /** /v2/worlds Api */
     readonly worlds: WorldsApi;
-    /**
-     * /v2/wvw Api
-     */
+    /** /v2/wvw Api */
     readonly wvw: WorldVsWorldApi;
 }