@quenty/roblox-api-dump 1.0.1-canary.247.1597949.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.247.1597949.0 (2022-01-17)
+
+
+### Features
+
+* Add RobloxApiDump package. This pulls in the API dump and allows querying of the API surface. ([c5bf337](https://github.com/Quenty/NevermoreEngine/commit/c5bf337d80016f47abac026f7ef0281aeb487e8d))

package/LICENSE.md

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2014-2021 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,21 @@
+## Roblox-Api-Dump
+<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>
+
+Utility functions for grabbing the Roblox API from the web
+
+<div align="center"><a href="https://quenty.github.io/NevermoreEngine/api/RobloxApiDump">View docs →</a></div>
+
+## Installation
+```
+npm install @quenty/roblox-api-dump --save
+```

package/default.project.json

@@ -0,0 +1,6 @@
+{
+  "name": "roblox-api-dump",
+  "tree": {
+    "$path": "src"
+  }
+}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "@quenty/roblox-api-dump",
+  "version": "1.0.1-canary.247.1597949.0",
+  "description": "Utility functions for grabbing the Roblox API from the web",
+  "keywords": [
+    "Roblox",
+    "Nevermore",
+    "Lua",
+    "Http",
+    "API"
+  ],
+  "bugs": {
+    "url": "https://github.com/Quenty/NevermoreEngine/issues"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/Quenty/NevermoreEngine.git",
+    "directory": "src/roblox-api-dump/"
+  },
+  "funding": {
+    "type": "patreon",
+    "url": "https://www.patreon.com/quenty"
+  },
+  "license": "MIT",
+  "contributors": [
+    "Quenty"
+  ],
+  "dependencies": {
+    "@quenty/baseobject": "3.4.1-canary.247.1597949.0",
+    "@quenty/httppromise": "3.5.2-canary.247.1597949.0",
+    "@quenty/loader": "3.3.1-canary.247.1597949.0",
+    "@quenty/promise": "3.5.2-canary.247.1597949.0",
+    "@quenty/table": "2.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "159794913fb32aedaf48d2a2d7808d50449f4c01"
+}

package/src/Server/RobloxApiClass.lua

@@ -0,0 +1,267 @@
+--[=[
+	Represents a specific Roblox class.
+	@class RobloxApiClass
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Promise = require("Promise")
+local RobloxApiDumpConstants = require("RobloxApiDumpConstants")
+
+local RobloxApiClass = {}
+RobloxApiClass.ClassName = "RobloxApiClass"
+RobloxApiClass.__index = RobloxApiClass
+
+--[=[
+	Constructs a new RobloxApiClass. See [RobloxApiDump.PromiseClass] to actually construct
+	this class.
+	@param robloxApiDump RobloxApiDump
+	@param data table
+	@return RobloxApiClass
+]=]
+function RobloxApiClass.new(robloxApiDump, data)
+	local self = setmetatable({}, RobloxApiClass)
+
+	--[[
+        {
+            "Members": [
+				...
+            ],
+            "MemoryCategory": "Instances",
+            "Name": "PackageUIService",
+            "Superclass": "Instance",
+            "Tags": [
+                "NotCreatable",
+                "Service",
+                "NotReplicated"
+            ]
+        },
+	]]
+	self._robloxApiDump = assert(robloxApiDump, "No robloxApiDump")
+	self._data = assert(data, "No data")
+
+	return self
+end
+
+--[=[
+	Retrieves the raw class data
+	@return table
+]=]
+function RobloxApiClass:GetRawData()
+	return self._data
+end
+
+--[=[
+	Gets the class name.
+	@return string
+]=]
+function RobloxApiClass:GetClassName()
+	assert(type(self._data.Name) == "string", "Bad Name")
+	return self._data.Name
+end
+
+--[=[
+	Gets the class category.
+	@return string?
+]=]
+function RobloxApiClass:GetMemberCategory()
+	return self._data.MemoryCategory -- might be nil, stuff like "Data" or ""
+end
+
+--[=[
+	Retrieves the super class, or rejects.
+	@return Promise<RobloxApiClass>
+]=]
+function RobloxApiClass:PromiseSuperClass()
+	local superclass = self:GetSuperClassName()
+	if superclass then
+		return self._robloxApiDump:PromiseClass(superclass)
+	else
+		return Promise.rejected("No super class")
+	end
+end
+
+--[=[
+	Returns a promise that resolves whether this class is of a specific type.
+	@param className string
+	@return Promise<boolean>
+]=]
+function RobloxApiClass:PromiseIsA(className)
+	if self:GetClassName() == className then
+		return Promise.resolved(true)
+	end
+
+	return self:PromiseIsDescendantOf(className)
+end
+
+--[=[
+	Returns a promise that resolves whether this class is a descendant of another
+	specific class.
+
+	@param className string
+	@return Promise<boolean>
+]=]
+function RobloxApiClass:PromiseIsDescendantOf(className)
+	return self:PromiseAllSuperClasses():Then(function(classes)
+		for _, class in pairs(classes) do
+			if class:GetClassName() == className then
+				return true
+			end
+		end
+
+		return false
+	end)
+end
+
+--[=[
+	Returns a promise that resolves to all super classes.
+	@return Promise<{ RobloxApiClass }>
+]=]
+function RobloxApiClass:PromiseAllSuperClasses()
+	if self._allSuperClassesPromise then
+		return self._allSuperClassesPromise
+	end
+
+	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)
+	end
+
+	self._allSuperClassesPromise = chain(self)
+	return self._allSuperClassesPromise
+end
+
+--[=[
+	Returns the super class name
+	@return string?
+]=]
+function RobloxApiClass:GetSuperClassName()
+	local data = self._data.Superclass
+	if data == RobloxApiDumpConstants.ROOT_CLASS_NAME then
+		return nil
+	else
+		return data
+	end
+end
+
+--[=[
+	Returns whether the class has a super class
+	@return boolean
+]=]
+function RobloxApiClass:HasSuperClass()
+	return self:GetSuperClassName() ~= nil
+end
+
+--[=[
+	Retrieves all class members (events, properties, callbacks, functions).
+	@return Promise<{ RobloxApiMember }>
+]=]
+function RobloxApiClass:PromiseMembers()
+	return self._robloxApiDump:PromiseMembers(self:GetClassName())
+end
+
+--[=[
+	Gets all class properties.
+	@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
+			end
+			return result
+		end)
+end
+
+--[=[
+	Gets all class events.
+	@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
+			end
+			return result
+		end)
+end
+
+--[=[
+	Gets all class functions (i.e. methods).
+	@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
+			end
+			return result
+		end)
+end
+
+--[=[
+	Retrieves whether the class is a service
+	@return boolean
+]=]
+function RobloxApiClass:IsService()
+	return self:HasTag("Service")
+end
+
+--[=[
+	Retrieves whether the class is not creatable
+	@return boolean
+]=]
+function RobloxApiClass:IsNotCreatable()
+	return self:HasTag("NotCreatable")
+end
+
+--[=[
+	Retrieves whether the class is not replicated
+	@return boolean
+]=]
+function RobloxApiClass:IsNotReplicated()
+	return self:HasTag("NotReplicated")
+end
+
+--[=[
+	Retrieves whether the class has a tag or not
+	@param tagName string
+	@return boolean
+]=]
+function RobloxApiClass:HasTag(tagName)
+	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
+			self._tagCache[tag] = true
+		end
+	end
+
+	return self._tagCache[tagName] == true
+end
+
+return RobloxApiClass

package/src/Server/RobloxApiDump.lua

@@ -0,0 +1,169 @@
+--[=[
+	Entry point for the Roblox API dump, this class contains api surfaces to
+	query the actual API.
+	@class RobloxApiDump
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local RobloxApiUtils = require("RobloxApiUtils")
+local Promise = require("Promise")
+local RobloxApiMember = require("RobloxApiMember")
+local RobloxApiClass = require("RobloxApiClass")
+local BaseObject = require("BaseObject")
+local RobloxApiDumpConstants = require("RobloxApiDumpConstants")
+
+local RobloxApiDump = setmetatable({}, BaseObject)
+RobloxApiDump.ClassName = "RobloxApiDump"
+RobloxApiDump.__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)
+
+	self._classMemberPromises = {}
+	self._ancestorListPromise = {}
+	self._classPromises = {}
+
+	return self
+end
+
+--[=[
+	Promises the Roblox API class for the given class name.
+	@param className string
+	@return RobloxApiClass
+]=]
+function RobloxApiDump:PromiseClass(className)
+	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)
+
+	return self._classPromises[className]
+end
+
+--[=[
+	Promises all Roblox API members.
+	@param className string
+	@return { RobloxApiMember }
+]=]
+function RobloxApiDump:PromiseMembers(className)
+	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
+				end
+			end
+
+			return members
+		end)
+
+	return self._classMemberPromises[className]
+end
+
+function RobloxApiDump:_promiseClassDataAndAncestorList(className)
+	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(("Could not find data for %q"):format(className))
+			end
+
+			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(("Could not find data for super class %q"):format(superclass))
+					end
+				else
+					current = nil
+				end
+			end
+
+			return dataList
+		end)
+
+	return self._ancestorListPromise[className]
+end
+
+function RobloxApiDump:_promiseRawClassData(className)
+	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(("Could not find data for %q"):format(className))
+			end
+		end)
+end
+
+function RobloxApiDump:_promiseClassMap()
+	if self._classMapPromise then
+		return self._classMapPromise
+	end
+
+	self._classMapPromise = self:_promiseDump():Then(function(dump)
+		assert(dump.Version == 1, "Only able to parse version 1 of the dump")
+
+		local classMap = {}
+		for _, entry in pairs(dump.Classes) do
+			assert(type(entry) == "table", "Bad entry")
+			assert(type(entry.Name) == "string", "Bad entry.Name")
+
+			if classMap[entry.Name] then
+				warn(("[RobloxApiDump] - Duplicate entry for %q"):format(tostring(entry.Name)))
+				return
+			end
+
+			classMap[entry.Name] = entry
+		end
+
+		return classMap
+	end)
+
+	return self._classMapPromise
+end
+
+function RobloxApiDump:_promiseDump()
+	if self._dumpPromise then
+		return self._dumpPromise
+	end
+
+	self._dumpPromise = RobloxApiUtils.promiseDump()
+	return self._maid:GivePromise(self._dumpPromise)
+end
+
+return RobloxApiDump

package/src/Server/RobloxApiDumpConstants.lua

@@ -0,0 +1,11 @@
+--[=[
+	@class RobloxApiDumpConstants
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local Table = require("Table")
+
+return Table.readonly({
+	ROOT_CLASS_NAME = "<<<ROOT>>>"
+})

package/src/Server/RobloxApiMember.lua

@@ -0,0 +1,274 @@
+--[=[
+	Represents a specific member of a class. This could be a property or event, or method, or callback.
+	@class RobloxApiMember
+]=]
+
+local RobloxApiMember = {}
+RobloxApiMember.ClassName = "RobloxApiMember"
+RobloxApiMember.__index = RobloxApiMember
+
+--[=[
+	Constructs a new RobloxApiMember wrapping the data given. See [RobloxApiDump.PromiseMembers] to actually
+	construct this class.
+	@param data table
+	@return RobloxApiMember
+]=]
+function RobloxApiMember.new(data)
+	local self = setmetatable({}, RobloxApiMember)
+
+	--[[
+	 {
+	    "Category": "Data",
+	    "MemberType": "Property",
+	    "Name": "ClassName",
+	    "Security": {
+	        "Read": "None",
+	        "Write": "None"
+	    },
+	    "Serialization": {
+	        "CanLoad": false,
+	        "CanSave": false
+	    },
+	    "Tags": [
+	        "ReadOnly",
+	        "NotReplicated"
+	    ],
+	    "ThreadSafety": "ReadSafe",
+	    "ValueType": {
+	        "Category": "Primitive",
+	        "Name": "string"
+	    }
+	},
+	]]
+	self._data = assert(data, "No data")
+
+	return self
+end
+
+function RobloxApiMember:GetTypeName()
+	local valueType = self._data.ValueType
+	if valueType then
+		return valueType.Name
+	else
+		return nil
+	end
+end
+
+--[=[
+	Gets the member name.
+	@return string
+]=]
+function RobloxApiMember:GetName()
+	assert(type(self._data.Name) == "string", "Bad Name")
+	return self._data.Name
+end
+
+--[=[
+	Gets the member category.
+	@return string?
+]=]
+function RobloxApiMember:GetCategory()
+	return self._data.Category -- might be nil, stuff like "Data" or ""
+end
+
+--[=[
+	Retrieves whether the API member is read only.
+	@return boolean
+]=]
+function RobloxApiMember:IsReadOnly()
+	return self:HasTag("ReadOnly")
+end
+
+--[=[
+	Retrieves the member type.
+	@return string
+]=]
+function RobloxApiMember:GetMemberType()
+	assert(type(self._data.MemberType) == "string", "Bad MemberType")
+	return self._data.MemberType
+end
+
+--[=[
+	Returns whether the member is an event.
+	@return boolean
+]=]
+function RobloxApiMember:IsEvent()
+	return self:GetMemberType() == "Event"
+end
+
+--[=[
+	Retrieves the raw member data
+	@return table
+]=]
+function RobloxApiMember:GetRawData()
+	return self._data
+end
+
+--[=[
+	Returns whether this member has write NotAccessibleSecurity
+	@return boolean
+]=]
+function RobloxApiMember:IsWriteNotAccessibleSecurity()
+	return self:GetWriteSecurity() == "NotAccessibleSecurity"
+end
+
+--[=[
+	Returns whether this member has write NotAccessibleSecurity
+	@return boolean
+]=]
+function RobloxApiMember:IsReadNotAccessibleSecurity()
+	return self:GetReadSecurity() == "NotAccessibleSecurity"
+end
+
+--[=[
+	Returns whether this member has write LocalUserSecurity
+	@return boolean
+]=]
+function RobloxApiMember:IsWriteLocalUserSecurity()
+	return self:GetWriteSecurity() == "LocalUserSecurity"
+end
+
+--[=[
+	Returns whether this member has read LocalUserSecurity
+	@return boolean
+]=]
+function RobloxApiMember:IsReadLocalUserSecurity()
+	return self:GetReadSecurity() == "LocalUserSecurity"
+end
+
+--[=[
+	Returns whether this can serialize save
+	@return boolean?
+]=]
+function RobloxApiMember:CanSerializeSave()
+	local serialization = self._data.Serialization
+	if type(serialization) == "table" then
+		return serialization.CanSave
+	else
+		return nil
+	end
+end
+
+--[=[
+	Returns whether this can serialize save
+	@return boolean?
+]=]
+function RobloxApiMember:CanSerializeLoad()
+	local serialization = self._data.Serialization
+	if type(serialization) == "table" then
+		return serialization.CanLoad
+	else
+		return nil
+	end
+end
+
+--[=[
+	Returns the member's write security as a string
+	@return string?
+]=]
+function RobloxApiMember:GetWriteSecurity()
+	local security = self._data.Security
+	if type(security) == "table" then
+		return security.Write
+	else
+		return nil
+	end
+end
+
+--[=[
+	Returns the member's read security as a string
+	@return string?
+]=]
+function RobloxApiMember:GetReadSecurity()
+	local security = self._data.Security
+	if type(security) == "table" then
+		return security.Write
+	else
+		return nil
+	end
+end
+
+--[=[
+	Returns whether the member is a property.
+	@return boolean
+]=]
+function RobloxApiMember:IsProperty()
+	return self:GetMemberType() == "Property"
+end
+
+--[=[
+	Returns whether the member is a function (i.e. method).
+	@return boolean
+]=]
+function RobloxApiMember:IsFunction()
+	return self:GetMemberType() == "Function"
+end
+
+--[=[
+	Returns whether the member is a callback.
+	@return boolean
+]=]
+function RobloxApiMember:IsCallback()
+	return self:GetMemberType() == "Callback"
+end
+
+--[=[
+	Returns whether a script can modify it.
+	@return boolean
+]=]
+function RobloxApiMember:IsNotScriptable()
+	return self:HasTag("NotScriptable")
+end
+
+--[=[
+	Returns whether the member is not replicated.
+	@return boolean
+]=]
+function RobloxApiMember:IsNotReplicated()
+	return self:HasTag("NotReplicated")
+end
+
+--[=[
+	Returns whether the member is deprecated..
+]=]
+function RobloxApiMember:IsDeprecated()
+	return self:HasTag("Deprecated")
+end
+
+--[=[
+	Returns whether this api member is hidden.
+	@return boolean
+]=]
+function RobloxApiMember:IsHidden()
+	return self:HasTag("Hidden")
+end
+
+--[=[
+	Returns a list of tags. Do not modify this list.
+	@return {string}
+]=]
+function RobloxApiMember:GetTags()
+	return self._data.Tags
+end
+
+--[=[
+	Retrieves whether the member has a tag or not.
+	@param tagName string
+	@return boolean
+]=]
+function RobloxApiMember:HasTag(tagName)
+	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
+			self._tagCache[tag] = true
+		end
+	end
+
+	return self._tagCache[tagName] == true
+end
+
+return RobloxApiMember

package/src/Server/RobloxApiUtils.lua

@@ -0,0 +1,21 @@
+--[=[
+	@class RobloxApiUtils
+]=]
+
+local require = require(script.Parent.loader).load(script)
+
+local HttpPromise = require("HttpPromise")
+
+local API_DUMP_URL = "https://raw.githubusercontent.com/CloneTrooper1019/Roblox-Client-Watch/roblox/API-Dump.json"
+
+local RobloxApiUtils = {}
+
+--[=[
+	Retrieves the raw API dump from the web.
+	@return Promise<table>
+]=]
+function RobloxApiUtils.promiseDump()
+	return HttpPromise.json(API_DUMP_URL)
+end
+
+return RobloxApiUtils

package/src/node_modules.project.json

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