@ivogt/rsc-router 0.0.0-experimental.1

package/README.md

@@ -0,0 +1,19 @@
+# @ivogt/rsc-router
+
+> **Warning:** This package is experimental and under active development. APIs may change without notice.
+
+Type-safe RSC router with partial rendering support for Vite.
+
+## Installation
+
+```bash
+npm install @ivogt/rsc-router@experimental
+```
+
+## Status
+
+This package is in early experimental stages. It is not recommended for production use.
+
+## License
+
+MIT

package/package.json

@@ -0,0 +1,131 @@
+{
+  "name": "@ivogt/rsc-router",
+  "version": "0.0.0-experimental.1",
+  "type": "module",
+  "description": "Type-safe RSC router with partial rendering support",
+  "author": "Ivo Todorov",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ivogt/vite-rsc.git",
+    "directory": "packages/rsc-router"
+  },
+  "homepage": "https://github.com/ivogt/vite-rsc#readme",
+  "bugs": {
+    "url": "https://github.com/ivogt/vite-rsc/issues"
+  },
+  "publishConfig": {
+    "access": "public",
+    "tag": "experimental"
+  },
+  "keywords": [
+    "react",
+    "rsc",
+    "react-server-components",
+    "router",
+    "vite"
+  ],
+  "exports": {
+    ".": {
+      "react-server": "./src/index.rsc.ts",
+      "types": "./src/index.ts",
+      "default": "./src/index.ts"
+    },
+    "./server": {
+      "types": "./src/server.ts",
+      "import": "./src/server.ts"
+    },
+    "./client": {
+      "react-server": "./src/client.rsc.tsx",
+      "types": "./src/client.tsx",
+      "default": "./src/client.tsx"
+    },
+    "./browser": {
+      "types": "./src/browser/index.ts",
+      "default": "./src/browser/index.ts"
+    },
+    "./ssr": {
+      "types": "./src/ssr/index.tsx",
+      "default": "./src/ssr/index.tsx"
+    },
+    "./rsc": {
+      "react-server": "./src/rsc/index.ts",
+      "types": "./src/rsc/index.ts",
+      "default": "./src/rsc/index.ts"
+    },
+    "./vite": {
+      "types": "./src/vite/index.ts",
+      "import": "./src/vite/index.ts"
+    },
+    "./types": {
+      "types": "./src/vite/version.d.ts"
+    },
+    "./internal/deps/browser": {
+      "types": "./src/deps/browser.ts",
+      "default": "./src/deps/browser.ts"
+    },
+    "./internal/deps/ssr": {
+      "types": "./src/deps/ssr.ts",
+      "default": "./src/deps/ssr.ts"
+    },
+    "./internal/deps/rsc": {
+      "react-server": "./src/deps/rsc.ts",
+      "types": "./src/deps/rsc.ts",
+      "default": "./src/deps/rsc.ts"
+    },
+    "./internal/deps/html-stream-client": {
+      "types": "./src/deps/html-stream-client.ts",
+      "default": "./src/deps/html-stream-client.ts"
+    },
+    "./internal/deps/html-stream-server": {
+      "types": "./src/deps/html-stream-server.ts",
+      "default": "./src/deps/html-stream-server.ts"
+    },
+    "./cache": {
+      "react-server": "./src/cache/index.ts",
+      "types": "./src/cache/index.ts",
+      "default": "./src/cache/index.ts"
+    }
+  },
+  "files": [
+    "src",
+    "README.md"
+  ],
+  "peerDependencies": {
+    "@cloudflare/vite-plugin": "^1.21.0",
+    "@vitejs/plugin-rsc": "^0.5.14",
+    "react": "^18.0.0 || ^19.0.0",
+    "vite": "^7.3.0"
+  },
+  "peerDependenciesMeta": {
+    "@cloudflare/vite-plugin": {
+      "optional": true
+    },
+    "vite": {
+      "optional": true
+    }
+  },
+  "dependencies": {
+    "@vitejs/plugin-rsc": "^0.5.14",
+    "magic-string": "^0.30.17",
+    "rsc-html-stream": "^0.0.7"
+  },
+  "devDependencies": {
+    "@playwright/test": "^1.49.1",
+    "@types/node": "^24.10.1",
+    "@types/react": "^19.2.7",
+    "@types/react-dom": "^19.2.3",
+    "react": "^19.2.1",
+    "react-dom": "^19.2.1",
+    "tinyexec": "^0.3.2",
+    "typescript": "^5.3.0",
+    "vitest": "^2.1.8"
+  },
+  "scripts": {
+    "typecheck": "tsc --noEmit",
+    "test": "playwright test",
+    "test:ui": "playwright test --ui",
+    "test:unit": "vitest run",
+    "test:unit:watch": "vitest"
+  }
+}

package/src/__mocks__/version.ts

@@ -0,0 +1,6 @@
+/**
+ * Mock for rsc-router:version virtual module.
+ * Used by vitest since the virtual module is only available at build time.
+ * Empty string disables version path in URLs for simpler test assertions.
+ */
+export const VERSION = "";

package/src/__tests__/route-definition.test.ts

@@ -0,0 +1,63 @@
+import { describe, it, expect } from "vitest";
+import { route } from "../route-definition";
+
+describe("route()", () => {
+  describe("with nested RouteConfig objects", () => {
+    it("should flatten nested RouteConfig with trailing slash config", () => {
+      const routes = route({
+        index: "/",
+        trailingSlash: {
+          ignore: { path: "/ts-ignore", trailingSlash: "ignore" },
+          always: { path: "/ts-always", trailingSlash: "always" },
+          never: { path: "/ts-never", trailingSlash: "never" },
+        },
+      }) as any;
+
+      // Check routes are flattened correctly
+      expect(routes.index).toBe("/");
+      expect(routes["trailingSlash.ignore"]).toBe("/ts-ignore");
+      expect(routes["trailingSlash.always"]).toBe("/ts-always");
+      expect(routes["trailingSlash.never"]).toBe("/ts-never");
+
+      // Check trailing slash config is attached
+      expect(routes.__trailingSlash).toBeDefined();
+      expect(routes.__trailingSlash["trailingSlash.ignore"]).toBe("ignore");
+      expect(routes.__trailingSlash["trailingSlash.always"]).toBe("always");
+      expect(routes.__trailingSlash["trailingSlash.never"]).toBe("never");
+    });
+
+    it("should be enumerable for Object.entries", () => {
+      const routes = route({
+        index: "/",
+        trailingSlash: {
+          ignore: { path: "/ts-ignore", trailingSlash: "ignore" },
+        },
+      });
+
+      const entries = Object.entries(routes);
+      expect(entries).toContainEqual(["index", "/"]);
+      expect(entries).toContainEqual(["trailingSlash.ignore", "/ts-ignore"]);
+    });
+
+    it("should apply global default to string routes", () => {
+      const routes = route({
+        blog: "/blog",
+        about: "/about",
+      }, { trailingSlash: "never" }) as any;
+
+      expect(routes.__trailingSlash).toBeDefined();
+      expect(routes.__trailingSlash.blog).toBe("never");
+      expect(routes.__trailingSlash.about).toBe("never");
+    });
+
+    it("should let per-route config override global default", () => {
+      const routes = route({
+        blog: "/blog",
+        api: { path: "/api", trailingSlash: "ignore" },
+      }, { trailingSlash: "never" }) as any;
+
+      expect(routes.__trailingSlash.blog).toBe("never");
+      expect(routes.__trailingSlash.api).toBe("ignore");
+    });
+  });
+});