@quenty/observablecollection 12.20.0 → 12.20.1

package/src/Shared/ObservableMapSet.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Holds a map of sets. That is, for a given key, a set of all valid entries. This is great
 	for looking up something that may have duplicate keys, like configurations or other things.
@@ -13,22 +14,36 @@ local ObservableMap = require("ObservableMap")
 local ObservableSet = require("ObservableSet")
 local Rx = require("Rx")
 local RxBrioUtils = require("RxBrioUtils")
+local _Brio = require("Brio")
+local _Signal = require("Signal")
+local _Table = require("Table")
 
 local ObservableMapSet = {}
 ObservableMapSet.ClassName = "ObservableMapSet"
 ObservableMapSet.__index = ObservableMapSet
 
+export type ObservableMapSet<TKey, TValue> = typeof(setmetatable(
+	{} :: {
+		_observableMapOfSets: any, -- ObservableMap.ObservableMap<TKey, ObservableSet.ObservableSet<TValue>>,
+		_maid: Maid.Maid,
+		SetAdded: _Signal.Signal<TKey>,
+		SetRemoved: _Signal.Signal<TKey>,
+		CountChanged: _Signal.Signal<number>,
+	},
+	ObservableMapSet
+))
+
 --[=[
 	Constructs a new ObservableMapSet
 	@return ObservableMapSet<TKey, TValue>
 ]=]
-function ObservableMapSet.new()
-	local self = setmetatable({}, ObservableMapSet)
+function ObservableMapSet.new<TKey, TValue>(): ObservableMapSet<TKey, TValue>
+	local self = setmetatable({} :: any, ObservableMapSet)
 
 	self._maid = Maid.new()
 	self._observableMapOfSets = self._maid:Add(ObservableMap.new())
 
---[=[
+	--[=[
 	Fires when an item is added
 	@readonly
 	@prop SetAdded Signal<TKey>
@@ -36,7 +51,7 @@ function ObservableMapSet.new()
 ]=]
 	self.SetAdded = assert(self._observableMapOfSets.KeyAdded, "Bad KeyAdded") -- :Fire(key, set)
 
---[=[
+	--[=[
 	Fires when an item is removed
 	@readonly
 	@prop SetRemoved Signal<TKey>
@@ -44,7 +59,7 @@ function ObservableMapSet.new()
 ]=]
 	self.SetRemoved = assert(self._observableMapOfSets.KeyRemoved, "Bad KeyRemoved") -- :Fire(key)
 
---[=[
+	--[=[
 	Fires when the count changes.
 	@prop CountChanged RBXScriptSignal
 	@within ObservableMap
@@ -67,14 +82,18 @@ end
 	@return MaidTask -- Cleanup object that will remove the entry
 ]=]
 
-function ObservableMapSet:Push(observeKey, entry)
+function ObservableMapSet.Push<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	observeKey: Observable.Observable<TKey> | TKey,
+	entry: TValue
+): Maid.Maid
 	assert(observeKey ~= nil, "Bad observeKey")
 	assert(entry ~= nil, "Bad entry")
 
 	local maid = Maid.new()
 
 	if Observable.isObservable(observeKey) then
-		maid:GiveTask(observeKey:Subscribe(function(key)
+		maid:GiveTask((observeKey :: any):Subscribe(function(key)
 			maid._currentAddValue = nil
 
 			if key ~= nil then
@@ -82,13 +101,13 @@ function ObservableMapSet:Push(observeKey, entry)
 			end
 		end))
 	else
-		maid:GiveTask(self:_addToSet(observeKey, entry))
+		maid:GiveTask(self:_addToSet(observeKey :: any, entry))
 	end
 
 	-- Ensure self-cleanup when map cleans up
-	self._maid[maid] = maid
+	self._maid[maid :: any] = maid
 	maid:GiveTask(function()
-		self._maid[maid] = nil
+		self._maid[maid :: any] = nil
 	end)
 
 	return maid
@@ -108,12 +127,20 @@ end
 	@param observeKey Observable<TKey> | TKey
 	@return MaidTask -- Cleanup object that will remove the entry
 ]=]
-function ObservableMapSet:Add(entry, observeKey)
+function ObservableMapSet.Add<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	entry: TValue,
+	observeKey: Observable.Observable<TKey> | TKey
+): Maid.Maid
 	assert(Observable.isObservable(observeKey), "Bad observeKey")
 	assert(entry ~= nil, "Bad entry")
 
-	warn(string.format("[ObservableMapSet.Add] - This API call will swap observable key order eventually. Use ObservableMapSet.Push for now to suppress this warning.\n%s",
-		debug.traceback()))
+	warn(
+		string.format(
+			"[ObservableMapSet.Add] - This API call will swap observable key order eventually. Use ObservableMapSet.Push for now to suppress this warning.\n%s",
+			debug.traceback()
+		)
+	)
 
 	return self:Push(observeKey, entry)
 end
@@ -122,7 +149,7 @@ end
 	Gets a list of all keys.
 	@return { TKey }
 ]=]
-function ObservableMapSet:GetKeyList()
+function ObservableMapSet.GetKeyList<TKey, TValue>(self: ObservableMapSet<TKey, TValue>): { TKey }
 	return self._observableMapOfSets:GetKeyList()
 end
 
@@ -130,7 +157,7 @@ end
 	Observes the list of all keys.
 	@return Observable<{ TKey }>
 ]=]
-function ObservableMapSet:ObserveKeyList()
+function ObservableMapSet.ObserveKeyList<TKey, TValue>(self: ObservableMapSet<TKey, TValue>): Observable.Observable<{ TKey }>
 	return self._observableMapOfSets:ObserveKeyList()
 end
 
@@ -138,7 +165,7 @@ end
 	Observes all keys in the map
 	@return Observable<Brio<TKey>>
 ]=]
-function ObservableMapSet:ObserveKeysBrio()
+function ObservableMapSet.ObserveKeysBrio<TKey, TValue>(self: ObservableMapSet<TKey, TValue>): Observable.Observable<_Brio.Brio<TKey>>
 	return self._observableMapOfSets:ObserveKeysBrio()
 end
 
@@ -146,7 +173,7 @@ end
 	Gets how many sets exist
 	@return number
 ]=]
-function ObservableMapSet:GetSetCount()
+function ObservableMapSet.GetSetCount<TKey, TValue>(self: ObservableMapSet<TKey, TValue>): number
 	return self._observableMapOfSets:GetCount()
 end
 
@@ -156,7 +183,7 @@ ObservableMapSet.__len = ObservableMapSet.GetSetCount
 	Observes how many sets exist
 	@return Observable<number>
 ]=]
-function ObservableMapSet:ObserveSetCount()
+function ObservableMapSet.ObserveSetCount<TKey, TValue>(self: ObservableMapSet<TKey, TValue>): Observable.Observable<number>
 	return self._observableMapOfSets:ObserveCount()
 end
 
@@ -165,7 +192,10 @@ end
 	@param key TKey
 	@return Observable<Brio<TValue>>
 ]=]
-function ObservableMapSet:ObserveItemsForKeyBrio(key)
+function ObservableMapSet.ObserveItemsForKeyBrio<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	key: TKey
+): Observable.Observable<_Brio.Brio<TValue>>
 	assert(key ~= nil, "Bad key")
 
 	return self._observableMapOfSets:ObserveAtKeyBrio(key):Pipe({
@@ -175,19 +205,19 @@ function ObservableMapSet:ObserveItemsForKeyBrio(key)
 			else
 				return Rx.EMPTY
 			end
-		end);
+		end),
 	})
 end
 
 --[=[
 	Gets the first item for the given key
 	@param key TKey
-	@return TValue | nil
+	@return TValue?
 ]=]
-function ObservableMapSet:GetFirstItemForKey(key)
+function ObservableMapSet.GetFirstItemForKey<TKey, TValue>(self: ObservableMapSet<TKey, TValue>, key: TKey): TValue?
 	assert(key ~= nil, "Bad key")
 
-	local observableSet = self:GetObservableSetForKey(key)
+	local observableSet: ObservableSet.ObservableSet<TValue> = self:GetObservableSetForKey(key) :: any
 	if not observableSet then
 		return nil
 	end
@@ -200,7 +230,7 @@ end
 	@param key TKey
 	@return { TValue }
 ]=]
-function ObservableMapSet:GetListForKey(key)
+function ObservableMapSet.GetListForKey<TKey, TValue>(self: ObservableMapSet<TKey, TValue>, key: TKey): _Table.Array<TValue>
 	assert(key ~= nil, "Bad key")
 
 	local observableSet = self:GetObservableSetForKey(key)
@@ -216,7 +246,10 @@ end
 	@param key TKey
 	@return ObservableSet<TValue>
 ]=]
-function ObservableMapSet:GetObservableSetForKey(key)
+function ObservableMapSet.GetObservableSetForKey<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	key: TKey
+): ObservableSet.ObservableSet<TValue>
 	assert(key ~= nil, "Bad key")
 
 	return self._observableMapOfSets:Get(key)
@@ -228,7 +261,12 @@ end
 	@param key TKey
 	@return Observable<Brio<ObservableSet<TValue>>>
 ]=]
-function ObservableMapSet:ObserveSetBrio(key)
+function ObservableMapSet.ObserveSetBrio<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	key: TKey
+): Observable.Observable<
+	_Brio.Brio<ObservableSet.ObservableSet<TValue>>
+>
 	assert(key ~= nil, "Bad key")
 
 	return self._observableMapOfSets:ObserveAtKeyBrio(key)
@@ -240,40 +278,45 @@ end
 	@param key TKey
 	@return Observable<number>
 ]=]
-function ObservableMapSet:ObserveCountForKey(key)
-	assert(key ~= nil, "Bad key")
+function ObservableMapSet.ObserveCountForKey<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	key: TKey
+): Observable.Observable<number>
+	assert((key :: any) ~= nil, "Bad key")
 
 	return self:ObserveSetBrio(key):Pipe({
 		RxBrioUtils.switchMapBrio(function(observableSet)
 			return observableSet:ObserveCount()
-		end);
-		RxBrioUtils.emitOnDeath(0);
-	})
+		end),
+		RxBrioUtils.emitOnDeath(0),
+	}) :: any
 end
 
-
-function ObservableMapSet:_addToSet(key, entry)
+function ObservableMapSet._addToSet<TKey, TValue>(self: ObservableMapSet<TKey, TValue>, key: TKey, entry: TValue): () -> ()
 	local set = self:_getOrCreateSet(key)
 	return set:Add(entry)
 end
 
-function ObservableMapSet:_getOrCreateSet(key)
+function ObservableMapSet._getOrCreateSet<TKey, TValue>(
+	self: ObservableMapSet<TKey, TValue>,
+	key: TKey
+): ObservableSet.ObservableSet<TValue>
 	local existing = self._observableMapOfSets:Get(key)
 	if existing then
 		return existing
 	end
 
 	local maid = Maid.new()
-	local set = maid:Add(ObservableSet.new(nil))
+	local set = maid:Add(ObservableSet.new())
 
 	maid:GiveTask(set.CountChanged:Connect(function(count)
 		if count <= 0 then
-			self._maid[set] = nil
+			self._maid[set :: any] = nil
 		end
 	end))
 
 	maid:GiveTask(self._observableMapOfSets:Set(key, set))
-	self._maid[set] = maid
+	self._maid[set :: any] = maid
 
 	return set
 end
@@ -281,10 +324,9 @@ end
 --[=[
 	Cleans up the ObservableMapSet and sets the metatable to nil.
 ]=]
-function ObservableMapSet:Destroy()
+function ObservableMapSet.Destroy<TKey, TValue>(self: ObservableMapSet<TKey, TValue>)
 	self._maid:DoCleaning()
-	setmetatable(self, nil)
+	setmetatable(self :: any, nil)
 end
 
-
-return ObservableMapSet
+return ObservableMapSet

package/src/Shared/ObservableSet.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	A list that can be observed for blend and other components
 	@class ObservableSet
@@ -12,17 +13,31 @@ local Brio = require("Brio")
 local ValueObject = require("ValueObject")
 local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
 local DuckTypeUtils = require("DuckTypeUtils")
+local _Set = require("Set")
 
 local ObservableSet = {}
 ObservableSet.ClassName = "ObservableSet"
 ObservableSet.__index = ObservableSet
 
+export type ObservableSet<T> = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_set: _Set.Set<T>,
+		_containsObservables: any,
+		_countValue: ValueObject.ValueObject<number>,
+		ItemAdded: Signal.Signal<T>,
+		ItemRemoved: Signal.Signal<T>,
+		CountChanged: Signal.Signal<number>,
+	},
+	ObservableSet
+))
+
 --[=[
 	Constructs a new ObservableSet
 	@return ObservableSet<T>
 ]=]
-function ObservableSet.new()
-	local self = setmetatable({}, ObservableSet)
+function ObservableSet.new<T>(): ObservableSet<T>
+	local self = setmetatable({} :: any, ObservableSet)
 
 	self._maid = Maid.new()
 	self._set = {}
@@ -30,7 +45,7 @@ function ObservableSet.new()
 	self._containsObservables = self._maid:Add(ObservableSubscriptionTable.new())
 	self._countValue = self._maid:Add(ValueObject.new(0, "number"))
 
---[=[
+	--[=[
 	Fires when an item is added
 	@readonly
 	@prop ItemAdded Signal<T>
@@ -38,7 +53,7 @@ function ObservableSet.new()
 ]=]
 	self.ItemAdded = self._maid:Add(Signal.new())
 
---[=[
+	--[=[
 	Fires when an item is removed.
 	@readonly
 	@prop ItemRemoved Signal<T>
@@ -46,7 +61,7 @@ function ObservableSet.new()
 ]=]
 	self.ItemRemoved = self._maid:Add(Signal.new())
 
---[=[
+	--[=[
 	Fires when the count changes.
 	@prop CountChanged RBXScriptSignal
 	@within ObservableSet
@@ -61,7 +76,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function ObservableSet.isObservableSet(value)
+function ObservableSet.isObservableSet(value: any): boolean
 	return DuckTypeUtils.isImplementation(ObservableSet, value)
 end
 
@@ -70,7 +85,7 @@ end
 
 	@return (T) -> ((T, nextIndex: any) -> ...any, T?)
 ]=]
-function ObservableSet:__iter()
+function ObservableSet.__iter<T>(self: ObservableSet<T>): typeof(pairs({} :: _Set.Set<T>))
 	return pairs(self._set)
 end
 
@@ -78,43 +93,51 @@ end
 	Observes all items in the set
 	@return Observable<Brio<T>>
 ]=]
-function ObservableSet:ObserveItemsBrio()
+function ObservableSet.ObserveItemsBrio<T>(self: ObservableSet<T>): Observable.Observable<Brio.Brio<T>>
 	return Observable.new(function(sub)
 		if not self.Destroy then
 			return sub:Fail("ObservableSet is already cleaned up")
 		end
 
 		local maid = Maid.new()
+		local brios: _Set.Map<T, Brio.Brio<T>> = {}
 
-		local function handleItem(item)
-			if maid[item] then
+		local function handleItem(item: T)
+			if brios[item] then
 				-- Happens when we're re-entrance
 				return
 			end
 
 			local brio = Brio.new(item)
-			maid[item] = brio
+			brios[item] = brio :: any
 			sub:Fire(brio)
 		end
 
-
 		maid:GiveTask(self.ItemAdded:Connect(handleItem))
-		maid:GiveTask(self.ItemRemoved:Connect(function(item)
-			maid[item] = nil
+		maid:GiveTask(self.ItemRemoved:Connect(function(item: T)
+			if brios[item] then
+				local brio = brios[item]
+				brios[item] = nil
+
+				brio:Destroy()
+			end
 		end))
 
-		for item, _ in pairs(self._set) do
+		for item, _ in self._set do
 			handleItem(item)
 		end
 
-		self._maid[sub] = maid
+		self._maid[sub :: any] = maid
 		maid:GiveTask(function()
-			self._maid[sub] = nil
+			for _, brio: any in brios do
+				brio:Destroy()
+			end
+			self._maid[sub :: any] = nil
 			sub:Complete()
 		end)
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -124,7 +147,7 @@ end
 	@param item T
 	@return Observable<boolean>
 ]=]
-function ObservableSet:ObserveContains(item)
+function ObservableSet.ObserveContains<T>(self: ObservableSet<T>, item: T): Observable.Observable<boolean>
 	assert(item ~= nil, "Bad item")
 
 	return Observable.new(function(sub)
@@ -144,14 +167,14 @@ function ObservableSet:ObserveContains(item)
 			sub:Fire(doesContain)
 		end))
 
-		self._maid[sub] = maid
+		self._maid[sub :: any] = maid
 		maid:GiveTask(function()
-			self._maid[sub] = nil
+			self._maid[sub :: any] = nil
 			sub:Complete()
 		end)
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
@@ -159,7 +182,7 @@ end
 	@param item T
 	@return boolean
 ]=]
-function ObservableSet:Contains(item)
+function ObservableSet.Contains<T>(self: ObservableSet<T>, item: T): boolean
 	assert(item ~= nil, "Bad item")
 
 	return self._set[item] == true
@@ -169,7 +192,7 @@ end
 	Gets the count of items in the set
 	@return number
 ]=]
-function ObservableSet:GetCount()
+function ObservableSet.GetCount<T>(self: ObservableSet<T>): number
 	return self._countValue.Value or 0
 end
 
@@ -179,7 +202,7 @@ ObservableSet.__len = ObservableSet.GetCount
 	Observes the count of the set
 	@return Observable<number>
 ]=]
-function ObservableSet:ObserveCount()
+function ObservableSet.ObserveCount<T>(self: ObservableSet<T>): Observable.Observable<number>
 	return self._countValue:Observe()
 end
 
@@ -188,7 +211,7 @@ end
 	@param item T
 	@return callback -- Call to remove
 ]=]
-function ObservableSet:Add(item)
+function ObservableSet.Add<T>(self: ObservableSet<T>, item: T): () -> ()
 	assert(item ~= nil, "Bad item")
 
 	if not self._set[item] then
@@ -210,8 +233,9 @@ end
 --[=[
 	Removes the item from the set if it exists.
 	@param item T
+	@return True if removed
 ]=]
-function ObservableSet:Remove(item)
+function ObservableSet.Remove<T>(self: ObservableSet<T>, item: T): boolean
 	assert(item ~= nil, "Bad item")
 
 	if self._set[item] then
@@ -223,6 +247,9 @@ function ObservableSet:Remove(item)
 			self.ItemRemoved:Fire(item)
 		end
 		self._countValue.Value = self._countValue.Value - 1
+		return true
+	else
+		return false
 	end
 end
 
@@ -230,7 +257,7 @@ end
 	Gets an arbitrary item in the set (not guaranteed to be ordered)
 	@return T
 ]=]
-function ObservableSet:GetFirstItem()
+function ObservableSet.GetFirstItem<T>(self: ObservableSet<T>): T?
 	local value = next(self._set)
 	return value
 end
@@ -239,9 +266,9 @@ end
 	Gets a list of all entries.
 	@return { T }
 ]=]
-function ObservableSet:GetList()
+function ObservableSet.GetList<T>(self: ObservableSet<T>): { T }
 	local list = table.create(self._countValue.Value)
-	for item, _ in pairs(self._set) do
+	for item, _ in self._set do
 		table.insert(list, item)
 	end
 	return list
@@ -251,7 +278,7 @@ end
 	Gets a copy of the set
 	@return { [T]: true }
 ]=]
-function ObservableSet:GetSetCopy()
+function ObservableSet.GetSetCopy<T>(self: ObservableSet<T>): _Set.Set<T>
 	return table.clone(self._set)
 end
 
@@ -259,7 +286,7 @@ end
 	Gets the raw set. Do not modify this set.
 	@return { [T]: true }
 ]=]
-function ObservableSet:GetRawSet()
+function ObservableSet.GetRawSet<T>(self: ObservableSet<T>): _Set.Set<T>
 	return self._set
 end
 
@@ -267,9 +294,9 @@ end
 --[=[
 	Cleans up the ObservableSet and sets the metatable to nil.
 ]=]
-function ObservableSet:Destroy()
+function ObservableSet.Destroy<T>(self: ObservableSet<T>)
 	self._maid:DoCleaning()
-	setmetatable(self, nil)
+	setmetatable(self :: any, nil)
 end
 
 return ObservableSet