@wvdsh/sdk-js 1.3.6 → 1.3.8

package/dist/index.d.ts

@@ -82,6 +82,7 @@ type LeaderboardEntries = FunctionReturnType<typeof api.sdk.leaderboards.listEnt
 type UpsertedLeaderboardEntry = FunctionReturnType<typeof api.sdk.leaderboards.upsertLeaderboardEntry>["entry"] & {
     userId: GenericId<"users">;
     username: string;
+    userAvatarUrl?: string;
 };
 type WavedashEvent = (typeof WavedashEvents)[keyof typeof WavedashEvents];
 interface WavedashConfig {
@@ -701,18 +702,8 @@ declare class OverlayManager extends WavedashManager {
 
 declare class FriendsManager extends WavedashManager {
     private userCache;
+    private leaderboardPageUserCache;
     constructor(sdk: WavedashSDK);
-    /**
-     * Cache users from any source (friends, lobby users)
-     * Accepts both Friend format (avatarUrl) and LobbyUser format (userAvatarUrl)
-     * @param users - Array of users with userId, username, and optional avatar r2Key
-     */
-    cacheUsers(users: Array<{
-        userId: GenericId<"users">;
-        username: string;
-        avatarUrl?: string;
-        userAvatarUrl?: string;
-    }>): void;
     /**
      * Returns CDN URL with size transformation for a cached user's avatar.
      * @param userId - The user ID to get the avatar URL for
@@ -727,6 +718,15 @@ declare class FriendsManager extends WavedashManager {
      * @returns The username, or null if user not cached
      */
     getUsername(userId: GenericId<"users">): string | null;
+    /**
+     * List all friends for the logged in user
+     * @returns Array<{
+     *   avatarUrl?: string;
+     *   isOnline: boolean;
+     *   userId: Id<"users">;
+     *   username: string;
+     * }>
+     */
     listFriends(): Promise<Friend[]>;
 }
 

package/dist/index.js

@@ -1063,7 +1063,8 @@ var LeaderboardManager = class extends WavedashManager {
     const entry = result.entry ? {
       ...result.entry,
       userId: this.sdk.wavedashUser.id,
-      username: this.sdk.wavedashUser.username
+      username: this.sdk.wavedashUser.username,
+      userAvatarUrl: this.sdk.wavedashUser.avatarUrl
     } : null;
     return entry ? [entry] : [];
   }
@@ -1075,6 +1076,7 @@ var LeaderboardManager = class extends WavedashManager {
     if (result && result.totalEntries) {
       this.updateCachedTotalEntries(leaderboardId, result.totalEntries);
     }
+    this.sdk.friendsManager.cacheLeaderboardPage(result.entries);
     return result.entries;
   }
   async listLeaderboardEntries(leaderboardId, offset, limit, friendsOnly = false) {
@@ -1085,6 +1087,7 @@ var LeaderboardManager = class extends WavedashManager {
     if (result && result.totalEntries) {
       this.updateCachedTotalEntries(leaderboardId, result.totalEntries);
     }
+    this.sdk.friendsManager.cacheLeaderboardPage(result.entries);
     return result.entries;
   }
   async uploadLeaderboardScore(leaderboardId, score, keepBest, ugcId) {
@@ -1098,7 +1101,8 @@ var LeaderboardManager = class extends WavedashManager {
     return {
       ...result.entry,
       userId: this.sdk.wavedashUser.id,
-      username: this.sdk.wavedashUser.username
+      username: this.sdk.wavedashUser.username,
+      userAvatarUrl: this.sdk.wavedashUser.avatarUrl
     };
   }
   // ================
@@ -3008,21 +3012,10 @@ function getCdnImageUrl(r2Key, host, options) {
 var FriendsManager = class extends WavedashManager {
   constructor(sdk) {
     super(sdk);
+    // Persistent cache for users with a durable relationship (self, friends, shared lobby).
     this.userCache = /* @__PURE__ */ new Map();
-  }
-  /**
-   * Cache users from any source (friends, lobby users)
-   * Accepts both Friend format (avatarUrl) and LobbyUser format (userAvatarUrl)
-   * @param users - Array of users with userId, username, and optional avatar r2Key
-   */
-  cacheUsers(users) {
-    for (const user of users) {
-      this.userCache.set(user.userId, {
-        username: user.username,
-        // Support both Friend (avatarUrl) and LobbyUser (userAvatarUrl) formats
-        avatarR2Key: user.avatarUrl ?? user.userAvatarUrl
-      });
-    }
+    // Transient cache for only the most recently loaded leaderboard page. Cleared on each new page.
+    this.leaderboardPageUserCache = /* @__PURE__ */ new Map();
   }
   /**
    * Returns CDN URL with size transformation for a cached user's avatar.
@@ -3032,7 +3025,7 @@ var FriendsManager = class extends WavedashManager {
    * @returns CDN URL with size transformation, or null if user not cached or has no avatar
    */
   getUserAvatarUrl(userId, size = AvatarSize.MEDIUM) {
-    const user = this.userCache.get(userId);
+    const user = this.userCache.get(userId) ?? this.leaderboardPageUserCache.get(userId);
     if (!user?.avatarR2Key) {
       return null;
     }
@@ -3050,8 +3043,17 @@ var FriendsManager = class extends WavedashManager {
    * @returns The username, or null if user not cached
    */
   getUsername(userId) {
-    return this.userCache.get(userId)?.username ?? null;
+    return this.userCache.get(userId)?.username ?? this.leaderboardPageUserCache.get(userId)?.username ?? null;
   }
+  /**
+   * List all friends for the logged in user
+   * @returns Array<{
+   *   avatarUrl?: string;
+   *   isOnline: boolean;
+   *   userId: Id<"users">;
+   *   username: string;
+   * }>
+   */
   async listFriends() {
     const friends = await this.sdk.convexClient.query(
       api8.sdk.friends.listFriends,
@@ -3060,6 +3062,39 @@ var FriendsManager = class extends WavedashManager {
     this.cacheUsers(friends);
     return friends;
   }
+  /**
+   * Cache users from any source (friends, lobby users)
+   * Accepts both Friend format (avatarUrl) and LobbyUser format (userAvatarUrl)
+   * @param users - Array of users with userId, username, and optional avatar r2Key
+   * @internal
+   */
+  cacheUsers(users) {
+    for (const user of users) {
+      this.userCache.set(user.userId, {
+        username: user.username,
+        // Support both Friend (avatarUrl) and LobbyUser (userAvatarUrl) formats
+        avatarR2Key: user.avatarUrl ?? user.userAvatarUrl
+      });
+    }
+  }
+  /**
+   * Replace the leaderboard-page cache with the users from a single page of
+   * leaderboard entries.
+   * 
+   * In general devs should just use the username and userAvatarUrl returned
+   * from `listLeaderboardEntries` directly, but we cache the latest leaderboard
+   * page here just so getUserAvatarUrl and getUsername still work for the current page.
+   * @internal
+   */
+  cacheLeaderboardPage(users) {
+    this.leaderboardPageUserCache.clear();
+    for (const user of users) {
+      this.leaderboardPageUserCache.set(user.userId, {
+        username: user.username,
+        avatarR2Key: user.userAvatarUrl
+      });
+    }
+  }
 };
 
 // src/utils/logger.ts

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@wvdsh/sdk-js",
-  "version": "1.3.6",
+  "version": "1.3.8",
   "type": "module",
   "description": "Wavedash JavaScript SDK",
   "main": "./dist/client.js",
@@ -49,7 +49,7 @@
     "typescript-eslint": "^8.52.0"
   },
   "dependencies": {
-    "@wvdsh/api": "^0.1.14",
+    "@wvdsh/api": "^0.1.16",
     "convex": "^1.34.0",
     "lodash.throttle": "^4.1.1"
   }