Merge branch 'master' of https://github.com/ffrostflame/BridgeNet2

Author: ffrostfall

CHANGELOG.md

@@ -11,7 +11,7 @@ This project uses [semantic versioning](https://semver.org/spec/v2.0.0.html).
 ### Improvements
 - Type improvements
 
-## [version 0.5.3](incomplete): 7/31/2023
+## [version 0.5.3](https://github.com/ffrostflame/BridgeNet2/releases/tag/v0.5.3): 7/31/2023
 
 ### Added
 - A mock API for when BridgeNet2 is ran in edit mode. Limitations: InvokeServerAsync will infinitely yield, connections will never run.

docs/Tutorials/Using Identifiers.md

@@ -32,7 +32,7 @@ local anotherThing = BridgeNet2.ReferenceIdentifier("anotherThing")
 
 sendSomeData:Fire({
 	[firstThingToSend] = 5,
-	[anotherThingToSend] = false,
+	[anotherThing] = false,
 })
 ```
-At the cost of 2 lines of code, we completely solved the problem! Our code is now both readable and efficient.
+At the cost of 2 lines of code, we completely solved the problem! Our code is now both readable and efficient.

sourcemap.json

@@ -1 +1 @@
-{"name":"bridgenet2-test","className":"DataModel","filePaths":["testing.project.json"],"children":[{"name":"ReplicatedStorage","className":"ReplicatedStorage","children":[{"name":"Packages","className":"Folder","children":[{"name":"RemotePacketSizeCounter","className":"ModuleScript","filePaths":["Packages\\RemotePacketSizeCounter.lua"]},{"name":"TableKit","className":"ModuleScript","filePaths":["Packages\\TableKit.lua"]},{"name":"_Index","className":"Folder","children":[{"name":"[email protected]","className":"Folder","children":[{"name":"tablekit","className":"ModuleScript","filePaths":["Packages\\_Index\\[email protected]\\tablekit\\src\\init.luau","Packages\\_Index\\[email protected]\\tablekit\\default.project.json"]}]},{"name":"[email protected]","className":"Folder","children":[{"name":"remotepacketsizecounter","className":"ModuleScript","filePaths":["Packages\\_Index\\[email protected]\\remotepacketsizecounter\\src\\init.luau","Packages\\_Index\\[email protected]\\remotepacketsizecounter\\default.project.json"]}]}]},{"name":"bridgenet2","className":"ModuleScript","filePaths":["src\\init.luau"],"children":[{"name":"Client","className":"ModuleScript","filePaths":["src\\Client\\init.luau"],"children":[{"name":"ClientBridge","className":"ModuleScript","filePaths":["src\\Client\\ClientBridge.luau"]},{"name":"ClientConnection","className":"ModuleScript","filePaths":["src\\Client\\ClientConnection.luau"]},{"name":"ClientIdentifiers","className":"ModuleScript","filePaths":["src\\Client\\ClientIdentifiers.luau"]},{"name":"ClientProcess","className":"ModuleScript","filePaths":["src\\Client\\ClientProcess.luau"]}]},{"name":"Constants","className":"ModuleScript","filePaths":["src\\Constants.luau"]},{"name":"PublicTypes","className":"ModuleScript","filePaths":["src\\PublicTypes.luau"]},{"name":"Server","className":"ModuleScript","filePaths":["src\\Server\\init.luau"],"children":[{"name":"HandleInvalidPlayer","className":"ModuleScript","filePaths":["src\\Server\\HandleInvalidPlayer.luau"]},{"name":"PlayerContainers","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\init.luau"],"children":[{"name":"All","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\All.luau"]},{"name":"Except","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\Except.luau"]},{"name":"Players","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\Players.luau"]},{"name":"Single","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\Single.luau"]}]},{"name":"ServerBridge","className":"ModuleScript","filePaths":["src\\Server\\ServerBridge.luau"]},{"name":"ServerConnection","className":"ModuleScript","filePaths":["src\\Server\\ServerConnection.luau"]},{"name":"ServerIdentifiers","className":"ModuleScript","filePaths":["src\\Server\\ServerIdentifiers.luau"]},{"name":"ServerProcess","className":"ModuleScript","filePaths":["src\\Server\\ServerProcess.luau"]}]},{"name":"Studio","className":"Folder","children":[{"name":"MockBridge","className":"ModuleScript","filePaths":["src\\Studio\\MockBridge.luau"]},{"name":"MockConnection","className":"ModuleScript","filePaths":["src\\Studio\\MockConnection.luau"]},{"name":"MockIdentifiers","className":"ModuleScript","filePaths":["src\\Studio\\MockIdentifiers.luau"]}]},{"name":"Types","className":"ModuleScript","filePaths":["src\\Types.luau"]},{"name":"Utilities","className":"Folder","children":[{"name":"NetworkUtils","className":"ModuleScript","filePaths":["src\\Utilities\\NetworkUtils.luau"]},{"name":"Output","className":"ModuleScript","filePaths":["src\\Utilities\\Output.luau"]},{"name":"RecycledSpawn","className":"ModuleScript","filePaths":["src\\Utilities\\RecycledSpawn.luau"]},{"name":"isEditMode","className":"ModuleScript","filePaths":["src\\Utilities\\isEditMode.luau"]},{"name":"tostringData","className":"ModuleScript","filePaths":["src\\Utilities\\tostringData.luau"]}]},{"name":"version","className":"ModuleScript","filePaths":["src\\version.luau"]}]}]},{"name":"benches","className":"Folder","children":[{"name":"Hex.bench","className":"ModuleScript","filePaths":["benchmarks\\Hex.bench.luau"]}]},{"name":"framework","className":"ModuleScript","filePaths":["testing/framework\\init.luau"],"children":[{"name":"bootstrapper","className":"ModuleScript","filePaths":["testing/framework\\bootstrapper.luau"]},{"name":"expect","className":"ModuleScript","filePaths":["testing/framework\\expect.luau"]}]}]},{"name":"ServerScriptService","className":"ServerScriptService","children":[{"name":"featureTests","className":"Script","filePaths":["testing/tests/server\\featureTests\\init.server.luau"]}]},{"name":"StarterPlayer","className":"StarterPlayer","children":[{"name":"StarterPlayerScripts","className":"StarterPlayerScripts","children":[{"name":"featureTests","className":"LocalScript","filePaths":["testing/tests/client\\featureTests\\init.client.luau"]}]}]}]}
+{"name":"bridgenet2-test","className":"DataModel","filePaths":["testing.project.json"],"children":[{"name":"ReplicatedStorage","className":"ReplicatedStorage","children":[{"name":"Packages","className":"Folder","children":[{"name":"RemotePacketSizeCounter","className":"ModuleScript","filePaths":["Packages\\RemotePacketSizeCounter.lua"]},{"name":"TableKit","className":"ModuleScript","filePaths":["Packages\\TableKit.lua"]},{"name":"_Index","className":"Folder","children":[{"name":"[email protected]","className":"Folder","children":[{"name":"tablekit","className":"ModuleScript","filePaths":["Packages\\_Index\\[email protected]\\tablekit\\src\\init.luau","Packages\\_Index\\[email protected]\\tablekit\\default.project.json"]}]},{"name":"[email protected]","className":"Folder","children":[{"name":"remotepacketsizecounter","className":"ModuleScript","filePaths":["Packages\\_Index\\[email protected]\\remotepacketsizecounter\\src\\init.luau","Packages\\_Index\\[email protected]\\remotepacketsizecounter\\default.project.json"]}]}]},{"name":"bridgenet2","className":"ModuleScript","filePaths":["src\\init.luau"],"children":[{"name":"Client","className":"ModuleScript","filePaths":["src\\Client\\init.luau"],"children":[{"name":"ClientBridge","className":"ModuleScript","filePaths":["src\\Client\\ClientBridge.luau"]},{"name":"ClientConnection","className":"ModuleScript","filePaths":["src\\Client\\ClientConnection.luau"]},{"name":"ClientIdentifiers","className":"Folder"},{"name":"ClientIdentifiers","className":"ModuleScript","filePaths":["src\\Client\\ClientIdentifiers.luau"]},{"name":"ClientProcess","className":"ModuleScript","filePaths":["src\\Client\\ClientProcess.luau"]}]},{"name":"Constants","className":"ModuleScript","filePaths":["src\\Constants.luau"]},{"name":"PublicTypes","className":"ModuleScript","filePaths":["src\\PublicTypes.luau"]},{"name":"Server","className":"ModuleScript","filePaths":["src\\Server\\init.luau"],"children":[{"name":"HandleInvalidPlayer","className":"ModuleScript","filePaths":["src\\Server\\HandleInvalidPlayer.luau"]},{"name":"PlayerContainers","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\init.luau"],"children":[{"name":"All","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\All.luau"]},{"name":"Except","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\Except.luau"]},{"name":"Players","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\Players.luau"]},{"name":"Single","className":"ModuleScript","filePaths":["src\\Server\\PlayerContainers\\Single.luau"]}]},{"name":"ServerBridge","className":"ModuleScript","filePaths":["src\\Server\\ServerBridge.luau"]},{"name":"ServerConnection","className":"ModuleScript","filePaths":["src\\Server\\ServerConnection.luau"]},{"name":"ServerIdentifiers","className":"ModuleScript","filePaths":["src\\Server\\ServerIdentifiers.luau"]},{"name":"ServerProcess","className":"ModuleScript","filePaths":["src\\Server\\ServerProcess.luau"]}]},{"name":"Studio","className":"Folder","children":[{"name":"MockBridge","className":"ModuleScript","filePaths":["src\\Studio\\MockBridge.luau"]},{"name":"MockConnection","className":"ModuleScript","filePaths":["src\\Studio\\MockConnection.luau"]},{"name":"MockIdentifiers","className":"ModuleScript","filePaths":["src\\Studio\\MockIdentifiers.luau"]}]},{"name":"Types","className":"ModuleScript","filePaths":["src\\Types.luau"]},{"name":"Utilities","className":"Folder","children":[{"name":"NetworkUtils","className":"ModuleScript","filePaths":["src\\Utilities\\NetworkUtils.luau"]},{"name":"Output","className":"ModuleScript","filePaths":["src\\Utilities\\Output.luau"]},{"name":"RecycledSpawn","className":"ModuleScript","filePaths":["src\\Utilities\\RecycledSpawn.luau"]},{"name":"isEditMode","className":"ModuleScript","filePaths":["src\\Utilities\\isEditMode.luau"]},{"name":"tostringData","className":"ModuleScript","filePaths":["src\\Utilities\\tostringData.luau"]}]},{"name":"version","className":"ModuleScript","filePaths":["src\\version.luau"]}]}]},{"name":"benches","className":"Folder","children":[{"name":"Hex.bench","className":"ModuleScript","filePaths":["benchmarks\\Hex.bench.luau"]}]},{"name":"framework","className":"ModuleScript","filePaths":["testing/framework\\init.luau"],"children":[{"name":"bootstrapper","className":"ModuleScript","filePaths":["testing/framework\\bootstrapper.luau"]},{"name":"expect","className":"ModuleScript","filePaths":["testing/framework\\expect.luau"]}]}]},{"name":"ServerScriptService","className":"ServerScriptService","children":[{"name":"featureTests","className":"Script","filePaths":["testing/tests/server\\featureTests\\init.server.luau"]}]},{"name":"StarterPlayer","className":"StarterPlayer","children":[{"name":"StarterPlayerScripts","className":"StarterPlayerScripts","children":[{"name":"featureTests","className":"LocalScript","filePaths":["testing/tests/client\\featureTests\\init.client.luau"]}]}]}]}

src/Client/ClientBridge.luau

@@ -9,6 +9,11 @@ local RemotePacketSizeCounter = require(script.Parent.Parent.Parent.RemotePacket
 local Types = require(script.Parent.Parent.Types)
 local tostringData = require(script.Parent.Parent.Utilities.tostringData)
 
+--[=[
+	This class handles the client-sided interface of BridgeNet2.
+
+	@class clientBridgePrototype
+]=]
 local clientBridgePrototype = {}
 
 local CLASS_METATABLE = { __index = clientBridgePrototype }
@@ -17,14 +22,31 @@ function CLASS_METATABLE:__tostring()
 	return "ClientBridge"
 end
 
+--[=[
+	Sets the rate limit, cannot be used client-sided.
+
+    @ignore
+	@return string
+]=]
 function clientBridgePrototype:RateLimit()
 	Output.warn("cannot call :RateLimit() from client")
 end
 
+--[=[
+	Disables the rate limit, cannot be used client-sided.
+
+    @ignore
+	@return string
+]=]
 function clientBridgePrototype:DisableRateLimit()
 	Output.warn("cannot call :DisableRateLimit() from client")
 end
 
+--[=[
+	Sets some middleware to run when a bridge is fired from the server. 
+
+    @param middlewareTable {(object: any) -> any}
+]=]
 function clientBridgePrototype:InboundMiddleware(middlewareTable: { (object: any) -> any })
 	Output.fatalAssert(tostring(self) == "ClientBridge", "InboundMiddleware called with . instead of :")
 	Output.fatalAssert(
@@ -36,6 +58,11 @@ function clientBridgePrototype:InboundMiddleware(middlewareTable: { (object: any
 	self._inboundMiddleware = middlewareTable
 end
 
+--[=[
+	Sets some middleware to run when a bridge is fired from the local client. 
+
+    @param middlewareTable {(object: any) -> any}
+]=]
 function clientBridgePrototype:OutboundMiddleware(middlewareTable: { (object: any) -> any })
 	Output.fatalAssert(tostring(self) == "ClientBridge", "OutboundMiddleware called with . instead of :")
 	Output.fatalAssert(
@@ -47,6 +74,11 @@ function clientBridgePrototype:OutboundMiddleware(middlewareTable: { (object: an
 	self._outboundMiddleware = middlewareTable
 end
 
+--[=[
+	Fires the bridge locally, which can then be recieved from the server along with packet data sent along.
+
+    @param content any
+]=]
 function clientBridgePrototype:Fire(content: any)
 	Output.fatalAssert(tostring(self) == "ClientBridge", "Fire called with . instead of :")
 
@@ -96,7 +128,13 @@ function clientBridgePrototype:Fire(content: any)
 	end
 end
 
-function clientBridgePrototype:Connect(callback: (content: Types.Content) -> (), name: string?): RBXScriptConnection
+--[=[
+	Connects the bridge to any events recieved from the server, this is when inbound middleware is ran. This shares identical behavior with [RemoteEvent.OnServerEvent:Connect].
+
+    @param callback (content: Types.Content) -> ()
+    @return RBXScriptConnection
+]=]
+function clientBridgePrototype:Connect(callback: (content: Types.Content) -> (), name: string?)
 	Output.fatalAssert(tostring(self) == "ClientBridge", "connect called with . instead of :")
 	Output.typecheck("function", "Connect", "callback", callback)
 
@@ -175,6 +213,12 @@ function clientBridgePrototype:Connect(callback: (content: Types.Content) -> (),
 	end)
 end
 
+--[=[
+	Connects the bridge to any events recieved from the server, this is when inbound middleware is ran. This shares identical behavior with [RemoteEvent.OnServerEvent:Wait].
+
+    @yields
+    @return any
+]=]
 function clientBridgePrototype:Wait()
 	Output.fatalAssert(tostring(self) == "ClientBridge", "Wait called with . instead of :")
 	-- Again, very basic QoL implementation of :Wait()
@@ -185,6 +229,14 @@ function clientBridgePrototype:Wait()
 	return coroutine.yield()
 end
 
+--[=[
+	Invokes the server, then returns a value afterwards. This function yields the thread until content is recieved.
+
+    @yields
+
+    @param content any
+    @return any
+]=]
 function clientBridgePrototype:InvokeServerAsync(content: any)
 	Output.fatalAssert(tostring(self) == "ClientBridge", "InvokeServerAsync called with . instead of :")
 	self:Fire({ ClientIdentifiers.ref("REQUEST", 3, false), content })
@@ -202,6 +254,12 @@ function clientBridgePrototype:InvokeServerAsync(content: any)
 	return coroutine.yield()
 end
 
+--[=[
+	Connects the bridge to any events recieved from the server, this is when inbound middleware is ran. This shares identical behavior with [clientBridgePrototype:Connect] with the difference being that the event instantly disconnects on recieved.
+
+    @param func (content: Types.Content) -> ()
+    @return RBXScriptConnection
+]=]
 function clientBridgePrototype:Once(func: (content: Types.Content) -> ())
 	Output.fatalAssert(tostring(self) == "ClientBridge", "Once called with . instead of :")
 	-- Instantly disconnects. Very basic QoL implementation
@@ -214,6 +272,9 @@ function clientBridgePrototype:Once(func: (content: Types.Content) -> ())
 	return connection
 end
 
+--[=[
+	Destroys the bridge it was called on.
+]=]
 function clientBridgePrototype:Destroy()
 	Output.fatalAssert(tostring(self) == "ClientBridge", "Destroy called with . instead of :")
 	-- Don't actually do any logic here- remember that ClientBridges are really just listening objects that let the end user communicate.

src/Client/ClientConnection.luau

@@ -28,5 +28,5 @@ return function(identifier, callback)
 
 	self._disconnectCallback = ClientProcess.connect(identifier, callback)
 
-	return (self :: unknown) :: RBXScriptConnection
+	return self :: unknown
 end