@hadoku/prefs-client 1.1.10 → 1.1.11

package/README.md

@@ -147,9 +147,16 @@ const byUser = await resolveAvatars(
   { serviceKey: process.env.SERVICE_KEY! },
   userIds
 );
-// every requested id is present; unknown users resolve to { source: 'sprite' }
+// every requested id is present; unknown users resolve to { source: 'sprite', name: null }
+byUser[id].name; // their live display name, or null for an unknown or closed account
 ```
 
+**Names come from here too.** A server stores only userIds (IDENTITY_MODEL R12) and names
+people, online or not, when it shows them: `resolveAvatars(...)[id].name`. Never keep a copy.
+prefs-api reads the registry at most once a minute per isolate, so a rename shows within a
+minute and a deleted account stops being named. Over HTTP it is `POST /prefs/api/v1/_avatar/resolve`
+`{ userIds }` with a service-tier `X-User-Key`.
+
 Rules for an app that renders avatars:
 
 - **`url` → `<img src>`**, nothing else: never fetch it server-side, never proxy it. Set

package/dist/avatar.d.ts

@@ -93,9 +93,18 @@ interface LinkStart {
 interface ResolveRequest {
     userIds: string[];
 }
+/**
+ * One person as a server shows them: their avatar and their live display name.
+ * `name` is null for an unknown id or a closed (deleted, banned) account, so a
+ * server that stores only userIds (IDENTITY_MODEL R12) names people at display
+ * time and never keeps a copy.
+ */
+interface ResolvedPerson extends ResolvedAvatar {
+    name: string | null;
+}
 interface ResolveResponse {
-    /** Every requested id is present; an unknown user resolves to `{ source: 'sprite' }`. */
-    avatars: Record<string, ResolvedAvatar>;
+    /** Every requested id is present; an unknown user resolves to `{ source: 'sprite', name: null }`. */
+    avatars: Record<string, ResolvedPerson>;
 }
 declare const RESOLVE_MAX_IDS = 100;
 /** A watchparty character id, as prefs-api accepts one from the watchparty blob. */
@@ -156,9 +165,11 @@ interface ResolveAvatarsOptions extends AvatarClientOptions {
     serviceKey: string;
 }
 /**
- * Server-side: resolve many users' avatars by userId. Batches past
+ * Server-side: resolve many users by userId: each one's avatar and live display
+ * `name` (null for an unknown or closed account). Store only the userId and
+ * call this when showing people (IDENTITY_MODEL R12). Batches past
  * RESOLVE_MAX_IDS for you. Every requested id is in the result.
  */
-declare function resolveAvatars(opts: ResolveAvatarsOptions, userIds: readonly string[]): Promise<Record<string, ResolvedAvatar>>;
+declare function resolveAvatars(opts: ResolveAvatarsOptions, userIds: readonly string[]): Promise<Record<string, ResolvedPerson>>;
 
-export { AVATAR_SOURCES, type AvatarClient, type AvatarClientOptions, AvatarError, type AvatarSettings, type AvatarSource, type AvatarUpdate, type AvatarUploadLimits, LINK_CALLBACK_PATH, LINK_MESSAGE_TYPE, LINK_POPUP_MARK, LINK_PROVIDERS, type LinkMessage, type LinkProvider, type LinkStart, type LinkedAccountView, RESOLVE_MAX_IDS, type ResolveAvatarsOptions, type ResolveRequest, type ResolveResponse, type ResolvedAvatar, SPRITE_ID_PATTERN, type UploadView, createAvatarClient, resolveAvatars };
+export { AVATAR_SOURCES, type AvatarClient, type AvatarClientOptions, AvatarError, type AvatarSettings, type AvatarSource, type AvatarUpdate, type AvatarUploadLimits, LINK_CALLBACK_PATH, LINK_MESSAGE_TYPE, LINK_POPUP_MARK, LINK_PROVIDERS, type LinkMessage, type LinkProvider, type LinkStart, type LinkedAccountView, RESOLVE_MAX_IDS, type ResolveAvatarsOptions, type ResolveRequest, type ResolveResponse, type ResolvedAvatar, type ResolvedPerson, SPRITE_ID_PATTERN, type UploadView, createAvatarClient, resolveAvatars };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@hadoku/prefs-client",
-  "version": "1.1.10",
+  "version": "1.1.11",
   "description": "Client SDK for the hadoku unified preferences store. Wraps /prefs/api/v1/* with localStorage caching, debounced writes, Zod-validated reads, and a usePrefs() React hook, plus match history, ratings and leaderboards for every game (./games), and the one resolved avatar per user (./avatar).",
   "type": "module",
   "main": "./dist/index.js",