@quenty/tie 10.19.0 → 10.19.1

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.
 
+## [10.19.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/tie@10.19.0...@quenty/tie@10.19.1) (2025-03-21)
+
+**Note:** Version bump only for package @quenty/tie
+
+
+
+
+
 # [10.19.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/tie@10.18.1...@quenty/tie@10.19.0) (2025-02-18)
 
 **Note:** Version bump only for package @quenty/tie

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/tie",
-  "version": "10.19.0",
+  "version": "10.19.1",
   "description": "Tie allows interfaces to be defined between Lua OOP and Roblox objects.",
   "keywords": [
     "Roblox",
@@ -28,29 +28,29 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/attributeutils": "^14.16.0",
+    "@quenty/attributeutils": "^14.16.1",
     "@quenty/baseobject": "^10.8.0",
-    "@quenty/brio": "^14.16.0",
-    "@quenty/collectionserviceutils": "^8.16.0",
-    "@quenty/instanceutils": "^13.16.0",
+    "@quenty/brio": "^14.16.1",
+    "@quenty/collectionserviceutils": "^8.16.1",
+    "@quenty/instanceutils": "^13.16.1",
     "@quenty/loader": "^10.8.0",
     "@quenty/maid": "^3.4.0",
-    "@quenty/rx": "^13.16.0",
-    "@quenty/rxsignal": "^7.16.0",
-    "@quenty/statestack": "^14.17.0",
-    "@quenty/string": "^3.3.0",
+    "@quenty/rx": "^13.16.1",
+    "@quenty/rxsignal": "^7.16.1",
+    "@quenty/statestack": "^14.17.1",
+    "@quenty/string": "^3.3.1",
     "@quenty/symbol": "^3.4.0",
-    "@quenty/table": "^3.7.0",
+    "@quenty/table": "^3.7.1",
     "@quenty/tuple": "^1.5.0",
-    "@quenty/valuebaseutils": "^13.16.0",
-    "@quenty/valueobject": "^13.16.0"
+    "@quenty/valuebaseutils": "^13.16.1",
+    "@quenty/valueobject": "^13.16.1"
   },
   "devDependencies": {
-    "@quenty/promise": "^10.10.0",
+    "@quenty/promise": "^10.10.1",
     "@quenty/signal": "^7.10.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "184a407d8d7366c39009444c3c9a7023cb176471"
+  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
 }

package/src/Shared/TieDefinition.lua

@@ -71,9 +71,9 @@ TieDefinition.ClassName = "TieDefinition"
 TieDefinition.__index = TieDefinition
 
 TieDefinition.Types = Table.readonly({
-	METHOD = Symbol.named("method");
-	SIGNAL = Symbol.named("signal");
-	PROPERTY = Symbol.named("property"); -- will default to nil
+	METHOD = Symbol.named("method"),
+	SIGNAL = Symbol.named("signal"),
+	PROPERTY = Symbol.named("property"), -- will default to nil
 })
 
 TieDefinition.Realms = TieRealms
@@ -89,7 +89,7 @@ function TieDefinition.new(definitionName, members)
 	local self = setmetatable({}, TieDefinition)
 
 	self._definitionName = assert(definitionName, "No definitionName")
-	self._validContainerNameSetWeakCache = setmetatable({}, {__mode = "kv"})
+	self._validContainerNameSetWeakCache = setmetatable({}, { __mode = "kv" })
 	self._memberMap = {}
 	self._defaultTieRealm = TieRealms.SHARED
 
@@ -97,15 +97,15 @@ function TieDefinition.new(definitionName, members)
 	self:_addMembers(members, TieRealms.SHARED)
 
 	self.Server = setmetatable({
-		_defaultTieRealm = TieRealms.SERVER
+		_defaultTieRealm = TieRealms.SERVER,
 	}, {
-		__index = self;
+		__index = self,
 	})
 
 	self.Client = setmetatable({
-		_defaultTieRealm = TieRealms.CLIENT
+		_defaultTieRealm = TieRealms.CLIENT,
 	}, {
-		__index = self;
+		__index = self,
 	})
 
 	return self
@@ -114,12 +114,16 @@ end
 function TieDefinition:_addMembers(members, realm)
 	for memberName, memberTypeOrDefaultValue in pairs(members) do
 		if TieRealmUtils.isTieRealm(memberName) then
-
 			self:_addMembers(memberTypeOrDefaultValue, memberName)
 		elseif type(memberName) == "string" then
 			self:_addMember(memberName, memberTypeOrDefaultValue, realm)
 		else
-			error(string.format("[TieDefinition] - Bad memberName %q, expected either string or TieRealm.", tostring(memberName)))
+			error(
+				string.format(
+					"[TieDefinition] - Bad memberName %q, expected either string or TieRealm.",
+					tostring(memberName)
+				)
+			)
 		end
 	end
 end
@@ -168,20 +172,19 @@ function TieDefinition:GetNewImplClass(tieRealm)
 end
 
 local IMPL_CLIENT_SET = table.freeze({
-	["Configuration"] = true;
+	["Configuration"] = true,
 })
 
 local IMPL_SERVER_SET = table.freeze({
-	["Camera"] = true;
+	["Camera"] = true,
 })
 
 local IMPL_SHARED_SET = table.freeze({
-	["Camera"] = true;
-	["Configuration"] = true;
+	["Camera"] = true,
+	["Configuration"] = true,
 })
 
 function TieDefinition:GetImplClassSet(tieRealm)
-
 	if tieRealm == TieRealms.CLIENT then
 		-- Shared implements both...
 		return IMPL_CLIENT_SET
@@ -229,7 +232,7 @@ function TieDefinition:ObserveChildrenBrio(adornee: Instance, tieRealm)
 	return RxInstanceUtils.observeChildrenBrio(adornee):Pipe({
 		RxBrioUtils.flatMapBrio(function(child)
 			return self:ObserveBrio(child, tieRealm)
-		end)
+		end),
 	})
 end
 
@@ -240,7 +243,7 @@ end
 	@param tieRealm TieRealm?
 	@return Promise<TieInterface>
 ]=]
-function TieDefinition:Promise(adornee, tieRealm)
+function TieDefinition:Promise(adornee: Instance, tieRealm)
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 	assert(TieRealmUtils.isTieRealm(tieRealm) or tieRealm == nil, "Bad tieRealm")
 
@@ -249,7 +252,7 @@ function TieDefinition:Promise(adornee, tieRealm)
 	return Rx.toPromise(self:Observe(adornee, tieRealm):Pipe({
 		Rx.where(function(value)
 			return value ~= nil
-		end)
+		end),
 	}))
 end
 
@@ -304,7 +307,7 @@ function TieDefinition:ObserveAllTaggedBrio(tagName, tieRealm)
 	return RxCollectionServiceUtils.observeTaggedBrio(tagName):Pipe({
 		RxBrioUtils.flatMapBrio(function(instance)
 			return self:ObserveBrio(instance, tieRealm)
-		end)
+		end),
 	})
 end
 
@@ -369,15 +372,14 @@ function TieDefinition:ObserveIsImplemented(adornee: Instance, tieRealm): boolea
 	assert(typeof(adornee) == "Instance", "Bad adornee")
 	assert(TieRealmUtils.isTieRealm(tieRealm) or tieRealm == nil, "Bad tieRealm")
 
-	return self:ObserveLastImplementationBrio(adornee, tieRealm)
-		:Pipe({
-			RxBrioUtils.map(function(result)
-				return result and true or false
-			end);
-			RxBrioUtils.emitOnDeath(false);
-			Rx.defaultsTo(false);
-			Rx.distinct();
-		})
+	return self:ObserveLastImplementationBrio(adornee, tieRealm):Pipe({
+		RxBrioUtils.map(function(result)
+			return result and true or false
+		end),
+		RxBrioUtils.emitOnDeath(false),
+		Rx.defaultsTo(false),
+		Rx.distinct(),
+	})
 end
 
 --[=[
@@ -392,15 +394,14 @@ function TieDefinition:ObserveIsImplementation(implParent: Instance, tieRealm)
 
 	tieRealm = tieRealm or self._defaultTieRealm
 
-	return self:_observeImplementation(implParent, tieRealm)
-		:Pipe({
-			RxBrioUtils.map(function(result)
-				return result and true or false
-			end);
-			RxBrioUtils.emitOnDeath(false);
-			Rx.defaultsTo(false);
-			Rx.distinct();
-		})
+	return self:_observeImplementation(implParent, tieRealm):Pipe({
+		RxBrioUtils.map(function(result)
+			return result and true or false
+		end),
+		RxBrioUtils.emitOnDeath(false),
+		Rx.defaultsTo(false),
+		Rx.distinct(),
+	})
 end
 
 --[=[
@@ -422,13 +423,13 @@ function TieDefinition:ObserveIsImplementedOn(implParent: Instance, adornee: Ins
 	end):Pipe({
 		RxBrioUtils.switchMapBrio(function()
 			return self:_observeImplementation(implParent, tieRealm)
-		end);
+		end),
 		RxBrioUtils.map(function(result)
 			return result and true or false
-		end);
-		RxBrioUtils.emitOnDeath(false);
-		Rx.defaultsTo(false);
-		Rx.distinct();
+		end),
+		RxBrioUtils.emitOnDeath(false),
+		Rx.defaultsTo(false),
+		Rx.distinct(),
 	})
 end
 
@@ -445,13 +446,12 @@ function TieDefinition:ObserveBrio(adornee: Instance, tieRealm)
 
 	tieRealm = tieRealm or self._defaultTieRealm
 
-	return self:ObserveValidContainerChildrenBrio(adornee, tieRealm)
-		:Pipe({
-			RxBrioUtils.switchMapBrio(function(implParent)
-				return self:_observeImplementation(implParent, tieRealm)
-			end);
-			RxBrioUtils.onlyLastBrioSurvives();
-		})
+	return self:ObserveValidContainerChildrenBrio(adornee, tieRealm):Pipe({
+		RxBrioUtils.switchMapBrio(function(implParent)
+			return self:_observeImplementation(implParent, tieRealm)
+		end),
+		RxBrioUtils.onlyLastBrioSurvives(),
+	})
 end
 
 --[=[
@@ -466,7 +466,7 @@ function TieDefinition:Observe(adornee: Instance, tieRealm)
 	assert(TieRealmUtils.isTieRealm(tieRealm) or tieRealm == nil, "Bad tieRealm")
 
 	return self:ObserveBrio(adornee, tieRealm):Pipe({
-		RxStateStackUtils.topOfStack();
+		RxStateStackUtils.topOfStack(),
 	})
 end
 
@@ -485,12 +485,11 @@ function TieDefinition:ObserveImplementationsBrio(adornee: Instance, tieRealm)
 
 	tieRealm = tieRealm or self._defaultTieRealm
 
-	return self:ObserveValidContainerChildrenBrio(adornee, tieRealm)
-		:Pipe({
-			RxBrioUtils.flatMapBrio(function(implParent)
-				return self:_observeImplementation(implParent, tieRealm)
-			end)
-		})
+	return self:ObserveValidContainerChildrenBrio(adornee, tieRealm):Pipe({
+		RxBrioUtils.flatMapBrio(function(implParent)
+			return self:_observeImplementation(implParent, tieRealm)
+		end),
+	})
 end
 
 function TieDefinition:ObserveValidContainerChildrenBrio(adornee, tieRealm)
@@ -639,23 +638,23 @@ function TieDefinition:GetValidContainerNameSet(tieRealm)
 	if tieRealm == TieRealms.CLIENT then
 		-- Shared implements both...
 		self._validContainerNameSetWeakCache[tieRealm] = table.freeze({
-			[self._definitionName .. "Client"] = true;
-			[self._definitionName .. "Shared"] = true;
+			[self._definitionName .. "Client"] = true,
+			[self._definitionName .. "Shared"] = true,
 		})
 		return self._validContainerNameSetWeakCache[tieRealm]
 	elseif tieRealm == TieRealms.SERVER then
 		self._validContainerNameSetWeakCache[tieRealm] = table.freeze({
-			[self._definitionName] = true;
-			[self._definitionName .. "Shared"] = true;
+			[self._definitionName] = true,
+			[self._definitionName .. "Shared"] = true,
 		})
 		return self._validContainerNameSetWeakCache[tieRealm]
 	elseif tieRealm == TieRealms.SHARED then
 		-- Technically on the implementation shared is very strict,
 		-- but we allow any calls here for discovery
 		self._validContainerNameSetWeakCache[tieRealm] = table.freeze({
-			[self._definitionName] = true;
-			[self._definitionName .. "Client"] = true;
-			[self._definitionName .. "Shared"] = true;
+			[self._definitionName] = true,
+			[self._definitionName .. "Client"] = true,
+			[self._definitionName .. "Shared"] = true,
 		})
 		return self._validContainerNameSetWeakCache[tieRealm]
 	else
@@ -748,4 +747,4 @@ function TieDefinition:IsImplementation(implParent, tieRealm)
 	return true
 end
 
-return TieDefinition
+return TieDefinition

package/src/Shared/TieImplementation.lua

@@ -17,7 +17,15 @@ local TieImplementation = setmetatable({}, BaseObject)
 TieImplementation.ClassName = "TieImplementation"
 TieImplementation.__index = TieImplementation
 
-function TieImplementation.new(tieDefinition, adornee, implementer, implementationTieRealm)
+--[=[
+	Constructs a new implementation. Use [TieDefinition.Implement] instead of using this directly.
+
+	@param tieDefinition TieDefinition
+	@param adornee Instance
+	@param implementer table
+	@param implementationTieRealm TieRealm
+]=]
+function TieImplementation.new(tieDefinition, adornee: Instance, implementer, implementationTieRealm)
 	assert(TieRealmUtils.isTieRealm(implementationTieRealm), "Bad implementationTieRealm")
 
 	local self = setmetatable(BaseObject.new(), TieImplementation)
@@ -53,14 +61,15 @@ function TieImplementation:__index(index)
 		return TieImplementation[index]
 	end
 
-	if index == "_implParent"
+	if
+		index == "_implParent"
 		or index == "_adornee"
 		or index == "_tieDefinition"
 		or index == "_memberImplementations"
 		or index == "_implementationTieRealm"
 		or index == "_memberMap"
-		or index == "_actualSelf" then
-
+		or index == "_actualSelf"
+	then
 		return rawget(self, index)
 	end
 
@@ -72,7 +81,13 @@ function TieImplementation:__index(index)
 		if memberDefinition:IsAllowedForImplementation(self._implementationTieRealm) then
 			return memberDefinition:GetInterface(self._implParent, self, implementationTieRealm)
 		else
-			error(string.format("[TieImplementation] - %q is not available on %s", memberDefinition:GetFriendlyName(), self._implementationTieRealm))
+			error(
+				string.format(
+					"[TieImplementation] - %q is not available on %s",
+					memberDefinition:GetFriendlyName(),
+					self._implementationTieRealm
+				)
+			)
 		end
 	else
 		error(string.format("Bad index %q for TieImplementation", tostring(index)))
@@ -80,14 +95,15 @@ function TieImplementation:__index(index)
 end
 
 function TieImplementation:__newindex(index, value)
-	if index == "_implParent"
+	if
+		index == "_implParent"
 		or index == "_adornee"
 		or index == "_tieDefinition"
 		or index == "_memberImplementations"
 		or index == "_implementationTieRealm"
 		or index == "_memberMap"
-		or index == "_actualSelf" then
-
+		or index == "_actualSelf"
+	then
 		rawset(self, index, value)
 	elseif self._memberImplementations[index] then
 		self._memberImplementations[index]:SetImplementation(value, self._actualSelf)
@@ -119,7 +135,9 @@ function TieImplementation:_buildMemberImplementations(implementer)
 			end
 		end
 
-		local memberImplementation = self._maid:Add(memberDefinition:Implement(self._implParent, found, self._actualSelf, self._implementationTieRealm))
+		local memberImplementation = self._maid:Add(
+			memberDefinition:Implement(self._implParent, found, self._actualSelf, self._implementationTieRealm)
+		)
 		self._memberImplementations[memberDefinition:GetMemberName()] = memberImplementation
 	end
 
@@ -127,18 +145,22 @@ function TieImplementation:_buildMemberImplementations(implementer)
 end
 
 function TieImplementation:_getErrorMessageForNotAllowedMember(memberDefinition)
-	local errorMessage = string.format("[TieImplementation] - Member implements %s only member %s (we are a %s implementation)",
+	local errorMessage = string.format(
+		"[TieImplementation] - Member implements %s only member %s (we are a %s implementation)",
 		memberDefinition:GetMemberTieRealm(),
 		memberDefinition:GetFriendlyName(),
-		self._implementationTieRealm)
+		self._implementationTieRealm
+	)
 
 	if self._implementationTieRealm == TieRealms.SHARED then
 		if memberDefinition:GetMemberTieRealm() ~= TieRealms.SHARED then
-			errorMessage = string.format("%s\n\tHINT: This is declared as a %s implementation. %s is only allowed on %s.",
+			errorMessage = string.format(
+				"%s\n\tHINT: This is declared as a %s implementation. %s is only allowed on %s.",
 				errorMessage,
 				self._implementationTieRealm,
 				memberDefinition:GetFriendlyName(),
-				memberDefinition:GetMemberTieRealm())
+				memberDefinition:GetMemberTieRealm()
+			)
 		end
 	end
 
@@ -146,22 +168,26 @@ function TieImplementation:_getErrorMessageForNotAllowedMember(memberDefinition)
 end
 
 function TieImplementation:_getErrorMessageRequiredMember(memberDefinition)
-	local errorMessage = string.format("[TieImplementation] - Missing %s member %s (we are a %s implementation)",
+	local errorMessage = string.format(
+		"[TieImplementation] - Missing %s member %s (we are a %s implementation)",
 		memberDefinition:GetMemberTieRealm(),
 		memberDefinition:GetFriendlyName(),
-		self._implementationTieRealm)
+		self._implementationTieRealm
+	)
 
 	if self._implementationTieRealm == TieRealms.SHARED then
 		if memberDefinition:GetMemberTieRealm() ~= TieRealms.SHARED then
-			errorMessage = string.format("%s\n\tHINT: This is declared as a %s implementation. Shared implements require both client and server components. You could also specify the implementation realm by writing %sInterface.%s:Implement(...)",
+			errorMessage = string.format(
+				"%s\n\tHINT: This is declared as a %s implementation. Shared implements require both client and server components. You could also specify the implementation realm by writing %sInterface.%s:Implement(...)",
 				errorMessage,
 				self._implementationTieRealm,
 				self._tieDefinition:GetName(),
-				String.uppercaseFirstLetter(memberDefinition:GetMemberTieRealm()))
+				String.uppercaseFirstLetter(memberDefinition:GetMemberTieRealm())
+			)
 		end
 	end
 
 	return errorMessage
 end
 
-return TieImplementation
+return TieImplementation

package/test/modules/Server/Action/Action.lua

@@ -1,6 +1,6 @@
---[=[
+--[[
 	@class Action
-]=]
+]]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -32,4 +32,4 @@ function Action:Activate()
 	self.Activated:Fire()
 end
 
-return Action
+return Action

package/test/modules/Server/Action/ActionInterface.lua

@@ -1,14 +1,14 @@
---[=[
+--[[
 	@class ActionInterface
-]=]
+]]
 
 local require = require(script.Parent.loader).load(script)
 
 local TieDefinition = require("TieDefinition")
 
 return TieDefinition.new("Action", {
-	DisplayName = "???";
-	IsEnabled = false;
-	Activated = TieDefinition.Types.SIGNAL;
-	Activate = TieDefinition.Types.METHOD;
-})
+	DisplayName = "???",
+	IsEnabled = false,
+	Activated = TieDefinition.Types.SIGNAL,
+	Activate = TieDefinition.Types.METHOD,
+})

package/test/modules/Server/Door.lua

@@ -1,6 +1,6 @@
---[=[
+--[[
 	@class Door
-]=]
+]]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -56,4 +56,4 @@ function Door:PromiseClose()
 	return promise
 end
 
-return Door
+return Door

package/test/modules/Server/OpenableInterface.lua

@@ -1,16 +1,16 @@
---[=[
+--[[
 	@class OpenableInterface
-]=]
+]]
 
 local require = require(script.Parent.loader).load(script)
 
 local TieDefinition = require("TieDefinition")
 
 return TieDefinition.new("Openable", {
-	Opening = TieDefinition.Types.SIGNAL;
-	Closing = TieDefinition.Types.SIGNAL;
-	IsOpen = TieDefinition.Types.PROPERTY;
-	LastPromise = TieDefinition.Types.PROPERTY;
-	PromiseOpen = TieDefinition.Types.METHOD;
-	PromiseClose = TieDefinition.Types.METHOD;
+	Opening = TieDefinition.Types.SIGNAL,
+	Closing = TieDefinition.Types.SIGNAL,
+	IsOpen = TieDefinition.Types.PROPERTY,
+	LastPromise = TieDefinition.Types.PROPERTY,
+	PromiseOpen = TieDefinition.Types.METHOD,
+	PromiseClose = TieDefinition.Types.METHOD,
 })

package/test/modules/Server/Window.lua

@@ -1,6 +1,6 @@
---[=[
+--[[
 	@class Window
-]=]
+]]
 
 local require = require(script.Parent.loader).load(script)
 
@@ -56,4 +56,4 @@ function Window:PromiseClose()
 	return promise
 end
 
-return Window
+return Window