orpc-file-based-router 0.0.1

package/README.md

@@ -0,0 +1,78 @@
+# orpc-file-based-router
+
+A plugin for [oRPC](https://orpc.unnoq.com) that automatically creates an oRPC router configuration based on your file structure.
+
+## Installation
+
+```bash
+npm install orpc-file-based-router
+# or
+yarn add orpc-file-based-router
+```
+
+## Usage
+
+```typescript
+// generator.ts
+import { generateRouter } from 'orpc-file-based-router'
+
+const routesDir = './routes'
+const outputFile = './router.ts'
+
+generateRouter(routesDir, outputFile)
+  .then(() => console.log('Router generated successfully'))
+  .catch(console.error)
+```
+
+### File Structure Example
+
+```                                                                                                              
+src/routes
+  ├── auth
+  │    ├── me.ts (exports: me)
+  │    ├── signin.ts (exports: signin)
+  │    └── signup.ts (exports: signup)
+  │
+  ├── planets
+  │    ├── {id}
+  │    │    ├── find.ts (exports: findPlanet)
+  │    │    └── update.ts (exports: updatePlanet)
+  │    │
+  │    ├── create.ts (exports: createPlanet)
+  │    ├── index.ts (exports: indexRoute)
+  │    └── list.ts (exports: listPlanets)
+  │
+  └── sse.ts (exports: sse)
+```
+### Run `tsx src/generator.ts `
+
+### Generated result
+
+```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'
+
+export const router = {
+  auth: {
+    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' }),
+  },
+  sse: sse.route({ path: '/sse' }),
+}
+```
+

package/dist/index.cjs

@@ -0,0 +1,110 @@
+'use strict';
+
+const node_fs = require('node:fs');
+const path = require('node:path');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e.default : e; }
+
+const path__default = /*#__PURE__*/_interopDefaultCompat(path);
+
+function walkTree(directory, tree = []) {
+  const results = [];
+  for (const fileName of node_fs.readdirSync(directory)) {
+    const filePath = path.join(directory, fileName);
+    const fileStats = node_fs.statSync(filePath);
+    if (fileStats.isDirectory()) {
+      results.push(...walkTree(filePath, [...tree, fileName]));
+    } else {
+      results.push({
+        name: fileName,
+        path: directory,
+        rel: mergePaths(...tree, fileName)
+      });
+    }
+  }
+  return results;
+}
+function mergePaths(...paths) {
+  return `/${paths.map((path2) => path2.replace(/^\/|\/$/g, "")).filter((path2) => path2 !== "").join("/")}`;
+}
+async function generateRouter(routesDir, outputFile) {
+  const files = walkTree(
+    routesDir
+  );
+  const exports = await generateRoutes(files);
+  const importPaths = exports.map((x) => path.relative(path.dirname(outputFile), routesDir).concat(x.routePath));
+  const router = buildRouter(exports.map((x) => {
+    return {
+      exports: Object.keys(x.exports),
+      routePath: x.routePath
+    };
+  }));
+  let routerContent = `// This file is auto-generated
+
+`;
+  routerContent += importPaths.map((x, i) => `import { ${Object.keys(exports[i].exports).join(", ")} } from "./${x}"`).join("\n");
+  routerContent += "\n\nexport const router = ";
+  routerContent += JSON.stringify(router, null, 2).replace(/"/g, "");
+  node_fs.writeFileSync(path.join(outputFile), routerContent);
+}
+function buildRoutePath(parsedFile) {
+  const directory = parsedFile.dir === parsedFile.root ? "" : parsedFile.dir;
+  const name = parsedFile.name.startsWith("index") ? parsedFile.name.replace("index", "") : `/${parsedFile.name}`;
+  return directory + name;
+}
+function buildRouter(inputs) {
+  const router = {};
+  for (const input of inputs) {
+    const segments = input.routePath.replace(/\{\w+\}/g, "").replace(/\/\//g, "/").split("/").filter(Boolean);
+    let current = router;
+    for (let i = 0; i < segments.length; i++) {
+      const segment = segments[i];
+      if (i === segments.length - 1) {
+        current[segment] = current[segment] || {};
+        for (const exp of input.exports) {
+          current[segment][exp] = `${exp}.route({ path: '${input.routePath}' })`;
+        }
+      } else {
+        current[segment] = current[segment] || {};
+        current = current[segment];
+      }
+    }
+  }
+  return simplifyRouter(router);
+}
+function simplifyRouter(router) {
+  const simplifiedRouter = {};
+  for (const key in router) {
+    if (typeof router[key] === "string") {
+      simplifiedRouter[key] = router[key];
+    } else if (typeof router[key] === "object" && isSingleLeaf(router[key])) {
+      const childKey = Object.keys(router[key])[0];
+      simplifiedRouter[key] = router[key][childKey];
+    } else {
+      simplifiedRouter[key] = simplifyRouter(router[key]);
+    }
+  }
+  return simplifiedRouter;
+}
+function isSingleLeaf(obj) {
+  const keys = Object.keys(obj);
+  return keys.length === 1 && typeof obj[keys[0]] === "string";
+}
+const isCjs = () => typeof module !== "undefined" && !!module?.exports;
+const IS_ESM = !isCjs();
+const MODULE_IMPORT_PREFIX = IS_ESM ? "file://" : "";
+async function generateRoutes(files) {
+  const routes = [];
+  for (const file of files) {
+    const parsedFile = path__default.parse(file.rel);
+    const routePath = buildRoutePath(parsedFile);
+    const exports = await import(MODULE_IMPORT_PREFIX + path__default.join(file.path, file.name));
+    routes.push({
+      exports,
+      routePath
+    });
+  }
+  return routes;
+}
+
+exports.generateRouter = generateRouter;

package/dist/index.d.cts

@@ -0,0 +1,3 @@
+declare function generateRouter(routesDir: string, outputFile: string): Promise<void>;
+
+export { generateRouter };

package/dist/index.d.mts

@@ -0,0 +1,3 @@
+declare function generateRouter(routesDir: string, outputFile: string): Promise<void>;
+
+export { generateRouter };

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+declare function generateRouter(routesDir: string, outputFile: string): Promise<void>;
+
+export { generateRouter };

package/dist/index.mjs

@@ -0,0 +1,104 @@
+import { writeFileSync, readdirSync, statSync } from 'node:fs';
+import path, { relative, dirname, join } from 'node:path';
+
+function walkTree(directory, tree = []) {
+  const results = [];
+  for (const fileName of readdirSync(directory)) {
+    const filePath = join(directory, fileName);
+    const fileStats = statSync(filePath);
+    if (fileStats.isDirectory()) {
+      results.push(...walkTree(filePath, [...tree, fileName]));
+    } else {
+      results.push({
+        name: fileName,
+        path: directory,
+        rel: mergePaths(...tree, fileName)
+      });
+    }
+  }
+  return results;
+}
+function mergePaths(...paths) {
+  return `/${paths.map((path2) => path2.replace(/^\/|\/$/g, "")).filter((path2) => path2 !== "").join("/")}`;
+}
+async function generateRouter(routesDir, outputFile) {
+  const files = walkTree(
+    routesDir
+  );
+  const exports = await generateRoutes(files);
+  const importPaths = exports.map((x) => relative(dirname(outputFile), routesDir).concat(x.routePath));
+  const router = buildRouter(exports.map((x) => {
+    return {
+      exports: Object.keys(x.exports),
+      routePath: x.routePath
+    };
+  }));
+  let routerContent = `// This file is auto-generated
+
+`;
+  routerContent += importPaths.map((x, i) => `import { ${Object.keys(exports[i].exports).join(", ")} } from "./${x}"`).join("\n");
+  routerContent += "\n\nexport const router = ";
+  routerContent += JSON.stringify(router, null, 2).replace(/"/g, "");
+  writeFileSync(join(outputFile), routerContent);
+}
+function buildRoutePath(parsedFile) {
+  const directory = parsedFile.dir === parsedFile.root ? "" : parsedFile.dir;
+  const name = parsedFile.name.startsWith("index") ? parsedFile.name.replace("index", "") : `/${parsedFile.name}`;
+  return directory + name;
+}
+function buildRouter(inputs) {
+  const router = {};
+  for (const input of inputs) {
+    const segments = input.routePath.replace(/\{\w+\}/g, "").replace(/\/\//g, "/").split("/").filter(Boolean);
+    let current = router;
+    for (let i = 0; i < segments.length; i++) {
+      const segment = segments[i];
+      if (i === segments.length - 1) {
+        current[segment] = current[segment] || {};
+        for (const exp of input.exports) {
+          current[segment][exp] = `${exp}.route({ path: '${input.routePath}' })`;
+        }
+      } else {
+        current[segment] = current[segment] || {};
+        current = current[segment];
+      }
+    }
+  }
+  return simplifyRouter(router);
+}
+function simplifyRouter(router) {
+  const simplifiedRouter = {};
+  for (const key in router) {
+    if (typeof router[key] === "string") {
+      simplifiedRouter[key] = router[key];
+    } else if (typeof router[key] === "object" && isSingleLeaf(router[key])) {
+      const childKey = Object.keys(router[key])[0];
+      simplifiedRouter[key] = router[key][childKey];
+    } else {
+      simplifiedRouter[key] = simplifyRouter(router[key]);
+    }
+  }
+  return simplifiedRouter;
+}
+function isSingleLeaf(obj) {
+  const keys = Object.keys(obj);
+  return keys.length === 1 && typeof obj[keys[0]] === "string";
+}
+const isCjs = () => typeof module !== "undefined" && !!module?.exports;
+const IS_ESM = !isCjs();
+const MODULE_IMPORT_PREFIX = IS_ESM ? "file://" : "";
+async function generateRoutes(files) {
+  const routes = [];
+  for (const file of files) {
+    const parsedFile = path.parse(file.rel);
+    const routePath = buildRoutePath(parsedFile);
+    const exports = await import(MODULE_IMPORT_PREFIX + path.join(file.path, file.name));
+    routes.push({
+      exports,
+      routePath
+    });
+  }
+  return routes;
+}
+
+export { generateRouter };

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "orpc-file-based-router",
+  "version": "0.0.1",
+  "description": "File-based router plugin for oRPC - automatically generate oRPC router from your file structure",
+  "author": "zeeeeby",
+  "license": "MIT",
+  "homepage": "https://github.com/zeeeeby/orpc-file-based-router",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/zeeeeby/orpc-file-based-router.git"
+  },
+  "bugs": {
+    "url": "https://github.com/zeeeeby/orpc-file-based-router/issues"
+  },
+  "keywords": [
+    "orpc",
+    "router",
+    "file-based-routing",
+    "plugin"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "npm run type-check && unbuild",
+    "type-check": "tsc --noEmit"
+  },
+  "devDependencies": {
+    "@types/node": "^22.14.0",
+    "unbuild": "^3.5.0"
+  }
+}