@quenty/influxdbclient 7.19.3 → 7.19.4-canary.559.339cfa7.0

package/CHANGELOG.md

@@ -3,6 +3,22 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [7.19.4-canary.559.339cfa7.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/influxdbclient@7.19.3...@quenty/influxdbclient@7.19.4-canary.559.339cfa7.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [7.19.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/influxdbclient@7.19.2...@quenty/influxdbclient@7.19.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/influxdbclient

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/influxdbclient",
-  "version": "7.19.3",
+  "version": "7.19.4-canary.559.339cfa7.0",
   "description": "Provides a Roblox Lua InfluxDB client",
   "keywords": [
     "Roblox",
@@ -25,22 +25,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/httppromise": "^10.10.4",
-    "@quenty/jsonutils": "^10.10.4",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/math": "^2.7.3",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/rx": "^13.17.3",
-    "@quenty/servicebag": "^11.11.4",
-    "@quenty/signal": "^7.10.3",
-    "@quenty/string": "^3.3.3",
-    "@quenty/table": "^3.7.4",
-    "@quenty/valueobject": "^13.17.3"
+    "@quenty/baseobject": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/httppromise": "10.10.5-canary.559.339cfa7.0",
+    "@quenty/jsonutils": "10.10.5-canary.559.339cfa7.0",
+    "@quenty/loader": "10.8.4-canary.559.339cfa7.0",
+    "@quenty/maid": "3.4.4-canary.559.339cfa7.0",
+    "@quenty/math": "2.7.3",
+    "@quenty/promise": "10.10.5-canary.559.339cfa7.0",
+    "@quenty/rx": "13.17.4-canary.559.339cfa7.0",
+    "@quenty/servicebag": "11.11.5-canary.559.339cfa7.0",
+    "@quenty/signal": "7.10.4-canary.559.339cfa7.0",
+    "@quenty/string": "3.3.3",
+    "@quenty/table": "3.7.5-canary.559.339cfa7.0",
+    "@quenty/valueobject": "13.17.4-canary.559.339cfa7.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "339cfa778736f08768ed7305041f6221faa35bfc"
 }

package/src/Server/Config/InfluxDBClientConfigUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class InfluxDBClientConfigUtils
 ]=]
@@ -31,9 +32,9 @@ function InfluxDBClientConfigUtils.createClientConfig(config: InfluxDBClientConf
 	assert(InfluxDBClientConfigUtils.isClientConfig(config), "Bad config")
 
 	return {
-		url = config.url;
-		token = config.token;
+		url = config.url,
+		token = config.token,
 	}
 end
 
-return InfluxDBClientConfigUtils
+return InfluxDBClientConfigUtils

package/src/Server/Config/InfluxDBPointSettings.lua

@@ -1,4 +1,7 @@
+--!strict
 --[=[
+	Holds settings for the InfluxDB point API
+
 	@class InfluxDBPointSettings
 ]=]
 
@@ -7,10 +10,23 @@ InfluxDBPointSettings.ClassName = "InfluxDBPointSettings"
 InfluxDBPointSettings.__index = InfluxDBPointSettings
 
 export type InfluxDBTags = { [string]: string }
-export type ConvertTime = (number) -> number
+export type ConvertTime = ((DateTime | number | string)?) -> number
+
+export type InfluxDBPointSettings = typeof(setmetatable(
+	{} :: {
+		_defaultTags: InfluxDBTags,
+		_convertTime: ConvertTime?,
+	},
+	{} :: typeof({ __index = InfluxDBPointSettings })
+))
 
-function InfluxDBPointSettings.new()
-	local self = setmetatable({}, InfluxDBPointSettings)
+--[=[
+	Creates a new InfluxDB point settings
+
+	@return InfluxDBPointSettings
+]=]
+function InfluxDBPointSettings.new(): InfluxDBPointSettings
+	local self: InfluxDBPointSettings = setmetatable({} :: any, InfluxDBPointSettings)
 
 	self._defaultTags = {}
 	self._convertTime = nil :: ConvertTime?
@@ -18,7 +34,12 @@ function InfluxDBPointSettings.new()
 	return self
 end
 
-function InfluxDBPointSettings:SetDefaultTags(tags: InfluxDBTags)
+--[=[
+	Sets the default tags for the InfluxDB point settings
+
+	@param tags InfluxDBTags
+]=]
+function InfluxDBPointSettings.SetDefaultTags(self: InfluxDBPointSettings, tags: InfluxDBTags): ()
 	assert(type(tags) == "table", "Bad tags")
 
 	for key, value in tags do
@@ -29,19 +50,33 @@ function InfluxDBPointSettings:SetDefaultTags(tags: InfluxDBTags)
 	self._defaultTags = tags
 end
 
-function InfluxDBPointSettings:GetDefaultTags(): InfluxDBTags
+--[=[
+	Gets the default tags for the InfluxDB point settings
+
+	@return InfluxDBTags
+]=]
+function InfluxDBPointSettings.GetDefaultTags(self: InfluxDBPointSettings): InfluxDBTags
 	return self._defaultTags
 end
 
-function InfluxDBPointSettings:SetConvertTime(convertTime: ConvertTime?)
+--[=[
+	Sets the conversion time function for the InfluxDB point settings
+
+	@param convertTime (number) -> number
+]=]
+function InfluxDBPointSettings.SetConvertTime(self: InfluxDBPointSettings, convertTime: ConvertTime?)
 	assert(type(convertTime) == "function" or convertTime == nil, "Bad convertTime")
 
 	self._convertTime = convertTime
 end
 
-function InfluxDBPointSettings:GetConvertTime(): ConvertTime?
+--[=[
+	Gets the conversion time function for the InfluxDB point settings
+
+	@return (number) -> number
+]=]
+function InfluxDBPointSettings.GetConvertTime(self: InfluxDBPointSettings): ConvertTime?
 	return self._convertTime
 end
 
-
-return InfluxDBPointSettings
+return InfluxDBPointSettings

package/src/Server/Config/InfluxDBWriteOptionUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class InfluxDBWriteOptionUtils
 ]=]
@@ -41,14 +42,14 @@ function InfluxDBWriteOptionUtils.isWriteOptions(options: any): boolean
 		and type(options.batchSize) == "number"
 		and type(options.maxBatchBytes) == "number"
 		and type(options.flushIntervalSeconds) == "number"
-		-- and type(options.maxRetries) == "number"
-		-- and type(options.maxRetryTimeSeconds) == "number"
-		-- and type(options.maxBufferLines) == "number"
-		-- and type(options.retryJitterSeconds) == "number"
-		-- and type(options.minRetryDelaySeconds) == "number"
-		-- and type(options.maxRetryDelaySeconds) == "number"
-		-- and type(options.exponentialBase) == "number"
-		-- and type(options.randomRetry) == "boolean"
+	-- and type(options.maxRetries) == "number"
+	-- and type(options.maxRetryTimeSeconds) == "number"
+	-- and type(options.maxBufferLines) == "number"
+	-- and type(options.retryJitterSeconds) == "number"
+	-- and type(options.minRetryDelaySeconds) == "number"
+	-- and type(options.maxRetryDelaySeconds) == "number"
+	-- and type(options.exponentialBase) == "number"
+	-- and type(options.randomRetry) == "boolean"
 end
 
-return InfluxDBWriteOptionUtils
+return InfluxDBWriteOptionUtils

package/src/Server/InfluxDBClient.lua

@@ -1,4 +1,8 @@
+--!strict
 --[=[
+	Client to write InfluxDB points to the server.
+
+	@server
 	@class InfluxDBClient
 ]=]
 
@@ -7,16 +11,32 @@ local require = require(script.Parent.loader).load(script)
 local BaseObject = require("BaseObject")
 local InfluxDBClientConfigUtils = require("InfluxDBClientConfigUtils")
 local InfluxDBWriteAPI = require("InfluxDBWriteAPI")
-local ValueObject = require("ValueObject")
 local Maid = require("Maid")
+local Promise = require("Promise")
 local PromiseUtils = require("PromiseUtils")
+local ValueObject = require("ValueObject")
 
 local InfluxDBClient = setmetatable({}, BaseObject)
 InfluxDBClient.ClassName = "InfluxDBClient"
 InfluxDBClient.__index = InfluxDBClient
 
-function InfluxDBClient.new(clientConfig)
-	local self = setmetatable(BaseObject.new(), InfluxDBClient)
+export type InfluxDBClient = typeof(setmetatable(
+	{} :: {
+		_clientConfig: ValueObject.ValueObject<InfluxDBClientConfigUtils.InfluxDBClientConfig>,
+		_writeApis: { [string]: { [string]: InfluxDBWriteAPI.InfluxDBWriteAPI } },
+		_flushAllPromises: Promise.Promise<()>,
+	},
+	{} :: typeof({ __index = InfluxDBClient })
+)) & BaseObject.BaseObject
+
+--[=[
+	Creates a new InfluxDB client
+
+	@param clientConfig InfluxDBClientConfig?
+	@return InfluxDBClient
+]=]
+function InfluxDBClient.new(clientConfig: InfluxDBClientConfigUtils.InfluxDBClientConfig?): InfluxDBClient
+	local self: InfluxDBClient = setmetatable(BaseObject.new() :: any, InfluxDBClient)
 
 	self._clientConfig = self._maid:Add(ValueObject.new(nil))
 
@@ -29,13 +49,26 @@ function InfluxDBClient.new(clientConfig)
 	return self
 end
 
-function InfluxDBClient:SetClientConfig(clientConfig)
+--[=[
+	Sets the client config for this client
+
+	@param clientConfig InfluxDBClientConfig
+]=]
+function InfluxDBClient.SetClientConfig(
+	self: InfluxDBClient,
+	clientConfig: InfluxDBClientConfigUtils.InfluxDBClientConfig
+)
 	assert(InfluxDBClientConfigUtils.isClientConfig(clientConfig), "Bad clientConfig")
 
 	self._clientConfig.Value = InfluxDBClientConfigUtils.createClientConfig(clientConfig)
 end
 
-function InfluxDBClient:GetWriteAPI(org, bucket, precision)
+function InfluxDBClient.GetWriteAPI(
+	self: InfluxDBClient,
+	org: string,
+	bucket: string,
+	precision: string?
+): InfluxDBWriteAPI.InfluxDBWriteAPI
 	assert(self._clientConfig, "No self._clientConfig")
 	assert(type(org) == "string", "Bad org")
 	assert(type(bucket) == "string", "Bad bucket")
@@ -75,20 +108,25 @@ function InfluxDBClient:GetWriteAPI(org, bucket, precision)
 	return writeAPI
 end
 
-function InfluxDBClient:PromiseFlushAll()
+--[=[
+	Flushes all write APIs. Returns a promise that resolves when all write APIs are flushed for all buckets.
+
+	@return Promise<()>
+]=]
+function InfluxDBClient.PromiseFlushAll(self: InfluxDBClient): Promise.Promise<()>
 	if self._flushAllPromises and self._flushAllPromises:IsPending() then
 		return self._flushAllPromises
 	end
 
 	local promises = {}
 	for _, bucketList in self._writeApis do
-		for _, writeAPI in bucketList do
+		for _, writeAPI: any in bucketList do
 			table.insert(promises, writeAPI:PromiseFlush())
 		end
 	end
 
 	self._flushAllPromises = PromiseUtils.all(promises)
-	return self._flushAllPromises
+	return self._flushAllPromises :: any
 end
 
-return InfluxDBClient
+return InfluxDBClient

package/src/Server/InfluxDBClient.story.lua

@@ -2,7 +2,8 @@
 	@class InfluxDBClient.story
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
 local InfluxDBClient = require("InfluxDBClient")
 local InfluxDBClientConfigUtils = require("InfluxDBClientConfigUtils")
@@ -13,8 +14,8 @@ return function(_target)
 	local maid = Maid.new()
 
 	local config = InfluxDBClientConfigUtils.createClientConfig({
-		url = "https://ingest.robloxanalytics.com/";
-		token = "test-api-key";
+		url = "https://ingest.robloxanalytics.com/",
+		token = "test-api-key",
 	})
 
 	local influxDBClient = InfluxDBClient.new(config)
@@ -33,7 +34,7 @@ return function(_target)
 	point:AddTag("place_id", tostring(game.PlaceId))
 	point:AddStringField("username", "Quenty")
 	point:AddIntField("userid", 4397833)
-	point:AddFloatField("fps", 30 + math.random()*30)
+	point:AddFloatField("fps", 30 + math.random() * 30)
 	point:AddBooleanField("is_alive", true)
 	point:AddBooleanField("is_silent", false)
 
@@ -48,4 +49,4 @@ return function(_target)
 	return function()
 		maid:DoCleaning()
 	end
-end
+end

package/src/Server/Utils/InfluxDBErrorUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class InfluxDBErrorUtils
 ]=]
@@ -6,6 +7,13 @@ local require = require(script.Parent.loader).load(script)
 
 local JSONUtils = require("JSONUtils")
 
+--[=[
+	InfluxDB error type.
+	@interface InfluxDBError
+	.code string
+	.message string
+	@within InfluxDBErrorUtils
+]=]
 export type InfluxDBError = {
 	code: string,
 	message: string,
@@ -13,6 +21,13 @@ export type InfluxDBError = {
 
 local InfluxDBErrorUtils = {}
 
+--[=[
+	Tries to parse the error body from InfluxDB.
+	Returns nil if it fails to parse.
+
+	@param body string
+	@return InfluxDBError?
+]=]
 function InfluxDBErrorUtils.tryParseErrorBody(body: string): InfluxDBError?
 	local ok, decoded, _err = JSONUtils.jsonDecode(body)
 	if not ok then
@@ -26,10 +41,14 @@ function InfluxDBErrorUtils.tryParseErrorBody(body: string): InfluxDBError?
 	end
 end
 
+--[=[
+	Checks if the given data is an InfluxDB error.
+
+	@param data any
+	@return boolean
+]=]
 function InfluxDBErrorUtils.isInfluxDBError(data: any): boolean
-	return type(data) == "table"
-		and type(data.code) == "string"
-		and type(data.message) == "string"
+	return type(data) == "table" and type(data.code) == "string" and type(data.message) == "string"
 end
 
-return InfluxDBErrorUtils
+return InfluxDBErrorUtils

package/src/Server/Write/InfluxDBWriteAPI.lua

@@ -1,4 +1,8 @@
+--!strict
 --[=[
+	InfluxDB API to write to the server.
+
+	@server
 	@class InfluxDBWriteAPI
 ]=]
 
@@ -7,6 +11,7 @@ local require = require(script.Parent.loader).load(script)
 local BaseObject = require("BaseObject")
 local HttpPromise = require("HttpPromise")
 local InfluxDBClientConfigUtils = require("InfluxDBClientConfigUtils")
+local InfluxDBErrorUtils = require("InfluxDBErrorUtils")
 local InfluxDBPoint = require("InfluxDBPoint")
 local InfluxDBPointSettings = require("InfluxDBPointSettings")
 local InfluxDBWriteBuffer = require("InfluxDBWriteBuffer")
@@ -14,14 +19,38 @@ local InfluxDBWriteOptionUtils = require("InfluxDBWriteOptionUtils")
 local Promise = require("Promise")
 local Signal = require("Signal")
 local ValueObject = require("ValueObject")
-local InfluxDBErrorUtils = require("InfluxDBErrorUtils")
 
 local InfluxDBWriteAPI = setmetatable({}, BaseObject)
 InfluxDBWriteAPI.ClassName = "InfluxDBWriteAPI"
 InfluxDBWriteAPI.__index = InfluxDBWriteAPI
 
-function InfluxDBWriteAPI.new(org: string, bucket: string, precision: string?)
-	local self = setmetatable(BaseObject.new(), InfluxDBWriteAPI)
+export type InfluxDBWriteAPI = typeof(setmetatable(
+	{} :: {
+		RequestFinished: Signal.Signal<(any)>,
+		Destroying: Signal.Signal<()>,
+
+		_clientConfig: ValueObject.ValueObject<InfluxDBClientConfigUtils.InfluxDBClientConfig>,
+		_printDebugWriteEnabled: boolean,
+		_org: string,
+		_bucket: string,
+		_precision: string,
+		_pointSettings: InfluxDBPointSettings.InfluxDBPointSettings,
+		_writeOptions: InfluxDBWriteOptionUtils.InfluxDBWriteOptions,
+		_writeBuffer: InfluxDBWriteBuffer.InfluxDBWriteBuffer,
+	},
+	{} :: typeof({ __index = InfluxDBWriteAPI })
+)) & BaseObject.BaseObject
+
+--[=[
+	Creates a new InfluxDB write API. Retrieve this from the [InfluxDBClient].
+
+	@param org string
+	@param bucket string
+	@param precision string?
+	@return InfluxDBWriteAPI
+]=]
+function InfluxDBWriteAPI.new(org: string, bucket: string, precision: string?): InfluxDBWriteAPI
+	local self: InfluxDBWriteAPI = setmetatable(BaseObject.new() :: any, InfluxDBWriteAPI)
 
 	assert(type(org) == "string", "Bad org")
 	assert(type(bucket) == "string", "Bad bucket")
@@ -53,27 +82,45 @@ function InfluxDBWriteAPI.new(org: string, bucket: string, precision: string?)
 	return self
 end
 
-function InfluxDBWriteAPI:SetPrintDebugWriteEnabled(printDebugEnabled: boolean)
+function InfluxDBWriteAPI.SetPrintDebugWriteEnabled(self: InfluxDBWriteAPI, printDebugEnabled: boolean): ()
 	assert(type(printDebugEnabled) == "boolean", "Bad printDebugEnabled")
 
 	self._printDebugWriteEnabled = printDebugEnabled
 end
 
-function InfluxDBWriteAPI:SetClientConfig(clientConfig: InfluxDBClientConfigUtils.InfluxDBClientConfig)
+function InfluxDBWriteAPI.SetClientConfig(
+	self: InfluxDBWriteAPI,
+	clientConfig: InfluxDBClientConfigUtils.InfluxDBClientConfig
+): ()
 	assert(InfluxDBClientConfigUtils.isClientConfig(clientConfig), "Bad clientConfig")
 
 	self._clientConfig.Value = InfluxDBClientConfigUtils.createClientConfig(clientConfig)
 end
 
-function InfluxDBWriteAPI:SetDefaultTags(tags)
+--[=[
+	Sets the default tags to write with each point.
+
+	@param tags InfluxDBTags
+]=]
+function InfluxDBWriteAPI.SetDefaultTags(self: InfluxDBWriteAPI, tags: InfluxDBPointSettings.InfluxDBTags): ()
 	self._pointSettings:SetDefaultTags(tags)
 end
 
-function InfluxDBWriteAPI:SetConvertTime(convertTime)
+--[=[
+	Sets the conversion time
+
+	@param convertTime (number) -> number
+]=]
+function InfluxDBWriteAPI.SetConvertTime(self: InfluxDBWriteAPI, convertTime: InfluxDBPointSettings.ConvertTime?): ()
 	self._pointSettings:SetConvertTime(convertTime)
 end
 
-function InfluxDBWriteAPI:QueuePoint(point: InfluxDBPoint.InfluxDBPoint)
+--[=[
+	Queues a new influx DB point to send to the server.
+
+	@param point InfluxDBPoint
+]=]
+function InfluxDBWriteAPI.QueuePoint(self: InfluxDBWriteAPI, point: InfluxDBPoint.InfluxDBPoint): ()
 	assert(InfluxDBPoint.isInfluxDBPoint(point), "Bad point")
 
 	local line = point:ToLineProtocol(self._pointSettings)
@@ -82,11 +129,16 @@ function InfluxDBWriteAPI:QueuePoint(point: InfluxDBPoint.InfluxDBPoint)
 	end
 
 	if self._printDebugWriteEnabled then
-		print(string.format("[InfluxDBWriteAPI.QueuePoint] - Queueing '%s'", line))
+		print(string.format("[InfluxDBWriteAPI.QueuePoint] - Queueing '%s'", line or "nil"))
 	end
 end
 
-function InfluxDBWriteAPI:QueuePoints(points: { InfluxDBPoint.InfluxDBPoint })
+--[=[
+	Queues a new list of influx DB points to send to the server.
+
+	@param points { InfluxDBPoint }
+]=]
+function InfluxDBWriteAPI.QueuePoints(self: InfluxDBWriteAPI, points: { InfluxDBPoint.InfluxDBPoint }): ()
 	assert(type(points) == "table", "Bad points")
 
 	for _, point in points do
@@ -98,12 +150,12 @@ function InfluxDBWriteAPI:QueuePoints(points: { InfluxDBPoint.InfluxDBPoint })
 		end
 
 		if self._printDebugWriteEnabled then
-			print(string.format("[InfluxDBWriteAPI.QueuePoints] - Queueing '%s'", line))
+			print(string.format("[InfluxDBWriteAPI.QueuePoints] - Queueing '%s'", line or "nil"))
 		end
 	end
 end
 
-function InfluxDBWriteAPI:_promiseSendBatch(toSend: { InfluxDBPoint.InfluxDBPoint }): Promise.Promise<()>
+function InfluxDBWriteAPI._promiseSendBatch(self: InfluxDBWriteAPI, toSend: { string }): Promise.Promise<()>
 	assert(type(toSend) == "table", "Bad toSend")
 
 	local clientConfig = self._clientConfig.Value
@@ -122,13 +174,13 @@ function InfluxDBWriteAPI:_promiseSendBatch(toSend: { InfluxDBPoint.InfluxDBPoin
 	end
 
 	local body = table.concat(toSend, "\n")
-	local request = {
+	local request: HttpPromise.HTTPRequest = {
 		Method = "POST",
 		Headers = {
 			["Content-Type"] = "application/json",
 			["Accept"] = "application/json",
 			["Authorization"] = authHeader,
-		},
+		} :: any,
 		Compress = Enum.HttpCompression.Gzip,
 		Url = self:_getWriteUrl(),
 		Body = body,
@@ -189,24 +241,20 @@ function InfluxDBWriteAPI:_promiseSendBatch(toSend: { InfluxDBPoint.InfluxDBPoin
 		end)
 end
 
-function InfluxDBWriteAPI:PromiseFlush(): Promise.Promise<()>
+function InfluxDBWriteAPI.PromiseFlush(self: InfluxDBWriteAPI): Promise.Promise<()>
 	return self._writeBuffer:PromiseFlush()
 end
 
-function InfluxDBWriteAPI:_getWriteUrl(): string
+function InfluxDBWriteAPI._getWriteUrl(self: InfluxDBWriteAPI): string
 	local config = self._clientConfig.Value
-	local url = config.url
+	local url: string = config.url
 
 	assert(type(url) == "string", "Bad url")
 
 	-- escape trailing slashes
-	url = string.match(url, "(.-)[\\/]*$")
+	url = string.match(url, "(.-)[\\/]*$") or ""
 
-	return string.format("%s/api/v2/write?org=%s&bucket=%s&precision=%s",
-		url,
-		self._org,
-		self._bucket,
-		self._precision)
+	return string.format("%s/api/v2/write?org=%s&bucket=%s&precision=%s", url, self._org, self._bucket, self._precision)
 end
 
-return InfluxDBWriteAPI
+return InfluxDBWriteAPI

package/src/Server/Write/InfluxDBWriteBuffer.lua

@@ -1,34 +1,46 @@
 --!strict
 --[=[
+	Buffer for influx DB points.
+
+	@server
 	@class InfluxDBWriteBuffer
 ]=]
 
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
+local InfluxDBWriteOptionUtils = require("InfluxDBWriteOptionUtils")
 local Promise = require("Promise")
 local Signal = require("Signal")
-local _InfluxDBWriteOptionUtils = require("InfluxDBWriteOptionUtils")
 
 local InfluxDBWriteBuffer = setmetatable({}, BaseObject)
 InfluxDBWriteBuffer.ClassName = "InfluxDBWriteBuffer"
 InfluxDBWriteBuffer.__index = InfluxDBWriteBuffer
 
+export type PromiseHandleFlush = (entries: { string }) -> Promise.Promise<()>
+
 export type InfluxDBWriteBuffer = typeof(setmetatable(
 	{} :: {
 		_bytes: number,
 		_length: number,
 		_entries: { string },
-		_writeOptions: _InfluxDBWriteOptionUtils.InfluxDBWriteOptions,
-		_promiseHandleFlush: (entries: { string }) -> Promise.Promise<()>,
+		_writeOptions: InfluxDBWriteOptionUtils.InfluxDBWriteOptions,
+		_promiseHandleFlush: PromiseHandleFlush,
 		_requestQueueNext: Signal.Signal<()>,
 	},
 	{} :: typeof({ __index = InfluxDBWriteBuffer })
 )) & BaseObject.BaseObject
 
+--[=[
+	Creates a new InfluxDB write buffer.
+
+	@param writeOptions InfluxDBWriteOptions
+	@param promiseHandleFlush (entries: { string }) -> Promise.Promise<()>
+	@return InfluxDBWriteBuffer
+]=]
 function InfluxDBWriteBuffer.new(
-	writeOptions: _InfluxDBWriteOptionUtils.InfluxDBWriteOptions,
-	promiseHandleFlush
+	writeOptions: InfluxDBWriteOptionUtils.InfluxDBWriteOptions,
+	promiseHandleFlush: PromiseHandleFlush
 ): InfluxDBWriteBuffer
 	local self: InfluxDBWriteBuffer = setmetatable(BaseObject.new() :: any, InfluxDBWriteBuffer)
 
@@ -44,7 +56,12 @@ function InfluxDBWriteBuffer.new(
 	return self
 end
 
-function InfluxDBWriteBuffer.Add(self: InfluxDBWriteBuffer, entry: string)
+--[=[
+	Adds an entry to the buffer. If the buffer is full, it will flush
+
+	@param entry string
+]=]
+function InfluxDBWriteBuffer.Add(self: InfluxDBWriteBuffer, entry: string): ()
 	assert(type(entry) == "string", "Bad entry")
 
 	-- Already overflowing
@@ -64,7 +81,7 @@ function InfluxDBWriteBuffer.Add(self: InfluxDBWriteBuffer, entry: string)
 	end
 end
 
-function InfluxDBWriteBuffer._queueNextSend(self: InfluxDBWriteBuffer)
+function InfluxDBWriteBuffer._queueNextSend(self: InfluxDBWriteBuffer): ()
 	if self._maid._queuedSendTask then
 		return
 	end
@@ -78,7 +95,7 @@ function InfluxDBWriteBuffer._queueNextSend(self: InfluxDBWriteBuffer)
 	end)
 end
 
-function InfluxDBWriteBuffer._reset(self: InfluxDBWriteBuffer)
+function InfluxDBWriteBuffer._reset(self: InfluxDBWriteBuffer): { string }
 	local entries = self._entries
 
 	self._bytes = 0
@@ -88,7 +105,7 @@ function InfluxDBWriteBuffer._reset(self: InfluxDBWriteBuffer)
 	return entries
 end
 
-function InfluxDBWriteBuffer._promiseFlushAll(self: InfluxDBWriteBuffer)
+function InfluxDBWriteBuffer._promiseFlushAll(self: InfluxDBWriteBuffer): Promise.Promise<()>
 	self._maid._queuedSendTask = nil
 
 	local entries = self:_reset()
@@ -99,8 +116,13 @@ function InfluxDBWriteBuffer._promiseFlushAll(self: InfluxDBWriteBuffer)
 	end
 end
 
-function InfluxDBWriteBuffer.PromiseFlush(self: InfluxDBWriteBuffer)
+--[=[
+	Flushes all entries in the buffer. Returns a promise that resolves when the flush is complete.
+
+	@return Promise<()>
+]=]
+function InfluxDBWriteBuffer.PromiseFlush(self: InfluxDBWriteBuffer): Promise.Promise<()>
 	return self:_promiseFlushAll()
 end
 
-return InfluxDBWriteBuffer
+return InfluxDBWriteBuffer

package/src/Shared/Utils/InfluxDBEscapeUtils.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class InfluxDBEscapeUtils
 ]=]
@@ -23,6 +24,12 @@ end
 
 export type EscapeTable = { [string]: string }
 
+--[=[
+	Creates a new escaper function for the given table.
+
+	@param subTable EscapeTable
+	@return (string) -> string
+]=]
 function InfluxDBEscapeUtils.createEscaper(subTable: EscapeTable): (string) -> string
 	assert(type(subTable) == "table", "Bad subTable")
 
@@ -43,39 +50,44 @@ function InfluxDBEscapeUtils.createEscaper(subTable: EscapeTable): (string) -> s
 	end
 end
 
+--[=[
+	Creates a new escaper function for the given table, with quotes.
+
+	@param subTable EscapeTable
+	@return (string) -> string
+]=]
 function InfluxDBEscapeUtils.createQuotedEscaper(subTable: EscapeTable): (string) -> string
 	assert(type(subTable) == "table", "Bad subTable")
 
 	local escaper = InfluxDBEscapeUtils.createEscaper(subTable)
 
 	return function(str: string)
-		return string.format("\"%s\"", escaper(str))
+		return string.format('"%s"', escaper(str))
 	end
 end
 
-
 InfluxDBEscapeUtils.measurement = InfluxDBEscapeUtils.createEscaper({
-	[","] = "\\,";
-	[" "] = "\\ ";
-	["\n"] = "\\n";
-	["\r"] = "\\r";
-	["\t"] = "\\t";
-	["\\"] = "\\\\"; -- not sure about this, is this part of spec?
+	[","] = "\\,",
+	[" "] = "\\ ",
+	["\n"] = "\\n",
+	["\r"] = "\\r",
+	["\t"] = "\\t",
+	["\\"] = "\\\\", -- not sure about this, is this part of spec?
 })
 
 InfluxDBEscapeUtils.quoted = InfluxDBEscapeUtils.createQuotedEscaper({
-	["\""] = "\\\"";
-	["\\"] = "\\\\";
+	['"'] = '\\"',
+	["\\"] = "\\\\",
 })
 
 InfluxDBEscapeUtils.tag = InfluxDBEscapeUtils.createEscaper({
-	[","] = "\\,";
-	[" "] = "\\ ";
-	["="] = "\\=";
-	["\n"] = "\\n";
-	["\r"] = "\\r";
-	["\t"] = "\\t";
-	["\\"] = "\\\\"; -- not sure about this, is this part of spec?
+	[","] = "\\,",
+	[" "] = "\\ ",
+	["="] = "\\=",
+	["\n"] = "\\n",
+	["\r"] = "\\r",
+	["\t"] = "\\t",
+	["\\"] = "\\\\", -- not sure about this, is this part of spec?
 })
 
-return InfluxDBEscapeUtils
+return InfluxDBEscapeUtils

package/src/Shared/Utils/InfluxDBEscapeUtils.spec.lua

@@ -2,7 +2,8 @@
 	@class InfluxDBEscapeUtils.spec.lua
 ]]
 
-local require = require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
+local require =
+	require(game:GetService("ServerScriptService"):FindFirstChild("LoaderUtils", true).Parent).bootstrapStory(script)
 
 local InfluxDBEscapeUtils = require("InfluxDBEscapeUtils")
 local Jest = require("Jest")
@@ -25,11 +26,11 @@ end)
 
 describe("InfluxDBEscapeUtils.quoted", function()
 	it("should pass through fine", function()
-		expect(InfluxDBEscapeUtils.quoted("hi")).toBe("\"hi\"")
+		expect(InfluxDBEscapeUtils.quoted("hi")).toBe('"hi"')
 	end)
 
 	it("should escape quotes", function()
-		expect(InfluxDBEscapeUtils.quoted("\"hi")).toBe("\"\\\"hi\"")
+		expect(InfluxDBEscapeUtils.quoted('"hi')).toBe('"\\"hi"')
 	end)
 end)
 
@@ -58,4 +59,4 @@ describe("InfluxDBEscapeUtils.tag", function()
 		local tag = InfluxDBEscapeUtils.tag("\nhi")
 		expect(tag).toBe("\\nhi")
 	end)
-end)
+end)

package/src/Shared/Write/InfluxDBPoint.lua

@@ -5,10 +5,11 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Math = require("Math")
 local InfluxDBEscapeUtils = require("InfluxDBEscapeUtils")
-local Table = require("Table")
+local InfluxDBPointSettings = require("InfluxDBPointSettings")
+local Math = require("Math")
 local Set = require("Set")
+local Table = require("Table")
 
 local InfluxDBPoint = {}
 InfluxDBPoint.ClassName = "InfluxDBPoint"
@@ -31,6 +32,12 @@ export type InfluxDBPointTableData = {
 	fields: { [string]: string },
 }
 
+--[=[
+	Creates a new InfluxDB point
+
+	@param measurementName string?
+	@return InfluxDBPoint
+]=]
 function InfluxDBPoint.new(measurementName: string?): InfluxDBPoint
 	local self: InfluxDBPoint = setmetatable({} :: any, InfluxDBPoint)
 
@@ -44,7 +51,13 @@ function InfluxDBPoint.new(measurementName: string?): InfluxDBPoint
 	return self
 end
 
-function InfluxDBPoint.fromTableData(data: InfluxDBPointTableData)
+--[=[
+	Creates a new InfluxDB point from table data
+
+	@param data InfluxDBPointTableData
+	@return InfluxDBPoint
+]=]
+function InfluxDBPoint.fromTableData(data: InfluxDBPointTableData): InfluxDBPoint
 	assert(type(data) == "table", "Bad data")
 	assert(type(data.measurementName) == "string" or data.measurementName == nil, "Bad data.measurementName")
 
@@ -77,20 +90,42 @@ function InfluxDBPoint.fromTableData(data: InfluxDBPointTableData)
 	return copy
 end
 
+--[=[
+	Checks if the point is an InfluxDBPoint
+
+	@param point any
+	@return boolean
+]=]
 function InfluxDBPoint.isInfluxDBPoint(point: any): boolean
 	return type(point) == "table" and getmetatable(point) == InfluxDBPoint
 end
 
+--[=[
+	Sets the measurement name
+
+	@param name string?
+	@return boolean
+]=]
 function InfluxDBPoint.SetMeasurementName(self: InfluxDBPoint, name: string)
 	assert(type(name) == "string" or name == nil, "Bad name")
 
 	self._measurementName = name
 end
 
+--[=[
+	Gets the measurement name
+
+	@return string?
+]=]
 function InfluxDBPoint.GetMeasurementName(self: InfluxDBPoint): string?
 	return self._measurementName
 end
 
+--[=[
+	Converts the point into a table data format safe for serialization
+
+	@return InfluxDBPointTableData
+]=]
 function InfluxDBPoint.ToTableData(self: InfluxDBPoint): InfluxDBPointTableData
 	return {
 		measurementName = self._measurementName,
@@ -210,7 +245,16 @@ function InfluxDBPoint.AddStringField(self: InfluxDBPoint, fieldName: string, va
 	self._fields[fieldName] = InfluxDBEscapeUtils.quoted(value)
 end
 
-function InfluxDBPoint.ToLineProtocol(self: InfluxDBPoint, pointSettings)
+--[=[
+	Converts the point to line protocol format to send to InfluxDB for consumption
+
+	@param pointSettings InfluxDBPointSettings
+	@return string?
+]=]
+function InfluxDBPoint.ToLineProtocol(
+	self: InfluxDBPoint,
+	pointSettings: InfluxDBPointSettings.InfluxDBPointSettings
+): string?
 	if not self._measurementName then
 		return nil
 	end
@@ -248,9 +292,9 @@ function InfluxDBPoint.ToLineProtocol(self: InfluxDBPoint, pointSettings)
 		end
 	end
 
-	local timestamp: any? = self._timestamp
+	local timestamp = self._timestamp
 	local convertTime = pointSettings:GetConvertTime()
-	if convertTime then
+	if convertTime ~= nil then
 		timestamp = convertTime(timestamp)
 	else
 		timestamp = self:_convertTimeToMillis(timestamp)
@@ -273,7 +317,7 @@ end
 
 function InfluxDBPoint._convertTimeToMillis(_self: InfluxDBPoint, value: (string | DateTime | number)?): string?
 	if value == nil then
-	    return tostring(DateTime.now().UnixTimestampMillis)
+		return tostring(DateTime.now().UnixTimestampMillis)
 	elseif type(value) == "string" then
 		if #value > 0 then
 			return value
@@ -289,4 +333,4 @@ function InfluxDBPoint._convertTimeToMillis(_self: InfluxDBPoint, value: (string
 	end
 end
 
-return InfluxDBPoint
+return InfluxDBPoint