guildwars2-ts 1.1.1 → 1.1.4

package/README.md

@@ -20,10 +20,7 @@ const api: GW2Api = new GW2Api({
 	// Token is not required for all of the endpoints
 	token: "YOUR-TOKEN-HERE",
 	language: ApiLanguage.English,
-	rateLimit: {
-		retry: true,
-		attempts: 3,
-	},
+	rateLimitRetry: true
 });
 
 (async () => {
@@ -42,12 +39,6 @@ const api: GW2Api = new GW2Api({
 
 If you find any kinds of errors in the program code, or wish to add/update any of the functionality provided by this project, please feel free to open a pull request. Validation error logs are extremely helpful, so please include them in the request
 
-## Plans
-- Data caching for repeated requests
-- Better logging
-- Support for different schemas, when available
-- Endpoint structure rework (backend only)
-
 [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/index.d.mts

@@ -26,17 +26,8 @@ type UrlParams = Record<string, string | number | string[] | number[]>;
 interface ApiParams {
     token?: string;
     language?: ApiLanguage;
-    rateLimit?: RatelimitParams;
+    rateLimitRetry?: boolean;
 }
-/**
- * Ratelimiting parameters
- */
-type RatelimitParams = {
-    retry: true;
-    attempts: number;
-} | {
-    retry: false;
-};
 
 /**
  * Base Api object. Implements anything needed for the requests to all endpoints
@@ -58,8 +49,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 +62,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
      *
@@ -339,6 +331,70 @@ declare class AccountApi extends ApiBase {
         id: number;
         value: number;
     }[]>;
+    /**
+     * Returns the current set of daily Wizard's Vault achievements for the account.
+     */
+    getWizardsVaultDaily(): Promise<{
+        objectives: {
+            id: number;
+            title: string;
+            track: string;
+            acclaim: number;
+            progress_current: number;
+            progress_complete: number;
+            claimed: boolean;
+        }[];
+        meta_progress_current: number;
+        meta_progress_complete: number;
+        meta_reward_item_id: number;
+        meta_reward_astral: number;
+        meta_reward_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;
+        type: "Featured" | "Normal" | "Legacy";
+        item_id: number;
+        item_count: number;
+        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<{
+        objectives: {
+            id: number;
+            title: string;
+            track: string;
+            acclaim: number;
+            progress_current: number;
+            progress_complete: number;
+            claimed: boolean;
+        }[];
+        meta_progress_current: number;
+        meta_progress_complete: number;
+        meta_reward_item_id: number;
+        meta_reward_astral: number;
+        meta_reward_claimed: boolean;
+    }>;
     /**
      * Returns information about which world bosses have been killed by the account since daily-reset.
      */
@@ -432,16 +488,16 @@ declare const BackstoryAnswersDTO: z.ZodArray<z.ZodObject<{
     races: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: string;
-    description: string;
     title: string;
+    description: string;
     journal: string;
     question: number;
     professions?: string[] | undefined;
     races?: string[] | undefined;
 }, {
     id: string;
-    description: string;
     title: string;
+    description: string;
     journal: string;
     question: number;
     professions?: string[] | undefined;
@@ -468,17 +524,17 @@ declare const BackstoryQuestionsDTO: z.ZodArray<z.ZodObject<{
     professions: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
 }, "strip", z.ZodTypeAny, {
     id: number;
+    title: string;
     description: string;
     order: number;
-    title: string;
     answers: string[];
     races?: string[] | undefined;
     professions?: string[] | undefined;
 }, {
     id: number;
+    title: string;
     description: string;
     order: number;
-    title: string;
     answers: string[];
     races?: string[] | undefined;
     professions?: string[] | undefined;
@@ -1799,8 +1855,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 +1894,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 +1932,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">;
 
 /**
@@ -5836,10 +5892,10 @@ declare const LegendaryArmoryDTO: z.ZodArray<z.ZodObject<{
     max_count: z.ZodUnion<[z.ZodLiteral<1>, z.ZodLiteral<2>, z.ZodLiteral<4>, z.ZodLiteral<7>, z.ZodLiteral<8>]>;
 }, "strip", z.ZodTypeAny, {
     id: number;
-    max_count: 1 | 2 | 4 | 7 | 8;
+    max_count: 4 | 2 | 1 | 7 | 8;
 }, {
     id: number;
-    max_count: 1 | 2 | 4 | 7 | 8;
+    max_count: 4 | 2 | 1 | 7 | 8;
 }>, "many">;
 
 /**
@@ -6086,16 +6142,16 @@ declare const MinisDTO: z.ZodArray<z.ZodObject<{
 }, "strip", z.ZodTypeAny, {
     id: number;
     name: string;
+    item_id: number;
     order: number;
     icon: string;
-    item_id: number;
     unlock?: string | undefined;
 }, {
     id: number;
     name: string;
+    item_id: number;
     order: number;
     icon: string;
-    item_id: number;
     unlock?: string | undefined;
 }>, "many">;
 
@@ -9744,6 +9800,58 @@ declare const StoriesSeasonsDTO: z.ZodArray<z.ZodObject<{
     order: number;
 }>, "many">;
 
+/**
+ * /v2/wizardsvault/listings definition
+ */
+declare const WizardsVaultListingsDTO: z.ZodArray<z.ZodObject<{
+    /** The listing id. */
+    id: z.ZodNumber;
+    /** The id of the item */
+    item_id: z.ZodNumber;
+    /** The quantity of the item the user receives */
+    item_count: z.ZodNumber;
+    /** Appears to be the position in the wizards vault UI. */
+    type: z.ZodEnum<["Featured", "Normal", "Legacy"]>;
+    /** The quantity of Astral Acclaim to purchase . */
+    cost: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    type: "Featured" | "Normal" | "Legacy";
+    item_id: number;
+    item_count: number;
+    cost: number;
+}, {
+    id: number;
+    type: "Featured" | "Normal" | "Legacy";
+    item_id: number;
+    item_count: number;
+    cost: number;
+}>, "many">;
+
+/**
+ * /v2/wizardsvault/objectives definition
+ */
+declare const WizardsVaultObjectivesDTO: z.ZodArray<z.ZodObject<{
+    /** The ID of the objective. */
+    id: z.ZodNumber;
+    /** The title of the objective. */
+    title: z.ZodString;
+    /** The reward track containing the objective. */
+    track: z.ZodEnum<["PvP", "WvW", "PvE"]>;
+    /** The amount of astral acclaim awarded. */
+    acclaim: z.ZodNumber;
+}, "strip", z.ZodTypeAny, {
+    id: number;
+    title: string;
+    track: "PvP" | "WvW" | "PvE";
+    acclaim: number;
+}, {
+    id: number;
+    title: string;
+    track: "PvP" | "WvW" | "PvE";
+    acclaim: number;
+}>, "many">;
+
 /**
  * /v2/wvw/abilities definition
  */
@@ -11020,8 +11128,8 @@ declare class GuildApi extends ApiBase {
     } | {
         type: "stash";
         count: number;
-        coins: number;
         item_id: number;
+        coins: number;
         operation: "deposit" | "withdraw" | "move";
     } | {
         type: "motd";
@@ -12291,6 +12399,39 @@ declare class PvPApi extends ApiBase {
     }>;
 }
 
+declare class WizardsVaultApi extends ApiBase {
+    /**
+     * Returns information about the current Wizard's Vault season.
+     */
+    get(): Promise<{
+        listings: number[];
+        objectives: number[];
+        title: string;
+        start: string;
+        end: string;
+    }>;
+    /**
+     * Returns details about listings in the Wizard's Vault.
+     */
+    getListings(): Promise<z.infer<typeof numberArrayType>>;
+    /**
+     * Returns details about listings in the Wizard's Vault.
+     *
+     * @param ids - (optional) List of listing ids, or "all".
+     */
+    getListings(ids: number[] | 'all'): Promise<z.infer<typeof WizardsVaultListingsDTO>>;
+    /**
+     * Returns all Wizard's Vault's objectives in the game.
+     */
+    getObjectives(): Promise<z.infer<typeof numberArrayType>>;
+    /**
+     * Returns all Wizard's Vault's objectives in the game.
+     *
+     * @param ids - (optional) List of objective ids, or "all".
+     */
+    getObjectives(ids: number[] | 'all'): Promise<z.infer<typeof WizardsVaultObjectivesDTO>>;
+}
+
 /**
  * /v2/wvw Api
  */
@@ -12517,6 +12658,8 @@ declare class GW2Api extends ApiBase {
     readonly tokenInfo: TokenInfoApi;
     /** /v2/traits Api */
     readonly traits: TraitsApi;
+    /** /v2/wizardsvault Api */
+    readonly wizardsVault: WizardsVaultApi;
     /** /v2/worldbosses Api */
     readonly worldBosses: WorldBossesApi;
     /** /v2/worlds Api */
@@ -12529,13 +12672,10 @@ declare class GW2Api extends ApiBase {
  * TSlog log level
  */
 declare enum LogLevel {
-    silly = 0,
-    trace = 1,
-    debug = 2,
-    info = 3,
-    warn = 4,
     error = 5,
-    fatal = 6
+    warn = 4,
+    info = 3,
+    debug = 2
 }
 /**
  * Set logger level
@@ -12550,4 +12690,4 @@ declare const setLogLevel: (minLevel: LogLevel) => void;
  */
 declare const setPathLogging: (displayFilePath: boolean) => void;
 
-export { ApiLanguage, ApiParams, GW2Api, LogLevel, RatelimitParams, UrlParams, setLogLevel, setPathLogging };
+export { ApiLanguage, type ApiParams, GW2Api, LogLevel, setLogLevel, setPathLogging };