@rbxts/tether 1.0.0

package/README.md

@@ -0,0 +1,2 @@
+# Tether
+A message-based networking solution for Roblox with automatic binary serialization

package/out/index.d.ts

@@ -0,0 +1,26 @@
+import { Modding } from "@flamework/core";
+import { type SerializerMetadata } from "@rbxts/flamework-binary-serializer";
+type ClientMessageCallback<T = unknown> = (data: T) => void;
+type ServerMessageCallback<T = unknown> = (player: Player, data: T) => void;
+type BaseMessage = number | string;
+export declare class MessageEmitter<Message extends BaseMessage, MessageData extends Record<Message, unknown>> {
+    private readonly clientCallbacks;
+    private readonly serverCallbacks;
+    private readonly serializers;
+    private readonly serverEvents;
+    private readonly clientEvents;
+    constructor();
+    /** @metadata macro */
+    addSerializer<Kind extends Message>(message: Kind, meta?: Modding.Many<SerializerMetadata<MessageData[Kind]>>): void;
+    initialize(): RBXScriptConnection;
+    onServerMessage<Kind extends Message>(message: Kind, callback: ServerMessageCallback<MessageData[Kind]>): () => void;
+    onClientMessage<Kind extends Message>(message: Kind, callback: ClientMessageCallback<MessageData[Kind]>): () => void;
+    emitServer<Kind extends Message>(message: Kind, data: MessageData[Kind], unreliable?: boolean): void;
+    emitClient<Kind extends Message>(player: Player, message: Kind, data: MessageData[Kind], unreliable?: boolean): void;
+    emitAllClients<Kind extends Message>(message: Kind, data: MessageData[Kind], unreliable?: boolean): void;
+    private getPacket;
+    /** @metadata macro */
+    private createMessageSerializer;
+    private getSerializer;
+}
+export {};

package/out/init.luau

@@ -0,0 +1,156 @@
+-- Compiled with roblox-ts v3.0.0
+local TS = _G[script]
+local Networking = TS.import(script, TS.getModule(script, "@flamework", "networking").out).Networking
+local createBinarySerializer = TS.import(script, TS.getModule(script, "@rbxts", "flamework-binary-serializer").out).createBinarySerializer
+local RunService = TS.import(script, TS.getModule(script, "@rbxts", "services")).RunService
+local GlobalEvents = Networking.createEvent()
+local MessageEmitter
+do
+	MessageEmitter = setmetatable({}, {
+		__tostring = function()
+			return "MessageEmitter"
+		end,
+	})
+	MessageEmitter.__index = MessageEmitter
+	function MessageEmitter.new(...)
+		local self = setmetatable({}, MessageEmitter)
+		return self:constructor(...) or self
+	end
+	function MessageEmitter:constructor()
+		self.clientCallbacks = {}
+		self.serverCallbacks = {}
+		self.serializers = {}
+		if RunService:IsServer() then
+			self.serverEvents = GlobalEvents:createServer({})
+		else
+			self.clientEvents = GlobalEvents:createClient({})
+		end
+	end
+	function MessageEmitter:addSerializer(message, meta)
+		self.serializers[message] = self:createMessageSerializer(meta)
+	end
+	function MessageEmitter:initialize()
+		if RunService:IsClient() then
+			return self.clientEvents.sendClientMessage:connect(function(sentMessage, _param)
+				local buffer = _param.buffer
+				local blobs = _param.blobs
+				local _clientCallbacks = self.clientCallbacks
+				local _sentMessage = sentMessage
+				local _condition = _clientCallbacks[_sentMessage]
+				if _condition == nil then
+					_condition = {}
+				end
+				local messageCallbacks = _condition
+				if #messageCallbacks == 0 then
+					return nil
+				end
+				local serializer = self:getSerializer(sentMessage)
+				local data = serializer.deserialize(buffer, blobs)
+				for _, callback in messageCallbacks do
+					callback(data)
+				end
+			end)
+		else
+			return self.serverEvents.sendServerMessage:connect(function(player, sentMessage, _param)
+				local buffer = _param.buffer
+				local blobs = _param.blobs
+				local _serverCallbacks = self.serverCallbacks
+				local _sentMessage = sentMessage
+				local _condition = _serverCallbacks[_sentMessage]
+				if _condition == nil then
+					_condition = {}
+				end
+				local messageCallbacks = _condition
+				if #messageCallbacks == 0 then
+					return nil
+				end
+				local serializer = self:getSerializer(sentMessage)
+				local data = serializer.deserialize(buffer, blobs)
+				for _, callback in messageCallbacks do
+					callback(player, data)
+				end
+			end)
+		end
+	end
+	function MessageEmitter:onServerMessage(message, callback)
+		local _serverCallbacks = self.serverCallbacks
+		local _message = message
+		if not (_serverCallbacks[_message] ~= nil) then
+			local _serverCallbacks_1 = self.serverCallbacks
+			local _message_1 = message
+			_serverCallbacks_1[_message_1] = {}
+		end
+		local _serverCallbacks_1 = self.serverCallbacks
+		local _message_1 = message
+		local callbacks = _serverCallbacks_1[_message_1]
+		local _callback = callback
+		table.insert(callbacks, _callback)
+		local _serverCallbacks_2 = self.serverCallbacks
+		local _message_2 = message
+		_serverCallbacks_2[_message_2] = callbacks
+		return function()
+			local _callback_1 = callback
+			local _arg0 = (table.find(callbacks, _callback_1) or 0) - 1
+			return table.remove(callbacks, _arg0 + 1)
+		end
+	end
+	function MessageEmitter:onClientMessage(message, callback)
+		local _clientCallbacks = self.clientCallbacks
+		local _message = message
+		if not (_clientCallbacks[_message] ~= nil) then
+			local _clientCallbacks_1 = self.clientCallbacks
+			local _message_1 = message
+			_clientCallbacks_1[_message_1] = {}
+		end
+		local _clientCallbacks_1 = self.clientCallbacks
+		local _message_1 = message
+		local callbacks = _clientCallbacks_1[_message_1]
+		local _callback = callback
+		table.insert(callbacks, _callback)
+		local _clientCallbacks_2 = self.clientCallbacks
+		local _message_2 = message
+		_clientCallbacks_2[_message_2] = callbacks
+		return function()
+			local _callback_1 = callback
+			local _arg0 = (table.find(callbacks, _callback_1) or 0) - 1
+			return table.remove(callbacks, _arg0 + 1)
+		end
+	end
+	function MessageEmitter:emitServer(message, data, unreliable)
+		if unreliable == nil then
+			unreliable = false
+		end
+		local send = if unreliable then self.clientEvents.sendUnreliableServerMessage else self.clientEvents.sendServerMessage
+		send(message, self:getPacket(message, data))
+	end
+	function MessageEmitter:emitClient(player, message, data, unreliable)
+		if unreliable == nil then
+			unreliable = false
+		end
+		local send = if unreliable then self.serverEvents.sendUnreliableClientMessage else self.serverEvents.sendClientMessage
+		send(player, message, self:getPacket(message, data))
+	end
+	function MessageEmitter:emitAllClients(message, data, unreliable)
+		if unreliable == nil then
+			unreliable = false
+		end
+		local send = if unreliable then self.serverEvents.sendUnreliableClientMessage else self.serverEvents.sendClientMessage
+		send:broadcast(message, self:getPacket(message, data))
+	end
+	function MessageEmitter:getPacket(message, data, unreliable)
+		if unreliable == nil then
+			unreliable = false
+		end
+		local serializer = self:getSerializer(message)
+		return serializer.serialize(data)
+	end
+	function MessageEmitter:createMessageSerializer(meta)
+		return createBinarySerializer(meta)
+	end
+	function MessageEmitter:getSerializer(message)
+		return self.serializers[message]
+	end
+end
+return {
+	MessageEmitter = MessageEmitter,
+}

package/package.json

@@ -0,0 +1,42 @@
+{
+  "name": "@rbxts/tether",
+  "version": "1.0.0",
+  "main": "out/init.lua",
+  "scripts": {
+    "build": "rbxtsc",
+    "watch": "rbxtsc -w",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "roblox",
+    "tether",
+    "networking",
+    "message"
+  ],
+  "repository": {
+    "url": "https://github.com/R-unic/tether.git"
+  },
+  "author": "runicly",
+  "license": "ISC",
+  "description": "A message-based networking solution for Roblox with automatic binary serialization",
+  "types": "out/index.d.ts",
+  "files": [
+    "out",
+    "!**/*.tsbuildinfo"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "devDependencies": {
+    "@rbxts/compiler-types": "^3.0.0-types.0",
+    "@rbxts/types": "^1.0.835",
+    "roblox-ts": "^3.0.0",
+    "typescript": "^5.7.3"
+  },
+  "dependencies": {
+    "@flamework/core": "^1.2.3",
+    "@flamework/networking": "^1.2.3",
+    "@rbxts/flamework-binary-serializer": "^0.6.0",
+    "@rbxts/services": "^1.5.5"
+  }
+}