@quenty/templateprovider 11.18.0-canary.544.de8fcee.0 → 11.18.1-canary.545.2374fb2.0

package/CHANGELOG.md

@@ -3,7 +3,26 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-# [11.18.0-canary.544.de8fcee.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@11.17.3...@quenty/templateprovider@11.18.0-canary.544.de8fcee.0) (2025-04-01)
+## [11.18.1-canary.545.2374fb2.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@11.18.0...@quenty/templateprovider@11.18.1-canary.545.2374fb2.0) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
+# [11.18.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@11.17.4...@quenty/templateprovider@11.18.0) (2025-04-02)
+
+**Note:** Version bump only for package @quenty/templateprovider
+
+
+
+
+
+## [11.17.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/templateprovider@11.17.3...@quenty/templateprovider@11.17.4) (2025-03-31)
 
 **Note:** Version bump only for package @quenty/templateprovider
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/templateprovider",
-  "version": "11.18.0-canary.544.de8fcee.0",
+  "version": "11.18.1-canary.545.2374fb2.0",
   "description": "Base of a template retrieval system",
   "keywords": [
     "Roblox",
@@ -25,24 +25,24 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "10.8.0",
-    "@quenty/brio": "14.17.0-canary.544.de8fcee.0",
-    "@quenty/collectionserviceutils": "8.17.0-canary.544.de8fcee.0",
-    "@quenty/ducktype": "5.8.1",
-    "@quenty/insertserviceutils": "10.10.1",
-    "@quenty/instanceutils": "13.17.0-canary.544.de8fcee.0",
-    "@quenty/loader": "10.8.0",
-    "@quenty/maid": "3.4.0",
-    "@quenty/observablecollection": "12.20.0-canary.544.de8fcee.0",
-    "@quenty/promise": "10.10.1",
-    "@quenty/promisemaid": "5.10.1",
-    "@quenty/remoting": "12.18.0-canary.544.de8fcee.0",
-    "@quenty/rx": "13.17.0-canary.544.de8fcee.0",
-    "@quenty/string": "3.3.1",
-    "@quenty/table": "3.7.1"
+    "@quenty/baseobject": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/brio": "14.17.1-canary.545.2374fb2.0",
+    "@quenty/collectionserviceutils": "8.17.1-canary.545.2374fb2.0",
+    "@quenty/ducktype": "5.8.2-canary.545.2374fb2.0",
+    "@quenty/insertserviceutils": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/instanceutils": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/loader": "10.8.1-canary.545.2374fb2.0",
+    "@quenty/maid": "3.4.1-canary.545.2374fb2.0",
+    "@quenty/observablecollection": "12.20.1-canary.545.2374fb2.0",
+    "@quenty/promise": "10.10.2-canary.545.2374fb2.0",
+    "@quenty/promisemaid": "5.10.2-canary.545.2374fb2.0",
+    "@quenty/remoting": "12.18.1-canary.545.2374fb2.0",
+    "@quenty/rx": "13.17.1-canary.545.2374fb2.0",
+    "@quenty/string": "3.3.2-canary.545.2374fb2.0",
+    "@quenty/table": "3.7.2-canary.545.2374fb2.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "de8fcee995fcdae464964357b4c770c03f4c7e03"
+  "gitHead": "2374fb2b043cfbe0e9b507b3316eec46a4e353a0"
 }

package/src/Shared/Modules/ModuleProvider.lua

@@ -39,7 +39,7 @@ function ModuleProvider:Init()
 	end
 
 	if self._initModule then
-		for moduleScript, _module in pairs(self._moduleScriptToModule) do
+		for moduleScript, _module in self._moduleScriptToModule do
 			self._initModule(_module, moduleScript)
 		end
 	end
@@ -61,7 +61,7 @@ function ModuleProvider:GetFromName(name)
 end
 
 function ModuleProvider:_processFolder(folder)
-	for _, moduleScript in pairs(folder:GetChildren()) do
+	for _, moduleScript in folder:GetChildren() do
 		if moduleScript:IsA("ModuleScript") then
 			self:_addToRegistery(moduleScript)
 		else

package/src/Shared/TaggedTemplateProvider.lua

@@ -11,7 +11,7 @@ local RxCollectionServiceUtils = require("RxCollectionServiceUtils")
 
 local TaggedTemplateProvider = {}
 
-function TaggedTemplateProvider.new(providerName, tagName)
+function TaggedTemplateProvider.new(providerName: string, tagName: string)
 	assert(type(providerName) == "string", "bad providerName")
 	assert(type(tagName) == "string", "Bad tagName")
 

package/src/Shared/TemplateProvider.lua

@@ -60,6 +60,7 @@ local RxInstanceUtils = require("RxInstanceUtils")
 local String = require("String")
 local TemplateReplicationModes = require("TemplateReplicationModes")
 local TemplateReplicationModesUtils = require("TemplateReplicationModesUtils")
+local _ServiceBag = require("ServiceBag")
 
 local TOMBSTONE_ID_ATTRIBUTE = "UnreplicatedTemplateId"
 local TOMBSTONE_NAME_POSTFIX_UNLOADED = "_Unloaded"
@@ -81,7 +82,7 @@ TemplateProvider.__index = TemplateProvider
 	@param providerName string
 	@param initialTemplates Template
 ]=]
-function TemplateProvider.new(providerName, initialTemplates)
+function TemplateProvider.new(providerName: string, initialTemplates)
 	assert(type(providerName) == "string", "Bad providerName")
 	local self = setmetatable({}, TemplateProvider)
 
@@ -89,7 +90,13 @@ function TemplateProvider.new(providerName, initialTemplates)
 	self._initialTemplates = initialTemplates
 
 	if not (self:_isValidTemplate(self._initialTemplates) or self._initialTemplates == nil) then
-		error(string.format("[TemplateProvider.%s] - Bad initialTemplates of type %s", self.ServiceName, typeof(initialTemplates)))
+		error(
+			string.format(
+				"[TemplateProvider.%s] - Bad initialTemplates of type %s",
+				self.ServiceName,
+				typeof(initialTemplates)
+			)
+		)
 	end
 
 	return self
@@ -102,7 +109,7 @@ end
 	@return boolean
 ]=]
 
-function TemplateProvider.isTemplateProvider(value)
+function TemplateProvider.isTemplateProvider(value: any): boolean
 	return DuckTypeUtils.isImplementation(TemplateProvider, value)
 end
 
@@ -111,7 +118,7 @@ end
 
 	@param serviceBag ServiceBag
 ]=]
-function TemplateProvider:Init(serviceBag)
+function TemplateProvider:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
@@ -179,14 +186,16 @@ function TemplateProvider:_setupTemplateCache()
 		end
 
 		local containerMaid, container = containerBrio:ToMaidAndValue()
-		self:_handleContainer(containerMaid,  container)
+		self:_handleContainer(containerMaid, container)
 	end))
 end
 
-function TemplateProvider:_handleContainer(containerMaid, container)
-	if self._replicationMode == TemplateReplicationModes.SERVER
+function TemplateProvider:_handleContainer(containerMaid: Maid.Maid, container: Instance)
+	if
+		self._replicationMode == TemplateReplicationModes.SERVER
 		and not container:IsA("Camera")
-		and not container:FindFirstAncestorWhichIsA("Camera") then
+		and not container:FindFirstAncestorWhichIsA("Camera")
+	then
 		-- Prevent replication to client immediately
 
 		local camera = containerMaid:Add(Instance.new("Camera"))
@@ -206,7 +215,7 @@ function TemplateProvider:_handleContainer(containerMaid, container)
 
 		containerMaid:GiveTask(container.ChildAdded:Connect(handleChild))
 
-		for _, child in pairs(container:GetChildren()) do
+		for _, child in container:GetChildren() do
 			handleChild(child)
 		end
 
@@ -225,7 +234,7 @@ function TemplateProvider:_handleContainer(containerMaid, container)
 	end))
 end
 
-function TemplateProvider:_replicateTombstones(topMaid, unreplicatedParent, replicatedParent)
+function TemplateProvider:_replicateTombstones(topMaid: Maid.Maid, unreplicatedParent, replicatedParent)
 	assert(self._replicationMode == TemplateReplicationModes.SERVER, "Only should be invoked on server")
 
 	-- Tombstone each child so the client knows what is replicated
@@ -265,25 +274,25 @@ end
 	@param templateName string
 	@return Observable<Instance>
 ]=]
-function TemplateProvider:ObserveTemplate(templateName)
-	assert(type(templateName) == "string", "templateName must be a string")
+function TemplateProvider:ObserveTemplate(templateName: string): Observable.Observable<Instance>
+	assert(type(templateName) == "string", "Bad templateName")
 
 	return self._templateMapList:ObserveList(templateName):Pipe({
 		Rx.switchMap(function(list)
 			if not list then
-				return Rx.of(nil);
+				return Rx.of(nil)
 			end
 
 			return list:ObserveAtIndex(-1)
-		end);
+		end),
 	})
 end
 
-function TemplateProvider:ObserveTemplateNamesBrio()
+function TemplateProvider:ObserveTemplateNamesBrio(): Observable.Observable<Brio.Brio<string>>
 	return self._templateMapList:ObserveKeysBrio()
 end
 
-function TemplateProvider:ObserveUnreplicatedTemplateNamesBrio()
+function TemplateProvider:ObserveUnreplicatedTemplateNamesBrio(): Observable.Observable<Brio.Brio<string>>
 	return self._unreplicatedTemplateMapList:ObserveKeysBrio()
 end
 
@@ -293,8 +302,8 @@ end
 	@param templateName string
 	@return Instance?
 ]=]
-function TemplateProvider:GetTemplate(templateName)
-	assert(type(templateName) == "string", "templateName must be a string")
+function TemplateProvider:GetTemplate(templateName: string): Instance?
+	assert(type(templateName) == "string", "Bad templateName")
 
 	return self._templateMapList:GetItemForKeyAtIndex(templateName, -1)
 end
@@ -305,13 +314,12 @@ end
 	@param templateName string
 	@return Promise<Instance>
 ]=]
-function TemplateProvider:PromiseCloneTemplate(templateName)
-	assert(type(templateName) == "string", "templateName must be a string")
+function TemplateProvider:PromiseCloneTemplate(templateName: string): Promise.Promise<Instance>
+	assert(type(templateName) == "string", "Bad templateName")
 
-	return self:PromiseTemplate(templateName)
-		:Then(function(template)
-			return self:_cloneTemplate(template)
-		end)
+	return self:PromiseTemplate(templateName):Then(function(template)
+		return self:_cloneTemplate(template)
+	end)
 end
 
 --[=[
@@ -320,8 +328,8 @@ end
 	@param templateName string
 	@return Promise<Instance>
 ]=]
-function TemplateProvider:PromiseTemplate(templateName)
-	assert(type(templateName) == "string", "templateName must be a string")
+function TemplateProvider:PromiseTemplate(templateName: string): Promise.Promise<Instance>
+	assert(type(templateName) == "string", "Bad templateName")
 
 	local foundTemplate = self._templateMapList:GetItemForKeyAtIndex(templateName, -1)
 	if foundTemplate then
@@ -346,41 +354,68 @@ function TemplateProvider:PromiseTemplate(templateName)
 			-- There's a chance an external process will stream in our template
 
 			topMaid:GiveTask(task.delay(5, function()
-				warn(string.format("[TemplateProvider.%s.PromiseTemplate] - Missing template %q", self.ServiceName, templateName))
+				warn(
+					string.format(
+						"[TemplateProvider.%s.PromiseTemplate] - Missing template %q",
+						self.ServiceName,
+						templateName
+					)
+				)
 			end))
 		elseif self._replicationMode == TemplateReplicationModes.CLIENT then
 			-- Replicate from the unfound area
-			topMaid:GiveTask(self._unreplicatedTemplateMapList:ObserveAtListIndexBrio(templateName, -1):Subscribe(function(brio)
-				if brio:IsDead() then
-					return
-				end
+			topMaid:GiveTask(
+				self._unreplicatedTemplateMapList:ObserveAtListIndexBrio(templateName, -1):Subscribe(function(brio)
+					if brio:IsDead() then
+						return
+					end
 
-				local maid, templateTombstone = brio:ToMaidAndValue()
+					local maid, templateTombstone = brio:ToMaidAndValue()
 
-				local originalName = templateTombstone.Name
+					local originalName = templateTombstone.Name
 
-				maid:GivePromise(self:_promiseReplicateTemplateFromTombstone(templateTombstone))
-					:Then(function(template)
-						-- Cache the template here which then loads it into the known templates naturally
-						templateTombstone.Name = String.removePostfix(originalName, TOMBSTONE_NAME_POSTFIX_UNLOADED) .. TOMBSTONE_NAME_POSTFIX_LOADED
-						template.Parent = templateTombstone
+					maid:GivePromise(self:_promiseReplicateTemplateFromTombstone(templateTombstone))
+						:Then(function(template)
+							-- Cache the template here which then loads it into the known templates naturally
+							templateTombstone.Name = String.removePostfix(originalName, TOMBSTONE_NAME_POSTFIX_UNLOADED)
+								.. TOMBSTONE_NAME_POSTFIX_LOADED
+							template.Parent = templateTombstone
 
-						promiseTemplate:Resolve(template)
-					end)
-			end))
+							promiseTemplate:Resolve(template)
+						end)
+				end)
+			)
 
 			topMaid:GiveTask(task.delay(5, function()
 				if self._unreplicatedTemplateMapList:GetListForKey(templateName) then
-					warn(string.format("[TemplateProvider.%s.PromiseTemplate] - Failed to replicate template %q from server to client", self.ServiceName, templateName))
+					warn(
+						string.format(
+							"[TemplateProvider.%s.PromiseTemplate] - Failed to replicate template %q from server to client",
+							self.ServiceName,
+							templateName
+						)
+					)
 				else
-					warn(string.format("[TemplateProvider.%s.PromiseTemplate] - Template %q is not a known template", self.ServiceName, templateName))
+					warn(
+						string.format(
+							"[TemplateProvider.%s.PromiseTemplate] - Template %q is not a known template",
+							self.ServiceName,
+							templateName
+						)
+					)
 				end
 			end))
 		elseif self._replicationMode == TemplateReplicationModes.SHARED then
 			-- There's a chance an external process will stream in our template
 
 			topMaid:GiveTask(task.delay(5, function()
-				warn(string.format("[TemplateProvider.%s.PromiseTemplate] - Missing template %q", self.ServiceName, templateName))
+				warn(
+					string.format(
+						"[TemplateProvider.%s.PromiseTemplate] - Missing template %q",
+						self.ServiceName,
+						templateName
+					)
+				)
 			end))
 		else
 			error("Bad replicationMode")
@@ -398,7 +433,7 @@ function TemplateProvider:PromiseTemplate(templateName)
 	return promiseTemplate
 end
 
-function TemplateProvider:_promiseReplicateTemplateFromTombstone(templateTombstone)
+function TemplateProvider:_promiseReplicateTemplateFromTombstone(templateTombstone: Instance): Promise.Promise<Instance>
 	assert(self._replicationMode == TemplateReplicationModes.CLIENT, "Bad replicationMode")
 	assert(typeof(templateTombstone) == "Instance", "Bad templateTombstone")
 
@@ -414,10 +449,12 @@ function TemplateProvider:_promiseReplicateTemplateFromTombstone(templateTombsto
 	local promiseTemplate = Promise.new()
 
 	PromiseMaidUtils.whilePromise(promiseTemplate, function(topMaid)
-		topMaid:GivePromise(self._remoting.ReplicateTemplate:PromiseInvokeServer(tombstoneId))
+		topMaid
+			:GivePromise(self._remoting.ReplicateTemplate:PromiseInvokeServer(tombstoneId))
 			:Then(function(tempTemplate)
 				if not tempTemplate then
-					return Promise.rejected("Failed to get any template")
+					Promise.rejected("Failed to get any template")
+					return
 				end
 
 				-- This tempTemplate will get destroyed by the server soon to free up server memory
@@ -450,20 +487,30 @@ end
 	@param templateName string
 	@return Instance?
 ]=]
-function TemplateProvider:CloneTemplate(templateName)
-	assert(type(templateName) == "string", "templateName must be a string")
+function TemplateProvider:CloneTemplate(templateName: string): Instance?
+	assert(type(templateName) == "string", "Bad templateName")
 
 	local template = self._templateMapList:GetItemForKeyAtIndex(templateName, -1)
 	if not template then
 		local unreplicated = self._unreplicatedTemplateMapList:GetListForKey(templateName)
 
 		if unreplicated then
-			error(string.format("[TemplateProvider.%s.CloneTemplate] - Template %q is not replicated. Use PromiseCloneTemplate instead", self.ServiceName, tostring(templateName)))
+			error(
+				string.format(
+					"[TemplateProvider.%s.CloneTemplate] - Template %q is not replicated. Use PromiseCloneTemplate instead",
+					self.ServiceName,
+					tostring(templateName)
+				)
+			)
 		else
-			error(string.format("[TemplateProvider.%s.CloneTemplate] - Cannot provide template %q", self.ServiceName, tostring(templateName)))
+			error(
+				string.format(
+					"[TemplateProvider.%s.CloneTemplate] - Cannot provide template %q",
+					self.ServiceName,
+					tostring(templateName)
+				)
+			)
 		end
-
-		return nil
 	end
 
 	return self:_cloneTemplate(template)
@@ -481,7 +528,7 @@ end
 	@param container Template
 	@return MaidTask
 ]=]
-function TemplateProvider:AddTemplates(container)
+function TemplateProvider:AddTemplates(container): Maid.Maid
 	assert(self:_isValidTemplate(container), "Bad container")
 
 	if typeof(container) == "Instance" then
@@ -502,14 +549,20 @@ function TemplateProvider:AddTemplates(container)
 	elseif type(container) == "table" then
 		local topMaid = Maid.new()
 
-		for _, value in pairs(container) do
+		for _, value in container do
 			if typeof(value) == "Instance" then
 				-- Always add these as we explicitly ask for this to be a root too.
 				topMaid:GiveTask(self._containerRootCountingMap:Add(value))
 			elseif Observable.isObservable(value) then
 				self:_addObservableTemplates(topMaid, value)
 			else
-				error(string.format("[TemplateProvider.%s] - Bad value of type %q in container table", self.ServiceName, typeof(value)))
+				error(
+					string.format(
+						"[TemplateProvider.%s] - Bad value of type %q in container table",
+						self.ServiceName,
+						typeof(value)
+					)
+				)
 			end
 		end
 
@@ -524,7 +577,7 @@ function TemplateProvider:AddTemplates(container)
 	end
 end
 
-function TemplateProvider:_addObservableTemplates(topMaid, observable)
+function TemplateProvider:_addObservableTemplates(topMaid: Maid.Maid, observable)
 	topMaid:GiveTask(observable:Subscribe(function(result)
 		if Brio.isBrio(result) then
 			if result:IsDead() then
@@ -543,24 +596,27 @@ function TemplateProvider:_addObservableTemplates(topMaid, observable)
 	end))
 end
 
-function TemplateProvider:_addInstanceTemplate(topMaid, template)
+function TemplateProvider:_addInstanceTemplate(topMaid: Maid.Maid, template: Instance)
 	if self:_shouldAddChildrenAsTemplates(template) then
 		topMaid:GiveTask(self._containerRootCountingMap:Add(template))
 	end
 
 	if template:GetAttribute(TOMBSTONE_ID_ATTRIBUTE) then
-		topMaid:GiveTask(self._unreplicatedTemplateMapList:Push(RxInstanceUtils.observeProperty(template, "Name"):Pipe({
-			Rx.map(function(name)
-				if String.endsWith(name, TOMBSTONE_NAME_POSTFIX_UNLOADED) then
-					return String.removePostfix(name, TOMBSTONE_NAME_POSTFIX_UNLOADED)
-				elseif String.endsWith(name, TOMBSTONE_NAME_POSTFIX_LOADED) then
-					return String.removePostfix(name, TOMBSTONE_NAME_POSTFIX_LOADED)
-				else
-					return name
-				end
-			end);
-			Rx.distinct();
-		}), template))
+		topMaid:GiveTask(self._unreplicatedTemplateMapList:Push(
+			RxInstanceUtils.observeProperty(template, "Name"):Pipe({
+				Rx.map(function(name)
+					if String.endsWith(name, TOMBSTONE_NAME_POSTFIX_UNLOADED) then
+						return String.removePostfix(name, TOMBSTONE_NAME_POSTFIX_UNLOADED)
+					elseif String.endsWith(name, TOMBSTONE_NAME_POSTFIX_LOADED) then
+						return String.removePostfix(name, TOMBSTONE_NAME_POSTFIX_LOADED)
+					else
+						return name
+					end
+				end),
+				Rx.distinct(),
+			}),
+			template
+		))
 	else
 		topMaid:GiveTask(self._templateMapList:Push(RxInstanceUtils.observeProperty(template, "Name"), template))
 	end
@@ -572,8 +628,8 @@ end
 	@param templateName string
 	@return boolean
 ]=]
-function TemplateProvider:IsTemplateAvailable(templateName)
-	assert(type(templateName) == "string", "templateName must be a string")
+function TemplateProvider:IsTemplateAvailable(templateName: string)
+	assert(type(templateName) == "string", "Bad templateName")
 
 	return self._templateMapList:GetItemForKeyAtIndex(templateName, -1) ~= nil
 end
@@ -583,7 +639,7 @@ end
 
 	@return { Instance }
 ]=]
-function TemplateProvider:GetTemplateList()
+function TemplateProvider:GetTemplateList(): { Instance }
 	return self._templateMapList:GetListOfValuesAtListIndex(-1)
 end
 
@@ -592,7 +648,7 @@ end
 
 	@return { Instance }
 ]=]
-function TemplateProvider:GetContainerList()
+function TemplateProvider:GetContainerList(): { Instance }
 	return self._containerRootCountingMap:GetList()
 end
 
@@ -604,17 +660,17 @@ TemplateProvider.PromiseClone = assert(TemplateProvider.PromiseCloneTemplate, "M
 TemplateProvider.GetAllTemplates = assert(TemplateProvider.GetTemplateList, "Missing method")
 TemplateProvider.GetAll = assert(TemplateProvider.GetTemplateList, "Missing method")
 
-function TemplateProvider:_cloneTemplate(template)
+function TemplateProvider:_cloneTemplate(template: Instance): Instance
 	local newItem = template:Clone()
 	newItem.Name = String.removePostfix(template.Name, "Template")
 	return newItem
 end
 
-function TemplateProvider:_shouldAddChildrenAsTemplates(container)
+function TemplateProvider:_shouldAddChildrenAsTemplates(container: Instance): boolean
 	return container:IsA("Folder")
 end
 
-function TemplateProvider:_isValidTemplate(container)
+function TemplateProvider:_isValidTemplate(container): boolean
 	return typeof(container) == "Instance"
 		or Observable.isObservable(container)
 		or type(container) == "table"