guildwars2-ts 1.1.1 → 1.1.2

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/dist/index.d.mts

@@ -58,8 +58,9 @@ declare class ApiBase {
      * @param endpoint - API Endpoint
      * @param apiParams - Query string
      * @param responseType - Type of the response
+     * @param attempts - Previously failed retry count
      */
-    protected buildRequest<T extends z.ZodType>(endpoint: Endpoint, apiParams: UrlParams, responseType: T): Promise<z.infer<T>>;
+    protected buildRequest<T extends z.ZodType>(endpoint: Endpoint, apiParams: UrlParams, responseType: T, attempts?: number): Promise<z.infer<T>>;
     /**
      * Retries failed requests
      *
@@ -70,7 +71,7 @@ declare class ApiBase {
      * @param rateLimitAttempt - Current rate-limit retry counter
      * @param prevError - Error that caused a retry
      */
-    protected retryRequest<T extends z.ZodType>(endpoint: Endpoint, prevOptions: RawAxiosRequestConfig, responseType: T, apiParams: UrlParams, rateLimitAttempt?: number, 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
      *
@@ -1799,8 +1800,9 @@ declare const ColorsDTO: z.ZodArray<z.ZodObject<{
     /** ID of the dye item. */
     item: z.ZodOptional<z.ZodNumber>;
     /** Color categories. */
-    categories: z.ZodOptional<z.ZodTuple<[z.ZodEnum<["Gray", "Brown", "Red", "Orange", "Yellow", "Green", "Blue", "Purple"]>, z.ZodEnum<["Vibrant", "Leather", "Metal"]>, z.ZodEnum<["Starter", "Common", "Uncommon", "Rare", "Exclusive"]>], null>>;
+    categories: z.ZodUnion<[z.ZodTuple<[z.ZodEnum<["Gray", "Brown", "Red", "Orange", "Yellow", "Green", "Blue", "Purple"]>, z.ZodEnum<["Vibrant", "Leather", "Metal"]>, z.ZodEnum<["Starter", "Common", "Uncommon", "Rare", "Exclusive"]>], null>, z.ZodArray<z.ZodUndefined, "many">]>;
 }, "strip", z.ZodTypeAny, {
+    categories: (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"]) & (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined);
     id: number;
     name: string;
     base_rgb: number[];
@@ -1837,8 +1839,8 @@ declare const ColorsDTO: z.ZodArray<z.ZodObject<{
         rgb: number[];
     } | undefined;
     item?: number | undefined;
-    categories?: ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined;
 }, {
+    categories: (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"]) & (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined);
     id: number;
     name: string;
     base_rgb: number[];
@@ -1875,7 +1877,6 @@ declare const ColorsDTO: z.ZodArray<z.ZodObject<{
         rgb: number[];
     } | undefined;
     item?: number | undefined;
-    categories?: ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined;
 }>, "many">;
 
 /**

package/dist/index.d.ts

@@ -58,8 +58,9 @@ declare class ApiBase {
      * @param endpoint - API Endpoint
      * @param apiParams - Query string
      * @param responseType - Type of the response
+     * @param attempts - Previously failed retry count
      */
-    protected buildRequest<T extends z.ZodType>(endpoint: Endpoint, apiParams: UrlParams, responseType: T): Promise<z.infer<T>>;
+    protected buildRequest<T extends z.ZodType>(endpoint: Endpoint, apiParams: UrlParams, responseType: T, attempts?: number): Promise<z.infer<T>>;
     /**
      * Retries failed requests
      *
@@ -70,7 +71,7 @@ declare class ApiBase {
      * @param rateLimitAttempt - Current rate-limit retry counter
      * @param prevError - Error that caused a retry
      */
-    protected retryRequest<T extends z.ZodType>(endpoint: Endpoint, prevOptions: RawAxiosRequestConfig, responseType: T, apiParams: UrlParams, rateLimitAttempt?: number, 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
      *
@@ -1799,8 +1800,9 @@ declare const ColorsDTO: z.ZodArray<z.ZodObject<{
     /** ID of the dye item. */
     item: z.ZodOptional<z.ZodNumber>;
     /** Color categories. */
-    categories: z.ZodOptional<z.ZodTuple<[z.ZodEnum<["Gray", "Brown", "Red", "Orange", "Yellow", "Green", "Blue", "Purple"]>, z.ZodEnum<["Vibrant", "Leather", "Metal"]>, z.ZodEnum<["Starter", "Common", "Uncommon", "Rare", "Exclusive"]>], null>>;
+    categories: z.ZodUnion<[z.ZodTuple<[z.ZodEnum<["Gray", "Brown", "Red", "Orange", "Yellow", "Green", "Blue", "Purple"]>, z.ZodEnum<["Vibrant", "Leather", "Metal"]>, z.ZodEnum<["Starter", "Common", "Uncommon", "Rare", "Exclusive"]>], null>, z.ZodArray<z.ZodUndefined, "many">]>;
 }, "strip", z.ZodTypeAny, {
+    categories: (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"]) & (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined);
     id: number;
     name: string;
     base_rgb: number[];
@@ -1837,8 +1839,8 @@ declare const ColorsDTO: z.ZodArray<z.ZodObject<{
         rgb: number[];
     } | undefined;
     item?: number | undefined;
-    categories?: ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined;
 }, {
+    categories: (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"]) & (undefined[] | ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined);
     id: number;
     name: string;
     base_rgb: number[];
@@ -1875,7 +1877,6 @@ declare const ColorsDTO: z.ZodArray<z.ZodObject<{
         rgb: number[];
     } | undefined;
     item?: number | undefined;
-    categories?: ["Gray" | "Brown" | "Red" | "Orange" | "Yellow" | "Green" | "Blue" | "Purple", "Vibrant" | "Leather" | "Metal", "Starter" | "Common" | "Uncommon" | "Rare" | "Exclusive"] | undefined;
 }>, "many">;
 
 /**

package/dist/index.js

@@ -131,8 +131,9 @@ var ApiBase = class {
    * @param endpoint - API Endpoint
    * @param apiParams - Query string
    * @param responseType - Type of the response
+   * @param attempts - Previously failed retry count
    */
-  async buildRequest(endpoint, apiParams, responseType) {
+  async buildRequest(endpoint, apiParams, responseType, attempts) {
     const { tokenRequired } = endpoint;
     const url = this._getApiUrl(endpoint, apiParams);
     const headers = new axios.AxiosHeaders();
@@ -161,7 +162,7 @@ var ApiBase = class {
       }
       return data;
     } catch (error) {
-      return await this.retryRequest(endpoint, options, responseType, apiParams, 0, error);
+      return await this.retryRequest(endpoint, options, responseType, apiParams, attempts ?? 0, error);
     }
   }
   /**
@@ -174,7 +175,7 @@ var ApiBase = class {
    * @param rateLimitAttempt - Current rate-limit retry counter
    * @param prevError - Error that caused a retry
    */
-  async retryRequest(endpoint, prevOptions, responseType, apiParams, rateLimitAttempt = 0, prevError) {
+  async retryRequest(endpoint, prevOptions, responseType, apiParams, rateLimitAttempt, prevError) {
     if (prevError instanceof axios.AxiosError && prevError.response) {
       const { status } = prevError.response;
       switch (true) {
@@ -191,20 +192,18 @@ var ApiBase = class {
           logger.warn(`Request to ${prevOptions.url} returned no data.`);
           throw new ApiNotFoundError();
         }
-        case (status === 429 && this._rateLimitRetry): {
-          logger.warn("Rate-limit has been reached. Request will be repeated soon.");
+        case status === 429: {
+          if (!this._rateLimitRetry) {
+            logger.warn("Rate-limit has been reached, but retries were turned off. Stopping here.");
+            throw new ApiRetryFailedError();
+          }
           if (rateLimitAttempt < 3) {
-            setTimeout(async () => {
-              return await this.retryRequest(
-                endpoint,
-                prevOptions,
-                responseType,
-                apiParams,
-                rateLimitAttempt++,
-                prevError
-              );
-            }, 1e3);
-            break;
+            logger.warn(
+              // biome-ignore lint/style/noNonNullAssertion: <This will always be present>
+              `Rate-limit has been reached. Request to ${prevOptions.url} will be repeated in 30 seconds.`
+            );
+            await new Promise((resolve) => setTimeout(() => resolve(), 3e4));
+            return await this.buildRequest(endpoint, apiParams, responseType, ++rateLimitAttempt);
           } else {
             logger.error(`Rate-limit retries failed. Aborting request to ${prevOptions.url}`);
             throw new ApiRetryFailedError();
@@ -216,6 +215,7 @@ var ApiBase = class {
         }
         default:
           logger.warn(`Request to ${prevOptions.url} failed. ${prevError.message}`);
+          throw new ApiGenericError();
       }
     }
     throw new ApiGenericError();
@@ -1783,7 +1783,7 @@ var ColorsDTO = zod.z.array(
     /** ID of the dye item. */
     item: zod.z.number().optional(),
     /** Color categories. */
-    categories: zod.z.tuple([Hue, Material, Rarity]).optional()
+    categories: zod.z.tuple([Hue, Material, Rarity]).or(zod.z.array(zod.z.undefined()).length(0))
   })
 );
 var EmblemDTO = zod.z.array(
@@ -6293,5 +6293,3 @@ exports.GW2Api = GW2Api;
 exports.LogLevel = LogLevel;
 exports.setLogLevel = setLogLevel;
 exports.setPathLogging = setPathLogging;
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.js.map

package/dist/index.mjs

@@ -124,8 +124,9 @@ var ApiBase = class {
    * @param endpoint - API Endpoint
    * @param apiParams - Query string
    * @param responseType - Type of the response
+   * @param attempts - Previously failed retry count
    */
-  async buildRequest(endpoint, apiParams, responseType) {
+  async buildRequest(endpoint, apiParams, responseType, attempts) {
     const { tokenRequired } = endpoint;
     const url = this._getApiUrl(endpoint, apiParams);
     const headers = new AxiosHeaders();
@@ -154,7 +155,7 @@ var ApiBase = class {
       }
       return data;
     } catch (error) {
-      return await this.retryRequest(endpoint, options, responseType, apiParams, 0, error);
+      return await this.retryRequest(endpoint, options, responseType, apiParams, attempts ?? 0, error);
     }
   }
   /**
@@ -167,7 +168,7 @@ var ApiBase = class {
    * @param rateLimitAttempt - Current rate-limit retry counter
    * @param prevError - Error that caused a retry
    */
-  async retryRequest(endpoint, prevOptions, responseType, apiParams, rateLimitAttempt = 0, prevError) {
+  async retryRequest(endpoint, prevOptions, responseType, apiParams, rateLimitAttempt, prevError) {
     if (prevError instanceof AxiosError && prevError.response) {
       const { status } = prevError.response;
       switch (true) {
@@ -184,20 +185,18 @@ var ApiBase = class {
           logger.warn(`Request to ${prevOptions.url} returned no data.`);
           throw new ApiNotFoundError();
         }
-        case (status === 429 && this._rateLimitRetry): {
-          logger.warn("Rate-limit has been reached. Request will be repeated soon.");
+        case status === 429: {
+          if (!this._rateLimitRetry) {
+            logger.warn("Rate-limit has been reached, but retries were turned off. Stopping here.");
+            throw new ApiRetryFailedError();
+          }
           if (rateLimitAttempt < 3) {
-            setTimeout(async () => {
-              return await this.retryRequest(
-                endpoint,
-                prevOptions,
-                responseType,
-                apiParams,
-                rateLimitAttempt++,
-                prevError
-              );
-            }, 1e3);
-            break;
+            logger.warn(
+              // biome-ignore lint/style/noNonNullAssertion: <This will always be present>
+              `Rate-limit has been reached. Request to ${prevOptions.url} will be repeated in 30 seconds.`
+            );
+            await new Promise((resolve) => setTimeout(() => resolve(), 3e4));
+            return await this.buildRequest(endpoint, apiParams, responseType, ++rateLimitAttempt);
           } else {
             logger.error(`Rate-limit retries failed. Aborting request to ${prevOptions.url}`);
             throw new ApiRetryFailedError();
@@ -209,6 +208,7 @@ var ApiBase = class {
         }
         default:
           logger.warn(`Request to ${prevOptions.url} failed. ${prevError.message}`);
+          throw new ApiGenericError();
       }
     }
     throw new ApiGenericError();
@@ -1776,7 +1776,7 @@ var ColorsDTO = z.array(
     /** ID of the dye item. */
     item: z.number().optional(),
     /** Color categories. */
-    categories: z.tuple([Hue, Material, Rarity]).optional()
+    categories: z.tuple([Hue, Material, Rarity]).or(z.array(z.undefined()).length(0))
   })
 );
 var EmblemDTO = z.array(
@@ -6282,5 +6282,3 @@ var GW2Api = class extends ApiBase {
 };
 
 export { ApiLanguage, GW2Api, LogLevel, setLogLevel, setPathLogging };
-//# sourceMappingURL=out.js.map
-//# sourceMappingURL=index.mjs.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "guildwars2-ts",
-  "version": "1.1.1",
+  "version": "1.1.2",
   "description": "GuildWars 2 API Wrapper in Typescript",
   "homepage": "https://gitlab.com/dinckelman/guildwars2-ts",
   "main": "dist/index.js",