orpc-file-based-router 0.0.8 → 0.0.10

package/README.md

@@ -1,10 +1,22 @@
 # orpc-file-based-router
 
-A plugin for [oRPC](https://orpc.unnoq.com) that automatically creates an oRPC router configuration based on your file structure.
+A plugin for [oRPC](https://orpc.unnoq.com) that automatically creates an oRPC router configuration based on your file
+structure, similar to Next.js, express-file-routing
 
-> ⚠️ **IMPORTANT:** At this time, the plugin's functionality is only guaranteed in nodejs runtime
+## Highlights
 
-## Installation
+- 📁 File-based structure: Organize your API endpoints intuitively through your filesystem
+- 🔄 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 handling: Support for index routes via index.ts files
+
+> ⚠️ **IMPORTANT:** At this time, the plugin's functionality is only guaranteed
+> in nodejs runtime
+
+## Get started
+
+1. Install package
 
 ```bash
 npm install orpc-file-based-router
@@ -12,22 +24,9 @@ npm install orpc-file-based-router
 yarn add orpc-file-based-router
 ```
 
-## Usage
-
-```typescript
-import { RPCHandler } from '@orpc/server/node'
-import { generateRouter } from 'orpc-file-based-router'
-
-const routesDir = new URL('./routes', import.meta.url).pathname
-const outputFile = new URL('./router.ts', import.meta.url).pathname
-const router = await generateRouter(routesDir, outputFile)
+2. Create a routes directory structure (for example):
 
-const handler = new RPCHandler(router)
 ```
-
-### File Structure Example
-
-```                                                                                                              
 src/routes
   ├── auth
   │    ├── me.ts 
@@ -43,37 +42,69 @@ src/routes
   │    ├── index.ts 
   │    └── list.ts 
   │
-  └── sse.ts 
+  └── sse.ts
 ```
 
-### Generated result
+3. Each file should export a oRPC handler function 
+
+4. Simply replace router in your handlers with the result of the `createRouter`
+function:
 
 ```typescript
-import { me } from './routes/auth/me'
-import { signin } from './routes/auth/signin'
-import { signup } from './routes/auth/signup'
-import { createPlanet } from './routes/planets/create'
-import { indexRoute } from './routes/planets'
-import { listPlanets } from './routes/planets/list'
-import { findPlanet } from './routes/planets/{id}/find'
-import { updatePlanet } from './routes/planets/{id}/update'
-import { sse } from './routes/sse'
+import { RPCHandler } from "@orpc/server/node";
+import { createRouter } from "orpc-file-based-router";
+
+const routesDir = new URL("./routes", import.meta.url).pathname;
+const router = await createRouter(routesDir);
+
+const handler = new RPCHandler(router);
+```
+
+## How to generate configuration file
+
+1. Call `generateRouter` 
+
+```typescript
+import { generateRouter } from "orpc-file-based-router";
+
+const routesDir = new URL("./routes", import.meta.url).pathname;
+const outputFile = new URL("./router.ts", import.meta.url).pathname;
+generateRouter(routesDir, outputFile);
+```
+
+2. Generated configuration is ready to use in router client:
+
+```typescript
+// router.ts
+import { me } from "./routes/auth/me";
+import { signin } from "./routes/auth/signin";
+import { signup } from "./routes/auth/signup";
+import { createPlanet } from "./routes/planets/create";
+import { indexRoute } from "./routes/planets";
+import { listPlanets } from "./routes/planets/list";
+import { findPlanet } from "./routes/planets/{id}/find";
+import { updatePlanet } from "./routes/planets/{id}/update";
+import { sse } from "./routes/sse";
 
 export const router = {
   auth: {
-    me: me.route({ path: '/auth/me' }),
-    signin: signin.route({ path: '/auth/signin' }),
-    signup: signup.route({ path: '/auth/signup' }),
+    me: me.route({ path: "/auth/me" }),
+    signin: signin.route({ path: "/auth/signin" }),
+    signup: signup.route({ path: "/auth/signup" }),
   },
   planets: {
-    create: createPlanet.route({ path: '/planets/create' }),
-    indexRoute: indexRoute.route({ path: '/planets' }),
-    list: listPlanets.route({ path: '/planets/list' }),
-    find: findPlanet.route({ path: '/planets/{id}/find' }),
-    update: updatePlanet.route({ path: '/planets/{id}/update' }),
+    create: createPlanet.route({ path: "/planets/create" }),
+    indexRoute: indexRoute.route({ path: "/planets" }),
+    list: listPlanets.route({ path: "/planets/list" }),
+    find: findPlanet.route({ path: "/planets/{id}/find" }),
+    update: updatePlanet.route({ path: "/planets/{id}/update" }),
   },
-  sse: sse.route({ path: '/sse' }),
-}
+  sse: sse.route({ path: "/sse" }),
+};
+
+// lib/orpc.ts
+const client: RouterClient<typeof router> = createORPCClient(link)
+
 ```
 
 ## License

package/dist/index.cjs

@@ -27,6 +27,15 @@ function walkTree(directory, tree = []) {
 function mergePaths(...paths) {
   return `/${paths.map((path2) => path2.replace(/^\/|\/$/g, "")).filter((path2) => path2 !== "").join("/")}`;
 }
+async function createRouter(routesDir) {
+  const files = walkTree(
+    routesDir
+  );
+  const exports = await generateRoutes(files);
+  return buildRouter(exports, (r, e) => {
+    return r.exports[e].route({ path: `${r.path}` });
+  });
+}
 async function generateRouter(routesDir, outputFile) {
   const files = walkTree(
     routesDir
@@ -43,10 +52,6 @@ async function generateRouter(routesDir, outputFile) {
   routerContent += "\n\nexport const router = ";
   routerContent += JSON.stringify(content, null, 2).replace(/"/g, "");
   node_fs.writeFileSync(path.join(outputFile), routerContent);
-  const router = buildRouter(exports, (r, e) => {
-    return r.exports[e].route({ path: `${r.path}` });
-  });
-  return router;
 }
 function buildRoutePath(parsedFile) {
   const directory = parsedFile.dir === parsedFile.root ? "" : parsedFile.dir;
@@ -78,12 +83,11 @@ function simplifyRouter(router) {
   for (const key in router) {
     if (isLeaf(router[key])) {
       simplifiedRouter[key] = router[key];
+    } else if (hasSingleLeaf(router[key])) {
+      const childKey = Object.keys(router[key])[0];
+      simplifiedRouter[key] = router[key][childKey];
     } else {
       simplifiedRouter[key] = simplifyRouter(router[key]);
-      if (isSingleChild(simplifiedRouter[key])) {
-        const childKey = Object.keys(simplifiedRouter[key])[0];
-        simplifiedRouter[key] = simplifiedRouter[key][childKey];
-      }
     }
   }
   return simplifiedRouter;
@@ -94,9 +98,9 @@ function isORPCProcedure(obj) {
 function isLeaf(obj) {
   return typeof obj === "string" || isORPCProcedure(obj);
 }
-function isSingleChild(obj) {
+function hasSingleLeaf(obj) {
   const keys = Object.keys(obj);
-  return keys.length === 1;
+  return keys.length === 1 && isLeaf(obj[keys[0]]);
 }
 const isCjs = () => typeof module !== "undefined" && !!module?.exports;
 const IS_ESM = !isCjs();
@@ -115,4 +119,5 @@ async function generateRoutes(files) {
   return routes;
 }
 
+exports.createRouter = createRouter;
 exports.generateRouter = generateRouter;

package/dist/index.d.cts

@@ -1,4 +1,5 @@
-declare function generateRouter(routesDir: string, outputFile: string): Promise<Router>;
+declare function createRouter(routesDir: string): Promise<Router>;
+declare function generateRouter(routesDir: string, outputFile: string): Promise<void>;
 type Router = Record<string, any>;
 
-export { generateRouter };
+export { createRouter, generateRouter };

package/dist/index.d.mts

@@ -1,4 +1,5 @@
-declare function generateRouter(routesDir: string, outputFile: string): Promise<Router>;
+declare function createRouter(routesDir: string): Promise<Router>;
+declare function generateRouter(routesDir: string, outputFile: string): Promise<void>;
 type Router = Record<string, any>;
 
-export { generateRouter };
+export { createRouter, generateRouter };

package/dist/index.d.ts

@@ -1,4 +1,5 @@
-declare function generateRouter(routesDir: string, outputFile: string): Promise<Router>;
+declare function createRouter(routesDir: string): Promise<Router>;
+declare function generateRouter(routesDir: string, outputFile: string): Promise<void>;
 type Router = Record<string, any>;
 
-export { generateRouter };
+export { createRouter, generateRouter };

package/dist/index.mjs

@@ -21,6 +21,15 @@ function walkTree(directory, tree = []) {
 function mergePaths(...paths) {
   return `/${paths.map((path2) => path2.replace(/^\/|\/$/g, "")).filter((path2) => path2 !== "").join("/")}`;
 }
+async function createRouter(routesDir) {
+  const files = walkTree(
+    routesDir
+  );
+  const exports = await generateRoutes(files);
+  return buildRouter(exports, (r, e) => {
+    return r.exports[e].route({ path: `${r.path}` });
+  });
+}
 async function generateRouter(routesDir, outputFile) {
   const files = walkTree(
     routesDir
@@ -37,10 +46,6 @@ async function generateRouter(routesDir, outputFile) {
   routerContent += "\n\nexport const router = ";
   routerContent += JSON.stringify(content, null, 2).replace(/"/g, "");
   writeFileSync(join(outputFile), routerContent);
-  const router = buildRouter(exports, (r, e) => {
-    return r.exports[e].route({ path: `${r.path}` });
-  });
-  return router;
 }
 function buildRoutePath(parsedFile) {
   const directory = parsedFile.dir === parsedFile.root ? "" : parsedFile.dir;
@@ -72,12 +77,11 @@ function simplifyRouter(router) {
   for (const key in router) {
     if (isLeaf(router[key])) {
       simplifiedRouter[key] = router[key];
+    } else if (hasSingleLeaf(router[key])) {
+      const childKey = Object.keys(router[key])[0];
+      simplifiedRouter[key] = router[key][childKey];
     } else {
       simplifiedRouter[key] = simplifyRouter(router[key]);
-      if (isSingleChild(simplifiedRouter[key])) {
-        const childKey = Object.keys(simplifiedRouter[key])[0];
-        simplifiedRouter[key] = simplifiedRouter[key][childKey];
-      }
     }
   }
   return simplifiedRouter;
@@ -88,9 +92,9 @@ function isORPCProcedure(obj) {
 function isLeaf(obj) {
   return typeof obj === "string" || isORPCProcedure(obj);
 }
-function isSingleChild(obj) {
+function hasSingleLeaf(obj) {
   const keys = Object.keys(obj);
-  return keys.length === 1;
+  return keys.length === 1 && isLeaf(obj[keys[0]]);
 }
 const isCjs = () => typeof module !== "undefined" && !!module?.exports;
 const IS_ESM = !isCjs();
@@ -109,4 +113,4 @@ async function generateRoutes(files) {
   return routes;
 }
 
-export { generateRouter };
+export { createRouter, generateRouter };

package/package.json

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