feat: added a new response object, which carries additional metadata

Author: ColinEberhardt

features/support/support.js

@@ -78,7 +78,7 @@ When(
 );
 
 When(/extracting the object at index ([0-9]*)/, (index) => {
-  apiResponse = apiResponse[parseInt(index)];
+  apiResponse.data = apiResponse.data[parseInt(index)];
 });
 
 When(
@@ -115,21 +115,21 @@ Then(
 );
 
 Then(/the response should be of type (.*)/, (type) => {
-  assert.equal(apiResponse.constructor.name, type);
+  assert.equal(apiResponse.data.constructor.name, type);
 });
 
 Then(
   /the response should have a property ([a-zA-Z]*) with value (.*)/,
   (propName, propValue) => {
-    const value = apiResponse[propName];
+    const value = apiResponse.data[propName];
     const formattedValue =
       value instanceof Date ? value.toISOString() : value.toString();
     assert.equal(formattedValue, propValue);
   }
 );
 
 Then(/the response should be an array/, () => {
-  assert.isArray(apiResponse);
+  assert.isArray(apiResponse.data);
 });
 
 Then(/the requested URL should be (.*)/, (url) => {
@@ -141,11 +141,11 @@ Then(/the request should have a body with value (.*)/, (body) => {
 });
 
 Then(/the response should be equal to "(.*)"/, (value) => {
-  assert.equal(apiResponse, value);
+  assert.equal(apiResponse.data, value);
 });
 
 Then(/the response should be null/, () => {
-  assert.isNull(apiResponse);
+  assert.isNull(apiResponse.data);
 });
 
 Then(/it should generate a model object named (\w*)/, (modelName) => {

features/support/util.js

@@ -28,7 +28,9 @@ function createApi(serverIndex = 0) {
     const Configuration = require("../api/configuration.js");
     const mockTransport = async (params) => {
       mock.requestParams = params;
-      return mock.serverResponseObject;
+      return {
+        data: mock.serverResponseObject
+      };
     };
 
     const config = new Configuration(mockTransport);

template/api.js.handlebars

@@ -57,9 +57,14 @@ class Api{{_tag.name}} {
 
         const response = await request(this.config, "{{@root.path}}", "{{@key}}", builder.parameters);
         {{#if _response.schema}}
-        return deserialize(response, "{{typeConvert _response.schema}}");
+        return {
+          ...response,
+          data: deserialize(response.data, "{{typeConvert _response.schema}}")
+        }
         {{else}}
-        return null;
+        return {
+          ...response
+        };
         {{/if}}
       };
 

template/fetch.js.handlebars

@@ -1,9 +1,19 @@
 async function transport(params) {
-  const response = await fetch(params.url, params);
-  if (response.status !== 200) {
-    throw new Error(`${response.status} ${response.statusText}`);
+  const fetchResponse = await fetch(params.url, params);
+
+  if (fetchResponse.ok) {
+    const json = await fetchResponse.json();
+    return {
+      data: json,
+      statusCode: fetchResponse.status,
+      headers: fetchResponse.headers,
+      type: fetchResponse.type,
+    };
+  } else {
+    throw new Error(
+      `Error ${fetchResponse.status}: ${fetchResponse.statusText}`
+    );
   }
-  return await response.json();
 }
 
 {{{export}}} transport;