Add IResultProxy interface to proxy classes

Author: wadetandy

index.d.ts

@@ -28,3 +28,9 @@ interface japiResource extends japiResourceIdentifier {
   meta?: Object;
   links?: Object;
 }
+
+interface IResultProxy<T> {
+  data: any
+  meta: Object
+  raw: japiDoc
+}

src/associations.ts

@@ -1,6 +1,5 @@
 import Attribute from './attribute';
 import Model from './model';
-import CollectionProxy from './collection-proxy';
 
 class Base extends Attribute {
   klass: typeof Model;

src/model.ts

@@ -4,8 +4,7 @@ import Scope from './scope';
 import Config from './configuration';
 import Attribute from './attribute';
 import deserialize from './util/deserialize';
-import CollectionProxy from './collection-proxy';
-import RecordProxy from './record-proxy';
+import { CollectionProxy, RecordProxy } from './proxies';
 import _extend from './util/extend';
 import { camelize } from './util/string';
 

src/proxies.ts

@@ -0,0 +1,7 @@
+import CollectionProxy from './proxies/collection-proxy'
+import RecordProxy from './proxies/record-proxy'
+
+export {
+  CollectionProxy,
+  RecordProxy
+}

src/collection-proxy.ts renamed to src/proxies/collection-proxy.ts

@@ -1,6 +1,6 @@
-import Model from './model';
+import Model from '../model';
 
-class CollectionProxy<T> {
+class CollectionProxy<T> implements IResultProxy<T> {
   private _raw_json : japiDoc;
   private _array : Array<T>;
 
@@ -25,11 +25,9 @@ class CollectionProxy<T> {
 
     this._array = [];
 
-    if (this.raw.data) {
-      this.raw.data.map((datum : japiResource) => {
-        this._array.push(Model.fromJsonapi(datum, this.raw));
-      });
-    }
+    this.raw.data.map((datum : japiResource) => {
+      this._array.push(Model.fromJsonapi(datum, this.raw));
+    });
   }
 }
 

src/record-proxy.ts renamed to src/proxies/record-proxy.ts

@@ -1,6 +1,6 @@
-import Model from './model';
+import Model from '../model';
 
-class RecordProxy<T> {
+class RecordProxy<T> implements IResultProxy<T> {
   private _raw_json : japiDoc;
   private _model : T;
 
@@ -23,9 +23,10 @@ class RecordProxy<T> {
   private setRaw = (json_payload : japiDoc) => {
     this._raw_json = json_payload;
 
-
     if (this.raw.data) {
       this._model = Model.fromJsonapi(this.raw.data, this.raw);
+    } else {
+      this._model = null
     }
   }
 }

src/scope.ts

@@ -2,8 +2,7 @@ import Model from './model';
 import Config from './configuration';
 import parameterize from './util/parameterize';
 import IncludeDirective from './util/include-directive';
-import CollectionProxy from './collection-proxy';
-import RecordProxy from './record-proxy';
+import { CollectionProxy, RecordProxy } from './proxies';
 import Request from './request';
 import colorize from './util/colorize';
 

test/unit/collection-proxy-test.ts

@@ -1,6 +1,6 @@
 import { Person } from '../fixtures';
 
-import CollectionProxy from '../../src/collection-proxy'
+import CollectionProxy from '../../src/proxies/collection-proxy'
 
 describe('CollectionProxy', function() {
   let personData = {

test/unit/record-proxy-test.ts

@@ -1,6 +1,6 @@
 import { Person } from '../fixtures';
 
-import RecordProxy from '../../src/record-proxy'
+import RecordProxy from '../../src/proxies/record-proxy'
 
 describe('RecordProxy', function() {
   let personData = {
@@ -30,10 +30,21 @@ describe('RecordProxy', function() {
       expect(record.raw).to.deep.equal(personData)
     })
 
-    it('should assign the correct models to the data array', function() {
+    it('should assign the correct model to the data field', function() {
       let record = new RecordProxy(personData)
       expect(record.data).to.be.instanceof(Person)
     })
+
+    context('data is null', function() {
+      let personData = {
+        data: null
+      }
+
+      it('should assign data to null', function() {
+        let record = new RecordProxy(personData)
+        expect(record.data).to.eq(null)
+      })
+    })
   })
 
   describe('#meta', function() {

test/unit/relationships-test.ts

@@ -3,8 +3,6 @@
 import { sinon } from '../../test/test-helper';
 import { Author, Genre } from '../fixtures';
 
-import CollectionProxy from '../../src/collection-proxy';
-
 describe('Model relationships', function() {
   it('supports direct assignment of models', function() {
     let author = new Author();