@quenty/gameproductservice 14.0.0 → 14.1.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.
 
+# [14.1.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gameproductservice@14.0.0...@quenty/gameproductservice@14.1.0) (2024-03-09)
+
+
+### Features
+
+* Add PromisePlayerPromptClosed() to GameProductService ([1a8ced1](https://github.com/Quenty/NevermoreEngine/commit/1a8ced1c83c7318107fe5a92bded8559bad3c06b))
+
+
+
+
+
 # [14.0.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/gameproductservice@13.0.0...@quenty/gameproductservice@14.0.0) (2024-02-14)
 
 **Note:** Version bump only for package @quenty/gameproductservice

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/gameproductservice",
-  "version": "14.0.0",
+  "version": "14.1.0",
   "description": "Generalized monetization system for handling products and purchases correctly.",
   "keywords": [
     "Roblox",
@@ -27,31 +27,31 @@
     "access": "public"
   },
   "dependencies": {
-    "@quenty/attributeutils": "^14.0.0",
-    "@quenty/baseobject": "^10.0.0",
-    "@quenty/binder": "^14.0.0",
-    "@quenty/brio": "^14.0.0",
+    "@quenty/attributeutils": "^14.1.0",
+    "@quenty/baseobject": "^10.1.0",
+    "@quenty/binder": "^14.1.0",
+    "@quenty/brio": "^14.1.0",
     "@quenty/enumutils": "^3.1.0",
-    "@quenty/gameconfig": "^12.0.0",
-    "@quenty/instanceutils": "^13.0.0",
-    "@quenty/loader": "^10.0.0",
-    "@quenty/maid": "^3.0.0",
-    "@quenty/marketplaceutils": "^11.0.0",
-    "@quenty/observablecollection": "^12.0.0",
-    "@quenty/playerbinder": "^14.0.0",
-    "@quenty/playerutils": "^8.0.0",
-    "@quenty/promise": "^10.0.0",
-    "@quenty/promisemaid": "^5.0.0",
-    "@quenty/receiptprocessing": "^7.0.0",
-    "@quenty/remoting": "^12.0.0",
-    "@quenty/rx": "^13.0.0",
-    "@quenty/rxbinderutils": "^14.0.0",
-    "@quenty/servicebag": "^11.0.0",
-    "@quenty/signal": "^7.0.0",
-    "@quenty/statestack": "^14.0.0",
+    "@quenty/gameconfig": "^12.1.0",
+    "@quenty/instanceutils": "^13.1.0",
+    "@quenty/loader": "^10.1.0",
+    "@quenty/maid": "^3.1.0",
+    "@quenty/marketplaceutils": "^11.1.0",
+    "@quenty/observablecollection": "^12.1.0",
+    "@quenty/playerbinder": "^14.1.0",
+    "@quenty/playerutils": "^8.1.0",
+    "@quenty/promise": "^10.1.0",
+    "@quenty/promisemaid": "^5.1.0",
+    "@quenty/receiptprocessing": "^7.1.0",
+    "@quenty/remoting": "^12.1.0",
+    "@quenty/rx": "^13.1.0",
+    "@quenty/rxbinderutils": "^14.1.0",
+    "@quenty/servicebag": "^11.1.0",
+    "@quenty/signal": "^7.1.0",
+    "@quenty/statestack": "^14.1.0",
     "@quenty/string": "^3.1.0",
     "@quenty/table": "^3.4.0",
-    "@quenty/valueobject": "^13.0.0"
+    "@quenty/valueobject": "^13.1.0"
   },
-  "gitHead": "63f949a67b77d3edc98b358cace163da8c789e9f"
+  "gitHead": "e0148dde5ca3864389a0faa2da66153a776acc1e"
 }

package/src/Client/GameProductServiceClient.lua

@@ -187,7 +187,7 @@ end
 	Returns true if the prompt is open
 
 	@param player Player
-	@return boolean
+	@return Promise<boolean>
 ]=]
 function GameProductServiceClient:PromisePlayerIsPromptOpen(player)
 	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
@@ -197,6 +197,20 @@ function GameProductServiceClient:PromisePlayerIsPromptOpen(player)
 	return self._helper:PromisePlayerIsPromptOpen(player)
 end
 
+--[=[
+	Returns a promise that will resolve when all prompts are closed
+
+	@param player Player
+	@return Promise
+]=]
+function GameProductServiceClient:PromisePlayerPromptClosed(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(self ~= GameProductServiceClient, "Use serviceBag")
+	assert(self._serviceBag, "Not initialized")
+
+	return self._helper:PromisePlayerPromptClosed(player)
+end
+
 --[=[
 	Checks if the asset is ownable and if it is, checks player ownership. Otherwise, it checks if the asset
 	has been purchased this session. If the asset has not been purchased this session it prompts the user to

package/src/Server/GameProductService.lua

@@ -128,6 +128,32 @@ function GameProductService:HasPlayerPurchasedThisSession(player, assetType, idO
 	return self._helper:HasPlayerPurchasedThisSession(player, assetType, idOrKey)
 end
 
+--[=[
+	Returns true if the prompt is open
+
+	@param player Player
+	@return Promise<boolean>
+]=]
+function GameProductService:PromisePlayerIsPromptOpen(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(self._serviceBag, "Not initialized")
+
+	return self._helper:PromisePlayerIsPromptOpen(player)
+end
+
+--[=[
+	Returns a promise that will resolve when all prompts are closed
+
+	@param player Player
+	@return Promise
+]=]
+function GameProductService:PromisePlayerPromptClosed(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+	assert(self._serviceBag, "Not initialized")
+
+	return self._helper:PromisePlayerPromptClosed(player)
+end
+
 --[=[
 	Prompts the user to purchase the asset, and returns true if purchased
 

package/src/Shared/Helpers/GameProductServiceHelper.lua

@@ -126,6 +126,22 @@ function GameProductServiceHelper:PromisePlayerIsPromptOpen(player)
 			return marketeer:IsPromptOpen()
 		end)
 end
+
+--[=[
+	Promises the player prompt as opened
+
+	@param player Player
+	@return Promise<boolean>
+]=]
+function GameProductServiceHelper:PromisePlayerPromptClosed(player)
+	assert(typeof(player) == "Instance" and player:IsA("Player"), "Bad player")
+
+	return self:_promisePlayerMarketeer(player)
+		:Then(function(marketeer)
+			return marketeer:PromisePlayerPromptClosed()
+		end)
+end
+
 --[=[
 	Observes player ownership
 

package/src/Shared/Trackers/PlayerAssetMarketTracker.lua

@@ -12,6 +12,7 @@ local Maid = require("Maid")
 local Observable = require("Observable")
 local Promise = require("Promise")
 local Signal = require("Signal")
+local ValueObject = require("ValueObject")
 
 local PlayerAssetMarketTracker = setmetatable({}, BaseObject)
 PlayerAssetMarketTracker.ClassName = "PlayerAssetMarketTracker"
@@ -38,23 +39,25 @@ function PlayerAssetMarketTracker.new(assetType, convertIds, observeIdsBrio)
 	self._purchasedThisSession = {} -- [number] = true
 	self._receiptProcessingExpected = false
 
-	self._promptsOpen = Instance.new("IntValue")
-	self._promptsOpen.Value = 0
-	self._maid:GiveTask(self._promptsOpen)
-
-	self.Purchased = Signal.new() -- :Fire(id)
-	self._maid:GiveTask(self.Purchased)
-
-	self.PromptFinished = Signal.new() -- :Fire(id, isPurchased)
-	self._maid:GiveTask(self.PromptFinished)
-
-	self.ShowPromptRequested = Signal.new() -- :Fire(id)
-	self._maid:GiveTask(self.ShowPromptRequested)
+	self._promptsOpenCount = self._maid:Add(ValueObject.new(0, "number"))
+	self.Purchased = self._maid:Add(Signal.new()) -- :Fire(id)
+	self.PromptFinished = self._maid:Add(Signal.new()) -- :Fire(id, isPurchased)
+	self.ShowPromptRequested = self._maid:Add(Signal.new()) -- :Fire(id)
 
 	self._maid:GiveTask(self.Purchased:Connect(function(id)
 		self._purchasedThisSession[id] = true
 	end))
 
+	self._maid:GiveTask(self._promptsOpenCount:Observe():Subscribe(function(promptsOpen)
+		if promptsOpen <= 0 then
+			local promise = self._promiseNoPromptOpen
+			self._promiseNoPromptOpen = nil
+			if promise then
+				promise:Resolve()
+			end
+		end
+	end))
+
 	self._maid:GiveTask(function()
 		while #self._pendingPurchasePromises > 0 do
 			local pending = table.remove(self._pendingPurchasePromises, #self._pendingPurchasePromises)
@@ -70,6 +73,10 @@ function PlayerAssetMarketTracker.new(assetType, convertIds, observeIdsBrio)
 	return self
 end
 
+function PlayerAssetMarketTracker:ObservePromptOpenCount()
+	return self._promptsOpenCount:Observe()
+end
+
 --[=[
 	Observes an asset purchased
 
@@ -142,7 +149,7 @@ function PlayerAssetMarketTracker:PromisePromptPurchase(idOrKey)
 			end
 
 			-- We reject here because there's no safe way to queue this
-			if self._promptsOpen.Value > 0 then
+			if self._promptsOpenCount.Value > 0 then
 				return Promise.rejected(string.format("[PlayerAssetMarketTracker] - Either already prompting user, or prompting is on cooldown. Will not prompt for %s", idOrKey))
 			end
 
@@ -161,12 +168,12 @@ function PlayerAssetMarketTracker:PromisePromptPurchase(idOrKey)
 				local promptOpenPromise = Promise.new()
 				self._pendingPromptOpenPromises[id] = promptOpenPromise
 
-				self._promptsOpen.Value = self._promptsOpen.Value + 1
+				self._promptsOpenCount.Value = self._promptsOpenCount.Value + 1
 				promptOpenPromise:Finally(function()
 					if self._pendingPromptOpenPromises[id] == promptOpenPromise then
 						self._pendingPromptOpenPromises[id] = nil
 					end
-					self._promptsOpen.Value = self._promptsOpen.Value - 1
+					self._promptsOpenCount.Value = self._promptsOpenCount.Value - 1
 				end)
 			end
 
@@ -225,7 +232,7 @@ end
 	@return boolean
 ]=]
 function PlayerAssetMarketTracker:IsPromptOpen()
-	return self._promptsOpen.Value > 0
+	return self._promptsOpenCount.Value > 0
 end
 
 --[=[

package/src/Shared/Trackers/PlayerMarketeer.lua

@@ -14,6 +14,8 @@ local MarketplaceUtils = require("MarketplaceUtils")
 local PlayerAssetOwnershipTracker = require("PlayerAssetOwnershipTracker")
 local PlayerAssetMarketTracker = require("PlayerAssetMarketTracker")
 local GameConfigAssetTypeUtils = require("GameConfigAssetTypeUtils")
+local Promise = require("Promise")
+local Rx = require("Rx")
 
 local PlayerMarketeer = setmetatable({}, BaseObject)
 PlayerMarketeer.ClassName = "PlayerMarketeer"
@@ -102,6 +104,46 @@ function PlayerMarketeer:IsPromptOpen()
 	return false
 end
 
+--[=[
+	Promises that no prompt is open
+
+	@return Promise
+]=]
+function PlayerMarketeer:PromisePlayerPromptClosed()
+	if not self:IsPromptOpen() then
+		return Promise.resolved()
+	end
+
+	if self._observeNextNoPromptOpen then
+		return Rx.toPromise(self._observeNextNoPromptOpen)
+	end
+
+	local observeOpenCounts = {}
+
+	for assetType, assetTracker in pairs(self._assetMarketTrackers) do
+		observeOpenCounts[assetType] = assetTracker:ObservePromptOpenCount()
+	end
+
+	self._observeNextNoPromptOpen = Rx.combineLatest(observeOpenCounts):Pipe({
+		Rx.map(function(state)
+			for _, item in pairs(state) do
+				if item > 0 then
+					return false
+				end
+			end
+
+			return true
+		end);
+		Rx.where(function(value)
+			return value
+		end);
+		Rx.distinct();
+		Rx.share();
+	})
+
+	return Rx.toPromise(self._observeNextNoPromptOpen)
+end
+
 --[=[
 	Gets the current asset tracker