arri 0.36.0 → 0.37.0

package/README.md

@@ -18,6 +18,7 @@ Typescript implementation of Arri RPC. It's built on top of [H3](https://github.
 -   [Key Concepts](#key-concepts)
     -   [Arri Definition File](#arri-definition-file)
     -   [How Procedures Map To Endpoints](#how-procedures-map-to-endpoints)
+    -   [H3 Support](#h3-support)
 -   [Arri CLI](#arri-cli)
 
 ## Quickstart
@@ -107,24 +108,9 @@ Create an app entry file in your src directory. The name of the file must match
 ```ts
 // ./src/app.ts
 import { ArriApp } from "arri";
-import { a } from "arri-validate";
 
 const app = new ArriApp();
 
-app.rpc("sayHello", {
-    params: a.object({
-        name: a.string(),
-    }),
-    response: a.object({
-        message: a.string(),
-    }),
-    handler({ params }) {
-        return {
-            message: `Hello ${params.name}`,
-        };
-    },
-});
-
 export default app;
 ```
 
@@ -480,6 +466,37 @@ The supported HTTP methods are as follows:
 
 When using a get method the RPC params will be mapped as query parameters which will be coerced into their type using the `a.coerce` method from `arri-validate`. Get methods support all basic scalar types however arrays and nested objects are not supported.
 
+### H3 Support
+Arri is built on top of [H3](https://h3.unjs.io/utils/request#getrequestipevent) so many of the concepts that apply to H3 also apply to Arri.
+
+#### Accessing Utilities
+Arri re-eports all of the H3 utilities.
+
+```ts
+import { getRequestIP, setResponseHeader } from 'arri';
+```
+
+#### Accessing H3 Events
+You can access H3 events from inside procedures handlers.
+
+```ts
+defineRpc({
+  params: undefined,
+  response: undefined,
+  handler(_, event) {
+    getRequestIP(event);
+  }
+)
+
+defineEventStreamRpc({
+  params: undefined,
+  response: undefined,
+  handler(_, event) {
+    getRequestIP(event);
+  }
+)
+```
+
 ## Arri CLI
 
 ```bash

package/dist/cli.cjs

@@ -11,7 +11,7 @@ const esbuild = require('esbuild');
 const esbuildPluginReplace = require('esbuild-plugin-replace');
 const path = require('pathe');
 const prettier = require('prettier');
-const config = require('./shared/arri.087dabd0.cjs');
+const config = require('./shared/arri.1ce0fa20.cjs');
 const consola = require('consola');
 const globby = require('globby');
 const scule = require('scule');
@@ -93,10 +93,17 @@ async function createAppWithRoutesModule(config) {
     ).join(",\n")}
         ];
         for(const route of routes) {
-            app.rpc({
-                name: route.id,
-                ...route.route,
-            });
+            if(route.route.transport === 'http') {
+                app.rpc({
+                    name: route.id,
+                    ...route.route,
+                });
+            } else {
+                app.wsRpc({
+                    name: route.id,
+                    ...route.route,
+                });
+            }
         }
         export default app`,
     { parser: "typescript", tabWidth: 4 }
@@ -321,6 +328,14 @@ import app from './${OUT_APP_FILE}';
 void listen(toNodeListener(app.h3App), {
     port: process.env.PORT ?? ${config.port},
     public: true,
+    ws: {
+        resolve(info) {
+            if (app.h3App.websocket?.resolve) {
+                return app.h3App.websocket.resolve(info);
+            }
+            return app.h3App.websocket?.hooks ?? app.h3App.handler?.__websocket__ ?? {};
+        }
+    },
     http2: ${config.http2 ?? false},
     ${httpsString}
 });`;
@@ -471,7 +486,8 @@ const startListener = (config, showQr = false) => listhen.listenAndWatch(path__d
   logger,
   qr: showQr,
   https: config.https,
-  http2: config.http2
+  http2: config.http2,
+  ws: true
 });
 async function bundleFilesContext(config) {
   const serverContent = `import app from './${OUT_APP_FILE}';

package/dist/cli.mjs

@@ -10,7 +10,7 @@ import { build as build$1 } from 'esbuild';
 import { replace } from 'esbuild-plugin-replace';
 import path from 'pathe';
 import prettier from 'prettier';
-import { q as defaultConfig, o as isArriConfig, p as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.b0950dad.mjs';
+import { q as defaultConfig, o as isArriConfig, p as isResolvedArriConfig, a as DEV_DEFINITION_ENDPOINT } from './shared/arri.90dd1716.mjs';
 import { createConsola } from 'consola';
 import { globby } from 'globby';
 import { camelCase, kebabCase } from 'scule';
@@ -69,10 +69,17 @@ async function createAppWithRoutesModule(config) {
     ).join(",\n")}
         ];
         for(const route of routes) {
-            app.rpc({
-                name: route.id,
-                ...route.route,
-            });
+            if(route.route.transport === 'http') {
+                app.rpc({
+                    name: route.id,
+                    ...route.route,
+                });
+            } else {
+                app.wsRpc({
+                    name: route.id,
+                    ...route.route,
+                });
+            }
         }
         export default app`,
     { parser: "typescript", tabWidth: 4 }
@@ -297,6 +304,14 @@ import app from './${OUT_APP_FILE}';
 void listen(toNodeListener(app.h3App), {
     port: process.env.PORT ?? ${config.port},
     public: true,
+    ws: {
+        resolve(info) {
+            if (app.h3App.websocket?.resolve) {
+                return app.h3App.websocket.resolve(info);
+            }
+            return app.h3App.websocket?.hooks ?? app.h3App.handler?.__websocket__ ?? {};
+        }
+    },
     http2: ${config.http2 ?? false},
     ${httpsString}
 });`;
@@ -447,7 +462,8 @@ const startListener = (config, showQr = false) => listenAndWatch(path.resolve(co
   logger,
   qr: showQr,
   https: config.https,
-  http2: config.http2
+  http2: config.http2,
+  ws: true
 });
 async function bundleFilesContext(config) {
   const serverContent = `import app from './${OUT_APP_FILE}';

package/dist/index.cjs

@@ -1,8 +1,9 @@
 'use strict';
 
-const config = require('./shared/arri.087dabd0.cjs');
+const config = require('./shared/arri.1ce0fa20.cjs');
 const h3 = require('h3');
 require('arri-codegen-utils');
+require('consola');
 require('arri-validate');
 require('h3-sse');
 require('scule');
@@ -16,14 +17,17 @@ exports.ArriServerErrorResponse = config.ArriServerErrorResponse;
 exports.DEV_DEFINITION_ENDPOINT = config.DEV_DEFINITION_ENDPOINT;
 exports.DEV_ENDPOINT_ROOT = config.DEV_ENDPOINT_ROOT;
 exports.EventStreamConnection = config.EventStreamConnection;
+exports.WsPeer = config.WsPeer;
 exports.createAppDefinition = config.createAppDefinition;
 exports.createHttpRpcDefinition = config.createHttpRpcDefinition;
+exports.createWsRpcDefinition = config.createWsRpcDefinition;
 exports.defaultConfig = config.defaultConfig;
 exports.defineConfig = config.defineConfig;
 exports.defineError = config.defineError;
 exports.defineEventStreamRpc = config.defineEventStreamRpc;
 exports.defineRoute = config.defineRoute;
 exports.defineRpc = config.defineRpc;
+exports.defineWebsocketRpc = config.defineWebsocketRpc;
 exports.errorResponseFromValidationErrors = config.errorResponseFromValidationErrors;
 exports.getRpcParamName = config.getRpcParamName;
 exports.getRpcPath = config.getRpcPath;
@@ -38,6 +42,7 @@ exports.isRpcParamSchema = config.isRpcParamSchema;
 exports.registerEventStreamRpc = config.registerEventStreamRpc;
 exports.registerRoute = config.registerRoute;
 exports.registerRpc = config.registerRpc;
+exports.registerWebsocketRpc = config.registerWebsocketRpc;
 exports.validateRpcRequestInput = config.validateRpcRequestInput;
 exports.defineMiddleware = defineMiddleware;
 Object.keys(h3).forEach(function (k) {

package/dist/index.d.cts

@@ -1,8 +1,9 @@
-import { HttpMethod, RpcHttpMethod, HttpRpcDefinition, SchemaFormProperties, SchemaFormDiscriminator, SchemaFormValues, AppDefinition, ClientGenerator } from 'arri-codegen-utils';
-import { AObjectSchema, a, ValidationError, ASchema, InferType, ValueError, ADiscriminatorSchema } from 'arri-validate';
+import { HttpMethod, WsRpcDefinition, RpcHttpMethod, HttpRpcDefinition, SchemaFormProperties, SchemaFormDiscriminator, SchemaFormValues, AppDefinition, ClientGenerator } from 'arri-codegen-utils';
+import { AObjectSchema, a, ValidationError, ASchema, InferType, ValueError, CompiledValidator, ADiscriminatorSchema } from 'arri-validate';
 import { H3Error, H3Event, H3EventContext, Router, App } from 'h3';
 export * from 'h3';
 import { EventStream } from 'h3-sse';
+import { Peer, WSError } from 'crossws';
 import { BuildOptions } from 'esbuild';
 
 declare class ArriServerError extends Error {
@@ -67,7 +68,7 @@ type RouteOptions = Pick<ArriOptions, "onAfterResponse" | "onBeforeResponse" | "
 declare function registerRoute(router: Router, route: ArriRoute<any>, opts: RouteOptions): void;
 declare function handleRoute(router: Router, method: HttpMethod, route: ArriRoute<any>, opts: RouteOptions): void;
 
-declare function defineEventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<EventStreamRpc<TParams, TResponse>, "isEventStream">): EventStreamRpc<TParams, TResponse>;
+declare function defineEventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<EventStreamRpc<TParams, TResponse>, "isEventStream" | "transport">): EventStreamRpc<TParams, TResponse>;
 declare function isEventStreamRpc(input: unknown): input is EventStreamRpc<any, any>;
 interface EventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends Omit<Rpc<true, TParams, TResponse>, "handler" | "postHandler"> {
     isEventStream: true;
@@ -116,12 +117,62 @@ declare function registerEventStreamRpc(router: Router, path: string, procedure:
     name: string;
 }, opts: RouteOptions): void;
 
+interface NamedWebsocketRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends WebsocketRpc<TParams, TResponse> {
+    name: string;
+}
+interface WebsocketRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> {
+    transport: "ws";
+    description?: string;
+    path?: string;
+    isDeprecated?: boolean;
+    params: TParams;
+    response: TResponse;
+    pingInterval?: boolean;
+    handler: WebSocketRpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined>;
+}
+interface WsPeerOpts<TResponse> {
+    validator?: CompiledValidator<ASchema<TResponse>>;
+    context: WsPeerContext;
+}
+interface WsPeerContext extends Record<string, any> {
+    rpcName: string;
+    queryParams?: Record<string, string>;
+    clientAddress?: string;
+}
+declare class WsPeer<TResponse> {
+    private readonly _peer;
+    private readonly _validator?;
+    context: WsPeerContext;
+    url: string;
+    constructor(peer: Peer, opts: WsPeerOpts<TResponse>);
+    send(data: TResponse): number | undefined;
+    sendError(err: ArriServerErrorResponse): number;
+    close(): void;
+    subscribe(channel: string): void;
+    unsubscribe(channel: string): void;
+    publish(channel: string, message: TResponse): void;
+    readyState(): (0 | 1 | 2 | 3) | -1;
+}
+interface WebSocketRpcHandler<TParams, TResponse> {
+    onOpen: (peer: WsPeer<TResponse>) => void;
+    onMessage: (peer: WsPeer<TResponse>, message: TParams) => void;
+    onClose: (peer: WsPeer<TResponse>, details: {
+        code?: number;
+        reason?: string;
+    }) => void;
+    onError: (peer: WsPeer<TResponse>, error: WSError) => void;
+}
+declare function defineWebsocketRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(def: Omit<WebsocketRpc<TParams, TResponse>, "transport">): WebsocketRpc<TParams, TResponse>;
+declare function registerWebsocketRpc(router: Router, path: string, rpc: NamedWebsocketRpc<any, any>): void;
+declare function createWsRpcDefinition(rpcName: string, path: string, rpc: NamedWebsocketRpc<any, any>): WsRpcDefinition;
+
 type RpcParamSchema<TObjectInner = any, TDiscriminatorInner = any> = AObjectSchema<TObjectInner> | ADiscriminatorSchema<TDiscriminatorInner>;
 declare function isRpcParamSchema(input: unknown): input is RpcParamSchema;
 interface NamedRpc<TIsEventStream extends boolean = false, TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends Rpc<TIsEventStream, TParams, TResponse> {
     name: string;
 }
 interface Rpc<TIsEventStream extends boolean = false, TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> {
+    transport: "http";
     method?: RpcHttpMethod;
     path?: string;
     description?: string;
@@ -151,16 +202,17 @@ interface RpcPostEvent<TParams = undefined, TResponse = undefined> extends Omit<
 type RpcHandler<TParams, TResponse> = (context: RpcHandlerContext<TParams>, event: RpcEvent<TParams>) => TResponse | Promise<TResponse>;
 type RpcPostHandler<TParams, TResponse> = (context: RpcPostHandlerContext<TParams, TResponse>, event: RpcPostEvent<TParams, TResponse>) => any;
 declare function isRpc(input: unknown): input is Rpc<any, any>;
-declare function defineRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: HttpRpc<TParams, TResponse>): Rpc<false, TParams, TResponse>;
+declare function defineRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<HttpRpc<TParams, TResponse>, "transport">): Rpc<false, TParams, TResponse>;
 declare function createHttpRpcDefinition(rpcName: string, httpPath: string, procedure: Rpc<any, any, any>): HttpRpcDefinition;
 declare function getRpcPath(rpcName: string, prefix?: string): string;
-declare function getRpcParamName(rpcName: string, procedure: Rpc<any, any, any>): string | undefined;
-declare function getRpcResponseName(rpcName: string, procedure: Rpc<any, any, any>): string | undefined;
+declare function getRpcParamName(rpcName: string, procedure: Rpc<any, any, any> | WebsocketRpc<any, any>): string | undefined;
+declare function getRpcResponseName(rpcName: string, procedure: Rpc<any, any, any> | WebsocketRpc<any, any>): string | undefined;
 declare function registerRpc(router: Router, path: string, procedure: NamedRpc<any, any, any>, opts: RouteOptions): void;
 declare function validateRpcRequestInput(event: H3Event, httpMethod: RpcHttpMethod, schema: ASchema): Promise<void>;
 
 interface ArriRouterBase {
-    rpc: <TIsEventStream extends boolean, TParams extends AObjectSchema<any, any> | undefined, TResponse extends AObjectSchema<any, any> | undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>) => void;
+    rpc: <TIsEventStream extends boolean, TParams extends AObjectSchema<any, any> | undefined, TResponse extends AObjectSchema<any, any> | undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">) => void;
+    wsRpc: <TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">) => void;
     route: <TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>) => void;
     registerModels: (models: ModelMap) => void;
 }
@@ -168,10 +220,11 @@ declare class ArriRouter implements ArriRouterBase {
     private readonly procedures;
     private readonly routes;
     private readonly models;
-    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;
+    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">): void;
+    wsRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">): void;
     route<TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): void;
     registerModels(models: ModelMap): void;
-    getProcedures(): NamedRpc<any, any, any>[];
+    getProcedures(): (NamedWebsocketRpc<any, any> | NamedRpc<any, any, any>)[];
     getRoutes(): ArriRoute<any, any, any, any>[];
     getModels(): ModelMap;
 }
@@ -195,9 +248,11 @@ declare class ArriApp implements ArriRouterBase {
     private readonly _onBeforeResponse;
     private readonly _onError;
     private readonly _debug;
+    readonly definitionPath: string;
     constructor(opts?: ArriOptions);
     use(input: Middleware | ArriRouter): void;
-    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;
+    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">): void;
+    wsRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">): void;
     route<TPath extends string, TQuery extends AObjectSchema<any, any>, TBody extends ASchema<any>, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): void;
     registerModels(models: ModelMap): void;
     getAppDefinition(): AppDefinition;
@@ -247,4 +302,4 @@ type ResolvedArriConfig = Required<ArriConfig>;
 declare const defaultConfig: Required<ArriConfig>;
 declare function defineConfig(config: ArriConfig): ResolvedArriConfig;
 
-export { ArriApp, type ArriConfig, type ArriOptions, type ArriRoute, ArriRouter, type ArriRouterBase, ArriServerError, ArriServerErrorResponse, DEV_DEFINITION_ENDPOINT, DEV_ENDPOINT_ROOT, EventStreamConnection, type EventStreamConnectionOptions, type EventStreamRpc, type EventStreamRpcHandler, type EventStreamRpcHandlerContext, type ExtractParam, type ExtractParams, type HandlerContext, type HttpRpc, type Middleware, type MiddlewareEvent, type MiddlewareEventContext, type ModelMap, type NamedRpc, type PostRouteEvent, type PostRouteEventContext, type ResolvedArriConfig, type RouteEvent, type RouteEventContext, type RouteOptions, type Rpc, type RpcEvent, type RpcHandler, type RpcHandlerContext, type RpcParamSchema, type RpcPostEvent, type RpcPostHandler, type RpcPostHandlerContext, type StatusCode, createAppDefinition, createHttpRpcDefinition, defaultConfig, defineConfig, defineError, defineEventStreamRpc, defineMiddleware, defineRoute, defineRpc, errorResponseFromValidationErrors, getRpcParamName, getRpcPath, getRpcResponseName, handleH3Error, handleRoute, isArriConfig, isEventStreamRpc, isResolvedArriConfig, isRpc, isRpcParamSchema, registerEventStreamRpc, registerRoute, registerRpc, validateRpcRequestInput };
+export { ArriApp, type ArriConfig, type ArriOptions, type ArriRoute, ArriRouter, type ArriRouterBase, ArriServerError, ArriServerErrorResponse, DEV_DEFINITION_ENDPOINT, DEV_ENDPOINT_ROOT, EventStreamConnection, type EventStreamConnectionOptions, type EventStreamRpc, type EventStreamRpcHandler, type EventStreamRpcHandlerContext, type ExtractParam, type ExtractParams, type HandlerContext, type HttpRpc, type Middleware, type MiddlewareEvent, type MiddlewareEventContext, type ModelMap, type NamedRpc, type NamedWebsocketRpc, type PostRouteEvent, type PostRouteEventContext, type ResolvedArriConfig, type RouteEvent, type RouteEventContext, type RouteOptions, type Rpc, type RpcEvent, type RpcHandler, type RpcHandlerContext, type RpcParamSchema, type RpcPostEvent, type RpcPostHandler, type RpcPostHandlerContext, type StatusCode, type WebSocketRpcHandler, type WebsocketRpc, WsPeer, type WsPeerContext, createAppDefinition, createHttpRpcDefinition, createWsRpcDefinition, defaultConfig, defineConfig, defineError, defineEventStreamRpc, defineMiddleware, defineRoute, defineRpc, defineWebsocketRpc, errorResponseFromValidationErrors, getRpcParamName, getRpcPath, getRpcResponseName, handleH3Error, handleRoute, isArriConfig, isEventStreamRpc, isResolvedArriConfig, isRpc, isRpcParamSchema, registerEventStreamRpc, registerRoute, registerRpc, registerWebsocketRpc, validateRpcRequestInput };

package/dist/index.d.mts

@@ -1,8 +1,9 @@
-import { HttpMethod, RpcHttpMethod, HttpRpcDefinition, SchemaFormProperties, SchemaFormDiscriminator, SchemaFormValues, AppDefinition, ClientGenerator } from 'arri-codegen-utils';
-import { AObjectSchema, a, ValidationError, ASchema, InferType, ValueError, ADiscriminatorSchema } from 'arri-validate';
+import { HttpMethod, WsRpcDefinition, RpcHttpMethod, HttpRpcDefinition, SchemaFormProperties, SchemaFormDiscriminator, SchemaFormValues, AppDefinition, ClientGenerator } from 'arri-codegen-utils';
+import { AObjectSchema, a, ValidationError, ASchema, InferType, ValueError, CompiledValidator, ADiscriminatorSchema } from 'arri-validate';
 import { H3Error, H3Event, H3EventContext, Router, App } from 'h3';
 export * from 'h3';
 import { EventStream } from 'h3-sse';
+import { Peer, WSError } from 'crossws';
 import { BuildOptions } from 'esbuild';
 
 declare class ArriServerError extends Error {
@@ -67,7 +68,7 @@ type RouteOptions = Pick<ArriOptions, "onAfterResponse" | "onBeforeResponse" | "
 declare function registerRoute(router: Router, route: ArriRoute<any>, opts: RouteOptions): void;
 declare function handleRoute(router: Router, method: HttpMethod, route: ArriRoute<any>, opts: RouteOptions): void;
 
-declare function defineEventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<EventStreamRpc<TParams, TResponse>, "isEventStream">): EventStreamRpc<TParams, TResponse>;
+declare function defineEventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<EventStreamRpc<TParams, TResponse>, "isEventStream" | "transport">): EventStreamRpc<TParams, TResponse>;
 declare function isEventStreamRpc(input: unknown): input is EventStreamRpc<any, any>;
 interface EventStreamRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends Omit<Rpc<true, TParams, TResponse>, "handler" | "postHandler"> {
     isEventStream: true;
@@ -116,12 +117,62 @@ declare function registerEventStreamRpc(router: Router, path: string, procedure:
     name: string;
 }, opts: RouteOptions): void;
 
+interface NamedWebsocketRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends WebsocketRpc<TParams, TResponse> {
+    name: string;
+}
+interface WebsocketRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> {
+    transport: "ws";
+    description?: string;
+    path?: string;
+    isDeprecated?: boolean;
+    params: TParams;
+    response: TResponse;
+    pingInterval?: boolean;
+    handler: WebSocketRpcHandler<TParams extends RpcParamSchema ? InferType<TParams> : undefined, TResponse extends RpcParamSchema ? InferType<TResponse> : undefined>;
+}
+interface WsPeerOpts<TResponse> {
+    validator?: CompiledValidator<ASchema<TResponse>>;
+    context: WsPeerContext;
+}
+interface WsPeerContext extends Record<string, any> {
+    rpcName: string;
+    queryParams?: Record<string, string>;
+    clientAddress?: string;
+}
+declare class WsPeer<TResponse> {
+    private readonly _peer;
+    private readonly _validator?;
+    context: WsPeerContext;
+    url: string;
+    constructor(peer: Peer, opts: WsPeerOpts<TResponse>);
+    send(data: TResponse): number | undefined;
+    sendError(err: ArriServerErrorResponse): number;
+    close(): void;
+    subscribe(channel: string): void;
+    unsubscribe(channel: string): void;
+    publish(channel: string, message: TResponse): void;
+    readyState(): (0 | 1 | 2 | 3) | -1;
+}
+interface WebSocketRpcHandler<TParams, TResponse> {
+    onOpen: (peer: WsPeer<TResponse>) => void;
+    onMessage: (peer: WsPeer<TResponse>, message: TParams) => void;
+    onClose: (peer: WsPeer<TResponse>, details: {
+        code?: number;
+        reason?: string;
+    }) => void;
+    onError: (peer: WsPeer<TResponse>, error: WSError) => void;
+}
+declare function defineWebsocketRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(def: Omit<WebsocketRpc<TParams, TResponse>, "transport">): WebsocketRpc<TParams, TResponse>;
+declare function registerWebsocketRpc(router: Router, path: string, rpc: NamedWebsocketRpc<any, any>): void;
+declare function createWsRpcDefinition(rpcName: string, path: string, rpc: NamedWebsocketRpc<any, any>): WsRpcDefinition;
+
 type RpcParamSchema<TObjectInner = any, TDiscriminatorInner = any> = AObjectSchema<TObjectInner> | ADiscriminatorSchema<TDiscriminatorInner>;
 declare function isRpcParamSchema(input: unknown): input is RpcParamSchema;
 interface NamedRpc<TIsEventStream extends boolean = false, TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> extends Rpc<TIsEventStream, TParams, TResponse> {
     name: string;
 }
 interface Rpc<TIsEventStream extends boolean = false, TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined = undefined> {
+    transport: "http";
     method?: RpcHttpMethod;
     path?: string;
     description?: string;
@@ -151,16 +202,17 @@ interface RpcPostEvent<TParams = undefined, TResponse = undefined> extends Omit<
 type RpcHandler<TParams, TResponse> = (context: RpcHandlerContext<TParams>, event: RpcEvent<TParams>) => TResponse | Promise<TResponse>;
 type RpcPostHandler<TParams, TResponse> = (context: RpcPostHandlerContext<TParams, TResponse>, event: RpcPostEvent<TParams, TResponse>) => any;
 declare function isRpc(input: unknown): input is Rpc<any, any>;
-declare function defineRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: HttpRpc<TParams, TResponse>): Rpc<false, TParams, TResponse>;
+declare function defineRpc<TParams extends RpcParamSchema | undefined = undefined, TResponse extends RpcParamSchema | undefined | never = undefined>(config: Omit<HttpRpc<TParams, TResponse>, "transport">): Rpc<false, TParams, TResponse>;
 declare function createHttpRpcDefinition(rpcName: string, httpPath: string, procedure: Rpc<any, any, any>): HttpRpcDefinition;
 declare function getRpcPath(rpcName: string, prefix?: string): string;
-declare function getRpcParamName(rpcName: string, procedure: Rpc<any, any, any>): string | undefined;
-declare function getRpcResponseName(rpcName: string, procedure: Rpc<any, any, any>): string | undefined;
+declare function getRpcParamName(rpcName: string, procedure: Rpc<any, any, any> | WebsocketRpc<any, any>): string | undefined;
+declare function getRpcResponseName(rpcName: string, procedure: Rpc<any, any, any> | WebsocketRpc<any, any>): string | undefined;
 declare function registerRpc(router: Router, path: string, procedure: NamedRpc<any, any, any>, opts: RouteOptions): void;
 declare function validateRpcRequestInput(event: H3Event, httpMethod: RpcHttpMethod, schema: ASchema): Promise<void>;
 
 interface ArriRouterBase {
-    rpc: <TIsEventStream extends boolean, TParams extends AObjectSchema<any, any> | undefined, TResponse extends AObjectSchema<any, any> | undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>) => void;
+    rpc: <TIsEventStream extends boolean, TParams extends AObjectSchema<any, any> | undefined, TResponse extends AObjectSchema<any, any> | undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">) => void;
+    wsRpc: <TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">) => void;
     route: <TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>) => void;
     registerModels: (models: ModelMap) => void;
 }
@@ -168,10 +220,11 @@ declare class ArriRouter implements ArriRouterBase {
     private readonly procedures;
     private readonly routes;
     private readonly models;
-    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;
+    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">): void;
+    wsRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">): void;
     route<TPath extends string, TQuery extends AObjectSchema<any, any> = any, TBody extends ASchema<any> = any, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): void;
     registerModels(models: ModelMap): void;
-    getProcedures(): NamedRpc<any, any, any>[];
+    getProcedures(): (NamedWebsocketRpc<any, any> | NamedRpc<any, any, any>)[];
     getRoutes(): ArriRoute<any, any, any, any>[];
     getModels(): ModelMap;
 }
@@ -195,9 +248,11 @@ declare class ArriApp implements ArriRouterBase {
     private readonly _onBeforeResponse;
     private readonly _onError;
     private readonly _debug;
+    readonly definitionPath: string;
     constructor(opts?: ArriOptions);
     use(input: Middleware | ArriRouter): void;
-    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: NamedRpc<TIsEventStream, TParams, TResponse>): void;
+    rpc<TIsEventStream extends boolean = false, TParams extends AObjectSchema<any, any> | undefined = undefined, TResponse extends AObjectSchema<any, any> | undefined = undefined>(procedure: Omit<NamedRpc<TIsEventStream, TParams, TResponse>, "transport">): void;
+    wsRpc<TParams extends RpcParamSchema | undefined, TResponse extends RpcParamSchema | undefined>(procedure: Omit<NamedWebsocketRpc<TParams, TResponse>, "transport">): void;
     route<TPath extends string, TQuery extends AObjectSchema<any, any>, TBody extends ASchema<any>, TResponse = any>(route: ArriRoute<TPath, TQuery, TBody, TResponse>): void;
     registerModels(models: ModelMap): void;
     getAppDefinition(): AppDefinition;
@@ -247,4 +302,4 @@ type ResolvedArriConfig = Required<ArriConfig>;
 declare const defaultConfig: Required<ArriConfig>;
 declare function defineConfig(config: ArriConfig): ResolvedArriConfig;
 
-export { ArriApp, type ArriConfig, type ArriOptions, type ArriRoute, ArriRouter, type ArriRouterBase, ArriServerError, ArriServerErrorResponse, DEV_DEFINITION_ENDPOINT, DEV_ENDPOINT_ROOT, EventStreamConnection, type EventStreamConnectionOptions, type EventStreamRpc, type EventStreamRpcHandler, type EventStreamRpcHandlerContext, type ExtractParam, type ExtractParams, type HandlerContext, type HttpRpc, type Middleware, type MiddlewareEvent, type MiddlewareEventContext, type ModelMap, type NamedRpc, type PostRouteEvent, type PostRouteEventContext, type ResolvedArriConfig, type RouteEvent, type RouteEventContext, type RouteOptions, type Rpc, type RpcEvent, type RpcHandler, type RpcHandlerContext, type RpcParamSchema, type RpcPostEvent, type RpcPostHandler, type RpcPostHandlerContext, type StatusCode, createAppDefinition, createHttpRpcDefinition, defaultConfig, defineConfig, defineError, defineEventStreamRpc, defineMiddleware, defineRoute, defineRpc, errorResponseFromValidationErrors, getRpcParamName, getRpcPath, getRpcResponseName, handleH3Error, handleRoute, isArriConfig, isEventStreamRpc, isResolvedArriConfig, isRpc, isRpcParamSchema, registerEventStreamRpc, registerRoute, registerRpc, validateRpcRequestInput };
+export { ArriApp, type ArriConfig, type ArriOptions, type ArriRoute, ArriRouter, type ArriRouterBase, ArriServerError, ArriServerErrorResponse, DEV_DEFINITION_ENDPOINT, DEV_ENDPOINT_ROOT, EventStreamConnection, type EventStreamConnectionOptions, type EventStreamRpc, type EventStreamRpcHandler, type EventStreamRpcHandlerContext, type ExtractParam, type ExtractParams, type HandlerContext, type HttpRpc, type Middleware, type MiddlewareEvent, type MiddlewareEventContext, type ModelMap, type NamedRpc, type NamedWebsocketRpc, type PostRouteEvent, type PostRouteEventContext, type ResolvedArriConfig, type RouteEvent, type RouteEventContext, type RouteOptions, type Rpc, type RpcEvent, type RpcHandler, type RpcHandlerContext, type RpcParamSchema, type RpcPostEvent, type RpcPostHandler, type RpcPostHandlerContext, type StatusCode, type WebSocketRpcHandler, type WebsocketRpc, WsPeer, type WsPeerContext, createAppDefinition, createHttpRpcDefinition, createWsRpcDefinition, defaultConfig, defineConfig, defineError, defineEventStreamRpc, defineMiddleware, defineRoute, defineRpc, defineWebsocketRpc, errorResponseFromValidationErrors, getRpcParamName, getRpcPath, getRpcResponseName, handleH3Error, handleRoute, isArriConfig, isEventStreamRpc, isResolvedArriConfig, isRpc, isRpcParamSchema, registerEventStreamRpc, registerRoute, registerRpc, registerWebsocketRpc, validateRpcRequestInput };