@quenty/roblox-api-dump 8.11.1 → 8.11.2

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.
 
+## [8.11.2](https://github.com/Quenty/NevermoreEngine/compare/@quenty/roblox-api-dump@8.11.1...@quenty/roblox-api-dump@8.11.2) (2025-04-05)
+
+
+### Bug Fixes
+
+* Add types to packages ([2374fb2](https://github.com/Quenty/NevermoreEngine/commit/2374fb2b043cfbe0e9b507b3316eec46a4e353a0))
+
+
+
+
+
 ## [8.11.1](https://github.com/Quenty/NevermoreEngine/compare/@quenty/roblox-api-dump@8.11.0...@quenty/roblox-api-dump@8.11.1) (2025-03-21)
 
 **Note:** Version bump only for package @quenty/roblox-api-dump

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@quenty/roblox-api-dump",
-  "version": "8.11.1",
+  "version": "8.11.2",
   "description": "Utility functions for grabbing the Roblox API from the web",
   "keywords": [
     "Roblox",
@@ -26,14 +26,14 @@
     "Quenty"
   ],
   "dependencies": {
-    "@quenty/baseobject": "^10.8.0",
-    "@quenty/httppromise": "^10.10.1",
-    "@quenty/loader": "^10.8.0",
-    "@quenty/promise": "^10.10.1",
-    "@quenty/table": "^3.7.1"
+    "@quenty/baseobject": "^10.8.1",
+    "@quenty/httppromise": "^10.10.2",
+    "@quenty/loader": "^10.8.1",
+    "@quenty/promise": "^10.10.2",
+    "@quenty/table": "^3.7.2"
   },
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "6b7c3e15e60cdb185986207b574e2b5591261e7a"
+  "gitHead": "78c3ac0ab08dd18085b6e6e6e4f745e76ed99f68"
 }

package/src/Server/RobloxApiClass.lua

@@ -86,7 +86,7 @@ end
 	@param className string
 	@return Promise<boolean>
 ]=]
-function RobloxApiClass:PromiseIsA(className)
+function RobloxApiClass:PromiseIsA(className: string)
 	if self:GetClassName() == className then
 		return Promise.resolved(true)
 	end
@@ -103,7 +103,7 @@ end
 ]=]
 function RobloxApiClass:PromiseIsDescendantOf(className)
 	return self:PromiseAllSuperClasses():Then(function(classes)
-		for _, class in pairs(classes) do
+		for _, class in classes do
 			if class:GetClassName() == className then
 				return true
 			end
@@ -125,15 +125,14 @@ function RobloxApiClass:PromiseAllSuperClasses()
 	local list = {}
 
 	local function chain(current)
-		return current:PromiseSuperClass()
-			:Then(function(superclass)
-				if superclass then
-					table.insert(list, superclass)
-					return chain(superclass)
-				else
-					return list
-				end
-			end)
+		return current:PromiseSuperClass():Then(function(superclass)
+			if superclass then
+				table.insert(list, superclass)
+				return chain(superclass)
+			else
+				return list
+			end
+		end)
 	end
 
 	self._allSuperClassesPromise = chain(self)
@@ -157,7 +156,7 @@ end
 	Returns whether the class has a super class
 	@return boolean
 ]=]
-function RobloxApiClass:HasSuperClass()
+function RobloxApiClass:HasSuperClass(): boolean
 	return self:GetSuperClassName() ~= nil
 end
 
@@ -174,16 +173,15 @@ end
 	@return Promise<{ RobloxApiMember }>
 ]=]
 function RobloxApiClass:PromiseProperties()
-	return self:PromiseMembers()
-		:Then(function(members)
-			local result = {}
-			for _, member in pairs(members) do
-				if member:IsProperty() then
-					table.insert(result, member)
-				end
+	return self:PromiseMembers():Then(function(members)
+		local result = {}
+		for _, member in members do
+			if member:IsProperty() then
+				table.insert(result, member)
 			end
-			return result
-		end)
+		end
+		return result
+	end)
 end
 
 --[=[
@@ -191,16 +189,15 @@ end
 	@return Promise<{ RobloxApiMember }>
 ]=]
 function RobloxApiClass:PromiseEvents()
-	return self:PromiseMembers()
-		:Then(function(members)
-			local result = {}
-			for _, member in pairs(members) do
-				if member:IsEvent() then
-					table.insert(result, member)
-				end
+	return self:PromiseMembers():Then(function(members)
+		local result = {}
+		for _, member in members do
+			if member:IsEvent() then
+				table.insert(result, member)
 			end
-			return result
-		end)
+		end
+		return result
+	end)
 end
 
 --[=[
@@ -208,23 +205,22 @@ end
 	@return Promise<{ RobloxApiMember }>
 ]=]
 function RobloxApiClass:PromiseFunctions()
-	return self:PromiseMembers()
-		:Then(function(members)
-			local result = {}
-			for _, member in pairs(members) do
-				if member:IsFunction() then
-					table.insert(result, member)
-				end
+	return self:PromiseMembers():Then(function(members)
+		local result = {}
+		for _, member in members do
+			if member:IsFunction() then
+				table.insert(result, member)
 			end
-			return result
-		end)
+		end
+		return result
+	end)
 end
 
 --[=[
 	Retrieves whether the class is a service
 	@return boolean
 ]=]
-function RobloxApiClass:IsService()
+function RobloxApiClass:IsService(): boolean
 	return self:HasTag("Service")
 end
 
@@ -232,7 +228,7 @@ end
 	Retrieves whether the class is not creatable
 	@return boolean
 ]=]
-function RobloxApiClass:IsNotCreatable()
+function RobloxApiClass:IsNotCreatable(): boolean
 	return self:HasTag("NotCreatable")
 end
 
@@ -240,7 +236,7 @@ end
 	Retrieves whether the class is not replicated
 	@return boolean
 ]=]
-function RobloxApiClass:IsNotReplicated()
+function RobloxApiClass:IsNotReplicated(): boolean
 	return self:HasTag("NotReplicated")
 end
 
@@ -249,14 +245,14 @@ end
 	@param tagName string
 	@return boolean
 ]=]
-function RobloxApiClass:HasTag(tagName)
+function RobloxApiClass:HasTag(tagName: string): boolean
 	if self._tagCache then
 		return self._tagCache[tagName] == true
 	end
 
 	self._tagCache = {}
 	if type(self._data.Tags) == "table" then
-		for _, tag in pairs(self._data.Tags) do
+		for _, tag in self._data.Tags do
 			self._tagCache[tag] = true
 		end
 	end

package/src/Server/RobloxApiDump.lua

@@ -17,12 +17,14 @@ local RobloxApiDump = setmetatable({}, BaseObject)
 RobloxApiDump.ClassName = "RobloxApiDump"
 RobloxApiDump.__index = RobloxApiDump
 
+export type RobloxApiDump = typeof(setmetatable({}, { __index = RobloxApiDump }))
+
 --[=[
 	Constructs a new RobloxApiDump which will cache all results for its lifetime.
 	@return RobloxApiDump
 ]=]
-function RobloxApiDump.new()
-	local self = setmetatable(BaseObject.new(), RobloxApiDump)
+function RobloxApiDump.new(): RobloxApiDump
+	local self = setmetatable(BaseObject.new() :: any, RobloxApiDump)
 
 	self._classMemberPromises = {}
 	self._ancestorListPromise = {}
@@ -36,17 +38,16 @@ end
 	@param className string
 	@return RobloxApiClass
 ]=]
-function RobloxApiDump:PromiseClass(className)
+function RobloxApiDump:PromiseClass(className: string)
 	assert(type(className) == "string", "Bad className")
 
 	if self._classPromises[className] then
 		return self._classPromises[className]
 	end
 
-	self._classPromises[className] = self:_promiseRawClassData(className)
-		:Then(function(classData)
-			return RobloxApiClass.new(self, classData)
-		end)
+	self._classPromises[className] = self:_promiseRawClassData(className):Then(function(classData)
+		return RobloxApiClass.new(self, classData)
+	end)
 
 	return self._classPromises[className]
 end
@@ -56,78 +57,74 @@ end
 	@param className string
 	@return { RobloxApiMember }
 ]=]
-function RobloxApiDump:PromiseMembers(className)
+function RobloxApiDump:PromiseMembers(className: string)
 	assert(type(className) == "string", "Bad className")
 
 	if self._classMemberPromises[className] then
 		return self._classMemberPromises[className]
 	end
 
-
-	self._classMemberPromises[className] = self:_promiseClassDataAndAncestorList(className)
-		:Then(function(list)
-			local members = {}
-			for _, entry in pairs(list) do
-				if entry.Members then
-					for _, member in pairs(entry.Members) do
-						table.insert(members, RobloxApiMember.new(member))
-					end
+	self._classMemberPromises[className] = self:_promiseClassDataAndAncestorList(className):Then(function(list)
+		local members = {}
+		for _, entry in list do
+			if entry.Members then
+				for _, member in entry.Members do
+					table.insert(members, RobloxApiMember.new(member))
 				end
 			end
+		end
 
-			return members
-		end)
+		return members
+	end)
 
 	return self._classMemberPromises[className]
 end
 
-function RobloxApiDump:_promiseClassDataAndAncestorList(className)
+function RobloxApiDump:_promiseClassDataAndAncestorList(className: string)
 	assert(type(className) == "string", "Bad className")
 
 	if self._ancestorListPromise[className] then
 		return self._ancestorListPromise[className]
 	end
 
-	self._ancestorListPromise[className] = self:_promiseClassMap()
-		:Then(function(classMap)
-			local current = classMap[className]
-			if not current then
-				return Promise.rejected(string.format("Could not find data for %q", className))
-			end
+	self._ancestorListPromise[className] = self:_promiseClassMap():Then(function(classMap)
+		local current = classMap[className]
+		if not current then
+			return Promise.rejected(string.format("Could not find data for %q", className))
+		end
+
+		local dataList = {}
+		while current do
+			table.insert(dataList, current)
 
-			local dataList = {}
-			while current do
-				table.insert(dataList, current)
-
-				local superclass = current.Superclass
-				if superclass and superclass ~= RobloxApiDumpConstants.ROOT_CLASS_NAME then
-					current = classMap[superclass]
-					if not current then
-						return Promise.rejected(string.format("Could not find data for super class %q", superclass))
-					end
-				else
-					current = nil
+			local superclass = current.Superclass
+			if superclass and superclass ~= RobloxApiDumpConstants.ROOT_CLASS_NAME then
+				current = classMap[superclass]
+				if not current then
+					return Promise.rejected(string.format("Could not find data for super class %q", superclass))
 				end
+			else
+				current = nil
 			end
+		end
 
-			return dataList
-		end)
+		return dataList
+	end)
 
 	return self._ancestorListPromise[className]
 end
 
-function RobloxApiDump:_promiseRawClassData(className)
+function RobloxApiDump:_promiseRawClassData(className: string)
 	assert(type(className) == "string", "Bad className")
 
-	return self:_promiseClassMap()
-		:Then(function(classMap)
-			local data = classMap[className]
-			if data then
-				return data
-			else
-				return Promise.rejected(string.format("Could not find data for %q", className))
-			end
-		end)
+	return self:_promiseClassMap():Then(function(classMap)
+		local data = classMap[className]
+		if data then
+			return data
+		else
+			return Promise.rejected(string.format("Could not find data for %q", className))
+		end
+	end)
 end
 
 function RobloxApiDump:_promiseClassMap()
@@ -139,7 +136,7 @@ function RobloxApiDump:_promiseClassMap()
 		assert(dump.Version == 1, "Only able to parse version 1 of the dump")
 
 		local classMap = {}
-		for _, entry in pairs(dump.Classes) do
+		for _, entry in dump.Classes do
 			assert(type(entry) == "table", "Bad entry")
 			assert(type(entry.Name) == "string", "Bad entry.Name")
 

package/src/Server/RobloxApiMember.lua

@@ -45,7 +45,7 @@ function RobloxApiMember.new(data)
 	return self
 end
 
-function RobloxApiMember:GetTypeName()
+function RobloxApiMember:GetTypeName(): string?
 	local valueType = self._data.ValueType
 	if valueType then
 		return valueType.Name
@@ -58,7 +58,7 @@ end
 	Gets the member name.
 	@return string
 ]=]
-function RobloxApiMember:GetName()
+function RobloxApiMember:GetName(): string
 	assert(type(self._data.Name) == "string", "Bad Name")
 	return self._data.Name
 end
@@ -67,7 +67,7 @@ end
 	Gets the member category.
 	@return string?
 ]=]
-function RobloxApiMember:GetCategory()
+function RobloxApiMember:GetCategory(): string
 	return self._data.Category -- might be nil, stuff like "Data" or ""
 end
 
@@ -75,7 +75,7 @@ end
 	Retrieves whether the API member is read only.
 	@return boolean
 ]=]
-function RobloxApiMember:IsReadOnly()
+function RobloxApiMember:IsReadOnly(): boolean
 	return self:HasTag("ReadOnly")
 end
 
@@ -83,7 +83,7 @@ end
 	Retrieves the member type.
 	@return string
 ]=]
-function RobloxApiMember:GetMemberType()
+function RobloxApiMember:GetMemberType(): string
 	assert(type(self._data.MemberType) == "string", "Bad MemberType")
 	return self._data.MemberType
 end
@@ -92,7 +92,7 @@ end
 	Returns whether the member is an event.
 	@return boolean
 ]=]
-function RobloxApiMember:IsEvent()
+function RobloxApiMember:IsEvent(): boolean
 	return self:GetMemberType() == "Event"
 end
 
@@ -108,7 +108,7 @@ end
 	Returns whether this member has write NotAccessibleSecurity
 	@return boolean
 ]=]
-function RobloxApiMember:IsWriteNotAccessibleSecurity()
+function RobloxApiMember:IsWriteNotAccessibleSecurity(): boolean
 	return self:GetWriteSecurity() == "NotAccessibleSecurity"
 end
 
@@ -116,7 +116,7 @@ end
 	Returns whether this member has write NotAccessibleSecurity
 	@return boolean
 ]=]
-function RobloxApiMember:IsReadNotAccessibleSecurity()
+function RobloxApiMember:IsReadNotAccessibleSecurity(): boolean
 	return self:GetReadSecurity() == "NotAccessibleSecurity"
 end
 
@@ -124,7 +124,7 @@ end
 	Returns whether this member has write LocalUserSecurity
 	@return boolean
 ]=]
-function RobloxApiMember:IsWriteLocalUserSecurity()
+function RobloxApiMember:IsWriteLocalUserSecurity(): boolean
 	return self:GetWriteSecurity() == "LocalUserSecurity"
 end
 
@@ -132,7 +132,7 @@ end
 	Returns whether this member has read LocalUserSecurity
 	@return boolean
 ]=]
-function RobloxApiMember:IsReadLocalUserSecurity()
+function RobloxApiMember:IsReadLocalUserSecurity(): boolean
 	return self:GetReadSecurity() == "LocalUserSecurity"
 end
 
@@ -140,7 +140,7 @@ end
 	Returns whether this member has read RobloxScriptSecurity
 	@return boolean
 ]=]
-function RobloxApiMember:IsReadRobloxScriptSecurity()
+function RobloxApiMember:IsReadRobloxScriptSecurity(): boolean
 	return self:GetReadSecurity() == "RobloxScriptSecurity"
 end
 
@@ -148,7 +148,7 @@ end
 	Returns whether this member has write RobloxScriptSecurity
 	@return boolean
 ]=]
-function RobloxApiMember:IsWriteRobloxScriptSecurity()
+function RobloxApiMember:IsWriteRobloxScriptSecurity(): boolean
 	return self:GetWriteSecurity() == "RobloxScriptSecurity"
 end
 
@@ -156,7 +156,7 @@ end
 	Returns whether this can serialize save
 	@return boolean?
 ]=]
-function RobloxApiMember:CanSerializeSave()
+function RobloxApiMember:CanSerializeSave(): boolean?
 	local serialization = self._data.Serialization
 	if type(serialization) == "table" then
 		return serialization.CanSave
@@ -169,7 +169,7 @@ end
 	Returns whether this can serialize save
 	@return boolean?
 ]=]
-function RobloxApiMember:CanSerializeLoad()
+function RobloxApiMember:CanSerializeLoad(): boolean?
 	local serialization = self._data.Serialization
 	if type(serialization) == "table" then
 		return serialization.CanLoad
@@ -182,7 +182,7 @@ end
 	Returns the member's write security as a string
 	@return string?
 ]=]
-function RobloxApiMember:GetWriteSecurity()
+function RobloxApiMember:GetWriteSecurity(): boolean?
 	local security = self._data.Security
 	if type(security) == "table" then
 		return security.Write
@@ -195,7 +195,7 @@ end
 	Returns the member's read security as a string
 	@return string?
 ]=]
-function RobloxApiMember:GetReadSecurity()
+function RobloxApiMember:GetReadSecurity(): boolean?
 	local security = self._data.Security
 	if type(security) == "table" then
 		return security.Write
@@ -208,7 +208,7 @@ end
 	Returns whether the member is a property.
 	@return boolean
 ]=]
-function RobloxApiMember:IsProperty()
+function RobloxApiMember:IsProperty(): boolean
 	return self:GetMemberType() == "Property"
 end
 
@@ -216,7 +216,7 @@ end
 	Returns whether the member is a function (i.e. method).
 	@return boolean
 ]=]
-function RobloxApiMember:IsFunction()
+function RobloxApiMember:IsFunction(): boolean
 	return self:GetMemberType() == "Function"
 end
 
@@ -224,7 +224,7 @@ end
 	Returns whether the member is a callback.
 	@return boolean
 ]=]
-function RobloxApiMember:IsCallback()
+function RobloxApiMember:IsCallback(): boolean
 	return self:GetMemberType() == "Callback"
 end
 
@@ -232,7 +232,7 @@ end
 	Returns whether a script can modify it.
 	@return boolean
 ]=]
-function RobloxApiMember:IsNotScriptable()
+function RobloxApiMember:IsNotScriptable(): boolean
 	return self:HasTag("NotScriptable")
 end
 
@@ -240,14 +240,14 @@ end
 	Returns whether the member is not replicated.
 	@return boolean
 ]=]
-function RobloxApiMember:IsNotReplicated()
+function RobloxApiMember:IsNotReplicated(): boolean
 	return self:HasTag("NotReplicated")
 end
 
 --[=[
 	Returns whether the member is deprecated..
 ]=]
-function RobloxApiMember:IsDeprecated()
+function RobloxApiMember:IsDeprecated(): boolean
 	return self:HasTag("Deprecated")
 end
 
@@ -255,7 +255,7 @@ end
 	Returns whether this api member is hidden.
 	@return boolean
 ]=]
-function RobloxApiMember:IsHidden()
+function RobloxApiMember:IsHidden(): boolean
 	return self:HasTag("Hidden")
 end
 
@@ -263,7 +263,7 @@ end
 	Returns a list of tags. Do not modify this list.
 	@return {string}
 ]=]
-function RobloxApiMember:GetTags()
+function RobloxApiMember:GetTags(): { string }
 	return self._data.Tags
 end
 
@@ -272,14 +272,14 @@ end
 	@param tagName string
 	@return boolean
 ]=]
-function RobloxApiMember:HasTag(tagName)
+function RobloxApiMember:HasTag(tagName: string): boolean
 	if self._tagCache then
 		return self._tagCache[tagName] == true
 	end
 
 	self._tagCache = {}
 	if type(self._data.Tags) == "table" then
-		for _, tag in pairs(self._data.Tags) do
+		for _, tag in self._data.Tags do
 			self._tagCache[tag] = true
 		end
 	end