vite-elysia-forge 0.0.7 → 0.0.9

package/README.md

@@ -1,43 +1,40 @@
 # vite-elysia-forge
 
-<svg width="200" height="120" viewBox="0 0 200 120" xmlns="http://www.w3.org/2000/svg">
-  <!-- Vite logo representation -->
-  <defs>
-    <linearGradient id="viteGradient" x1="0%" y1="0%" x2="100%" y2="100%">
-      <stop offset="0%" style="stop-color:#646cff;stop-opacity:1" />
-      <stop offset="100%" style="stop-color:#535bf2;stop-opacity:1" />
-    </linearGradient>
-  </defs>
-  
-  <!-- Vite symbol -->
-  <polygon points="50,20 70,60 50,100 30,60" fill="url(#viteGradient)" />
-  
-  <!-- Arrow connecting to Elysia -->
-  <line x1="80" y1="60" x2="120" y2="60" stroke="#646cff" stroke-width="3" marker-end="url(#arrowhead)" />
-  <defs>
-    <marker id="arrowhead" markerWidth="10" markerHeight="10" refX="9" refY="3" orient="auto">
-      <polygon points="0 0, 10 3, 0 6" fill="#646cff" />
-    </marker>
-  </defs>
-  
-  <!-- Elysia symbol (simplified) -->
-  <circle cx="150" cy="30" r="15" fill="#e0db55" />
-  <circle cx="150" cy="90" r="15" fill="#e0db55" />
-  <rect x="135" y="50" width="30" height="20" fill="#e0db55" />
-</svg>
-
-Vite middleware plugin that hot-reloads an Elysia API module and forwards `/api` requests to it during local development.
-
-## Installation
+<p align="center">
+  <img src="https://vitejs.dev/logo.svg" alt="Vite" width="60" height="60" />
+  <img src="https://elysiajs.com/assets/elysia.svg" alt="Elysia" width="60" height="60" />
+  <img src="https://bun.sh/logo.svg" alt="Bun" width="60" height="60" />
+</p>
+
+A [Vite](https://vite.dev/) middleware plugin that hot-reloads an [Elysia](https://elysiajs.com/) API module and forwards `/api` requests to it during local development. Powered by [Bun](https://bun.sh/).
+
+## 1. Installation
 
 ```bash
-bun install
+bun install vite-elysia-forge
+```
+
+## 2. Quick Start
+
+### 2.1 Create Your API Handler
+
+Place your Elysia handler at `src/server/api.ts` (default path):
+
+```ts
+import { Elysia } from "elysia";
+
+export const api = new Elysia({
+  prefix: "/api",
+});
+
+api.get("/", () => "hello from elysia");
+
+export default api;
 ```
 
-## Quick Start
+### 2.2 Configure Vite
 
-1. Place your Elysia handler at `src/server/api.ts` (default path).
-2. In your Vite config, register the plugin:
+Register the plugin in your Vite config:
 
 ```ts
 import { defineConfig } from "vite";
@@ -46,85 +43,158 @@ import elysiaPlugin from "vite-elysia-forge";
 export default defineConfig({
   plugins: [
     elysiaPlugin({
-      serverFile: "/server/api.ts",
+      serverFile: "./src/server/api.ts",
     }),
   ],
 });
 ```
 
-3. Run Vite as usual, and hit `/api/*` routes. The plugin will reload the Elysia module when the file changes.
+### 2.3 Start Development
 
-## Starting the App
-
-To build and start the app:
+Run Vite as usual and access your API at `/api/*` routes. The plugin will automatically reload the Elysia module when files change.
 
 ```bash
-bun run build
-bun start
+bun run dev
 ```
 
-`bun run build` compiles the plugin for production, and `bun start` runs the built application.
+## 3. Configuration Options
+
+### 3.1 Plugin Options
 
-## Configuration
+```ts
+elysiaPlugin({
+  // Path to your Elysia API module (relative to project root)
+  serverFile?: string; // default: "/server/api.ts"
+})
+```
 
-| Option       | Type   | Default      | Description                                             |
-| ------------ | ------ | ------------ | ------------------------------------------------------- |
-| `serverURL`  | string | `"/server/"` | URL prefix to your API module (leading slash required). |
-| `serverFile` | string | `"api.ts"`   | Filename of the Elysia module to load and hot-reload.   |
+## 4. API Module Requirements
 
-## Expectations for the API module
+Your API module must export an Elysia instance with a `handle(request: Request) => Promise<Response>` method.
 
-Your API module should export `api` with a `handle(request: Request) => Promise<Response>` signature.
+### 4.1 Basic Example
 
 ```ts
+import { Elysia } from "elysia";
+
 export const api = new Elysia({
   prefix: "/api",
 });
 
 api.get("/", () => "hello from elysia");
+api.get("/users", () => ["user1", "user2"]);
 
 export default api;
 ```
 
-## Production Usage
+## 5. Integration with @elysiajs/openapi
 
-When building for production, you need to build both the Vite frontend and the Elysia backend. This package provides a CLI to handle this for you.
+To use the [@elysiajs/openapi plugin](https://elysiajs.com/patterns/openapi), add the following to your `tsconfig.json`:
 
-1. Update your `package.json` build script:
+```json
+{
+  "compilerOptions": {
+    "types": ["bun-types"],
+    "typeRoots": ["node_modules"]
+  }
+}
+```
+
+### 5.1 Example with `fromTypes`
+
+It is recommended to pre-generate the declaration file (`.d.ts`) to provide type declaration to the generator.
+
+```ts
+import { Elysia, t } from "elysia";
+import { openapi, fromTypes } from "@elysiajs/openapi";
+
+const app = new Elysia().use(
+  openapi({
+    references: fromTypes("server/api"),
+  })
+);
+```
+
+## 6. Production Deployment
+
+### 6.1 Build Configuration
+
+Update your `package.json` scripts:
 
 ```json
 {
   "scripts": {
+    "dev": "vite",
     "build": "vite-elysia-forge build",
     "start": "bun dist/server.js"
   }
 }
 ```
 
-2. Run the build:
+If your API is located elsewhere, specify the path:
+
+```bash
+vite-elysia-forge build src/my-api.ts
+```
+
+### 6.2 Building for Production
+
+Run the build command:
 
 ```bash
 bun run build
 ```
 
-This will:
+This command performs the following steps:
+
+1. Runs `vite build` to compile your frontend to `dist/`
+2. Automatically generates a temporary entry file that imports your API from `src/server/api.ts`
+3. Bundles the server into a single file at `dist/server.js`
 
-1. Run `vite build` to compile your frontend to `dist/`.
-2. Automatically generate a temporary entry file that imports your API from `src/server/api.ts` (default).
-3. Bundle the server into a single file at `dist/server.js`.
+### 6.3 Starting the Production Server
 
-If your API is located elsewhere, you can specify the path:
+Start the server with:
 
 ```bash
-vite-elysia-forge build src/my-api.ts
+bun start
 ```
 
-3. Start the server:
+## 7. Troubleshooting
+
+### 7.1 "Bun is not defined" Error
+
+If you encounter this error, ensure you are running Vite with the Bun runtime:
 
 ```bash
-bun start
+bunx --bun vite
+```
+
+Or update your `dev` script in `package.json`:
+
+```json
+"scripts": {
+  "dev": "bunx --bun vite"
+}
 ```
 
-## Authors
+**Benefits:**
+
+- **Access to Bun APIs:** You can use `Bun.file`, `Bun.env`, `bun:sqlite`, and other native Bun features directly in your server code.
+- **Performance:** Vite often starts faster and uses less memory when running under Bun.
+
+**Caveats:**
+
+- **Node.js Compatibility:** While Bun has excellent Node.js compatibility, some Vite plugins that rely on obscure Node.js internals might behave unexpectedly.
+- **Performance:** Running Vite under Bun is generally faster, but you might encounter edge cases where optimization differs from Node.js.
+
+### 7.2 Hot Reload Not Working
+
+Check that your file changes are within the dependency graph of your API module. The plugin uses Vite's dependency tracking to determine when to reload.
+
+## 8. Authors
 
 - Chijioke Udokporo ([@chijiokeudokporo](https://github.com/chijioke-udokporo))
+
+## 9. License
+
+MIT

package/dist/index.cjs

@@ -1,2 +1,2 @@
-'use strict';var path=require('path');function M({serverFile:g="/server/api.ts"}){return {name:"vite-elysia-forge",async configureServer(s){let l=g,y=path.resolve(s.config.root,l.slice(1)),f=async()=>(await s.ssrLoadModule(l)).api,p=await f();s.watcher.add(y),s.watcher.on("change",async e=>{let o=await s.moduleGraph.getModuleByUrl(l);if(!o)return;let i=s.moduleGraph.getModulesByFile(e);if(!i||i.size===0)return;let n=false,r=new Set,a=[...i];for(;a.length>0;){let t=a.shift();if(!(!t||!t.id||r.has(t.id))){if(r.add(t.id),t.id===o.id){n=true;break}for(let c of t.importers)a.push(c);}}if(n)try{s.moduleGraph.invalidateModule(o),p=await f(),console.log("[vite-elysia-forge] Reloaded Elysia API module");}catch(t){console.error(`[vite-elysia-forge] Failed to reload Elysia API: ${t}`);}}),s.middlewares.use(async(e,o,i)=>{if(!e.url?.startsWith("/api"))return i();try{let n="http",r=e.headers.host||"localhost:3000",a=`${n}://${r}${e.url}`,t;if(e.method!=="GET"&&e.method!=="HEAD"){let d=[];for await(let h of e)d.push(h);t=Buffer.concat(d).toString();}let c=new Request(a,{method:e.method,headers:e.headers,body:t}),u=await p.handle(c);o.statusCode=u.status,u.headers.forEach((d,h)=>{o.setHeader(h,d);});let m=await u.text();o.end(m);}catch(n){console.error(`[vite-elysia-forge] Elysia error: ${n}`),o.statusCode=500,o.end("Internal Server Error");}});}}}var P=M;
+'use strict';var path=require('path');function E({serverFile:g="/server/api.ts"}={}){return {name:"vite-elysia-forge",async configureServer(s){let l=g,y=path.resolve(s.config.root,l.slice(1)),f=async()=>(await s.ssrLoadModule(l)).api,p=await f();s.watcher.add(y),s.watcher.on("change",async e=>{let o=await s.moduleGraph.getModuleByUrl(l);if(!o)return;let i=s.moduleGraph.getModulesByFile(e);if(!i||i.size===0)return;let n=false,r=new Set,a=[...i];for(;a.length>0;){let t=a.shift();if(!(!t||!t.id||r.has(t.id))){if(r.add(t.id),t.id===o.id){n=true;break}for(let c of t.importers)a.push(c);}}if(n)try{s.moduleGraph.invalidateModule(o),p=await f(),console.log("[vite-elysia-forge] Reloaded Elysia API module");}catch(t){console.error(`[vite-elysia-forge] Failed to reload Elysia API: ${t}`);}}),s.middlewares.use(async(e,o,i)=>{if(!e.url?.startsWith("/api"))return i();try{let n="http",r=e.headers.host||"localhost:3000",a=`${n}://${r}${e.url}`,t;if(e.method!=="GET"&&e.method!=="HEAD"){let d=[];for await(let h of e)d.push(h);t=Buffer.concat(d).toString();}let c=new Request(a,{method:e.method,headers:e.headers,body:t}),u=await p.handle(c);o.statusCode=u.status,u.headers.forEach((d,h)=>{o.setHeader(h,d);});let m=await u.text();o.end(m);}catch(n){console.error(`[vite-elysia-forge] Elysia error: ${n}`),o.statusCode=500,o.end("Internal Server Error");}});}}}var P=E;
 module.exports=P;

package/dist/index.d.cts

@@ -20,6 +20,6 @@ interface ConfigOptions {
  * @param options - Configuration options for the plugin.
  * @returns A Vite plugin instance.
  */
-declare function elysiaPlugin({ serverFile }: ConfigOptions): Plugin;
+declare function elysiaPlugin({ serverFile }?: ConfigOptions): Plugin;
 
 export { type ConfigOptions, elysiaPlugin as default };

package/dist/index.d.ts

@@ -20,6 +20,6 @@ interface ConfigOptions {
  * @param options - Configuration options for the plugin.
  * @returns A Vite plugin instance.
  */
-declare function elysiaPlugin({ serverFile }: ConfigOptions): Plugin;
+declare function elysiaPlugin({ serverFile }?: ConfigOptions): Plugin;
 
 export { type ConfigOptions, elysiaPlugin as default };

package/dist/index.js

@@ -1,2 +1,2 @@
-import {resolve}from'path';function M({serverFile:g="/server/api.ts"}){return {name:"vite-elysia-forge",async configureServer(s){let l=g,y=resolve(s.config.root,l.slice(1)),f=async()=>(await s.ssrLoadModule(l)).api,p=await f();s.watcher.add(y),s.watcher.on("change",async e=>{let o=await s.moduleGraph.getModuleByUrl(l);if(!o)return;let i=s.moduleGraph.getModulesByFile(e);if(!i||i.size===0)return;let n=false,r=new Set,a=[...i];for(;a.length>0;){let t=a.shift();if(!(!t||!t.id||r.has(t.id))){if(r.add(t.id),t.id===o.id){n=true;break}for(let c of t.importers)a.push(c);}}if(n)try{s.moduleGraph.invalidateModule(o),p=await f(),console.log("[vite-elysia-forge] Reloaded Elysia API module");}catch(t){console.error(`[vite-elysia-forge] Failed to reload Elysia API: ${t}`);}}),s.middlewares.use(async(e,o,i)=>{if(!e.url?.startsWith("/api"))return i();try{let n="http",r=e.headers.host||"localhost:3000",a=`${n}://${r}${e.url}`,t;if(e.method!=="GET"&&e.method!=="HEAD"){let d=[];for await(let h of e)d.push(h);t=Buffer.concat(d).toString();}let c=new Request(a,{method:e.method,headers:e.headers,body:t}),u=await p.handle(c);o.statusCode=u.status,u.headers.forEach((d,h)=>{o.setHeader(h,d);});let m=await u.text();o.end(m);}catch(n){console.error(`[vite-elysia-forge] Elysia error: ${n}`),o.statusCode=500,o.end("Internal Server Error");}});}}}var P=M;
+import {resolve}from'path';function E({serverFile:g="/server/api.ts"}={}){return {name:"vite-elysia-forge",async configureServer(s){let l=g,y=resolve(s.config.root,l.slice(1)),f=async()=>(await s.ssrLoadModule(l)).api,p=await f();s.watcher.add(y),s.watcher.on("change",async e=>{let o=await s.moduleGraph.getModuleByUrl(l);if(!o)return;let i=s.moduleGraph.getModulesByFile(e);if(!i||i.size===0)return;let n=false,r=new Set,a=[...i];for(;a.length>0;){let t=a.shift();if(!(!t||!t.id||r.has(t.id))){if(r.add(t.id),t.id===o.id){n=true;break}for(let c of t.importers)a.push(c);}}if(n)try{s.moduleGraph.invalidateModule(o),p=await f(),console.log("[vite-elysia-forge] Reloaded Elysia API module");}catch(t){console.error(`[vite-elysia-forge] Failed to reload Elysia API: ${t}`);}}),s.middlewares.use(async(e,o,i)=>{if(!e.url?.startsWith("/api"))return i();try{let n="http",r=e.headers.host||"localhost:3000",a=`${n}://${r}${e.url}`,t;if(e.method!=="GET"&&e.method!=="HEAD"){let d=[];for await(let h of e)d.push(h);t=Buffer.concat(d).toString();}let c=new Request(a,{method:e.method,headers:e.headers,body:t}),u=await p.handle(c);o.statusCode=u.status,u.headers.forEach((d,h)=>{o.setHeader(h,d);});let m=await u.text();o.end(m);}catch(n){console.error(`[vite-elysia-forge] Elysia error: ${n}`),o.statusCode=500,o.end("Internal Server Error");}});}}}var P=E;
 export{P as default};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vite-elysia-forge",
-  "version": "0.0.7",
+  "version": "0.0.9",
   "description": "A Vite plugin to seamlessly integrate ElysiaJS for full-stack development with Bun runtime.",
   "type": "module",
   "main": "dist/index.cjs",
@@ -13,7 +13,7 @@
   "author": "chijioke-udokporo",
   "private": false,
   "scripts": {
-    "build": "bun run test && tsup",
+    "build": "rm -rf dist &&bun run test && tsup",
     "test": "bun test"
   },
   "dependencies": {},