Expand Steamworks parity bindings

Author: raub

CHECKLIST.md

@@ -14,7 +14,7 @@
 - [x] `greenworks.getCurrentUILanguage()`
 - [x] `greenworks.getCurrentGameInstallDir()`
 - [x] `greenworks.getAppInstallDir(appId, buffer, buffer_size)`
-- [ ] `greenworks.getNumberOfPlayers(success_callback, [error_callback])`
+- [x] `greenworks.getNumberOfPlayers(success_callback, [error_callback])`
 - [x] `greenworks.activateGameOverlay(option)`
 - [x] `game-overlay-activated` event
 - [x] `greenworks.activateGameOverlayToWebPage(url)`
@@ -45,18 +45,18 @@
 ## Authentication
 
 - [x] `greenworks.getAuthSessionTicket(success_callback, [error_callback])`
-- [ ] `greenworks.getAuthSessionTicketForWebAPI(identity, success_callback, [error_callback])`
+- [x] `greenworks.getAuthSessionTicketForWebAPI(identity, success_callback, [error_callback])`
 - [x] `greenworks.cancelAuthTicket(ticket_handle)`
-- [ ] `greenworks.beginAuthSessionAsUser(ticket, steam_id)`
-- [ ] `greenworks.endAuthSessionAsUser(steam_id)`
-- [ ] `greenworks.getEncryptedAppTicket(user_data, success_callback, [error_callback])`
-- [ ] `greenworks.decryptAppTicket(encrypted_ticket, decryption_key)`
-- [ ] `greenworks.isTicketForApp(decrypted_ticket, app_id)`
-- [ ] `greenworks.getTicketIssueTime(decrypted_ticket)`
-- [ ] `greenworks.getTicketSteamId(decrypted_ticket)`
-- [ ] `greenworks.getTicketAppId(decrypted_ticket)`
-- [ ] `greenworks.EncryptedAppTicketSymmetricKeyLength`
-- [ ] `validate-auth-ticket` event
+- [x] `greenworks.beginAuthSessionAsUser(ticket, steam_id)`
+- [x] `greenworks.endAuthSessionAsUser(steam_id)`
+- [x] `greenworks.getEncryptedAppTicket(user_data, success_callback, [error_callback])`
+- [x] `greenworks.decryptAppTicket(encrypted_ticket, decryption_key)`
+- [x] `greenworks.isTicketForApp(decrypted_ticket, app_id)`
+- [x] `greenworks.getTicketIssueTime(decrypted_ticket)`
+- [x] `greenworks.getTicketSteamId(decrypted_ticket)`
+- [x] `greenworks.getTicketAppId(decrypted_ticket)`
+- [x] `greenworks.EncryptedAppTicketSymmetricKeyLength`
+- [x] `validate-auth-ticket` event
 
 ## Achievements and Stats
 
@@ -74,146 +74,139 @@
 
 ## Cloud and Remote Storage
 
-- [ ] `greenworks.saveTextToFile(file_name, file_content, success_callback, [error_callback])`
-- [ ] `greenworks.readTextFromFile(file_name, success_callback, [error_callback])`
-- [ ] `greenworks.deleteFile(file_name, success_callback, [error_callback])`
-- [ ] `greenworks.saveFilesToCloud(files_path, success_callback, [error_callback])`
-- [ ] `greenworks.isCloudEnabledForUser()`
-- [ ] `greenworks.isCloudEnabled()`
-- [ ] `greenworks.enableCloud(flag)`
-- [ ] `greenworks.getCloudQuota(success_callback, [error_callback])`
-- [ ] `greenworks.getFileCount()`
-- [ ] `greenworks.getFileNameAndSize(index)`
+- [x] `greenworks.saveTextToFile(file_name, file_content, success_callback, [error_callback])`
+- [x] `greenworks.readTextFromFile(file_name, success_callback, [error_callback])`
+- [x] `greenworks.deleteFile(file_name, success_callback, [error_callback])`
+- [x] `greenworks.saveFilesToCloud(files_path, success_callback, [error_callback])`
+- [x] `greenworks.isCloudEnabledForUser()`
+- [x] `greenworks.isCloudEnabled()`
+- [x] `greenworks.enableCloud(flag)`
+- [x] `greenworks.getCloudQuota(success_callback, [error_callback])`
+- [x] `greenworks.getFileCount()`
+- [x] `greenworks.getFileNameAndSize(index)`
 
 ## Friends and SteamID
 
-- [ ] `SteamID.isAnonymous()`
-- [ ] `SteamID.isAnonymousGameServer()`
-- [ ] `SteamID.isAnonymousGameServerLogin()`
-- [ ] `SteamID.isAnonymousUser()`
-- [ ] `SteamID.isChatAccount()`
-- [ ] `SteamID.isClanAccount()`
-- [ ] `SteamID.isConsoleUserAccount()`
-- [ ] `SteamID.isContentServerAccount()`
-- [ ] `SteamID.isGameServerAccount()`
-- [ ] `SteamID.isIndividualAccount()`
-- [ ] `SteamID.isPersistentGameServerAccount()`
-- [ ] `SteamID.isLobby()`
-- [ ] `SteamID.getAccountID()`
-- [ ] `SteamID.getRawSteamID()`
-- [ ] `SteamID.getAccountType()`
-- [ ] `SteamID.isValid()`
-- [ ] `SteamID.getStaticAccountKey()`
-- [ ] `SteamID.getPersonaName()`
-- [ ] `SteamID.getNickname()`
-- [ ] `SteamID.getRelationship()`
-- [ ] `SteamID.getSteamLevel()`
-- [ ] `greenworks.getFriendCount(friend_flag)`
-- [ ] `greenworks.getFriends(friend_flag)`
-- [ ] `greenworks.requestUserInformation(raw_steam_id, require_name_only)`
-- [ ] `greenworks.getSmallFriendAvatar(raw_steam_id)`
-- [ ] `greenworks.getMediumFriendAvatar(raw_steam_id)`
-- [ ] `greenworks.getLargeFriendAvatar(raw_steam_id)`
-- [ ] `greenworks.setListenForFriendsMessage(intercept_enabled)`
-- [ ] `greenworks.replyToFriendMessage(raw_steam_id, message)`
-- [ ] `greenworks.getFriendMessage(raw_steam_id, message_id, maximum_message_size)`
-- [ ] `greenworks.getFriendPersonaName(raw_steam_id)`
-- [ ] `greenworks.setRichPresence(pchKey, pchValue)`
-- [ ] `greenworks.clearRichPresence()`
-- [ ] `greenworks.getFriendRichPresence(steamIDFriend, pchKey)`
-- [ ] `greenworks.setPlayedWith(steamIDUserPlayedWith)`
-- [ ] `greenworks.getFriendGamePlayed(steamIDFriend)`
-- [ ] `greenworks.activateGameOverlayInviteDialog(steamIDLobby)`
-- [ ] `greenworks.activateGameOverlayToUser(pchDialog, steamID)`
-- [ ] `persona-state-change` event
-- [ ] `avatar-image-loaded` event
-- [ ] `game-connected-friend-chat-message` event
-- [ ] `rich-presence-join-requested` event
+- [x] `SteamID.isAnonymous()`
+- [x] `SteamID.isAnonymousGameServer()`
+- [x] `SteamID.isAnonymousGameServerLogin()`
+- [x] `SteamID.isAnonymousUser()`
+- [x] `SteamID.isChatAccount()`
+- [x] `SteamID.isClanAccount()`
+- [x] `SteamID.isConsoleUserAccount()`
+- [x] `SteamID.isContentServerAccount()`
+- [x] `SteamID.isGameServerAccount()`
+- [x] `SteamID.isIndividualAccount()`
+- [x] `SteamID.isPersistentGameServerAccount()`
+- [x] `SteamID.isLobby()`
+- [x] `SteamID.getAccountID()`
+- [x] `SteamID.getRawSteamID()`
+- [x] `SteamID.getAccountType()`
+- [x] `SteamID.isValid()`
+- [x] `SteamID.getStaticAccountKey()`
+- [x] `SteamID.getPersonaName()`
+- [x] `SteamID.getNickname()`
+- [x] `SteamID.getRelationship()`
+- [x] `SteamID.getSteamLevel()`
+- [x] `greenworks.getFriendCount(friend_flag)`
+- [x] `greenworks.getFriends(friend_flag)`
+- [x] `greenworks.requestUserInformation(raw_steam_id, require_name_only)`
+- [x] `greenworks.getSmallFriendAvatar(raw_steam_id)`
+- [x] `greenworks.getMediumFriendAvatar(raw_steam_id)`
+- [x] `greenworks.getLargeFriendAvatar(raw_steam_id)`
+- [x] `greenworks.setListenForFriendsMessage(intercept_enabled)`
+- [x] `greenworks.replyToFriendMessage(raw_steam_id, message)`
+- [x] `greenworks.getFriendMessage(raw_steam_id, message_id, maximum_message_size)`
+- [x] `greenworks.getFriendPersonaName(raw_steam_id)`
+- [x] `greenworks.setRichPresence(pchKey, pchValue)`
+- [x] `greenworks.clearRichPresence()`
+- [x] `greenworks.getFriendRichPresence(steamIDFriend, pchKey)`
+- [x] `greenworks.setPlayedWith(steamIDUserPlayedWith)`
+- [x] `greenworks.getFriendGamePlayed(steamIDFriend)`
+- [x] `greenworks.activateGameOverlayInviteDialog(steamIDLobby)`
+- [x] `greenworks.activateGameOverlayToUser(pchDialog, steamID)`
+- [x] `persona-state-change` event
+- [x] `avatar-image-loaded` event
+- [x] `game-connected-friend-chat-message` event
+- [x] `rich-presence-join-requested` event
 
 ## Workshop and UGC
 
-- [ ] `greenworks.fileShare(file_path, success_callback, [error_callback])`
-- [ ] `greenworks.publishWorkshopFile([options,] file_path, image_path, title, description, success_callback, [error_callback])`
-- [ ] `greenworks.updatePublishedWorkshopFile([options,] published_file_handle, file_path, image_path, title, description, success_callback, [error_callback])`
-- [ ] `greenworks.ugcPublish(file_path, title, description, image_path, success_callback, [error_callback], [progress_callback])`
-- [ ] `greenworks.ugcPublishUpdate(published_file_handle, file_path, title, description, image_path, success_callback, [error_callback], [progress_callback])`
-- [ ] `greenworks.ugcGetItems([options,] ugc_matching_type, ugc_query_type, success_callback, [error_callback])`
-- [ ] `greenworks.ugcGetUserItems([options,] ugc_matching_type, ugc_list_sort_order, ugc_list, success_callback, [error_callback])`
-- [ ] `greenworks.ugcDownloadItem(download_file_handle, download_dir, success_callback, [error_callback])`
-- [ ] `greenworks.ugcSynchronizeItems([options,] sync_dir, success_callback, [error_callback])`
-- [ ] `greenworks.ugcUnsubscribe(published_file_handle, success_callback, [error_callback])`
-- [ ] `greenworks.ugcShowOverlay([published_file_id])`
-- [ ] `greenworks.ugcGetItemState(published_file_id)`
-- [ ] `greenworks.ugcGetItemInstallInfo(published_file_id)`
-- [ ] `_publishWorkshopFile`
-- [ ] `_updatePublishedWorkshopFile`
-- [ ] `_ugcGetItems`
-- [ ] `_ugcGetUserItems`
-- [ ] `_ugcSynchronizeItems`
-- [ ] `SteamUGCDetails`
+- [x] `greenworks.fileShare(file_path, success_callback, [error_callback])`
+- [x] `greenworks.publishWorkshopFile([options,] file_path, image_path, title, description, success_callback, [error_callback])`
+- [x] `greenworks.updatePublishedWorkshopFile([options,] published_file_handle, file_path, image_path, title, description, success_callback, [error_callback])`
+- [x] `greenworks.ugcPublish(file_path, title, description, image_path, success_callback, [error_callback], [progress_callback])`
+- [x] `greenworks.ugcPublishUpdate(published_file_handle, file_path, title, description, image_path, success_callback, [error_callback], [progress_callback])`
+- [x] `greenworks.ugcGetItems([options,] ugc_matching_type, ugc_query_type, success_callback, [error_callback])`
+- [x] `greenworks.ugcGetUserItems([options,] ugc_matching_type, ugc_list_sort_order, ugc_list, success_callback, [error_callback])`
+- [x] `greenworks.ugcDownloadItem(download_file_handle, download_dir, success_callback, [error_callback])`
+- [x] `greenworks.ugcSynchronizeItems([options,] sync_dir, success_callback, [error_callback])`
+- [x] `greenworks.ugcUnsubscribe(published_file_handle, success_callback, [error_callback])`
+- [x] `greenworks.ugcShowOverlay([published_file_id])`
+- [x] `greenworks.ugcGetItemState(published_file_id)`
+- [x] `greenworks.ugcGetItemInstallInfo(published_file_id)`
+- [x] `_publishWorkshopFile`
+- [x] `_updatePublishedWorkshopFile`
+- [x] `_ugcGetItems`
+- [x] `_ugcGetUserItems`
+- [x] `_ugcSynchronizeItems`
+- [x] `SteamUGCDetails`
 
 ## Matchmaking and Lobbies
 
-- [ ] `greenworks.createLobby(lobbyType, maxMembers)`
-- [ ] `greenworks.deleteLobbyData(steamIDLobby, pchKey)`
-- [ ] `greenworks.getLobbyByIndex(iLobby)`
-- [ ] `greenworks.getLobbyData(steamIDLobby, pchKey)`
-- [ ] `greenworks.getLobbyMemberByIndex(steamIDLobby, iMember)`
-- [ ] `greenworks.getNumLobbyMembers(steamIDLobby)`
-- [ ] `greenworks.getLobbyOwner(steamIDLobby)`
-- [ ] `greenworks.inviteUserToLobby(steamIDLobby, steamIDInvitee)`
-- [ ] `greenworks.joinLobby(steamIDLobby)`
-- [ ] `greenworks.leaveLobby(steamIDLobby)`
-- [ ] `greenworks.setLobbyData(steamIDLobby, pchKey, pchValue)`
-- [ ] `greenworks.setLobbyJoinable(steamIDLobby, bLobbyJoinable)`
-- [ ] `greenworks.setLobbyOwner(steamIDLobby, steamIDNewOwner)`
-- [ ] `greenworks.setLobbyType(steamIDLobby, eLobbyType)`
-- [ ] `greenworks.requestLobbyList()`
-- [ ] `greenworks.getLobbyMemberLimit(steamIDLobby)`
-- [ ] `greenworks.setLobbyMemberLimit(steamIDLobby, limit)`
-- [ ] `greenworks.getLobbyMemberData(steamIDLobby, steamIDMember, pchKey)`
-- [ ] `greenworks.setLobbyMemberData(steamIDLobby, pchKey, pchValue)`
-- [ ] `greenworks.getLobbyDataCount(steamIDLobby)`
-- [ ] `greenworks.getLobbyDataByIndex(steamIDLobby, index)`
-- [ ] `greenworks.sendLobbyChatMsg(steamIDLobby, data)`
-- [ ] `greenworks.getLobbyChatEntry(steamIDLobby, chatID)`
-- [ ] `lobby-created` event
-- [ ] `lobby-data-update` event
-- [ ] `lobby-enter` event
-- [ ] `lobby-invite` event
-- [ ] `lobby-join-requested` event
-- [ ] `lobby-match-list` event
-- [ ] `lobby-chat-update` event
-- [ ] `lobby-chat-msg` event
+- [x] `greenworks.createLobby(lobbyType, maxMembers)`
+- [x] `greenworks.deleteLobbyData(steamIDLobby, pchKey)`
+- [x] `greenworks.getLobbyByIndex(iLobby)`
+- [x] `greenworks.getLobbyData(steamIDLobby, pchKey)`
+- [x] `greenworks.getLobbyMemberByIndex(steamIDLobby, iMember)`
+- [x] `greenworks.getNumLobbyMembers(steamIDLobby)`
+- [x] `greenworks.getLobbyOwner(steamIDLobby)`
+- [x] `greenworks.inviteUserToLobby(steamIDLobby, steamIDInvitee)`
+- [x] `greenworks.joinLobby(steamIDLobby)`
+- [x] `greenworks.leaveLobby(steamIDLobby)`
+- [x] `greenworks.setLobbyData(steamIDLobby, pchKey, pchValue)`
+- [x] `greenworks.setLobbyJoinable(steamIDLobby, bLobbyJoinable)`
+- [x] `greenworks.setLobbyOwner(steamIDLobby, steamIDNewOwner)`
+- [x] `greenworks.setLobbyType(steamIDLobby, eLobbyType)`
+- [x] `greenworks.requestLobbyList()`
+- [x] `greenworks.getLobbyMemberLimit(steamIDLobby)`
+- [x] `greenworks.setLobbyMemberLimit(steamIDLobby, limit)`
+- [x] `greenworks.getLobbyMemberData(steamIDLobby, steamIDMember, pchKey)`
+- [x] `greenworks.setLobbyMemberData(steamIDLobby, pchKey, pchValue)`
+- [x] `greenworks.getLobbyDataCount(steamIDLobby)`
+- [x] `greenworks.getLobbyDataByIndex(steamIDLobby, index)`
+- [x] `greenworks.sendLobbyChatMsg(steamIDLobby, data)`
+- [x] `greenworks.getLobbyChatEntry(steamIDLobby, chatID)`
+- [x] `lobby-created` event
+- [x] `lobby-data-update` event
+- [x] `lobby-enter` event
+- [x] `lobby-invite` event
+- [x] `lobby-join-requested` event
+- [x] `lobby-match-list` event
+- [x] `lobby-chat-update` event
+- [x] `lobby-chat-msg` event
 
 ## P2P Networking
 
-- [ ] `greenworks.sendP2PPacket(steamId, sendType, data, nChannel)`
-- [ ] `greenworks.isP2PPacketAvailable(nChannel)`
-- [ ] `greenworks.readP2PPacket(size, nChannel)`
-- [ ] `greenworks.acceptP2PSessionWithUser(steamId)`
-- [ ] `greenworks.getP2PSessionState(steamIDUser)`
-- [ ] `greenworks.closeP2PSessionWithUser(steamIDUser)`
-- [ ] `greenworks.closeP2PChannelWithUser(steamIDUser, nChannel)`
-- [ ] `greenworks.isBehindNAT()`
-- [ ] `p2p-session-request` event
-- [ ] `p2p-session-connect-fail` event
-
-## Archive Utilities
-
-- [ ] `greenworks.Utils.move(source_dir, target_dir, [success_callback], [error_callback])`
-- [ ] `greenworks.Utils.createArchive(zip_file_path, source_dir, password, compress_level, success_callback, [error_callback])`
-- [ ] `greenworks.Utils.extractArchive(zip_file_path, extract_dir, password, success_callback, [error_callback])`
+- [x] `greenworks.sendP2PPacket(steamId, sendType, data, nChannel)`
+- [x] `greenworks.isP2PPacketAvailable(nChannel)`
+- [x] `greenworks.readP2PPacket(size, nChannel)`
+- [x] `greenworks.acceptP2PSessionWithUser(steamId)`
+- [x] `greenworks.getP2PSessionState(steamIDUser)`
+- [x] `greenworks.closeP2PSessionWithUser(steamIDUser)`
+- [x] `greenworks.closeP2PChannelWithUser(steamIDUser, nChannel)`
+- [x] `greenworks.isBehindNAT()`
+- [x] `p2p-session-request` event
+- [x] `p2p-session-connect-fail` event
 
 ## Floating Gamepad Text Input
 
-- [ ] `greenworks.showFloatingGamepadTextInput(keyboardMode, x, y, width, height)`
+- [x] `greenworks.showFloatingGamepadTextInput(keyboardMode, x, y, width, height)`
 - [x] `floating-gamepad-text-input-dismissed` event
 
 ## Constants and Enums
 
-- [ ] `_version`
-- [ ] `EncryptedAppTicketSymmetricKeyLength`
+- [x] `EncryptedAppTicketSymmetricKeyLength`
 - [x] `FriendFlags`
 - [x] `FriendRelationship`
 - [x] `PersonaChange`

CONTRIBUTING.md

@@ -45,16 +45,32 @@ callback polling.
   - `setStat` convenience helper or documented split helpers
 - [x] Phase 2: add typed enum exports.
 - [ ] Phase 2b: add typed result/object types for larger API families.
+  - [x] UGC published file ID, UGC handle, and item install info types.
+  - [x] UGC query details and async query result types.
+  - [x] UGC download and unsubscribe result types.
+  - [x] UGC file share, publish, and update result types.
+  - [x] UGC composed publish/update result types.
+  - [x] UGC sync result types.
 - [x] Phase 3a: refactor callback bridge payloads and cover core Greenworks
   event outcomes.
 - [ ] Phase 3b: expand callback bridge as friends, lobbies, P2P, UGC, and auth
   event families land.
+  - [x] Friends callback events.
+  - [x] Lobby callback events.
+  - [x] P2P networking callback events.
+  - [x] Auth ticket callback events.
 - [ ] Phase 4: implement friends, SteamID object parity or string-first
   equivalents, avatars, chat, and rich presence.
+  - [x] SteamID string-first helper namespace.
+  - [x] Friends, avatars, chat message, rich presence, and played-with methods.
 - [ ] Phase 5: implement remote storage/cloud and callback-style async wrappers.
+  - [x] Cloud text/file writes, reads, delete, settings, quota, and enumeration.
 - [ ] Phase 6: implement matchmaking/lobbies and P2P networking.
-- [ ] Phase 7: implement workshop/UGC and archive utility helpers if still
-  desired.
+  - [x] Matchmaking lobby methods.
+  - [x] P2P packet/session methods.
+- [x] Phase 6b: implement auth session and encrypted app ticket helpers.
+- [x] Phase 6c: implement current player count and floating gamepad text input.
+- [x] Phase 7: implement workshop/UGC equivalents.
 - [ ] Phase 8: keep `GREENWORKS.md` migration mappings current for implemented
   capability families.