Version 2.0 (#36)

* Clean up code and update build packages
* Remove sjsId
* Move sjsOptions
* Add return type to toJSON
* Change return type of clone

Author: codeBelt

.eslintignore

@@ -0,0 +1,10 @@
+.generated
+.github
+.jest-cache
+.scripts
+.vscode
+docs
+node_modules
+tools
+build
+*.d.ts

.eslintrc.js

@@ -0,0 +1,101 @@
+// https://nextjs.org/docs/basic-features/eslint
+// https://paulintrognon.fr/blog/typescript-prettier-eslint-next-js
+
+module.exports = {
+  plugins: ['typescript-sort-keys', 'unused-imports'],
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:typescript-sort-keys/recommended',
+    // Make sure this is always the last configuration in the extends array.
+    'prettier',
+  ],
+  rules: {
+    // 0 = off, 1 = warn, 2 = error
+    '@typescript-eslint/no-explicit-any': 'off',
+    '@typescript-eslint/no-unused-vars': ['error', { args: 'none', ignoreRestSiblings: true }],
+    '@typescript-eslint/no-empty-interface': 'off',
+    '@typescript-eslint/no-inferrable-types': 'off',
+    '@typescript-eslint/no-empty-function': 'off',
+    '@typescript-eslint/interface-name-prefix': 0,
+    '@typescript-eslint/explicit-function-return-type': 0,
+    '@typescript-eslint/no-shadow': 2,
+    'array-bracket-spacing': [2, 'never'],
+    'no-return-await': 2,
+    'id-length': ['error', { exceptions: ['_', 'x', 'y', 'a', 'b'] }],
+    curly: 2,
+    'eol-last': 2,
+    'keyword-spacing': [
+      2,
+      {
+        before: true,
+        after: true,
+      },
+    ],
+    'import/no-cycle': [0, { maxDepth: 1 }],
+    'no-console': [2, { allow: ['warn', 'error', 'info', 'groupCollapsed', 'group', 'groupEnd'] }],
+    'no-const-assign': 2,
+    'no-empty-pattern': 2,
+    'no-eval': 2,
+    'no-global-assign': 2,
+    'no-mixed-spaces-and-tabs': 2,
+    'no-multi-assign': 2,
+    'no-multi-str': 2,
+    'no-trailing-spaces': 2,
+    'no-unreachable': 2,
+    'no-var': 2,
+    'no-whitespace-before-property': 2,
+    'object-curly-spacing': [2, 'always'],
+    'one-var': [2, 'never'],
+    'padded-blocks': [2, 'never'],
+    'padding-line-between-statements': [
+      2,
+      { blankLine: 'always', prev: '*', next: 'return' },
+      { blankLine: 'always', prev: ['const', 'let', 'var'], next: 'return' },
+      { blankLine: 'any', prev: ['const', 'let', 'var'], next: ['const', 'let', 'var'] },
+      { blankLine: 'always', prev: '*', next: 'multiline-block-like' },
+      { blankLine: 'always', prev: 'multiline-block-like', next: '*' },
+      { blankLine: 'never', prev: '*', next: 'case' },
+    ],
+    'prefer-const': 2,
+    'prefer-template': 2,
+    'react/prop-types': 0,
+    'space-before-blocks': [2, 'always'],
+    'newline-after-var': [2, 'always'],
+    'space-before-function-paren': [
+      2,
+      {
+        anonymous: 'never',
+        named: 'never',
+        asyncArrow: 'always',
+      },
+    ],
+    'space-infix-ops': 2,
+    'space-in-parens': [2, 'never'],
+    'template-curly-spacing': [2, 'never'],
+    'spaced-comment': [
+      2,
+      'always',
+      {
+        line: {
+          markers: ['/'],
+          exceptions: ['-'],
+        },
+        block: {
+          markers: ['/', '*'],
+        },
+      },
+    ],
+    'no-param-reassign': [2, { props: false }],
+    'dot-notation': [2, { allowPattern: '^[a-z]+(_[a-z]+)+$' }],
+    quotes: [2, 'single', { avoidEscape: true }],
+    'unused-imports/no-unused-imports': 2,
+  },
+  overrides: [
+    {
+      files: ['./**/*.test.ts'],
+      rules: {
+        'dot-notation': 'off',
+      },
+    },
+  ],
+};

.npmignore

@@ -1,11 +1,12 @@
-node_modules
-.rpt2_cache
-__tests__
 .editorconfig
+.eslintignore
+.eslintrc.js
 .npmrc
 .nvmrc
+.rpt2_cache
 .yarnrc
+__tests__
+node_modules
 rollup.config.js
 tsconfig.json
-tslint.json
 yarn.lock

README.md

@@ -191,16 +191,6 @@ export default class SomeModel extends BaseModel {
 
 There are a couple of properties on the `BaseModel`. If you call the `.toJSON();` method on the model it will remove all `sjs-base-model` specific properties.
 
-#### sjsId
-
-Each `sjs-base-model` that is created has a unique model id. You can access it by the `sjsId` property.
-
-```javascript
-const carModel = new CarModel();
-
-carModel.sjsId; // unique model id
-```
-
 #### sjsOptions
 
 Each `sjs-base-model` has an object on it that keeps track of options you can set. You can set these options by passing an object to the `super` method of the class constructor. Currently there is only the option `expand` which accepts a `boolean`. See the [BaseModel Expand Scaffolding](##masemodel-expand-scaffolding) section to learn more.
@@ -225,7 +215,7 @@ carModel.update({ year: 2015, feature: { abs: true } });
 
 #### toJSON()
 
-Converts the BaseModel data into a JSON object and deletes the sjsId property.
+Converts the BaseModel data into a JSON object.
 
 ```javascript
 const json = carModel.toJSON();
@@ -323,6 +313,8 @@ export default class CarModel extends BaseModel {
 
 ## Release History
 
+- 2022-04-20 v2.0.0 Remove `sjsId`, Move `sjsOptions` out of BaseModel, Add return type to `.toJSON()`, Change return type of `.clone()`, Change types exported paths.
+-
 - 2020-07-29 v1.9.1 Fix deletePropertyFromObject bug; If null was inside an array would cause the code to break.
 
 - 2019-06-23 v1.9.0 IConvertOption now happens before data is assigned to properties. Now if you use ConversionTypeEnum.JSON and have a default model it will create that new model instead of having a plain object.

__tests__/BaseModel.test.ts

@@ -9,23 +9,20 @@ import { NameModel } from './data/models/NameModel';
 import { AdminModel } from './data/models/AdminModel';
 
 describe('BaseModel', () => {
-  let json: any = null;
+  let json = data;
 
   beforeEach(() => {
-    json = Util.clone(data as any);
-  });
-
-  afterEach(() => {
-    json = null;
+    json = Util.clone(data);
   });
 
   test('update returns itself', () => {
     const baseModel = new BaseModel();
+
     expect(baseModel.update()).toEqual(baseModel);
   });
 
   test('should populate InfoModel', () => {
-    const model = new InfoModel(json.info);
+    const model = new InfoModel(json.info as any);
 
     expect(model.toJSON()).toEqual({
       ...json.info,
@@ -52,16 +49,14 @@ describe('BaseModel', () => {
 
     expect(model.info).toEqual(null);
     expect(model.results).toEqual([]);
-    expect(model.sjsOptions).toEqual({ expand: false });
   });
 
   test('should clone and not mutate data', () => {
-    const model = new UserResponseModel(json);
-    const clone = model.clone<UserResponseModel>();
+    const model = new UserResponseModel(json as any);
+    const clone = model.clone();
 
     clone.info.version = '888';
 
-    expect(model.info.sjsId).not.toEqual(clone.info.sjsId);
     expect(model.info).not.toEqual(clone.info);
     expect(model.toJSON()).not.toEqual(clone.toJSON());
   });
@@ -87,23 +82,31 @@ describe('BaseModel', () => {
   });
 
   test('should have default of UserResponseModel with null passed in', () => {
-    console.error('Ignore the "Something is wrong!" errors. They are expected.');
+    const consoleError = jest.spyOn(console, 'error').mockImplementation(() => {});
 
     const model = new UserResponseModel(null as any);
 
     expect(model.info).toEqual(null);
     expect(model.results).toEqual([]);
-    expect(model.sjsOptions).toEqual({ expand: false });
+    expect(consoleError).toBeCalledWith(
+      'Something is wrong! UserResponseModel only allows Objects but "null" was passed in.'
+    );
+
+    consoleError.mockReset();
   });
 
   test('should have populate UserResponseModel', () => {
-    const model = new UserResponseModel(json);
+    const model = new UserResponseModel(json as any);
 
     const expectedData = {
       ...json,
-      results: json.results.map((resultItem: any) =>
-        Util.deletePropertyFromObject(resultItem, ['location', 'login', 'dob', 'registered', 'phone', 'cell', 'id'])
-      ),
+      results: json.results.map((resultItem) => ({
+        gender: resultItem.gender,
+        name: resultItem.name,
+        picture: resultItem.picture,
+        email: resultItem.email,
+        nat: resultItem.nat,
+      })),
       info: {
         ...json.info,
         stringified: JSON.parse(json.info.stringified),
@@ -114,12 +117,16 @@ describe('BaseModel', () => {
   });
 
   test('should call update with empty object and have no changes', () => {
-    const model = new UserResponseModel(json);
+    const model = new UserResponseModel(json as any);
     const expectedData = {
       ...json,
-      results: json.results.map((resultItem: any) =>
-        Util.deletePropertyFromObject(resultItem, ['location', 'login', 'dob', 'registered', 'phone', 'cell', 'id'])
-      ),
+      results: json.results.map((resultItem) => ({
+        gender: resultItem.gender,
+        name: resultItem.name,
+        picture: resultItem.picture,
+        email: resultItem.email,
+        nat: resultItem.nat,
+      })),
       info: {
         ...json.info,
         stringified: JSON.parse(json.info.stringified),
@@ -132,15 +139,19 @@ describe('BaseModel', () => {
   });
 
   test('should have populate UserResponseModel from same UserResponseModel', () => {
-    let model = new UserResponseModel(json);
+    let model = new UserResponseModel(json as any);
 
     model = new UserResponseModel(model);
 
     const expectedData = {
       ...json,
-      results: json.results.map((resultItem: any) =>
-        Util.deletePropertyFromObject(resultItem, ['location', 'login', 'dob', 'registered', 'phone', 'cell', 'id'])
-      ),
+      results: json.results.map((resultItem) => ({
+        gender: resultItem.gender,
+        name: resultItem.name,
+        picture: resultItem.picture,
+        email: resultItem.email,
+        nat: resultItem.nat,
+      })),
       info: {
         ...json.info,
         stringified: JSON.parse(json.info.stringified),
@@ -151,7 +162,7 @@ describe('BaseModel', () => {
   });
 
   test('should update email results to one item in the array', () => {
-    const model = new UserResponseModel(json);
+    const model = new UserResponseModel(json as any);
 
     expect(model.results.length).toBe(3);
 
@@ -192,27 +203,22 @@ describe('BaseModel', () => {
 
   test('should populate UserModel', () => {
     const theData = json.results[0];
-    const model = new UserModel(theData);
-
-    // const hey = model.toJSON()
-    // hey.
+    const model = new UserModel(theData as any);
 
-    const expectedData = Util.deletePropertyFromObject(theData, [
-      'location',
-      'login',
-      'dob',
-      'registered',
-      'phone',
-      'cell',
-      'id',
-    ]);
+    const expectedData = {
+      gender: theData.gender,
+      name: theData.name,
+      picture: theData.picture,
+      email: theData.email,
+      nat: theData.nat,
+    };
 
     expect(model.toJSON()).toEqual(expectedData);
   });
 
   test('should update UserModel', () => {
     const theData = json.results[0];
-    const model = new UserModel(theData);
+    const model = new UserModel(theData as any);
 
     expect(model.email).toBe(theData.email);
     expect(model.name.last).toBe(theData.name.last);
@@ -257,18 +263,19 @@ describe('BaseModel', () => {
     expect(model.toJSON()).toEqual(expected);
   });
 
-  test('should test isObject', () => {
+  describe('should test isObject', () => {
     const model = new BaseModel();
 
     const objects: object[] = [{}, new UserResponseModel()];
     const nonObjects: any[] = [[], true, false, undefined, null, 8, 20.18, '🚀'];
 
-    // tslint:disable-next-line:no-string-literal
-    objects.forEach((object: object) => expect(model['_isObject'](object)).toBeTruthy());
-    // tslint:disable-next-line:no-string-literal
-    nonObjects.forEach((nonObject: any) => expect(model['_isObject'](nonObject)).toBeFalsy());
+    test.each(objects)('toBeTruthy', (object) => {
+      expect(model['_isObject'](object)).toBeTruthy();
+    });
 
-    console.error('Ignore the "Something is wrong!" errors. They are expected.');
+    test.each(nonObjects)('toBeTruthy', (nonObject) => {
+      expect(model['_isObject'](nonObject)).toBeFalsy();
+    });
   });
 
   test('should test IConversionOption', () => {
@@ -291,7 +298,6 @@ describe('BaseModel', () => {
 
   test('should test non existent keys on IConversionOption', () => {
     expect(() => {
-      // tslint:disable-next-line:no-unused-expression
       new NonExistentKeyConversionModel({});
     }).toThrow(SyntaxError);
   });