@quenty/datastore 3.5.0 → 3.6.0

package/CHANGELOG.md

@@ -3,6 +3,25 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+# [3.6.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@3.5.1...@quenty/datastore@3.6.0) (2022-01-17)
+
+
+### Features
+
+* Add optional PlayerDataStoreService to centralize datastore usage across submodules. ([1c4349f](https://github.com/Quenty/NevermoreEngine/commit/1c4349fa3ed4ef59ed41117319057ca9e2bd6dfd))
+
+
+
+
+
+## [3.5.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@3.5.0...@quenty/datastore@3.5.1) (2022-01-16)
+
+**Note:** Version bump only for package @quenty/datastore
+
+
+
+
+
 # [3.5.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/datastore@3.4.0...@quenty/datastore@3.5.0) (2022-01-07)
 
 **Note:** Version bump only for package @quenty/datastore

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/datastore",
-  "version": "3.5.0",
+  "version": "3.6.0",
   "description": "Quenty's Datastore implementation for Roblox",
   "keywords": [
     "Roblox",
@@ -26,10 +26,10 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^3.4.0",
-    "@quenty/loader": "^3.3.0",
-    "@quenty/maid": "^2.0.2",
-    "@quenty/promise": "^3.5.0",
+    "@quenty/baseobject": "^3.5.0",
+    "@quenty/loader": "^3.4.0",
+    "@quenty/maid": "^2.1.0",
+    "@quenty/promise": "^3.6.0",
     "@quenty/signal": "^2.1.0",
     "@quenty/symbol": "^2.0.1",
     "@quenty/table": "^2.1.1"
@@ -37,5 +37,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "5a3f3fb6c908fd3874f5ceacc70b404780275119"
+  "gitHead": "c094ba8f4e128cdff08919d89de226d3d65247ce"
 }

package/src/Server/PlayerDataStoreService.lua

@@ -0,0 +1,124 @@
+--[=[
+	Centralized service using serviceBag. This will let other packages work with a single player datastore service.
+
+	@server
+	@class PlayerDataStoreService
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local PlayerDataStoreManager = require("PlayerDataStoreManager")
+local DataStorePromises = require("DataStorePromises")
+local Promise = require("Promise")
+local Maid = require("Maid")
+
+local PlayerDataStoreService = {}
+
+--[=[
+	Initializes the PlayerDataStoreService. Should be done via [ServiceBag.Init].
+	@param serviceBag ServiceBag
+]=]
+function PlayerDataStoreService:Init(serviceBag)
+	self._serviceBag = assert(serviceBag, "No serviceBag")
+
+	self._maid = Maid.new()
+	self._started = Promise.new()
+	self._maid:GiveTask(self._started)
+
+	self._dataStoreName = "PlayerData"
+	self._dataStoreScope = "SaveData"
+end
+
+--[=[
+	Initializes the datastore service for players. Should be done via [ServiceBag.Start].
+]=]
+function PlayerDataStoreService:Start()
+	-- Give time for configuration
+	self._started:Resolve()
+end
+
+--[=[
+	Sets the name for the datastore to retrieve.
+
+	:::info
+	Must be done before start and after init.
+	:::
+
+	@param dataStoreName string
+]=]
+function PlayerDataStoreService:SetDataStoreName(dataStoreName)
+	assert(type(dataStoreName) == "string", "Bad dataStoreName")
+	assert(self._started, "Not initialized")
+	assert(self._started:IsPending(), "Already started, cannot configure")
+
+	self._dataStoreName = dataStoreName
+end
+
+--[=[
+	Sets the scope for the datastore to retrieve.
+
+	:::info
+	Must be done before start and after init.
+	:::
+
+	@param dataStoreScope string
+]=]
+function PlayerDataStoreService:SetDataStoreScope(dataStoreScope)
+	assert(type(dataStoreScope) == "string", "Bad dataStoreScope")
+	assert(self._started, "Not initialized")
+	assert(self._started:IsPending(), "Already started, cannot configure")
+
+	self._dataStoreScope = dataStoreScope
+end
+
+--[=[
+	Gets the datastore for the player.
+	@param player Player
+	@return Promise<DataStore>
+]=]
+function PlayerDataStoreService:PromiseDataStore(player)
+	return self:PromiseManager()
+		:Then(function(manager)
+			return manager:GetDataStore(player)
+		end)
+end
+
+--[=[
+	Adds a removing callback to the manager.
+	@param callback function
+	@return Promise
+]=]
+function PlayerDataStoreService:PromiseAddRemovingCallback(callback)
+	return self:PromiseManager()
+		:Then(function(manager)
+			manager:AddRemovingCallback(callback)
+		end)
+end
+
+--[=[
+	Retrieves the manager
+	@return PlayerDataStoreManager
+]=]
+function PlayerDataStoreService:PromiseManager()
+	if self._dataStoreManagerPromise then
+		return self._dataStoreManagerPromise
+	end
+
+	self._dataStoreManagerPromise = self._started
+		:Then(function()
+			return DataStorePromises.promiseDataStore(self._dataStoreName, self._dataStoreScope)
+		end)
+		:Then(function(dataStore)
+			local manager = PlayerDataStoreManager.new(
+				dataStore,
+				function(player)
+					return tostring(player.UserId)
+				end)
+			self._maid:GiveTask(manager)
+			return manager
+		end)
+
+	return self._dataStoreManagerPromise
+end
+
+return PlayerDataStoreService