@quenty/soundgroup 1.20.2 → 1.20.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [1.20.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/soundgroup@1.20.2...@quenty/soundgroup@1.20.3) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/soundgroup
+
+
+
+
+
 ## [1.20.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/soundgroup@1.20.0...@quenty/soundgroup@1.20.2) (2025-04-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/soundgroup",
-  "version": "1.20.2",
+  "version": "1.20.3",
   "description": "Service and utility methods to working with sound groups and sounds in Roblox",
   "keywords": [
     "Roblox",
@@ -25,18 +25,18 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.2",
-    "@quenty/counter": "^7.17.2",
-    "@quenty/instanceutils": "^13.17.2",
-    "@quenty/loader": "^10.8.2",
-    "@quenty/maid": "^3.4.2",
-    "@quenty/observablecollection": "^12.20.2",
-    "@quenty/rx": "^13.17.2",
-    "@quenty/table": "^3.7.3",
-    "@quenty/valueobject": "^13.17.2"
+    "@quenty/baseobject": "^10.8.3",
+    "@quenty/counter": "^7.17.3",
+    "@quenty/instanceutils": "^13.17.3",
+    "@quenty/loader": "^10.8.3",
+    "@quenty/maid": "^3.4.3",
+    "@quenty/observablecollection": "^12.20.3",
+    "@quenty/rx": "^13.17.3",
+    "@quenty/table": "^3.7.4",
+    "@quenty/valueobject": "^13.17.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64def70499ec067077ee39f279936b620b217847"
+  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
 }

package/src/Shared/Effects/SoundEffectsList.lua

@@ -1,4 +1,7 @@
+--!strict
 --[=[
+	Holds sound effects to be applied
+
 	@class SoundEffectsList
 ]=]
 
@@ -11,13 +14,29 @@ local MaidTaskUtils = require("MaidTaskUtils")
 local ValueObject = require("ValueObject")
 local Counter = require("Counter")
 local Rx = require("Rx")
+local _Signal = require("Signal")
+local _Observable = require("Observable")
 
 local SoundEffectsList = setmetatable({}, BaseObject)
 SoundEffectsList.ClassName = "SoundEffectsList"
 SoundEffectsList.__index = SoundEffectsList
 
-function SoundEffectsList.new()
-	local self = setmetatable(BaseObject.new(), SoundEffectsList)
+export type SoundEffectApplier = (SoundGroup | Sound) -> MaidTaskUtils.MaidTask?
+
+export type SoundEffectsList = typeof(setmetatable(
+	{} :: {
+		_effectList: ObservableList.ObservableList<SoundEffectApplier>,
+		_appliedCount: Counter.Counter,
+		_isActive: ValueObject.ValueObject<boolean>,
+		_hasEffects: ValueObject.ValueObject<boolean>,
+		IsActiveChanged: _Signal.Signal<boolean>,
+		HasEffects: () -> boolean,
+	},
+	{} :: typeof({ __index = SoundEffectsList })
+)) & BaseObject.BaseObject
+
+function SoundEffectsList.new(): SoundEffectsList
+	local self: SoundEffectsList = setmetatable(BaseObject.new() :: any, SoundEffectsList)
 
 	self._effectList = self._maid:Add(ObservableList.new())
 	self._appliedCount = self._maid:Add(Counter.new())
@@ -26,11 +45,11 @@ function SoundEffectsList.new()
 	self._isActive = self._maid:Add(ValueObject.new(false, "boolean"))
 	self._hasEffects = self._maid:Add(ValueObject.new(false, "boolean"))
 
-	self.IsActiveChanged = assert(self._isActive.Changed, "No Changed")
+	self.IsActiveChanged = assert(self._isActive.Changed :: any, "No Changed")
 
 	self._maid:GiveTask(Rx.combineLatest({
-		appliedCount = self._appliedCount:Observe();
-		effectCount = self._effectList:ObserveCount();
+		appliedCount = self._appliedCount:Observe(),
+		effectCount = self._effectList:ObserveCount(),
 	}):Subscribe(function(state)
 		self._hasEffects.Value = state.effectCount > 0
 		self._isActive.Value = state.appliedCount > 0 or state.effectCount > 0
@@ -39,15 +58,28 @@ function SoundEffectsList.new()
 	return self
 end
 
-function SoundEffectsList:HasEffects()
+--[=[
+	Returns the number of effects that are currently applied.
+
+	@return boolean
+]=]
+function SoundEffectsList.HasEffects(self: SoundEffectsList): boolean
 	return self._hasEffects.Value
 end
 
-function SoundEffectsList:ObserveHasEffects()
+--[=[
+	Observes whether the list has any effects.
+
+	@return Observable<boolean>
+]=]
+function SoundEffectsList.ObserveHasEffects(self: SoundEffectsList): _Observable.Observable<boolean>
 	return self._hasEffects:Observe()
 end
 
-function SoundEffectsList:IsActive(): boolean
+--[=[
+	Rounds whether the list is effective or not.
+]=]
+function SoundEffectsList.IsActive(self: SoundEffectsList): boolean
 	return self._isActive.Value
 end
 
@@ -58,7 +90,7 @@ end
 	@param effect (instance) -> MaidTask
 	@return () -> () -- Cleanup call
 ]=]
-function SoundEffectsList:PushEffect(effect: () -> ())
+function SoundEffectsList.PushEffect(self: SoundEffectsList, effect: SoundEffectApplier): () -> ()
 	assert(type(effect) == "function", "Bad effect")
 
 	return self._effectList:Add(effect)
@@ -71,7 +103,7 @@ end
 	@param instance SoundGroup | Sound
 	@return () -> () -- Cleanup call
 ]=]
-function SoundEffectsList:ApplyEffects(instance)
+function SoundEffectsList.ApplyEffects(self: SoundEffectsList, instance: SoundGroup | Sound): () -> ()
 	assert(typeof(instance) == "Instance" and (instance:IsA("SoundGroup") or instance:IsA("Sound")), "Bad instance")
 
 	local topMaid = Maid.new()

package/src/Shared/Effects/SoundEffectsRegistry.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Allows us to independently apply sound effects to both sound groups and to
 	individual sounds.
@@ -13,13 +14,23 @@ local ObservableMap = require("ObservableMap")
 local SoundEffectsList = require("SoundEffectsList")
 local SoundGroupPathUtils = require("SoundGroupPathUtils")
 local ObservableSet = require("ObservableSet")
+local _Observable = require("Observable")
+local _Brio = require("Brio")
 
 local SoundEffectsRegistry = setmetatable({}, BaseObject)
 SoundEffectsRegistry.ClassName = "SoundEffectsRegistry"
 SoundEffectsRegistry.__index = SoundEffectsRegistry
 
-function SoundEffectsRegistry.new()
-	local self = setmetatable(BaseObject.new(), SoundEffectsRegistry)
+export type SoundEffectsRegistry = typeof(setmetatable(
+	{} :: {
+		_pathToEffectList: ObservableMap.ObservableMap<string, SoundEffectsList.SoundEffectsList>,
+		_activeEffectsPathSet: ObservableSet.ObservableSet<string>,
+	},
+	{} :: typeof({ __index = SoundEffectsRegistry })
+)) & BaseObject.BaseObject
+
+function SoundEffectsRegistry.new(): SoundEffectsRegistry
+	local self: SoundEffectsRegistry = setmetatable(BaseObject.new() :: any, SoundEffectsRegistry)
 
 	self._pathToEffectList = self._maid:Add(ObservableMap.new())
 	self._activeEffectsPathSet = self._maid:Add(ObservableSet.new())
@@ -27,7 +38,11 @@ function SoundEffectsRegistry.new()
 	return self
 end
 
-function SoundEffectsRegistry:PushEffect(soundGroupPath, effect)
+function SoundEffectsRegistry.PushEffect(
+	self: SoundEffectsRegistry,
+	soundGroupPath: string,
+	effect: SoundEffectsList.SoundEffectApplier
+): () -> ()
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 	assert(type(effect) == "function", "Bad effect")
 
@@ -35,7 +50,11 @@ function SoundEffectsRegistry:PushEffect(soundGroupPath, effect)
 	return effectsList:PushEffect(effect)
 end
 
-function SoundEffectsRegistry:ApplyEffects(soundGroupPath, instance)
+function SoundEffectsRegistry.ApplyEffects(
+	self: SoundEffectsRegistry,
+	soundGroupPath: string,
+	instance: SoundGroup | Sound
+): () -> ()
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 	assert(typeof(instance) == "Instance" and (instance:IsA("SoundGroup") or instance:IsA("Sound")), "Bad instance")
 
@@ -43,11 +62,13 @@ function SoundEffectsRegistry:ApplyEffects(soundGroupPath, instance)
 	return effectsList:ApplyEffects(instance)
 end
 
-function SoundEffectsRegistry:ObserveActiveEffectsPathBrios()
-	return self._activeEffectsPathSet:ObserveItemsBrio()
+function SoundEffectsRegistry.ObserveActiveEffectsPathBrios(
+	self: SoundEffectsRegistry
+): _Observable.Observable<_Brio.Brio<string>>
+	return self._activeEffectsPathSet:ObserveItemsBrio() :: any
 end
 
-function SoundEffectsRegistry:_getOrCreateEffectList(soundGroupPath)
+function SoundEffectsRegistry._getOrCreateEffectList(self: SoundEffectsRegistry, soundGroupPath: string): SoundEffectsList.SoundEffectsList
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 
 	local found = self._pathToEffectList:Get(soundGroupPath)

package/src/Shared/Groups/WellKnownSoundGroups.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class WellKnownSoundGroups
 ]=]
@@ -6,10 +7,17 @@ local require = require(script.Parent.loader).load(script)
 
 local Table = require("Table")
 
+export type WellKnownSoundGroups = {
+	MASTER: "Master",
+	SFX: "Master.SoundEffects",
+	MUSIC: "Master.Music",
+	VOICE: "Master.Voice",
+}
+
 return Table.readonly({
-	MASTER = "Master";
+	MASTER = "Master",
 
-	SFX = "Master.SoundEffects";
-	MUSIC = "Master.Music";
-	VOICE = "Master.Voice";
-})
+	SFX = "Master.SoundEffects",
+	MUSIC = "Master.Music",
+	VOICE = "Master.Voice",
+} :: WellKnownSoundGroups)

package/src/Shared/SoundGroupTracker.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class SoundGroupTracker
 ]=]
@@ -9,7 +10,7 @@ local RxInstanceUtils = require("RxInstanceUtils")
 local ObservableMapList = require("ObservableMapList")
 local Maid = require("Maid")
 local ObservableMap = require("ObservableMap")
-local SoundGroupPathUtils= require("SoundGroupPathUtils")
+local SoundGroupPathUtils = require("SoundGroupPathUtils")
 local Rx = require("Rx")
 local Observable = require("Observable")
 
@@ -17,8 +18,16 @@ local SoundGroupTracker = setmetatable({}, BaseObject)
 SoundGroupTracker.ClassName = "SoundGroupTracker"
 SoundGroupTracker.__index = SoundGroupTracker
 
-function SoundGroupTracker.new(root)
-	local self = setmetatable(BaseObject.new(), SoundGroupTracker)
+export type SoundGroupTracker = typeof(setmetatable(
+	{} :: {
+		_pathToSoundGroupList: ObservableMapList.ObservableMapList<string, SoundGroup>,
+		_soundGroupToPath: ObservableMap.ObservableMap<SoundGroup, string>,
+	},
+	{} :: typeof({ __index = SoundGroupTracker })
+)) & BaseObject.BaseObject
+
+function SoundGroupTracker.new(root): SoundGroupTracker
+	local self: SoundGroupTracker = setmetatable(BaseObject.new() :: any, SoundGroupTracker)
 
 	-- Handle edge case of multiple sound groups with the same name...
 	self._pathToSoundGroupList = self._maid:Add(ObservableMapList.new())
@@ -31,39 +40,39 @@ function SoundGroupTracker.new(root)
 	return self
 end
 
-function SoundGroupTracker:GetFirstSoundGroup(soundGroupPath)
+function SoundGroupTracker.GetFirstSoundGroup(self: SoundGroupTracker, soundGroupPath)
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 
 	return self._pathToSoundGroupList:GetAtListIndex(soundGroupPath, 1)
 end
 
-function SoundGroupTracker:ObserveSoundGroup(soundGroupPath)
+function SoundGroupTracker.ObserveSoundGroup(self: SoundGroupTracker, soundGroupPath)
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 
 	return self._pathToSoundGroupList:ObserveAtListIndex(soundGroupPath, 1)
 end
 
-function SoundGroupTracker:ObserveSoundGroupBrio(soundGroupPath)
+function SoundGroupTracker.ObserveSoundGroupBrio(self: SoundGroupTracker, soundGroupPath)
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 
 	return self._pathToSoundGroupList:ObserveAtListIndexBrio(soundGroupPath, 1)
 end
 
-function SoundGroupTracker:ObserveSoundGroupsBrio()
+function SoundGroupTracker.ObserveSoundGroupsBrio(self: SoundGroupTracker)
 	return self._soundGroupToPath:ObserveKeysBrio()
 end
 
-function SoundGroupTracker:Track(parent)
+function SoundGroupTracker.Track(self: SoundGroupTracker, parent)
 	return self:_track(nil, parent)
 end
 
-function SoundGroupTracker:ObserveSoundGroupPath(soundGroup)
+function SoundGroupTracker.ObserveSoundGroupPath(self: SoundGroupTracker, soundGroup)
 	assert(typeof(soundGroup) == "Instance" and soundGroup:IsA("SoundGroup"), "Bad soundGroup")
 
 	return self._soundGroupToPath:ObserveAtKey(soundGroup)
 end
 
-function SoundGroupTracker:_track(observeRootPath, parent)
+function SoundGroupTracker._track(self: SoundGroupTracker, observeRootPath, parent)
 	assert(Observable.isObservable(observeRootPath) or observeRootPath == nil, "Bad observeRootPath")
 	assert(typeof(parent) == "Instance", "Bad parent")
 
@@ -76,6 +85,7 @@ function SoundGroupTracker:_track(observeRootPath, parent)
 
 		local maid, soundGroup = brio:ToMaidAndValue()
 
+		-- stylua: ignore
 		local observePath = Rx.combineLatest({
 			rootPath = observeRootPath or nil;
 			name = RxInstanceUtils.observeProperty(soundGroup, "Name");
@@ -87,11 +97,11 @@ function SoundGroupTracker:_track(observeRootPath, parent)
 				else
 					return state.name
 				end
-			end)
+			end) :: any
 		})
 
 		maid:Add(observePath:Subscribe(function(path)
-			maid._currentPath = self._soundGroupToPath:Set(soundGroup, path)
+			maid._currentPath = self._soundGroupToPath:Set(soundGroup :: SoundGroup, path)
 		end))
 		maid:Add(self._pathToSoundGroupList:Push(observePath, soundGroup))