elysia-autoload 1.0.0 → 1.1.0

package/README.md

@@ -1,6 +1,6 @@
 # elysia-autoload
 
-Plugin for [Elysia](https://elysiajs.com/) which autoload all routes in directory and code-generate types for [Eden](https://elysiajs.com/eden/overview.html) with [`Bun.build`](https://bun.sh/docs/bundler) support!
+Plugin for [Elysia](https://elysiajs.com/) which autoload all routes in directory and code-generate types for [Eden](https://elysiajs.com/eden/overview.html) with [`Bun.build`](#bun-build-usage) support!
 
 **Currently, Eden types generation is broken!!**
 
@@ -28,11 +28,16 @@ bun install elysia-autoload
 import { Elysia } from "elysia";
 import { autoload } from "elysia-autoload";
 
-const app = new Elysia().use(autoload()).listen(3000);
+const app = new Elysia().use(await autoload()).listen(3000);
 
 export type ElysiaApp = typeof app;
 ```
 
+> [!IMPORTANT]
+> We strictly recommend use `await` when registering plugin
+>
+> Read more about [Lazy-load plugins](https://elysiajs.com/patterns/lazy-loading-module.html)
+
 ## Create route
 
 ```ts
@@ -99,7 +104,7 @@ import { autoload } from "elysia-autoload";
 
 const app = new Elysia()
     .use(
-        autoload({
+        await autoload({
             types: {
                 output: "./routes.ts",
                 typeName: "Routes",
@@ -129,11 +134,28 @@ const { data } = await app.test["some-path-param"].get({
 console.log(data);
 ```
 
+`routes.ts` will be:
+
+```ts
+// @filename: routes.ts
+
+import type { ElysiaWithBaseUrl } from "elysia-autoload";
+import type Route0 from "./routes/index";
+import type Route1 from "./routes/test/[some]/index";
+
+declare global {
+    export type Routes = ElysiaWithBaseUrl<"/api", ReturnType<typeof Route0>> &
+        ElysiaWithBaseUrl<"/api/test/:some", ReturnType<typeof Route1>>;
+}
+```
+
 Example of app with types code-generation you can see in [example](https://github.com/kravetsone/elysia-autoload/tree/main/example)
 
-### Bun build usage
+**Currently, Eden types generation is broken!!**
+
+### [Bun build](https://bun.sh/docs/bundler) usage
 
-You can use this plugin with `Bun.build`, thanks to [esbuild-plugin-autoload](https://github.com/kravetsone/esbuild-plugin-autoload)!
+You can use this plugin with [`Bun.build`](https://bun.sh/docs/bundler), thanks to [esbuild-plugin-autoload](https://github.com/kravetsone/esbuild-plugin-autoload)!
 
 ```ts
 // @filename: build.ts
@@ -141,6 +163,7 @@ import { autoload } from "esbuild-plugin-autoload"; // default import also suppo
 
 await Bun.build({
     entrypoints: ["src/index.ts"],
+    target: "bun",
     outdir: "out",
     plugins: [autoload()],
 }).then(console.log);
@@ -148,6 +171,26 @@ await Bun.build({
 
 Then, build it with `bun build.ts` and run with `bun out/index.ts`.
 
+### [Bun compile](https://bun.sh/docs/bundler/executables) usage
+
+You can bundle and then compile it into a [single executable binary file](https://bun.sh/docs/bundler/executables)
+
+```ts
+import { autoload } from "esbuild-plugin-autoload"; // default import also supported
+
+await Bun.build({
+    entrypoints: ["src/index.ts"],
+    target: "bun",
+    outdir: "out",
+    plugins: [autoload()],
+}).then(console.log);
+
+await Bun.$`bun build --compile out/index.js`;
+```
+
+> [!WARNING]
+> You cannot use it in `bun build --compile` mode without extra step ([Feature issue](https://github.com/oven-sh/bun/issues/11895))
+
 [Read more](https://github.com/kravetsone/esbuild-plugin-autoload)
 
 ### Usage of schema handler
@@ -159,7 +202,7 @@ import { autoload } from "elysia-autoload";
 
 const app = new Elysia()
     .use(
-        autoload({
+        await autoload({
             schema: ({ path, url }) => {
                 const tag = url.split("/").at(1)!;
 

package/dist/index.d.ts

@@ -1,5 +1,4 @@
-import Elysia, { RouteBase, Elysia as Elysia$1, LocalHook, InputSchema, RouteSchema, SingletonBase } from 'elysia';
-import { BaseMacro } from 'elysia/dist/types';
+import Elysia, { RouteBase, LocalHook, InputSchema, RouteSchema, SingletonBase, BaseMacro, Elysia as Elysia$1 } from 'elysia';
 
 type RemoveLastChar<T extends string> = T extends `${infer V}/` ? V : T;
 type RoutesWithPrefix<Routes extends RouteBase, Prefix extends string> = {
@@ -34,6 +33,7 @@ declare function autoload(options?: IAutoloadOptions): Promise<Elysia$1<string,
 }, {
     schema: {};
     macro: {};
+    macroFn: {};
 }, {}, {
     derive: {};
     resolve: {};
@@ -44,4 +44,4 @@ declare function autoload(options?: IAutoloadOptions): Promise<Elysia$1<string,
     schema: {};
 }>>;
 
-export { type ElysiaWithBaseUrl, type IAutoloadOptions, type ITypesOptions, autoload };
+export { type ElysiaWithBaseUrl, type IAutoloadOptions, type ITypesOptions, type TSchemaHandler, autoload };

package/dist/index.js

@@ -1,19 +1,15 @@
-// src/index.ts
-import fs from "node:fs";
-import path2 from "node:path";
-import {
-  Elysia
-} from "elysia";
+import fs from 'node:fs';
+import path from 'node:path';
+import { Elysia } from 'elysia';
 
-// src/utils.ts
-import path from "node:path";
 function getPath(dir) {
-  if (path.isAbsolute(dir)) return dir;
+  if (path.isAbsolute(dir))
+    return dir;
   if (path.isAbsolute(process.argv[1]))
     return path.join(process.argv[1], "..", dir);
   return path.join(process.cwd(), process.argv[1], "..", dir);
 }
-function transformToUrl(path3) {
+function transformToUrl(path2) {
   const replacements = [
     // Clean the url extensions
     { regex: /\.(ts|tsx|js|jsx|mjs|cjs)$/u, replacement: "" },
@@ -35,30 +31,46 @@ function transformToUrl(path3) {
     // remove index from end of path
     { regex: /\/?index$/, replacement: "" }
   ];
-  let url = path3;
+  let url = path2;
   for (const { regex, replacement } of replacements) {
     url = url.replace(regex, replacement);
   }
   return url;
 }
-function getParamsCount(path3) {
-  return path3.match(/\[(.*?)\]/gu)?.length || 0;
+function getParamsCount(path2) {
+  return path2.match(/\[(.*?)\]/gu)?.length || 0;
 }
 function sortByNestedParams(routes) {
   return routes.sort((a, b) => getParamsCount(a) - getParamsCount(b));
 }
 function fixSlashes(prefix) {
-  if (!prefix?.endsWith("/")) return prefix;
+  if (!prefix?.endsWith("/"))
+    return prefix;
   return prefix.slice(0, -1);
 }
+function addRelativeIfNotDot(path2) {
+  if (path2.at(0) !== ".")
+    return `./${path2}`;
+  return path2;
+}
 
-// src/index.ts
-var TYPES_OUTPUT_DEFAULT = "./routes-types.ts";
-var TYPES_TYPENAME_DEFAULT = "Routes";
+const DIR_ROUTES_DEFAULT = "./routes";
+const TYPES_OUTPUT_DEFAULT = "./routes-types.ts";
+const TYPES_TYPENAME_DEFAULT = "Routes";
+const TYPES_OBJECT_DEFAULT = {
+  output: [TYPES_OUTPUT_DEFAULT],
+  typeName: TYPES_TYPENAME_DEFAULT
+};
 async function autoload(options = {}) {
-  const fileSources = {};
-  const { pattern, dir, prefix, schema, types } = options;
-  const directoryPath = getPath(dir || "./routes");
+  const { pattern, prefix, schema } = options;
+  const dir = options.dir ?? DIR_ROUTES_DEFAULT;
+  const types = options.types ? options.types !== true ? {
+    ...TYPES_OBJECT_DEFAULT,
+    ...options.types,
+    // This code allows you to omit the output data or specify it as an string[] or string.
+    output: !options.types.output ? [TYPES_OUTPUT_DEFAULT] : Array.isArray(options.types.output) ? options.types.output : [options.types.output]
+  } : TYPES_OBJECT_DEFAULT : false;
+  const directoryPath = getPath(dir);
   if (!fs.existsSync(directoryPath))
     throw new Error(`Directory ${directoryPath} doesn't exists`);
   if (!fs.statSync(directoryPath).isDirectory())
@@ -81,37 +93,43 @@ async function autoload(options = {}) {
   );
   const paths = [];
   for await (const filePath of sortByNestedParams(files)) {
-    const fullPath = path2.join(directoryPath, filePath);
+    const fullPath = path.join(directoryPath, filePath);
     const file = await import(fullPath);
     if (!file.default)
       throw new Error(`${filePath} doesn't provide default export`);
     const url = transformToUrl(filePath);
     const groupOptions = schema ? schema({ path: filePath, url }) : {};
     plugin.group(url, groupOptions, file.default);
-    if (types) paths.push(fullPath.replace(directoryPath, ""));
+    if (types)
+      paths.push(fullPath.replace(directoryPath, ""));
   }
   if (types) {
-    const imports = paths.map(
-      (x, index) => `import type Route${index} from "${(directoryPath + x.replace(".ts", "").replace(".tsx", "")).replace(/\\/gu, "/")}";`
-    );
-    for await (const outputPath of types === true || !types.output ? [TYPES_OUTPUT_DEFAULT] : Array.isArray(types.output) ? types.output : [types.output]) {
+    for await (const outputPath of types.output) {
+      const outputAbsolutePath = getPath(outputPath);
+      const imports = paths.map(
+        (x, index) => `import type Route${index} from "${addRelativeIfNotDot(
+          path.relative(
+            path.dirname(outputAbsolutePath),
+            directoryPath + x.replace(".ts", "").replace(".tsx", "")
+          ).replace(/\\/gu, "/")
+        )}";`
+      );
       await Bun.write(
-        getPath(outputPath),
+        outputAbsolutePath,
         [
           `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(
+          !types.useExport ? "declare global {" : "",
+          `    export type ${types.typeName} = ${paths.map(
             (x, index) => `ElysiaWithBaseUrl<"${((prefix?.endsWith("/") ? prefix.slice(0, -1) : prefix) ?? "") + transformToUrl(x) || "/"}", ReturnType<typeof Route${index}>>`
           ).join("\n              & ")}`,
-          types === true || !types.useExport ? "}" : ""
+          !types.useExport ? "}" : ""
         ].join("\n")
       );
     }
   }
   return plugin;
 }
-export {
-  autoload
-};
+
+export { autoload };

package/package.json

@@ -1,12 +1,17 @@
 {
     "name": "elysia-autoload",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "author": "kravetsone",
     "type": "module",
     "types": "./dist/index.d.ts",
-    "main": "./dist/index.cjs",
     "module": "./dist/index.js",
-    "description": "Plugin for Elysia which autoload all routes in directory and code-generate types for Eden",
+    "exports": {
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.js"
+        }
+    },
+    "description": "Plugin for Elysia which autoload all routes in directory and code-generate types for Eden with Bun.build support",
     "homepage": "https://github.com/kravetsone/elysia-autoload",
     "keywords": [
         "bun",
@@ -22,7 +27,7 @@
         "codegeneration"
     ],
     "scripts": {
-        "prepublishOnly": "bun test && bunx tsup && rm -f ./dist/index.d.сts",
+        "prepublishOnly": "bun test && bunx pkgroll",
         "lint": "bunx @biomejs/biome check src",
         "lint:fix": "bun lint --apply",
         "prepare": "bunx husky"
@@ -31,16 +36,15 @@
         "dist"
     ],
     "devDependencies": {
-        "@biomejs/biome": "1.6.3",
-        "@elysiajs/eden": "^1.0.14",
-        "@elysiajs/swagger": "^1.0.5",
-        "@types/bun": "^1.1.3",
-        "elysia": "^1.0.23",
-        "husky": "^9.0.11",
-        "tsup": "^8.0.2",
-        "typescript": "^5.4.5"
+        "@biomejs/biome": "1.8.3",
+        "@elysiajs/eden": "^1.1.0",
+        "@elysiajs/swagger": "^1.1.0",
+        "@types/bun": "^1.1.6",
+        "elysia": "^1.1.2",
+        "pkgroll": "^2.1.1",
+        "typescript": "^5.5.3"
     },
     "peerDependencies": {
-        "elysia": "^1.0.0"
+        "elysia": "^1.1.0"
     }
 }

package/dist/index.cjs

@@ -1,150 +0,0 @@
-"use strict";
-var __create = Object.create;
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __getProtoOf = Object.getPrototypeOf;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
-  // If the importer is in node compatibility mode or this is not an ESM
-  // file that has been converted to a CommonJS file using a Babel-
-  // compatible transform (i.e. "__esModule" has not been set), then set
-  // "default" to the CommonJS "module.exports" for node compatibility.
-  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
-  mod
-));
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-
-// src/index.ts
-var src_exports = {};
-__export(src_exports, {
-  autoload: () => autoload
-});
-module.exports = __toCommonJS(src_exports);
-var import_node_fs = __toESM(require("fs"), 1);
-var import_node_path2 = __toESM(require("path"), 1);
-var import_elysia = require("elysia");
-
-// src/utils.ts
-var import_node_path = __toESM(require("path"), 1);
-function getPath(dir) {
-  if (import_node_path.default.isAbsolute(dir)) return dir;
-  if (import_node_path.default.isAbsolute(process.argv[1]))
-    return import_node_path.default.join(process.argv[1], "..", dir);
-  return import_node_path.default.join(process.cwd(), process.argv[1], "..", dir);
-}
-function transformToUrl(path3) {
-  const replacements = [
-    // Clean the url extensions
-    { regex: /\.(ts|tsx|js|jsx|mjs|cjs)$/u, replacement: "" },
-    // Fix windows slashes
-    { regex: /\\/gu, 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 = path3;
-  for (const { regex, replacement } of replacements) {
-    url = url.replace(regex, replacement);
-  }
-  return url;
-}
-function getParamsCount(path3) {
-  return path3.match(/\[(.*?)\]/gu)?.length || 0;
-}
-function sortByNestedParams(routes) {
-  return routes.sort((a, b) => getParamsCount(a) - getParamsCount(b));
-}
-function fixSlashes(prefix) {
-  if (!prefix?.endsWith("/")) return prefix;
-  return prefix.slice(0, -1);
-}
-
-// src/index.ts
-var TYPES_OUTPUT_DEFAULT = "./routes-types.ts";
-var TYPES_TYPENAME_DEFAULT = "Routes";
-async function autoload(options = {}) {
-  const fileSources = {};
-  const { pattern, dir, prefix, schema, types } = options;
-  const directoryPath = getPath(dir || "./routes");
-  if (!import_node_fs.default.existsSync(directoryPath))
-    throw new Error(`Directory ${directoryPath} doesn't exists`);
-  if (!import_node_fs.default.statSync(directoryPath).isDirectory())
-    throw new Error(`${directoryPath} isn't a directory`);
-  const plugin = new import_elysia.Elysia({
-    name: "elysia-autoload",
-    prefix: fixSlashes(prefix),
-    seed: {
-      pattern,
-      dir,
-      prefix,
-      types
-    }
-  });
-  const glob = new Bun.Glob(pattern || "**/*.{ts,tsx,js,jsx,mjs,cjs}");
-  const files = await Array.fromAsync(
-    glob.scan({
-      cwd: directoryPath
-    })
-  );
-  const paths = [];
-  for await (const filePath of sortByNestedParams(files)) {
-    const fullPath = import_node_path2.default.join(directoryPath, filePath);
-    const file = await import(fullPath);
-    if (!file.default)
-      throw new Error(`${filePath} doesn't provide default export`);
-    const url = transformToUrl(filePath);
-    const groupOptions = schema ? schema({ path: filePath, url }) : {};
-    plugin.group(url, groupOptions, file.default);
-    if (types) paths.push(fullPath.replace(directoryPath, ""));
-  }
-  if (types) {
-    const imports = paths.map(
-      (x, index) => `import type Route${index} from "${(directoryPath + x.replace(".ts", "").replace(".tsx", "")).replace(/\\/gu, "/")}";`
-    );
-    for await (const outputPath of types === true || !types.output ? [TYPES_OUTPUT_DEFAULT] : Array.isArray(types.output) ? types.output : [types.output]) {
-      await Bun.write(
-        getPath(outputPath),
-        [
-          `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<"${((prefix?.endsWith("/") ? prefix.slice(0, -1) : prefix) ?? "") + transformToUrl(x) || "/"}", ReturnType<typeof Route${index}>>`
-          ).join("\n              & ")}`,
-          types === true || !types.useExport ? "}" : ""
-        ].join("\n")
-      );
-    }
-  }
-  return plugin;
-}
-// Annotate the CommonJS export names for ESM import in node:
-0 && (module.exports = {
-  autoload
-});

package/dist/index.d.cts

@@ -1,47 +0,0 @@
-import Elysia, { RouteBase, Elysia as Elysia$1, LocalHook, InputSchema, RouteSchema, SingletonBase } from 'elysia';
-import { BaseMacro } from 'elysia/dist/types';
-
-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];
-};
-type ElysiaWithBaseUrl<BaseUrl extends string, ElysiaType extends Elysia<any, any, any, any, any, any, any, any>> = ElysiaType extends Elysia<infer BasePath, infer Scoped, infer Singleton, infer Definitions, infer Metadata, infer Routes, infer Ephemeral, infer Volatile> ? Elysia<BasePath, Scoped, Singleton, Definitions, Metadata, RoutesWithPrefix<Routes, BaseUrl>, Ephemeral, Volatile> : never;
-
-type TSchemaHandler = ({ path, url, }: {
-    path: string;
-    url: string;
-}) => LocalHook<InputSchema, RouteSchema, SingletonBase, Record<string, Error>, BaseMacro, "">;
-interface ITypesOptions {
-    output?: string | string[];
-    typeName?: string;
-    useExport?: boolean;
-}
-interface IAutoloadOptions {
-    pattern?: string;
-    dir?: string;
-    prefix?: string;
-    schema?: TSchemaHandler;
-    types?: ITypesOptions | true;
-}
-declare function autoload(options?: IAutoloadOptions): Promise<Elysia$1<string, false, {
-    decorator: {};
-    store: {};
-    derive: {};
-    resolve: {};
-}, {
-    type: {};
-    error: {};
-}, {
-    schema: {};
-    macro: {};
-}, {}, {
-    derive: {};
-    resolve: {};
-    schema: {};
-}, {
-    derive: {};
-    resolve: {};
-    schema: {};
-}>>;
-
-export { type ElysiaWithBaseUrl, type IAutoloadOptions, type ITypesOptions, autoload };