From e17b25708b6c4b964dbc8a5adc766e7ff1b13879 Mon Sep 17 00:00:00 2001
From: Filip Tibell <filip.tibell@gmail.com>
Date: Fri, 24 Mar 2023 11:10:11 +0100
Subject: [PATCH] Add typedefs for roblox builtin

---
 docs/typedefs/Roblox.luau | 96 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 96 insertions(+)
 create mode 100644 docs/typedefs/Roblox.luau

diff --git a/docs/typedefs/Roblox.luau b/docs/typedefs/Roblox.luau
new file mode 100644
index 0000000..205547e
--- /dev/null
+++ b/docs/typedefs/Roblox.luau
@@ -0,0 +1,96 @@
+export type Instance = {}
+
+--[=[
+	@class Process
+
+	Built-in library for manipulating Roblox place & model files
+
+	### Example usage
+
+	```lua
+	local roblox = require("@lune/roblox")
+
+	-- Reading & writing a place file
+	local game = roblox.readPlaceFile("myPlaceFile.rbxl")
+	local workspace = game:GetService("Workspace")
+
+	for _, child in workspace:GetChildren() do
+		print("Found child " .. child.Name .. " of class " .. child.ClassName)
+	end
+
+	roblox.writePlaceFile("myPlaceFile.rbxl", game)
+	```
+]=]
+export type Roblox = {
+	--[=[
+		Reads a place file into a DataModel instance.
+
+		### Example usage
+
+		```lua
+		local roblox = require("@lune/roblox")
+		local game = roblox.readPlaceFile("filePath.rbxl")
+		```
+	]=]
+	readPlaceFile: (filePath: string) -> Instance,
+	--[=[
+		Reads a model file into a table of instances.
+
+		### Example usage
+
+		```lua
+		local roblox = require("@lune/roblox")
+		local instances = roblox.readModelFile("filePath.rbxm")
+		```
+	]=]
+	readModelFile: (filePath: string) -> { Instance },
+	--[=[
+		Writes a DataModel instance to a place file.
+
+		### Example usage
+
+		```lua
+		local roblox = require("@lune/roblox")
+		roblox.writePlaceFile("filePath.rbxl", game)
+		```
+	]=]
+	writePlaceFile: (filePath: string, dataModel: Instance) -> (),
+	--[=[
+		Writes one or more instances to a model file.
+
+		### Example usage
+
+		```lua
+		local roblox = require("@lune/roblox")
+		roblox.writeModelFile("filePath.rbxm", { instance1, instance2, ... })
+		```
+	]=]
+	writeModelFile: (filePath: string, instances: { Instance }) -> (),
+	--[=[
+		Gets the current auth cookie, for usage with Roblox web APIs.
+
+		### Example usage
+
+		```lua
+		local roblox = require("@lune/roblox")
+		local net = require("@lune/net")
+
+		local cookie = roblox.getAuthCookie()
+		assert(cookie ~= nil, "Failed to get roblox auth cookie")
+
+		local myPrivatePlaceId = 1234567890
+
+		local response = net.request({
+			url = "https://assetdelivery.roblox.com/v2/assetId/" .. tostring(myPrivatePlaceId),
+			headers = {
+				Cookie = cookie,
+			},
+		})
+
+		local responseTable = net.jsonDecode(response.body)
+		local responseLocation = responseTable.locations[1].location
+		print("Download link to place: " .. responseLocation)
+		```
+	]=]
+	getAuthCookie: (raw: boolean?) -> string?,
+}