@enfyra/sdk-nuxt 0.7.5 → 0.7.6

package/README.md

@@ -7,6 +7,7 @@ Nuxt SDK for Enfyra CMS - A lightweight composable-based API client with full Ty
 ✅ **Simple & Flexible** - Get base URL and build your own composables  
 ✅ **Authentication Integration** - Built-in auth composables with automatic header forwarding  
 ✅ **Asset Proxy** - Automatic `/assets/**` proxy to backend with no configuration needed  
+✅ **WebSocket Relay** - Relay Socket.IO through Nuxt at `/ws/:path` (keeps backend hidden)  
 ✅ **TypeScript Support** - Full type safety with auto-generated declarations  
 ✅ **SSR Ready** - Works seamlessly with Nuxt's `useFetch` and `$fetch`
 
@@ -43,10 +44,27 @@ The SDK automatically detects your application URL:
 
 ```typescript
 // Get the base URL for your API requests
-const { baseUrl, apiPrefix } = useEnfyra();
+const { baseUrl, apiPrefix, wsBaseUrl, wsPath } = useEnfyra();
 
 // baseUrl: "http://localhost:3001/enfyra/api"
 // apiPrefix: "/enfyra/api"
+// wsBaseUrl: "http://localhost:3001" (for WebSocket relay)
+// wsPath: "/ws/socket.io" (engine path)
+```
+
+### WebSocket Relay
+
+The SDK relays Socket.IO through Nuxt so the backend can stay non-public. Use `socket.io-client` with `wsBaseUrl` and `wsPath`:
+
+```typescript
+import { io } from 'socket.io-client';
+
+const { wsBaseUrl, wsPath } = useEnfyra();
+
+const socket = io(wsBaseUrl + '/chat', {
+  path: wsPath,
+  auth: { token },  // if gateway requireAuth
+});
 ```
 
 ### Using with `useFetch` (SSR)

package/dist/module.cjs

@@ -106,6 +106,9 @@ declare module '#imports' {
       route: `${apiPrefix}/**`,
       handler: resolve("./runtime/server/api/all")
     });
+    nuxt.options.nitro = nuxt.options.nitro || {};
+    nuxt.options.nitro.experimental = nuxt.options.nitro.experimental || {};
+    nuxt.options.nitro.experimental.websocket = true;
   }
 });
 

package/dist/module.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;;AAED,wBA6HG"}
+{"version":3,"file":"module.d.ts","sourceRoot":"","sources":["../src/module.ts"],"names":[],"mappings":"AAYA,MAAM,WAAW,aAAa;IAC5B,MAAM,EAAE,MAAM,CAAC;IACf,SAAS,CAAC,EAAE,MAAM,CAAC;CACpB;;AAED,wBAiIG"}

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=3.0.0"
   },
-  "version": "0.7.5",
+  "version": "0.7.6",
   "builder": {
     "@nuxt/module-builder": "0.8.4",
     "unbuild": "2.0.0"

package/dist/module.mjs

@@ -103,6 +103,9 @@ declare module '#imports' {
       route: `${apiPrefix}/**`,
       handler: resolve("./runtime/server/api/all")
     });
+    nuxt.options.nitro = nuxt.options.nitro || {};
+    nuxt.options.nitro.experimental = nuxt.options.nitro.experimental || {};
+    nuxt.options.nitro.experimental.websocket = true;
   }
 });
 

package/dist/runtime/server/plugins/socket-relay.d.ts

@@ -0,0 +1,3 @@
+declare const _default: import("nitropack").NitroAppPlugin;
+export default _default;
+//# sourceMappingURL=socket-relay.d.ts.map

package/dist/runtime/server/plugins/socket-relay.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"socket-relay.d.ts","sourceRoot":"","sources":["../../../../src/runtime/server/plugins/socket-relay.ts"],"names":[],"mappings":";AAUA,wBAwEG"}

package/dist/runtime/server/plugins/socket-relay.js

@@ -0,0 +1,69 @@
+import { defineNitroPlugin } from "nitropack/runtime";
+import { Server as Engine } from "engine.io";
+import { Server } from "socket.io";
+import { io as ioClient } from "socket.io-client";
+import { defineEventHandler } from "h3";
+import { useRuntimeConfig } from "#imports";
+const ENGINE_PATH = "/socket.io";
+const ENGINE_PATH_SLASH = `${ENGINE_PATH}/`;
+export default defineNitroPlugin((nitroApp) => {
+  const config = useRuntimeConfig();
+  const apiUrl = config.public?.enfyraSDK?.apiUrl;
+  if (!apiUrl) return;
+  const backendUrl = String(apiUrl).replace(/\/+$/, "");
+  const engine = new Engine();
+  const io = new Server();
+  io.bind(engine);
+  io.on("connection", (clientSocket) => {
+    const namespace = clientSocket.nsp.name;
+    const backendNamespace = namespace === "/" || namespace === "" ? "/" : namespace;
+    const backendNsUrl = `${backendUrl}${backendNamespace}`;
+    const backendSocket = ioClient(backendNsUrl, {
+      path: "/socket.io",
+      auth: clientSocket.handshake.auth,
+      transports: ["websocket", "polling"]
+    });
+    clientSocket.onAny((event, ...args) => {
+      if (event !== "disconnect") {
+        backendSocket.emit(event, ...args);
+      }
+    });
+    backendSocket.onAny((event, ...args) => {
+      clientSocket.emit(event, ...args);
+    });
+    clientSocket.on("disconnect", () => {
+      backendSocket.disconnect();
+    });
+    backendSocket.on("disconnect", () => {
+      clientSocket.disconnect();
+    });
+    backendSocket.on("connect_error", (err) => {
+      clientSocket.emit("connect_error", err.message);
+      clientSocket.disconnect();
+    });
+  });
+  nitroApp.router.use(
+    `${ENGINE_PATH_SLASH}`,
+    defineEventHandler({
+      handler(event) {
+        const req = event.node.req;
+        const res = event.node.res;
+        engine.handleRequest(req, res);
+        event._handled = true;
+      },
+      websocket: {
+        open(peer) {
+          const nodeReq = peer._internal?.nodeReq;
+          if (nodeReq) {
+            engine.prepare(nodeReq);
+            engine.onWebSocket(
+              nodeReq,
+              nodeReq.socket,
+              peer.websocket
+            );
+          }
+        }
+      }
+    })
+  );
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enfyra/sdk-nuxt",
-  "version": "0.7.5",
+  "version": "0.7.6",
   "type": "module",
   "description": "Nuxt SDK for Enfyra CMS",
   "repository": {
@@ -55,13 +55,17 @@
   },
   "peerDependencies": {
     "@nuxt/kit": "^3.18.1",
+    "nitropack": ">=2.0.0",
     "vue": "^3.0.0"
   },
   "dependencies": {
     "defu": "^6.1.4",
+    "engine.io": "^6.6.3",
     "h3": "^1.15.4",
     "http-proxy": "^1.18.1",
-    "ofetch": "^1.3.3"
+    "ofetch": "^1.3.3",
+    "socket.io": "^4.8.3",
+    "socket.io-client": "^4.8.3"
   },
   "devDependencies": {
     "@nuxt/module-builder": "^0.8.4",

package/src/module.ts

@@ -139,5 +139,9 @@ declare module '#imports' {
       route: `${apiPrefix}/**`,
       handler: resolve("./runtime/server/api/all"),
     });
+
+    nuxt.options.nitro = nuxt.options.nitro || {};
+    nuxt.options.nitro.experimental = nuxt.options.nitro.experimental || {};
+    nuxt.options.nitro.experimental.websocket = true;
   },
 });

package/src/runtime/server/plugins/socket-relay.ts

@@ -0,0 +1,83 @@
+// @ts-nocheck - Nitro plugin
+import { defineNitroPlugin } from "nitropack/runtime";
+import { Server as Engine } from "engine.io";
+import { Server } from "socket.io";
+import { io as ioClient } from "socket.io-client";
+import { defineEventHandler } from "h3";
+import { useRuntimeConfig } from "#imports";
+const ENGINE_PATH = "/socket.io";
+const ENGINE_PATH_SLASH = `${ENGINE_PATH}/`;
+
+export default defineNitroPlugin((nitroApp) => {
+  const config = useRuntimeConfig();
+  const apiUrl = config.public?.enfyraSDK?.apiUrl;
+  if (!apiUrl) return;
+
+  const backendUrl = String(apiUrl).replace(/\/+$/, "");
+  const engine = new Engine();
+  const io = new Server();
+  io.bind(engine);
+
+  io.on("connection", (clientSocket) => {
+    const namespace = clientSocket.nsp.name;
+    const backendNamespace =
+      namespace === "/" || namespace === "" ? "/" : namespace;
+    const backendNsUrl = `${backendUrl}${backendNamespace}`;
+
+    const backendSocket = ioClient(backendNsUrl, {
+      path: "/socket.io",
+      auth: clientSocket.handshake.auth,
+      transports: ["websocket", "polling"],
+    });
+
+    clientSocket.onAny((event: string, ...args: unknown[]) => {
+      if (event !== "disconnect") {
+        backendSocket.emit(event, ...args);
+      }
+    });
+
+    backendSocket.onAny((event: string, ...args: unknown[]) => {
+      clientSocket.emit(event, ...args);
+    });
+
+    clientSocket.on("disconnect", () => {
+      backendSocket.disconnect();
+    });
+
+    backendSocket.on("disconnect", () => {
+      clientSocket.disconnect();
+    });
+
+    backendSocket.on("connect_error", (err: Error) => {
+      clientSocket.emit("connect_error", err.message);
+      clientSocket.disconnect();
+    });
+  });
+
+  nitroApp.router.use(
+    `${ENGINE_PATH_SLASH}`,
+    defineEventHandler({
+      handler(event) {
+        const req = event.node.req as Parameters<InstanceType<typeof Engine>["handleRequest"]>[0];
+        const res = event.node.res as Parameters<InstanceType<typeof Engine>["handleRequest"]>[1];
+        engine.handleRequest(req, res);
+        event._handled = true;
+      },
+      websocket: {
+        open(peer) {
+          // Nitro/crossws peer with nodeReq for engine.io integration
+          const nodeReq = (peer as { _internal?: { nodeReq?: { socket?: unknown } } })._internal?.nodeReq;
+          if (nodeReq) {
+            (engine as unknown as { prepare(r: unknown): void; onWebSocket(a: unknown, b: unknown, c: WebSocket): void })
+              .prepare(nodeReq);
+            (engine as unknown as { onWebSocket(a: unknown, b: unknown, c: WebSocket): void }).onWebSocket(
+              nodeReq,
+              (nodeReq as { socket?: unknown }).socket,
+              peer.websocket,
+            );
+          }
+        },
+      },
+    }),
+  );
+});