steamworks.js-timmy 0.1.17 → 0.1.19

package/dist/osx/index.d.ts

@@ -0,0 +1,6 @@
+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");
+export const SteamCallback: typeof import("./client.d").callback.SteamCallback;

package/dist/osx/index.js

@@ -0,0 +1,89 @@
+const { platform, arch } = process
+
+/** @typedef {typeof import('./client.d')} Client */
+/** @type {Client} */
+let nativeBinding = undefined
+
+if (platform === 'win32' && arch === 'x64') {
+    nativeBinding = require('./dist/win64/steamworksjs.win32-x64-msvc.node')
+} else if (platform === 'linux' && arch === 'x64') {
+    nativeBinding = require('./dist/linux64/steamworksjs.linux-x64-gnu.node')
+} else if (platform === 'darwin') {
+    if (arch === 'x64') {
+        nativeBinding = require('./dist/osx/steamworksjs.darwin-x64.node')
+    } else if (arch === 'arm64') {
+        nativeBinding = require('./dist/osx/steamworksjs.darwin-arm64.node')
+    }
+} else {
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+let runCallbacksInterval = undefined
+
+/**
+ * Initialize the steam client or throw an error if it fails
+ * @param {number} [appId] - App ID of the game to load, if undefined, will search for a steam_appid.txt file
+ * @returns {Omit<Client, 'init' | 'runCallbacks'>}
+*/
+module.exports.init = (appId) => {
+    const { init: internalInit, runCallbacks, restartAppIfNecessary, ...api } = nativeBinding
+
+    internalInit(appId)
+
+    clearInterval(runCallbacksInterval)
+    runCallbacksInterval = setInterval(() => {
+        // console.log("Running callbacks")
+        runCallbacks()
+    }, 1000 / 120)
+
+    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}
+ * @returns {boolean} 
+ */
+module.exports.restartAppIfNecessary = (appId) => nativeBinding.restartAppIfNecessary(appId);
+
+/**
+ * Enable the steam overlay on electron
+ * @param {boolean} [disableEachFrameInvalidation] - Should attach a single pixel to be rendered each frame
+*/
+module.exports.electronEnableSteamOverlay = (disableEachFrameInvalidation) => {
+    const electron = require('electron')
+    if (!electron) {
+        throw new Error('Electron module not found')
+    }
+
+    electron.app.commandLine.appendSwitch('in-process-gpu')
+    electron.app.commandLine.appendSwitch('disable-direct-composition')
+
+    if (!disableEachFrameInvalidation) {
+        /** @param {electron.BrowserWindow} browserWindow */
+        const attachFrameInvalidator = (browserWindow) => {
+            browserWindow.steamworksRepaintInterval = setInterval(() => {
+                if (browserWindow.isDestroyed()) {
+                    clearInterval(browserWindow.steamworksRepaintInterval)
+                } else if (!browserWindow.webContents.isPainting()) {
+                    browserWindow.webContents.invalidate()
+                }
+            }, 1000 / 60)
+        }
+
+        electron.BrowserWindow.getAllWindows().forEach(attachFrameInvalidator)
+        electron.app.on('browser-window-created', (_, bw) => attachFrameInvalidator(bw))
+    }
+}
+
+const SteamCallback = nativeBinding.callback.SteamCallback
+module.exports.SteamCallback = SteamCallback

package/dist/win64/client.d.ts

@@ -567,6 +567,16 @@ export declare namespace input {
     PS5Controller = 'PS5Controller',
     SteamDeckController = 'SteamDeckController'
   }
+  export const enum KeyboardInputKind {
+    /** The text input that will closes on Enter keypress */
+    SingleLine = 0,
+    /** Text input that will closes on user's demand. */
+    MultiLine = 1,
+    /** Text input that will make typing email address easier. */
+    Email = 2,
+    /** Text input that will make typing numeric input easier. */
+    Numeric = 3
+  }
   export interface MotionData {
     /** Absolute Rotation (drift) X axis */
     rotQuatX: number
@@ -592,6 +602,11 @@ export declare namespace input {
   export function runFrame(): void
   export function setInputActionManifestFilePath(path: string): boolean
   export function shutdown(): void
+  /**
+   * Opens a floating keyboard over the game content and sends OS keyboard keys directly to the game.
+   * The text field position is specified in pixels relative the origin of the game window and is used to position the floating keyboard in a way that doesn't cover the text field.
+   */
+  export function triggerOnScreenKeyboard(keyboardInputKind: KeyboardInputKind, xPosOfTextInput: number, yPosOfTextInput: number, widthOfTextInput: number, heightOfTextInput: number, dismissedCallback?: (arg?: unknown) => unknown | undefined | null): boolean
   export const enum VibrateSide {
     Left = 0,
     Right = 1

package/index.js

@@ -1,89 +1,89 @@
-const { platform, arch } = process
-
-/** @typedef {typeof import('./client.d')} Client */
-/** @type {Client} */
-let nativeBinding = undefined
-
-if (platform === 'win32' && arch === 'x64') {
-    nativeBinding = require('./dist/win64/steamworksjs.win32-x64-msvc.node')
-} else if (platform === 'linux' && arch === 'x64') {
-    nativeBinding = require('./dist/linux64/steamworksjs.linux-x64-gnu.node')
-} else if (platform === 'darwin') {
-    if (arch === 'x64') {
-        nativeBinding = require('./dist/osx/steamworksjs.darwin-x64.node')
-    } else if (arch === 'arm64') {
-        nativeBinding = require('./dist/osx/steamworksjs.darwin-arm64.node')
-    }
-} else {
-    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
-}
-
-let runCallbacksInterval = undefined
-
-/**
- * Initialize the steam client or throw an error if it fails
- * @param {number} [appId] - App ID of the game to load, if undefined, will search for a steam_appid.txt file
- * @returns {Omit<Client, 'init' | 'runCallbacks'>}
-*/
-module.exports.init = (appId) => {
-    const { init: internalInit, runCallbacks, restartAppIfNecessary, ...api } = nativeBinding
-
-    internalInit(appId)
-
-    clearInterval(runCallbacksInterval)
-    runCallbacksInterval = setInterval(() => {
-        // console.log("Running callbacks")
-        runCallbacks()
-    }, 1000 / 120)
-
-    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}
- * @returns {boolean} 
- */
-module.exports.restartAppIfNecessary = (appId) => nativeBinding.restartAppIfNecessary(appId);
-
-/**
- * Enable the steam overlay on electron
- * @param {boolean} [disableEachFrameInvalidation] - Should attach a single pixel to be rendered each frame
-*/
-module.exports.electronEnableSteamOverlay = (disableEachFrameInvalidation) => {
-    const electron = require('electron')
-    if (!electron) {
-        throw new Error('Electron module not found')
-    }
-
-    electron.app.commandLine.appendSwitch('in-process-gpu')
-    electron.app.commandLine.appendSwitch('disable-direct-composition')
-
-    if (!disableEachFrameInvalidation) {
-        /** @param {electron.BrowserWindow} browserWindow */
-        const attachFrameInvalidator = (browserWindow) => {
-            browserWindow.steamworksRepaintInterval = setInterval(() => {
-                if (browserWindow.isDestroyed()) {
-                    clearInterval(browserWindow.steamworksRepaintInterval)
-                } else if (!browserWindow.webContents.isPainting()) {
-                    browserWindow.webContents.invalidate()
-                }
-            }, 1000 / 60)
-        }
-
-        electron.BrowserWindow.getAllWindows().forEach(attachFrameInvalidator)
-        electron.app.on('browser-window-created', (_, bw) => attachFrameInvalidator(bw))
-    }
-}
-
-const SteamCallback = nativeBinding.callback.SteamCallback
+const { platform, arch } = process
+
+/** @typedef {typeof import('./client.d')} Client */
+/** @type {Client} */
+let nativeBinding = undefined
+
+if (platform === 'win32' && arch === 'x64') {
+    nativeBinding = require('./dist/win64/steamworksjs.win32-x64-msvc.node')
+} else if (platform === 'linux' && arch === 'x64') {
+    nativeBinding = require('./dist/linux64/steamworksjs.linux-x64-gnu.node')
+} else if (platform === 'darwin') {
+    if (arch === 'x64') {
+        nativeBinding = require('./dist/osx/steamworksjs.darwin-x64.node')
+    } else if (arch === 'arm64') {
+        nativeBinding = require('./dist/osx/steamworksjs.darwin-arm64.node')
+    }
+} else {
+    throw new Error(`Unsupported OS: ${platform}, architecture: ${arch}`)
+}
+
+let runCallbacksInterval = undefined
+
+/**
+ * Initialize the steam client or throw an error if it fails
+ * @param {number} [appId] - App ID of the game to load, if undefined, will search for a steam_appid.txt file
+ * @returns {Omit<Client, 'init' | 'runCallbacks'>}
+*/
+module.exports.init = (appId) => {
+    const { init: internalInit, runCallbacks, restartAppIfNecessary, ...api } = nativeBinding
+
+    internalInit(appId)
+
+    clearInterval(runCallbacksInterval)
+    runCallbacksInterval = setInterval(() => {
+        // console.log("Running callbacks")
+        runCallbacks()
+    }, 1000 / 120)
+
+    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}
+ * @returns {boolean} 
+ */
+module.exports.restartAppIfNecessary = (appId) => nativeBinding.restartAppIfNecessary(appId);
+
+/**
+ * Enable the steam overlay on electron
+ * @param {boolean} [disableEachFrameInvalidation] - Should attach a single pixel to be rendered each frame
+*/
+module.exports.electronEnableSteamOverlay = (disableEachFrameInvalidation) => {
+    const electron = require('electron')
+    if (!electron) {
+        throw new Error('Electron module not found')
+    }
+
+    electron.app.commandLine.appendSwitch('in-process-gpu')
+    electron.app.commandLine.appendSwitch('disable-direct-composition')
+
+    if (!disableEachFrameInvalidation) {
+        /** @param {electron.BrowserWindow} browserWindow */
+        const attachFrameInvalidator = (browserWindow) => {
+            browserWindow.steamworksRepaintInterval = setInterval(() => {
+                if (browserWindow.isDestroyed()) {
+                    clearInterval(browserWindow.steamworksRepaintInterval)
+                } else if (!browserWindow.webContents.isPainting()) {
+                    browserWindow.webContents.invalidate()
+                }
+            }, 1000 / 60)
+        }
+
+        electron.BrowserWindow.getAllWindows().forEach(attachFrameInvalidator)
+        electron.app.on('browser-window-created', (_, bw) => attachFrameInvalidator(bw))
+    }
+}
+
+const SteamCallback = nativeBinding.callback.SteamCallback
 module.exports.SteamCallback = SteamCallback

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "steamworks.js-timmy",
-    "version": "0.1.17",
+    "version": "0.1.19",
     "main": "index.js",
     "types": "index.d.ts",
     "napi": {
@@ -21,9 +21,11 @@
         "README.md"
     ],
     "license": "MIT",
+    "dependencies": {
+        "@types/node": "*"
+    },
     "devDependencies": {
         "@napi-rs/cli": "3.3.1",
-        "@types/node": "*",
         "electron": "24.2.0",
         "rimraf": "6.0.1",
         "typescript": "5.5.3"