@quenty/soundgroup 1.20.0 → 1.20.1-canary.545.2374fb2.0

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.
 
+## [1.20.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/soundgroup@1.20.0...@quenty/soundgroup@1.20.1-canary.545.2374fb2.0) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [1.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/soundgroup@1.19.4...@quenty/soundgroup@1.20.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/soundgroup

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/soundgroup",
-  "version": "1.20.0",
+  "version": "1.20.1-canary.545.2374fb2.0",
   "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.0",
-    "@quenty/counter": "^7.17.0",
-    "@quenty/instanceutils": "^13.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/observablecollection": "^12.20.0",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/counter": "7.17.1-canary.545.2374fb2.0",
+    "@quenty/instanceutils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/observablecollection": "12.20.1-canary.545.2374fb2.0",
+    "@quenty/rx": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/table": "3.7.2-canary.545.2374fb2.0",
+    "@quenty/valueobject": "13.17.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Client/SoundGroupServiceClient.lua

@@ -5,11 +5,12 @@
 local require = require(script.Parent.loader).load(script)
 
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local SoundGroupServiceClient = {}
 SoundGroupServiceClient.ServiceName = "SoundGroupServiceClient"
 
-function SoundGroupServiceClient:Init(serviceBag)
+function SoundGroupServiceClient:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()

package/src/Server/SoundGroupService.lua

@@ -6,11 +6,12 @@ local require = require(script.Parent.loader).load(script)
 
 local Maid = require("Maid")
 local WellKnownSoundGroups = require("WellKnownSoundGroups")
+local _ServiceBag = require("ServiceBag")
 
 local SoundGroupService = {}
 SoundGroupService.ServiceName = "SoundGroupService"
 
-function SoundGroupService:Init(serviceBag)
+function SoundGroupService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()

package/src/Shared/Effects/SoundEffectsList.lua

@@ -47,7 +47,7 @@ function SoundEffectsList:ObserveHasEffects()
 	return self._hasEffects:Observe()
 end
 
-function SoundEffectsList:IsActive()
+function SoundEffectsList:IsActive(): boolean
 	return self._isActive.Value
 end
 
@@ -58,7 +58,7 @@ end
 	@param effect (instance) -> MaidTask
 	@return () -> () -- Cleanup call
 ]=]
-function SoundEffectsList:PushEffect(effect)
+function SoundEffectsList:PushEffect(effect: () -> ())
 	assert(type(effect) == "function", "Bad effect")
 
 	return self._effectList:Add(effect)

package/src/Shared/SoundEffectService.lua

@@ -14,11 +14,12 @@ local SoundEffectsRegistry = require("SoundEffectsRegistry")
 local SoundGroupPathUtils = require("SoundGroupPathUtils")
 local SoundGroupTracker = require("SoundGroupTracker")
 local WellKnownSoundGroups = require("WellKnownSoundGroups")
+local _ServiceBag = require("ServiceBag")
 
 local SoundEffectService = {}
 SoundEffectService.ServiceName = "SoundEffectService"
 
-function SoundEffectService:Init(serviceBag)
+function SoundEffectService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -36,14 +37,14 @@ end
 	@param sound Sound
 	@param soundGroupPath string? -- Optional
 ]=]
-function SoundEffectService:RegisterSFX(sound, soundGroupPath)
+function SoundEffectService:RegisterSFX(sound: Sound, soundGroupPath: string?)
 	assert(typeof(sound) == "Instance" and sound:IsA("Sound"), "Bad sound")
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath) or soundGroupPath == nil, "Bad soundGroupPath")
 
 	sound.SoundGroup = self:GetOrCreateSoundGroup(soundGroupPath or WellKnownSoundGroups.SFX)
 end
 
-function SoundEffectService:GetOrCreateSoundGroup(soundGroupPath)
+function SoundEffectService:GetOrCreateSoundGroup(soundGroupPath: string): SoundGroup
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 
 	local found = self:GetSoundGroup(soundGroupPath)
@@ -55,7 +56,7 @@ function SoundEffectService:GetOrCreateSoundGroup(soundGroupPath)
 	return SoundGroupPathUtils.findOrCreateSoundGroup(soundGroupPath)
 end
 
-function SoundEffectService:GetSoundGroup(soundGroupPath)
+function SoundEffectService:GetSoundGroup(soundGroupPath: string): SoundGroup
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 
 	if not self._tracker then
@@ -75,7 +76,7 @@ function SoundEffectService:GetSoundGroup(soundGroupPath)
 	return SoundGroupPathUtils.findOrCreateSoundGroup(soundGroupPath)
 end
 
-function SoundEffectService:PushEffect(soundGroupPath, effect)
+function SoundEffectService:PushEffect(soundGroupPath: string, effect)
 	assert(SoundGroupPathUtils.isSoundGroupPath(soundGroupPath), "Bad soundGroupPath")
 	assert(type(effect) == "function", "Bad effect")
 

package/src/Shared/Utils/SoundGroupPathUtils.lua

@@ -1,60 +1,93 @@
+--!strict
 --[=[
 	@class SoundGroupPathUtils
 ]=]
 
-local require = require(script.Parent.loader).load(script)
-
 local SoundService = game:GetService("SoundService")
 
 local SoundGroupPathUtils = {}
 
-function SoundGroupPathUtils.isSoundGroupPath(soundGroupPath)
+--[=[
+	Checks if the given string is a valid sound group path.
+
+	@param soundGroupPath string
+	@return boolean
+]=]
+function SoundGroupPathUtils.isSoundGroupPath(soundGroupPath: string): boolean
 	return type(soundGroupPath) == "string"
 end
 
-function SoundGroupPathUtils.toPathTable(soundGroupPath)
+--[=[
+	Converts a sound group path into a table of strings.
+
+	@param soundGroupPath string
+	@return { string }
+]=]
+function SoundGroupPathUtils.toPathTable(soundGroupPath: string): { string }
 	assert(type(soundGroupPath) == "string", "Bad soundGroupPath")
 
 	return string.split(soundGroupPath, ".")
 end
 
-function SoundGroupPathUtils.findSoundGroup(soundGroupPath, root)
+--[=[
+	Converts a table of strings into a sound group path.
+
+	@param soundGroupPath string
+	@param root Instance?
+	@return SoundGroup
+]=]
+function SoundGroupPathUtils.findSoundGroup(soundGroupPath: string, root: Instance?): SoundGroup?
 	assert(type(soundGroupPath) == "string", "Bad soundGroupPath")
 	assert(typeof(root) == "Instance" or root == nil, "Bad root")
 
-	local current = SoundService
+	local current: Instance = root or SoundService
 	for _, soundGroupName in SoundGroupPathUtils.toPathTable(soundGroupPath) do
-		current = SoundGroupPathUtils._findSoundGroup(current, soundGroupName)
-		if not current then
+		local found = SoundGroupPathUtils._findSoundGroup(current, soundGroupName)
+		if not found then
 			return nil
 		end
+		current = found
 	end
 
-	return current
+	if current ~= root and current:IsA("SoundGroup") then
+		return current
+	else
+		return nil
+	end
 end
 
-function SoundGroupPathUtils.findOrCreateSoundGroup(soundGroupPath, root)
+--[=[
+	Converts a table of strings into a sound group path.
+
+	@param soundGroupPath string
+	@return SoundGroup
+]=]
+function SoundGroupPathUtils.findOrCreateSoundGroup(soundGroupPath: string, root: Instance?): SoundGroup
 	assert(type(soundGroupPath) == "string", "Bad soundGroupPath")
 	assert(typeof(root) == "Instance" or root == nil, "Bad root")
 
-	local current = root or SoundService
+	local current: Instance = root or SoundService
 
 	for _, soundGroupName in SoundGroupPathUtils.toPathTable(soundGroupPath) do
 		local parent = current
-		current = SoundGroupPathUtils._findSoundGroup(parent, soundGroupName)
-
-		if not current then
-			current = Instance.new("SoundGroup")
-			current.Name = soundGroupName
-			current.Volume = 1
-			current.Parent = parent
+		local found = SoundGroupPathUtils._findSoundGroup(parent, soundGroupName)
+
+		if found then
+			current = found
+		else
+			local constructed = Instance.new("SoundGroup")
+			constructed.Name = soundGroupName
+			constructed.Volume = 1
+			constructed.Parent = parent
+			current = constructed
 		end
 	end
 
+	assert(current:IsA("SoundGroup"), "Current is not a SoundGroup")
 	return current
 end
 
-function SoundGroupPathUtils._findSoundGroup(parent, soundGroupName)
+function SoundGroupPathUtils._findSoundGroup(parent: Instance, soundGroupName: string): SoundGroup?
 	for _, item in parent:GetChildren() do
 		if item:IsA("SoundGroup") and item.Name == soundGroupName then
 			return item