@jrmc/adonis-attachment 3.0.0 → 3.1.0

package/build/tests/helpers/app.js

@@ -0,0 +1,104 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { copyFile, mkdir } from 'node:fs/promises';
+import { IgnitorFactory } from '@adonisjs/core/factories';
+import { defineConfig as defineLucidConfig } from '@adonisjs/lucid';
+import { defineConfig } from '../../src/define_config.js';
+import { defineConfig as defineDriveConfig, services } from '@adonisjs/drive';
+import { BASE_URL } from './index.js';
+const IMPORTER = (filePath) => {
+    if (filePath.startsWith('./') || filePath.startsWith('../')) {
+        return import(new URL(filePath, BASE_URL).href);
+    }
+    return import(filePath);
+};
+const attachmentConfig = defineConfig({
+    converters: {
+        thumbnail: {
+            converter: () => import('../fixtures/converters/image_converter.js'),
+            options: {
+                resize: 300,
+            },
+        },
+        medium: {
+            converter: () => import('../fixtures/converters/image_converter.js'),
+            options: {
+                resize: 600,
+            },
+        },
+    },
+});
+export async function createApp(options = {}) {
+    const app = new IgnitorFactory()
+        .merge({
+        rcFileContents: {
+            commands: [() => import('@adonisjs/lucid/commands')],
+            providers: [
+                () => import('@adonisjs/lucid/database_provider'),
+                () => import('@adonisjs/drive/drive_provider'),
+                () => import('../../providers/attachment_provider.js'),
+            ],
+        },
+        config: {
+            attachment: options
+                ? defineConfig({
+                    ...options,
+                    converters: {
+                        thumbnail: {
+                            converter: () => import('../fixtures/converters/image_converter.js'),
+                            options: {
+                                resize: 300,
+                            },
+                        },
+                    },
+                })
+                : attachmentConfig,
+            drive: defineDriveConfig({
+                default: 'fs',
+                services: {
+                    fs: services.fs({
+                        location: BASE_URL,
+                        serveFiles: true,
+                        routeBasePath: '/uploads',
+                        visibility: 'public',
+                    }),
+                },
+            }),
+            database: defineLucidConfig({
+                connection: 'sqlite',
+                connections: {
+                    sqlite: {
+                        client: 'better-sqlite3',
+                        connection: {
+                            filename: new URL('../db.sqlite', BASE_URL).pathname,
+                        },
+                    },
+                },
+            }),
+        },
+    })
+        .withCoreConfig()
+        .withCoreProviders()
+        .create(BASE_URL, {
+        importer: IMPORTER,
+    })
+        .createApp('web');
+    await app.init();
+    await app.boot();
+    await mkdir(app.migrationsPath(), { recursive: true });
+    await copyFile(new URL('../fixtures/migrations/create_users_table.ts', import.meta.url), app.migrationsPath('create_users_table.ts'));
+    return app;
+}
+export async function initializeDatabase(app) {
+    const ace = await app.container.make('ace');
+    await ace.exec('migration:fresh', []);
+    // await seedDatabase()
+}
+// async function seedDatabase() {
+//   const { default: User } = await import('./fixtures/models/user.js')
+//   await User.createMany([{ name: 'AdonisJS' }, { name: 'Jeremy' }])
+// }

package/build/tests/helpers/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+export declare const BASE_URL: import("url").URL;

package/build/tests/helpers/index.js

@@ -0,0 +1,7 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+export const BASE_URL = new URL('../tmp/', import.meta.url);

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

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

package/build/tests/options.spec.js

@@ -0,0 +1,126 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { test } from '@japa/runner';
+import { createApp } from './helpers/app.js';
+import { UserFactory } from './fixtures/factories/user.js';
+test.group('options', () => {
+    test('with default values', async ({ assert, cleanup }) => {
+        const app = await createApp();
+        cleanup(() => {
+            app.terminate();
+        });
+        const user = await UserFactory.create();
+        assert.deepEqual(user.avatar.options, {
+            disk: undefined,
+            folder: 'uploads',
+            preComputeUrl: false,
+            variants: [],
+            meta: true,
+            rename: true,
+        });
+    });
+    test('with config values', async ({ assert, cleanup }) => {
+        const app = await createApp({
+            preComputeUrl: true,
+            meta: false,
+            rename: false,
+        });
+        cleanup(() => {
+            app.terminate();
+        });
+        const user = await UserFactory.create();
+        assert.deepEqual(user.avatar.options, {
+            disk: undefined,
+            folder: 'uploads',
+            preComputeUrl: true,
+            variants: [],
+            meta: false,
+            rename: false,
+        });
+    });
+    test('with model values', async ({ assert, cleanup }) => {
+        const app = await createApp();
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        cleanup(() => {
+            app.terminate();
+        });
+        const avatar2 = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo123.jpg',
+            originalName: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        const user = await UserFactory.merge({ avatar2 }).create();
+        assert.deepEqual(user.avatar2.options, {
+            disk: 's3',
+            folder: 'avatar',
+            preComputeUrl: true,
+            variants: [],
+            meta: false,
+            rename: false,
+        });
+    });
+    test('with priority 1/model 2/config 3/default values', async ({ assert, cleanup }) => {
+        const app = await createApp({
+            preComputeUrl: false,
+            meta: true,
+            rename: true,
+        });
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        cleanup(() => {
+            app.terminate();
+        });
+        const avatar2 = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo123.jpg',
+            originalName: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        const user = await UserFactory.merge({ avatar2 }).create();
+        assert.deepEqual(user.avatar2.options, {
+            disk: 's3',
+            folder: 'avatar',
+            preComputeUrl: true,
+            variants: [],
+            meta: false,
+            rename: false,
+        });
+    });
+    test('with rename options', async ({ assert, cleanup }) => {
+        const app = await createApp({
+            rename: true,
+        });
+        const attachmentManager = await app.container.make('jrmc.attachment');
+        cleanup(() => {
+            app.terminate();
+        });
+        const avatar2 = attachmentManager.createFromDbResponse(JSON.stringify({
+            size: 1440,
+            name: 'foo123.jpg',
+            originalName: 'foo.jpg',
+            extname: 'jpg',
+            mimeType: 'image/jpg',
+        }));
+        const user = await UserFactory.merge({ avatar2 }).create();
+        const data = user.serialize();
+        assert.notEqual(data.avatar.name, 'avatar.jpg');
+        assert.equal(data.avatar2.name, 'foo.jpg');
+    });
+    test('with meta options', async ({ assert, cleanup }) => {
+        const app = await createApp({
+            meta: true,
+        });
+        cleanup(() => {
+            app.terminate();
+        });
+        const user = await UserFactory.create();
+        const data = user.serialize();
+        assert.deepEqual(data.avatar.meta, { dimension: { width: 1920, height: 1313 } });
+    });
+});

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

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

package/build/tests/variants.spec.js

@@ -0,0 +1,21 @@
+/**
+ * @jrmc/adonis-attachment
+ *
+ * @license MIT
+ * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
+ */
+import { test } from '@japa/runner';
+import { createApp } from './helpers/app.js';
+import { UserFactory } from './fixtures/factories/user_with_variants.js';
+test.group('variants', () => {
+    test('generation', async ({ assert, cleanup }) => {
+        const app = await createApp();
+        cleanup(() => {
+            app.terminate();
+        });
+        const user = await UserFactory.create();
+        const data = await user.serialize();
+        assert.isNotNull(data.avatar.thumbnail);
+        assert.isNotNull(data.avatar.medium);
+    }).timeout(10_000);
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "3.0.0",
+  "version": "3.1.0",
   "type": "module",
   "description": "Turn any field on your Lucid model to an attachment data type",
   "engines": {
@@ -46,7 +46,9 @@
     "format": "prettier --write .",
     "docs:dev": "vitepress dev docs",
     "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
+    "docs:preview": "vitepress preview docs",
+    "test": "c8 npm run quick:test",
+    "quick:test": "node --import=./tsnode.esm.js --enable-source-maps bin/test.ts"
   },
   "exports": {
     ".": "./build/index.js",
@@ -63,22 +65,36 @@
   },
   "dependencies": {
     "@poppinss/defer": "^1.1.0",
-    "exifreader": "^4.23.3",
-    "file-type": "^19.4.0"
+    "exifreader": "^4.25.0",
+    "file-type": "^19.6.0"
   },
   "devDependencies": {
-    "@adonisjs/assembler": "^7.7.0",
-    "@adonisjs/core": "^6.12.1",
+    "@adonisjs/assembler": "^7.8.2",
+    "@adonisjs/core": "^6.17.0",
     "@adonisjs/drive": "^3.2.0",
-    "@adonisjs/lucid": "^20.6.0",
-    "@adonisjs/prettier-config": "^1.3.0",
-    "@adonisjs/tsconfig": "^1.3.0",
-    "@types/node": "^22.2.0",
+    "@adonisjs/lucid": "^21.5.1",
+    "@adonisjs/prettier-config": "^1.4.0",
+    "@adonisjs/tsconfig": "^1.4.0",
+    "@japa/assert": "^3.0.0",
+    "@japa/expect-type": "^2.0.2",
+    "@japa/file-system": "^2.3.0",
+    "@japa/plugin-adonisjs": "^3.0.1",
+    "@japa/runner": "^3.1.4",
+    "@poppinss/utils": "^6.8.3",
+    "@swc/core": "^1.10.1",
+    "@types/luxon": "^3.4.2",
+    "@types/node": "^22.10.2",
+    "@types/sinon": "^17.0.3",
+    "better-sqlite3": "^11.7.0",
+    "c8": "^10.1.3",
     "copyfiles": "^2.4.1",
-    "del-cli": "^5.1.0",
-    "prettier": "^3.3.3",
-    "typescript": "^5.5.4",
-    "vitepress": "^1.3.3"
+    "del-cli": "^6.0.0",
+    "flydrive": "^1.1.0",
+    "luxon": "^3.5.0",
+    "prettier": "^3.4.2",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.7.2",
+    "vitepress": "^1.5.0"
   },
   "peerDependencies": {
     "@adonisjs/core": "^6.12.1",
@@ -86,6 +102,15 @@
     "@adonisjs/lucid": "^20.6.0 || ^21.0.0"
   },
   "prettier": "@adonisjs/prettier-config",
+  "c8": {
+    "reporter": [
+      "text",
+      "html"
+    ],
+    "exclude": [
+      "tests/**"
+    ]
+  },
   "publishConfig": {
     "access": "public",
     "tag": "latest"