@quenty/datastore 13.20.0 → 13.20.1

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.
 
+## [13.20.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.20.0...@quenty/datastore@13.20.1) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 # [13.20.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.19.3...@quenty/datastore@13.20.0) (2025-04-02)
 
 **Note:** Version bump only for package @quenty/datastore

package/README.md

@@ -26,9 +26,9 @@ This datastore prevents data loss by being explicit about what we're writing to,
 * Native Rx and Promise implementation
 
 ## How syncing works
-Sometimes datastores (like a global game data store) need to be synced live instead of upon server or player start. This is if we expect multiple servers to write to the same datastore at once we can use thie sync method to 
+Sometimes datastores (like a global game data store) need to be synced live instead of upon server or player start. This is if we expect multiple servers to write to the same datastore at once we can use thie sync method to
 
-Syncing is like saving. However, instead of treating the current datastore as a session lock, we load in additional data from our "source-of-truth". From here, we merge that data into the datastore, which means both clearing any matching write tokens that our sync says is done. 
+Syncing is like saving. However, instead of treating the current datastore as a session lock, we load in additional data from our "source-of-truth". From here, we merge that data into the datastore, which means both clearing any matching write tokens that our sync says is done.
 
 This is best for a "shared" memory that can be temporarily not correct. Deleting with a sync is less effective.
 
@@ -394,7 +394,7 @@ end
 -- Do actual load
 
 Players.PlayerAdded:Connect(handlePlayerAdded)
-for _, player in pairs(Players:GetPlayers()) do
+for _, player in Players:GetPlayers() do
 	handlePlayerAdded(player)
 end
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "13.20.0",
+  "version": "13.20.1",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,22 +26,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/bindtocloseservice": "^8.17.0",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/maid": "^3.4.0",
-    "@quenty/math": "^2.7.1",
-    "@quenty/pagesutils": "^5.11.1",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/rx": "^13.17.0",
-    "@quenty/servicebag": "^11.11.1",
-    "@quenty/signal": "^7.10.0",
-    "@quenty/symbol": "^3.4.0",
-    "@quenty/table": "^3.7.1",
-    "@quenty/valueobject": "^13.17.0"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/bindtocloseservice": "^8.17.1",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/maid": "^3.4.1",
+    "@quenty/math": "^2.7.2",
+    "@quenty/pagesutils": "^5.11.2",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/rx": "^13.17.1",
+    "@quenty/servicebag": "^11.11.2",
+    "@quenty/signal": "^7.10.1",
+    "@quenty/symbol": "^3.4.1",
+    "@quenty/table": "^3.7.2",
+    "@quenty/valueobject": "^13.17.1"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "e8ea56930e65322fcffc05a1556d5df988068f0b"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Server/DataStore.lua

@@ -32,7 +32,7 @@
 
 	local topMaid = Maid.new()
 
-	local function handlePlayer(player)
+	local function handlePlayer(player: Player)
 		local maid = Maid.new()
 
 		local playerMoneyValue = Instance.new("IntValue")
@@ -54,7 +54,7 @@
 	Players.PlayerRemoving:Connect(function(player)
 		topMaid[player] = nil
 	end)
-	for _, player in pairs(Players:GetPlayers()) do
+	for _, player in Players:GetPlayers() do
 		task.spawn(handlePlayer, player)
 	end
 	```
@@ -85,6 +85,8 @@ local DataStore = setmetatable({}, DataStoreStage)
 DataStore.ClassName = "DataStore"
 DataStore.__index = DataStore
 
+export type DataStore = typeof(setmetatable({}, { __index = DataStore }))
+
 --[=[
 	Constructs a new DataStore. See [DataStoreStage] for more API.
 
@@ -96,7 +98,7 @@ DataStore.__index = DataStore
 	@param key string
 	@return DataStore
 ]=]
-function DataStore.new(robloxDataStore, key)
+function DataStore.new(robloxDataStore, key: string)
 	local self = setmetatable(DataStoreStage.new(key), DataStore)
 
 	self._key = key or error("No key")
@@ -114,7 +116,7 @@ function DataStore.new(robloxDataStore, key)
 		error("[DataStore] - Key cannot be an empty string")
 	end
 
---[=[
+	--[=[
 	Prop that fires when saving. Promise will resolve once saving is complete.
 	@prop Saving Signal<Promise>
 	@within DataStore
@@ -131,7 +133,7 @@ end
 
 	@param debugWriting boolean
 ]=]
-function DataStore:SetDoDebugWriting(debugWriting)
+function DataStore:SetDoDebugWriting(debugWriting: boolean)
 	assert(type(debugWriting) == "boolean", "Bad debugWriting")
 
 	self._debugWriting = debugWriting
@@ -141,7 +143,7 @@ end
 	Returns the full path for the datastore
 	@return string
 ]=]
-function DataStore:GetFullPath()
+function DataStore:GetFullPath(): string
 	return string.format("RobloxDataStore@%s", self._key)
 end
 
@@ -149,9 +151,9 @@ end
 	How frequent the data store will autosave (or sync) to the cloud. If set to nil then the datastore
 	will not do any syncing.
 
-	@param autoSaveTimeSeconds number | nil
+	@param autoSaveTimeSeconds number?
 ]=]
-function DataStore:SetAutoSaveTimeSeconds(autoSaveTimeSeconds)
+function DataStore:SetAutoSaveTimeSeconds(autoSaveTimeSeconds: number?)
 	assert(type(autoSaveTimeSeconds) == "number" or autoSaveTimeSeconds == nil, "Bad autoSaveTimeSeconds")
 
 	self._autoSaveTimeSeconds.Value = autoSaveTimeSeconds
@@ -162,7 +164,7 @@ end
 
 	@param syncEnabled boolean
 ]=]
-function DataStore:SetSyncOnSave(syncEnabled)
+function DataStore:SetSyncOnSave(syncEnabled: boolean)
 	assert(type(syncEnabled) == "boolean", "Bad syncEnabled")
 
 	self._syncOnSave.Value = syncEnabled
@@ -172,7 +174,7 @@ end
 	Returns whether the datastore failed.
 	@return boolean
 ]=]
-function DataStore:DidLoadFail()
+function DataStore:DidLoadFail(): boolean
 	if not self._firstLoadPromise then
 		return false
 	end
@@ -189,7 +191,7 @@ end
 
 	@return Promise<boolean>
 ]=]
-function DataStore:PromiseLoadSuccessful()
+function DataStore:PromiseLoadSuccessful(): Promise.Promise<boolean>
 	return self._maid:GivePromise(self:PromiseViewUpToDate()):Then(function()
 		return true
 	end, function()
@@ -201,7 +203,7 @@ end
 	Saves all stored data.
 	@return Promise
 ]=]
-function DataStore:Save()
+function DataStore:Save(): Promise.Promise<()>
 	return self:_syncData(false)
 end
 
@@ -211,16 +213,16 @@ end
 
 	@return Promise
 ]=]
-function DataStore:Sync()
+function DataStore:Sync(): Promise.Promise<()>
 	return self:_syncData(true)
 end
 
 --[=[
 	Sets the user id list associated with this datastore. Can be useful for GDPR compliance.
 
-	@param userIdList { number } | nil
+	@param userIdList { number }?
 ]=]
-function DataStore:SetUserIdList(userIdList)
+function DataStore:SetUserIdList(userIdList: { number }?)
 	assert(type(userIdList) == "table" or userIdList == nil, "Bad userIdList")
 	assert(not Symbol.isSymbol(userIdList), "Should not be symbol")
 
@@ -230,9 +232,9 @@ end
 --[=[
 	Returns a list of user ids or nil
 
-	@return { number } | nil
+	@return { number }?
 ]=]
-function DataStore:GetUserIdList()
+function DataStore:GetUserIdList(): { number }?
 	return self._userIdList
 end
 
@@ -241,7 +243,7 @@ end
 
 	@return Promise
 ]=]
-function DataStore:PromiseViewUpToDate()
+function DataStore:PromiseViewUpToDate(): Promise.Promise<()>
 	if self._firstLoadPromise then
 		return self._firstLoadPromise
 	end
@@ -259,10 +261,10 @@ function DataStore:_setupAutoSaving()
 	local startTime = os.clock()
 
 	self._maid:GiveTask(Rx.combineLatest({
-		autoSaveTimeSeconds = self._autoSaveTimeSeconds:Observe();
-		jitterProportion = self._jitterProportion:Observe();
-		syncOnSave = self._syncOnSave:Observe();
-		loadedOk = self._loadedOk:Observe();
+		autoSaveTimeSeconds = self._autoSaveTimeSeconds:Observe(),
+		jitterProportion = self._jitterProportion:Observe(),
+		syncOnSave = self._syncOnSave:Observe(),
+		loadedOk = self._loadedOk:Observe(),
 	}):Subscribe(function(state)
 		if state.autoSaveTimeSeconds and state.loadedOk then
 			local maid = Maid.new()
@@ -275,7 +277,11 @@ function DataStore:_setupAutoSaving()
 				while true do
 					local jitterBase = math.random()
 					local timeElapsed = os.clock() - startTime
-					local totalWaitTime = Math.jitter(state.autoSaveTimeSeconds, state.jitterProportion*state.autoSaveTimeSeconds, jitterBase)
+					local totalWaitTime = Math.jitter(
+						state.autoSaveTimeSeconds,
+						state.jitterProportion * state.autoSaveTimeSeconds,
+						jitterBase
+					)
 					local timeRemaining = totalWaitTime - timeElapsed
 
 					if timeRemaining > 0 then
@@ -301,7 +307,7 @@ function DataStore:_setupAutoSaving()
 	end))
 end
 
-function DataStore:_syncData(doMergeNewData)
+function DataStore:_syncData(doMergeNewData: boolean)
 	if self:DidLoadFail() then
 		warn("[DataStore] - Not syncing, failed to load")
 		return Promise.rejected("Load not successful, not syncing")
@@ -354,6 +360,8 @@ function DataStore:_doDataSync(writer, doMergeNewData)
 				-- Do syncing after
 				return self:_promiseGetAsyncNoCache()
 			end
+
+			return nil
 		end))
 	else
 		if self._debugWriting then

package/src/Server/GameDataStoreService.lua

@@ -12,11 +12,12 @@ local DataStore = require("DataStore")
 local DataStorePromises = require("DataStorePromises")
 local Maid = require("Maid")
 local Promise = require("Promise")
+local _ServiceBag = require("ServiceBag")
 
 local GameDataStoreService = {}
 GameDataStoreService.ServiceName = "GameDataStoreService"
 
-function GameDataStoreService:Init(serviceBag)
+function GameDataStoreService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 

package/src/Server/Modules/DataStoreSnapshotUtils.lua

@@ -8,7 +8,7 @@ local Symbol = require("Symbol")
 
 local DataStoreSnapshotUtils = {}
 
-function DataStoreSnapshotUtils.isEmptySnapshot(snapshot)
+function DataStoreSnapshotUtils.isEmptySnapshot(snapshot: any): boolean
 	return not Symbol.isSymbol(snapshot) and type(snapshot) == "table" and next(snapshot) == nil
 end
 

package/src/Server/Modules/DataStoreStage.lua

@@ -20,7 +20,7 @@ local BaseObject = require("BaseObject")
 local DataStoreDeleteToken = require("DataStoreDeleteToken")
 local DataStoreSnapshotUtils = require("DataStoreSnapshotUtils")
 local DataStoreWriter = require("DataStoreWriter")
-local GoodSignal = require("GoodSignal")
+local Signal = require("Signal")
 local Maid = require("Maid")
 local Observable = require("Observable")
 local ObservableSubscriptionTable = require("ObservableSubscriptionTable")
@@ -36,6 +36,14 @@ local DataStoreStage = setmetatable({}, BaseObject)
 DataStoreStage.ClassName = "DataStoreStage"
 DataStoreStage.__index = DataStoreStage
 
+export type DataStoreStage = typeof(setmetatable(
+	{} :: {
+		Changed: Signal.Signal<any>,
+		DataStored: Signal.Signal<any>,
+	},
+	DataStoreStage
+))
+
 --[=[
 	Constructs a new DataStoreStage to load from. Prefer to use DataStore because this doesn't
 	have any way to retrieve this.
@@ -51,15 +59,15 @@ DataStoreStage.__index = DataStoreStage
 	@param loadParent DataStoreStage?
 	@return DataStoreStage
 ]=]
-function DataStoreStage.new(loadName, loadParent)
+function DataStoreStage.new(loadName: string, loadParent: DataStoreStage?)
 	local self = setmetatable(BaseObject.new(), DataStoreStage)
 
 	-- LoadParent is optional, used for loading
 	self._loadName = loadName
 	self._loadParent = loadParent
 
-	self.Changed = self._maid:Add(GoodSignal.new()) -- :Fire(viewSnapshot)
-	self.DataStored = self._maid:Add(GoodSignal.new())
+	self.Changed = self._maid:Add(Signal.new()) -- :Fire(viewSnapshot)
+	self.DataStored = self._maid:Add(Signal.new())
 
 	-- Stores the actual data loaded and synced (but not pending written data)
 	self._saveDataSnapshot = nil
@@ -83,10 +91,10 @@ end
 	dataStore:Store("money", 25)
 	```
 
-	@param key string | number
+	@param key string
 	@param value any
 ]=]
-function DataStoreStage:Store(key, value)
+function DataStoreStage:Store(key: string, value: any)
 	assert(type(key) == "string", "Bad key")
 
 	if value == nil then
@@ -112,7 +120,7 @@ end
 	@param defaultValue T?
 	@return Promise<T>
 ]=]
-function DataStoreStage:Load(key, defaultValue)
+function DataStoreStage:Load<T>(key: string | number, defaultValue: T?): Promise.Promise<T>
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	return self:PromiseViewUpToDate():Then(function()
@@ -165,7 +173,7 @@ end
 	@param key string | number
 	@return DataStoreStage
 ]=]
-function DataStoreStage:GetSubStore(key)
+function DataStoreStage:GetSubStore(key: string | number)
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if self._stores[key] then
@@ -220,7 +228,7 @@ end
 
 	@param key string | number
 ]=]
-function DataStoreStage:Delete(key)
+function DataStoreStage:Delete(key: string)
 	assert(type(key) == "string", "Bad key")
 
 	self:_storeAtKey(key, DataStoreDeleteToken)
@@ -238,7 +246,7 @@ end
 
 	If no key is passed than it will observe the whole view snapshot
 
-	@param key string | number | nil
+	@param key string | number?
 	@param defaultValue T?
 	@return Observable<T>
 ]=]
@@ -248,25 +256,24 @@ function DataStoreStage:Observe(key, defaultValue)
 	if key == nil then
 		return Observable.new(function(sub)
 			local maid = Maid.new()
-			maid:GivePromise(self:LoadAll())
-				:Then(function()
-					-- Only connect once loaded
-					maid:GiveTask(self.Changed:Connect(function(viewSnapshot)
-						if viewSnapshot == nil then
-							sub:Fire(defaultValue)
-						else
-							sub:Fire(viewSnapshot)
-						end
-					end))
-
-					if self._viewSnapshot == nil then
+			maid:GivePromise(self:LoadAll()):Then(function()
+				-- Only connect once loaded
+				maid:GiveTask(self.Changed:Connect(function(viewSnapshot)
+					if viewSnapshot == nil then
 						sub:Fire(defaultValue)
 					else
-						sub:Fire(self._viewSnapshot)
+						sub:Fire(viewSnapshot)
 					end
-				end, function(...)
-					sub:Fail(...)
-				end)
+				end))
+
+				if self._viewSnapshot == nil then
+					sub:Fire(defaultValue)
+				else
+					sub:Fire(self._viewSnapshot)
+				end
+			end, function(...)
+				sub:Fail(...)
+			end)
 
 			return maid
 		end)
@@ -275,21 +282,23 @@ function DataStoreStage:Observe(key, defaultValue)
 	return Observable.new(function(sub)
 		local maid = Maid.new()
 
-		maid:GiveTask(self._keySubscriptions:Observe(key):Subscribe(function(value)
-			if value == nil then
-				sub:Fire(defaultValue)
-			else
-				sub:Fire(value)
-			end
-		end), sub:GetFailComplete())
+		maid:GiveTask(
+			self._keySubscriptions:Observe(key):Subscribe(function(value)
+				if value == nil then
+					sub:Fire(defaultValue)
+				else
+					sub:Fire(value)
+				end
+			end),
+			sub:GetFailComplete()
+		)
 
 		-- Load initially
-		maid:GivePromise(self:Load(key, defaultValue))
-			:Then(function(value)
-				sub:Fire(value)
-			end, function(...)
-				sub:Fail(...)
-			end)
+		maid:GivePromise(self:Load(key, defaultValue)):Then(function(value)
+			sub:Fire(value)
+		end, function(...)
+			sub:Fail(...)
+		end)
 
 		return maid
 	end)
@@ -301,7 +310,7 @@ end
 	@param callback function -- May return a promise
 	@return function -- Call to remove
 ]=]
-function DataStoreStage:AddSavingCallback(callback)
+function DataStoreStage:AddSavingCallback(callback: () -> ())
 	assert(type(callback) == "function", "Bad callback")
 
 	table.insert(self._savingCallbacks, callback)
@@ -317,7 +326,7 @@ end
 	Removes a saving callback from the data store stage
 	@param callback function
 ]=]
-function DataStoreStage:RemoveSavingCallback(callback)
+function DataStoreStage:RemoveSavingCallback(callback: () -> ())
 	assert(type(callback) == "function", "Bad callback")
 
 	local index = table.find(self._savingCallbacks, callback)
@@ -361,10 +370,10 @@ function DataStoreStage:PromiseKeyList()
 	return self:PromiseKeySet()
 		:Then(function(keys)
 			local list = {}
-			for key, _ in pairs(keys) do
-				table.insert(list, key)
-			end
-			return list
+		for key, _ in keys do
+			table.insert(list, key)
+		end
+		return list
 		end)
 end
 
@@ -437,11 +446,12 @@ function DataStoreStage:MarkDataAsSaved(parentWriter)
 				newBaseDataSnapshot = {}
 			end
 
-			for key, value in pairs(dataToSave) do
+			for key, value in dataToSave do
 				local ourSnapshotValue = self._saveDataSnapshot[key]
 				if Table.deepEquivalent(ourSnapshotValue, value) or ourSnapshotValue == nil then
 					-- This shouldn't fire any event because our save data is matching
-					newBaseDataSnapshot[key] = self:_updateStoresAndComputeBaseDataSnapshotValueFromDiffSnapshot(key, value)
+					newBaseDataSnapshot[key] =
+						self:_updateStoresAndComputeBaseDataSnapshotValueFromDiffSnapshot(key, value)
 					newSaveSnapshot[key] = nil
 				end
 			end
@@ -512,12 +522,12 @@ function DataStoreStage:Overwrite(data)
 		local newSaveSnapshot = {}
 
 		local remaining = Set.fromKeys(self._stores)
-		for key, store in pairs(self._stores) do
+		for key, store in self._stores do
 			-- Update each store
 			store:Overwrite(data[key])
 		end
 
-		for key, value in pairs(data) do
+		for key, value in data do
 			remaining[key] = nil
 			if self._stores[key] then
 				self._stores[key]:Overwrite(value)
@@ -526,13 +536,13 @@ function DataStoreStage:Overwrite(data)
 			end
 		end
 
-		for key, _ in pairs(remaining) do
+		for key, _ in remaining do
 			self._stores[key]:Overwrite(DataStoreDeleteToken)
 		end
 
 		self._saveDataSnapshot = table.freeze(newSaveSnapshot)
 	else
-		for _, store in pairs(self._stores) do
+		for _, store in self._stores do
 			store:Overwrite(DataStoreDeleteToken)
 		end
 
@@ -559,7 +569,7 @@ function DataStoreStage:OverwriteMerge(data)
 
 	if type(data) == "table" and data ~= DataStoreDeleteToken then
 		-- Note we explicitly don't wipe values here! Need delete token if we want to delete!
-		for key, value in pairs(data) do
+		for key, value in data do
 			self:_storeAtKey(key, value)
 		end
 	else
@@ -605,7 +615,7 @@ function DataStoreStage:HasWritableData()
 		return true
 	end
 
-	for name, store in pairs(self._stores) do
+	for name, store in self._stores do
 		if not store.Destroy then
 			warn(string.format("[DataStoreStage] - Substore %q destroyed", name))
 			continue
@@ -639,7 +649,7 @@ function DataStoreStage:GetNewWriter()
 		writer:SetSaveDataSnapshot(self._saveDataSnapshot)
 	end
 
-	for key, store in pairs(self._stores) do
+	for key, store in self._stores do
 		if not store.Destroy then
 			warn(string.format("[DataStoreStage] - Substore %q destroyed", key))
 			continue
@@ -667,14 +677,14 @@ end
 function DataStoreStage:PromiseInvokeSavingCallbacks()
 	local removingPromises = {}
 
-	for _, func in pairs(self._savingCallbacks) do
+	for _, func in self._savingCallbacks do
 		local result = func()
 		if Promise.isPromise(result) then
 			table.insert(removingPromises, result)
 		end
 	end
 
-	for _, substore in pairs(self._stores) do
+	for _, substore in self._stores do
 		local promise = substore:PromiseInvokeSavingCallbacks()
 		if promise then
 			table.insert(removingPromises, promise)
@@ -695,7 +705,7 @@ function DataStoreStage:_createFullBaseDataSnapshot()
 			newSnapshot = {}
 		end
 
-		for key, store in pairs(self._stores) do
+		for key, store in self._stores do
 			if not store.Destroy then
 				warn(string.format("[DataStoreStage] - Substore %q destroyed", key))
 				continue
@@ -730,7 +740,7 @@ function DataStoreStage:_updateStoresAndComputeBaseDataSnapshotFromDiffSnapshot(
 		end
 
 		-- Merge all of our newly downloaded data here into our base layer.
-		for key, value in pairs(diffSnapshot) do
+		for key, value in diffSnapshot do
 			newBaseDataSnapshot[key] = self:_updateStoresAndComputeBaseDataSnapshotValueFromDiffSnapshot(key, value)
 		end
 
@@ -750,7 +760,11 @@ function DataStoreStage:_updateStoresAndComputeBaseDataSnapshotValueFromDiffSnap
 		return nil
 	elseif value == DataStoreDeleteToken then
 		return nil
-	elseif type(value) == "table" and type(self._baseDataSnapshot) == "table" and type(self._baseDataSnapshot[key]) == "table" then
+	elseif
+		type(value) == "table"
+		and type(self._baseDataSnapshot) == "table"
+		and type(self._baseDataSnapshot[key]) == "table"
+	then
 		return self:_recurseMergeTable(self._baseDataSnapshot[key], value)
 	else
 		return value
@@ -765,7 +779,7 @@ function DataStoreStage:_recurseMergeTable(original, incoming)
 		local newSnapshot = table.clone(original)
 
 		-- Overwerite with merged values...
-		for key, value in pairs(incoming) do
+		for key, value in incoming do
 			newSnapshot[key] = self:_recurseMergeTable(original[key], value)
 		end
 
@@ -788,11 +802,11 @@ function DataStoreStage:_updateViewSnapshot()
 		local changedKeys = self:_computeChangedKeys(previousViewSnapshot, newViewSnapshot)
 		if next(changedKeys) ~= nil then
 			if type(newViewSnapshot) == "table" then
-				for key, _ in pairs(changedKeys) do
+				for key, _ in changedKeys do
 					self._keySubscriptions:Fire(key, newViewSnapshot[key])
 				end
 			else
-				for key, _ in pairs(changedKeys) do
+				for key, _ in changedKeys do
 					self._keySubscriptions:Fire(key, nil)
 				end
 			end
@@ -810,7 +824,7 @@ function DataStoreStage:_computeChangedKeys(previousViewSnapshot, newViewSnapsho
 		local changedKeys = {}
 
 		local keys = Set.union(Set.fromKeys(previousViewSnapshot), Set.fromKeys(newViewSnapshot))
-		for key, _ in pairs(keys) do
+		for key, _ in keys do
 			if not Table.deepEquivalent(previousViewSnapshot[key], newViewSnapshot[key]) then
 				changedKeys[key] = true
 			end
@@ -869,13 +883,13 @@ function DataStoreStage:_computeNewViewSnapshot()
 		end
 
 		-- Add in stores
-		for key, store in pairs(self._stores) do
+		for key, store in self._stores do
 			newView[key] = store._viewSnapshot
 		end
 
 		-- Then finally save data
 		if type(self._saveDataSnapshot) == "table" then
-			for key, value in pairs(self._saveDataSnapshot) do
+			for key, value in self._saveDataSnapshot do
 				if value == DataStoreDeleteToken then
 					newView[key] = nil
 				else
@@ -884,7 +898,10 @@ function DataStoreStage:_computeNewViewSnapshot()
 			end
 		end
 
-		if next(newView) == nil and not (type(self._baseDataSnapshot) == "table" or type(self._saveDataSnapshot) == "table") then
+		if
+			next(newView) == nil
+			and not (type(self._baseDataSnapshot) == "table" or type(self._saveDataSnapshot) == "table")
+		then
 			-- We have no reason to be a table, make sure we return nil
 			return nil
 		end
@@ -995,11 +1012,11 @@ function DataStoreStage:_checkSnapshotIntegrity(label, result)
 			return
 		end
 
-		for key, item in pairs(value) do
+		for key, item in value do
 			local keyLabel = innerLabel .. "." .. tostring(key)
 
 			if not (type(key) == "string" or type(key) == "number") then
-				 error(string.format("%s should be a number or string", keyLabel))
+				error(string.format("%s should be a number or string", keyLabel))
 			end
 
 			if item == DataStoreDeleteToken then
@@ -1037,7 +1054,7 @@ function DataStoreStage:_checkIntegrity()
 		self:_checkSnapshotIntegrity("self._viewSnapshot", self._viewSnapshot)
 	end
 
-	for key, _ in pairs(self._stores) do
+	for key, _ in self._stores do
 		if type(self._baseDataSnapshot) == "table" and self._baseDataSnapshot[key] ~= nil then
 			error(string.format("[DataStoreStage] - Duplicate baseData at key %q", key))
 		end

package/src/Server/Modules/DataStoreWriter.lua

@@ -24,7 +24,7 @@ DataStoreWriter.__index = DataStoreWriter
 	@param debugName string
 	@return DataStoreWriter
 ]=]
-function DataStoreWriter.new(debugName)
+function DataStoreWriter.new(debugName: string)
 	local self = setmetatable({}, DataStoreWriter)
 
 	self._debugName = assert(debugName, "No debugName")
@@ -66,7 +66,10 @@ function DataStoreWriter:GetSubWritersMap()
 end
 
 function DataStoreWriter:SetFullBaseDataSnapshot(fullBaseDataSnapshot)
-	assert(type(fullBaseDataSnapshot) ~= "table" or table.isfrozen(fullBaseDataSnapshot), "fullBaseDataSnapshot should be frozen")
+	assert(
+		type(fullBaseDataSnapshot) ~= "table" or table.isfrozen(fullBaseDataSnapshot),
+		"fullBaseDataSnapshot should be frozen"
+	)
 	assert(not Symbol.isSymbol(fullBaseDataSnapshot), "fullBaseDataSnapshot should not be symbol")
 
 	if fullBaseDataSnapshot == DataStoreDeleteToken then
@@ -81,7 +84,7 @@ end
 	@param name string
 	@param writer DataStoreWriter
 ]=]
-function DataStoreWriter:AddSubWriter(name, writer)
+function DataStoreWriter:AddSubWriter(name: string, writer)
 	assert(type(name) == "string", "Bad name")
 	assert(not self._writers[name], "Writer already exists for name")
 	assert(writer, "Bad writer")
@@ -95,7 +98,7 @@ end
 	@param name string
 	@return DataStoreWriter
 ]=]
-function DataStoreWriter:GetWriter(name)
+function DataStoreWriter:GetWriter(name: string)
 	assert(type(name) == "string", "Bad name")
 
 	return self._writers[name]
@@ -124,7 +127,7 @@ function DataStoreWriter:ComputeDiffSnapshot(incoming)
 		end
 
 		local diffSnapshot = {}
-		for key, _ in pairs(keys) do
+		for key, _ in keys do
 			if self._writers[key] then
 				diffSnapshot[key] = self._writers[key]:ComputeDiffSnapshot(incoming[key])
 			else
@@ -172,7 +175,7 @@ function DataStoreWriter:_computeTableDiff(original, incoming)
 	local keys = Set.union(Set.fromKeys(original), Set.fromKeys(incoming))
 
 	local diffSnapshot = {}
-	for key, _ in pairs(keys) do
+	for key, _ in keys do
 		diffSnapshot[key] = self:_computeValueDiff(original[key], incoming[key])
 	end
 
@@ -224,7 +227,7 @@ function DataStoreWriter:_writeMergeWriters(original)
 		end
 
 		-- Write our writers first...
-		for key, writer in pairs(self._writers) do
+		for key, writer in self._writers do
 			local result = writer:WriteMerge(copy[key])
 			if result == DataStoreDeleteToken then
 				copy[key] = nil
@@ -235,15 +238,26 @@ function DataStoreWriter:_writeMergeWriters(original)
 	end
 
 	-- Write our save data next
-	if not Symbol.isSymbol(self._saveDataSnapshot) and type(self._saveDataSnapshot) == "table" and next(self._saveDataSnapshot) ~= nil then
+	if
+		not Symbol.isSymbol(self._saveDataSnapshot)
+		and type(self._saveDataSnapshot) == "table"
+		and next(self._saveDataSnapshot) ~= nil
+	then
 		-- Original was not a table. We need to swap to one.
 		if type(copy) ~= "table" then
 			copy = {}
 		end
 
-		for key, value in pairs(self._saveDataSnapshot) do
+		for key, value in self._saveDataSnapshot do
 			if self._writers[key] then
-				warn(string.format("[DataStoreWriter._writeMergeWriters] - Overwriting key %q already saved as rawData with a writer with %q (was %q)", key, tostring(value), tostring(copy[key])))
+				warn(
+					string.format(
+						"[DataStoreWriter._writeMergeWriters] - Overwriting key %q already saved as rawData with a writer with %q (was %q)",
+						key,
+						tostring(value),
+						tostring(copy[key])
+					)
+				)
 			end
 
 			if value == DataStoreDeleteToken then
@@ -276,7 +290,11 @@ function DataStoreWriter:WriteMerge(original)
 
 	if self._saveDataSnapshot == DataStoreDeleteToken then
 		return DataStoreDeleteToken
-	elseif self._saveDataSnapshot == UNSET_TOKEN or self._saveDataSnapshot == nil or type(self._saveDataSnapshot) == "table" then
+	elseif
+		self._saveDataSnapshot == UNSET_TOKEN
+		or self._saveDataSnapshot == nil
+		or type(self._saveDataSnapshot) == "table"
+	then
 		return self:_writeMergeWriters(original)
 	else
 		-- Save data must be a boolean or something
@@ -284,7 +302,7 @@ function DataStoreWriter:WriteMerge(original)
 	end
 end
 
-function DataStoreWriter:IsCompleteWipe()
+function DataStoreWriter:IsCompleteWipe(): boolean
 	if self._saveDataSnapshot == UNSET_TOKEN then
 		return false
 	end

package/src/Server/PlayerDataStoreManager.lua

@@ -17,7 +17,7 @@
 
 	local topMaid = Maid.new()
 
-	local function handlePlayer(player)
+	local function handlePlayer(player: Player)
 		local maid = Maid.new()
 
 		local playerMoneyValue = Instance.new("IntValue")
@@ -39,7 +39,7 @@
 	Players.PlayerRemoving:Connect(function(player)
 		topMaid[player] = nil
 	end)
-	for _, player in pairs(Players:GetPlayers()) do
+	for _, player in Players:GetPlayers() do
 		task.spawn(handlePlayer, player)
 	end
 	```
@@ -72,7 +72,7 @@ PlayerDataStoreManager.__index = PlayerDataStoreManager
 	@param skipBindingToClose boolean?
 	@return PlayerDataStoreManager
 ]=]
-function PlayerDataStoreManager.new(robloxDataStore, keyGenerator, skipBindingToClose)
+function PlayerDataStoreManager.new(robloxDataStore: DataStore, keyGenerator, skipBindingToClose)
 	local self = setmetatable(BaseObject.new(), PlayerDataStoreManager)
 
 	assert(type(skipBindingToClose) == "boolean" or skipBindingToClose == nil, "Bad skipBindingToClose")
@@ -131,7 +131,7 @@ end
 
 	@param player Player
 ]=]
-function PlayerDataStoreManager:RemovePlayerDataStore(player)
+function PlayerDataStoreManager:RemovePlayerDataStore(player: Player)
 	self:_removePlayerDataStore(player)
 end
 
@@ -139,7 +139,7 @@ end
 	@param player Player
 	@return DataStore
 ]=]
-function PlayerDataStoreManager:GetDataStore(player)
+function PlayerDataStoreManager:GetDataStore(player: Player)
 	assert(typeof(player) == "Instance", "Bad player")
 	assert(player:IsA("Player"), "Bad player")
 
@@ -161,13 +161,13 @@ end
 	@return Promise
 ]=]
 function PlayerDataStoreManager:PromiseAllSaves()
-	for player, _ in pairs(self._datastores) do
+	for player, _ in self._datastores do
 		self:_removePlayerDataStore(player)
 	end
 	return self._maid:GivePromise(PromiseUtils.all(self._pendingSaves:GetAll()))
 end
 
-function PlayerDataStoreManager:_createDataStore(player)
+function PlayerDataStoreManager:_createDataStore(player: Player)
 	assert(not self._datastores[player], "Bad player")
 
 	local datastore = DataStore.new(self._robloxDataStore, self:_getKey(player))
@@ -182,7 +182,7 @@ function PlayerDataStoreManager:_createDataStore(player)
 	return datastore
 end
 
-function PlayerDataStoreManager:_removePlayerDataStore(player)
+function PlayerDataStoreManager:_removePlayerDataStore(player: Player)
 	assert(typeof(player) == "Instance", "Bad player")
 	assert(player:IsA("Player"), "Bad player")
 
@@ -194,7 +194,7 @@ function PlayerDataStoreManager:_removePlayerDataStore(player)
 	self._removing[player] = true
 
 	local removingPromises = {}
-	for _, func in pairs(self._removingCallbacks) do
+	for _, func in self._removingCallbacks do
 		local result = func(player)
 		if Promise.isPromise(result) then
 			table.insert(removingPromises, result)
@@ -215,7 +215,7 @@ function PlayerDataStoreManager:_removePlayerDataStore(player)
 	self._maid._savingConns[player] = nil
 end
 
-function PlayerDataStoreManager:_getKey(player)
+function PlayerDataStoreManager:_getKey(player: Player)
 	return self._keyGenerator(player)
 end
 

package/src/Server/PlayerDataStoreService.lua

@@ -11,6 +11,7 @@ local PlayerDataStoreManager = require("PlayerDataStoreManager")
 local DataStorePromises = require("DataStorePromises")
 local Promise = require("Promise")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local PlayerDataStoreService = {}
 PlayerDataStoreService.ServiceName = "PlayerDataStoreService"
@@ -19,7 +20,7 @@ PlayerDataStoreService.ServiceName = "PlayerDataStoreService"
 	Initializes the PlayerDataStoreService. Should be done via [ServiceBag.Init].
 	@param serviceBag ServiceBag
 ]=]
-function PlayerDataStoreService:Init(serviceBag)
+function PlayerDataStoreService:Init(serviceBag: _ServiceBag.ServiceBag)
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
@@ -49,7 +50,7 @@ end
 
 	@param dataStoreName string
 ]=]
-function PlayerDataStoreService:SetDataStoreName(dataStoreName)
+function PlayerDataStoreService:SetDataStoreName(dataStoreName: string)
 	assert(type(dataStoreName) == "string", "Bad dataStoreName")
 	assert(self._promiseStarted, "Not initialized")
 	assert(self._promiseStarted:IsPending(), "Already started, cannot configure")
@@ -66,7 +67,7 @@ end
 
 	@param dataStoreScope string
 ]=]
-function PlayerDataStoreService:SetDataStoreScope(dataStoreScope)
+function PlayerDataStoreService:SetDataStoreScope(dataStoreScope: string)
 	assert(type(dataStoreScope) == "string", "Bad dataStoreScope")
 	assert(self._promiseStarted, "Not initialized")
 	assert(self._promiseStarted:IsPending(), "Already started, cannot configure")

package/src/Server/PrivateServerDataStoreService.lua

@@ -10,11 +10,12 @@ local require = require(script.Parent.loader).load(script)
 local DataStore = require("DataStore")
 local DataStorePromises = require("DataStorePromises")
 local Maid = require("Maid")
+local _ServiceBag = require("ServiceBag")
 
 local PrivateServerDataStoreService = {}
 PrivateServerDataStoreService.ServiceName = "PrivateServerDataStoreService"
 
-function PrivateServerDataStoreService:Init(serviceBag)
+function PrivateServerDataStoreService:Init(serviceBag: _ServiceBag.ServiceBag)
 	assert(not self._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 

package/src/Server/Utility/DataStorePromises.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Utility methods to interactive with Roblox datastores.
 	@server
@@ -21,7 +22,7 @@ local DataStorePromises = {}
 	@param scope string
 	@return Promise<DataStore>
 ]=]
-function DataStorePromises.promiseDataStore(name, scope)
+function DataStorePromises.promiseDataStore(name: string, scope: string): Promise.Promise<DataStore>
 	assert(type(name) == "string", "Bad name")
 	assert(type(scope) == "string", "Bad scope")
 
@@ -44,7 +45,7 @@ end
 	@param scope string
 	@return Promise<OrderedDataStore>
 ]=]
-function DataStorePromises.promiseOrderedDataStore(name, scope)
+function DataStorePromises.promiseOrderedDataStore(name: string, scope: string): Promise.Promise<OrderedDataStore>
 	assert(type(name) == "string", "Bad name")
 	assert(type(scope) == "string", "Bad scope")
 
@@ -66,7 +67,7 @@ end
 	@param key string
 	@return Promise<T>
 ]=]
-function DataStorePromises.getAsync(robloxDataStore, key)
+function DataStorePromises.getAsync<T>(robloxDataStore: DataStore, key: string): Promise.Promise<T>
 	assert(typeof(robloxDataStore) == "Instance", "Bad robloxDataStore")
 	assert(type(key) == "string", "Bad key")
 
@@ -88,10 +89,14 @@ end
 	@param robloxDataStore DataStore
 	@param key string
 	@param updateFunc (T) -> T?
-	@return Promise<boolean>
+	@return Promise<T>
 ]=]
 
-function DataStorePromises.updateAsync(robloxDataStore, key, updateFunc)
+function DataStorePromises.updateAsync<T>(
+	robloxDataStore: DataStore,
+	key: string,
+	updateFunc: (T) -> T?
+): Promise.Promise<(T, DataStoreKeyInfo)>
 	assert(typeof(robloxDataStore) == "Instance", "Bad robloxDataStore")
 	assert(type(key) == "string", "Bad key")
 	assert(type(updateFunc) == "function", "Bad updateFunc")
@@ -119,7 +124,12 @@ end
 	@param userIds { number } -- Associated userIds
 	@return Promise<boolean>
 ]=]
-function DataStorePromises.setAsync(robloxDataStore, key, value, userIds)
+function DataStorePromises.setAsync(
+	robloxDataStore: DataStore,
+	key,
+	value: string,
+	userIds: { number }?
+): Promise.Promise<boolean>
 	assert(typeof(robloxDataStore) == "Instance", "Bad robloxDataStore")
 	assert(type(key) == "string", "Bad key")
 	assert(type(userIds) == "table" or userIds == nil, "Bad userIds")
@@ -142,7 +152,11 @@ end
 	@param delta number
 	@return Promise<boolean>
 ]=]
-function DataStorePromises.promiseIncrementAsync(robloxDataStore, key, delta)
+function DataStorePromises.promiseIncrementAsync(
+	robloxDataStore: DataStore,
+	key: string,
+	delta: number
+): Promise.Promise<boolean>
 	assert(typeof(robloxDataStore) == "Instance", "Bad robloxDataStore")
 	assert(type(key) == "string", "Bad key")
 	assert(type(delta) == "number" or delta == nil, "Bad delta")
@@ -164,7 +178,7 @@ end
 	@param key string
 	@return Promise<boolean>
 ]=]
-function DataStorePromises.removeAsync(robloxDataStore, key)
+function DataStorePromises.removeAsync(robloxDataStore: DataStore, key: string): Promise.Promise<boolean>
 	assert(typeof(robloxDataStore) == "Instance", "Bad robloxDataStore")
 	assert(type(key) == "string", "Bad key")
 
@@ -191,7 +205,13 @@ end
 	@param maxValue number?
 	@return Promise<DataStorePages>
 ]=]
-function DataStorePromises.promiseSortedPagesAsync(orderedDataStore, ascending, pagesize, minValue, maxValue)
+function DataStorePromises.promiseSortedPagesAsync(
+	orderedDataStore: OrderedDataStore,
+	ascending: boolean,
+	pagesize: number,
+	minValue: number?,
+	maxValue: number?
+): Promise.Promise<DataStorePages>
 	assert(typeof(orderedDataStore) == "Instance" and orderedDataStore:IsA("OrderedDataStore"), "Bad orderedDataStore")
 	assert(type(ascending) == "boolean", "Bad ascending")
 	assert(type(pagesize) == "number", "Bad entries")
@@ -212,7 +232,6 @@ function DataStorePromises.promiseSortedPagesAsync(orderedDataStore, ascending,
 	end)
 end
 
-
 --[=[
 	@interface OrderedDataStoreEntry
 	.key any
@@ -253,19 +272,20 @@ end
 	@param maxValue number?
 	@return Promise<OrderedDataStoreEntry>
 ]=]
-function DataStorePromises.promiseOrderedEntries(orderedDataStore, ascending, pagesize, entries, minValue, maxValue)
+function DataStorePromises.promiseOrderedEntries(orderedDataStore: OrderedDataStore, ascending: boolean, pagesize: number, entries: number, minValue: number?, maxValue: number?): Promise.Promise<OrderedDataStoreEntry>
 	assert(typeof(orderedDataStore) == "Instance" and orderedDataStore:IsA("OrderedDataStore"), "Bad orderedDataStore")
 	assert(type(ascending) == "boolean", "Bad ascending")
 	assert(type(entries) == "number", "Bad entries")
 
+	-- stylua: ignore
 	return DataStorePromises.promiseSortedPagesAsync(orderedDataStore, ascending, pagesize, minValue, maxValue)
-		:Then(function(dataStorePages)
+		:Then(function(dataStorePages: DataStorePages)
 			return Promise.spawn(function(resolve, reject)
 				local resultList = {}
 
-				local pageData = dataStorePages:GetCurrentPage()
+				local pageData: any? = dataStorePages:GetCurrentPage()
 				while pageData do
-					for _, data in pairs(pageData) do
+					for _, data in pageData do
 						if #resultList < entries then
 							table.insert(resultList, data)
 						else

package/test/scripts/Server/ServerMain.server.lua

@@ -13,7 +13,7 @@ local Promise = require("Promise")
 
 local TURN_TIME = 8
 
-local function spinUpGameCopy(prefix)
+local function spinUpGameCopy(prefix: string)
 	assert(type(prefix) == "string", "Bad prefix")
 
 	local serviceBag = require("ServiceBag").new()