onelobby 0.3.1 → 0.5.0

package/dist/onelobby.d.ts

@@ -4,8 +4,9 @@ import { Lobby, type RateLimit } from "./lobby.js";
 import { type LobbySummary } from "./signaling.js";
 import { type LinkFactory, type SocketFactory } from "./transport.js";
 import type { VoiceCodec, FrameSource, AudioSink } from "./voice-types.js";
+import { type Blueprint } from "./blueprint.js";
 export declare const LIB_NAME = "onelobby";
-export declare const LIB_VERSION = "0.3.1";
+export declare const LIB_VERSION = "0.5.0";
 /** Where `rememberSeat` keeps the resume token: the subset of the Web Storage API it uses. */
 export interface SeatStorage {
     getItem(key: string): string | null;
@@ -73,6 +74,16 @@ export interface OneLobbyOptions {
     /** @deprecated use `advanced.createSink` */
     createSink?: (() => AudioSink) | null;
 }
+/** Per-launch settings for `OneLobby.fromConfig`; everything else comes from the blueprint. */
+export interface FromConfigOverrides {
+    /** The player's name. Checked against `players.identity` and `players.maxNameLength`. */
+    displayName?: string;
+    /** Wins over `hosting.lobbyServer` (the file is the bottom layer: put `?lobby=` / storage / `<meta>` lookups here). */
+    lobbyServer?: string;
+    /** Default: `lobby.rejoin` from the file. */
+    rememberSeat?: boolean;
+    advanced?: AdvancedOptions;
+}
 export interface HostOptions {
     name: string;
     maxPlayers: number;
@@ -120,6 +131,16 @@ export declare class OneLobby extends Emitter<OneLobbyEvents> {
     private createMic;
     private createSink;
     private storage;
+    /** The validated, frozen onelobby.json this kit was built from (`OneLobby.fromConfig`); undefined for `new OneLobby`. */
+    readonly blueprint?: Blueprint;
+    /**
+     * Build a kit from an onelobby.json (already parsed; docs/design/blueprint.md s.7). Throws `bad_config` for an
+     * invalid file or name, `identity_anonymous` for a name when `players.identity` is "anonymous". Then `host()` and
+     * `hostDirect()` default their options from the file and the file's chat/listing switches are enforced.
+     */
+    static fromConfig(json: unknown, overrides?: FromConfigOverrides): OneLobby;
+    /** @internal Host options the blueprint implies (empty without one). */
+    blueprintHostDefaults(): Partial<HostOptions>;
     constructor(o: OneLobbyOptions);
     private get seatKey();
     private loadSeat;
@@ -134,8 +155,11 @@ export declare class OneLobby extends Emitter<OneLobbyEvents> {
     resume(): Promise<Lobby | null>;
     private helloMsg;
     private connect;
+    /** The signaling socket only (no hello yet); with a timeout (direct IP), no answer is `direct_unreachable`. */
+    private open;
     private makeLobby;
-    host(h: HostOptions): Promise<Lobby>;
+    /** With a blueprint (`fromConfig`) every option defaults from `lobby.*`; explicit options win. */
+    host(opts?: Partial<HostOptions>): Promise<Lobby>;
     join(code: string): Promise<Lobby>;
     /**
      * Join a direct-IP host (docs/direct-ip.md): a join code from the host's screen (`6B01-RGFE-P2B`, any case, spaces
@@ -144,8 +168,16 @@ export declare class OneLobby extends Emitter<OneLobbyEvents> {
      * The address is also given to ICE as the host's UDP candidate. When the host leaves, `sessionEnded("host_left")`.
      */
     joinDirect(codeOrAddress: string, opts?: JoinDirectOptions): Promise<Lobby>;
+    /**
+     * Take a direct-IP seat back after a drop or a restart: the code (or address) joined before and that lobby's
+     * `resumeToken` (save it after every join; it changes on each resume). The host keeps a dropped seat for 60 s and the
+     * same peer id comes back. Rejects with `invalid_token` when the seat is gone: offer `joinDirect` then.
+     */
+    rejoinDirect(codeOrAddress: string, resumeToken: string, opts?: JoinDirectOptions): Promise<Lobby>;
+    private directTarget;
     /** @internal onelobby/direct's host: create the one lobby on the embedded hub, in direct mode. */
     hostDirectWith(h: HostOptions, hooks: DirectLobbyHooks): Promise<Lobby>;
     rejoin(resumeToken: string): Promise<Lobby>;
+    private resumeAt;
     list(opts?: ListOptions): Promise<LobbySummary[]>;
 }