Lucid Model Unique IDs Column Type - UUID, CUID, ULID and Custom

[devhammed]

Hello everyone!

I just ported the HasUniqueIds trait logic from Laravel which allows generating IDs on the application level before persisting to the database, this is useful for when you want to use something like CUID or ULID or Snowflake ID which might not be supported natively by the database system you are running on.

I have implemented UUID, ULID and CUID columns for now but you can use the uniqueIdColumn decorator to implement what is needed.

import { cuid } from '@adonisjs/core/helpers'
import { ColumnOptions, DecoratorFn, LucidModel, LucidRow } from '@adonisjs/lucid/types/model'
import { ulid } from 'ulid'

export function uniqueIdColumn<ID>(
  options?: Partial<ColumnOptions> & {
    factory: (model: LucidRow) => Promise<ID> | ID
  }
): DecoratorFn {
  const { factory, ...columnOptions } = options ?? {}

  if (!factory) {
    throw new Error('Missing ID factory function.')
  }

  return function decoratedWithUniqueId(target, property) {
    const Model = target.constructor as LucidModel

    Model.boot()

    Model.$addColumn(property, columnOptions)

    Model.before('create', async (model: any) => {
      if (model[property] === undefined) {
        model[property] = await factory(model)
      }
    })
  }
}

export function cuidColumn(options?: Partial<ColumnOptions>): DecoratorFn {
  return uniqueIdColumn({
    ...(options ?? {}),
    factory: () => cuid(),
  })
}

export function ulidColumn(options?: Partial<ColumnOptions>): DecoratorFn {
  return uniqueIdColumn({
    ...(options ?? {}),
    factory: () => ulid().toLowerCase(),
  })
}

export function uuidColumn(options?: Partial<ColumnOptions>): DecoratorFn {
  return uniqueIdColumn({
    ...(options ?? {}),
    factory: () => crypto.randomUUID(),
  })
}

Hopefully, this gets merged into the Lucid core someday.