@superfunctions/http 0.1.1 → 0.1.2

package/README.md

@@ -72,12 +72,12 @@ const apiRouter = createRouter({
 
 ```typescript
 import express from 'express';
-import { toExpressRouter } from '@superfunctions/http-express';
+import { toExpress } from '@superfunctions/http-express';
 import { apiRouter } from './api';
 
 const app = express();
 app.use(express.json());
-app.use('/api', toExpressRouter(apiRouter));
+app.use('/api', toExpress(apiRouter));
 app.listen(3000);
 ```
 
@@ -85,11 +85,11 @@ app.listen(3000);
 
 ```typescript
 import { Hono } from 'hono';
-import { toHonoHandler } from '@superfunctions/http-hono';
+import { toHono } from '@superfunctions/http-hono';
 import { apiRouter } from './api';
 
 const app = new Hono();
-app.route('/api', toHonoHandler(apiRouter));
+app.route('/api', toHono(apiRouter));
 
 export default app;
 ```
@@ -105,14 +105,14 @@ const router = createRouter({ routes: [...] });
 
 // Cloudflare Workers
 export default {
-  fetch: (req) => router.handler(req)
+  fetch: router.handle
 };
 
 // Deno
-Deno.serve((req) => router.handler(req));
+Deno.serve(router.handle);
 
 // Bun
-Bun.serve({ fetch: (req) => router.handler(req) });
+Bun.serve({ fetch: router.handle });
 ```
 
 ## Features
@@ -186,6 +186,41 @@ const router = createRouter({
 });
 ```
 
+### Base Path
+
+**⚠️ Important: Only use `basePath` for standalone deployments without framework mounting.**
+
+```typescript
+// ✅ Good: Standalone deployment (Cloudflare Workers, Vercel Edge)
+const router = createRouter({
+  basePath: '/api/v1',
+  routes: [
+    { method: 'GET', path: '/users', handler: ... } // Accessible at /api/v1/users
+  ]
+});
+
+export default { fetch: router.handle }; // or router.handler
+
+// ❌ Bad: With framework mounting (creates double prefixing)
+const router = createRouter({
+  basePath: '/v1',  // Don't do this!
+  routes: [...]
+});
+app.use('/api', toExpress(router)); // Would need /api/v1/users
+
+// ✅ Good: With framework mounting (no basePath)
+const router = createRouter({
+  routes: [
+    { method: 'GET', path: '/users', handler: ... }
+  ]
+});
+app.use('/api/v1', toExpress(router)); // Accessible at /api/v1/users
+```
+
+**Rule of thumb:**
+- **Standalone deployment** → Use `basePath` in router
+- **Framework mounting** → Use framework's mounting (e.g., `app.use('/path', ...)`) and omit `basePath`
+
 ### CORS
 
 ```typescript
@@ -250,9 +285,9 @@ interface RouteContext {
 
 | Framework | Package | Function |
 |-----------|---------|----------|
-| Express | `@superfunctions/http-express` | `toExpressRouter()`, `toExpressHandler()` |
-| Hono | `@superfunctions/http-hono` | `toHonoHandler()` |
-| Fastify | `@superfunctions/http-fastify` | `toFastifyPlugin()` |
+| Express | `@superfunctions/http-express` | `toExpress()`, `toExpressHandler()` |
+| Hono | `@superfunctions/http-hono` | `toHono()` |
+| Fastify | `@superfunctions/http-fastify` | `toFastify()` |
 | Next.js | `@superfunctions/http-next` | `toNextHandlers()` |
 | SvelteKit | `@superfunctions/http-sveltekit` | `toSvelteKitHandler()`, `toSvelteKitHandlers()` |
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@superfunctions/http",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Framework-agnostic HTTP abstraction layer for Superfunctions libraries",
   "type": "module",
   "main": "./dist/index.js",