feat: add MorphTo relation (#106)

Co-authored-by: ryandialpad <[email protected]>
Co-authored-by: Cue <[email protected]>

Author: 3 people

src/database/Database.ts

@@ -1,6 +1,6 @@
 import { Store } from 'vuex'
 import { schema as Normalizr } from 'normalizr'
-import { Schema } from '../schema/Schema'
+import { Schema, Schemas } from '../schema/Schema'
 import { Model } from '../model/Model'
 import { Relation } from '../model/attributes/relations/Relation'
 import { State } from '../modules/State'
@@ -26,7 +26,7 @@ export class Database {
   /**
    * The schema definition for the registered models.
    */
-  schemas: Record<string, Normalizr.Entity> = {}
+  schemas: Schemas = {}
 
   /**
    * Whether the database has already been installed to Vuex or not.

src/index.ts

@@ -16,6 +16,7 @@ export * from './model/decorators/attributes/relations/BelongsTo'
 export * from './model/decorators/attributes/relations/HasMany'
 export * from './model/decorators/attributes/relations/HasManyBy'
 export * from './model/decorators/attributes/relations/MorphOne'
+export * from './model/decorators/attributes/relations/MorphTo'
 export * from './model/decorators/Contracts'
 export * from './model/decorators/NonEnumerable'
 export * from './model/attributes/Attribute'
@@ -31,6 +32,7 @@ export { BelongsTo as BelongsToAttr } from './model/attributes/relations/Belongs
 export { HasMany as HasManyAttr } from './model/attributes/relations/HasMany'
 export { HasManyBy as HasManyByAttr } from './model/attributes/relations/HasManyBy'
 export { MorphOne as MorphOneAttr } from './model/attributes/relations/MorphOne'
+export { MorphTo as MorphToAttr } from './model/attributes/relations/MorphTo'
 export * from './modules/RootModule'
 export * from './modules/RootState'
 export * from './modules/Module'
@@ -63,6 +65,7 @@ import { BelongsTo as BelongsToAttr } from './model/attributes/relations/Belongs
 import { HasMany as HasManyAttr } from './model/attributes/relations/HasMany'
 import { HasManyBy as HasManyByAttr } from './model/attributes/relations/HasManyBy'
 import { MorphOne as MorphOneAttr } from './model/attributes/relations/MorphOne'
+import { MorphTo as MorphToAttr } from './model/attributes/relations/MorphTo'
 import { Repository } from './repository/Repository'
 import { Interpreter } from './interpreter/Interpreter'
 import { Query } from './query/Query'
@@ -88,6 +91,7 @@ export default {
   HasManyAttr,
   HasManyByAttr,
   MorphOneAttr,
+  MorphToAttr,
   Repository,
   Interpreter,
   Query,

src/model/Model.ts

@@ -12,6 +12,7 @@ import { BelongsTo } from './attributes/relations/BelongsTo'
 import { HasMany } from './attributes/relations/HasMany'
 import { HasManyBy } from './attributes/relations/HasManyBy'
 import { MorphOne } from './attributes/relations/MorphOne'
+import { MorphTo } from './attributes/relations/MorphTo'
 
 export type ModelFields = Record<string, Attribute>
 export type ModelSchemas = Record<string, ModelFields>
@@ -247,6 +248,21 @@ export class Model {
     return new MorphOne(model, related.newRawInstance(), id, type, localKey)
   }
 
+  /**
+   * Create a new MorphTo relation instance.
+   */
+  static morphTo(
+    related: typeof Model[],
+    id: string,
+    type: string,
+    ownerKey: string = ''
+  ): MorphTo {
+    const instance = this.newRawInstance()
+    const relatedModels = related.map((model) => model.newRawInstance())
+
+    return new MorphTo(instance, relatedModels, id, type, ownerKey)
+  }
+
   /**
    * Get the constructor for this model.
    */
@@ -332,16 +348,17 @@ export class Model {
    */
   protected $fillField(key: string, attr: Attribute, value: any): void {
     if (value !== undefined) {
-      this[key] = attr.make(value)
-      return
-    }
+      this[key] =
+        attr instanceof MorphTo
+          ? attr.make(value, this[attr.getType()])
+          : attr.make(value)
 
-    if (this[key] !== undefined) {
-      this[key] = this[key]
       return
     }
 
-    this[key] = attr.make()
+    if (this[key] === undefined) {
+      this[key] = attr.make()
+    }
   }
 
   /**

src/model/attributes/relations/BelongsTo.ts

@@ -84,20 +84,29 @@ export class BelongsTo extends Relation {
   /**
    * Match the eagerly loaded results to their respective parents.
    */
-  match(relation: string, models: Collection, results: Collection): void {
-    const dictionary = results.reduce<Record<string, Model>>((dic, result) => {
-      dic[result[this.ownerKey]] = result
-
-      return dic
-    }, {})
+  match(relation: string, models: Collection, query: Query): void {
+    const dictionary = this.buildDictionary(query.get())
 
     models.forEach((model) => {
-      dictionary[model[this.foreignKey]]
-        ? model.$setRelation(relation, dictionary[model[this.foreignKey]])
+      const key = model[this.foreignKey]
+
+      dictionary[key]
+        ? model.$setRelation(relation, dictionary[key])
         : model.$setRelation(relation, null)
     })
   }
 
+  /**
+   * Build model dictionary keyed by relation's parent key.
+   */
+  protected buildDictionary(models: Collection): Record<string, Model> {
+    return models.reduce<Record<string, Model>>((dictionary, model) => {
+      dictionary[model[this.ownerKey]] = model
+
+      return dictionary
+    }, {})
+  }
+
   /**
    * Make a related model.
    */

src/model/attributes/relations/HasMany.ts

@@ -3,7 +3,7 @@ import { Schema } from '../../../schema/Schema'
 import { Element, Collection } from '../../../data/Data'
 import { Query } from '../../../query/Query'
 import { Model } from '../../Model'
-import { Relation, Dictionary } from './Relation'
+import { Dictionary, Relation } from './Relation'
 
 export class HasMany extends Relation {
   /**
@@ -61,8 +61,8 @@ export class HasMany extends Relation {
   /**
    * Match the eagerly loaded results to their parents.
    */
-  match(relation: string, models: Collection, results: Collection): void {
-    const dictionary = this.buildDictionary(results)
+  match(relation: string, models: Collection, query: Query): void {
+    const dictionary = this.buildDictionary(query.get())
 
     models.forEach((model) => {
       const key = model[this.localKey]

src/model/attributes/relations/HasManyBy.ts

@@ -105,12 +105,8 @@ export class HasManyBy extends Relation {
   /**
    * Match the eagerly loaded results to their parents.
    */
-  match(relation: string, models: Collection, results: Collection): void {
-    const dictionary = results.reduce<Record<string, Model>>((dic, result) => {
-      dic[result[this.ownerKey]] = result
-
-      return dic
-    }, {})
+  match(relation: string, models: Collection, query: Query): void {
+    const dictionary = this.buildDictionary(query.get())
 
     models.forEach((model) => {
       const relatedModels = this.getRelatedModels(
@@ -122,6 +118,17 @@ export class HasManyBy extends Relation {
     })
   }
 
+  /**
+   * Build model dictionary keyed by the relation's foreign key.
+   */
+  protected buildDictionary(models: Collection): Record<string, Model> {
+    return models.reduce<Record<string, Model>>((dictionary, model) => {
+      dictionary[model[this.ownerKey]] = model
+
+      return dictionary
+    }, {})
+  }
+
   /**
    * Get all related models from the given dictionary.
    */

src/model/attributes/relations/HasOne.ts

@@ -61,8 +61,8 @@ export class HasOne extends Relation {
   /**
    * Match the eagerly loaded results to their parents.
    */
-  match(relation: string, models: Collection, results: Collection): void {
-    const dictionary = this.buildDictionary(results)
+  match(relation: string, models: Collection, query: Query): void {
+    const dictionary = this.buildDictionary(query.get())
 
     models.forEach((model) => {
       const key = model[this.localKey]

src/model/attributes/relations/MorphOne.ts

@@ -3,7 +3,7 @@ import { Schema } from '../../../schema/Schema'
 import { Element, Collection } from '../../../data/Data'
 import { Query } from '../../../query/Query'
 import { Model } from '../../Model'
-import { Relation, Dictionary } from './Relation'
+import { Relation } from './Relation'
 
 export class MorphOne extends Relation {
   /**
@@ -63,32 +63,35 @@ export class MorphOne extends Relation {
    * Set the constraints for an eager load of the relation.
    */
   addEagerConstraints(query: Query, models: Collection): void {
-    query.where(this.morphType, this.parent.$entity())
-    query.whereIn(this.morphId, this.getKeys(models, this.localKey))
+    query
+      .where(this.morphType, this.parent.$entity())
+      .whereIn(this.morphId, this.getKeys(models, this.localKey))
   }
 
   /**
    * Match the eagerly loaded results to their parents.
    */
-  match(relation: string, models: Collection, results: Collection): void {
-    const dictionary = this.buildDictionary(results)
+  match(relation: string, models: Collection, query: Query): void {
+    const dictionary = this.buildDictionary(query.get())
 
     models.forEach((model) => {
       const key = model[this.localKey]
 
       dictionary[key]
-        ? model.$setRelation(relation, dictionary[key][0])
+        ? model.$setRelation(relation, dictionary[key])
         : model.$setRelation(relation, null)
     })
   }
 
   /**
    * Build model dictionary keyed by the relation's foreign key.
    */
-  protected buildDictionary(results: Collection): Dictionary {
-    return this.mapToDictionary(results, (result) => {
-      return [result[this.morphId], result]
-    })
+  protected buildDictionary(models: Collection): Record<string, Model> {
+    return models.reduce<Record<string, Model>>((dictionary, model) => {
+      dictionary[model[this.morphId]] = model
+
+      return dictionary
+    }, {})
   }
 
   /**