@colyseus/sdk 0.17.38 → 0.17.40

package/dist/debug.js

@@ -3,7 +3,7 @@
 // This software is released under the MIT License.
 // https://opensource.org/license/MIT
 //
-// colyseus.js@0.17.38
+// colyseus.js@0.17.40
 (function (Client_ts, sharedTypes) {
   'use strict';
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@colyseus/sdk",
-  "version": "0.17.38",
+  "version": "0.17.40",
   "description": "Colyseus Multiplayer SDK for JavaScript/TypeScript",
   "author": "Endel Dreyer",
   "license": "MIT",
@@ -55,8 +55,8 @@
     "@colyseus/schema": "^4.0.7",
     "tslib": "^2.1.0",
     "ws": "^8.13.0",
-    "@colyseus/shared-types": "^0.17.6",
-    "@colyseus/better-call": "^1.3.1"
+    "@colyseus/better-call": "^1.3.1",
+    "@colyseus/shared-types": "^0.17.6"
   },
   "devDependencies": {
     "@rollup/plugin-alias": "^5.1.1",
@@ -82,7 +82,7 @@
     "typescript": "^5.9.3",
     "vite": "^5.0.11",
     "vitest": "^2.1.1",
-    "@colyseus/core": "^0.17.40"
+    "@colyseus/core": "^0.17.41"
   },
   "peerDependencies": {
     "@colyseus/core": "0.17.x"
@@ -103,9 +103,10 @@
     "build-ci": "tsc && npm run build && npm run build-dist-dts && npm run build-release-assets",
     "build-release-assets": "zip --junk-paths colyseus-sdk dist/colyseus*",
     "build-all": "tsc && npm run build && npm run build-dist-dts && npm run copy-cocos-creator-files && npm run copy-construct3-files",
+    "copy-cocos-creator-files": "tsc test/dist-types-check.ts --noEmit --skipLibCheck && cp dist/colyseus.js cocos-creator-3-extension/colyseus-sdk/runtime/colyseus.js && cp dist/debug.js cocos-creator-3-extension/colyseus-sdk/runtime/debug.js && cp dist/colyseus.d.ts cocos-creator-3-extension/colyseus-sdk/runtime",
     "copy-construct3-files": "cp dist/colyseus.js ../../../colyseus-construct3/plugin/colyseus.js && cp dist/debug.js ../../../colyseus-construct3/plugin/colyseus-debug.js",
-    "copy-cocos-creator-files": "tsc test/dist-types-check.ts --noEmit --skipLibCheck && cp dist/colyseus-cocos-creator.js cocos-creator-3-extension/colyseus-sdk/runtime/colyseus.js && cp dist/debug.js cocos-creator-3-extension/colyseus-sdk/runtime/debug.js && cp dist/colyseus.d.ts cocos-creator-3-extension/colyseus-sdk/runtime",
     "watch": "tsc -w",
+    "typecheck": "tsc --noEmit",
     "tslint": "tslint --project ."
   }
 }

package/src/Client.ts

@@ -3,7 +3,7 @@ import { CloseCode, Protocol, type InferState, type SDKTypes, type ServerRoomLik
 import { MatchMakeError, ServerError } from './errors/Errors.ts';
 import { Room } from './Room.ts';
 import { SchemaConstructor } from './serializer/SchemaSerializer.ts';
-import { HTTP } from './HTTP.ts';
+import { HTTP, type FetchFn } from './HTTP.ts';
 import { Auth } from './Auth.ts';
 import { Connection } from './Connection.ts';
 import { discordURLBuilder } from './3rd_party/discord.ts';
@@ -30,6 +30,7 @@ export interface ClientOptions {
     headers?: { [id: string]: string };
     urlBuilder?: (url: URL) => string;
     protocol?: "ws" | "h3";
+    fetchFn?: FetchFn;
 }
 
 export interface LatencyOptions {
@@ -108,7 +109,7 @@ export class ColyseusSDK<ServerType extends SDKTypes = any, UserData = any> {
 
         this.http = new HTTP(this, {
             headers: options?.headers || {},
-        });
+        }, options?.fetchFn);
         this.auth = new Auth(this.http);
 
         this.urlBuilder = options?.urlBuilder;

package/src/HTTP.ts

@@ -1,6 +1,7 @@
 import type { Router, HasRequiredKeys, Prettify, UnionToIntersection, Endpoint, HTTPMethod } from "@colyseus/better-call";
 import { ColyseusSDK } from "./Client.ts";
 import { ServerError } from "./errors/Errors.ts";
+import { xhrFetch } from "./fetchXHR.ts";
 
 /**
  * TODO: we should clean up the types repetition in this file.
@@ -29,27 +30,7 @@ type HasRequired<
         query?: any;
         params?: any;
     },
-> = T["body"] extends object
-    ? HasRequiredKeys<T["body"]> extends true
-        ? true
-        : T["query"] extends object
-            ? HasRequiredKeys<T["query"]> extends true
-                ? true
-                : T["params"] extends object
-                    ? HasRequiredKeys<T["params"]>
-                    : false
-            : T["params"] extends object
-                ? HasRequiredKeys<T["params"]>
-                : false
-    : T["query"] extends object
-        ? HasRequiredKeys<T["query"]> extends true
-            ? true
-            : T["params"] extends object
-                ? HasRequiredKeys<T["params"]>
-                : false
-        : T["params"] extends object
-            ? HasRequiredKeys<T["params"]>
-            : false;
+> = keyof RequiredOptionKeys<T> extends never ? false : true;
 
 type InferContext<T> = T extends (ctx: infer Ctx) => any
     ? Ctx extends object
@@ -86,27 +67,42 @@ type MethodOptions<API, M extends HTTPMethod> = API extends { [key: string]: inf
         : {}
     : {};
 
+// When the endpoint didn't declare a schema, better-call infers:
+//   - body: `any`
+//   - query: `Record<string, any> | undefined`
+//   - params: `Record<string, any> | undefined` (no `:param` in path)
+// Under `strictNullChecks: false`, `undefined extends T` is vacuously true and
+// `undefined extends object` is also true, so the previous `extends object`
+// guard wrongly classified these undeclared slots as required. The checks
+// below use `IsAny` for body and `string extends keyof NonNullable<…>` to
+// detect the fallback index signature — both are immune to null-check mode.
+type IsUndeclaredSchema<T> = [T] extends [never]
+    ? true
+    : string extends keyof NonNullable<T> ? true : false;
+
 export type RequiredOptionKeys<
     C extends {
         body?: any;
         query?: any;
         params?: any;
     },
-> = (C["body"] extends object
-    ? HasRequiredKeys<C["body"]> extends true
-        ? { body: true }
-        : {}
-    : {}) &
-    (C["query"] extends object
-        ? HasRequiredKeys<C["query"]> extends true
-            ? { query: true }
+> = (IsAny<C["body"]> extends true
+    ? {}
+    : NonNullable<C["body"]> extends object
+        ? HasRequiredKeys<NonNullable<C["body"]>> extends true
+            ? { body: true }
             : {}
-        : {}) &
-    (C["params"] extends object
-        ? HasRequiredKeys<C["params"]> extends true
+        : { body: true }) &
+    (IsUndeclaredSchema<C["query"]> extends true
+        ? {}
+        : HasRequiredKeys<NonNullable<C["query"]>> extends true
+            ? { query: true }
+            : {}) &
+    (IsUndeclaredSchema<C["params"]> extends true
+        ? {}
+        : HasRequiredKeys<NonNullable<C["params"]>> extends true
             ? { params: true }
-            : {}
-        : {});
+            : {});
 
 
 type CommonHeaders = {
@@ -249,18 +245,35 @@ type InferReturnType<R, OPT, K extends keyof OPT> =
         ? any
         : Awaited<ReturnType<OPT[K] extends Endpoint ? OPT[K] : never>>;
 
+export type FetchFn = (url: string | URL | Request, init?: RequestInit) => Promise<Response>;
+
 export class HTTP<R extends Router | Router["endpoints"]> {
     public authToken: string | undefined;
     public options: FetchRequestOptions;
 
     private sdk: ColyseusSDK;
+    private _fetchFn: FetchFn | undefined;
 
     // alias "del()" to "delete()"
     public del = this.delete;
 
-    constructor(sdk: ColyseusSDK, baseOptions: FetchRequestOptions) {
+    constructor(sdk: ColyseusSDK, baseOptions: FetchRequestOptions, fetchFn?: FetchFn) {
         this.sdk = sdk;
         this.options = baseOptions;
+        this._fetchFn = fetchFn;
+    }
+
+    /**
+     * Lazily resolve the fetch implementation.
+     * Falls back to XMLHttpRequest when fetch is unavailable (e.g. Cocos Creator Native).
+     */
+    private get fetchFn(): FetchFn {
+        if (!this._fetchFn) {
+            this._fetchFn = (typeof(globalThis.fetch) !== 'undefined')
+                ? globalThis.fetch.bind(globalThis)
+                : xhrFetch;
+        }
+        return this._fetchFn;
     }
 
     private async request<
@@ -509,7 +522,7 @@ export class HTTP<R extends Router | Router["endpoints"]> {
 
         let raw: Response;
         try {
-            raw = await fetch(url, mergedOptions);
+            raw = await this.fetchFn(url, mergedOptions);
         } catch (err: any) {
             // If it's an AbortError, re-throw as-is
             if (err.name === 'AbortError') {

package/src/fetchXHR.ts

@@ -0,0 +1,88 @@
+/**
+ * Minimal fetch-compatible wrapper around XMLHttpRequest.
+ * Used as an automatic fallback when globalThis.fetch is unavailable
+ * (e.g. Cocos Creator Native).
+ */
+export function xhrFetch(url: string | URL | Request, init?: RequestInit): Promise<Response> {
+    return new Promise((resolve, reject) => {
+        const xhr = new XMLHttpRequest();
+        const method = init?.method || "GET";
+
+        xhr.open(method, url.toString());
+        xhr.withCredentials = (init?.credentials === "include");
+
+        // Apply request headers
+        if (init?.headers) {
+            const headers = (init.headers instanceof Headers)
+                ? init.headers
+                : new Headers(init.headers as HeadersInit);
+            headers.forEach((value, key) => {
+                xhr.setRequestHeader(key, value);
+            });
+        }
+
+        xhr.onload = () => {
+            // Parse response headers
+            const headers = new Headers();
+            const rawHeaders = xhr.getAllResponseHeaders().trim();
+            if (rawHeaders) {
+                for (const line of rawHeaders.split(/[\r\n]+/)) {
+                    const idx = line.indexOf(": ");
+                    if (idx > 0) {
+                        headers.append(line.substring(0, idx), line.substring(idx + 2));
+                    }
+                }
+            }
+
+            const responseBody = xhr.response ?? xhr.responseText;
+
+            resolve(new XHRResponse(responseBody, {
+                status: xhr.status,
+                statusText: xhr.statusText,
+                headers,
+            }) as unknown as Response);
+        };
+
+        xhr.onerror = () => reject(new TypeError("Network request failed"));
+        xhr.ontimeout = () => reject(new TypeError("Network request timed out"));
+
+        xhr.send(init?.body as XMLHttpRequestBodyInit | null ?? null);
+    });
+}
+
+/**
+ * Minimal Response-compatible class backed by XHR response data.
+ * Implements only the surface used by HTTP.executeRequest().
+ */
+class XHRResponse {
+    readonly status: number;
+    readonly statusText: string;
+    readonly headers: Headers;
+    readonly ok: boolean;
+
+    private body: any;
+
+    constructor(body: any, init: { status: number; statusText: string; headers: Headers }) {
+        this.body = body;
+        this.status = init.status;
+        this.statusText = init.statusText;
+        this.headers = init.headers;
+        this.ok = init.status >= 200 && init.status < 300;
+    }
+
+    async json(): Promise<any> {
+        return typeof this.body === "string"
+            ? JSON.parse(this.body)
+            : this.body;
+    }
+
+    async text(): Promise<string> {
+        return typeof this.body === "string"
+            ? this.body
+            : JSON.stringify(this.body);
+    }
+
+    async blob(): Promise<Blob> {
+        return new Blob([this.body]);
+    }
+}

package/src/index.ts

@@ -1,6 +1,7 @@
 import './legacy';
 
 export { ColyseusSDK, Client, type JoinOptions, type EndpointSettings, type ClientOptions, type ISeatReservation as SeatReservation } from './Client.ts';
+export { type FetchFn } from './HTTP.ts';
 export { Room, type RoomAvailable } from './Room.ts';
 export { Auth, type AuthSettings, type PopupSettings, type AuthResponse, type UserDataResponse, type ForgotPasswordResponse, type AuthData } from "./Auth.ts";
 export { ServerError, AbortError, MatchMakeError } from './errors/Errors.ts';