elysia-autoload 0.0.1

package/README.md

@@ -0,0 +1,97 @@
+# elysia-autoload
+
+Plugin for [Elysia](https://elysiajs.com/) which autoload all routes in directory
+
+## Installation
+
+```bash
+bun install elysia-autoload
+```
+
+## Usage
+
+## Register the plugin
+
+```ts
+import { Elysia } from "elysia";
+import { autoload } from "elysia-autoload";
+
+const app = new Elysia().use(autoload()).listen(3000);
+
+export type ElysiaApp = typeof app;
+```
+
+## Create route
+
+```ts
+// routes/index.ts
+import type { ElysiaApp } from "app";
+
+export default (app: ElysiaApp) => app.get("/", { hello: "world" });
+```
+
+### Directory structure
+
+Guide how `elysia-autoload` match routes
+
+```
+├── app.ts
+├── routes
+    ├── index.ts // index routes
+    ├── posts
+        ├── index.ts
+        └── [id].ts // dynamic params
+    ├── likes
+        ├── [...].ts
+    └── users.ts
+└── package.json
+```
+
+-   /routes/index.ts → /
+-   /routes/posts/index.ts → /posts
+-   /routes/posts/[id].ts → /posts/:id
+-   /routes/users.ts → /users
+-   /routes/likes/[...].ts → /likes/\*
+
+## Options
+
+| Key      | Type     | Default                     | Description                                                         |
+| -------- | -------- | --------------------------- | ------------------------------------------------------------------- |
+| pattern? | string   | "\*\*_/\*_.{ts,js,mjs,cjs}" | [Glob patterns](<https://en.wikipedia.org/wiki/Glob_(programming)>) |
+| dir?     | string   | "./routes"                  | The folder where routes are located                                 |
+| prefix?  | string   |                             | Prefix for routes                                                   |
+| schema?  | Function |                             | Handler for providing routes guard schema                           |
+
+### Usage of schema handler
+
+```ts
+import swagger from "@elysiajs/swagger";
+import Elysia from "elysia";
+import { autoload } from "elysia-autoload";
+
+const app = new Elysia()
+    .use(
+        autoload({
+            schema: ({ path, url }) => {
+                const tag = url.split("/").at(1)!;
+
+                return {
+                    beforeHandle: ({ request }) => {
+                        console.log(request.url);
+                    },
+                    detail: {
+                        description: `Route autoloaded from ${path}`,
+                        tags: [tag],
+                    },
+                };
+            },
+        }),
+    )
+    .use(swagger());
+
+export type ElysiaApp = typeof app;
+
+app.listen(3001, console.log);
+```
+
+### Thanks [https://github.com/wobsoriano/elysia-autoroutes](elysia-autoroutes) for some ideas

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import Elysia from "elysia";
+export interface AutoloadOptions {
+    pattern?: string;
+    dir?: string;
+    prefix?: string;
+    schema?: ({ path, url, }: {
+        path: string;
+        url: string;
+    }) => Parameters<InstanceType<typeof Elysia>["group"]>[1];
+}
+export declare function autoload({ pattern, dir, prefix, schema, }?: AutoloadOptions): Promise<Elysia<"", {
+    request: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    type: {};
+    error: {};
+}, {}, {}, {}, false>>;

package/dist/index.js

@@ -0,0 +1,39 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.autoload = void 0;
+const elysia_1 = require("elysia");
+const node_fs_1 = require("node:fs");
+const node_path_1 = require("node:path");
+const utils_1 = require("./utils");
+async function autoload({ pattern, dir, prefix, schema, } = {}) {
+    const directoryPath = (0, utils_1.getPath)(dir || "./routes");
+    if (!node_fs_1.default.existsSync(directoryPath))
+        throw new Error(`Directory ${directoryPath} doesn't exists`);
+    if (!node_fs_1.default.statSync(directoryPath).isDirectory())
+        throw new Error(`${directoryPath} isn't a directory`);
+    const app = new elysia_1.default({
+        name: "elysia-autoload",
+        seed: {
+            pattern,
+            dir,
+        },
+    });
+    const glob = new Bun.Glob(pattern || "**/*.{ts,js,mjs,cjs}");
+    const files = await Array.fromAsync(glob.scan({
+        cwd: directoryPath,
+    }));
+    for await (const path of (0, utils_1.sortByNestedParams)(files)) {
+        const file = await Promise.resolve(`${(0, node_path_1.join)(directoryPath, path)}`).then(s => require(s));
+        if (!file.default)
+            throw new Error(`${path} don't provide export default`);
+        const url = (0, utils_1.transformToUrl)(path);
+        const groupOptions = schema ? schema({ path, url }) : {};
+        // Типы свойства "body" несовместимы.
+        // Тип "string | TSchema | undefined" не может быть назначен для типа "TSchema | undefined".
+        // Тип "string" не может быть назначен для типа "TSchema".ts(2345)
+        // @ts-expect-error why....
+        app.group((prefix ?? "") + url, groupOptions, file.default);
+    }
+    return app;
+}
+exports.autoload = autoload;

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+export declare function getPath(dir: string): string;
+export declare function transformToUrl(path: string): string;
+export declare function sortByNestedParams(routes: string[]): string[];

package/dist/utils.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.sortByNestedParams = exports.transformToUrl = exports.getPath = void 0;
+const node_path_1 = require("node:path");
+function getPath(dir) {
+    if ((0, node_path_1.isAbsolute)(dir))
+        return dir;
+    if ((0, node_path_1.isAbsolute)(process.argv[1]))
+        return (0, node_path_1.join)(process.argv[1], "..", dir);
+    return (0, node_path_1.join)(process.cwd(), process.argv[1], "..", dir);
+}
+exports.getPath = getPath;
+// Inspired by https://github.com/wobsoriano/elysia-autoroutes/blob/main/src/utils/transformPathToUrl.ts#L4C31-L4C31
+function transformToUrl(path) {
+    const replacements = [
+        // Clean the url extensions
+        { regex: /\.(ts|js|mjs|cjs)$/u, replacement: "" },
+        // Handle wild card based routes - users/[...id]/profile.ts -> users/*/profile
+        { regex: /\[\.\.\..*\]/gu, replacement: "*" },
+        // Handle generic square bracket based routes - users/[id]/index.ts -> users/:id
+        {
+            regex: /\[(.*?)\]/gu,
+            replacement: (_, match) => `:${match}`,
+        },
+        // Handle the case when multiple parameters are present in one file
+        // users / [id] - [name].ts to users /: id -:name and users / [id] - [name] / [age].ts to users /: id -: name /: age
+        { regex: /\]-\[/gu, replacement: "-:" },
+        { regex: /\]\//gu, replacement: "/" },
+        { regex: /\[/gu, replacement: "" },
+        { regex: /\]/gu, replacement: "" },
+        // remove index from end of path
+        { regex: /\/?index$/, replacement: "" },
+    ];
+    let url = path;
+    for (const { regex, replacement } of replacements) {
+        url = url.replace(regex, replacement);
+    }
+    return "/" + url;
+}
+exports.transformToUrl = transformToUrl;
+function getParamsCount(path) {
+    return path.match(/\[(.*?)\]/gu)?.length || 0;
+}
+// Is it necessary?..
+// Sorts by the smallest parameters
+function sortByNestedParams(routes) {
+    return routes.sort((a, b) => getParamsCount(a) - getParamsCount(b));
+}
+exports.sortByNestedParams = sortByNestedParams;

package/package.json

@@ -0,0 +1,33 @@
+{
+    "name": "elysia-autoload",
+    "version": "0.0.1",
+    "author": "kravetsone",
+    "description": "Plugin for Elysia which autoload all routes in directory",
+    "keywords": [
+        "bun",
+        "elysia",
+        "autoimports",
+        "autoload",
+        "nextjs",
+        "filerouter",
+        "autoroutes"
+    ],
+    "scripts": {
+        "prepublishOnly": "npm run lint:fix && tsc",
+        "lint": "eslint \"src/**/*.{ts,tsx,js,mjs,cjs}\"",
+        "lint:fix": "eslint \"src/**/*.{ts,tsx,js,mjs,cjs}\" --fix"
+    },
+    "devDependencies": {
+        "bun-types": "latest",
+        "eslint": "^8.41.0",
+        "eslint-kit": "^10.0.0",
+        "prettier": "^3.0.0"
+    },
+    "peerDependencies": {
+        "typescript": "^5.0.0",
+        "elysia": "^0.8.0"
+    },
+    "files": [
+        "dist"
+    ]
+}