@wise/dynamic-flow-client-internal 0.3.4 → 0.4.0

package/README.md

@@ -84,8 +84,8 @@ DF can be initialised with `initialAction` (recommended) or with an `initialStep
 ```tsx
 <DynamicFlow
   initialAction={{ method: 'GET', url: '/my-amazing-new-flow' }}
-  fetcher={(...args) => fetch(...args)}
-  onComplete={(result) => {
+  httpClient={(...args) => fetch(...args)}
+  onCompletion={(result) => {
     console.log('Flow exited with', result);
   }}
   onError={(error, statusCode) => {
@@ -101,39 +101,39 @@ In some cases you may want to obtain the initial step yourself, and then pass it
 ```tsx
 <DynamicFlow
   initialStep={someInitialStep}
-  fetcher={...}
-  onComplete={...}
+  httpClient={...}
+  onCompletion={...}
   onError={...}
 />
 ```
 
-### The `fetcher` function prop
+### The `httpClient`
 
-You must pass a fetcher function. This can be `window.fetch` itself or some wrapper function where you inject authorisation headers and anything else you many need.
+You must pass an http client. This can be `window.fetch` itself or some wrapper function where you inject authorisation headers and anything else you many need.
 
-You can take advantage of the `makeFetcher` utility function. This function takes a `baseUrl` and `additionalHeaders` arguments. The `baseUrl` will be prefixed to any relative request URLs. Absolute URLs will not be altered. The `additionalHeaders` parameter can be used to add any request headers you need in all requests, such as `{ 'X-Access-Token': 'Tr4n5f3rw153' }`:
+You can take advantage of the `makeHttpClient` utility function. This function takes a `baseUrl` and `additionalHeaders` arguments. The `baseUrl` will be prefixed to any relative request URLs. Absolute URLs will not be altered. The `additionalHeaders` parameter can be used to add any request headers you need in all requests, such as `{ 'X-Access-Token': 'Tr4n5f3rw153' }`:
 
 ```tsx
-import { makeFetcher, DynamicFlow } from '@wise/dynamic-flow-client';
+import { makeHttpClient, DynamicFlow } from '@wise/dynamic-flow-client';
 
-const myFetcher = makeFetcher('/my-base-url', { 'X-Access-Token': 'Tr4n5f3rw153' });
+const myHttpClient = makeHttpClient('/my-base-url', { 'X-Access-Token': 'Tr4n5f3rw153' });
 
 ...
 
 <DynamicFlow
   initialAction={{ method: 'GET', url: '/my-amazing-new-flow' }}
-  fetcher={myFetcher}
-  onComplete={...}
+  httpClient={myHttpClient}
+  onCompletion={...}
   onError={...}
 />
 ```
 
-#### Custom `fetcher` functions
+#### Using a custom `httpClient`
 
-If you want to write your own fetcher function (or if you're writing mocks), it's important that you return proper `Response` objects, and that you **do not throw**. Errors should result in a response with an error status code and potentially a body with an error message. For example:
+If you want to write your own `httpClient` (or if you're writing mocks), it's important that you return proper `Response` objects, and that you **do not throw**. Errors should result in a response with an error status code and potentially a body with an error message. For example:
 
 ```tsx
-const mockFetcher = (input, init) => {
+const mockHttpClient = (input, init) => {
   switch (input) {
     case '/standard':
       return Promise.resolve(new Response(init.body));
@@ -150,12 +150,12 @@ Also, please make sure your mocks return a new `Response` instace every time. Th
 ```ts
 const initialResponse = new Response(JSON.stringify(initialStep));
 // ❌ wrong - the same instance is returned on each request
-const mockFetcher = (input, init) => Promise.resolve(initialResponse);
+const mockHttpClient = (input, init) => Promise.resolve(initialResponse);
 ```
 
 ```ts
 // ✅ correct - a new instance is returned on each request
-const mockFetcher = (input, init) => Promise.resolve(new Response(JSON.stringify(initialStep)));
+const mockHttpClient = (input, init) => Promise.resolve(new Response(JSON.stringify(initialStep)));
 ```
 
 ### Telemetry