@quenty/datastore 13.26.1 → 13.27.0

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.27.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.26.1...@quenty/datastore@13.27.0) (2026-01-06)
+
+
+### Bug Fixes
+
+* Add more typing ([f32615e](https://github.com/Quenty/NevermoreEngine/commit/f32615ec9d846a1a4392a3b21a0f594e8d420b44))
+
+
+
+
+
 ## [13.26.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@13.26.0...@quenty/datastore@13.26.1) (2026-01-05)
 
 **Note:** Version bump only for package @quenty/datastore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "13.26.1",
+  "version": "13.27.0",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -44,5 +44,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5232cd2c58ca0dcdf591dd8ae78995211da2f3e2"
+  "gitHead": "540aa2a77acbb6c9c5967fe4417400a903df2c2c"
 }

package/src/Server/DataStore.lua

@@ -314,7 +314,7 @@ function DataStore.PromiseViewUpToDate(self: DataStore): Promise.Promise<()>
 	return promise
 end
 
-function DataStore._setupAutoSaving(self: DataStore)
+function DataStore._setupAutoSaving(self: DataStore): ()
 	local startTime = os.clock()
 
 	self._maid:GiveTask(Rx.combineLatest({
@@ -364,7 +364,7 @@ function DataStore._setupAutoSaving(self: DataStore)
 	end))
 end
 
-function DataStore._syncData(self: DataStore, doMergeNewData: boolean, doCloseSession: boolean?)
+function DataStore._syncData(self: DataStore, doMergeNewData: boolean, doCloseSession: boolean?): Promise.Promise<()>
 	if self:DidLoadFail() then
 		warn("[DataStore] - Not syncing, failed to load")
 		return Promise.rejected("Load not successful, not syncing")

package/src/Server/GameDataStoreService.lua

@@ -18,16 +18,31 @@ local ServiceBag = require("ServiceBag")
 local GameDataStoreService = {}
 GameDataStoreService.ServiceName = "GameDataStoreService"
 
-function GameDataStoreService:Init(serviceBag: ServiceBag.ServiceBag)
-	assert(not self._serviceBag, "Already initialized")
+export type GameDataStoreService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: ServiceBag.ServiceBag,
+		_maid: Maid.Maid,
+		_dataStorePromise: Promise.Promise<DataStore.DataStore>?,
+		_robloxDataStorePromise: Promise.Promise<any>?,
+		_bindToCloseService: any,
+	},
+	{} :: typeof({ __index = GameDataStoreService })
+))
+
+function GameDataStoreService.Init(self: GameDataStoreService, serviceBag: ServiceBag.ServiceBag): ()
+	assert(not (self :: any)._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
 
 	self._bindToCloseService = self._serviceBag:GetService(require("BindToCloseService"))
-
-	self._maid = Maid.new()
 end
 
-function GameDataStoreService:PromiseDataStore(): Promise.Promise<DataStore>
+--[=[
+	Promises a DataStore for the current game that is synchronized every 5 seconds.
+
+	@return Promise<DataStore>
+]=]
+function GameDataStoreService.PromiseDataStore(self: GameDataStoreService): Promise.Promise<DataStore>
 	if self._dataStorePromise then
 		return self._dataStorePromise
 	end
@@ -48,11 +63,12 @@ function GameDataStoreService:PromiseDataStore(): Promise.Promise<DataStore>
 
 		return dataStore
 	end)
+	assert(self._dataStorePromise, "Typechecking assertion")
 
 	return self._dataStorePromise
 end
 
-function GameDataStoreService:_promiseRobloxDataStore(): Promise.Promise<any>
+function GameDataStoreService._promiseRobloxDataStore(self: GameDataStoreService): Promise.Promise<any>
 	if self._robloxDataStorePromise then
 		return self._robloxDataStorePromise
 	end
@@ -60,14 +76,16 @@ function GameDataStoreService:_promiseRobloxDataStore(): Promise.Promise<any>
 	self._robloxDataStorePromise =
 		self._maid:GivePromise(DataStorePromises.promiseDataStore("GameDataStore", "Version1"))
 
+	assert(self._robloxDataStorePromise, "Typechecking assertion")
+
 	return self._robloxDataStorePromise
 end
 
-function GameDataStoreService:_getKey(): string
+function GameDataStoreService._getKey(_self: GameDataStoreService): string
 	return "version1"
 end
 
-function GameDataStoreService:Destroy()
+function GameDataStoreService.Destroy(self: GameDataStoreService)
 	self._maid:DoCleaning()
 end
 

package/src/Server/Modules/DataStoreDeleteToken.lua

@@ -9,4 +9,6 @@ local require = require(script.Parent.loader).load(script)
 
 local Symbol = require("Symbol")
 
-return Symbol.named("dataStoreDeleteToken")
+export type DataStoreDeleteToken = Symbol.Symbol
+
+return Symbol.named("dataStoreDeleteToken") :: DataStoreDeleteToken

package/src/Server/Modules/DataStoreStage.lua

@@ -111,8 +111,12 @@ end
 	@param key string
 	@param value any
 ]=]
-function DataStoreStage.Store(self: DataStoreStage, key: string, value: any)
-	assert(type(key) == "string", "Bad key")
+function DataStoreStage.Store(
+	self: DataStoreStage,
+	key: DataStoreStageKey,
+	value: any | DataStoreDeleteToken.DataStoreDeleteToken
+): ()
+	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if value == nil then
 		value = DataStoreDeleteToken
@@ -133,7 +137,7 @@ end
 	end)
 	```
 
-	@param key string | number
+	@param key DataStoreStageKey
 	@param defaultValue T?
 	@return Promise<T>
 ]=]
@@ -166,7 +170,7 @@ end
 	@param defaultValue any
 	@return Promise<any>
 ]=]
-function DataStoreStage.LoadAll(self: DataStoreStage, defaultValue)
+function DataStoreStage.LoadAll<T>(self: DataStoreStage, defaultValue: T?): Promise.Promise<T?>
 	return self:PromiseViewUpToDate():Then(function()
 		if self._viewSnapshot == nil then
 			return defaultValue
@@ -187,10 +191,10 @@ end
 	saveslot:Store("Money", 0)
 	```
 
-	@param key string | number
+	@param key DataStoreStageKey
 	@return DataStoreStage
 ]=]
-function DataStoreStage.GetSubStore(self: DataStoreStage, key: DataStoreStageKey)
+function DataStoreStage.GetSubStore(self: DataStoreStage, key: DataStoreStageKey): DataStoreStage
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if self._stores[key] then
@@ -243,10 +247,10 @@ end
 --[=[
 	Explicitely deletes data at the key
 
-	@param key string | number
+	@param key DataStoreStageKey
 ]=]
-function DataStoreStage.Delete(self: DataStoreStage, key: string)
-	assert(type(key) == "string", "Bad key")
+function DataStoreStage.Delete(self: DataStoreStage, key: DataStoreStageKey): ()
+	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	self:_storeAtKey(key, DataStoreDeleteToken)
 end
@@ -254,7 +258,7 @@ end
 --[=[
 	Queues up a wipe of all values. This will completely set the data to nil.
 ]=]
-function DataStoreStage.Wipe(self: DataStoreStage)
+function DataStoreStage.Wipe(self: DataStoreStage): ()
 	self:Overwrite(DataStoreDeleteToken)
 end
 
@@ -263,12 +267,16 @@ end
 
 	If no key is passed than it will observe the whole view snapshot
 
-	@param key string | number?
+	@param key DataStoreStageKey?
 	@param defaultValue T?
 	@return Observable<T>
 ]=]
-function DataStoreStage.Observe(self: DataStoreStage, key, defaultValue)
-	assert(type(key) == "string" or type(key) == "number" or key == nil, "Bad key")
+function DataStoreStage.Observe<T>(
+	self: DataStoreStage,
+	key: DataStoreStageKey?,
+	defaultValue: T?
+): Observable.Observable<T>
+	assert(type(key) == "string" or type(key) == "number", "Bad key")
 
 	if key == nil then
 		return Observable.new(function(sub)
@@ -293,7 +301,7 @@ function DataStoreStage.Observe(self: DataStoreStage, key, defaultValue)
 			end)
 
 			return maid
-		end)
+		end) :: any
 	end
 
 	return Observable.new(function(sub)
@@ -315,16 +323,16 @@ function DataStoreStage.Observe(self: DataStoreStage, key, defaultValue)
 		end)
 
 		return maid
-	end)
+	end) :: any
 end
 
 --[=[
 	Adds a callback to be called before save. This may return a promise.
 
 	@param callback function -- May return a promise
-	@return function -- Call to remove
+	@return () -> () -- Call to remove
 ]=]
-function DataStoreStage.AddSavingCallback(self: DataStoreStage, callback: DataStoreCallback?)
+function DataStoreStage.AddSavingCallback(self: DataStoreStage, callback: DataStoreCallback?): () -> ()
 	assert(type(callback) == "function", "Bad callback")
 
 	table.insert(self._savingCallbacks, callback)
@@ -340,7 +348,7 @@ end
 	Removes a saving callback from the data store stage
 	@param callback function
 ]=]
-function DataStoreStage.RemoveSavingCallback(self: DataStoreStage, callback: DataStoreCallback?)
+function DataStoreStage.RemoveSavingCallback(self: DataStoreStage, callback: DataStoreCallback?): ()
 	assert(type(callback) == "function", "Bad callback")
 
 	local index = table.find(self._savingCallbacks, callback)
@@ -434,7 +442,7 @@ end
 
 	@param parentWriter DataStoreWriter
 ]=]
-function DataStoreStage.MarkDataAsSaved(self: DataStoreStage, parentWriter: DataStoreWriter.DataStoreWriter)
+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]
@@ -504,7 +512,7 @@ end
 
 	@return Promise
 ]=]
-function DataStoreStage.PromiseViewUpToDate(self: DataStoreStage)
+function DataStoreStage.PromiseViewUpToDate(self: DataStoreStage): Promise.Promise<()>
 	if not self._loadParent then
 		error("[DataStoreStage.Load] - Failed to load, no loadParent!")
 	end
@@ -525,7 +533,7 @@ end
 
 	@param data any
 ]=]
-function DataStoreStage.Overwrite(self: DataStoreStage, data)
+function DataStoreStage.Overwrite(self: DataStoreStage, data: any | DataStoreDeleteToken.DataStoreDeleteToken): ()
 	-- Ensure that we at least start loading (and thus the autosave loop) for write
 	self:PromiseViewUpToDate()
 
@@ -578,7 +586,7 @@ end
 
 	@param data any
 ]=]
-function DataStoreStage.OverwriteMerge(self: DataStoreStage, data)
+function DataStoreStage.OverwriteMerge(self: DataStoreStage, data: any): ()
 	-- Ensure that we at least start loading (and thus the autosave loop) for write
 	self:PromiseViewUpToDate()
 
@@ -775,7 +783,7 @@ end
 function DataStoreStage._updateStoresAndComputeBaseDataSnapshotValueFromDiffSnapshot(
 	self: DataStoreStage,
 	key: DataStoreStageKey,
-	value
+	value: any | DataStoreDeleteToken.DataStoreDeleteToken
 )
 	assert(type(key) == "string" or type(key) == "number", "Bad key")
 

package/src/Server/Modules/DataStoreWriter.lua

@@ -95,7 +95,7 @@ end
 
 --[=[
 	Adds a recursive child writer to use at the key `name`
-	@param name string | number
+	@param name DataStoreStageKey
 	@param writer DataStoreWriter
 ]=]
 function DataStoreWriter.AddSubWriter(self: DataStoreWriter, name: DataStoreStageKey, writer: DataStoreWriter)
@@ -109,7 +109,7 @@ end
 --[=[
 	Gets a sub writer
 
-	@param name string | number
+	@param name DataStoreStageKey
 	@return DataStoreWriter
 ]=]
 function DataStoreWriter.GetWriter(self: DataStoreWriter, name: DataStoreStageKey): DataStoreWriter?

package/src/Server/PlayerDataStoreService.lua

@@ -25,6 +25,8 @@ export type PlayerDataStoreService = typeof(setmetatable(
 		_dataStoreName: string,
 		_dataStoreScope: string,
 		_dataStoreManagerPromise: Promise.Promise<PlayerDataStoreManager.PlayerDataStoreManager>,
+		_bindToCloseService: any,
+		_promiseStarted: Promise.Promise<()>,
 	},
 	{} :: typeof({ __index = PlayerDataStoreService })
 ))
@@ -33,7 +35,7 @@ export type PlayerDataStoreService = typeof(setmetatable(
 	Initializes the PlayerDataStoreService. Should be done via [ServiceBag.Init].
 	@param serviceBag ServiceBag
 ]=]
-function PlayerDataStoreService:Init(serviceBag: ServiceBag.ServiceBag)
+function PlayerDataStoreService.Init(self: PlayerDataStoreService, serviceBag: ServiceBag.ServiceBag): ()
 	self._serviceBag = assert(serviceBag, "No serviceBag")
 	self._maid = Maid.new()
 
@@ -49,7 +51,7 @@ end
 --[=[
 	Initializes the datastore service for players. Should be done via [ServiceBag.Start].
 ]=]
-function PlayerDataStoreService:Start()
+function PlayerDataStoreService.Start(self: PlayerDataStoreService): ()
 	-- Give time for configuration
 	self._promiseStarted:Resolve()
 end
@@ -63,7 +65,7 @@ end
 
 	@param dataStoreName string
 ]=]
-function PlayerDataStoreService:SetDataStoreName(dataStoreName: string): ()
+function PlayerDataStoreService.SetDataStoreName(self: PlayerDataStoreService, dataStoreName: string): ()
 	assert(type(dataStoreName) == "string", "Bad dataStoreName")
 	assert(self._promiseStarted, "Not initialized")
 	assert(self._promiseStarted:IsPending(), "Already started, cannot configure")
@@ -80,7 +82,7 @@ end
 
 	@param dataStoreScope string
 ]=]
-function PlayerDataStoreService:SetDataStoreScope(dataStoreScope: string): ()
+function PlayerDataStoreService.SetDataStoreScope(self: PlayerDataStoreService, dataStoreScope: string): ()
 	assert(type(dataStoreScope) == "string", "Bad dataStoreScope")
 	assert(self._promiseStarted, "Not initialized")
 	assert(self._promiseStarted:IsPending(), "Already started, cannot configure")
@@ -93,7 +95,10 @@ end
 	@param player Player
 	@return Promise<DataStore>
 ]=]
-function PlayerDataStoreService:PromiseDataStore(player: Player): Promise.Promise<DataStore.DataStore>
+function PlayerDataStoreService.PromiseDataStore(
+	self: PlayerDataStoreService,
+	player: Player
+): Promise.Promise<DataStore.DataStore>
 	return self:PromiseManager():Then(function(manager)
 		return manager:GetDataStore(player)
 	end)
@@ -104,7 +109,10 @@ end
 	@param callback function -- May return a promise
 	@return Promise
 ]=]
-function PlayerDataStoreService:PromiseAddRemovingCallback(callback)
+function PlayerDataStoreService.PromiseAddRemovingCallback(
+	self: PlayerDataStoreService,
+	callback: () -> Promise.Promise<any>?
+): Promise.Promise<()>
 	return self:PromiseManager():Then(function(manager)
 		manager:AddRemovingCallback(callback)
 	end)
@@ -114,7 +122,9 @@ end
 	Retrieves the manager
 	@return Promise<PlayerDataStoreManager>
 ]=]
-function PlayerDataStoreService:PromiseManager(): Promise.Promise<PlayerDataStoreManager.PlayerDataStoreManager>
+function PlayerDataStoreService.PromiseManager(
+	self: PlayerDataStoreService
+): Promise.Promise<PlayerDataStoreManager.PlayerDataStoreManager>
 	if self._dataStoreManagerPromise then
 		return self._dataStoreManagerPromise
 	end
@@ -135,11 +145,12 @@ function PlayerDataStoreService:PromiseManager(): Promise.Promise<PlayerDataStor
 
 			return manager
 		end)
+	assert(self._dataStoreManagerPromise, "Typechecking assertion")
 
 	return self._dataStoreManagerPromise
 end
 
-function PlayerDataStoreService:Destroy()
+function PlayerDataStoreService.Destroy(self: PlayerDataStoreService): ()
 	self._maid:DoCleaning()
 end
 

package/src/Server/PrivateServerDataStoreService.lua

@@ -17,23 +17,41 @@ local ServiceBag = require("ServiceBag")
 local PrivateServerDataStoreService = {}
 PrivateServerDataStoreService.ServiceName = "PrivateServerDataStoreService"
 
-function PrivateServerDataStoreService:Init(serviceBag: ServiceBag.ServiceBag)
-	assert(not self._serviceBag, "Already initialized")
+export type PrivateServerDataStoreService = typeof(setmetatable(
+	{} :: {
+		_serviceBag: ServiceBag.ServiceBag,
+		_maid: Maid.Maid,
+		_dataStorePromise: Promise.Promise<DataStore.DataStore>?,
+		_robloxDataStorePromise: Promise.Promise<any>?,
+		_bindToCloseService: any,
+		_customKey: string?,
+	},
+	{} :: typeof({ __index = PrivateServerDataStoreService })
+))
+
+function PrivateServerDataStoreService.Init(self: PrivateServerDataStoreService, serviceBag: ServiceBag.ServiceBag): ()
+	assert(not (self :: any)._serviceBag, "Already initialized")
 	self._serviceBag = assert(serviceBag, "No serviceBag")
+	self._maid = Maid.new()
 
 	self._bindToCloseService = self._serviceBag:GetService(require("BindToCloseService"))
-
-	self._maid = Maid.new()
 end
 
-function PrivateServerDataStoreService:PromiseDataStore(): Promise.Promise<DataStore.DataStore>
+--[=[
+	Promises a DataStore for the current private server. If this is not a private server, it returns a datastore
+	that is keyed towards "main".
+
+	@return Promise<DataStore>
+]=]
+function PrivateServerDataStoreService.PromiseDataStore(
+	self: PrivateServerDataStoreService
+): Promise.Promise<DataStore.DataStore>
 	if self._dataStorePromise then
 		return self._dataStorePromise
 	end
 
 	self._dataStorePromise = self:_promiseRobloxDataStore():Then(function(robloxDataStore)
-		local dataStore = DataStore.new(robloxDataStore, self:_getKey())
-		self._maid:GiveTask(dataStore)
+		local dataStore = self._maid:Add(DataStore.new(robloxDataStore, self:_getKey()))
 
 		if game.PrivateServerOwnerId ~= 0 then
 			dataStore:Store("LastPrivateServerOwnerId", game.PrivateServerOwnerId)
@@ -45,11 +63,12 @@ function PrivateServerDataStoreService:PromiseDataStore(): Promise.Promise<DataS
 
 		return dataStore
 	end)
+	assert(self._dataStorePromise, "Typechecking assertion")
 
 	return self._dataStorePromise
 end
 
-function PrivateServerDataStoreService:SetCustomKey(customKey: string)
+function PrivateServerDataStoreService.SetCustomKey(self: PrivateServerDataStoreService, customKey: string): ()
 	assert(
 		self._dataStorePromise == nil,
 		"[PrivateServerDataStoreService] - Already got datastore, cannot set custom key"
@@ -58,7 +77,9 @@ function PrivateServerDataStoreService:SetCustomKey(customKey: string)
 	self._customKey = customKey
 end
 
-function PrivateServerDataStoreService:_promiseRobloxDataStore(): Promise.Promise<any>
+function PrivateServerDataStoreService._promiseRobloxDataStore(
+	self: PrivateServerDataStoreService
+): Promise.Promise<any>
 	if self._robloxDataStorePromise then
 		return self._robloxDataStorePromise
 	end
@@ -66,11 +87,12 @@ function PrivateServerDataStoreService:_promiseRobloxDataStore(): Promise.Promis
 	-- This could potentially
 	self._robloxDataStorePromise =
 		self._maid:GivePromise(DataStorePromises.promiseDataStore("PrivateServerDataStores", "Version1"))
+	assert(self._robloxDataStorePromise, "Typechecking assertion")
 
 	return self._robloxDataStorePromise
 end
 
-function PrivateServerDataStoreService:_getKey(): string
+function PrivateServerDataStoreService._getKey(self: PrivateServerDataStoreService): string
 	if self._customKey then
 		return self._customKey
 	end
@@ -81,7 +103,7 @@ function PrivateServerDataStoreService:_getKey(): string
 	end
 end
 
-function PrivateServerDataStoreService:Destroy(): ()
+function PrivateServerDataStoreService.Destroy(self: PrivateServerDataStoreService): ()
 	self._maid:DoCleaning()
 end