sjs-base-model

Install

$ npm install sjs-base-model

Usage

const apiData = {
 make: 'Tesla',
 model: 'Model S',
 YeAr: 2014,
 feature: {
 abs: true,
 airbags: true,
 },
 colors: [
 { id: 'red', name: 'Red' },
 { id: 'white', name: 'White' },
 ],
};

const carModel = new CarModel(apiData);

import { BaseModel } from 'sjs-base-model';
export default class CarModel extends BaseModel {
 make = '';
 model = '';
 year = null;
 feature = FeatureModel;
 colors = [ColorModel];
 constructor(data) {
 super();
 this.update(data);
 }
 update(data) {
 super.update(data);
 this.year = data.YeAr;
 }
}

import { BaseModel } from 'sjs-base-model';
export default class CarModel extends BaseModel {
 // The class properties must match the data properties being passed in. Otherwise they will be ignored
 make = '';
 model = '';
 year = null;
 // If data passed in is an object then a FeatureModel will be created
 // else the property will be set to null
 feature = FeatureModel;
 // If the data passed is an array then it will create a ColorModel for each item
 // else the property will be set to an empty array
 colors = [ColorModel];
 constructor(data) {
 super();
 this.update(data);
 }
 update(data) {
 super.update(data);
 // If the data doesn't match the property name
 // You can set the value(s) manually after the update super method has been called.
 this.year = data.YeAr;
 // Check out PropertyNormalizerUtility example below on how to normalize you data to
 // match the properties so you don't need to do it manually.
 }
}

BaseModel Conversion Types

const json = {
 "seed": "abc",
 "results": "3", // We want this to be a boolean
 "page": "1", // We want this to be a number
 "version": "1.1", // We want this to be a float number
 "value": 4 // We want this to be a string
 "statuses": "{\"complete\":\"Complete\"}" // We want this to be a JSON object
};
const model = new SomeModel(json);

import { BaseModel, ConversionTypeEnum } from 'sjs-base-model';
export default class SomeModel extends BaseModel {
 seed = '';
 results = false; // Previously string; converted to boolean by IConversionOption
 page = null; // Previously string; converted to number by IConversionOption
 version = null; // Previously string; converted to float by IConversionOption
 value = ''; // Previously number; converted to string by IConversionOption
 statuses = null; // Previously string; converted to JSON by IConversionOption
 constructor(data) {
 super();
 this.update(data);
 }
 update(data) {
 const conversionOptions = {
 results: ConversionTypeEnum.Boolean,
 page: ConversionTypeEnum.Number,
 version: ConversionTypeEnum.Float,
 value: ConversionTypeEnum.String,
 statuses: ConversionTypeEnum.JSON,
 };
 super.update(data, conversionOptions);
 }
}

import {BaseModel, ConversionTypeEnum, IConversionOption} from 'sjs-base-model';
export default class SomeModel extends BaseModel {
 public readonly seed: string = '';
 public readonly results: boolean = false; // Previously string; converted to boolean by IConversionOption
 public readonly page: number = null; // Previously string; converted to number by IConversionOption
 public readonly version: number = null; // Previously string; converted to float by IConversionOption
 public readonly value: string = ''; // Previously number; converted to string by IConversionOption
 public readonly statuses: object = null; // Previously string; converted to JSON by IConversionOption
 constructor(data: Partial<SomeModel>) {
 super();
 this.update(data);
 }
 public update(data: Partial<SomeModel>): void {
 const conversionOptions: IConversionOption = {
 results: ConversionTypeEnum.Boolean,
 page: ConversionTypeEnum.Number,
 version: ConversionTypeEnum.Float,
 value: ConversionTypeEnum.String,
 statuses: ConversionTypeEnum.JSON,
 };
 super.update(data, conversionOptions);
 }
}

BaseModel Properties

sjsOptions

constructor(data) {
 super({expand: true});
 this.update(data);
}

BaseModel Methods

update(json)

carModel.update({ year: 2015, feature: { abs: true } });

toJSON()

const json = carModel.toJSON();

toJSONString()

const jsonStr = carModel.toJSONString();

fromJSON(jsonString)

const str = '{"make":"Tesla","model":"Model S","year":2014}';
const carModel = new CarModel();
carModel.fromJSON(str);

clone()

const clone = carModel.clone();

TypeScript Usage

import { BaseModel } from 'sjs-base-model';
export default class CarModel extends BaseModel {
 make: string = '';
 model: string = '';
 year: number = null;
 feature: FeatureModel = FeatureModel as any;
 colors: ColorModel[] = [ColorModel as any];
 constructor(data: Partial<CarModel>) {
 super();
 this.update(data);
 }
 update(data: Partial<CarModel>): void {
 super.update(data);
 this.year = data.YeAr;
 }
}

Real World

BaseModel Expand Scaffolding

import { BaseModel } from 'sjs-base-model';
export default class CarModel extends BaseModel {
 make = '';
 model = '';
 year = null;
 feature = FeatureModel; // This will be an empty FeatureModel if no data is passed in
 colors = [ColorModel]; // This will be an empty array
 constructor(data) {
 super({ expand: true }); // Notice sjsOptions
 this.update(data);
 }
 update(data) {
 super.update(data);
 this.year = data.YeAr;
 }
}

Release History