@axpecter/lync 1.4.3 → 1.5.0

package/src/api/Packet.luau

@@ -2,21 +2,22 @@
 --!optimize 2
 -- Packet definition and send/listen API.
 
-local RunService = game:GetService ("RunService")
+local RunService = game:GetService("RunService")
 
-local Client = require (script.Parent.Parent.transport.Client)
-local Registry = require (script.Parent.Parent.internal.Registry)
-local Server = require (script.Parent.Parent.transport.Server)
-local Signal = require (script.Parent.Signal)
-local Types = require (script.Parent.Parent.Types)
+local Client = require(script.Parent.Parent.transport.Client)
+local Registry = require(script.Parent.Parent.internal.Registry)
+local Server = require(script.Parent.Parent.transport.Server)
+local Signal = require(script.Parent.Signal)
+local Types = require(script.Parent.Parent.Types)
 
 type Connection = Types.Connection
+type Codec<T> = Types.Codec<T>
 type InternalCodec<T> = Types.InternalCodec<T>
 type PacketConfig<T> = Types.PacketConfig<T>
 
--- Constants ----------------------------------------------------------
+-- Constants -----------------------------------------------------------
 
-local IS_SERVER = RunService:IsServer ()
+local IS_SERVER = RunService:IsServer()
 
 local serverWriteTo = Server.writeTo
 local serverWriteToAll = Server.writeToAll
@@ -28,32 +29,44 @@ local clientWrite = Client.write
 local DELTA_TARGETED = 1
 local DELTA_BROADCAST = 2
 
--- Private ------------------------------------------------------------
+-- Private -------------------------------------------------------------
 
--- Shared methods (both contexts)
+type PacketFields = {
+    _id: number,
+    _name: string,
+    _codec: Codec<any>,
+    _isUnreliable: boolean,
+    _isDelta: boolean,
+    _deltaMode: number,
+    _signal: Signal.Signal,
+}
+
+-- Shared methods(both contexts)
 local SharedImpl = {}
 
-function SharedImpl.listen (self: any, callback: (...any) -> ()): Connection
-    return self._signal:connect (callback)
+function SharedImpl.listen(self: Packet, callback: (...any) -> ()): Connection
+    return self._signal:connect(callback)
 end
 
-function SharedImpl.once (self: any, callback: (...any) -> ()): Connection
-    return self._signal:once (callback)
+function SharedImpl.once(self: Packet, callback: (...any) -> ()): Connection
+    return self._signal:once(callback)
 end
 
-function SharedImpl.wait (self: any): ...any
-    return self._signal:wait ()
+function SharedImpl.wait(self: Packet): ...any
+    return self._signal:wait()
 end
 
-function SharedImpl.disconnectAll (self: any): ()
-    self._signal:disconnectAll ()
+function SharedImpl.disconnectAll(self: Packet): ()
+    self._signal:disconnectAll()
 end
 
 -- Server-only metatable. Single send() dispatches on target type.
-local ServerImpl = setmetatable ({}, { __index = SharedImpl })
+local ServerImpl = setmetatable({}, { __index = SharedImpl })
 ServerImpl.__index = ServerImpl
 
-local function checkDeltaMode (self: any, mode: number): ()
+export type Packet = typeof(setmetatable({} :: PacketFields, ServerImpl))
+
+local function checkDeltaMode(self: Packet, mode: number): ()
     if not self._isDelta then
         return
     end
@@ -61,13 +74,13 @@ local function checkDeltaMode (self: any, mode: number): ()
     if current == 0 then
         self._deltaMode = mode
     elseif current ~= mode then
-        error (`[Lync] Delta packet cannot mix targeted and broadcast: "{self._name}"`)
+        error(`[Lync] Delta packet cannot mix targeted and broadcast: "{self._name}"`)
     end
 end
 
-function ServerImpl.send (self: any, data: any, target: any?): ()
+function ServerImpl.send(self: Packet, data: any, target: any?): ()
     if target == nil then
-        error ("[Lync] Server packet:send requires a target")
+        error("[Lync] Server packet:send requires a target")
     end
 
     local id = self._id
@@ -76,9 +89,9 @@ function ServerImpl.send (self: any, data: any, target: any?): ()
     local isUnreliable = self._isUnreliable
 
     -- Single player
-    if typeof (target) == "Instance" then
-        checkDeltaMode (self, DELTA_TARGETED)
-        serverWriteTo (target :: Player, id, name, codec, data, isUnreliable)
+    if typeof(target) == "Instance" then
+        checkDeltaMode(self, DELTA_TARGETED)
+        serverWriteTo(target :: Player, id, name, codec, data, isUnreliable)
         return
     end
 
@@ -87,63 +100,63 @@ function ServerImpl.send (self: any, data: any, target: any?): ()
 
     -- Lync.all sentinel
     if tag == "all" then
-        checkDeltaMode (self, DELTA_BROADCAST)
-        serverWriteToAll (id, name, codec, data, isUnreliable)
+        checkDeltaMode(self, DELTA_BROADCAST)
+        serverWriteToAll(id, name, codec, data, isUnreliable)
         return
     end
 
     -- Lync.except(player, ...) descriptor
     if tag == "except" then
-        checkDeltaMode (self, DELTA_BROADCAST)
-        serverWriteToAllExcept (target._set, id, name, codec, data, isUnreliable)
+        checkDeltaMode(self, DELTA_BROADCAST)
+        serverWriteToAllExcept(target._set, id, name, codec, data, isUnreliable)
         return
     end
 
     -- Group object
     if tag == "group" then
-        checkDeltaMode (self, DELTA_BROADCAST)
-        serverWriteToSet (target:getSet (), id, name, codec, data, isUnreliable)
+        checkDeltaMode(self, DELTA_BROADCAST)
+        serverWriteToSet(target:getSet(), id, name, codec, data, isUnreliable)
         return
     end
 
-    -- Player list (array)
-    checkDeltaMode (self, DELTA_TARGETED)
-    serverWriteToList (target :: { Player }, id, name, codec, data, isUnreliable)
+    -- Player list(array)
+    checkDeltaMode(self, DELTA_TARGETED)
+    serverWriteToList(target :: { Player }, id, name, codec, data, isUnreliable)
 end
 
-table.freeze (ServerImpl)
+table.freeze(ServerImpl)
 
 -- Client-only metatable. Has send(), no target needed.
-local ClientImpl = setmetatable ({}, { __index = SharedImpl })
+local ClientImpl = setmetatable({}, { __index = SharedImpl })
 ClientImpl.__index = ClientImpl
 
-function ClientImpl.send (self: any, data: any): ()
-    clientWrite (self._id, self._name, self._codec, data, self._isUnreliable)
+function ClientImpl.send(self: Packet, data: any): ()
+    clientWrite(self._id, self._name, self._codec, data, self._isUnreliable)
 end
 
-table.freeze (ClientImpl)
+table.freeze(ClientImpl)
 
--- Public -------------------------------------------------------------
+-- Public --------------------------------------------------------------
 
-local Packet = {}
+local PacketModule = {}
 
-function Packet.define (name: string, config: PacketConfig<any>): any
+function PacketModule.define(name: string, config: PacketConfig<any>): Packet
     if #name == 0 then
-        error ("[Lync] Packet name must not be empty")
+        error("[Lync] Packet name must not be empty")
     end
     if not config.value then
-        error (`[Lync] Packet requires a value codec: "{name}"`)
+        error(`[Lync] Packet requires a value codec: "{name}"`)
     end
 
     local isUnreliable = config.unreliable or false
 
     if (config.value :: InternalCodec<any>)._isDelta and isUnreliable then
-        error (`[Lync] Delta codec requires reliable delivery: "{name}"`)
+        error(`[Lync] Delta codec requires reliable delivery: "{name}"`)
     end
 
-    local signal = Signal.create ()
+    local signal = Signal.create()
 
-    local reg = Registry.register (
+    local reg = Registry.register(
         name,
         config.value,
         isUnreliable,
@@ -155,7 +168,7 @@ function Packet.define (name: string, config: PacketConfig<any>): any
 
     local isDelta = (config.value :: InternalCodec<any>)._isDelta == true
 
-    return setmetatable ({
+    local fields: PacketFields = {
         _id = reg.id,
         _name = reg.name,
         _codec = reg.codec,
@@ -163,7 +176,12 @@ function Packet.define (name: string, config: PacketConfig<any>): any
         _isDelta = isDelta,
         _deltaMode = 0,
         _signal = signal,
-    }, if IS_SERVER then ServerImpl else ClientImpl)
+    }
+
+    if IS_SERVER then
+        return setmetatable(fields, ServerImpl)
+    end
+    return setmetatable(fields, ClientImpl) :: Packet
 end
 
-return table.freeze (Packet)
+return table.freeze(PacketModule)

package/src/api/Query.luau

@@ -2,26 +2,27 @@
 --!optimize 2
 -- Bidirectional request-reply over RemoteEvents.
 
-local Players = game:GetService ("Players")
-local RunService = game:GetService ("RunService")
+local Players = game:GetService("Players")
+local RunService = game:GetService("RunService")
 
-local Client = require (script.Parent.Parent.transport.Client)
-local Registry = require (script.Parent.Parent.internal.Registry)
-local Server = require (script.Parent.Parent.transport.Server)
-local Signal = require (script.Parent.Signal)
-local Types = require (script.Parent.Parent.Types)
+local Client = require(script.Parent.Parent.transport.Client)
+local Registry = require(script.Parent.Parent.internal.Registry)
+local Server = require(script.Parent.Parent.transport.Server)
+local Signal = require(script.Parent.Signal)
+local Types = require(script.Parent.Parent.Types)
 
 type Connection = Types.Connection
 type QueryConfig<R, S> = Types.QueryConfig<R, S>
+type Registration = Types.Registration
 
--- Constants ----------------------------------------------------------
+-- Constants -----------------------------------------------------------
 
-local IS_SERVER = RunService:IsServer ()
+local IS_SERVER = RunService:IsServer()
 
 -- Wire ceiling: correlationId is u16 in Channel.writeQuery / Reader.process.
 local POOL_SIZE = 65536
 
--- State --------------------------------------------------------------
+-- State ---------------------------------------------------------------
 
 type PendingQuery = {
     thread: thread?,
@@ -33,11 +34,11 @@ local _pending = {} :: { [number]: PendingQuery }
 local _nextId = 0
 local _activeCount = 0
 
--- Private ------------------------------------------------------------
+-- Private -------------------------------------------------------------
 
-local function allocCorrelation (): number
+local function allocCorrelation(): number
     if _activeCount >= POOL_SIZE then
-        error ("[Lync] All 65536 query correlation slots exhausted")
+        error("[Lync] All 65536 query correlation slots exhausted")
     end
 
     local id = _nextId
@@ -55,38 +56,50 @@ end
 
 -- Decrements the active correlation counter. Does not free a specific slot;
 -- that is handled by nil-ing _pending[id] at the call site.
-local function releaseCorrelation (): ()
+local function releaseCorrelation(): ()
     _activeCount -= 1
 end
 
-local function completeQuery (id: number, data: any): ()
+local function completeQuery(id: number, data: any): ()
     local entry = _pending[id]
     if not entry then
         return
     end
 
     _pending[id] = nil
-    releaseCorrelation ()
+    releaseCorrelation()
 
     if entry.timeout then
-        task.cancel (entry.timeout)
+        task.cancel(entry.timeout)
     end
 
     if entry.callback then
-        entry.callback (data)
+        entry.callback(data)
     elseif entry.thread then
-        coroutine.resume (entry.thread :: thread, data)
+        coroutine.resume(entry.thread :: thread, data)
     end
 end
 
-local function onTimeout (correlation: number): ()
-    completeQuery (correlation, nil)
+local function onTimeout(correlation: number): ()
+    completeQuery(correlation, nil)
 end
 
+type QueryFields = {
+    _name: string,
+    _reqReg: Registration,
+    _respReg: Registration,
+    _timeout: number,
+}
+
+local QueryImpl = {}
+QueryImpl.__index = QueryImpl
+
+export type Query = typeof(setmetatable({} :: QueryFields, QueryImpl))
+
 -- Send a query to multiple players and yield. Returns { [Player]: response? }.
-local function requestMulti (self: any, players: { Player }, data: any): { [Player]: any? }
+local function requestMulti(self: Query, players: { Player }, data: any): { [Player]: any? }
     if not IS_SERVER then
-        error ("[Lync] Multi-request is server-only")
+        error("[Lync] Multi-request is server-only")
     end
 
     local count = #players
@@ -95,13 +108,12 @@ local function requestMulti (self: any, players: { Player }, data: any): { [Play
     end
 
     if count == 1 then
-        -- Delegate to single-player path
-        local correlation = allocCorrelation ()
-        local thread = coroutine.running ()
+        local correlation = allocCorrelation()
+        local thread = coroutine.running()
         local entry: PendingQuery = { thread = thread, timeout = nil }
         _pending[correlation] = entry
 
-        Server.writeQuery (
+        Server.writeQuery(
             players[1],
             self._reqReg.id,
             self._name,
@@ -110,15 +122,15 @@ local function requestMulti (self: any, players: { Player }, data: any): { [Play
             data
         )
 
-        entry.timeout = task.delay (self._timeout, onTimeout, correlation)
-        local result = coroutine.yield ()
+        entry.timeout = task.delay(self._timeout, onTimeout, correlation)
+        local result = coroutine.yield()
         return { [players[1]] = result }
     end
 
-    local thread = coroutine.running ()
+    local thread = coroutine.running()
     local results = {} :: { [Player]: any? }
     local remaining = count
-    local correlations = table.create (count) :: { number }
+    local correlations = table.create(count) :: { number }
     local finished = false
 
     local reqId = self._reqReg.id
@@ -128,28 +140,27 @@ local function requestMulti (self: any, players: { Player }, data: any): { [Play
 
     for i = 1, count do
         local player = players[i]
-        local correlation = allocCorrelation ()
+        local correlation = allocCorrelation()
         correlations[i] = correlation
 
         local entry: PendingQuery = {
             thread = nil,
-            callback = function (resp: any): ()
+            callback = function(resp: any): ()
                 results[player] = resp
                 remaining -= 1
                 if remaining == 0 and not finished then
                     finished = true
-                    task.spawn (thread, results)
+                    task.spawn(thread, results)
                 end
             end,
             timeout = nil,
         }
 
         _pending[correlation] = entry
-
-        Server.writeQuery (player, reqId, reqName, correlation, reqCodec, data)
+        Server.writeQuery(player, reqId, reqName, correlation, reqCodec, data)
     end
 
-    local timeoutThread = task.delay (timeout, function (): ()
+    local timeoutThread = task.delay(timeout, function(): ()
         if finished then
             return
         end
@@ -157,14 +168,13 @@ local function requestMulti (self: any, players: { Player }, data: any): { [Play
 
         for i = 1, count do
             local cid = correlations[i]
-            local entry = _pending[cid]
-            if entry then
+            if _pending[cid] then
                 _pending[cid] = nil
-                releaseCorrelation ()
+                releaseCorrelation()
             end
         end
 
-        task.spawn (thread, results)
+        task.spawn(thread, results)
     end)
 
     for i = 1, count do
@@ -175,44 +185,41 @@ local function requestMulti (self: any, players: { Player }, data: any): { [Play
         end
     end
 
-    return coroutine.yield ()
+    return coroutine.yield()
 end
 
-local QueryImpl = {}
-QueryImpl.__index = QueryImpl
-
-function QueryImpl.listen (self: any, callback: (...any) -> any): Connection
+function QueryImpl.listen(self: Query, callback: (...any) -> any): Connection
     local respId = self._respReg.id
     local respName = self._name
     local respCodec = self._respReg.codec
 
     if IS_SERVER then
-        return self._reqReg.signal:connect (
-            function (request: any, player: Player, correlation: number): ()
-                local ok, response = pcall (callback, request, player)
+        return self._reqReg.signal:connect(
+            function(request: any, player: Player, correlation: number): ()
+                local ok, response = pcall(callback, request, player)
                 if not ok then
-                    warn (`[Lync] Query handler error on "{respName}": {response}`)
+                    warn(`[Lync] Query handler error on "{respName}": {response}`)
                 end
 
                 if ok and response ~= nil then
-                    Server.writeQuery (player, respId, respName, correlation, respCodec, response)
+                    Server.writeQuery(player, respId, respName, correlation, respCodec, response)
                 else
-                    Server.writeQueryNil (player, respId, respName, correlation)
+                    Server.writeQueryNil(player, respId, respName, correlation)
                 end
             end
         )
     else
-        return self._reqReg.signal:connect (
-            function (request: any, _player: Player?, correlation: number): ()
-                local ok, response = pcall (callback, request)
+        return self._reqReg.signal:connect(
+            function(request: any, _player: Player?, correlation: number): ()
+                local ok, response = pcall(callback, request)
                 if not ok then
-                    warn (`[Lync] Query handler error on "{respName}": {response}`)
+                    warn(`[Lync] Query handler error on "{respName}": {response}`)
                 end
 
                 if ok and response ~= nil then
-                    Client.writeQuery (respId, respName, correlation, respCodec, response)
+                    Client.writeQuery(respId, respName, correlation, respCodec, response)
                 else
-                    Client.writeQueryNil (respId, respName, correlation)
+                    Client.writeQueryNil(respId, respName, correlation)
                 end
             end
         )
@@ -220,78 +227,77 @@ function QueryImpl.listen (self: any, callback: (...any) -> any): Connection
 end
 
 -- Client: send request to server, yield until response.
-function QueryImpl.request (self: any, data: any): any
+function QueryImpl.request(self: Query, data: any): any
     if IS_SERVER then
-        error ("[Lync] query:request is client-only. Use query:requestFrom on server")
+        error("[Lync] query:request is client-only. Use query:requestFrom on server")
     end
 
-    local correlation = allocCorrelation ()
-    local thread = coroutine.running ()
+    local correlation = allocCorrelation()
+    local thread = coroutine.running()
     local entry: PendingQuery = { thread = thread, timeout = nil }
     _pending[correlation] = entry
 
-    Client.writeQuery (self._reqReg.id, self._name, correlation, self._reqReg.codec, data)
+    Client.writeQuery(self._reqReg.id, self._name, correlation, self._reqReg.codec, data)
 
-    entry.timeout = task.delay (self._timeout, onTimeout, correlation)
-    return coroutine.yield ()
+    entry.timeout = task.delay(self._timeout, onTimeout, correlation)
+    return coroutine.yield()
 end
 
 -- Server: send request to one player, yield until response.
-function QueryImpl.requestFrom (self: any, player: Player, data: any): any
+function QueryImpl.requestFrom(self: Query, player: Player, data: any): any
     if not IS_SERVER then
-        error ("[Lync] query:requestFrom is server-only. Use query:request on client")
+        error("[Lync] query:requestFrom is server-only. Use query:request on client")
     end
 
-    local correlation = allocCorrelation ()
-    local thread = coroutine.running ()
+    local correlation = allocCorrelation()
+    local thread = coroutine.running()
     local entry: PendingQuery = { thread = thread, timeout = nil }
     _pending[correlation] = entry
 
-    Server.writeQuery (player, self._reqReg.id, self._name, correlation, self._reqReg.codec, data)
+    Server.writeQuery(player, self._reqReg.id, self._name, correlation, self._reqReg.codec, data)
 
-    entry.timeout = task.delay (self._timeout, onTimeout, correlation)
-    return coroutine.yield ()
+    entry.timeout = task.delay(self._timeout, onTimeout, correlation)
+    return coroutine.yield()
 end
 
 -- Server: send request to all players, yield until all respond or timeout.
-function QueryImpl.requestAll (self: any, data: any): { [Player]: any? }
-    local players = Players:GetPlayers ()
-    return requestMulti (self, players, data)
+function QueryImpl.requestAll(self: Query, data: any): { [Player]: any? }
+    return requestMulti(self, Players:GetPlayers(), data)
 end
 
 -- Server: send request to a list of players.
-function QueryImpl.requestList (self: any, players: { Player }, data: any): { [Player]: any? }
-    return requestMulti (self, players, data)
+function QueryImpl.requestList(self: Query, players: { Player }, data: any): { [Player]: any? }
+    return requestMulti(self, players, data)
 end
 
 -- Server: send request to all players in a group.
-function QueryImpl.requestGroup (self: any, group: any, data: any): { [Player]: any? }
-    local set = group:getSet ()
+function QueryImpl.requestGroup(self: Query, group: any, data: any): { [Player]: any? }
+    local set = group:getSet()
     local players = {} :: { Player }
     for player in set do
-        table.insert (players, player)
+        table.insert(players, player)
     end
-    return requestMulti (self, players, data)
+    return requestMulti(self, players, data)
 end
 
-table.freeze (QueryImpl)
+table.freeze(QueryImpl)
 
--- Public -------------------------------------------------------------
+-- Public --------------------------------------------------------------
 
-local Query = {}
+local QueryModule = {}
 
-function Query.define (name: string, config: QueryConfig<any, any>): any
+function QueryModule.define(name: string, config: QueryConfig<any, any>): Query
     if not config.request then
-        error (`[Lync] Query requires a request codec: "{name}"`)
+        error(`[Lync] Query requires a request codec: "{name}"`)
     end
     if not config.response then
-        error (`[Lync] Query requires a response codec: "{name}"`)
+        error(`[Lync] Query requires a response codec: "{name}"`)
     end
 
-    local reqSignal = Signal.create ()
-    local respSignal = Signal.create ()
+    local reqSignal = Signal.create()
+    local respSignal = Signal.create()
 
-    local reqReg, respReg = Registry.registerQueryPair (
+    local reqReg, respReg = Registry.registerQueryPair(
         name,
         config.request,
         config.response,
@@ -301,11 +307,11 @@ function Query.define (name: string, config: QueryConfig<any, any>): any
         config.validate
     )
 
-    respSignal:connect (function (resp: any, correlation: number): ()
-        completeQuery (correlation, resp)
+    respSignal:connect(function(resp: any, correlation: number): ()
+        completeQuery(correlation, resp)
     end)
 
-    return setmetatable ({
+    return setmetatable({
         _name = name,
         _reqReg = reqReg,
         _respReg = respReg,
@@ -314,8 +320,8 @@ function Query.define (name: string, config: QueryConfig<any, any>): any
 end
 
 -- Returns the number of queries currently awaiting a response.
-function Query.pendingCount (): number
+function QueryModule.pendingCount(): number
     return _activeCount
 end
 
-return table.freeze (Query)
+return table.freeze(QueryModule)