@codenameryuu/adonis-lucid-auto-preload 1.7.0 → 1.9.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/index.d.ts

@@ -1,2 +1,2 @@
 export { configure } from './configure.js';
-export { AutoPreload } from './src/mixins/auto_preload.ts';
+export { AutoPreload } from './src/mixins/auto_preload.js';

package/build/index.js

@@ -7,4 +7,4 @@
  * file that was distributed with this source code.
  */
 export { configure } from './configure.js';
-export { AutoPreload } from "./src/mixins/auto_preload.js";
+export { AutoPreload } from './src/mixins/auto_preload.js';

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

@@ -1,5 +1,6 @@
 import type { NormalizeConstructor } from '@adonisjs/core/types/helpers';
 import type { LucidModel, ModelQueryBuilderContract } from '@adonisjs/lucid/types/model';
+type PreloadEntry = string | ((query: ModelQueryBuilderContract<any, any>) => void);
 export declare function AutoPreload<T extends NormalizeConstructor<LucidModel>>(superclass: T): {
     new (...args: any[]): {
         $attributes: import("@adonisjs/lucid/types/model").ModelObject;
@@ -60,16 +61,19 @@ export declare function AutoPreload<T extends NormalizeConstructor<LucidModel>>(
         toAttributes(): Record<string, any>;
         related<Name extends undefined>(relation: Name): NonNullable</*elided*/ any[Name]> extends import("@adonisjs/lucid/types/relations").ModelRelations<LucidModel, LucidModel> ? (import("@adonisjs/lucid/types/relations").ModelRelations<LucidModel, LucidModel> & /*elided*/ any[Name] & {})["client"] : never;
     };
-    $with: Array<string | any>;
-    boot(): void;
     /**
-     * Change from 'protected' to 'public' to fix the TS error
+     * List of relationships to auto-preload.
      */
+    $with: ReadonlyArray<PreloadEntry>;
+    boot(): void;
     applyAutoPreload(query: ModelQueryBuilderContract<any, any>): void;
+    handleNestedPreload(query: any, parts: string[]): void;
     /**
-     * Change from 'private' to 'public'
+     * Correct Implementation: Returns the Query Builder to avoid global state pollution
      */
-    handleNestedPreload(query: any, parts: string[]): void;
+    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>;
     $relationsDefinitions: Map<string, import("@adonisjs/lucid/types/relations").RelationshipsContract>;
@@ -150,3 +154,4 @@ export declare function AutoPreload<T extends NormalizeConstructor<LucidModel>>(
     transaction: import("@adonisjs/lucid/types/database").TransactionFn;
     truncate: (cascade?: boolean) => Promise<void>;
 } & T;
+export {};

package/build/src/mixins/auto_preload.js

@@ -1,27 +1,38 @@
 export function AutoPreload(superclass) {
     return class extends superclass {
+        /**
+         * List of relationships to auto-preload.
+         */
         static $with = [];
         static boot() {
             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]
             this.before('paginate', (queries) => {
-                // Lucid v6/v7 sends [countQuery, mainQuery]
                 const query = Array.isArray(queries) ? queries[1] : queries;
                 this.applyAutoPreload(query);
             });
         }
-        /**
-         * Change from 'protected' to 'public' to fix the TS error
-         */
         static applyAutoPreload(query) {
-            const relations = this.$with || [];
+            // Check if auto-preload has been disabled for this specific query instance
+            if (query.$disableAutoPreload)
+                return;
+            const relations = this.$with;
             if (!Array.isArray(relations))
                 return;
-            relations.forEach((relation) => {
+            // 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('.')) {
                         this.handleNestedPreload(query, relation.split('.'));
                     }
@@ -32,20 +43,35 @@ export function AutoPreload(superclass) {
                 else if (typeof relation === 'function') {
                     relation(query);
                 }
-            });
+            }
         }
-        /**
-         * Change from 'private' to 'public'
-         */
         static handleNestedPreload(query, parts) {
             const current = parts.shift();
             if (!current)
                 return;
             query.preload(current, (builder) => {
                 if (parts.length > 0) {
-                    this.handleNestedPreload(builder, parts);
+                    this.handleNestedPreload(builder, [...parts]);
                 }
             });
         }
+        /**
+         * Correct Implementation: Returns the Query Builder to avoid global state pollution
+         */
+        static without(relations) {
+            const query = this.query();
+            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;
+            return query;
+        }
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codenameryuu/adonis-lucid-auto-preload",
-  "version": "1.7.0",
+  "version": "1.9.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",