@quenty/pagesutils 5.11.4 → 5.11.5-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.
 
+## [5.11.5-canary.11a5dcf.0](https://github.com/Quenty/NevermoreEngine/compare/@quenty/pagesutils@5.11.4...@quenty/pagesutils@5.11.5-canary.11a5dcf.0) (2025-05-10)
+
+
+### Features
+
+* Add even more types ([b31717d](https://github.com/Quenty/NevermoreEngine/commit/b31717d8c9f7620c457f5018a2affa760a65334a))
+
+
+
+
+
 ## [5.11.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/pagesutils@5.11.3...@quenty/pagesutils@5.11.4) (2025-04-10)
 
 **Note:** Version bump only for package @quenty/pagesutils

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/pagesutils",
-  "version": "5.11.4",
+  "version": "5.11.5-canary.11a5dcf.0",
   "description": "Utilities to advance over the Roblox pages API surface",
   "keywords": [
     "Roblox",
@@ -26,12 +26,12 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/ducktype": "^5.8.4",
-    "@quenty/loader": "^10.8.3",
-    "@quenty/promise": "^10.10.4"
+    "@quenty/ducktype": "5.8.5-canary.11a5dcf.0",
+    "@quenty/loader": "10.8.4-canary.11a5dcf.0",
+    "@quenty/promise": "10.10.5-canary.11a5dcf.0"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
+  "gitHead": "11a5dcf7d4c7a0bfbf3337e97d30e8346ea09d3f"
 }

package/src/Shared/PagesUtils.lua

@@ -6,8 +6,8 @@
 
 local require = require(script.Parent.loader).load(script)
 
-local Promise = require("Promise")
 local PagesProxy = require("PagesProxy")
+local Promise = require("Promise")
 
 local PagesUtils = {}
 
@@ -17,7 +17,7 @@ local PagesUtils = {}
 	@param pages Pages
 	@return { any }
 ]=]
-function PagesUtils.promiseAdvanceToNextPage(pages: Pages): Promise.Promise<({any})>
+function PagesUtils.promiseAdvanceToNextPage(pages: Pages): Promise.Promise<({ any })>
 	assert(typeof(pages) == "Instance" and pages:IsA("Pages") or PagesProxy.isPagesProxy(pages), "Bad pages")
 
 	return Promise.spawn(function(resolve, reject)

package/src/Shared/Proxy/PagesDatabase.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	@class PagesDatabase
 ]=]
@@ -10,8 +11,17 @@ local PagesDatabase = {}
 PagesDatabase.ClassName = "PagesDatabase"
 PagesDatabase.__index = PagesDatabase
 
-function PagesDatabase.new(pages: Pages)
-	local self = setmetatable({}, PagesDatabase)
+export type PagesDatabase = typeof(setmetatable(
+	{} :: {
+		_pages: Pages,
+		_lastIncrementedIndex: number,
+		_pageData: { [number]: { currentPage: any, isFinished: boolean } },
+	},
+	{} :: typeof({ __index = PagesDatabase })
+))
+
+function PagesDatabase.new(pages: Pages): PagesDatabase
+	local self: PagesDatabase = setmetatable({} :: any, PagesDatabase)
 
 	self._pages = assert(pages, "No pages")
 	self._lastIncrementedIndex = 1
@@ -26,7 +36,7 @@ function PagesDatabase.isPagesDatabase(value): boolean
 	return DuckTypeUtils.isImplementation(PagesDatabase, value)
 end
 
-function PagesDatabase:IncrementToPageIdAsync(pageId: number)
+function PagesDatabase.IncrementToPageIdAsync(self: PagesDatabase, pageId: number)
 	while self._lastIncrementedIndex < pageId do
 		self._lastIncrementedIndex += 1
 		self._pages:AdvanceToNextPageAsync()
@@ -34,25 +44,25 @@ function PagesDatabase:IncrementToPageIdAsync(pageId: number)
 	end
 end
 
-function PagesDatabase:GetPage(pageId: number)
+function PagesDatabase.GetPage(self: PagesDatabase, pageId: number)
 	assert(type(pageId) == "number", "Bad pageId")
 
 	return self:_getPageState(pageId).currentPage
 end
 
-function PagesDatabase:GetIsFinished(pageId: number)
+function PagesDatabase.GetIsFinished(self: PagesDatabase, pageId: number): boolean
 	assert(type(pageId) == "number", "Bad pageId")
 
 	return self:_getPageState(pageId).isFinished
 end
 
-function PagesDatabase:_getPageState(pageId: number)
+function PagesDatabase._getPageState(self: PagesDatabase, pageId: number)
 	assert(pageId > 0 and pageId <= self._lastIncrementedIndex, "pageId is out of bounds")
 
 	return assert(self._pageData[pageId], "Missing data")
 end
 
-function PagesDatabase:_storeState()
+function PagesDatabase._storeState(self: PagesDatabase)
 	self._pageData[self._lastIncrementedIndex] = {
 		currentPage = self._pages:GetCurrentPage(),
 		isFinished = self._pages.IsFinished,

package/src/Shared/Proxy/PagesProxy.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Proxy pages and cache the results to allow for reuse
 
@@ -13,11 +14,19 @@ local PagesProxy = {}
 PagesProxy.ClassName = "PagesProxy"
 PagesProxy.__index = PagesProxy
 
-function PagesProxy.new(database)
-	local self = setmetatable({}, PagesProxy)
+export type PagesProxy = typeof(setmetatable(
+	{} :: {
+		_database: PagesDatabase.PagesDatabase,
+		_currentPageIndex: number,
+	},
+	{} :: typeof({ __index = PagesProxy })
+))
+
+function PagesProxy.new(database: PagesDatabase.PagesDatabase | Pages): PagesProxy
+	local self: PagesProxy = setmetatable({} :: any, PagesProxy)
 
 	if PagesDatabase.isPagesDatabase(database) then
-		self._database = database
+		self._database = database :: any
 	elseif typeof(database) == "Instance" and database:IsA("Pages") then
 		-- Convenient for consumers
 		self._database = PagesDatabase.new(database)
@@ -34,7 +43,7 @@ function PagesProxy.isPagesProxy(value): boolean
 	return DuckTypeUtils.isImplementation(PagesProxy, value)
 end
 
-function PagesProxy:AdvanceToNextPageAsync()
+function PagesProxy.AdvanceToNextPageAsync(self: PagesProxy): ()
 	if self._database:GetIsFinished(self._currentPageIndex) then
 		error("Already finished, cannot increment more")
 	end
@@ -44,18 +53,18 @@ function PagesProxy:AdvanceToNextPageAsync()
 	return self._database:IncrementToPageIdAsync(self._currentPageIndex)
 end
 
-function PagesProxy:GetCurrentPage()
+function PagesProxy.GetCurrentPage(self: PagesProxy): Pages
 	return self._database:GetPage(self._currentPageIndex)
 end
 
-function PagesProxy:Clone()
+function PagesProxy.Clone(self: PagesProxy): PagesProxy
 	local copy = PagesProxy.new(self._database)
 	copy._currentPageIndex = self._currentPageIndex
 
 	return copy
 end
 
-function PagesProxy:__index(index)
+(PagesProxy :: any).__index = function(self: PagesProxy, index)
 	if index == nil then
 		error("Attempt to index with a nil value")
 	elseif PagesProxy[index] then
@@ -63,7 +72,7 @@ function PagesProxy:__index(index)
 	elseif index == "IsFinished" then
 		return self._database:GetIsFinished(self._currentPageIndex)
 	elseif type(index) == "string" then
-		return rawget(self, index)
+		return rawget(self :: any, index)
 	else
 		error("Bad index")
 	end