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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "5.0.0-beta.2",
+  "version": "5.0.0-beta.4",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {
@@ -65,51 +65,56 @@
     "./attachment_provider": "./build/providers/attachment_provider.js"
   },
   "dependencies": {
-    "@poppinss/defer": "^1.1.1",
+    "@poppinss/defer": "^1.1.2",
+    "@verrou/core": "^0.5.1",
     "blurhash": "^2.0.5",
     "execa": "^9.6.0",
-    "exifreader": "^4.26.0",
-    "file-type": "^19.6.0",
-    "mime-types": "^2.1.35"
+    "exifreader": "^4.31.1",
+    "file-type": "^21.0.0",
+    "mime-types": "^3.0.1"
   },
   "devDependencies": {
     "@adonisjs/assembler": "^7.8.2",
-    "@adonisjs/core": "^6.17.1",
-    "@adonisjs/drive": "^3.2.0",
-    "@adonisjs/lucid": "^21.6.0",
-    "@adonisjs/prettier-config": "^1.4.0",
-    "@adonisjs/tsconfig": "^1.4.0",
+    "@adonisjs/core": "^6.19.0",
+    "@adonisjs/drive": "^3.4.1",
+    "@adonisjs/lock": "^1.1.1",
+    "@adonisjs/lucid": "^21.7.0",
+    "@adonisjs/prettier-config": "^1.4.5",
+    "@adonisjs/tsconfig": "^1.4.1",
     "@japa/assert": "^4.0.1",
     "@japa/expect-type": "^2.0.3",
     "@japa/file-system": "^2.3.2",
-    "@japa/plugin-adonisjs": "^4.0.0",
     "@japa/runner": "^4.1.0",
     "@poppinss/utils": "^6.9.2",
-    "@swc/core": "^1.10.7",
-    "@types/luxon": "^3.4.2",
-    "@types/mime-types": "^2.1.4",
-    "@types/node": "^22.10.7",
-    "@types/sinon": "^17.0.3",
-    "better-sqlite3": "^11.8.0",
+    "@swc/core": "^1.12.9",
+    "@types/luxon": "^3.6.2",
+    "@types/mime-types": "^3.0.1",
+    "@types/node": "^24.0.10",
+    "@types/sinon": "^17.0.4",
+    "better-sqlite3": "^12.2.0",
     "c8": "^10.1.3",
     "copyfiles": "^2.4.1",
     "del-cli": "^6.0.0",
-    "flydrive": "^1.1.0",
-    "luxon": "^3.5.0",
+    "flydrive": "^1.3.0",
+    "luxon": "^3.6.1",
     "prettier": "^3.4.2",
-    "sharp": "^0.33.5",
-    "sinon": "^19.0.2",
+    "sharp": "^0.34.2",
+    "sinon": "^21.0.0",
     "ts-node": "^10.9.2",
-    "typescript": "^5.7.3",
+    "typescript": "^5.3.3",
     "vitepress": "^1.5.0"
   },
   "peerDependencies": {
     "@adonisjs/core": "^6.12.1",
     "@adonisjs/drive": "^3.2.0",
+    "@adonisjs/lock": "^1.1.1",
     "@adonisjs/lucid": "^20.6.0 || ^21.0.0",
     "sharp": "^0.33.0"
   },
   "peerDependenciesMeta": {
+    "@adonisjs/lock": {
+      "optional": true
+    },
     "sharp": {
       "optional": true
     }

package/build/src/converter_manager.d.ts

@@ -1,13 +0,0 @@
-import type { Converter, ConverterInitializeAttributes } from './types/converter.js';
-import type { Attachment, Variant } from './types/attachment.js';
-export declare class ConverterManager {
-    #private;
-    constructor({ record, attributeName, options, filters }: ConverterInitializeAttributes);
-    run(): Promise<void>;
-    static generate({ key, attachment, converter }: {
-        key: string;
-        attachment: Attachment;
-        converter: Converter;
-    }): Promise<Variant | undefined>;
-}
-//# sourceMappingURL=converter_manager.d.ts.map

package/build/src/converter_manager.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"converter_manager.d.ts","sourceRoot":"","sources":["../../src/converter_manager.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,6BAA6B,EAAE,MAAM,sBAAsB,CAAA;AACpF,OAAO,KAAK,EAAE,UAAU,EAAE,OAAO,EAAgB,MAAM,uBAAuB,CAAA;AAS9E,qBAAa,gBAAgB;;gBAQf,EAAE,MAAM,EAAE,aAAa,EAAE,OAAO,EAAE,OAAO,EAAE,EAAE,6BAA6B;IAOhF,GAAG;WAyCI,QAAQ,CAAC,EAAE,GAAG,EAAE,UAAU,EAAE,SAAS,EAAE,EAAG;QAAE,GAAG,EAAE,MAAM,CAAC;QAAC,UAAU,EAAE,UAAU,CAAC;QAAC,SAAS,EAAE,SAAS,CAAA;KAAE;CA6FrH"}

package/build/src/converter_manager.js

@@ -1,121 +0,0 @@
-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 { streamToTempFile } from './utils/helpers.js';
-export class ConverterManager {
-    #record;
-    #attributeName;
-    #options;
-    #filters;
-    constructor({ record, attributeName, options, filters }) {
-        this.#record = record;
-        this.#attributeName = attributeName;
-        this.#options = options;
-        this.#filters = filters;
-    }
-    async run() {
-        const attachments = this.#record.getAttachments({
-            attributeName: this.#attributeName,
-        });
-        const variants = [];
-        await this.#purge(attachments);
-        if (!attachments || !this.#options.variants || !this.#options.variants.length) {
-            return;
-        }
-        for await (const key of this.#options.variants) {
-            if (this.#filters?.variants !== undefined && !this.#filters?.variants?.includes(key)) {
-                continue;
-            }
-            const converter = (await attachmentManager.getConverter(key));
-            if (converter) {
-                for await (const attachment of attachments) {
-                    const variant = await ConverterManager.generate({
-                        key,
-                        attachment,
-                        converter
-                    });
-                    if (variant) {
-                        variants.push(variant);
-                    }
-                }
-            }
-        }
-        return this.#commit(attachments, () => {
-            for (let i = 0; i < variants.length; i++) {
-                attachmentManager.remove(variants[i]);
-            }
-        });
-    }
-    static async generate({ key, attachment, converter }) {
-        let input = attachment.input;
-        if (!input) {
-            input = await streamToTempFile(await attachment.getStream());
-        }
-        const output = await converter.handle({
-            input,
-            options: converter.options,
-        });
-        if (output === undefined) {
-            // throw new errors.E_CANNOT_PATH_BY_CONVERTER()
-            return;
-        }
-        const variant = await attachment.createVariant(key, 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;
-                    await variant.generateBlurhash(options);
-                }
-                catch (error) {
-                    logger.error(error.message);
-                }
-            }
-        }
-        await attachmentManager.write(variant);
-        return variant;
-    }
-    async #commit(attachments, rollback) {
-        const Model = this.#record.row.constructor;
-        const id = this.#record.row.$attributes['id'];
-        const data = {};
-        const index = string.snakeCase(this.#attributeName);
-        if (Array.isArray(this.#record.row.$original[this.#attributeName])) {
-            data[index] = JSON.stringify(attachments.map((att) => att.toObject()));
-        }
-        else {
-            data[index] = JSON.stringify(attachments[0].toObject());
-        }
-        const trx = await db.transaction();
-        trx.after('rollback', rollback);
-        try {
-            await trx.query().from(Model.table).where('id', id).update(data);
-            return trx.commit();
-        }
-        catch (error) {
-            return trx.rollback();
-        }
-    }
-    async #purge(attachments) {
-        return Promise.all(attachments.map(async (attachment) => {
-            if (attachment.variants) {
-                await Promise.all(attachment.variants.map(async (variant) => {
-                    if (this.#filters?.variants !== undefined && !this.#filters?.variants?.includes(variant.key)) {
-                        return;
-                    }
-                    return attachmentManager.remove(variant);
-                }));
-                if (this.#filters?.variants !== undefined) {
-                    attachment.variants = await attachment.variants.filter((variant) => !this.#filters?.variants?.includes(variant.key));
-                }
-                else {
-                    attachment.variants = [];
-                }
-            }
-        }));
-    }
-}

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

@@ -1,33 +0,0 @@
-import type { RowWithAttachment } from '../types/mixin.js';
-import type { Attachment as AttachmentType } from '../types/attachment.js';
-import type { RecordWithAttachment as RecordWithAttachmentImplementation } from '../types/service.js';
-import type { RegenerateOptions } from '../types/regenerate.js';
-export default class RecordWithAttachment implements RecordWithAttachmentImplementation {
-    #private;
-    constructor(row: RowWithAttachment);
-    /**
-     * During commit, we should cleanup the old detached files
-     */
-    commit(): Promise<void>;
-    /**
-     * During rollback we should remove the attached files.
-     */
-    rollback(): Promise<void>;
-    persist(): Promise<void>;
-    transaction(options?: {
-        enabledRollback: boolean;
-    }): Promise<void>;
-    preComputeUrl(): Promise<void>;
-    setKeyId(): Promise<void>;
-    generateVariants(): Promise<void>;
-    regenerateVariants(options?: RegenerateOptions): Promise<void>;
-    detach(): Promise<PromiseSettledResult<void>[]>;
-    detachAll(): Promise<PromiseSettledResult<void>[]>;
-    get row(): RowWithAttachment;
-    getAttachments(options: {
-        attributeName: string;
-        requiredOriginal?: boolean;
-        requiredDirty?: boolean;
-    }): AttachmentType[];
-}
-//# sourceMappingURL=record_with_attachment.d.ts.map

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

@@ -1 +0,0 @@
-{"version":3,"file":"record_with_attachment.d.ts","sourceRoot":"","sources":["../../../src/services/record_with_attachment.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,mBAAmB,CAAA;AAC1D,OAAO,KAAK,EAAE,UAAU,IAAI,cAAc,EAAgB,MAAM,wBAAwB,CAAA;AACxF,OAAO,KAAK,EAAE,oBAAoB,IAAI,kCAAkC,EAAE,MAAM,qBAAqB,CAAA;AACrG,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAA;AAW/D,MAAM,CAAC,OAAO,OAAO,oBAAqB,YAAW,kCAAkC;;gBAGzE,GAAG,EAAE,iBAAiB;IAWlC;;OAEG;IACG,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC;IAQ7B;;OAEG;IACG,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IAQzB,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC;IAiDxB,WAAW,CAAC,OAAO;;KAA4B,GAAG,OAAO,CAAC,IAAI,CAAC;IAkB/D,aAAa,IAAI,OAAO,CAAC,IAAI,CAAC;IAkB9B,QAAQ,IAAI,OAAO,CAAC,IAAI,CAAC;IA4BzB,gBAAgB,IAAI,OAAO,CAAC,IAAI,CAAC;IA+BjC,kBAAkB,CAAC,OAAO,GAAE,iBAAsB;IAmClD,MAAM;IA2CN,SAAS;IAkBf,IAAI,GAAG,sBAEN;IAED,cAAc,CAAC,OAAO,EAAE;QAAE,aAAa,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,OAAO,CAAC;QAAC,aAAa,CAAC,EAAE,OAAO,CAAA;KAAE;CAwEvG"}

package/build/src/services/record_with_attachment.js

@@ -1,303 +0,0 @@
-import logger from '@adonisjs/core/services/logger';
-import encryption from '@adonisjs/core/services/encryption';
-import attachmentManager from '../../services/main.js';
-import { defaultStateAttributeMixin } from '../utils/default_values.js';
-import { Attachment } from '../attachments/attachment.js';
-import { optionsSym } from '../utils/symbols.js';
-import { ConverterManager } from '../converter_manager.js';
-import { E_CANNOT_CREATE_VARIANT } from '../errors.js';
-export default class RecordWithAttachment {
-    #row;
-    constructor(row) {
-        this.#row = row;
-        if (!this.#row.$attachments) {
-            /**
-             * Empty previous $attachments
-             */
-            this.#row.$attachments = structuredClone(defaultStateAttributeMixin);
-        }
-    }
-    /**
-     * During commit, we should cleanup the old detached files
-     */
-    async commit() {
-        await Promise.allSettled(this.#row.$attachments.detached.map((attachment) => attachmentManager.remove(attachment)));
-    }
-    /**
-     * During rollback we should remove the attached files.
-     */
-    async rollback() {
-        await Promise.allSettled(this.#row.$attachments.attached.map((attachment) => attachmentManager.remove(attachment)));
-    }
-    async persist() {
-        const attachmentAttributeNames = this.#getDirtyAttributeNamesOfAttachment();
-        /**
-         * Persist attachments before saving the row to the database. This
-         * way if file saving fails we will not write anything to the
-         * database
-         */
-        await Promise.all(attachmentAttributeNames.map(async (name) => {
-            const originalAttachments = this.#getOriginalAttachmentsByAttributeName(name);
-            const newAttachments = this.#getAttachmentsByAttributeName(name);
-            const options = this.#getOptionsByAttributeName(name);
-            /**
-             * Skip when the attachment attributeName hasn't been updated
-             */
-            if (!originalAttachments && !newAttachments) {
-                return;
-            }
-            /**
-             * memorise attribute name for generate variants
-             */
-            this.#row.$attachments.dirtied.push(name);
-            for (let i = 0; i < newAttachments.length; i++) {
-                if (originalAttachments.includes(newAttachments[i])) {
-                    continue;
-                }
-                /**
-                 * If there is a new file and its local then we must save this
-                 * file.
-                 */
-                if (newAttachments[i]) {
-                    newAttachments[i].setOptions(options).makeFolder(this.#row);
-                    this.#row.$attachments.attached.push(newAttachments[i]);
-                    /**
-                     * Also write the file to the disk right away
-                     */
-                    await attachmentManager.write(newAttachments[i]);
-                }
-            }
-        }));
-    }
-    async transaction(options = { enabledRollback: true }) {
-        try {
-            if (this.#row.$trx) {
-                this.#row.$trx.after('commit', () => this.commit());
-                if (options.enabledRollback) {
-                    this.#row.$trx.after('rollback', () => this.rollback());
-                }
-            }
-            else {
-                await this.commit();
-            }
-        }
-        catch (error) {
-            if (options.enabledRollback) {
-                await this.rollback();
-            }
-            throw error;
-        }
-    }
-    async preComputeUrl() {
-        const attachmentAttributeNames = this.#getAttributeNamesOfAttachment();
-        await Promise.all(attachmentAttributeNames.map(async (name) => {
-            const options = this.#getOptionsByAttributeName(name);
-            if (this.#row.$attributes[name]) {
-                const attachments = this.#getAttachmentsByAttributeName(name);
-                for (let i = 0; i < attachments.length; i++) {
-                    attachments[i].setOptions(options);
-                    await attachmentManager.preComputeUrl(attachments[i]);
-                }
-            }
-        }));
-    }
-    async setKeyId() {
-        const attachmentAttributeNames = this.#getAttributeNamesOfAttachment();
-        await Promise.all(attachmentAttributeNames.map(async (name) => {
-            if (this.#row.$attributes[name]) {
-                const attachments = this.#getAttachmentsByAttributeName(name);
-                for (let i = 0; i < attachments.length; i++) {
-                    const { disk, folder, meta, rename } = attachments[i].options;
-                    const model = this.#row.constructor;
-                    const key = encryption.encrypt({
-                        model: model.table,
-                        id: this.#row.$attributes['id'],
-                        attribute: name,
-                        options: {
-                            disk,
-                            folder,
-                            meta,
-                            rename
-                        }
-                    });
-                    attachments[i].setKeyId(key);
-                }
-            }
-        }));
-    }
-    async generateVariants() {
-        /* this.#row.$dirty is not avalable in afterSave hooks */
-        const attachmentAttributeNames = this.#row.$attachments.dirtied;
-        /**
-         * For all properties Attachment
-         * Launch async generation variants
-         */
-        for await (const name of attachmentAttributeNames) {
-            const record = this;
-            attachmentManager.queue.push({
-                name: `${this.#row.constructor.name}-${name}`,
-                async run() {
-                    const converterManager = new ConverterManager({
-                        record,
-                        attributeName: name,
-                        options: record.#getOptionsByAttributeName(name),
-                    });
-                    await converterManager.run();
-                },
-            })
-                .onError = function (error) {
-                if (error.message) {
-                    logger.error(error.message);
-                }
-                else {
-                    throw new E_CANNOT_CREATE_VARIANT([error]);
-                }
-            };
-        }
-    }
-    async regenerateVariants(options = {}) {
-        let attachmentAttributeNames;
-        if (options.attributes?.length) {
-            attachmentAttributeNames = options.attributes;
-        }
-        else {
-            attachmentAttributeNames = this.#getAttributeNamesOfAttachment();
-        }
-        for await (const name of attachmentAttributeNames) {
-            const record = this;
-            attachmentManager.queue.push({
-                name: `${this.#row.constructor.name}-${name}`,
-                async run() {
-                    const converterManager = new ConverterManager({
-                        record,
-                        attributeName: name,
-                        options: record.#getOptionsByAttributeName(name),
-                        filters: {
-                            variants: options.variants
-                        }
-                    });
-                    await converterManager.run();
-                },
-            })
-                .onError = function (error) {
-                if (error.message) {
-                    logger.error(error.message);
-                }
-                else {
-                    throw new E_CANNOT_CREATE_VARIANT([error]);
-                }
-            };
-        }
-    }
-    async detach() {
-        const attachmentAttributeNames = this.#getDirtyAttributeNamesOfAttachment();
-        /**
-         * Mark all original attachments for deletion
-         */
-        return Promise.allSettled(attachmentAttributeNames.map((name) => {
-            let attachments = [];
-            const options = this.#getOptionsByAttributeName(name);
-            if (this.#row.$dirty[name] === null) {
-                attachments = this.#getOriginalAttachmentsByAttributeName(name);
-            }
-            else {
-                const originalAttachments = this.#getOriginalAttachmentsByAttributeName(name);
-                const newAttachments = this.#getAttachmentsByAttributeName(name);
-                /**
-                 * Clean Attachments changed
-                 */
-                for (let i = 0; i < originalAttachments.length; i++) {
-                    if (newAttachments.includes(originalAttachments[i])) {
-                        continue;
-                    }
-                    /**
-                     * If there was an existing file, then we must get rid of it
-                     */
-                    if (originalAttachments[i]) {
-                        originalAttachments[i].setOptions(options);
-                        attachments.push(originalAttachments[i]);
-                    }
-                }
-            }
-            for (let i = 0; i < attachments.length; i++) {
-                attachments[i].setOptions(options);
-                this.#row.$attachments.detached.push(attachments[i]);
-            }
-        }));
-    }
-    async detachAll() {
-        const attachmentAttributeNames = this.#getAttributeNamesOfAttachment();
-        /**
-         * Mark all attachments for deletion
-         */
-        return Promise.allSettled(attachmentAttributeNames.map((name) => {
-            const options = this.#getOptionsByAttributeName(name);
-            const attachments = this.#getAttachmentsByAttributeName(name);
-            for (let i = 0; i < attachments.length; i++) {
-                attachments[i].setOptions(options);
-                this.#row.$attachments.detached.push(attachments[i]);
-            }
-        }));
-    }
-    get row() {
-        return this.#row;
-    }
-    getAttachments(options) {
-        let attachments;
-        if (options.requiredOriginal) {
-            attachments = this.#getOriginalAttachmentsByAttributeName(options.attributeName);
-        }
-        else if (options.requiredDirty) {
-            attachments = this.#getDirtyAttachmentsByAttributeName(options.attributeName);
-        }
-        else {
-            attachments = this.#getAttachmentsByAttributeName(options.attributeName);
-        }
-        const opts = this.#getOptionsByAttributeName(options.attributeName);
-        attachments.map((attachment) => attachment.setOptions(opts).makeFolder(this.#row));
-        return attachments;
-    }
-    #getAttachmentsByAttributeName(name) {
-        if (Array.isArray(this.#row.$attributes[name])) {
-            return this.#row.$attributes[name];
-        }
-        return [this.#row.$attributes[name]];
-    }
-    #getOriginalAttachmentsByAttributeName(name) {
-        if (Array.isArray(this.#row.$original[name])) {
-            return this.#row.$original[name];
-        }
-        return [this.#row.$original[name]];
-    }
-    #getDirtyAttachmentsByAttributeName(name) {
-        if (Array.isArray(this.#row.$dirty[name])) {
-            return this.#row.$dirty[name];
-        }
-        return [this.#row.$dirty[name]];
-    }
-    #getOptionsByAttributeName(name) {
-        return this.#row.constructor.prototype[optionsSym]?.[name];
-    }
-    #getAttributeNamesOfAttachment() {
-        return Object.keys(this.#row.$attributes).filter((name) => {
-            const value = this.#row.$attributes[name];
-            return (value instanceof Attachment ||
-                (Array.isArray(value) && value.every((item) => item instanceof Attachment)));
-        });
-    }
-    #getDirtyAttributeNamesOfAttachment() {
-        return Object.keys(this.#row.$dirty).filter((name) => {
-            const dirtyValue = this.#row.$dirty[name];
-            const originalValue = this.#row.$original[name]; // if dirtyValue is null, check original type
-            const isDirtyAttachment = dirtyValue instanceof Attachment ||
-                (Array.isArray(dirtyValue) &&
-                    dirtyValue.length &&
-                    dirtyValue.every((item) => item instanceof Attachment));
-            const isOriginalAttachment = originalValue instanceof Attachment ||
-                (Array.isArray(originalValue) &&
-                    originalValue.length &&
-                    originalValue.every((item) => item instanceof Attachment));
-            return isDirtyAttachment || isOriginalAttachment;
-        });
-    }
-}