@quenty/rogue-properties 11.21.3 → 11.21.4

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.
 
+## [11.21.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rogue-properties@11.21.3...@quenty/rogue-properties@11.21.4) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/rogue-properties
+
+
+
+
+
 ## [11.21.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/rogue-properties@11.21.2...@quenty/rogue-properties@11.21.3) (2025-03-13)
 
 **Note:** Version bump only for package @quenty/rogue-properties

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/rogue-properties",
-  "version": "11.21.3",
+  "version": "11.21.4",
   "description": "Roguelike properties which can be modified by external provides",
   "keywords": [
     "Roblox",
@@ -24,33 +24,33 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/adorneedata": "^7.17.0",
+    "@quenty/adorneedata": "^7.17.1",
     "@quenty/baseobject": "^10.8.0",
-    "@quenty/binder": "^14.18.0",
-    "@quenty/brio": "^14.16.0",
+    "@quenty/binder": "^14.18.1",
+    "@quenty/brio": "^14.16.1",
     "@quenty/defaultvalueutils": "^1.2.0",
-    "@quenty/ducktype": "^5.8.0",
-    "@quenty/instanceutils": "^13.16.0",
-    "@quenty/jsonutils": "^10.10.0",
-    "@quenty/linkutils": "^13.16.0",
+    "@quenty/ducktype": "^5.8.1",
+    "@quenty/instanceutils": "^13.16.1",
+    "@quenty/jsonutils": "^10.10.1",
+    "@quenty/linkutils": "^13.16.1",
     "@quenty/loader": "^10.8.0",
     "@quenty/maid": "^3.4.0",
-    "@quenty/observablecollection": "^12.19.2",
-    "@quenty/rx": "^13.16.0",
-    "@quenty/rxbinderutils": "^14.18.0",
-    "@quenty/rxsignal": "^7.16.0",
-    "@quenty/servicebag": "^11.11.0",
+    "@quenty/observablecollection": "^12.19.3",
+    "@quenty/rx": "^13.16.1",
+    "@quenty/rxbinderutils": "^14.18.1",
+    "@quenty/rxsignal": "^7.16.1",
+    "@quenty/servicebag": "^11.11.1",
     "@quenty/signal": "^7.10.0",
-    "@quenty/spring": "^10.8.0",
-    "@quenty/string": "^3.3.0",
-    "@quenty/table": "^3.7.0",
-    "@quenty/tie": "^10.19.0",
-    "@quenty/valuebaseutils": "^13.16.0",
-    "@quenty/valueobject": "^13.16.0",
+    "@quenty/spring": "^10.8.1",
+    "@quenty/string": "^3.3.1",
+    "@quenty/table": "^3.7.1",
+    "@quenty/tie": "^10.19.1",
+    "@quenty/valuebaseutils": "^13.16.1",
+    "@quenty/valueobject": "^13.16.1",
     "@quentystudios/t": "^3.0.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "454a991b6f45e1db7b8030e216a1a8d6efc34083"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/Cache/RoguePropertyCache.lua

@@ -1,4 +1,6 @@
 --[=[
+	Utility class that helps cache rogue properties per an instance
+
 	@class RoguePropertyCache
 ]=]
 
@@ -11,21 +13,33 @@ RoguePropertyCache.__index = RoguePropertyCache
 function RoguePropertyCache.new()
 	local self = setmetatable({}, RoguePropertyCache)
 
-	self._cache = setmetatable({}, {__mode="v"})
+	self._cache = setmetatable({}, { __mode = "v" })
 
 	return self
 end
 
-function RoguePropertyCache:Store(adornee, roguePropertyTable)
+--[=[
+	Caches the implementation for a given instance
+
+	@param adornee Instance
+	@param roguePropertyTable RoguePropertyTable
+]=]
+function RoguePropertyCache:Store(adornee: Instance, roguePropertyTable)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	self._cache[adornee] = roguePropertyTable
 end
 
-function RoguePropertyCache:Find(adornee)
+--[=[
+	Retrieves the cached item
+
+	@param adornee Instance
+	@return RoguePropertyTable
+]=]
+function RoguePropertyCache:Find(adornee: Instance)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 
 	return self._cache[adornee]
 end
 
-return RoguePropertyCache
+return RoguePropertyCache

package/src/Shared/Definition/RoguePropertyTableDefinition.lua

@@ -35,7 +35,7 @@ function RoguePropertyTableDefinition.new(tableName, defaultValueTable)
 	return self
 end
 
-function RoguePropertyTableDefinition.isRoguePropertyTableDefinition(value)
+function RoguePropertyTableDefinition.isRoguePropertyTableDefinition(value): boolean
 	return DuckTypeUtils.isImplementation(RoguePropertyTableDefinition, value)
 end
 
@@ -72,22 +72,34 @@ function RoguePropertyTableDefinition:SetDefaultValue(defaultValueTable)
 
 	if next(defaultArrayData) ~= nil then
 		-- Enforce array data types for sanity
-		local requiredPropertyDefinitionTemplate, message = RoguePropertyArrayUtils.createRequiredPropertyDefinitionFromArray(defaultArrayData, self)
+		local requiredPropertyDefinitionTemplate, message =
+			RoguePropertyArrayUtils.createRequiredPropertyDefinitionFromArray(defaultArrayData, self)
 
 		if requiredPropertyDefinitionTemplate then
-			self._arrayDefinitionHelper = RoguePropertyDefinitionArrayHelper.new(self, defaultArrayData, requiredPropertyDefinitionTemplate)
+			self._arrayDefinitionHelper =
+				RoguePropertyDefinitionArrayHelper.new(self, defaultArrayData, requiredPropertyDefinitionTemplate)
 		else
-			error(string.format("[RoguePropertyTableDefinition] - Could not create infer array type definition. Error: %s", message))
+			error(
+				string.format(
+					"[RoguePropertyTableDefinition] - Could not create infer array type definition. Error: %s",
+					message
+				)
+			)
 		end
 	end
 end
 
-
-function RoguePropertyTableDefinition:CanAssign(mainValue, strict)
+function RoguePropertyTableDefinition:CanAssign(mainValue, strict: boolean): boolean
 	assert(type(strict) == "boolean", "Bad strict")
 
 	if type(mainValue) ~= "table" then
-		return false, string.format("got %q, expected %q when assigning to %q", self._valueType, typeof(mainValue), self:GetFullName())
+		return false,
+			string.format(
+				"got %q, expected %q when assigning to %q",
+				self._valueType,
+				typeof(mainValue),
+				self:GetFullName()
+			)
 	end
 
 	local remainingKeys
@@ -107,7 +119,13 @@ function RoguePropertyTableDefinition:CanAssign(mainValue, strict)
 					if message then
 						return false, message
 					else
-						return false, string.format("Bad index %q of %q due to %s", tostring(key), self:GetFullName(), tostring(message))
+						return false,
+							string.format(
+								"Bad index %q of %q due to %s",
+								tostring(key),
+								self:GetFullName(),
+								tostring(message)
+							)
 					end
 				end
 			else
@@ -120,7 +138,13 @@ function RoguePropertyTableDefinition:CanAssign(mainValue, strict)
 					if message then
 						return false, message
 					else
-						return false, string.format("Bad index %q of %q due to %s", tostring(key), self:GetFullName(), tostring(message))
+						return false,
+							string.format(
+								"Bad index %q of %q due to %s",
+								tostring(key),
+								self:GetFullName(),
+								tostring(message)
+							)
 					end
 				end
 			else
@@ -131,7 +155,13 @@ function RoguePropertyTableDefinition:CanAssign(mainValue, strict)
 
 	-- We missed some keys
 	if next(remainingKeys) ~= nil then
-		return false, string.format("Had %d unassigned keys %q while assigning to %q", #remainingKeys, table.concat(remainingKeys, ", "), self:GetFullName())
+		return false,
+			string.format(
+				"Had %d unassigned keys %q while assigning to %q",
+				#remainingKeys,
+				table.concat(remainingKeys, ", "),
+				self:GetFullName()
+			)
 	end
 
 	return true
@@ -196,7 +226,7 @@ RoguePropertyTableDefinition.GetPropertyTable = RoguePropertyTableDefinition.Get
 	@param canInitialize boolean
 	@return Observable<Brio<Folder>>
 ]=]
-function RoguePropertyTableDefinition:ObserveContainerBrio(adornee, canInitialize)
+function RoguePropertyTableDefinition:ObserveContainerBrio(adornee: Instance, canInitialize)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 	assert(type(canInitialize) == "boolean", "Bad canInitialize")
 
@@ -205,12 +235,11 @@ function RoguePropertyTableDefinition:ObserveContainerBrio(adornee, canInitializ
 
 	local parentDefinition = self:GetParentPropertyDefinition()
 	if parentDefinition then
-		return parentDefinition:ObserveContainerBrio(adornee, canInitialize)
-			:Pipe({
-				RxBrioUtils.switchMapBrio(function(parent)
-					return RxInstanceUtils.observeLastNamedChildBrio(parent, "Folder", self:GetName())
-				end)
-			})
+		return parentDefinition:ObserveContainerBrio(adornee, canInitialize):Pipe({
+			RxBrioUtils.switchMapBrio(function(parent)
+				return RxInstanceUtils.observeLastNamedChildBrio(parent, "Folder", self:GetName())
+			end),
+		})
 	else
 		return RxInstanceUtils.observeLastNamedChildBrio(adornee, "Folder", self:GetName())
 	end
@@ -222,7 +251,7 @@ end
 	@param canInitialize boolean
 	@return Folder?
 ]=]
-function RoguePropertyTableDefinition:GetContainer(adornee, canInitialize)
+function RoguePropertyTableDefinition:GetContainer(adornee: Instance, canInitialize): Folder?
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 	assert(type(canInitialize) == "boolean", "Bad canInitialize")
 
@@ -292,4 +321,4 @@ function RoguePropertyTableDefinition:__index(index)
 	end
 end
 
-return RoguePropertyTableDefinition
+return RoguePropertyTableDefinition