Add typings for Relations

nounder · koskimas · commit cdf3a542d7c7 · 2018-07-28T21:11:38.000+03:00
diff --git a/typings/objection/index.d.ts b/typings/objection/index.d.ts
@@ -183,8 +183,23 @@ declare namespace Objection {
     [relationName: string]: RelationMapping;
   }
 
+  interface RelationProperty {
+    size: number;
+    modelClass: Model;
+    props: string[];
+    cols: string[];
+  }
+
   interface Relation {
-    // TODO should this be something other than a tagging interface?
+    name: string;
+    ownerModelClass: Model;
+    relatedModelClass: Model;
+    ownerProp: RelationProperty;
+    relatedProp: RelationProperty;
+    joinModelClass: Function;
+    joinTable: string;
+    joinTableOwnerProp: RelationProperty;
+    joinTableRelatedProp: RelationProperty;
   }
 
   export interface RelationJoin {
@@ -462,6 +477,8 @@ declare namespace Objection {
     static WhereInEagerAlgorithm: EagerAlgorithm;
     static NaiveEagerAlgorithm: EagerAlgorithm;
 
+    static getRelations(): { [key: string]: Relation }
+
     static query<QM extends Model>(
       this: Constructor<QM>,
       trxOrKnex?: Transaction | knex
