orpc-file-based-router 0.1.3 → 0.1.5

package/README.md

@@ -9,10 +9,6 @@ structure, inspired by Next.js and express-file-routing approaches.
 - 🔄 **Zero Configuration**: Generate routes automatically based on your directory structure
 - ⚡️ **Development Speed**: Eliminate boilerplate code and reduce maintenance overhead
 - 🔍 **Dynamic Routing**: Support for path parameters using `{param}` syntax in file names
-- 📑 **Index Routes**: Support for index routes via `index.ts` files
-
-> ⚠️ **IMPORTANT:** At this time, the plugin's functionality is only guaranteed
-> in nodejs runtime
 
 ## Quickstart
 
@@ -62,17 +58,18 @@ const router = await createRouter(routesDir);
 const handler = new RPCHandler(router);
 
 ```
-> **Note:** If your environment doesn't support top-level await, just use `cachedRouter` for example in expressjs it could be:
+**Note:** If your environment doesn't support top-level await, just use `lazy` for example in expressjs it could be:
 ```typescript
 import { RPCHandler } from "@orpc/server/node";
-import { cachedRouter } from "orpc-file-based-router";
+import { lazy, createRouter } from "orpc-file-based-router";
 
 const routesDir = new URL("./routes", import.meta.url).pathname;
-const router = cachedRouter(routesDir)
+
+const router = lazy(() => createRouter(routesDir))
 
 app.use('/rpc{/*path}', async (req, res, next) => {
 
-    const handler = new RPCHandler(await router.getRouter());
+    const handler = new RPCHandler(await router());
 
     const { matched } = await handler.handle(req, res, {
         prefix: '/rpc',
@@ -90,7 +87,7 @@ app.use('/rpc{/*path}', async (req, res, next) => {
 
 For users of the [oRPC client](https://orpc.unnoq.com/docs/client/client-side), we provide automatic configuration generation for enhanced type safety and improved developer experience.
 
-1. Add the following code to your main server file (e.g., `server.ts` or `main.ts`). This will automatically regenerate the router configuration each time your server starts:
+1. You can add this code either directly in your server project (e.g., in server.ts or main.ts) or put it into a separate script (e.g., router-gen.ts).
 
 ```typescript
 import { generateRouter } from "orpc-file-based-router";
@@ -102,6 +99,8 @@ generateRouter(routesDir, outputFile);
 
 2. Generated router is ready to use in client:
 
+> ⚠️ If you don't want plugin to generate openapi `route({})` suffix, just set parameter `includeRoute` to `false`
+
 ```typescript
 // router.ts
 import { me } from "./routes/auth/me";
@@ -130,6 +129,7 @@ export const router = {
   sse: sse.route({ path: "/sse" }),
 };
 
+
 // lib/orpc.ts
 const client: RouterClient<typeof router> = createORPCClient(link)
 
@@ -142,6 +142,7 @@ When using `generateRouter`, you can provide additional options to customize the
 | Field              | Type      | Required | Default Value | Description                                                                                                                     |
 |-------------------|----------|--------------|-----------------------|------------------------------------------------------------------------------------------------------------------------------|
 | `importExtension` | string   | false         | `""`(No extension) | File extension to append to import statements in the generated router. Useful when your build setup requires specific extensions. <br>Example: `.js` → `import { me } from "./routes/auth/me.js"` |
+| `includeRoute` | boolean   | false         | `true` | When set to true, each route will be wrapped with openapi `.route({ path: '...' })` call   |
 
 
 

package/dist/index.cjs

@@ -36,17 +36,19 @@ async function createRouter(routesDir) {
     return r.exports[e].route({ path: `${r.path}` });
   });
 }
-function cachedRouter(routesDir) {
-  let router = null;
-  return {
-    getRouter: async () => {
-      if (!router) {
-        router = await createRouter(routesDir);
-      }
-      return router;
+const lazy = (create) => {
+  let cache = null;
+  const fn = () => {
+    if (!cache) {
+      cache = Promise.resolve(create());
     }
+    return cache;
   };
-}
+  fn.reset = () => {
+    cache = null;
+  };
+  return fn;
+};
 async function generateRouter(routesDir, outputFile, options) {
   const files = walkTree(
     routesDir
@@ -54,7 +56,10 @@ async function generateRouter(routesDir, outputFile, options) {
   const exports = await generateRoutes(files);
   const importPaths = exports.map((x) => path.relative(path.dirname(outputFile), routesDir).concat(x.path));
   const content = buildRouter(exports, (r, e) => {
-    return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    if (options?.includeRoute ?? true) {
+      return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    }
+    return e;
   });
   let routerContent = `// This file is auto-generated
 
@@ -131,6 +136,6 @@ async function generateRoutes(files) {
   return routes;
 }
 
-exports.cachedRouter = cachedRouter;
 exports.createRouter = createRouter;
 exports.generateRouter = generateRouter;
+exports.lazy = lazy;

package/dist/index.d.cts

@@ -1,6 +1,7 @@
 declare function createRouter(routesDir: string): Promise<Router>;
-declare function cachedRouter(routesDir: string): {
-    getRouter: () => Promise<Router>;
+declare const lazy: <T>(create: () => Promise<T> | T) => {
+    (): Promise<T>;
+    reset(): void;
 };
 type GeneratorOptions = {
     /**
@@ -10,8 +11,14 @@ type GeneratorOptions = {
      * @default "" (no extension)
      */
     importExtension?: string;
+    /**
+     * Include openapi route paths in the generated router.
+     * When set to true, each route will have its openapi path
+     * @default true
+     */
+    includeRoute?: boolean;
 };
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;
 
-export { cachedRouter, createRouter, generateRouter };
+export { createRouter, generateRouter, lazy };

package/dist/index.d.mts

@@ -1,6 +1,7 @@
 declare function createRouter(routesDir: string): Promise<Router>;
-declare function cachedRouter(routesDir: string): {
-    getRouter: () => Promise<Router>;
+declare const lazy: <T>(create: () => Promise<T> | T) => {
+    (): Promise<T>;
+    reset(): void;
 };
 type GeneratorOptions = {
     /**
@@ -10,8 +11,14 @@ type GeneratorOptions = {
      * @default "" (no extension)
      */
     importExtension?: string;
+    /**
+     * Include openapi route paths in the generated router.
+     * When set to true, each route will have its openapi path
+     * @default true
+     */
+    includeRoute?: boolean;
 };
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;
 
-export { cachedRouter, createRouter, generateRouter };
+export { createRouter, generateRouter, lazy };

package/dist/index.d.ts

@@ -1,6 +1,7 @@
 declare function createRouter(routesDir: string): Promise<Router>;
-declare function cachedRouter(routesDir: string): {
-    getRouter: () => Promise<Router>;
+declare const lazy: <T>(create: () => Promise<T> | T) => {
+    (): Promise<T>;
+    reset(): void;
 };
 type GeneratorOptions = {
     /**
@@ -10,8 +11,14 @@ type GeneratorOptions = {
      * @default "" (no extension)
      */
     importExtension?: string;
+    /**
+     * Include openapi route paths in the generated router.
+     * When set to true, each route will have its openapi path
+     * @default true
+     */
+    includeRoute?: boolean;
 };
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;
 
-export { cachedRouter, createRouter, generateRouter };
+export { createRouter, generateRouter, lazy };

package/dist/index.mjs

@@ -30,17 +30,19 @@ async function createRouter(routesDir) {
     return r.exports[e].route({ path: `${r.path}` });
   });
 }
-function cachedRouter(routesDir) {
-  let router = null;
-  return {
-    getRouter: async () => {
-      if (!router) {
-        router = await createRouter(routesDir);
-      }
-      return router;
+const lazy = (create) => {
+  let cache = null;
+  const fn = () => {
+    if (!cache) {
+      cache = Promise.resolve(create());
     }
+    return cache;
   };
-}
+  fn.reset = () => {
+    cache = null;
+  };
+  return fn;
+};
 async function generateRouter(routesDir, outputFile, options) {
   const files = walkTree(
     routesDir
@@ -48,7 +50,10 @@ async function generateRouter(routesDir, outputFile, options) {
   const exports = await generateRoutes(files);
   const importPaths = exports.map((x) => relative(dirname(outputFile), routesDir).concat(x.path));
   const content = buildRouter(exports, (r, e) => {
-    return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    if (options?.includeRoute ?? true) {
+      return `${e}.route({ path: '${r.path.replace(/\/{0,1}index$/, "")}' })`;
+    }
+    return e;
   });
   let routerContent = `// This file is auto-generated
 
@@ -125,4 +130,4 @@ async function generateRoutes(files) {
   return routes;
 }
 
-export { cachedRouter, createRouter, generateRouter };
+export { createRouter, generateRouter, lazy };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "orpc-file-based-router",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "File-based router plugin for oRPC - automatically generate oRPC router from your file structure",
   "author": "zeeeeby",
   "license": "MIT",