@colyseus/shared-types 0.17.2 → 0.17.3

package/build/index.cjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "sourcesContent": ["import type { StandardSchemaV1 } from '@standard-schema/spec';\n\n// Re-export StandardSchemaV1 for convenience\nexport type { StandardSchemaV1 };\n\n// Re-export Protocol types\nexport { Protocol, ErrorCode, CloseCode } from './Protocol.js';\n\n/**\n * Minimal Room-like interface for SDK type inference.\n * Allows typing SDK methods without depending on @colyseus/core.\n */\nexport interface ServerRoomLike<State = any, Options = any> {\n  state: State;\n  onJoin: (client: any, options?: Options, auth?: any) => any;\n  messages?: Record<string, any>;\n  '~client'?: { '~messages'?: Record<string, any> };\n}\n\n/**\n * Seat reservation returned by matchmaking operations.\n */\nexport interface ISeatReservation {\n  name: string;\n  sessionId: string;\n  roomId: string;\n  publicAddress?: string;\n  processId?: string;\n  reconnectionToken?: string;\n  devMode?: boolean;\n}\n\n/**\n * Helper types for flexible Room generics on the client SDK.\n * Allows: Room<State>, Room<ServerRoom>, or Room<ServerRoom, State>\n *\n * Uses `~state` phantom property to distinguish Room types from plain state types.\n * This prevents incorrectly extracting `state` from a state type that happens to have a `state` property.\n */\nexport type InferState<T, S> = [S] extends [never]\n    ? (T extends abstract new (...args: any) => { '~state': infer ST }\n        ? ST  // Constructor type (typeof MyRoom): extract state via ~state phantom\n        : T extends { '~state': infer ST }\n            ? ST  // Instance type (MyRoom): extract state via ~state phantom\n            : T)  // State type or other: return as-is\n    : S;\n\n/**\n * Normalizes T for message extraction: returns T if it has ~state (Room type),\n * otherwise returns any (plain state type). This ensures Room<State> is equivalent\n * to Room<any, State> when State doesn't have ~state.\n */\nexport type NormalizeRoomType<T> = T extends abstract new (...args: any) => { '~state': any }\n    ? T  // Constructor type with ~state: keep as-is\n    : T extends { '~state': any }\n        ? T  // Instance type with ~state: keep as-is\n        : any;  // Plain state type: normalize to any\n\n/**\n * Extract room messages type from a Room constructor or instance type.\n * Supports both constructor types (typeof MyRoom) and instance types (MyRoom)\n */\nexport type ExtractRoomMessages<T> = T extends abstract new (...args: any) => { messages: infer M }\n    ? M\n    : T extends { messages: infer M }\n        ? M\n        : {};\n\n/**\n * Extract client-side messages type from a Room constructor or instance type.\n * These are messages that the server can send to the client.\n */\nexport type ExtractRoomClientMessages<T> = T extends abstract new (...args: any) => { '~client': { '~messages': infer M } }\n    ? M\n    : T extends { '~client': { '~messages': infer M } }\n        ? M\n        : {};\n\n/**\n * Message handler with automatic type inference from format schema.\n * When a format is provided, the message type is automatically inferred from the schema.\n *\n * @template T - The StandardSchema type for message validation\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandlerWithFormat<T extends StandardSchemaV1 = any, Client = any, This = any> = {\n  format: T;\n  handler: (this: This, client: Client, message: StandardSchemaV1.InferOutput<T>) => void;\n};\n\n/**\n * Message handler type that can be either a function or a format handler with validation.\n *\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandler<Client = any, This = any> =\n  | ((this: This, client: Client, message: any) => void)\n  | MessageHandlerWithFormat<any, Client, This>;\n\n/**\n * Extract the message payload type from a message handler.\n * Works with both function handlers and format handlers.\n */\nexport type ExtractMessageType<T> =\n  T extends { format: infer Format extends StandardSchemaV1; handler: any }\n    ? StandardSchemaV1.InferOutput<Format>\n    : T extends (this: any, client: any, message: infer Message) => void\n      ? Message\n      : any;\n\n/**\n * A map of message types to message handlers.\n *\n * @template Room - The Room class type\n * @template Client - The client type\n */\nexport type Messages<Room = any, Client = any> = Record<string, MessageHandler<Client, Room>>;\n\n/**\n * Exposed types for the client-side SDK.\n * Used by defineServer() to expose room and route types to the client.\n *\n * @template RoomTypes - Record of room names to their RegisteredHandler types\n * @template Routes - Router type from @colyseus/better-call\n */\nexport interface SDKTypes<\n  RoomTypes extends Record<string, any> = any,\n  Routes = any\n> {\n  '~rooms': RoomTypes;\n  '~routes': Routes;\n}\n"],
+  "sourcesContent": ["import type { StandardSchemaV1 } from '@standard-schema/spec';\n\n// Re-export StandardSchemaV1 for convenience\nexport type { StandardSchemaV1 };\n\n// Re-export Protocol types\nexport { Protocol, ErrorCode, CloseCode } from './Protocol.js';\n\n/**\n * Minimal Room-like interface for SDK type inference.\n * Allows typing SDK methods without depending on @colyseus/core.\n * Note: onJoin is optional because core Room defines it as optional.\n */\nexport interface ServerRoomLike<State = any, Options = any> {\n  state: State;\n  onJoin?: (client: any, options?: Options, auth?: any) => any;\n  messages?: Record<string, any>;\n  '~client'?: { '~messages'?: Record<string, any> };\n}\n\n/**\n * Seat reservation returned by matchmaking operations.\n */\nexport interface ISeatReservation {\n  name: string;\n  sessionId: string;\n  roomId: string;\n  publicAddress?: string;\n  processId?: string;\n  reconnectionToken?: string;\n  devMode?: boolean;\n}\n\n/**\n * Extract instance type from a constructor type.\n * If T is not a constructor, returns T as-is.\n */\ntype Instantiate<T> = T extends abstract new (...args: any) => infer I ? I : T;\n\n/**\n * Check if a type is a Schema (has ~refId marker).\n * Schema defines ~refId as optional, so we check keyof instead of property presence.\n */\ntype IsSchema<T> = '~refId' extends keyof T ? true : false;\n\n/**\n * Check if ~state phantom property contains a useful type (not object/any/never).\n * Returns true if ~state exists and has meaningful structure.\n */\ntype HasUsefulStatePhantom<T> = T extends { '~state': infer S }\n    ? [S] extends [never] ? false           // never is not useful\n    : unknown extends S ? false             // any is not useful\n    : S extends object\n        ? [keyof S] extends [never] ? false // {} or object with no keys is not useful\n        : true\n        : false\n    : false;\n\n/**\n * Extract state from a Room-like instance type.\n * Priority: useful ~state phantom > Schema state property > return T as-is\n */\ntype ExtractStateFromRoom<T> = T extends { '~state': infer S }\n    ? HasUsefulStatePhantom<T> extends true\n        ? S  // Use ~state if it's useful\n        : T extends { state: infer St }\n            ? IsSchema<St> extends true ? St : T  // Fallback to state if Schema\n            : T\n    : T extends { state: infer S }\n        ? IsSchema<S> extends true ? S : T\n        : T;\n\n/**\n * Infer the state type from T, or use explicit S if provided.\n *\n * Supports multiple usage patterns:\n * - Room<MyState>: T is a Schema type, return as-is\n * - Room<MyRoom>: T is a Room instance, extract from ~state or state property\n * - Room<typeof MyRoom>: T is a constructor, instantiate first then extract\n * - Room<T, ExplicitState>: S overrides all inference\n */\nexport type InferState<T, S> = [S] extends [never]\n    ? Instantiate<T> extends infer I\n        ? IsSchema<I> extends true\n            ? I  // It's a Schema, return as-is\n            : ExtractStateFromRoom<I>\n        : never\n    : S;\n\n/**\n * Normalizes T for message extraction: returns T if it has ~state (Room type),\n * otherwise returns any (plain state type). This ensures Room<State> is equivalent\n * to Room<any, State> when State doesn't have ~state.\n */\nexport type NormalizeRoomType<T> = Instantiate<T> extends { '~state': any } ? T : any;\n\n/**\n * Extract room messages type from a Room constructor or instance type.\n * Supports both constructor types (typeof MyRoom) and instance types (MyRoom)\n */\nexport type ExtractRoomMessages<T> = Instantiate<T> extends { messages: infer M } ? M : {};\n\n/**\n * Extract client-side messages type from a Room constructor or instance type.\n * These are messages that the server can send to the client.\n */\nexport type ExtractRoomClientMessages<T> = Instantiate<T> extends { '~client': { '~messages': infer M } } ? M : {};\n\n/**\n * Message handler with automatic type inference from format schema.\n * When a format is provided, the message type is automatically inferred from the schema.\n *\n * @template T - The StandardSchema type for message validation\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandlerWithFormat<T extends StandardSchemaV1 = any, Client = any, This = any> = {\n  format: T;\n  handler: (this: This, client: Client, message: StandardSchemaV1.InferOutput<T>) => void;\n};\n\n/**\n * Message handler type that can be either a function or a format handler with validation.\n *\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandler<Client = any, This = any> =\n  | ((this: This, client: Client, message: any) => void)\n  | MessageHandlerWithFormat<any, Client, This>;\n\n/**\n * Extract the message payload type from a message handler.\n * Works with both function handlers and format handlers.\n */\nexport type ExtractMessageType<T> =\n  T extends { format: infer Format extends StandardSchemaV1; handler: any }\n    ? StandardSchemaV1.InferOutput<Format>\n    : T extends (this: any, client: any, message: infer Message) => void\n      ? Message\n      : any;\n\n/**\n * A map of message types to message handlers.\n *\n * @template Room - The Room class type\n * @template Client - The client type\n */\nexport type Messages<Room = any, Client = any> = Record<string, MessageHandler<Client, Room>>;\n\n/**\n * Exposed types for the client-side SDK.\n * Used by defineServer() to expose room and route types to the client.\n *\n * @template RoomTypes - Record of room names to their RegisteredHandler types\n * @template Routes - Router type from @colyseus/better-call\n */\nexport interface SDKTypes<\n  RoomTypes extends Record<string, any> = any,\n  Routes = any\n> {\n  '~rooms': RoomTypes;\n  '~routes': Routes;\n}\n"],
   "mappings": ";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAMA,sBAA+C;",
   "names": []
 }

package/build/index.d.ts

@@ -4,10 +4,11 @@ export { Protocol, ErrorCode, CloseCode } from './Protocol.js';
 /**
  * Minimal Room-like interface for SDK type inference.
  * Allows typing SDK methods without depending on @colyseus/core.
+ * Note: onJoin is optional because core Room defines it as optional.
  */
 export interface ServerRoomLike<State = any, Options = any> {
     state: State;
-    onJoin: (client: any, options?: Options, auth?: any) => any;
+    onJoin?: (client: any, options?: Options, auth?: any) => any;
     messages?: Record<string, any>;
     '~client'?: {
         '~messages'?: Record<string, any>;
@@ -26,45 +27,63 @@ export interface ISeatReservation {
     devMode?: boolean;
 }
 /**
- * Helper types for flexible Room generics on the client SDK.
- * Allows: Room<State>, Room<ServerRoom>, or Room<ServerRoom, State>
+ * Extract instance type from a constructor type.
+ * If T is not a constructor, returns T as-is.
+ */
+type Instantiate<T> = T extends abstract new (...args: any) => infer I ? I : T;
+/**
+ * Check if a type is a Schema (has ~refId marker).
+ * Schema defines ~refId as optional, so we check keyof instead of property presence.
+ */
+type IsSchema<T> = '~refId' extends keyof T ? true : false;
+/**
+ * Check if ~state phantom property contains a useful type (not object/any/never).
+ * Returns true if ~state exists and has meaningful structure.
+ */
+type HasUsefulStatePhantom<T> = T extends {
+    '~state': infer S;
+} ? [S] extends [never] ? false : unknown extends S ? false : S extends object ? [keyof S] extends [never] ? false : true : false : false;
+/**
+ * Extract state from a Room-like instance type.
+ * Priority: useful ~state phantom > Schema state property > return T as-is
+ */
+type ExtractStateFromRoom<T> = T extends {
+    '~state': infer S;
+} ? HasUsefulStatePhantom<T> extends true ? S : T extends {
+    state: infer St;
+} ? IsSchema<St> extends true ? St : T : T : T extends {
+    state: infer S;
+} ? IsSchema<S> extends true ? S : T : T;
+/**
+ * Infer the state type from T, or use explicit S if provided.
  *
- * Uses `~state` phantom property to distinguish Room types from plain state types.
- * This prevents incorrectly extracting `state` from a state type that happens to have a `state` property.
+ * Supports multiple usage patterns:
+ * - Room<MyState>: T is a Schema type, return as-is
+ * - Room<MyRoom>: T is a Room instance, extract from ~state or state property
+ * - Room<typeof MyRoom>: T is a constructor, instantiate first then extract
+ * - Room<T, ExplicitState>: S overrides all inference
  */
-export type InferState<T, S> = [S] extends [never] ? (T extends abstract new (...args: any) => {
-    '~state': infer ST;
-} ? ST : T extends {
-    '~state': infer ST;
-} ? ST : T) : S;
+export type InferState<T, S> = [S] extends [never] ? Instantiate<T> extends infer I ? IsSchema<I> extends true ? I : ExtractStateFromRoom<I> : never : S;
 /**
  * Normalizes T for message extraction: returns T if it has ~state (Room type),
  * otherwise returns any (plain state type). This ensures Room<State> is equivalent
  * to Room<any, State> when State doesn't have ~state.
  */
-export type NormalizeRoomType<T> = T extends abstract new (...args: any) => {
-    '~state': any;
-} ? T : T extends {
+export type NormalizeRoomType<T> = Instantiate<T> extends {
     '~state': any;
 } ? T : any;
 /**
  * Extract room messages type from a Room constructor or instance type.
  * Supports both constructor types (typeof MyRoom) and instance types (MyRoom)
  */
-export type ExtractRoomMessages<T> = T extends abstract new (...args: any) => {
-    messages: infer M;
-} ? M : T extends {
+export type ExtractRoomMessages<T> = Instantiate<T> extends {
     messages: infer M;
 } ? M : {};
 /**
  * Extract client-side messages type from a Room constructor or instance type.
  * These are messages that the server can send to the client.
  */
-export type ExtractRoomClientMessages<T> = T extends abstract new (...args: any) => {
-    '~client': {
-        '~messages': infer M;
-    };
-} ? M : T extends {
+export type ExtractRoomClientMessages<T> = Instantiate<T> extends {
     '~client': {
         '~messages': infer M;
     };

package/build/index.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/index.ts"],
-  "sourcesContent": ["import type { StandardSchemaV1 } from '@standard-schema/spec';\n\n// Re-export StandardSchemaV1 for convenience\nexport type { StandardSchemaV1 };\n\n// Re-export Protocol types\nexport { Protocol, ErrorCode, CloseCode } from './Protocol.js';\n\n/**\n * Minimal Room-like interface for SDK type inference.\n * Allows typing SDK methods without depending on @colyseus/core.\n */\nexport interface ServerRoomLike<State = any, Options = any> {\n  state: State;\n  onJoin: (client: any, options?: Options, auth?: any) => any;\n  messages?: Record<string, any>;\n  '~client'?: { '~messages'?: Record<string, any> };\n}\n\n/**\n * Seat reservation returned by matchmaking operations.\n */\nexport interface ISeatReservation {\n  name: string;\n  sessionId: string;\n  roomId: string;\n  publicAddress?: string;\n  processId?: string;\n  reconnectionToken?: string;\n  devMode?: boolean;\n}\n\n/**\n * Helper types for flexible Room generics on the client SDK.\n * Allows: Room<State>, Room<ServerRoom>, or Room<ServerRoom, State>\n *\n * Uses `~state` phantom property to distinguish Room types from plain state types.\n * This prevents incorrectly extracting `state` from a state type that happens to have a `state` property.\n */\nexport type InferState<T, S> = [S] extends [never]\n    ? (T extends abstract new (...args: any) => { '~state': infer ST }\n        ? ST  // Constructor type (typeof MyRoom): extract state via ~state phantom\n        : T extends { '~state': infer ST }\n            ? ST  // Instance type (MyRoom): extract state via ~state phantom\n            : T)  // State type or other: return as-is\n    : S;\n\n/**\n * Normalizes T for message extraction: returns T if it has ~state (Room type),\n * otherwise returns any (plain state type). This ensures Room<State> is equivalent\n * to Room<any, State> when State doesn't have ~state.\n */\nexport type NormalizeRoomType<T> = T extends abstract new (...args: any) => { '~state': any }\n    ? T  // Constructor type with ~state: keep as-is\n    : T extends { '~state': any }\n        ? T  // Instance type with ~state: keep as-is\n        : any;  // Plain state type: normalize to any\n\n/**\n * Extract room messages type from a Room constructor or instance type.\n * Supports both constructor types (typeof MyRoom) and instance types (MyRoom)\n */\nexport type ExtractRoomMessages<T> = T extends abstract new (...args: any) => { messages: infer M }\n    ? M\n    : T extends { messages: infer M }\n        ? M\n        : {};\n\n/**\n * Extract client-side messages type from a Room constructor or instance type.\n * These are messages that the server can send to the client.\n */\nexport type ExtractRoomClientMessages<T> = T extends abstract new (...args: any) => { '~client': { '~messages': infer M } }\n    ? M\n    : T extends { '~client': { '~messages': infer M } }\n        ? M\n        : {};\n\n/**\n * Message handler with automatic type inference from format schema.\n * When a format is provided, the message type is automatically inferred from the schema.\n *\n * @template T - The StandardSchema type for message validation\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandlerWithFormat<T extends StandardSchemaV1 = any, Client = any, This = any> = {\n  format: T;\n  handler: (this: This, client: Client, message: StandardSchemaV1.InferOutput<T>) => void;\n};\n\n/**\n * Message handler type that can be either a function or a format handler with validation.\n *\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandler<Client = any, This = any> =\n  | ((this: This, client: Client, message: any) => void)\n  | MessageHandlerWithFormat<any, Client, This>;\n\n/**\n * Extract the message payload type from a message handler.\n * Works with both function handlers and format handlers.\n */\nexport type ExtractMessageType<T> =\n  T extends { format: infer Format extends StandardSchemaV1; handler: any }\n    ? StandardSchemaV1.InferOutput<Format>\n    : T extends (this: any, client: any, message: infer Message) => void\n      ? Message\n      : any;\n\n/**\n * A map of message types to message handlers.\n *\n * @template Room - The Room class type\n * @template Client - The client type\n */\nexport type Messages<Room = any, Client = any> = Record<string, MessageHandler<Client, Room>>;\n\n/**\n * Exposed types for the client-side SDK.\n * Used by defineServer() to expose room and route types to the client.\n *\n * @template RoomTypes - Record of room names to their RegisteredHandler types\n * @template Routes - Router type from @colyseus/better-call\n */\nexport interface SDKTypes<\n  RoomTypes extends Record<string, any> = any,\n  Routes = any\n> {\n  '~rooms': RoomTypes;\n  '~routes': Routes;\n}\n"],
+  "sourcesContent": ["import type { StandardSchemaV1 } from '@standard-schema/spec';\n\n// Re-export StandardSchemaV1 for convenience\nexport type { StandardSchemaV1 };\n\n// Re-export Protocol types\nexport { Protocol, ErrorCode, CloseCode } from './Protocol.js';\n\n/**\n * Minimal Room-like interface for SDK type inference.\n * Allows typing SDK methods without depending on @colyseus/core.\n * Note: onJoin is optional because core Room defines it as optional.\n */\nexport interface ServerRoomLike<State = any, Options = any> {\n  state: State;\n  onJoin?: (client: any, options?: Options, auth?: any) => any;\n  messages?: Record<string, any>;\n  '~client'?: { '~messages'?: Record<string, any> };\n}\n\n/**\n * Seat reservation returned by matchmaking operations.\n */\nexport interface ISeatReservation {\n  name: string;\n  sessionId: string;\n  roomId: string;\n  publicAddress?: string;\n  processId?: string;\n  reconnectionToken?: string;\n  devMode?: boolean;\n}\n\n/**\n * Extract instance type from a constructor type.\n * If T is not a constructor, returns T as-is.\n */\ntype Instantiate<T> = T extends abstract new (...args: any) => infer I ? I : T;\n\n/**\n * Check if a type is a Schema (has ~refId marker).\n * Schema defines ~refId as optional, so we check keyof instead of property presence.\n */\ntype IsSchema<T> = '~refId' extends keyof T ? true : false;\n\n/**\n * Check if ~state phantom property contains a useful type (not object/any/never).\n * Returns true if ~state exists and has meaningful structure.\n */\ntype HasUsefulStatePhantom<T> = T extends { '~state': infer S }\n    ? [S] extends [never] ? false           // never is not useful\n    : unknown extends S ? false             // any is not useful\n    : S extends object\n        ? [keyof S] extends [never] ? false // {} or object with no keys is not useful\n        : true\n        : false\n    : false;\n\n/**\n * Extract state from a Room-like instance type.\n * Priority: useful ~state phantom > Schema state property > return T as-is\n */\ntype ExtractStateFromRoom<T> = T extends { '~state': infer S }\n    ? HasUsefulStatePhantom<T> extends true\n        ? S  // Use ~state if it's useful\n        : T extends { state: infer St }\n            ? IsSchema<St> extends true ? St : T  // Fallback to state if Schema\n            : T\n    : T extends { state: infer S }\n        ? IsSchema<S> extends true ? S : T\n        : T;\n\n/**\n * Infer the state type from T, or use explicit S if provided.\n *\n * Supports multiple usage patterns:\n * - Room<MyState>: T is a Schema type, return as-is\n * - Room<MyRoom>: T is a Room instance, extract from ~state or state property\n * - Room<typeof MyRoom>: T is a constructor, instantiate first then extract\n * - Room<T, ExplicitState>: S overrides all inference\n */\nexport type InferState<T, S> = [S] extends [never]\n    ? Instantiate<T> extends infer I\n        ? IsSchema<I> extends true\n            ? I  // It's a Schema, return as-is\n            : ExtractStateFromRoom<I>\n        : never\n    : S;\n\n/**\n * Normalizes T for message extraction: returns T if it has ~state (Room type),\n * otherwise returns any (plain state type). This ensures Room<State> is equivalent\n * to Room<any, State> when State doesn't have ~state.\n */\nexport type NormalizeRoomType<T> = Instantiate<T> extends { '~state': any } ? T : any;\n\n/**\n * Extract room messages type from a Room constructor or instance type.\n * Supports both constructor types (typeof MyRoom) and instance types (MyRoom)\n */\nexport type ExtractRoomMessages<T> = Instantiate<T> extends { messages: infer M } ? M : {};\n\n/**\n * Extract client-side messages type from a Room constructor or instance type.\n * These are messages that the server can send to the client.\n */\nexport type ExtractRoomClientMessages<T> = Instantiate<T> extends { '~client': { '~messages': infer M } } ? M : {};\n\n/**\n * Message handler with automatic type inference from format schema.\n * When a format is provided, the message type is automatically inferred from the schema.\n *\n * @template T - The StandardSchema type for message validation\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandlerWithFormat<T extends StandardSchemaV1 = any, Client = any, This = any> = {\n  format: T;\n  handler: (this: This, client: Client, message: StandardSchemaV1.InferOutput<T>) => void;\n};\n\n/**\n * Message handler type that can be either a function or a format handler with validation.\n *\n * @template Client - The client type (from @colyseus/core Transport)\n * @template This - The Room class context\n */\nexport type MessageHandler<Client = any, This = any> =\n  | ((this: This, client: Client, message: any) => void)\n  | MessageHandlerWithFormat<any, Client, This>;\n\n/**\n * Extract the message payload type from a message handler.\n * Works with both function handlers and format handlers.\n */\nexport type ExtractMessageType<T> =\n  T extends { format: infer Format extends StandardSchemaV1; handler: any }\n    ? StandardSchemaV1.InferOutput<Format>\n    : T extends (this: any, client: any, message: infer Message) => void\n      ? Message\n      : any;\n\n/**\n * A map of message types to message handlers.\n *\n * @template Room - The Room class type\n * @template Client - The client type\n */\nexport type Messages<Room = any, Client = any> = Record<string, MessageHandler<Client, Room>>;\n\n/**\n * Exposed types for the client-side SDK.\n * Used by defineServer() to expose room and route types to the client.\n *\n * @template RoomTypes - Record of room names to their RegisteredHandler types\n * @template Routes - Router type from @colyseus/better-call\n */\nexport interface SDKTypes<\n  RoomTypes extends Record<string, any> = any,\n  Routes = any\n> {\n  '~rooms': RoomTypes;\n  '~routes': Routes;\n}\n"],
   "mappings": ";AAMA,SAAS,UAAU,WAAW,iBAAiB;",
   "names": []
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/shared-types",
-  "version": "0.17.2",
+  "version": "0.17.3",
   "description": "Shared TypeScript types for Colyseus server and client SDK",
   "type": "module",
   "input": "./src/index.ts",
@@ -47,8 +47,8 @@
   },
   "devDependencies": {
     "vitest": "^3.1.1",
-    "@colyseus/sdk": "^0.17.18",
-    "@colyseus/core": "^0.17.17"
+    "@colyseus/core": "^0.17.21",
+    "@colyseus/sdk": "^0.17.21"
   },
   "publishConfig": {
     "access": "public"

package/src/index.ts

@@ -9,10 +9,11 @@ export { Protocol, ErrorCode, CloseCode } from './Protocol.js';
 /**
  * Minimal Room-like interface for SDK type inference.
  * Allows typing SDK methods without depending on @colyseus/core.
+ * Note: onJoin is optional because core Room defines it as optional.
  */
 export interface ServerRoomLike<State = any, Options = any> {
   state: State;
-  onJoin: (client: any, options?: Options, auth?: any) => any;
+  onJoin?: (client: any, options?: Options, auth?: any) => any;
   messages?: Record<string, any>;
   '~client'?: { '~messages'?: Record<string, any> };
 }
@@ -31,18 +32,59 @@ export interface ISeatReservation {
 }
 
 /**
- * Helper types for flexible Room generics on the client SDK.
- * Allows: Room<State>, Room<ServerRoom>, or Room<ServerRoom, State>
+ * Extract instance type from a constructor type.
+ * If T is not a constructor, returns T as-is.
+ */
+type Instantiate<T> = T extends abstract new (...args: any) => infer I ? I : T;
+
+/**
+ * Check if a type is a Schema (has ~refId marker).
+ * Schema defines ~refId as optional, so we check keyof instead of property presence.
+ */
+type IsSchema<T> = '~refId' extends keyof T ? true : false;
+
+/**
+ * Check if ~state phantom property contains a useful type (not object/any/never).
+ * Returns true if ~state exists and has meaningful structure.
+ */
+type HasUsefulStatePhantom<T> = T extends { '~state': infer S }
+    ? [S] extends [never] ? false           // never is not useful
+    : unknown extends S ? false             // any is not useful
+    : S extends object
+        ? [keyof S] extends [never] ? false // {} or object with no keys is not useful
+        : true
+        : false
+    : false;
+
+/**
+ * Extract state from a Room-like instance type.
+ * Priority: useful ~state phantom > Schema state property > return T as-is
+ */
+type ExtractStateFromRoom<T> = T extends { '~state': infer S }
+    ? HasUsefulStatePhantom<T> extends true
+        ? S  // Use ~state if it's useful
+        : T extends { state: infer St }
+            ? IsSchema<St> extends true ? St : T  // Fallback to state if Schema
+            : T
+    : T extends { state: infer S }
+        ? IsSchema<S> extends true ? S : T
+        : T;
+
+/**
+ * Infer the state type from T, or use explicit S if provided.
  *
- * Uses `~state` phantom property to distinguish Room types from plain state types.
- * This prevents incorrectly extracting `state` from a state type that happens to have a `state` property.
+ * Supports multiple usage patterns:
+ * - Room<MyState>: T is a Schema type, return as-is
+ * - Room<MyRoom>: T is a Room instance, extract from ~state or state property
+ * - Room<typeof MyRoom>: T is a constructor, instantiate first then extract
+ * - Room<T, ExplicitState>: S overrides all inference
  */
 export type InferState<T, S> = [S] extends [never]
-    ? (T extends abstract new (...args: any) => { '~state': infer ST }
-        ? ST  // Constructor type (typeof MyRoom): extract state via ~state phantom
-        : T extends { '~state': infer ST }
-            ? ST  // Instance type (MyRoom): extract state via ~state phantom
-            : T)  // State type or other: return as-is
+    ? Instantiate<T> extends infer I
+        ? IsSchema<I> extends true
+            ? I  // It's a Schema, return as-is
+            : ExtractStateFromRoom<I>
+        : never
     : S;
 
 /**
@@ -50,31 +92,19 @@ export type InferState<T, S> = [S] extends [never]
  * otherwise returns any (plain state type). This ensures Room<State> is equivalent
  * to Room<any, State> when State doesn't have ~state.
  */
-export type NormalizeRoomType<T> = T extends abstract new (...args: any) => { '~state': any }
-    ? T  // Constructor type with ~state: keep as-is
-    : T extends { '~state': any }
-        ? T  // Instance type with ~state: keep as-is
-        : any;  // Plain state type: normalize to any
+export type NormalizeRoomType<T> = Instantiate<T> extends { '~state': any } ? T : any;
 
 /**
  * Extract room messages type from a Room constructor or instance type.
  * Supports both constructor types (typeof MyRoom) and instance types (MyRoom)
  */
-export type ExtractRoomMessages<T> = T extends abstract new (...args: any) => { messages: infer M }
-    ? M
-    : T extends { messages: infer M }
-        ? M
-        : {};
+export type ExtractRoomMessages<T> = Instantiate<T> extends { messages: infer M } ? M : {};
 
 /**
  * Extract client-side messages type from a Room constructor or instance type.
  * These are messages that the server can send to the client.
  */
-export type ExtractRoomClientMessages<T> = T extends abstract new (...args: any) => { '~client': { '~messages': infer M } }
-    ? M
-    : T extends { '~client': { '~messages': infer M } }
-        ? M
-        : {};
+export type ExtractRoomClientMessages<T> = Instantiate<T> extends { '~client': { '~messages': infer M } } ? M : {};
 
 /**
  * Message handler with automatic type inference from format schema.