Merge pull request #31 from maneetoo/master

Fixed Type Annotation for Client.Connect

docs/api/1.1/buffer.md

@@ -5,7 +5,7 @@ For efficient data serialization and schema definition with optimized packing.
 ## Getting the Buffer Object
 
 ```lua
-local Buffer = Warp.Buffer()
+local Buffer = Warp.Buffer
 ```
 
 ## Schema System <Badge type="tip" text="v1.1" />
@@ -35,6 +35,8 @@ Define strict data schemas for optimized serialization and type safety.
 	"buffer",
 	"vector2", -- f16 x/y
 	"vector3", -- f16 x/y/z
+	"vector2f32", -- f32 x/y
+	"vector3f32", -- f32 x/y/z
 	"vector2int16", -- i16 x/y
 	"vector3int16", -- i16 x/y/z
 	"cframe", -- f32 position + compressed rotation (f16)
@@ -81,7 +83,7 @@ there is no standalone `"nil"` schema type. To represent a value that can be `ni
 ```
 
 ```luau [Example]
-local Buffer = Warp.Buffer()
+local Buffer = Warp.Buffer
 
 -- # this custom datatype must be registered on both server & client side
 Buffer.Schema.custom_datatype("u64", {}, function(w: Buffer.Writer, value: any) -- just for reference
@@ -111,7 +113,7 @@ Create a new buffer writer for serializing data.
 ```
 
 ```luau [Example]
-local Buffer = Warp.Buffer()
+local Buffer = Warp.Buffer
 local writer = Buffer.createWriter(256) -- Pre-allocate 256 bytes
 ```
 :::
@@ -128,7 +130,7 @@ Build the final buffer for transmission.
 ```
 
 ```luau [Example]
-local Buffer = Warp.Buffer()
+local Buffer = Warp.Buffer
 local writer = Buffer.createWriter()
 
 -- Write some data
@@ -153,7 +155,7 @@ Build the final buffer with instance references for transmission.
 ```
 
 ```luau [Example]
-local Buffer = Warp.Buffer()
+local Buffer = Warp.Buffer
 local writer = Buffer.createWriter()
 
 -- Write some data with instances
@@ -178,7 +180,7 @@ Reset a writer for reuse, clearing all data.
 ```
 
 ```luau [Example]
-local Buffer = Warp.Buffer()
+local Buffer = Warp.Buffer
 local writer = Buffer.createWriter()
 
 -- Use writer for first batch

docs/api/1.1/server.md

@@ -20,7 +20,7 @@ this is optional and conditional, you may have to use this if you had a problem
 ```luau [Variable]
 (
 	namespaces: { string },
-) -> Connection
+)
 ```
 
 ```luau [Example]

docs/guide/example.md

@@ -40,6 +40,8 @@ local Players = game:GetService("Players")
 local Warp = require(path.to.warp).Client()
 local Schemas = require(path.to.schemas)
 
+Warp.awaitReady() -- this is optional, but recommended if facing any issues with race-condition, or remotes not registered
+
 -- Use schemas
 for eventName, schema in Schemas do
 	Warp.useSchema(eventName, schema)

pesde.toml

@@ -1,5 +1,5 @@
 name = "eternitydev/warp"
-version = "1.1.0-pre4"
+version = "1.1.0-pre7"
 description = "A rapidly-fast & powerful networking library."
 authors = ["eternitydev"]
 repository = "https://github.com/imezx/Warp"

src/Client/init.luau

@@ -9,8 +9,8 @@ local Replication = require("./Replication")
 local Xor = require("./Util/Xor")
 
 local RunService = game:GetService("RunService")
-local Event: RemoteEvent = script.Parent:WaitForChild("Event")
+local Event: RemoteEvent = script.Parent:WaitForChild("Event") :: RemoteEvent
-local UnreliableEvent: UnreliableRemoteEvent = script.Parent:WaitForChild("UnreliableEvent")
+local UnreliableEvent: UnreliableRemoteEvent = script.Parent:WaitForChild("UnreliableEvent") :: UnreliableRemoteEvent
 local deltaT: number, cycle: number = 0, 1 / 61
 local writer: Buffer.Writer = Buffer.createWriter()
 
@@ -51,7 +51,7 @@ end
 --@remoteName string
 --@fn function
 -- Connect to an event to receive incoming data from the server.
-Client.Connect = function(remoteName: string, fn: (Player, ...any?) -> ...any?): Connection
+Client.Connect = function(remoteName: string, fn: (...any?) -> ...any?): Connection
 	local id = Replication.get_id[remoteName]
 	if not id then
 		warn(`[Warp]: ".Connect"::"{remoteName}" does not exist, likely its not registered on the server yet.`)
@@ -176,8 +176,8 @@ if RunService:IsClient() then
 			local args = content[2]
 			if handleInvokes then
 				if remote == 0 then
-					local id = content[1]
+					local id = args[1]
-					local results = content[2]
+					local results = args[2]
 					local pending = pendingInvokes[id]
 					if pending then
 						task.spawn(pending :: any, table.unpack(results))
@@ -200,7 +200,7 @@ if RunService:IsClient() then
 			local connections = eventListeners[remote]
 			if connections then
 				for _, connection in connections do
-					Thread(connection.c, table.unpack(args))
+					Thread(connection.c :: any, table.unpack(args))
 				end
 			end
 		end

src/Replication/init.luau

@@ -14,7 +14,7 @@ local warp_identifier_registry = shared.__warp_identifier_registry
 if RunService:IsClient() or RunService:IsRunMode() then
 	local pending_id_yields, pending_name_yields, ready_yields = {}, {}, {}
 	local is_ready = false
-	
+
 	if RunService:IsClient() then
 		_repl.OnClientEvent:Connect(function(b: buffer)
 			if type(b) ~= "buffer" then
@@ -26,7 +26,7 @@ if RunService:IsClient() or RunService:IsRunMode() then
 				local id: number, remote: string = content[1], content[2]
 				warp_identifier_registry.cache[remote] = id
 				warp_identifier_registry.name[id] = remote
-				
+
 				if pending_id_yields[remote] then
 					for _, thread in pending_id_yields[remote] do
 						task.spawn(thread, id)
@@ -55,7 +55,6 @@ if RunService:IsClient() or RunService:IsRunMode() then
 	-- wait for the identifiers to be replicated from the server
 	Replication.wait_for_ready = function()
 		if is_ready then return end
-
 		local thread = coroutine.running()
 		table.insert(ready_yields, thread)
 		coroutine.yield()

src/Server/init.luau

@@ -11,9 +11,9 @@ local Xor = require("./Util/Xor")
 
 local Players = game:GetService("Players")
 local RunService = game:GetService("RunService")
-local Event: RemoteEvent = script.Parent:WaitForChild("Event")
+local Event: RemoteEvent = script.Parent:WaitForChild("Event") :: RemoteEvent
-local _repl: RemoteEvent = script.Parent:WaitForChild("_repl")
+local _repl: RemoteEvent = script.Parent:WaitForChild("_repl") :: RemoteEvent
-local UnreliableEvent: UnreliableRemoteEvent = script.Parent:WaitForChild("UnreliableEvent")
+local UnreliableEvent: UnreliableRemoteEvent = script.Parent:WaitForChild("UnreliableEvent") :: UnreliableRemoteEvent
 local deltaT: number, cycle: number = 0, 1 / 61
 local writer: Buffer.Writer = Buffer.createWriter()
 
@@ -182,7 +182,7 @@ Server.Invoke = function(remoteName: string, player: Player, timeout: number?, .
 	end
 	table.insert(queueEvent[player], {
 		0,
-		{ Identifier.get_id(remoteName), reqId :: any, { ... } :: any } :: any,
+		{ reqId :: any, { ... } :: any } :: any,
 	})
 	return coroutine.yield()
 end
@@ -217,7 +217,7 @@ if RunService:IsServer() then
 					continue
 				end
 				if remote == 0 then
-					if #eventListeners == 0 then
+					if not next(eventListeners) then
 						continue
 					end
 					local remoteName = d[1]
@@ -242,7 +242,7 @@ if RunService:IsServer() then
 			local connections = eventListeners[remote]
 			if connections then
 				for _, connection in connections do
-					Thread(connection.c, player, table.unpack(d))
+					Thread(connection.c :: any, player, table.unpack(d))
 				end
 			end
 		end

src/Util/Buffer/init.luau

@@ -50,7 +50,11 @@ local T_BUFFER = 0xDC
 local T_BOOL_ARR = 0xDD
 
 local T_VEC3 = 0xE0
+local T_VEC3F32 = 0xE1
+local T_VEC3I16 = 0xF1
 local T_VEC2 = 0xE2
+local T_VEC2F32 = 0xE3
+local T_VEC2I16 = 0xF4
 local T_CFRAME = 0xE4
 local T_COLOR3 = 0xE6
 local T_COLOR3_F = 0xE7
@@ -65,8 +69,6 @@ local T_NUMBERRANGE = 0xEF
 local T_RAY = 0xF0
 local T_COLSEQ = 0xF2
 local T_NUMSEQ = 0xF3
-local T_VEC3I16 = 0xF1
-local T_VEC2I16 = 0xF4
 local T_TWEENINFO = 0xF5
 local T_PHYSPROP = 0xF6
 local T_FONT = 0xF7
@@ -732,6 +734,14 @@ local function packVector3(w: Writer, v: Vector3)
 	rawF16(w, v.Z)
 end
 
+local function packVector3F32(w: Writer, v: Vector3)
+	ensureSpace(w, 13)
+	rawU8(w, T_VEC3F32)
+	rawF32(w, v.X)
+	rawF32(w, v.Y)
+	rawF32(w, v.Z)
+end
+
 local function packVector2(w: Writer, v: Vector2)
 	ensureSpace(w, 5)
 	rawU8(w, T_VEC2)
@@ -739,6 +749,13 @@ local function packVector2(w: Writer, v: Vector2)
 	rawF16(w, v.Y)
 end
 
+local function packVector2F32(w: Writer, v: Vector2)
+	ensureSpace(w, 9)
+	rawU8(w, T_VEC2F32)
+	rawF32(w, v.X)
+	rawF32(w, v.Y)
+end
+
 local function packCFrame(w: Writer, cf: CFrame)
 	local pos = cf.Position
 	local qi, q0, q1, q2 = compressCFrameRotation(cf)
@@ -796,10 +813,33 @@ PACK_DISPATCH["Vector3"] = function(w: Writer, v: any)
 	packVector3(w, v)
 end
 
+PACK_DISPATCH["Vector3F32"] = function(w: Writer, v: any)
+	packVector3F32(w, v)
+end
+
+PACK_DISPATCH["Vector3int16"] = function(w: Writer, v: any)
+	ensureSpace(w, 7)
+	rawU8(w, T_VEC3I16)
+	rawI16(w, v.X)
+	rawI16(w, v.Y)
+	rawI16(w, v.Z)
+end
+
 PACK_DISPATCH["Vector2"] = function(w: Writer, v: any)
 	packVector2(w, v)
 end
 
+PACK_DISPATCH["Vector2F32"] = function(w: Writer, v: any)
+	packVector2F32(w, v)
+end
+
+PACK_DISPATCH["Vector2int16"] = function(w: Writer, v: any)
+	ensureSpace(w, 5)
+	rawU8(w, T_VEC2I16)
+	rawI16(w, v.X)
+	rawI16(w, v.Y)
+end
+
 PACK_DISPATCH["CFrame"] = function(w: Writer, v: any)
 	packCFrame(w, v)
 end
@@ -924,21 +964,6 @@ PACK_DISPATCH["buffer"] = function(w: Writer, v: any)
 	w.cursor += len
 end
 
-PACK_DISPATCH["Vector3int16"] = function(w: Writer, v: any)
-	ensureSpace(w, 7)
-	rawU8(w, T_VEC3I16)
-	rawI16(w, v.X)
-	rawI16(w, v.Y)
-	rawI16(w, v.Z)
-end
-
-PACK_DISPATCH["Vector2int16"] = function(w: Writer, v: any)
-	ensureSpace(w, 5)
-	rawU8(w, T_VEC2I16)
-	rawI16(w, v.X)
-	rawI16(w, v.Y)
-end
-
 PACK_DISPATCH["TweenInfo"] = function(w: Writer, v: any)
 	ensureSpace(w, 16) -- tag(1) + f32(4) + u8(1) + u8(1) + i32(4) + u8(1) + f32(4)
 	rawU8(w, T_TWEENINFO)
@@ -1066,15 +1091,6 @@ UNPACK[T_F64 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number):
 	return buffer.readf64(buf, pos), pos + 8
 end
 
-UNPACK[T_VEC3I16 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
-	return Vector3int16.new(buffer.readi16(buf, pos), buffer.readi16(buf, pos + 2), buffer.readi16(buf, pos + 4)),
-		pos + 6
-end
-
-UNPACK[T_VEC2I16 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
-	return Vector2int16.new(buffer.readi16(buf, pos), buffer.readi16(buf, pos + 2)), pos + 4
-end
-
 UNPACK[T_TWEENINFO + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
 	return TweenInfo.new(
 		buffer.readf32(buf, pos),
@@ -1288,6 +1304,20 @@ UNPACK[T_VEC3 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number):
 	return Vector3.new(x, y, z), pos + 6
 end
 
+-- Vector3 float32
+UNPACK[T_VEC3F32 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
+	local x = buffer.readf32(buf, pos)
+	local y = buffer.readf32(buf, pos + 4)
+	local z = buffer.readf32(buf, pos + 8)
+	return Vector3.new(x, y, z), pos + 12
+end
+
+-- Vector3int16
+UNPACK[T_VEC3I16 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
+	return Vector3int16.new(buffer.readi16(buf, pos), buffer.readi16(buf, pos + 2), buffer.readi16(buf, pos + 4)),
+		pos + 6
+end
+
 -- Vector2
 UNPACK[T_VEC2 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
 	local x = readF16(buf, pos)
@@ -1295,6 +1325,18 @@ UNPACK[T_VEC2 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number):
 	return Vector2.new(x, y), pos + 4
 end
 
+-- Vector2 float32
+UNPACK[T_VEC2F32 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
+	local x = buffer.readf32(buf, pos)
+	local y = buffer.readf32(buf, pos + 4)
+	return Vector2.new(x, y), pos + 8
+end
+
+-- Vector2int16
+UNPACK[T_VEC2I16 + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
+	return Vector2int16.new(buffer.readi16(buf, pos), buffer.readi16(buf, pos + 2)), pos + 4
+end
+
 -- CFrame
 UNPACK[T_CFRAME + 1] = function(buf: buffer, pos: number, _: { any }?, _: number): (any, number)
 	local px = buffer.readf32(buf, pos)
@@ -1469,7 +1511,11 @@ Schema.f32 = { type = "f32" }
 Schema.f64 = { type = "f64" }
 Schema.boolean = { type = "boolean" }
 Schema.vector3 = { type = "vector3" }
+Schema.vector3f32 = { type = "vector3f32" }
+Schema.vector3int16 = { type = "vector3int16" }
 Schema.vector2 = { type = "vector2" }
+Schema.vector2f32 = { type = "vector2f32" }
+Schema.vector2int16 = { type = "vector2int16" }
 Schema.cframe = { type = "cframe" }
 Schema.color3 = { type = "color3" }
 Schema.color3f16 = { type = "color3f16" }
@@ -1484,8 +1530,6 @@ Schema.colorsequence = { type = "colorsequence" }
 Schema.numbersequence = { type = "numbersequence" }
 Schema.brickcolor = { type = "brickcolor" }
 Schema.buffer = { type = "buffer" }
-Schema.vector3int16 = { type = "vector3int16" }
-Schema.vector2int16 = { type = "vector2int16" }
 Schema.tweeninfo = { type = "tweeninfo" }
 Schema.physicalproperties = { type = "physicalproperties" }
 Schema.font = { type = "font" }
@@ -1544,7 +1588,11 @@ local SCHEMA_FIXED_SIZES: { [string]: number } = {
 	f64 = 8,
 	boolean = 1,
 	vector3 = 6,
+	vector3f32 = 12,
+	vector3int16 = 6,
 	vector2 = 4,
+	vector2f32 = 8,
+	vector2int16 = 4,
 	cframe = 19,
 	color3 = 3,
 	color3f16 = 6,
@@ -1554,8 +1602,6 @@ local SCHEMA_FIXED_SIZES: { [string]: number } = {
 	numberrange = 8,
 	ray = 24,
 	brickcolor = 2,
-	vector3int16 = 6,
-	vector2int16 = 4,
 	tweeninfo = 15,
 	physicalproperties = 20,
 	datetime = 8,
@@ -1637,7 +1683,6 @@ local function compilePacker(s: SchemaType): (Writer, any) -> ()
 			rawString(w, v, len)
 		end
 	end
-
 	if schema_type == "vector3" then
 		return function(w: Writer, v: any)
 			ensureSpace(w, 6)
@@ -1646,6 +1691,14 @@ local function compilePacker(s: SchemaType): (Writer, any) -> ()
 			rawF16(w, v.Z)
 		end
 	end
+	if schema_type == "vector3f32" then
+		return function(w: Writer, v: any)
+			ensureSpace(w, 12)
+			rawF32(w, v.X)
+			rawF32(w, v.Y)
+			rawF32(w, v.Z)
+		end
+	end
 	if schema_type == "vector2" then
 		return function(w: Writer, v: any)
 			ensureSpace(w, 4)
@@ -1653,6 +1706,13 @@ local function compilePacker(s: SchemaType): (Writer, any) -> ()
 			rawF16(w, v.Y)
 		end
 	end
+	if schema_type == "vector2f32" then
+		return function(w: Writer, v: any)
+			ensureSpace(w, 8)
+			rawF32(w, v.X)
+			rawF32(w, v.Y)
+		end
+	end
 
 	if schema_type == "cframe" then
 		return function(w: Writer, v: any)
@@ -2084,6 +2144,14 @@ local function compileReader(s: SchemaType): (buffer, number, { any }?) -> (any,
 			return Vector3.new(x, y, z), c + 6
 		end
 	end
+	if schema_type == "vector3f32" then
+		return function(b: buffer, c: number)
+			local x = buffer.readf32(b, c)
+			local y = buffer.readf32(b, c + 4)
+			local z = buffer.readf32(b, c + 8)
+			return Vector3.new(x, y, z), c + 12
+		end
+	end
 	if schema_type == "vector2" then
 		return function(b: buffer, c: number)
 			local x = readF16(b, c)
@@ -2091,6 +2159,13 @@ local function compileReader(s: SchemaType): (buffer, number, { any }?) -> (any,
 			return Vector2.new(x, y), c + 4
 		end
 	end
+	if schema_type == "vector2f32" then
+		return function(b: buffer, c: number)
+			local x = buffer.readf32(b, c)
+			local y = buffer.readf32(b, c + 4)
+			return Vector2.new(x, y), c + 8
+		end
+	end
 	if schema_type == "color3" then
 		return function(b: buffer, c: number)
 			local r = buffer.readu8(b, c)

src/Util/Identifier.luau

@@ -1,8 +1,8 @@
 --!optimize 2
 --!strict
 --@EternityDev
-local BITS: number = 8
+const BITS: number = 8
-local MAX_VALUE: number = bit32.lshift(1, BITS) - 1
+const MAX_VALUE: number = bit32.lshift(1, BITS) - 1
 local hook_fn: (string, number) -> ()
 
 if not shared.__warp_identifier_registry then

src/Util/Xor.luau

@@ -10,17 +10,27 @@ local clientPrev: { [Player]: XorEntry } = {}
 
 local clientOutPrev: XorEntry? = nil
 local clientInPrev: XorEntry? = nil
+const MAX_BUFFER_SIZE: number = 1024
 
-local function xorApply(current: buffer, curLen: number, prev: buffer, prevLen: number): buffer
+local function xorApply(
+	current: buffer, curLen: number,
+	prev: buffer, prevLen: number
+): buffer
 	local out = buffer.create(curLen)
 	local common = if curLen < prevLen then curLen else prevLen
 
 	local wordEnd = (common // 4) * 4
 	for off = 0, wordEnd - 4, 4 do
-		buffer.writeu32(out, off, bit32.bxor(buffer.readu32(current, off), buffer.readu32(prev, off)))
+		buffer.writeu32(
+			out, off,
+			bit32.bxor(buffer.readu32(current, off), buffer.readu32(prev, off))
+		)
 	end
 	for i = wordEnd, common - 1 do
-		buffer.writeu8(out, i, bit32.bxor(buffer.readu8(current, i), buffer.readu8(prev, i)))
+		buffer.writeu8(
+			out, i,
+			bit32.bxor(buffer.readu8(current, i), buffer.readu8(prev, i))
+		)
 	end
 
 	if curLen > common then
@@ -30,10 +40,13 @@ local function xorApply(current: buffer, curLen: number, prev: buffer, prevLen:
 end
 
 local function storeEntry(entry: XorEntry?, src: buffer, len: number): XorEntry
-	local e: XorEntry = entry or { buf = buffer.create(len > 64 and len or 64), len = 0 }
+	local e: XorEntry = entry or { buf = buffer.create(math.max(len, 64)), len = 0 }
+	local cap = buffer.len(e.buf)
 
-	if buffer.len(e.buf) < len then
+	if cap < len then
-		e.buf = buffer.create(len * 2)
+		e.buf = buffer.create(math.min(len * 2, MAX_BUFFER_SIZE + len))
+	elseif cap > len * 4 and cap > 128 then
+		e.buf = buffer.create(math.max(len, 64))
 	end
 
 	buffer.copy(e.buf, 0, src, 0, len)

wally.toml

@@ -1,6 +1,6 @@
 [package]
 name = "imezx/warp"
-version = "1.1.0-pre4"
+version = "1.1.0-pre7"
 registry = "https://github.com/UpliftGames/wally-index"
 realm = "shared"
 license = "MIT"