@quenty/inputmode 4.1.1-canary.256.edbbcfc.0 → 5.0.0

package/CHANGELOG.md

@@ -3,7 +3,15 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-## [4.1.1-canary.256.edbbcfc.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputmode@4.1.0...@quenty/inputmode@4.1.1-canary.256.edbbcfc.0) (2022-03-27)
+# [5.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputmode@4.2.0...@quenty/inputmode@5.0.0) (2022-05-21)
+
+**Note:** Version bump only for package @quenty/inputmode
+
+
+
+
+
+# [4.2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/inputmode@4.1.0...@quenty/inputmode@4.2.0) (2022-03-27)
 
 **Note:** Version bump only for package @quenty/inputmode
 

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2014-2021 Quenty
+Copyright (c) 2014-2022 Quenty
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/inputmode",
-  "version": "4.1.1-canary.256.edbbcfc.0",
+  "version": "5.0.0",
   "description": "Trace input mode state and trigger changes correctly",
   "keywords": [
     "Roblox",
@@ -25,14 +25,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "4.0.1-canary.256.edbbcfc.0",
-    "@quenty/maid": "2.2.1-canary.256.edbbcfc.0",
-    "@quenty/signal": "2.1.1-canary.256.edbbcfc.0",
-    "@quenty/table": "2.1.2-canary.256.edbbcfc.0",
-    "@quenty/valueobject": "4.1.1-canary.256.edbbcfc.0"
+    "@quenty/loader": "^5.0.0",
+    "@quenty/maid": "^2.3.0",
+    "@quenty/signal": "^2.2.0",
+    "@quenty/table": "^3.0.0",
+    "@quenty/valueobject": "^5.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "edbbcfc38516772a791d50dc43cd6b304ffc4aff"
+  "gitHead": "9f7eaea7543c33c89d2e32c38491b13f9271f4f7"
 }

package/src/Client/InputMode.lua

@@ -46,6 +46,15 @@ function InputMode.new(name, typesAndInputModes)
 	return self
 end
 
+--[=[
+	Returns true if a given value is an InputMode
+	@param value any
+	@return boolean
+]=]
+function InputMode.isInputMode(value)
+	return type(value) == "table" and getmetatable(value) == InputMode
+end
+
 --[=[
 	Checks the last point this input mode was used.
 	@return number

package/src/Client/InputModeSelector.lua

@@ -27,6 +27,9 @@ function InputModeSelector.new(inputModes)
 
 	self._maid = Maid.new()
 
+	-- keep this ordered so we are always stable in selection.
+	self._inputModeList = {}
+
 	self._activeMode = ValueObject.new()
 	self._maid:GiveTask(self._activeMode)
 
@@ -38,12 +41,39 @@ function InputModeSelector.new(inputModes)
 	self.Changed = self._activeMode.Changed
 
 	for _, inputMode in pairs(inputModes or InputModeSelector.DEFAULT_MODES) do
-		self:_addInputMode(inputMode)
+		self:AddInputMode(inputMode)
 	end
 
 	return self
 end
 
+--[=[
+	Constructs a new InputModeSelector
+	@param observeInputModesBrio Observable<Brio<InputMode>>
+	@return InputModeSelector
+]=]
+function InputModeSelector.fromObservableBrio(observeInputModesBrio)
+	local selector = InputModeSelector.new({})
+
+	selector._maid:GiveTask(observeInputModesBrio:Subscribe(function(brio)
+		if brio:IsDead() then
+			return
+		end
+
+		local inputMode = brio:GetValue()
+		local maid = brio:ToMaid()
+		selector:AddInputMode(inputMode)
+
+		maid:GiveTask(function()
+			if selector.Destroy then
+				selector:RemoveInputMode(inputMode)
+			end
+		end)
+	end))
+
+	return selector
+end
+
 --[=[
 	Returns the current active mode
 	@return InputMode
@@ -52,6 +82,14 @@ function InputModeSelector:GetActiveMode()
 	return rawget(self, "_activeMode").Value
 end
 
+--[=[
+	Observes the current active mode
+	@return Observable<InputMode>
+]=]
+function InputModeSelector:ObserveActiveMode()
+	return rawget(self, "_activeMode"):Observe()
+end
+
 --[=[
 	The current active input mode
 	@prop Value InputMode?
@@ -106,7 +144,10 @@ function InputModeSelector:Bind(updateBindFunction)
 		if newMode then
 			local modeMaid = Maid.new()
 			maid._modeMaid = modeMaid
-			updateBindFunction(newMode, modeMaid)
+
+			if newMode then
+				updateBindFunction(newMode, modeMaid)
+			end
 		end
 	end
 
@@ -116,9 +157,39 @@ function InputModeSelector:Bind(updateBindFunction)
 	return self
 end
 
-function InputModeSelector:_addInputMode(inputMode)
-	assert(not self._maid[inputMode], "Bad inputMode")
+--[=[
+	Removes the input mode
+	@param inputMode InputMode
+]=]
+function InputModeSelector:RemoveInputMode(inputMode)
+	if not self._maid[inputMode] then
+		return
+	end
+
+	local index = table.find(self._inputModeList, inputMode)
+	if index then
+		table.remove(self._inputModeList, index)
+	else
+		warn("[InputModeSelector] - Failed to find inputMode")
+	end
+
+	self._maid[inputMode] = nil
+
+	if self._activeMode.Value == inputMode then
+		self:_pickNewInputMode()
+	end
+end
+
+--[=[
+	Adds a new input mode
+	@param inputMode InputMode
+]=]
+function InputModeSelector:AddInputMode(inputMode)
+	if self._maid[inputMode] then
+		return
+	end
 
+	table.insert(self._inputModeList, inputMode)
 	self._maid[inputMode] = inputMode.Enabled:Connect(function()
 		self._activeMode.Value = inputMode
 	end)
@@ -129,6 +200,20 @@ function InputModeSelector:_addInputMode(inputMode)
 	end
 end
 
+function InputModeSelector:_pickNewInputMode()
+	local bestEnabledTime = -math.huge
+	local bestMode
+	for _, inputMode in pairs(self._inputModeList) do
+		local enableTime = inputMode:GetLastEnabledTime()
+		if enableTime >= bestEnabledTime then
+			bestEnabledTime = enableTime
+			bestMode = inputMode
+		end
+	end
+
+	self._activeMode.Value = bestMode
+end
+
 --[=[
 	Cleans up the input mode selector.