Merge pull request #1 from Coreoz/create-http-fetch-request

Create http fetch request

Author: amanteaux

.yarnrc.yml

@@ -2,4 +2,10 @@ plugins:
   - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
     spec: "@yarnpkg/plugin-interactive-tools"
 
+packageExtensions:
+  chalk@5.0.1:
+    dependencies:
+      "#ansi-styles": npm:ansi-styles@6.1.0
+      "#supports-color": npm:supports-color@9.2.2
+
 yarnPath: .yarn/releases/yarn-3.2.0.cjs

README.md

@@ -36,20 +36,11 @@ A request builder will be returned, when executed, this request will return a [H
 
 ```typescript
 restRequest<T>(method: HttpMethod, path: string): HttpRequest<HttpPromise<T>> {
-  return new HttpRequest<HttpPromise<T>>(
-    // the base API client
-    (httpRequest) => new HttpPromise<T>(
-      // unwrapHttpPromise enables to transforme a Promise<HttpResponse<T>> result to a HttpPromise<T> result
-      // while defaultJsonFetchClient will connect take care of HTTP exchange and try to parse the result to a JSON T object (the generic parameter that represents the type we are waiting for)
-      unwrapHttpPromise(defaultJsonFetchClient(httpRequest)),
-      httpRequest,
-    ),
-    // the base URL, e.g. https://google.fr/api
-    baseUrl,
-    // the method, e.g. HttpMethod.GET
-    method,
-    // the path, e.g. /users/123/addresses
-    path,
+  return createHttpFetchRequest(
+    baseUrl, // the base URL, e.g. https://google.fr/api
+    method, // the method, e.g. HttpMethod.GET
+    path, // the path, e.g. /users/123/addresses
+    defaultJsonFetchClient // the base API client
   );
 }
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "simple-http-rest-client",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "A lightweight framework for creating reliable REST HTTP clients in TypeScript",
   "author": "Aurélien Manteaux <amanteaux@coreoz.com> (https://coreoz.com)",
   "repository": "https://github.com/coreoz/simple-http-rest-client",
@@ -55,7 +55,7 @@
     "jest": "^27.5.1",
     "jest-config": "^27.5.1",
     "node-fetch": "2",
-    "release-it": "^14.13.1",
+    "release-it": "^15.1.0",
     "source-map-support": "^0.5.21",
     "ts-jest": "^27.1.4",
     "ts-node": "^10.7.0",

src/index.ts

@@ -1,9 +1,15 @@
 // content type validator
 export { contentTypeValidator } from './lib/client/ContentTypeValidator';
 // fetch client
-export { fetchClientExecutor, networkErrorCatcher, fetchClient } from './lib/client/FetchClient';
+export {
+  fetchClientExecutor,
+  networkErrorCatcher,
+  fetchClient,
+  createHttpFetchRequest,
+} from './lib/client/FetchClient';
 export type {
   FetchResponseHandler,
+  HttpFetchClient,
 } from './lib/client/FetchClient';
 // fetch status validators
 export { validateBasicStatusCodes } from './lib/client/FetchStatusValidators';

src/lib/client/FetchClient.ts

@@ -1,12 +1,17 @@
 import { Logger } from 'simple-logging-system';
-import { HttpRequest, HttpClient } from 'simple-http-request-builder';
+import {
+  HttpRequest,
+  HttpClient,
+  HttpMethod,
+} from 'simple-http-request-builder';
 import {
   genericError,
   HttpResponse,
   toErrorResponsePromise,
   networkError,
   timeoutError,
 } from './HttpResponse';
+import { HttpPromise, unwrapHttpPromise } from '../promise/HttpPromise';
 
 const logger = new Logger('FetchClient');
 
@@ -113,3 +118,36 @@ export const fetchClient = <T = Response>(httpRequest: HttpRequest<unknown>, ...
       return { response };
     })
     .catch(networkErrorCatcher);
+
+/**
+ * A {@link HttpClient} that uses {@link HttpRequest} and returns a `Promise<HttpResponse<T>>`.
+ *
+ * This is used by {@link createHttpFetchRequest} to make fetch requests.
+ *
+ * Common clients are:
+ * - {@link defaultJsonFetchClient} for REST JSON API
+ * - raw {@link fetchClient} for non-JSON API (so often just for binary content)
+ */
+export type HttpFetchClient = <T>(httpRequest: HttpRequest<unknown>) => Promise<HttpResponse<T>>;
+
+/**
+ * Factory function to create fetch {@link HttpRequest}.
+ *
+ * @param baseUrl The base URL. It should not contain an ending slash. A valid base URL is: http://hostname/api
+ * @param method The HTTP method used for the request, see {@link HttpMethod}
+ * @param path The path of the endpoint to call, it should be composed with a leading slash
+ * and will be appended to the {@link HttpRequest#baseUrl}. A valid path is: /users
+ * @param httpClient The fetch client that uses {@link HttpRequest} and returns a `Promise<HttpResponse<T>>`
+ */
+export const createHttpFetchRequest = <T>(
+  baseUrl: string, method: HttpMethod, path: string, httpClient: HttpFetchClient,
+)
+  : HttpRequest<HttpPromise<T>> => new HttpRequest<HttpPromise<T>>(
+    (httpRequest) => new HttpPromise<T>(
+      unwrapHttpPromise(httpClient(httpRequest)),
+      httpRequest,
+    ),
+    baseUrl,
+    method,
+    path,
+  );