lune-packaging/docs/typedefs/Roblox.luau

-- TODO: Autogenerate this somehow ...
export type Instance = {}

--[=[
	@class Roblox

	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)
	```
]=]
return {
	--[=[
		@within Roblox
		@must_use

		Reads a place file into a DataModel instance.

		### Example usage

		```lua
		local roblox = require("@lune/roblox")
		local game = roblox.readPlaceFile("filePath.rbxl")
		```

		@param filePath The file path to read from
	]=]
	readPlaceFile = function(filePath: string): Instance
		return nil :: any
	end,
	--[=[
		@within Roblox
		@must_use

		Reads a model file into a table of instances.

		### Example usage

		```lua
		local roblox = require("@lune/roblox")
		local instances = roblox.readModelFile("filePath.rbxm")
		```

		@param filePath The file path to read from
	]=]
	readModelFile = function(filePath: string): { Instance }
		return nil :: any
	end,
	--[=[
		@within Roblox

		Writes a DataModel instance to a place file.

		### Example usage

		```lua
		local roblox = require("@lune/roblox")
		roblox.writePlaceFile("filePath.rbxl", game)
		```

		@param filePath The file path to write to
		@param dataModel The DataModel to write to the file
	]=]
	writePlaceFile = function(filePath: string, dataModel: Instance) end,
	--[=[
		@within Roblox

		Writes one or more instances to a model file.

		### Example usage

		```lua
		local roblox = require("@lune/roblox")
		roblox.writeModelFile("filePath.rbxm", { instance1, instance2, ... })
		```

		@param filePath The file path to write to
		@param instances The array of instances to write to the file
	]=]
	writeModelFile = function(filePath: string, instances: { Instance }) end,
	--[=[
		@within Roblox
		@must_use

		Gets the current auth cookie, for usage with Roblox web APIs.

		Note that this auth cookie is formatted for use as a "Cookie" header,
		and that it contains restrictions so that it may only be used for
		official Roblox endpoints. To get the raw cookie value without any
		additional formatting, you can pass `true` as the first and only parameter.

		### 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)
		```

		@param raw If the cookie should be returned as a pure value or not. Defaults to false
	]=]
	getAuthCookie = function(raw: boolean?): string?
		return nil :: any
	end,
}