@rbxts/tether 1.4.14 → 1.4.16

package/out/emitters/message-emitter.d.ts

@@ -7,6 +7,7 @@ import { ServerEmitter } from "./server-emitter";
 import { ClientEmitter } from "./client-emitter";
 import { Relayer } from "../relayer";
 import { Serdes } from "../serdes";
+import { SerializerMetadata } from "@rbxts/serio";
 export interface MessageEmitterOptions<MessageData> {
     readonly batchRemotes: boolean;
     readonly batchRate: number;
@@ -34,6 +35,11 @@ export declare class MessageEmitter<MessageData> extends Destroyable {
     runServerSendMiddlewares<Kind extends keyof MessageData>(message: Kind & BaseMessage, data?: MessageData[Kind]): [boolean, MessageData[Kind]];
     /** @hidden */
     onRemoteFire(isServer: boolean, serializedPackets: SerializedPacket[], player?: Player): void;
+    /**
+     * Note: Will only work for literal message types, where `MessageData[Kind]` can be exactly inferred
+     * @metadata macro
+     */
+    getSchema<Kind extends keyof MessageData>(message: Kind & BaseMessage, meta?: Modding.Many<SerializerMetadata<MessageData[Kind]>>): SerializerMetadata<MessageData[Kind]>;
     private runServerReceiveMiddlewares;
     private runClientReceiveMiddlewares;
     private validateData;

package/out/emitters/message-emitter.luau

@@ -167,6 +167,9 @@ do
 			self:executeFunctions(isServer, message, packet)
 		end
 	end
+	function MessageEmitter:getSchema(message, meta)
+		return self.serdes:getSchema(message, meta)
+	end
 	function MessageEmitter:runServerReceiveMiddlewares(message, player, data)
 		local ctx = {
 			message = message,

package/out/serdes.d.ts

@@ -3,11 +3,13 @@ import type { Serializer, SerializerMetadata } from "@rbxts/serio";
 import type { BaseMessage, SerializedPacket } from "./structs";
 export declare class Serdes<MessageData> {
     serializers: Partial<Record<keyof MessageData, Serializer<MessageData[keyof MessageData]>>>;
+    /** @metadata macro */
+    getSchema<Kind extends keyof MessageData>(message: Kind & BaseMessage, meta?: Modding.Many<SerializerMetadata<MessageData[Kind]>>): SerializerMetadata<MessageData[Kind]>;
     serializePacket<Kind extends keyof MessageData>(message: Kind & BaseMessage, data?: MessageData[Kind]): SerializedPacket;
     deserializePacket<K extends keyof MessageData>(message: K & BaseMessage, serializedPacket: SerializedPacket): MessageData[K] | undefined;
     /** @metadata macro */
     addSerializer<K extends keyof MessageData>(message: K & BaseMessage, meta?: Modding.Many<SerializerMetadata<MessageData[K]>>): void;
     /** @metadata macro */
     createMessageSerializer<Kind extends keyof MessageData>(meta?: Modding.Many<SerializerMetadata<MessageData[Kind]>>): Serializer<MessageData[Kind]>;
-    getSerializer<Kind extends keyof MessageData>(message: Kind & BaseMessage): Serializer<MessageData[Kind] | undefined> | undefined;
+    getSerializer<Kind extends keyof MessageData>(message: Kind & BaseMessage): Serializer<MessageData[Kind]> | undefined;
 }

package/out/serdes.luau

@@ -17,6 +17,13 @@ do
 	function Serdes:constructor()
 		self.serializers = {}
 	end
+	function Serdes:getSchema(message, meta)
+		local serializer = self:getSerializer(message)
+		if serializer == nil then
+			error(`[@rbxts/tether]: Cannot get schema metadata for message '{message}', serializer not found`)
+		end
+		return serializer:getSchema(meta)
+	end
 	function Serdes:serializePacket(message, data)
 		local serializer = self:getSerializer(message)
 		local messageBuf = createMessageBuffer(message)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@rbxts/tether",
-  "version": "1.4.14",
+  "version": "1.4.16",
   "main": "out/init.luau",
   "scripts": {
     "setup-rokit": "rokit trust lune-org/lune && rokit trust rojo-rbx/rojo && rokit install",
@@ -32,7 +32,7 @@
   },
   "devDependencies": {
     "@rbxts/compiler-types": "^3.0.0-types.0",
-    "@rbxts/types": "^1.0.896",
+    "@rbxts/types": "^1.0.907",
     "rbxts-transformer-flamework": "^1.3.2",
     "roblox-ts": "^3.0.0",
     "ts-toolbelt": "^9.6.0",
@@ -44,7 +44,7 @@
     "@rbxts/flamework-meta-utils": "^1.0.7",
     "@rbxts/object-utils": "^1.0.4",
     "@rbxts/repr": "^1.0.3",
-    "@rbxts/serio": "^1.2.2",
+    "@rbxts/serio": "^1.2.4",
     "@rbxts/services": "^1.6.0",
     "@rbxts/trash": "^1.0.8"
   }