@jrmc/adonis-attachment 3.0.0 → 3.1.0

package/build/tests/attachment-manager.spec.js

@@ -0,0 +1,234 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import https from 'node:https';
+import { readFile } from 'node:fs/promises';
+import { test } from '@japa/runner';
+import app from '@adonisjs/core/services/app';
+import drive from '@adonisjs/drive/services/main';
+import { MultipartFileFactory } from '@adonisjs/core/factories/bodyparser';
+import { UserFactory } from './fixtures/factories/user.js';
+import { attachmentManager } from '../index.js';
+test.group('attachment-manager', () => {
+    test('save method - should result in noop when attachment is created from db response', async ({ assert, }) => {
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        const attachment = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo123.jpg',
+            originalName: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        assert.equal(attachment?.originalName, 'foo.jpg');
+    });
+    test('Attachment - should be null when db response is null', async ({ assert }) => {
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        const attachment = attachmentManager.createFromDbResponse(null);
+        assert.isNull(attachment);
+    });
+    test('Attachment path default is uploads', async ({ assert }) => {
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        const attachment = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        assert.equal(attachment?.path, 'uploads/foo.jpg');
+    });
+    test('Attachment path - should be custom', async ({ assert }) => {
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        const attachment = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        attachment?.setOptions({ folder: 'avatar' });
+        assert.equal(attachment?.path, 'avatar/foo.jpg');
+    });
+    test('Attachment get url', async ({ assert, cleanup }) => {
+        drive.fake('fs');
+        cleanup(() => drive.restore('fs'));
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        const attachment = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        attachment?.setOptions({ folder: 'avatars' });
+        const url = await attachment?.getUrl();
+        const signedUrl = await attachment?.getSignedUrl();
+        assert.match(url, /\/drive\/fakes\/avatars\/foo\.jpg/);
+        assert.match(signedUrl, /\/drive\/fakes\/signed\/avatars\/foo\.jpg/);
+    });
+    test('Precompute file url', async ({ assert, cleanup }) => {
+        drive.fake('fs');
+        cleanup(() => drive.restore('fs'));
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        const attachment = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        attachment?.setOptions({ preComputeUrl: true, folder: 'avatars' });
+        await attachmentManager.preComputeUrl(attachment);
+        assert.match(attachment?.url, /\/drive\/fakes\/avatars\/foo\.jpg/);
+    });
+    test('with base64 (prefix)', async ({ assert }) => {
+        const avatar = await attachmentManager.createFromBase64('data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3/OAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAANCSURBVEiJtZZPbBtFFMZ/M7ubXdtdb1xSFyeilBapySVU8h8OoFaooFSqiihIVIpQBKci6KEg9Q6H9kovIHoCIVQJJCKE1ENFjnAgcaSGC6rEnxBwA04Tx43t2FnvDAfjkNibxgHxnWb2e/u992bee7tCa00YFsffekFY+nUzFtjW0LrvjRXrCDIAaPLlW0nHL0SsZtVoaF98mLrx3pdhOqLtYPHChahZcYYO7KvPFxvRl5XPp1sN3adWiD1ZAqD6XYK1b/dvE5IWryTt2udLFedwc1+9kLp+vbbpoDh+6TklxBeAi9TL0taeWpdmZzQDry0AcO+jQ12RyohqqoYoo8RDwJrU+qXkjWtfi8Xxt58BdQuwQs9qC/afLwCw8tnQbqYAPsgxE1S6F3EAIXux2oQFKm0ihMsOF71dHYx+f3NND68ghCu1YIoePPQN1pGRABkJ6Bus96CutRZMydTl+TvuiRW1m3n0eDl0vRPcEysqdXn+jsQPsrHMquGeXEaY4Yk4wxWcY5V/9scqOMOVUFthatyTy8QyqwZ+kDURKoMWxNKr2EeqVKcTNOajqKoBgOE28U4tdQl5p5bwCw7BWquaZSzAPlwjlithJtp3pTImSqQRrb2Z8PHGigD4RZuNX6JYj6wj7O4TFLbCO/Mn/m8R+h6rYSUb3ekokRY6f/YukArN979jcW+V/S8g0eT/N3VN3kTqWbQ428m9/8k0P/1aIhF36PccEl6EhOcAUCrXKZXXWS3XKd2vc/TRBG9O5ELC17MmWubD2nKhUKZa26Ba2+D3P+4/MNCFwg59oWVeYhkzgN/JDR8deKBoD7Y+ljEjGZ0sosXVTvbc6RHirr2reNy1OXd6pJsQ+gqjk8VWFYmHrwBzW/n+uMPFiRwHB2I7ih8ciHFxIkd/3Omk5tCDV1t+2nNu5sxxpDFNx+huNhVT3/zMDz8usXC3ddaHBj1GHj/As08fwTS7Kt1HBTmyN29vdwAw+/wbwLVOJ3uAD1wi/dUH7Qei66PfyuRj4Ik9is+hglfbkbfR3cnZm7chlUWLdwmprtCohX4HUtlOcQjLYCu+fzGJH2QRKvP3UNz8bWk1qMxjGTOMThZ3kvgLI5AzFfo379UAAAAASUVORK5CYII=', 'avatar.png');
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'png',
+            meta: {
+                dimension: {
+                    height: 24,
+                    width: 24,
+                },
+                host: 'www.inkscape.org',
+            },
+            mimeType: 'image/png',
+            name: data.avatar.name,
+            originalName: 'avatar.png',
+            size: 965,
+        });
+    });
+    test('with base64 (no prefix)', async ({ assert }) => {
+        const avatar = await attachmentManager.createFromBase64('iVBORw0KGgoAAAANSUhEUgAAABgAAAAYCAYAAADgdz34AAAABHNCSVQICAgIfAhkiAAAAAlwSFlzAAAApgAAAKYB3X3/OAAAABl0RVh0U29mdHdhcmUAd3d3Lmlua3NjYXBlLm9yZ5vuPBoAAANCSURBVEiJtZZPbBtFFMZ/M7ubXdtdb1xSFyeilBapySVU8h8OoFaooFSqiihIVIpQBKci6KEg9Q6H9kovIHoCIVQJJCKE1ENFjnAgcaSGC6rEnxBwA04Tx43t2FnvDAfjkNibxgHxnWb2e/u992bee7tCa00YFsffekFY+nUzFtjW0LrvjRXrCDIAaPLlW0nHL0SsZtVoaF98mLrx3pdhOqLtYPHChahZcYYO7KvPFxvRl5XPp1sN3adWiD1ZAqD6XYK1b/dvE5IWryTt2udLFedwc1+9kLp+vbbpoDh+6TklxBeAi9TL0taeWpdmZzQDry0AcO+jQ12RyohqqoYoo8RDwJrU+qXkjWtfi8Xxt58BdQuwQs9qC/afLwCw8tnQbqYAPsgxE1S6F3EAIXux2oQFKm0ihMsOF71dHYx+f3NND68ghCu1YIoePPQN1pGRABkJ6Bus96CutRZMydTl+TvuiRW1m3n0eDl0vRPcEysqdXn+jsQPsrHMquGeXEaY4Yk4wxWcY5V/9scqOMOVUFthatyTy8QyqwZ+kDURKoMWxNKr2EeqVKcTNOajqKoBgOE28U4tdQl5p5bwCw7BWquaZSzAPlwjlithJtp3pTImSqQRrb2Z8PHGigD4RZuNX6JYj6wj7O4TFLbCO/Mn/m8R+h6rYSUb3ekokRY6f/YukArN979jcW+V/S8g0eT/N3VN3kTqWbQ428m9/8k0P/1aIhF36PccEl6EhOcAUCrXKZXXWS3XKd2vc/TRBG9O5ELC17MmWubD2nKhUKZa26Ba2+D3P+4/MNCFwg59oWVeYhkzgN/JDR8deKBoD7Y+ljEjGZ0sosXVTvbc6RHirr2reNy1OXd6pJsQ+gqjk8VWFYmHrwBzW/n+uMPFiRwHB2I7ih8ciHFxIkd/3Omk5tCDV1t+2nNu5sxxpDFNx+huNhVT3/zMDz8usXC3ddaHBj1GHj/As08fwTS7Kt1HBTmyN29vdwAw+/wbwLVOJ3uAD1wi/dUH7Qei66PfyuRj4Ik9is+hglfbkbfR3cnZm7chlUWLdwmprtCohX4HUtlOcQjLYCu+fzGJH2QRKvP3UNz8bWk1qMxjGTOMThZ3kvgLI5AzFfo379UAAAAASUVORK5CYII=', 'avatar.png');
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'png',
+            meta: {
+                dimension: {
+                    height: 24,
+                    width: 24,
+                },
+                host: 'www.inkscape.org',
+            },
+            mimeType: 'image/png',
+            name: data.avatar.name,
+            originalName: 'avatar.png',
+            size: 965,
+        });
+    });
+    test('with buffer', async ({ assert }) => {
+        const buffer = await readFile(app.makePath('../fixtures/images/img.jpg'));
+        const avatar = await attachmentManager.createFromBuffer(buffer, 'avatar.jpg');
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'jpg',
+            meta: {
+                dimension: {
+                    height: 1313,
+                    width: 1920,
+                },
+            },
+            mimeType: 'image/jpeg',
+            name: data.avatar.name,
+            originalName: 'avatar.jpg',
+            size: 122851,
+        });
+    });
+    test('with file', async ({ assert }) => {
+        const file = new MultipartFileFactory()
+            .merge({
+            size: 4000000,
+            extname: 'jpg',
+            type: 'image',
+            subtype: 'jpeg',
+        })
+            .create();
+        file.tmpPath = app.makePath('../fixtures/images/img.jpg');
+        const avatar = await attachmentManager.createFromFile(file);
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'jpg',
+            meta: {
+                dimension: {
+                    height: 1313,
+                    width: 1920,
+                },
+            },
+            mimeType: 'image/jpeg',
+            name: data.avatar.name,
+            originalName: 'file.jpg',
+            size: 4000000,
+        });
+    });
+    test('with path', async ({ assert }) => {
+        const path = app.makePath('../fixtures/images/img.jpg');
+        const avatar = await attachmentManager.createFromPath(path, 'file.jpg');
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'jpg',
+            meta: {
+                dimension: {
+                    height: 1313,
+                    width: 1920,
+                },
+            },
+            mimeType: 'image/jpeg',
+            name: data.avatar.name,
+            originalName: 'file.jpg',
+            size: 83,
+        });
+    });
+    test('with url', async ({ assert }) => {
+        const url = new URL('https://raw.githubusercontent.com/batosai/adonis-attachment/refs/heads/develop/tests/fixtures/images/img.jpg');
+        const avatar = await attachmentManager.createFromUrl(url, 'file.jpg');
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'jpg',
+            meta: {
+                dimension: {
+                    height: 1313,
+                    width: 1920,
+                },
+            },
+            mimeType: 'image/jpeg',
+            name: data.avatar.name,
+            originalName: 'file.jpg',
+            size: 31,
+        });
+    });
+    test('with stream', async ({ assert }) => {
+        async function downloadImageStream(input) {
+            return await new Promise((resolve) => {
+                https.get(input, (response) => {
+                    if (response.statusCode === 200) {
+                        resolve(response);
+                    }
+                });
+            });
+        }
+        const url = new URL('https://raw.githubusercontent.com/batosai/adonis-attachment/refs/heads/develop/tests/fixtures/images/img.jpg');
+        const stream = await downloadImageStream(url);
+        const avatar = await attachmentManager.createFromStream(stream, 'file.jpg');
+        const user = await UserFactory.merge({ avatar }).create();
+        const data = await user.serialize();
+        assert.deepEqual(data.avatar, {
+            extname: 'jpg',
+            meta: {
+                dimension: {
+                    height: 1313,
+                    width: 1920,
+                },
+            },
+            mimeType: 'image/jpeg',
+            name: data.avatar.name,
+            originalName: 'file.jpg',
+            size: 31,
+        });
+    });
+});

package/build/tests/attachment.spec.d.ts

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

package/build/tests/attachment.spec.js

@@ -0,0 +1,16 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { test } from '@japa/runner';
+import { UserFactory } from './fixtures/factories/user.js';
+test.group('attachment', () => {
+    test('delete', async ({ assert }) => {
+        const user = await UserFactory.create();
+        user.avatar = null;
+        await user.save();
+        assert.isNull(user.avatar);
+    });
+});

package/build/tests/commands.spec.d.ts

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

package/build/tests/commands.spec.js

@@ -0,0 +1,58 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { test } from '@japa/runner';
+import Configure from '@adonisjs/core/commands/configure';
+import { IgnitorFactory } from '@adonisjs/core/factories';
+import MakeConverter from '../commands/make/converter.js';
+import { BASE_URL } from './helpers/index.js';
+async function setupFakeAdonisProject(fs) {
+    await Promise.all([
+        fs.create('.env', ''),
+        fs.createJson('tsconfig.json', {}),
+        fs.create('adonisrc.ts', `export default defineConfig({})`),
+    ]);
+}
+async function setupApp() {
+    const ignitor = new IgnitorFactory()
+        .withCoreProviders()
+        .withCoreConfig()
+        .create(BASE_URL, {
+        importer: (filePath) => {
+            if (filePath.startsWith('./') || filePath.startsWith('../')) {
+                return import(new URL(filePath, BASE_URL).href);
+            }
+            return import(filePath);
+        },
+    });
+    const app = ignitor.createApp('web');
+    await app.init();
+    await app.boot();
+    const ace = await app.container.make('ace');
+    ace.ui.switchMode('raw');
+    return { ace, app };
+}
+test.group('configure', (group) => {
+    group.tap((t) => t.timeout(20_000));
+    group.each.setup(async ({ context }) => setupFakeAdonisProject(context.fs));
+    test('add provider, config file, and command', async ({ assert }) => {
+        const { ace } = await setupApp();
+        const command = await ace.create(Configure, ['../../configure.js']);
+        await command.exec();
+        command.assertSucceeded();
+        await assert.fileExists('config/attachment.ts');
+        await assert.fileExists('adonisrc.ts');
+        await assert.fileContains('adonisrc.ts', '@jrmc/adonis-attachment/attachment_provider');
+        await assert.fileContains('adonisrc.ts', '@jrmc/adonis-attachment/commands');
+    });
+    test('create converter', async ({ assert }) => {
+        const { ace } = await setupApp();
+        const command = await ace.create(MakeConverter, ['thumb']);
+        await command.exec();
+        command.assertSucceeded();
+        await assert.fileExists('app/converters/thumb_converter.ts');
+    });
+});

package/build/tests/fixtures/converters/image_converter.d.ts

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

package/build/tests/fixtures/converters/image_converter.js

@@ -0,0 +1,12 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import Converter from '../../../src/converters/converter.js';
+export default class ImageConverter extends Converter {
+    async handle({ input }) {
+        return input;
+    }
+}

package/build/tests/fixtures/factories/user.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import User from '../models/user.js';
+export declare const UserFactory: import("@adonisjs/lucid/types/factory").FactoryBuilderQueryContract<typeof User, import("@adonisjs/lucid/types/factory").FactoryModelContract<typeof User>>;

package/build/tests/fixtures/factories/user.js

@@ -0,0 +1,19 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { readFile } from 'node:fs/promises';
+import User from '../models/user.js';
+import Factory from '@adonisjs/lucid/factories';
+import app from '@adonisjs/core/services/app';
+export const UserFactory = Factory.define(User, async ({ faker }) => {
+    const attachmentManager = await app.container.make('jrmc.attachment');
+    const buffer = await readFile(app.makePath('../fixtures/images/img.jpg'));
+    const avatar = await attachmentManager.createFromBuffer(buffer, 'avatar.jpg');
+    return {
+        name: faker.person.lastName(),
+        avatar,
+    };
+}).build();

package/build/tests/fixtures/factories/user_with_variants.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import User from '../models/user_with_variants.js';
+export declare const UserFactory: import("@adonisjs/lucid/types/factory").FactoryBuilderQueryContract<typeof User, import("@adonisjs/lucid/types/factory").FactoryModelContract<typeof User>>;

package/build/tests/fixtures/factories/user_with_variants.js

@@ -0,0 +1,19 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { readFile } from 'node:fs/promises';
+import User from '../models/user_with_variants.js';
+import Factory from '@adonisjs/lucid/factories';
+import app from '@adonisjs/core/services/app';
+export const UserFactory = Factory.define(User, async ({ faker }) => {
+    const attachmentManager = await app.container.make('jrmc.attachment');
+    const buffer = await readFile(app.makePath('../fixtures/images/img.jpg'));
+    const avatar = await attachmentManager.createFromBuffer(buffer, 'avatar.jpg');
+    return {
+        name: faker.person.lastName(),
+        avatar,
+    };
+}).build();

package/build/tests/fixtures/migrations/create_users_table.d.ts

@@ -0,0 +1,12 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { BaseSchema } from '@adonisjs/lucid/schema';
+export default class extends BaseSchema {
+    protected tableName: string;
+    up(): Promise<void>;
+    down(): Promise<void>;
+}

package/build/tests/fixtures/migrations/create_users_table.js

@@ -0,0 +1,23 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { BaseSchema } from '@adonisjs/lucid/schema';
+export default class extends BaseSchema {
+    tableName = 'users';
+    async up() {
+        this.schema.createTable(this.tableName, (table) => {
+            table.increments('id');
+            table.string('name');
+            table.json('avatar');
+            table.json('avatar_2');
+            table.timestamp('created_at');
+            table.timestamp('updated_at');
+        });
+    }
+    async down() {
+        this.schema.dropTable(this.tableName);
+    }
+}