Add type for http request body

Author: nebarf

src/cache/http-cache.ts

@@ -13,15 +13,15 @@ export class HttpCacheService {
    * Gets the unique key used as idenitifier to store
    * a cached response for the given http request.
    */
-  private getRequestIdentifier(request: HttpRequest): string {
+  private getRequestIdentifier<HttpRequestBodyT>(request: HttpRequest<HttpRequestBodyT>): string {
     const fullUrl = request.urlWithParams;
     return fullUrl;
   }
 
   /**
    * Tells if a cached entry is expired.
    */
-  private isEntryExpired<T>(entry: HttpCacheEntry<T>): boolean {
+  private isEntryExpired<HttpResponseT>(entry: HttpCacheEntry<HttpResponseT>): boolean {
     const nowTime = new Date().getTime();
     const cachedAtDate = entry.cachedAt instanceof Date ? entry.cachedAt : new Date(entry.cachedAt);
     const cachedTime = cachedAtDate.getTime();
@@ -31,30 +31,32 @@ export class HttpCacheService {
   /**
    * Gets the cached entry associated with the request.
    */
-  private getEntry<T>(request: HttpRequest): HttpCacheEntry<T> | undefined {
+  private getEntry<HttpResponseT, HttpRequestBodyT>(
+    request: HttpRequest<HttpRequestBodyT>
+  ): HttpCacheEntry<HttpResponseT> | undefined {
     const reqIdentifier = this.getRequestIdentifier(request);
-    return this.prefixedStore.get(reqIdentifier) as HttpCacheEntry<T>;
+    return this.prefixedStore.get(reqIdentifier) as HttpCacheEntry<HttpResponseT>;
   }
 
   /**
    * Removes a cached entry.
    */
-  private removeEntry<T>(entry: HttpCacheEntry<T>): void {
+  private removeEntry<HttpResponseT>(entry: HttpCacheEntry<HttpResponseT>): void {
     this.prefixedStore.delete(entry.identifier);
   }
 
   /**
    * Determines if for the given request is available a cached response.
    */
-  has(request: HttpRequest): boolean {
+  has<HttpRequestBodyT>(request: HttpRequest<HttpRequestBodyT>): boolean {
     const key = this.getRequestIdentifier(request);
     return this.prefixedStore.has(key);
   }
 
   /**
    * Tells if the cached request is expired or not.
    */
-  isExpired(request: HttpRequest): boolean {
+  isExpired<HttpRequestBodyT>(request: HttpRequest<HttpRequestBodyT>): boolean {
     const cachedEntry = this.getEntry(request);
     if (!cachedEntry) {
       return true;
@@ -66,26 +68,31 @@ export class HttpCacheService {
   /**
    * Gets the cached entry in the map for the given request.
    */
-  get<T>(request: HttpRequest): T | undefined {
+  get<HttpResponseT, HttpRequestBodyT>(
+    request: HttpRequest<HttpRequestBodyT>
+  ): HttpResponseT | undefined {
     const cachedEntry = this.getEntry(request);
     if (!cachedEntry) {
       return undefined;
     }
 
     const isExpired = this.isEntryExpired(cachedEntry);
-    return isExpired ? undefined : (cachedEntry.response as T);
+    return isExpired ? undefined : (cachedEntry.response as HttpResponseT);
   }
 
   /**
    * Puts a new cached response for the given request.
    */
-  put<T>(request: HttpRequest, response: T): void {
+  put<HttpResponseT, HttpRequestBodyT>(
+    request: HttpRequest<HttpRequestBodyT>,
+    response: HttpResponseT
+  ): void {
     if (!request.maxAge) {
       return;
     }
 
     const reqKey = this.getRequestIdentifier(request);
-    const entry: HttpCacheEntry<T> = {
+    const entry: HttpCacheEntry<HttpResponseT> = {
       response,
       identifier: reqKey,
       cachedAt: new Date(),

src/client/http-request.ts

@@ -1,8 +1,8 @@
 import { HttpMethod } from '../enum';
 
-export interface HttpRequestProps {
+export interface HttpRequestProps<HttpRequestBodyT> {
   baseUrl: string;
-  body?: unknown;
+  body?: HttpRequestBodyT;
   credentials?: RequestCredentials;
   headers?: HeadersInit;
   maxAge?: number;
@@ -12,7 +12,7 @@ export interface HttpRequestProps {
   signal?: AbortSignal;
 }
 
-export class HttpRequest implements HttpRequestProps {
+export class HttpRequest<HttpRequestBodyT> implements HttpRequestProps<HttpRequestBodyT> {
   /**
    * The base url of the remote call. The subpath is
    * relative to the base url.
@@ -28,7 +28,7 @@ export class HttpRequest implements HttpRequestProps {
   /**
    * The request body.
    */
-  private _body?: unknown;
+  private _body?: HttpRequestBodyT;
 
   /**
    * The request credentials.
@@ -60,7 +60,7 @@ export class HttpRequest implements HttpRequestProps {
    */
   private _signal?: AbortSignal;
 
-  constructor(requestOpts: HttpRequestProps) {
+  constructor(requestOpts: HttpRequestProps<HttpRequestBodyT>) {
     const {
       baseUrl,
       body,
@@ -88,8 +88,8 @@ export class HttpRequest implements HttpRequestProps {
     return this._baseUrl;
   }
 
-  get body(): unknown {
-    return this._body || null;
+  get body(): HttpRequestBodyT | undefined {
+    return this._body;
   }
 
   get credentials(): RequestCredentials | undefined {

src/client/types.ts

@@ -4,25 +4,25 @@ export interface UseHttpClientParams {
   baseUrl: string;
 }
 
-export type AbortableHttpRequestReturn<HttpResponse> = [
-  res: Promise<HttpResponse>,
+export type AbortableHttpRequestReturn<HttpResponseT> = [
+  res: Promise<HttpResponseT>,
   abort: AbortController
 ];
 
-export interface PerformHttpRequestParams {
+export interface PerformHttpRequestParams<HttpRequestBodyT> {
   relativeUrl: string;
   parser: HttpResponseParser;
   baseUrlOverride: string;
-  requestOptions: Partial<HttpRequestOptions>;
+  requestOptions: Partial<HttpRequestOptions<HttpRequestBodyT>>;
 }
 
-export type HttpClientRequest = <HttpResponse = Response>(
-  params: Partial<PerformHttpRequestParams>
-) => Promise<HttpResponse>;
+export type HttpClientRequest = <HttpResponseT, HttpRequestBodyT>(
+  params: Partial<PerformHttpRequestParams<HttpRequestBodyT>>
+) => Promise<HttpResponseT>;
 
-export type HttpClientAbortableRequest = <HttpResponse = Response>(
-  params: Partial<PerformHttpRequestParams>
-) => AbortableHttpRequestReturn<HttpResponse>;
+export type HttpClientAbortableRequest = <HttpResponseT, HttpRequestBodyT>(
+  params: Partial<PerformHttpRequestParams<HttpRequestBodyT>>
+) => AbortableHttpRequestReturn<HttpResponseT>;
 
 export interface UseHttpClientReturn {
   request: HttpClientRequest;
@@ -39,7 +39,7 @@ export interface UseHttpClientReturn {
   abortableDelete: HttpClientAbortableRequest;
 }
 
-export interface HttpRequestOptions<RequestBody = unknown> {
+export interface HttpRequestOptions<RequestBody> {
   body: RequestBody | null | undefined;
   credentials: RequestCredentials | undefined;
   headers?: HeadersInit;