serialization of JSON looks much nicer now

lib/entity/entity.ts

@@ -1,3 +1,5 @@
+import { SchemaDefinition } from "..";
+
 /**
  * A JavaScript object containing the underlying data of an {@link Entity}.
  */
@@ -7,7 +9,10 @@ export type EntityData = Record<string, number | boolean | string | string[]>;
  * A constructor that creates an {@link Entity} of type TEntity.
  * @template TEntity The {@link Entity} type.
  */
-export type EntityConstructor<TEntity> = new (id: string, data?: EntityData) => TEntity;
+export type EntityConstructor<TEntity> = new (
+  schemaDef: SchemaDefinition, 
+  id: string,
+  data?: EntityData) => TEntity;
 
 /**
  * An Entity is the class from which objects that Redis OM maps to are made. You need
@@ -27,12 +32,24 @@ export default abstract class Entity {
    */
   readonly entityData: EntityData;
 
+  private schemaDef: SchemaDefinition;
+
   /** 
    * Creates an new Entity.
    * @internal
    */
-  constructor(id: string, data: EntityData = {}) {
+  constructor(schemaDef: SchemaDefinition, id: string, data: EntityData = {}) {
+    this.schemaDef = schemaDef;
     this.entityId = id;
     this.entityData = data;
   }
+
+  toJSON() {
+    let json: Record<string, any> = { entityId: this.entityId }
+    console.log(Object.getOwnPropertyDescriptors(this));
+    for (let key in this.schemaDef) {
+      json[key] = (this as Record<string, any>)[key];
+    }
+    return json;
+  }
 }

lib/repository/repository.ts

@@ -112,7 +112,7 @@ export default class Repository<TEntity extends Entity> {
    */
   createEntity(data: EntityCreationData = {}): TEntity {
     let id = this.schema.generateId();
-    let entity = new this.schema.entityCtor(id);
+    let entity = new this.schema.entityCtor(this.schema.definition, id);
     for (let key in data) {
       if (this.schema.entityCtor.prototype.hasOwnProperty(key)) {
         (entity as Record<string, any>)[key] = data[key]
@@ -178,7 +178,7 @@ export default class Repository<TEntity extends Entity> {
       entityData = this.hashConverter.toEntityData(hashData);
     }
 
-    let entity = new this.schema.entityCtor(id, entityData);
+    let entity = new this.schema.entityCtor(this.schema.definition, id, entityData);
     return entity;
   }
 

lib/schema/schema-definitions.ts

@@ -56,13 +56,7 @@ export type FieldDefinition = NumericField | StringField | BooleanField | ArrayF
 /**
 * Group of {@link FieldDefinition}s that define the schema for an {@link Entity}.
  */
-export type SchemaDefinition = {
-  /**
-   * The key determines the propery name that is added to the {@link Entity}. The property
-   * contains a {@link FieldDefinition} that tell Redis OM how to map the property to Redis.
-   */
-  [key: string]: FieldDefinition
-}
+export type SchemaDefinition = Record<string, FieldDefinition>;
 
 /** A function that generates random {@link Entity.entityId | Entity IDs}. */
 export type IdStrategy = () => string;

lib/search/results-converter.ts

@@ -56,7 +56,7 @@ export class HashSearchResultsConverter<TEntity extends Entity> extends SearchRe
 
     let converter = new HashConverter(this.schema.definition);
     let entityData: EntityData = converter.toEntityData(hashData);
-    return new this.schema.entityCtor(id, entityData);
+    return new this.schema.entityCtor(this.schema.definition, id, entityData);
   }
 }
 
@@ -66,6 +66,6 @@ export class JsonSearchResultsConverter<TEntity extends Entity> extends SearchRe
     let jsonData: JsonData = JSON.parse(jsonString);
     let converter = new JsonConverter(this.schema.definition);
     let entityData: EntityData = converter.toEntityData(jsonData);
-    return new this.schema.entityCtor(id, entityData);
+    return new this.schema.entityCtor(this.schema.definition, id, entityData);
   }
 }

spec/unit/entity/entity.spec.ts

@@ -1,4 +1,4 @@
-import { AliasedEntity, SimpleEntity } from '../helpers/test-entity-and-schema';
+import { AliasedEntity, aliasedSchema, SimpleEntity, simpleSchema } from '../helpers/test-entity-and-schema';
 
 describe("Entity", () => {
 
@@ -8,27 +8,31 @@ describe("Entity", () => {
 
     let entity: SimpleEntity;
 
-    beforeEach(() => entity = new SimpleEntity(entityId));
+    beforeEach(() => entity = new SimpleEntity(simpleSchema.definition, entityId));
 
     it("has the passed in Redis ID", () => expect(entity.entityId).toBe(entityId));
     it("returns null for the number property", () => expect(entity.aNumber).toBeNull());
     it("returns null for the string property", () => expect(entity.aString).toBeNull());
     it("returns null for the boolean property", () => expect(entity.aBoolean).toBeNull());
     it("returns null for the array property", () => expect(entity.anArray).toBeNull());
+    it("serializes to the expected JSON", () => expect(JSON.stringify(entity))
+      .toBe('{"entityId":"foo","aString":null,"aNumber":null,"aBoolean":null,"anArray":null}'));
   });
 
   describe("with data", () => {
 
     let entity: SimpleEntity;
 
-    beforeEach(() => entity = new SimpleEntity(entityId,
+    beforeEach(() => entity = new SimpleEntity(simpleSchema.definition, entityId,
       { aNumber: 42, aString: 'foo', aBoolean: false, anArray: [ "foo", "bar", "baz"] }));
 
     it("has the passed in Redis ID", () => expect(entity.entityId).toBe(entityId));
     it("returns a number for the number property", () => expect(entity.aNumber).toBe(42));
     it("returns a string for the string property", () => expect(entity.aString).toBe('foo'));
     it("returns a boolean for the boolean property", () => expect(entity.aBoolean).toBe(false));
     it("returns an array for the array property", () => expect(entity.anArray).toEqual([ 'foo', 'bar', 'baz' ]));
+    it("serializes to the expected JSON", () => expect(JSON.stringify(entity))
+      .toBe('{"entityId":"foo","aString":"foo","aNumber":42,"aBoolean":false,"anArray":["foo","bar","baz"]}'));
 
     describe("changing the data", () => {
       it("stores a number when the number property is changed", () => {
@@ -145,14 +149,16 @@ describe("Entity", () => {
 
     let entity: AliasedEntity;
 
-    beforeEach(() => entity = new AliasedEntity(entityId,
+    beforeEach(() => entity = new AliasedEntity(aliasedSchema.definition, entityId,
       { anotherNumber: 23, anotherString: 'bar', anotherBoolean: true, anotherArray: [ "bar", "baz", "qux" ] }));
 
     it("has the passed in Redis ID", () => expect(entity.entityId).toBe(entityId));
     it("returns a number for the number property", () => expect(entity.aNumber).toBe(23));
     it("returns a string for the string property", () => expect(entity.aString).toBe('bar'));
     it("returns a boolean for the boolean property", () => expect(entity.aBoolean).toBe(true));
     it("returns an array for the array property", () => expect(entity.anArray).toEqual([ 'bar', 'baz', 'qux' ]));
+    it("serializes to the expected JSON", () => expect(JSON.stringify(entity))
+      .toBe('{"entityId":"foo","aString":"bar","aNumber":23,"aBoolean":true,"anArray":["bar","baz","qux"]}'));
 
     describe("changing the data", () => {
       it("stores a number when the number property is changed", () => {

spec/unit/helpers/test-entity-and-schema.ts

@@ -29,7 +29,7 @@ export interface AliasedEntity {
   aNumber?: number | null;
   aBoolean?: boolean | null;
   anArray?: string[] | null;
-}  
+}
 
 export const simpleSchema = new Schema(SimpleEntity, {
   aString: { type: 'string' },

spec/unit/schema/schema-fields.spec.ts

@@ -303,7 +303,7 @@ describe("Schema", () => {
     beforeEach(() => {
       let entityData: EntityData = {};
       entityData[data.providedEntityFieldName] = data.providedEntityFieldValue;
-      entity = new TestEntity('foo', entityData)
+      entity = new TestEntity(data.schemaDef, 'foo', entityData)
     });
 
     it("adds the getter and setter for the field from the schema definition to the entity", () => {