elysia-autoload 0.0.3 → 0.1.1

package/README.md

@@ -1,6 +1,6 @@
 # elysia-autoload
 
-Plugin for [Elysia](https://elysiajs.com/) which autoload all routes in directory
+Plugin for [Elysia](https://elysiajs.com/) which autoload all routes in directory and code-generate types for [Eden](https://elysiajs.com/eden/overview.html)
 
 ## Installation
 
@@ -55,12 +55,62 @@ Guide how `elysia-autoload` match routes
 
 ## 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                           |
+| 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                                                                   |
+| types?   | boolean \| [Types Options](#types-options) | false                       | Options to configure type code-generation. if boolean - enables/disables generation |
+| schema?  | Function                                   |                             | Handler for providing routes guard schema                                           |
+
+### Types Options
+
+| Key        | Type    | Default             | Description                                                                             |
+| ---------- | ------- | ------------------- | --------------------------------------------------------------------------------------- |
+| output?    | string  | "./routes-types.ts" | Type code-generation output                                                             |
+| typeName?  | string  | "Routes"            | Name for code-generated global type for [Eden](https://elysiajs.com/eden/overview.html) |
+| useExport? | boolean | false               | Use export instead of global type                                                       |
+
+### Usage of types code-generation for [Eden](https://elysiajs.com/eden/overview.html)
+
+```ts
+// app.ts
+import { Elysia } from "elysia";
+import { autoload } from "elysia-autoload";
+
+const app = new Elysia()
+    .use(
+        autoload({
+            types: {
+                output: "./routes.ts",
+                typeName: "Routes",
+            }, // or pass true for use default params
+        }),
+    )
+    .listen(3000);
+
+export type ElysiaApp = typeof app;
+```
+
+```ts
+// client.ts
+
+import { edenTreaty } from "@elysiajs/eden";
+
+// Routes are a global type so you don't need to import it.
+
+const app = edenTreaty<Routes>("http://localhost:3002");
+
+const { data } = await app.test["some-path-param"].get({
+    $query: {
+        key: 2,
+    },
+});
+
+console.log(data);
+```
+
+Example of app with types code-generation you can see in [example](https://github.com/kravetsone/elysia-autoload/tree/main/example)
 
 ### Usage of schema handler
 

package/dist/index.d.ts

@@ -1,14 +1,21 @@
 import Elysia from "elysia";
-export interface AutoloadOptions {
+type TSchemaHandler = ({ path, url, }: {
+    path: string;
+    url: string;
+}) => Parameters<InstanceType<typeof Elysia>["group"]>[1];
+export interface ITypesOptions {
+    output?: string;
+    typeName?: string;
+    useExport?: boolean;
+}
+export interface IAutoloadOptions {
     pattern?: string;
     dir?: string;
     prefix?: string;
-    schema?: ({ path, url, }: {
-        path: string;
-        url: string;
-    }) => Parameters<InstanceType<typeof Elysia>["group"]>[1];
+    schema?: TSchemaHandler;
+    types?: ITypesOptions | true;
 }
-export declare function autoload({ pattern, dir, prefix, schema, }?: AutoloadOptions): Promise<Elysia<"", {
+export declare function autoload({ pattern, dir, prefix, schema, types, }?: IAutoloadOptions): Promise<Elysia<"", {
     request: {};
     store: {};
     derive: {};
@@ -17,3 +24,4 @@ export declare function autoload({ pattern, dir, prefix, schema, }?: AutoloadOpt
     type: {};
     error: {};
 }, {}, {}, {}, false>>;
+export * from "./types";

package/dist/index.js

@@ -1,11 +1,27 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
 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 TYPES_OUTPUT_DEFAULT = "./routes-types.ts";
+const TYPES_TYPENAME_DEFAULT = "Routes";
+async function autoload({ pattern, dir, prefix, schema, types, } = {}) {
     const directoryPath = (0, utils_1.getPath)(dir || "./routes");
     if (!(0, node_fs_1.existsSync)(directoryPath))
         throw new Error(`Directory ${directoryPath} doesn't exists`);
@@ -17,13 +33,16 @@ async function autoload({ pattern, dir, prefix, schema, } = {}) {
             pattern,
             dir,
             prefix,
+            types,
         },
     });
     const glob = new Bun.Glob(pattern || "**/*.{ts,js,mjs,cjs}");
     const files = await Array.fromAsync(glob.scan({
         cwd: directoryPath,
     }));
+    const paths = [];
     for await (const path of (0, utils_1.sortByNestedParams)(files)) {
+        const fullPath = (0, node_path_1.join)(directoryPath, path);
         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`);
@@ -34,7 +53,27 @@ async function autoload({ pattern, dir, prefix, schema, } = {}) {
         // Тип "string" не может быть назначен для типа "TSchema".ts(2345)
         // @ts-expect-error why....
         app.group((prefix ?? "") + url, groupOptions, file.default);
+        if (types)
+            paths.push(fullPath.replace(directoryPath, ""));
+    }
+    if (types) {
+        const imports = paths.map((x, index) => `import Route${index} from "${directoryPath + x.replace(".ts", "")}";`);
+        await Bun.write((0, utils_1.getPath)(types === true || !types.output
+            ? TYPES_OUTPUT_DEFAULT
+            : types.output), [
+            `import type { ElysiaWithBaseUrl } from "elysia-autoload";`,
+            imports.join("\n"),
+            "",
+            types === true || !types.useExport ? "declare global {" : "",
+            `    export type ${types === true || !types.typeName
+                ? TYPES_TYPENAME_DEFAULT
+                : types.typeName} = ${paths
+                .map((x, index) => `ElysiaWithBaseUrl<"${(0, utils_1.transformToUrl)(x) || "/"}", ReturnType<typeof Route${index}>>`)
+                .join("\n              & ")}`,
+            types === true || !types.useExport ? "}" : "",
+        ].join("\n"));
     }
     return app;
 }
 exports.autoload = autoload;
+__exportStar(require("./types"), exports);

package/dist/types.d.ts

@@ -0,0 +1,8 @@
+import type Elysia from "elysia";
+import type { RouteBase } from "elysia";
+type RemoveLastChar<T extends string> = T extends `${infer V}/` ? V : T;
+type RoutesWithPrefix<Routes extends RouteBase, Prefix extends string> = {
+    [K in keyof Routes as `${Prefix}${RemoveLastChar<K & string>}`]: Routes[K];
+};
+export type ElysiaWithBaseUrl<BaseUrl extends string, ElysiaType extends Elysia> = ElysiaType extends Elysia<infer BasePath, infer Decorators, infer Definitions, infer ParentSchema, infer Macro, infer Routes, infer Scoped> ? Elysia<BasePath, Decorators, Definitions, ParentSchema, Macro, RoutesWithPrefix<Routes, BaseUrl>, Scoped> : never;
+export {};

package/dist/types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils.js

@@ -35,7 +35,7 @@ function transformToUrl(path) {
     for (const { regex, replacement } of replacements) {
         url = url.replace(regex, replacement);
     }
-    return "/" + url;
+    return url;
 }
 exports.transformToUrl = transformToUrl;
 function getParamsCount(path) {

package/package.json

@@ -1,8 +1,10 @@
 {
     "name": "elysia-autoload",
-    "version": "0.0.3",
+    "version": "0.1.1",
     "author": "kravetsone",
-    "description": "Plugin for Elysia which autoload all routes in directory",
+    "main": "dist/index.js",
+    "description": "Plugin for Elysia which autoload all routes in directory and code-generate types for Eden",
+    "homepage": "https://github.com/kravetsone/elysia-autoload",
     "keywords": [
         "bun",
         "elysia",
@@ -10,25 +12,31 @@
         "autoload",
         "nextjs",
         "filerouter",
-        "autoroutes"
+        "autoroutes",
+        "eden",
+        "treaty",
+        "trpc",
+        "codegeneration"
     ],
-    "main": "dist/index.js",
     "scripts": {
         "prepublishOnly": "tsc",
-        "lint": "eslint \"src/**/*.{ts,tsx,js,mjs,cjs}\"",
-        "lint:fix": "eslint \"src/**/*.{ts,tsx,js,mjs,cjs}\" --fix"
+        "lint": "eslint \"{src,example}/**/*.{ts,tsx,js,mjs,cjs}\"",
+        "lint:fix": "eslint \"{src,example}/**/*.{ts,tsx,js,mjs,cjs}\" --fix"
     },
+    "files": [
+        "dist"
+    ],
     "devDependencies": {
+        "@elysiajs/eden": "^0.8.0",
+        "@elysiajs/swagger": "^0.8.0",
         "bun-types": "latest",
+        "elysia": "^0.8.3",
         "eslint": "^8.41.0",
         "eslint-kit": "^10.0.0",
-        "prettier": "^3.0.0"
+        "prettier": "^3.0.0",
+        "typescript": "^5.0.0"
     },
     "peerDependencies": {
-        "typescript": "^5.0.0",
         "elysia": "^0.8.0"
-    },
-    "files": [
-        "dist"
-    ]
+    }
 }