@efebia/fastify-auto-import 0.0.3 → 1.0.3

package/README.md

@@ -0,0 +1,76 @@
+# @efebia/fastify-auto-import
+
+Fastify plugin that automatically discovers and registers route plugins from a directory.
+
+## Install
+
+```bash
+npm install @efebia/fastify-auto-import
+```
+
+## Usage
+
+```ts
+import Fastify from 'fastify';
+import autoImport from '@efebia/fastify-auto-import';
+
+const fastify = Fastify();
+
+await fastify.register(autoImport, {
+  // Required: the starting directory (use import.meta.url in ESM)
+  startingDirectory: import.meta.url,
+  // Directory to scan, relative to startingDirectory (default: 'src/plugins')
+  directory: 'src/plugins',
+  // File name to import from each subdirectory (default: 'routes')
+  routeFile: 'routes',
+  // Subdirectories to skip (default: [])
+  excludedDirectories: ['_shared'],
+});
+```
+
+Given the following structure:
+
+```
+src/plugins/
+  users/
+    routes.ts
+  orders/
+    routes.ts
+  _shared/
+    utils.ts   ← skipped
+```
+
+The plugin will register `users/routes.ts` and `orders/routes.ts` as Fastify plugins.
+
+Each route file must export a default Fastify plugin:
+
+```ts
+// src/plugins/users/routes.ts
+import type { FastifyPluginAsync } from 'fastify';
+
+const plugin: FastifyPluginAsync = async (fastify) => {
+  fastify.get('/users', async () => ({ users: [] }));
+};
+
+export default plugin;
+```
+
+## API
+
+### `autoImport` (default export)
+
+A `fastify-plugin` compatible plugin. Register it with `fastify.register()`.
+
+**Options** (`Globber`):
+
+| Option | Type | Default | Description |
+|--------|------|---------|-------------|
+| `startingDirectory` | `string` | — | **Required.** Base directory. Pass `import.meta.url` (ESM) or `__dirname` (CJS). |
+| `directory` | `string` | `'src/plugins'` | Directory to scan for route subdirectories, relative to `startingDirectory`. |
+| `routeFile` | `string` | `'routes'` | File name (without extension) to import from each subdirectory. |
+| `excludedDirectories` | `string[]` | `[]` | Subdirectory names to skip. |
+| `log` | `pino.BaseLogger` | Fastify logger | Logger instance for import errors. |
+
+## License
+
+MIT

package/lib/cjs/globber.js

@@ -15,13 +15,23 @@ var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (
 }) : function(o, v) {
     o["default"] = v;
 });
-var __importStar = (this && this.__importStar) || function (mod) {
-    if (mod && mod.__esModule) return mod;
-    var result = {};
-    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
-    __setModuleDefault(result, mod);
-    return result;
-};
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
@@ -50,20 +60,19 @@ const globFiles = async (opts) => {
     const filteredDirectories = routesDirectories.filter(dir => !opts.excludedDirectories.includes(dir));
     const importedFiles = await (0, serial_js_1.serial)(filteredDirectories.map((dir) => async () => {
         var _a;
-        var _b;
         const osPath = node_path_1.default.join(pluginsDirectory, dir, packageType === 'module' ? `${opts.routeFile.replace(".js", "")}.js` : opts.routeFile.replace(".js", ""));
         const href = node_url_1.default.pathToFileURL(osPath).href;
         try {
             if (packageType === "module") {
-                const importedPlugin = await (_a = href, Promise.resolve().then(() => __importStar(require(_a))));
+                const importedPlugin = await Promise.resolve(`${href}`).then(s => __importStar(require(s)));
                 return importedPlugin.default;
             }
             return require(osPath);
         }
         catch (e) {
             console.log(e);
-            (_b = opts.log) === null || _b === void 0 ? void 0 : _b.error({ error: e, path: osPath }, "@efebia/fastify-auto-import error on importing plugin");
-            return null;
+            (_a = opts.log) === null || _a === void 0 ? void 0 : _a.error({ error: e, path: osPath }, "@efebia/fastify-auto-import error on importing plugin");
+            throw e;
         }
     }));
     return importedFiles.filter((e) => e);

package/lib/cjs/index.d.ts

@@ -1,3 +1,3 @@
 import { Globber } from './globber.js';
-declare const plugin: import("fastify").FastifyPluginAsync<Globber, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
+declare const plugin: import("fastify").FastifyPluginCallback<Globber, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
 export default plugin;

package/lib/cjs/index.js

@@ -13,6 +13,6 @@ const plugin = (0, fastify_plugin_1.default)(async (fastify, opts) => {
     }));
 }, {
     name: '@efebia/fastify-auto-import',
-    fastify: '4.x'
+    fastify: '5.x'
 });
 exports.default = plugin;

package/lib/esm/globber.js

@@ -33,7 +33,7 @@ export const globFiles = async (opts) => {
         catch (e) {
             console.log(e);
             (_a = opts.log) === null || _a === void 0 ? void 0 : _a.error({ error: e, path: osPath }, "@efebia/fastify-auto-import error on importing plugin");
-            return null;
+            throw e;
         }
     }));
     return importedFiles.filter((e) => e);

package/lib/esm/index.d.ts

@@ -1,3 +1,3 @@
 import { Globber } from './globber.js';
-declare const plugin: import("fastify").FastifyPluginAsync<Globber, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
+declare const plugin: import("fastify").FastifyPluginCallback<Globber, import("fastify").RawServerDefault, import("fastify").FastifyTypeProviderDefault, import("fastify").FastifyBaseLogger>;
 export default plugin;

package/lib/esm/index.js

@@ -8,6 +8,6 @@ const plugin = fp(async (fastify, opts) => {
     }));
 }, {
     name: '@efebia/fastify-auto-import',
-    fastify: '4.x'
+    fastify: '5.x'
 });
 export default plugin;

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@efebia/fastify-auto-import",
-  "version": "0.0.3",
+  "version": "1.0.3",
   "license": "MIT",
   "main": "./lib/index.js",
   "types": "./lib/index.d.ts",
   "type": "module",
   "dependencies": {
-    "fastify": "^4.11.0",
-    "fastify-plugin": "^4.4.0",
+    "fastify": "^5.3.0",
+    "fastify-plugin": "^5.0.1",
     "pino": "^8.8.0",
     "pkg-up": "^3.1.0"
   },
@@ -16,7 +16,7 @@
     "@types/node": "^18.11.18",
     "jest": "^29.3.1",
     "ts-jest": "^29.0.3",
-    "typescript": "^4.9.4"
+    "typescript": "~5.8.3"
   },
   "files": [
     "/lib"