Merge pull request #116 from ghidoz/feature/custom-property-converters

Add custom property converter

Author: safo6m

README.MD

@@ -116,7 +116,7 @@ export class Datastore extends JsonApiDatastore {
 Then set up your models:
 - Extend the `JsonApiModel` class
 - Decorate it with `@JsonApiModelConfig`, passing the `type`
-- Decorate the class properties with `@Attribute`: The serialized property name can optionally be specified by setting it as value of the annotation.
+- Decorate the class properties with `@Attribute`
 - Decorate the relationships attributes with `@HasMany` and `@BelongsTo`
 - (optional) Define your [Metadata](#metadata)
 
@@ -435,6 +435,16 @@ export class Post extends JsonApiModel { }
 * `modelEndpointUrl` - if not specified, `type` will be used instead
 * `meta` - optional, metadata model
 
+### Decorators
+
+#### Model decorators
+
+* `Attribute(options: AttributeDecoratorOptions)`
+
+    * `AttributeDecoratorOptions`:
+
+        * `converter`, optional, must implement `PropertyConverter` interface
+        * `serializedName`, optional
 
 ### Custom Headers
 

src/converters/date/date.converter.ts

@@ -0,0 +1,12 @@
+import { format, parse } from 'date-fns';
+import { PropertyConverter } from '../../interfaces/property-converter.interface';
+
+export class DateConverter implements PropertyConverter {
+  mask(value: any) {
+    return parse(value);
+  }
+
+  unmask(value: any) {
+    return format(value, 'YYYY-MM-DDTHH:mm:ss[Z]');
+  }
+}

src/decorators/attribute.decorator.ts

@@ -1,15 +1,29 @@
 import { format, parse } from 'date-fns';
+import { AttributeDecoratorOptions } from '../interfaces/attribute-decorator-options.interface';
+import { DateConverter } from '../converters/date/date.converter';
 
-export function Attribute(serializedName?: string) {
+export function Attribute(options: AttributeDecoratorOptions = {}): PropertyDecorator {
   return function (target: any, propertyName: string) {
     const converter = function (dataType: any, value: any, forSerialisation = false): any {
-      if (!forSerialisation) {
-        if (dataType === Date) {
-          return parse(value);
-        }
+      let attrConverter;
+
+      if (options.converter) {
+        attrConverter = options.converter;
+      } else if (dataType === Date) {
+        attrConverter = new DateConverter();
       } else {
-        if (dataType === Date) {
-          return format(value, 'YYYY-MM-DDTHH:mm:ss[Z]');
+        const datatype = new dataType();
+
+        if (datatype.mask && datatype.unmask) {
+          attrConverter = datatype;
+        }
+      }
+
+      if (attrConverter) {
+        if (!forSerialisation) {
+          return attrConverter.mask(value);
+        } else {
+          return attrConverter.unmask(value);
         }
       }
 
@@ -21,7 +35,7 @@ export function Attribute(serializedName?: string) {
       const targetType = Reflect.getMetadata('design:type', target, propertyName);
 
       const mappingMetadata = Reflect.getMetadata('AttributeMapping', target) || {};
-      const serializedPropertyName = serializedName !== undefined ? serializedName : propertyName;
+      const serializedPropertyName = options.serializedName !== undefined ? options.serializedName : propertyName;
       mappingMetadata[serializedPropertyName] = propertyName;
       Reflect.defineMetadata('AttributeMapping', mappingMetadata, target);
 
@@ -30,7 +44,7 @@ export function Attribute(serializedName?: string) {
       annotations[propertyName] = {
         newValue,
         oldValue,
-        serializedName,
+        serializedName: options.serializedName,
         hasDirtyAttributes: propertyHasDirtyAttributes,
         serialisationValue: converter(targetType, newValue, true)
       };

src/index.ts

@@ -11,8 +11,9 @@ export * from './models/json-api-query-data';
 
 export * from './interfaces/datastore-config.interface';
 export * from './interfaces/model-config.interface';
+export * from './interfaces/attribute-decorator-options.interface';
+export * from './interfaces/property-converter.interface';
 
 export * from './providers';
 
 export * from './module';
-

src/interfaces/attribute-decorator-options.interface.ts

@@ -0,0 +1,6 @@
+import { PropertyConverter } from './property-converter.interface';
+
+export interface AttributeDecoratorOptions {
+  serializedName?: string;
+  converter?: PropertyConverter;
+}

src/interfaces/property-converter.interface.ts

@@ -0,0 +1,4 @@
+export interface PropertyConverter {
+  mask(value: any): any;
+  unmask(value: any): any;
+}

src/services/json-api-datastore.service.spec.ts

@@ -108,10 +108,10 @@ describe('JsonApiDatastore', () => {
       backend.connections.subscribe((c: MockConnection) => {
         expect(c.request.url).not.toEqual(`${BASE_URL}/${API_VERSION}`);
         expect(c.request.url).toEqual(`${BASE_URL}/${API_VERSION}/` + 'authors?' +
-          encodeURIComponent('page[size]') + '=10&' +
-          encodeURIComponent('page[number]') + '=1&' +
-          encodeURIComponent('include') + '=comments&' +
-          encodeURIComponent('filter[title][keyword]') + '=Tolkien');
+            encodeURIComponent('page[size]') + '=10&' +
+            encodeURIComponent('page[number]') + '=1&' +
+            encodeURIComponent('include') + '=comments&' +
+            encodeURIComponent('filter[title][keyword]') + '=Tolkien');
         expect(c.request.method).toEqual(RequestMethod.Get);
       });
       datastore.query(Author, {
@@ -134,6 +134,7 @@ describe('JsonApiDatastore', () => {
         expect(c.request.headers.has('Authorization')).toBeTruthy();
         expect(c.request.headers.get('Authorization')).toBe('Bearer');
       });
+
       datastore.query(Author, null, new Headers({ Authorization: 'Bearer' })).subscribe();
     });
 
@@ -212,11 +213,13 @@ describe('JsonApiDatastore', () => {
 
     it('should fire error', () => {
       const resp = {
-        errors: [{
-          code: '100',
-          title: 'Example error',
-          detail: 'detailed error Message'
-        }]
+        errors: [
+          {
+            code: '100',
+            title: 'Example error',
+            detail: 'detailed error Message'
+          }
+        ]
       };
 
       backend.connections.subscribe((c: MockConnection) => {
@@ -227,15 +230,13 @@ describe('JsonApiDatastore', () => {
           })
         ));
       });
-      datastore.query(Author).subscribe((authors) => fail('onNext has been called'),
-        (response) => {
-          expect(response).toEqual(jasmine.any(ErrorResponse));
-          expect(response.errors.length).toEqual(1);
-          expect(response.errors[0].code).toEqual(resp.errors[0].code);
-          expect(response.errors[0].title).toEqual(resp.errors[0].title);
-          expect(response.errors[0].detail).toEqual(resp.errors[0].detail);
-        },
-        () => fail('onCompleted has been called'));
+      datastore.query(Author).subscribe((authors) => fail('onNext has been called'), (response) => {
+        expect(response).toEqual(jasmine.any(ErrorResponse));
+        expect(response.errors.length).toEqual(1);
+        expect(response.errors[0].code).toEqual(resp.errors[0].code);
+        expect(response.errors[0].title).toEqual(resp.errors[0].title);
+        expect(response.errors[0].detail).toEqual(resp.errors[0].detail);
+      }, () => fail('onCompleted has been called'));
     });
 
     it('should generate correct query string for array params with findAll', () => {
@@ -268,7 +269,6 @@ describe('JsonApiDatastore', () => {
           })
         ));
       });
-
       datastore.findRecord(Author, '1').subscribe((author) => {
         expect(author).toBeDefined();
         expect(author.id).toBe(AUTHOR_ID);
@@ -314,12 +314,10 @@ describe('JsonApiDatastore', () => {
           })
         ));
       });
-
       const author = datastore.createRecord(Author, {
         name: AUTHOR_NAME,
         date_of_birth: AUTHOR_BIRTH
       });
-
       author.save().subscribe((val) => {
         expect(val.id).toBeDefined();
         expect(val.id).toEqual('1');
@@ -331,11 +329,9 @@ describe('JsonApiDatastore', () => {
         expect(c.request.method).toEqual(RequestMethod.Post);
         c.mockRespond(new Response(new ResponseOptions({ status: 204 })));
       });
-
       const author = datastore.createRecord(Author, {
         name: AUTHOR_NAME
       });
-
       author.save().subscribe((val) => {
         expect(val).toBeDefined();
       });
@@ -351,16 +347,13 @@ describe('JsonApiDatastore', () => {
         expect(obj.relationships.books.data.length).toBe(1);
         expect(obj.relationships.books.data[0].id).toBe('10');
       });
-
       const author = datastore.createRecord(Author, {
         name: AUTHOR_NAME
       });
-
       author.books = [new Book(datastore, {
         id: '10',
         title: BOOK_TITLE
       })];
-
       author.save().subscribe();
     });
 
@@ -374,15 +367,12 @@ describe('JsonApiDatastore', () => {
         expect(obj.relationships.books.data.length).toBe(1);
         expect(obj.relationships.books.data[0].attributes.title).toBe(BOOK_TITLE);
       });
-
       const author = datastore.createRecord(Author, {
         name: AUTHOR_NAME
       });
-
       author.books = [datastore.createRecord(Book, {
         title: BOOK_TITLE
       })];
-
       author.save().subscribe();
     });
 
@@ -395,15 +385,12 @@ describe('JsonApiDatastore', () => {
         expect(obj.relationships).toBeDefined();
         expect(obj.relationships.author.data.id).toBe(AUTHOR_ID);
       });
-
       const book = datastore.createRecord(Book, {
         title: BOOK_TITLE
       });
-
       book.author = new Author(datastore, {
         id: AUTHOR_ID
       });
-
       book.save().subscribe();
     });
   });
@@ -420,16 +407,15 @@ describe('JsonApiDatastore', () => {
         expect(obj.id).toBe(AUTHOR_ID);
         expect(obj.type).toBe('authors');
         expect(obj.relationships).toBeUndefined();
-      });
 
+      });
       const author = new Author(datastore, {
         id: AUTHOR_ID,
         attributes: {
           date_of_birth: parse(AUTHOR_BIRTH),
           name: AUTHOR_NAME
         }
       });
-
       author.name = 'Rowling';
       author.date_of_birth = parse('1965-07-31');
       author.save().subscribe();

test/models/author.model.ts

@@ -13,12 +13,11 @@ export class Author extends JsonApiModel {
   @Attribute()
   name: string;
 
-  @Attribute('dob')
+  @Attribute({
+    serializedName: 'dob'
+  })
   date_of_birth: Date;
 
-  @Attribute()
-  date_of_death: Date;
-
   @Attribute()
   created_at: Date;