@alwatr/fetch 2.2.1 → 3.1.0

package/fetch.js

@@ -1,293 +0,0 @@
-import { createLogger, definePackage, NODE_MODE, globalScope } from '@alwatr/logger';
-import { getClientId, delay } from '@alwatr/util';
-const logger = createLogger('alwatr/fetch');
-definePackage('fetch', '2.x');
-let alwatrCacheStorage;
-const cacheSupported = 'caches' in globalScope;
-const duplicateRequestStorage = {};
-/**
- * Fetch from alwatr services and return standard response.
- */
-export async function serviceRequest(options) {
-    logger.logMethodArgs?.('serviceRequest', { url: options.url });
-    if (!NODE_MODE) {
-        options.headers ?? (options.headers = {});
-        if (!options.headers['client-id']) {
-            options.headers['client-id'] = getClientId();
-        }
-    }
-    let response;
-    try {
-        response = await fetch(options);
-    }
-    catch (err) {
-        const errMessage = err.message;
-        if (errMessage !== 'fetch_cache_not_found') {
-            logger.error('serviceRequest', err.message || 'fetch_failed', err, options);
-        }
-        throw err;
-    }
-    let responseText;
-    try {
-        responseText = await response.text();
-    }
-    catch (err) {
-        logger.error('serviceRequest', 'invalid_response', err, {
-            response,
-        });
-        throw err;
-    }
-    let responseJson;
-    try {
-        responseJson = JSON.parse(responseText);
-    }
-    catch (err) {
-        logger.error('serviceRequest', 'invalid_json', err, { responseText });
-        throw err;
-    }
-    if (responseJson.ok !== true) {
-        if (typeof responseJson.errorCode === 'string') {
-            logger.accident('serviceRequest', responseJson.errorCode, { responseJson });
-            throw new Error(responseJson.errorCode);
-        }
-        else {
-            logger.error('serviceRequest', 'fetch_nok', { responseJson });
-            throw new Error('fetch_nok');
-        }
-    }
-    // TODO: generate fetch signals hook (for easier handle loading and show error toast)
-    return responseJson;
-}
-/**
- * It's a wrapper around the browser's `fetch` function that adds retry pattern, timeout, cacheStrategy,
- * remove duplicates, etc.
- *
- * Example:
- *
- * ```ts
- * const response = await fetch({
- *   url: '/api/products',
- *   queryParameters: {limit: 10},
- *   timeout: 10_000,
- *   retry: 3,
- *   cacheStrategy: 'stale_while_revalidate',
- *   cacheDuplicate: 'auto',
- * });
- * ```
- */
-export function fetch(options) {
-    options = _processOptions(options);
-    logger.logMethodArgs?.('fetch', { options });
-    return _handleCacheStrategy(options);
-}
-/**
- * Process fetch options and set defaults, etc.
- */
-function _processOptions(options) {
-    options.method ?? (options.method = 'GET');
-    options.window ?? (options.window = null);
-    options.timeout ?? (options.timeout = 10000);
-    options.retry ?? (options.retry = 3);
-    options.retryDelay ?? (options.retryDelay = 1000);
-    options.cacheStrategy ?? (options.cacheStrategy = 'network_only');
-    options.removeDuplicate ?? (options.removeDuplicate = 'never');
-    options.headers ?? (options.headers = {});
-    if (options.cacheStrategy !== 'network_only' && cacheSupported !== true) {
-        logger.incident?.('fetch', 'fetch_cache_strategy_unsupported', {
-            cacheSupported,
-        });
-        options.cacheStrategy = 'network_only';
-    }
-    if (options.removeDuplicate === 'auto') {
-        options.removeDuplicate = cacheSupported ? 'until_load' : 'always';
-    }
-    if (options.url.lastIndexOf('?') === -1 && options.queryParameters != null) {
-        const queryParameters = options.queryParameters;
-        // prettier-ignore
-        const queryArray = Object
-            .keys(queryParameters)
-            .map((key) => `${key}=${String(queryParameters[key])}`);
-        if (queryArray.length > 0) {
-            options.url += '?' + queryArray.join('&');
-        }
-    }
-    if (options.bodyJson != null) {
-        options.body = JSON.stringify(options.bodyJson);
-        options.headers['Content-Type'] = 'application/json';
-    }
-    if (options.token != null) {
-        options.headers.Authorization = `Bearer ${options.token}`;
-    }
-    if (options.userAuth != null) {
-        options.headers.Authorization = `Bearer ${options.userAuth.id}/${options.userAuth.token}`;
-    }
-    return options;
-}
-/**
- * Handle Cache Strategy over `_handleRemoveDuplicate`.
- */
-async function _handleCacheStrategy(options) {
-    if (options.cacheStrategy === 'network_only') {
-        return _handleRemoveDuplicate(options);
-    }
-    // else handle cache strategies!
-    logger.logMethod?.('_handleCacheStrategy');
-    if (alwatrCacheStorage == null && options.cacheStorageName == null) {
-        alwatrCacheStorage = await caches.open('alwatr_fetch_cache');
-    }
-    const cacheStorage = options.cacheStorageName != null ? await caches.open(options.cacheStorageName) : alwatrCacheStorage;
-    const request = new Request(options.url, options);
-    switch (options.cacheStrategy) {
-        case 'cache_first': {
-            const cachedResponse = await cacheStorage.match(request);
-            if (cachedResponse != null) {
-                return cachedResponse;
-            }
-            // else
-            const response = await _handleRemoveDuplicate(options);
-            if (response.ok) {
-                cacheStorage.put(request, response.clone());
-            }
-            return response;
-        }
-        case 'cache_only': {
-            const cachedResponse = await cacheStorage.match(request);
-            if (cachedResponse == null) {
-                logger.accident('_handleCacheStrategy', 'fetch_cache_not_found', { url: request.url });
-                throw new Error('fetch_cache_not_found');
-            }
-            // else
-            return cachedResponse;
-        }
-        case 'network_first': {
-            try {
-                const networkResponse = await _handleRemoveDuplicate(options);
-                if (networkResponse.ok) {
-                    cacheStorage.put(request, networkResponse.clone());
-                }
-                return networkResponse;
-            }
-            catch (err) {
-                const cachedResponse = await cacheStorage.match(request);
-                if (cachedResponse != null) {
-                    return cachedResponse;
-                }
-                // else
-                throw err;
-            }
-        }
-        case 'update_cache': {
-            const networkResponse = await _handleRemoveDuplicate(options);
-            if (networkResponse.ok) {
-                cacheStorage.put(request, networkResponse.clone());
-            }
-            return networkResponse;
-        }
-        case 'stale_while_revalidate': {
-            const cachedResponse = await cacheStorage.match(request);
-            const fetchedResponsePromise = _handleRemoveDuplicate(options).then((networkResponse) => {
-                if (networkResponse.ok) {
-                    cacheStorage.put(request, networkResponse.clone());
-                    if (typeof options.revalidateCallback === 'function') {
-                        setTimeout(options.revalidateCallback, 0, networkResponse.clone());
-                    }
-                }
-                return networkResponse;
-            });
-            return cachedResponse ?? fetchedResponsePromise;
-        }
-        default: {
-            return _handleRemoveDuplicate(options);
-        }
-    }
-}
-/**
- * Handle Remove Duplicates over `_handleRetryPattern`.
- */
-async function _handleRemoveDuplicate(options) {
-    if (options.removeDuplicate === 'never')
-        return _handleRetryPattern(options);
-    logger.logMethod?.('_handleRemoveDuplicate');
-    const cacheKey = options.method + ' ' + options.url;
-    // We must cache fetch promise without await for handle other parallel requests.
-    duplicateRequestStorage[cacheKey] ?? (duplicateRequestStorage[cacheKey] = _handleRetryPattern(options));
-    try {
-        // For all requests need to await for clone responses.
-        const response = await duplicateRequestStorage[cacheKey];
-        if (duplicateRequestStorage[cacheKey] != null) {
-            if (response.ok !== true || options.removeDuplicate === 'until_load') {
-                delete duplicateRequestStorage[cacheKey];
-            }
-        }
-        return response.clone();
-    }
-    catch (err) {
-        // clean cache on any error.
-        delete duplicateRequestStorage[cacheKey];
-        throw err;
-    }
-}
-/**
- * Handle retry pattern over `_handleTimeout`.
- */
-async function _handleRetryPattern(options) {
-    if (!(options.retry > 1))
-        return _handleTimeout(options);
-    logger.logMethod?.('_handleRetryPattern');
-    options.retry--;
-    const externalAbortSignal = options.signal;
-    try {
-        const response = await _handleTimeout(options);
-        if (response.status < 500) {
-            return response;
-        }
-        // else
-        throw new Error('fetch_server_error');
-    }
-    catch (err) {
-        logger.accident('fetch', 'fetch_failed_retry', err);
-        if (globalScope.navigator?.onLine === false) {
-            throw new Error('offline');
-        }
-        await delay(options.retryDelay);
-        options.signal = externalAbortSignal;
-        return _handleRetryPattern(options);
-    }
-}
-/**
- * It's a wrapper around the browser's `fetch` with timeout.
- */
-function _handleTimeout(options) {
-    if (options.timeout === 0) {
-        return globalScope.fetch(options.url, options);
-    }
-    // else
-    logger.logMethod?.('_handleTimeout');
-    return new Promise((resolved, reject) => {
-        const abortController = typeof globalScope.AbortController === 'function' ? new AbortController() : null;
-        const externalAbortSignal = options.signal;
-        options.signal = abortController?.signal;
-        if (abortController !== null && externalAbortSignal != null) {
-            // Respect external abort signal
-            externalAbortSignal.addEventListener('abort', () => abortController.abort(), { once: true });
-        }
-        const timeoutId = setTimeout(() => {
-            reject(new Error('fetch_timeout'));
-            abortController?.abort('fetch_timeout');
-        }, options.timeout);
-        // abortController.signal.addEventListener('abort', () => {
-        //   logger.incident('fetch', 'fetch_abort_signal', {
-        //     reason: abortController.signal.reason,
-        //   });
-        // });
-        globalScope
-            .fetch(options.url, options)
-            .then((response) => resolved(response))
-            .catch((reason) => reject(reason))
-            .finally(() => {
-            delete options.signal; // try to avoid memory leak in nodejs!
-            clearTimeout(timeoutId);
-        });
-    });
-}
-//# sourceMappingURL=fetch.js.map

package/fetch.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"fetch.js","sourceRoot":"","sources":["src/fetch.ts"],"names":[],"mappings":"AAAA,OAAO,EAAC,YAAY,EAAE,aAAa,EAAE,SAAS,EAAE,WAAW,EAAC,MAAM,gBAAgB,CAAC;AACnF,OAAO,EAAC,WAAW,EAAE,KAAK,EAAC,MAAM,cAAc,CAAC;AAOhD,MAAM,MAAM,GAAG,YAAY,CAAC,cAAc,CAAC,CAAC;AAE5C,aAAa,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC;AAE9B,IAAI,kBAAyB,CAAC;AAC9B,MAAM,cAAc,GAAG,QAAQ,IAAI,WAAW,CAAC;AAE/C,MAAM,uBAAuB,GAAsC,EAAE,CAAC;AAEtE;;GAEG;AACH,MAAM,CAAC,KAAK,UAAU,cAAc,CAClC,OAAqB;IAErB,MAAM,CAAC,aAAa,EAAE,CAAC,gBAAgB,EAAE,EAAC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAC,CAAC,CAAC;IAE7D,IAAI,CAAC,SAAS,EAAE,CAAC;QACf,OAAO,CAAC,OAAO,KAAf,OAAO,CAAC,OAAO,GAAK,EAAE,EAAC;QACvB,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,EAAE,CAAC;YAClC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,GAAG,WAAW,EAAE,CAAC;QAC/C,CAAC;IACH,CAAC;IAED,IAAI,QAAkB,CAAC;IACvB,IAAI,CAAC;QACH,QAAQ,GAAG,MAAM,KAAK,CAAC,OAAO,CAAC,CAAC;IAClC,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,UAAU,GAAI,GAAa,CAAC,OAAO,CAAC;QAC1C,IAAI,UAAU,KAAK,uBAAuB,EAAE,CAAC;YAC3C,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAG,GAAa,CAAC,OAAO,IAAI,cAAc,EAAE,GAAG,EAAE,OAAO,CAAC,CAAC;QACzF,CAAC;QACD,MAAM,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,YAAoB,CAAC;IACzB,IAAI,CAAC;QACH,YAAY,GAAG,MAAM,QAAQ,CAAC,IAAI,EAAE,CAAC;IACvC,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,kBAAkB,EAAE,GAAG,EAAE;YACtD,QAAQ;SACT,CAAC,CAAC;QACH,MAAM,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,YAAe,CAAC;IACpB,IAAI,CAAC;QACH,YAAY,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,CAAC;IAC1C,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,cAAc,EAAE,GAAG,EAAE,EAAC,YAAY,EAAC,CAAC,CAAC;QACpE,MAAM,GAAG,CAAC;IACZ,CAAC;IAED,IAAI,YAAY,CAAC,EAAE,KAAK,IAAI,EAAE,CAAC;QAC7B,IAAI,OAAO,YAAY,CAAC,SAAS,KAAK,QAAQ,EAAE,CAAC;YAC/C,MAAM,CAAC,QAAQ,CAAC,gBAAgB,EAAE,YAAY,CAAC,SAAS,EAAE,EAAC,YAAY,EAAC,CAAC,CAAC;YAC1E,MAAM,IAAI,KAAK,CAAC,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1C,CAAC;aACI,CAAC;YACJ,MAAM,CAAC,KAAK,CAAC,gBAAgB,EAAE,WAAW,EAAE,EAAC,YAAY,EAAC,CAAC,CAAC;YAC5D,MAAM,IAAI,KAAK,CAAC,WAAW,CAAC,CAAC;QAC/B,CAAC;IACH,CAAC;IAED,qFAAqF;IAErF,OAAO,YAAY,CAAC;AACtB,CAAC;AAED;;;;;;;;;;;;;;;;GAgBG;AACH,MAAM,UAAU,KAAK,CAAC,OAAqB;IACzC,OAAO,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;IACnC,MAAM,CAAC,aAAa,EAAE,CAAC,OAAO,EAAE,EAAC,OAAO,EAAC,CAAC,CAAC;IAC3C,OAAO,oBAAoB,CAAC,OAAiC,CAAC,CAAC;AACjE,CAAC;AAED;;GAEG;AACH,SAAS,eAAe,CAAC,OAAqB;IAC5C,OAAO,CAAC,MAAM,KAAd,OAAO,CAAC,MAAM,GAAK,KAAK,EAAC;IACzB,OAAO,CAAC,MAAM,KAAd,OAAO,CAAC,MAAM,GAAK,IAAI,EAAC;IAExB,OAAO,CAAC,OAAO,KAAf,OAAO,CAAC,OAAO,GAAK,KAAM,EAAC;IAC3B,OAAO,CAAC,KAAK,KAAb,OAAO,CAAC,KAAK,GAAK,CAAC,EAAC;IACpB,OAAO,CAAC,UAAU,KAAlB,OAAO,CAAC,UAAU,GAAK,IAAK,EAAC;IAC7B,OAAO,CAAC,aAAa,KAArB,OAAO,CAAC,aAAa,GAAK,cAAc,EAAC;IACzC,OAAO,CAAC,eAAe,KAAvB,OAAO,CAAC,eAAe,GAAK,OAAO,EAAC;IACpC,OAAO,CAAC,OAAO,KAAf,OAAO,CAAC,OAAO,GAAK,EAAE,EAAC;IAEvB,IAAI,OAAO,CAAC,aAAa,KAAK,cAAc,IAAI,cAAc,KAAK,IAAI,EAAE,CAAC;QACxE,MAAM,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,kCAAkC,EAAE;YAC7D,cAAc;SACf,CAAC,CAAC;QACH,OAAO,CAAC,aAAa,GAAG,cAAc,CAAC;IACzC,CAAC;IAED,IAAI,OAAO,CAAC,eAAe,KAAK,MAAM,EAAE,CAAC;QACvC,OAAO,CAAC,eAAe,GAAG,cAAc,CAAC,CAAC,CAAC,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC;IACrE,CAAC;IAED,IAAI,OAAO,CAAC,GAAG,CAAC,WAAW,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,IAAI,OAAO,CAAC,eAAe,IAAI,IAAI,EAAE,CAAC;QAC3E,MAAM,eAAe,GAAG,OAAO,CAAC,eAAe,CAAC;QAChD,kBAAkB;QAClB,MAAM,UAAU,GAAG,MAAM;aACtB,IAAI,CAAC,eAAe,CAAC;aACrB,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,GAAG,IAAI,MAAM,CAAC,eAAe,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC;QAE1D,IAAI,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YAC1B,OAAO,CAAC,GAAG,IAAI,GAAG,GAAG,UAAU,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;QAC5C,CAAC;IACH,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC7B,OAAO,CAAC,IAAI,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;QAChD,OAAO,CAAC,OAAO,CAAC,cAAc,CAAC,GAAG,kBAAkB,CAAC;IACvD,CAAC;IAED,IAAI,OAAO,CAAC,KAAK,IAAI,IAAI,EAAE,CAAC;QAC1B,OAAO,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,CAAC,KAAK,EAAE,CAAC;IAC5D,CAAC;IAED,IAAI,OAAO,CAAC,QAAQ,IAAI,IAAI,EAAE,CAAC;QAC7B,OAAO,CAAC,OAAO,CAAC,aAAa,GAAG,UAAU,OAAO,CAAC,QAAQ,CAAC,EAAE,IAAI,OAAO,CAAC,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC5F,CAAC;IAED,OAAO,OAAiC,CAAC;AAC3C,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,oBAAoB,CAAC,OAA+B;IACjE,IAAI,OAAO,CAAC,aAAa,KAAK,cAAc,EAAE,CAAC;QAC7C,OAAO,sBAAsB,CAAC,OAAO,CAAC,CAAC;IACzC,CAAC;IACD,gCAAgC;IAChC,MAAM,CAAC,SAAS,EAAE,CAAC,sBAAsB,CAAC,CAAC;IAE3C,IAAI,kBAAkB,IAAI,IAAI,IAAI,OAAO,CAAC,gBAAgB,IAAI,IAAI,EAAE,CAAC;QACnE,kBAAkB,GAAG,MAAM,MAAM,CAAC,IAAI,CAAC,oBAAoB,CAAC,CAAC;IAC/D,CAAC;IAED,MAAM,YAAY,GAChB,OAAO,CAAC,gBAAgB,IAAI,IAAI,CAAC,CAAC,CAAC,MAAM,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC;IAEtG,MAAM,OAAO,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IAElD,QAAQ,OAAO,CAAC,aAAa,EAAE,CAAC;QAC9B,KAAK,aAAa,CAAC,CAAC,CAAC;YACnB,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzD,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;gBAC3B,OAAO,cAAc,CAAC;YACxB,CAAC;YACD,OAAO;YACP,MAAM,QAAQ,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;YACvD,IAAI,QAAQ,CAAC,EAAE,EAAE,CAAC;gBAChB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,KAAK,EAAE,CAAC,CAAC;YAC9C,CAAC;YACD,OAAO,QAAQ,CAAC;QAClB,CAAC;QAED,KAAK,YAAY,CAAC,CAAC,CAAC;YAClB,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzD,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;gBAC3B,MAAM,CAAC,QAAQ,CAAC,sBAAsB,EAAE,uBAAuB,EAAE,EAAC,GAAG,EAAE,OAAO,CAAC,GAAG,EAAC,CAAC,CAAC;gBACrF,MAAM,IAAI,KAAK,CAAC,uBAAuB,CAAC,CAAC;YAC3C,CAAC;YACD,OAAO;YACP,OAAO,cAAc,CAAC;QACxB,CAAC;QAED,KAAK,eAAe,CAAC,CAAC,CAAC;YACrB,IAAI,CAAC;gBACH,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;gBAC9D,IAAI,eAAe,CAAC,EAAE,EAAE,CAAC;oBACvB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC;gBACrD,CAAC;gBACD,OAAO,eAAe,CAAC;YACzB,CAAC;YACD,OAAO,GAAG,EAAE,CAAC;gBACX,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;gBACzD,IAAI,cAAc,IAAI,IAAI,EAAE,CAAC;oBAC3B,OAAO,cAAc,CAAC;gBACxB,CAAC;gBACD,OAAO;gBACP,MAAM,GAAG,CAAC;YACZ,CAAC;QACH,CAAC;QAED,KAAK,cAAc,CAAC,CAAC,CAAC;YACpB,MAAM,eAAe,GAAG,MAAM,sBAAsB,CAAC,OAAO,CAAC,CAAC;YAC9D,IAAI,eAAe,CAAC,EAAE,EAAE,CAAC;gBACvB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC;YACrD,CAAC;YACD,OAAO,eAAe,CAAC;QACzB,CAAC;QAED,KAAK,wBAAwB,CAAC,CAAC,CAAC;YAC9B,MAAM,cAAc,GAAG,MAAM,YAAY,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC;YACzD,MAAM,sBAAsB,GAAG,sBAAsB,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,eAAe,EAAE,EAAE;gBACtF,IAAI,eAAe,CAAC,EAAE,EAAE,CAAC;oBACvB,YAAY,CAAC,GAAG,CAAC,OAAO,EAAE,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC;oBACnD,IAAI,OAAO,OAAO,CAAC,kBAAkB,KAAK,UAAU,EAAE,CAAC;wBACrD,UAAU,CAAC,OAAO,CAAC,kBAAkB,EAAE,CAAC,EAAE,eAAe,CAAC,KAAK,EAAE,CAAC,CAAC;oBACrE,CAAC;gBACH,CAAC;gBACD,OAAO,eAAe,CAAC;YACzB,CAAC,CAAC,CAAC;YAEH,OAAO,cAAc,IAAI,sBAAsB,CAAC;QAClD,CAAC;QAED,OAAO,CAAC,CAAC,CAAC;YACR,OAAO,sBAAsB,CAAC,OAAO,CAAC,CAAC;QACzC,CAAC;IACH,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,sBAAsB,CAAC,OAA+B;IACnE,IAAI,OAAO,CAAC,eAAe,KAAK,OAAO;QAAE,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;IAE7E,MAAM,CAAC,SAAS,EAAE,CAAC,wBAAwB,CAAC,CAAC;IAE7C,MAAM,QAAQ,GAAG,OAAO,CAAC,MAAM,GAAG,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC;IAEpD,gFAAgF;IAChF,uBAAuB,CAAC,QAAQ,MAAhC,uBAAuB,CAAC,QAAQ,IAAM,mBAAmB,CAAC,OAAO,CAAC,EAAC;IAEnE,IAAI,CAAC;QACH,sDAAsD;QACtD,MAAM,QAAQ,GAAG,MAAM,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QAEzD,IAAI,uBAAuB,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC;YAC9C,IAAI,QAAQ,CAAC,EAAE,KAAK,IAAI,IAAI,OAAO,CAAC,eAAe,KAAK,YAAY,EAAE,CAAC;gBACrE,OAAO,uBAAuB,CAAC,QAAQ,CAAC,CAAC;YAC3C,CAAC;QACH,CAAC;QAED,OAAO,QAAQ,CAAC,KAAK,EAAE,CAAC;IAC1B,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,4BAA4B;QAC5B,OAAO,uBAAuB,CAAC,QAAQ,CAAC,CAAC;QACzC,MAAM,GAAG,CAAC;IACZ,CAAC;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,mBAAmB,CAAC,OAA+B;IAChE,IAAI,CAAC,CAAC,OAAO,CAAC,KAAK,GAAG,CAAC,CAAC;QAAE,OAAO,cAAc,CAAC,OAAO,CAAC,CAAC;IAEzD,MAAM,CAAC,SAAS,EAAE,CAAC,qBAAqB,CAAC,CAAC;IAC1C,OAAO,CAAC,KAAK,EAAE,CAAC;IAEhB,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;IAE3C,IAAI,CAAC;QACH,MAAM,QAAQ,GAAG,MAAM,cAAc,CAAC,OAAO,CAAC,CAAC;QAE/C,IAAI,QAAQ,CAAC,MAAM,GAAG,GAAG,EAAE,CAAC;YAC1B,OAAO,QAAQ,CAAC;QAClB,CAAC;QACD,OAAO;QACP,MAAM,IAAI,KAAK,CAAC,oBAAoB,CAAC,CAAC;IACxC,CAAC;IACD,OAAO,GAAG,EAAE,CAAC;QACX,MAAM,CAAC,QAAQ,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,CAAC,CAAC;QAEpD,IAAI,WAAW,CAAC,SAAS,EAAE,MAAM,KAAK,KAAK,EAAE,CAAC;YAC5C,MAAM,IAAI,KAAK,CAAC,SAAS,CAAC,CAAC;QAC7B,CAAC;QAED,MAAM,KAAK,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC;QAEhC,OAAO,CAAC,MAAM,GAAG,mBAAmB,CAAC;QACrC,OAAO,mBAAmB,CAAC,OAAO,CAAC,CAAC;IACtC,CAAC;AACH,CAAC;AAED;;GAEG;AACH,SAAS,cAAc,CAAC,OAAqB;IAC3C,IAAI,OAAO,CAAC,OAAO,KAAK,CAAC,EAAE,CAAC;QAC1B,OAAO,WAAW,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC,CAAC;IACjD,CAAC;IACD,OAAO;IACP,MAAM,CAAC,SAAS,EAAE,CAAC,gBAAgB,CAAC,CAAC;IACrC,OAAO,IAAI,OAAO,CAAC,CAAC,QAAQ,EAAE,MAAM,EAAE,EAAE;QACtC,MAAM,eAAe,GAAG,OAAO,WAAW,CAAC,eAAe,KAAK,UAAU,CAAC,CAAC,CAAC,IAAI,eAAe,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;QACzG,MAAM,mBAAmB,GAAG,OAAO,CAAC,MAAM,CAAC;QAC3C,OAAO,CAAC,MAAM,GAAG,eAAe,EAAE,MAAM,CAAC;QAEzC,IAAI,eAAe,KAAK,IAAI,IAAI,mBAAmB,IAAI,IAAI,EAAE,CAAC;YAC5D,gCAAgC;YAChC,mBAAmB,CAAC,gBAAgB,CAAC,OAAO,EAAE,GAAG,EAAE,CAAC,eAAe,CAAC,KAAK,EAAE,EAAE,EAAC,IAAI,EAAE,IAAI,EAAC,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,SAAS,GAAG,UAAU,CAAC,GAAG,EAAE;YAChC,MAAM,CAAC,IAAI,KAAK,CAAC,eAAe,CAAC,CAAC,CAAC;YACnC,eAAe,EAAE,KAAK,CAAC,eAAe,CAAC,CAAC;QAC1C,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC;QAEpB,2DAA2D;QAC3D,qDAAqD;QACrD,6CAA6C;QAC7C,QAAQ;QACR,MAAM;QAEN,WAAW;aACR,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,OAAO,CAAC;aAC3B,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;aACtC,KAAK,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;aACjC,OAAO,CAAC,GAAG,EAAE;YACZ,OAAO,OAAO,CAAC,MAAM,CAAC,CAAC,sCAAsC;YAC7D,YAAY,CAAC,SAAS,CAAC,CAAC;QAC1B,CAAC,CAAC,CAAC;IACP,CAAC,CAAC,CAAC;AACL,CAAC","sourcesContent":["import {createLogger, definePackage, NODE_MODE, globalScope} from '@alwatr/logger';\nimport {getClientId, delay} from '@alwatr/util';\n\nimport type {FetchOptions} from './type.js';\nimport type {AlwatrServiceResponse} from '@alwatr/type';\n\nexport type * from './type.js';\n\nconst logger = createLogger('alwatr/fetch');\n\ndefinePackage('fetch', '2.x');\n\nlet alwatrCacheStorage: Cache;\nconst cacheSupported = 'caches' in globalScope;\n\nconst duplicateRequestStorage: Record<string, Promise<Response>> = {};\n\n/**\n * Fetch from alwatr services and return standard response.\n */\nexport async function serviceRequest<T extends AlwatrServiceResponse = AlwatrServiceResponse>(\n  options: FetchOptions,\n): Promise<T> {\n  logger.logMethodArgs?.('serviceRequest', {url: options.url});\n\n  if (!NODE_MODE) {\n    options.headers ??= {};\n    if (!options.headers['client-id']) {\n      options.headers['client-id'] = getClientId();\n    }\n  }\n\n  let response: Response;\n  try {\n    response = await fetch(options);\n  }\n  catch (err) {\n    const errMessage = (err as Error).message;\n    if (errMessage !== 'fetch_cache_not_found') {\n      logger.error('serviceRequest', (err as Error).message || 'fetch_failed', err, options);\n    }\n    throw err;\n  }\n\n  let responseText: string;\n  try {\n    responseText = await response.text();\n  }\n  catch (err) {\n    logger.error('serviceRequest', 'invalid_response', err, {\n      response,\n    });\n    throw err;\n  }\n\n  let responseJson: T;\n  try {\n    responseJson = JSON.parse(responseText);\n  }\n  catch (err) {\n    logger.error('serviceRequest', 'invalid_json', err, {responseText});\n    throw err;\n  }\n\n  if (responseJson.ok !== true) {\n    if (typeof responseJson.errorCode === 'string') {\n      logger.accident('serviceRequest', responseJson.errorCode, {responseJson});\n      throw new Error(responseJson.errorCode);\n    }\n    else {\n      logger.error('serviceRequest', 'fetch_nok', {responseJson});\n      throw new Error('fetch_nok');\n    }\n  }\n\n  // TODO: generate fetch signals hook (for easier handle loading and show error toast)\n\n  return responseJson;\n}\n\n/**\n * It's a wrapper around the browser's `fetch` function that adds retry pattern, timeout, cacheStrategy,\n * remove duplicates, etc.\n *\n * Example:\n *\n * ```ts\n * const response = await fetch({\n *   url: '/api/products',\n *   queryParameters: {limit: 10},\n *   timeout: 10_000,\n *   retry: 3,\n *   cacheStrategy: 'stale_while_revalidate',\n *   cacheDuplicate: 'auto',\n * });\n * ```\n */\nexport function fetch(options: FetchOptions): Promise<Response> {\n  options = _processOptions(options);\n  logger.logMethodArgs?.('fetch', {options});\n  return _handleCacheStrategy(options as Required<FetchOptions>);\n}\n\n/**\n * Process fetch options and set defaults, etc.\n */\nfunction _processOptions(options: FetchOptions): Required<FetchOptions> {\n  options.method ??= 'GET';\n  options.window ??= null;\n\n  options.timeout ??= 10_000;\n  options.retry ??= 3;\n  options.retryDelay ??= 1_000;\n  options.cacheStrategy ??= 'network_only';\n  options.removeDuplicate ??= 'never';\n  options.headers ??= {};\n\n  if (options.cacheStrategy !== 'network_only' && cacheSupported !== true) {\n    logger.incident?.('fetch', 'fetch_cache_strategy_unsupported', {\n      cacheSupported,\n    });\n    options.cacheStrategy = 'network_only';\n  }\n\n  if (options.removeDuplicate === 'auto') {\n    options.removeDuplicate = cacheSupported ? 'until_load' : 'always';\n  }\n\n  if (options.url.lastIndexOf('?') === -1 && options.queryParameters != null) {\n    const queryParameters = options.queryParameters;\n    // prettier-ignore\n    const queryArray = Object\n      .keys(queryParameters)\n      .map((key) => `${key}=${String(queryParameters[key])}`);\n\n    if (queryArray.length > 0) {\n      options.url += '?' + queryArray.join('&');\n    }\n  }\n\n  if (options.bodyJson != null) {\n    options.body = JSON.stringify(options.bodyJson);\n    options.headers['Content-Type'] = 'application/json';\n  }\n\n  if (options.token != null) {\n    options.headers.Authorization = `Bearer ${options.token}`;\n  }\n\n  if (options.userAuth != null) {\n    options.headers.Authorization = `Bearer ${options.userAuth.id}/${options.userAuth.token}`;\n  }\n\n  return options as Required<FetchOptions>;\n}\n\n/**\n * Handle Cache Strategy over `_handleRemoveDuplicate`.\n */\nasync function _handleCacheStrategy(options: Required<FetchOptions>): Promise<Response> {\n  if (options.cacheStrategy === 'network_only') {\n    return _handleRemoveDuplicate(options);\n  }\n  // else handle cache strategies!\n  logger.logMethod?.('_handleCacheStrategy');\n\n  if (alwatrCacheStorage == null && options.cacheStorageName == null) {\n    alwatrCacheStorage = await caches.open('alwatr_fetch_cache');\n  }\n\n  const cacheStorage =\n    options.cacheStorageName != null ? await caches.open(options.cacheStorageName) : alwatrCacheStorage;\n\n  const request = new Request(options.url, options);\n\n  switch (options.cacheStrategy) {\n    case 'cache_first': {\n      const cachedResponse = await cacheStorage.match(request);\n      if (cachedResponse != null) {\n        return cachedResponse;\n      }\n      // else\n      const response = await _handleRemoveDuplicate(options);\n      if (response.ok) {\n        cacheStorage.put(request, response.clone());\n      }\n      return response;\n    }\n\n    case 'cache_only': {\n      const cachedResponse = await cacheStorage.match(request);\n      if (cachedResponse == null) {\n        logger.accident('_handleCacheStrategy', 'fetch_cache_not_found', {url: request.url});\n        throw new Error('fetch_cache_not_found');\n      }\n      // else\n      return cachedResponse;\n    }\n\n    case 'network_first': {\n      try {\n        const networkResponse = await _handleRemoveDuplicate(options);\n        if (networkResponse.ok) {\n          cacheStorage.put(request, networkResponse.clone());\n        }\n        return networkResponse;\n      }\n      catch (err) {\n        const cachedResponse = await cacheStorage.match(request);\n        if (cachedResponse != null) {\n          return cachedResponse;\n        }\n        // else\n        throw err;\n      }\n    }\n\n    case 'update_cache': {\n      const networkResponse = await _handleRemoveDuplicate(options);\n      if (networkResponse.ok) {\n        cacheStorage.put(request, networkResponse.clone());\n      }\n      return networkResponse;\n    }\n\n    case 'stale_while_revalidate': {\n      const cachedResponse = await cacheStorage.match(request);\n      const fetchedResponsePromise = _handleRemoveDuplicate(options).then((networkResponse) => {\n        if (networkResponse.ok) {\n          cacheStorage.put(request, networkResponse.clone());\n          if (typeof options.revalidateCallback === 'function') {\n            setTimeout(options.revalidateCallback, 0, networkResponse.clone());\n          }\n        }\n        return networkResponse;\n      });\n\n      return cachedResponse ?? fetchedResponsePromise;\n    }\n\n    default: {\n      return _handleRemoveDuplicate(options);\n    }\n  }\n}\n\n/**\n * Handle Remove Duplicates over `_handleRetryPattern`.\n */\nasync function _handleRemoveDuplicate(options: Required<FetchOptions>): Promise<Response> {\n  if (options.removeDuplicate === 'never') return _handleRetryPattern(options);\n\n  logger.logMethod?.('_handleRemoveDuplicate');\n\n  const cacheKey = options.method + ' ' + options.url;\n\n  // We must cache fetch promise without await for handle other parallel requests.\n  duplicateRequestStorage[cacheKey] ??= _handleRetryPattern(options);\n\n  try {\n    // For all requests need to await for clone responses.\n    const response = await duplicateRequestStorage[cacheKey];\n\n    if (duplicateRequestStorage[cacheKey] != null) {\n      if (response.ok !== true || options.removeDuplicate === 'until_load') {\n        delete duplicateRequestStorage[cacheKey];\n      }\n    }\n\n    return response.clone();\n  }\n  catch (err) {\n    // clean cache on any error.\n    delete duplicateRequestStorage[cacheKey];\n    throw err;\n  }\n}\n\n/**\n * Handle retry pattern over `_handleTimeout`.\n */\nasync function _handleRetryPattern(options: Required<FetchOptions>): Promise<Response> {\n  if (!(options.retry > 1)) return _handleTimeout(options);\n\n  logger.logMethod?.('_handleRetryPattern');\n  options.retry--;\n\n  const externalAbortSignal = options.signal;\n\n  try {\n    const response = await _handleTimeout(options);\n\n    if (response.status < 500) {\n      return response;\n    }\n    // else\n    throw new Error('fetch_server_error');\n  }\n  catch (err) {\n    logger.accident('fetch', 'fetch_failed_retry', err);\n\n    if (globalScope.navigator?.onLine === false) {\n      throw new Error('offline');\n    }\n\n    await delay(options.retryDelay);\n\n    options.signal = externalAbortSignal;\n    return _handleRetryPattern(options);\n  }\n}\n\n/**\n * It's a wrapper around the browser's `fetch` with timeout.\n */\nfunction _handleTimeout(options: FetchOptions): Promise<Response> {\n  if (options.timeout === 0) {\n    return globalScope.fetch(options.url, options);\n  }\n  // else\n  logger.logMethod?.('_handleTimeout');\n  return new Promise((resolved, reject) => {\n    const abortController = typeof globalScope.AbortController === 'function' ? new AbortController() : null;\n    const externalAbortSignal = options.signal;\n    options.signal = abortController?.signal;\n\n    if (abortController !== null && externalAbortSignal != null) {\n      // Respect external abort signal\n      externalAbortSignal.addEventListener('abort', () => abortController.abort(), {once: true});\n    }\n\n    const timeoutId = setTimeout(() => {\n      reject(new Error('fetch_timeout'));\n      abortController?.abort('fetch_timeout');\n    }, options.timeout);\n\n    // abortController.signal.addEventListener('abort', () => {\n    //   logger.incident('fetch', 'fetch_abort_signal', {\n    //     reason: abortController.signal.reason,\n    //   });\n    // });\n\n    globalScope\n      .fetch(options.url, options)\n      .then((response) => resolved(response))\n      .catch((reason) => reject(reason))\n      .finally(() => {\n        delete options.signal; // try to avoid memory leak in nodejs!\n        clearTimeout(timeoutId);\n      });\n  });\n}\n"]}

package/type.d.ts

@@ -1,90 +0,0 @@
-import type { Methods, QueryParameters, StringifyableRecord, UserAuth } from '@alwatr/type';
-export type CacheStrategy = 'network_only' | 'network_first' | 'cache_only' | 'cache_first' | 'update_cache' | 'stale_while_revalidate';
-export type CacheDuplicate = 'never' | 'always' | 'until_load' | 'auto';
-export interface FetchOptions extends RequestInit {
-    /**
-     * Request URL.
-     */
-    url: string;
-    /**
-     * A string to set request's method.
-     *
-     * @default 'GET'
-     */
-    method?: Methods;
-    /**
-     * A Headers object to set request's headers.
-     */
-    headers?: Record<string, string>;
-    /**
-     * A timeout for the fetch request.
-     * Set `0` for disable it.
-     *
-     * Use with cation, you will have memory leak issue in nodejs.
-     *
-     * @default 10_000 ms
-     */
-    timeout?: number;
-    /**
-     * If fetch response not acceptable or timed out, it will retry the request.
-     *
-     * @default 3
-     */
-    retry?: number;
-    /**
-     * Delay before each retries.
-     *
-     * @default 1_000 ms
-     */
-    retryDelay?: number;
-    /**
-     * Simple memory caching for remove duplicate/parallel requests.
-     *
-     * - `never`: Never use memory caching.
-     * - `always`: Always use memory caching and remove all duplicate requests.
-     * - `until_load`: Cache parallel requests until request completed (it will be removed after the promise resolved).
-     * - `auto`: If CacheStorage was supported use `until_load` strategy else use `always`.
-     *
-     * @default 'never'
-     */
-    removeDuplicate?: CacheDuplicate;
-    /**
-     * Strategies for caching.
-     *
-     * - `network_only`: Only network request without any cache.
-     * - `network_first`: Network first, falling back to cache.
-     * - `cache_only`: Cache only without any network request.
-     * - `cache_first`: Cache first, falling back to network.
-     * - `update_cache`: Like `network_only` but with update cache.
-     * - `stale_while_revalidate`: Fastest strategy, Use cached first but always request network to update the cache.
-     *
-     * @default 'network_only'
-     */
-    cacheStrategy?: CacheStrategy;
-    /**
-     * Revalidate callback for `stale_while_revalidate` cache strategy.
-     */
-    revalidateCallback?: (response: Response) => void | Promise<void>;
-    /**
-     * Cache storage custom name.
-     */
-    cacheStorageName?: string;
-    /**
-     * Body as JS Object.
-     */
-    bodyJson?: StringifyableRecord;
-    /**
-     * URL Query Parameters as JS Object.
-     */
-    queryParameters?: QueryParameters;
-    /**
-     * Add token to Authentication bearer header.
-     */
-    token?: string;
-    /**
-     * Add user id and token to Authentication bearer header.
-     */
-    userAuth?: UserAuth;
-}
-export type StringifyableFetchOptions = Pick<FetchOptions, 'url' | 'bodyJson' | 'cache' | 'cacheStorageName' | 'cacheStrategy' | 'headers' | 'credentials' | 'keepalive' | 'method' | 'mode' | 'queryParameters' | 'removeDuplicate' | 'timeout' | 'token' | 'retry' | 'retryDelay' | 'referrer' | 'referrerPolicy' | 'userAuth'>;
-//# sourceMappingURL=type.d.ts.map

package/type.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.d.ts","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAC,OAAO,EAAE,eAAe,EAAE,mBAAmB,EAAE,QAAQ,EAAC,MAAM,cAAc,CAAC;AAE1F,MAAM,MAAM,aAAa,GACrB,cAAc,GACd,eAAe,GACf,YAAY,GACZ,aAAa,GACb,cAAc,GACd,wBAAwB,CAAC;AAE7B,MAAM,MAAM,cAAc,GAAG,OAAO,GAAG,QAAQ,GAAG,YAAY,GAAG,MAAM,CAAC;AAExE,MAAM,WAAW,YAAa,SAAQ,WAAW;IAC/C;;OAEG;IACH,GAAG,EAAE,MAAM,CAAC;IAEZ;;;;OAIG;IACH,MAAM,CAAC,EAAE,OAAO,CAAC;IAEjB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAEjC;;;;;;;OAOG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;;;OAIG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;;;;;;;;OASG;IACH,eAAe,CAAC,EAAE,cAAc,CAAC;IAEjC;;;;;;;;;;;OAWG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,kBAAkB,CAAC,EAAE,CAAC,QAAQ,EAAE,QAAQ,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAC;IAElE;;OAEG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAC;IAE/B;;OAEG;IACH,eAAe,CAAC,EAAE,eAAe,CAAC;IAElC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,QAAQ,CAAC,EAAE,QAAQ,CAAC;CACrB;AAED,MAAM,MAAM,yBAAyB,GAAG,IAAI,CAC1C,YAAY,EACV,KAAK,GACL,UAAU,GACV,OAAO,GACP,kBAAkB,GAClB,eAAe,GACf,SAAS,GACT,aAAa,GACb,WAAW,GACX,QAAQ,GACR,MAAM,GACN,iBAAiB,GACjB,iBAAiB,GACjB,SAAS,GACT,OAAO,GACP,OAAO,GACP,YAAY,GACZ,UAAU,GACV,gBAAgB,GAChB,UAAU,CACb,CAAC"}

package/type.js

@@ -1,2 +0,0 @@
-export {};
-//# sourceMappingURL=type.js.map

package/type.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"type.js","sourceRoot":"","sources":["src/type.ts"],"names":[],"mappings":"","sourcesContent":["import type {Methods, QueryParameters, StringifyableRecord, UserAuth} from '@alwatr/type';\n\nexport type CacheStrategy =\n  | 'network_only'\n  | 'network_first'\n  | 'cache_only'\n  | 'cache_first'\n  | 'update_cache'\n  | 'stale_while_revalidate';\n\nexport type CacheDuplicate = 'never' | 'always' | 'until_load' | 'auto';\n\nexport interface FetchOptions extends RequestInit {\n  /**\n   * Request URL.\n   */\n  url: string;\n\n  /**\n   * A string to set request's method.\n   *\n   * @default 'GET'\n   */\n  method?: Methods;\n\n  /**\n   * A Headers object to set request's headers.\n   */\n  headers?: Record<string, string>;\n\n  /**\n   * A timeout for the fetch request.\n   * Set `0` for disable it.\n   *\n   * Use with cation, you will have memory leak issue in nodejs.\n   *\n   * @default 10_000 ms\n   */\n  timeout?: number;\n\n  /**\n   * If fetch response not acceptable or timed out, it will retry the request.\n   *\n   * @default 3\n   */\n  retry?: number;\n\n  /**\n   * Delay before each retries.\n   *\n   * @default 1_000 ms\n   */\n  retryDelay?: number;\n\n  /**\n   * Simple memory caching for remove duplicate/parallel requests.\n   *\n   * - `never`: Never use memory caching.\n   * - `always`: Always use memory caching and remove all duplicate requests.\n   * - `until_load`: Cache parallel requests until request completed (it will be removed after the promise resolved).\n   * - `auto`: If CacheStorage was supported use `until_load` strategy else use `always`.\n   *\n   * @default 'never'\n   */\n  removeDuplicate?: CacheDuplicate;\n\n  /**\n   * Strategies for caching.\n   *\n   * - `network_only`: Only network request without any cache.\n   * - `network_first`: Network first, falling back to cache.\n   * - `cache_only`: Cache only without any network request.\n   * - `cache_first`: Cache first, falling back to network.\n   * - `update_cache`: Like `network_only` but with update cache.\n   * - `stale_while_revalidate`: Fastest strategy, Use cached first but always request network to update the cache.\n   *\n   * @default 'network_only'\n   */\n  cacheStrategy?: CacheStrategy;\n\n  /**\n   * Revalidate callback for `stale_while_revalidate` cache strategy.\n   */\n  revalidateCallback?: (response: Response) => void | Promise<void>;\n\n  /**\n   * Cache storage custom name.\n   */\n  cacheStorageName?: string;\n\n  /**\n   * Body as JS Object.\n   */\n  bodyJson?: StringifyableRecord;\n\n  /**\n   * URL Query Parameters as JS Object.\n   */\n  queryParameters?: QueryParameters;\n\n  /**\n   * Add token to Authentication bearer header.\n   */\n  token?: string;\n\n  /**\n   * Add user id and token to Authentication bearer header.\n   */\n  userAuth?: UserAuth;\n}\n\nexport type StringifyableFetchOptions = Pick<\n  FetchOptions,\n  | 'url'\n  | 'bodyJson'\n  | 'cache'\n  | 'cacheStorageName'\n  | 'cacheStrategy'\n  | 'headers'\n  | 'credentials'\n  | 'keepalive'\n  | 'method'\n  | 'mode'\n  | 'queryParameters'\n  | 'removeDuplicate'\n  | 'timeout'\n  | 'token'\n  | 'retry'\n  | 'retryDelay'\n  | 'referrer'\n  | 'referrerPolicy'\n  | 'userAuth'\n>;\n"]}