Merge branch 'develop'

Author: batosai

docs/changelog.md

@@ -1,5 +1,10 @@
 # Changelog
 
+## 2.4.2
+
+* fix: issue [#2](https://github.com/batosai/adonis-attachment/issues/2), cannot read properties of undefined (reading 'getConfig') 
+* fix: delete old file after option rename changed
+
 ## 2.4.1
 
 * fix: typo error mimetype -> mimeType

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "2.4.1",
+  "version": "2.4.2",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {

src/attachment_manager.ts

@@ -50,7 +50,8 @@ export class AttachmentManager {
       }
     })
 
-    return new Attachment(this.#drive, attributes)
+    const attachment = new Attachment(this.#drive, attributes)
+    return this.#configureAttachment(attachment)
   }
 
   async createFromFile(file: MultipartFile) {
@@ -65,7 +66,8 @@ export class AttachmentManager {
       throw new errors.ENOENT()
     }
 
-    return new Attachment(this.#drive, attributes, file.tmpPath)
+    const attachment = new Attachment(this.#drive, attributes, file.tmpPath)
+    return this.#configureAttachment(attachment)
   }
 
   async createFromBuffer(buffer: Buffer, name?: string) {
@@ -75,7 +77,8 @@ export class AttachmentManager {
 
     const attributes = await createAttachmentAttributes(buffer, name)
 
-    return new Attachment(this.#drive, attributes, buffer)
+    const attachment = new Attachment(this.#drive, attributes, buffer)
+    return this.#configureAttachment(attachment)
   }
 
   async createFromBase64(data: string, name?: string) {
@@ -147,9 +150,7 @@ export class AttachmentManager {
 
   async delete(attachment: AttachmentBase) {
     if (attachment.path) {
-      const filePath = attachment.path
-
-      await attachment.getDisk().delete(filePath)
+      await attachment.getDisk().delete(attachment.path)
 
       if (attachment instanceof Attachment) {
         if (attachment.variants) {
@@ -158,5 +159,27 @@ export class AttachmentManager {
         }
       }
     }
+
+    if (attachment.originalPath) {
+      await attachment.getDisk().delete(attachment.originalPath)
+    }
+  }
+
+  // private methods
+
+  #configureAttachment(attachment: AttachmentType) {
+    if (this.#config.meta !== undefined) {
+      attachment.setOptions({ meta: this.#config.meta })
+    }
+
+    if (this.#config.rename !== undefined) {
+      attachment.setOptions({ rename: this.#config.rename })
+    }
+
+    if (this.#config.preComputeUrl !== undefined) {
+      attachment.setOptions({ preComputeUrl: this.#config.preComputeUrl })
+    }
+
+    return attachment
   }
 }

src/attachments/attachment.ts

@@ -37,6 +37,22 @@ export class Attachment extends AttachmentBase implements AttachmentInterface {
     }
   }
 
+  /**
+   * Getters
+   */
+
+  get name() {
+    if (this.options && this.options.rename === false) {
+      return this.originalName
+    }
+
+    return super.name
+  }
+
+  /**
+   * Methods
+   */
+
   async createVariant(key: string, input: Input): Promise<Variant> {
     const attributes = {
       ...(await createAttachmentAttributes(input)),
@@ -101,15 +117,6 @@ export class Attachment extends AttachmentBase implements AttachmentInterface {
       ...options,
     }
 
-    if (!this.path) {
-      if (!this.options.rename) {
-        this.name = this.originalName
-      }
-
-      this.folder = this.options!.folder!
-      this.path = path.join(this.folder, this.name)
-    }
-
     if (this.variants) {
       this.variants.forEach((v) => {
         v.setOptions({
@@ -122,6 +129,10 @@ export class Attachment extends AttachmentBase implements AttachmentInterface {
     return this
   }
 
+  /**
+   *
+   */
+
   toObject(): AttachmentAttributes {
     const variants = this.variants?.map((v) => v.toObject())
 

src/attachments/attachment_base.ts

@@ -13,6 +13,7 @@ import type {
 } from '../types/attachment.js'
 import type { Exif, Input } from '../types/input.js'
 
+import path from 'node:path'
 import { cuid } from '@adonisjs/core/helpers'
 import { defaultOptionsDecorator } from '../utils/default_values.js'
 
@@ -21,13 +22,14 @@ export class AttachmentBase implements AttachmentBaseInterface {
 
   input?: Input
 
-  name: string
+  #name: string
+  #folder?: string
+
   size: number
   extname: string
   mimeType: string
   meta?: Exif
-  folder?: string
-  path?: string
+  originalPath?: string
   url?: string
 
   options?: LucidOptions
@@ -39,20 +41,42 @@ export class AttachmentBase implements AttachmentBaseInterface {
     this.meta = attributes.meta
     this.extname = attributes.extname
     this.mimeType = attributes.mimeType
-    this.folder = attributes.folder
-    this.path = attributes.path
+    this.originalPath = attributes.path
 
-    this.options = defaultOptionsDecorator
+    this.#folder = attributes.folder
+    if (attributes.name) {
+      this.#name = attributes.name
+    } else {
+      this.#name = `${cuid()}.${this.extname}`
+    }
 
+    this.options = defaultOptionsDecorator
     this.drive = drive
+  }
 
-    if (attributes.name) {
-      this.name = attributes.name
-    } else {
-      this.name = `${cuid()}.${this.extname}`
+  /**
+   * Getters
+   */
+
+  get name(): string {
+    return this.#name
+  }
+
+  get folder(): string | undefined {
+    if (this.options) {
+      return this.options?.folder
     }
+    return this.#folder
   }
 
+  get path(): string {
+    return path.join(this.folder!, this.name)
+  }
+
+  /**
+   * Methods
+   */
+
   getDisk() {
     return this.drive.use(this.options?.disk)
   }
@@ -73,6 +97,10 @@ export class AttachmentBase implements AttachmentBaseInterface {
     return this
   }
 
+  /**
+   *
+   */
+
   toObject(): AttachmentBaseAttributes {
     return {
       name: this.name,

src/attachments/variant_attachment.ts

@@ -9,25 +9,35 @@ import type { DriveService } from '@adonisjs/drive/types'
 import type { VariantAttributes, Variant as VariantInterface } from '../types/attachment.js'
 import type { Input } from '../types/input.js'
 
-import path from 'node:path'
 import { AttachmentBase } from './attachment_base.js'
 
 export class Variant extends AttachmentBase implements VariantInterface {
   key: string
-  folder: string
+  #folder: string
 
   constructor(drive: DriveService, attributes: VariantAttributes, input?: Input) {
     super(drive, attributes, input)
 
     this.key = attributes.key
-    this.folder = attributes.folder!
-    this.path = path.join(this.folder, this.name)
+    this.#folder = attributes.folder!
   }
 
+  /**
+   * Getters
+   */
+
+  get folder(): string {
+    return this.#folder
+  }
+
+  /**
+   *
+   */
+
   toObject(): VariantAttributes {
     return {
       key: this.key,
-      folder: this.folder,
+      folder: this.folder!,
       name: this.name,
       ...super.toObject(),
     }

src/decorators/attachment.ts

@@ -18,27 +18,6 @@ export const attachment = (options?: LucidOptions) => {
       target[optionsSym] = {}
     }
 
-    const defaultConfig = attachmentManager.getConfig()
-    const defaultOptions = {
-      meta: defaultConfig.meta !== undefined ? defaultConfig.meta : defaultOptionsDecorator.meta,
-      rename:
-        defaultConfig.rename !== undefined ? defaultConfig.rename : defaultOptionsDecorator.rename,
-      preComputeUrl:
-        defaultConfig.preComputeUrl !== undefined
-          ? defaultConfig.preComputeUrl
-          : defaultOptionsDecorator.preComputeUrl,
-    }
-
-    if (!options || options?.meta === undefined) {
-      options!.meta = defaultOptions.meta
-    }
-    if (!options || options?.rename === undefined) {
-      options!.rename = defaultOptions.rename
-    }
-    if (!options || options?.preComputeUrl === undefined) {
-      options!.preComputeUrl = defaultOptions.preComputeUrl
-    }
-
     target[optionsSym][attributeName] = options
 
     const Model = target.constructor as LucidModel
@@ -53,7 +32,17 @@ export const attachment = (options?: LucidOptions) => {
       consume: (value) => {
         if (value) {
           const attachment = attachmentManager.createFromDbResponse(value)
-          attachment?.setOptions({ disk, folder, variants, meta, rename })
+          attachment?.setOptions({ disk, folder, variants })
+
+          if (options && options?.meta !== undefined) {
+            attachment?.setOptions({ meta: options!.meta })
+          }
+          if (options && options?.rename !== undefined) {
+            attachment?.setOptions({ rename: options!.rename })
+          }
+          if (options && options?.preComputeUrl !== undefined) {
+            attachment?.setOptions({ preComputeUrl: options!.preComputeUrl })
+          }
           return attachment
         } else {
           return null

src/types/attachment.ts

@@ -16,12 +16,14 @@ export type AttachmentBase = {
   input?: Input
 
   name: string
+  folder?: string
+  path?: string
+
   size: number
   extname: string
   mimeType: string
   meta?: Exif
-  folder?: string
-  path?: string
+  originalPath?: string
   url?: string
 
   options?: LucidOptions