@rbxts/tether 1.2.5 → 1.2.7

package/out/builtin-middlewares.d.ts

@@ -2,7 +2,6 @@ import { Modding } from "@flamework/core";
 import type { SerializerMetadata } from "@rbxts/flamework-binary-serializer";
 import type { Any } from "ts-toolbelt";
 import { type SharedMiddleware } from "./middleware";
-import type { TetherPacket } from "./structs";
 export declare namespace BuiltinMiddlewares {
     /**
      * Creates a shared middleware that will simulate a ping of the given amount when a message is sent
@@ -39,5 +38,5 @@ export declare namespace BuiltinMiddlewares {
      * @returns A shared middleware that will log a message whenever a message is sent.
      * @metadata macro
      */
-    function debug<T>(schema?: Modding.Many<Any.Equals<T, unknown> extends 1 ? undefined : SerializerMetadata<TetherPacket<T>>>): SharedMiddleware<T>;
+    function debug<T>(schema?: Modding.Many<Any.Equals<T, unknown> extends 1 ? undefined : SerializerMetadata<T>>): SharedMiddleware<T>;
 }

package/out/builtin-middlewares.luau

@@ -93,20 +93,16 @@ do
 				local rawData = getRawData()
 				local bufferSize = buffer.len(rawData.buffer)
 				local blobsSize = #rawData.blobs * BLOB_SIZE
-				local schemaString = if schema ~= nil then " " .. table.concat(string.split(repr(schema[2], {
+				local schemaString = if schema ~= nil then " " .. table.concat(string.split(repr(schema[1], {
 					pretty = true,
 				}), "\n"), "\n ") else "unknown"
-				local text = { "\n", horizontalLine, "\n", "Packet sent to ", (if RunService:IsServer() then "client" else "server"), "!\n", " - Message: ", message, "\n", " - Data: ", if data == nil then "undefined" else data, "\n", " - Raw data:\n", "   - Buffer: ", bufferToString(rawData.buffer), "\n", "   - Blobs: ", repr(rawData.blobs, {
+				local text = { "\n", horizontalLine, "\n", "Packet sent to ", (if RunService:IsServer() then "client" else "server"), "!\n", " - Message: ", message, "\n", " - Data: ", repr(data, {
+					pretty = true,
+				}), "\n", " - Raw data:\n", "   - Buffer: ", bufferToString(rawData.buffer), "\n", "   - Blobs: ", repr(rawData.blobs, {
 					pretty = false,
 					robloxClassName = true,
 				}), "\n", " - Packet size: ", bufferSize + blobsSize, " bytes\n", "   - Buffer: ", bufferSize, " bytes\n", "   - Blobs: ", blobsSize, " bytes\n", " - Schema: ", schemaString, "\n", horizontalLine, "\n" }
-				-- ▼ ReadonlyArray.join ▼
-				local _result = table.create(#text)
-				for _k, _v in text do
-					_result[_k] = tostring(_v)
-				end
-				-- ▲ ReadonlyArray.join ▲
-				print(table.concat(_result, ""))
+				print(table.concat(text, ""))
 			end
 		end
 	end

package/out/message-emitter.luau

@@ -7,15 +7,15 @@ local _services = TS.import(script, TS.getModule(script, "@rbxts", "services"))
 local Players = _services.Players
 local RunService = _services.RunService
 local Destroyable = TS.import(script, TS.getModule(script, "@rbxts", "destroyable").out).default
+local repr = TS.import(script, TS.getModule(script, "@rbxts", "repr").out)
 local _middleware = TS.import(script, script.Parent, "middleware")
 local DropRequest = _middleware.DropRequest
 local MiddlewareProvider = _middleware.MiddlewareProvider
 -- TODO: error when trying to do something like server.emit() from the server
-local messageSerializer = createBinarySerializer({ "object_raw", { { "message", { "u8" } }, { "data", { "literal", {}, -1 } } } })
 local remotes = Networking.createEvent("@rbxts/tether:message-emitter@remotes")
 local metaGenerationFailed = "[@rbxts/tether]: Failed to generate message metadata - make sure you have the Flamework transformer and are using Flamework macro-friendly types in your schemas"
-local guardFailed = function(message)
-	return `[@rbxts/tether]: Type validation guard failed for message '{message}' - check your sent data`
+local guardFailed = function(message, data)
+	return `[@rbxts/tether]: Type validation guard failed for message '{message}' - check your sent data\nSent data: {repr(data)}`
 end
 local MessageEmitter
 do
@@ -300,10 +300,12 @@ do
 				incomingIds = { "sendServerMessage", "sendUnreliableServerMessage" },
 				incoming = {
 					sendServerMessage = { { t.interface({
+						messageBuffer = t.typeof("buffer"),
 						buffer = t.typeof("buffer"),
 						blobs = t.array(t.any),
 					}) }, nil },
 					sendUnreliableServerMessage = { { t.interface({
+						messageBuffer = t.typeof("buffer"),
 						buffer = t.typeof("buffer"),
 						blobs = t.array(t.any),
 					}) }, nil },
@@ -323,10 +325,12 @@ do
 				incomingIds = { "sendClientMessage", "sendUnreliableClientMessage" },
 				incoming = {
 					sendClientMessage = { { t.interface({
+						messageBuffer = t.typeof("buffer"),
 						buffer = t.typeof("buffer"),
 						blobs = t.array(t.any),
 					}) }, nil },
 					sendUnreliableClientMessage = { { t.interface({
+						messageBuffer = t.typeof("buffer"),
 						buffer = t.typeof("buffer"),
 						blobs = t.array(t.any),
 					}) }, nil },
@@ -355,7 +359,6 @@ do
 			local numberKind = tonumber(kind)
 			emitter.guards[numberKind] = guard
 			if serializerMetadata == nil then
-				emitter.serializers[numberKind] = messageSerializer
 				continue
 			end
 			emitter:addSerializer(numberKind, serializerMetadata)
@@ -368,7 +371,7 @@ do
 		local guard = _guards[_message]
 		local guardPassed = guard(data)
 		if not guardPassed then
-			warn(guardFailed(message))
+			warn(guardFailed(message, data))
 		end
 		return guardPassed
 	end
@@ -391,8 +394,10 @@ do
 		return self
 	end
 	function MessageEmitter:onRemoteFire(serializedPacket, player)
-		local _binding = messageSerializer.deserialize(serializedPacket.buffer, serializedPacket.blobs)
-		local message = _binding.message
+		if buffer.len(serializedPacket.messageBuffer) > 1 then
+			return warn("[@rbxts/tether]: Rejected message because message buffer was larger than one byte")
+		end
+		local message = buffer.readu8(serializedPacket.messageBuffer, 0)
 		self:executeEventCallbacks(message, serializedPacket, player)
 		self:executeFunctions(message, serializedPacket)
 	end
@@ -411,11 +416,7 @@ do
 		end
 		local packet = _packet
 		for callback in functions do
-			local _result = packet
-			if _result ~= nil then
-				_result = _result.data
-			end
-			callback(_result)
+			callback(packet)
 		end
 	end
 	function MessageEmitter:executeEventCallbacks(message, serializedPacket, player)
@@ -434,18 +435,9 @@ do
 		local packet = _packet
 		for callback in callbacks do
 			if isServer then
-				local _exp = player
-				local _result = packet
-				if _result ~= nil then
-					_result = _result.data
-				end
-				callback(_exp, _result)
+				callback(player, packet)
 			else
-				local _result = packet
-				if _result ~= nil then
-					_result = _result.data
-				end
-				callback(_result)
+				callback(packet)
 			end
 		end
 	end
@@ -484,17 +476,22 @@ do
 	end
 	function MessageEmitter:getPacket(message, data)
 		local serializer = self:getSerializer(message)
+		local messageBuffer = buffer.create(1)
+		buffer.writeu8(messageBuffer, 0, message)
 		if serializer == nil then
-			warn(`[@rbxts/tether]: Failed to get packet for message '{message}', no serializer was found`)
-			return messageSerializer.serialize({
-				message = message,
-				data = nil,
-			})
+			return {
+				messageBuffer = messageBuffer,
+				buffer = buffer.create(0),
+				blobs = {},
+			}
+		end
+		local _object = {
+			messageBuffer = messageBuffer,
+		}
+		for _k, _v in serializer.serialize(data) do
+			_object[_k] = _v
 		end
-		return serializer.serialize({
-			message = message,
-			data = data,
-		})
+		return _object
 	end
 	function MessageEmitter:addSerializer(message, meta)
 		self.serializers[message] = self:createMessageSerializer(meta)

package/out/structs.d.ts

@@ -1,6 +1,6 @@
 import { Modding } from "@flamework/core";
 import type { Networking } from "@flamework/networking";
-import type { DataType, SerializerMetadata } from "@rbxts/flamework-binary-serializer";
+import type { SerializerMetadata } from "@rbxts/flamework-binary-serializer";
 export type MessageCallback<T = unknown> = ServerMessageCallback<T> | ClientMessageCallback<T>;
 export type ClientMessageCallback<T = unknown> = (data: T) => void;
 export type ClientMessageFunctionCallback<T = unknown, R = unknown> = (data: T) => R;
@@ -8,13 +8,10 @@ export type ServerMessageCallback<T = unknown> = (player: Player, data: T) => vo
 export type ServerMessageFunctionCallback<T = unknown, R = unknown> = (player: Player, data: T) => R;
 export type BaseMessage = number;
 export interface SerializedPacket {
+    readonly messageBuffer: buffer;
     readonly buffer: buffer;
     readonly blobs: defined[];
 }
-export interface TetherPacket<Data> {
-    readonly message: DataType.u8;
-    readonly data: Data;
-}
 export type MessageEvent = (packet: SerializedPacket) => void;
 export type UnreliableMessageEvent = Networking.Unreliable<MessageEvent>;
 export interface ServerEvents {
@@ -27,7 +24,7 @@ export interface ClientEvents {
 }
 export interface MessageMetadata<MessageData, Kind extends keyof MessageData> {
     readonly guard: Modding.Generic<MessageData[Kind], "guard">;
-    readonly serializerMetadata: MessageData[Kind] extends undefined ? undefined : Modding.Many<SerializerMetadata<TetherPacket<MessageData[Kind]>>>;
+    readonly serializerMetadata: MessageData[Kind] extends undefined ? undefined : Modding.Many<SerializerMetadata<MessageData[Kind]>>;
 }
 export type Guard<T = unknown> = (value: unknown) => value is T;
 export type MessageEmitterMetadata<MessageData> = {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/tether",
-  "version": "1.2.5",
+  "version": "1.2.7",
   "main": "out/init.lua",
   "scripts": {
     "build": "rbxtsc",