MorphMany

src/index.cjs.ts

@@ -16,6 +16,7 @@ import { BelongsTo } from './model/decorators/attributes/relations/BelongsTo'
 import { HasMany } from './model/decorators/attributes/relations/HasMany'
 import { HasManyBy } from './model/decorators/attributes/relations/HasManyBy'
 import { MorphOne } from './model/decorators/attributes/relations/MorphOne'
+import { MorphMany } from './model/decorators/attributes/relations/MorphMany'
 import { Attribute } from './model/attributes/Attribute'
 import { Type } from './model/attributes/types/Type'
 import { Attr as AttrAttr } from './model/attributes/types/Attr'
@@ -29,6 +30,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 { MorphMany as MorphManyAttr } from './model/attributes/relations/MorphMany'
 import { Repository } from './repository/Repository'
 import { Interpreter } from './interpreter/Interpreter'
 import { Query } from './query/Query'
@@ -51,6 +53,7 @@ export default {
   HasMany,
   HasManyBy,
   MorphOne,
+  MorphMany,
   Attribute,
   Type,
   AttrAttr,
@@ -64,6 +67,7 @@ export default {
   HasManyAttr,
   HasManyByAttr,
   MorphOneAttr,
+  MorphManyAttr,
   Repository,
   Interpreter,
   Query,

src/index.ts

@@ -17,6 +17,7 @@ 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/attributes/relations/MorphMany'
 export * from './model/decorators/Contracts'
 export * from './model/decorators/NonEnumerable'
 export * from './model/attributes/Attribute'
@@ -33,6 +34,7 @@ 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 { MorphMany as MorphManyAttr } from './model/attributes/relations/MorphMany'
 export * from './modules/RootModule'
 export * from './modules/RootState'
 export * from './modules/Module'
@@ -66,6 +68,7 @@ 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 { MorphMany as MorphManyAttr } from './model/attributes/relations/MorphMany'
 import { Repository } from './repository/Repository'
 import { Interpreter } from './interpreter/Interpreter'
 import { Query } from './query/Query'
@@ -92,6 +95,7 @@ export default {
   HasManyByAttr,
   MorphOneAttr,
   MorphToAttr,
+  MorphManyAttr,
   Repository,
   Interpreter,
   Query,

src/model/Model.ts

@@ -13,6 +13,7 @@ import { HasMany } from './attributes/relations/HasMany'
 import { HasManyBy } from './attributes/relations/HasManyBy'
 import { MorphOne } from './attributes/relations/MorphOne'
 import { MorphTo } from './attributes/relations/MorphTo'
+import { MorphMany } from './attributes/relations/MorphMany'
 
 export type ModelFields = Record<string, Attribute>
 export type ModelSchemas = Record<string, ModelFields>
@@ -263,6 +264,22 @@ export class Model {
     return new MorphTo(instance, relatedModels, id, type, ownerKey)
   }
 
+  /**
+   * Create a new MorphMany relation instance.
+   */
+  static morphMany(
+    related: typeof Model,
+    id: string,
+    type: string,
+    localKey?: string
+  ): MorphMany {
+    const model = this.newRawInstance()
+
+    localKey = localKey ?? model.$getLocalKey()
+
+    return new MorphMany(model, related.newRawInstance(), id, type, localKey)
+  }
+
   /**
    * Get the constructor for this model.
    */

src/model/attributes/relations/MorphMany.ts

@@ -0,0 +1,102 @@
+import { Schema as NormalizrSchema } from 'normalizr'
+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'
+
+export class MorphMany extends Relation {
+  /**
+   * The field name that contains id of the parent model.
+   */
+  protected morphId: string
+
+  /**
+   * The field name that contains type of the parent model.
+   */
+  protected morphType: string
+
+  /**
+   * The local key of the model.
+   */
+  protected localKey: string
+
+  /**
+   * Create a new morph-many relation instance.
+   */
+  constructor(
+    parent: Model,
+    related: Model,
+    morphId: string,
+    morphType: string,
+    localKey: string
+  ) {
+    super(parent, related)
+    this.morphId = morphId
+    this.morphType = morphType
+    this.localKey = localKey
+  }
+
+  /**
+   * Get all related models for the relationship.
+   */
+  getRelateds(): Model[] {
+    return [this.related]
+  }
+
+  /**
+   * Define the normalizr schema for the relation.
+   */
+  define(schema: Schema): NormalizrSchema {
+    return schema.many(this.related, this.parent)
+  }
+
+  /**
+   * Attach the parent type and id to the given relation.
+   */
+  attach(record: Element, child: Element): void {
+    child[this.morphId] = record[this.localKey]
+    child[this.morphType] = this.parent.$entity()
+  }
+
+  /**
+   * 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))
+  }
+
+  /**
+   * Match the eagerly loaded results to their parents.
+   */
+  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])
+        : model.$setRelation(relation, [])
+    })
+  }
+
+  /**
+   * 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]
+    })
+  }
+
+  /**
+   * Make related models.
+   */
+  make(elements?: Element[]): Model[] {
+    return elements
+      ? elements.map((element) => this.related.$newInstance(element))
+      : []
+  }
+}

src/model/decorators/attributes/relations/MorphMany.ts

@@ -0,0 +1,20 @@
+import { Model } from '../../../Model'
+import { PropertyDecorator } from '../../Contracts'
+
+/**
+ * Create a morph-many attribute property decorator.
+ */
+export function MorphMany(
+  related: () => typeof Model,
+  id: string,
+  type: string,
+  localKey?: string
+): PropertyDecorator {
+  return (target, propertyKey) => {
+    const self = target.$self()
+
+    self.setRegistry(propertyKey, () =>
+      self.morphMany(related(), id, type, localKey)
+    )
+  }
+}