import * as http from 'http'; import * as https from 'https'; import type { Router } from '@colyseus/better-call'; import { StateView } from '@colyseus/schema'; import { EventEmitter } from 'events'; import type { Room } from './Room.ts'; export declare function setTransport(transport: Transport): void; export declare function getTransport(): Transport; export declare abstract class Transport { protocol?: string; server?: http.Server | https.Server; abstract listen(port?: number | string, hostname?: string, backlog?: number, listeningListener?: Function): this; abstract shutdown(): void; abstract simulateLatency(milliseconds: number): void; /** * Returns an Express-compatible application for HTTP route handling. * For uWebSockets transport, this uses the uwebsockets-express module. * This method is called lazily only when an express callback is provided in server options. */ getExpressApp?(): Promise | import('express').Application | undefined; /** * Binds a router to the transport. * Some transports may have a custom way to bind a router to the transport. * (uWebSocketsTransport) */ bindRouter?(router: Router): void; } export type AuthContext = { token?: string; headers: Headers; ip: string | string[]; req?: any; }; export interface ISendOptions { afterNextPatch?: boolean; } export declare const ClientState: { readonly JOINING: 0; readonly JOINED: 1; readonly RECONNECTING: 2; readonly RECONNECTED: 3; readonly LEAVING: 4; readonly CLOSED: 5; }; export type ClientState = (typeof ClientState)[keyof typeof ClientState]; type ExtractClientUserData = T extends { userData: infer U; } ? U : T; type ExtractClientAuth = T extends { auth: infer A; } ? A : any; type ExtractClientMessages = T extends { messages: infer M; } ? M : any; export type MessageArgs = unknown extends M ? [message?: M, options?: Options] : [ M ] extends [never] ? [message?: M, options?: Options] : [ M ] extends [void] ? [message?: M, options?: Options] : [ M ] extends [undefined] ? [message?: M, options?: Options] : undefined extends M ? [message?: M, options?: Options] : [ message: M, options?: Options ]; /** * The client instance from the server-side is responsible for the transport layer between the server and the client. * It should not be confused with the Client from the client-side SDK, as they have completely different purposes! * You operate on client instances from `this.clients`, `Room#onJoin()`, `Room#onLeave()` and `Room#onMessage()`. * * - This is the raw WebSocket connection coming from the `ws` package. There are more methods available which aren't * encouraged to use along with Colyseus. */ export interface Client; } = any> { '~messages': ExtractClientMessages; ref: EventEmitter; /** * @deprecated use `sessionId` instead. */ id: string; /** * Unique id per session. */ sessionId: string; /** * Connection state */ state: ClientState; /** * Optional: when using `@view()` decorator in your state properties, this will be the view instance for this client. */ view?: StateView; /** * User-defined data can be attached to the Client instance through this variable. * - Can be used to store custom data about the client's connection. userData is not synchronized with the client, * and should be used only to keep player-specific with its connection. */ userData?: ExtractClientUserData; /** * auth data provided by your `onAuth` */ auth?: ExtractClientAuth; /** * Reconnection token used to re-join the room after onLeave + allowReconnection(). * * IMPORTANT: * This is not the full reconnection token the client provides for the server. * The format provided by .reconnect() from the client-side must follow: "${roomId}:${reconnectionToken}" */ reconnectionToken: string; raw(data: Uint8Array | Buffer, options?: ISendOptions, cb?: (err?: Error) => void): void; enqueueRaw(data: Uint8Array | Buffer, options?: ISendOptions): void; /** * Send a type of message to the client. Messages are encoded with MsgPack and can hold any * JSON-serializable data structure. * * @param type String or Number identifier the client SDK will use to receive this message * @param message Message payload. (automatically encoded with msgpack.) * @param options */ send(type: K, ...args: MessageArgs): void; /** * Send raw bytes to this specific client. * * @param type String or Number identifier the client SDK will use to receive this message * @param bytes Raw byte array payload * @param options */ sendBytes(type: string | number, bytes: Buffer | Uint8Array, options?: ISendOptions): void; /** * Disconnect this client from the room. * * @param code Custom close code. Default value is 1000. * @param data * @see [Leave room](https://docs.colyseus.io/room#leave-room) */ leave(code?: number, data?: string): void; /** * @deprecated Use .leave() instead. */ close(code?: number, data?: string): void; /** * Triggers `onError` with specified code to the client-side. * * @param code * @param message */ error(code: number, message?: string): void; } /** * Private properties of the Client instance. * Only accessible internally by the framework, should not be encouraged/auto-completed for the user. * * TODO: refactor this. * @private */ export interface ClientPrivate { readyState: number; _enqueuedMessages?: any[]; _afterNextPatchQueue: Array<[string | number | Client, ArrayLike]>; _joinedAt: number; /** * Used for rate limiting via maxMessagesPerSecond. */ _numMessagesLastSecond?: number; _lastMessageTime?: number; } export declare class ClientArray extends Array { getById(sessionId: string): C | undefined; delete(client: C): boolean; } /** * Shared internal method to connect a Client into a Room. * Validates seat reservation and joins the client to the room. * * @remarks * **⚠️ This is an internal API and not intended for end-user use.** * * @internal */ export declare function connectClientToRoom(room: Room | undefined, client: Client & ClientPrivate, authContext: AuthContext, connectionOptions: { reconnectionToken?: string; skipHandshake?: boolean; }): Promise; export {};