@quenty/loader 10.8.0 → 10.8.1

package/src/LoaderLink/LoaderLinkCreator.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Adds the loader instance so script.Parent.loader works.
 
@@ -13,7 +14,24 @@ local LoaderLinkCreator = {}
 LoaderLinkCreator.ClassName = "LoaderLinkCreator"
 LoaderLinkCreator.__index = LoaderLinkCreator
 
-function LoaderLinkCreator.new(root, references, isRoot)
+export type LoaderLinkCreator = typeof(setmetatable(
+	{} :: {
+		_maid: Maid.Maid,
+		_root: Instance,
+		_references: ReplicatorReferences.ReplicatorReferences?,
+		_hasLoaderCount: IntValue,
+		_childRequiresLoaderCount: IntValue,
+		_provideLoader: BoolValue,
+		_lastProvidedLoader: Instance?,
+	},
+	LoaderLinkCreator
+))
+
+function LoaderLinkCreator.new(
+	root: Instance,
+	references: ReplicatorReferences.ReplicatorReferences?,
+	isRoot: boolean?
+): LoaderLinkCreator
 	assert(typeof(root) == "Instance", "Bad root")
 	assert(ReplicatorReferences.isReplicatorReferences(references) or references == nil, "Bad references")
 
@@ -36,10 +54,10 @@ function LoaderLinkCreator.new(root, references, isRoot)
 	self:_setupEventTracking()
 	self:_setupRendering()
 
-	return self
+	return self :: LoaderLinkCreator
 end
 
-function LoaderLinkCreator:_setupEventTracking()
+function LoaderLinkCreator._setupEventTracking(self: LoaderLinkCreator)
 	self._maid:GiveTask(self._root.ChildAdded:Connect(function(child)
 		self:_handleChildAdded(child)
 	end))
@@ -47,21 +65,21 @@ function LoaderLinkCreator:_setupEventTracking()
 		self:_handleChildRemoved(child)
 	end))
 
-	for _, child in pairs(self._root:GetChildren()) do
+	for _, child in self._root:GetChildren() do
 		self:_handleChildAdded(child)
 	end
 
 	-- Need to do this AFTER child added loop
 	if self._references then
-		self._maid:GiveTask(self._references:ObserveReferenceChanged(loader, function(replicatedLoader)
+		self._maid:GiveTask(self._references:ObserveReferenceChanged(loader, function(replicatedLoader: Instance?)
 			if replicatedLoader and replicatedLoader ~= loader then
-				self._maid._trackFakeLoader = self:_countLoaderReferences(replicatedLoader)
+				self._maid._trackFakeLoader = (self :: any):_countLoaderReferences(replicatedLoader)
 			else
 				self._maid._trackFakeLoader = nil
 			end
 		end))
 	else
-		self._maid:GiveTask(self:_countLoaderReferences(loader))
+		self._maid:GiveTask((self :: any):_countLoaderReferences(loader))
 	end
 
 	-- Update state
@@ -74,11 +92,11 @@ function LoaderLinkCreator:_setupEventTracking()
 	self:_updateProviderLoader()
 end
 
-function LoaderLinkCreator:_setupRendering()
+function LoaderLinkCreator._setupRendering(self: LoaderLinkCreator)
 	if self._references then
 		local function renderLoader()
 			if self._provideLoader.Value then
-				self._maid._loader = self:_renderLoaderWithReferences()
+				self._maid._loader = self:_renderLoaderWithReferences(self._references)
 			else
 				self._maid._loader = nil
 			end
@@ -101,15 +119,15 @@ function LoaderLinkCreator:_setupRendering()
 	end
 end
 
-function LoaderLinkCreator:_updateProviderLoader()
+function LoaderLinkCreator._updateProviderLoader(self: LoaderLinkCreator)
 	self._provideLoader.Value = (self._childRequiresLoaderCount.Value > 0) and self._hasLoaderCount.Value <= 0
 end
 
-function LoaderLinkCreator:_handleChildRemoved(child)
+function LoaderLinkCreator._handleChildRemoved(self: LoaderLinkCreator, child: Instance)
 	self._maid[child] = nil
 end
 
-function LoaderLinkCreator:_handleChildAdded(child)
+function LoaderLinkCreator._handleChildAdded(self: LoaderLinkCreator, child: Instance)
 	assert(typeof(child) == "Instance", "Bad child")
 
 	if child:IsA("ModuleScript") then
@@ -126,10 +144,13 @@ function LoaderLinkCreator:_handleChildAdded(child)
 	end
 end
 
-function LoaderLinkCreator:_renderLoaderWithReferences()
+function LoaderLinkCreator._renderLoaderWithReferences(
+	self: LoaderLinkCreator,
+	references: ReplicatorReferences.ReplicatorReferences
+): Maid.Maid
 	local maid = Maid.new()
 
-	maid:GiveTask(self._references:ObserveReferenceChanged(loader, function(value)
+	maid:GiveTask(references:ObserveReferenceChanged(loader, function(value: Instance?)
 		if value then
 			maid._current = self:_doLoaderRender(value)
 		else
@@ -140,17 +161,16 @@ function LoaderLinkCreator:_renderLoaderWithReferences()
 	return maid
 end
 
-function LoaderLinkCreator:_doLoaderRender(value)
+function LoaderLinkCreator._doLoaderRender(self: LoaderLinkCreator, value: Instance)
 	local loaderLink = LoaderLinkUtils.create(value, loader.Name)
 	self._lastProvidedLoader = loaderLink
 
 	loaderLink.Parent = self._root
 
-
 	return loaderLink
 end
 
-function LoaderLinkCreator:_incrementNeededLoader(amount)
+function LoaderLinkCreator._incrementNeededLoader(self: LoaderLinkCreator, amount: number): () -> ()
 	assert(type(amount) == "number", "Bad amount")
 
 	self._childRequiresLoaderCount.Value = self._childRequiresLoaderCount.Value + amount
@@ -159,7 +179,7 @@ function LoaderLinkCreator:_incrementNeededLoader(amount)
 	end
 end
 
-function LoaderLinkCreator:_addToHasLoaderCount(amount)
+function LoaderLinkCreator._addToHasLoaderCount(self: LoaderLinkCreator, amount: number): () -> ()
 	assert(type(amount) == "number", "Bad amount")
 
 	self._hasLoaderCount.Value = self._hasLoaderCount.Value + amount
@@ -168,7 +188,7 @@ function LoaderLinkCreator:_addToHasLoaderCount(amount)
 	end
 end
 
-function LoaderLinkCreator:_countLoaderReferences(robloxInst)
+function LoaderLinkCreator._countLoaderReferences(self: LoaderLinkCreator, robloxInst: Instance): Maid.Maid
 	assert(typeof(robloxInst) == "Instance", "Bad robloxInst")
 
 	local maid = Maid.new()
@@ -193,9 +213,9 @@ end
 	Cleans up the replicator disconnecting all events and cleaning up
 	created instances.
 ]=]
-function LoaderLinkCreator:Destroy()
+function LoaderLinkCreator.Destroy(self: LoaderLinkCreator)
 	self._maid:DoCleaning()
-	setmetatable(self, nil)
+	setmetatable(self :: any, nil)
 end
 
 return LoaderLinkCreator

package/src/LoaderLink/LoaderLinkUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class LoaderLinkUtils
 	@private
@@ -7,7 +8,7 @@ local LoaderLink = script.Parent.LoaderLink
 
 local LoaderLinkUtils = {}
 
-function LoaderLinkUtils.create(loader, linkName)
+function LoaderLinkUtils.create(loader: Instance, linkName: string): ModuleScript
 	assert(typeof(loader) == "Instance", "Bad loader")
 	assert(type(linkName) == "string", "Bad linkName")
 

package/src/LoaderUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 -- Literally here just so old loading code works
 
 error("Not implemented! Please require LoaderUtils.Parent. This file acts as a marker for old loader versions.")

package/src/Maid.lua

@@ -1,3 +1,4 @@
+--!strict
 --[[
 	Manages the cleaning of events and other things. Useful for
 	encapsulating state and make deconstructors easy.
@@ -26,6 +27,21 @@
 local Maid = {}
 Maid.ClassName = "Maid"
 
+export type MaidTask = (() -> ()) | Instance | thread | Maid | any
+
+export type Maid = typeof(setmetatable(
+	{} :: {
+		Add: <T>(self: Maid, task: T) -> T,
+		GiveTask: (self: Maid, task: MaidTask) -> number,
+		GivePromise: <T>(self: Maid, promise: T) -> T,
+		DoCleaning: (self: Maid) -> (),
+		Destroy: (self: Maid) -> (),
+		_tasks: { [any]: MaidTask },
+		[string | number | { [any]: any } | Instance]: MaidTask?,
+	},
+	Maid
+))
+
 --[[
 	Constructs a new Maid object
 
@@ -36,10 +52,10 @@ Maid.ClassName = "Maid"
 	@ignore
 	@return Maid
 ]]
-function Maid.new()
+function Maid.new(): Maid
 	return setmetatable({
-		_tasks = {}
-	}, Maid)
+		_tasks = {},
+	}, Maid) :: Maid
 end
 
 --[[
@@ -54,7 +70,7 @@ end
 	@param value any
 	@return boolean
 ]]
-function Maid.isMaid(value)
+function Maid.isMaid(value: any): boolean
 	return type(value) == "table" and value.ClassName == "Maid"
 end
 
@@ -74,7 +90,7 @@ end
 	@param index any
 	@return MaidTask
 ]]
-function Maid:__index(index)
+function Maid.__index(self: Maid, index: any)
 	if Maid[index] then
 		return Maid[index]
 	else
@@ -102,7 +118,7 @@ end
 	@param index any
 	@param newTask MaidTask
 ]]
-function Maid:__newindex(index, newTask)
+function Maid.__newindex(self: Maid, index: any, newTask: MaidTask)
 	if Maid[index] ~= nil then
 		error(string.format("Cannot use '%s' as a Maid key", tostring(index)), 2)
 	end
@@ -117,16 +133,15 @@ function Maid:__newindex(index, newTask)
 	tasks[index] = newTask
 
 	if job then
-		local jobType = typeof(job)
-		if jobType == "function" then
-			job()
-		elseif jobType == "table" then
+		if typeof(job) == "function" then
+			(job :: any)()
+		elseif typeof(job) == "table" then
 			if type(job.Destroy) == "function" then
 				job:Destroy()
 			end
-		elseif jobType == "Instance" then
+		elseif typeof(job) == "Instance" then
 			job:Destroy()
-		elseif jobType == "thread" then
+		elseif typeof(job) == "thread" then
 			local cancelled
 			if coroutine.running() ~= job then
 				cancelled = pcall(function()
@@ -139,7 +154,7 @@ function Maid:__newindex(index, newTask)
 					task.cancel(job)
 				end)
 			end
-		elseif jobType == "RBXScriptConnection" then
+		elseif typeof(job) == "RBXScriptConnection" then
 			job:Disconnect()
 		end
 	end
@@ -152,14 +167,14 @@ end
 	@param task MaidTask -- An item to clean
 	@return MaidTask
 ]]
-function Maid:Add(task)
+function Maid.Add<T>(self: Maid, task: T): T
 	if not task then
 		error("Task cannot be false or nil", 2)
 	end
 
-	self[#self._tasks+1] = task
+	self[#(self._tasks :: any) + 1] = task
 
-	if type(task) == "table" and (not task.Destroy) then
+	if type(task) == "table" and not task.Destroy then
 		warn("[Maid.Add] - Gave table task without .Destroy\n\n" .. debug.traceback())
 	end
 
@@ -173,15 +188,15 @@ end
 	@param task MaidTask -- An item to clean
 	@return number -- taskId
 ]]
-function Maid:GiveTask(task)
+function Maid.GiveTask(self: Maid, task: MaidTask): number
 	if not task then
 		error("Task cannot be false or nil", 2)
 	end
 
-	local taskId = #self._tasks+1
+	local taskId = #(self._tasks :: any) + 1
 	self[taskId] = task
 
-	if type(task) == "table" and (not task.Destroy) then
+	if type(task) == "table" and not task.Destroy then
 		warn("[Maid.GiveTask] - Gave table task without .Destroy\n\n" .. debug.traceback())
 	end
 
@@ -195,7 +210,7 @@ end
 	@param promise Promise<T>
 	@return Promise<T>
 ]]
-function Maid:GivePromise(promise)
+function Maid.GivePromise(self: Maid, promise: any): any
 	if not promise:IsPending() then
 		return promise
 	end
@@ -229,11 +244,11 @@ end
 
 	@ignore
 ]]
-function Maid:DoCleaning()
+function Maid.DoCleaning(self: Maid)
 	local tasks = self._tasks
 
 	-- Disconnect all events first as we know this is safe
-	for index, job in pairs(tasks) do
+	for index, job in tasks do
 		if typeof(job) == "RBXScriptConnection" then
 			tasks[index] = nil
 			job:Disconnect()
@@ -244,14 +259,13 @@ function Maid:DoCleaning()
 	local index, job = next(tasks)
 	while job ~= nil do
 		tasks[index] = nil
-		local jobType = typeof(job)
-		if jobType == "function" then
-			job()
-		elseif jobType == "table" and type(job.Destroy) == "function" then
+		if typeof(job) == "function" then
+			(job :: any)()
+		elseif typeof(job) == "table" and type(job.Destroy) == "function" then
 			job:Destroy()
-		elseif jobType == "Instance" then
+		elseif typeof(job) == "Instance" then
 			job:Destroy()
-		elseif jobType == "thread" then
+		elseif typeof(job) == "thread" then
 			local cancelled
 			if coroutine.running() ~= job then
 				cancelled = pcall(function()
@@ -265,7 +279,7 @@ function Maid:DoCleaning()
 					task.cancel(toCancel)
 				end)
 			end
-		elseif jobType == "RBXScriptConnection" then
+		elseif typeof(job) == "RBXScriptConnection" then
 			job:Disconnect()
 		end
 		index, job = next(tasks)

package/src/Replication/ReplicationType.lua

@@ -1,4 +1,6 @@
+--!strict
 --[=[
+
 	Different replication types we can be in.
 
 	@class ReplicationType
@@ -6,9 +8,18 @@
 
 local Utils = require(script.Parent.Parent.Utils)
 
+export type ReplicationTypeMap = {
+	CLIENT: "client",
+	SERVER: "server",
+	SHARED: "shared",
+	PLUGIN: "plugin",
+}
+
+export type ReplicationType = "client" | "server" | "shared" | "plugin"
+
 return Utils.readonly({
-	CLIENT = "client";
-	SERVER = "server";
-	SHARED = "shared";
-	PLUGIN = "plugin";
-})
+	CLIENT = "client",
+	SERVER = "server",
+	SHARED = "shared",
+	PLUGIN = "plugin",
+} :: ReplicationTypeMap)

package/src/Replication/ReplicationTypeUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility functions involving [ReplicationType]
 	@class ReplicationTypeUtils
@@ -14,14 +15,17 @@ local ReplicationTypeUtils = {}
 	@param replicationType any
 	@return boolean
 ]=]
-function ReplicationTypeUtils.isReplicationType(replicationType)
+function ReplicationTypeUtils.isReplicationType(replicationType: any): boolean
 	return replicationType == ReplicationType.SHARED
 		or replicationType == ReplicationType.CLIENT
 		or replicationType == ReplicationType.SERVER
 		or replicationType == ReplicationType.PLUGIN
 end
 
-function ReplicationTypeUtils.getFolderReplicationType(folderName, ancestorReplicationType)
+function ReplicationTypeUtils.getFolderReplicationType(
+	folderName: string,
+	ancestorReplicationType: ReplicationType.ReplicationType
+): ReplicationType.ReplicationType
 	assert(type(folderName) == "string", "Bad folderName")
 	assert(type(ancestorReplicationType) == "string", "Bad ancestorReplicationType")
 
@@ -36,7 +40,7 @@ function ReplicationTypeUtils.getFolderReplicationType(folderName, ancestorRepli
 	end
 end
 
-function ReplicationTypeUtils.inferReplicationType()
+function ReplicationTypeUtils.inferReplicationType(): ReplicationType.ReplicationType
 	if (not RunService:IsRunning()) and RunService:IsStudio() then
 		return ReplicationType.PLUGIN
 	elseif RunService:IsServer() then
@@ -48,7 +52,7 @@ function ReplicationTypeUtils.inferReplicationType()
 	end
 end
 
-function ReplicationTypeUtils.isAllowed(replicationType, requestedReplicationType)
+function ReplicationTypeUtils.isAllowed(replicationType: ReplicationType.ReplicationType, requestedReplicationType: ReplicationType.ReplicationType): boolean
 	assert(ReplicationTypeUtils.isReplicationType(replicationType), "Bad replicationType")
 	assert(ReplicationTypeUtils.isReplicationType(requestedReplicationType), "Bad requestedReplicationType")