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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sounds",
-  "version": "10.10.1",
+  "version": "10.10.2-canary.545.2374fb2.0",
   "description": "Utility functions involving sounds and their state",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/promisemaid": "^5.10.1",
-    "@quenty/rbxasset": "^5.8.0"
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/promise": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/promisemaid": "5.10.2-canary.545.2374fb2.0",
+    "@quenty/rbxasset": "5.8.1-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Shared/SoundPromiseUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving sounds and their state
 	@class SoundPromiseUtils
@@ -17,7 +18,7 @@ local SoundPromiseUtils = {}
 	@param sound Sound
 	@return Promise
 ]=]
-function SoundPromiseUtils.promiseLoaded(sound)
+function SoundPromiseUtils.promiseLoaded(sound: Sound): Promise.Promise<()>
 	if sound.IsLoaded then
 		return Promise.resolved()
 	end
@@ -44,13 +45,13 @@ function SoundPromiseUtils.promiseLoaded(sound)
 	return promise
 end
 
-function SoundPromiseUtils.promisePlayed(sound)
+function SoundPromiseUtils.promisePlayed(sound: Sound): Promise.Promise<()>
 	return SoundPromiseUtils.promiseLoaded(sound):Then(function()
 		return PromiseUtils.delayed(sound.TimeLength)
 	end)
 end
 
-function SoundPromiseUtils.promiseLooped(sound)
+function SoundPromiseUtils.promiseLooped(sound: Sound): Promise.Promise<()>
 	local promise = Promise.new()
 
 	PromiseMaidUtils.whilePromise(promise, function(maid)
@@ -66,12 +67,12 @@ end
 	@param sounds { Sound }
 	@return Promise
 ]=]
-function SoundPromiseUtils.promiseAllSoundsLoaded(sounds)
+function SoundPromiseUtils.promiseAllSoundsLoaded(sounds: { Sound }): Promise.Promise<()>
 	local promises = {}
-	for _, sound in pairs(sounds) do
+	for _, sound in sounds do
 		table.insert(promises, SoundPromiseUtils.promiseLoaded(sound))
 	end
 	return PromiseUtils.all(promises)
 end
 
-return SoundPromiseUtils
+return SoundPromiseUtils

package/src/Shared/SoundUtils.lua

@@ -16,6 +16,10 @@ local RunService = game:GetService("RunService")
 local SoundPromiseUtils = require("SoundPromiseUtils")
 local RbxAssetUtils = require("RbxAssetUtils")
 
+export type SoundOptions = {
+	SoundId: number | string,
+}
+
 local SoundUtils = {}
 
 --[=[
@@ -31,7 +35,7 @@ local SoundUtils = {}
 
 	@return Sound
 ]=]
-function SoundUtils.playFromId(id: string | number | table): Sound
+function SoundUtils.playFromId(id: string | number | SoundOptions): Sound
 	local sound = SoundUtils.createSoundFromId(id)
 
 	if RunService:IsClient() then
@@ -48,7 +52,7 @@ end
 --[=[
 	Creates a new sound object from the given id
 ]=]
-function SoundUtils.createSoundFromId(id: string | number | table): Sound
+function SoundUtils.createSoundFromId(id: string | number | SoundOptions): Sound
 	local soundId = SoundUtils.toRbxAssetId(id)
 	assert(type(soundId) == "string", "Bad id")
 
@@ -60,7 +64,7 @@ function SoundUtils.createSoundFromId(id: string | number | table): Sound
 	return sound
 end
 
-function SoundUtils.applyPropertiesFromId(sound, id)
+function SoundUtils.applyPropertiesFromId(sound: Sound, id: string | number | SoundOptions)
 	local soundId = SoundUtils.toRbxAssetId(id)
 	sound.Name = string.format("Sound_%s", soundId)
 	sound.SoundId = soundId
@@ -68,18 +72,20 @@ function SoundUtils.applyPropertiesFromId(sound, id)
 	sound.Volume = 0.25
 
 	if type(id) == "table" then
-		for property, value in pairs(id) do
+		local properties = id :: any
+
+		for property, value in properties do
 			if property ~= "Parent" and property ~= "RollOffMinDistance" then
-				sound[property] = value
+				(sound :: any)[property] = value
 			end
 		end
 
-		if id.RollOffMinDistance then
-			sound.RollOffMinDistance = id.RollOffMinDistance
+		if properties.RollOffMinDistance then
+			sound.RollOffMinDistance = properties.RollOffMinDistance
 		end
 
-		if id.Parent then
-			sound.Parent = id.Parent
+		if properties.Parent then
+			sound.Parent = properties.Parent
 		end
 	end
 end
@@ -87,7 +93,7 @@ end
 --[=[
 	Plays back a template given asset id in the parent
 ]=]
-function SoundUtils.playFromIdInParent(id: string | number | table, parent: Instance): Sound
+function SoundUtils.playFromIdInParent(id: string | number | SoundOptions, parent: Instance): Sound
 	assert(typeof(parent) == "Instance", "Bad parent")
 
 	local sound = SoundUtils.createSoundFromId(id)
@@ -149,7 +155,7 @@ end
 	@return string?
 	@within SoundUtils
 ]=]
-function SoundUtils.toRbxAssetId(soundId)
+function SoundUtils.toRbxAssetId(soundId: string | number | SoundOptions)
 	if type(soundId) == "table" then
 		return RbxAssetUtils.toRbxAssetId(soundId.SoundId)
 	else
@@ -157,7 +163,7 @@ function SoundUtils.toRbxAssetId(soundId)
 	end
 end
 
-function SoundUtils.isConvertableToRbxAsset(soundId)
+function SoundUtils.isConvertableToRbxAsset(soundId: string | number | SoundOptions): boolean
 	if type(soundId) == "table" then
 		return RbxAssetUtils.isConvertableToRbxAsset(soundId.SoundId)
 	else