feat(steam): add friends API

Author: Armaldio

README.md

@@ -36,6 +36,8 @@ The build uses the pluginConfig file to generate everything else.
 The main files you may want to look at would be instance.js
 
 ## Examples Files
+- [discord](./examples/discord.c3p)
+</br>
 - [example](./examples/example.c3p)
 </br>
 - [steam](./examples/steam.c3p)
@@ -267,6 +269,12 @@ When Download type is Around the user, the offsets are the amount of entries aro
 | Get workshop items with metadata | Gets multiple workshop items with their metadata, state, install info, and download info | Item IDs             *(string)* <br>Tag             *(string)* <br> |
 | Get workshop items with metadata | Gets multiple workshop items with their metadata, state, install info, and download info | Item IDs             *(string)* <br> |
 | Get workshop items with metadata | Gets multiple workshop items with their metadata, state, install info, and download info | Item IDs             *(string)* <br>Tag             *(string)* <br> |
+| Get friends | Get an array of friends matching the provided flags. | Flags             *(combo)* <br>Output             *(object)* <br>Tag             *(string)* <br> |
+| Get friends | Get an array of friends matching the provided flags. | Flags             *(combo)* <br>Output             *(object)* <br> |
+| Get friends | Get an array of friends matching the provided flags. | Flags             *(combo)* <br>Output             *(object)* <br>Tag             *(string)* <br> |
+| Get friend name | Get the persona name of a friend. | Steam ID             *(string)* <br>Tag             *(string)* <br> |
+| Get friend name | Get the persona name of a friend. | Steam ID             *(string)* <br> |
+| Get friend name | Get the persona name of a friend. | Steam ID             *(string)* <br>Tag             *(string)* <br> |
 
 
 ---
@@ -477,6 +485,14 @@ When Download type is Around the user, the offsets are the amount of entries aro
 | On any "GetCurrentGameLanguage" success | Trigger when any of the "GetCurrentGameLanguage" are executed with success. |  |
 | On "GetCurrentGameLanguage" error | Trigger when the "GetCurrentGameLanguage" failed to execute. | Tag *(string)* <br> |
 | On any "GetCurrentGameLanguage" error | Trigger when any of the "GetCurrentGameLanguage" failed to execute. |  |
+| On "GetFriends" success | Trigger when the "GetFriends" is executed with success. | Tag *(string)* <br> |
+| On any "GetFriends" success | Trigger when any of the "GetFriends" are executed with success. |  |
+| On "GetFriends" error | Trigger when the "GetFriends" failed to execute. | Tag *(string)* <br> |
+| On any "GetFriends" error | Trigger when any of the "GetFriends" failed to execute. |  |
+| On "GetFriendName" success | Trigger when the "GetFriendName" is executed with success. | Tag *(string)* <br> |
+| On any "GetFriendName" success | Trigger when any of the "GetFriendName" are executed with success. |  |
+| On "GetFriendName" error | Trigger when the "GetFriendName" failed to execute. | Tag *(string)* <br> |
+| On any "GetFriendName" error | Trigger when any of the "GetFriendName" failed to execute. |  |
 | On overlay activated | Triggered when the Steam overlay is activated. |  |
 | On overlay deactivated | Triggered when the Steam overlay is deactivated. |  |
 | On "TriggerScreenshot" success | Trigger when the "TriggerScreenshot" is executed with success. | Tag *(string)* <br> |
@@ -729,6 +745,10 @@ When Download type is Around the user, the offsets are the amount of entries aro
 | WorkshopItemTimestamp | Get the install timestamp of a workshop item | number | Item ID *(string)* <br> | 
 | WorkshopItemDownloadCurrent | Get the current download progress of a workshop item | number | Item ID *(string)* <br> | 
 | WorkshopItemDownloadTotal | Get the total download progress of a workshop item | number | Item ID *(string)* <br> | 
+| GetFriendsError | The error of the "GetFriends last call" | string |  | 
+| GetFriendsResult | The result of the "GetFriends last call" | string |  | 
+| GetFriendNameError | The error of the "GetFriendName last call" | string |  | 
+| GetFriendNameResult | The result of the "GetFriendName last call" | string |  | 
 | ArgumentAt | Get the argument at the given index. | string | Index *(number)* <br> | 
 | ArgumentCount | Get the number of arguments. | number |  | 
 | AppFolderURL | Return the URL of the folder of the current app. | string |  | 
@@ -774,6 +794,14 @@ When Download type is Around the user, the offsets are the amount of entries aro
 | SteamIpCountry | Get the Steam IP country. | string |  | 
 | SteamIsRunningOnSteamDeck | Return true if the app is running on a Steam Deck. | number |  | 
 | SteamAppId | Get the currently used Steam App ID. | number |  | 
+| SteamIsOffline | Return 1 if the provided steam state is Offline (0). | number | State *(number)* <br> | 
+| SteamIsOnline | Return 1 if the provided steam state is Online (1). | number | State *(number)* <br> | 
+| SteamIsBusy | Return 1 if the provided steam state is Busy (2). | number | State *(number)* <br> | 
+| SteamIsAway | Return 1 if the provided steam state is Away (3). | number | State *(number)* <br> | 
+| SteamIsSnooze | Return 1 if the provided steam state is Snooze (4). | number | State *(number)* <br> | 
+| SteamIsLookingToTrade | Return 1 if the provided steam state is Looking to Trade (5). | number | State *(number)* <br> | 
+| SteamIsLookingToPlay | Return 1 if the provided steam state is Looking to Play (6). | number | State *(number)* <br> | 
+| SteamIsInvisible | Return 1 if the provided steam state is Invisible (7). | number | State *(number)* <br> | 
 
 ## Paths
 **ProjectFilesFolder**: Direct path to your games's content

examples/discord.c3p

@@ -36,7 +36,6 @@
     "electron": "35.0.3",
     "esbuild": "0.25.10",
     "lefthook": "1.11.3",
-    "steamworks.js": "0.4.0",
     "typescript": "5.8.2"
   }
 }

examples/example.c3p

@@ -223,6 +223,18 @@ const defaultSteamId = {
   steamId64: '',
 }
 
+const friendFlagsMap = [
+  0x00,   // none
+  0x01,   // blocked
+  0x02,   // friendshipRequested
+  0x04,   // immediate
+  0x08,   // clanMember
+  0x10,   // onGameServer
+  0x80,   // requestingFriendship
+  0x100,  // requestingInfo
+  0xFFFF, // all
+];
+
 // Simple path utility for POSIX-style path operations
 const posixPath = {
   dirname: (/** @type {string} */ path) => {
@@ -418,6 +430,19 @@ function getInstanceJs(parentClass, addonTriggers, C3) {
     /** @type {string} */
     _GetCurrentGameLanguageResultValue = ''
 
+    /** @type {any[]} */
+    _friendsList = []
+
+    /** @type {string} */
+    _GetFriendsErrorValue = ''
+    /** @type {string} */
+    _GetFriendsResultValue = ''
+
+    /** @type {string} */
+    _GetFriendNameErrorValue = ''
+    /** @type {string} */
+    _GetFriendNameResultValue = ''
+
     /**
      * Description
      * @param {ISDKInstanceBase_} inst
@@ -2329,6 +2354,86 @@ function getInstanceJs(parentClass, addonTriggers, C3) {
       }
     }, this.unsupportedEngine)
 
+    _GetFriends = this.wrap(super._GetFriends, async (
+      /** @type {number} */ flagsIdx,
+      /** @type {IObjectType<IJSONInstance>} */ jsonObject,
+      /** @type {Tag} */ tag
+    ) => {
+      try {
+        const flags = friendFlagsMap[flagsIdx] ?? 0x00;
+        /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').SteamRaw<'friends', 'getFriends'>, 'input'>} */
+        const order = {
+          url: '/steam/raw',
+          body: {
+            namespace: 'friends',
+            method: 'getFriends',
+            args: [flags],
+          },
+        };
+        const answer = await this.ws?.sendAndWaitForResponse(order);
+        if (answer?.body.success === false) {
+          throw new Error('Failed')
+        }
+        this._friendsList = answer?.body.data ?? []
+        this._GetFriendsResultValue = JSON.stringify(this._friendsList)
+        this._GetFriendsErrorValue = ''
+
+        const jsonInstance = jsonObject.getFirstInstance()
+        jsonInstance?.setJsonDataCopy(answer?.body.data ?? [])
+
+        await this.trigger(tag, [
+          C3.Plugins.pipelabv2.Cnds.OnGetFriendsSuccess,
+          C3.Plugins.pipelabv2.Cnds.OnAnyGetFriendsSuccess
+        ])
+      } catch (e) {
+        if (e instanceof Error) {
+          this._GetFriendsErrorValue = e.message
+          this._friendsList = []
+          await this.trigger(tag, [
+            C3.Plugins.pipelabv2.Cnds.OnGetFriendsError,
+            C3.Plugins.pipelabv2.Cnds.OnAnyGetFriendsError
+          ])
+        }
+      }
+    }, this.unsupportedEngine)
+
+    _GetFriendName = this.wrap(super._GetFriendName, async (
+      /** @type {string} */ steamId64,
+      /** @type {Tag} */ tag
+    ) => {
+      try {
+        /** @type {import('@pipelab/core').MakeInputOutput<import('@pipelab/core').SteamRaw<'friends', 'getFriendName'>, 'input'>} */
+        const order = {
+          url: '/steam/raw',
+          body: {
+            namespace: 'friends',
+            method: 'getFriendName',
+            args: [steamId64],
+          },
+        };
+        const answer = await this.ws?.sendAndWaitForResponse(order);
+        if (answer?.body.success === false) {
+          throw new Error('Failed')
+        }
+        this._GetFriendNameResultValue = answer?.body.data ?? ''
+        this._GetFriendNameErrorValue = ''
+
+        await this.trigger(tag, [
+          C3.Plugins.pipelabv2.Cnds.OnGetFriendNameSuccess,
+          C3.Plugins.pipelabv2.Cnds.OnAnyGetFriendNameSuccess
+        ])
+      } catch (e) {
+        if (e instanceof Error) {
+          this._GetFriendNameErrorValue = e.message
+          this._GetFriendNameResultValue = ''
+          await this.trigger(tag, [
+            C3.Plugins.pipelabv2.Cnds.OnGetFriendNameError,
+            C3.Plugins.pipelabv2.Cnds.OnAnyGetFriendNameError
+          ])
+        }
+      }
+    }, this.unsupportedEngine)
+
     // Steam Screenshots
     _TriggerScreenshot = this.wrap(super._TriggerScreenshot, async (
       /** @type {Tag} */ tag
@@ -3736,6 +3841,16 @@ function getInstanceJs(parentClass, addonTriggers, C3) {
     _OnCheckDLCIsInstalledError = this.wrap(super._OnCheckDLCIsInstalledError, (/** @type {Tag} */ tag) => this._currentTag === tag)
     _OnAnyCheckDLCIsInstalledError = this.wrap(super._OnAnyCheckDLCIsInstalledError, () => true)
 
+    _OnGetFriendsSuccess = this.wrap(super._OnGetFriendsSuccess, (/** @type {Tag} */ tag) => this._currentTag === tag)
+    _OnAnyGetFriendsSuccess = this.wrap(super._OnAnyGetFriendsSuccess, () => true)
+    _OnGetFriendsError = this.wrap(super._OnGetFriendsError, (/** @type {Tag} */ tag) => this._currentTag === tag)
+    _OnAnyGetFriendsError = this.wrap(super._OnAnyGetFriendsError, () => true)
+
+    _OnGetFriendNameSuccess = this.wrap(super._OnGetFriendNameSuccess, (/** @type {Tag} */ tag) => this._currentTag === tag)
+    _OnAnyGetFriendNameSuccess = this.wrap(super._OnAnyGetFriendNameSuccess, () => true)
+    _OnGetFriendNameError = this.wrap(super._OnGetFriendNameError, (/** @type {Tag} */ tag) => this._currentTag === tag)
+    _OnAnyGetFriendNameError = this.wrap(super._OnAnyGetFriendNameError, () => true)
+
     _OnCreateWorkshopItemSuccess = this.wrap(super._OnCreateWorkshopItemSuccess, (/** @type {Tag} */ tag) => this._currentTag === tag)
     _OnAnyCreateWorkshopItemSuccess = this.wrap(super._OnAnyCreateWorkshopItemSuccess, () => true)
     _OnCreateWorkshopItemError = this.wrap(super._OnCreateWorkshopItemError, (/** @type {Tag} */ tag) => this._currentTag === tag)
@@ -3999,6 +4114,38 @@ function getInstanceJs(parentClass, addonTriggers, C3) {
       return this._steam_AppId
     })
 
+    _SteamIsOffline = this.exprs(super._SteamIsOffline, (state) => {
+      return state === 0 ? 1 : 0
+    })
+
+    _SteamIsOnline = this.exprs(super._SteamIsOnline, (state) => {
+      return state === 1 ? 1 : 0
+    })
+
+    _SteamIsBusy = this.exprs(super._SteamIsBusy, (state) => {
+      return state === 2 ? 1 : 0
+    })
+
+    _SteamIsAway = this.exprs(super._SteamIsAway, (state) => {
+      return state === 3 ? 1 : 0
+    })
+
+    _SteamIsSnooze = this.exprs(super._SteamIsSnooze, (state) => {
+      return state === 4 ? 1 : 0
+    })
+
+    _SteamIsLookingToTrade = this.exprs(super._SteamIsLookingToTrade, (state) => {
+      return state === 5 ? 1 : 0
+    })
+
+    _SteamIsLookingToPlay = this.exprs(super._SteamIsLookingToPlay, (state) => {
+      return state === 6 ? 1 : 0
+    })
+
+    _SteamIsInvisible = this.exprs(super._SteamIsInvisible, (state) => {
+      return state === 7 ? 1 : 0
+    })
+
     _IsOverlayActive = this.wrap(super._IsOverlayActive, () => {
       return this._lastOverlayState ? 1 : 0
     })
@@ -4347,6 +4494,19 @@ function getInstanceJs(parentClass, addonTriggers, C3) {
       return this._CheckDLCIsInstalledResultValue ?? 0
     })
 
+    _GetFriendsError = this.exprs(super._GetFriendsError, () => {
+      return this._GetFriendsErrorValue
+    })
+    _GetFriendsResult = this.exprs(super._GetFriendsResult, () => {
+      return this._GetFriendsResultValue
+    })
+    _GetFriendNameError = this.exprs(super._GetFriendNameError, () => {
+      return this._GetFriendNameErrorValue
+    })
+    _GetFriendNameResult = this.exprs(super._GetFriendNameResult, () => {
+      return this._GetFriendNameResultValue
+    })
+
     // Workshop expressions
     _CreateWorkshopItemError = this.exprs(super._CreateWorkshopItemError, () => {
       return this._CreateWorkshopItemErrorValue