@quenty/roblox-api-dump 8.11.3 → 8.11.4

package/CHANGELOG.md

@@ -3,6 +3,14 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
+## [8.11.4](https://github.com/Quenty/NevermoreEngine/compare/@quenty/roblox-api-dump@8.11.3...@quenty/roblox-api-dump@8.11.4) (2025-04-10)
+
+**Note:** Version bump only for package @quenty/roblox-api-dump
+
+
+
+
+
 ## [8.11.3](https://github.com/Quenty/NevermoreEngine/compare/@quenty/roblox-api-dump@8.11.1...@quenty/roblox-api-dump@8.11.3) (2025-04-07)
 
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/roblox-api-dump",
-  "version": "8.11.3",
+  "version": "8.11.4",
   "description": "Utility functions for grabbing the Roblox API from the web",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.2",
-    "@quenty/httppromise": "^10.10.3",
-    "@quenty/loader": "^10.8.2",
-    "@quenty/promise": "^10.10.3",
-    "@quenty/table": "^3.7.3"
+    "@quenty/baseobject": "^10.8.3",
+    "@quenty/httppromise": "^10.10.4",
+    "@quenty/loader": "^10.8.3",
+    "@quenty/promise": "^10.10.4",
+    "@quenty/table": "^3.7.4"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "64def70499ec067077ee39f279936b620b217847"
+  "gitHead": "b06c070ae91d5dab7bd8de6e290ad2caabb15d8f"
 }

package/src/Server/RobloxApiClass.lua

@@ -1,3 +1,4 @@
+--!strict
 --[=[
 	Represents a specific Roblox class.
 	@class RobloxApiClass
@@ -12,6 +13,16 @@ local RobloxApiClass = {}
 RobloxApiClass.ClassName = "RobloxApiClass"
 RobloxApiClass.__index = RobloxApiClass
 
+export type RobloxApiClass = typeof(setmetatable(
+	{} :: {
+		_robloxApiDump: any,
+		_data: any,
+		_allSuperClassesPromise: Promise.Promise<any>?,
+		_tagCache: { [string]: boolean }?,
+	},
+	{} :: typeof({ __index = RobloxApiClass })
+))
+
 --[=[
 	Constructs a new RobloxApiClass. See [RobloxApiDump.PromiseClass] to actually construct
 	this class.
@@ -19,8 +30,8 @@ RobloxApiClass.__index = RobloxApiClass
 	@param data table
 	@return RobloxApiClass
 ]=]
-function RobloxApiClass.new(robloxApiDump, data)
-	local self = setmetatable({}, RobloxApiClass)
+function RobloxApiClass.new(robloxApiDump, data): RobloxApiClass
+	local self: RobloxApiClass = setmetatable({} :: any, RobloxApiClass)
 
 	--[[
         {
@@ -47,7 +58,7 @@ end
 	Retrieves the raw class data
 	@return table
 ]=]
-function RobloxApiClass:GetRawData()
+function RobloxApiClass.GetRawData(self: RobloxApiClass): unknown
 	return self._data
 end
 
@@ -55,7 +66,7 @@ end
 	Gets the class name.
 	@return string
 ]=]
-function RobloxApiClass:GetClassName()
+function RobloxApiClass.GetClassName(self: RobloxApiClass): string
 	assert(type(self._data.Name) == "string", "Bad Name")
 	return self._data.Name
 end
@@ -64,7 +75,7 @@ end
 	Gets the class category.
 	@return string?
 ]=]
-function RobloxApiClass:GetMemberCategory()
+function RobloxApiClass.GetMemberCategory(self: RobloxApiClass): string?
 	return self._data.MemoryCategory -- might be nil, stuff like "Data" or ""
 end
 
@@ -72,7 +83,7 @@ end
 	Retrieves the super class, or rejects.
 	@return Promise<RobloxApiClass>
 ]=]
-function RobloxApiClass:PromiseSuperClass()
+function RobloxApiClass.PromiseSuperClass(self: RobloxApiClass): Promise.Promise<RobloxApiClass>
 	local superclass = self:GetSuperClassName()
 	if superclass then
 		return self._robloxApiDump:PromiseClass(superclass)
@@ -86,7 +97,7 @@ end
 	@param className string
 	@return Promise<boolean>
 ]=]
-function RobloxApiClass:PromiseIsA(className: string)
+function RobloxApiClass.PromiseIsA(self: RobloxApiClass, className: string): Promise.Promise<boolean>
 	if self:GetClassName() == className then
 		return Promise.resolved(true)
 	end
@@ -101,7 +112,7 @@ end
 	@param className string
 	@return Promise<boolean>
 ]=]
-function RobloxApiClass:PromiseIsDescendantOf(className)
+function RobloxApiClass.PromiseIsDescendantOf(self: RobloxApiClass, className: string)
 	return self:PromiseAllSuperClasses():Then(function(classes)
 		for _, class in classes do
 			if class:GetClassName() == className then
@@ -117,33 +128,34 @@ end
 	Returns a promise that resolves to all super classes.
 	@return Promise<{ RobloxApiClass }>
 ]=]
-function RobloxApiClass:PromiseAllSuperClasses()
+function RobloxApiClass.PromiseAllSuperClasses(self: RobloxApiClass): Promise.Promise<{ RobloxApiClass }>
 	if self._allSuperClassesPromise then
 		return self._allSuperClassesPromise
 	end
 
-	local list = {}
+	local list: { RobloxApiClass } = {}
 
-	local function chain(current)
+	local function chain(current: RobloxApiClass): Promise.Promise<{ RobloxApiClass }>
 		return current:PromiseSuperClass():Then(function(superclass)
 			if superclass then
 				table.insert(list, superclass)
 				return chain(superclass)
 			else
-				return list
+				return list :: any
 			end
 		end)
 	end
 
-	self._allSuperClassesPromise = chain(self)
-	return self._allSuperClassesPromise
+	local promise = chain(self)
+	self._allSuperClassesPromise = promise
+	return promise
 end
 
 --[=[
 	Returns the super class name
 	@return string?
 ]=]
-function RobloxApiClass:GetSuperClassName()
+function RobloxApiClass.GetSuperClassName(self: RobloxApiClass)
 	local data = self._data.Superclass
 	if data == RobloxApiDumpConstants.ROOT_CLASS_NAME then
 		return nil
@@ -156,7 +168,7 @@ end
 	Returns whether the class has a super class
 	@return boolean
 ]=]
-function RobloxApiClass:HasSuperClass(): boolean
+function RobloxApiClass.HasSuperClass(self: RobloxApiClass): boolean
 	return self:GetSuperClassName() ~= nil
 end
 
@@ -164,7 +176,7 @@ end
 	Retrieves all class members (events, properties, callbacks, functions).
 	@return Promise<{ RobloxApiMember }>
 ]=]
-function RobloxApiClass:PromiseMembers()
+function RobloxApiClass.PromiseMembers(self: RobloxApiClass)
 	return self._robloxApiDump:PromiseMembers(self:GetClassName())
 end
 
@@ -172,7 +184,7 @@ end
 	Gets all class properties.
 	@return Promise<{ RobloxApiMember }>
 ]=]
-function RobloxApiClass:PromiseProperties()
+function RobloxApiClass.PromiseProperties(self: RobloxApiClass)
 	return self:PromiseMembers():Then(function(members)
 		local result = {}
 		for _, member in members do
@@ -188,7 +200,7 @@ end
 	Gets all class events.
 	@return Promise<{ RobloxApiMember }>
 ]=]
-function RobloxApiClass:PromiseEvents()
+function RobloxApiClass.PromiseEvents(self: RobloxApiClass)
 	return self:PromiseMembers():Then(function(members)
 		local result = {}
 		for _, member in members do
@@ -204,7 +216,7 @@ end
 	Gets all class functions (i.e. methods).
 	@return Promise<{ RobloxApiMember }>
 ]=]
-function RobloxApiClass:PromiseFunctions()
+function RobloxApiClass.PromiseFunctions(self: RobloxApiClass)
 	return self:PromiseMembers():Then(function(members)
 		local result = {}
 		for _, member in members do
@@ -220,7 +232,7 @@ end
 	Retrieves whether the class is a service
 	@return boolean
 ]=]
-function RobloxApiClass:IsService(): boolean
+function RobloxApiClass.IsService(self: RobloxApiClass): boolean
 	return self:HasTag("Service")
 end
 
@@ -228,7 +240,7 @@ end
 	Retrieves whether the class is not creatable
 	@return boolean
 ]=]
-function RobloxApiClass:IsNotCreatable(): boolean
+function RobloxApiClass.IsNotCreatable(self: RobloxApiClass): boolean
 	return self:HasTag("NotCreatable")
 end
 
@@ -236,7 +248,7 @@ end
 	Retrieves whether the class is not replicated
 	@return boolean
 ]=]
-function RobloxApiClass:IsNotReplicated(): boolean
+function RobloxApiClass.IsNotReplicated(self: RobloxApiClass): boolean
 	return self:HasTag("NotReplicated")
 end
 
@@ -245,19 +257,21 @@ end
 	@param tagName string
 	@return boolean
 ]=]
-function RobloxApiClass:HasTag(tagName: string): boolean
+function RobloxApiClass.HasTag(self: RobloxApiClass, tagName: string): boolean
 	if self._tagCache then
 		return self._tagCache[tagName] == true
 	end
 
-	self._tagCache = {}
+	local cache = {}
+	self._tagCache = cache
+
 	if type(self._data.Tags) == "table" then
 		for _, tag in self._data.Tags do
-			self._tagCache[tag] = true
+			cache[tag] = true
 		end
 	end
 
-	return self._tagCache[tagName] == true
+	return cache[tagName] == true
 end
 
 return RobloxApiClass

package/src/Server/RobloxApiDump.lua

@@ -17,14 +17,26 @@ local RobloxApiDump = setmetatable({}, BaseObject)
 RobloxApiDump.ClassName = "RobloxApiDump"
 RobloxApiDump.__index = RobloxApiDump
 
-export type RobloxApiDump = typeof(setmetatable({}, { __index = RobloxApiDump }))
+export type RobloxApiDump = typeof(setmetatable(
+	{} :: {
+		_classMemberPromises: { [string]: Promise.Promise<()> },
+		_ancestorListPromise: { [string]: Promise.Promise<()> },
+		_classPromises: { [string]: Promise.Promise<()> },
+		_classMapPromise: Promise.Promise<()>?,
+		_dumpPromise: Promise.Promise<()>?,
+		_className: string,
+		_obj: Instance?,
+		_maid: any,
+	},
+	{} :: typeof({ __index = RobloxApiDump })
+)) & BaseObject.BaseObject
 
 --[=[
 	Constructs a new RobloxApiDump which will cache all results for its lifetime.
 	@return RobloxApiDump
 ]=]
 function RobloxApiDump.new(): RobloxApiDump
-	local self = setmetatable(BaseObject.new() :: any, RobloxApiDump)
+	local self: RobloxApiDump = setmetatable(BaseObject.new() :: any, RobloxApiDump)
 
 	self._classMemberPromises = {}
 	self._ancestorListPromise = {}