@irtio/client 0.3.0 → 0.5.0

package/dist/index.d.ts

@@ -776,6 +776,15 @@ interface JoinOptions<S, Role extends string = string> {
     readonly rpc?: ClientImplementations<ClientRpcs<SchemaRpc<S>>>;
     /** Endpoint override. Otherwise resolved as described in `resolveUrl`. */
     readonly url?: string;
+    /**
+     * The hosted region this project is deployed to, e.g. `'us'`. Used only when no `url` and no
+     * `IRT_URL` is set and the page is not on localhost, where the endpoint becomes
+     * `wss://<region>.irt.io`; omitted ⇒ `eu`, which is exactly what every client resolved to
+     * before regions existed. It must match the region the project is set to in the dashboard,
+     * which `irtio deploy` prints as the URL it reports the deployment reachable at. A label that
+     * is not a region label throws rather than quietly falling back.
+     */
+    readonly region?: string;
     /**
      * Public project key. Defaults to `schema.project`, or `'dev'` against a localhost endpoint
      * (which is what `irtio dev` uses when there is no `irtio.json`).
@@ -818,6 +827,8 @@ interface JoinRelayOptions {
     readonly role?: string;
     readonly name?: string;
     readonly url?: string;
+    /** The hosted region, as in `JoinOptions.region`. Omitted ⇒ `eu`. */
+    readonly region?: string;
     /** Public project key; defaults to `'dev'`. */
     readonly key?: string;
     readonly onStatus?: (status: Status) => void;
@@ -940,15 +951,29 @@ interface RelayRoom {
  * The builder writes no URL and no env var in the common case: the schema carries the project id,
  * `location.hostname` decides localhost vs the region, and the room code lives in the URL.
  */
-/** The region every project resolves to (single-region hosting). */
+/** The region a project resolves to when neither a URL nor a `region` says otherwise. */
 declare const DEFAULT_REGION = "eu";
+/**
+ * The shape of a region label. There is no list of regions to check against: a region exists
+ * because servers joined the fleet carrying that label and a router terminates TLS for
+ * `<label>.irt.io`, so the set is operational. What is checked is that the label is a label,
+ * because it goes straight into a hostname. Same rule the control plane applies when a project
+ * declares its region; the SDK keeps its own copy rather than depending on a private package.
+ */
+declare const REGION_RE: RegExp;
 /** `irtio dev`'s default port. */
 declare const DEV_PORT = 7070;
 /**
  * Resolution order: explicit `url` > `IRT_URL` / `window.IRT_URL` > `ws://localhost:7070` when the
- * page is on localhost (or there is no page at all — Node, bots, tests) > `wss://eu.irt.io`.
+ * page is on localhost (or there is no page at all — Node, bots, tests) > `wss://<region>.irt.io`,
+ * where `region` defaults to `eu`.
+ *
+ * `region` only decides the last step. A page on localhost still gets the local dev server, which
+ * is what a developer running `irtio dev` wants no matter which region the deployed project lives
+ * in, and an explicit `url` or `IRT_URL` still wins outright. The label is validated whichever
+ * step wins, because a typo in it is a bug either way.
  */
-declare function resolveUrl(explicit?: string): string;
+declare function resolveUrl(explicit?: string, region?: string): string;
 /**
  * A room option may be a bare code (`ABCD`) or a whole share link. Returns the code, or `''`
  * when the argument names no room (create-by-join).
@@ -1244,4 +1269,4 @@ declare function joinRoom<S extends AnySchema, Role extends string = RoleOf<S> &
  */
 declare function joinRelay(options?: JoinRelayOptions): Promise<RelayRoom>;
 
-export { CALL_TIMEOUT_MS, type ClientBodySpec, type ClientCollection, type ClientPhysicsOptions, type ClientRapierBody, type ClientRapierModule, type ClientRapierWorld, type ClientState, ClientStore, type ClientVector3, type Correction, DEFAULT_REGION, DEFAULT_WRITE_INTERVAL_MS, DEV_PORT, E_CONNECT_FAILED, type FrameHook, type JoinOptions, type JoinRelayOptions, MAX_PREDICTED_BODIES, type MessageTarget, PING_INTERVAL_MS, PREDICTION_EPSILON, type PredictionStats, type PredictionStatus, RESIM_DEPTH, type RelayRoom, type Room, type RoomCallProxy, type RoomError, type RoomEvents, SMOOTHING_HALF_LIFE_MS, SMOOTHING_SNAP_UNITS, type Scheduler, Session, type Status, type Transport, type TransportSocket, type Unsubscribe, defaultScheduler, joinRelay, joinRoom, linkForUrl, resolveUrl, roomIdFrom, webSocketTransport };
+export { CALL_TIMEOUT_MS, type ClientBodySpec, type ClientCollection, type ClientPhysicsOptions, type ClientRapierBody, type ClientRapierModule, type ClientRapierWorld, type ClientState, ClientStore, type ClientVector3, type Correction, DEFAULT_REGION, DEFAULT_WRITE_INTERVAL_MS, DEV_PORT, E_CONNECT_FAILED, type FrameHook, type JoinOptions, type JoinRelayOptions, MAX_PREDICTED_BODIES, type MessageTarget, PING_INTERVAL_MS, PREDICTION_EPSILON, type PredictionStats, type PredictionStatus, REGION_RE, RESIM_DEPTH, type RelayRoom, type Room, type RoomCallProxy, type RoomError, type RoomEvents, SMOOTHING_HALF_LIFE_MS, SMOOTHING_SNAP_UNITS, type Scheduler, Session, type Status, type Transport, type TransportSocket, type Unsubscribe, defaultScheduler, joinRelay, joinRoom, linkForUrl, resolveUrl, roomIdFrom, webSocketTransport };

package/dist/index.js

@@ -11,6 +11,8 @@ import {
 
 // src/endpoint.ts
 var DEFAULT_REGION = "eu";
+var HOSTED_DOMAIN = "irt.io";
+var REGION_RE = /^[a-z][a-z0-9]{0,15}$/;
 var DEV_PORT = 7070;
 function currentLocation() {
   const loc = globalThis.location;
@@ -28,13 +30,23 @@ function envUrl() {
   if (typeof fromEnv === "string" && fromEnv !== "") return fromEnv;
   return void 0;
 }
-function resolveUrl(explicit) {
+function regionLabel(region) {
+  if (region === void 0 || region === "") return DEFAULT_REGION;
+  if (!REGION_RE.test(region)) {
+    throw new Error(
+      `irtio: ${JSON.stringify(region)} is not a region label. Use lowercase letters and digits starting with a letter, e.g. "eu" or "us", matching the region your project is set to in the dashboard.`
+    );
+  }
+  return region;
+}
+function resolveUrl(explicit, region) {
+  const label = regionLabel(region);
   if (explicit !== void 0 && explicit !== "") return explicit;
   const fromEnv = envUrl();
   if (fromEnv !== void 0) return fromEnv;
   const loc = currentLocation();
   if (!loc || isLocalHostname(loc.hostname)) return `ws://localhost:${DEV_PORT}`;
-  return `wss://${DEFAULT_REGION}.irt.io`;
+  return `wss://${label}.${HOSTED_DOMAIN}`;
 }
 function isLocalUrl(url) {
   try {
@@ -1191,7 +1203,7 @@ function callProxy(session) {
   });
 }
 async function joinRoom(schema, options = {}) {
-  const url = resolveUrl(options.url);
+  const url = resolveUrl(options.url, options.region);
   const key = resolveKey(options.key, schema, url);
   const explicitRoom = options.room !== void 0;
   const fromLocation = !explicitRoom && currentLocation() !== void 0;
@@ -1269,7 +1281,7 @@ function makeRoom(session) {
   return room;
 }
 async function joinRelay(options = {}) {
-  const url = resolveUrl(options.url);
+  const url = resolveUrl(options.url, options.region);
   const explicitRoom = options.room !== void 0;
   const fromLocation = !explicitRoom && currentLocation() !== void 0;
   const roomId = explicitRoom ? roomIdFrom(options.room ?? "") : fromLocation ? roomIdFromLocation() : "";
@@ -1322,6 +1334,7 @@ export {
   MAX_PREDICTED_BODIES,
   PING_INTERVAL_MS,
   PREDICTION_EPSILON,
+  REGION_RE,
   RESIM_DEPTH,
   SMOOTHING_HALF_LIFE_MS,
   SMOOTHING_SNAP_UNITS,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@irtio/client",
-  "version": "0.3.0",
+  "version": "0.5.0",
   "description": "irtio client SDK: joinRoom, owned-write batching, corrections, typed RPCs, presence, reconnection",
   "license": "MIT",
   "publishConfig": {
@@ -19,8 +19,8 @@
     "dist"
   ],
   "dependencies": {
-    "@irtio/schema": "0.3.0",
-    "@irtio/protocol": "0.3.0"
+    "@irtio/protocol": "0.5.0",
+    "@irtio/schema": "0.5.0"
   },
   "peerDependencies": {
     "@dimforge/rapier3d-compat": ">=0.20.0"