orpc-file-based-router 0.1.2 → 0.1.4

package/README.md

@@ -62,17 +62,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 +91,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";

package/dist/index.cjs

@@ -36,17 +36,19 @@ 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;
+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
@@ -131,6 +133,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,7 +1,8 @@
 declare function createRouter(routesDir: string): Promise<Router>;
-declare function cachedRouter(routesDir: string): Promise<{
-    getRouter: () => Promise<Router>;
-}>;
+declare const lazy: <T>(create: () => Promise<T> | T) => {
+    (): Promise<T>;
+    reset(): void;
+};
 type GeneratorOptions = {
     /**
      * File extension to append to import statements in the generated router.
@@ -14,4 +15,4 @@ type GeneratorOptions = {
 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,7 +1,8 @@
 declare function createRouter(routesDir: string): Promise<Router>;
-declare function cachedRouter(routesDir: string): Promise<{
-    getRouter: () => Promise<Router>;
-}>;
+declare const lazy: <T>(create: () => Promise<T> | T) => {
+    (): Promise<T>;
+    reset(): void;
+};
 type GeneratorOptions = {
     /**
      * File extension to append to import statements in the generated router.
@@ -14,4 +15,4 @@ type GeneratorOptions = {
 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,7 +1,8 @@
 declare function createRouter(routesDir: string): Promise<Router>;
-declare function cachedRouter(routesDir: string): Promise<{
-    getRouter: () => Promise<Router>;
-}>;
+declare const lazy: <T>(create: () => Promise<T> | T) => {
+    (): Promise<T>;
+    reset(): void;
+};
 type GeneratorOptions = {
     /**
      * File extension to append to import statements in the generated router.
@@ -14,4 +15,4 @@ type GeneratorOptions = {
 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}` });
   });
 }
-async 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
@@ -125,4 +127,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.2",
+  "version": "0.1.4",
   "description": "File-based router plugin for oRPC - automatically generate oRPC router from your file structure",
   "author": "zeeeeby",
   "license": "MIT",