@alwatr/fetch 3.1.1 → 3.1.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +4 -0
- package/dist/main.cjs +2 -2
- package/dist/main.mjs +2 -2
- package/package.json +9 -9
- package/src/main.test.js +31 -1
package/CHANGELOG.md
CHANGED
|
@@ -3,6 +3,10 @@
|
|
|
3
3
|
All notable changes to this project will be documented in this file.
|
|
4
4
|
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
|
5
5
|
|
|
6
|
+
## [3.1.2](https://github.com/Alwatr/nanolib/compare/@alwatr/fetch@3.1.1...@alwatr/fetch@3.1.2) (2024-03-28)
|
|
7
|
+
|
|
8
|
+
**Note:** Version bump only for package @alwatr/fetch
|
|
9
|
+
|
|
6
10
|
## [3.1.1](https://github.com/Alwatr/nanolib/compare/@alwatr/fetch@3.1.0...@alwatr/fetch@3.1.1) (2024-01-31)
|
|
7
11
|
|
|
8
12
|
### Bug Fixes
|
package/dist/main.cjs
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
/* @alwatr/fetch v3.1.
|
|
2
|
-
"use strict";var m=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var k=Object.prototype.hasOwnProperty;var x=(e,r)=>{for(var t in r)m(e,t,{get:r[t],enumerable:!0})},T=(e,r,t,a)=>{if(r&&typeof r=="object"||typeof r=="function")for(let c of O(r))!k.call(e,c)&&c!==t&&m(e,c,{get:()=>r[c],enumerable:!(a=b(r,c))||a.enumerable});return e};var v=e=>T(m({},"__esModule",{value:!0}),e);var C={};x(C,{cacheSupported:()=>s,fetch:()=>S,fetchJson:()=>P});module.exports=v(C);var f=require("@alwatr/global-scope"),_=require("@alwatr/logger"),w=require("@alwatr/wait"),n=(0,_.definePackage)("@alwatr/fetch","3.1.
|
|
1
|
+
/* @alwatr/fetch v3.1.2 */
|
|
2
|
+
"use strict";var m=Object.defineProperty;var b=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var k=Object.prototype.hasOwnProperty;var x=(e,r)=>{for(var t in r)m(e,t,{get:r[t],enumerable:!0})},T=(e,r,t,a)=>{if(r&&typeof r=="object"||typeof r=="function")for(let c of O(r))!k.call(e,c)&&c!==t&&m(e,c,{get:()=>r[c],enumerable:!(a=b(r,c))||a.enumerable});return e};var v=e=>T(m({},"__esModule",{value:!0}),e);var C={};x(C,{cacheSupported:()=>s,fetch:()=>S,fetchJson:()=>P});module.exports=v(C);var f=require("@alwatr/global-scope"),_=require("@alwatr/logger"),w=require("@alwatr/wait"),n=(0,_.definePackage)("@alwatr/fetch","3.1.2"),i,s=Object.hasOwn(f.globalScope,"caches"),u={};function g(e){if(e.method??(e.method="GET"),e.window??(e.window=null),e.timeout??(e.timeout=8e3),e.retry??(e.retry=3),e.retryDelay??(e.retryDelay=1e3),e.cacheStrategy??(e.cacheStrategy="network_only"),e.removeDuplicate??(e.removeDuplicate="never"),e.headers??(e.headers={}),e.cacheStrategy!=="network_only"&&s!==!0&&(n.incident?.("fetch","fetch_cache_strategy_unsupported",{cacheSupported:s}),e.cacheStrategy="network_only"),e.removeDuplicate==="auto"&&(e.removeDuplicate=s?"until_load":"always"),e.url.lastIndexOf("?")===-1&&e.queryParameters!=null){let r=e.queryParameters,t=Object.keys(r).map(a=>`${a}=${String(r[a])}`);t.length>0&&(e.url+="?"+t.join("&"))}return e.bodyJson!==void 0&&(e.body=JSON.stringify(e.bodyJson),e.headers["Content-Type"]="application/json"),e.bearerToken!==void 0?e.headers.Authorization=`Bearer ${e.bearerToken}`:e.alwatrAuth!==void 0&&(e.headers.Authorization=`Alwatr ${e.alwatrAuth.userId}:${e.alwatrAuth.userToken}`),e}async function R(e){if(e.cacheStrategy==="network_only")return h(e);n.logMethod?.("_handleCacheStrategy"),i==null&&e.cacheStorageName==null&&(i=await caches.open("fetch_cache"));let r=e.cacheStorageName!=null?await caches.open(e.cacheStorageName):i,t=new Request(e.url,e);switch(e.cacheStrategy){case"cache_first":{let a=await r.match(t);if(a!=null)return a;let c=await h(e);return c.ok&&r.put(t,c.clone()),c}case"cache_only":{let a=await r.match(t);if(a==null)throw n.accident("_handleCacheStrategy","fetch_cache_not_found",{url:t.url}),new Error("fetch_cache_not_found");return a}case"network_first":try{let a=await h(e);return a.ok&&r.put(t,a.clone()),a}catch(a){let c=await r.match(t);if(c!=null)return c;throw a}case"update_cache":{let a=await h(e);return a.ok&&r.put(t,a.clone()),a}case"stale_while_revalidate":{let a=await r.match(t),c=h(e).then(l=>(l.ok&&(r.put(t,l.clone()),typeof e.revalidateCallback=="function"&&setTimeout(e.revalidateCallback,0,l.clone())),l));return a??c}default:return h(e)}}async function h(e){if(e.removeDuplicate==="never")return o(e);n.logMethod?.("handleRemoveDuplicate_");let r=e.method+" "+e.url;u[r]??(u[r]=o(e));try{let t=await u[r];return u[r]!=null&&(t.ok!==!0||e.removeDuplicate==="until_load")&&delete u[r],t.clone()}catch(t){throw delete u[r],t}}async function o(e){if(!(e.retry>1))return y(e);n.logMethod?.("_handleRetryPattern"),e.retry--;let r=e.signal;try{let t=await y(e);if(t.status<500)return t;throw new Error("fetch_server_error")}catch(t){if(n.accident("fetch","fetch_failed_retry",t),f.globalScope.navigator?.onLine===!1)throw n.accident("handleRetryPattern_","offline","Skip retry because offline"),t;return await(0,w.waitForTimeout)(e.retryDelay),e.signal=r,o(e)}}function y(e){return e.timeout===0?f.globalScope.fetch(e.url,e):(n.logMethod?.("handleTimeout_"),new Promise((r,t)=>{let a=typeof AbortController=="function"?new AbortController:null,c=e.signal;e.signal=a?.signal,a!==null&&c!=null&&c.addEventListener("abort",()=>a.abort(),{once:!0});let l=setTimeout(()=>{t(new Error("fetch_timeout")),a?.abort("fetch_timeout")},e.timeout);f.globalScope.fetch(e.url,e).then(d=>r(d)).catch(d=>t(d)).finally(()=>{delete e.signal,clearTimeout(l)})}))}async function P(e){let r,t,a;try{return r=await S(e),t=await r.text(),a=JSON.parse(t),a.ok=!0,a.statusCode=r.status,a}catch(c){let l={ok:!1,statusCode:r?.status,statusText:r?.statusText,errorCode:a?.errorCode??c.message,responseText:t,meta:a?.meta};return n.accident("fetchJson","fetch_failed",{responseError:l,error:c}),l}}function S(e){return e=g(e),n.logMethodArgs?.("fetch",{options:e}),R(e)}0&&(module.exports={cacheSupported,fetch,fetchJson});
|
|
3
3
|
//# sourceMappingURL=main.cjs.map
|
package/dist/main.mjs
CHANGED
|
@@ -1,3 +1,3 @@
|
|
|
1
|
-
/* @alwatr/fetch v3.1.
|
|
2
|
-
import{globalScope as f}from"@alwatr/global-scope";import{definePackage as w}from"@alwatr/logger";import{waitForTimeout as g}from"@alwatr/wait";var n=w("@alwatr/fetch","3.1.
|
|
1
|
+
/* @alwatr/fetch v3.1.2 */
|
|
2
|
+
import{globalScope as f}from"@alwatr/global-scope";import{definePackage as w}from"@alwatr/logger";import{waitForTimeout as g}from"@alwatr/wait";var n=w("@alwatr/fetch","3.1.2"),m,s=Object.hasOwn(f,"caches"),u={};function y(e){if(e.method??(e.method="GET"),e.window??(e.window=null),e.timeout??(e.timeout=8e3),e.retry??(e.retry=3),e.retryDelay??(e.retryDelay=1e3),e.cacheStrategy??(e.cacheStrategy="network_only"),e.removeDuplicate??(e.removeDuplicate="never"),e.headers??(e.headers={}),e.cacheStrategy!=="network_only"&&s!==!0&&(n.incident?.("fetch","fetch_cache_strategy_unsupported",{cacheSupported:s}),e.cacheStrategy="network_only"),e.removeDuplicate==="auto"&&(e.removeDuplicate=s?"until_load":"always"),e.url.lastIndexOf("?")===-1&&e.queryParameters!=null){let a=e.queryParameters,t=Object.keys(a).map(r=>`${r}=${String(a[r])}`);t.length>0&&(e.url+="?"+t.join("&"))}return e.bodyJson!==void 0&&(e.body=JSON.stringify(e.bodyJson),e.headers["Content-Type"]="application/json"),e.bearerToken!==void 0?e.headers.Authorization=`Bearer ${e.bearerToken}`:e.alwatrAuth!==void 0&&(e.headers.Authorization=`Alwatr ${e.alwatrAuth.userId}:${e.alwatrAuth.userToken}`),e}async function _(e){if(e.cacheStrategy==="network_only")return h(e);n.logMethod?.("_handleCacheStrategy"),m==null&&e.cacheStorageName==null&&(m=await caches.open("fetch_cache"));let a=e.cacheStorageName!=null?await caches.open(e.cacheStorageName):m,t=new Request(e.url,e);switch(e.cacheStrategy){case"cache_first":{let r=await a.match(t);if(r!=null)return r;let c=await h(e);return c.ok&&a.put(t,c.clone()),c}case"cache_only":{let r=await a.match(t);if(r==null)throw n.accident("_handleCacheStrategy","fetch_cache_not_found",{url:t.url}),new Error("fetch_cache_not_found");return r}case"network_first":try{let r=await h(e);return r.ok&&a.put(t,r.clone()),r}catch(r){let c=await a.match(t);if(c!=null)return c;throw r}case"update_cache":{let r=await h(e);return r.ok&&a.put(t,r.clone()),r}case"stale_while_revalidate":{let r=await a.match(t),c=h(e).then(l=>(l.ok&&(a.put(t,l.clone()),typeof e.revalidateCallback=="function"&&setTimeout(e.revalidateCallback,0,l.clone())),l));return r??c}default:return h(e)}}async function h(e){if(e.removeDuplicate==="never")return i(e);n.logMethod?.("handleRemoveDuplicate_");let a=e.method+" "+e.url;u[a]??(u[a]=i(e));try{let t=await u[a];return u[a]!=null&&(t.ok!==!0||e.removeDuplicate==="until_load")&&delete u[a],t.clone()}catch(t){throw delete u[a],t}}async function i(e){if(!(e.retry>1))return o(e);n.logMethod?.("_handleRetryPattern"),e.retry--;let a=e.signal;try{let t=await o(e);if(t.status<500)return t;throw new Error("fetch_server_error")}catch(t){if(n.accident("fetch","fetch_failed_retry",t),f.navigator?.onLine===!1)throw n.accident("handleRetryPattern_","offline","Skip retry because offline"),t;return await g(e.retryDelay),e.signal=a,i(e)}}function o(e){return e.timeout===0?f.fetch(e.url,e):(n.logMethod?.("handleTimeout_"),new Promise((a,t)=>{let r=typeof AbortController=="function"?new AbortController:null,c=e.signal;e.signal=r?.signal,r!==null&&c!=null&&c.addEventListener("abort",()=>r.abort(),{once:!0});let l=setTimeout(()=>{t(new Error("fetch_timeout")),r?.abort("fetch_timeout")},e.timeout);f.fetch(e.url,e).then(d=>a(d)).catch(d=>t(d)).finally(()=>{delete e.signal,clearTimeout(l)})}))}async function T(e){let a,t,r;try{return a=await R(e),t=await a.text(),r=JSON.parse(t),r.ok=!0,r.statusCode=a.status,r}catch(c){let l={ok:!1,statusCode:a?.status,statusText:a?.statusText,errorCode:r?.errorCode??c.message,responseText:t,meta:r?.meta};return n.accident("fetchJson","fetch_failed",{responseError:l,error:c}),l}}function R(e){return e=y(e),n.logMethodArgs?.("fetch",{options:e}),_(e)}export{s as cacheSupported,R as fetch,T as fetchJson};
|
|
3
3
|
//# sourceMappingURL=main.mjs.map
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@alwatr/fetch",
|
|
3
|
-
"version": "3.1.
|
|
3
|
+
"version": "3.1.2",
|
|
4
4
|
"description": "Enhanced fetch API with cache strategy, retry pattern, timeout, helper methods and enhanced types.",
|
|
5
5
|
"author": "S. Ali Mihandoost <ali.mihandoost@gmail.com>",
|
|
6
6
|
"keywords": [
|
|
@@ -71,18 +71,18 @@
|
|
|
71
71
|
"clean": "rm -rfv dist *.tsbuildinfo"
|
|
72
72
|
},
|
|
73
73
|
"dependencies": {
|
|
74
|
-
"@alwatr/global-scope": "^1.1.
|
|
75
|
-
"@alwatr/logger": "^3.2.
|
|
76
|
-
"@alwatr/wait": "^1.1.
|
|
74
|
+
"@alwatr/global-scope": "^1.1.14",
|
|
75
|
+
"@alwatr/logger": "^3.2.6",
|
|
76
|
+
"@alwatr/wait": "^1.1.9"
|
|
77
77
|
},
|
|
78
78
|
"devDependencies": {
|
|
79
|
-
"@alwatr/nano-build": "^1.3.
|
|
79
|
+
"@alwatr/nano-build": "^1.3.4",
|
|
80
80
|
"@alwatr/prettier-config": "^1.0.4",
|
|
81
81
|
"@alwatr/tsconfig-base": "^1.1.2",
|
|
82
|
-
"@alwatr/type-helper": "^1.2.
|
|
83
|
-
"@types/node": "^20.11.
|
|
82
|
+
"@alwatr/type-helper": "^1.2.2",
|
|
83
|
+
"@types/node": "^20.11.30",
|
|
84
84
|
"jest": "^29.7.0",
|
|
85
|
-
"typescript": "^5.
|
|
85
|
+
"typescript": "^5.4.3"
|
|
86
86
|
},
|
|
87
|
-
"gitHead": "
|
|
87
|
+
"gitHead": "df149736d1e85335aaeb9c547ff3bdd1161f9b33"
|
|
88
88
|
}
|
package/src/main.test.js
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
import {fetch} from '@alwatr/fetch'
|
|
1
|
+
import {fetch, fetchJson} from '@alwatr/fetch'
|
|
2
2
|
|
|
3
3
|
describe('fetch with search params', () => {
|
|
4
4
|
it('should make a GET request to the specified URL', async () => {
|
|
@@ -22,3 +22,33 @@ describe('fetch with search params', () => {
|
|
|
22
22
|
expect(responseJson.args.a).toBe('2');
|
|
23
23
|
});
|
|
24
24
|
});
|
|
25
|
+
|
|
26
|
+
describe('fetch json', () => {
|
|
27
|
+
it('should make a GET request to the specified URL with json body and parse valid json', async () => {
|
|
28
|
+
const options = {
|
|
29
|
+
url: 'http://httpbin.org/post',
|
|
30
|
+
method: 'POST',
|
|
31
|
+
bodyJson: {
|
|
32
|
+
a: 2
|
|
33
|
+
},
|
|
34
|
+
cacheStrategy: 'network_only',
|
|
35
|
+
};
|
|
36
|
+
|
|
37
|
+
const responseJson = await fetchJson(options);
|
|
38
|
+
|
|
39
|
+
expect(responseJson.ok).toBe(true);
|
|
40
|
+
expect(responseJson.json.a).toBe(2);
|
|
41
|
+
})
|
|
42
|
+
|
|
43
|
+
it('should make a GET request to the specified URL and parse json and handle 404 status code', async () => {
|
|
44
|
+
const options = {
|
|
45
|
+
url: 'https://httpbin.org/status/404',
|
|
46
|
+
cacheStrategy: 'network_only',
|
|
47
|
+
};
|
|
48
|
+
|
|
49
|
+
const responseJson = await fetchJson(options);
|
|
50
|
+
|
|
51
|
+
expect(responseJson.ok).toBe(false);
|
|
52
|
+
expect(responseJson.statusCode).toBe(404);
|
|
53
|
+
});
|
|
54
|
+
});
|