@quenty/undostack 7.17.3 → 7.17.4-canary.11a5dcf.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.
 
+## [7.17.4-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@7.17.3...@quenty/undostack@7.17.4-canary.11a5dcf.0) (2025-05-10)
+
+
+### Bug Fixes
+
+* Additional type checking updates ([05ba29a](https://github.com/Quenty/NevermoreEngine/commit/05ba29a03efc9f3feed74b34f1d9dfb237496214))
+
+
+
+
+
 ## [7.17.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/undostack@7.17.2...@quenty/undostack@7.17.3) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/undostack

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/undostack",
-  "version": "7.17.3",
+  "version": "7.17.4-canary.11a5dcf.0",
   "description": "Generalized undo stack for Roblox",
   "keywords": [
     "Roblox",
@@ -25,17 +25,17 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.3",
-    "@quenty/ducktype": "^5.8.4",
-    "@quenty/instanceutils": "^13.17.3",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/maid": "^3.4.3",
-    "@quenty/promise": "^10.10.4",
-    "@quenty/signal": "^7.10.3",
-    "@quenty/valueobject": "^13.17.3"
+    "@quenty/baseobject": "10.8.4-canary.11a5dcf.0",
+    "@quenty/ducktype": "5.8.5-canary.11a5dcf.0",
+    "@quenty/instanceutils": "13.17.4-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/maid": "3.4.4-canary.11a5dcf.0",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0",
+    "@quenty/signal": "7.10.4-canary.11a5dcf.0",
+    "@quenty/valueobject": "13.17.4-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Shared/UndoStack.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class UndoStack
 ]=]
@@ -5,10 +6,11 @@
 local require = require(script.Parent.loader).load(script)
 
 local BaseObject = require("BaseObject")
+local Maid = require("Maid")
+local Observable = require("Observable")
 local Promise = require("Promise")
 local UndoStackEntry = require("UndoStackEntry")
 local ValueObject = require("ValueObject")
-local Maid = require("Maid")
 
 local DEFAULT_MAX_SIZE = 25
 
@@ -16,8 +18,21 @@ local UndoStack = setmetatable({}, BaseObject)
 UndoStack.ClassName = "UndoStack"
 UndoStack.__index = UndoStack
 
-function UndoStack.new(maxSize: number?)
-	local self = setmetatable(BaseObject.new(), UndoStack)
+export type UndoStack = typeof(setmetatable(
+	{} :: {
+		_undoStack: { UndoStackEntry.UndoStackEntry },
+		_redoStack: { UndoStackEntry.UndoStackEntry },
+		_hasUndoEntries: ValueObject.ValueObject<boolean>,
+		_hasRedoEntries: ValueObject.ValueObject<boolean>,
+		_isActionExecuting: ValueObject.ValueObject<boolean>,
+		_maxSize: number,
+		_latestPromiseChain: Promise.Promise<()>?,
+	},
+	{} :: typeof({ __index = UndoStack })
+)) & BaseObject.BaseObject
+
+function UndoStack.new(maxSize: number?): UndoStack
+	local self: UndoStack = setmetatable(BaseObject.new() :: any, UndoStack)
 
 	assert(type(maxSize) == "number" or maxSize == nil, "Bad maxSize")
 
@@ -38,7 +53,7 @@ end
 	can't push an undo.
 	@return boolean
 ]=]
-function UndoStack:ClearRedoStack()
+function UndoStack.ClearRedoStack(self: UndoStack)
 	self._redoStack = {}
 	self:_updateHasRedoEntries()
 end
@@ -47,7 +62,7 @@ end
 	Returns true if an action is executing
 	@return boolean
 ]=]
-function UndoStack:IsActionExecuting(): boolean
+function UndoStack.IsActionExecuting(self: UndoStack): boolean
 	return self._isActionExecuting.Value
 end
 
@@ -55,7 +70,7 @@ end
 	Observes whether the stack has undo entries
 	@return Observable<boolean>
 ]=]
-function UndoStack:ObserveHasUndoEntries()
+function UndoStack.ObserveHasUndoEntries(self: UndoStack): Observable.Observable<boolean>
 	return self._hasUndoEntries:Observe()
 end
 
@@ -63,7 +78,7 @@ end
 	Observes whether the stack has redo entries
 	@return Observable<boolean>
 ]=]
-function UndoStack:ObserveHasRedoEntries()
+function UndoStack.ObserveHasRedoEntries(self: UndoStack): Observable.Observable<boolean>
 	return self._hasRedoEntries:Observe()
 end
 
@@ -71,7 +86,7 @@ end
 	Returns true if there are undo entries on the stack
 	@return boolean
 ]=]
-function UndoStack:HasUndoEntries()
+function UndoStack.HasUndoEntries(self: UndoStack): boolean
 	return self._hasUndoEntries.Value
 end
 
@@ -79,7 +94,7 @@ end
 	Returns true if there are redo entries on the stack
 	@return boolean
 ]=]
-function UndoStack:HasRedoEntries()
+function UndoStack.HasRedoEntries(self: UndoStack): boolean
 	return self._hasRedoEntries.Value
 end
 
@@ -101,7 +116,7 @@ end
 	@param undoStackEntry UndoStackEntry
 	@return function -- Callback that removes the action
 ]=]
-function UndoStack:Push(undoStackEntry)
+function UndoStack.Push(self: UndoStack, undoStackEntry: UndoStackEntry.UndoStackEntry): () -> ()
 	assert(UndoStackEntry.isUndoStackEntry(undoStackEntry), "Bad undoStackEntry")
 
 	if self._maid[undoStackEntry] then
@@ -142,7 +157,7 @@ end
 
 	@param undoStackEntry The undo stack entry to remove
 ]=]
-function UndoStack:Remove(undoStackEntry)
+function UndoStack.Remove(self: UndoStack, undoStackEntry: UndoStackEntry.UndoStackEntry): ()
 	assert(UndoStackEntry.isUndoStackEntry(undoStackEntry), "Bad undoStackEntry")
 
 	self._maid[undoStackEntry] = nil
@@ -171,7 +186,7 @@ end
 
 	@return Promise
 ]=]
-function UndoStack:PromiseUndo()
+function UndoStack.PromiseUndo(self: UndoStack): Promise.Promise<()>
 	return self:_promiseCurrent(function()
 		local undoStackEntry = table.remove(self._undoStack)
 		if not undoStackEntry then
@@ -182,15 +197,14 @@ function UndoStack:PromiseUndo()
 
 		return self:_executePromiseWithMaid(function(maid)
 			return undoStackEntry:PromiseUndo(maid)
+		end):Then(function()
+			if undoStackEntry:HasRedo() then
+				table.insert(self._redoStack, undoStackEntry)
+				self:_updateHasRedoEntries()
+			end
+
+			return true
 		end)
-			:Then(function()
-				if undoStackEntry:HasRedo() then
-					table.insert(self._redoStack, undoStackEntry)
-					self:_updateHasRedoEntries()
-				end
-
-				return true
-			end)
 	end)
 end
 
@@ -199,7 +213,7 @@ end
 
 	@return Promise
 ]=]
-function UndoStack:PromiseRedo()
+function UndoStack.PromiseRedo(self: UndoStack): Promise.Promise<()>
 	return self:_promiseCurrent(function()
 		local undoStackEntry = table.remove(self._redoStack)
 		if not undoStackEntry then
@@ -210,25 +224,23 @@ function UndoStack:PromiseRedo()
 
 		return self:_executePromiseWithMaid(function(maid)
 			return undoStackEntry:PromiseRedo(maid)
+		end):Then(function()
+			if undoStackEntry:HasUndo() then
+				table.insert(self._undoStack, undoStackEntry)
+				self:_updateHasUndoEntries()
+			end
+
+			return true
 		end)
-			:Then(function()
-				if undoStackEntry:HasUndo() then
-					table.insert(self._undoStack, undoStackEntry)
-					self:_updateHasUndoEntries()
-				end
-
-				return true
-			end)
 	end)
 end
 
-function UndoStack:_promiseCurrent(doNextPromise)
+function UndoStack._promiseCurrent(self: UndoStack, doNextPromise: () -> Promise.Promise<()>): Promise.Promise<()>
 	local promise
 	if self._latestPromiseChain then
-		promise = self._latestPromiseChain
-			:Finally(function()
-				return self._maid:GivePromise(doNextPromise())
-			end)
+		promise = self._latestPromiseChain:Finally(function()
+			return self._maid:GivePromise(doNextPromise())
+		end)
 	else
 		promise = self._maid:GivePromise(doNextPromise())
 	end
@@ -248,8 +260,8 @@ function UndoStack:_promiseCurrent(doNextPromise)
 	return promise
 end
 
-function UndoStack:_executePromiseWithMaid(callback)
-	local maid  = Maid.new()
+function UndoStack._executePromiseWithMaid(self: UndoStack, callback: (Maid.Maid) -> any): Promise.Promise<()>
+	local maid = Maid.new()
 
 	local promise = Promise.new()
 	maid:GiveTask(promise)
@@ -270,12 +282,12 @@ function UndoStack:_executePromiseWithMaid(callback)
 	return promise
 end
 
-function UndoStack:_updateHasUndoEntries()
+function UndoStack._updateHasUndoEntries(self: UndoStack)
 	self._hasUndoEntries.Value = #self._undoStack > 0
 end
 
-function UndoStack:_updateHasRedoEntries()
+function UndoStack._updateHasRedoEntries(self: UndoStack)
 	self._hasRedoEntries.Value = #self._redoStack > 0
 end
 
-return UndoStack
+return UndoStack

package/src/Shared/UndoStackEntry.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Holds undo state
 	@class UndoStackEntry
@@ -5,23 +6,35 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Promise = require("Promise")
-local Maid = require("Maid")
 local BaseObject = require("BaseObject")
-local Signal = require("Signal")
 local DuckTypeUtils = require("DuckTypeUtils")
+local Maid = require("Maid")
+local Promise = require("Promise")
+local Signal = require("Signal")
 
 local UndoStackEntry = setmetatable({}, BaseObject)
 UndoStackEntry.ClassName = "UndoStackEntry"
 UndoStackEntry.__index = UndoStackEntry
 
+export type ExecuteUndo = (Maid.Maid) -> Promise.Promise<()> | any
+export type ExecuteRedo = (Maid.Maid) -> Promise.Promise<()> | any
+
+export type UndoStackEntry = typeof(setmetatable(
+	{} :: {
+		Destroying: Signal.Signal<()>,
+		_promiseUndo: ExecuteUndo?,
+		_promiseRedo: ExecuteRedo?,
+	},
+	{} :: typeof({ __index = UndoStackEntry })
+)) & BaseObject.BaseObject
+
 --[=[
 	Constructs a new undo restack entry. See [UndoStack] for usage.
 
 	@return UndoStackEntry
 ]=]
-function UndoStackEntry.new()
-	local self = setmetatable(BaseObject.new(), UndoStackEntry)
+function UndoStackEntry.new(): UndoStackEntry
+	local self: UndoStackEntry = setmetatable(BaseObject.new() :: any, UndoStackEntry)
 
 	self.Destroying = Signal.new()
 	self._maid:GiveTask(function()
@@ -47,7 +60,7 @@ end
 
 	@param promiseUndo function | nil
 ]=]
-function UndoStackEntry:SetPromiseUndo(promiseUndo)
+function UndoStackEntry.SetPromiseUndo(self: UndoStackEntry, promiseUndo: ExecuteUndo)
 	assert(type(promiseUndo) == "function" or promiseUndo == nil, "Bad promiseUndo")
 
 	self._promiseUndo = promiseUndo
@@ -58,7 +71,7 @@ end
 
 	@param promiseRedo function | nil
 ]=]
-function UndoStackEntry:SetPromiseRedo(promiseRedo)
+function UndoStackEntry.SetPromiseRedo(self: UndoStackEntry, promiseRedo: ExecuteRedo)
 	assert(type(promiseRedo) == "function" or promiseRedo == nil, "Bad promiseRedo")
 
 	self._promiseRedo = promiseRedo
@@ -68,7 +81,7 @@ end
 	Returns true if this entry can be undone
 	@return boolean
 ]=]
-function UndoStackEntry:HasUndo()
+function UndoStackEntry.HasUndo(self: UndoStackEntry): boolean
 	return self._promiseUndo ~= nil
 end
 
@@ -76,7 +89,7 @@ end
 	Returns true if this entry can be redone
 	@return boolean
 ]=]
-function UndoStackEntry:HasRedo()
+function UndoStackEntry.HasRedo(self: UndoStackEntry): boolean
 	return self._promiseRedo ~= nil
 end
 
@@ -86,14 +99,15 @@ end
 	@param maid Maid
 	@return Promise
 ]=]
-function UndoStackEntry:PromiseUndo(maid)
+function UndoStackEntry.PromiseUndo(self: UndoStackEntry, maid: Maid.Maid): Promise.Promise<()>
 	assert(Maid.isMaid(maid), "Bad maid")
 
-	if not self._promiseUndo then
+	local promiseUndo = self._promiseUndo
+	if not promiseUndo then
 		return Promise.resolved()
 	end
 
-	local result = maid:GivePromise(self._promiseUndo(maid))
+	local result = maid:GivePromise(promiseUndo(maid))
 	if Promise.isPromise(result) then
 		return result
 	else
@@ -107,14 +121,15 @@ end
 	@param maid Maid
 	@return Promise
 ]=]
-function UndoStackEntry:PromiseRedo(maid)
+function UndoStackEntry.PromiseRedo(self: UndoStackEntry, maid: Maid.Maid): Promise.Promise<()>
 	assert(Maid.isMaid(maid), "Bad maid")
 
-	if not self._promiseUndo then
+	local promiseRedo = self._promiseRedo
+	if not promiseRedo then
 		return Promise.resolved()
 	end
 
-	local result = maid:GivePromise(self._promiseRedo(maid))
+	local result = maid:GivePromise(promiseRedo(maid))
 	if Promise.isPromise(result) then
 		return result
 	else
@@ -122,4 +137,4 @@ function UndoStackEntry:PromiseRedo(maid)
 	end
 end
 
-return UndoStackEntry
+return UndoStackEntry