@jrmc/adonis-attachment 6.0.0-alpha.0 → 6.0.0-alpha.1

package/build/tests/migrate_legacy_attachment.spec.js

@@ -4,88 +4,130 @@
  * @license MIT
  * @copyright Jeremy Chaufourier <jeremy@chaufourier.fr>
  */
-import { test } from '@japa/runner';
-import { migrateLegacyAttachment } from '../index.js';
-import { createAttachmentOwnerKey } from '../src/integrations/lucid/attachment_owner.js';
-test.group('migrateLegacyAttachment', () => {
-    test('converts an original attachment and its variants to polymorphic rows', ({ assert }) => {
-        const ids = ['original-id', 'thumbnail-id'];
+import { test } from "@japa/runner";
+import { migrateLegacyAttachment, migrateLegacyAttachmentColumn, } from "../index.js";
+import { createAttachmentOwnerKey } from "../src/integrations/lucid/attachment_owner.js";
+test.group("migrateLegacyAttachment", () => {
+    test("converts an original attachment and its variants to polymorphic rows", ({ assert, }) => {
+        const ids = ["original-id", "thumbnail-id"];
         const rows = migrateLegacyAttachment({
-            name: 'avatar.jpg',
-            originalName: 'profile.jpg',
+            name: "avatar.jpg",
+            originalName: "profile.jpg",
             size: 42,
-            extname: 'jpg',
-            mimeType: 'image/jpeg',
-            disk: 's3',
-            path: 'users/42/avatar.jpg',
+            extname: "jpg",
+            mimeType: "image/jpeg",
+            disk: "s3",
+            path: "users/42/avatar.jpg",
             meta: { width: 800 },
             variants: [
                 {
-                    key: 'thumbnail',
-                    name: 'avatar.webp',
+                    key: "thumbnail",
+                    name: "avatar.webp",
                     size: 12,
-                    extname: 'webp',
-                    mimeType: 'image/webp',
-                    path: 'users/42/variants/avatar.webp',
+                    extname: "webp",
+                    mimeType: "image/webp",
+                    path: "users/42/variants/avatar.webp",
                 },
             ],
         }, {
-            owner: { type: 'users', id: '42', field: 'avatar' },
-            defaultDisk: 'public',
+            owner: { type: "users", id: "42", field: "avatar" },
+            defaultDisk: "public",
             createId: () => ids.shift(),
         });
         assert.deepEqual(rows, [
             {
-                id: 'original-id',
-                attachableType: 'users',
-                attachableId: '42',
-                field: 'avatar',
-                ownerKey: createAttachmentOwnerKey({ type: 'users', id: '42', field: 'avatar' }),
+                id: "original-id",
+                attachableType: "users",
+                attachableId: "42",
+                field: "avatar",
+                ownerKey: createAttachmentOwnerKey({
+                    type: "users",
+                    id: "42",
+                    field: "avatar",
+                }),
                 parentId: null,
                 variantKey: null,
-                disk: 's3',
-                path: 'users/42/avatar.jpg',
-                name: 'avatar.jpg',
-                originalName: 'profile.jpg',
-                mimeType: 'image/jpeg',
-                extname: 'jpg',
+                disk: "s3",
+                path: "users/42/avatar.jpg",
+                name: "avatar.jpg",
+                originalName: "profile.jpg",
+                mimeType: "image/jpeg",
+                extname: "jpg",
                 size: 42,
                 metadata: { width: 800 },
             },
             {
-                id: 'thumbnail-id',
-                attachableType: 'users',
-                attachableId: '42',
-                field: 'avatar',
+                id: "thumbnail-id",
+                attachableType: "users",
+                attachableId: "42",
+                field: "avatar",
                 ownerKey: null,
-                parentId: 'original-id',
-                variantKey: 'thumbnail',
-                disk: 'public',
-                path: 'users/42/variants/avatar.webp',
-                name: 'avatar.webp',
-                originalName: 'profile.jpg',
-                mimeType: 'image/webp',
-                extname: 'webp',
+                parentId: "original-id",
+                variantKey: "thumbnail",
+                disk: "public",
+                path: "users/42/variants/avatar.webp",
+                name: "avatar.webp",
+                originalName: "profile.jpg",
+                mimeType: "image/webp",
+                extname: "webp",
                 size: 12,
                 metadata: null,
             },
         ]);
     });
-    test('accepts a serialized v5 document', ({ assert }) => {
+    test("accepts a serialized v5 document", ({ assert }) => {
         const rows = migrateLegacyAttachment('{"name":"report.pdf","size":10,"extname":"pdf","mimeType":"application/pdf"}', {
-            owner: { type: 'reports', id: 'report-id', field: 'document' },
-            defaultDisk: 'public',
-            createId: () => 'attachment-id',
+            owner: { type: "reports", id: "report-id", field: "document" },
+            defaultDisk: "public",
+            createId: () => "attachment-id",
         });
-        assert.equal(rows[0]?.disk, 'public');
-        assert.equal(rows[0]?.originalName, 'report.pdf');
+        assert.equal(rows[0]?.disk, "public");
+        assert.equal(rows[0]?.originalName, "report.pdf");
     });
-    test('rejects malformed serialized documents', ({ assert }) => {
-        assert.throws(() => migrateLegacyAttachment('{not json}', {
-            owner: { type: 'reports', id: 'report-id', field: 'document' },
-            defaultDisk: 'public',
-            createId: () => 'attachment-id',
-        }), 'Legacy attachment value must be valid JSON');
+    test("rejects malformed serialized documents", ({ assert }) => {
+        assert.throws(() => migrateLegacyAttachment("{not json}", {
+            owner: { type: "reports", id: "report-id", field: "document" },
+            defaultDisk: "public",
+            createId: () => "attachment-id",
+        }), "Legacy attachment value must be valid JSON");
+    });
+    test("converts a v5 document for a retained single attachment column", ({ assert, }) => {
+        const attachment = migrateLegacyAttachmentColumn({
+            name: "avatar.jpg",
+            originalName: "profile.jpg",
+            size: 42,
+            extname: "jpg",
+            mimeType: "image/jpeg",
+            meta: { width: 800 },
+        }, { defaultDisk: "public", createId: () => "attachment-id" });
+        assert.deepEqual(attachment, {
+            id: "attachment-id",
+            disk: "public",
+            path: "avatar.jpg",
+            name: "avatar.jpg",
+            originalName: "profile.jpg",
+            mimeType: "image/jpeg",
+            extname: "jpg",
+            size: 42,
+            metadata: { width: 800 },
+        });
+    });
+    test("rejects legacy variants for a retained single attachment column", ({ assert, }) => {
+        assert.throws(() => migrateLegacyAttachmentColumn({
+            name: "avatar.jpg",
+            size: 42,
+            extname: "jpg",
+            mimeType: "image/jpeg",
+            variants: [
+                {
+                    key: "thumbnail",
+                    name: "thumbnail.jpg",
+                    size: 10,
+                    extname: "jpg",
+                    mimeType: "image/jpeg",
+                },
+            ],
+        }, { defaultDisk: "public", createId: () => "attachment-id" }), "Legacy attachments with variants must migrate to the polymorphic table");
     });
 });
 //# sourceMappingURL=migrate_legacy_attachment.spec.js.map

package/build/tests/migrate_legacy_attachment.spec.js.map

@@ -1 +1 @@
-{"version":3,"file":"migrate_legacy_attachment.spec.js","sourceRoot":"","sources":["../../tests/migrate_legacy_attachment.spec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAA;AAEnC,OAAO,EAAE,uBAAuB,EAAE,MAAM,aAAa,CAAA;AACrD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAA;AAExF,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACzC,IAAI,CAAC,sEAAsE,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAC1F,MAAM,GAAG,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,CAAA;QAC3C,MAAM,IAAI,GAAG,uBAAuB,CAClC;YACE,IAAI,EAAE,YAAY;YAClB,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACpB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,WAAW;oBAChB,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE,MAAM;oBACf,QAAQ,EAAE,YAAY;oBACtB,IAAI,EAAE,+BAA+B;iBACtC;aACF;SACF,EACD;YACE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YACnD,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,EAAG;SAC7B,CACF,CAAA;QAED,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE;YACrB;gBACE,EAAE,EAAE,aAAa;gBACjB,cAAc,EAAE,OAAO;gBACvB,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,wBAAwB,CAAC,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;gBAChF,QAAQ,EAAE,IAAI;gBACd,UAAU,EAAE,IAAI;gBAChB,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,YAAY;gBAClB,YAAY,EAAE,aAAa;gBAC3B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,KAAK;gBACd,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;aACzB;YACD;gBACE,EAAE,EAAE,cAAc;gBAClB,cAAc,EAAE,OAAO;gBACvB,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,aAAa;gBACvB,UAAU,EAAE,WAAW;gBACvB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,+BAA+B;gBACrC,IAAI,EAAE,aAAa;gBACnB,YAAY,EAAE,aAAa;gBAC3B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,IAAI;aACf;SACF,CAAC,CAAA;IACJ,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,kCAAkC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACtD,MAAM,IAAI,GAAG,uBAAuB,CAClC,8EAA8E,EAC9E;YACE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE;YAC9D,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe;SAChC,CACF,CAAA;QAED,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAA;QACrC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,CAAA;IACnD,CAAC,CAAC,CAAA;IAEF,IAAI,CAAC,wCAAwC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAC5D,MAAM,CAAC,MAAM,CACX,GAAG,EAAE,CACH,uBAAuB,CAAC,YAAY,EAAE;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE;YAC9D,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe;SAChC,CAAC,EACJ,4CAA4C,CAC7C,CAAA;IACH,CAAC,CAAC,CAAA;AACJ,CAAC,CAAC,CAAA"}
+{"version":3,"file":"migrate_legacy_attachment.spec.js","sourceRoot":"","sources":["../../tests/migrate_legacy_attachment.spec.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,EAAE,IAAI,EAAE,MAAM,cAAc,CAAC;AAEpC,OAAO,EACL,uBAAuB,EACvB,6BAA6B,GAC9B,MAAM,aAAa,CAAC;AACrB,OAAO,EAAE,wBAAwB,EAAE,MAAM,+CAA+C,CAAC;AAEzF,IAAI,CAAC,KAAK,CAAC,yBAAyB,EAAE,GAAG,EAAE;IACzC,IAAI,CAAC,sEAAsE,EAAE,CAAC,EAC5E,MAAM,GACP,EAAE,EAAE;QACH,MAAM,GAAG,GAAG,CAAC,aAAa,EAAE,cAAc,CAAC,CAAC;QAC5C,MAAM,IAAI,GAAG,uBAAuB,CAClC;YACE,IAAI,EAAE,YAAY;YAClB,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,IAAI;YACV,IAAI,EAAE,qBAAqB;YAC3B,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;YACpB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,WAAW;oBAChB,IAAI,EAAE,aAAa;oBACnB,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE,MAAM;oBACf,QAAQ,EAAE,YAAY;oBACtB,IAAI,EAAE,+BAA+B;iBACtC;aACF;SACF,EACD;YACE,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE,QAAQ,EAAE;YACnD,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC,GAAG,CAAC,KAAK,EAAG;SAC7B,CACF,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE;YACrB;gBACE,EAAE,EAAE,aAAa;gBACjB,cAAc,EAAE,OAAO;gBACvB,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,wBAAwB,CAAC;oBACjC,IAAI,EAAE,OAAO;oBACb,EAAE,EAAE,IAAI;oBACR,KAAK,EAAE,QAAQ;iBAChB,CAAC;gBACF,QAAQ,EAAE,IAAI;gBACd,UAAU,EAAE,IAAI;gBAChB,IAAI,EAAE,IAAI;gBACV,IAAI,EAAE,qBAAqB;gBAC3B,IAAI,EAAE,YAAY;gBAClB,YAAY,EAAE,aAAa;gBAC3B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,KAAK;gBACd,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;aACzB;YACD;gBACE,EAAE,EAAE,cAAc;gBAClB,cAAc,EAAE,OAAO;gBACvB,YAAY,EAAE,IAAI;gBAClB,KAAK,EAAE,QAAQ;gBACf,QAAQ,EAAE,IAAI;gBACd,QAAQ,EAAE,aAAa;gBACvB,UAAU,EAAE,WAAW;gBACvB,IAAI,EAAE,QAAQ;gBACd,IAAI,EAAE,+BAA+B;gBACrC,IAAI,EAAE,aAAa;gBACnB,YAAY,EAAE,aAAa;gBAC3B,QAAQ,EAAE,YAAY;gBACtB,OAAO,EAAE,MAAM;gBACf,IAAI,EAAE,EAAE;gBACR,QAAQ,EAAE,IAAI;aACf;SACF,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,kCAAkC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QACtD,MAAM,IAAI,GAAG,uBAAuB,CAClC,8EAA8E,EAC9E;YACE,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE;YAC9D,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe;SAChC,CACF,CAAC;QAEF,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,QAAQ,CAAC,CAAC;QACtC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,YAAY,EAAE,YAAY,CAAC,CAAC;IACpD,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,wCAAwC,EAAE,CAAC,EAAE,MAAM,EAAE,EAAE,EAAE;QAC5D,MAAM,CAAC,MAAM,CACX,GAAG,EAAE,CACH,uBAAuB,CAAC,YAAY,EAAE;YACpC,KAAK,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,WAAW,EAAE,KAAK,EAAE,UAAU,EAAE;YAC9D,WAAW,EAAE,QAAQ;YACrB,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe;SAChC,CAAC,EACJ,4CAA4C,CAC7C,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,gEAAgE,EAAE,CAAC,EACtE,MAAM,GACP,EAAE,EAAE;QACH,MAAM,UAAU,GAAG,6BAA6B,CAC9C;YACE,IAAI,EAAE,YAAY;YAClB,YAAY,EAAE,aAAa;YAC3B,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,YAAY;YACtB,IAAI,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACrB,EACD,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE,CAC3D,CAAC;QAEF,MAAM,CAAC,SAAS,CAAC,UAAU,EAAE;YAC3B,EAAE,EAAE,eAAe;YACnB,IAAI,EAAE,QAAQ;YACd,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,YAAY;YAClB,YAAY,EAAE,aAAa;YAC3B,QAAQ,EAAE,YAAY;YACtB,OAAO,EAAE,KAAK;YACd,IAAI,EAAE,EAAE;YACR,QAAQ,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE;SACzB,CAAC,CAAC;IACL,CAAC,CAAC,CAAC;IAEH,IAAI,CAAC,iEAAiE,EAAE,CAAC,EACvE,MAAM,GACP,EAAE,EAAE;QACH,MAAM,CAAC,MAAM,CACX,GAAG,EAAE,CACH,6BAA6B,CAC3B;YACE,IAAI,EAAE,YAAY;YAClB,IAAI,EAAE,EAAE;YACR,OAAO,EAAE,KAAK;YACd,QAAQ,EAAE,YAAY;YACtB,QAAQ,EAAE;gBACR;oBACE,GAAG,EAAE,WAAW;oBAChB,IAAI,EAAE,eAAe;oBACrB,IAAI,EAAE,EAAE;oBACR,OAAO,EAAE,KAAK;oBACd,QAAQ,EAAE,YAAY;iBACvB;aACF;SACF,EACD,EAAE,WAAW,EAAE,QAAQ,EAAE,QAAQ,EAAE,GAAG,EAAE,CAAC,eAAe,EAAE,CAC3D,EACH,wEAAwE,CACzE,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jrmc/adonis-attachment",
-  "version": "6.0.0-alpha.0",
+  "version": "6.0.0-alpha.1",
   "type": "module",
   "description": "Next-generation attachment primitives for AdonisJS and standalone TypeScript applications",
   "repository": {
@@ -115,9 +115,11 @@
     "better-sqlite3": "^12.11.1",
     "copyfiles": "^2.4.1",
     "del-cli": "^7.0.0",
+    "mermaid": "^11.16.0",
     "prettier": "^3.9.5",
     "typescript": "^5.9.3",
-    "vitepress": "^1.6.4"
+    "vitepress": "^1.6.4",
+    "vitepress-plugin-mermaid": "^2.0.17"
   },
   "peerDependencies": {
     "@adonisjs/core": "^7.0.0",