Add types for /v2/home/cats and /v2/home/nodes

GW2Treasures · Aug 10, 2024 · fcd1158 · fcd1158
1 parent d97021e
commit fcd1158
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 0 deletions.
diff --git a/.changeset/dirty-rockets-shake.md b/.changeset/dirty-rockets-shake.md
@@ -0,0 +1,5 @@
+---
+"@gw2api/types": patch
+---
+
+Add types for `/v2/home/cats` and `/v2/home/nodes`
diff --git a/packages/types/data/home.ts b/packages/types/data/home.ts
@@ -0,0 +1,22 @@
+/**
+ * Cats (/v2/home/cats).
+ *
+ * @see https://wiki.guildwars2.com/wiki/API:2/home/cats
+ */
+export interface HomeCat {
+  /** The cat id */
+  id: number,
+
+  /** The hint on how to obtain the cat */
+  hint: string,
+}
+
+/**
+ * Home instance nodes (/v2/home/nodes).
+ *
+ * @see https://wiki.guildwars2.com/wiki/API:2/home/nodes
+ */
+export interface HomeNode {
+  /** The cat id */
+  id: string,
+}
diff --git a/packages/types/endpoints.ts b/packages/types/endpoints.ts
@@ -17,6 +17,7 @@ import type { Listing, Price, TransactionCurrent, TransactionHistoric } from './
 import type { Createsubtoken } from './data/createsubtoken';
 import type { Currency } from './data/currency';
 import type { GuildUpgrade } from './data/guild';
+import type { HomeCat, HomeNode } from './data/home';
 import type { HomesteadDecoration } from './data/homestead';
 import type { Item } from './data/item';
 import type { Legendaryarmory } from './data/legendaryarmory';
@@ -438,6 +439,8 @@ export type EndpointType<Url extends KnownEndpoint | (string & {}), Schema exten
   Url extends BulkExpandedEndpointUrl<'/v2/colors', number> ? BulkExpandedResponseType<'/v2/colors', Url, number, Color> :
   Url extends BulkExpandedEndpointUrl<'/v2/currencies', number> ? BulkExpandedResponseType<'/v2/currencies', Url, number, Currency> :
   Url extends BulkExpandedEndpointUrl<'/v2/guild/upgrades', number> ? BulkExpandedResponseType<'/v2/guild/upgrades', Url, number, GuildUpgrade> :
+  Url extends BulkExpandedEndpointUrl<'/v2/home/cats', number> ? BulkExpandedResponseType<'/v2/home/cats', Url, number, HomeCat> :
+  Url extends BulkExpandedEndpointUrl<'/v2/home/nodes', string> ? BulkExpandedResponseType<'/v2/home/nodes', Url, string, HomeNode> :
   Url extends BulkExpandedEndpointUrl<'/v2/homestead/decorations', number> ? BulkExpandedResponseType<'/v2/homestead/decorations', Url, number, HomesteadDecoration> :
   Url extends BulkExpandedEndpointUrl<'/v2/items', number> ? BulkExpandedResponseType<'/v2/items', Url, number, Item<Schema>> :
   Url extends BulkExpandedEndpointUrl<'/v2/legendaryarmory', number> ? BulkExpandedResponseType<'/v2/legendaryarmory', Url, number, Legendaryarmory> :