@quenty/promptqueue 1.0.1-canary.468.ea8a226.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 1.0.1-canary.468.ea8a226.0 (2024-05-09)
+
+
+### Features
+
+* Add PromptQueue package ([6b0dd39](https://github.com/Quenty/NevermoreEngine/commit/6b0dd39938ef2d4c3b31dd9f57301668f239bb65))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2024 James Onnen (Quenty)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,23 @@
+## PromptQueue
+
+<div align="center">
+  <a href="http://quenty.github.io/NevermoreEngine/">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/docs.yml/badge.svg" alt="Documentation status" />
+  </a>
+  <a href="https://discord.gg/mhtGUS8">
+    <img src="https://img.shields.io/discord/385151591524597761?color=5865F2&label=discord&logo=discord&logoColor=white" alt="Discord" />
+  </a>
+  <a href="https://github.com/Quenty/NevermoreEngine/actions">
+    <img src="https://github.com/Quenty/NevermoreEngine/actions/workflows/build.yml/badge.svg" alt="Build and release status" />
+  </a>
+</div>
+
+Queue system for prompts and other UI
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/PromptQueueUtils">View docs →</a></div>
+
+## Installation
+
+```
+npm install @quenty/promptqueue --save
+```

package/default.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "promptqueue",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,38 @@
+{
+  "name": "@quenty/promptqueue",
+  "version": "1.0.1-canary.468.ea8a226.0",
+  "description": "Queue system for prompts and other UI",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "promptqueue"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/promptqueue/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/loader": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/promise": "10.2.1-canary.468.ea8a226.0",
+    "@quenty/signal": "7.2.1-canary.468.ea8a226.0",
+    "@quenty/transitionmodel": "7.2.1-canary.468.ea8a226.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "ea8a2260a364aaf6d6c246a93632b789935da134"
+}

package/src/Shared/PromptQueue.lua

@@ -0,0 +1,199 @@
+--[=[
+	Queue system for prompts and other UI
+
+	@class PromptQueue
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Maid = require("Maid")
+local BaseObject = require("BaseObject")
+local Promise = require("Promise")
+local TransitionModel = require("TransitionModel")
+local ValueObject = require("ValueObject")
+local Signal = require("Signal")
+
+local PromptQueue = setmetatable({}, BaseObject)
+PromptQueue.ClassName = "PromptQueue"
+PromptQueue.__index = PromptQueue
+
+--[=[
+	Constructs a new prompt queue
+	@return PromptQueue
+]=]
+function PromptQueue.new()
+	local self = setmetatable(BaseObject.new(), PromptQueue)
+
+	self._isShowing = self._maid:Add(ValueObject.new(false, "boolean"))
+	self._clearRequested = self._maid:Add(Signal.new())
+
+	self._queue = {}
+	self._currentProcessingEntry = nil
+
+	return self
+end
+
+--[=[
+	Queues a transition model to be shown
+
+	@param transitionModel TransitionModel
+]=]
+function PromptQueue:Queue(transitionModel)
+	assert(TransitionModel.isTransitionModel(transitionModel), "Bad transitionModel")
+
+	local maid = Maid.new()
+	local promise = maid:Add(Promise.new())
+
+	local isCancelling = false
+
+	local entry = {
+		promise = promise;
+		execute = function()
+			assert(promise:IsPending(), "Not pending")
+
+			maid:GivePromise(transitionModel:PromiseShow())
+				:Then(function()
+					if transitionModel.PromiseSustain then
+						return maid:GivePromise(transitionModel:PromiseSustain())
+					end
+				end)
+				:Then(function()
+					return maid:GivePromise(transitionModel:PromiseHide())
+				end)
+				:Then(function()
+					promise:Resolve()
+				end)
+				:Catch(function(...)
+					if promise:IsPending() then
+						return
+					end
+
+					if isCancelling then
+						return
+					end
+
+					warn(string.format("[PromptQueue] - Failed to execute due to %q", tostring(... or nil)))
+					return  Promise.rejected(...)
+				end)
+		end;
+		cancel = function(doNotAnimate)
+			assert(promise:IsPending(), "Not pending")
+			if isCancelling then
+				return
+			end
+
+			isCancelling = true
+
+			maid:GivePromise(transitionModel:PromiseHide(doNotAnimate))
+				:Then(function()
+					promise:Resolve()
+				end)
+				:Catch(function(...)
+					promise:Reject(...)
+
+					if select("#", ...) > 0 then
+						warn(string.format("[PromptQueue] - Failed to cancel due to %q", tostring(... or nil)))
+					end
+
+					return Promise.rejected(...)
+				end)
+		end;
+	}
+
+	table.insert(self._queue, entry)
+
+
+	maid:GiveTask(self._clearRequested:Connect(function(doNotAnimate)
+		entry.cancel(doNotAnimate)
+	end))
+
+	promise:Finally(function()
+		self._maid[maid] = nil
+	end)
+	maid:GiveTask(function()
+		if self._currentProcessingEntry == entry then
+			self._currentProcessingEntry = nil
+		end
+
+		local index = table.find(self._queue, entry)
+		if index then
+			table.remove(self._queue, index)
+		end
+
+		self._maid[maid] = nil
+	end)
+
+	self._maid[maid] = maid
+
+	self:_startQueueProcessing()
+
+	return promise
+end
+
+--[=[
+	Returns if the queue has any items
+
+	@return boolean
+]=]
+function PromptQueue:HasItems()
+	return #self._queue > 0
+end
+
+--[=[
+	Clears the current queue
+
+	@param doNotAnimate boolean?
+]=]
+function PromptQueue:Clear(doNotAnimate)
+	self._clearRequested:Fire(doNotAnimate)
+end
+
+--[=[
+	Promises the current prompt to be hidden
+
+	@param doNotAnimate boolean?
+	@return Promise
+]=]
+function PromptQueue:HideCurrent(doNotAnimate)
+	if self._currentProcessingEntry then
+		local promise = self._currentProcessingEntry.promise
+
+		self._currentProcessingEntry.cancel(doNotAnimate)
+
+	 	return promise
+	else
+		return Promise.resolved()
+	end
+end
+
+function PromptQueue:_startQueueProcessing()
+	if self._maid._processing then
+		return
+	end
+
+	self._maid._processing = task.spawn(function()
+		self._isShowing.Value = true
+
+		local current = table.remove(self._queue, 1)
+		while current do
+			self._currentProcessingEntry = current
+
+			current.execute()
+			current.promise:Yield()
+
+			if self._currentProcessingEntry == current then
+				self._currentProcessingEntry = nil
+			end
+
+			-- Otherwise  we have an issue where we process stuff that should have been already removed...?
+			task.wait(0.05)
+
+			current = table.remove(self._queue, 1)
+		end
+
+		self._isShowing.Value = false
+		self._maid._processing = nil
+	end)
+end
+
+return PromptQueue

package/src/node_modules.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "node_modules",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$path": { "optional": "../node_modules" }
+  }
+}

package/test/default.project.json

@@ -0,0 +1,12 @@
+{
+  "name": "PromptQueueTest",
+  "globIgnorePaths": [ "**/.package-lock.json" ],
+  "tree": {
+    "$className": "DataModel",
+    "ServerScriptService": {
+      "promptqueue": {
+        "$path": ".."
+      }
+    }
+  }
+}