refactor: cleanup for making relationships and their types more consi…

…stent

The commit has some unfinished work

adonis-typings/model.txt

@@ -0,0 +1,90 @@
+    /**
+     * Save the related model.
+     */
+    save (model: T, wrapInTransaction?: boolean): Promise<void>
+
+    /**
+     * Save the related model.
+     */
+    saveMany (model: T[], wrapInTransaction?: boolean): Promise<void>
+
+    /**
+     * Create the related model instance
+     */
+    create (values: ModelObject, wrapInTransaction?: boolean): Promise<T>
+
+    /**
+     * Create many of the related model instance
+     */
+    createMany (values: ModelObject[], wrapInTransaction?: boolean): Promise<T[]>
+
+    /**
+     * Update the relationship or create a new one
+     */
+    updateOrCreate (
+      search: ModelObject,
+      updatePayload: ModelObject,
+      wrapInTransaction?: boolean,
+    ): Promise<T>
+
+
+
+
+    /**
+     * Associate related model.
+     */
+    associate (model: T, wrapInTransaction?: boolean): Promise<void>
+
+    /**
+     * Dissociate all relationships.
+     */
+    dissociate (): Promise<void>
+
+
+
+
+
+
+
+
+    /**
+     * Save related model
+     */
+    save (model: T, wrapInTransaction?: boolean, checkExisting?: boolean): Promise<void>
+
+    /**
+     * Save related many
+     */
+    saveMany (model: T[], wrapInTransaction?: boolean, checkExisting?: boolean): Promise<void>
+
+    /**
+     * Create the related model instance
+     */
+    create (values: ModelObject, wrapInTransaction?: boolean, checkExisting?: boolean): Promise<T>
+
+    /**
+     * Create many of the related model instance
+     */
+    createMany (values: ModelObject, wrapInTransaction?: boolean, checkExisting?: boolean): Promise<T[]>
+
+    /**
+     * Attach related
+     */
+    attach (
+      ids: (string | number)[] | { [key: string]: ModelObject },
+      checkExisting?: boolean,
+    ): Promise<void>
+
+    /**
+     * Detach from pivot table
+     */
+    detach (ids: (string | number)[]): Promise<void>
+
+    /**
+     * Sync related ids
+     */
+    sync (
+      ids: (string | number)[] | { [key: string]: ModelObject },
+      wrapInTransaction?: boolean,
+      checkExisting?: boolean,
+    ): Promise<void>

adonis-typings/orm.ts

@@ -9,30 +9,33 @@
 
 declare module '@ioc:Adonis/Lucid/Orm' {
   import {
-    ColumnFn,
-    HasOneFn,
-    HasManyFn,
-    ComputedFn,
-    BelongsToFn,
-    ManyToManyFn,
-    HasManyThroughFn,
+    ColumnDecorator,
+    ComputedDecorator,
     ModelConstructorContract,
   } from '@ioc:Adonis/Lucid/Model'
 
-  /**
-   * Generate key/value pair of model properties and
-   * adapter keys
-   */
-  export type Refs<T extends any, K extends keyof T> = {
-    [P in K]: string
-  }
+  import {
+    HasOneDecorator,
+    HasManyDecorator,
+    BelongsToDecorator,
+    ManyToManyDecorator,
+    HasManyThroughDecorator,
+  } from '@ioc:Adonis/Lucid/Relations'
+
+  export {
+    HasOne,
+    HasMany,
+    BelongsTo,
+    ManyToMany,
+    HasManyThrough,
+  } from '@ioc:Adonis/Lucid/Relations'
 
   export const BaseModel: ModelConstructorContract
-  export const column: ColumnFn
-  export const computed: ComputedFn
-  export const hasOne: HasOneFn
-  export const belongsTo: BelongsToFn
-  export const hasMany: HasManyFn
-  export const manyToMany: ManyToManyFn
-  export const hasManyThrough: HasManyThroughFn
+  export const column: ColumnDecorator
+  export const computed: ComputedDecorator
+  export const hasOne: HasOneDecorator
+  export const belongsTo: BelongsToDecorator
+  export const hasMany: HasManyDecorator
+  export const manyToMany: ManyToManyDecorator
+  export const hasManyThrough: HasManyThroughDecorator
 }