Merge pull request #65 from privy-open-source/feat/axios-1.x

release: `1.0.0`

Author: adenvt

.eslintignore

@@ -89,6 +89,7 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
+.output
 dist
 
 # Gatsby files

.github/workflows/ci.yml

@@ -11,31 +11,26 @@ on:
   merge_group:
     types: [checks_requested]
 
+env:
+  NODE_VERSION: 20
+
 jobs:
   analyze:
-    runs-on: ${{ matrix.os }}
+    runs-on: ubuntu-latest
 
     permissions:
       actions: read
       contents: read
       security-events: write
 
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - ubuntu-latest
-        language:
-          - javascript
-
     steps:
       - name: Git Checkout
         uses: actions/checkout@v3
 
       - name: Initialize CodeQL
         uses: github/codeql-action/init@v2
         with:
-          languages: ${{ matrix.language }}
+          languages: javascript
 
       - name: Autobuild
         uses: github/codeql-action/autobuild@v2
@@ -44,15 +39,7 @@ jobs:
         uses: github/codeql-action/analyze@v2
 
   build:
-    runs-on: ${{ matrix.os }}
-
-    strategy:
-      fail-fast: false
-      matrix:
-        os:
-          - ubuntu-latest
-        node-version:
-          - 18
+    runs-on: ubuntu-latest
 
     steps:
       - name: Git Checkout
@@ -73,10 +60,10 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-yarn-
 
-      - name: Use Node.js ${{ matrix.node-version }}
+      - name: Use Node.js ${{ env.NODE_VERSION }}
         uses: actions/setup-node@v4
         with:
-          node-version: ${{ matrix.node-version }}
+          node-version: ${{ env.NODE_VERSION }}
           cache: "yarn"
 
       - name: Install Deps

.gitignore

@@ -89,6 +89,7 @@ out
 
 # Nuxt.js build / generate output
 .nuxt
+.output
 dist
 
 # Gatsby files
@@ -128,3 +129,5 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
+
+.clinic/

.nvmrc

@@ -1 +1 @@
-18
+20

.yarn/releases/yarn-3.8.3.cjs

@@ -4,4 +4,4 @@ enableGlobalCache: false
 
 nodeLinker: node-modules
 
-yarnPath: .yarn/releases/yarn-4.4.0.cjs
+yarnPath: .yarn/releases/yarn-4.5.3.cjs

.yarn/releases/yarn-4.4.0.cjs

@@ -24,7 +24,7 @@ Find and replace all on all files (CMD+SHIFT+F):
 
 <!-- Highlight some of the features your module provide here -->
 - ✅ Using Fetch instead of XHR
-- ✅ Built-in adapter for Dedupe, and Priority Queue request.
+- ✅ Built-in adapter for Retry, Dedupe, and Priority Queue request.
 - ✅ Composable hook for Axios interceptors.
 
 ## Compabilities
@@ -133,26 +133,80 @@ onResponseError(async (error) => {
 
 ## Queue
 
-All request per instance will be add into queue before sent with priority `1`.
+All request per instance will be add into queue before sent with priority MEDIUM (`20`).
 If you want to send your request first before the others, you can set using option `priority`. The higher priority will run first.
 
 ```ts
+import { QueuePriority } from '@privyid/nuapi/core'
+
 useApi().get('/document/load', {
-  priority: 2,
+  // Using presets
+  priority: QueuePriority.HIGH,
+  // Or using number
+  priority: 50,
 })
 ```
 
 ## Dedupe
 
 Sometime, you want to cancel request with same endpoint like when you working with searching or filter.
 
-NuAPI has built in function for this case. Just set `requestId`, multiple sent request with same id will cancel last request before.
+NuAPI has built in function for this case. Just set `requestkey`, multiple sent request with same id will cancel last request before.
 
 ```ts
 useApi().get('/document/load', {
-  requestId: 'document-load',
+  requestkey: 'document-load',
 })
 ```
+
+### Cancel Manually
+
+Cancel spesific request by `requestKey` using `.cancel()`
+
+```ts
+useApi().cancel('document-load')
+```
+
+Or cancel all requests that have `requestKey` using `.cancelAll()`
+
+```ts
+useApi().cancelAll()
+```
+
+## Retry
+
+NuAPI automatically retries request when got an error with status code:
+
+- 408 - Request Timeout
+- 409 - Conflict
+- 425 - Too Early
+- 429 - Too Many Requests
+- 500 - Internal Server Error
+- 502 - Bad Gateway
+- 503 - Service Unavailable
+- 504 - Gateway Timeout
+
+By default will retries `3` times (except for `PATCH`, `POST`, `PUT`, `DELETE`) can be changed using option `retry`.
+
+```ts
+useApi().get('/document/load', {
+  retry: 5,
+})
+```
+
+### Customize Retry Condition
+
+You can customize when request should retries using `retryOn`
+
+```ts
+useApi().get('/document/load', {
+  retryOn (error) {
+    return getCode(error) === 423
+      && error.config.retryCount < 3
+  },
+})
+```
+
 ## API
 
 👉 You can learn more about usage in [JSDocs Documentation](https://www.jsdocs.io/package/@privyid/nuapi).

.yarn/releases/yarn-4.5.3.cjs

@@ -19,6 +19,13 @@ const server = setupServer(
     await delay(2)
   }),
 
+  http.all(`${BASE_URL}/api/echo`, async ({ request }) => {
+    return HttpResponse.json({
+      method : request.method,
+      headers: request.headers,
+    })
+  }),
+
   http.get(`${BASE_URL}/api/ping`, () => {
     return HttpResponse.json({ message: 'Pong' })
   }),
@@ -55,8 +62,20 @@ const server = setupServer(
     }, { status: 422 })
   }),
 
-  http.get(`${BASE_URL}/api/error/500`, () => {
-    return new HttpResponse(undefined, { status: 500 })
+  http.all(`${BASE_URL}/api/error/500`, () => {
+    return HttpResponse.json({}, { status: 500 })
+  }),
+
+  http.get(`${BASE_URL}/api/error/unstable`, async function * () {
+    let count = 0
+
+    while (count < 2) {
+      yield HttpResponse.json({ data: { count } }, { status: 500 })
+
+      count++
+    }
+
+    return HttpResponse.json({ message: 'Pong', data: { count } })
   }),
 )