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

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

@@ -65,7 +65,9 @@ export declare function AutoPreload<T extends NormalizeConstructor<LucidModel>>(
      * List of relationships to auto-preload.
      */
     $with: ReadonlyArray<PreloadEntry>;
-    boot(): void;
+    beforeFindHook(query: ModelQueryBuilderContract<any, any>): void;
+    beforeFetchHook(query: ModelQueryBuilderContract<any, any>): void;
+    beforePaginateHook(queries: any): void;
     applyAutoPreload(query: ModelQueryBuilderContract<any, any>): void;
     handleNestedPreload(query: any, parts: string[]): void;
     /**
@@ -112,6 +114,7 @@ export declare function AutoPreload<T extends NormalizeConstructor<LucidModel>>(
         <Model extends LucidModel>(this: Model, name: string): import("@adonisjs/lucid/types/relations").RelationshipsContract;
     };
     $defineProperty: <Model extends LucidModel, Prop extends keyof Model>(this: Model, propertyName: Prop, defaultValue: Model[Prop], strategy: "inherit" | "define" | ((value: Model[Prop]) => Model[Prop])) => void;
+    boot: () => void;
     before: {
         <Model extends LucidModel, Event extends "find" | "fetch">(this: Model, event: Event, handler: import("@adonisjs/lucid/types/model").HooksHandler<ModelQueryBuilderContract<Model>, Event>): void;
         <Model extends LucidModel>(this: Model, event: "paginate", handler: import("@adonisjs/lucid/types/model").HooksHandler<[ModelQueryBuilderContract<Model>, ModelQueryBuilderContract<Model>], "paginate">): void;

package/build/src/mixins/auto_preload.js

@@ -1,49 +1,19 @@
+import { beforeFetch, beforeFind, beforePaginate } from '@adonisjs/lucid/orm';
 export function AutoPreload(superclass) {
-    return class extends superclass {
+    class AutoPreloadModel extends superclass {
         /**
          * List of relationships to auto-preload.
          */
         static $with = [];
-        static boot() {
-            if (this.booted)
-                return;
-            super.boot();
-            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) => {
-                if (Array.isArray(queries)) {
-                    const main = extractQuery(queries[1]) ?? extractQuery(queries[0]);
-                    if (main)
-                        this.applyAutoPreload(main);
-                    return;
-                }
-                applyFrom(queries);
-            });
+        static beforeFindHook(query) {
+            this.applyAutoPreload(query);
+        }
+        static beforeFetchHook(query) {
+            this.applyAutoPreload(query);
+        }
+        static beforePaginateHook(queries) {
+            const main = Array.isArray(queries) ? (queries[1] ?? queries[0]) : queries;
+            this.applyAutoPreload(main);
         }
         static applyAutoPreload(query) {
             // Check if auto-preload has been disabled for this specific query instance
@@ -101,5 +71,11 @@ export function AutoPreload(superclass) {
             query.$disableAutoPreload = true;
             return query;
         }
-    };
+    }
+    // Apply Lucid hooks decorators without using `@decorator` syntax
+    // (some package tsconfigs disable the decorator syntax).
+    beforeFind()(AutoPreloadModel, 'beforeFindHook');
+    beforeFetch()(AutoPreloadModel, 'beforeFetchHook');
+    beforePaginate()(AutoPreloadModel, 'beforePaginateHook');
+    return AutoPreloadModel;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@codenameryuu/adonis-lucid-auto-preload",
-  "version": "2.0.0",
+  "version": "2.1.0",
   "description": "Auto-preload multiple relationships when retrieving Lucid models on Adonis JS 7",
   "author": "codenameryuu",
   "license": "MIT",