feat: pojo faker factory

common/changes/@cats-cradle/create-artifact/feature-pojo-faker-factory_2023-10-28-21-42.json

@@ -0,0 +1,10 @@
+{
+  "changes": [
+    {
+      "packageName": "@cats-cradle/create-artifact",
+      "comment": "",
+      "type": "none"
+    }
+  ],
+  "packageName": "@cats-cradle/create-artifact"
+}

libraries/faker-factory/.eslintrc.js

@@ -3,4 +3,7 @@ module.exports = {
   parserOptions: {
     tsconfigRootDir: __dirname,
   },
+  rules: {
+    'no-prototype-builtins': 'off',
+  },
 };

libraries/faker-factory/CHANGELOG.json

@@ -1,6 +1,18 @@
 {
   "name": "@cats-cradle/faker-factory",
   "entries": [
+    {
+      "version": "1.1.0",
+      "tag": "@cats-cradle/faker-factory_v1.1.0",
+      "date": "Sat, 28 Oct 2023 21:42:52 GMT",
+      "comments": {
+        "minor": [
+          {
+            "comment": "add to pojo option"
+          }
+        ]
+      }
+    },
     {
       "version": "1.0.4",
       "tag": "@cats-cradle/faker-factory_v1.0.4",

libraries/faker-factory/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Change Log - @cats-cradle/faker-factory
 
-This log was last generated on Wed, 04 Oct 2023 03:44:49 GMT and should not be manually modified.
+This log was last generated on Sat, 28 Oct 2023 21:42:52 GMT and should not be manually modified.
+
+## 1.1.0
+Sat, 28 Oct 2023 21:42:52 GMT
+
+### Minor changes
+
+- add to pojo option
 
 ## 1.0.4
 Wed, 04 Oct 2023 03:44:49 GMT

libraries/faker-factory/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cats-cradle/faker-factory",
-  "version": "1.0.4",
+  "version": "1.1.0",
   "main": "./dist/index.js",
   "repository": {
     "type": "git",

libraries/faker-factory/src/__tests__/faker-factory.test.ts

@@ -5,10 +5,19 @@ describe('FakerFactory', () => {
   describe('create', () => {
     let faker: SampleClass;
 
-    beforeAll(async () => {
+    beforeEach(async () => {
       faker = await FakerFactory.create<SampleClass>(SampleClass);
     });
 
+    it('should create a pojo faker object', async () => {
+      faker = await FakerFactory.create<SampleClass>(
+        SampleClass,
+        {},
+        { pojo: true },
+      );
+      expect(typeof faker).toBe('object');
+    });
+
     it('should create a faker object', () => {
       expect(typeof faker).toBe('object');
     });

libraries/faker-factory/src/__tests__/pojo.test.ts

@@ -0,0 +1,35 @@
+import { isPojo, toPojo } from '../pojo';
+
+class TestClass {
+  a: string;
+
+  b() {
+    return this.a;
+  }
+}
+
+describe('toPojo', () => {
+  it('should convert complex object into plain old javascript object', () => {
+    const sut = new TestClass();
+    sut.a = 'Test';
+
+    expect(toPojo(sut)).toEqual({ a: 'Test' });
+  });
+});
+
+describe('isPojo', () => {
+  it('should return false for non-pojo', () => {
+    const sut = new TestClass();
+    sut.a = 'Test';
+
+    expect(isPojo(sut)).toBeFalsy();
+  });
+
+  it('should return true for pojo', () => {
+    const sut = new TestClass();
+    sut.a = 'Test';
+    const pojo = sut;
+
+    expect(isPojo(pojo)).toBeFalsy();
+  });
+});

libraries/faker-factory/src/faker-factory.ts

@@ -3,6 +3,7 @@ import { cloneDeep } from 'lodash';
 import { Settings } from './settings';
 import { generateFakeData } from './generate-fake-data';
 import { getSchemas } from './schemas';
+import { toPojo } from './pojo';
 
 export class FakerFactory {
   public static create<T>(
@@ -30,6 +31,10 @@ export class FakerFactory {
       ...partialClone,
     });
 
+    if (settings?.pojo === true) {
+      return toPojo(objectInstance);
+    }
+
     return objectInstance as T;
   }
 }

libraries/faker-factory/src/index.ts

@@ -1 +1,3 @@
 export * from './faker-factory';
+export { toPojo, isPojo } from './pojo';
+export { Settings } from './settings';

libraries/faker-factory/src/pojo.ts

@@ -0,0 +1,34 @@
+/**
+ * toPojo
+ * @param obj
+ * @returns
+ */
+export function toPojo(obj: any): any {
+  if (obj === null || typeof obj !== 'object') {
+    return obj;
+  }
+
+  if (Array.isArray(obj)) {
+    return obj.map((item) => toPojo(item));
+  }
+
+  const result: { [key: string]: any } = {};
+  for (const key in obj) {
+    if (obj.hasOwnProperty(key)) {
+      result[key] = toPojo(obj[key]);
+    }
+  }
+
+  return result;
+}
+
+export function isPojo(obj: any): boolean {
+  if (typeof obj !== 'object' || obj === null) {
+    return false;
+  }
+
+  const prototype = Object.getPrototypeOf(obj);
+
+  // If the prototype is null, it's a plain object
+  return prototype === null;
+}

libraries/faker-factory/src/settings.ts

@@ -7,6 +7,12 @@ export interface Settings {
    */
   optionals?: boolean | undefined;
 
+  /**
+   * whether to return a plain old javascript object
+   * which is helpful when comparing rest request
+   */
+  pojo?: boolean | undefined;
+
   /**
    * whether optional properties are shown
    */

libraries/nestjs-modules/CHANGELOG.json

@@ -1,6 +1,18 @@
 {
   "name": "@cats-cradle/nestjs-modules",
   "entries": [
+    {
+      "version": "0.2.5",
+      "tag": "@cats-cradle/nestjs-modules_v0.2.5",
+      "date": "Sat, 28 Oct 2023 21:42:52 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@cats-cradle/faker-factory\" to `1.1.0`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.2.4",
       "tag": "@cats-cradle/nestjs-modules_v0.2.4",

libraries/nestjs-modules/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @cats-cradle/nestjs-modules
 
-This log was last generated on Wed, 04 Oct 2023 03:44:49 GMT and should not be manually modified.
+This log was last generated on Sat, 28 Oct 2023 21:42:52 GMT and should not be manually modified.
+
+## 0.2.5
+Sat, 28 Oct 2023 21:42:52 GMT
+
+_Version update only_
 
 ## 0.2.4
 Wed, 04 Oct 2023 03:44:49 GMT

libraries/nestjs-modules/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cats-cradle/nestjs-modules",
-  "version": "0.2.4",
+  "version": "0.2.5",
   "main": "./dist/index.js",
   "repository": {
     "type": "git",

libraries/validation-schemas/CHANGELOG.json

@@ -1,6 +1,18 @@
 {
   "name": "@cats-cradle/validation-schemas",
   "entries": [
+    {
+      "version": "0.3.1",
+      "tag": "@cats-cradle/validation-schemas_v0.3.1",
+      "date": "Sat, 28 Oct 2023 21:42:52 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@cats-cradle/faker-factory\" to `1.1.0`"
+          }
+        ]
+      }
+    },
     {
       "version": "0.3.0",
       "tag": "@cats-cradle/validation-schemas_v0.3.0",

libraries/validation-schemas/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @cats-cradle/validation-schemas
 
-This log was last generated on Sun, 22 Oct 2023 15:17:07 GMT and should not be manually modified.
+This log was last generated on Sat, 28 Oct 2023 21:42:52 GMT and should not be manually modified.
+
+## 0.3.1
+Sat, 28 Oct 2023 21:42:52 GMT
+
+_Version update only_
 
 ## 0.3.0
 Sun, 22 Oct 2023 15:17:07 GMT

libraries/validation-schemas/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cats-cradle/validation-schemas",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "main": "./dist/index.js",
   "license": "MIT",
   "repository": {

platform/create-artifact/src/__tests__/test-data/package-output.json

@@ -1,6 +1,6 @@
 {
   "name": "@cats-cradle/create-artifact",
-  "version": "1.1.1",
+  "version": "2.0.0",
   "license": "MIT",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",

services/authentication-service/CHANGELOG.json

@@ -1,6 +1,21 @@
 {
   "name": "@cats-cradle/authentication-service",
   "entries": [
+    {
+      "version": "1.0.6",
+      "tag": "@cats-cradle/authentication-service_v1.0.6",
+      "date": "Sat, 28 Oct 2023 21:42:52 GMT",
+      "comments": {
+        "dependency": [
+          {
+            "comment": "Updating dependency \"@cats-cradle/nestjs-modules\" to `0.2.5`"
+          },
+          {
+            "comment": "Updating dependency \"@cats-cradle/faker-factory\" to `1.1.0`"
+          }
+        ]
+      }
+    },
     {
       "version": "1.0.5",
       "tag": "@cats-cradle/authentication-service_v1.0.5",

services/authentication-service/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Change Log - @cats-cradle/authentication-service
 
-This log was last generated on Sat, 28 Oct 2023 04:52:47 GMT and should not be manually modified.
+This log was last generated on Sat, 28 Oct 2023 21:42:52 GMT and should not be manually modified.
+
+## 1.0.6
+Sat, 28 Oct 2023 21:42:52 GMT
+
+_Version update only_
 
 ## 1.0.5
 Sat, 28 Oct 2023 04:52:47 GMT

services/authentication-service/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@cats-cradle/authentication-service",
   "module": "commonjs",
-  "version": "1.0.5",
+  "version": "1.0.6",
   "scripts": {
     "dev": "nest start --debug --watch",
     "build": "tsc",