@quenty/cframeserializer 4.7.1 → 4.7.2

package/CHANGELOG.md

@@ -3,6 +3,17 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [4.7.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cframeserializer@4.7.1...@quenty/cframeserializer@4.7.2) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 ## [4.7.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/cframeserializer@4.7.0...@quenty/cframeserializer@4.7.1) (2025-03-21)
 
 **Note:** Version bump only for package @quenty/cframeserializer

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/cframeserializer",
-  "version": "4.7.1",
+  "version": "4.7.2",
   "description": "Optimized these functions for speed as well as preserving fidality. In the future, use Roblox's orthogonal angle format.",
   "keywords": [
     "Roblox",
@@ -28,8 +28,8 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/loader": "^10.8.0",
-    "@quenty/math": "^2.7.1"
+    "@quenty/loader": "^10.8.1",
+    "@quenty/math": "^2.7.2"
   },
-  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Shared/CFrameSerializer.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Optimized these functions for speed as well as preserving fidality.
 	In the future, use Roblox's orthogonal angle format.
@@ -16,24 +17,26 @@ local CFrameSerializer = {}
 local PRECISION = 10000
 local MULTIPLIER = 128
 
+export type SerializedCFrame = { number }
+
 --[=[
 	Outputs the rotation
 	@param cf CFrame
 	@return { number, number, number, number, number, number }
 ]=]
-function CFrameSerializer.outputRotationAzure(cf)
+function CFrameSerializer.outputRotationAzure(cf: CFrame): SerializedCFrame
 	local lookVector = cf.LookVector
 	local azumith = math.atan2(-lookVector.X, -lookVector.Z)
-	local ybase = (lookVector.X^2 + lookVector.Z^2)^0.5
+	local ybase = (lookVector.X ^ 2 + lookVector.Z ^ 2) ^ 0.5
 	local elevation = math.atan2(lookVector.Y, ybase)
 
 	local withoutRoll = CFrame.Angles(0, azumith, 0) * CFrame.Angles(elevation, 0, 0) + cf.Position
-	local _, _, roll = (withoutRoll:Inverse()*cf):ToEulerAnglesXYZ()
+	local _, _, roll = (withoutRoll:Inverse() * cf):ToEulerAnglesXYZ()
 
 	-- Atan2 -> in the range [-pi, pi]
-	azumith   = Math.round((azumith   /  math.pi   ) * PRECISION)
-	roll      = Math.round((roll      /  math.pi   ) * PRECISION)
-	elevation = Math.round((elevation / (math.pi/2)) * PRECISION)
+	azumith = Math.round((azumith / math.pi) * PRECISION)
+	roll = Math.round((roll / math.pi) * PRECISION)
+	elevation = Math.round((elevation / (math.pi / 2)) * PRECISION)
 
 	-- Buffer:WriteSigned(22, azumith)
 	-- Buffer:WriteSigned(21, roll)
@@ -43,7 +46,7 @@ function CFrameSerializer.outputRotationAzure(cf)
 	px = Math.round(px * MULTIPLIER)
 	py = Math.round(py * MULTIPLIER)
 	pz = Math.round(pz * MULTIPLIER)
-	return {px, py, pz, azumith, roll, elevation}
+	return { px, py, pz, azumith, roll, elevation }
 end
 
 --[=[
@@ -52,7 +55,7 @@ end
 	@param cf CFrame
 	@return string
 ]=]
-function CFrameSerializer.toJSONString(cf)
+function CFrameSerializer.toJSONString(cf: CFrame): string
 	return HttpService:JSONEncode(CFrameSerializer.outputRotationAzure(cf))
 end
 
@@ -62,7 +65,7 @@ end
 	@param data any
 	@return boolean
 ]=]
-function CFrameSerializer.isRotationAzure(data)
+function CFrameSerializer.isRotationAzure(data: any): boolean
 	return type(data) == "table"
 		and type(data[1]) == "number"
 		and type(data[2]) == "number"
@@ -78,7 +81,7 @@ end
 	@param str string
 	@return CFrame
 ]=]
-function CFrameSerializer.fromJSONString(str)
+function CFrameSerializer.fromJSONString(str: string): CFrame?
 	local decoded = HttpService:JSONDecode(str)
 	if CFrameSerializer.isRotationAzure(decoded) then
 		return CFrameSerializer.readRotationAzure(decoded)
@@ -92,17 +95,17 @@ end
 	@param data { number, number, number, number, number, number }
 	@return Vector3
 ]=]
-function CFrameSerializer.readPosition(data)
-	return Vector3.new(data[1]/MULTIPLIER, data[2]/MULTIPLIER, data[3]/MULTIPLIER)
+function CFrameSerializer.readPosition(data: SerializedCFrame): Vector3
+	return Vector3.new(data[1] / MULTIPLIER, data[2] / MULTIPLIER, data[3] / MULTIPLIER)
 end
 
 --[=[
 	Returns the CFrame
 
 	@param data { number, number, number, number, number, number }
-	@return Vector3
+	@return CFrame
 ]=]
-function CFrameSerializer.readRotationAzure(data)
+function CFrameSerializer.readRotationAzure(data: SerializedCFrame): CFrame
 	local azumith = data[4]
 	local roll = data[5] -- Buffer:ReadSigned(21)
 	local elevation = data[6] -- Buffer:ReadSigned(21)