@rbxts/tether 1.0.3 → 1.0.32

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -5,7 +5,7 @@ A message-based networking solution for Roblox with automatic binary serializati
5
5
  ```ts
6
6
  import { DataType } from "@rbxts/flamework-binary-serializer";
7
7
 
8
- export const messageEmitter = new MessageEmitter<Message, MessageData>;
8
+ export const messageEmitter = MessageEmitter.create<MessageData>();
9
9
  messageEmitter.initialize();
10
10
 
11
11
  export const enum Message {
@@ -18,8 +18,6 @@ export interface MessageData {
18
18
  readonly n: DataType.u8;
19
19
  };
20
20
  }
21
-
22
- messageEmitter.addSerializer<Message.TEST>(Message.TEST);
23
21
  ```
24
22
 
25
23
  > [!CAUTION]
package/out/index.d.ts CHANGED
@@ -2,17 +2,17 @@ import { Modding } from "@flamework/core";
2
2
  import { type SerializerMetadata } from "@rbxts/flamework-binary-serializer";
3
3
  type ClientMessageCallback<T = unknown> = (data: T) => void;
4
4
  type ServerMessageCallback<T = unknown> = (player: Player, data: T) => void;
5
- /** @metadata macro */
6
- export declare function createMessageEmitter<MessageData>(metaForEachMessage?: Modding.Many<{
7
- [Kind in keyof MessageData]: Modding.Many<SerializerMetadata<MessageData[Kind]>>;
8
- }>): MessageEmitter<MessageData> | undefined;
9
- declare class MessageEmitter<MessageData> {
5
+ export declare class MessageEmitter<MessageData> {
10
6
  private readonly clientCallbacks;
11
7
  private readonly serverCallbacks;
12
8
  private readonly serializers;
13
9
  private readonly serverEvents;
14
10
  private readonly clientEvents;
15
- constructor();
11
+ /** @metadata macro */
12
+ static create<MessageData>(metaForEachMessage?: Modding.Many<{
13
+ [Kind in keyof MessageData]: Modding.Many<SerializerMetadata<MessageData[Kind]>>;
14
+ }>): MessageEmitter<MessageData>;
15
+ private constructor();
16
16
  /** @metadata macro */
17
17
  addSerializer<Kind extends keyof MessageData>(message: Kind, meta?: Modding.Many<SerializerMetadata<MessageData[Kind]>>): void;
18
18
  initialize(): RBXScriptConnection;
package/out/init.luau CHANGED
@@ -1,20 +1,11 @@
1
1
  -- Compiled with roblox-ts v3.0.0
2
2
  local TS = _G[script]
3
+ local t = TS.import(script, TS.getModule(script, "@rbxts", "t").lib.ts).t
3
4
  local Networking = TS.import(script, TS.getModule(script, "@flamework", "networking").out).Networking
4
5
  local createBinarySerializer = TS.import(script, TS.getModule(script, "@rbxts", "flamework-binary-serializer").out).createBinarySerializer
5
6
  local RunService = TS.import(script, TS.getModule(script, "@rbxts", "services")).RunService
6
- local GlobalEvents = Networking.createEvent()
7
- --* @metadata macro
7
+ local GlobalEvents = Networking.createEvent("@rbxts/tether:init@GlobalEvents")
8
8
  local MessageEmitter
9
- local function createMessageEmitter(metaForEachMessage)
10
- if metaForEachMessage == nil then
11
- return nil
12
- end
13
- local emitter = MessageEmitter.new()
14
- for kind, meta in pairs(metaForEachMessage) do
15
- emitter:addSerializer(kind, meta)
16
- end
17
- end
18
9
  do
19
10
  MessageEmitter = setmetatable({}, {
20
11
  __tostring = function()
@@ -31,10 +22,66 @@ do
31
22
  self.serverCallbacks = {}
32
23
  self.serializers = {}
33
24
  if RunService:IsServer() then
34
- self.serverEvents = GlobalEvents:createServer({})
25
+ self.serverEvents = GlobalEvents:createServer({}, {
26
+ incomingIds = { "sendServerMessage", "sendUnreliableServerMessage" },
27
+ incoming = {
28
+ sendServerMessage = { { t.union(t.string, t.number), t.interface({
29
+ buffer = t.typeof("buffer"),
30
+ blobs = t.array(t.any),
31
+ }) }, nil },
32
+ sendUnreliableServerMessage = { { t.union(t.string, t.number), t.interface({
33
+ buffer = t.typeof("buffer"),
34
+ blobs = t.array(t.any),
35
+ }) }, nil },
36
+ },
37
+ incomingUnreliable = {
38
+ sendUnreliableServerMessage = true,
39
+ },
40
+ outgoingIds = { "sendClientMessage", "sendUnreliableClientMessage" },
41
+ outgoingUnreliable = {
42
+ sendUnreliableClientMessage = true,
43
+ },
44
+ namespaceIds = {},
45
+ namespaces = {},
46
+ })
35
47
  else
36
- self.clientEvents = GlobalEvents:createClient({})
48
+ self.clientEvents = GlobalEvents:createClient({}, {
49
+ incomingIds = { "sendClientMessage", "sendUnreliableClientMessage" },
50
+ incoming = {
51
+ sendClientMessage = { { t.union(t.string, t.number), t.interface({
52
+ buffer = t.typeof("buffer"),
53
+ blobs = t.array(t.any),
54
+ }) }, nil },
55
+ sendUnreliableClientMessage = { { t.union(t.string, t.number), t.interface({
56
+ buffer = t.typeof("buffer"),
57
+ blobs = t.array(t.any),
58
+ }) }, nil },
59
+ },
60
+ incomingUnreliable = {
61
+ sendUnreliableClientMessage = true,
62
+ },
63
+ outgoingIds = { "sendServerMessage", "sendUnreliableServerMessage" },
64
+ outgoingUnreliable = {
65
+ sendUnreliableServerMessage = true,
66
+ },
67
+ namespaceIds = {},
68
+ namespaces = {},
69
+ })
70
+ end
71
+ end
72
+ function MessageEmitter:create(metaForEachMessage)
73
+ if metaForEachMessage == nil then
74
+ warn("[Tether]: Failed to generate serializer metadata for MessageEmitter")
75
+ end
76
+ local emitter = MessageEmitter.new()
77
+ if metaForEachMessage == nil then
78
+ return emitter
79
+ end
80
+ for kind, meta in pairs(metaForEachMessage) do
81
+ print(kind, meta)
82
+ emitter:addSerializer(kind, meta)
37
83
  end
84
+ return emitter
38
85
  end
39
86
  function MessageEmitter:addSerializer(message, meta)
40
87
  self.serializers[message] = self:createMessageSerializer(meta)
@@ -162,5 +209,5 @@ do
162
209
  end
163
210
  end
164
211
  return {
165
- createMessageEmitter = createMessageEmitter,
212
+ MessageEmitter = MessageEmitter,
166
213
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@rbxts/tether",
3
- "version": "1.0.3",
3
+ "version": "1.0.32",
4
4
  "main": "out/init.lua",
5
5
  "scripts": {
6
6
  "build": "rbxtsc",
@@ -14,7 +14,7 @@
14
14
  "message"
15
15
  ],
16
16
  "repository": {
17
- "url": "https://github.com/R-unic/tether.git"
17
+ "url": "git+https://github.com/R-unic/tether.git"
18
18
  },
19
19
  "author": "runicly",
20
20
  "license": "ISC",
@@ -30,8 +30,9 @@
30
30
  "devDependencies": {
31
31
  "@rbxts/compiler-types": "^3.0.0-types.0",
32
32
  "@rbxts/types": "^1.0.835",
33
+ "rbxts-transformer-flamework": "latest",
33
34
  "roblox-ts": "^3.0.0",
34
- "typescript": "^5.7.3"
35
+ "typescript": "^5.5.3"
35
36
  },
36
37
  "dependencies": {
37
38
  "@flamework/core": "^1.2.3",