fetchbasequery 0.2.1 → 1.0.0

package/src/baseQuery.js

@@ -1,80 +0,0 @@
-import responseFromError from './helpers/responseFromError.js'
-import purge from './helpers/purge.js'
-import mergeHeaders from './helpers/mergeHeaders.js'
-
-const moduleName = 'fetchBaseQuery/baseQuery'
-
-const baseQuery = async ({ url: endpoint, request: subject, ...options } = {}) => {
-    const {
-        baseUrl,
-        logErrors,
-        debug,
-        ...restOptions
-    } = {
-        logErrors: false,
-        baseUrl: globalThis.location
-            ? globalThis.location.origin
-            : undefined,
-        ...options
-    }
-    // extract options which are known by `fetch()`
-    const { method, headers, body, mode, credentials, cache, redirect,
-        referrer, referrerPolicy, integrity, keepalive, signal } = restOptions
-    // combine extracted options and remove undefined properties
-    const fetchOptions = purge({ method, headers, body, mode, credentials, cache, redirect,
-        referrer, referrerPolicy, integrity, keepalive, signal })
-    // do request
-    let request
-    let response
-    try {
-        if (endpoint !== undefined) {
-            let url, origin, prefix = '/'
-            if (baseUrl) {
-                const url = new URL(baseUrl)
-                origin = url.origin
-                prefix = url.pathname
-            }
-            try {
-                url = new URL(endpoint)
-            } catch (error) {
-                url = new URL(
-                    /\/$/.test(prefix) && /^\//.test(endpoint)
-                        ? prefix + endpoint.substring(1)
-                        : prefix + endpoint,
-                    origin
-                )
-            }
-            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 })
-        }
-        response = await fetch(request)
-    } catch (error) {
-        if (logErrors) {
-            console.error(moduleName, error)
-        }
-        response = responseFromError(error)
-    }
-    if (debug?.baseQuery) {
-        console.log(moduleName, { response })
-    }
-    return response
-}
-
-export default ({ timeout, signal, ...options } = {}) => {
-    // construct abort signal
-    const abortController = new AbortController()
-    const abortSignal = AbortSignal.any([
-        abortController.signal,
-        ...(timeout ? [ AbortSignal.timeout(timeout) ] : []),
-        ...(signal ? [ signal ] : [])
-    ])
-    // construct abortable promise
-    const promise = baseQuery({ ...options, signal: abortSignal })
-    promise.abort = () => abortController.abort()
-    return promise
-}

package/src/helpers/abortable.js

@@ -1,13 +0,0 @@
-export default middleware => query => ({ signal, ...options } = {}) => {
-    const abortController = new AbortController()
-    const abortableQuery = (options) => query({
-        ...options,
-        signal: AbortSignal.any([
-            abortController.signal,
-            ...(signal ? [ signal ] : [])
-        ])
-    })
-    const promise = middleware(abortableQuery)(options)
-    promise.abort = () => abortController.abort()
-    return promise
-}

package/src/helpers/encodeJson.js

@@ -1,8 +0,0 @@
-export default body => JSON.stringify(body, (key, value) => {
-    if (value instanceof Error) {
-        return value.stack.split(/\r?\n/g)
-    } else if (typeof value === 'bigint') {
-        return value.toString()
-    }
-    return value
-})

package/src/helpers/mergeHeaders.js

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

package/src/helpers/pipe.js

@@ -1 +0,0 @@
-export default (...fns) => (input) => fns.reduce((chain, f) => f(chain), input)

package/src/helpers/purge.js

@@ -1,16 +0,0 @@
-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/helpers/responseFromError.js

@@ -1,5 +0,0 @@
-export default (error) => {
-    const response = Response.error()
-    response.error = error
-    return response
-}

package/src/middlewares/accessToken.js

@@ -1,62 +0,0 @@
-import responseFromError from '../helpers/responseFromError.js'
-import purge from '../helpers/purge.js'
-import mergeHeaders from '../helpers/mergeHeaders.js'
-
-const moduleName = 'fetchBaseQuery/middlewares/accessToken'
-
-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) => (
-            accessToken
-                ? { Authorization: `bearer ${accessToken}` }
-                : {}
-        ),
-        ...settings
-    }
-    let response
-    try {
-        response = await query({
-            ...options,
-            headers: mergeHeaders(
-                purge(getAuthorizationHeaders(getAccessToken(payload))),
-                headers || {}
-            )
-        })
-    } catch (error) {
-        if (options.logErrors) {
-            console.error(moduleName, error)
-        }
-        response = responseFromError(error)
-    }
-    try {
-        if (isUnauthorized(response)) {
-            removeAccessToken()
-        } else {
-            const updatedAccessToken = await getUpdatedAccessToken(response)
-            if (updatedAccessToken) {
-                setAccessToken(updatedAccessToken)
-            }
-        }
-    } catch (error) {
-        if (options.logErrors) {
-            console.error(moduleName, error)
-        }
-        response = responseFromError(error)
-    }
-    if (options.debug?.accessToken) {
-        console.log(moduleName, { response })
-    }
-    return response
-}

package/src/middlewares/commonReply.js

@@ -1,23 +0,0 @@
-const moduleName = 'fetchBaseQuery/middlewares/commonReply'
-
-export default () => query => async (options) => {
-    const { status, data, error, headers } = await query(options)
-    let reply
-    if (error) {
-        reply = { status, error: true, message: error.message || error, headers }
-    } else if (data) {
-        if (data.success) {
-            reply = { ...data, status, headers }
-        } else if (data.error) {
-            reply = { status, error: true, message: data.message, headers }
-        } else {
-            reply = { status, error: true, message: 'Unexpected format of common response body.', headers }
-        }
-    } else {
-        reply = { status, headers }
-    }
-    if (options.debug?.commonReply) {
-        console.log(moduleName, { reply })
-    }
-    return reply
-}

package/src/middlewares/encodeBody.js

@@ -1,85 +0,0 @@
-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'
-
-const getEncodedBody = body => (
-    typeof body === 'string'
-    || body instanceof String
-    || body instanceof FormData
-    || body instanceof Blob
-    || body instanceof ArrayBuffer
-    || body instanceof DataView
-    || body instanceof File
-    || body instanceof ReadableStream
-    || body instanceof Int8Array
-    || body instanceof Uint8Array
-    || body instanceof Int16Array
-    || body instanceof Uint16Array
-    || body instanceof Int32Array
-    || body instanceof Uint32Array
-    || body instanceof BigInt64Array
-    || body instanceof BigUint64Array
-        ? body // raw
-        : (
-            body instanceof URLSearchParams
-                ? body.toString()
-                : encodeJson(body) // default
-          )
-)
-
-const detectContentType = ({ body }) => {
-    if (body instanceof ArrayBuffer
-        || body instanceof DataView
-        || body instanceof ReadableStream
-        || body instanceof Int8Array
-        || body instanceof Uint8Array
-        || body instanceof Int16Array
-        || body instanceof Uint16Array
-        || body instanceof Int32Array
-        || body instanceof Uint32Array
-        || body instanceof BigInt64Array
-        || body instanceof BigUint64Array
-    ) return 'application/octet-stream'
-    if (body instanceof URLSearchParams) return 'application/x-www-form-urlencoded'
-    if (body instanceof FormData) return 'multipart/form-data'
-    if (body instanceof Object) return 'application/json; charset=utf-8'
-    // return undefined
-}
-
-export default (settings = {}) => (query) => async ({ body, headers, ...options } = {}) => {
-    const {
-        contentType,
-        encodeBody
-    } = {
-        contentType: detectContentType,
-        encodeBody: getEncodedBody,
-        ...settings
-    }
-    let response
-    try {
-        response = await query({
-            ...options,
-            headers: mergeHeaders(
-                purge({
-                    'Content-Type': contentType instanceof Function
-                        ? contentType({ body })
-                        : contentType
-                }),
-                headers || {}
-            ),
-            body: encodeBody(body)
-        })
-    } catch (error) {
-        if (options.logErrors) {
-            console.error(moduleName, error)
-        }
-        response = responseFromError(error)
-    }
-    if (options.debug?.encodeBody) {
-        console.log(moduleName, { response })
-    }
-    return response
-}

package/src/middlewares/jsonReply.js

@@ -1,35 +0,0 @@
-const moduleName = 'fetchBaseQuery/middlewares/jsonReply'
-
-export default (settings = {}) => query => async (options = {}) => {
-    const {
-        isJsonBody
-    } = {
-        isJsonBody: (response) => /^application\/json/i.test(response.headers.get('Content-Type')),
-        ...settings
-    }
-    const response = await query(options)
-    const { status, error, headers } = response
-    let reply
-    if (error) {
-        reply = { status, error, headers }
-    } else {
-        let data
-        try {
-            if (isJsonBody(response)) {
-                data = await response.json()
-                reply = { status, data, headers }
-            } else {
-                reply = { status, headers }
-            }
-        } catch (error) {
-            if (options.logErrors) {
-                console.error(moduleName, error)
-            }
-            reply = { status, error, headers }
-        }
-    }
-    if (options.debug?.jsonReply) {
-        console.log(moduleName, { reply })
-    }
-    return reply
-}

package/types/index.d.ts

@@ -1,64 +0,0 @@
-export type DebuggingFlags = {
-    baseQuery?: boolean,
-    encodeBody?: boolean,
-    accessToken?: boolean,
-    jsonReply?: boolean,
-    commonReply?: boolean
-};
-
-export type FetchOptions = {
-    logErrors?: boolean,
-    url?: URL | string,
-    request?: Request,
-    timeout?: number,
-    method?: string,
-    headers?: Headers | object,
-    body?: string
-        | object
-        | FormData
-        | Blob
-        | ArrayBuffer
-        | DataView
-        | File
-        | ReadableStream
-        | Int8Array
-        | Uint8Array
-        | Int16Array
-        | Uint16Array
-        | Int32Array
-        | Uint32Array
-        | BigInt64Array
-        | BigUint64Array
-        | URLSearchParams,
-    mode?: string,
-    credentials?: string,
-    cache?: string,
-    redirect?: string,
-    referrer?: string,
-    referrerPolicy?: string,
-    integrity?: string,
-    keepalive?: boolean,
-    signal?: AbortSignal,
-    debug?: DebuggingFlags
-};
-
-export type baseQueryFn = (options?: FetchOptions) => Promise<Response>;
-export type queryFn = (options?: FetchOptions) => Promise<any>;
-export type middlewareFn = (settings: any) => (query: queryFn) => queryFn;
-
-export type FetchBaseQueryOptions = {
-    baseUrl?: URL | string,
-    baseQuery?: baseQueryFn,
-    middlewares?: Array<middlewareFn>
-};
-
-export const baseQuery: baseQueryFn;
-
-export const encodeBody: middlewareFn;
-export const accessToken: middlewareFn;
-export const jsonReply: middlewareFn;
-export const commonReply: middlewareFn;
-
-declare function fetchBaseQuery(options?: FetchBaseQueryOptions & FetchOptions): queryFn;
-
-export default fetchBaseQuery;