shokupan 0.7.0 → 0.9.0

package/README.md

@@ -243,6 +243,59 @@ app.mount('/api', UserController);
 - `@Ctx()` - Access full context
 - `@Req()` - Access request object
 
+### WebSockets
+
+> Notice: The WebSocket API is currently in an experimental stage and subject to change.
+
+Shokupan provides native WebSocket handling and an HTTP Bridge feature.
+
+#### Event Decorator
+
+Handle WebSocket events directly in your controllers:
+
+```typescript
+import { Controller, Event, ShokupanContext } from 'shokupan';
+
+@Controller('/chat')
+export class ChatController {
+
+    @Event('message')
+    async onMessage(ctx: ShokupanContext) {
+        const payload = await ctx.body();
+        console.log('Received:', payload);
+        
+        // Reply using underlying socket
+        // Native Bun: ctx.socket is ServerWebSocket
+        // Socket.IO: ctx.socket is Socket
+        ctx.emit('ack', 'received');
+    }
+}
+```
+
+#### Socket.IO Support
+
+Easily integrate Socket.IO and wire up your event decorators via the built-in helper:
+
+```typescript
+import { Shokupan } from 'shokupan';
+import { Server } from 'socket.io';
+import { attachSocketIOBridge } from 'shokupan';
+
+const app = new Shokupan({ enableHttpBridge: false });
+const server = await app.listen(3000);
+
+// Attach Socket.IO
+const io = new Server(server.nodeServer); // For Node.js
+attachSocketIOBridge(io, app);
+```
+
+#### HTTP Bridge
+
+Expose your HTTP API over WebSockets (set `enableHttpBridge: true` in config).
+
+Client sends: `{ type: "HTTP", method: "GET", path: "/api/users", ... }`
+Server responds: `{ type: "RESPONSE", status: 200, body: ... }`
+
 ### Middleware
 
 Middleware functions have access to the context and can control request flow:

package/dist/context.d.ts

@@ -1,7 +1,9 @@
-import { BodyInit, Server } from 'bun';
+import { BodyInit, Server, ServerWebSocket } from 'bun';
+import { Socket, Server as SocketServer } from 'socket.io';
 import { Shokupan } from './shokupan';
 import { ShokupanRequest } from './util/request';
 import { ShokupanResponse } from './util/response';
+import { $bodyParsed, $bodyParseError, $bodyType, $cachedBody, $cachedHost, $cachedHostname, $cachedOrigin, $cachedProtocol, $cachedQuery, $debug, $finalResponse, $io, $rawBody, $requestId, $routeMatched, $socket, $url, $ws } from './util/symbol';
 import { CookieOptions, HeadersInit, JSXRenderer } from './util/types';
 export interface HandlerStackItem {
     name: string;
@@ -87,25 +89,30 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
     state: State;
     handlerStack: HandlerStackItem[];
     readonly response: ShokupanResponse;
-    _debug?: DebugCollector;
-    _finalResponse?: Response;
-    _rawBody?: string | ArrayBuffer | Uint8Array;
-    private _url?;
-    private _cachedBody?;
-    private _bodyType?;
-    private _bodyParsed;
-    _bodyParseError?: Error;
-    _routeMatched: boolean;
-    private _cachedHostname?;
-    private _cachedProtocol?;
-    private _cachedHost?;
-    private _cachedOrigin?;
-    private _cachedQuery?;
+    [$debug]?: DebugCollector;
+    [$finalResponse]?: Response;
+    [$rawBody]?: string | ArrayBuffer | Uint8Array;
+    private [$url]?;
+    private [$cachedBody]?;
+    private [$bodyType]?;
+    private [$bodyParsed];
+    private [$bodyParseError]?;
+    [$routeMatched]: boolean;
+    private [$cachedHostname]?;
+    private [$cachedProtocol]?;
+    private [$cachedHost]?;
+    private [$cachedOrigin]?;
+    private [$cachedQuery]?;
+    private [$ws]?;
+    private [$socket]?;
+    private [$io]?;
     /**
      * JSX Rendering Function
      */
     private renderer?;
     setRenderer(renderer: JSXRenderer): void;
+    private [$requestId];
+    get requestId(): string;
     constructor(request: ShokupanRequest<any>, server?: Server, state?: State, app?: Shokupan, signal?: AbortSignal, // Optional as it might not be provided in tests or simple creates
     enableMiddlewareTracking?: boolean);
     get url(): URL;
@@ -162,12 +169,34 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
      * Base response object
      */
     get res(): ShokupanResponse;
+    /**
+     * Raw WebSocket connection
+     */
+    get ws(): ServerWebSocket<undefined>;
+    /**
+     * Socket.io socket
+     */
+    get socket(): Socket<import('socket.io').DefaultEventsMap, import('socket.io').DefaultEventsMap, import('socket.io').DefaultEventsMap, any>;
+    /**
+     * Socket.io server
+     */
+    get io(): SocketServer<import('socket.io').DefaultEventsMap, import('socket.io').DefaultEventsMap, import('socket.io').DefaultEventsMap, any>;
     /**
      * Helper to set a header on the response
      * @param key Header key
      * @param value Header value
      */
     set(key: string, value: string): this;
+    isUpgraded: boolean;
+    /**
+     * Upgrades the request to a WebSocket connection.
+     * @param options Upgrade options
+     * @returns true if upgraded, false otherwise
+     */
+    upgrade(options?: {
+        data?: any;
+        headers?: HeadersInit;
+    }): boolean;
     /**
      * Set a cookie
      * @param name Cookie name
@@ -200,6 +229,12 @@ export declare class ShokupanContext<State extends Record<string, any> = Record<
      * @returns Response
      */
     send(body?: BodyInit, options?: ResponseInit): Response;
+    /**
+     * Emit an event to the client (WebSocket only)
+     * @param event Event name
+     * @param data Event data (Must be JSON serializable)
+     */
+    emit(event: string, data?: any): void;
     /**
      * Respond with a JSON object
      */

package/dist/{http-server-DFhwlK8e.cjs → http-server-BEMPIs33.cjs}

@@ -70,7 +70,9 @@ function createHttpServer() {
       requestIP: (req) => null,
       publish: () => 0,
       subscriberCount: () => 0,
-      url: new URL(`http://${options.hostname}:${options.port}`)
+      url: new URL(`http://${options.hostname}:${options.port}`),
+      // Expose the raw Node.js server for generic socket/websocket support (e.g. Socket.IO)
+      nodeServer: server
     };
     return new Promise((resolve) => {
       server.listen(options.port, options.hostname, () => {
@@ -80,4 +82,4 @@ function createHttpServer() {
   };
 }
 exports.createHttpServer = createHttpServer;
-//# sourceMappingURL=http-server-DFhwlK8e.cjs.map
+//# sourceMappingURL=http-server-BEMPIs33.cjs.map

package/dist/http-server-BEMPIs33.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-server-BEMPIs33.cjs","sources":["../src/plugins/application/http-server.ts"],"sourcesContent":["import type { Server } from \"bun\";\nimport * as http from \"node:http\";\nimport * as https from \"node:https\";\nimport type { ServerFactory } from \"../../util/types\";\n\n/**\n * Creates a server factory that uses the standard Node.js `http` module.\n * @returns A ServerFactory compatible with Shokupan.\n */\nexport function createHttpServer(): ServerFactory {\n    return async (options: any): Promise<Server> => {\n        const server = http.createServer(async (req, res) => {\n            const url = new URL(req.url!, `http://${req.headers.host}`);\n            const request = new Request(url.toString(), {\n                method: req.method,\n                headers: req.headers as any,\n                body: ['GET', 'HEAD'].includes(req.method!) ? undefined : new ReadableStream({\n                    start(controller) {\n                        req.on('data', chunk => controller.enqueue(chunk));\n                        req.on('end', () => controller.close());\n                        req.on('error', err => controller.error(err));\n                    }\n                }) as any,\n                // Required for Node.js undici when sending a body\n                duplex: 'half'\n            } as any);\n\n            const response = await options.fetch(request, fauxServer);\n\n            res.statusCode = response.status;\n            response.headers.forEach((v, k) => res.setHeader(k, v));\n\n            if (response.body) {\n                // Optimize: Use arrayBuffer for direct conversion instead of async iteration\n                const buffer = await response.arrayBuffer();\n                res.end(Buffer.from(buffer));\n            } else {\n                res.end();\n            }\n        });\n\n        const fauxServer: Server = {\n            stop: () => {\n                server.close();\n                return Promise.resolve(); // Bun.Server stop usually returns void but in type definition it might vary.\n            },\n            upgrade(req, options) {\n                return false;\n            },\n            reload(options) {\n                return fauxServer as any;\n            },\n            get port() {\n                const addr = server.address();\n                if (typeof addr === 'object' && addr !== null) {\n                    return addr.port;\n                }\n                return options.port;\n            },\n            hostname: options.hostname,\n            development: options.development,\n            pendingRequests: 0,\n            requestIP: (req) => null,\n            publish: () => 0,\n            subscriberCount: () => 0,\n            url: new URL(`http://${options.hostname}:${options.port}`),\n            // Expose the raw Node.js server for generic socket/websocket support (e.g. Socket.IO)\n            nodeServer: server\n        } as unknown as Server;\n\n        return new Promise((resolve) => {\n            server.listen(options.port, options.hostname, () => {\n                resolve(fauxServer);\n            });\n        });\n    };\n}\n\n/**\n * Creates a server factory that uses the standard Node.js `https` module.\n * @param sslOptions - Node.js HTTPS options (key, cert, etc.)\n * @returns A ServerFactory compatible with Shokupan.\n */\nexport function createHttpsServer(sslOptions: https.ServerOptions): ServerFactory {\n    return async (options: any): Promise<Server> => {\n        const server = https.createServer(sslOptions, async (req, res) => {\n            const url = new URL(req.url!, `https://${req.headers.host}`);\n            const request = new Request(url.toString(), {\n                method: req.method,\n                headers: req.headers as any,\n                body: ['GET', 'HEAD'].includes(req.method!) ? undefined : new ReadableStream({\n                    start(controller) {\n                        req.on('data', chunk => controller.enqueue(chunk));\n                        req.on('end', () => controller.close());\n                        req.on('error', err => controller.error(err));\n                    }\n                }) as any,\n                // Required for Node.js undici when sending a body\n                duplex: 'half'\n            } as any);\n\n            const response = await options.fetch(request, fauxServer);\n\n            res.statusCode = response.status;\n            response.headers.forEach((v, k) => res.setHeader(k, v));\n\n            if (response.body) {\n                // Optimize: Use arrayBuffer for direct conversion instead of async iteration\n                const buffer = await response.arrayBuffer();\n                res.end(Buffer.from(buffer));\n            } else {\n                res.end();\n            }\n        });\n\n        const fauxServer: Server = {\n            stop: () => {\n                server.close();\n            },\n            upgrade(req, options) {\n                return false;\n            },\n            reload(options) {\n                return fauxServer as any;\n            },\n            get port() {\n                const addr = server.address();\n                if (typeof addr === 'object' && addr !== null) {\n                    return addr.port;\n                }\n                return options.port;\n            },\n            hostname: options.hostname,\n            development: options.development,\n            pendingRequests: 0,\n            requestIP: (req) => null,\n            publish: () => 0,\n            subscriberCount: () => 0,\n            url: new URL(`https://${options.hostname}:${options.port}`),\n            // Expose the raw Node.js server for generic socket/websocket support\n            nodeServer: server\n        } as unknown as Server;\n\n        return new Promise((resolve) => {\n            server.listen(options.port, options.hostname, () => {\n                resolve(fauxServer);\n            });\n        });\n    };\n}\n"],"names":["http","options"],"mappings":";;;;;;;;;;;;;;;;;;;;;AASO,SAAS,mBAAkC;AAC9C,SAAO,OAAO,YAAkC;AAC5C,UAAM,SAASA,gBAAK,aAAa,OAAO,KAAK,QAAQ;AACjD,YAAM,MAAM,IAAI,IAAI,IAAI,KAAM,UAAU,IAAI,QAAQ,IAAI,EAAE;AAC1D,YAAM,UAAU,IAAI,QAAQ,IAAI,YAAY;AAAA,QACxC,QAAQ,IAAI;AAAA,QACZ,SAAS,IAAI;AAAA,QACb,MAAM,CAAC,OAAO,MAAM,EAAE,SAAS,IAAI,MAAO,IAAI,SAAY,IAAI,eAAe;AAAA,UACzE,MAAM,YAAY;AACd,gBAAI,GAAG,QAAQ,CAAA,UAAS,WAAW,QAAQ,KAAK,CAAC;AACjD,gBAAI,GAAG,OAAO,MAAM,WAAW,OAAO;AACtC,gBAAI,GAAG,SAAS,CAAA,QAAO,WAAW,MAAM,GAAG,CAAC;AAAA,UAChD;AAAA,QAAA,CACH;AAAA;AAAA,QAED,QAAQ;AAAA,MAAA,CACJ;AAER,YAAM,WAAW,MAAM,QAAQ,MAAM,SAAS,UAAU;AAExD,UAAI,aAAa,SAAS;AAC1B,eAAS,QAAQ,QAAQ,CAAC,GAAG,MAAM,IAAI,UAAU,GAAG,CAAC,CAAC;AAEtD,UAAI,SAAS,MAAM;AAEf,cAAM,SAAS,MAAM,SAAS,YAAA;AAC9B,YAAI,IAAI,OAAO,KAAK,MAAM,CAAC;AAAA,MAC/B,OAAO;AACH,YAAI,IAAA;AAAA,MACR;AAAA,IACJ,CAAC;AAED,UAAM,aAAqB;AAAA,MACvB,MAAM,MAAM;AACR,eAAO,MAAA;AACP,eAAO,QAAQ,QAAA;AAAA,MACnB;AAAA,MACA,QAAQ,KAAKC,UAAS;AAClB,eAAO;AAAA,MACX;AAAA,MACA,OAAOA,UAAS;AACZ,eAAO;AAAA,MACX;AAAA,MACA,IAAI,OAAO;AACP,cAAM,OAAO,OAAO,QAAA;AACpB,YAAI,OAAO,SAAS,YAAY,SAAS,MAAM;AAC3C,iBAAO,KAAK;AAAA,QAChB;AACA,eAAO,QAAQ;AAAA,MACnB;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB,aAAa,QAAQ;AAAA,MACrB,iBAAiB;AAAA,MACjB,WAAW,CAAC,QAAQ;AAAA,MACpB,SAAS,MAAM;AAAA,MACf,iBAAiB,MAAM;AAAA,MACvB,KAAK,IAAI,IAAI,UAAU,QAAQ,QAAQ,IAAI,QAAQ,IAAI,EAAE;AAAA;AAAA,MAEzD,YAAY;AAAA,IAAA;AAGhB,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC5B,aAAO,OAAO,QAAQ,MAAM,QAAQ,UAAU,MAAM;AAChD,gBAAQ,UAAU;AAAA,MACtB,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AACJ;;"}

package/dist/{http-server-0xH174zz.js → http-server-CCeagTyU.js}

@@ -51,7 +51,9 @@ function createHttpServer() {
       requestIP: (req) => null,
       publish: () => 0,
       subscriberCount: () => 0,
-      url: new URL(`http://${options.hostname}:${options.port}`)
+      url: new URL(`http://${options.hostname}:${options.port}`),
+      // Expose the raw Node.js server for generic socket/websocket support (e.g. Socket.IO)
+      nodeServer: server
     };
     return new Promise((resolve) => {
       server.listen(options.port, options.hostname, () => {
@@ -63,4 +65,4 @@ function createHttpServer() {
 export {
   createHttpServer
 };
-//# sourceMappingURL=http-server-0xH174zz.js.map
+//# sourceMappingURL=http-server-CCeagTyU.js.map

package/dist/http-server-CCeagTyU.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"http-server-CCeagTyU.js","sources":["../src/plugins/application/http-server.ts"],"sourcesContent":["import type { Server } from \"bun\";\nimport * as http from \"node:http\";\nimport * as https from \"node:https\";\nimport type { ServerFactory } from \"../../util/types\";\n\n/**\n * Creates a server factory that uses the standard Node.js `http` module.\n * @returns A ServerFactory compatible with Shokupan.\n */\nexport function createHttpServer(): ServerFactory {\n    return async (options: any): Promise<Server> => {\n        const server = http.createServer(async (req, res) => {\n            const url = new URL(req.url!, `http://${req.headers.host}`);\n            const request = new Request(url.toString(), {\n                method: req.method,\n                headers: req.headers as any,\n                body: ['GET', 'HEAD'].includes(req.method!) ? undefined : new ReadableStream({\n                    start(controller) {\n                        req.on('data', chunk => controller.enqueue(chunk));\n                        req.on('end', () => controller.close());\n                        req.on('error', err => controller.error(err));\n                    }\n                }) as any,\n                // Required for Node.js undici when sending a body\n                duplex: 'half'\n            } as any);\n\n            const response = await options.fetch(request, fauxServer);\n\n            res.statusCode = response.status;\n            response.headers.forEach((v, k) => res.setHeader(k, v));\n\n            if (response.body) {\n                // Optimize: Use arrayBuffer for direct conversion instead of async iteration\n                const buffer = await response.arrayBuffer();\n                res.end(Buffer.from(buffer));\n            } else {\n                res.end();\n            }\n        });\n\n        const fauxServer: Server = {\n            stop: () => {\n                server.close();\n                return Promise.resolve(); // Bun.Server stop usually returns void but in type definition it might vary.\n            },\n            upgrade(req, options) {\n                return false;\n            },\n            reload(options) {\n                return fauxServer as any;\n            },\n            get port() {\n                const addr = server.address();\n                if (typeof addr === 'object' && addr !== null) {\n                    return addr.port;\n                }\n                return options.port;\n            },\n            hostname: options.hostname,\n            development: options.development,\n            pendingRequests: 0,\n            requestIP: (req) => null,\n            publish: () => 0,\n            subscriberCount: () => 0,\n            url: new URL(`http://${options.hostname}:${options.port}`),\n            // Expose the raw Node.js server for generic socket/websocket support (e.g. Socket.IO)\n            nodeServer: server\n        } as unknown as Server;\n\n        return new Promise((resolve) => {\n            server.listen(options.port, options.hostname, () => {\n                resolve(fauxServer);\n            });\n        });\n    };\n}\n\n/**\n * Creates a server factory that uses the standard Node.js `https` module.\n * @param sslOptions - Node.js HTTPS options (key, cert, etc.)\n * @returns A ServerFactory compatible with Shokupan.\n */\nexport function createHttpsServer(sslOptions: https.ServerOptions): ServerFactory {\n    return async (options: any): Promise<Server> => {\n        const server = https.createServer(sslOptions, async (req, res) => {\n            const url = new URL(req.url!, `https://${req.headers.host}`);\n            const request = new Request(url.toString(), {\n                method: req.method,\n                headers: req.headers as any,\n                body: ['GET', 'HEAD'].includes(req.method!) ? undefined : new ReadableStream({\n                    start(controller) {\n                        req.on('data', chunk => controller.enqueue(chunk));\n                        req.on('end', () => controller.close());\n                        req.on('error', err => controller.error(err));\n                    }\n                }) as any,\n                // Required for Node.js undici when sending a body\n                duplex: 'half'\n            } as any);\n\n            const response = await options.fetch(request, fauxServer);\n\n            res.statusCode = response.status;\n            response.headers.forEach((v, k) => res.setHeader(k, v));\n\n            if (response.body) {\n                // Optimize: Use arrayBuffer for direct conversion instead of async iteration\n                const buffer = await response.arrayBuffer();\n                res.end(Buffer.from(buffer));\n            } else {\n                res.end();\n            }\n        });\n\n        const fauxServer: Server = {\n            stop: () => {\n                server.close();\n            },\n            upgrade(req, options) {\n                return false;\n            },\n            reload(options) {\n                return fauxServer as any;\n            },\n            get port() {\n                const addr = server.address();\n                if (typeof addr === 'object' && addr !== null) {\n                    return addr.port;\n                }\n                return options.port;\n            },\n            hostname: options.hostname,\n            development: options.development,\n            pendingRequests: 0,\n            requestIP: (req) => null,\n            publish: () => 0,\n            subscriberCount: () => 0,\n            url: new URL(`https://${options.hostname}:${options.port}`),\n            // Expose the raw Node.js server for generic socket/websocket support\n            nodeServer: server\n        } as unknown as Server;\n\n        return new Promise((resolve) => {\n            server.listen(options.port, options.hostname, () => {\n                resolve(fauxServer);\n            });\n        });\n    };\n}\n"],"names":["options"],"mappings":";;AASO,SAAS,mBAAkC;AAC9C,SAAO,OAAO,YAAkC;AAC5C,UAAM,SAAS,KAAK,aAAa,OAAO,KAAK,QAAQ;AACjD,YAAM,MAAM,IAAI,IAAI,IAAI,KAAM,UAAU,IAAI,QAAQ,IAAI,EAAE;AAC1D,YAAM,UAAU,IAAI,QAAQ,IAAI,YAAY;AAAA,QACxC,QAAQ,IAAI;AAAA,QACZ,SAAS,IAAI;AAAA,QACb,MAAM,CAAC,OAAO,MAAM,EAAE,SAAS,IAAI,MAAO,IAAI,SAAY,IAAI,eAAe;AAAA,UACzE,MAAM,YAAY;AACd,gBAAI,GAAG,QAAQ,CAAA,UAAS,WAAW,QAAQ,KAAK,CAAC;AACjD,gBAAI,GAAG,OAAO,MAAM,WAAW,OAAO;AACtC,gBAAI,GAAG,SAAS,CAAA,QAAO,WAAW,MAAM,GAAG,CAAC;AAAA,UAChD;AAAA,QAAA,CACH;AAAA;AAAA,QAED,QAAQ;AAAA,MAAA,CACJ;AAER,YAAM,WAAW,MAAM,QAAQ,MAAM,SAAS,UAAU;AAExD,UAAI,aAAa,SAAS;AAC1B,eAAS,QAAQ,QAAQ,CAAC,GAAG,MAAM,IAAI,UAAU,GAAG,CAAC,CAAC;AAEtD,UAAI,SAAS,MAAM;AAEf,cAAM,SAAS,MAAM,SAAS,YAAA;AAC9B,YAAI,IAAI,OAAO,KAAK,MAAM,CAAC;AAAA,MAC/B,OAAO;AACH,YAAI,IAAA;AAAA,MACR;AAAA,IACJ,CAAC;AAED,UAAM,aAAqB;AAAA,MACvB,MAAM,MAAM;AACR,eAAO,MAAA;AACP,eAAO,QAAQ,QAAA;AAAA,MACnB;AAAA,MACA,QAAQ,KAAKA,UAAS;AAClB,eAAO;AAAA,MACX;AAAA,MACA,OAAOA,UAAS;AACZ,eAAO;AAAA,MACX;AAAA,MACA,IAAI,OAAO;AACP,cAAM,OAAO,OAAO,QAAA;AACpB,YAAI,OAAO,SAAS,YAAY,SAAS,MAAM;AAC3C,iBAAO,KAAK;AAAA,QAChB;AACA,eAAO,QAAQ;AAAA,MACnB;AAAA,MACA,UAAU,QAAQ;AAAA,MAClB,aAAa,QAAQ;AAAA,MACrB,iBAAiB;AAAA,MACjB,WAAW,CAAC,QAAQ;AAAA,MACpB,SAAS,MAAM;AAAA,MACf,iBAAiB,MAAM;AAAA,MACvB,KAAK,IAAI,IAAI,UAAU,QAAQ,QAAQ,IAAI,QAAQ,IAAI,EAAE;AAAA;AAAA,MAEzD,YAAY;AAAA,IAAA;AAGhB,WAAO,IAAI,QAAQ,CAAC,YAAY;AAC5B,aAAO,OAAO,QAAQ,MAAM,QAAQ,UAAU,MAAM;AAChD,gBAAQ,UAAU;AAAA,MACtB,CAAC;AAAA,IACL,CAAC;AAAA,EACL;AACJ;"}