@blizzard-api/d3 1.0.4 → 1.0.5

package/dist/index.js

@@ -1,157 +1,304 @@
-// src/base.ts
-var base = "d3/data";
-var profileBase = `d3/profile`;
-var gameDataBase = `data/d3`;
+//#region src/base.ts
+const base = "d3/data";
+const profileBase = `d3/profile`;
+const gameDataBase = `data/d3`;
 
-// src/act/act.ts
+//#endregion
+//#region src/act/act.ts
+/**
+
+* Returns the act information for the specified act ID.
+
+* @param actId The ID of the act.
+
+* @returns The act resource. See {@link ActResponse}.
+
+*/
 function act(actId) {
-  return {
-    path: `${base}/act/${actId}`
-  };
+	return { path: `${base}/act/${actId}` };
 }
+/**
+
+* Returns the index of acts.
+
+* @returns The act index resource. See {@link ActIndexResponse}.
+
+*/
 function actIndex() {
-  return {
-    path: `${base}/act`
-  };
+	return { path: `${base}/act` };
 }
 
-// src/artisan-and-recipe/artisan-and-recipe.ts
+//#endregion
+//#region src/artisan-and-recipe/artisan-and-recipe.ts
+/**
+
+* Returns the artisan information for the specified artisan slug.
+
+* @param artisanSlug The slug of the artisan.
+
+* @returns The artisan resource. See {@link ArtisanResponse}.
+
+*/
 function artisan(artisanSlug) {
-  return {
-    path: `${base}/artisan/${artisanSlug}`
-  };
+	return { path: `${base}/artisan/${artisanSlug}` };
 }
+/**
+
+* Returns the recipe information for the specified artisan and recipe slugs.
+
+* @param artisanSlug The slug of the artisan.
+
+* @param recipeSlug The slug of the recipe.
+
+* @returns The recipe resource. See {@link RecipeResponse}.
+
+*/
 function recipe(artisanSlug, recipeSlug) {
-  return {
-    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`
-  };
+	return { path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}` };
 }
 
-// src/character-class-and-skill/character-class-and-skill.ts
+//#endregion
+//#region src/character-class-and-skill/character-class-and-skill.ts
+/**
+
+* Returns the character class information for the specified character class slug.
+
+* @param characterClassSlug The slug of the character class.
+
+* @returns The character class resource. See {@link CharacterClassResponse}.
+
+*/
 function characterClass(characterClassSlug) {
-  return {
-    path: `${base}/character-class/${characterClassSlug}`
-  };
+	return { path: `${base}/character-class/${characterClassSlug}` };
 }
+/**
+
+* Returns the skill information for the specified character class and skill slugs.
+
+* @param characterClassSlug The slug of the character class.
+
+* @param skillSlug The slug of the skill.
+
+* @returns The skill resource. See {@link SkillResponse}.
+
+*/
 function skill(characterClassSlug, skillSlug) {
-  return {
-    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`
-  };
+	return { path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}` };
 }
 
-// src/follower/follower.ts
+//#endregion
+//#region src/follower/follower.ts
+/**
+
+* Returns the follower information for the specified follower slug.
+
+* @param followerSlug The slug of the follower.
+
+* @returns The follower resource. See {@link FollowerResponse}.
+
+*/
 function follower(followerSlug) {
-  return {
-    path: `${base}/follower/${followerSlug}`
-  };
+	return { path: `${base}/follower/${followerSlug}` };
 }
 
-// src/game-data/game-data.ts
+//#endregion
+//#region src/game-data/game-data.ts
+/**
+
+* Returns the era information for the specified era ID.
+
+* @param id The ID of the era.
+
+* @returns The era resource. See {@link EraResponse}.
+
+*/
 function era(id) {
-  return {
-    path: `${gameDataBase}/era/${id}`
-  };
+	return { path: `${gameDataBase}/era/${id}` };
 }
+/**
+
+* Returns the era index.
+
+* @returns The era index resource. See {@link EraIndexResponse}.
+
+*/
 function eraIndex() {
-  return {
-    path: `${gameDataBase}/era`
-  };
+	return { path: `${gameDataBase}/era` };
 }
+/**
+
+* Returns the era leaderboard for the specified era ID and leaderboard.
+
+* @param id The ID of the era.
+
+* @param leaderboard The name of the leaderboard.
+
+* @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.
+
+*/
 function eraLeaderboard(id, leaderboard) {
-  return {
-    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`
-  };
+	return { path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}` };
 }
+/**
+
+* Returns the season information for the specified season ID.
+
+* @param id The ID of the season.
+
+* @returns The season resource. See {@link SeasonResponse}.
+
+*/
 function season(id) {
-  return {
-    path: `${gameDataBase}/season/${id}`
-  };
+	return { path: `${gameDataBase}/season/${id}` };
 }
+/**
+
+* Returns the season index.
+
+* @returns The season index resource. See {@link SeasonIndexResponse}.
+
+*/
 function seasonIndex() {
-  return {
-    path: `${gameDataBase}/season`
-  };
+	return { path: `${gameDataBase}/season` };
 }
+/**
+
+* Returns the season leaderboard for the specified season ID and leaderboard.
+
+* @param id The ID of the season.
+
+* @param leaderboard The name of the leaderboard.
+
+* @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.
+
+*/
 function seasonLeaderboard(id, leaderboard) {
-  return {
-    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`
-  };
+	return { path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}` };
 }
 
-// src/item-type/item-type.ts
+//#endregion
+//#region src/item-type/item-type.ts
+/**
+
+* Returns the item type information for the specified item type slug.
+
+* @param itemTypeSlug The slug of the item type, example: "sword2h"
+
+* @returns The item type resource. See {@link ItemTypeResponse}.
+
+*/
 function itemType(itemTypeSlug) {
-  return {
-    path: `${base}/item-type/${itemTypeSlug}`
-  };
+	return { path: `${base}/item-type/${itemTypeSlug}` };
 }
+/**
+
+* Returns the item type index.
+
+* @returns The item type index resource. See {@link ItemTypeIndexResponse}.
+
+*/
 function itemTypeIndex() {
-  return {
-    path: `${base}/item-type`
-  };
+	return { path: `${base}/item-type` };
 }
 
-// src/item/item.ts
+//#endregion
+//#region src/item/item.ts
+/**
+
+* Returns the item information for the specified item slug and ID.
+
+* @param itemSlugAndId The slug and ID of the item, example: "corrupted-ashbringer-Unique_Sword_2H_104_x1".
+
+* @returns The item resource. See {@link ItemResponse}.
+
+*/
 function item(itemSlugAndId) {
-  return {
-    path: `${base}/item/${itemSlugAndId}`
-  };
+	return { path: `${base}/item/${itemSlugAndId}` };
 }
 
-// src/profile/profile.ts
+//#endregion
+//#region src/profile/profile.ts
+/**
+
+* Returns the account information for the specified battle tag.
+
+* @param battleTag The battle tag of the account.
+
+* @returns The account resource. See {@link AccountResponse}.
+
+*/
 function account(battleTag) {
-  return {
-    path: `${profileBase}/${battleTag}`
-  };
+	return { path: `${profileBase}/${battleTag}` };
 }
+/**
+
+* Returns the hero information for the specified battle tag and hero ID.
+
+* @param battleTag The battle tag of the account.
+
+* @param heroId The ID of the hero.
+
+* @returns The hero resource. See {@link AccountHeroResponse}.
+
+*/
 function accountHero(battleTag, heroId) {
-  return {
-    path: `${profileBase}/${battleTag}/hero/${heroId}`
-  };
+	return { path: `${profileBase}/${battleTag}/hero/${heroId}` };
 }
+/**
+
+* Returns the follower items for the specified battle tag and hero ID.
+
+* @param battleTag The battle tag of the account.
+
+* @param heroId The ID of the hero.
+
+* @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.
+
+*/
 function accountHeroFollowerItems(battleTag, heroId) {
-  return {
-    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`
-  };
+	return { path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items` };
 }
+/**
+
+* Returns the items for the specified battle tag and hero ID.
+
+* @param battleTag The battle tag of the account.
+
+* @param heroId The ID of the hero.
+
+* @returns The hero items resource. See {@link AccountHeroResponse}.
+
+*/
 function accountHeroItems(battleTag, heroId) {
-  return {
-    path: `${profileBase}/${battleTag}/hero/${heroId}/items`
-  };
-}
-
-// src/index.ts
-var d3 = {
-  //Act
-  act,
-  actIndex,
-  //Artisan and Recipe
-  artisan,
-  recipe,
-  //Follower
-  follower,
-  //Character Class and Skill
-  characterClass,
-  skill,
-  //Item Type
-  itemType,
-  itemTypeIndex,
-  //Item
-  item,
-  //Profile
-  account,
-  accountHero,
-  accountHeroFollowerItems,
-  accountHeroItems,
-  //Game Data
-  era,
-  eraIndex,
-  eraLeaderboard,
-  season,
-  seasonIndex,
-  seasonLeaderboard
+	return { path: `${profileBase}/${battleTag}/hero/${heroId}/items` };
+}
+
+//#endregion
+//#region src/index.ts
+const d3 = {
+	act,
+	actIndex,
+	artisan,
+	recipe,
+	follower,
+	characterClass,
+	skill,
+	itemType,
+	itemTypeIndex,
+	item,
+	account,
+	accountHero,
+	accountHeroFollowerItems,
+	accountHeroItems,
+	era,
+	eraIndex,
+	eraLeaderboard,
+	season,
+	seasonIndex,
+	seasonLeaderboard
 };
 var src_default = d3;
 
+//#endregion
 export { account, accountHero, accountHeroFollowerItems, accountHeroItems, act, actIndex, artisan, characterClass, d3, src_default as default, era, eraIndex, eraLeaderboard, follower, item, itemType, itemTypeIndex, recipe, season, seasonIndex, seasonLeaderboard, skill };
-//# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"sources":["../src/base.ts","../src/act/act.ts","../src/artisan-and-recipe/artisan-and-recipe.ts","../src/character-class-and-skill/character-class-and-skill.ts","../src/follower/follower.ts","../src/game-data/game-data.ts","../src/item-type/item-type.ts","../src/item/item.ts","../src/profile/profile.ts","../src/index.ts"],"names":[],"mappings":";AAAO,IAAM,IAAO,GAAA,SAAA;AAEb,IAAM,WAAc,GAAA,CAAA,UAAA,CAAA;AAGpB,IAAM,YAAe,GAAA,CAAA,OAAA,CAAA;;;ACIrB,SAAS,IAAI,KAAsC,EAAA;AACxD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,KAAA,EAAQ,KAAK,CAAA;AAAA,GAC5B;AACF;AAMO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,IAAA;AAAA,GACf;AACF;;;ACdO,SAAS,QAAQ,WAAgD,EAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,SAAA,EAAY,WAAW,CAAA;AAAA,GACtC;AACF;AAQO,SAAS,MAAA,CAAO,aAAqB,UAA8C,EAAA;AACxF,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAY,SAAA,EAAA,WAAW,WAAW,UAAU,CAAA;AAAA,GAC3D;AACF;;;AChBO,SAAS,eAAe,kBAA8D,EAAA;AAC3F,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,iBAAA,EAAoB,kBAAkB,CAAA;AAAA,GACrD;AACF;AAQO,SAAS,KAAA,CAAM,oBAA4B,SAA4C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,IAAI,CAAS,MAAA,EAAA,kBAAkB,UAAU,SAAS,CAAA;AAAA,GAC7D;AACF;;;AChBO,SAAS,SAAS,YAAkD,EAAA;AACzE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,UAAA,EAAa,YAAY,CAAA;AAAA,GACxC;AACF;;;ACGO,SAAS,IAAI,EAAmC,EAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,KAAA,EAAQ,EAAE,CAAA;AAAA,GACjC;AACF;AAMO,SAAS,QAAuC,GAAA;AACrD,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,IAAA;AAAA,GACvB;AACF;AAQO,SAAS,cAAA,CAAe,IAAY,WAAuD,EAAA;AAChG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAQ,KAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA;AAAA,GAC5D;AACF;AAOO,SAAS,OAAO,EAAsC,EAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,YAAY,CAAA,QAAA,EAAW,EAAE,CAAA;AAAA,GACpC;AACF;AAMO,SAAS,WAA6C,GAAA;AAC3D,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,YAAY,CAAA,OAAA;AAAA,GACvB;AACF;AAQO,SAAS,iBAAA,CAAkB,IAAY,WAA0D,EAAA;AACtG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,YAAY,CAAW,QAAA,EAAA,EAAE,gBAAgB,WAAW,CAAA;AAAA,GAC/D;AACF;;;AClEO,SAAS,SAAS,YAAyD,EAAA;AAChF,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,WAAA,EAAc,YAAY,CAAA;AAAA,GACzC;AACF;AAMO,SAAS,aAAwD,GAAA;AACtE,EAAO,OAAA;AAAA,IACL,IAAA,EAAM,GAAG,IAAI,CAAA,UAAA;AAAA,GACf;AACF;;;ACdO,SAAS,KAAK,aAA+C,EAAA;AAClE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,IAAI,CAAA,MAAA,EAAS,aAAa,CAAA;AAAA,GACrC;AACF;;;ACJO,SAAS,QAAQ,SAA8C,EAAA;AACpE,EAAO,OAAA;AAAA,IACL,IAAM,EAAA,CAAA,EAAG,WAAW,CAAA,CAAA,EAAI,SAAS,CAAA;AAAA,GACnC;AACF;AAQO,SAAS,WAAA,CAAY,WAAmB,MAA+C,EAAA;AAC5F,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA;AAAA,GAClD;AACF;AAQO,SAAS,wBAAA,CACd,WACA,MAC4C,EAAA;AAC5C,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,eAAA;AAAA,GAClD;AACF;AAQO,SAAS,gBAAA,CAAiB,WAAmB,MAA+C,EAAA;AACjG,EAAO,OAAA;AAAA,IACL,MAAM,CAAG,EAAA,WAAW,CAAI,CAAA,EAAA,SAAS,SAAS,MAAM,CAAA,MAAA;AAAA,GAClD;AACF;;;AC3CA,IAAM,EAAK,GAAA;AAAA;AAAA,EAET,GAAA;AAAA,EACA,QAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,MAAA;AAAA;AAAA,EAEA,QAAA;AAAA;AAAA,EAEA,cAAA;AAAA,EACA,KAAA;AAAA;AAAA,EAEA,QAAA;AAAA,EACA,aAAA;AAAA;AAAA,EAEA,IAAA;AAAA;AAAA,EAEA,OAAA;AAAA,EACA,WAAA;AAAA,EACA,wBAAA;AAAA,EACA,gBAAA;AAAA;AAAA,EAEA,GAAA;AAAA,EACA,QAAA;AAAA,EACA,cAAA;AAAA,EACA,MAAA;AAAA,EACA,WAAA;AAAA,EACA;AACF;AACA,IAAO,WAAQ,GAAA","file":"index.js","sourcesContent":["export const base = 'd3/data';\r\n\r\nexport const profileBase = `d3/profile`;\r\n\r\n//Why is the game data APIs base root the reverse of the regular base?\r\nexport const gameDataBase = `data/d3`;\r\n\r\n/**\r\n * Base interface for Blizzard API responses.\r\n */\r\nexport interface ResponseBase {\r\n  _links: {\r\n    self: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ActIndexResponse, ActResponse } from './types';\r\n\r\n/**\r\n * Returns the act information for the specified act ID.\r\n * @param actId The ID of the act.\r\n * @returns The act resource. See {@link ActResponse}.\r\n */\r\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the index of acts.\r\n * @returns The act index resource. See {@link ActIndexResponse}.\r\n */\r\nexport function actIndex(): Resource<ActIndexResponse> {\r\n  return {\r\n    path: `${base}/act`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ArtisanResponse, RecipeResponse } from './types';\r\n\r\n/**\r\n * Returns the artisan information for the specified artisan slug.\r\n * @param artisanSlug The slug of the artisan.\r\n * @returns The artisan resource. See {@link ArtisanResponse}.\r\n */\r\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the recipe information for the specified artisan and recipe slugs.\r\n * @param artisanSlug The slug of the artisan.\r\n * @param recipeSlug The slug of the recipe.\r\n * @returns The recipe resource. See {@link RecipeResponse}.\r\n */\r\nexport function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { CharacterClassResponse, SkillResponse } from './types';\r\n\r\n/**\r\n * Returns the character class information for the specified character class slug.\r\n * @param characterClassSlug The slug of the character class.\r\n * @returns The character class resource. See {@link CharacterClassResponse}.\r\n */\r\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the skill information for the specified character class and skill slugs.\r\n * @param characterClassSlug The slug of the character class.\r\n * @param skillSlug The slug of the skill.\r\n * @returns The skill resource. See {@link SkillResponse}.\r\n */\r\nexport function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse> {\r\n  return {\r\n    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { FollowerResponse } from './types';\r\n\r\n/**\r\n * Returns the follower information for the specified follower slug.\r\n * @param followerSlug The slug of the follower.\r\n * @returns The follower resource. See {@link FollowerResponse}.\r\n */\r\nexport function follower(followerSlug: string): Resource<FollowerResponse> {\r\n  return {\r\n    path: `${base}/follower/${followerSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { gameDataBase } from '../base';\r\nimport type {\r\n  EraIndexResponse,\r\n  EraLeaderboardResponse,\r\n  EraResponse,\r\n  SeasonIndexResponse,\r\n  SeasonLeaderboardResponse,\r\n  SeasonResponse,\r\n} from './types';\r\n\r\n/**\r\n * Returns the era information for the specified era ID.\r\n * @param id The ID of the era.\r\n * @returns The era resource. See {@link EraResponse}.\r\n */\r\nexport function era(id: number): Resource<EraResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era index.\r\n * @returns The era index resource. See {@link EraIndexResponse}.\r\n */\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era leaderboard for the specified era ID and leaderboard.\r\n * @param id The ID of the era.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.\r\n */\r\nexport function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season information for the specified season ID.\r\n * @param id The ID of the season.\r\n * @returns The season resource. See {@link SeasonResponse}.\r\n */\r\nexport function season(id: number): Resource<SeasonResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season index.\r\n * @returns The season index resource. See {@link SeasonIndexResponse}.\r\n */\r\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season leaderboard for the specified season ID and leaderboard.\r\n * @param id The ID of the season.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.\r\n */\r\nexport function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\n/**\r\n * Returns the item type information for the specified item type slug.\r\n * @param itemTypeSlug The slug of the item type, example: \"sword2h\"\r\n * @returns The item type resource. See {@link ItemTypeResponse}.\r\n */\r\nexport function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>> {\r\n  return {\r\n    path: `${base}/item-type/${itemTypeSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the item type index.\r\n * @returns The item type index resource. See {@link ItemTypeIndexResponse}.\r\n */\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\r\n\r\n/**\r\n * Returns the item information for the specified item slug and ID.\r\n * @param itemSlugAndId The slug and ID of the item, example: \"corrupted-ashbringer-Unique_Sword_2H_104_x1\".\r\n * @returns The item resource. See {@link ItemResponse}.\r\n */\r\nexport function item(itemSlugAndId: string): Resource<ItemResponse> {\r\n  return {\r\n    path: `${base}/item/${itemSlugAndId}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\r\n\r\n/**\r\n * Returns the account information for the specified battle tag.\r\n * @param battleTag The battle tag of the account.\r\n * @returns The account resource. See {@link AccountResponse}.\r\n */\r\nexport function account(battleTag: string): Resource<AccountResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the hero information for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the follower items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.\r\n */\r\nexport function accountHeroFollowerItems(\r\n  battleTag: string,\r\n  heroId: number,\r\n): Resource<AccountHeroFollowerItemsResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero items resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/items`,\r\n  };\r\n}\r\n","import { act, actIndex } from './act/act';\r\nimport { artisan, recipe } from './artisan-and-recipe/artisan-and-recipe';\r\nimport { characterClass, skill } from './character-class-and-skill/character-class-and-skill';\r\nimport { follower } from './follower/follower';\r\nimport { era, eraIndex, eraLeaderboard, season, seasonIndex, seasonLeaderboard } from './game-data/game-data';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { item } from './item/item';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nconst d3 = {\r\n  //Act\r\n  act,\r\n  actIndex,\r\n  //Artisan and Recipe\r\n  artisan,\r\n  recipe,\r\n  //Follower\r\n  follower,\r\n  //Character Class and Skill\r\n  characterClass,\r\n  skill,\r\n  //Item Type\r\n  itemType,\r\n  itemTypeIndex,\r\n  //Item\r\n  item,\r\n  //Profile\r\n  account,\r\n  accountHero,\r\n  accountHeroFollowerItems,\r\n  accountHeroItems,\r\n  //Game Data\r\n  era,\r\n  eraIndex,\r\n  eraLeaderboard,\r\n  season,\r\n  seasonIndex,\r\n  seasonLeaderboard,\r\n};\r\nexport default d3;\r\nexport { d3 };\r\n\r\n//Act\r\nexport * from './act/act';\r\nexport type * from './act/types';\r\n//Artisan and Recipe\r\nexport * from './artisan-and-recipe/artisan-and-recipe';\r\nexport type * from './artisan-and-recipe/types';\r\n//Character Class and Skill\r\nexport * from './character-class-and-skill/character-class-and-skill';\r\nexport type * from './character-class-and-skill/types';\r\n//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"]}
+{"version":3,"file":"index.js","names":["actId: number","artisanSlug: string","recipeSlug: string","characterClassSlug: string","skillSlug: string","followerSlug: string","id: number","leaderboard: string","itemTypeSlug: string","itemSlugAndId: string","battleTag: string","heroId: number"],"sources":["../src/base.ts","../src/act/act.ts","../src/artisan-and-recipe/artisan-and-recipe.ts","../src/character-class-and-skill/character-class-and-skill.ts","../src/follower/follower.ts","../src/game-data/game-data.ts","../src/item-type/item-type.ts","../src/item/item.ts","../src/profile/profile.ts","../src/index.ts"],"sourcesContent":["export const base = 'd3/data';\r\n\r\nexport const profileBase = `d3/profile`;\r\n\r\n//Why is the game data APIs base root the reverse of the regular base?\r\nexport const gameDataBase = `data/d3`;\r\n\r\n/**\r\n * Base interface for Blizzard API responses.\r\n */\r\nexport interface ResponseBase {\r\n  _links: {\r\n    self: {\r\n      href: string;\r\n    };\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ActIndexResponse, ActResponse } from './types';\r\n\r\n/**\r\n * Returns the act information for the specified act ID.\r\n * @param actId The ID of the act.\r\n * @returns The act resource. See {@link ActResponse}.\r\n */\r\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the index of acts.\r\n * @returns The act index resource. See {@link ActIndexResponse}.\r\n */\r\nexport function actIndex(): Resource<ActIndexResponse> {\r\n  return {\r\n    path: `${base}/act`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ArtisanResponse, RecipeResponse } from './types';\r\n\r\n/**\r\n * Returns the artisan information for the specified artisan slug.\r\n * @param artisanSlug The slug of the artisan.\r\n * @returns The artisan resource. See {@link ArtisanResponse}.\r\n */\r\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the recipe information for the specified artisan and recipe slugs.\r\n * @param artisanSlug The slug of the artisan.\r\n * @param recipeSlug The slug of the recipe.\r\n * @returns The recipe resource. See {@link RecipeResponse}.\r\n */\r\nexport function recipe(artisanSlug: string, recipeSlug: string): Resource<RecipeResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { CharacterClassResponse, SkillResponse } from './types';\r\n\r\n/**\r\n * Returns the character class information for the specified character class slug.\r\n * @param characterClassSlug The slug of the character class.\r\n * @returns The character class resource. See {@link CharacterClassResponse}.\r\n */\r\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the skill information for the specified character class and skill slugs.\r\n * @param characterClassSlug The slug of the character class.\r\n * @param skillSlug The slug of the skill.\r\n * @returns The skill resource. See {@link SkillResponse}.\r\n */\r\nexport function skill(characterClassSlug: string, skillSlug: string): Resource<SkillResponse> {\r\n  return {\r\n    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { FollowerResponse } from './types';\r\n\r\n/**\r\n * Returns the follower information for the specified follower slug.\r\n * @param followerSlug The slug of the follower.\r\n * @returns The follower resource. See {@link FollowerResponse}.\r\n */\r\nexport function follower(followerSlug: string): Resource<FollowerResponse> {\r\n  return {\r\n    path: `${base}/follower/${followerSlug}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { gameDataBase } from '../base';\r\nimport type {\r\n  EraIndexResponse,\r\n  EraLeaderboardResponse,\r\n  EraResponse,\r\n  SeasonIndexResponse,\r\n  SeasonLeaderboardResponse,\r\n  SeasonResponse,\r\n} from './types';\r\n\r\n/**\r\n * Returns the era information for the specified era ID.\r\n * @param id The ID of the era.\r\n * @returns The era resource. See {@link EraResponse}.\r\n */\r\nexport function era(id: number): Resource<EraResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era index.\r\n * @returns The era index resource. See {@link EraIndexResponse}.\r\n */\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the era leaderboard for the specified era ID and leaderboard.\r\n * @param id The ID of the era.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The era leaderboard resource. See {@link EraLeaderboardResponse}.\r\n */\r\nexport function eraLeaderboard(id: number, leaderboard: string): Resource<EraLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season information for the specified season ID.\r\n * @param id The ID of the season.\r\n * @returns The season resource. See {@link SeasonResponse}.\r\n */\r\nexport function season(id: number): Resource<SeasonResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season index.\r\n * @returns The season index resource. See {@link SeasonIndexResponse}.\r\n */\r\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the season leaderboard for the specified season ID and leaderboard.\r\n * @param id The ID of the season.\r\n * @param leaderboard The name of the leaderboard.\r\n * @returns The season leaderboard resource. See {@link SeasonLeaderboardResponse}.\r\n */\r\nexport function seasonLeaderboard(id: number, leaderboard: string): Resource<SeasonLeaderboardResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\n/**\r\n * Returns the item type information for the specified item type slug.\r\n * @param itemTypeSlug The slug of the item type, example: \"sword2h\"\r\n * @returns The item type resource. See {@link ItemTypeResponse}.\r\n */\r\nexport function itemType(itemTypeSlug: string): Resource<Array<ItemTypeResponse>> {\r\n  return {\r\n    path: `${base}/item-type/${itemTypeSlug}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the item type index.\r\n * @returns The item type index resource. See {@link ItemTypeIndexResponse}.\r\n */\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\r\n\r\n/**\r\n * Returns the item information for the specified item slug and ID.\r\n * @param itemSlugAndId The slug and ID of the item, example: \"corrupted-ashbringer-Unique_Sword_2H_104_x1\".\r\n * @returns The item resource. See {@link ItemResponse}.\r\n */\r\nexport function item(itemSlugAndId: string): Resource<ItemResponse> {\r\n  return {\r\n    path: `${base}/item/${itemSlugAndId}`,\r\n  };\r\n}\r\n","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\r\n\r\n/**\r\n * Returns the account information for the specified battle tag.\r\n * @param battleTag The battle tag of the account.\r\n * @returns The account resource. See {@link AccountResponse}.\r\n */\r\nexport function account(battleTag: string): Resource<AccountResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the hero information for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHero(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the follower items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The follower items resource. See {@link AccountHeroFollowerItemsResponse}.\r\n */\r\nexport function accountHeroFollowerItems(\r\n  battleTag: string,\r\n  heroId: number,\r\n): Resource<AccountHeroFollowerItemsResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-items`,\r\n  };\r\n}\r\n\r\n/**\r\n * Returns the items for the specified battle tag and hero ID.\r\n * @param battleTag The battle tag of the account.\r\n * @param heroId The ID of the hero.\r\n * @returns The hero items resource. See {@link AccountHeroResponse}.\r\n */\r\nexport function accountHeroItems(battleTag: string, heroId: number): Resource<AccountHeroResponse> {\r\n  return {\r\n    path: `${profileBase}/${battleTag}/hero/${heroId}/items`,\r\n  };\r\n}\r\n","import { act, actIndex } from './act/act';\r\nimport { artisan, recipe } from './artisan-and-recipe/artisan-and-recipe';\r\nimport { characterClass, skill } from './character-class-and-skill/character-class-and-skill';\r\nimport { follower } from './follower/follower';\r\nimport { era, eraIndex, eraLeaderboard, season, seasonIndex, seasonLeaderboard } from './game-data/game-data';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { item } from './item/item';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nconst d3 = {\r\n  //Act\r\n  act,\r\n  actIndex,\r\n  //Artisan and Recipe\r\n  artisan,\r\n  recipe,\r\n  //Follower\r\n  follower,\r\n  //Character Class and Skill\r\n  characterClass,\r\n  skill,\r\n  //Item Type\r\n  itemType,\r\n  itemTypeIndex,\r\n  //Item\r\n  item,\r\n  //Profile\r\n  account,\r\n  accountHero,\r\n  accountHeroFollowerItems,\r\n  accountHeroItems,\r\n  //Game Data\r\n  era,\r\n  eraIndex,\r\n  eraLeaderboard,\r\n  season,\r\n  seasonIndex,\r\n  seasonLeaderboard,\r\n};\r\nexport default d3;\r\nexport { d3 };\r\n\r\n//Act\r\nexport * from './act/act';\r\nexport type * from './act/types';\r\n//Artisan and Recipe\r\nexport * from './artisan-and-recipe/artisan-and-recipe';\r\nexport type * from './artisan-and-recipe/types';\r\n//Character Class and Skill\r\nexport * from './character-class-and-skill/character-class-and-skill';\r\nexport type * from './character-class-and-skill/types';\r\n//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n"],"mappings":";AAAA,MAAa,OAAO;AAEpB,MAAa,eAAe;AAG5B,MAAa,gBAAgB;;;;;;;;;;;;;ACI7B,SAAgB,IAAIA,OAAsC;AACxD,QAAO,EACL,OAAO,EAAE,KAAK,OAAO,MAAM,EAC5B;AACF;;;;;;;;AAMD,SAAgB,WAAuC;AACrD,QAAO,EACL,OAAO,EAAE,KAAK,MACf;AACF;;;;;;;;;;;;;ACdD,SAAgB,QAAQC,aAAgD;AACtE,QAAO,EACL,OAAO,EAAE,KAAK,WAAW,YAAY,EACtC;AACF;;;;;;;;;;;;AAQD,SAAgB,OAAOA,aAAqBC,YAA8C;AACxF,QAAO,EACL,OAAO,EAAE,KAAK,WAAW,YAAY,UAAU,WAAW,EAC3D;AACF;;;;;;;;;;;;;AChBD,SAAgB,eAAeC,oBAA8D;AAC3F,QAAO,EACL,OAAO,EAAE,KAAK,mBAAmB,mBAAmB,EACrD;AACF;;;;;;;;;;;;AAQD,SAAgB,MAAMA,oBAA4BC,WAA4C;AAC5F,QAAO,EACL,OAAO,EAAE,KAAK,QAAQ,mBAAmB,SAAS,UAAU,EAC7D;AACF;;;;;;;;;;;;;AChBD,SAAgB,SAASC,cAAkD;AACzE,QAAO,EACL,OAAO,EAAE,KAAK,YAAY,aAAa,EACxC;AACF;;;;;;;;;;;;;ACGD,SAAgB,IAAIC,IAAmC;AACrD,QAAO,EACL,OAAO,EAAE,aAAa,OAAO,GAAG,EACjC;AACF;;;;;;;;AAMD,SAAgB,WAAuC;AACrD,QAAO,EACL,OAAO,EAAE,aAAa,MACvB;AACF;;;;;;;;;;;;AAQD,SAAgB,eAAeA,IAAYC,aAAuD;AAChG,QAAO,EACL,OAAO,EAAE,aAAa,OAAO,GAAG,eAAe,YAAY,EAC5D;AACF;;;;;;;;;;AAOD,SAAgB,OAAOD,IAAsC;AAC3D,QAAO,EACL,OAAO,EAAE,aAAa,UAAU,GAAG,EACpC;AACF;;;;;;;;AAMD,SAAgB,cAA6C;AAC3D,QAAO,EACL,OAAO,EAAE,aAAa,SACvB;AACF;;;;;;;;;;;;AAQD,SAAgB,kBAAkBA,IAAYC,aAA0D;AACtG,QAAO,EACL,OAAO,EAAE,aAAa,UAAU,GAAG,eAAe,YAAY,EAC/D;AACF;;;;;;;;;;;;;AClED,SAAgB,SAASC,cAAyD;AAChF,QAAO,EACL,OAAO,EAAE,KAAK,aAAa,aAAa,EACzC;AACF;;;;;;;;AAMD,SAAgB,gBAAwD;AACtE,QAAO,EACL,OAAO,EAAE,KAAK,YACf;AACF;;;;;;;;;;;;;ACdD,SAAgB,KAAKC,eAA+C;AAClE,QAAO,EACL,OAAO,EAAE,KAAK,QAAQ,cAAc,EACrC;AACF;;;;;;;;;;;;;ACJD,SAAgB,QAAQC,WAA8C;AACpE,QAAO,EACL,OAAO,EAAE,YAAY,GAAG,UAAU,EACnC;AACF;;;;;;;;;;;;AAQD,SAAgB,YAAYA,WAAmBC,QAA+C;AAC5F,QAAO,EACL,OAAO,EAAE,YAAY,GAAG,UAAU,QAAQ,OAAO,EAClD;AACF;;;;;;;;;;;;AAQD,SAAgB,yBACdD,WACAC,QAC4C;AAC5C,QAAO,EACL,OAAO,EAAE,YAAY,GAAG,UAAU,QAAQ,OAAO,iBAClD;AACF;;;;;;;;;;;;AAQD,SAAgB,iBAAiBD,WAAmBC,QAA+C;AACjG,QAAO,EACL,OAAO,EAAE,YAAY,GAAG,UAAU,QAAQ,OAAO,QAClD;AACF;;;;AC3CD,MAAM,KAAK;CAET;CACA;CAEA;CACA;CAEA;CAEA;CACA;CAEA;CACA;CAEA;CAEA;CACA;CACA;CACA;CAEA;CACA;CACA;CACA;CACA;CACA;AACD;AACD,kBAAe"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/d3",
-  "version": "1.0.4",
+  "version": "1.0.5",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Diablo 3 Blizzard API",
@@ -34,14 +34,14 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@blizzard-api/core": "2.1.0"
+    "@blizzard-api/core": "2.1.1"
   },
   "devDependencies": {
-    "@blizzard-api/core": "2.1.0"
+    "@blizzard-api/core": "2.1.1"
   },
   "scripts": {
-    "build": "tsup",
-    "dev": "tsup --watch",
+    "build": "tsdown",
+    "dev": "tsdown --watch",
     "test": "vitest run",
     "test:coverage": "pnpm test -- --coverage",
     "test:watch": "vitest watch"