elysia-vision 0.1.0 → 0.1.1

package/dist/README.md

@@ -0,0 +1,75 @@
+<h1 align='center'>
+  Elysia Vision <img alt="NPM Version" src="https://img.shields.io/npm/v/elysia-vision">
+</h1>
+<img alt="Elysia vision webapp" src="image.png">
+<h3 align='center'>
+  <b>CURRENTLY IN PROGRESS.</b>
+</h3>
+
+<p align='center'>
+Plugin for <a href='https://github.com/elysiajs/elysia'>Elysia.js</a> to monitor your API requests in real-time through a web dashboard and more.
+</p>
+
+## How it works
+
+**elysia-vision** consists of two parts:
+
+1. **This plugin** - Adds WebSocket monitoring capabilities to your Elysia server
+2. **The web dashboard** - A separate webapp hosted at https://elysia-vision-webapp.vercel.app
+
+The plugin exposes a WebSocket endpoint on your server. The dashboard connects to your server's URL (e.g., `localhost:3000`) to display real-time request data.
+
+> **Note:** The webapp is hosted separately and does not require installation. You simply configure your server's URL in the dashboard.
+
+## Installation
+
+### 0. Install the plugin
+
+```bash
+bun add elysia-vision
+```
+
+### 1. Add the plugin to your Elysia server
+
+```typescript
+import { Elysia } from "elysia";
+import vision from "elysia-vision";
+
+const app = new Elysia().use(vision()).listen(3000);
+```
+
+Configure:
+
+| Option  | Description                  | Default | Comments            |
+| ------- | ---------------------------- | ------- | ------------------- |
+| enabled | Whether to enable the plugin | true    | false in production |
+
+### 2. Open the web dashboard
+
+Go to **https://elysia-vision-webapp.vercel.app**
+
+### 3. Configure your server URL
+
+In the dashboard, enter your server's base URL: `localhost:3000` for example
+
+The dashboard will connect via WebSocket to monitor your requests in real-time.
+
+## Roadmap
+
+- Real-time request monitoring dashboard (v0.1.x)
+- REplay request, edit, share request
+- Module structure visualization
+- System metrics (RAM, CPU usage)
+- See the path of a request in the modules
+
+## Important Notes
+
+⚠️ I'm aware of concerns regarding the current hosting provider (Vercel) and plan to migrate soon
+
+## Contact
+
+[Twitter/X](https://x.com/RouretLucas)
+
+## License
+
+MIT

package/dist/cjs/index.d.ts

@@ -1,6 +1,34 @@
 import { Elysia } from 'elysia';
+import { ElysiaVisionConfig } from './types.js';
 
-declare const vision: () => Elysia<"", {
+declare const vision: (config?: ElysiaVisionConfig) => Elysia<"", {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}> | Elysia<"", {
     decorator: {};
     store: {};
     derive: {};
@@ -37,6 +65,6 @@ declare const vision: () => Elysia<"", {
     schema: {};
     standaloneSchema: {};
     response: {};
-}> | null;
+}>;
 
 export { vision as default };

package/dist/cjs/index.js

@@ -42,9 +42,11 @@ var sanitizeHeaders = (headers) => {
 };
 
 // src/index.ts
-var vision = () => {
-  if (process.env.NODE_ENV === "production") {
-    return null;
+var vision = (config = {}) => {
+  if (process.env.NODE_ENV === "production" || !config.enabled) {
+    return new import_elysia.Elysia({
+      name: "elysia-vision"
+    });
   }
   const clients = /* @__PURE__ */ new Set();
   const calls = /* @__PURE__ */ new Map();

package/dist/cjs/types.d.ts

@@ -20,5 +20,12 @@ type VisionCall = {
     request: VisionRequest;
     response: VisionResponse | null;
 };
+type ElysiaVisionConfig = {
+    /**
+     * @default true
+     * false in production
+     */
+    enabled?: boolean;
+};
 
-export type { VisionCall, VisionRequest, VisionResponse, _INTERNAL_VisionWebSocketPayload };
+export type { ElysiaVisionConfig, VisionCall, VisionRequest, VisionResponse, _INTERNAL_VisionWebSocketPayload };

package/dist/index.d.ts

@@ -1,6 +1,34 @@
 import { Elysia } from 'elysia';
+import { ElysiaVisionConfig } from './types.js';
 
-declare const vision: () => Elysia<"", {
+declare const vision: (config?: ElysiaVisionConfig) => Elysia<"", {
+    decorator: {};
+    store: {};
+    derive: {};
+    resolve: {};
+}, {
+    typebox: {};
+    error: {};
+}, {
+    schema: {};
+    standaloneSchema: {};
+    macro: {};
+    macroFn: {};
+    parser: {};
+    response: {};
+}, {}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}, {
+    derive: {};
+    resolve: {};
+    schema: {};
+    standaloneSchema: {};
+    response: {};
+}> | Elysia<"", {
     decorator: {};
     store: {};
     derive: {};
@@ -37,6 +65,6 @@ declare const vision: () => Elysia<"", {
     schema: {};
     standaloneSchema: {};
     response: {};
-}> | null;
+}>;
 
 export { vision as default };

package/dist/index.mjs

@@ -18,9 +18,11 @@ var sanitizeHeaders = (headers) => {
 };
 
 // src/index.ts
-var vision = () => {
-  if (process.env.NODE_ENV === "production") {
-    return null;
+var vision = (config = {}) => {
+  if (process.env.NODE_ENV === "production" || !config.enabled) {
+    return new Elysia({
+      name: "elysia-vision"
+    });
   }
   const clients = /* @__PURE__ */ new Set();
   const calls = /* @__PURE__ */ new Map();

package/dist/types.d.ts

@@ -20,5 +20,12 @@ type VisionCall = {
     request: VisionRequest;
     response: VisionResponse | null;
 };
+type ElysiaVisionConfig = {
+    /**
+     * @default true
+     * false in production
+     */
+    enabled?: boolean;
+};
 
-export type { VisionCall, VisionRequest, VisionResponse, _INTERNAL_VisionWebSocketPayload };
+export type { ElysiaVisionConfig, VisionCall, VisionRequest, VisionResponse, _INTERNAL_VisionWebSocketPayload };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "elysia-vision",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Plugin for Elysia that monitors your API requests in real-time through a web dashboard.",
   "exports": {
     "./package.json": "./package.json",
@@ -35,8 +35,7 @@
     "build": "bun build.ts"
   },
   "files": [
-    "dist",
-    "README.md"
+    "dist"
   ],
   "publishConfig": {
     "access": "public"
@@ -50,4 +49,4 @@
   "peerDependencies": {
     "elysia": ">= 1.4.0"
   }
-}
+}