From 73b12eae5bc68d174cfeac6511349585cb39c1f0 Mon Sep 17 00:00:00 2001
From: Adam Mcgrath <adamjmcgrath@gmail.com>
Date: Wed, 30 Aug 2023 10:29:31 +0100
Subject: [PATCH] Rename fetch option, add request examples

---
 EXAMPLES.md        | 100 ++++++++++++++++++++++++++++++++++++++++++++-
 src/lib/models.ts  |   2 +-
 src/lib/runtime.ts |   2 +-
 3 files changed, 101 insertions(+), 3 deletions(-)

diff --git a/EXAMPLES.md b/EXAMPLES.md
index 4d0b07685..fcdc60b4f 100644
--- a/EXAMPLES.md
+++ b/EXAMPLES.md
@@ -10,7 +10,11 @@
   - [Paginate through a list of users](#paginate-through-a-list-of-users)
   - [Paginate through a list of logs using checkpoint pagination](#paginate-through-a-list-of-logs-using-checkpoint-pagination)
   - [Import users from a JSON file](#import-users-from-a-json-file)
-  - [Update a user's user_metadata](#update-a-users-user_metadata)
+  - [Update a user's user_metadata](#update-a-user-s-user-metadata)
+- [Customizing the request](#customizing-the-request)
+  - [Passing custom options to fetch](#passing-custom-options-to-fetch)
+  - [Using middleware](#using-middleware)
+  - [Overriding `fetch`](#overriding-fetch)
 
 ## Authentication Client
 
@@ -230,3 +234,97 @@ const management = new ManagementClient({
 
 await management.users.update({ id: '{user id}' }, { user_metadata: { foo: 'bar' } });
 ```
+
+## Customizing the request
+
+### Passing custom options to fetch
+
+```js
+import https from 'https';
+import { ManagementClient } from 'auth0';
+
+const management = new ManagementClient({
+  domain: '{YOUR_TENANT_AND REGION}.auth0.com',
+  clientId: '{YOUR_CLIENT_ID}',
+  clientSecret: '{YOUR_CLIENT_SECRET}',
+  headers: { 'foo': 'applied to all requests' },
+  agent: new https.Agent({ ... }),
+  httpTimeout: 5000
+});
+
+await management.users.get({ id: '{user id}' }, { headers: { 'bar': 'applied to this request' } });
+```
+
+### Using middleware
+
+```js
+import { ManagementClient } from 'auth0';
+
+const management = new ManagementClient({
+  domain: '{YOUR_TENANT_AND REGION}.auth0.com',
+  clientId: '{YOUR_CLIENT_ID}',
+  clientSecret: '{YOUR_CLIENT_SECRET}',
+  middleware: [
+    {
+      async pre({ url, init }) {
+        // Run some code before every request
+        log(url, init.method);
+        // optionally modify the url of fetchoptions
+        return { url, init: { ...init, priority: 'high' } };
+      },
+    },
+    {
+      // Runs after all retries, before reading the response
+      async post({ response }) {
+        // Run some code after every request
+        log(url, init.method, response);
+        // Optionall modify the response
+        const json = await response.json();
+        return Response.json({ ...json, foo: 'bar' });
+      },
+    },
+    {
+      // Runs after all retries, before reading the response
+      async onError({ fetch, url, init, error, response }) {
+        // Run some code when the request fails.
+        log(error);
+        // Optionally return a backup response
+        return Response.json({ foo: 'bar' });
+      },
+    },
+    {
+      async onError({ fetch, url, init, error, response }) {
+        if (response.status === 429) {
+          // Retry the response using your own retry logic (rather than the SDK's exponential backoff)
+          return fetch(url, init);
+        }
+        // throw a custom error
+        throw new Error('foo');
+      },
+    },
+  ],
+});
+
+await management.users.get({ id: '{user id}' });
+```
+
+### Overriding `fetch`
+
+```js
+import { ManagementClient } from 'auth0';
+import { myFetch } from './fetch';
+
+const management = new ManagementClient({
+  domain: '{YOUR_TENANT_AND REGION}.auth0.com',
+  clientId: '{YOUR_CLIENT_ID}',
+  clientSecret: '{YOUR_CLIENT_SECRET}',
+  async fetch(url, init) {
+    log('before', url, init.method);
+    const res = await myFetch(url, init);
+    log('after', url, init.method, res.status);
+    return res;
+  },
+});
+
+await management.users.get({ id: '{user id}' });
+```
diff --git a/src/lib/models.ts b/src/lib/models.ts
index ef306bf09..bc96c249b 100644
--- a/src/lib/models.ts
+++ b/src/lib/models.ts
@@ -16,7 +16,7 @@ export interface Configuration {
   /**
    * Provide your own fetch implementation.
    */
-  fetchApi?: FetchAPI;
+  fetch?: FetchAPI;
   /**
    * Provide a middleware that will run either before the request, after the request or when the request fails.
    */
diff --git a/src/lib/runtime.ts b/src/lib/runtime.ts
index 46573b862..bfcf5ccbe 100644
--- a/src/lib/runtime.ts
+++ b/src/lib/runtime.ts
@@ -31,7 +31,7 @@ export class BaseAPI {
     }
 
     this.middleware = configuration.middleware || [];
-    this.fetchApi = configuration.fetchApi || fetch;
+    this.fetchApi = configuration.fetch || fetch;
     this.parseError = configuration.parseError;
     this.timeoutDuration =
       typeof configuration.timeoutDuration === 'number' ? configuration.timeoutDuration : 10000;