fetchbasequery 0.0.2 → 0.1.1

package/README.md

@@ -2,8 +2,21 @@
 
 Library for easily make HTTP queries without mass of boilerplate code.
 
-Usage
------
+## Installation
+
+NPM:
+
+```sh
+npm install fetchbasequery
+```
+
+PNPM:
+
+```sh
+pnpm add fetchbasequery
+```
+
+## Usage
 
 Build base query function:
 
@@ -11,14 +24,21 @@ Build base query function:
 import fetchBaseQuery, { baseQuery, encodeBody, accessToken, jsonReply, commonReply } from 'fetchbasequery'
 
 const query = fetchBaseQuery({
+    // main options ...
     baseUrl: 'https://api.example.org/v1'
     baseQuery,
     logErrors: true,
+    // add some defaults for `fetch()` ...
+    mode: 'cors',
+    credentials: 'include',
+    cache: 'reload',
+    // middlewares
     middleware: [
         encodeBody(),
         accessToken({
             getAccessToken: () => localStorage.getItem('access_token'),
             setAccessToken: (token) => localStorage.setItem('access_token', token),
+            removeAccessToken: (token) => localStorage.removeItem('access_token'),
             getUpdatedAccessToken: async (response) => response.headers.get('X-Access-Token')
         }),
         jsonReply(),
@@ -54,3 +74,7 @@ addEventListener('fetch', evt => {
 It works fine both on frontend and backend sides. For backend side usage Node.js v18+ is required,
 because the middleware `baseQuery` based on `Fetch API`. But it can be replaced with your own
 implementation based on another API (e.g. based on `axios` etc).
+
+## License
+
+MIT

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fetchbasequery",
-  "version": "0.0.2",
+  "version": "0.1.1",
   "description": "Library for easily make HTTP queries without mass of boilerplate code.",
   "type": "module",
   "main": "src/fetchBaseQuery.js",

package/src/baseQuery.js

@@ -1,5 +1,6 @@
 import responseFromError from './helpers/responseFromError.js'
 import purge from './helpers/purge.js'
+import mergeHeaders from './helpers/mergeHeaders.js'
 
 const moduleName = 'fetchBaseQuery/baseQuery'
 
@@ -16,12 +17,6 @@ export default async ({ url: endpoint, request: subject, ...options } = {}) => {
             : undefined,
         ...options
     }
-    // default options for `fetch()`
-    const defaultFetchOptions = {
-        method: 'GET',
-        cache: 'reload',
-        credentials: 'include',
-    }
     // extract options which are known by `fetch()`
     const { method, headers, body, mode, credentials, cache, redirect,
         referrer, referrerPolicy, integrity, keepalive, signal } = restOptions
@@ -50,11 +45,13 @@ export default async ({ url: endpoint, request: subject, ...options } = {}) => {
                 )
             }
             subject = url
+        } else if (fetchOptions.headers) {
+            fetchOptions.headers = mergeHeaders(subject.headers, fetchOptions.headers)
+        }
+        request = new Request(subject, fetchOptions)
+        if (debug?.baseQuery) {
+            console.log(moduleName, { request })
         }
-        request = new Request(subject, {
-            ...defaultFetchOptions,
-            ...fetchOptions
-        })
         response = await fetch(request)
     } catch (error) {
         if (logErrors) {
@@ -63,7 +60,7 @@ export default async ({ url: endpoint, request: subject, ...options } = {}) => {
         response = responseFromError(error)
     }
     if (debug?.baseQuery) {
-        console.log(moduleName, response)
+        console.log(moduleName, { response })
     }
     return response
 }

package/src/helpers/mergeHeaders.js

@@ -0,0 +1,7 @@
+export default (a, b) => {
+    const result = new Headers(a)
+    b = (b instanceof Headers ? b : new Headers(b))
+    b.entries().forEach(pair => result.delete(pair[0]))
+    b.entries().forEach(pair => result.append(pair[0], pair[1]))
+    return result
+}

package/src/helpers/purge.js

@@ -1,4 +1,16 @@
-export default object => Object.fromEntries(
+const purgeObject = object => Object.fromEntries(
     Object.entries(object)
         .filter(entry => entry[1] !== undefined)
 )
+
+const purgeHeaders = headers => {
+    headers.entities().forEach(([ name, value ]) => {
+        if (value === '')
+            headers.delete(name)
+    })
+    return headers
+}
+
+export default object => object instanceof Headers
+    ? purgeHeaders(object)
+    : purgeObject(object)

package/src/middlewares/accessToken.js

@@ -1,5 +1,6 @@
 import responseFromError from '../helpers/responseFromError.js'
 import purge from '../helpers/purge.js'
+import mergeHeaders from '../helpers/mergeHeaders.js'
 
 const moduleName = 'fetchBaseQuery/middlewares/accessToken'
 
@@ -7,12 +8,14 @@ export default (settings = {}) => query => async ({ payload, headers, ...options
     const {
         getAccessToken,
         setAccessToken,
+        removeAccessToken,
         isUnauthorized,
         getUpdatedAccessToken,
         getAuthorizationHeaders
     } = {
         getAccessToken: (payload) => undefined,
         setAccessToken: (token) => {},
+        removeAccessToken: () => {},
         isUnauthorized: (response) => response.status === 401,
         getUpdatedAccessToken: async (response) => undefined,
         getAuthorizationHeaders: (accessToken) => (
@@ -26,10 +29,10 @@ export default (settings = {}) => query => async ({ payload, headers, ...options
     try {
         response = await query({
             ...options,
-            headers: purge({
-                ...(getAuthorizationHeaders(getAccessToken(payload))),
-                ...(headers || {})
-            })
+            headers: mergeHeaders(
+                purge(getAuthorizationHeaders(getAccessToken(payload))),
+                headers || {}
+            )
         })
     } catch (error) {
         if (options.logErrors) {
@@ -39,7 +42,7 @@ export default (settings = {}) => query => async ({ payload, headers, ...options
     }
     try {
         if (isUnauthorized(response)) {
-            setAccessToken(null) // special case to remove access token from storage
+            removeAccessToken()
         } else {
             const updatedAccessToken = await getUpdatedAccessToken(response)
             if (updatedAccessToken) {
@@ -53,7 +56,7 @@ export default (settings = {}) => query => async ({ payload, headers, ...options
         response = responseFromError(error)
     }
     if (options.debug?.accessToken) {
-        console.log(moduleName, response)
+        console.log(moduleName, { response })
     }
     return response
 }

package/src/middlewares/commonReply.js

@@ -17,7 +17,7 @@ export default () => query => async (options) => {
         reply = { status, headers }
     }
     if (options.debug?.commonReply) {
-        console.log(moduleName, reply)
+        console.log(moduleName, { reply })
     }
     return reply
 }

package/src/middlewares/encodeBody.js

@@ -1,6 +1,7 @@
 import purge from '../helpers/purge.js'
 import encodeJson from '../helpers/encodeJson.js'
 import responseFromError from '../helpers/responseFromError.js'
+import mergeHeaders from '../helpers/mergeHeaders.js'
 
 const moduleName = 'fetchBaseQuery/middlewares/accessToken'
 
@@ -61,12 +62,14 @@ export default (settings = {}) => (query) => async ({ body, headers, ...options
     try {
         response = await query({
             ...options,
-            headers: purge({
-                'Content-Type': contentType instanceof Function
-                    ? contentType({ body })
-                    : contentType,
-                ...(headers || {})
-            }),
+            headers: mergeHeaders(
+                purge({
+                    'Content-Type': contentType instanceof Function
+                        ? contentType({ body })
+                        : contentType
+                }),
+                headers || {}
+            ),
             body: encodeBody(body)
         })
     } catch (error) {
@@ -76,7 +79,7 @@ export default (settings = {}) => (query) => async ({ body, headers, ...options
         response = responseFromError(error)
     }
     if (options.debug?.encodeBody) {
-        console.log(moduleName, response)
+        console.log(moduleName, { response })
     }
     return response
 }

package/src/middlewares/jsonReply.js

@@ -29,7 +29,7 @@ export default (settings = {}) => query => async (options = {}) => {
         }
     }
     if (options.debug?.jsonReply) {
-        console.log(moduleName, reply)
+        console.log(moduleName, { reply })
     }
     return reply
 }

package/types/index.d.ts

@@ -11,7 +11,7 @@ export type FetchOptions = {
     url: URL | string | undefined,
     request: Request | undefined,
     method: string | undefined,
-    headers: object | undefined,
+    headers: Headers | object | undefined,
     body: string
         | object
         | FormData