Improvements to Typechecking

* Introduces `QueryResult:server()`, `QueryResult:client()`, and `QueryResult:iter()` for better typechecking.

Author: YetAnotherClown

lib/Connection.luau

@@ -10,10 +10,7 @@ type ConnectionImpl = {
 	new: <U...>(callback: (U...) -> ()) -> Connection,
 }
 
-export type Connection = typeof(setmetatable({
-	-- selene: allow(unused_variable)
-	_callback = function(...) end,
-}, {} :: ConnectionImpl))
+export type Connection = typeof(setmetatable({} :: ConnectionImpl, {} :: ConnectionImpl))
 
 --[=[
     @class Connection
@@ -60,7 +57,7 @@ function Connection.new<U...>(callback: (U...) -> ())
 		task.spawn(callback, ...)
 	end
 
-	return self
+	return self :: any
 end
 
 return Connection

lib/QueryResult.luau

@@ -15,6 +15,30 @@ export type Identifier = Identifier.Identifier
 
 local read = Identifier.read
 
+type ClientQueryResult<U...> = {
+	__index: ClientQueryResult<U...>,
+	__iter: (self: ClientQueryResult<U...>) -> () -> (number, U...),
+
+	_snapshot: { IncomingPacket },
+	_identifier: Identifier,
+	_senders: { NetServer },
+
+	iter: (self: ClientQueryResult<U...>) -> () -> (number, U...),
+}
+
+type ServerQueryResult<U...> = {
+	__index: ServerQueryResult<U...>,
+	__iter: (self: ServerQueryResult<U...>) -> () -> (number, Player, U...),
+
+	_snapshot: { IncomingPacket },
+	_identifier: Identifier,
+	_senders: { Player },
+	_view: "server",
+
+	iter: (self: ServerQueryResult<U...>) -> () -> (number, Player, U...),
+	from: (self: QueryResult<U...>, ...Player) -> QueryResult<U...>,
+}
+
 --[=[
 	@class QueryResult
 	@since v0.4.0
@@ -37,23 +61,31 @@ local read = Identifier.read
 	See [Querying Data](/docs/getting-started/routes#querying) for more information.
 ]=]
 type QueryResultImpl<U...> = {
+	__index: QueryResultImpl<U...>,
+	__iter: (self: QueryResult<U...>) -> () -> (number, Player | NetServer, U...),
+
 	_snapshot: { IncomingPacket },
 	_identifier: Identifier,
 	_senders: { Player | NetServer },
+	_view: "client"?,
 
-	__index: QueryResultImpl<U...>,
-	__iter: (self: QueryResult<U...>) -> () -> (number?, (Player | NetServer)?, U...),
-
+	iter: (self: QueryResult<U...>) -> () -> (number, Player | NetServer, U...),
 	from: (self: QueryResult<U...>, ...(Player | NetServer)) -> QueryResult<U...>,
 
+	client: (self: QueryResult<U...>) -> ClientQueryResult<U...>,
+	server: (self: QueryResult<U...>) -> ServerQueryResult<U...>,
+
 	new: (
 		snapshot: { IncomingPacket },
 		identifier: Identifier,
 		senders: { Recipient }?
 	) -> QueryResult<U...>,
 }
 
-export type QueryResult<U...> = typeof(setmetatable({}, {} :: QueryResultImpl<U...>))
+export type QueryResult<U...> = typeof(setmetatable(
+	{} :: QueryResultImpl<U...>,
+	{} :: QueryResultImpl<U...>
+))
 
 local QueryResult: QueryResultImpl<...any> = {} :: QueryResultImpl<...any>
 QueryResult.__index = QueryResult
@@ -82,6 +114,8 @@ function QueryResult:__iter()
 
 	local filteredSnapshot = {}
 
+	local view = self._view
+
 	for i = 1, #self._snapshot do
 		local packet = self._snapshot[i]
 		if not packet then
@@ -100,18 +134,38 @@ function QueryResult:__iter()
 
 	local i = 0
 
-	return function()
+	return function(): ...any
 		i += 1
 
 		local packet = filteredSnapshot[i]
 		if not packet then
 			return
 		end
 
+		if view == "client" then
+			return i, unpack(packet.data)
+		end
+
 		return i, packet.sender, unpack(packet.data)
 	end
 end
 
+--[=[
+	@method iter
+	@within QueryResult
+	
+	An iterator method for typechecking.
+
+	```lua
+	for i, sender, ... in route:query():iter() do
+		-- ...
+	end
+	```
+]=]
+function QueryResult:iter()
+	return self:__iter()
+end
+
 --[=[
 	@method from
 	@within QueryResult
@@ -139,6 +193,40 @@ function QueryResult:from(...)
 	return self.new(self._snapshot, self._identifier, senders)
 end
 
+--[=[
+	@method client
+	@within QueryResult
+	
+	Switches the query to a client view, for typechecking.
+	The client view will not return a `sender` when iterating.
+
+	```lua
+	for i, ... in route:query():client():iter() do
+		-- ...
+	end
+	```
+]=]
+function QueryResult:client()
+	self._view = "client"
+	return self :: any
+end
+
+--[=[
+	@method server
+	@within QueryResult
+	
+	Switches the query to a server view, for typechecking.
+
+	```lua
+	for i, player, ... in route:query():server():iter() do
+		-- ...
+	end
+	```
+]=]
+function QueryResult:server()
+	return self :: any
+end
+
 --[=[
 	@function new
 	@within QueryResult
@@ -153,7 +241,7 @@ function QueryResult.new(snapshot, identifier, senders)
 		_snapshot = snapshot,
 		_identifier = identifier,
 		_senders = senders or {},
-	}, QueryResult)
+	}, QueryResult) :: any
 end
 
 return QueryResult

lib/SendRequest.luau

@@ -25,15 +25,15 @@ local isClient = RunService:IsClient()
 	Allows for modification of queued packets before they're sent.
 ]=]
 type SendRequestImpl = {
+	__index: SendRequestImpl,
+
 	_outgoingQueue: { OutgoingPacket },
 	_position: number,
 
-	__index: SendRequestImpl,
-
 	to: (self: SendRequest, recipient: Recipient) -> (),
 }
 
-export type SendRequest = typeof(setmetatable({}, {} :: SendRequestImpl))
+export type SendRequest = typeof(setmetatable({} :: SendRequestImpl, {} :: SendRequestImpl))
 
 local SendRequest: SendRequestImpl = {} :: SendRequestImpl
 SendRequest.__index = SendRequest

lib/init.luau

@@ -58,8 +58,12 @@ export type Configuration = {
 
 	See the [Intro](/docs/intro) to get started.
 ]=]
-type RouteImpl<U...> = {
+export type RouteImpl<U...> = {
+	__index: RouteImpl<U...>,
+	__iter: (self: Route<U...>) -> QueryResult<U...>,
+
 	server: NetServer,
+
 	_identifier: Identifier,
 	_configuration: Configuration,
 	_outgoingQueue: { OutgoingPacket },
@@ -71,32 +75,20 @@ type RouteImpl<U...> = {
 		Outgoing: ((...any) -> ...any)?,
 	},
 
-	__index: RouteImpl<U...>,
-	__iter: (self: Route<U...>) -> QueryResult<U...>,
+	addIncomingMiddleware: (self: Route<U...>, middleware: (...any) -> ...any) -> (),
+	addOutgoingMiddleware: (self: Route<U...>, middleware: (...any) -> ...any) -> (),
 
 	_queuePackets: (Route<U...>, Bridge) -> (),
 	_updateSnapshot: (Route<U...>, Bridge) -> (),
 	_processConnections: (Route<U...>) -> (),
-	addIncomingMiddleware: (self: Route<U...>, middleware: (...any) -> ...any) -> (),
-	addOutgoingMiddleware: (self: Route<U...>, middleware: (...any) -> ...any) -> (),
-	send: (self: Route<U...>, U...) -> SendRequest,
-	query: (self: Route<U...>) -> QueryResult<U...>,
 
-	start: (loop: any, { Route<U...> }) -> (),
-	createHook: ({ Route<U...> }) -> () -> (),
+	query: (self: Route<U...>) -> QueryResult<U...>,
+	send: (self: Route<U...>, U...) -> SendRequest,
 
-	new: (Configuration) -> Route<U...>,
+	new: (Configuration?) -> Route<U...>,
 }
 
-export type Route<U...> = typeof(setmetatable(
-	{} :: {
-		_configuration: Configuration,
-		_outgoingQueue: { OutgoingPacket },
-		_snapshot: IncomingQueue,
-		_currentPlayers: { Player },
-	},
-	{} :: RouteImpl<U...>
-))
+type Route<U...> = typeof(setmetatable({} :: RouteImpl<U...>, {} :: RouteImpl<U...>))
 
 local Route: RouteImpl<...any> = {} :: RouteImpl<...any>
 Route.__index = Route
@@ -174,7 +166,7 @@ function Route:send(...)
 	SendRequest._position = #self._outgoingQueue
 	setmetatable(sendRequest, SendRequest)
 
-	return sendRequest
+	return sendRequest :: any
 end
 
 --[=[
@@ -393,7 +385,7 @@ function Route.new(configuration: Configuration?)
 		Unreliable = {},
 	}
 
-	return self
+	return self :: any
 end
 
 --[=[