@diffenderfer-games/hub 2.0.0-next.0 → 2.0.0-next.10

package/dist/shared/social.d.ts

@@ -1,8 +1,9 @@
 import "./wire-types.js";
-import { n as HubMpApi } from "./multiplayer-types.js";
-import { n as HubRoomsApi } from "./room-types.js";
+import { n as HubMpApi, r as InviteLinkMethods } from "./multiplayer-types.js";
+import { n as HubRoomsApi, s as RoomReclaimMethods } from "./room-types.js";
 import { t as HubRaceApi } from "./race-types.js";
-import { Audience, ChatMode, ChatMode as ChatMode$1, Conversation, Counts, ErrorBody, FriendEntry, FriendEntry as FriendEntry$1, Invite, Invite as Invite$1, JoinInfo as JoinInfo$1, Launch as Launch$1, LaunchTicket, Message, MessagesPage, NotifyChange, NotifyPrefs, Party, Party as Party$1, PlayerCard, PlayerLite, Presence, Presence as Presence$1, PresenceInput, PresenceInput as PresenceInput$1, PresenceKind, RaceOutcome, RaceParams as RaceParams$1, RaceRecord, RaceResult as RaceResult$1, RaceStatValue, RaceState, RaceStats as RaceStats$1, Racer, RacerResult, RacerState, RecentPlayer, Relation, ReportInput, ReportKind, ReportReason, RoomInfo as RoomInfo$1, SocialConfig, SocialMe, Suggestion, SuggestionStatus } from "@diffenderfer-games/hub-contract";
+import { AvatarLook } from "@diffenderfer-games/hub-contract/avatar";
+import { Audience, ChatMode, ChatMode as ChatMode$1, Conversation, Counts, ErrorBody, EventData, EventName, FriendEntry, FriendEntry as FriendEntry$1, Invite, Invite as Invite$1, JoinInfo as JoinInfo$1, Launch as Launch$1, LaunchTicket, Message, MessagesPage, NotifyChange, NotifyPrefs, OpAck, OpInput, OpName, Party, Party as Party$1, PlayerCard, PlayerLite, Presence, Presence as Presence$1, PresenceInput, PresenceInput as PresenceInput$1, PresenceKind, RaceOutcome, RaceParams as RaceParams$1, RaceRecord, RaceResult as RaceResult$1, RaceStatValue, RaceState, RaceStats as RaceStats$1, Racer, RacerResult, RacerState, RecentPlayer, Relation, ReportInput, ReportKind, ReportReason, RoomInfo as RoomInfo$1, SocialConfig, SocialMe, Suggestion, SuggestionStatus, events, ops } from "@diffenderfer-games/hub-contract";
 //#region src/realtime/social-types.d.ts
 /** Online counts as a game sees them. */
 interface SocialCounts {
@@ -65,6 +66,11 @@ interface HubSocialApi {
   openNotify(options?: {
     game?: string;
   }): void;
+  /**
+   * Open "Play online": games waiting for a player, invites, tournaments and
+   * the quick 1v1 (feature version 4; a no-op on older runtimes).
+   */
+  openPlayOnline(): void;
   /** Friends with live presence. Rejects with `OfflineError` without the runtime. */
   friends(): Promise<FriendEntry[]>;
   /** Live counts; all zero until the runtime is up. */
@@ -74,6 +80,8 @@ interface HubSocialApi {
   /** Subscribe to social events; works before the runtime loads. Returns the unsubscribe function. */
   on<Name extends keyof SocialEvents>(event: Name, listener: (payload: SocialEvents[Name]) => void): () => void;
 }
+/** What feature version 4 added to `hub.social`. */
+type PlayOnlineMethods = Pick<HubSocialApi, 'openPlayOnline'>;
 /** `hub.notify`: toast behaviour during intense play. */
 interface HubNotifyApi {
   /** Quiet: toasts collapse into the menu badge; invites still show as a small pill. */
@@ -101,12 +109,74 @@ interface RealtimeHubLink {
 /** Called once by the core client so forwarder errors use its classes and tickets use its REST client. */
 declare function linkRealtimeToHub(link: RealtimeHubLink): void;
 //#endregion
+//#region src/core/avatar/avatar-types.d.ts
+/**
+ * A player's avatar as games hold it: the code (pass it to any renderer),
+ * the decoded look, whether it is their generated default, and whether the
+ * player is hidden from you (draw the silhouette).
+ */
+interface AvatarRef {
+  readonly code: string;
+  /** `null` when hidden or the code is malformed (renderers draw the silhouette). */
+  readonly look: AvatarLook | null;
+  /** They never designed one: this is their generated default. */
+  readonly isDefault: boolean;
+  /** Hidden where the username is hidden (§2.8). */
+  readonly hidden: boolean;
+}
+/** A player's avatar changed (`hub.avatar.on('change')`). */
+interface AvatarChange {
+  readonly userId: number;
+  readonly ref: AvatarRef;
+}
+/** Options for the designer. */
+interface OpenDesignerOptions {
+  /** Why it opened (`'game'`, `'world'`, …), for metrics only. */
+  readonly reason?: string;
+}
+/** What the designer reports when it closes. */
+interface DesignerResult {
+  /** The player saved a new look. */
+  readonly saved: boolean;
+}
+/** What the social runtime adds for avatars (feature version 5). */
+interface RuntimeAvatarApi {
+  /** Open "Make your avatar" over the page; resolves when it closes. */
+  openDesigner(options?: OpenDesignerOptions): Promise<DesignerResult>;
+  /** Live `ev:avatar` changes (yours, friends', your room's). */
+  on(event: 'change', listener: (change: {
+    readonly userId: number;
+    readonly code: string;
+  }) => void): () => void;
+}
+//#endregion
+//#region src/realtime/world-types.d.ts
+/** A `world.*` op name. */
+type WorldOpName = Extract<OpName, `world.${string}`>;
+/** A `world.*` event name. */
+type WorldEventName = Extract<EventName, `world.${string}`>;
+/** `rt.world` (realtime feature version 6 and later). */
+interface RuntimeWorldApi {
+  /** Send a world op on the page's socket; rejects with the hub's refusal. */
+  op<Name extends WorldOpName>(name: Name, input: OpInput<(typeof ops)[Name]>): Promise<OpAck<(typeof ops)[Name]>>;
+  /** Hear a world event; returns the unsubscribe. */
+  on<Name extends WorldEventName>(name: Name, listener: (payload: EventData<(typeof events)[Name]>) => void): () => void;
+}
+//#endregion
 //#region src/realtime/runtime-api.d.ts
 /**
  * The realtime feature version the runtime reports in {@link RealtimeApi.version}.
- * 2 added races; a client feature-detects newer additions with it.
+ * 2 added races; 3 added invite links and taking back a held seat; 4 added
+ * "Play online" (tournaments); 5 added avatars (the designer and `ev:avatar`); 6 added the world (`world`).
+ * A client feature-detects newer additions with it (or by the optional method).
  */
-declare const REALTIME_FEATURE_VERSION = 2;
+declare const REALTIME_FEATURE_VERSION = 6;
+/** `hub.social` as a runtime installs it: version 4's `openPlayOnline` is missing on older runtimes. */
+type RuntimeSocialApi = Omit<HubSocialApi, keyof PlayOnlineMethods> & Partial<PlayOnlineMethods>;
+/** `hub.mp` as a runtime installs it: version 3's invite-link methods are missing on older runtimes. */
+type RuntimeMpApi = Omit<HubMpApi, keyof InviteLinkMethods> & Partial<InviteLinkMethods>;
+/** `hub.rooms` as a runtime installs it: version 3's `reclaim` is missing on older runtimes. */
+type RuntimeRoomsApi = Omit<HubRoomsApi, keyof RoomReclaimMethods> & Partial<RoomReclaimMethods>;
 /**
  * The cross-bundle shape number of the `rt` page singleton (plan §4.4). The
  * runtime registers with it through `claimSingleton`; bump it only when the
@@ -115,6 +185,13 @@ declare const REALTIME_FEATURE_VERSION = 2;
 declare const REALTIME_SINGLETON_API = 1;
 /** The window event the runtime fires once it has installed itself. */
 declare const REALTIME_READY_EVENT = "hub:rt-ready";
+/**
+ * The window event the runtime fires each time its socket says hello (it
+ * connected, or connected again after a drop), with `{ user: { id, look } }`
+ * from the hello snapshot. `hub.avatar` and `hub.userId()` follow it; changes
+ * sent while the socket was down are fetched again.
+ */
+declare const SESSION_EVENT = "hub:session";
 /** The window event the menu fires when the runtime failed to load (its reason is on `window.__HUB_RT_ERROR__`). */
 declare const REALTIME_FAILED_EVENT = "hub:rt-failed";
 /**
@@ -127,15 +204,19 @@ interface RealtimeApi {
   /** Presence reporting. */
   presence: HubPresenceApi;
   /** Friends and the social dialogs. */
-  social: HubSocialApi;
+  social: RuntimeSocialApi;
   /** Invites, launches, the leave guard and tickets. */
-  mp: HubMpApi;
+  mp: RuntimeMpApi;
   /** Hub relay rooms. */
-  rooms: HubRoomsApi;
+  rooms: RuntimeRoomsApi;
   /** Toast behaviour. */
   notify: HubNotifyApi;
   /** Races (feature version 2 and later). */
   race?: HubRaceApi;
+  /** Avatars: the designer and live changes (feature version 5 and later). */
+  avatar?: RuntimeAvatarApi;
+  /** The world's ops and events (feature version 6 and later). */
+  world?: RuntimeWorldApi;
 }
 //#endregion
 //#region src/realtime/page-runtime.d.ts
@@ -144,5 +225,5 @@ declare function isRealtimeApi(candidate: unknown): candidate is RealtimeApi;
 /** The page's realtime API if the runtime has loaded, else `null`. */
 declare function findRealtimeApi(): RealtimeApi | null;
 //#endregion
-export { HubNotifyApi as $, RacerState as A, SuggestionStatus as B, RaceRecord as C, RaceStats$1 as D, RaceState as E, ReportReason as F, REALTIME_READY_EVENT as G, isRealtimeApi as H, RoomInfo$1 as I, RealtimeHubLink as J, REALTIME_SINGLETON_API as K, SocialConfig as L, Relation as M, ReportInput as N, Racer as O, ReportKind as P, socialForwarder as Q, SocialMe as R, RaceParams$1 as S, RaceStatValue as T, REALTIME_FAILED_EVENT as U, findRealtimeApi as V, REALTIME_FEATURE_VERSION as W, notifyForwarder as X, linkRealtimeToHub as Y, presenceForwarder as Z, PlayerLite as _, ErrorBody as a, SocialEvents as at, PresenceKind as b, JoinInfo$1 as c, Message as d, HubPresenceApi as et, MessagesPage as f, PlayerCard as g, Party$1 as h, Counts as i, SocialCounts as it, RecentPlayer as j, RacerResult as k, Launch$1 as l, NotifyPrefs as m, ChatMode$1 as n, OpenInviteOptions as nt, FriendEntry$1 as o, NotifyChange as p, RealtimeApi as q, Conversation as r, PlayerRef as rt, Invite$1 as s, Audience as t, HubSocialApi as tt, LaunchTicket as u, Presence$1 as v, RaceResult$1 as w, RaceOutcome as x, PresenceInput$1 as y, Suggestion as z };
+export { AvatarRef as $, RacerState as A, SuggestionStatus as B, RaceRecord as C, RaceStats$1 as D, RaceState as E, ReportReason as F, REALTIME_READY_EVENT as G, isRealtimeApi as H, RoomInfo$1 as I, SESSION_EVENT as J, REALTIME_SINGLETON_API as K, SocialConfig as L, Relation as M, ReportInput as N, Racer as O, ReportKind as P, AvatarChange as Q, SocialMe as R, RaceParams$1 as S, RaceStatValue as T, REALTIME_FAILED_EVENT as U, findRealtimeApi as V, REALTIME_FEATURE_VERSION as W, WorldEventName as X, RuntimeWorldApi as Y, WorldOpName as Z, PlayerLite as _, ErrorBody as a, notifyForwarder as at, PresenceKind as b, JoinInfo$1 as c, HubNotifyApi as ct, Message as d, OpenInviteOptions as dt, DesignerResult as et, MessagesPage as f, PlayOnlineMethods as ft, PlayerCard as g, Party$1 as h, SocialEvents as ht, Counts as i, linkRealtimeToHub as it, RecentPlayer as j, RacerResult as k, Launch$1 as l, HubPresenceApi as lt, NotifyPrefs as m, SocialCounts as mt, ChatMode$1 as n, RuntimeAvatarApi as nt, FriendEntry$1 as o, presenceForwarder as ot, NotifyChange as p, PlayerRef as pt, RealtimeApi as q, Conversation as r, RealtimeHubLink as rt, Invite$1 as s, socialForwarder as st, Audience as t, OpenDesignerOptions as tt, LaunchTicket as u, HubSocialApi as ut, Presence$1 as v, RaceResult$1 as w, RaceOutcome as x, PresenceInput$1 as y, Suggestion as z };
 //# sourceMappingURL=social.d.ts.map

package/dist/shared/social.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"social.d.ts","names":[],"sources":["../../src/realtime/social-types.ts","../../src/realtime/social-forwarder.ts","../../src/realtime/hub-link.ts","../../src/realtime/runtime-api.ts","../../src/realtime/page-runtime.ts"],"mappings":";;;;;;;UAOiB;;EAEf;;EAEA;;EAEA;;;UAIe;;EAEf,SAAS;;EAET;IAAY;IAAgB,GAAG;;;EAE/B,QAAQ;;EAER,QAAQ;;EAER,OAAO;;;KAIG;EAAc;;EAAqB;;;UAG9B;;EAEf;;EAEA;;;UAIe;;EAEf,IAAI,UAAU;;EAEd;;;UAIe;;EAEf,WAAW,KAAK;;EAEhB;;EAEA,SAAS;;EAET,WAAW,UAAU;;EAErB;;EAEA,WAAW;IAAY;;;EAEvB,WAAW,QAAQ;;EAEnB,UAAU;;EAEV,SAAS,qBAAqB;;EAE9B,GAAG,mBAAmB,cAAc,OAAO,MAAM,WAAW,SAAS,aAAa;;;UAInE;;EAEf,SAAS;;;;;cC5DE,mBAAmB;;cAYnB,iBAAiB;;cAQjB,iBAAiB;;;;UCzBb;;EAGf,WAAW,iBAAiB;;EAE5B,mBAAmB,kBAAkB;;EAErC,uBAAuB;;;iBAuCT,kBAAkB,MAAM;;;;;;;cC3C3B;;;;;;cAOA;;cAGA;;cAGA;;;;;UAMI;;WAEN;;EAET,UAAU;;EAEV,QAAQ;;EAER,IAAI;;EAEJ,OAAO;;EAEP,QAAQ;;EAER,OAAO;;;;;iBCnCO,cAAc,qBAAqB,aAAa;;iBAsBhD,mBAAmB"}
+{"version":3,"file":"social.d.ts","names":[],"sources":["../../src/realtime/social-types.ts","../../src/realtime/social-forwarder.ts","../../src/realtime/hub-link.ts","../../src/core/avatar/avatar-types.ts","../../src/realtime/world-types.ts","../../src/realtime/runtime-api.ts","../../src/realtime/page-runtime.ts"],"mappings":";;;;;;;;UAOiB;;EAEf;;EAEA;;EAEA;;;UAIe;;EAEf,SAAS;;EAET;IAAY;IAAgB,GAAG;;;EAE/B,QAAQ;;EAER,QAAQ;;EAER,OAAO;;;KAIG;EAAc;;EAAqB;;;UAG9B;;EAEf;;EAEA;;;UAIe;;EAEf,IAAI,UAAU;;EAEd;;;UAIe;;EAEf,WAAW,KAAK;;EAEhB;;EAEA,SAAS;;EAET,WAAW,UAAU;;EAErB;;EAEA,WAAW;IAAY;;;;;;EAKvB;;EAEA,WAAW,QAAQ;;EAEnB,UAAU;;EAEV,SAAS,qBAAqB;;EAE9B,GAAG,mBAAmB,cAAc,OAAO,MAAM,WAAW,SAAS,aAAa;;;KAIxE,oBAAoB,KAAK;;UAGpB;;EAEf,SAAS;;;;;cCpEE,mBAAmB;;cAYnB,iBAAiB;;cAQjB,iBAAiB;;;;UCzBb;;EAGf,WAAW,iBAAiB;;EAE5B,mBAAmB,kBAAkB;;EAErC,uBAAuB;;;iBAuCT,kBAAkB,MAAM;;;;;;;;UCjDvB;WACN;;WAEA,MAAM;;WAEN;;WAEA;;;UAIM;WACN;WACA,KAAK;;;UAIC;;WAEN;;;UAIM;;WAEN;;;UAIM;;EAEf,aAAa,UAAU,sBAAsB,QAAQ;;EAErD,GAAG,iBAAiB,WAAW;aAAmB;aAAyB;;;;;;KCjCjE,cAAc,QAAQ;;KAGtB,iBAAiB,QAAQ;;UAGpB;;EAEf,GAAG,aAAa,aAAa,MAAM,MAAM,OAAO,gBAAgB,KAAK,SAAS,QAAQ,cAAc,KAAK;;EAEzG,GAAG,aAAa,gBAAgB,MAAM,MAAM,WAAW,SAAS,kBAAkB,QAAQ;;;;;;;;;;cCA/E;;KAGD,mBAAmB,KAAK,oBAAoB,qBAAqB,QAAQ;;KAGzE,eAAe,KAAK,gBAAgB,qBAAqB,QAAQ;;KAGjE,kBAAkB,KAAK,mBAAmB,sBAAsB,QAAQ;;;;;;cAOvE;;cAGA;;;;;;;cAQA;;cAGA;;;;;UAMI;;WAEN;;EAET,UAAU;;EAEV,QAAQ;;EAER,IAAI;;EAEJ,OAAO;;EAEP,QAAQ;;EAER,OAAO;;EAEP,SAAS;;EAET,QAAQ;;;;;iBC5DM,cAAc,qBAAqB,aAAa;;iBAsBhD,mBAAmB"}

package/dist/shared/social.js

@@ -1,4 +1,4 @@
-import { t as pageBridge } from "./bridge.js";
+import { n as pageBridge } from "./bridge.js";
 import { t as latestState } from "./latest-state.js";
 import { t as createRuntimeOpener } from "./runtime-opener.js";
 //#region src/realtime/social-forwarder.ts
@@ -62,6 +62,11 @@ const socialForwarder = {
 			realtime.social.openNotify(options);
 		});
 	},
+	openPlayOnline: () => {
+		openWithRuntime((realtime) => {
+			realtime.social.openPlayOnline?.();
+		});
+	},
 	friends: () => pageBridge.call((realtime) => realtime.social.friends()),
 	counts: () => pageBridge.current()?.social.counts() ?? { ...NO_COUNTS },
 	chatMode: (userIds) => pageBridge.current()?.social.chatMode(userIds) ?? "off",

package/dist/shared/social.js.map

@@ -1 +1 @@
-{"version":3,"file":"social.js","names":[],"sources":["../../src/realtime/social-forwarder.ts"],"mappings":";;;;;;;;;AAUA,MAAM,kBAAkB,oBAAoB,UAAU;;AAGtD,MAAM,YAA0B;CAAE,QAAQ;CAAG,QAAQ;CAAG,eAAe;AAAE;;AAGzE,MAAa,oBAAoC;CAC/C,IAAI,UAAU;EACZ,YAAY,WAAW,EAAE,GAAG,SAAS;EACrC,WAAW,QAAQ,CAAC,EAAE,SAAS,IAAI,YAAY,QAAQ;CACzD;CACA,QAAQ;EACN,YAAY,WAAW,EAAE,MAAM,OAAO;EACtC,WAAW,QAAQ,CAAC,EAAE,SAAS,MAAM;CACvC;AACF;;AAGA,MAAa,kBAAgC,EAC3C,SAAS,SAAS;CAChB,YAAY,UAAU;CACtB,WAAW,QAAQ,CAAC,EAAE,OAAO,SAAS,OAAO;AAC/C,EACF;;AAGA,MAAa,kBAAgC;CAC3C,aAAa,QAAQ;EACnB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,WAAW,GAAG;EAChC,CAAC;CACH;CACA,mBAAmB;EACjB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,YAAY;EAC9B,CAAC;CACH;CACA,WAAW,WAAW;EACpB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,SAAS,MAAM;EACjC,CAAC;CACH;CACA,aAAa,YAAY;EACvB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,WAAW,OAAO;EACpC,CAAC;CACH;CACA,mBAAmB;EACjB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,YAAY;EAC9B,CAAC;CACH;CACA,aAAa,YAAY;EACvB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,WAAW,OAAO;EACpC,CAAC;CACH;CACA,eAAe,WAAW,MAAM,aAAa,SAAS,OAAO,QAAQ,CAAC;CACtE,cAAc,WAAW,QAAQ,CAAC,EAAE,OAAO,OAAO,KAAK,EAAE,GAAG,UAAU;CACtE,WAAW,YAAY,WAAW,QAAQ,CAAC,EAAE,OAAO,SAAS,OAAO,KAAK;CACzE,KAAK,OAAO,aAAa,WAAW,WAAW,aAAa,SAAS,OAAO,GAAG,OAAO,QAAQ,CAAC;AACjG"}
+{"version":3,"file":"social.js","names":[],"sources":["../../src/realtime/social-forwarder.ts"],"mappings":";;;;;;;;;AAUA,MAAM,kBAAkB,oBAAoB,UAAU;;AAGtD,MAAM,YAA0B;CAAE,QAAQ;CAAG,QAAQ;CAAG,eAAe;AAAE;;AAGzE,MAAa,oBAAoC;CAC/C,IAAI,UAAU;EACZ,YAAY,WAAW,EAAE,GAAG,SAAS;EACrC,WAAW,QAAQ,CAAC,EAAE,SAAS,IAAI,YAAY,QAAQ;CACzD;CACA,QAAQ;EACN,YAAY,WAAW,EAAE,MAAM,OAAO;EACtC,WAAW,QAAQ,CAAC,EAAE,SAAS,MAAM;CACvC;AACF;;AAGA,MAAa,kBAAgC,EAC3C,SAAS,SAAS;CAChB,YAAY,UAAU;CACtB,WAAW,QAAQ,CAAC,EAAE,OAAO,SAAS,OAAO;AAC/C,EACF;;AAGA,MAAa,kBAAgC;CAC3C,aAAa,QAAQ;EACnB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,WAAW,GAAG;EAChC,CAAC;CACH;CACA,mBAAmB;EACjB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,YAAY;EAC9B,CAAC;CACH;CACA,WAAW,WAAW;EACpB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,SAAS,MAAM;EACjC,CAAC;CACH;CACA,aAAa,YAAY;EACvB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,WAAW,OAAO;EACpC,CAAC;CACH;CACA,mBAAmB;EACjB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,YAAY;EAC9B,CAAC;CACH;CACA,aAAa,YAAY;EACvB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,WAAW,OAAO;EACpC,CAAC;CACH;CACA,sBAAsB;EACpB,iBAAiB,aAAa;GAC5B,SAAS,OAAO,iBAAiB;EACnC,CAAC;CACH;CACA,eAAe,WAAW,MAAM,aAAa,SAAS,OAAO,QAAQ,CAAC;CACtE,cAAc,WAAW,QAAQ,CAAC,EAAE,OAAO,OAAO,KAAK,EAAE,GAAG,UAAU;CACtE,WAAW,YAAY,WAAW,QAAQ,CAAC,EAAE,OAAO,SAAS,OAAO,KAAK;CACzE,KAAK,OAAO,aAAa,WAAW,WAAW,aAAa,SAAS,OAAO,GAAG,OAAO,QAAQ,CAAC;AACjG"}