@quenty/playerinputmode 9.19.0 → 9.19.1

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [9.19.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerinputmode@9.19.0...@quenty/playerinputmode@9.19.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [9.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/playerinputmode@9.18.2...@quenty/playerinputmode@9.19.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/playerinputmode

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/playerinputmode",
-  "version": "9.19.0",
+  "version": "9.19.1",
   "description": "Service that takes active input modes from the player and exposes it to every other player via the server.",
   "keywords": [
     "Roblox",
@@ -26,20 +26,20 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^14.17.0",
-    "@quenty/brio": "^14.17.0",
-    "@quenty/inputmode": "^13.18.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/playerutils": "^8.17.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/remoting": "^12.18.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/servicebag": "^11.11.1",
-    "@quenty/table": "^3.7.1"
+    "@quenty/attributeutils": "^14.17.1",
+    "@quenty/brio": "^14.17.1",
+    "@quenty/inputmode": "^13.18.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/playerutils": "^8.17.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/remoting": "^12.18.1",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/servicebag": "^11.11.2",
+    "@quenty/table": "^3.7.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Client/PlayerInputModeServiceClient.lua

@@ -18,11 +18,12 @@ local PlayerInputModeUtils = require("PlayerInputModeUtils")
 local PlayerInputModeTypes = require("PlayerInputModeTypes")
 local RxPlayerUtils = require("RxPlayerUtils")
 local RxBrioUtils = require("RxBrioUtils")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerInputModeServiceClient = {}
 PlayerInputModeServiceClient.ServiceName = "PlayerInputModeServiceClient"
 
-function PlayerInputModeServiceClient:Init(serviceBag)
+function PlayerInputModeServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
@@ -70,7 +71,7 @@ end
 	@param player Player
 	@return Observable<PlayerInputModeType>
 ]=]
-function PlayerInputModeServiceClient:ObservePlayerInputType(player)
+function PlayerInputModeServiceClient:ObservePlayerInputType(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return PlayerInputModeUtils.observePlayerInputModeType(player)
@@ -82,7 +83,7 @@ end
 	@param player Player
 	@return PlayerInputModeType
 ]=]
-function PlayerInputModeServiceClient:GetPlayerInputModeType(player)
+function PlayerInputModeServiceClient:GetPlayerInputModeType(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return PlayerInputModeUtils.getPlayerInputModeType(player)

package/src/Server/PlayerInputModeService.lua

@@ -12,11 +12,12 @@ local GetRemoteEvent  = require("GetRemoteEvent")
 local Maid = require("Maid")
 local PlayerInputModeServiceConstants = require("PlayerInputModeServiceConstants")
 local PlayerInputModeUtils = require("PlayerInputModeUtils")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerInputModeService = {}
 PlayerInputModeService.ServiceName = "PlayerInputModeService"
 
-function PlayerInputModeService:Init(serviceBag)
+function PlayerInputModeService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 
@@ -37,7 +38,7 @@ end
 	@param player Player
 	@return PlayerInputModeType
 ]=]
-function PlayerInputModeService:GetPlayerInputModeType(player)
+function PlayerInputModeService:GetPlayerInputModeType(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return PlayerInputModeUtils.getPlayerInputModeType(player)
@@ -50,7 +51,7 @@ end
 	@param cancelToken CancelToken
 	@return Promise<PlayerInputModeType>
 ]=]
-function PlayerInputModeService:PromisePlayerInputMode(player, cancelToken)
+function PlayerInputModeService:PromisePlayerInputMode(player: Player, cancelToken)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return PlayerInputModeUtils.promisePlayerInputMode(player, cancelToken)
@@ -62,13 +63,13 @@ end
 	@param player Player
 	@return Observable<PlayerInputModeType>
 ]=]
-function PlayerInputModeService:ObservePlayerInputType(player)
+function PlayerInputModeService:ObservePlayerInputType(player: Player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
 	return PlayerInputModeUtils.observePlayerInputModeType(player)
 end
 
-function PlayerInputModeService:_handleServerEvent(player, request, ...)
+function PlayerInputModeService:_handleServerEvent(player: Player, request, ...)
 	if request == PlayerInputModeServiceConstants.REQUEST_SET_INPUT_MODE then
 		self:_setPlayerInputModeType(player, ...)
 	else
@@ -76,7 +77,7 @@ function PlayerInputModeService:_handleServerEvent(player, request, ...)
 	end
 end
 
-function PlayerInputModeService:_setPlayerInputModeType(player, inputModeType)
+function PlayerInputModeService:_setPlayerInputModeType(player: Player, inputModeType)
 	assert(PlayerInputModeUtils.isInputModeType(inputModeType), "Bad inputModeType")
 
 	PlayerInputModeUtils.setPlayerInputModeType(player, inputModeType)

package/src/Shared/PlayerInputModeUtils.lua

@@ -1,42 +1,98 @@
 --[=[
+	Utility methods to track public player input mode
+
 	@class PlayerInputModeUtils
 ]=]
 
 local require = require(script.Parent.loader).load(script)
 
+local AttributeUtils = require("AttributeUtils")
 local PlayerInputModeServiceConstants = require("PlayerInputModeServiceConstants")
-local RxAttributeUtils = require("RxAttributeUtils")
 local PlayerInputModeTypes = require("PlayerInputModeTypes")
-local AttributeUtils = require("AttributeUtils")
+local Rx = require("Rx")
+local RxAttributeUtils = require("RxAttributeUtils")
 
 local PlayerInputModeUtils = {}
 
-function PlayerInputModeUtils.getPlayerInputModeType(player)
+export type PlayerInputModeType = "Gamepad" | "Keyboard" | "Touch"
+
+--[=[
+	Returns the player input mode type for a player.
+
+	@param player Player
+	@return PlayerInputModeType?
+]=]
+function PlayerInputModeUtils.getPlayerInputModeType(player: Player): PlayerInputModeType?
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	return player:GetAttribute(PlayerInputModeServiceConstants.INPUT_MODE_ATTRIBUTE)
+	local result = player:GetAttribute(PlayerInputModeServiceConstants.INPUT_MODE_ATTRIBUTE)
+	if PlayerInputModeUtils.isInputModeType(result) then
+		return result
+	else
+		return nil
+	end
 end
 
-function PlayerInputModeUtils.observePlayerInputModeType(player)
+--[=[
+	Observes the player input mode type for a player.
+
+	@param player Player
+	@return Observable<PlayerInputModeType?>
+]=]
+function PlayerInputModeUtils.observePlayerInputModeType(player: Player): PlayerInputModeType?
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	return RxAttributeUtils.observeAttribute(player, PlayerInputModeServiceConstants.INPUT_MODE_ATTRIBUTE)
+	return RxAttributeUtils.observeAttribute(player, PlayerInputModeServiceConstants.INPUT_MODE_ATTRIBUTE):Pipe({
+		Rx.map(function(value)
+			if PlayerInputModeUtils.isInputModeType(value) then
+				return value
+			else
+				return nil
+			end
+		end),
+	})
 end
 
-function PlayerInputModeUtils.promisePlayerInputMode(player, cancelToken)
+--[=[
+	Observes the player input mode type for a player.
+
+	@param player Player
+	@param cancelToken CancelToken?
+	@return Promise<string?>
+]=]
+function PlayerInputModeUtils.promisePlayerInputMode(player: Player, cancelToken)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 
-	return AttributeUtils.promiseAttribute(player, PlayerInputModeServiceConstants.INPUT_MODE_ATTRIBUTE, PlayerInputModeUtils.isInputModeType, cancelToken)
+	return AttributeUtils.promiseAttribute(
+		player,
+		PlayerInputModeServiceConstants.INPUT_MODE_ATTRIBUTE,
+		PlayerInputModeUtils.isInputModeType,
+		cancelToken
+	)
 end
 
-function PlayerInputModeUtils.isInputModeType(playerInputModeType)
-	return typeof(playerInputModeType) == "string" and (
-		playerInputModeType == PlayerInputModeTypes.GAMEPAD
-		or playerInputModeType == PlayerInputModeTypes.KEYBOARD
-		or playerInputModeType == PlayerInputModeTypes.TOUCH)
+--[=[
+	Checks if the input mode type is valid.
+
+	@param playerInputModeType any
+	@return boolean
+]=]
+function PlayerInputModeUtils.isInputModeType(playerInputModeType: any): boolean
+	return typeof(playerInputModeType) == "string"
+		and (
+			playerInputModeType == PlayerInputModeTypes.GAMEPAD
+			or playerInputModeType == PlayerInputModeTypes.KEYBOARD
+			or playerInputModeType == PlayerInputModeTypes.TOUCH
+		)
 end
 
-function PlayerInputModeUtils.setPlayerInputModeType(player, playerInputModeType)
+--[=[
+	Sets the player input mode type for a player.
+
+	@param player Player
+	@param playerInputModeType string
+]=]
+function PlayerInputModeUtils.setPlayerInputModeType(player: Player, playerInputModeType: PlayerInputModeType)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
 	assert(PlayerInputModeUtils.isInputModeType(playerInputModeType), "Bad playerInputModeType")