@rbxts/tether 1.0.1 → 1.0.3

package/README.md

@@ -19,9 +19,12 @@ export interface MessageData {
   };
 }
 
-messageEmitter.addSerializer<Message.TOGGLE_MOVEMENT>(Message.TOGGLE_MOVEMENT);
+messageEmitter.addSerializer<Message.TEST>(Message.TEST);
 ```
 
+> [!CAUTION]
+> Every single message kind must implement an interface for it's data (in the example that would be the object with the `foo` and `bar` fields) as well as call `MessageEmitter.addSerializer()`. Messages will not work if you don't do this.
+
 ### Server
 ```ts
 import { Message, messageEmitter } from "shared/messaging";

package/out/index.d.ts

@@ -2,8 +2,11 @@ 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>> {
+/** @metadata macro */
+export declare function createMessageEmitter<MessageData>(metaForEachMessage?: Modding.Many<{
+    [Kind in keyof MessageData]: Modding.Many<SerializerMetadata<MessageData[Kind]>>;
+}>): MessageEmitter<MessageData> | undefined;
+declare class MessageEmitter<MessageData> {
     private readonly clientCallbacks;
     private readonly serverCallbacks;
     private readonly serializers;
@@ -11,13 +14,13 @@ export declare class MessageEmitter<Message extends BaseMessage, MessageData ext
     private readonly clientEvents;
     constructor();
     /** @metadata macro */
-    addSerializer<Kind extends Message>(message: Kind, meta?: Modding.Many<SerializerMetadata<MessageData[Kind]>>): void;
+    addSerializer<Kind extends keyof MessageData>(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;
+    onServerMessage<Kind extends keyof MessageData>(message: Kind, callback: ServerMessageCallback<MessageData[Kind]>): () => void;
+    onClientMessage<Kind extends keyof MessageData>(message: Kind, callback: ClientMessageCallback<MessageData[Kind]>): () => void;
+    emitServer<Kind extends keyof MessageData>(message: Kind, data: MessageData[Kind], unreliable?: boolean): void;
+    emitClient<Kind extends keyof MessageData>(player: Player, message: Kind, data: MessageData[Kind], unreliable?: boolean): void;
+    emitAllClients<Kind extends keyof MessageData>(message: Kind, data: MessageData[Kind], unreliable?: boolean): void;
     private getPacket;
     /** @metadata macro */
     private createMessageSerializer;

package/out/init.luau

@@ -4,7 +4,17 @@ local Networking = TS.import(script, TS.getModule(script, "@flamework", "network
 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()
+--* @metadata macro 
 local MessageEmitter
+local function createMessageEmitter(metaForEachMessage)
+	if metaForEachMessage == nil then
+		return nil
+	end
+	local emitter = MessageEmitter.new()
+	for kind, meta in pairs(metaForEachMessage) do
+		emitter:addSerializer(kind, meta)
+	end
+end
 do
 	MessageEmitter = setmetatable({}, {
 		__tostring = function()
@@ -152,5 +162,5 @@ do
 	end
 end
 return {
-	MessageEmitter = MessageEmitter,
+	createMessageEmitter = createMessageEmitter,
 }

package/package.json

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