@diffenderfer-games/hub 2.0.0-next.6 → 2.0.0-next.7

package/src/core/page-account.ts

@@ -1,121 +1,121 @@
-/**
- * Who the page is signed in as, as the hub tells it, so `hub.userId()` and
- * `hub.avatar` follow the account without the game calling `hub.me()`:
- *
- * - the menu's `hub:account` (every refresh: after it makes a new guest's
- *   account, after sign-in) and `hub:auth` (the account changed);
- * - the social runtime's {@link SESSION_EVENT} each time its socket says
- *   hello (connected, or connected again after a drop);
- * - this client's own sign-in, sign-up, claim and sign-out.
- *
- * One per page: every bundle's copy hears the same window events.
- */
-import { readField } from '../realtime/cross-bundle';
-import { SESSION_EVENT } from '../realtime/runtime-api';
-import { isBrowserPage } from './page';
-
-/** The window events that say who is signed in (`{ user }`). */
-const ACCOUNT_EVENTS = ['hub:account', 'hub:auth'] as const;
-
-/** The signed-in player as the page heard it. */
-export interface PageUser {
-  readonly id: number;
-  /** Their look code when the source carried it, else `null`. */
-  readonly look: string | null;
-}
-
-/** Where the news came from: an account event, or a socket hello (a time to catch up on what was missed). */
-export type AccountSource = 'account' | 'session';
-
-/** Hears every report of who is signed in. */
-export type AccountListener = (user: PageUser | null, source: AccountSource) => void;
-
-/** The page's account, as last heard. */
-export class PageAccount {
-  /** `undefined` until something said; `null` when signed out. */
-  private heard: PageUser | null | undefined = undefined;
-  private readonly listeners = new Set<AccountListener>();
-  private isListening = false;
-
-  constructor() {
-    this.listen();
-  }
-
-  /** The signed-in player, `null` when signed out, `undefined` before anything said. */
-  get user(): PageUser | null | undefined {
-    this.listen();
-    return this.heard;
-  }
-
-  /** Record who is signed in (this client's own sign-in or sign-out) and tell the listeners. */
-  note(user: PageUser | null, source: AccountSource = 'account'): void {
-    this.heard = user;
-    for (const listener of [...this.listeners]) {
-      listener(user, source);
-    }
-  }
-
-  /** Hear every report; returns the unsubscribe function. */
-  on(listener: AccountListener): () => void {
-    this.listen();
-    this.listeners.add(listener);
-    return () => {
-      this.listeners.delete(listener);
-    };
-  }
-
-  /** Listen to the window events (at once in a page; made before a window existed, on first use). */
-  private listen(): void {
-    if (this.isListening || !isBrowserPage()) {
-      return;
-    }
-    this.isListening = true;
-    for (const eventName of ACCOUNT_EVENTS) {
-      window.addEventListener(eventName, (event) => { this.onEvent(event, 'account'); });
-    }
-    window.addEventListener(SESSION_EVENT, (event) => { this.onEvent(event, 'session'); });
-  }
-
-  private onEvent(event: Event, source: AccountSource): void {
-    if (!(event instanceof CustomEvent)) {
-      return;
-    }
-    const user = readUser(event.detail);
-    if (user !== undefined) {
-      this.note(user, source);
-    }
-  }
-}
-
-/** A page user from an account the hub sent (`look` when it has one). */
-export function toPageUser(user: { readonly id: number; readonly look?: string | undefined }): PageUser {
-  return { id: user.id, look: lookOrNull(user.look) };
-}
-
-/** A non-empty look code, else `null`. */
-// eslint-disable-next-line no-restricted-syntax -- trust boundary: a field of another bundle's event detail
-function lookOrNull(look: unknown): string | null {
-  return typeof look === 'string' && look !== '' ? look : null;
-}
-
-/** The user in a `{ user }` detail: the user, `null` (signed out), or `undefined` (it doesn't say). */
-// eslint-disable-next-line no-restricted-syntax -- trust boundary: another bundle's event detail, read field by field
-function readUser(detail: unknown): PageUser | null | undefined {
-  const user = readField(detail, 'user');
-  if (user === null) {
-    return null;
-  }
-  const id = readField(user, 'id');
-  if (typeof id !== 'number' || !Number.isInteger(id)) {
-    return undefined;
-  }
-  return { id, look: lookOrNull(readField(user, 'look')) };
-}
-
-let pageAccountSingleton: PageAccount | null = null;
-
-/** The page's account tracker (made on first use; the hub client makes it at load). */
-export function pageAccount(): PageAccount {
-  pageAccountSingleton ??= new PageAccount();
-  return pageAccountSingleton;
-}
+/**
+ * Who the page is signed in as, as the hub tells it, so `hub.userId()` and
+ * `hub.avatar` follow the account without the game calling `hub.me()`:
+ *
+ * - the menu's `hub:account` (every refresh: after it makes a new guest's
+ *   account, after sign-in) and `hub:auth` (the account changed);
+ * - the social runtime's {@link SESSION_EVENT} each time its socket says
+ *   hello (connected, or connected again after a drop);
+ * - this client's own sign-in, sign-up, claim and sign-out.
+ *
+ * One per page: every bundle's copy hears the same window events.
+ */
+import { readField } from '../realtime/cross-bundle';
+import { SESSION_EVENT } from '../realtime/runtime-api';
+import { isBrowserPage } from './page';
+
+/** The window events that say who is signed in (`{ user }`). */
+const ACCOUNT_EVENTS = ['hub:account', 'hub:auth'] as const;
+
+/** The signed-in player as the page heard it. */
+export interface PageUser {
+  readonly id: number;
+  /** Their look code when the source carried it, else `null`. */
+  readonly look: string | null;
+}
+
+/** Where the news came from: an account event, or a socket hello (a time to catch up on what was missed). */
+export type AccountSource = 'account' | 'session';
+
+/** Hears every report of who is signed in. */
+export type AccountListener = (user: PageUser | null, source: AccountSource) => void;
+
+/** The page's account, as last heard. */
+export class PageAccount {
+  /** `undefined` until something said; `null` when signed out. */
+  private heard: PageUser | null | undefined = undefined;
+  private readonly listeners = new Set<AccountListener>();
+  private isListening = false;
+
+  constructor() {
+    this.listen();
+  }
+
+  /** The signed-in player, `null` when signed out, `undefined` before anything said. */
+  get user(): PageUser | null | undefined {
+    this.listen();
+    return this.heard;
+  }
+
+  /** Record who is signed in (this client's own sign-in or sign-out) and tell the listeners. */
+  note(user: PageUser | null, source: AccountSource = 'account'): void {
+    this.heard = user;
+    for (const listener of [...this.listeners]) {
+      listener(user, source);
+    }
+  }
+
+  /** Hear every report; returns the unsubscribe function. */
+  on(listener: AccountListener): () => void {
+    this.listen();
+    this.listeners.add(listener);
+    return () => {
+      this.listeners.delete(listener);
+    };
+  }
+
+  /** Listen to the window events (at once in a page; made before a window existed, on first use). */
+  private listen(): void {
+    if (this.isListening || !isBrowserPage()) {
+      return;
+    }
+    this.isListening = true;
+    for (const eventName of ACCOUNT_EVENTS) {
+      window.addEventListener(eventName, (event) => { this.onEvent(event, 'account'); });
+    }
+    window.addEventListener(SESSION_EVENT, (event) => { this.onEvent(event, 'session'); });
+  }
+
+  private onEvent(event: Event, source: AccountSource): void {
+    if (!(event instanceof CustomEvent)) {
+      return;
+    }
+    const user = readUser(event.detail);
+    if (user !== undefined) {
+      this.note(user, source);
+    }
+  }
+}
+
+/** A page user from an account the hub sent (`look` when it has one). */
+export function toPageUser(user: { readonly id: number; readonly look?: string | undefined }): PageUser {
+  return { id: user.id, look: lookOrNull(user.look) };
+}
+
+/** A non-empty look code, else `null`. */
+// eslint-disable-next-line no-restricted-syntax -- trust boundary: a field of another bundle's event detail
+function lookOrNull(look: unknown): string | null {
+  return typeof look === 'string' && look !== '' ? look : null;
+}
+
+/** The user in a `{ user }` detail: the user, `null` (signed out), or `undefined` (it doesn't say). */
+// eslint-disable-next-line no-restricted-syntax -- trust boundary: another bundle's event detail, read field by field
+function readUser(detail: unknown): PageUser | null | undefined {
+  const user = readField(detail, 'user');
+  if (user === null) {
+    return null;
+  }
+  const id = readField(user, 'id');
+  if (typeof id !== 'number' || !Number.isInteger(id)) {
+    return undefined;
+  }
+  return { id, look: lookOrNull(readField(user, 'look')) };
+}
+
+let pageAccountSingleton: PageAccount | null = null;
+
+/** The page's account tracker (made on first use; the hub client makes it at load). */
+export function pageAccount(): PageAccount {
+  pageAccountSingleton ??= new PageAccount();
+  return pageAccountSingleton;
+}

package/src/core/version/client-version.gen.ts

@@ -1,3 +1,3 @@
 // Generated by tools/hub-client/generate.ts. Do not edit; run `npm run gen:hub-client`.
 /** This client's package version, sent as `x-hub-client` on REST calls and `client` in `hello`. */
-export const HUB_CLIENT_VERSION = '2.0.0-next.6';
+export const HUB_CLIENT_VERSION = '2.0.0-next.7';

package/src/overlay/overlay.ts

@@ -215,9 +215,9 @@ export class Overlay implements NavHighlighter {
   }
 }
 
-/** Every inset side. */
-const INSET_SIDES: readonly (keyof Insets)[] = ['top', 'right', 'bottom', 'left'];
-
+/** Every inset side. */
+const INSET_SIDES: readonly (keyof Insets)[] = ['top', 'right', 'bottom', 'left'];
+
 /** The page-wide CSS variables other hub UI (the runtime's toasts) keeps clear of. */
 function publishInsets(insets: Partial<Insets>): void {
   if (typeof document === 'undefined') {