@jrmc/adonis-attachment 3.3.0-beta.1 → 3.3.0-beta.3

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

@@ -0,0 +1,4 @@
+declare const _default: {
+    encode(pixels: Uint8ClampedArray, width: number, height: number, componentX: number, componentY: number): Promise<string>;
+};
+export default _default;

package/build/src/adapters/blurhash.js

@@ -0,0 +1,6 @@
+import { encode } from 'blurhash';
+export default {
+    async encode(pixels, width, height, componentX, componentY) {
+        return encode(pixels, width, height, componentX, componentY);
+    },
+};

package/build/src/attachments/attachment.js

@@ -129,6 +129,7 @@ export class Attachment extends AttachmentBase {
                     mimeType: v.mimeType,
                     meta: v.meta,
                     size: v.size,
+                    blurhash: v.blurhash,
                 };
             });
         }

package/build/src/attachments/variant_attachment.d.ts

@@ -11,6 +11,7 @@ import { AttachmentBase } from './attachment_base.js';
 export declare class Variant extends AttachmentBase implements VariantInterface {
     #private;
     key: string;
+    blurhash?: string;
     constructor(drive: DriveService, attributes: VariantAttributes, input?: Input);
     /**
      * Getters

package/build/src/attachments/variant_attachment.js

@@ -8,10 +8,12 @@ import { AttachmentBase } from './attachment_base.js';
 export class Variant extends AttachmentBase {
     key;
     #folder;
+    blurhash;
     constructor(drive, attributes, input) {
         super(drive, attributes, input);
         this.key = attributes.key;
         this.#folder = attributes.folder;
+        this.blurhash = attributes.blurhash;
     }
     /**
      * Getters
@@ -27,6 +29,7 @@ export class Variant extends AttachmentBase {
             key: this.key,
             folder: this.folder,
             name: this.name,
+            blurhash: this.blurhash,
             ...super.toObject(),
         };
     }

package/build/src/converter_manager.js

@@ -1,7 +1,9 @@
+import logger from '@adonisjs/core/services/logger';
 import string from '@adonisjs/core/helpers/string';
 import db from '@adonisjs/lucid/services/db';
 import attachmentManager from '../services/main.js';
 import * as errors from './errors.js';
+import { imageToBlurhash } from './utils/helpers.js';
 export class ConverterManager {
     #record;
     #attributeName;
@@ -19,11 +21,11 @@ export class ConverterManager {
         const id = this.#record.model.$attributes['id'];
         const data = {};
         if (this.#options.variants) {
-            for (const option of this.#options.variants) {
+            for await (const option of this.#options.variants) {
                 const converter = (await attachmentManager.getConverter(option));
                 if (attachments && converter) {
-                    for (let i = 0; i < attachments.length; i++) {
-                        const input = attachments[i].input;
+                    for await (const attachment of attachments) {
+                        const input = attachment.input;
                         const output = await converter.handle({
                             input,
                             options: converter.options,
@@ -31,7 +33,22 @@ export class ConverterManager {
                         if (output === undefined) {
                             throw new errors.E_CANNOT_PATH_BY_CONVERTER();
                         }
-                        const variant = await attachments[i].createVariant(option, output);
+                        const variant = await attachment.createVariant(option, output);
+                        if (converter.options.blurhash) {
+                            if ((typeof converter.options.blurhash !== 'boolean' &&
+                                converter.options.blurhash.enabled === true) ||
+                                converter.options.blurhash === true) {
+                                try {
+                                    const options = typeof converter.options.blurhash !== 'boolean'
+                                        ? converter.options.blurhash
+                                        : undefined;
+                                    variant.blurhash = await imageToBlurhash(variant.input, options);
+                                }
+                                catch (error) {
+                                    logger.error(error.message);
+                                }
+                            }
+                        }
                         await attachmentManager.save(variant);
                     }
                 }
@@ -53,10 +70,10 @@ export class ConverterManager {
         });
         try {
             await trx.query().from(Model.table).where('id', id).update(data);
-            return await trx.commit();
+            return trx.commit();
         }
         catch (error) {
-            return await trx.rollback();
+            return trx.rollback();
         }
     }
 }

package/build/src/services/record_with_attachment.js

@@ -106,7 +106,7 @@ export default class Record {
          * For all properties Attachment
          * Launch async generation variants
          */
-        await Promise.allSettled(attachmentAttributeNames.map((name) => {
+        for await (const name of attachmentAttributeNames) {
             const record = this;
             attachmentManager.queue.push({
                 name: `${this.#model.constructor.name}-${name}`,
@@ -124,7 +124,7 @@ export default class Record {
                     }
                 },
             });
-        }));
+        }
     }
     async detach() {
         const attachmentAttributeNames = this.#getDirtyAttributeNamesOfAttachment();
@@ -214,7 +214,9 @@ export default class Record {
             const dirtyValue = this.#model.$dirty[name];
             const originalValue = this.#model.$original[name]; // if dirtyValue is null, check original type
             const isDirtyAttachment = dirtyValue instanceof Attachment ||
-                (Array.isArray(dirtyValue) && dirtyValue.every((item) => item instanceof Attachment));
+                (Array.isArray(dirtyValue) &&
+                    dirtyValue.every((item) => item instanceof Attachment) &&
+                    dirtyValue.length);
             const isOriginalAttachment = originalValue instanceof Attachment ||
                 (Array.isArray(originalValue) && originalValue.every((item) => item instanceof Attachment));
             return isDirtyAttachment || isOriginalAttachment;

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

@@ -41,6 +41,7 @@ export type Attachment = AttachmentBase & {
 export type Variant = AttachmentBase & {
     key: string;
     folder: string;
+    blurhash?: string;
     toObject(): VariantAttributes;
 };
 export type LucidOptions = {
@@ -67,4 +68,5 @@ export type AttachmentAttributes = AttachmentBaseAttributes & {
 export type VariantAttributes = AttachmentBaseAttributes & {
     key: string;
     folder: string;
+    blurhash?: string;
 };

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

@@ -22,6 +22,11 @@ export type ConverterAttributes = {
     input: Input;
     options: ConverterOptions;
 };
+export type BlurhashOptions = {
+    enabled: boolean;
+    componentX: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+    componentY: 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9;
+};
 type jpeg = {
     format: 'jpeg';
     options: {
@@ -127,5 +132,6 @@ export type ConverterOptions = {
         fastShrinkOnLoad?: Boolean;
     };
     format?: 'jpeg' | 'jpg' | 'png' | 'gif' | 'webp' | 'avif' | 'heif' | 'tiff' | 'raw' | jpeg | png | gif | webp | avif | heif;
+    blurhash?: boolean | BlurhashOptions;
 };
 export {};

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

@@ -4,9 +4,12 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
+import type { Input } from '../types/input.js';
+import type { BlurhashOptions } from '../types/converter.js';
 export declare function cleanObject(obj: any): any;
 export declare function use(module: string): Promise<any>;
 export declare function bufferToTempFile(input: Buffer): Promise<string>;
 export declare function streamToTempFile(input: NodeJS.ReadableStream): Promise<string>;
 export declare function downloadToTempFile(input: URL): Promise<string>;
 export declare function isBase64(str: string): boolean;
+export declare function imageToBlurhash(input: Input, options?: BlurhashOptions): Promise<string>;

package/build/src/utils/helpers.js

@@ -11,6 +11,7 @@ import fs from 'node:fs/promises';
 import { pipeline } from 'node:stream';
 import { promisify } from 'node:util';
 import { createWriteStream } from 'node:fs';
+import BlurhashAdapter from '../adapters/blurhash.js';
 import * as errors from '../errors.js';
 const streamPipeline = promisify(pipeline);
 export function cleanObject(obj) {
@@ -91,3 +92,21 @@ export function isBase64(str) {
         return false;
     }
 }
+export function imageToBlurhash(input, options) {
+    const { componentX, componentY } = options || { componentX: 4, componentY: 4 };
+    return new Promise(async (resolve, reject) => {
+        try {
+            const sharp = await use('sharp');
+            // Convert input to pixels
+            const { data: pixels, info: metadata } = await sharp(input)
+                .raw()
+                .ensureAlpha()
+                .toBuffer({ resolveWithObject: true });
+            const blurhash = BlurhashAdapter.encode(new Uint8ClampedArray(pixels), metadata.width, metadata.height, componentX, componentY);
+            return resolve(blurhash);
+        }
+        catch (error) {
+            return reject(error);
+        }
+    });
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "3.3.0-beta.1",
+  "version": "3.3.0-beta.3",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {
@@ -65,6 +65,7 @@
   },
   "dependencies": {
     "@poppinss/defer": "^1.1.1",
+    "blurhash": "^2.0.5",
     "exifreader": "^4.26.0",
     "file-type": "^19.6.0",
     "mime-types": "^2.1.35"
@@ -94,6 +95,8 @@
     "flydrive": "^1.1.0",
     "luxon": "^3.5.0",
     "prettier": "^3.4.2",
+    "sharp": "^0.33.5",
+    "sinon": "^19.0.2",
     "ts-node": "^10.9.2",
     "typescript": "^5.7.3",
     "vitepress": "^1.5.0"