Model setup

Next, in the model, import the attachment decorator and the Attachment type from the package.

Make sure NOT to use the @column decorator when using the @attachment decorator.

import { BaseModel } from '@adonisjs/lucid/orm'
import { attachment } from '@jrmc/adonis-attachment'
import type { Attachment } from '@jrmc/adonis-attachment/types/attachment'

class User extends BaseModel { 
  @attachment() 
  declare avatar: Attachment
}

Specifying folder

You can also store files inside the subfolder by defining the folder property as follows.

class User extends BaseModel {
  @attachment({ folder: 'uploads/avatars' }) 
  declare avatar: Attachment
}

by path parameters (⚠️ avalable in v4.0.0)

class User extends BaseModel {
  @column()
  declare name: string

  @attachment({ folder: 'uploads/:name/avatars' }) 
  declare avatar: Attachment
}

Only parameters of the string type are allowed. Additionally, the following processes are performed:

• lowercase
• escape html
• no case
• slugify

custom (⚠️ avalable in v4.0.0)

class User extends BaseModel {
  @column()
  declare name: string

  @attachment({ folder: () => DateTime.now().toFormat('yyyy/MM') }) 
  declare avatar: Attachment

  @attachment({ folder: (user: User) => user.name }) 
  declare file: Attachment
}

⚠️ :id autoincrement parameter is not defined on first save

Specifying variants

Generate variants

class User extends BaseModel {
  @attachment({
    variants: ['thumbnail', 'medium', 'large'] 
  })
  declare avatar: Attachment
}

Specifying disk

You can specify type of disk to use, default is defined in default adonis/drive config

class User extends BaseModel {
  @attachment({ disk: 's3' }) 
  declare avatar: Attachment
}

Specifying preComputeUrl

⚠️ avalable in v2.2.0

You can enabled pre compute the URLs after SELECT queries, default is false

class User extends BaseModel {
  @attachment({ preComputeUrl: true }) 
  declare avatar: Attachment
}

Specifying meta

⚠️ avalable in v2.1.0

You can disabled meta generation, default is true

class User extends BaseModel {
  @attachment({ meta: false }) 
  declare avatar: Attachment
}

Specifying rename

⚠️ avalable in v2.1.0

You can disabled rename file, default is true

class User extends BaseModel {
  @attachment({ rename: false }) 
  declare avatar: Attachment
}

Re-naming properties

⚠️ avalable in v4.0.0

Just like the other Lucid attributes, you can rename the serialized property names by using the serializeAs option. You will still access the property by its actual name on the model, but the serialized output will use the serializeAs name. For example:

@attachment({
  serializeAs: 'avatar', 
})
declare file: Attachment | null

/**
 {
  avatar: {
    "name": 'lj9kbwvb8gqq8pjsmuog369l.jpg',
    "originalName": 'photo_2023-11-19_00-21-49.jpg',
    "size": 201654,
    "extname": 'jpg',
    "mimeType": 'image/jpeg',
    ...
  }
 } 
*/

Hiding properties

⚠️ avalable in v4.0.0

You can remove the model properties from the serialized output by setting the serializeAs value to null. For example:

@attachment({
  serializeAs: null, 
})
declare file: Attachment | null

Serialize

⚠️ avalable in v4.0.0

You can customize the output of a serialize. For example:

@attachments({
  preComputeUrl: true,
  serialize: (value?: Attachment) => value?.url ?? null
})
declare avatar: Attachment | null

/**
 {
  avatar: '/uploads/lj9kbwvb8gqq8pjsmuog369l.jpg',
 } 
*/

attachments decorator

⚠️ avalable in v4.0.0

attachments decorator is a array of Attachment object, it'a accept all options of attachment

import { BaseModel } from '@adonisjs/lucid/orm'
import { compose } from '@adonisjs/core/helpers'
import { attachments } from '@jrmc/adonis-attachment'
import type { Attachment } from '@jrmc/adonis-attachment/types/attachment'

class User extends BaseModel {
  @attachments() 
  declare files: Attachment[] | null
}

⚠️ Depending on the number of objects and processing, the attachments decorator can be very resource-intensive. I recommend using a HasMany relationship in Lucid to manage attachment decorator.