@blizzard-api/classic-wow 1.1.1 → 1.1.3

package/README.md

@@ -14,34 +14,39 @@ You can get paths, namespaces, parameters and more for a specific endpoint by ca
 
 ```ts
 import { classicWow } from "@blizzard-api/classic-wow"
+//or
+import classicWow from "@blizzard-api/classic-wow"
 
 const powerType = classicWow.powerType("static-classic", 123);
-        ^ { path: string, namespace: string }
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
 ```
 
+If you don't want to use the exported classicWow object, you can also access the functions directly:
+
+```ts
+import { powerType } from "@blizzard-api/classic-wow"
+
+const powerTypeEndpoint = powerType("static-classic", 123);
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
+```
+
+### Types
+
 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 { PowerTypeResponse } from '@blizzard-api/classic-wow';
 ```
 
-If you simply want to use the existing object, you can use the helper from `@blizzard-api/core` like so:
+If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
 
 ```ts
 import { classicWow } from "@blizzard-api/classic-wow"
+import type { ExtractResourceType } from "@blizzard-api/core";
 
 const powerType = classicWow.powerType("static-classic", 123);
-        ^ { path: string, namespace: string }
-type PowerTypeResponse = ExtractResourceType<typeof powerType>;
-```
-
-If you don't want to use the exported classicWow object, you can also access the functions directly:
-
-```ts
-import { powerType } from "@blizzard-api/wow"
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
 
-const powerType = powerType("static-classic", 123);
-        ^ { path: string, namespace: string }
 type PowerTypeResponse = ExtractResourceType<typeof powerType>;
 ```
 
@@ -56,11 +61,11 @@ Because there are multiple classic flavours of the game, each endpoint will take
 | World of Warcraft Classic (Era)              | static-classic1x-{region} | dynamic-classic1x-{region} | profile-classic1x-{region} |
 | Wrath of the Lich King Classic (Progression) | static-classic-{region}   | dynamic-classic-{region}   | profile-classic-{region}   |
 
-## Types
+## Notes on 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
+## 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.
 

package/dist/index.cjs

@@ -1,71 +1,6 @@
-"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);
+'use strict';
 
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  auctionHouseIndex: () => auctionHouseIndex,
-  auctions: () => auctions,
-  classicWow: () => classicWow,
-  connectedRealm: () => connectedRealm,
-  connectedRealmIndex: () => connectedRealmIndex,
-  connectedRealmSearch: () => connectedRealmSearch,
-  creature: () => creature,
-  creatureDisplayMedia: () => creatureDisplayMedia,
-  creatureFamily: () => creatureFamily,
-  creatureFamilyIndex: () => creatureFamilyIndex,
-  creatureFamilyMedia: () => creatureFamilyMedia,
-  creatureSearch: () => creatureSearch,
-  creatureType: () => creatureType,
-  creatureTypeIndex: () => creatureTypeIndex,
-  guildCrestBorder: () => guildCrestBorder,
-  guildCrestComponentsIndex: () => guildCrestComponentsIndex,
-  guildCrestEmblem: () => guildCrestEmblem,
-  item: () => item,
-  itemClass: () => itemClass,
-  itemClassIndex: () => itemClassIndex,
-  itemMedia: () => itemMedia,
-  itemSearch: () => itemSearch,
-  itemSubClass: () => itemSubClass,
-  mediaSearch: () => mediaSearch,
-  playableClass: () => playableClass,
-  playableClassIndex: () => playableClassIndex,
-  playableClassMedia: () => playableClassMedia,
-  playableRace: () => playableRace,
-  playableRaceIndex: () => playableRaceIndex,
-  powerType: () => powerType,
-  powerTypeIndex: () => powerTypeIndex,
-  pvpLeaderboard: () => pvpLeaderboard,
-  pvpLeaderboardIndex: () => pvpLeaderboardIndex,
-  pvpRegionIndex: () => pvpRegionIndex,
-  pvpRegionalSeason: () => pvpRegionalSeason,
-  pvpRegionalSeasonIndex: () => pvpRegionalSeasonIndex,
-  pvpRewardsIndex: () => pvpRewardsIndex,
-  pvpSeason: () => pvpSeason,
-  pvpSeasonIndex: () => pvpSeasonIndex,
-  realm: () => realm,
-  realmIndex: () => realmIndex,
-  realmSearch: () => realmSearch,
-  region: () => region,
-  regionIndex: () => regionIndex
-});
-module.exports = __toCommonJS(src_exports);
+Object.defineProperty(exports, '__esModule', { value: true });
 
 // ../wow/src/base.ts
 var base = "/data/wow";
@@ -75,28 +10,28 @@ var searchBase = `${base}/search`;
 // src/auction-house/auction-house.ts
 function auctionHouseIndex(namespace, connectedRealmId) {
   return {
-    path: `${base}/connected-realm/${connectedRealmId}/auctions/index`,
-    namespace
+    namespace,
+    path: `${base}/connected-realm/${connectedRealmId}/auctions/index`
   };
 }
 function auctions(namespace, connectedRealmId, auctionHouseId) {
   return {
-    path: `${base}/connected-realm/${connectedRealmId}/auctions/${auctionHouseId}`,
-    namespace
+    namespace,
+    path: `${base}/connected-realm/${connectedRealmId}/auctions/${auctionHouseId}`
   };
 }
 
 // src/connected-realm/connected-realm.ts
 function connectedRealmIndex(namespace) {
   return {
-    path: `${base}/connected-realm/index`,
-    namespace
+    namespace,
+    path: `${base}/connected-realm/index`
   };
 }
 function connectedRealm(namespace, connectedRealmId) {
   return {
-    path: `${base}/connected-realm/${connectedRealmId}`,
-    namespace
+    namespace,
+    path: `${base}/connected-realm/${connectedRealmId}`
   };
 }
 function connectedRealmSearch(namespace, options) {
@@ -105,8 +40,8 @@ function connectedRealmSearch(namespace, options) {
     parameters: {
       _page: options._page,
       orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
-      "status.type": options["status.type"],
-      "realms.timezone": options["realms.timezone"]
+      "realms.timezone": options["realms.timezone"],
+      "status.type": options["status.type"]
     },
     path: `${base}/search/connected-realm`
   };
@@ -115,44 +50,44 @@ function connectedRealmSearch(namespace, options) {
 // src/creature/creature.ts
 function creature(namespace, creatureId) {
   return {
-    path: `${base}/creature/${creatureId}`,
-    namespace
+    namespace,
+    path: `${base}/creature/${creatureId}`
   };
 }
 function creatureDisplayMedia(namespace, creatureDisplayId) {
   return {
-    path: `${mediaBase}/creature-display/${creatureDisplayId}`,
-    namespace
+    namespace,
+    path: `${mediaBase}/creature-display/${creatureDisplayId}`
   };
 }
 function creatureFamily(namespace, creatureFamilyId) {
   return {
-    path: `${base}/creature-family/${creatureFamilyId}`,
-    namespace
+    namespace,
+    path: `${base}/creature-family/${creatureFamilyId}`
   };
 }
 function creatureFamilyIndex(namespace) {
   return {
-    path: `${base}/creature-family/index`,
-    namespace
+    namespace,
+    path: `${base}/creature-family/index`
   };
 }
 function creatureFamilyMedia(namespace, creatureFamilyId) {
   return {
-    path: `${mediaBase}/creature-family/${creatureFamilyId}`,
-    namespace
+    namespace,
+    path: `${mediaBase}/creature-family/${creatureFamilyId}`
   };
 }
 function creatureType(namespace, creatureTypeId) {
   return {
-    path: `${base}/creature-type/${creatureTypeId}`,
-    namespace
+    namespace,
+    path: `${base}/creature-type/${creatureTypeId}`
   };
 }
 function creatureTypeIndex(namespace) {
   return {
-    path: `${base}/creature-type/index`,
-    namespace
+    namespace,
+    path: `${base}/creature-type/index`
   };
 }
 function creatureSearch(namespace, options) {
@@ -160,8 +95,8 @@ function creatureSearch(namespace, options) {
     namespace,
     parameters: {
       _page: options._page,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
-      [`name.${options.locale}`]: options.name
+      [`name.${options.locale}`]: options.name,
+      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
     },
     path: `${searchBase}/creature`
   };
@@ -170,28 +105,28 @@ function creatureSearch(namespace, options) {
 // src/guild-crest/guild-crest.ts
 function guildCrestComponentsIndex(namespace) {
   return {
-    path: `${base}/guild-crest/index`,
-    namespace
+    namespace,
+    path: `${base}/guild-crest/index`
   };
 }
 function guildCrestBorder(namespace, borderId) {
   return {
-    path: `${mediaBase}/guild-crest/border/${borderId}`,
-    namespace
+    namespace,
+    path: `${mediaBase}/guild-crest/border/${borderId}`
   };
 }
 function guildCrestEmblem(namespace, emblemId) {
   return {
-    path: `${mediaBase}/guild-crest/emblem/${emblemId}`,
-    namespace
+    namespace,
+    path: `${mediaBase}/guild-crest/emblem/${emblemId}`
   };
 }
 
 // src/item/item.ts
 function itemClassIndex(namespace) {
   return {
-    path: `${base}/item-class/index`,
-    namespace
+    namespace,
+    path: `${base}/item-class/index`
   };
 }
 function itemClass(namespace, itemClassId) {
@@ -223,8 +158,8 @@ function itemSearch(namespace, options) {
     namespace,
     parameters: {
       _page: options._page,
-      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby,
-      [`name.${options.locale}`]: options.name
+      [`name.${options.locale}`]: options.name,
+      orderby: Array.isArray(options.orderby) ? options.orderby.join(",") : options.orderby
     },
     path: `${searchBase}/item`
   };
@@ -344,14 +279,14 @@ function pvpRewardsIndex(namespace, pvpRegionId, pvpSeasonId) {
 // src/realm/realm.ts
 function realm(namespace, realmSlug) {
   return {
-    path: `${base}/realm/${realmSlug}`,
-    namespace
+    namespace,
+    path: `${base}/realm/${realmSlug}`
   };
 }
 function realmIndex(namespace) {
   return {
-    path: `${base}/realm/index`,
-    namespace
+    namespace,
+    path: `${base}/realm/index`
   };
 }
 function realmSearch(namespace, options) {
@@ -369,14 +304,14 @@ function realmSearch(namespace, options) {
 // src/region/region.ts
 function region(namespace, regionId) {
   return {
-    path: `${base}/region/${regionId}`,
-    namespace
+    namespace,
+    path: `${base}/region/${regionId}`
   };
 }
 function regionIndex(namespace) {
   return {
-    path: `${base}/region/index`,
-    namespace
+    namespace,
+    path: `${base}/region/index`
   };
 }
 
@@ -395,20 +330,20 @@ var classicWow = {
   creatureFamily,
   creatureFamilyIndex,
   creatureFamilyMedia,
+  creatureSearch,
   creatureType,
   creatureTypeIndex,
-  creatureSearch,
   //Guild Crest
-  guildCrestComponentsIndex,
   guildCrestBorder,
+  guildCrestComponentsIndex,
   guildCrestEmblem,
   //Item
-  itemClassIndex,
-  itemClass,
-  itemSubClass,
   item,
+  itemClass,
+  itemClassIndex,
   itemMedia,
   itemSearch,
+  itemSubClass,
   //Media Search
   mediaSearch,
   //Playable Class
@@ -422,67 +357,68 @@ var classicWow = {
   powerType,
   powerTypeIndex,
   //Pvp Season
-  pvpSeasonIndex,
-  pvpSeason,
-  pvpRegionIndex,
-  pvpRegionalSeasonIndex,
-  pvpRegionalSeason,
-  pvpLeaderboardIndex,
-  pvpLeaderboard,
-  pvpRewardsIndex,
-  //Realm
-  realm,
-  realmIndex,
-  realmSearch,
-  //Region
-  region,
-  regionIndex
-};
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  auctionHouseIndex,
-  auctions,
-  classicWow,
-  connectedRealm,
-  connectedRealmIndex,
-  connectedRealmSearch,
-  creature,
-  creatureDisplayMedia,
-  creatureFamily,
-  creatureFamilyIndex,
-  creatureFamilyMedia,
-  creatureSearch,
-  creatureType,
-  creatureTypeIndex,
-  guildCrestBorder,
-  guildCrestComponentsIndex,
-  guildCrestEmblem,
-  item,
-  itemClass,
-  itemClassIndex,
-  itemMedia,
-  itemSearch,
-  itemSubClass,
-  mediaSearch,
-  playableClass,
-  playableClassIndex,
-  playableClassMedia,
-  playableRace,
-  playableRaceIndex,
-  powerType,
-  powerTypeIndex,
   pvpLeaderboard,
   pvpLeaderboardIndex,
-  pvpRegionIndex,
   pvpRegionalSeason,
   pvpRegionalSeasonIndex,
+  pvpRegionIndex,
   pvpRewardsIndex,
   pvpSeason,
   pvpSeasonIndex,
+  //Realm
   realm,
   realmIndex,
   realmSearch,
+  //Region
   region,
   regionIndex
-});
+};
+var src_default = classicWow;
+
+exports.auctionHouseIndex = auctionHouseIndex;
+exports.auctions = auctions;
+exports.classicWow = classicWow;
+exports.connectedRealm = connectedRealm;
+exports.connectedRealmIndex = connectedRealmIndex;
+exports.connectedRealmSearch = connectedRealmSearch;
+exports.creature = creature;
+exports.creatureDisplayMedia = creatureDisplayMedia;
+exports.creatureFamily = creatureFamily;
+exports.creatureFamilyIndex = creatureFamilyIndex;
+exports.creatureFamilyMedia = creatureFamilyMedia;
+exports.creatureSearch = creatureSearch;
+exports.creatureType = creatureType;
+exports.creatureTypeIndex = creatureTypeIndex;
+exports.default = src_default;
+exports.guildCrestBorder = guildCrestBorder;
+exports.guildCrestComponentsIndex = guildCrestComponentsIndex;
+exports.guildCrestEmblem = guildCrestEmblem;
+exports.item = item;
+exports.itemClass = itemClass;
+exports.itemClassIndex = itemClassIndex;
+exports.itemMedia = itemMedia;
+exports.itemSearch = itemSearch;
+exports.itemSubClass = itemSubClass;
+exports.mediaSearch = mediaSearch;
+exports.playableClass = playableClass;
+exports.playableClassIndex = playableClassIndex;
+exports.playableClassMedia = playableClassMedia;
+exports.playableRace = playableRace;
+exports.playableRaceIndex = playableRaceIndex;
+exports.powerType = powerType;
+exports.powerTypeIndex = powerTypeIndex;
+exports.pvpLeaderboard = pvpLeaderboard;
+exports.pvpLeaderboardIndex = pvpLeaderboardIndex;
+exports.pvpRegionIndex = pvpRegionIndex;
+exports.pvpRegionalSeason = pvpRegionalSeason;
+exports.pvpRegionalSeasonIndex = pvpRegionalSeasonIndex;
+exports.pvpRewardsIndex = pvpRewardsIndex;
+exports.pvpSeason = pvpSeason;
+exports.pvpSeasonIndex = pvpSeasonIndex;
+exports.realm = realm;
+exports.realmIndex = realmIndex;
+exports.realmSearch = realmSearch;
+exports.region = region;
+exports.regionIndex = regionIndex;
+//# sourceMappingURL=out.js.map
 //# sourceMappingURL=index.cjs.map