@jrmc/adonis-attachment 1.0.1 → 1.1.0

package/README.md

@@ -10,8 +10,8 @@ Project sample : [adonis-starter-kit](https://github.com/batosai/adonis-starter-
 - [x] save meta data
 - [x] variantes
   - [x] images
-  - [ ] documents
-  - [ ] videos
+  - [ ] documents thumbnail
+  - [x] videos thumbnail
 - [ ] command regenerate
 - [ ] adonis-drive/flydrive
 - [ ] jobs queue
@@ -227,11 +227,19 @@ export default defineConfig({
 
       }
     },
+    {
+      key: 'preview',
+      converter: () => import('@jrmc/adonis-attachment/converters/video_thumbnail_converter'),
+      options: {
+        format: 'jpeg',
+        resize: 720
+      }
+    },
   ]
 })
 ```
 
-Variant image is generate by [sharp module](https://sharp.pixelplumbing.com)
+Variants images are generates by [sharp module](https://sharp.pixelplumbing.com)
 
 Options resize is `number` or `object`(options) details in documentation : [sharp api resize](https://sharp.pixelplumbing.com/api-resize)
 
@@ -240,3 +248,10 @@ Options format is `string` or `object` [ format,  options ] details in documenta
 ```sh
 npm install sharp
 ```
+
+Variants thumbnail videos are generate by [fluent-ffmpeg](https://www.npmjs.com/package/fluent-ffmpeg)
+By default, image format is PNG and size is video size. `options` attribute use image_converter (and sharp)
+
+```sh
+npm install fluent-ffmpeg
+```

package/build/src/adapters/exif.d.ts

@@ -4,6 +4,5 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
-/// <reference types="node" resolution-mode="require"/>
-import type { Exif } from '../types/input.js';
-export declare const exif: (buffer: Buffer) => Promise<Exif>;
+import type { Exif, Input } from '../types/input.js';
+export declare const exif: (input: Input) => Promise<Exif | undefined>;

package/build/src/adapters/exif.js

@@ -4,9 +4,35 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
+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 } from '../utils/helpers.js';
-export const exif = async (buffer) => {
+export const exif = async (input) => {
+    let fileType;
+    let buffer;
+    if (Buffer.isBuffer(input)) {
+        fileType = await fileTypeFromBuffer(input);
+        if (fileType?.mime.includes('image')) {
+            buffer = input;
+        }
+    }
+    else {
+        fileType = await fileTypeFromFile(input);
+        if (fileType?.mime.includes('image')) {
+            buffer = await fs.readFile(input);
+        }
+    }
+    if (fileType?.mime.includes('video')) {
+        return videoExif(input);
+    }
+    if (buffer && fileType?.mime.includes('image')) {
+        return imageExif(buffer);
+    }
+    return undefined;
+};
+async function imageExif(buffer) {
     const tags = await ExifReader.load(buffer, { expanded: true });
     const data = {};
     if (tags.exif) {
@@ -75,4 +101,22 @@ export const exif = async (buffer) => {
         }
     }
     return cleanObject(data);
-};
+}
+async function videoExif(input) {
+    return new Promise(async (resolve) => {
+        const module = 'fluent-ffmpeg';
+        const result = await import(module);
+        const ffmpeg = result.default;
+        ffmpeg(input).ffprobe(0, (err, data) => {
+            if (err) {
+                logger.error({ err });
+            }
+            resolve({
+                dimension: {
+                    width: data.streams[0].width,
+                    height: data.streams[0].height,
+                }
+            });
+        });
+    });
+}

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

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

package/build/src/converters/autodetect_converter.js

@@ -0,0 +1,34 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { fileTypeFromBuffer, fileTypeFromFile } from 'file-type';
+import Converter from './converter.js';
+import ImageConverter from './image_converter.js';
+import VideoThumnailConverter from './video_thumbnail_converter.js';
+export default class AutodetectConverter extends Converter {
+    async handle({ input, options }) {
+        let converter;
+        let fileType;
+        if (Buffer.isBuffer(input)) {
+            fileType = await fileTypeFromBuffer(input);
+        }
+        else {
+            fileType = await fileTypeFromFile(input);
+        }
+        if (fileType?.mime.includes('image')) {
+            converter = new ImageConverter();
+        }
+        else if (fileType?.mime.includes('video')) {
+            converter = new VideoThumnailConverter();
+        }
+        if (converter) {
+            return await converter.handle({
+                input,
+                options
+            });
+        }
+    }
+}

package/build/src/converters/video_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 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

@@ -0,0 +1,53 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import os from 'node:os';
+import path from 'node:path';
+import logger from '@adonisjs/core/services/logger';
+import { cuid } from '@adonisjs/core/helpers';
+import Converter from './converter.js';
+import ImageConverter from './image_converter.js';
+export default class VideoThumbnailConvert extends Converter {
+    async handle({ input, options }) {
+        let ffmpeg;
+        try {
+            const module = 'fluent-ffmpeg';
+            const result = await import(module);
+            ffmpeg = result.default;
+        }
+        catch (error) {
+            logger.error({ err: error }, 'Dependence missing, please install fluent-ffmpeg');
+        }
+        if (ffmpeg) {
+            const filePath = await this.videoToImage(ffmpeg, input);
+            if (options && filePath) {
+                const converter = new ImageConverter();
+                return await converter.handle({
+                    input: filePath,
+                    options
+                });
+            }
+            else {
+                return filePath;
+            }
+        }
+    }
+    async videoToImage(ffmpeg, input) {
+        return new Promise((resolve) => {
+            const folder = os.tmpdir();
+            const filename = `${cuid()}.png`;
+            ffmpeg(input)
+                .screenshots({
+                count: 1,
+                filename,
+                folder,
+            })
+                .on('end', () => {
+                resolve(path.join(folder, filename));
+            });
+        });
+    }
+}

package/build/src/mixins/attachmentable.d.ts

@@ -264,6 +264,7 @@ export declare const Attachmentable: <Model extends NormalizeConstructor<import(
         related<Name_2 extends undefined>(relation: Name_2): any[Name_2] extends import("@adonisjs/lucid/types/relations").ModelRelations<import("@adonisjs/lucid/types/model").LucidModel, import("@adonisjs/lucid/types/model").LucidModel> ? any[Name_2]["client"] : never;
     }): Promise<void>;
     find: <T_1 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_1, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_1> | null>;
+    create: <T_2 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_2, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_2>>>, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_2>>;
     readonly booted: boolean;
     $columnsDefinitions: Map<string, import("@adonisjs/lucid/types/model").ModelColumnOptions>;
     $relationsDefinitions: Map<string, import("@adonisjs/lucid/types/relations").RelationshipsContract>;
@@ -284,8 +285,8 @@ export declare const Attachmentable: <Model extends NormalizeConstructor<import(
         serializedToColumns: import("@adonisjs/lucid/types/model").ModelKeysContract;
         serializedToAttributes: import("@adonisjs/lucid/types/model").ModelKeysContract;
     };
-    $createFromAdapterResult: <T_2 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_2, result?: import("@adonisjs/lucid/types/model").ModelObject | undefined, sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => InstanceType<T_2> | null;
-    $createMultipleFromAdapterResult: <T_3 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_3, results: import("@adonisjs/lucid/types/model").ModelObject[], sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => InstanceType<T_3>[];
+    $createFromAdapterResult: <T_3 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_3, result?: import("@adonisjs/lucid/types/model").ModelObject | undefined, sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => InstanceType<T_3> | null;
+    $createMultipleFromAdapterResult: <T_4 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_4, results: import("@adonisjs/lucid/types/model").ModelObject[], sideloadAttributes?: import("@adonisjs/lucid/types/model").ModelObject | undefined, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => InstanceType<T_4>[];
     $addColumn: (name: string, options: Partial<import("@adonisjs/lucid/types/model").ColumnOptions>) => import("@adonisjs/lucid/types/model").ColumnOptions;
     $hasColumn: (name: string) => boolean;
     $getColumn: (name: string) => import("@adonisjs/lucid/types/model").ModelColumnOptions | undefined;
@@ -310,7 +311,6 @@ export declare const Attachmentable: <Model extends NormalizeConstructor<import(
         <Model_8 extends import("@adonisjs/lucid/types/model").LucidModel>(this: Model_8, event: "paginate", handler: import("@adonisjs/lucid/types/model").HooksHandler<import("@adonisjs/lucid/types/model").ModelPaginatorContract<InstanceType<Model_8>>, "paginate">): void;
         <Model_9 extends import("@adonisjs/lucid/types/model").LucidModel, Event_2 extends import("@adonisjs/lucid/types/model").EventsList>(this: Model_9, event: Event_2, handler: import("@adonisjs/lucid/types/model").HooksHandler<InstanceType<Model_9>, Event_2>): void;
     };
-    create: <T_4 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_4, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_4>>>, options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_4>>;
     createMany: <T_5 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_5, values: Partial<import("@adonisjs/lucid/types/model").ModelAttributes<InstanceType<T_5>>>[], options?: import("@adonisjs/lucid/types/model").ModelAssignOptions | undefined) => Promise<InstanceType<T_5>[]>;
     findOrFail: <T_6 extends import("@adonisjs/lucid/types/model").LucidModel>(this: T_6, value: any, options?: import("@adonisjs/lucid/types/model").ModelAdapterOptions | undefined) => Promise<InstanceType<T_6>>;
     findBy: {

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

@@ -14,7 +14,7 @@ export declare function createAttachmentAttributes(input: Input, name?: string):
     extname: import("file-type").FileExtension;
     mimeType: import("file-type").MimeType;
     size: number;
-    meta: import("../types/input.js").Exif;
+    meta: import("../types/input.js").Exif | undefined;
 }>;
 export declare function cleanObject(obj: any): any;
 export declare function clone(object: Object): any;

package/build/src/utils/helpers.js

@@ -4,7 +4,6 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
-import fs from 'node:fs/promises';
 import { cuid } from '@adonisjs/core/helpers';
 import string from '@adonisjs/core/helpers/string';
 import { fileTypeFromBuffer, fileTypeFromFile } from 'file-type';
@@ -19,16 +18,13 @@ export function getOptions(modelInstance, attributeName) {
 }
 export async function createAttachmentAttributes(input, name) {
     let fileType;
-    let meta;
     if (Buffer.isBuffer(input)) {
         fileType = await fileTypeFromBuffer(input);
-        meta = await exif(input);
     }
     else {
         fileType = await fileTypeFromFile(input);
-        const buffer = await fs.readFile(input);
-        meta = await exif(buffer);
     }
+    const meta = await exif(input);
     if (name) {
         name = string.slug(name);
     }
@@ -40,7 +36,7 @@ export async function createAttachmentAttributes(input, name) {
         extname: fileType.ext,
         mimeType: fileType.mime,
         size: input.length,
-        meta,
+        meta: meta,
     };
 }
 export function cleanObject(obj) {

package/build/stubs/config.stub

@@ -37,5 +37,13 @@ export default defineConfig({
 
       }
     },
+    // {
+    //   key: 'preview',
+    //   converter: () => import('@jrmc/adonis-attachment/converters/video_thumbnail_converter'),
+    //   options: {
+    //     format: 'jpeg',
+    //     resize: 720
+    //   }
+    // },
   ]
 })

package/package.json

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

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

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

package/build/src/converters/video_converter.js

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