adonis-models-utilities v1.0.0

adonis-model-utilities

A set of tools to use within your AdonisJS models

1. Install

Install npm module:

$ adonis install adonis-model-utilities

2. Register provider

Once you have installed adonis-cast-attributes, make sure to register the provider inside start/app.js in order to make use of it.

const providers = [
  'adonis-model-utilities/providers/ModelUtilitiesProvider'
]

3. Use:

Title Case Trait:

Add trait to the model and set the field that should be TitleCase:

class User {
  static super () {
    super.boot()

    /**
     * add trait TitleCaseAttributes
    */
    this.addTrait('@provider:TitleCaseAttributes')
  }
  
  /**
   * add getter titleCases to inform trait what fields that should be treated
  */
  static get titleCases () {
    return ['name', 'lastName']
  }

}

Format Currency Trait:

Add trait to the model and set the fields that should be formatted:

class Product {
  static super () {
    super.boot()

    /**
     * add trait FormatCurrencyAttributes
    */
    this.addTrait('@provider:FormatCurrencyAttributes', {symbol: 'R$ '})
  }
  
  /**
   * add getter currencies to inform trait what fields that should apply the trait
  */
  static get currencies () {
    return ['price']
  }

}

This trait apply or add computed properties for the model, not changing the original field

Trait options (*optional)

  {
    symbol : "US$ ",   // default currency symbol is '$'
    format: "%s%v", // controls output: %s = symbol, %v = value/number (can be object: see below)
    decimal : ",",  // decimal point separator
    thousand: ".",  // thousands separator
    precision : 2   // decimal places
  }

Format Date Trait:

Add trait to the model and set the fields that should be formatted:

class User {
  static super () {
    super.boot()

    /**
     * add trait FormatDateAttributes
    */
    this.addTrait('@provider:FormatDataAttributes', {unformatted: 'YYYY-MM-DD', formatted: 'DD/MM/YY'})
  }
  
  /**
   * add getter currencies to inform trait what fields that should apply the trait
  */
  static get formattedDates () {
    return [
      {
        field: 'bday',
        setter: true,
        getter: true 
      }
    ]
  }

}

You can set the trait to only apply the getter, setter or both to the field

This trait shouldnt be used on created_at and updated_at columns or dates setted using AdonisJS dates mutator

Trait options (*optional)

  {
    unformatted: 'YYYY-MM-DD',
    formatted: 'DD/MM/YYYY'
  }

Uuid hook:

Add trait to the model and set the fields that should be formatted:

class User {

  static super () {
    super.boot()

    /**
     * Add uuid generate hook
     */
    this.addHook('beforeCreate', '@provider:UuidHook.id')
  }
  
  /**
  * Set incrementing to false to inform Adonis to not increment the id field
  */
  static get incrementing () {
    return false
  }

}

Example of migration using UUID

class UserSchema extends Schema {
  up () {
    this.create('users', (table) => {
      table.uuid('id').index().unique().notNullable()
    })
  }
  down () {
    this.drop('users')
  }
}

Built With

• Adonis
• Moment
• Accounting

Author

• Igor Trindade - Developer
• github.com/igortrinidad
• https://igortrindade.dev

License

This project is licensed under the MIT License - see the LICENSE file for details.

Changelog

• v1.0.0

  • Initial release.