@brickninjaapi/fetch 0.0.3 → 0.0.4

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @brickninjaapi/fetch
 
+## 0.0.4
+
+### Patch Changes
+
+- e45aa2b: New release
+- 75f64aa: New release
+
 ## 0.0.3
 
 ### Patch Changes

package/dist/index.d.ts

@@ -4,7 +4,7 @@ type RequiredKeys<T> = {
     [K in keyof T]-?: {} extends Pick<T, K> ? never : K;
 }[keyof T];
 type Args<Url extends string, Schema extends SchemaVersion> = RequiredKeys<OptionsByEndpoint<Url>> extends never ? [endpoint: Url, options?: FetchBrickNinjaApiOptions<Schema> & OptionsByEndpoint<Url> & FetchOptions] : [endpoint: Url, options: FetchBrickNinjaApiOptions<Schema> & OptionsByEndpoint<Url> & FetchOptions];
-export declare function fetchBrickNinjaApi<Url extends KnownEndpoint | (string & {}), Schema extends SchemaVersion = 'latest'>(...[endpoint, options]: Args<Url, Schema>): Promise<EndpointType<Url, Schema>>;
+export declare function fetchBrickNinjaApi<Url extends KnownEndpoint | (string & {}), Schema extends SchemaVersion = undefined>(...[endpoint, options]: Args<Url, Schema>): Promise<EndpointType<Url, Schema>>;
 export type FetchBrickNinjaApiOptions<Schema extends SchemaVersion> = {
     /** The schema to use when making the API request */
     schema?: Schema;

package/dist/index.js

@@ -10,7 +10,7 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 export function fetchBrickNinjaApi() {
     return __awaiter(this, arguments, void 0, function* (...[endpoint, options]) {
         var _a;
-        const url = new URL('https://brick-ninja-api.vercel.app/');
+        const url = new URL(endpoint, 'https://brick-ninja-api.vercel.app/');
         if (options.schema) {
             url.searchParams.set('v', options.schema);
         }
@@ -38,11 +38,11 @@ export function fetchBrickNinjaApi() {
         }
         // call the API
         const response = yield fetch(request);
-        // call the onResponse handler if it exists
+        // call onResponse handler
         yield ((_a = options.onResponse) === null || _a === void 0 ? void 0 : _a.call(options, response));
         // check if the response is json (`application/json; charset=utf-8`)
         const isJson = response.headers.get('content-type').startsWith('application/json');
-        // censor access token in the url to not leak it in error messages
+        // censor access token in url to not leak it in error messages
         const erroredUrl = hasAccessToken(options)
             ? url.toString().replace(options.accessToken, '***')
             : url.toString();
@@ -60,10 +60,14 @@ export function fetchBrickNinjaApi() {
         }
         // if the response is not JSON, throw an error
         if (!isJson) {
-            throw new BrickNinjaApiError(`The Brick Ninja API call to '${erroredUrl}'did not respond with a JSON response.`, response);
+            throw new BrickNinjaApiError(`The Brick Ninja API call to '${erroredUrl}' did not respond with a JSON response`, response);
         }
-        // parse the response as JSON
+        // parse json
         const json = yield response.json();
+        // check that json is not `["v1", "v2"]` which sometimes happens for authenticated endpoints
+        if (url.toString() !== 'https://brick-ninja-api.vercel.app/' && Array.isArray(json) && json.length === 2 && json[0] === 'v1' && json[1] === 'v2') {
+            throw new BrickNinjaApiError(`The Brick Ninja API call to '${erroredUrl}' did returned an invalid response (["v1", "v2"])`, response);
+        }
         // TODO: catch more errors
         return json;
     });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@brickninjaapi/fetch",
-  "version": "0.0.3",
+  "version": "0.0.4",
   "description": "Tiny wrapper around fetch that returns type-safe responses",
   "license": "MIT",
   "main": "dist/index.js",

package/src/index.ts

@@ -10,11 +10,11 @@ type Args<Url extends string, Schema extends SchemaVersion> = RequiredKeys<Optio
 
 export async function fetchBrickNinjaApi<
   Url extends KnownEndpoint | (string & {}),
-  Schema extends SchemaVersion = 'latest',
+  Schema extends SchemaVersion = undefined
 >(
   ...[endpoint, options]: Args<Url, Schema>
 ): Promise<EndpointType<Url, Schema>> {
-  const url = new URL('https://brick-ninja-api.vercel.app/');
+  const url = new URL(endpoint, 'https://brick-ninja-api.vercel.app/');
 
   if (options.schema) {
     url.searchParams.set('v', options.schema);
@@ -49,13 +49,13 @@ export async function fetchBrickNinjaApi<
   // call the API
   const response = await fetch(request);
 
-  // call the onResponse handler if it exists
+  // call onResponse handler
   await options.onResponse?.(response);
 
   // check if the response is json (`application/json; charset=utf-8`)
   const isJson = response.headers.get('content-type').startsWith('application/json');
 
-  // censor access token in the url to not leak it in error messages
+  // censor access token in url to not leak it in error messages
   const erroredUrl = hasAccessToken(options)
     ? url.toString().replace(options.accessToken, '***')
     : url.toString();
@@ -77,12 +77,17 @@ export async function fetchBrickNinjaApi<
 
   // if the response is not JSON, throw an error
   if (!isJson) {
-    throw new BrickNinjaApiError(`The Brick Ninja API call to '${erroredUrl}'did not respond with a JSON response.`, response);
+    throw new BrickNinjaApiError(`The Brick Ninja API call to '${erroredUrl}' did not respond with a JSON response`, response);
   }
 
-  // parse the response as JSON
+  // parse json
   const json = await response.json();
 
+  // check that json is not `["v1", "v2"]` which sometimes happens for authenticated endpoints
+  if(url.toString() !== 'https://brick-ninja-api.vercel.app/' && Array.isArray(json) && json.length === 2 && json[0] === 'v1' && json[1] === 'v2') {
+    throw new BrickNinjaApiError(`The Brick Ninja API call to '${erroredUrl}' did returned an invalid response (["v1", "v2"])`, response);
+  }
+
   // TODO: catch more errors
 
   return json;