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

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/tuple",
-  "version": "1.5.0",
+  "version": "1.5.1",
   "description": "Tuple utility package",
   "keywords": [
     "Roblox",
@@ -25,11 +25,11 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/loader": "^10.8.0",
-    "@quenty/lrucache": "^1.6.0"
+    "@quenty/loader": "^10.8.1",
+    "@quenty/lrucache": "^1.6.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/Tuple.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Tuple class for Lua
 
@@ -8,13 +9,20 @@ local Tuple = {}
 Tuple.ClassName = "Tuple"
 Tuple.__index = Tuple
 
+export type Tuple<T...> = typeof(setmetatable(
+	{} :: {
+		n: number,
+	},
+	Tuple
+))
+
 --[=[
 	Constructs a new tuple
 
 	@param ... any
-	@return Tuple<T>
+	@return Tuple<T...>
 ]=]
-function Tuple.new(...)
+function Tuple.new<T...>(...: T...): Tuple<T...>
 	return setmetatable(table.pack(...), Tuple)
 end
 
@@ -24,7 +32,7 @@ end
 	@param value any
 	@return boolean
 ]=]
-function Tuple.isTuple(value)
+function Tuple.isTuple(value: any): boolean
 	return getmetatable(value) == Tuple
 end
 
@@ -33,25 +41,25 @@ end
 
 	@return T
 ]=]
-function Tuple:Unpack()
-	return table.unpack(self, 1, self.n)
+function Tuple.Unpack<T...>(self: Tuple<T...>): T...
+	return table.unpack(self :: any, 1, self.n)
 end
 
 --[=[
 	Converts to array
 
-	@return { T }
+	@return { T... }
 ]=]
-function Tuple:ToArray()
-	return { self:Unpack() }
+function Tuple.ToArray<T...>(self: Tuple<T...>): { any }
+	return { Tuple.Unpack(self) }
 end
 
 --[=[
 	Converts the tuple to a string for easy debugging
 ]=]
-function Tuple:__tostring()
+function Tuple.__tostring<T...>(self: Tuple<T...>): string
 	local converted = {}
-	for i=1, self.n do
+	for i = 1, self.n do
 		converted[i] = tostring(self[i])
 	end
 	return table.concat(converted, ", ")
@@ -62,7 +70,7 @@ end
 
 	@return number
 ]=]
-function Tuple:__len()
+function Tuple.__len<T...>(self: Tuple<T...>): number
 	return self.n
 end
 
@@ -70,7 +78,7 @@ end
 	Compares the tuple to another tuple
 	@param other Tuple
 ]=]
-function Tuple:__eq(other)
+function Tuple.__eq<T...>(self: Tuple<T...>, other: Tuple<T...>): boolean
 	if not Tuple.isTuple(other) then
 		return false
 	end
@@ -79,7 +87,7 @@ function Tuple:__eq(other)
 		return false
 	end
 
-	for i=1, self.n do
+	for i = 1, self.n do
 		if self[i] ~= other[i] then
 			return false
 		end
@@ -92,12 +100,12 @@ end
 	Combines the tuple
 	@param other Tuple
 ]=]
-function Tuple:__add(other)
+function Tuple.__add<T...>(self: Tuple<T...>, other: Tuple<T...>): Tuple<T...>
 	assert(Tuple.isTuple(other), "Can only add tuples")
 
-	local result = Tuple.new(self:Unpack())
+	local result = Tuple.new(Tuple.Unpack(self))
 	local count = self.n
-	for i=1, other.n do
+	for i = 1, other.n do
 		result[count + i] = other[i]
 	end
 	result.n = count + other.n
@@ -109,8 +117,8 @@ end
 
 	@return ...
 ]=]
-function Tuple:__call()
-	return table.unpack(self, 1, self.n)
+function Tuple.__call<T...>(self: Tuple<T...>): T...
+	return table.unpack(self :: any, 1, self.n)
 end
 
 return Tuple

package/src/Shared/Tuple.story.lua

@@ -6,7 +6,7 @@ local require = require(game:GetService("ServerScriptService"):FindFirstChild("L
 
 local Tuple = require("Tuple")
 
-return function(_target)
+return function(_target: Frame)
 	local a = Tuple.new(1, 2, 3)
 	local b = Tuple.new(1, 2, 3)
 	local c = Tuple.new(3, 4, "d")

package/src/Shared/TupleLookup.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Helps look up tuples that can be used as keys
 
@@ -12,22 +13,30 @@ local TupleLookup = {}
 TupleLookup.ClassName = "TupleLookup"
 TupleLookup.__index = TupleLookup
 
-function TupleLookup.new()
+export type TupleLookup = typeof(setmetatable(
+	{} :: {
+		_tuples: { [Tuple.Tuple<...any>]: boolean },
+		_singleArgTuples: { [any]: Tuple.Tuple<...any> },
+	},
+	TupleLookup
+))
+
+function TupleLookup.new(): TupleLookup
 	local self = setmetatable({}, TupleLookup)
 
-	self._tuples = setmetatable({}, { __mode = "k"})
-	self._singleArgTuples = setmetatable({}, { __mode = "kv"})
+	self._tuples = setmetatable({}, { __mode = "k" })
+	self._singleArgTuples = setmetatable({}, { __mode = "kv" })
 
-	return self
+	return self :: any
 end
 
 --[=[
 	Gets a shared tuple with a weak table
 
 	@param ... any
-	@return Tuple<T>
+	@return Tuple<T...>
 ]=]
-function TupleLookup:ToTuple(...)
+function TupleLookup.ToTuple<T...>(self: TupleLookup, ...): Tuple.Tuple<T...>
 	local n = select("#", ...)
 	if n == 1 then
 		local arg = ...
@@ -38,9 +47,9 @@ function TupleLookup:ToTuple(...)
 
 	local created = Tuple.new(...)
 
-	for item, _ in pairs(self._tuples) do
-		if item == created then
-			return item
+	for item, _ in self._tuples do
+		if (item :: any) == created then
+			return item :: any
 		end
 	end