@quenty/sprites 13.16.0 → 13.16.1

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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/sprites",
-  "version": "13.16.0",
+  "version": "13.16.1",
   "description": "Spritesheet utility for Roblox including a built-in InputImageLibrary",
   "keywords": [
     "Roblox",
@@ -26,16 +26,16 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/uiobjectutils": "^6.16.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/uiobjectutils": "^6.16.1"
   },
   "devDependencies": {
-    "@quenty/string": "^3.3.1"
+    "@quenty/string": "^3.3.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/InputImageLibrary/InputImageLibrary.story.lua

@@ -157,7 +157,7 @@ local function makeSection(keycodes, theme, platform, parent)
 	uiGridLayout.CellSize = UDim2.new(0, 100, 0, 130)
 	uiGridLayout.Parent = container
 
-	for _, item in pairs(keycodes) do
+	for _, item in keycodes do
 		createInputKey(item, theme, platform, container)
 	end
 

package/src/Shared/InputImageLibrary/init.lua

@@ -29,22 +29,22 @@ end
 
 	@return { string }
 ]=]
-function InputImageLibrary:GetPreloadAssetIds()
+function InputImageLibrary:GetPreloadAssetIds(): { string }
 	local assets = {}
-	for _, platformSheets in pairs(self._spritesheets) do
-		for _, sheet in pairs(platformSheets) do
+	for _, platformSheets in self._spritesheets do
+		for _, sheet in platformSheets do
 			table.insert(assets, sheet:GetPreloadAssetId())
 		end
 	end
 	return assets
 end
 
-function InputImageLibrary:_loadSpriteSheets(parentFolder)
+function InputImageLibrary:_loadSpriteSheets(parentFolder: Instance)
 	assert(typeof(parentFolder) == "Instance", "Bad parentFolder")
 
-	for _, platform in pairs(parentFolder:GetChildren()) do
+	for _, platform in parentFolder:GetChildren() do
 		self._spritesheets[platform.Name] = {}
-		for _, style in pairs(platform:GetChildren()) do
+		for _, style in platform:GetChildren() do
 			if style:IsA("ModuleScript") then
 				self._spritesheets[platform.Name][style.Name] = require(style).new()
 			end
@@ -56,11 +56,11 @@ end
 	Retrieves a sprite from the library
 
 	@param keyCode any -- The sprite keyCode to get
-	@param preferredStyle string -- The preferred style type to retrieve this in
-	@param preferredPlatform string -- The preferred platform to get the sprite for
+	@param preferredStyle string? -- The preferred style type to retrieve this in
+	@param preferredPlatform string? -- The preferred platform to get the sprite for
 	@return Sprite
 ]=]
-function InputImageLibrary:GetSprite(keyCode, preferredStyle, preferredPlatform)
+function InputImageLibrary:GetSprite(keyCode, preferredStyle: string?, preferredPlatform: string?)
 	assert(keyCode ~= nil, "Bad keyCode")
 	assert(type(preferredStyle) == "string" or preferredStyle == nil, "Bad preferredStyle")
 	assert(type(preferredPlatform) == "string" or preferredPlatform == nil, "Bad preferredPlatform")
@@ -83,11 +83,11 @@ end
 
 	@param gui ImageLabel | ImageButton
 	@param keyCode any -- The sprite keyCode to get
-	@param preferredStyle string -- The preferred style type to retrieve this in
-	@param preferredPlatform string -- The preferred platform to get the sprite for
+	@param preferredStyle string? -- The preferred style type to retrieve this in
+	@param preferredPlatform string? -- The preferred platform to get the sprite for
 	@return Sprite
 ]=]
-function InputImageLibrary:StyleImage(gui, keyCode, preferredStyle, preferredPlatform)
+function InputImageLibrary:StyleImage(gui, keyCode, preferredStyle: string?, preferredPlatform: string?)
 	assert(typeof(gui) == "Instance" and (gui:IsA("ImageLabel") or gui:IsA("ImageButton")), "Bad gui")
 	assert(keyCode ~= nil, "Bad keyCode")
 	assert(type(preferredStyle) == "string" or preferredStyle == nil, "Bad preferredStyle")
@@ -118,7 +118,7 @@ function InputImageLibrary:_getDefaultPreferredPlatform()
 	end
 end
 
-function InputImageLibrary:GetScaledImageLabel(keyCode, preferredStyle, preferredPlatform)
+function InputImageLibrary:GetScaledImageLabel(keyCode, preferredStyle: string?, preferredPlatform: string?)
 	assert(keyCode ~= nil, "Bad keyCode")
 	assert(type(preferredStyle) == "string" or preferredStyle == nil, "Bad preferredStyle")
 	assert(type(preferredPlatform) == "string" or preferredPlatform == nil, "Bad preferredPlatform")
@@ -129,7 +129,7 @@ function InputImageLibrary:GetScaledImageLabel(keyCode, preferredStyle, preferre
 	end
 
 	local size = image.Size
-	local ratio = size.Y.Offset/size.X.Offset
+	local ratio = size.Y.Offset / size.X.Offset
 
 	local uiAspectRatio = Instance.new("UIAspectRatioConstraint")
 	uiAspectRatio.DominantAxis = Enum.DominantAxis.Height
@@ -141,7 +141,7 @@ function InputImageLibrary:GetScaledImageLabel(keyCode, preferredStyle, preferre
 	return image
 end
 
-function InputImageLibrary:PickSheet(keyCode, preferredStyle, preferredPlatform)
+function InputImageLibrary:PickSheet(keyCode, preferredStyle: string?, preferredPlatform: string?)
 	assert(keyCode ~= nil, "Bad keyCode")
 	assert(type(preferredStyle) == "string" or preferredStyle == nil, "Bad preferredStyle")
 	assert(type(preferredPlatform) == "string" or preferredPlatform == nil, "Bad preferredPlatform")
@@ -153,11 +153,13 @@ function InputImageLibrary:PickSheet(keyCode, preferredStyle, preferredPlatform)
 		end
 
 		-- otherwise search (yes, we double hit a sheet)
-		for _, sheet in pairs(platformSheets) do
+		for _, sheet in platformSheets do
 			if sheet:HasSprite(keyCode) then
 				return sheet
 			end
 		end
+
+		return nil
 	end
 
 	preferredPlatform = preferredPlatform or self:_getDefaultPreferredPlatform()
@@ -171,7 +173,7 @@ function InputImageLibrary:PickSheet(keyCode, preferredStyle, preferredPlatform)
 	end
 
 	-- otherwise search (repeats preferred :/ )
-	for _, platformSheets in pairs(self._spritesheets) do
+	for _, platformSheets in self._spritesheets do
 		local foundSheet = findSheet(platformSheets)
 		if foundSheet then
 			return foundSheet

package/src/Shared/Sprite/Sprite.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	A single image on a spritesheet.
 	@class Sprite
@@ -7,6 +8,16 @@ local Sprite = {}
 Sprite.ClassName = "Sprite"
 Sprite.__index = Sprite
 
+export type Sprite = typeof(setmetatable(
+	{} :: {
+		Texture: string,
+		Size: Vector2,
+		Position: Vector2,
+		Name: string,
+	},
+	Sprite
+))
+
 --[=[
 	Data used to construct a sprite.
 	@interface SpriteData
@@ -16,13 +27,19 @@ Sprite.__index = Sprite
 	.Name string
 	@within Sprite
 ]=]
+export type SpriteData = {
+	Texture: string,
+	Size: Vector2,
+	Position: Vector2,
+	Name: string,
+}
 
 --[=[
 	Constructs a new sprite
 	@param data SpriteData
 	@return Sprite
 ]=]
-function Sprite.new(data)
+function Sprite.new(data: SpriteData): Sprite
 	assert(data.Texture, "Bad data")
 	assert(data.Size, "Bad data")
 	assert(data.Position, "Bad data")
@@ -38,12 +55,11 @@ end
 	@param gui ImageLabel | ImageButton
 	@return Instance
 ]=]
-function Sprite:Style(gui)
-	assert(typeof(gui) == "Instance" and (gui:IsA("ImageLabel") or gui:IsA("ImageButton")), "Bad gui")
-
-	gui.Image = self.Texture
-	gui.ImageRectOffset = self.Position
-	gui.ImageRectSize = self.Size
+function Sprite:Style(gui: ImageLabel | ImageButton)
+	assert(typeof(gui) == "Instance" and (gui:IsA("ImageLabel") or gui:IsA("ImageButton")), "Bad gui");
+	(gui :: ImageLabel).Image = self.Texture;
+	(gui :: ImageLabel).ImageRectOffset = self.Position;
+	(gui :: ImageLabel).ImageRectSize = self.Size
 
 	return gui
 end
@@ -53,10 +69,10 @@ end
 	@param instanceType "ImageLabel" | "ImageButton"
 	@return ImageLabel | ImageButton
 ]=]
-function Sprite:Get(instanceType)
+function Sprite:Get(instanceType: "ImageLabel" | "ImageButton"): ImageLabel | ImageButton
 	assert(type(instanceType) == "string", "Bad instanceType")
 
-	local gui = Instance.new(instanceType)
+	local gui: any = Instance.new(instanceType)
 	gui.Size = UDim2.new(0, self.Size.X, 0, self.Size.Y)
 	gui.Name = self.Name
 	gui.BackgroundTransparency = 1

package/src/Shared/Sprite/Spritesheet.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Data model for sprite sheets
 	@class Spritesheet
@@ -11,12 +12,20 @@ local Spritesheet = {}
 Spritesheet.ClassName = "Spritesheet"
 Spritesheet.__index = Spritesheet
 
+export type Spritesheet = typeof(setmetatable(
+	{} :: {
+		_texture: string,
+		_sprites: { [any]: Sprite.Sprite },
+	},
+	Spritesheet
+))
+
 --[=[
 	Constructs a new Spritesheet
 	@param texture string
 	@return Spritesheet
 ]=]
-function Spritesheet.new(texture)
+function Spritesheet.new(texture: string): Spritesheet
 	local self = setmetatable({}, Spritesheet)
 
 	self._texture = texture or error("no texture")
@@ -29,7 +38,7 @@ end
 	Retrieves the preload asset ids to use
 	@return string
 ]=]
-function Spritesheet:GetPreloadAssetId()
+function Spritesheet:GetPreloadAssetId(): string
 	return self._texture
 end
 
@@ -40,17 +49,18 @@ end
 
 	Adds a named sprite at the given keyCode
 ]=]
-function Spritesheet:AddSprite(keyCode, position, size)
+function Spritesheet:AddSprite(keyCode: any, position: Vector2, size: Vector2): Sprite.Sprite
 	assert(not self._sprites[keyCode], "Already exists")
 
 	local sprite = Sprite.new({
-		Texture = self._texture;
-		Position = position;
-		Size = size;
-		Name = tostring(keyCode);
+		Texture = self._texture,
+		Position = position,
+		Size = size,
+		Name = tostring(keyCode),
 	})
 
 	self._sprites[keyCode] = sprite
+	return sprite
 end
 
 --[=[
@@ -58,7 +68,7 @@ end
 	@param keyCode any | EnumItem
 	@return Sprite?
 ]=]
-function Spritesheet:GetSprite(keyCode)
+function Spritesheet:GetSprite(keyCode: any): Sprite.Sprite?
 	if not keyCode then
 		warn("[Spritesheet.GetSprite] - Image name cannot be nil")
 		return nil
@@ -81,7 +91,7 @@ end
 	@param keyCode any | EnumItem
 	@return boolean
 ]=]
-function Spritesheet:HasSprite(keyCode)
+function Spritesheet:HasSprite(keyCode: any): boolean
 	return self:GetSprite(keyCode) ~= nil
 end