orpc-file-based-router 0.1.1 → 0.1.2

package/README.md

@@ -62,15 +62,29 @@ const router = await createRouter(routesDir);
 const handler = new RPCHandler(router);
 
 ```
-> **Note:** If your environment doesn't support top-level await, wrap your server startup code in an async function:
-> ```typescript
-> async function startServer() {
->   const router = await createRouter(routesDir);
->   const handler = new RPCHandler(router);
->   // ... start your server
-> }
-> startServer();
-> ```
+> **Note:** If your environment doesn't support top-level await, just use `cachedRouter` for example in expressjs it could be:
+```typescript
+import { RPCHandler } from "@orpc/server/node";
+import { cachedRouter } from "orpc-file-based-router";
+
+const routesDir = new URL("./routes", import.meta.url).pathname;
+const router = cachedRouter(routesDir)
+
+app.use('/rpc{/*path}', async (req, res, next) => {
+
+    const handler = new RPCHandler(await router.getRouter());
+
+    const { matched } = await handler.handle(req, res, {
+        prefix: '/rpc',
+    })
+
+    if (matched) {
+        return
+    }
+
+    next()
+})
+```
 
 ## 🔒 Type-Safe Client Configuration (Optional)
 

package/dist/index.cjs

@@ -36,6 +36,17 @@ async function createRouter(routesDir) {
     return r.exports[e].route({ path: `${r.path}` });
   });
 }
+async function cachedRouter(routesDir) {
+  let router = null;
+  return {
+    getRouter: async () => {
+      if (!router) {
+        router = await createRouter(routesDir);
+      }
+      return router;
+    }
+  };
+}
 async function generateRouter(routesDir, outputFile, options) {
   const files = walkTree(
     routesDir
@@ -120,5 +131,6 @@ async function generateRoutes(files) {
   return routes;
 }
 
+exports.cachedRouter = cachedRouter;
 exports.createRouter = createRouter;
 exports.generateRouter = generateRouter;

package/dist/index.d.cts

@@ -1,4 +1,7 @@
 declare function createRouter(routesDir: string): Promise<Router>;
+declare function cachedRouter(routesDir: string): Promise<{
+    getRouter: () => Promise<Router>;
+}>;
 type GeneratorOptions = {
     /**
      * File extension to append to import statements in the generated router.
@@ -11,4 +14,4 @@ type GeneratorOptions = {
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;
 
-export { createRouter, generateRouter };
+export { cachedRouter, createRouter, generateRouter };

package/dist/index.d.mts

@@ -1,4 +1,7 @@
 declare function createRouter(routesDir: string): Promise<Router>;
+declare function cachedRouter(routesDir: string): Promise<{
+    getRouter: () => Promise<Router>;
+}>;
 type GeneratorOptions = {
     /**
      * File extension to append to import statements in the generated router.
@@ -11,4 +14,4 @@ type GeneratorOptions = {
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;
 
-export { createRouter, generateRouter };
+export { cachedRouter, createRouter, generateRouter };

package/dist/index.d.ts

@@ -1,4 +1,7 @@
 declare function createRouter(routesDir: string): Promise<Router>;
+declare function cachedRouter(routesDir: string): Promise<{
+    getRouter: () => Promise<Router>;
+}>;
 type GeneratorOptions = {
     /**
      * File extension to append to import statements in the generated router.
@@ -11,4 +14,4 @@ type GeneratorOptions = {
 declare function generateRouter(routesDir: string, outputFile: string, options?: GeneratorOptions): Promise<void>;
 type Router = Record<string, any>;
 
-export { createRouter, generateRouter };
+export { cachedRouter, createRouter, generateRouter };

package/dist/index.mjs

@@ -30,6 +30,17 @@ async function createRouter(routesDir) {
     return r.exports[e].route({ path: `${r.path}` });
   });
 }
+async function cachedRouter(routesDir) {
+  let router = null;
+  return {
+    getRouter: async () => {
+      if (!router) {
+        router = await createRouter(routesDir);
+      }
+      return router;
+    }
+  };
+}
 async function generateRouter(routesDir, outputFile, options) {
   const files = walkTree(
     routesDir
@@ -114,4 +125,4 @@ async function generateRoutes(files) {
   return routes;
 }
 
-export { createRouter, generateRouter };
+export { cachedRouter, createRouter, generateRouter };

package/package.json

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