@quenty/datastore 13.20.2 → 13.20.3

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [13.20.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.20.2...@quenty/datastore@13.20.3) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/datastore
+
+
+
+
+
 ## [13.20.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.20.0...@quenty/datastore@13.20.2) (2025-04-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "13.20.2",
+  "version": "13.20.3",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,22 +26,22 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.2",
-    "@quenty/bindtocloseservice": "^8.17.2",
-    "@quenty/loader": "^10.8.2",
-    "@quenty/maid": "^3.4.2",
+    "@quenty/baseobject": "^10.8.3",
+    "@quenty/bindtocloseservice": "^8.17.3",
+    "@quenty/loader": "^10.8.3",
+    "@quenty/maid": "^3.4.3",
     "@quenty/math": "^2.7.3",
-    "@quenty/pagesutils": "^5.11.3",
-    "@quenty/promise": "^10.10.3",
-    "@quenty/rx": "^13.17.2",
-    "@quenty/servicebag": "^11.11.3",
-    "@quenty/signal": "^7.10.2",
+    "@quenty/pagesutils": "^5.11.4",
+    "@quenty/promise": "^10.10.4",
+    "@quenty/rx": "^13.17.3",
+    "@quenty/servicebag": "^11.11.4",
+    "@quenty/signal": "^7.10.3",
     "@quenty/symbol": "^3.4.2",
-    "@quenty/table": "^3.7.3",
-    "@quenty/valueobject": "^13.17.2"
+    "@quenty/table": "^3.7.4",
+    "@quenty/valueobject": "^13.17.3"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64def70499ec067077ee39f279936b620b217847"
+  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
 }

package/src/Server/DataStore.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Wraps the datastore object to provide async cached loading and saving. See [DataStoreStage] for more API.
 
@@ -78,14 +79,28 @@ local ValueObject = require("ValueObject")
 
 local DEFAULT_DEBUG_WRITING = false
 
-local DEFAULT_AUTO_SAVE_TIME_SECONDS = 60*5
+local DEFAULT_AUTO_SAVE_TIME_SECONDS = 60 * 5
 local DEFAULT_JITTER_PROPORTION = 0.1 -- Randomly assign jitter so if a ton of players join at once we don't hit the datastore at once
 
 local DataStore = setmetatable({}, DataStoreStage)
 DataStore.ClassName = "DataStore"
 DataStore.__index = DataStore
 
-export type DataStore = typeof(setmetatable({}, { __index = DataStore }))
+export type DataStore = typeof(setmetatable(
+	{} :: {
+		_key: string,
+		_userIdList: { number }?,
+		_robloxDataStore: DataStorePromises.RobloxDataStore,
+		_debugWriting: boolean,
+		_autoSaveTimeSeconds: ValueObject.ValueObject<number?>,
+		_jitterProportion: ValueObject.ValueObject<number>,
+		_syncOnSave: ValueObject.ValueObject<boolean>,
+		_loadedOk: ValueObject.ValueObject<boolean>,
+		_firstLoadPromise: Promise.Promise<()>,
+		Saving: Signal.Signal<Promise.Promise<()>>,
+	},
+	{} :: typeof({ __index = DataStore })
+)) & DataStoreStage.DataStoreStage
 
 --[=[
 	Constructs a new DataStore. See [DataStoreStage] for more API.
@@ -98,14 +113,14 @@ export type DataStore = typeof(setmetatable({}, { __index = DataStore }))
 	@param key string
 	@return DataStore
 ]=]
-function DataStore.new(robloxDataStore, key: string)
-	local self = setmetatable(DataStoreStage.new(key), DataStore)
+function DataStore.new(robloxDataStore: DataStorePromises.RobloxDataStore, key: string)
+	local self: DataStore = setmetatable(DataStoreStage.new(key) :: any, DataStore)
 
 	self._key = key or error("No key")
 	self._robloxDataStore = robloxDataStore or error("No robloxDataStore")
 	self._debugWriting = DEFAULT_DEBUG_WRITING
 
-	self._autoSaveTimeSeconds = self._maid:Add(ValueObject.new(DEFAULT_AUTO_SAVE_TIME_SECONDS))
+	self._autoSaveTimeSeconds = self._maid:Add(ValueObject.new(DEFAULT_AUTO_SAVE_TIME_SECONDS :: number?))
 	self._jitterProportion = self._maid:Add(ValueObject.new(DEFAULT_JITTER_PROPORTION, "number"))
 	self._syncOnSave = self._maid:Add(ValueObject.new(false, "boolean"))
 	self._loadedOk = self._maid:Add(ValueObject.new(false, "boolean"))
@@ -121,7 +136,7 @@ function DataStore.new(robloxDataStore, key: string)
 	@prop Saving Signal<Promise>
 	@within DataStore
 ]=]
-	self.Saving = self._maid:Add(Signal.new()) -- :Fire(promise)
+	self.Saving = self._maid:Add(Signal.new() :: any) -- :Fire(promise)
 
 	self:_setupAutoSaving()
 
@@ -133,7 +148,7 @@ end
 
 	@param debugWriting boolean
 ]=]
-function DataStore:SetDoDebugWriting(debugWriting: boolean)
+function DataStore.SetDoDebugWriting(self: DataStore, debugWriting: boolean)
 	assert(type(debugWriting) == "boolean", "Bad debugWriting")
 
 	self._debugWriting = debugWriting
@@ -143,7 +158,7 @@ end
 	Returns the full path for the datastore
 	@return string
 ]=]
-function DataStore:GetFullPath(): string
+function DataStore.GetFullPath(self: DataStore): string
 	return string.format("RobloxDataStore@%s", self._key)
 end
 
@@ -153,7 +168,7 @@ end
 
 	@param autoSaveTimeSeconds number?
 ]=]
-function DataStore:SetAutoSaveTimeSeconds(autoSaveTimeSeconds: number?)
+function DataStore.SetAutoSaveTimeSeconds(self: DataStore, autoSaveTimeSeconds: number?)
 	assert(type(autoSaveTimeSeconds) == "number" or autoSaveTimeSeconds == nil, "Bad autoSaveTimeSeconds")
 
 	self._autoSaveTimeSeconds.Value = autoSaveTimeSeconds
@@ -164,7 +179,7 @@ end
 
 	@param syncEnabled boolean
 ]=]
-function DataStore:SetSyncOnSave(syncEnabled: boolean)
+function DataStore.SetSyncOnSave(self: DataStore, syncEnabled: boolean)
 	assert(type(syncEnabled) == "boolean", "Bad syncEnabled")
 
 	self._syncOnSave.Value = syncEnabled
@@ -174,7 +189,7 @@ end
 	Returns whether the datastore failed.
 	@return boolean
 ]=]
-function DataStore:DidLoadFail(): boolean
+function DataStore.DidLoadFail(self: DataStore): boolean
 	if not self._firstLoadPromise then
 		return false
 	end
@@ -191,7 +206,7 @@ end
 
 	@return Promise<boolean>
 ]=]
-function DataStore:PromiseLoadSuccessful(): Promise.Promise<boolean>
+function DataStore.PromiseLoadSuccessful(self: DataStore): Promise.Promise<boolean>
 	return self._maid:GivePromise(self:PromiseViewUpToDate()):Then(function()
 		return true
 	end, function()
@@ -203,7 +218,7 @@ end
 	Saves all stored data.
 	@return Promise
 ]=]
-function DataStore:Save(): Promise.Promise<()>
+function DataStore.Save(self: DataStore): Promise.Promise<()>
 	return self:_syncData(false)
 end
 
@@ -213,7 +228,7 @@ end
 
 	@return Promise
 ]=]
-function DataStore:Sync(): Promise.Promise<()>
+function DataStore.Sync(self: DataStore): Promise.Promise<()>
 	return self:_syncData(true)
 end
 
@@ -222,7 +237,7 @@ end
 
 	@param userIdList { number }?
 ]=]
-function DataStore:SetUserIdList(userIdList: { number }?)
+function DataStore.SetUserIdList(self: DataStore, userIdList: { number }?)
 	assert(type(userIdList) == "table" or userIdList == nil, "Bad userIdList")
 	assert(not Symbol.isSymbol(userIdList), "Should not be symbol")
 
@@ -234,7 +249,7 @@ end
 
 	@return { number }?
 ]=]
-function DataStore:GetUserIdList(): { number }?
+function DataStore.GetUserIdList(self: DataStore): { number }?
 	return self._userIdList
 end
 
@@ -243,21 +258,22 @@ end
 
 	@return Promise
 ]=]
-function DataStore:PromiseViewUpToDate(): Promise.Promise<()>
+function DataStore.PromiseViewUpToDate(self: DataStore): Promise.Promise<()>
 	if self._firstLoadPromise then
 		return self._firstLoadPromise
 	end
 
-	self._firstLoadPromise = self:_promiseGetAsyncNoCache()
+	local promise = self:_promiseGetAsyncNoCache()
+	self._firstLoadPromise = promise
 
-	self._firstLoadPromise:Tap(function()
+	promise:Tap(function()
 		self._loadedOk.Value = true
 	end)
 
-	return self._firstLoadPromise
+	return promise
 end
 
-function DataStore:_setupAutoSaving()
+function DataStore._setupAutoSaving(self: DataStore)
 	local startTime = os.clock()
 
 	self._maid:GiveTask(Rx.combineLatest({
@@ -307,17 +323,18 @@ function DataStore:_setupAutoSaving()
 	end))
 end
 
-function DataStore:_syncData(doMergeNewData: boolean)
+function DataStore._syncData(self: DataStore, doMergeNewData: boolean)
 	if self:DidLoadFail() then
 		warn("[DataStore] - Not syncing, failed to load")
 		return Promise.rejected("Load not successful, not syncing")
 	end
 
-	return self._maid:GivePromise(self:PromiseViewUpToDate())
+	return self._maid
+		:GivePromise(self:PromiseViewUpToDate())
 		:Then(function()
 			return self._maid:GivePromise(self:PromiseInvokeSavingCallbacks())
 		end)
-		:Then(function()
+		:Then(function(): Promise.Promise<()>?
 			if not self:HasWritableData() then
 				if doMergeNewData then
 					-- Reads are cheaper than update async calls
@@ -336,7 +353,7 @@ function DataStore:_syncData(doMergeNewData: boolean)
 		end)
 end
 
-function DataStore:_doDataSync(writer, doMergeNewData)
+function DataStore._doDataSync(self: DataStore, writer, doMergeNewData: boolean): Promise.Promise<()>
 	assert(type(doMergeNewData) == "boolean", "Bad doMergeNewData")
 
 	-- Cache user id list
@@ -352,63 +369,75 @@ function DataStore:_doDataSync(writer, doMergeNewData)
 		end
 
 		-- This is, of course, dangerous, because we won't merge
-		promise:Resolve(maid:GivePromise(DataStorePromises.removeAsync(self._robloxDataStore, self._key)):Then(function()
-			if doMergeNewData then
-				-- Write our data
-				self:MarkDataAsSaved(writer)
+		promise:Resolve(
+			maid:GivePromise(DataStorePromises.removeAsync(self._robloxDataStore, self._key)):Then(function(): any
+				if doMergeNewData then
+					-- Write our data
+					self:MarkDataAsSaved(writer)
 
-				-- Do syncing after
-				return self:_promiseGetAsyncNoCache()
-			end
+					-- Do syncing after
+					return self:_promiseGetAsyncNoCache()
+				end
 
-			return nil
-		end))
+				return nil
+			end)
+		)
 	else
 		if self._debugWriting then
-			print(string.format("[DataStore] - DataStorePromises.updateAsync(%q) with doMergeNewData = %s", self._key, tostring(doMergeNewData)))
+			print(
+				string.format(
+					"[DataStore] - DataStorePromises.updateAsync(%q) with doMergeNewData = %s",
+					self._key,
+					tostring(doMergeNewData)
+				)
+			)
 		end
 
-		promise:Resolve(maid:GivePromise(DataStorePromises.updateAsync(self._robloxDataStore, self._key, function(original, datastoreKeyInfo)
-			if promise:IsRejected() then
-				-- Cancel if we have another request
-				return nil
-			end
+		promise:Resolve(
+			maid:GivePromise(
+				DataStorePromises.updateAsync(self._robloxDataStore, self._key, function(original, datastoreKeyInfo)
+					if promise:IsRejected() then
+						-- Cancel if we have another request
+						return nil
+					end
 
-			local diffSnapshot
-			if doMergeNewData then
-				diffSnapshot = writer:ComputeDiffSnapshot(original)
-			end
+					local diffSnapshot
+					if doMergeNewData then
+						diffSnapshot = writer:ComputeDiffSnapshot(original)
+					end
 
-			local result = writer:WriteMerge(original)
+					local result = writer:WriteMerge(original)
 
-			if result == DataStoreDeleteToken or result == nil then
-				result = {}
-			end
+					if result == DataStoreDeleteToken or result == nil then
+						result = {}
+					end
 
-			self:_checkSnapshotIntegrity("writer:WriteMerge(original)", result)
+					self:_checkSnapshotIntegrity("writer:WriteMerge(original)", result)
 
-			if self._debugWriting then
-				print("[DataStore] - Writing", result)
-			end
+					if self._debugWriting then
+						print("[DataStore] - Writing", result)
+					end
 
-			if doMergeNewData then
-				-- This prevents resaving at high frequency
-				self:MarkDataAsSaved(writer)
-				self:MergeDiffSnapshot(diffSnapshot)
-			end
+					if doMergeNewData then
+						-- This prevents resaving at high frequency
+						self:MarkDataAsSaved(writer)
+						self:MergeDiffSnapshot(diffSnapshot)
+					end
 
-			local userIdList = writer:GetUserIdList()
-			if datastoreKeyInfo then
-				userIdList = datastoreKeyInfo:GetUserIds()
-			end
+					local userIdList = writer:GetUserIdList()
+					if datastoreKeyInfo then
+						userIdList = datastoreKeyInfo:GetUserIds()
+					end
 
-			local metadata = nil
-			if datastoreKeyInfo then
-				metadata = datastoreKeyInfo:GetMetadata()
-			end
+					local metadata = nil
+					if datastoreKeyInfo then
+						metadata = datastoreKeyInfo:GetMetadata()
+					end
 
-			return result, userIdList, metadata
-		end)))
+					return result, userIdList, metadata
+				end)
+			)
+		)
 	end
 
 	promise:Tap(nil, function(err)
@@ -425,7 +454,7 @@ function DataStore:_doDataSync(writer, doMergeNewData)
 	return promise
 end
 
-function DataStore:_promiseGetAsyncNoCache()
+function DataStore._promiseGetAsyncNoCache(self: DataStore): Promise.Promise<()>
 	return self._maid:GivePromise(DataStorePromises.getAsync(self._robloxDataStore, self._key))
 		:Catch(function(err)
 			warn(string.format("DataStorePromises.getAsync(%q) -> warning - %s", tostring(self._key), tostring(err or "empty error")))

package/src/Server/Modules/DataStoreStage.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Provides a data storage facility with an ability to get sub-stores. So you can write
 	directly to this store, overwriting all children, or you can have more partial control
@@ -36,13 +37,27 @@ local DataStoreStage = setmetatable({}, BaseObject)
 DataStoreStage.ClassName = "DataStoreStage"
 DataStoreStage.__index = DataStoreStage
 
+export type DataStoreStageKey = string | number
+
+export type DataStoreCallback = () -> Promise.Promise<()>?
+
 export type DataStoreStage = typeof(setmetatable(
 	{} :: {
+		_loadName: DataStoreStageKey,
+		_loadParent: DataStoreStage?,
+		_saveDataSnapshot: any,
+		_fullPath: string?,
+		_baseDataSnapshot: any,
+		_viewSnapshot: any,
+		_stores: { [DataStoreStageKey]: DataStoreStage },
+		_savingCallbacks: { DataStoreCallback },
+		_keySubscriptions: ObservableSubscriptionTable.ObservableSubscriptionTable<any>,
+
 		Changed: Signal.Signal<any>,
 		DataStored: Signal.Signal<any>,
 	},
-	DataStoreStage
-))
+	{} :: typeof({ __index = DataStoreStage })
+)) & BaseObject.BaseObject
 
 --[=[
 	Constructs a new DataStoreStage to load from. Prefer to use DataStore because this doesn't
@@ -59,8 +74,8 @@ export type DataStoreStage = typeof(setmetatable(
 	@param loadParent DataStoreStage?
 	@return DataStoreStage
 ]=]
-function DataStoreStage.new(loadName: string, loadParent: DataStoreStage?)
-	local self = setmetatable(BaseObject.new(), DataStoreStage)
+function DataStoreStage.new(loadName: DataStoreStageKey, loadParent: DataStoreStage?): DataStoreStage
+	local self: DataStoreStage = setmetatable(BaseObject.new() :: any, DataStoreStage)
 
 	-- LoadParent is optional, used for loading
 	self._loadName = loadName
@@ -94,7 +109,7 @@ end
 	@param key string
 	@param value any
 ]=]
-function DataStoreStage:Store(key: string, value: any)
+function DataStoreStage.Store(self: DataStoreStage, key: string, value: any)
 	assert(type(key) == "string", "Bad key")
 
 	if value == nil then
@@ -120,7 +135,7 @@ end
 	@param defaultValue T?
 	@return Promise<T>
 ]=]
-function DataStoreStage:Load<T>(key: string | number, defaultValue: T?): Promise.Promise<T>
+function DataStoreStage.Load<T>(self: DataStoreStage, key: DataStoreStageKey, defaultValue: T?): Promise.Promise<T>
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	return self:PromiseViewUpToDate():Then(function()
@@ -149,7 +164,7 @@ end
 	@param defaultValue any
 	@return Promise<any>
 ]=]
-function DataStoreStage:LoadAll(defaultValue)
+function DataStoreStage.LoadAll(self: DataStoreStage, defaultValue)
 	return self:PromiseViewUpToDate():Then(function()
 		if self._viewSnapshot == nil then
 			return defaultValue
@@ -173,7 +188,7 @@ end
 	@param key string | number
 	@return DataStoreStage
 ]=]
-function DataStoreStage:GetSubStore(key: string | number)
+function DataStoreStage.GetSubStore(self: DataStoreStage, key: DataStoreStageKey)
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if self._stores[key] then
@@ -228,7 +243,7 @@ end
 
 	@param key string | number
 ]=]
-function DataStoreStage:Delete(key: string)
+function DataStoreStage.Delete(self: DataStoreStage, key: string)
 	assert(type(key) == "string", "Bad key")
 
 	self:_storeAtKey(key, DataStoreDeleteToken)
@@ -237,7 +252,7 @@ end
 --[=[
 	Queues up a wipe of all values. This will completely set the data to nil.
 ]=]
-function DataStoreStage:Wipe()
+function DataStoreStage.Wipe(self: DataStoreStage)
 	self:Overwrite(DataStoreDeleteToken)
 end
 
@@ -250,7 +265,7 @@ end
 	@param defaultValue T?
 	@return Observable<T>
 ]=]
-function DataStoreStage:Observe(key, defaultValue)
+function DataStoreStage.Observe(self: DataStoreStage, key, defaultValue)
 	assert(type(key) == "string" or type(key) == "number" or key == nil, "Bad key")
 
 	if key == nil then
@@ -282,16 +297,13 @@ 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)
@@ -310,7 +322,7 @@ end
 	@param callback function -- May return a promise
 	@return function -- Call to remove
 ]=]
-function DataStoreStage:AddSavingCallback(callback: () -> ())
+function DataStoreStage.AddSavingCallback(self: DataStoreStage, callback: DataStoreCallback?)
 	assert(type(callback) == "function", "Bad callback")
 
 	table.insert(self._savingCallbacks, callback)
@@ -326,7 +338,7 @@ end
 	Removes a saving callback from the data store stage
 	@param callback function
 ]=]
-function DataStoreStage:RemoveSavingCallback(callback: () -> ())
+function DataStoreStage.RemoveSavingCallback(self: DataStoreStage, callback: DataStoreCallback?)
 	assert(type(callback) == "function", "Bad callback")
 
 	local index = table.find(self._savingCallbacks, callback)
@@ -340,7 +352,7 @@ end
 
 	@return Signal
 ]=]
-function DataStoreStage:GetTopLevelDataStoredSignal()
+function DataStoreStage.GetTopLevelDataStoredSignal(self: DataStoreStage)
 	return self.DataStored
 end
 
@@ -349,15 +361,17 @@ end
 
 	@return string
 ]=]
-function DataStoreStage:GetFullPath()
+function DataStoreStage.GetFullPath(self: DataStoreStage): string
 	if self._fullPath then
 		return self._fullPath
 	elseif self._loadParent then
-		self._fullPath = self._loadParent:GetFullPath() .. "." .. tostring(self._loadName)
-		return self._fullPath
+		local fullPath = self._loadParent:GetFullPath() .. "." .. tostring(self._loadName)
+		self._fullPath = fullPath
+		return fullPath
 	else
-		self._fullPath = tostring(self._loadName)
-		return self._fullPath
+		local fullPath = tostring(self._loadName)
+		self._fullPath = fullPath
+		return fullPath
 	end
 end
 
@@ -366,15 +380,14 @@ end
 
 	@return Promise<{ string }>
 ]=]
-function DataStoreStage:PromiseKeyList()
-	return self:PromiseKeySet()
-		:Then(function(keys)
-			local list = {}
+function DataStoreStage.PromiseKeyList(self: DataStoreStage): Promise.Promise<{ string }>
+	return self:PromiseKeySet():Then(function(keys)
+		local list = {}
 		for key, _ in keys do
 			table.insert(list, key)
 		end
 		return list
-		end)
+	end)
 end
 
 --[=[
@@ -382,7 +395,7 @@ end
 
 	@return Promise<{ [string]: true }>
 ]=]
-function DataStoreStage:PromiseKeySet()
+function DataStoreStage.PromiseKeySet(self: DataStoreStage): Promise.Promise<{ [string]: true }>
 	return self:PromiseViewUpToDate():Then(function()
 		if type(self._viewSnapshot) == "table" then
 			return Set.fromKeys(self._viewSnapshot)
@@ -402,7 +415,7 @@ end
 
 	@param diffSnapshot any
 ]=]
-function DataStoreStage:MergeDiffSnapshot(diffSnapshot)
+function DataStoreStage.MergeDiffSnapshot(self: DataStoreStage, diffSnapshot)
 	self:_checkIntegrity()
 
 	self._baseDataSnapshot = self:_updateStoresAndComputeBaseDataSnapshotFromDiffSnapshot(diffSnapshot)
@@ -419,7 +432,7 @@ end
 
 	@param parentWriter DataStoreWriter
 ]=]
-function DataStoreStage:MarkDataAsSaved(parentWriter)
+function DataStoreStage.MarkDataAsSaved(self: DataStoreStage, parentWriter: DataStoreWriter.DataStoreWriter)
 	-- Update all children first
 	for key, subwriter in pairs(parentWriter:GetSubWritersMap()) do
 		local store = self._stores[key]
@@ -489,7 +502,7 @@ end
 
 	@return Promise
 ]=]
-function DataStoreStage:PromiseViewUpToDate()
+function DataStoreStage.PromiseViewUpToDate(self: DataStoreStage)
 	if not self._loadParent then
 		error("[DataStoreStage.Load] - Failed to load, no loadParent!")
 	end
@@ -510,7 +523,7 @@ end
 
 	@param data any
 ]=]
-function DataStoreStage:Overwrite(data)
+function DataStoreStage.Overwrite(self: DataStoreStage, data)
 	-- Ensure that we at least start loading (and thus the autosave loop) for write
 	self:PromiseViewUpToDate()
 
@@ -522,7 +535,7 @@ function DataStoreStage:Overwrite(data)
 		local newSaveSnapshot = {}
 
 		local remaining = Set.fromKeys(self._stores)
-		for key, store in self._stores do
+		for key, store: any in self._stores do
 			-- Update each store
 			store:Overwrite(data[key])
 		end
@@ -542,7 +555,7 @@ function DataStoreStage:Overwrite(data)
 
 		self._saveDataSnapshot = table.freeze(newSaveSnapshot)
 	else
-		for _, store in self._stores do
+		for _, store: any in self._stores do
 			store:Overwrite(DataStoreDeleteToken)
 		end
 
@@ -563,7 +576,7 @@ end
 
 	@param data any
 ]=]
-function DataStoreStage:OverwriteMerge(data)
+function DataStoreStage.OverwriteMerge(self: DataStoreStage, data)
 	-- Ensure that we at least start loading (and thus the autosave loop) for write
 	self:PromiseViewUpToDate()
 
@@ -585,7 +598,7 @@ end
 	@param valueObj Instance -- ValueBase object to store on
 	@return MaidTask -- Cleanup to remove this writer and free the key.
 ]=]
-function DataStoreStage:StoreOnValueChange(name, valueObj)
+function DataStoreStage.StoreOnValueChange(self: DataStoreStage, name: DataStoreStageKey, valueObj)
 	assert(type(name) == "string" or type(name) == "number", "Bad name")
 	assert(typeof(valueObj) == "Instance" or (type(valueObj) == "table" and valueObj.Changed), "Bad valueObj")
 
@@ -610,14 +623,14 @@ end
 
 	@return boolean
 ]=]
-function DataStoreStage:HasWritableData()
+function DataStoreStage.HasWritableData(self: DataStoreStage): boolean
 	if self._saveDataSnapshot ~= nil then
 		return true
 	end
 
-	for name, store in self._stores do
+	for name, store: any in self._stores do
 		if not store.Destroy then
-			warn(string.format("[DataStoreStage] - Substore %q destroyed", name))
+			warn(string.format("[DataStoreStage] - Substore %q destroyed", tostring(name)))
 			continue
 		end
 
@@ -638,7 +651,7 @@ end
 
 	@return DataStoreWriter
 ]=]
-function DataStoreStage:GetNewWriter()
+function DataStoreStage.GetNewWriter(self: DataStoreStage): DataStoreWriter.DataStoreWriter
 	self:_checkIntegrity()
 
 	local writer = DataStoreWriter.new(self:GetFullPath())
@@ -649,9 +662,9 @@ function DataStoreStage:GetNewWriter()
 		writer:SetSaveDataSnapshot(self._saveDataSnapshot)
 	end
 
-	for key, store in self._stores do
+	for key, store: any in self._stores do
 		if not store.Destroy then
-			warn(string.format("[DataStoreStage] - Substore %q destroyed", key))
+			warn(string.format("[DataStoreStage] - Substore %q destroyed", tostring(key)))
 			continue
 		end
 
@@ -674,17 +687,17 @@ end
 
 	@return Promise
 ]=]
-function DataStoreStage:PromiseInvokeSavingCallbacks()
-	local removingPromises = {}
+function DataStoreStage.PromiseInvokeSavingCallbacks(self: DataStoreStage)
+	local removingPromises: { Promise.Promise<()> } = {}
 
 	for _, func in self._savingCallbacks do
 		local result = func()
 		if Promise.isPromise(result) then
-			table.insert(removingPromises, result)
+			table.insert(removingPromises, result :: any)
 		end
 	end
 
-	for _, substore in self._stores do
+	for _, substore: any in self._stores do
 		local promise = substore:PromiseInvokeSavingCallbacks()
 		if promise then
 			table.insert(removingPromises, promise)
@@ -694,7 +707,7 @@ function DataStoreStage:PromiseInvokeSavingCallbacks()
 	return PromiseUtils.all(removingPromises)
 end
 
-function DataStoreStage:_createFullBaseDataSnapshot()
+function DataStoreStage._createFullBaseDataSnapshot(self: DataStoreStage)
 	if self._baseDataSnapshot == DataStoreDeleteToken then
 		error("BadDataSnapshot cannot be a delete token")
 	elseif type(self._baseDataSnapshot) == "table" or self._baseDataSnapshot == nil then
@@ -705,9 +718,9 @@ function DataStoreStage:_createFullBaseDataSnapshot()
 			newSnapshot = {}
 		end
 
-		for key, store in self._stores do
+		for key, store: any in self._stores do
 			if not store.Destroy then
-				warn(string.format("[DataStoreStage] - Substore %q destroyed", key))
+				warn(string.format("[DataStoreStage] - Substore %q destroyed", tostring(key)))
 				continue
 			end
 
@@ -726,7 +739,7 @@ function DataStoreStage:_createFullBaseDataSnapshot()
 	end
 end
 
-function DataStoreStage:_updateStoresAndComputeBaseDataSnapshotFromDiffSnapshot(diffSnapshot)
+function DataStoreStage._updateStoresAndComputeBaseDataSnapshotFromDiffSnapshot(self: DataStoreStage, diffSnapshot)
 	if diffSnapshot == DataStoreDeleteToken then
 		return nil
 	elseif type(diffSnapshot) == "table" then
@@ -752,7 +765,11 @@ function DataStoreStage:_updateStoresAndComputeBaseDataSnapshotFromDiffSnapshot(
 	end
 end
 
-function DataStoreStage:_updateStoresAndComputeBaseDataSnapshotValueFromDiffSnapshot(key, value)
+function DataStoreStage._updateStoresAndComputeBaseDataSnapshotValueFromDiffSnapshot(
+	self: DataStoreStage,
+	key: DataStoreStageKey,
+	value
+)
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if self._stores[key] then
@@ -771,7 +788,7 @@ function DataStoreStage:_updateStoresAndComputeBaseDataSnapshotValueFromDiffSnap
 	end
 end
 
-function DataStoreStage:_recurseMergeTable(original, incoming)
+function DataStoreStage._recurseMergeTable(self: DataStoreStage, original, incoming)
 	if incoming == DataStoreDeleteToken then
 		return nil
 	elseif type(incoming) == "table" and type(original) == "table" then
@@ -789,7 +806,7 @@ function DataStoreStage:_recurseMergeTable(original, incoming)
 	end
 end
 
-function DataStoreStage:_updateViewSnapshot()
+function DataStoreStage._updateViewSnapshot(self: DataStoreStage)
 	self:_checkIntegrity()
 
 	local newViewSnapshot = self:_computeNewViewSnapshot()
@@ -818,7 +835,7 @@ function DataStoreStage:_updateViewSnapshot()
 	self:_checkIntegrity()
 end
 
-function DataStoreStage:_computeChangedKeys(previousViewSnapshot, newViewSnapshot)
+function DataStoreStage._computeChangedKeys(_self: DataStoreStage, previousViewSnapshot, newViewSnapshot)
 	-- Detect keys that changed
 	if type(previousViewSnapshot) == "table" and type(newViewSnapshot) == "table" then
 		local changedKeys = {}
@@ -842,7 +859,7 @@ function DataStoreStage:_computeChangedKeys(previousViewSnapshot, newViewSnapsho
 	end
 end
 
-function DataStoreStage:_updateViewSnapshotAtKey(key)
+function DataStoreStage._updateViewSnapshotAtKey(self: DataStoreStage, key)
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if type(self._viewSnapshot) ~= "table" then
@@ -866,7 +883,7 @@ function DataStoreStage:_updateViewSnapshotAtKey(key)
 	self:_checkIntegrity()
 end
 
-function DataStoreStage:_computeNewViewSnapshot()
+function DataStoreStage._computeNewViewSnapshot(self: DataStoreStage)
 	-- This prioritizes save data first, then stores, then base data
 
 	if self._saveDataSnapshot == DataStoreDeleteToken then
@@ -916,7 +933,7 @@ function DataStoreStage:_computeNewViewSnapshot()
 	end
 end
 
-function DataStoreStage:_computeViewValueForKey(key)
+function DataStoreStage._computeViewValueForKey(self: DataStoreStage, key)
 	-- This prioritizes save data first, then stores, then base data
 
 	if self._saveDataSnapshot == DataStoreDeleteToken then
@@ -956,7 +973,7 @@ function DataStoreStage:_computeViewValueForKey(key)
 end
 
 -- Stores the data for overwrite.
-function DataStoreStage:_storeAtKey(key, value)
+function DataStoreStage._storeAtKey(self: DataStoreStage, key, value)
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 	assert(value ~= nil, "Bad value")
 
@@ -996,7 +1013,7 @@ function DataStoreStage:_storeAtKey(key, value)
 	self:_checkIntegrity()
 end
 
-function DataStoreStage:_checkSnapshotIntegrity(label, result)
+function DataStoreStage._checkSnapshotIntegrity(_self: DataStoreStage, label, result)
 	assert(type(label) == "string", "Bad label")
 
 	if not SLOW_INTEGRITY_CHECK_ENABLED then
@@ -1007,7 +1024,7 @@ function DataStoreStage:_checkSnapshotIntegrity(label, result)
 		error(string.format("%s should not be a DataStoreDeleteToken", label))
 	end
 
-	local function recurse(innerLabel, value)
+	local function recurse(innerLabel: string, value)
 		if type(value) ~= "table" then
 			return
 		end
@@ -1032,7 +1049,7 @@ function DataStoreStage:_checkSnapshotIntegrity(label, result)
 	recurse(label, result)
 end
 
-function DataStoreStage:_checkIntegrity()
+function DataStoreStage._checkIntegrity(self: DataStoreStage)
 	if not SLOW_INTEGRITY_CHECK_ENABLED then
 		return
 	end
@@ -1056,11 +1073,11 @@ function DataStoreStage:_checkIntegrity()
 
 	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))
+			error(string.format("[DataStoreStage] - Duplicate baseData at key %q", tostring(key)))
 		end
 
 		if type(self._saveDataSnapshot) == "table" and self._saveDataSnapshot[key] ~= nil then
-			error(string.format("[DataStoreStage] - Duplicate saveData at key %q", key))
+			error(string.format("[DataStoreStage] - Duplicate saveData at key %q", tostring(key)))
 		end
 	end
 end

package/src/Server/Modules/DataStoreWriter.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Captures a snapshot of data to write and then merges it with the original.
 	@server
@@ -18,14 +19,27 @@ local DataStoreWriter = {}
 DataStoreWriter.ClassName = "DataStoreWriter"
 DataStoreWriter.__index = DataStoreWriter
 
+export type DataStoreStageKey = string | number
+
+export type DataStoreWriter = typeof(setmetatable(
+	{} :: {
+		_debugName: string,
+		_saveDataSnapshot: any,
+		_fullBaseDataSnapshot: any,
+		_userIdList: { number } | nil,
+		_writers: { [DataStoreStageKey]: DataStoreWriter },
+	},
+	{} :: typeof({ __index = DataStoreWriter })
+))
+
 --[=[
 	Constructs a new DataStoreWriter. In general, you will not use this API directly.
 
 	@param debugName string
 	@return DataStoreWriter
 ]=]
-function DataStoreWriter.new(debugName: string)
-	local self = setmetatable({}, DataStoreWriter)
+function DataStoreWriter.new(debugName: string): DataStoreWriter
+	local self: DataStoreWriter = setmetatable({} :: any, DataStoreWriter)
 
 	self._debugName = assert(debugName, "No debugName")
 	self._saveDataSnapshot = UNSET_TOKEN
@@ -41,7 +55,7 @@ end
 	Sets the ray data to write
 	@param saveDataSnapshot table | any
 ]=]
-function DataStoreWriter:SetSaveDataSnapshot(saveDataSnapshot)
+function DataStoreWriter.SetSaveDataSnapshot(self: DataStoreWriter, saveDataSnapshot)
 	assert(type(saveDataSnapshot) ~= "table" or table.isfrozen(saveDataSnapshot), "saveDataSnapshot should be frozen")
 
 	if saveDataSnapshot == DataStoreDeleteToken then
@@ -53,7 +67,7 @@ function DataStoreWriter:SetSaveDataSnapshot(saveDataSnapshot)
 	end
 end
 
-function DataStoreWriter:GetDataToSave()
+function DataStoreWriter.GetDataToSave(self: DataStoreWriter): any
 	if self._saveDataSnapshot == UNSET_TOKEN then
 		return nil
 	end
@@ -61,11 +75,11 @@ function DataStoreWriter:GetDataToSave()
 	return self._saveDataSnapshot
 end
 
-function DataStoreWriter:GetSubWritersMap()
+function DataStoreWriter.GetSubWritersMap(self: DataStoreWriter): { [DataStoreStageKey]: DataStoreWriter }
 	return self._writers
 end
 
-function DataStoreWriter:SetFullBaseDataSnapshot(fullBaseDataSnapshot)
+function DataStoreWriter.SetFullBaseDataSnapshot(self: DataStoreWriter, fullBaseDataSnapshot)
 	assert(
 		type(fullBaseDataSnapshot) ~= "table" or table.isfrozen(fullBaseDataSnapshot),
 		"fullBaseDataSnapshot should be frozen"
@@ -81,11 +95,11 @@ end
 
 --[=[
 	Adds a recursive child writer to use at the key `name`
-	@param name string
+	@param name string | number
 	@param writer DataStoreWriter
 ]=]
-function DataStoreWriter:AddSubWriter(name: string, writer)
-	assert(type(name) == "string", "Bad name")
+function DataStoreWriter.AddSubWriter(self: DataStoreWriter, name: DataStoreStageKey, writer: DataStoreWriter)
+	assert(type(name) == "string" or type(name) == "number", "Bad name")
 	assert(not self._writers[name], "Writer already exists for name")
 	assert(writer, "Bad writer")
 
@@ -95,10 +109,10 @@ end
 --[=[
 	Gets a sub writer
 
-	@param name string
+	@param name string | number
 	@return DataStoreWriter
 ]=]
-function DataStoreWriter:GetWriter(name: string)
+function DataStoreWriter.GetWriter(self: DataStoreWriter, name: DataStoreStageKey): DataStoreWriter?
 	assert(type(name) == "string", "Bad name")
 
 	return self._writers[name]
@@ -111,7 +125,7 @@ end
 
 	@param incoming any
 ]=]
-function DataStoreWriter:ComputeDiffSnapshot(incoming)
+function DataStoreWriter.ComputeDiffSnapshot(self: DataStoreWriter, incoming)
 	assert(incoming ~= DataStoreDeleteToken, "Incoming value should not be DataStoreDeleteToken")
 	assert(not Symbol.isSymbol(incoming), "Incoming should not be symbol")
 
@@ -149,7 +163,7 @@ function DataStoreWriter:ComputeDiffSnapshot(incoming)
 	end
 end
 
-function DataStoreWriter:_computeValueDiff(original, incoming)
+function DataStoreWriter._computeValueDiff(self: DataStoreWriter, original, incoming)
 	assert(original ~= DataStoreDeleteToken, "original cannot be DataStoreDeleteToken")
 	assert(incoming ~= DataStoreDeleteToken, "incoming cannot be DataStoreDeleteToken")
 	assert(not Symbol.isSymbol(original), "original should not be symbol")
@@ -166,7 +180,7 @@ function DataStoreWriter:_computeValueDiff(original, incoming)
 	end
 end
 
-function DataStoreWriter:_computeTableDiff(original, incoming)
+function DataStoreWriter._computeTableDiff(self: DataStoreWriter, original, incoming)
 	assert(type(original) == "table", "Bad original")
 	assert(type(incoming) == "table", "Bad incoming")
 	assert(not Symbol.isSymbol(original), "original should not be symbol")
@@ -191,7 +205,7 @@ end
 
 	@param userIdList { number }
 ]=]
-function DataStoreWriter:SetUserIdList(userIdList)
+function DataStoreWriter.SetUserIdList(self: DataStoreWriter, userIdList: { number }?)
 	assert(type(userIdList) == "table" or userIdList == nil, "Bad userIdList")
 
 	self._userIdList = userIdList
@@ -202,7 +216,7 @@ end
 
 	@return userIdList { number }
 ]=]
-function DataStoreWriter:GetUserIdList()
+function DataStoreWriter.GetUserIdList(self: DataStoreWriter): { number }?
 	if self._userIdList == UNSET_TOKEN then
 		return nil
 	end
@@ -210,7 +224,7 @@ function DataStoreWriter:GetUserIdList()
 	return self._userIdList
 end
 
-function DataStoreWriter:_writeMergeWriters(original)
+function DataStoreWriter._writeMergeWriters(self: DataStoreWriter, original)
 	local copy
 	if Symbol.isSymbol(original) then
 		copy = original
@@ -285,7 +299,7 @@ end
 	@param original any
 	@return any -- The original value
 ]=]
-function DataStoreWriter:WriteMerge(original)
+function DataStoreWriter.WriteMerge(self: DataStoreWriter, original)
 	-- Prioritize save value first, followed by writers, followed by original value
 
 	if self._saveDataSnapshot == DataStoreDeleteToken then
@@ -302,7 +316,7 @@ function DataStoreWriter:WriteMerge(original)
 	end
 end
 
-function DataStoreWriter:IsCompleteWipe(): boolean
+function DataStoreWriter.IsCompleteWipe(self: DataStoreWriter): boolean
 	if self._saveDataSnapshot == UNSET_TOKEN then
 		return false
 	end

package/src/Server/PlayerDataStoreManager.lua

@@ -64,6 +64,19 @@ local PlayerDataStoreManager = setmetatable({}, BaseObject)
 PlayerDataStoreManager.ClassName = "PlayerDataStoreManager"
 PlayerDataStoreManager.__index = PlayerDataStoreManager
 
+export type PlayerDataStoreManager = typeof(setmetatable(
+	{} :: {
+		_robloxDataStore: any,
+		_keyGenerator: (Player) -> string,
+		_datastores: { [Player]: DataStore },
+		_removing: { [Player]: boolean },
+		_pendingSaves: PendingPromiseTracker.PendingPromiseTracker<any>,
+		_removingCallbacks: { (Player) -> any },
+		_disableSavingInStudio: boolean?,
+	},
+	{} :: typeof({ __index = PlayerDataStoreManager })
+)) & BaseObject.BaseObject
+
 --[=[
 	Constructs a new PlayerDataStoreManager.
 

package/src/Server/PlayerDataStoreService.lua

@@ -16,6 +16,17 @@ local _ServiceBag = require("ServiceBag")
 local PlayerDataStoreService = {}
 PlayerDataStoreService.ServiceName = "PlayerDataStoreService"
 
+export type PlayerDataStoreService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: _ServiceBag.ServiceBag,
+		_maid: Maid.Maid,
+		_dataStoreName: string,
+		_dataStoreScope: string,
+		_dataStoreManagerPromise: Promise.Promise<PlayerDataStoreManager.PlayerDataStoreManager>,
+	},
+	{} :: typeof({ __index = PlayerDataStoreService })
+))
+
 --[=[
 	Initializes the PlayerDataStoreService. Should be done via [ServiceBag.Init].
 	@param serviceBag ServiceBag

package/src/Server/Utility/DataStorePromises.lua

@@ -15,6 +15,8 @@ local Table = require("Table")
 
 local DataStorePromises = {}
 
+export type RobloxDataStore = DataStore
+
 --[=[
 	Promises a Roblox datastore object with the name and scope. Generally only fails
 	when you haven't published the place.
@@ -95,7 +97,7 @@ end
 function DataStorePromises.updateAsync<T>(
 	robloxDataStore: DataStore,
 	key: string,
-	updateFunc: (T) -> T?
+	updateFunc: (T, DataStoreKeyInfo) -> T?
 ): Promise.Promise<(T, DataStoreKeyInfo)>
 	assert(typeof(robloxDataStore) == "Instance", "Bad robloxDataStore")
 	assert(type(key) == "string", "Bad key")