Merge pull request #90 from ButterCMS/update-response-structure

update response structure to echo schema expected from TS defs and v1

__tests__/butter.test.js

@@ -15,14 +15,16 @@ test(
       }
     )
 
-    const response = await singlePageResponse;
-
+    const response = singlePageResponse.data;
+    
     await expect(response.data.fields.headline).toEqual("This is an example news page");
     await expect(response.data.slug).toEqual("example-news-page")
     await expect(response.data.page_type).not.toEqual("sport")
 
     // ensure we can get the page with the real page type attached
-    const response2 = await butter.page.retrieve('news', 'example-news-page')
+    const singlePageResponse2 = await butter.page.retrieve('news', 'example-news-page')
+
+    const response2 = singlePageResponse2.data;
 
     await expect(response2.data.fields.headline).toEqual("This is an example news page");
     await expect(response2.data.slug).toEqual("example-news-page")
@@ -76,11 +78,11 @@ test(
   "should list pages by single-pages", 
   async () => {
       const response = await butter.page.list('*')
-      
-      await expect(response.meta.count).toEqual(2);
-      await expect(response.data).toHaveLength(2);
+
+      await expect(response.data.meta.count).toEqual(2);
+      await expect(response.data.data).toHaveLength(2);
 
-      const firstPage = response.data[0];
+      const firstPage = response.data.data[0];
 
       await expect(firstPage).toHaveProperty('slug', 'single-page-1');
       await expect(firstPage).toHaveProperty('fields.title', 'This is a single page');
@@ -96,10 +98,10 @@ test(
   async () => {
       const response = await butter.page.list('*')
 
-      await expect(response.meta.count).toEqual(2);
-      await expect(response.data).toHaveLength(2);
+      await expect(response.data.meta.count).toEqual(2);
+      await expect(response.data.data).toHaveLength(2);
 
-      const firstPage = response.data[0];
+      const firstPage = response.data.data[0];
 
       await expect(firstPage).toHaveProperty('slug', 'single-page-1');
       await expect(firstPage).toHaveProperty('fields.title', 'This is a single page');
@@ -108,9 +110,11 @@ test(
 
       const response2 = await butter.page.retrieve('news', 'example-news-page')
 
-      await expect(response2.data.fields.headline).toEqual("This is an example news page");
-      await expect(response2.data.slug).toEqual("example-news-page")
-      await expect(response2.data.page_type).not.toEqual("sport")
+      const exactPage = response2.data
+
+      await expect(exactPage.data.fields.headline).toEqual("This is an example news page");
+      await expect(exactPage.data.slug).toEqual("example-news-page")
+      await expect(exactPage.data.page_type).not.toEqual("sport")
 
       return
   }

examples/basic.html

@@ -23,7 +23,7 @@
             const {
               meta,
               data: posts
-            } = resp
+            } = resp.data
 
             for(i = 0; i < posts.length; i++) {
               var title = posts[i].title;

examples/hooks.html

@@ -7,7 +7,7 @@
   </div>
 
   <script src="https://code.jquery.com/jquery-3.2.1.min.js"></script>
-  <script src="./lib/butter.min.js"></script>
+  <script src="https://cdnjs.buttercms.com/buttercms-2.0.3.min.js"></script><!-- {x-release-please-version} -->
   <script>
     $(function() {
 
@@ -40,7 +40,7 @@
             const {
               meta,
               data: posts
-            } = resp
+            } = resp.data
 
             if (!posts) return
 

lib/useButter.js

@@ -85,8 +85,8 @@ export default function useButter(type, butterConfig) {
                     cache: config.cache,
                     method: "GET",
                     headers,
-                    // use either the above timeout o
-                    // r the explicity AbortController cancelRequest to cancel request
+                    // use either the above timeout or
+                    // the explicit AbortController cancelRequest to cancel request
                     signal: AbortSignal.any([signal, timeoutSignal])
                 }
             );
@@ -101,7 +101,8 @@ export default function useButter(type, butterConfig) {
                     {
                         config,
                         params,
-                        type
+                        type,
+                        requestHeaders: butterHeaders
                     }
                 );
             }

lib/utils/useOnResponse.js

@@ -42,5 +42,22 @@ export default async function useOnResponse (response, kwargs) {
 
     // Parse and return the response as JSON.
     // The expected structure is { data, [meta, errors] }.
-    return await response.json()
+    const data = await response.json()
+
+    return {
+        data: data,
+        headers: Object.fromEntries(response.headers.entries()),
+        status: response.status,
+        statusText: response.statusText,
+        config: {
+            url: response.url,
+            method: "get",
+            headers: Object.fromEntries(kwargs.requestHeaders.entries()),
+            transformRequest: onRequest
+                ? [ onRequest ] : [],
+            transformResponse: onResponse
+                ? [ onResponse ] : [],
+            timeout: kwargs.config.timeout
+        }
+    }
 }

mocks/responses/page/page.json

@@ -31,4 +31,4 @@
       ]
     }
   }
-}
+}

package.json

@@ -1,6 +1,6 @@
 {
   "name": "buttercms",
-  "version": "2.0.3",
+  "version": "2.1.0",
   "description": "ButterCMS API Client",
   "keywords": [
     "buttercms",

tests/basic.html

@@ -23,7 +23,7 @@
             const {
               data: collections,
               meta
-            } = resp
+            } = resp.data
 
             if (collections) {
               const collection = collections["my-collection"]
@@ -58,7 +58,7 @@
             const {
               meta,
               data: posts
-            } = resp
+            } = resp.data
 
             if (posts) {
               for(i = 0; i < posts.length; i++) {

tests/hooks.html

@@ -40,7 +40,7 @@
             const {
               meta,
               data: posts
-            } = resp
+            } = resp.data
 
             if (!posts) return