@blizzard-api/d3 0.1.0

package/README.md

@@ -0,0 +1,71 @@
+# @blizzard-api/d3
+
+This package aims to make it easier for you to integrate with the Blizzard Battle.net API, specifically for Diablo 3.
+
+## Installation
+
+```sh
+npm i @blizzard-api/core @blizzard-api/d3
+```
+
+## Usage
+
+You can get paths, namespaces, parameters and more for a specific endpoint by calling it from the `d3` export.
+
+```ts
+import { d3 } from "@blizzard-api/d3"
+
+const achievement = d3.achievement(123);
+        ^ { path: string, namespace: string }
+```
+
+If you need the response types, they are also exported with "Response" appended, so to get the response type from the above code, you can import it like this:
+
+```ts
+import type { AchievementResponse } from '@blizzard-api/d3';
+```
+
+If you simply want to use the existing object, you can use the helper from `@blizzard-api/core` like so:
+
+```ts
+import { d3 } from "@blizzard-api/d3"
+
+const achievement = d3.achievement(123);
+        ^ { path: string, namespace: string }
+type AchievementResponse = ExtractResourceType<typeof achievement>;
+```
+
+If you don't want to use the exported d3 object, you can also access the functions directly:
+
+```ts
+import { achievement } from "@blizzard-api/d3"
+
+const achi = achievement(123);
+        ^ { path: string, namespace: string }
+type AchievementResponse = ExtractResourceType<typeof achi>;
+```
+
+## Types
+
+The types are manually created from using the Blizzard API documentation, and are as accurate as possible with smoke testing each endpoint. However, no-one is perfect so there is likely be some discrepancies. If you encounter any issues with the types from this package, please open an issue or a pull request.
+
+### Client
+
+While this package is made to function on it's own, it performs even better when combined with `@blizzard-api/client` where you can easily request data combining the two libraries.
+
+```ts
+import { createBlizzardApiClient } from '@blizzard-api/client';
+import { d3 } from '@blizzard-api/d3';
+
+const client = await createBlizzardApiClient({
+  key: 'environment.blizzardClientId',
+  secret: 'environment.blizzardClientSecret',
+  origin: 'eu',
+});
+
+//Response will automatically be typed with the appropriate values
+const response = await client.sendRequest(d3.commodities());
+
+console.log(response.data);
+                      ^ typeof AuctionHouseCommoditiesResponse
+```

package/dist/index.cjs

@@ -0,0 +1,223 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  account: () => account,
+  accountHero: () => accountHero,
+  accountHeroFollowerItems: () => accountHeroFollowerItems,
+  accountHeroItems: () => accountHeroItems,
+  act: () => act,
+  actIndex: () => actIndex,
+  artisan: () => artisan,
+  characterClass: () => characterClass,
+  d3: () => d3,
+  era: () => era,
+  eraIndex: () => eraIndex,
+  eraLeaderboard: () => eraLeaderboard,
+  follower: () => follower,
+  item: () => item,
+  itemType: () => itemType,
+  itemTypeIndex: () => itemTypeIndex,
+  recipe: () => recipe,
+  season: () => season,
+  seasonIndex: () => seasonIndex,
+  seasonLeaderboard: () => seasonLeaderboard,
+  skill: () => skill
+});
+module.exports = __toCommonJS(src_exports);
+
+// src/base.ts
+var base = "d3/data";
+var profileBase = `d3/profile`;
+var gameDataBase = `data/d3`;
+
+// src/act/act.ts
+function act(actId) {
+  return {
+    path: `${base}/act/${actId}`
+  };
+}
+function actIndex() {
+  return {
+    path: `${base}/act`
+  };
+}
+
+// src/artisan-and-recipe/artisan-and-recipe.ts
+function artisan(artisanSlug) {
+  return {
+    path: `${base}/artisan/${artisanSlug}`
+  };
+}
+function recipe(artisanSlug, recipeSlug) {
+  return {
+    path: `${base}/artisan/${artisanSlug}/recipe/${recipeSlug}`
+  };
+}
+
+// src/character-class-and-skill/character-class-and-skill.ts
+function characterClass(characterClassSlug) {
+  return {
+    path: `${base}/character-class/${characterClassSlug}`
+  };
+}
+function skill(characterClassSlug, skillSlug) {
+  return {
+    path: `${base}/hero/${characterClassSlug}/skill/${skillSlug}`
+  };
+}
+
+// src/follower/follower.ts
+function follower(followerSlug) {
+  return {
+    path: `${base}/follower/${followerSlug}`
+  };
+}
+
+// src/game-data/game-data.ts
+function seasonIndex() {
+  return {
+    path: `${gameDataBase}/season`
+  };
+}
+function season(id) {
+  return {
+    path: `${gameDataBase}/season/${id}`
+  };
+}
+function seasonLeaderboard(id, leaderboard) {
+  return {
+    path: `${gameDataBase}/season/${id}/leaderboard/${leaderboard}`
+  };
+}
+function eraIndex() {
+  return {
+    path: `${gameDataBase}/era`
+  };
+}
+function era(id) {
+  return {
+    path: `${gameDataBase}/era/${id}`
+  };
+}
+function eraLeaderboard(id, leaderboard) {
+  return {
+    path: `${gameDataBase}/era/${id}/leaderboard/${leaderboard}`
+  };
+}
+
+// src/item/item.ts
+function item(itemSlugAndId) {
+  return {
+    path: `${base}/item/${itemSlugAndId}`
+  };
+}
+
+// src/item-type/item-type.ts
+function itemTypeIndex() {
+  return {
+    path: `${base}/item-type`
+  };
+}
+function itemType(itemTypeSlug) {
+  return {
+    path: `${base}/item-type/${itemTypeSlug}`
+  };
+}
+
+// src/profile/profile.ts
+function account(battleTag) {
+  return {
+    path: `${profileBase}/${battleTag}`
+  };
+}
+function accountHero(battleTag, heroId) {
+  return {
+    path: `${profileBase}/${battleTag}/hero/${heroId}`
+  };
+}
+function accountHeroItems(battleTag, heroId) {
+  return {
+    path: `${profileBase}/${battleTag}/hero/${heroId}/items`
+  };
+}
+function accountHeroFollowerItems(battleTag, heroId) {
+  return {
+    path: `${profileBase}/${battleTag}/hero/${heroId}/follower-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,
+  accountHeroItems,
+  accountHeroFollowerItems,
+  //Game Data
+  seasonIndex,
+  season,
+  seasonLeaderboard,
+  eraIndex,
+  era,
+  eraLeaderboard
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  account,
+  accountHero,
+  accountHeroFollowerItems,
+  accountHeroItems,
+  act,
+  actIndex,
+  artisan,
+  characterClass,
+  d3,
+  era,
+  eraIndex,
+  eraLeaderboard,
+  follower,
+  item,
+  itemType,
+  itemTypeIndex,
+  recipe,
+  season,
+  seasonIndex,
+  seasonLeaderboard,
+  skill
+});
+//# sourceMappingURL=index.cjs.map

package/dist/index.cjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../src/index.ts","../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/item.ts","../src/item-type/item-type.ts","../src/profile/profile.ts"],"sourcesContent":["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 { item } from './item/item';\r\nimport { itemType, itemTypeIndex } from './item-type/item-type';\r\nimport { account, accountHero, accountHeroFollowerItems, accountHeroItems } from './profile/profile';\r\n\r\nexport const 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  accountHeroItems,\r\n  accountHeroFollowerItems,\r\n  //Game Data\r\n  seasonIndex,\r\n  season,\r\n  seasonLeaderboard,\r\n  eraIndex,\r\n  era,\r\n  eraLeaderboard,\r\n};\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//Follower\r\nexport * from './follower/follower';\r\nexport type * from './follower/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//Item Type\r\nexport * from './item-type/item-type';\r\nexport type * from './item-type/types';\r\n//Item\r\nexport * from './item/item';\r\nexport type * from './item/types';\r\n//Profile\r\nexport * from './profile/profile';\r\nexport type * from './profile/types';\r\n//Game Data\r\nexport * from './game-data/game-data';\r\nexport type * from './game-data/types';\r\n","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\nexport function act(actId: number): Resource<ActResponse> {\r\n  return {\r\n    path: `${base}/act/${actId}`,\r\n  };\r\n}\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\nexport function artisan(artisanSlug: string): Resource<ArtisanResponse> {\r\n  return {\r\n    path: `${base}/artisan/${artisanSlug}`,\r\n  };\r\n}\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\nexport function characterClass(characterClassSlug: string): Resource<CharacterClassResponse> {\r\n  return {\r\n    path: `${base}/character-class/${characterClassSlug}`,\r\n  };\r\n}\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\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\nexport function seasonIndex(): Resource<SeasonIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/season`,\r\n  };\r\n}\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\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\r\nexport function eraIndex(): Resource<EraIndexResponse> {\r\n  return {\r\n    path: `${gameDataBase}/era`,\r\n  };\r\n}\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\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","import type { Resource } from '@blizzard-api/core';\r\nimport { base } from '../base';\r\nimport type { ItemResponse } from './types';\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 { base } from '../base';\r\nimport type { ItemTypeIndexResponse, ItemTypeResponse } from './types';\r\n\r\nexport function itemTypeIndex(): Resource<Array<ItemTypeIndexResponse>> {\r\n  return {\r\n    path: `${base}/item-type`,\r\n  };\r\n}\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","import type { Resource } from '@blizzard-api/core';\r\nimport { profileBase } from '../base';\r\nimport type { AccountHeroFollowerItemsResponse, AccountHeroResponse, AccountResponse } from './types';\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\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\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\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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAO,IAAM,OAAO;AAEb,IAAM,cAAc;AAGpB,IAAM,eAAe;;;ACDrB,SAAS,IAAI,OAAsC;AACxD,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,QAAQ,KAAK;AAAA,EAC5B;AACF;AAEO,SAAS,WAAuC;AACrD,SAAO;AAAA,IACL,MAAM,GAAG,IAAI;AAAA,EACf;AACF;;;ACVO,SAAS,QAAQ,aAAgD;AACtE,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,YAAY,WAAW;AAAA,EACtC;AACF;AAEO,SAAS,OAAO,aAAqB,YAA8C;AACxF,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,YAAY,WAAW,WAAW,UAAU;AAAA,EAC3D;AACF;;;ACVO,SAAS,eAAe,oBAA8D;AAC3F,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,oBAAoB,kBAAkB;AAAA,EACrD;AACF;AAEO,SAAS,MAAM,oBAA4B,WAA4C;AAC5F,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,SAAS,kBAAkB,UAAU,SAAS;AAAA,EAC7D;AACF;;;ACVO,SAAS,SAAS,cAAkD;AACzE,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,aAAa,YAAY;AAAA,EACxC;AACF;;;ACGO,SAAS,cAA6C;AAC3D,SAAO;AAAA,IACL,MAAM,GAAG,YAAY;AAAA,EACvB;AACF;AAEO,SAAS,OAAO,IAAsC;AAC3D,SAAO;AAAA,IACL,MAAM,GAAG,YAAY,WAAW,EAAE;AAAA,EACpC;AACF;AAEO,SAAS,kBAAkB,IAAY,aAA0D;AACtG,SAAO;AAAA,IACL,MAAM,GAAG,YAAY,WAAW,EAAE,gBAAgB,WAAW;AAAA,EAC/D;AACF;AAEO,SAAS,WAAuC;AACrD,SAAO;AAAA,IACL,MAAM,GAAG,YAAY;AAAA,EACvB;AACF;AAEO,SAAS,IAAI,IAAmC;AACrD,SAAO;AAAA,IACL,MAAM,GAAG,YAAY,QAAQ,EAAE;AAAA,EACjC;AACF;AAEO,SAAS,eAAe,IAAY,aAAuD;AAChG,SAAO;AAAA,IACL,MAAM,GAAG,YAAY,QAAQ,EAAE,gBAAgB,WAAW;AAAA,EAC5D;AACF;;;ACzCO,SAAS,KAAK,eAA+C;AAClE,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,SAAS,aAAa;AAAA,EACrC;AACF;;;ACJO,SAAS,gBAAwD;AACtE,SAAO;AAAA,IACL,MAAM,GAAG,IAAI;AAAA,EACf;AACF;AAEO,SAAS,SAAS,cAAyD;AAChF,SAAO;AAAA,IACL,MAAM,GAAG,IAAI,cAAc,YAAY;AAAA,EACzC;AACF;;;ACVO,SAAS,QAAQ,WAA8C;AACpE,SAAO;AAAA,IACL,MAAM,GAAG,WAAW,IAAI,SAAS;AAAA,EACnC;AACF;AAEO,SAAS,YAAY,WAAmB,QAA+C;AAC5F,SAAO;AAAA,IACL,MAAM,GAAG,WAAW,IAAI,SAAS,SAAS,MAAM;AAAA,EAClD;AACF;AAEO,SAAS,iBAAiB,WAAmB,QAA+C;AACjG,SAAO;AAAA,IACL,MAAM,GAAG,WAAW,IAAI,SAAS,SAAS,MAAM;AAAA,EAClD;AACF;AAEO,SAAS,yBACd,WACA,QAC4C;AAC5C,SAAO;AAAA,IACL,MAAM,GAAG,WAAW,IAAI,SAAS,SAAS,MAAM;AAAA,EAClD;AACF;;;ATpBO,IAAM,KAAK;AAAA;AAAA,EAEhB;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA;AAAA,EAEA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF;","names":[]}