Fix #26 - Add rawData to composite response when raw:true option is given

Author: Tronix117

README.md

@@ -23,8 +23,8 @@ This adapter just add a light serialize and deserialize layer over DSHttpAdapter
 
 | package      | requirement   |
 | ------------ | ------------- |
-| js-data      | >= 3.0.0-rc.7 |
-| js-data-http | >= 3.0.0-rc.2 |
+| js-data      | >= 3.0.0      |
+| js-data-http | >= 3.0.0      |
 
 By design it is not compatible with JS-Data v2, for a full integration on v2, you should use: [js-data-jsonapi](https://github.com/BlairAllegroTech/js-data-jsonapi).
 
@@ -170,6 +170,7 @@ store.findAll('User', {}, {
 }).then((response) => {
   console.log(response.data); // Return the Records
   console.log(response.meta); // Return the JSONApi Metas
+  console.log(response.rawData); // Return the full response (should be discarded as soon as possible to save memory)
 })
 ```
 
@@ -207,10 +208,13 @@ Deserialization and serialization hooks, see above.
 * Custom hooks
 * By default update PATCH changes instead of PUT the record
 
+### What may work
+
+* Error handling (need intensive testing)
+
 ### What is remaining
 
 * ManyToMany
-* Error handling
 
 ## License
 

dist/js-data-jsonapi-light.js

@@ -32,6 +32,7 @@ export class JsonApiAdapter extends HttpAdapter{
 
   private handleResponse (opts?:any) { return function (response:any): Promise<any> {
     if (opts && opts.raw) {
+      response.rawData = response.data.rawData;
       response.meta = response.data.meta;
       response.data = response.data.result;
     }

dist/js-data-jsonapi-light.js.map

@@ -125,6 +125,7 @@ export function jsonApiDeserialize(mapper:Mapper, res:any, opts:any){
 
   return {
     result: outputDatas,
-    meta: res.data.meta
+    meta: res.data.meta,
+    rawData: res.data
   };
 }

src/adapter.ts

@@ -9,9 +9,10 @@ interface DSJsonApiLightResponse {
 }
 
 describe('Composite Response :', () => {
-  describe('when resources are fetched with a compositeResponse option', () => {
+  describe('when resources are fetched with a raw option', () => {
     const 
       USER_LENGTH = 1,
+      INCLUDED_LENGTH = 2,
       USER = {
         ID: 'e81fea3d-6379-4137-8068-7d70a90a1a7c',
         EMAIL: 'james@example.com'
@@ -33,6 +34,7 @@ describe('Composite Response :', () => {
 
     it('should return a composite response in the findAll promise', () => {
       expect(response).to.have.property('data');
+      expect(response).to.have.property('rawData');
       expect(response).to.have.property('meta');
     })
 
@@ -47,5 +49,24 @@ describe('Composite Response :', () => {
       expect(response.meta.count).to.equal(META.COUNT);
       expect(response.meta.about).to.deep.equal(META.ABOUT);
     })
+
+    it('should return the raw response in the rawData property of the composite response', () => {
+      expect(response.rawData).to.be.an('object');
+      expect(response.rawData).to.have.property('data');
+      expect(response.rawData).to.have.property('meta');
+      expect(response.rawData).to.have.property('links');
+      expect(response.rawData).to.have.property('included');
+      expect(response.rawData.data[0]).to.be.an('object');
+      expect(response.rawData.data[0].id).to.equal(USER.ID);
+      expect(response.rawData.data[0].type).to.equal('User');
+      expect(response.rawData.data[0]).to.have.property('attributes');
+      expect(response.rawData.data[0]).to.have.property('relationships');
+      expect(response.rawData.data[0].attributes).to.be.an('object');
+      expect(response.rawData.data[0].relationships).to.be.an('object');
+      expect(response.rawData.data[0].attributes.email).to.equal(USER.EMAIL);
+      expect(response.rawData.included)
+        .to.be.an('array')
+        .and.to.have.lengthOf(INCLUDED_LENGTH);
+    })
   })
 });