@colyseus/core 0.16.24 → 0.17.0

package/build/serializer/SchemaSerializerDebug.mjs

@@ -0,0 +1,7 @@
+// packages/core/src/serializer/SchemaSerializerDebug.ts
+import "fs";
+import "@colyseus/schema";
+import "./SchemaSerializer.mjs";
+import "../Transport.mjs";
+import "../Protocol.mjs";
+import "../Debug.mjs";

package/build/serializer/SchemaSerializerDebug.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
-  "sources": [],
-  "sourcesContent": [],
-  "mappings": "",
+  "sources": ["../../src/serializer/SchemaSerializerDebug.ts"],
+  "sourcesContent": ["/**\n * This serializer is a copy of SchemaSerializer,\n * but it writes debug information to a file.\n *\n * This script must be used\n */\n\nimport fs from 'fs';\nimport { Schema, dumpChanges, Iterator } from '@colyseus/schema';\nimport { SchemaSerializer } from './SchemaSerializer.ts';\nimport { Client, ClientState  } from \"../Transport.ts\";\nimport { Protocol} from '../Protocol.ts';\nimport { debugPatch } from '../Debug.ts';\n\n/*\nconst SHARED_VIEW = {};\n\nexport class SchemaSerializerDebug<T> extends SchemaSerializer<T> {\n  protected debugStream: fs.WriteStream;\n\n  constructor(fileName: string = \"schema-debug.txt\") {\n    super();\n\n    try { fs.unlinkSync(fileName); } catch (e) {}\n    this.debugStream = fs.createWriteStream(fileName, { flags: \"a\" });\n  }\n\n  public getFullState(client?: Client): Buffer {\n    const buf = super.getFullState(client);\n    this.debugStream.write(`state:${client.sessionId}:${Array.from(buf).slice(1).join(\",\")}\\n`);\n    return buf;\n  }\n\n  public applyPatches(clients: Client[]) {\n    let numClients = clients.length;\n\n    const debugChangesDeep = Schema.debugChangesDeep(this.encoder.state);\n\n    if (\n      numClients == 0 ||\n      (\n        this.encoder.root.changes.size === 0 &&\n        (!this.hasFilters || this.encoder.root.filteredChanges.size === 0)\n      )\n    ) {\n      // skip patching state if:\n      // - no clients are connected\n      // - no changes were made\n      // - no \"filtered changes\" were made when using filters\n      return false;\n    }\n\n    this.needFullEncode = true;\n\n    // dump changes for patch debugging\n    if (debugPatch.enabled) {\n      (debugPatch as any).dumpChanges = dumpChanges(this.encoder.state);\n    }\n\n    // get patch bytes\n    const it: Iterator = { offset: 1 };\n    this.encoder.sharedBuffer[0] = Protocol.ROOM_STATE_PATCH;\n\n    // encode changes once, for all clients\n    const encodedChanges = this.encoder.encode(it);\n\n    if (!this.hasFilters) {\n      while (numClients--) {\n        const client = clients[numClients];\n\n        //\n        // FIXME: avoid this check for each client\n        //\n        if (client.state !== ClientState.JOINED) {\n          continue;\n        }\n\n        debugChangesDeep.split(\"\\n\").forEach((line) => {\n          this.debugStream.write(`#${client.sessionId}:${line}\\n`);\n        });\n        this.debugStream.write(`patch:${client.sessionId}:${Array.from(encodedChanges).slice(1).join(\",\")}\\n`);\n\n        client.raw(encodedChanges);\n      }\n\n    } else {\n      // cache shared offset\n      const sharedOffset = it.offset;\n\n      // encode state multiple times, for each client\n      while (numClients--) {\n        const client = clients[numClients];\n\n        //\n        // FIXME: avoid this check for each client\n        //\n        if (client.state !== ClientState.JOINED) {\n          continue;\n        }\n\n        const view = client.view || SHARED_VIEW;\n\n        let encodedView = this.views.get(view);\n\n        // allow to pass the same encoded view for multiple clients\n        if (encodedView === undefined) {\n          encodedView = (view === SHARED_VIEW)\n            ? encodedChanges\n            : this.encoder.encodeView(client.view, sharedOffset, it);\n          this.views.set(view, encodedView);\n        }\n\n        debugChangesDeep.split(\"\\n\").forEach((line) => {\n          this.debugStream.write(`#${client.sessionId}:${line}\\n`);\n        });\n        this.debugStream.write(`patch:${client.sessionId}:${Array.from(encodedView).slice(1).join(\",\")}\\n`);\n\n        client.raw(encodedView);\n      }\n\n      // clear views\n      this.views.clear();\n    }\n\n    // discard changes after sending\n    this.encoder.discardChanges();\n\n    // debug patches\n    if (debugPatch.enabled) {\n      debugPatch(\n        '%d bytes sent to %d clients, %j',\n        encodedChanges.length,\n        clients.length,\n        (debugPatch as any).dumpChanges,\n      );\n    }\n\n    return true;\n  }\n\n  public handshake(): Buffer {\n    const buf = super.handshake();\n    this.debugStream.write(`handshake:${Array.from(buf).join(\",\")}\\n`);\n    return buf;\n  }\n}\n\n*/"],
+  "mappings": ";AAOA,OAAe;AACf,OAA8C;AAC9C,OAAiC;AACjC,OAAqC;AACrC,OAAwB;AACxB,OAA2B;",
   "names": []
 }

package/build/serializer/Serializer.js

@@ -1,3 +1,4 @@
+"use strict";
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
 var __getOwnPropNames = Object.getOwnPropertyNames;

package/build/serializer/Serializer.js.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../../src/serializer/Serializer.ts"],
-  "sourcesContent": ["import { Client } from '../Transport.js';\n\nexport interface Serializer<T> {\n  id: string;\n  reset(data: any): void;\n  getFullState(client?: Client): Buffer;\n  applyPatches(clients: Client[], state: T): boolean;\n  handshake?(): Buffer;\n}\n"],
-  "mappings": ";;;;;;;;;;;;;AAAA;AAAA;",
+  "sourcesContent": ["import type { Client } from '../Transport.ts';\n\nexport interface Serializer<T> {\n  id: string;\n  reset(data: any): void;\n  getFullState(client?: Client): Uint8Array;\n  applyPatches(clients: Client[], state: T): boolean;\n  handshake?(): Uint8Array;\n}"],
+  "mappings": ";;;;;;;;;;;;;;AAAA;AAAA;",
   "names": []
 }

package/build/{Debug.d.ts → src/Debug.d.ts}

@@ -1,9 +1,10 @@
 import debug from 'debug';
 export declare const debugConnection: debug.IDebugger;
 export declare const debugDriver: debug.IDebugger;
-export declare const debugError: debug.IDebugger;
 export declare const debugMatchMaking: debug.IDebugger;
 export declare const debugMessage: debug.IDebugger;
 export declare const debugPatch: debug.IDebugger;
 export declare const debugPresence: debug.IDebugger;
+export declare const debugError: debug.IDebugger;
+export declare const debugDevMode: debug.IDebugger;
 export declare const debugAndPrintError: (e: Error | string) => void;

package/build/{IPC.d.ts → src/IPC.d.ts}

@@ -1,5 +1,5 @@
-import { Presence } from './presence/Presence.js';
-export declare function requestFromIPC<T>(presence: Presence, publishToChannel: string, method: string, args: any[], rejectionTimeout?: number): Promise<T>;
+import { type Presence } from './presence/Presence.ts';
+export declare function requestFromIPC<T>(presence: Presence, publishToChannel: string, method: string | undefined, args: any[], rejectionTimeout?: number): Promise<T>;
 export declare function subscribeIPC(presence: Presence, channel: string, replyCallback: (method: string, args: any[]) => any): Promise<void>;
 /**
  * Wait for a room creation notification via presence publish/subscribe

package/build/{MatchMaker.d.ts → src/MatchMaker.d.ts}

@@ -1,32 +1,42 @@
-import { Deferred } from './utils/Utils.js';
-import { RegisteredHandler } from './matchmaker/RegisteredHandler.js';
-import { Room } from './Room.js';
-import { Presence } from './presence/Presence.js';
-import { IRoomCache, MatchMakerDriver, SortOptions } from './matchmaker/driver/local/LocalDriver.js';
-import controller from './matchmaker/controller.js';
-import * as stats from './Stats.js';
-import { AuthContext } from './Transport.js';
-import { Type } from './utils/types.js';
+import { type Type, Deferred, type ExtractMethodOrPropertyType } from './utils/Utils.ts';
+import { RegisteredHandler } from './matchmaker/RegisteredHandler.ts';
+import { type OnCreateOptions, Room } from './Room.ts';
+import { type Presence } from './presence/Presence.ts';
+import { type IRoomCache, type MatchMakerDriver, type SortOptions } from './matchmaker/LocalDriver/LocalDriver.ts';
+import controller from './matchmaker/controller.ts';
+import * as stats from './Stats.ts';
+import type { AuthContext } from './Transport.ts';
+import { type ExtractMetadata } from './matchmaker/driver.ts';
 export { controller, stats, type MatchMakerDriver };
 export type ClientOptions = any;
 export type SelectProcessIdCallback = (roomName: string, clientOptions: ClientOptions) => Promise<string>;
-export interface SeatReservation {
+export interface ISeatReservation {
+    name: string;
     sessionId: string;
-    room: IRoomCache;
+    roomId: string;
+    publicAddress?: string;
+    processId?: string;
+    reconnectionToken?: string;
     devMode?: boolean;
 }
 export declare let publicAddress: string;
 export declare let processId: string;
 export declare let presence: Presence;
 export declare let driver: MatchMakerDriver;
+/**
+ * Function to select the processId to create the room on.
+ * By default, returns the process with least amount of rooms created.
+ * @returns The processId to create the room on.
+ */
 export declare let selectProcessIdToCreateRoom: SelectProcessIdCallback;
 export declare function setHealthChecksEnabled(value: boolean): void;
 export declare let onReady: Deferred;
-export declare enum MatchMakerState {
-    INITIALIZING = 0,
-    READY = 1,
-    SHUTTING_DOWN = 2
-}
+export declare const MatchMakerState: {
+    readonly INITIALIZING: 0;
+    readonly READY: 1;
+    readonly SHUTTING_DOWN: 2;
+};
+export type MatchMakerState = (typeof MatchMakerState)[keyof typeof MatchMakerState];
 /**
  * Internal MatchMaker state
  */
@@ -44,22 +54,19 @@ export declare function accept(): Promise<void>;
 /**
  * Join or create into a room and return seat reservation
  */
-export declare function joinOrCreate(roomName: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<SeatReservation>;
+export declare function joinOrCreate(roomName: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<ISeatReservation>;
 /**
  * Create a room and return seat reservation
  */
-export declare function create(roomName: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<SeatReservation>;
+export declare function create(roomName: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<ISeatReservation>;
 /**
  * Join a room and return seat reservation
  */
-export declare function join(roomName: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<SeatReservation>;
+export declare function join(roomName: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<ISeatReservation>;
 /**
  * Join a room by id and return seat reservation
  */
-export declare function reconnect(roomId: string, clientOptions?: ClientOptions): Promise<{
-    room: import("./matchmaker/driver/api.js").RoomCache<any>;
-    sessionId: any;
-}>;
+export declare function reconnect(roomId: string, clientOptions?: ClientOptions): Promise<ISeatReservation>;
 /**
  * Join a room by id and return client seat reservation. An exception is thrown if a room is not found for roomId.
  *
@@ -69,11 +76,11 @@ export declare function reconnect(roomId: string, clientOptions?: ClientOptions)
  *
  * @returns Promise<SeatReservation> - A promise which contains `sessionId` and `IRoomCache`.
  */
-export declare function joinById(roomId: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<SeatReservation>;
+export declare function joinById(roomId: string, clientOptions?: ClientOptions, authContext?: AuthContext): Promise<ISeatReservation>;
 /**
  * Perform a query for all cached rooms
  */
-export declare function query(conditions?: Partial<IRoomCache>, sortOptions?: SortOptions): Promise<IRoomCache[]>;
+export declare function query<T extends Room = any>(conditions?: Partial<IRoomCache & ExtractMetadata<T>>, sortOptions?: SortOptions): Promise<IRoomCache<ExtractMetadata<T>>[]>;
 /**
  * Find for a public and unlocked room available.
  *
@@ -83,7 +90,7 @@ export declare function query(conditions?: Partial<IRoomCache>, sortOptions?: So
  *
  * @returns Promise<IRoomCache> - A promise contaning an object which includes room metadata and configurations.
  */
-export declare function findOneRoomAvailable(roomName: string, filterOptions: ClientOptions, additionalSortOptions?: SortOptions): Promise<import("./matchmaker/driver/api.js").RoomCache<any>>;
+export declare function findOneRoomAvailable(roomName: string, filterOptions: ClientOptions, additionalSortOptions?: SortOptions): Promise<IRoomCache<any>>;
 /**
  * Call a method or return a property on a remote room.
  *
@@ -93,11 +100,14 @@ export declare function findOneRoomAvailable(roomName: string, filterOptions: Cl
  *
  * @returns Promise<any> - Returned value from the called or retrieved method/attribute.
  */
-export declare function remoteRoomCall<R = any>(roomId: string, method: string, args?: any[], rejectionTimeout?: number): Promise<R>;
-export declare function defineRoomType<T extends Type<Room>>(roomName: string, klass: T, defaultOptions?: Parameters<NonNullable<InstanceType<T>['onCreate']>>[0]): RegisteredHandler;
+export declare function remoteRoomCall<TRoom = Room>(roomId: string, method: keyof TRoom, args?: any[], rejectionTimeout?: number): Promise<ExtractMethodOrPropertyType<TRoom, typeof method>>;
+export declare function defineRoomType<T extends Type<Room>>(roomName: string, klass: T, defaultOptions?: OnCreateOptions<T>): RegisteredHandler<T>;
+export declare function addRoomType(handler: RegisteredHandler): void;
 export declare function removeRoomType(roomName: string): void;
-export declare function hasHandler(roomName: string): boolean;
-export declare function getHandler(roomName: string): RegisteredHandler;
+export declare function getAllHandlers(): {
+    [id: string]: RegisteredHandler<any>;
+};
+export declare function getHandler(roomName: string): RegisteredHandler<any>;
 export declare function getRoomClass(roomName: string): Type<Room>;
 /**
  * Creates a new room.
@@ -113,11 +123,11 @@ export declare function handleCreateRoom(roomName: string, clientOptions: Client
  * Get room data by roomId.
  * This method does not return the actual room instance, use `getLocalRoomById` for that.
  */
-export declare function getRoomById(roomId: string): Promise<import("./matchmaker/driver/api.js").RoomCache<any>>;
+export declare function getRoomById(roomId: string): Promise<IRoomCache<any>>;
 /**
  * Get local room instance by roomId. (Can return "undefined" if the room is not available on this process)
  */
-export declare function getLocalRoomById(roomId: string): Room<any, any, any, any>;
+export declare function getLocalRoomById(roomId: string): Room<import("./Room.ts").RoomOptions>;
 /**
  * Disconnects every client on every room in the current process.
  */
@@ -126,7 +136,22 @@ export declare function gracefullyShutdown(): Promise<any>;
 /**
  * Reserve a seat for a client in a room
  */
-export declare function reserveSeatFor(room: IRoomCache, options: ClientOptions, authData?: any): Promise<SeatReservation>;
+export declare function reserveSeatFor(room: IRoomCache, options: ClientOptions, authData?: any): Promise<ISeatReservation>;
+/**
+ * Reserve multiple seats for clients in a room
+ */
+export declare function reserveMultipleSeatsFor(room: IRoomCache, clientsData: Array<{
+    sessionId: string;
+    options: ClientOptions;
+    auth: any;
+}>): Promise<boolean[]>;
+/**
+ * Build a seat reservation object.
+ * @param room - The room to build a seat reservation for.
+ * @param sessionId - The session ID of the client.
+ * @returns A seat reservation object.
+ */
+export declare function buildSeatReservation(room: IRoomCache, sessionId: string): ISeatReservation;
 /**
  * Perform health check on all processes
  */

package/build/src/Protocol.d.ts

@@ -0,0 +1,53 @@
+/**
+ * Colyseus protocol codes range between 0~100
+ */
+export declare const Protocol: {
+    readonly JOIN_ROOM: 10;
+    readonly ERROR: 11;
+    readonly LEAVE_ROOM: 12;
+    readonly ROOM_DATA: 13;
+    readonly ROOM_STATE: 14;
+    readonly ROOM_STATE_PATCH: 15;
+    readonly ROOM_DATA_BYTES: 17;
+    readonly PING: 18;
+};
+export type Protocol = typeof Protocol[keyof typeof Protocol];
+/**
+ * WebSocket close codes
+ * (See https://github.com/Luka967/websocket-close-codes)
+ */
+export declare const CloseCode: {
+    readonly NORMAL_CLOSURE: 1000;
+    readonly GOING_AWAY: 1001;
+    readonly NO_STATUS_RECEIVED: 1005;
+    readonly ABNORMAL_CLOSURE: 1006;
+    readonly CONSENTED: 4000;
+    readonly SERVER_SHUTDOWN: 4001;
+    readonly WITH_ERROR: 4002;
+    readonly DEVMODE_RESTART: 4010;
+};
+export type CloseCode = typeof CloseCode[keyof typeof CloseCode];
+export declare const ErrorCode: {
+    readonly MATCHMAKE_NO_HANDLER: 520;
+    readonly MATCHMAKE_INVALID_CRITERIA: 521;
+    readonly MATCHMAKE_INVALID_ROOM_ID: 522;
+    readonly MATCHMAKE_UNHANDLED: 523;
+    readonly MATCHMAKE_EXPIRED: 524;
+    readonly AUTH_FAILED: 525;
+    readonly APPLICATION_ERROR: 526;
+    readonly INVALID_PAYLOAD: 4217;
+};
+export type ErrorCode = typeof ErrorCode[keyof typeof ErrorCode];
+export declare const IpcProtocol: {
+    readonly SUCCESS: 0;
+    readonly ERROR: 1;
+    readonly TIMEOUT: 2;
+};
+export type IpcProtocol = typeof IpcProtocol[keyof typeof IpcProtocol];
+export declare const getMessageBytes: {
+    10: (reconnectionToken: string, serializerId: string, handshake?: Uint8Array) => Buffer<ArrayBuffer>;
+    11: (code: number, message?: string) => Buffer<ArrayBuffer>;
+    14: (bytes: number[]) => number[];
+    18: () => Buffer<ArrayBuffer>;
+    raw: (code: Protocol, type: string | number, message?: any, rawMessage?: Uint8Array | Buffer) => Buffer<ArrayBuffer>;
+};