@wvdsh/sdk-js 1.3.11 → 1.3.12

package/dist/client.d.ts

@@ -1,5 +1,5 @@
 import { WavedashSDK } from './index.js';
-export { BackendConnectionPayload, EngineInstance, Friend, FullscreenChangedPayload, Leaderboard, LeaderboardDisplayType, LeaderboardEntries, LeaderboardSortOrder, Lobby, LobbyDataUpdatedPayload, LobbyInvite, LobbyInvitePayload, LobbyJoinResponse, LobbyJoinedPayload, LobbyKickedPayload, LobbyKickedReason, LobbyMessage, LobbyMessagePayload, LobbyUser, LobbyUserChangeType, LobbyUsersUpdatedPayload, LobbyVisibility, P2PConfig, P2PConnection, P2PConnectionEstablishedPayload, P2PConnectionFailedPayload, P2PMessage, P2PPacketDropReason, P2PPacketDroppedPayload, P2PPeer, P2PPeerDisconnectedPayload, P2PPeerReconnectedPayload, P2PPeerReconnectingPayload, RemoteFileMetadata, StatsStoredPayload, UGCType, UGCVisibility, UpsertedLeaderboardEntry, WavedashConfig, WavedashEvent, WavedashEventMap, WavedashResponse } from './index.js';
+export { BackendConnectionPayload, EngineInstance, Friend, FullscreenChangedPayload, Leaderboard, LeaderboardDisplayType, LeaderboardEntries, LeaderboardSortOrder, ListUGCItemsArgs, Lobby, LobbyDataUpdatedPayload, LobbyInvite, LobbyInvitePayload, LobbyJoinResponse, LobbyJoinedPayload, LobbyKickedPayload, LobbyKickedReason, LobbyMessage, LobbyMessagePayload, LobbyUser, LobbyUserChangeType, LobbyUsersUpdatedPayload, LobbyVisibility, P2PConfig, P2PConnection, P2PConnectionEstablishedPayload, P2PConnectionFailedPayload, P2PMessage, P2PPacketDropReason, P2PPacketDroppedPayload, P2PPeer, P2PPeerDisconnectedPayload, P2PPeerReconnectedPayload, P2PPeerReconnectingPayload, PaginatedUGCItems, RemoteFileMetadata, StatsStoredPayload, UGCItem, UGCType, UGCVisibility, UpdateUGCItemArgs, UpsertedLeaderboardEntry, WavedashConfig, WavedashEvent, WavedashEventMap, WavedashResponse } from './index.js';
 export { GameLaunchParams } from '@wvdsh/api';
 export { GenericId as Id } from 'convex/values';
 import 'convex/browser';

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import { ConvexClient } from 'convex/browser';
 import { GenericId } from 'convex/values';
 export { GenericId as Id } from 'convex/values';
-import { FunctionReturnType } from 'convex/server';
+import { FunctionReturnType, FunctionArgs } from 'convex/server';
 import { LOBBY_VISIBILITY, api, UGC_TYPE, UGC_VISIBILITY, LEADERBOARD_SORT_ORDER, LEADERBOARD_DISPLAY_TYPE, GAME_ENGINE, SDKUser, IFrameEventPayloadMap, IFRAME_MESSAGE_TYPE, SDKConfig, GameLaunchParams } from '@wvdsh/api';
 export { GameLaunchParams } from '@wvdsh/api';
 
@@ -71,6 +71,13 @@ type LeaderboardSortOrder = (typeof LEADERBOARD_SORT_ORDER)[keyof typeof LEADERB
 type LeaderboardDisplayType = (typeof LEADERBOARD_DISPLAY_TYPE)[keyof typeof LEADERBOARD_DISPLAY_TYPE];
 type UGCType = (typeof UGC_TYPE)[keyof typeof UGC_TYPE];
 type UGCVisibility = (typeof UGC_VISIBILITY)[keyof typeof UGC_VISIBILITY];
+type UpdateUGCItemArgs = Omit<FunctionArgs<typeof api.sdk.userGeneratedContent.updateUGCItem>, "ugcId" | "createPresignedUploadUrl"> & {
+    filePath?: string;
+};
+type UGCItem = FunctionReturnType<typeof api.sdk.userGeneratedContent.listUGCItems>["page"][0];
+type PaginatedUGCItems = FunctionReturnType<typeof api.sdk.userGeneratedContent.listUGCItems>;
+type RawListUGCItemsArgs = FunctionArgs<typeof api.sdk.userGeneratedContent.listUGCItems>;
+type ListUGCItemsArgs = Omit<RawListUGCItemsArgs, "filters"> & NonNullable<RawListUGCItemsArgs["filters"]>;
 type LobbyUser = FunctionReturnType<typeof api.sdk.gameLobby.lobbyUsers>[0];
 type LobbyMessage = FunctionReturnType<typeof api.sdk.gameLobby.lobbyMessages>[0];
 type Lobby = FunctionReturnType<typeof api.sdk.gameLobby.listAvailable>[0];
@@ -429,9 +436,10 @@ declare class FileSystemManager extends WavedashManager {
 declare class UGCManager extends WavedashManager {
     constructor(sdk: WavedashSDK);
     createUGCItem(ugcType: UGCType, title?: string, description?: string, visibility?: UGCVisibility, filePath?: string): Promise<GenericId<"userGeneratedContent">>;
-    updateUGCItem(ugcId: GenericId<"userGeneratedContent">, title?: string, description?: string, visibility?: UGCVisibility, filePath?: string): Promise<GenericId<"userGeneratedContent">>;
+    updateUGCItem(ugcId: GenericId<"userGeneratedContent">, updates?: UpdateUGCItemArgs): Promise<GenericId<"userGeneratedContent">>;
     deleteUGCItem(ugcId: GenericId<"userGeneratedContent">): Promise<GenericId<"userGeneratedContent">>;
     downloadUGCItem(ugcId: GenericId<"userGeneratedContent">, filePath: string): Promise<GenericId<"userGeneratedContent">>;
+    listUGCItems(args?: ListUGCItemsArgs): Promise<PaginatedUGCItems>;
 }
 
 /**
@@ -634,7 +642,7 @@ declare class HeartbeatManager extends WavedashManager {
      * @param data - Data to send to the backend
      * @returns true if the presence was updated successfully
      */
-    updateUserPresence(data?: Record<string, unknown>): Promise<boolean>;
+    updateUserPresence(data?: Record<string, string | number | boolean | null>): Promise<boolean>;
     /**
      * Tests the connection to the backend
      */
@@ -848,7 +856,6 @@ declare class WavedashSDK extends EventTarget {
     };
     UGCVisibility: {
         readonly PUBLIC: 0;
-        readonly FRIENDS_ONLY: 1;
         readonly PRIVATE: 2;
     };
     AvatarSize: {
@@ -998,21 +1005,19 @@ declare class WavedashSDK extends EventTarget {
     createUGCItem(ugcType: UGCType, title?: string, description?: string, visibility?: UGCVisibility, filePath?: string): Promise<WavedashResponse<GenericId<"userGeneratedContent">>>;
     /**
      * Updates a UGC item and uploads the file to the server if a filePath is provided
-     * TODO: GD Script cannot call with optional arguments, convert this to accept a single dictionary of updates
-     * @param ugcId
-     * @param title
-     * @param description
-     * @param visibility
-     * @param filePath - optional IndexedDB key file path to upload to the server. If not provided, the UGC item will be updated but no file will be uploaded.
+     * @param ugcId - The ID of the UGC item to update
+     * @param updates - Object containing the fields to update. May also be passed
+     *   as a JSON string by engine bridges (Godot) that can't marshal a dict.
      * @returns ugcId
      */
-    updateUGCItem(ugcId: GenericId<"userGeneratedContent">, title?: string, description?: string, visibility?: UGCVisibility, filePath?: string): Promise<WavedashResponse<GenericId<"userGeneratedContent">>>;
+    updateUGCItem(ugcId: GenericId<"userGeneratedContent">, updates?: UpdateUGCItemArgs): Promise<WavedashResponse<GenericId<"userGeneratedContent">>>;
     /**
      * Delete a UGC item: removes the row, the R2 object, and frees up the
      * user's storage quota by the size of the deleted upload.
      */
     deleteUGCItem(ugcId: GenericId<"userGeneratedContent">): Promise<WavedashResponse<GenericId<"userGeneratedContent">>>;
     downloadUGCItem(ugcId: GenericId<"userGeneratedContent">, filePath: string): Promise<WavedashResponse<GenericId<"userGeneratedContent">>>;
+    listUGCItems(args?: ListUGCItemsArgs): Promise<WavedashResponse<PaginatedUGCItems>>;
     /**
      * Deletes a remote file from storage
      * @param filePath - The path of the remote file to delete
@@ -1158,11 +1163,10 @@ declare class WavedashSDK extends EventTarget {
     getLobbyInviteLink(copyToClipboard?: boolean): Promise<WavedashResponse<string>>;
     /**
      * Updates rich user presence so friends can see what the player is doing in game
-     * TODO: data param should be more strongly typed
      * @param data Game data to send to the backend
      * @returns true if the presence was updated successfully
      */
-    updateUserPresence(data?: Record<string, unknown>): Promise<WavedashResponse<boolean>>;
+    updateUserPresence(data?: Record<string, string | number | boolean | null>): Promise<WavedashResponse<boolean>>;
     private isGodot;
     private formatResponse;
     private ensureInit;
@@ -1209,4 +1213,4 @@ declare global {
 
 declare function setupWavedashSDK(): WavedashSDK;
 
-export { type BackendConnectionPayload, type EngineInstance, type Friend, type FullscreenChangedPayload, type Leaderboard, type LeaderboardDisplayType, type LeaderboardEntries, type LeaderboardSortOrder, type Lobby, type LobbyDataUpdatedPayload, type LobbyInvite, type LobbyInvitePayload, type LobbyJoinResponse, type LobbyJoinedPayload, type LobbyKickedPayload, type LobbyKickedReason, type LobbyMessage, type LobbyMessagePayload, type LobbyUser, type LobbyUserChangeType, type LobbyUsersUpdatedPayload, type LobbyVisibility, type P2PConfig, type P2PConnection, type P2PConnectionEstablishedPayload, type P2PConnectionFailedPayload, type P2PMessage, type P2PPacketDropReason, type P2PPacketDroppedPayload, type P2PPeer, type P2PPeerDisconnectedPayload, type P2PPeerReconnectedPayload, type P2PPeerReconnectingPayload, type RemoteFileMetadata, type StatsStoredPayload, type UGCType, type UGCVisibility, type UpsertedLeaderboardEntry, type WavedashConfig, type WavedashEvent, type WavedashEventMap, type WavedashResponse, WavedashSDK, setupWavedashSDK };
+export { type BackendConnectionPayload, type EngineInstance, type Friend, type FullscreenChangedPayload, type Leaderboard, type LeaderboardDisplayType, type LeaderboardEntries, type LeaderboardSortOrder, type ListUGCItemsArgs, type Lobby, type LobbyDataUpdatedPayload, type LobbyInvite, type LobbyInvitePayload, type LobbyJoinResponse, type LobbyJoinedPayload, type LobbyKickedPayload, type LobbyKickedReason, type LobbyMessage, type LobbyMessagePayload, type LobbyUser, type LobbyUserChangeType, type LobbyUsersUpdatedPayload, type LobbyVisibility, type P2PConfig, type P2PConnection, type P2PConnectionEstablishedPayload, type P2PConnectionFailedPayload, type P2PMessage, type P2PPacketDropReason, type P2PPacketDroppedPayload, type P2PPeer, type P2PPeerDisconnectedPayload, type P2PPeerReconnectedPayload, type P2PPeerReconnectingPayload, type PaginatedUGCItems, type RemoteFileMetadata, type StatsStoredPayload, type UGCItem, type UGCType, type UGCVisibility, type UpdateUGCItemArgs, type UpsertedLeaderboardEntry, type WavedashConfig, type WavedashEvent, type WavedashEventMap, type WavedashResponse, WavedashSDK, setupWavedashSDK };

package/dist/index.js

@@ -1033,7 +1033,8 @@ var UGCManager = class extends WavedashManager {
     }
     return ugcId;
   }
-  async updateUGCItem(ugcId, title, description, visibility, filePath) {
+  async updateUGCItem(ugcId, updates = {}) {
+    const { title, description, visibility, filePath } = updates;
     const { uploadUrl } = await this.sdk.convexClient.mutation(
       api3.sdk.userGeneratedContent.updateUGCItem,
       {
@@ -1079,6 +1080,18 @@ var UGCManager = class extends WavedashManager {
     }
     return ugcId;
   }
+  async listUGCItems(args = {}) {
+    const { createdBy, ugcType, titleSearch, numItems, continueCursor } = args;
+    const filters = createdBy !== void 0 || ugcType !== void 0 || titleSearch !== void 0 ? { createdBy, ugcType, titleSearch } : void 0;
+    return await this.sdk.convexClient.query(
+      api3.sdk.userGeneratedContent.listUGCItems,
+      {
+        filters,
+        numItems,
+        continueCursor
+      }
+    );
+  }
 };
 
 // src/services/leaderboards.ts
@@ -3362,11 +3375,29 @@ function vUnion(...variants) {
     throw new Error(`${path}: no variant matched, got ${describeValue(value)}`);
   };
 }
+function vObject(shape) {
+  return (value, path) => {
+    const obj = vRecord(value, path);
+    for (const key of Object.keys(obj)) {
+      if (!(key in shape)) {
+        throw new Error(`${path}: unrecognized property "${key}"`);
+      }
+    }
+    for (const key of Object.keys(shape)) {
+      shape[key](obj[key], `${path}.${key}`);
+    }
+    return obj;
+  };
+}
 function validateArgs(methodName, specs, values) {
+  const shape = {};
+  const obj = {};
   for (let i = 0; i < specs.length; i++) {
     const [argName, validator] = specs[i];
-    validator(values[i], `${methodName}.${argName}`);
+    shape[argName] = validator;
+    obj[argName] = values[i];
   }
+  vObject(shape)(obj, methodName);
 }
 function describeValue(value) {
   if (value === void 0) return "undefined";
@@ -3817,30 +3848,45 @@ var WavedashSDK = class extends EventTarget {
   }
   /**
    * Updates a UGC item and uploads the file to the server if a filePath is provided
-   * TODO: GD Script cannot call with optional arguments, convert this to accept a single dictionary of updates
-   * @param ugcId
-   * @param title
-   * @param description
-   * @param visibility
-   * @param filePath - optional IndexedDB key file path to upload to the server. If not provided, the UGC item will be updated but no file will be uploaded.
+   * @param ugcId - The ID of the UGC item to update
+   * @param updates - Object containing the fields to update. May also be passed
+   *   as a JSON string by engine bridges (Godot) that can't marshal a dict.
    * @returns ugcId
    */
-  async updateUGCItem(ugcId, title, description, visibility, filePath) {
+  async updateUGCItem(ugcId, updates = {}) {
+    if (typeof updates === "string") {
+      const raw = updates;
+      try {
+        updates = JSON.parse(raw);
+      } catch (error) {
+        const message = `updateUGCItem: invalid JSON: ${raw}`;
+        logger.error(message, error);
+        return this.formatResponse({
+          success: false,
+          data: null,
+          message
+        });
+      }
+    }
     return this.apiCall(
       this.ugcManager,
       "updateUGCItem",
       [
         ["ugcId", vId("userGeneratedContent")],
-        ["title", vOptional(vString)],
-        ["description", vOptional(vString)],
-        ["visibility", vOptional(vEnum(UGC_VISIBILITY, "UGCVisibility"))],
-        ["filePath", vOptional(vString)]
+        [
+          "updates",
+          vOptional(
+            vObject({
+              title: vOptional(vString),
+              description: vOptional(vString),
+              visibility: vOptional(vEnum(UGC_VISIBILITY, "UGCVisibility")),
+              filePath: vOptional(vString)
+            })
+          )
+        ]
       ],
       ugcId,
-      title,
-      description,
-      visibility,
-      filePath
+      updates
     );
   }
   /**
@@ -3867,6 +3913,47 @@ var WavedashSDK = class extends EventTarget {
       filePath
     );
   }
+  async listUGCItems(args = {}) {
+    if (typeof args === "string") {
+      const raw = args;
+      try {
+        args = JSON.parse(raw);
+      } catch (error) {
+        const message = `listUGCItems: invalid JSON: ${raw}`;
+        logger.error(message, error);
+        return this.formatResponse({
+          success: false,
+          data: null,
+          message
+        });
+      }
+    }
+    return this.apiCall(
+      this.ugcManager,
+      "listUGCItems",
+      [
+        [
+          "args",
+          vOptional((value, path) => {
+            const obj = vObject({
+              createdBy: vOptional(vId("users")),
+              ugcType: vOptional(vEnum(UGC_TYPE, "UGCType")),
+              titleSearch: vOptional(vString),
+              numItems: vOptional(vNumber),
+              continueCursor: vOptional(vString)
+            })(value, path);
+            if (obj.continueCursor !== void 0 && (obj.createdBy !== void 0 || obj.ugcType !== void 0 || obj.titleSearch !== void 0 || obj.numItems !== void 0)) {
+              throw new Error(
+                `${path}: continueCursor should be the only argument if present`
+              );
+            }
+            return obj;
+          })
+        ]
+      ],
+      args
+    );
+  }
   // ================================
   // Save state / Remote File Storage
   // ================================
@@ -4282,7 +4369,6 @@ var WavedashSDK = class extends EventTarget {
   // ==============================
   /**
    * Updates rich user presence so friends can see what the player is doing in game
-   * TODO: data param should be more strongly typed
    * @param data Game data to send to the backend
    * @returns true if the presence was updated successfully
    */

package/package.json

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