Refactor Hooks

Author: richgoldmd

src/templates/core/OpenAPI.hbs

@@ -4,14 +4,25 @@
 
 import { Result } from './Result';
 
+export interface RequestHookParams {
+    url: string;
+    request: RequestInit;
+    responseHeader: string|undefined;
+}
+
+export interface ResponseHookParams {
+    url: string;
+    result: Result;
+}
+
 interface Config {
     BASE: string;
     VERSION: string;
     CLIENT: 'fetch' | 'xhr';
     WITH_CREDENTIALS: boolean;
     TOKEN: string;
-    REQUEST_HOOK?(request: RequestInit): Promise<RequestInit>;
-    RESPONSE_HOOK?(result: Result): Promise<Result>
+    REQUEST_HOOK?(params: RequestHookParams): Promise<RequestHookParams>;
+    RESPONSE_HOOK?(result: ResponseHookParams): Promise<Result>
 }
 
 export const OpenAPI: Config = {

src/templates/core/Result.ts

@@ -8,4 +8,5 @@ export interface Result {
     status: number;
     statusText: string;
     body: any;
+    response?: Response|XMLHttpRequest;
 }

src/templates/core/request.ts

@@ -4,7 +4,7 @@
 
 import { getFormData } from './getFormData';
 import { getQueryString } from './getQueryString';
-import { OpenAPI } from './OpenAPI';
+import { OpenAPI, RequestHookParams, ResponseHookParams } from './OpenAPI';
 import { RequestOptions } from './RequestOptions';
 import { requestUsingFetch } from './requestUsingFetch';
 import { requestUsingXHR } from './requestUsingXHR';
@@ -73,18 +73,16 @@ export async function request(options: Readonly<RequestOptions>): Promise<Result
 
 
     // Pre-hook on request if a function is provided.
-    const requestToSend = OpenAPI.REQUEST_HOOK ? (await OpenAPI.REQUEST_HOOK(request)) : request;
-
+    const requestHookResult = OpenAPI.REQUEST_HOOK ? (await OpenAPI.REQUEST_HOOK({ url, request, responseHeader: options.responseHeader})) : { url, request, responseHeader: options.responseHeader};
     try {
-        let response: Result;
+        let result: Result;
         switch (OpenAPI.CLIENT) {
             case 'xhr':
-                response = await requestUsingXHR(url, request, options.responseHeader);
+                result = await requestUsingXHR(requestHookResult.url, requestHookResult.request, requestHookResult.responseHeader, !!OpenAPI.RESPONSE_HOOK);
             default:
-                response = await requestUsingFetch(url, request, options.responseHeader);
+                result = await requestUsingFetch(requestHookResult.url, requestHookResult.request, requestHookResult.responseHeader, !!OpenAPI.RESPONSE_HOOK);
         }
-        // If there is a response hook, call it
-        return OpenAPI.RESPONSE_HOOK ? OpenAPI.RESPONSE_HOOK(response) : response;
+        return OpenAPI.RESPONSE_HOOK ? OpenAPI.RESPONSE_HOOK({url, result}) : result;
     } catch (error) {
         return {
             url,

src/templates/core/requestUsingFetch.ts

@@ -52,7 +52,7 @@ function parseHeader(response: Response, responseHeader?: string): string | null
  * @param request The request object, containing method, headers, body, etc.
  * @param responseHeader The header we want to parse.
  */
-export async function requestUsingFetch(url: string, request: Readonly<RequestInit>, responseHeader?: string): Promise<Result> {
+export async function requestUsingFetch(url: string, request: Readonly<RequestInit>, responseHeader?: string, includeResponse?: boolean): Promise<Result> {
 
     // Fetch response using fetch API.
     const response = await fetch(url, request);
@@ -68,5 +68,6 @@ export async function requestUsingFetch(url: string, request: Readonly<RequestIn
         status: response.status,
         statusText: response.statusText,
         body: contentHeader || contentBody,
+        response: includeResponse ? response : undefined
     };
 }

src/templates/core/requestUsingXHR.ts

@@ -54,7 +54,7 @@ function parseHeader(xhr: XMLHttpRequest, responseHeader?: string): string | nul
  * @param request The request object, containing method, headers, body, etc.
  * @param responseHeader The header we want to parse.
  */
-export async function requestUsingXHR(url: string, request: Readonly<RequestInit>, responseHeader?: string): Promise<Result> {
+export async function requestUsingXHR(url: string, request: Readonly<RequestInit>, responseHeader?: string, includeResponse?: boolean): Promise<Result> {
     return new Promise(resolve => {
         const xhr = new XMLHttpRequest();
 
@@ -88,6 +88,7 @@ export async function requestUsingXHR(url: string, request: Readonly<RequestInit
                     status: xhr.status,
                     statusText: xhr.statusText,
                     body: contentHeader || contentBody,
+                    response: includeResponse ? xhr : undefined
                 };
 
                 // Done!