guildwars2-ts 1.1.0 → 1.1.1

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;
 }
@@ -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.

package/dist/index.d.ts

@@ -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;
 }
@@ -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.

package/dist/index.js

@@ -114,8 +114,6 @@ var ApiBase = class {
   }
   /**
    * Parameters for the api response, at top level
-   *
-   * @returns Api parameters
    */
   getParams() {
     return {
@@ -163,46 +161,62 @@ var ApiBase = class {
       }
       return data;
     } catch (error) {
-      return await this.retryRequest(endpoint, options, responseType, apiParams, error);
+      return await this.retryRequest(endpoint, options, responseType, apiParams, 0, error);
     }
   }
   /**
    * 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
    */
-  async retryRequest(endpoint, prevOptions, responseType, apiParams, prevError) {
-    if (prevError instanceof axios.AxiosError) {
-      if (prevError.response) {
-        const { status } = prevError.response;
-        if (status === 401) {
+  async retryRequest(endpoint, prevOptions, responseType, apiParams, rateLimitAttempt = 0, prevError) {
+    if (prevError instanceof axios.AxiosError && prevError.response) {
+      const { status } = prevError.response;
+      switch (true) {
+        case status === 401: {
           logger.warn(`Request to ${prevOptions.url} failed.`);
           throw new ApiTokenError();
         }
-        if (status === 403) {
+        case status === 403: {
           const requiredScope = prevError.response.data.text.slice(0, 1).toUpperCase() + prevError.response.data.text.slice(1);
           logger.warn(`Request to ${prevOptions.url} failed. ${requiredScope}.`);
           throw new ApiPermissionsError(requiredScope);
         }
-        if (status === 404) {
+        case status === 404: {
           logger.warn(`Request to ${prevOptions.url} returned no data.`);
           throw new ApiNotFoundError();
         }
-        if (status === 504) {
+        case (status === 429 && this._rateLimitRetry): {
+          logger.warn("Rate-limit has been reached. Request will be repeated soon.");
+          if (rateLimitAttempt < 3) {
+            setTimeout(async () => {
+              return await this.retryRequest(
+                endpoint,
+                prevOptions,
+                responseType,
+                apiParams,
+                rateLimitAttempt++,
+                prevError
+              );
+            }, 1e3);
+            break;
+          } else {
+            logger.error(`Rate-limit retries failed. Aborting request to ${prevOptions.url}`);
+            throw new ApiRetryFailedError();
+          }
+        }
+        case status === 504: {
           logger.warn(`Request to ${prevOptions.url} timed out.`);
           throw new ApiTimeoutError();
         }
+        default:
+          logger.warn(`Request to ${prevOptions.url} failed. ${prevError.message}`);
       }
-      logger.warn(`Request to ${prevOptions.url} failed. ${prevError.message}`);
-    } else if (this._rateLimitRetry) {
-      logger.info(`Rate-limit retries failed. Aborting request to ${prevOptions.url}`);
-      throw new ApiRetryFailedError();
     }
     throw new ApiGenericError();
   }
@@ -211,7 +225,6 @@ var ApiBase = class {
    *
    * @param endpoint - Api endpoint
    * @param urlParams - Parameters
-   * @returns Finalized endpoint Url
    */
   _getApiUrl(endpoint, urlParams) {
     const { path } = endpoint;
@@ -1550,9 +1563,9 @@ var GuildTeamsDTO = zod.z.array(
     /** Team ladder statistics aggregates. */
     ladders: zod.z.object({
       /** Ranked arena stats. */
-      ranked: PvPAggregate,
+      ranked: PvPAggregate.optional(),
       /** Unranked arena stats. */
-      unranked: PvPAggregate
+      unranked: PvPAggregate.optional()
     }),
     /** Team games. */
     games: zod.z.array(PvPGame),
@@ -1568,7 +1581,7 @@ var GuildTeamsDTO = zod.z.array(
         /** Seasonal rating. */
         rating: zod.z.number()
       })
-    )
+    ).optional()
   })
 );
 var GuildTreasuryDTO = zod.z.array(