@blizzard-api/d3 2.0.0 → 2.0.1

package/README.md

@@ -1,75 +1,75 @@
-# @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"
-//or
-import d3 from "@blizzard-api/d3"
-
-const achievement = d3.achievement(123);
-        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
-```
-
-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, 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 { AchievementResponse } from '@blizzard-api/d3';
-```
-
-If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
-
-```ts
-import { d3 } from "@blizzard-api/d3"
-
-const achievement = d3.achievement(123);
-        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
-
-type AchievementResponse = ExtractResourceType<typeof achievement>;
-```
-
-## 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 to 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);
-                ^ typeof AuctionHouseCommoditiesResponse
-```
+# @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"
+//or
+import d3 from "@blizzard-api/d3"
+
+const achievement = d3.achievement(123);
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
+```
+
+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, 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 { AchievementResponse } from '@blizzard-api/d3';
+```
+
+If you simply want to use the existing object, you can use the helper, `ExtractResourceType`, from `@blizzard-api/core` like so:
+
+```ts
+import { d3 } from "@blizzard-api/d3"
+
+const achievement = d3.achievement(123);
+        ^ { path: string, namespace?: string, parameters?: Record<string, never> }
+
+type AchievementResponse = ExtractResourceType<typeof achievement>;
+```
+
+## 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 to 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);
+                ^ typeof AuctionHouseCommoditiesResponse
+```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@blizzard-api/d3",
-  "version": "2.0.0",
+  "version": "2.0.1",
   "license": "MIT",
   "author": "Putro",
   "description": "A series of helpers to interact with the Diablo 3 Blizzard API",
@@ -34,10 +34,10 @@
   ],
   "dependencies": {},
   "peerDependencies": {
-    "@blizzard-api/core": "3.0.0"
+    "@blizzard-api/core": "3.0.1"
   },
   "devDependencies": {
-    "@blizzard-api/core": "3.0.0"
+    "@blizzard-api/core": "3.0.1"
   },
   "scripts": {
     "build": "tsdown",