steamworks.js-timmy 0.1.12 → 0.1.13

package/client.d.ts

@@ -1,3 +1,11 @@
+export interface FriendInfo {
+  name: string
+  nickName?: string
+  smallAvatar?: Buffer
+  mediumAvatar?: Buffer
+  largeAvatar?: Buffer
+}
+
 export declare function init(appId?: number | undefined | null): void
 
 export interface PlayerSteamId {
@@ -10,6 +18,12 @@ export declare function restartAppIfNecessary(appId: number): boolean
 
 export declare function runCallbacks(): void
 
+/**
+ * Shutdown the Steam client instance
+ * PLEASE DON'T USE THIS. Use [`shutdown`] instead.
+ */
+export declare function shutdownClient(): void
+
 export declare namespace achievement {
   export function activate(achievement: string): boolean
   export function clear(achievement: string): boolean
@@ -86,9 +100,13 @@ export declare namespace cloud {
   export function writeFile(name: string, content: string): boolean
 }
 
+export declare namespace friends {
+  export function requestUserInformation(steamId: bigint, requireNameOnly: boolean, timeoutSeconds?: number | undefined | null): Promise<FriendInfo>
+}
+
 export declare namespace input {
   export class Controller {
-    activateActionSet(actionSetHandle: bigint): void
+    activateActionSet(actionSetHandle: bigint): boolean
     isDigitalActionPressed(actionHandle: bigint): boolean
     getAnalogActionVector(actionHandle: bigint): AnalogActionVector
     getType(): InputType
@@ -105,7 +123,6 @@ export declare namespace input {
     getDigitalActionOrigins(actionSetHandle: bigint, digitalActionHandle: bigint): Array<InputActionOrigins>
     getCurrentActiveActionSet(): bigint
   }
-  export function activateActionSetAll(actionSetHandle: bigint): void
   export interface AnalogActionVector {
     x: number
     y: number

package/dist/linux64/client.d.ts

@@ -1,3 +1,11 @@
+export interface FriendInfo {
+  name: string
+  nickName?: string
+  smallAvatar?: Buffer
+  mediumAvatar?: Buffer
+  largeAvatar?: Buffer
+}
+
 export declare function init(appId?: number | undefined | null): void
 
 export interface PlayerSteamId {
@@ -10,6 +18,12 @@ export declare function restartAppIfNecessary(appId: number): boolean
 
 export declare function runCallbacks(): void
 
+/**
+ * Shutdown the Steam client instance
+ * PLEASE DON'T USE THIS. Use [`shutdown`] instead.
+ */
+export declare function shutdownClient(): void
+
 export declare namespace achievement {
   export function activate(achievement: string): boolean
   export function clear(achievement: string): boolean
@@ -86,9 +100,13 @@ export declare namespace cloud {
   export function writeFile(name: string, content: string): boolean
 }
 
+export declare namespace friends {
+  export function requestUserInformation(steamId: bigint, requireNameOnly: boolean, timeoutSeconds?: number | undefined | null): Promise<FriendInfo>
+}
+
 export declare namespace input {
   export class Controller {
-    activateActionSet(actionSetHandle: bigint): void
+    activateActionSet(actionSetHandle: bigint): boolean
     isDigitalActionPressed(actionHandle: bigint): boolean
     getAnalogActionVector(actionHandle: bigint): AnalogActionVector
     getType(): InputType
@@ -105,7 +123,6 @@ export declare namespace input {
     getDigitalActionOrigins(actionSetHandle: bigint, digitalActionHandle: bigint): Array<InputActionOrigins>
     getCurrentActiveActionSet(): bigint
   }
-  export function activateActionSetAll(actionSetHandle: bigint): void
   export interface AnalogActionVector {
     x: number
     y: number

package/dist/linux64/index.d.ts

@@ -1,4 +1,5 @@
 export function init(appId?: number): Omit<Client, "init" | "runCallbacks">;
+export function shutdown(): void;
 export function restartAppIfNecessary(appId: number): boolean;
 export function electronEnableSteamOverlay(disableEachFrameInvalidation?: boolean): void;
 export type Client = typeof import("./client.d");

package/dist/linux64/index.js

@@ -36,6 +36,15 @@ module.exports.init = (appId) => {
     return api
 }
 
+/**
+ * @description Shuts down the steam client
+ */
+module.exports.shutdown = () => { 
+    clearInterval(runCallbacksInterval)
+    nativeBinding.shutdownClient()
+    runCallbacksInterval = undefined
+}
+
 /**
  * @param {number} appId - App ID of the game to load
  * {@link https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary}

package/dist/osx/client.d.ts

@@ -1,3 +1,11 @@
+export interface FriendInfo {
+  name: string
+  nickName?: string
+  smallAvatar?: Buffer
+  mediumAvatar?: Buffer
+  largeAvatar?: Buffer
+}
+
 export declare function init(appId?: number | undefined | null): void
 
 export interface PlayerSteamId {
@@ -10,6 +18,12 @@ export declare function restartAppIfNecessary(appId: number): boolean
 
 export declare function runCallbacks(): void
 
+/**
+ * Shutdown the Steam client instance
+ * PLEASE DON'T USE THIS. Use [`shutdown`] instead.
+ */
+export declare function shutdownClient(): void
+
 export declare namespace achievement {
   export function activate(achievement: string): boolean
   export function clear(achievement: string): boolean
@@ -86,9 +100,13 @@ export declare namespace cloud {
   export function writeFile(name: string, content: string): boolean
 }
 
+export declare namespace friends {
+  export function requestUserInformation(steamId: bigint, requireNameOnly: boolean, timeoutSeconds?: number | undefined | null): Promise<FriendInfo>
+}
+
 export declare namespace input {
   export class Controller {
-    activateActionSet(actionSetHandle: bigint): void
+    activateActionSet(actionSetHandle: bigint): boolean
     isDigitalActionPressed(actionHandle: bigint): boolean
     getAnalogActionVector(actionHandle: bigint): AnalogActionVector
     getType(): InputType
@@ -105,7 +123,6 @@ export declare namespace input {
     getDigitalActionOrigins(actionSetHandle: bigint, digitalActionHandle: bigint): Array<InputActionOrigins>
     getCurrentActiveActionSet(): bigint
   }
-  export function activateActionSetAll(actionSetHandle: bigint): void
   export interface AnalogActionVector {
     x: number
     y: number

package/dist/osx/index.d.ts

@@ -1,4 +1,5 @@
 export function init(appId?: number): Omit<Client, "init" | "runCallbacks">;
+export function shutdown(): void;
 export function restartAppIfNecessary(appId: number): boolean;
 export function electronEnableSteamOverlay(disableEachFrameInvalidation?: boolean): void;
 export type Client = typeof import("./client.d");

package/dist/osx/index.js

@@ -36,6 +36,15 @@ module.exports.init = (appId) => {
     return api
 }
 
+/**
+ * @description Shuts down the steam client
+ */
+module.exports.shutdown = () => { 
+    clearInterval(runCallbacksInterval)
+    nativeBinding.shutdownClient()
+    runCallbacksInterval = undefined
+}
+
 /**
  * @param {number} appId - App ID of the game to load
  * {@link https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary}

package/dist/win64/client.d.ts

@@ -1,3 +1,11 @@
+export interface FriendInfo {
+  name: string
+  nickName?: string
+  smallAvatar?: Buffer
+  mediumAvatar?: Buffer
+  largeAvatar?: Buffer
+}
+
 export declare function init(appId?: number | undefined | null): void
 
 export interface PlayerSteamId {
@@ -10,6 +18,12 @@ export declare function restartAppIfNecessary(appId: number): boolean
 
 export declare function runCallbacks(): void
 
+/**
+ * Shutdown the Steam client instance
+ * PLEASE DON'T USE THIS. Use [`shutdown`] instead.
+ */
+export declare function shutdownClient(): void
+
 export declare namespace achievement {
   export function activate(achievement: string): boolean
   export function clear(achievement: string): boolean
@@ -86,9 +100,13 @@ export declare namespace cloud {
   export function writeFile(name: string, content: string): boolean
 }
 
+export declare namespace friends {
+  export function requestUserInformation(steamId: bigint, requireNameOnly: boolean, timeoutSeconds?: number | undefined | null): Promise<FriendInfo>
+}
+
 export declare namespace input {
   export class Controller {
-    activateActionSet(actionSetHandle: bigint): void
+    activateActionSet(actionSetHandle: bigint): boolean
     isDigitalActionPressed(actionHandle: bigint): boolean
     getAnalogActionVector(actionHandle: bigint): AnalogActionVector
     getType(): InputType
@@ -105,7 +123,6 @@ export declare namespace input {
     getDigitalActionOrigins(actionSetHandle: bigint, digitalActionHandle: bigint): Array<InputActionOrigins>
     getCurrentActiveActionSet(): bigint
   }
-  export function activateActionSetAll(actionSetHandle: bigint): void
   export interface AnalogActionVector {
     x: number
     y: number

package/dist/win64/index.d.ts

@@ -1,4 +1,5 @@
 export function init(appId?: number): Omit<Client, "init" | "runCallbacks">;
+export function shutdown(): void;
 export function restartAppIfNecessary(appId: number): boolean;
 export function electronEnableSteamOverlay(disableEachFrameInvalidation?: boolean): void;
 export type Client = typeof import("./client.d");

package/dist/win64/index.js

@@ -36,6 +36,15 @@ module.exports.init = (appId) => {
     return api
 }
 
+/**
+ * @description Shuts down the steam client
+ */
+module.exports.shutdown = () => { 
+    clearInterval(runCallbacksInterval)
+    nativeBinding.shutdownClient()
+    runCallbacksInterval = undefined
+}
+
 /**
  * @param {number} appId - App ID of the game to load
  * {@link https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary}

package/index.d.ts

@@ -1,4 +1,5 @@
 export function init(appId?: number): Omit<Client, "init" | "runCallbacks">;
+export function shutdown(): void;
 export function restartAppIfNecessary(appId: number): boolean;
 export function electronEnableSteamOverlay(disableEachFrameInvalidation?: boolean): void;
 export type Client = typeof import("./client.d");

package/index.js

@@ -36,6 +36,15 @@ module.exports.init = (appId) => {
     return api
 }
 
+/**
+ * @description Shuts down the steam client
+ */
+module.exports.shutdown = () => { 
+    clearInterval(runCallbacksInterval)
+    nativeBinding.shutdownClient()
+    runCallbacksInterval = undefined
+}
+
 /**
  * @param {number} appId - App ID of the game to load
  * {@link https://partner.steamgames.com/doc/api/steam_api#SteamAPI_RestartAppIfNecessary}

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "steamworks.js-timmy",
-    "version": "0.1.12",
+    "version": "0.1.13",
     "main": "index.js",
     "types": "index.d.ts",
     "napi": {