Use ts-morph to read models and properties

[tomgobich]

Try to use ts-morph to read models and their properties instead of manually going through the file as plaintext.

https://ts-morph.com

[ranseur92]

I've done a bit of testing on this,

Produces the following output:

Generating types for user.ts User
{
  fields: {
    id: 'number',
    fullName: 'null | string',
    email: '"test" | 55',
    createdAt: 'string',
    updatedAt: 'null | string'
  },
  imports: Set(0) {}
}


Generating types for test/test.ts Test
{
  fields: {
    id: 'number',
    createdAt: 'string',
    updatedAt: 'null | string',
    userId: 'number',
    user: 'User',
    userHasOne: 'User',
    userHasMany: 'User[]',
    userManyToMany: 'User[]',
    userHasManyThrough: 'User[]',
    hello: 'null | string',
    hmm: 'number'
  },
  imports: Set(1) { 'UserDTO' }
}

Based off of the following models

import type { DateTime } from 'luxon'
import { withAuthFinder } from '@adonisjs/auth/mixins/lucid'
import { compose } from '@adonisjs/core/helpers'
import hash from '@adonisjs/core/services/hash'
import { BaseModel, column } from '@adonisjs/lucid/orm'

const AuthFinder = withAuthFinder(() => hash.use('scrypt'), {
  uids: ['email'],
  passwordColumnName: 'password',
})

export default class User extends compose(BaseModel, AuthFinder) {
  @column({ isPrimary: true })
  declare id: number

  @column()
  declare fullName: string | null

  @column({ serialize(value) {
    if (value > 44) {
      return 'test'
    }
    return 55
  } })
  declare email: string

  @column({ serializeAs: null })
  declare password: string

  @column.dateTime({ autoCreate: true })
  declare createdAt: DateTime

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  declare updatedAt: DateTime | null
}


import type { BelongsTo, HasMany, HasManyThrough, HasOne, ManyToMany } from '@adonisjs/lucid/types/relations'
import type { DateTime } from 'luxon'
import User from '#models/user'
import { BaseModel, belongsTo, column, computed, hasMany, hasManyThrough, hasOne, manyToMany } from '@adonisjs/lucid/orm'

export default class Test extends BaseModel {
  @column({ isPrimary: true })
  declare id: number

  @column.dateTime({ autoCreate: true })
  declare createdAt: DateTime

  @column.dateTime({ autoCreate: true, autoUpdate: true })
  declare updatedAt: DateTime | null

  @column()
  declare userId: number

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

  @hasOne(() => User)
  declare userHasOne: HasOne<typeof User>

  @hasMany(() => User)
  declare userHasMany: HasMany<typeof User>

  @manyToMany(() => User)
  declare userManyToMany: ManyToMany<typeof User>

  @hasManyThrough([() => User, () => Test])
  declare userHasManyThrough: HasManyThrough<typeof User>

  @computed({ serializeAs: 'hello' })
  get excerpt() {
    return this.user.fullName
  }

  @computed({ serializeAs: undefined })
  get hmm() {
    return 44
  }
}

let me know if you're interested.

[tomgobich]

Hey Cory! Yeah definitely, this looks really promising. Thank you!