Using ManyToMany with a dedicated Model

[dimitrisnl]

Hello, I've been reading the docs and it states that I don't have to create a Model for my pivot table.

So If I have extra metadata (like the proficiency column in the example), the way to go is the following

@manyToMany(() => Skill, {
  pivotColumns: ['proficiency'],
})
public skills: ManyToMany<typeof Skill>

---

In my case, I want to have a Model. I call my pivot table memberships, so I'll assign a lot of stuff that shouldn't be part of the User model. So whitelisting many columns in the Org model feels a bit awkward to me.

This could be wrong, but I'm trying to follow this article (Teams should be an MVP feature!) closely for now.

So, would the following models, work the same way?

// Org.ts
export default class Org extends BaseModel {
  // Other fields and hooks were removed for simplicity
  @column({isPrimary: true})
  public id: string;
  
  @hasMany(() => Membership)
  public memberships: HasMany<typeof Membership>;
}

// User.ts
export default class User extends BaseModel {
  // Other fields and hooks were removed for simplicity
  @column({isPrimary: true})
  public id: string;

  @hasMany(() => Membership)
  public memberships: HasMany<typeof Membership>;
}

// Membership.ts
export default class Membership extends BaseModel {
  // Other fields and hooks were removed for simplicity
  @column({isPrimary: true})
  public id: string;

  @column()
  public orgId: string;

  @column()
  public userId: string;

  @belongsTo(() => User)
  public user: BelongsTo<typeof User>;

  @belongsTo(() => Org)
  public org: BelongsTo<typeof Org>;
}

Again, is there any concern about doing it this way instead of utilizing the manyToMany decorator? So far, it looks good. I'm not sure if I'm missing/breaking something by not following the conventions thought.

🙇🏻

---

Resources:

1. https://blog.bullettrain.co/teams-should-be-an-mvp-feature/
2. https://github.com/adocasts/adonisjs-changelog-app
3. https://blitzjs.com/docs/multitenancy

[dimitrisnl]

Bump 😢