@oakbun/ws 0.1.0 → 0.1.1

package/dist/ws/src/types.d.ts

@@ -1,87 +0,0 @@
-import type { ZodTypeAny } from 'zod';
-import type { AuthPayload } from 'oakbun';
-import type { BoundVelnDB } from '../../core/src/db/index';
-export interface WsCtx<TData = unknown> {
-    /** Matched path params, e.g. { roomId: '42' } for /rooms/:roomId */
-    params: Record<string, string>;
-    /** Parsed query string from the upgrade request */
-    query: Record<string, string | string[]>;
-    /**
-     * The Bun ServerWebSocket — use ws.send(), ws.close(), ws.subscribe(), etc.
-     * Typed with `data: WsCtxData` so ws.data carries ctx.user etc.
-     */
-    ws: import('bun').ServerWebSocket<WsCtxData>;
-    /**
-     * Validated & typed message payload.
-     * Only set inside onMessage() when a message schema was defined.
-     * Undefined in open / close / drain.
-     */
-    data: TData;
-    /** Set by jwtPlugin when registered on the app. undefined otherwise. */
-    user?: AuthPayload;
-    /** Set by dbPlugin when registered on the app. undefined otherwise. */
-    db?: BoundVelnDB;
-}
-export interface WsCtxData {
-    _wsPath: string;
-    params: Record<string, string>;
-    query: Record<string, string | string[]>;
-    user?: AuthPayload;
-    db?: BoundVelnDB;
-    [key: string]: unknown;
-    _data?: unknown;
-}
-export interface WsHandlers<TMsg = unknown> {
-    /** Called when a client opens a connection. ctx.data is undefined here. */
-    open?: (ctx: WsCtx<undefined>) => void | Promise<void>;
-    /**
-     * Called for each incoming message.
-     * If a message schema was provided, ctx.data is the validated & typed payload.
-     */
-    message?: (ctx: WsCtx<TMsg>, raw: string | Uint8Array) => void | Promise<void>;
-    /**
-     * Called when a client disconnects.
-     * code: WebSocket close code; reason: human-readable string.
-     */
-    close?: (ctx: WsCtx<undefined>, code: number, reason: string) => void | Promise<void>;
-    /** Called when the send buffer is drained and more data can be written. */
-    drain?: (ctx: WsCtx<undefined>) => void | Promise<void>;
-}
-/** Stored internally — one entry per registered WS path. */
-export interface WsRoute {
-    /** Registered path pattern, e.g. '/chat' or '/rooms/:id' */
-    path: string;
-    /** Optional Zod schema to parse incoming messages */
-    messageSchema?: ZodTypeAny;
-    handlers: WsHandlers<any>;
-    /** Reference to the originating module (null for app-level) */
-    _module: unknown | null;
-    /** Index signature — satisfies WsRouteShape from core */
-    [key: string]: unknown;
-}
-/**
- * WsRouteHandler — passed to app.ws() / module.ws().
- *
- * Usage (no schema):
- *   app.ws('/chat', { open(ctx) { ... }, message(ctx, raw) { ... } })
- *
- * Usage (with Zod schema — message is typed):
- *   app.ws('/chat', {
- *     message: z.object({ text: z.string() }),
- *     handlers: {
- *       message(ctx, raw) { ctx.data.text  // ← typed }
- *     }
- *   })
- */
-export type WsRouteHandler<TMsg = unknown> = WsHandlers<TMsg> | WsRouteHandlerWithSchema<TMsg>;
-export interface WsRouteHandlerWithSchema<TMsg = unknown> {
-    /** Zod schema for incoming messages. Parsed before onMessage is called. */
-    message: ZodTypeAny;
-    /** Lifecycle callbacks — message(ctx) receives the validated & typed payload */
-    handlers: WsHandlers<TMsg>;
-}
-export declare function normalizeWsHandler<TMsg>(handler: WsRouteHandler<TMsg>): {
-    messageSchema?: ZodTypeAny;
-    handlers: WsHandlers<TMsg>;
-};
-//# sourceMappingURL=types.d.ts.map

package/dist/ws/src/types.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,KAAK,CAAA;AACrC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,QAAQ,CAAA;AACzC,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAA;AAQ1D,MAAM,WAAW,KAAK,CAAC,KAAK,GAAG,OAAO;IACpC,oEAAoE;IACpE,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAC9B,mDAAmD;IACnD,KAAK,EAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IACzC;;;OAGG;IACH,EAAE,EAAM,OAAO,KAAK,EAAE,eAAe,CAAC,SAAS,CAAC,CAAA;IAChD;;;;OAIG;IACH,IAAI,EAAI,KAAK,CAAA;IACb,wEAAwE;IACxE,IAAI,CAAC,EAAG,WAAW,CAAA;IACnB,uEAAuE;IACvE,EAAE,CAAC,EAAK,WAAW,CAAA;CACpB;AAGD,MAAM,WAAW,SAAS;IACxB,OAAO,EAAG,MAAM,CAAA;IAChB,MAAM,EAAI,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAChC,KAAK,EAAK,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC,CAAA;IAC3C,IAAI,CAAC,EAAK,WAAW,CAAA;IACrB,EAAE,CAAC,EAAO,WAAW,CAAA;IAErB,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;IAEtB,KAAK,CAAC,EAAI,OAAO,CAAA;CAClB;AAID,MAAM,WAAW,UAAU,CAAC,IAAI,GAAG,OAAO;IACxC,2EAA2E;IAC3E,IAAI,CAAC,EAAK,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACzD;;;OAGG;IACH,OAAO,CAAC,EAAE,CAAC,GAAG,EAAE,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,MAAM,GAAG,UAAU,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IAC9E;;;OAGG;IACH,KAAK,CAAC,EAAI,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;IACvF,2EAA2E;IAC3E,KAAK,CAAC,EAAI,CAAC,GAAG,EAAE,KAAK,CAAC,SAAS,CAAC,KAAK,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,CAAA;CAC1D;AAID,4DAA4D;AAC5D,MAAM,WAAW,OAAO;IACtB,4DAA4D;IAC5D,IAAI,EAAY,MAAM,CAAA;IACtB,qDAAqD;IACrD,aAAa,CAAC,EAAE,UAAU,CAAA;IAC1B,QAAQ,EAAQ,UAAU,CAAC,GAAG,CAAC,CAAA;IAC/B,+DAA+D;IAC/D,OAAO,EAAS,OAAO,GAAG,IAAI,CAAA;IAC9B,yDAAyD;IACzD,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;CACvB;AAID;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,cAAc,CAAC,IAAI,GAAG,OAAO,IACrC,UAAU,CAAC,IAAI,CAAC,GAChB,wBAAwB,CAAC,IAAI,CAAC,CAAA;AAElC,MAAM,WAAW,wBAAwB,CAAC,IAAI,GAAG,OAAO;IACtD,2EAA2E;IAC3E,OAAO,EAAI,UAAU,CAAA;IACrB,gFAAgF;IAChF,QAAQ,EAAG,UAAU,CAAC,IAAI,CAAC,CAAA;CAC5B;AAID,wBAAgB,kBAAkB,CAAC,IAAI,EACrC,OAAO,EAAE,cAAc,CAAC,IAAI,CAAC,GAC5B;IAAE,aAAa,CAAC,EAAE,UAAU,CAAC;IAAC,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,CAAA;CAAE,CAQ5D"}