guildwars2-ts 1.1.1 → 1.1.4

package/dist/index.mjs

@@ -63,13 +63,10 @@ var ApiTimeoutError = class _ApiTimeoutError extends Error {
   }
 };
 var LogLevel = /* @__PURE__ */ ((LogLevel2) => {
-  LogLevel2[LogLevel2["silly"] = 0] = "silly";
-  LogLevel2[LogLevel2["trace"] = 1] = "trace";
-  LogLevel2[LogLevel2["debug"] = 2] = "debug";
-  LogLevel2[LogLevel2["info"] = 3] = "info";
-  LogLevel2[LogLevel2["warn"] = 4] = "warn";
   LogLevel2[LogLevel2["error"] = 5] = "error";
-  LogLevel2[LogLevel2["fatal"] = 6] = "fatal";
+  LogLevel2[LogLevel2["warn"] = 4] = "warn";
+  LogLevel2[LogLevel2["info"] = 3] = "info";
+  LogLevel2[LogLevel2["debug"] = 2] = "debug";
   return LogLevel2;
 })(LogLevel || {});
 var logger = new Logger({
@@ -102,8 +99,7 @@ var ApiBase = class {
   constructor(apiParams) {
     this._apiToken = apiParams?.token;
     this._language = apiParams?.language ?? "en" /* English */;
-    this._rateLimitRetry = apiParams?.rateLimit?.retry ?? true;
-    this._rateLimitRetryAttempts = apiParams?.rateLimit?.retry ? apiParams.rateLimit.attempts : 0;
+    this._rateLimitRetry = apiParams?.rateLimitRetry ?? true;
   }
   /**
    * Parameters for the api response, at top level
@@ -112,10 +108,7 @@ var ApiBase = class {
     return {
       token: this._apiToken,
       language: this._language,
-      rateLimit: {
-        retry: this._rateLimitRetry,
-        attempts: this._rateLimitRetryAttempts
-      }
+      rateLimitRetry: this._rateLimitRetry
     };
   }
   /**
@@ -124,8 +117,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();
@@ -147,14 +141,14 @@ var ApiBase = class {
       const parse = responseType.safeParse(data);
       if (!parse.success) {
         logger.warn(
-          "The requested data failed to parse, when using the known schema. Data is still returned, but may be incorrectly typed"
+          "The requested data failed to parse, when using the known schema. Data is still returned, but may be incorrectly typed. Please submit the following log to the developers:"
         );
-        logger.warn("Please submit the following log to the developers:");
         logger.warn(parse.error.errors);
       }
+      logger.info(`[200] Successful request to ${endpoint.path}`);
       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,48 +161,49 @@ 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) {
         case status === 401: {
-          logger.warn(`Request to ${prevOptions.url} failed.`);
+          logger.warn(
+            // biome-ignore lint/style/noNonNullAssertion: <This will always be present>
+            `[401] Failed request to ${prevOptions.url}. Failed to authorize with the provided token.`
+          );
           throw new ApiTokenError();
         }
         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}.`);
+          logger.warn(`[403] Failed request to ${prevOptions.url}. ${requiredScope}.`);
           throw new ApiPermissionsError(requiredScope);
         }
         case status === 404: {
-          logger.warn(`Request to ${prevOptions.url} returned no data.`);
+          logger.warn(`[404] Failed request to ${prevOptions.url}. No data was returned.`);
           throw new ApiNotFoundError();
         }
-        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}`);
+        case status === 429: {
+          if (!this._rateLimitRetry) {
+            logger.warn("[429] Rate-limit has been reached, but retries were turned off. Stopping here.");
             throw new ApiRetryFailedError();
           }
+          if (rateLimitAttempt < 3) {
+            logger.warn(
+              // biome-ignore lint/style/noNonNullAssertion: <This will always be present>
+              `[429] 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);
+          }
+          logger.error(`[429] Rate-limit retries failed. Aborting request to ${prevOptions.url}`);
+          throw new ApiRetryFailedError();
         }
         case status === 504: {
-          logger.warn(`Request to ${prevOptions.url} timed out.`);
+          logger.warn(`[504] 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}`);
+          throw new ApiGenericError();
       }
     }
     throw new ApiGenericError();
@@ -585,6 +580,107 @@ var AccountWalletDTO = z.array(
     value: z.number()
   })
 );
+var AccountWizardsVaultDailyDTO = z.object({
+  /** The current progress to the meta achievement for the daily. */
+  meta_progress_current: z.number(),
+  /** The threshold for the meta progress to be 'complete', and the meta reward claimable. */
+  meta_progress_complete: z.number(),
+  /** The ID of the item you receive for claiming the meta reward */
+  meta_reward_item_id: z.number(),
+  /** The amount of Astral Acclaim you receive for claiming the meta reward */
+  meta_reward_astral: z.number(),
+  /** Whether the account has claimed the meta reward. */
+  meta_reward_claimed: z.boolean(),
+  /** An array of objects detailing each daily objective */
+  objectives: z.array(
+    z.object({
+      /** The ID of the objective. */
+      id: z.number(),
+      /** The title of the objective. */
+      title: z.string(),
+      /** The reward track containing the objective. */
+      track: z.string(),
+      /** The astral acclaim awarded for the objective. */
+      acclaim: z.number(),
+      /** The current progress of the objective. */
+      progress_current: z.number(),
+      /** The progress status of the objective. */
+      progress_complete: z.number(),
+      /** The claim status of the objective. */
+      claimed: z.boolean()
+    })
+  )
+});
+var AccountWizardsVaultListingsDTO = z.array(
+  z.object({
+    /** The listing id. */
+    id: z.number(),
+    /** The id of the item */
+    item_id: z.number(),
+    /** The quantity of the item the user receives */
+    item_count: z.number(),
+    /** Appears to be the position in the wizards vault UI. */
+    type: z.enum(["Featured", "Normal", "Legacy"]),
+    /** The quantity of Astral Acclaim to purchase . */
+    cost: z.number(),
+    /** Amount of the item already purchased. Not included if the reward is unlimited. */
+    purchased: z.number().optional(),
+    /** Maximum amount that can be purchased. Not included if the reward is unlimited. */
+    purchase_limit: z.number().optional()
+  })
+);
+var AccountWizardsVaultSpecialDTO = z.object({
+  /** An array of objects detailing each weekly objective */
+  objectives: z.array(
+    z.object({
+      /** The ID of the objective. */
+      id: z.number(),
+      /** The title of the objective. */
+      title: z.string(),
+      /** The reward track containing the objective. */
+      track: z.string(),
+      /** The astral acclaim awarded for the objective. */
+      acclaim: z.number(),
+      /** The current progress of the objective. */
+      progress_current: z.number(),
+      /** The progress status of the objective. */
+      progress_complete: z.number(),
+      /** The claim status of the objective. */
+      claimed: z.boolean()
+    })
+  )
+});
+var AccountWizardsVaultWeeklyDTO = z.object({
+  /** The current progress to the meta achievement for the weekly. */
+  meta_progress_current: z.number(),
+  /** The threshold for the meta progress to be 'complete', and the meta reward claimable. */
+  meta_progress_complete: z.number(),
+  /** The ID of the item you receive for claiming the meta reward */
+  meta_reward_item_id: z.number(),
+  /** The amount of Astral Acclaim you receive for claiming the meta reward */
+  meta_reward_astral: z.number(),
+  /** Whether the account has claimed the meta reward. */
+  meta_reward_claimed: z.boolean(),
+  /** An array of objects detailing each weekly objective */
+  objectives: z.array(
+    z.object({
+      /** The ID of the objective. */
+      id: z.number(),
+      /** The title of the objective. */
+      title: z.string(),
+      /** The reward track containing the objective. */
+      track: z.string(),
+      /** The astral acclaim awarded for the objective. */
+      acclaim: z.number(),
+      /** The current progress of the objective. */
+      progress_current: z.number(),
+      /** The progress status of the objective. */
+      progress_complete: z.number(),
+      /** The claim status of the objective. */
+      claimed: z.boolean()
+    })
+  )
+});
 var AccountWorldBossesDTO = z.array(
   /** Name of the world boss. */
   z.string()
@@ -1776,7 +1872,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(
@@ -3636,6 +3732,44 @@ var StoriesSeasonsDTO = z.array(
     stories: z.array(z.number())
   })
 );
+var WizardsVaultDTO = z.object({
+  /** The name of the current season. */
+  title: z.string(),
+  /** The date that the current season begins. */
+  start: z.string(),
+  /** The date that the current season ends. */
+  end: z.string(),
+  /** The wizard's vault listing ids available (use the sub endpoint to view item details). */
+  listings: z.array(z.number()),
+  /** The wizard's vault objective ids available (use the sub endpoint to view item details). */
+  objectives: z.array(z.number())
+});
+var WizardsVaultListingsDTO = z.array(
+  z.object({
+    /** The listing id. */
+    id: z.number(),
+    /** The id of the item */
+    item_id: z.number(),
+    /** The quantity of the item the user receives */
+    item_count: z.number(),
+    /** Appears to be the position in the wizards vault UI. */
+    type: z.enum(["Featured", "Normal", "Legacy"]),
+    /** The quantity of Astral Acclaim to purchase . */
+    cost: z.number()
+  })
+);
+var WizardsVaultObjectivesDTO = z.array(
+  z.object({
+    /** The ID of the objective. */
+    id: z.number(),
+    /** The title of the objective. */
+    title: z.string(),
+    /** The reward track containing the objective. */
+    track: z.enum(["PvP", "WvW", "PvE"]),
+    /** The amount of astral acclaim awarded. */
+    acclaim: z.number()
+  })
+);
 var WvWAbilitiesDTO = z.array(
   z.object({
     /** The id of the abilities.*/
@@ -4025,6 +4159,22 @@ var endpoints = {
       path: "v2/account/wallet",
       tokenRequired: true
     },
+    wizardsVaultDaily: {
+      path: "v2/account/wizardsvault/daily",
+      tokenRequired: true
+    },
+    wizardsVaultListings: {
+      path: "v2/account/wizardsvault/listings",
+      tokenRequired: true
+    },
+    wizardsVaultSpecial: {
+      path: "v2/account/wizardsvault/special",
+      tokenRequired: true
+    },
+    wizardsVaultWeekly: {
+      path: "v2/account/wizardsvault/weekly",
+      tokenRequired: true
+    },
     worldBosses: {
       path: "v2/account/worldbosses",
       tokenRequired: true
@@ -4693,6 +4843,28 @@ var endpoints = {
       tokenRequired: false
     }
   },
+  wizardsVault: {
+    root: {
+      path: "v2/wizardsvault",
+      tokenRequired: false
+    },
+    listingsAll: {
+      path: "v2/wizardsvault/listings",
+      tokenRequired: false
+    },
+    listingsById: {
+      path: "v2/wizardsvault/listings?ids=$(ids)",
+      tokenRequired: false
+    },
+    objectivesAll: {
+      path: "v2/wizardsvault/objectives",
+      tokenRequired: false
+    },
+    objectivesById: {
+      path: "v2/wizardsvault/objectives?ids=$(ids)",
+      tokenRequired: false
+    }
+  },
   worldBosses: {
     path: "v2/worldbosses",
     tokenRequired: false
@@ -5033,6 +5205,46 @@ var AccountApi = class extends ApiBase {
   async getWallet() {
     return await this.buildRequest(endpoints.account.wallet, {}, AccountWalletDTO);
   }
+  /**
+   * Returns the current set of daily Wizard's Vault achievements for the account.
+   */
+  async getWizardsVaultDaily() {
+    return await this.buildRequest(
+      endpoints.account.wizardsVaultDaily,
+      {},
+      AccountWizardsVaultDailyDTO
+    );
+  }
+  /**
+   * 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.
+   */
+  async getWizardsVaultListings() {
+    return await this.buildRequest(
+      endpoints.account.wizardsVaultListings,
+      {},
+      AccountWizardsVaultListingsDTO
+    );
+  }
+  /**
+   * Returns the current set of special Wizard's Vault achievements for the account.
+   */
+  async getWizardsVaultSpecial() {
+    return await this.buildRequest(
+      endpoints.account.wizardsVaultSpecial,
+      {},
+      AccountWizardsVaultSpecialDTO
+    );
+  }
+  /**
+   * Returns the current set of weekly Wizard's Vault achievements for the account.
+   */
+  async getWizardsVaultWeekly() {
+    return await this.buildRequest(
+      endpoints.account.wizardsVaultWeekly,
+      {},
+      AccountWizardsVaultWeeklyDTO
+    );
+  }
   /**
    * Returns information about which world bosses have been killed by the account since daily-reset.
    */
@@ -6098,6 +6310,38 @@ var PvPApi = class extends ApiBase {
   }
 };
 
+// src/apis/wizardsvault/wizardsvault.ts
+var WizardsVaultApi = class extends ApiBase {
+  /**
+   * Returns information about the current Wizard's Vault season.
+   */
+  async get() {
+    return await this.buildRequest(endpoints.wizardsVault.root, {}, WizardsVaultDTO);
+  }
+  async getListings(ids) {
+    if (ids)
+      return await this.buildRequest(
+        endpoints.wizardsVault.listingsById,
+        { ids },
+        WizardsVaultListingsDTO
+      );
+    return await this.buildRequest(endpoints.wizardsVault.listingsAll, {}, numberArrayType);
+  }
+  async getObjectives(ids) {
+    if (ids)
+      return await this.buildRequest(
+        endpoints.wizardsVault.objectivesById,
+        { ids },
+        WizardsVaultObjectivesDTO
+      );
+    return await this.buildRequest(
+      endpoints.wizardsVault.objectivesAll,
+      {},
+      numberArrayType
+    );
+  }
+};
+
 // src/apis/wvw/wvw.ts
 var WorldVsWorldApi = class extends ApiBase {
   async getAbilities(ids) {
@@ -6273,6 +6517,8 @@ var GW2Api = class extends ApiBase {
   tokenInfo = new TokenInfoApi(this.getParams());
   /** /v2/traits Api */
   traits = new TraitsApi(this.getParams());
+  /** /v2/wizardsvault Api */
+  wizardsVault = new WizardsVaultApi(this.getParams());
   /** /v2/worldbosses Api */
   worldBosses = new WorldBossesApi(this.getParams());
   /** /v2/worlds Api */
@@ -6282,5 +6528,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.4",
   "description": "GuildWars 2 API Wrapper in Typescript",
   "homepage": "https://gitlab.com/dinckelman/guildwars2-ts",
   "main": "dist/index.js",
@@ -22,26 +22,26 @@
     "gw2"
   ],
   "dependencies": {
-    "axios": "^1.6.1",
-    "promise-queue": "^2.2.5",
-    "tslog": "^4.9.2",
-    "zod": "^3.22.4"
+    "axios": "1.6.7",
+    "promise-queue": "2.2.5",
+    "tslog": "4.9.2",
+    "zod": "3.22.4"
   },
   "devDependencies": {
-    "@biomejs/biome": "1.3.3",
+    "@biomejs/biome": "^1.5.3",
     "@jest/globals": "^29.7.0",
-    "@types/node": "^20.9.0",
+    "@types/node": "^20.11.24",
     "@types/promise-queue": "^2.2.3",
     "jest": "^29.7.0",
-    "ts-jest": "^29.1.1",
-    "ts-node": "^10.9.1",
-    "tsup": "^7.2.0",
-    "typescript": "^5.2.2"
+    "ts-jest": "^29.1.2",
+    "ts-node": "^10.9.2",
+    "tsup": "^8.0.2",
+    "typescript": "^5.3.3"
   },
   "scripts": {
     "lint:dry": "biome check .",
     "lint": "biome check . --apply",
-    "build": "tsup",
+    "build": "tsup --env.NODE_ENV production",
     "test": "jest",
     "test:coverage": "jest --coverage"
   }