@quenty/observablecollection 12.8.1 → 12.9.0

package/CHANGELOG.md

@@ -3,6 +3,29 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [12.9.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@12.8.1...@quenty/observablecollection@12.9.0) (2024-10-06)
+
+
+### Bug Fixes
+
+* Add ObservableMapSet:GetKeyList() ([e5d3461](https://github.com/Quenty/NevermoreEngine/commit/e5d3461e5f835c9442e49eb0f304dc5fb360cb28))
+* Brios sometime cleanup wrongly ([e546588](https://github.com/Quenty/NevermoreEngine/commit/e546588d97b2e8f8386d9795f04929c9b45a27d1))
+
+
+### Features
+
+* Add ObservableMapList:GetFirstItemForKey(key) and ObservableMapList:GetListOfValuesAtListIndex(index) ([bdfc759](https://github.com/Quenty/NevermoreEngine/commit/bdfc7596d8e25350e65a3cc841debcfa0ad444de))
+* Add ObservableMapList:GetItemForKeyAtIndex(key, index) ([224dd25](https://github.com/Quenty/NevermoreEngine/commit/224dd250f2794b7f584d756828dffd9e49b0d009))
+
+
+### Performance Improvements
+
+* Improve :GetKeyList() allocation performance ([b8043cf](https://github.com/Quenty/NevermoreEngine/commit/b8043cfad4e4cfdb2c8ec5d73988bb8bae723c42))
+
+
+
+
+
 ## [12.8.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/observablecollection@12.8.0...@quenty/observablecollection@12.8.1) (2024-10-04)
 
 **Note:** Version bump only for package @quenty/observablecollection

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/observablecollection",
-  "version": "12.8.1",
+  "version": "12.9.0",
   "description": "A set of observable collections, such as sets, maps, sorted lists, and more.",
   "keywords": [
     "Roblox",
@@ -27,23 +27,23 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.6.0",
-    "@quenty/brio": "^14.8.1",
-    "@quenty/ducktype": "^5.6.0",
-    "@quenty/loader": "^10.6.0",
+    "@quenty/baseobject": "^10.7.0",
+    "@quenty/brio": "^14.9.0",
+    "@quenty/ducktype": "^5.7.0",
+    "@quenty/loader": "^10.7.0",
     "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.6.0",
-    "@quenty/rx": "^13.8.0",
-    "@quenty/signal": "^7.7.0",
+    "@quenty/promise": "^10.7.0",
+    "@quenty/rx": "^13.9.0",
+    "@quenty/signal": "^7.8.0",
     "@quenty/steputils": "^3.5.1",
     "@quenty/symbol": "^3.2.0",
-    "@quenty/valueobject": "^13.8.1"
+    "@quenty/valueobject": "^13.9.0"
   },
   "devDependencies": {
-    "@quenty/blend": "^12.8.1"
+    "@quenty/blend": "^12.9.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "539802fea720a92f81ad48d6d5579605d8844d0a"
+  "gitHead": "67c5dbf46f6f45213812f3f117419a5534936a0b"
 }

package/src/Shared/ObservableCountingMap.lua

@@ -79,7 +79,7 @@ end
 ]=]
 function ObservableCountingMap:ObserveKeysList()
 	return self:_observeDerivedDataStructureFromKeys(function()
-		local list = {}
+		local list = table.create(self._totalKeyCountValue.Value)
 
 		for key, _ in pairs(self._map) do
 			table.insert(list, key)
@@ -184,22 +184,28 @@ end
 function ObservableCountingMap:ObserveKeysBrio()
 	return Observable.new(function(sub)
 		local maid = Maid.new()
+		local keyMaid = maid:Add(Maid.new())
 
 		local function handleItem(key)
+			-- Happens upon key added re-entrance
+			if keyMaid[key] then
+				return
+			end
+
 			local brio = Brio.new(key)
-			maid[key] = brio
+			keyMaid[key] = brio
 			sub:Fire(brio)
 		end
 
-		for key, _ in pairs(self._map) do
-			handleItem(key)
-		end
-
 		maid:GiveTask(self.KeyAdded:Connect(handleItem))
 		maid:GiveTask(self.KeyRemoved:Connect(function(key)
-			maid[key] = nil
+			keyMaid[key] = nil
 		end))
 
+		for key, _ in pairs(self._map) do
+			handleItem(key)
+		end
+
 		self._maid[sub] = maid
 		maid:GiveTask(function()
 			self._maid[sub] = nil
@@ -286,8 +292,10 @@ function ObservableCountingMap:Add(key, amount)
 		return
 	end
 
-	if self._map[key] then
-		local newValue = self._map[key] + amount
+	local oldValue = self._map[key]
+
+	if oldValue then
+		local newValue = oldValue + amount
 		if newValue == 0 then
 			-- Remove item
 			self._map[key] = nil
@@ -363,7 +371,7 @@ end
 	@return { T }
 ]=]
 function ObservableCountingMap:GetKeyList()
-	local list = {}
+	local list = table.create(self._totalKeyCountValue.Value)
 	for key, _ in pairs(self._map) do
 		table.insert(list, key)
 	end

package/src/Shared/ObservableList.lua

@@ -144,6 +144,11 @@ end
 	Observes the current value at a given index. This can be useful for observing
 	the first entry, or matching stuff up to a given slot.
 
+	```
+	list:ObserveAtIndex(1):Subscribe(print) --> prints first item
+	list:ObserveAtIndex(-1):Subscribe(print) --> prints last item
+	```
+
 	@param indexToObserve number
 	@return Observable<T?>
 ]=]

package/src/Shared/ObservableMapList.lua

@@ -92,8 +92,54 @@ function ObservableMapList:Push(observeKey, entry)
 	return maid
 end
 
+--[=[
+	Gets the first item for the given key
+
+	@param key TKey
+	@return TValue | nil
+]=]
+function ObservableMapList:GetFirstItemForKey(key)
+	assert(key ~= nil, "Bad key")
+
+	local observableList = self:GetListForKey(key)
+	if not observableList then
+		return nil
+	end
+
+	return observableList:Get(1)
+end
+
+--[=[
+	Gets the item for the given key at the index
+
+	```
+	mapList:Push("fruits", "apple")
+	mapList:Push("fruits", "orange")
+	mapList:Push("fruits", "banana")
+
+	-- Print the last item
+	print(mapList:GetItemForKeyAtIndex("fruits", -1)) ==> banana
+	```
+
+	@param key TKey
+	@param index number
+	@return TValue | nil
+]=]
+function ObservableMapList:GetItemForKeyAtIndex(key, index)
+	assert(key ~= nil, "Bad key")
+	assert(type(index) == "number", "Bad index")
+
+	local observableList = self:GetListForKey(key)
+	if not observableList then
+		return nil
+	end
+
+	return observableList:Get(index)
+end
+
 --[=[
 	Gets how many lists exist
+
 	@return number
 ]=]
 function ObservableMapList:GetListCount()
@@ -102,6 +148,7 @@ end
 
 --[=[
 	Observes how many lists exist
+
 	@return Observable<number>
 ]=]
 function ObservableMapList:ObserveListCount()
@@ -244,6 +291,27 @@ function ObservableMapList:GetListForKey(key)
 	return self._observableMapOfLists:Get(key)
 end
 
+--[=[
+	Gets a list of all of the entries at the given index, if it exists
+
+	@param index number
+	@return ObservableList<TValue>
+]=]
+function ObservableMapList:GetListOfValuesAtListIndex(index)
+	assert(type(index) == "number", "Bad index")
+
+	local list = table.create(self._observableMapOfLists:GetCount())
+
+	for _, observableList in pairs(self._observableMapOfLists:GetValueList()) do
+		local value = observableList:Get(index)
+		if value ~= nil then
+			table.insert(list, value)
+		end
+	end
+
+	return list
+end
+
 --[=[
 	Observes the observable list for the given key
 

package/src/Shared/ObservableMapSet.lua

@@ -122,7 +122,7 @@ end
 	Gets a list of all keys.
 	@return { TKey }
 ]=]
-function ObservableMapSet:ObserveKeyList()
+function ObservableMapSet:GetKeyList()
 	return self._observableMapOfSets:GetKeyList()
 end
 

package/src/Shared/ObservableSet.lua

@@ -78,20 +78,26 @@ function ObservableSet:ObserveItemsBrio()
 		local maid = Maid.new()
 
 		local function handleItem(item)
+			if maid[item] then
+				-- Happens when we're re-entrance
+				return
+			end
+
 			local brio = Brio.new(item)
 			maid[item] = brio
 			sub:Fire(brio)
 		end
 
-		for item, _ in pairs(self._set) do
-			handleItem(item)
-		end
 
 		maid:GiveTask(self.ItemAdded:Connect(handleItem))
 		maid:GiveTask(self.ItemRemoved:Connect(function(item)
 			maid[item] = nil
 		end))
 
+		for item, _ in pairs(self._set) do
+			handleItem(item)
+		end
+
 		self._maid[sub] = maid
 		maid:GiveTask(function()
 			self._maid[sub] = nil