@jrmc/adonis-attachment 5.0.0-beta.2 → 5.0.0-beta.3

package/build/src/services/variant/variant_purger.js

@@ -0,0 +1,42 @@
+import attachmentManager from '../../../services/main.js';
+export default class VariantPurger {
+    #filters;
+    constructor(filters) {
+        this.#filters = filters;
+    }
+    async purge(attachments) {
+        const variantsToRemove = this.#getVariantsToRemove(attachments);
+        await Promise.all(variantsToRemove.map(variant => attachmentManager.remove(variant)));
+        this.#updateAttachmentVariants(attachments);
+    }
+    #getVariantsToRemove(attachments) {
+        const variants = [];
+        attachments.forEach(attachment => {
+            if (attachment.variants) {
+                attachment.variants.forEach(variant => {
+                    if (this.#shouldRemoveVariant(variant)) {
+                        variants.push(variant);
+                    }
+                });
+            }
+        });
+        return variants;
+    }
+    #updateAttachmentVariants(attachments) {
+        attachments.forEach(attachment => {
+            if (attachment.variants) {
+                attachment.variants = this.#filterVariants(attachment.variants);
+            }
+        });
+    }
+    #shouldRemoveVariant(variant) {
+        return this.#filters?.variants === undefined ||
+            this.#filters.variants.includes(variant.key);
+    }
+    #filterVariants(variants) {
+        if (this.#filters?.variants === undefined) {
+            return [];
+        }
+        return variants.filter(variant => !this.#filters.variants.includes(variant.key));
+    }
+}

package/build/src/services/variant_service.d.ts

@@ -0,0 +1,7 @@
+import type { ConverterInitializeAttributes } from '../types/converter.js';
+export default class VariantService {
+    #private;
+    constructor({ record, attributeName, options, filters }: ConverterInitializeAttributes);
+    run(): Promise<import("../types/attachment.js").Variant[] | undefined>;
+}
+//# sourceMappingURL=variant_service.d.ts.map

package/build/src/services/variant_service.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"variant_service.d.ts","sourceRoot":"","sources":["../../../src/services/variant_service.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,6BAA6B,EAAE,MAAM,uBAAuB,CAAA;AAO1E,MAAM,CAAC,OAAO,OAAO,cAAc;;gBASrB,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,6BAA6B;IAgBhF,GAAG;CA6BV"}

package/build/src/services/variant_service.js

@@ -0,0 +1,52 @@
+import logger from '@adonisjs/core/services/logger';
+import VariantGenerator from './variant/variant_generator.js';
+import VariantPurger from './variant/variant_purger.js';
+import VariantPersister from './variant/variant_persister.js';
+export default class VariantService {
+    #record;
+    #attributeName;
+    #options;
+    #filters;
+    #variantGenerator;
+    #variantPurger;
+    #variantPersister;
+    constructor({ record, attributeName, options, filters }) {
+        this.#record = record;
+        this.#attributeName = attributeName;
+        this.#options = options;
+        this.#filters = filters;
+        this.#variantGenerator = new VariantGenerator();
+        this.#variantPurger = new VariantPurger(filters);
+        this.#variantPersister = new VariantPersister({
+            id: record.row.$attributes['id'],
+            modelTable: record.row.constructor.table,
+            attributeName,
+            multiple: Array.isArray(record.row.$original[attributeName])
+        });
+    }
+    async run() {
+        try {
+            const attachments = await this.#getAttachments();
+            if (!this.#shouldProcess(attachments)) {
+                return;
+            }
+            await this.#variantPurger.purge(attachments);
+            const variants = await this.#variantGenerator.generate({ attachments, options: this.#options, filters: this.#filters });
+            await this.#variantPersister.persist({ attachments, variants });
+            return variants;
+        }
+        catch (error) {
+            logger.error(`VariantService.run failed: ${error.message}`);
+            throw error;
+        }
+    }
+    async #getAttachments() {
+        await this.#record.row.refresh();
+        return this.#record.getAttachments({
+            attributeName: this.#attributeName,
+        });
+    }
+    #shouldProcess(attachments) {
+        return !!(attachments?.length && this.#options?.variants?.length);
+    }
+}

package/build/src/types/attachment.d.ts

@@ -40,7 +40,7 @@ export type Attachment = AttachmentBase & {
     originalName: string;
     variants?: Variant[];
     createVariant(key: string, input: Input): Promise<Variant>;
-    getVariant(variantName: string): Variant | undefined;
+    getVariant(variantName: string): Variant | null;
     getUrl(variantName?: string): Promise<string>;
     getSignedUrl(variantNameOrOptions?: string | SignedURLOptions, signedUrlOptions?: SignedURLOptions): Promise<string>;
     toObject(): AttachmentAttributes;
@@ -52,9 +52,9 @@ export type Variant = AttachmentBase & {
     generateBlurhash(options?: BlurhashOptions): void;
     toObject(): VariantAttributes;
 };
-export type LucidOptions = {
+export type LucidOptions<T = LucidRow> = {
     disk?: string;
-    folder?: string | ((record?: LucidRow) => string);
+    folder?: string | ((record: T) => string);
     preComputeUrl?: boolean;
     variants?: (keyof AttachmentVariants)[];
     rename?: boolean;

package/build/src/types/attachment.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"attachment.d.ts","sourceRoot":"","sources":["../../../src/types/attachment.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,YAAY,CAAA;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,OAAO,EAAE,YAAY,CAAA;IAErB,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IACnC,OAAO,IAAI,IAAI,CAAA;IACf,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;IAC/B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IAC5B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC3C,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACzB,YAAY,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAElE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAAA;IACvC,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,cAAc,CAAA;IAEjD,QAAQ,IAAI,wBAAwB,CAAA;IACpC,MAAM,IAAI,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG;IACxC,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IAEpB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC1D,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,SAAS,CAAA;IACpD,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7C,YAAY,CACV,oBAAoB,CAAC,EAAE,MAAM,GAAG,gBAAgB,EAChD,gBAAgB,CAAC,EAAE,gBAAgB,GAClC,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB,QAAQ,IAAI,oBAAoB,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG;IACrC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,gBAAgB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IACjD,QAAQ,IAAI,iBAAiB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACzB,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,CAAC,EAAE,QAAQ,KAAK,MAAM,CAAC,CAAA;IACjD,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,CAAC,MAAM,kBAAkB,CAAC,EAAE,CAAA;IACvC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,OAAO,CAAA;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,wBAAwB,GAAG;IAC5D,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC9B,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,wBAAwB,GAAG;IACzD,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA"}
+{"version":3,"file":"attachment.d.ts","sourceRoot":"","sources":["../../../src/types/attachment.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAA;AAC3D,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,uBAAuB,CAAA;AACzD,OAAO,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAA;AAC7D,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,yBAAyB,CAAA;AACjE,OAAO,EAAE,eAAe,EAAE,MAAM,gBAAgB,CAAA;AAEhD,MAAM,MAAM,cAAc,GAAG;IAC3B,KAAK,EAAE,YAAY,CAAA;IAEnB,KAAK,CAAC,EAAE,KAAK,CAAA;IAEb,IAAI,EAAE,MAAM,CAAA;IACZ,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb,IAAI,EAAE,MAAM,CAAA;IACZ,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,GAAG,CAAC,EAAE,MAAM,CAAA;IAEZ,OAAO,EAAE,YAAY,CAAA;IAErB,UAAU,CAAC,MAAM,CAAC,EAAE,QAAQ,GAAG,IAAI,CAAA;IACnC,OAAO,IAAI,IAAI,CAAA;IACf,QAAQ,IAAI,OAAO,CAAC,UAAU,CAAC,CAAA;IAC/B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IAC5B,SAAS,IAAI,OAAO,CAAC,MAAM,CAAC,cAAc,CAAC,CAAA;IAC3C,MAAM,IAAI,OAAO,CAAC,MAAM,CAAC,CAAA;IACzB,YAAY,CAAC,gBAAgB,CAAC,EAAE,gBAAgB,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAElE,QAAQ,CAAC,KAAK,EAAE,MAAM,GAAG,cAAc,CAAA;IACvC,UAAU,CAAC,OAAO,EAAE,YAAY,GAAG,cAAc,CAAA;IAEjD,QAAQ,IAAI,wBAAwB,CAAA;IACpC,MAAM,IAAI,MAAM,CAAA;CACjB,CAAA;AAED,MAAM,MAAM,UAAU,GAAG,cAAc,GAAG;IACxC,YAAY,EAAE,MAAM,CAAA;IACpB,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IAEpB,aAAa,CAAC,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,KAAK,GAAG,OAAO,CAAC,OAAO,CAAC,CAAA;IAC1D,UAAU,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;IAC/C,MAAM,CAAC,WAAW,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAAA;IAC7C,YAAY,CACV,oBAAoB,CAAC,EAAE,MAAM,GAAG,gBAAgB,EAChD,gBAAgB,CAAC,EAAE,gBAAgB,GAClC,OAAO,CAAC,MAAM,CAAC,CAAA;IAClB,QAAQ,IAAI,oBAAoB,CAAA;CACjC,CAAA;AAED,MAAM,MAAM,OAAO,GAAG,cAAc,GAAG;IACrC,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;IAEjB,gBAAgB,CAAC,OAAO,CAAC,EAAE,eAAe,GAAG,IAAI,CAAA;IACjD,QAAQ,IAAI,iBAAiB,CAAA;CAC9B,CAAA;AAED,MAAM,MAAM,YAAY,CAAC,CAAC,GAAG,QAAQ,IAAI;IACvC,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,CAAC,KAAK,MAAM,CAAC,CAAA;IACzC,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,QAAQ,CAAC,EAAE,CAAC,MAAM,kBAAkB,CAAC,EAAE,CAAA;IACvC,MAAM,CAAC,EAAE,OAAO,CAAA;IAChB,IAAI,CAAC,EAAE,OAAO,CAAA;IACd,SAAS,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,UAAU,KAAK,OAAO,CAAA;IAC3C,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACrC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,IAAI,CAAA;IACX,OAAO,EAAE,MAAM,CAAA;IACf,QAAQ,EAAE,MAAM,CAAA;IAChB,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,IAAI,CAAC,EAAE,MAAM,CAAA;CACd,CAAA;AAED,MAAM,MAAM,oBAAoB,GAAG,wBAAwB,GAAG;IAC5D,QAAQ,CAAC,EAAE,iBAAiB,EAAE,CAAA;IAC9B,YAAY,EAAE,MAAM,CAAA;CACrB,CAAA;AAED,MAAM,MAAM,iBAAiB,GAAG,wBAAwB,GAAG;IACzD,GAAG,EAAE,MAAM,CAAA;IACX,MAAM,EAAE,MAAM,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB,CAAA"}

package/build/stubs/config.stub

@@ -1,16 +1,114 @@
 {{{
   exports({ to: app.configPath('attachment.ts') })
 }}}
+// import sharp from 'sharp'
 import { defineConfig } from '@jrmc/adonis-attachment'
 import { InferConverters } from '@jrmc/adonis-attachment/types/config'
 
+/**
+* Documentation: https://adonis-attachment.jrmc.dev/guide/essentials/configuration
+*/
+
 const attachmentConfig = defineConfig({
+  /**
+  * Enable the preComputeUrl flag to pre compute the URLs after SELECT queries. (default: false)
+  */
+  // preComputeUrl: true,
+
+  /**
+  * Enable the meta informations after upload. (default: false)
+  */
+  // meta: true,
+
+  /**
+  * Enable file rename after upload. (default: true)
+  */
+  // rename: false,
+
+  /**
+  * Specify binary path
+  */
+  // bin: { // [!code focus:8]
+  //   ffmpegPath: 'ffmpeg_path', // the full path of the binary
+  //   ffprobePath: 'ffprobe_path', // the full path of the binary
+  //   pdftoppmPath: 'pdftoppm_path' // the full path of the binary
+  //   pdfinfoPath: 'pdfinfo_path' // the full path of the binary
+  //   sofficePath: 'soffice_path', // the full path of the binary (libreoffice/openoffice)
+  // },
+
+  /**
+  * Queue configuration for file processing.
+  * By default, 1 task is processed concurrently. A task corresponds to a model attribute.
+  * For example, if a model has a logo attribute and an avatar attribute,
+  * this represents 2 tasks, regardless of the number of concerts per attribute.
+  *
+  * Increasing concurrency can improve performance but consumes more resources.
+  * A value too high may lead to memory or CPU issues.
+  *
+  */
+  // queue: {
+  //   concurrency: 2
+  // },
+
+  /**
+  * Maximum duration (in milliseconds) that an operation can take before being interrupted.
+  * Default: 30_000 (30 seconds)
+  *
+  * This timeout applies to each individual operation conversion.
+  * If an operation exceeds this time limit, it will be interrupted and an error will be thrown.
+  *
+  * Increase this value if you're processing large files or if your operations
+  * require more time (e.g., long video conversion).
+  *
+  */
+  // timeout: 40_000,
+
+  /**
+  *
+  */
   converters: {
     thumbnail: {
-      converter: () => import('@jrmc/adonis-attachment/converters/image_converter'),
-      options: {
-        resize: 300,
-      }
+      /**
+      * optional converter
+      * default : @jrmc/adonis-attachment/converters/autodetect_converter
+      * image : @jrmc/adonis-attachment/converters/image_converter
+      * pdf : @jrmc/adonis-attachment/converters/pdf_thumbnail_converter
+      * document : @jrmc/adonis-attachment/converters/document_thumbnail_converter
+      * video : @jrmc/adonis-attachment/converters/video_thumbnail_converter
+      * create your custom converter : https://adonis-attachment.jrmc.dev/guide/advanced_usage/custom-converter
+      */
+      // converter: () => import('@jrmc/adonis-attachment/converters/autodetect_converter'),
+
+      /**
+      *
+      * https://sharp.pixelplumbing.com/api-resize/
+      */
+      resize: 300,
+
+      // resize: { // https://sharp.pixelplumbing.com/api-resize
+      //   width: 400,
+      //   height: 400,
+      //   fit: sharp.fit.cover,
+      //   position: 'top'
+      // },
+
+      /**
+      *
+      * https://sharp.pixelplumbing.com/api-output/#toformat
+      */
+      // format: 'jpeg',
+      // format: {
+      //   format: 'jpeg',
+      //   options: {
+      //     quality: 80
+      //   }
+      // }
+
+      /**
+      * generation of blurhashes (default: true)
+      * https://blurha.sh/
+      */
+      // blurhash: true
     }
   }
 })