fix: serialize data

Author: batosai

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "2.1.0",
+  "version": "2.1.1-1",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {
@@ -82,7 +82,7 @@
   "prettier": "@adonisjs/prettier-config",
   "publishConfig": {
     "access": "public",
-    "tag": "latest"
+    "tag": "beta"
   },
   "volta": {
     "node": "20.17.0"

src/attachment_manager.ts

@@ -8,7 +8,7 @@
 import type { LoggerService } from '@adonisjs/core/types'
 import type { DriveService } from '@adonisjs/drive/types'
 import type { MultipartFile } from '@adonisjs/core/bodyparser'
-import type { AttachmentBase } from './types/attachment.js'
+import type { AttachmentBase, Attachment as AttachmentType } from './types/attachment.js'
 import type { ResolvedAttachmentConfig } from './types/config.js'
 
 import { Exception } from '@poppinss/utils'
@@ -83,6 +83,33 @@ export class AttachmentManager {
     }
   }
 
+  async computeUrl(attachment: AttachmentType) {
+    if (attachment.options?.preComputeUrl === false) {
+      return
+    }
+
+    const disk = attachment.getDisk()
+    const fileVisibility = await disk.getVisibility(attachment.path!)
+
+    if (fileVisibility === 'private') {
+      attachment.url = await attachment.getSignedUrl()
+    } else {
+      attachment.url = await attachment.getUrl()
+    }
+
+    if (attachment.variants) {
+      for (const key in attachment.variants) {
+        if (Object.prototype.hasOwnProperty.call(attachment.variants, key)) {
+          if (fileVisibility === 'private') {
+            attachment.variants[key].url = await attachment.getSignedUrl(attachment.variants[key].key)
+          } else {
+            attachment.variants[key].url = await attachment.getUrl(attachment.variants[key].key)
+          }
+        }
+      }
+    }
+  }
+
   async save(attachment: AttachmentBase) {
     const destinationPath = attachment.path!
 

src/attachments/attachment.ts

@@ -120,27 +120,26 @@ export class Attachment extends AttachmentBase implements AttachmentInterface {
     }
   }
 
-  async toJSON(): Promise<Object> {
+  toJSON(): Object {
     const data: any = {
       name: this.name,
       originalName: this.originalName,
       size: this.size,
       extname: this.extname,
       mimetype: this.mimeType,
       meta: this.meta,
-      url: await this.getUrl(),
-      signedUrl: await this.getSignedUrl(),
     }
 
-    if (this.variants) {
-      await Promise.allSettled(
+    if (this.url) {
+      data.url = this.url
+
+      if (this.variants) {
         this.variants!.map(async (v) => {
           data[v.key] = {
-            url: await this.getUrl(v.key),
-            signedUrl: await this.getSignedUrl(v.key)
+            url: v.url,
           }
         })
-      )
+      }
     }
 
     return data

src/attachments/attachment_base.ts

@@ -28,6 +28,7 @@ export class AttachmentBase implements AttachmentBaseInterface {
   meta?: Exif
   folder?: string
   path?: string
+  url?: string
 
   options?: LucidOptions
 
@@ -83,11 +84,14 @@ export class AttachmentBase implements AttachmentBaseInterface {
     }
   }
 
-  async toJSON(): Promise<Object> {
-    return {
-      ...this.toObject(),
-      url: await this.getUrl(),
-      signedUrl: await this.getSignedUrl(),
+  toJSON(): Object {
+    if (this.url) {
+      return {
+        ...this.toObject(),
+        url: this.url
+      }
     }
+
+    return this.toObject()
   }
 }

src/decorators/attachment.ts

@@ -52,7 +52,7 @@ export const attachment = (options?: LucidOptions) => {
         }
       },
       prepare: (value) => (value ? JSON.stringify(value.toObject()) : null),
-      serialize: async (value) => (value ? await value.toJSON() : null),
+      serialize: (value) => (value ? value.toJSON() : null),
       ...columnOptions,
     })
   }

src/mixins/attachmentable.ts

@@ -9,8 +9,8 @@ import type { BaseModel } from '@adonisjs/lucid/orm'
 import type { NormalizeConstructor } from '@adonisjs/core/types/helpers'
 import type { AttributeOfModelWithAttachment } from '../types/mixin.js'
 
-import { beforeSave, afterSave, beforeDelete } from '@adonisjs/lucid/orm'
-import { persistAttachment, commit, rollback, generateVariants } from '../utils/actions.js'
+import { beforeSave, afterSave, beforeDelete, afterFind, afterFetch, afterPaginate } from '@adonisjs/lucid/orm'
+import { persistAttachment, commit, rollback, generateVariants, computeUrl } from '../utils/actions.js'
 import { clone, getAttachmentAttributeNames } from '../utils/helpers.js'
 import { defaultStateAttributeMixin } from '../utils/default_values.js'
 
@@ -20,6 +20,23 @@ export const Attachmentable = <Model extends NormalizeConstructor<typeof BaseMod
   class ModelWithAttachment extends superclass {
     $attachments: AttributeOfModelWithAttachment = clone(defaultStateAttributeMixin)
 
+    @afterFind()
+    static async afterFindHook(modelInstance: ModelWithAttachment) {
+      const attachmentAttributeNames = getAttachmentAttributeNames(modelInstance)
+
+      await Promise.all(
+        attachmentAttributeNames.map((attributeName) => {
+          return computeUrl(modelInstance, attributeName)
+        })
+      )
+    }
+
+    @afterFetch()
+    @afterPaginate()
+    static async afterFetchHook(modelInstances: ModelWithAttachment[]) {
+      await Promise.all(modelInstances.map((row) => this.afterFindHook(row)))
+    }
+
     @beforeSave()
     static async beforeSaveHook(modelInstance: ModelWithAttachment) {
       const attachmentAttributeNames = getAttachmentAttributeNames(modelInstance)

src/types/attachment.ts

@@ -22,6 +22,7 @@ export type AttachmentBase = {
   meta?: Exif
   folder?: string
   path?: string
+  url?: string
 
   options?: LucidOptions
 
@@ -32,7 +33,7 @@ export type AttachmentBase = {
   setOptions(options: LucidOptions): AttachmentBase
 
   toObject(): AttachmentBaseAttributes
-  toJSON(): Promise<Object>
+  toJSON(): Object
 }
 
 export type Attachment = AttachmentBase & {
@@ -56,6 +57,7 @@ export type Variant = AttachmentBase & {
 export type LucidOptions = {
   disk?: string
   folder?: string
+  preComputeUrl?: boolean
   variants?: string[]
   rename?: boolean
   meta?: boolean

src/utils/actions.ts

@@ -35,15 +35,15 @@ export async function rollback(modelInstance: ModelWithAttachment) {
 }
 
 /**
- * Persist attachment for a given attachment property
+ * Persist attachment for a given attachment attributeName
  */
-export async function persistAttachment(modelInstance: ModelWithAttachment, property: string) {
-  const existingFile = modelInstance.$original[property] as Attachment
-  const newFile = modelInstance.$attributes[property] as Attachment
-  const options = getOptions(modelInstance, property)
+export async function persistAttachment(modelInstance: ModelWithAttachment, attributeName: string) {
+  const existingFile = modelInstance.$original[attributeName] as Attachment
+  const newFile = modelInstance.$attributes[attributeName] as Attachment
+  const options = getOptions(modelInstance, attributeName)
 
   /**
-   * Skip when the attachment property hasn't been updated
+   * Skip when the attachment attributeName hasn't been updated
    */
   if (existingFile === newFile) {
     return
@@ -84,6 +84,15 @@ export async function persistAttachment(modelInstance: ModelWithAttachment, prop
   }
 }
 
+export async function computeUrl(modelInstance: ModelWithAttachment, attributeName: string) {
+  const attachment = modelInstance.$attributes[attributeName] as Attachment
+  const options = getOptions(modelInstance, attributeName)
+
+  attachment.setOptions(options)
+
+  return attachmentManager.computeUrl(attachment)
+}
+
 /**
  * Launch converter by variant option
  */

src/utils/default_values.ts

@@ -8,6 +8,7 @@
 export const defaultOptionsDecorator = {
   disk: undefined,
   folder: 'uploads',
+  preComputeUrl: false,
   variants: [],
   rename: true,
   meta: true