unb-api 1.4.0 → 2.0.0

package/README.md

@@ -10,6 +10,8 @@
 
 `npm install unb-api`
 
+Requires Node.js 18 or newer (uses the built-in `fetch`). For older Node.js versions, use `unb-api@1`.
+
 ## Documentation
 
 Full API documentation is located at [https://unbelievaboat.com/api/docs](https://unbelievaboat.com/api/docs)
@@ -89,7 +91,7 @@ Returns: `Promise<{ page: number, totalPages: number, items: InventoryItem[] }>`
 `getInventoryItem(guildId: string, userId: string, itemId: string)`  
 Returns: `Promise<InventoryItem>`
 
-`addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string })`  
+`addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string, ignoreMaxQuantity?: boolean })`  
 Returns: `Promise<InventoryItem>`
 
 `removeInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number)`  
@@ -138,6 +140,7 @@ Returns: `Promise<any>`
 | Number  | `price`          | Price of the item.                                                        |
 | Number  | `stockRemaining` | Amount of stock remaining for the item.                                   |
 | Boolean | `unlimitedStock` | Whether the item has unlimited stock.                                     |
+| Number  | `maxQuantity?`   | Max a user can own, or buy at once if not an inventory item.              |
 | Boolean | `isInventory`    | Indicates if the item will be added to a user’s inventory when purchased. |
 | Date    | `expiresAt?`     | Expiration date of the item.                                              |
 | Boolean | `isUsable`       | Whether the item can be used by the user.                                 |

package/eslintrc.js

@@ -1,5 +1,12 @@
 module.exports = {
     'extends': 'eslint:recommended',
+    'env': {
+        'node': true,
+        'es2020': true
+    },
+    'globals': {
+        'fetch': 'readonly'
+    },
     'rules': {
         'indent': ['error', 4],
         'linebreak-style': ['error', 'unix'],

package/index.d.ts

@@ -37,7 +37,7 @@ declare module 'unb-api' {
 
         public getInventoryItem(guildId: string, userId: string, itemId: string): Promise<InventoryItem>
 
-        public addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string }): Promise<InventoryItem>
+        public addInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number, options?: { inventoryUserId?: string, ignoreMaxQuantity?: boolean }): Promise<InventoryItem>
 
         public removeInventoryItem(guildId: string, userId: string, itemId: string, quantity?: string | number): Promise<any>
 
@@ -111,6 +111,7 @@ declare module 'unb-api' {
         public price: number;
         public stockRemaining: number;
         public unlimitedStock: boolean;
+        public maxQuantity: number | null;
         public isInventory: boolean;
         public expiresAt?: Date;
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "unb-api",
-  "version": "1.4.0",
+  "version": "2.0.0",
   "description": "API wrapper for UnbelievaBoat Discord Bot API",
   "main": "src/index.js",
   "types": "index.d.ts",
@@ -16,12 +16,12 @@
   ],
   "author": "unbelievable",
   "license": "MIT",
+  "engines": {
+    "node": ">=18"
+  },
   "devDependencies": {
     "@types/node": "^10.0.7",
     "eslint": "^6.7.2",
     "typescript": "^2.6.2"
-  },
-  "dependencies": {
-    "axios": "1.6.0"
   }
 }

package/src/lib/Client.js

@@ -336,6 +336,7 @@ class Client {
      * @param {number|string} [quantity=1] - Quantity to add
      * @param {object} [options]
      * @param {string} [options.inventoryUserId] - User ID of the inventory to add the item from (can be used if the item no longer exists in the store or the item settings differ)
+     * @param {boolean} [options.ignoreMaxQuantity=false] - Add the item even if the user would own more than the item's max quantity
      * @returns {Promise<InventoryItem>}
      * 
      * @see {@link https://unbelievaboat-api.readme.io/reference/add-inventory-item|Add Inventory Item}

package/src/lib/RequestHandler.js

@@ -1,4 +1,3 @@
-const axios = require('axios');
 const Bucket = require('./util/Bucket');
 const { APIError, HTTPError } = require('./errors');
 const MajorParams = ['guilds'];
@@ -7,13 +6,6 @@ class RequestHandler {
     constructor(client) {
         this._client = client;
         this.ratelimits = {};
-        this.axiosInstance = axios.create({
-            baseURL: this._client.baseURL,
-            headers: {
-                'Authorization': this._client.token,
-                'Content-Type': 'application/json'
-            }
-        });
     }
 
     async request(method, endpoint, data = {}, params = {}, _attempts = 0) {
@@ -32,7 +24,7 @@ class RequestHandler {
                 };
 
                 try {
-                    const { data: responseData, status, headers } = await this.axiosInstance(options);
+                    const { data: responseData, status, statusText, headers } = await this.fetch(options);
 
                     // Increase the number of attempts
                     ++_attempts;
@@ -44,21 +36,17 @@ class RequestHandler {
                         resolve(responseData);
                     } else if (status === 429) {
                         if (_attempts >= this._client.maxRetries) {
-                            this.rejectWithError(options, responseData, status, reject);
+                            this.rejectWithError(options, responseData, status, statusText, reject);
                         } else {
                             this.retryRequest(method, endpoint, data, params, _attempts, headers, resolve, reject);
                         }
                     } else {
-                        this.rejectWithError(options, responseData, status, reject);
+                        this.rejectWithError(options, responseData, status, statusText, reject);
                     }
 
                     callback();
                 } catch (error) {
-                    if (axios.isAxiosError(error)) {
-                        this.rejectWithError(options, error.response.data, error.response.status, reject);
-                    } else {
-                        reject(error);
-                    }
+                    reject(error);
                     callback();
                 }
             };
@@ -67,11 +55,49 @@ class RequestHandler {
         });
     }
 
-    rejectWithError(options, data, status, reject) {
+    async fetch(options) {
+        const url = new URL(`${this._client.baseURL.replace(/\/+$/, '')}${options.url}`);
+        for (const [key, value] of Object.entries(options.params || {})) {
+            if (value === undefined || value === null) continue;
+            if (Array.isArray(value)) {
+                for (const v of value) url.searchParams.append(`${key}[]`, v);
+            } else {
+                url.searchParams.append(key, value);
+            }
+        }
+
+        const response = await fetch(url, {
+            method: options.method,
+            headers: {
+                'Authorization': this._client.token,
+                'Content-Type': 'application/json'
+            },
+            body: ['GET', 'HEAD'].includes(options.method) ? undefined : JSON.stringify(options.data)
+        });
+
+        const text = await response.text();
+        let data = text;
+        if (text) {
+            try {
+                data = JSON.parse(text);
+            } catch (e) {
+                // Not JSON (e.g. an HTML error page from a proxy), keep the raw text
+            }
+        }
+
+        return {
+            data,
+            status: response.status,
+            statusText: response.statusText,
+            headers: Object.fromEntries(response.headers)
+        };
+    }
+
+    rejectWithError(options, data, status, statusText, reject) {
         if (data && data.message) {
-            reject(new APIError(options, { data, status }));
+            reject(new APIError(options, { data, status, statusText }));
         } else {
-            reject(new HTTPError(options, { data, status }));
+            reject(new HTTPError(options, { data, status, statusText }));
         }
     }
 

package/src/lib/structures/items/StoreItem.js

@@ -8,6 +8,7 @@ class StoreItem extends BaseItem {
     this.isInventory = data.is_inventory;
     this.stockRemaining = data.stock_remaining;
     this.unlimitedStock = data.unlimited_stock;
+    this.maxQuantity = data.max_quantity ?? null;
     if (data.expires_at) {
       this.expiresAt = new Date(data.expires_at);
     }