@jrmc/adonis-attachment 2.1.1-1 → 2.3.0

package/README.md

@@ -7,6 +7,7 @@ Project sample : [adonis-starter-kit](https://github.com/batosai/adonis-starter-
 ## Links
 
 [View documentation](https://adonis-attachment.jrmc.dev/)
+[Discord](https://discord.gg/89eMn2vB)
 
 [ChangeLog](https://adonis-attachment.jrmc.dev/changelog.html)
 
@@ -18,7 +19,7 @@ Project sample : [adonis-starter-kit](https://github.com/batosai/adonis-starter-
 - [x] save meta data
 - [x] variantes
   - [x] images
-  - [ ] documents thumbnail
+  - [x] documents thumbnail
   - [x] videos thumbnail
 - [ ] command regenerate
 - [x] adonis-drive/flydrive

package/build/src/adapters/exif.js

@@ -8,7 +8,7 @@ import fs from 'node:fs/promises';
 import ExifReader from 'exifreader';
 import logger from '@adonisjs/core/services/logger';
 import { fileTypeFromBuffer, fileTypeFromFile } from 'file-type';
-import { cleanObject, use } from '../utils/helpers.js';
+import { bufferToTempFile, cleanObject, use } from '../utils/helpers.js';
 import { attachmentManager } from '../../index.js';
 export const exif = async (input) => {
     let fileType;
@@ -106,7 +106,11 @@ async function imageExif(buffer) {
 async function videoExif(input) {
     return new Promise(async (resolve) => {
         const ffmpeg = await use('fluent-ffmpeg');
-        const ff = ffmpeg(input);
+        let file = input;
+        if (Buffer.isBuffer(input)) {
+            file = await bufferToTempFile(input);
+        }
+        const ff = ffmpeg(file);
         const config = attachmentManager.getConfig();
         if (config.bin) {
             if (config.bin.ffprobePath) {

package/build/src/attachment_manager.d.ts

@@ -5,7 +5,7 @@
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
 import type { LoggerService } from '@adonisjs/core/types';
-import type { DriveService } from '@adonisjs/drive/types';
+import type { DriveService, SignedURLOptions } from '@adonisjs/drive/types';
 import type { MultipartFile } from '@adonisjs/core/bodyparser';
 import type { AttachmentBase, Attachment as AttachmentType } from './types/attachment.js';
 import type { ResolvedAttachmentConfig } from './types/config.js';
@@ -18,8 +18,10 @@ export declare class AttachmentManager {
     createFromDbResponse(response: any): Attachment | null;
     createFromFile(file: MultipartFile): Promise<Attachment>;
     createFromBuffer(buffer: Buffer, name?: string): Promise<Attachment>;
+    createFromBase64(data: string, name?: string): Promise<Attachment>;
     getConverter(key: string): Promise<void | Converter>;
-    computeUrl(attachment: AttachmentType): Promise<void>;
+    computeUrl(attachment: AttachmentType | AttachmentBase, signedUrlOptions?: SignedURLOptions): Promise<void>;
+    preComputeUrl(attachment: AttachmentType): Promise<void>;
     save(attachment: AttachmentBase): Promise<void>;
     delete(attachment: AttachmentBase): Promise<void>;
 }

package/build/src/attachment_manager.js

@@ -49,6 +49,11 @@ export class AttachmentManager {
         const attributes = await createAttachmentAttributes(buffer, name);
         return new Attachment(this.#drive, attributes, buffer);
     }
+    async createFromBase64(data, name) {
+        const base64Data = data.replace(/^data:([A-Za-z-+\/]+);base64,/, '');
+        const buffer = Buffer.from(base64Data, 'base64');
+        return await this.createFromBuffer(buffer, name);
+    }
     async getConverter(key) {
         if (this.#config.converters) {
             for (const c of this.#config.converters) {
@@ -58,27 +63,25 @@ export class AttachmentManager {
             }
         }
     }
-    async computeUrl(attachment) {
-        if (attachment.options?.preComputeUrl === false) {
-            return;
-        }
+    async computeUrl(attachment, signedUrlOptions) {
         const disk = attachment.getDisk();
         const fileVisibility = await disk.getVisibility(attachment.path);
         if (fileVisibility === 'private') {
-            attachment.url = await attachment.getSignedUrl();
+            attachment.url = await attachment.getSignedUrl(signedUrlOptions);
         }
         else {
             attachment.url = await attachment.getUrl();
         }
-        if (attachment.variants) {
+    }
+    async preComputeUrl(attachment) {
+        if (attachment.options?.preComputeUrl === false) {
+            return;
+        }
+        await this.computeUrl(attachment);
+        if (attachment instanceof Attachment && 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);
-                    }
+                    await this.computeUrl(attachment.variants[key]);
                 }
             }
         }

package/build/src/attachments/attachment.js

@@ -79,6 +79,14 @@ export class Attachment extends AttachmentBase {
             this.folder = this.options.folder;
             this.path = path.join(this.folder, this.name);
         }
+        if (this.variants) {
+            this.variants.forEach((v) => {
+                v.setOptions({
+                    ...this.options,
+                    variants: []
+                });
+            });
+        }
         return this;
     }
     toObject() {
@@ -98,15 +106,26 @@ export class Attachment extends AttachmentBase {
             mimetype: this.mimeType,
             meta: this.meta,
         };
+        if (this.variants) {
+            this.variants.map(async (v) => {
+                data[v.key] = {
+                    name: v.name,
+                    extname: v.extname,
+                    mimetype: v.mimeType,
+                    meta: v.meta,
+                    size: v.size,
+                };
+            });
+        }
         if (this.url) {
             data.url = this.url;
-            if (this.variants) {
-                this.variants.map(async (v) => {
-                    data[v.key] = {
-                        url: v.url,
-                    };
-                });
-            }
+        }
+        if (this.variants) {
+            this.variants.map(async (v) => {
+                if (v.url) {
+                    data[v.key].url = v.url;
+                }
+            });
         }
         return data;
     }

package/build/src/converters/document_thumbnail_converter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import type { ConverterAttributes } from '../types/converter.js';
+import type { Input } from '../types/input.js';
+import Converter from './converter.js';
+export default class DocumentThumbnailConverter extends Converter {
+    handle({ input, options }: ConverterAttributes): Promise<any>;
+    documentToImage(LibreOfficeFileConverter: any, input: Input): Promise<any>;
+}

package/build/src/converters/document_thumbnail_converter.js

@@ -0,0 +1,56 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import Converter from './converter.js';
+import ImageConverter from './image_converter.js';
+import { use } from '../utils/helpers.js';
+export default class DocumentThumbnailConverter extends Converter {
+    async handle({ input, options }) {
+        const lib = await use('libreoffice-file-converter');
+        if (lib) {
+            const LibreOfficeFileConverter = lib.LibreOfficeFileConverter;
+            const outputBuffer = await this.documentToImage(LibreOfficeFileConverter, input);
+            if (options && outputBuffer) {
+                const converter = new ImageConverter();
+                return await converter.handle({
+                    input: outputBuffer,
+                    options
+                });
+            }
+            return outputBuffer;
+        }
+    }
+    async documentToImage(LibreOfficeFileConverter, input) {
+        let binaryPaths = undefined;
+        if (this.binPaths && this.binPaths.libreofficePaths) {
+            binaryPaths = this.binPaths.libreofficePaths;
+        }
+        const libreOfficeFileConverter = new LibreOfficeFileConverter({
+            childProcessOptions: {
+                timeout: 60 * 1000,
+            },
+            binaryPaths
+        });
+        if (Buffer.isBuffer(input)) {
+            const output = await libreOfficeFileConverter.convert({
+                buffer: input,
+                input: 'buffer',
+                output: 'buffer',
+                format: 'jpeg',
+            });
+            return output;
+        }
+        else {
+            const output = await libreOfficeFileConverter.convert({
+                inputPath: input,
+                input: 'file',
+                output: 'buffer',
+                format: 'jpeg',
+            });
+            return output;
+        }
+    }
+}

package/build/src/converters/pdf_thumbnail_converter.d.ts

@@ -0,0 +1,13 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import type { ConverterAttributes } from '../types/converter.js';
+import type { Input } from '../types/input.js';
+import Converter from './converter.js';
+export default class PdfThumbnailConverter extends Converter {
+    handle({ input, options }: ConverterAttributes): Promise<any>;
+    pdfToImage(Poppler: any, input: Input): Promise<string>;
+}

package/build/src/converters/pdf_thumbnail_converter.js

@@ -0,0 +1,44 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import os from 'node:os';
+import path from 'node:path';
+import { cuid } from '@adonisjs/core/helpers';
+import Converter from './converter.js';
+import ImageConverter from './image_converter.js';
+import { use } from '../utils/helpers.js';
+export default class PdfThumbnailConverter extends Converter {
+    async handle({ input, options }) {
+        const nodePoppler = await use('node-poppler');
+        if (nodePoppler) {
+            const Poppler = nodePoppler.Poppler;
+            const filePath = await this.pdfToImage(Poppler, input);
+            if (options && filePath) {
+                const converter = new ImageConverter();
+                return await converter.handle({
+                    input: filePath,
+                    options
+                });
+            }
+            return filePath;
+        }
+    }
+    async pdfToImage(Poppler, input) {
+        let binPath = null;
+        if (this.binPaths && this.binPaths.pdftocairoBasePath) {
+            binPath = this.binPaths.pdftocairoBasePath;
+        }
+        const poppler = new Poppler(binPath);
+        const options = {
+            // firstPageToConvert: 1,
+            lastPageToConvert: 1,
+            jpegFile: true,
+        };
+        const filePath = path.join(os.tmpdir(), cuid());
+        await poppler.pdfToCairo(input, filePath, options);
+        return filePath + '-1.jpg';
+    }
+}

package/build/src/converters/video_thumbnail_converter.d.ts

@@ -5,8 +5,8 @@
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
 import type { ConverterAttributes } from '../types/converter.js';
+import type { Input } from '../types/input.js';
 import Converter from './converter.js';
-import { Input } from '../types/input.js';
 export default class VideoThumbnailConvert extends Converter {
     handle({ input, options }: ConverterAttributes): Promise<any>;
     videoToImage(ffmpeg: Function, input: Input): Promise<string | false>;

package/build/src/converters/video_thumbnail_converter.js

@@ -9,7 +9,7 @@ import path from 'node:path';
 import { cuid } from '@adonisjs/core/helpers';
 import Converter from './converter.js';
 import ImageConverter from './image_converter.js';
-import { use } from '../utils/helpers.js';
+import { bufferToTempFile, use } from '../utils/helpers.js';
 export default class VideoThumbnailConvert extends Converter {
     async handle({ input, options }) {
         const ffmpeg = await use('fluent-ffmpeg');
@@ -28,10 +28,14 @@ export default class VideoThumbnailConvert extends Converter {
         }
     }
     async videoToImage(ffmpeg, input) {
+        let file = input;
+        if (Buffer.isBuffer(input)) {
+            file = await bufferToTempFile(input);
+        }
         return new Promise((resolve) => {
             const folder = os.tmpdir();
             const filename = `${cuid()}.png`;
-            const ff = ffmpeg(input);
+            const ff = ffmpeg(file);
             if (this.binPaths) {
                 if (this.binPaths.ffmpegPath) {
                     ff.setFfmpegPath(this.binPaths.ffmpegPath);

package/build/src/decorators/attachment.js

@@ -16,6 +16,7 @@ export const attachment = (options) => {
         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;
@@ -23,6 +24,9 @@ export const attachment = (options) => {
         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;
         Model.boot();

package/build/src/mixins/attachmentable.js

@@ -11,7 +11,7 @@ var __decorate = (this && this.__decorate) || function (decorators, target, key,
     return c > 3 && r && Object.defineProperty(target, key, r), r;
 };
 import { beforeSave, afterSave, beforeDelete, afterFind, afterFetch, afterPaginate } from '@adonisjs/lucid/orm';
-import { persistAttachment, commit, rollback, generateVariants, computeUrl } from '../utils/actions.js';
+import { persistAttachment, commit, rollback, generateVariants, preComputeUrl } from '../utils/actions.js';
 import { clone, getAttachmentAttributeNames } from '../utils/helpers.js';
 import { defaultStateAttributeMixin } from '../utils/default_values.js';
 export const Attachmentable = (superclass) => {
@@ -20,7 +20,7 @@ export const Attachmentable = (superclass) => {
         static async afterFindHook(modelInstance) {
             const attachmentAttributeNames = getAttachmentAttributeNames(modelInstance);
             await Promise.all(attachmentAttributeNames.map((attributeName) => {
-                return computeUrl(modelInstance, attributeName);
+                return preComputeUrl(modelInstance, attributeName);
             }));
         }
         static async afterFetchHook(modelInstances) {

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

@@ -16,11 +16,14 @@ type ConverterConfig = {
 export type BinPaths = {
     ffmpegPath?: string;
     ffprobePath?: string;
+    pdftocairoBasePath?: string;
+    libreofficePaths?: Array<string>;
 };
 export type AttachmentConfig = {
     bin?: BinPaths;
     meta?: boolean;
     rename?: boolean;
+    preComputeUrl?: boolean;
     converters?: ConverterConfig[];
 };
 export type ResolvedConverter = {
@@ -31,6 +34,7 @@ export type ResolvedAttachmentConfig = {
     bin?: BinPaths;
     meta?: boolean;
     rename?: boolean;
+    preComputeUrl?: boolean;
     converters?: ResolvedConverter[];
 };
 export {};

package/build/src/utils/actions.d.ts

@@ -17,7 +17,7 @@ export declare function rollback(modelInstance: ModelWithAttachment): Promise<vo
  * Persist attachment for a given attachment attributeName
  */
 export declare function persistAttachment(modelInstance: ModelWithAttachment, attributeName: string): Promise<void>;
-export declare function computeUrl(modelInstance: ModelWithAttachment, attributeName: string): Promise<void>;
+export declare function preComputeUrl(modelInstance: ModelWithAttachment, attributeName: string): Promise<void>;
 /**
  * Launch converter by variant option
  */

package/build/src/utils/actions.js

@@ -62,11 +62,11 @@ export async function persistAttachment(modelInstance, attributeName) {
         await attachmentManager.save(newFile);
     }
 }
-export async function computeUrl(modelInstance, attributeName) {
+export async function preComputeUrl(modelInstance, attributeName) {
     const attachment = modelInstance.$attributes[attributeName];
     const options = getOptions(modelInstance, attributeName);
     attachment.setOptions(options);
-    return attachmentManager.computeUrl(attachment);
+    return attachmentManager.preComputeUrl(attachment);
 }
 /**
  * Launch converter by variant option

package/build/src/utils/default_values.d.ts

@@ -9,8 +9,8 @@ export declare const defaultOptionsDecorator: {
     folder: string;
     preComputeUrl: boolean;
     variants: never[];
-    rename: boolean;
     meta: boolean;
+    rename: boolean;
 };
 export declare const defaultStateAttributeMixin: {
     attached: never[];

package/build/src/utils/default_values.js

@@ -9,8 +9,8 @@ export const defaultOptionsDecorator = {
     folder: 'uploads',
     preComputeUrl: false,
     variants: [],
-    rename: true,
-    meta: true
+    meta: true,
+    rename: true
 };
 export const defaultStateAttributeMixin = {
     attached: [],

package/build/src/utils/helpers.d.ts

@@ -18,3 +18,4 @@ export declare function createAttachmentAttributes(input: Input, name?: string):
 export declare function cleanObject(obj: any): any;
 export declare function clone(object: Object): any;
 export declare function use(module: string): Promise<any>;
+export declare function bufferToTempFile(input: Buffer): Promise<string>;

package/build/src/utils/helpers.js

@@ -4,6 +4,9 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
+import os from 'node:os';
+import path from 'node:path';
+import fs from 'fs/promises';
 import { cuid } from '@adonisjs/core/helpers';
 import string from '@adonisjs/core/helpers/string';
 import logger from '@adonisjs/core/services/logger';
@@ -61,9 +64,18 @@ export function clone(object) {
 export async function use(module) {
     try {
         const result = await import(module);
-        return result.default;
+        if (result.default) {
+            return result.default;
+        }
+        return result;
     }
     catch (error) {
         logger.error({ err: error }, `Dependence missing, please install ${module}`);
     }
 }
+export async function bufferToTempFile(input) {
+    const folder = os.tmpdir();
+    const tempFilePath = path.join(folder, `tempfile-${Date.now()}.tmp`);
+    await fs.writeFile(tempFilePath, input);
+    return tempFilePath;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "2.1.1-1",
+  "version": "2.3.0",
   "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": "beta"
+    "tag": "latest"
   },
   "volta": {
     "node": "20.17.0"

package/build/src/converters/document_converter.d.ts

@@ -1,7 +0,0 @@
-export {};
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */

package/build/src/converters/document_converter.js

@@ -1,7 +0,0 @@
-export {};
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */

package/build/src/converters/pdf_converter.d.ts

@@ -1,7 +0,0 @@
-export {};
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */

package/build/src/converters/pdf_converter.js

@@ -1,7 +0,0 @@
-export {};
-/**
- * @jrmc/adonis-attachment
- *
- * @license MIT
- * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
- */