@codenameryuu/adonis-lucid-auto-preload 1.8.0 → 2.0.0

package/build/adonis-typings/auto_preload.d.ts

@@ -5,10 +5,10 @@ type GetWith<T> = T extends {
 } ? Item extends string ? Item : string : string;
 export interface AutoPreloadMixin {
     <T extends NormalizeConstructor<LucidModel>>(superclass: T): T & {
-        $with: Array<string | ((query: any) => void)>;
-        without(this: T, relationships: Array<GetWith<T>>): T;
-        withOnly(this: T, relationships: Array<GetWith<T>>): T;
-        withoutAny(this: T): T;
+        $with: ReadonlyArray<string | ((query: any) => void)>;
+        without(this: T, relationships: Array<GetWith<T>>): any;
+        withOnly(this: T, relationships: Array<GetWith<T>>): any;
+        withoutAny(this: T): any;
         new (...args: Array<any>): {};
     };
 }

package/build/providers/auto_preload_provider.js

@@ -1,3 +1,4 @@
+import { AutoPreload } from '../src/mixins/auto_preload.js';
 export { configure } from '../configure.js';
 export default class AutoPreloadProvider {
     app;
@@ -5,7 +6,11 @@ export default class AutoPreloadProvider {
     constructor(app) {
         this.app = app;
     }
-    register() { }
+    register() {
+        this.app.container.singleton('@codenameryuu/adonis-lucid-auto-preload', () => {
+            return { AutoPreload };
+        });
+    }
     async boot() { }
     async ready() { }
     async shutdown() { }

package/build/src/mixins/auto_preload.d.ts

@@ -72,6 +72,7 @@ export declare function AutoPreload<T extends NormalizeConstructor<LucidModel>>(
      * Correct Implementation: Returns the Query Builder to avoid global state pollution
      */
     without(relations: string[]): ModelQueryBuilderContract</*elided*/ any & T, InstanceType</*elided*/ any & T>>;
+    withOnly(relations: string[]): ModelQueryBuilderContract</*elided*/ any & T, InstanceType</*elided*/ any & T>>;
     withoutAny(): ModelQueryBuilderContract</*elided*/ any & T, InstanceType</*elided*/ any & T>>;
     readonly booted: boolean;
     $columnsDefinitions: Map<string, import("@adonisjs/lucid/types/model").ModelColumnOptions>;

package/build/src/mixins/auto_preload.js

@@ -8,13 +8,41 @@ export function AutoPreload(superclass) {
             if (this.booted)
                 return;
             super.boot();
-            // We use 'find' and 'fetch' hooks
-            this.before('find', (query) => this.applyAutoPreload(query));
-            this.before('fetch', (query) => this.applyAutoPreload(query));
-            // Lucid v7 paginate sends [countQuery, mainQuery]
+            const extractQuery = (arg) => {
+                if (arg && typeof arg === 'object' && typeof arg.preload === 'function')
+                    return arg;
+                if (Array.isArray(arg)) {
+                    const candidate = arg.find((q) => q && typeof q === 'object' && typeof q.preload === 'function');
+                    return candidate ?? arg[1] ?? arg[0] ?? null;
+                }
+                return null;
+            };
+            const applyFrom = (arg) => {
+                const query = extractQuery(arg);
+                if (query)
+                    this.applyAutoPreload(query);
+            };
+            // Covers common Lucid model/query operations
+            for (const hook of [
+                'find',
+                'findOrFail',
+                'fetch',
+                'first',
+                'firstOrFail',
+                'all',
+                'get',
+            ]) {
+                this.before(hook, (arg) => applyFrom(arg));
+            }
+            // Lucid paginate sends [countQuery, mainQuery]
             this.before('paginate', (queries) => {
-                const query = Array.isArray(queries) ? queries[1] : queries;
-                this.applyAutoPreload(query);
+                if (Array.isArray(queries)) {
+                    const main = extractQuery(queries[1]) ?? extractQuery(queries[0]);
+                    if (main)
+                        this.applyAutoPreload(main);
+                    return;
+                }
+                applyFrom(queries);
             });
         }
         static applyAutoPreload(query) {
@@ -26,8 +54,11 @@ export function AutoPreload(superclass) {
                 return;
             // Get list of relations to skip for this specific query
             const skipList = query.$skipPreloads || [];
+            const onlyList = query.$onlyPreloads || [];
             for (const relation of relations) {
                 if (typeof relation === 'string') {
+                    if (onlyList.length > 0 && !onlyList.includes(relation))
+                        continue;
                     if (skipList.includes(relation))
                         continue;
                     if (relation.includes('.')) {
@@ -60,6 +91,11 @@ export function AutoPreload(superclass) {
             query.$skipPreloads = relations;
             return query;
         }
+        static withOnly(relations) {
+            const query = this.query();
+            query.$onlyPreloads = relations;
+            return query;
+        }
         static withoutAny() {
             const query = this.query();
             query.$disableAutoPreload = true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codenameryuu/adonis-lucid-auto-preload",
-  "version": "1.8.0",
+  "version": "2.0.0",
   "description": "Auto-preload multiple relationships when retrieving Lucid models on Adonis JS 7",
   "author": "codenameryuu",
   "license": "MIT",
@@ -13,17 +13,27 @@
     "node": ">=24.0.0"
   },
   "type": "module",
+  "types": "./build/index.d.ts",
   "files": [
     "build",
     "!build/bin",
     "!build/tests"
   ],
   "exports": {
-    ".": "./build/index.js",
-    "./mixins": "./build/src/mixins/auto_preload.js",
+    ".": {
+      "types": "./build/index.d.ts",
+      "default": "./build/index.js"
+    },
+    "./mixins": {
+      "types": "./build/src/mixins/auto_preload.d.ts",
+      "default": "./build/src/mixins/auto_preload.js"
+    },
     "./adonis-typings/*": "./build/adonis-typings/*.js",
     "./exceptions/*": "./build/exceptions/*.js",
-    "./provider": "./build/providers/auto_preload_provider.js"
+    "./provider": {
+      "types": "./build/providers/auto_preload_provider.d.ts",
+      "default": "./build/providers/auto_preload_provider.js"
+    }
   },
   "scripts": {
     "clean": "del-cli build",