rozod 3.1.6 → 4.1.0

package/LICENSE

@@ -1,15 +1,15 @@
-ISC License
-
-Copyright (c) 2023 Alex Op
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above
-copyright notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+ISC License
+
+Copyright (c) 2023 Alex Op
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

package/README.md

@@ -1,121 +1,121 @@
-<h1 align="center" style="height: 200; overflow: 'hidden'">
-    <img src="https://github.com/alexop1000/RoZod/assets/46445843/1c2a6cb5-b1d6-4784-b084-0679d81109c3" alt="RoZod" width="400" />
-    <br>
-
-</h1>
-
-<h4 align="center">A TypeScript package designed to simplify fully type-safe data fetching from the Roblox API.</h4>
-
-<p align="center">
-    <a href="https://www.npmjs.com/package/rozod"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/rozod?style=for-the-badge"></a>
-    <a href="https://www.npmjs.com/package/rozod"><img alt="npm" src="https://img.shields.io/npm/v/rozod?style=for-the-badge"></a>
-    <a href="https://www.npmjs.com/package/rozod"><img alt="npm" src="https://img.shields.io/npm/dt/rozod?style=for-the-badge"></a>
-</p>
-<p align="center">
-  <a href="#about">About</a> •
-  <a href="#features">Features</a> •
-  <a href="#installation">Installation</a> •
-  <a href="#usage">Usage</a> •
-  <a href="#credits">Credits</a> •
-  <a href="#disclaimer">Disclaimer</a>
-</p>
-
----
-
-## About
-`RoZod` is a TypeScript package designed to simplify fetching data from the Roblox API. It provides the functions `fetchApi`, `fetchApiPages`, and `fetchApliSplit`. 
-These allow you to get fully typesafe data from the Roblox API with minimal effort. You can also make custom endpoints to use in any context.
-
-## Features
-
-- Type-safe API requests and responses
-- Automatic validation of request and response data
-- Helper functions for paginated requests and splitting requests
-
-## Installation
-
-To install the package, run the following command:
-
-```bash
-npm install rozod
-```
-
----
-
-## Usage
-First, import the necessary functions and an example endpoint from the RoZod package:
-
-```ts
-import { fetchApi, fetchApiSplit, fetchApiPages, fetchApiPagesGenerator } from 'rozod';
-import { getTradesTradestatustype } from 'rozod/lib/endpoints/tradesv1';
-```
-
-### Simple API Request
-
-To make a simple API request, use the `fetchApi` function, and any endpoint from our exports:
-
-```ts
-const response = await fetchApi(getTradesTradestatustype, { tradeStatusType: 1 });
-console.log(response);
-```
-
-### Split API Request
-To split a request into multiple requests based on specified parameters, use the `fetchApiSplit` function:
-
-```ts
-const data = await fetchApiSplit(getGamesIcons, { universeIds: [1534453623, 65241, ...] }, { universeIds: 100 });
-console.log(data);
-```
-
-### Fetching All Pages
-To fetch all pages of a paginated endpoint, use the `fetchApiPages` function:
-
-```ts
-const allPages = await fetchApiPages(getGroupsGroupidWallPosts, { groupId: 11479637 });
-console.log(allPages);
-```
-### Fetching Pages with a Generator
-To fetch pages one at a time using an async generator, use the `fetchApiPagesGenerator` function:
-
-```ts
-const pages = fetchApiPagesGenerator(getGroupsGroupidWallPosts, { groupId: 11479637 });
-for await (const page of pages) {
-    console.log(page);
-}
-```
-
-### Custom Endpoints
-To create a custom endpoint, define an EndpointSchema object and export it. Here's an example of an endpoint from tradesv1.ts:
-```ts
-import { z, endpoint } from 'zod';
-
-export const getV1tradesTradeStatusType = endpoint({
-  method: 'get' as const,
-  path: '/v1/trades/:tradeStatusType', // Path parameters are optional
-  baseUrl: 'https://trades.roblox.com',
-  requestFormat: 'json' as const,
-  parameters: {
-    tradeStatusType: z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
-    limit: z
-      .union([z.literal(10), z.literal(25), z.literal(50), z.literal(100)])
-      .optional()
-      .default(10),
-    cursor: z.string().optional(),
-    sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
-  }, // Parameters are optional
-  response: ..., // Zod schema
-};
-```
-You can then use the endpoint with the `fetchApi` function:
-```ts
-const response = await fetchApi(getV1tradesTradeStatusType, { tradeStatusType: 1 });
-console.log(response);
-```
-
----
-
-## Credits
-- [alexop1000](https://github.com/alexop1000) - Creator
-
-## Disclaimer
-RoZod is not affiliated with, maintained, authorized, endorsed, or sponsored by Roblox Corporation or any of its affiliates.
+<h1 align="center" style="height: 200; overflow: 'hidden'">
+    <img src="https://github.com/alexop1000/RoZod/assets/46445843/1c2a6cb5-b1d6-4784-b084-0679d81109c3" alt="RoZod" width="400" />
+    <br>
+
+</h1>
+
+<h4 align="center">A TypeScript package designed to simplify fully type-safe data fetching from the Roblox API.</h4>
+
+<p align="center">
+    <a href="https://www.npmjs.com/package/rozod"><img alt="npm bundle size" src="https://img.shields.io/bundlephobia/minzip/rozod?style=for-the-badge"></a>
+    <a href="https://www.npmjs.com/package/rozod"><img alt="npm" src="https://img.shields.io/npm/v/rozod?style=for-the-badge"></a>
+    <a href="https://www.npmjs.com/package/rozod"><img alt="npm" src="https://img.shields.io/npm/dt/rozod?style=for-the-badge"></a>
+</p>
+<p align="center">
+  <a href="#about">About</a> •
+  <a href="#features">Features</a> •
+  <a href="#installation">Installation</a> •
+  <a href="#usage">Usage</a> •
+  <a href="#credits">Credits</a> •
+  <a href="#disclaimer">Disclaimer</a>
+</p>
+
+---
+
+## About
+`RoZod` is a TypeScript package designed to simplify fetching data from the Roblox API. It provides the functions `fetchApi`, `fetchApiPages`, and `fetchApliSplit`. 
+These allow you to get fully typesafe data from the Roblox API with minimal effort. You can also make custom endpoints to use in any context.
+
+## Features
+
+- Type-safe API requests and responses
+- Automatic validation of request and response data
+- Helper functions for paginated requests and splitting requests
+
+## Installation
+
+To install the package, run the following command:
+
+```bash
+npm install rozod
+```
+
+---
+
+## Usage
+First, import the necessary functions and an example endpoint from the RoZod package:
+
+```ts
+import { fetchApi, fetchApiSplit, fetchApiPages, fetchApiPagesGenerator } from 'rozod';
+import { getTradesTradestatustype } from 'rozod/lib/endpoints/tradesv1';
+```
+
+### Simple API Request
+
+To make a simple API request, use the `fetchApi` function, and any endpoint from our exports:
+
+```ts
+const response = await fetchApi(getTradesTradestatustype, { tradeStatusType: 1 });
+console.log(response);
+```
+
+### Split API Request
+To split a request into multiple requests based on specified parameters, use the `fetchApiSplit` function:
+
+```ts
+const data = await fetchApiSplit(getGamesIcons, { universeIds: [1534453623, 65241, ...] }, { universeIds: 100 });
+console.log(data);
+```
+
+### Fetching All Pages
+To fetch all pages of a paginated endpoint, use the `fetchApiPages` function:
+
+```ts
+const allPages = await fetchApiPages(getGroupsGroupidWallPosts, { groupId: 11479637 });
+console.log(allPages);
+```
+### Fetching Pages with a Generator
+To fetch pages one at a time using an async generator, use the `fetchApiPagesGenerator` function:
+
+```ts
+const pages = fetchApiPagesGenerator(getGroupsGroupidWallPosts, { groupId: 11479637 });
+for await (const page of pages) {
+    console.log(page);
+}
+```
+
+### Custom Endpoints
+To create a custom endpoint, define an EndpointSchema object and export it. Here's an example of an endpoint from tradesv1.ts:
+```ts
+import { z, endpoint } from 'zod';
+
+export const getV1tradesTradeStatusType = endpoint({
+  method: 'get' as const,
+  path: '/v1/trades/:tradeStatusType', // Path parameters are optional
+  baseUrl: 'https://trades.roblox.com',
+  requestFormat: 'json' as const,
+  parameters: {
+    tradeStatusType: z.union([z.literal(1), z.literal(2), z.literal(3), z.literal(4)]),
+    limit: z
+      .union([z.literal(10), z.literal(25), z.literal(50), z.literal(100)])
+      .optional()
+      .default(10),
+    cursor: z.string().optional(),
+    sortOrder: z.enum(['Asc', 'Desc']).optional().default('Asc'),
+  }, // Parameters are optional
+  response: ..., // Zod schema
+};
+```
+You can then use the endpoint with the `fetchApi` function:
+```ts
+const response = await fetchApi(getV1tradesTradeStatusType, { tradeStatusType: 1 });
+console.log(response);
+```
+
+---
+
+## Credits
+This repository is maintained by Alrovi ApS, the company behind RoGold.
+
+## Disclaimer
+RoZod is not affiliated with, maintained, authorized, endorsed, or sponsored by Roblox Corporation or any of its affiliates.

package/lib/cache.d.ts

@@ -8,7 +8,26 @@ interface CacheStore<T> {
     delete(key: string): Promise<void>;
     clear(): Promise<void>;
 }
-declare class Cache<T> {
+export declare class MemoryStore<T> implements CacheStore<T> {
+    private store;
+    get(key: string): Promise<CacheEntry<T> | null>;
+    set(key: string, value: CacheEntry<T>): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare class LocalStorageStore<T> implements CacheStore<T> {
+    get(key: string): Promise<CacheEntry<T> | null>;
+    set(key: string, value: CacheEntry<T>): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare class ChromeStore<T> implements CacheStore<T> {
+    get(key: string): Promise<CacheEntry<T> | null>;
+    set(key: string, value: CacheEntry<T>): Promise<void>;
+    delete(key: string): Promise<void>;
+    clear(): Promise<void>;
+}
+export declare class Cache<T> {
     private store;
     constructor(store: CacheStore<T>);
     get(key: string): Promise<T | null>;
@@ -16,7 +35,4 @@ declare class Cache<T> {
     delete(key: string): Promise<void>;
     clear(): Promise<void>;
 }
-export declare const cache: Cache<unknown>;
-export declare const localStorageCache: Cache<unknown>;
-export declare const chromeStorageCache: Cache<unknown>;
 export {};

package/lib/cache.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.chromeStorageCache = exports.localStorageCache = exports.cache = void 0;
+exports.Cache = exports.ChromeStore = exports.LocalStorageStore = exports.MemoryStore = void 0;
 class MemoryStore {
     store = {};
     async get(key) {
@@ -16,6 +16,7 @@ class MemoryStore {
         this.store = {};
     }
 }
+exports.MemoryStore = MemoryStore;
 class LocalStorageStore {
     async get(key) {
         const value = localStorage.getItem(key);
@@ -31,6 +32,7 @@ class LocalStorageStore {
         localStorage.clear();
     }
 }
+exports.LocalStorageStore = LocalStorageStore;
 class ChromeStore {
     async get(key) {
         return new Promise((resolve) => {
@@ -61,6 +63,7 @@ class ChromeStore {
         });
     }
 }
+exports.ChromeStore = ChromeStore;
 class Cache {
     store;
     constructor(store) {
@@ -90,6 +93,4 @@ class Cache {
         await this.store.clear();
     }
 }
-exports.cache = new Cache(new MemoryStore());
-exports.localStorageCache = new Cache(new LocalStorageStore());
-exports.chromeStorageCache = new Cache(new ChromeStore());
+exports.Cache = Cache;

package/lib/index.d.ts

@@ -1,4 +1,5 @@
 import { z } from 'zod';
+import { HBAClient } from 'roblox-bat';
 type RequestMethod = 'get' | 'post' | 'put' | 'delete' | 'patch';
 type RequestFormat = 'json' | 'text' | 'form-data';
 type SerializationMethod = Record<string, {
@@ -72,6 +73,13 @@ type CacheOptions = {
     cacheType?: 'memory' | 'local' | 'chrome';
 };
 type RequestOptions = RequestInit & RetryOptions & ErrorOptions & CacheOptions;
+export declare const hbaClient: HBAClient;
+/**
+ * Allows you to change the Crypto Key pair used by the internal hardware-based authentication signatures. This should only be used in a NodeJS context.
+ *
+ * @param keys The crypto key pair.
+ */
+export declare function changeHBAKeys(keys?: CryptoKeyPair): void;
 /**
  * Fetches the data from the given endpoint and returns it.
  *

package/lib/index.js

@@ -1,8 +1,9 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.endpoint = exports.fetchApiPagesGenerator = exports.fetchApiPages = exports.fetchApiSplit = exports.fetchApi = void 0;
+exports.endpoint = exports.fetchApiPagesGenerator = exports.fetchApiPages = exports.fetchApiSplit = exports.fetchApi = exports.changeHBAKeys = exports.hbaClient = void 0;
 const zod_1 = require("zod");
 const cache_1 = require("./cache");
+const roblox_bat_1 = require("roblox-bat");
 const endpoint = (endpoint) => {
     return endpoint;
 };
@@ -26,7 +27,7 @@ function replacePathParam(path, key, value) {
 // A helper function to serialize a value into a query parameter
 function serializeQueryParam(key, value, serializationMethod) {
     const mapStr = (v, joiner) => v.map(String).join(joiner);
-    if (!serializationMethod || !serializationMethod[key]) {
+    if (!serializationMethod?.[key]) {
         return Array.isArray(value) ? mapStr(value, ',') : String(value);
     }
     const { style, explode } = serializationMethod[key];
@@ -46,6 +47,8 @@ function prepareRequestUrl(endpoint, extendedParams) {
     for (const key in extendedParams) {
         if (!{}.hasOwnProperty.call(extendedParams, key))
             continue;
+        if (key === 'body')
+            continue;
         const value = extendedParams[key];
         processedPath = replacePathParam(processedPath, key, value);
         const serializedValue = serializeQueryParam(key, value, endpoint.serializationMethod);
@@ -67,6 +70,29 @@ function prepareRequestBody(method, requestFormat, body) {
     }
     return body;
 }
+exports.hbaClient = new roblox_bat_1.HBAClient({
+    onSite: 'document' in globalThis && globalThis.location.href.includes('.roblox.com'),
+});
+async function fetch(url, info) {
+    const headers = new Headers(info?.headers);
+    const setHeaders = await exports.hbaClient.generateBaseHeaders(url, info?.body);
+    for (const key in setHeaders) {
+        headers.set(key, setHeaders[key]);
+    }
+    return globalThis.fetch(url, {
+        ...info,
+        headers,
+    });
+}
+/**
+ * Allows you to change the Crypto Key pair used by the internal hardware-based authentication signatures. This should only be used in a NodeJS context.
+ *
+ * @param keys The crypto key pair.
+ */
+function changeHBAKeys(keys) {
+    exports.hbaClient.suppliedCryptoKeyPair = keys;
+}
+exports.changeHBAKeys = changeHBAKeys;
 async function handleRetryFetch(url, requestOptions, retries, retryDelay, body, method) {
     let response = undefined;
     while (response === undefined) {
@@ -88,6 +114,9 @@ async function handleRetryFetch(url, requestOptions, retries, retryDelay, body,
     }
     return response;
 }
+const localStorageCache = new cache_1.Cache(new cache_1.LocalStorageStore());
+const chromeStorageCache = new cache_1.Cache(new cache_1.ChromeStore());
+const cache = new cache_1.Cache(new cache_1.MemoryStore());
 /**
  * Fetches the data from the given endpoint and returns it.
  *
@@ -105,13 +134,13 @@ async function fetchApi(endpoint, params, requestOptions = { mode: 'cors', crede
     const cacheKey = requestOptions.cacheKey;
     let cacheToUse;
     if (requestOptions.cacheType === 'local') {
-        cacheToUse = cache_1.localStorageCache;
+        cacheToUse = localStorageCache;
     }
     else if (requestOptions.cacheType === 'chrome') {
-        cacheToUse = cache_1.chromeStorageCache;
+        cacheToUse = chromeStorageCache;
     }
     else {
-        cacheToUse = cache_1.cache;
+        cacheToUse = cache;
     }
     const cachedResponse = cacheKey && cacheToUse.get(cacheKey);
     if (cachedResponse) {
@@ -122,13 +151,16 @@ async function fetchApi(endpoint, params, requestOptions = { mode: 'cors', crede
     const response = await handleRetryFetch(url, requestOptions, retries, retryDelay, body, method);
     const error = endpoint.errors?.find(({ status }) => status === response.status);
     if (error) {
-        if (requestOptions.throwOnError) {
+        if (requestOptions.throwOnError === false) {
             throw new Error(error.description);
         }
         else {
-            return null;
+            return error.description;
         }
     }
+    if (requestFormat === 'json' && !response.headers.get('content-type')?.includes('application/json')) {
+        throw new Error('Invalid response data');
+    }
     if (requestOptions.cacheTime && cacheKey) {
         const responseClone = response.clone();
         const cacheTime = requestOptions.cacheTime;
@@ -137,9 +169,6 @@ async function fetchApi(endpoint, params, requestOptions = { mode: 'cors', crede
         }, cacheTime);
         cacheToUse.set(cacheKey, requestFormat === 'json' ? await responseClone.json() : await responseClone.text(), cacheTime);
     }
-    if (requestFormat === 'json' && !response.headers.get('content-type')?.includes('application/json')) {
-        throw new Error('Invalid response data');
-    }
     return requestFormat === 'json' ? await response.json() : await response.text();
 }
 exports.fetchApi = fetchApi;
@@ -168,7 +197,7 @@ async function fetchApiSplit(endpoint, params, max, transform = (response) => re
     }
     const splitParams = [];
     for (const key in max) {
-        if (!{}.hasOwnProperty.call(max, key) || !{}.hasOwnProperty.call(params, key)) {
+        if (!Object.hasOwn(max, key) || !{}.hasOwnProperty.call(params, key)) {
             continue;
         }
         const maxItems = max[key];
@@ -203,8 +232,12 @@ exports.fetchApiSplit = fetchApiSplit;
  */
 async function fetchApiPages(endpoint, initialParams, requestOptions, limit = 1000) {
     const allResults = [];
-    for await (const { nextPageCursor, ...response } of fetchApiPagesGenerator(endpoint, initialParams, requestOptions, limit)) {
-        allResults.push(response);
+    for await (const response of fetchApiPagesGenerator(endpoint, initialParams, requestOptions, limit)) {
+        if (response === null || response === undefined) {
+            break;
+        }
+        const { nextPageCursor, ...rest } = response;
+        allResults.push(rest);
         if (allResults.length >= limit || nextPageCursor === null || nextPageCursor === undefined) {
             break;
         }

package/package.json

@@ -1,36 +1,28 @@
 {
   "name": "rozod",
-  "version": "3.1.6",
+  "version": "4.1.0",
   "description": "A TypeScript wrapper for the Roblox API",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
-  "scripts": {
-    "test": "jest --config jestconfig.json",
-    "build": "tsc && tsc --project tsconfig.declarations.json",
-    "format": "prettier --write \"src/**/*.ts\"",
-    "lint": "tslint -p tsconfig.json",
-    "prepare": "npm run build",
-    "prepublishOnly": "npm test",
-    "version": "npm run format && git add -A src",
-    "generate": "node ./zodios-endpoints.js"
-  },
-  "author": "alexop1000",
+  "author": "AlroviOfficial",
   "license": "ISC",
   "dependencies": {
     "@alexop/openapi-zod-client": "^1.10.2",
     "p-limit": "^3.0.0",
+    "roblox-bat": "^0.1.1",
     "zod": "^3.21.4"
   },
   "repository": {
-    "url": "https://github.com/alexop1000/RoZod"
+    "url": "https://github.com/AlroviOfficial/RoZod"
   },
   "bugs": {
-    "url": "https://github.com/alexop1000/RoZod/issues"
+    "url": "https://github.com/AlroviOfficial/RoZod/issues"
   },
   "devDependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@thepotato97/openapi-zod-client": "^1.6.4",
     "@types/jest": "^29.5.1",
+    "@types/jsdom": "^21.1.2",
     "@zodios/plugins": "^10.6.0",
     "jest": "^29.5.0",
     "prettier": "^2.8.8",
@@ -51,5 +43,13 @@
   ],
   "files": [
     "lib/**/*"
-  ]
-}
+  ],
+  "scripts": {
+    "test": "jest --config jestconfig.json",
+    "build": "tsc && tsc --project tsconfig.declarations.json",
+    "format": "prettier --write \"src/**/*.ts\"",
+    "lint": "tslint -p tsconfig.json",
+    "version": "npm run format && git add -A src",
+    "generate": "node ./zodios-endpoints.js"
+  }
+}