Add support for uploading and syncing plugins (#4)

Co-authored-by: Marin Minnerly <[email protected]>

Author: vocksel

examples/plugin/default.project.json

@@ -0,0 +1,7 @@
+{
+  "name": "plugin",
+  "emitLegacyScripts": false,
+  "tree": {
+    "$path": "src"
+  }
+}

examples/plugin/deploy.luau

@@ -0,0 +1,12 @@
+local rbxasset = require("@root/")
+
+local process = require("@lune/process")
+
+local apiKey = process.args[1]
+assert(apiKey, "argument #1 must be a valid Open Cloud API key")
+
+assert(process.cwd:match("examples/plugin"), "you must be in the `examples/plugin` folder when running this script")
+
+process.exec("rojo", { "build", "-o", "plugin.rbxm" })
+
+rbxasset.publishPackageAsync(process.cwd, "plugin.rbxm", apiKey)

examples/plugin/icon.png

@@ -0,0 +1,5 @@
+assetId = "104757825775127"
+
+[images."icon.png"]
+assetId = "124561703176693"
+hash = "fac185770cf5e824d4c0a9b59e547df42dc10011c5ad139bfc2c7e1507eef631"

examples/plugin/rbxasset-manifest.toml

@@ -0,0 +1,12 @@
+[asset]
+name = "Example Plugin"
+description = "Longform description"
+icon = "icon.png"
+type = "Plugin"
+distribute = true
+
+[deployment]
+creatorId = 35175308
+creatorType = "Group"
+universeId = 7854970752
+placeId = 119490202754966

examples/plugin/rbxasset.toml

@@ -0,0 +1 @@
+print("This is a plugin!")

examples/plugin/src/init.plugin.luau

@@ -1,5 +1,5 @@
 [tools]
 lune = { source = "lune-org/lune", version = "=0.9.3" }
-rojo = { source = "rojo-rbx/rojo", version = "=7.3.0" }
+rojo = { source = "rojo-rbx/rojo", version = "=7.5.0" }
 selene = { source = "kampfkarren/selene", version = "=0.28.0" }
 stylua = { source = "johnnymorganz/stylua", version = "=2.1.0" }

foreman.toml

@@ -25,6 +25,7 @@ local function publishAssetAsync(
 	local variables = runLuauTask(publishAssetTask, {
 		CREATOR_ID = assetConfig.deployment.creatorId,
 		CREATOR_TYPE = assetConfig.deployment.creatorType,
+		ASSET_TYPE = assetConfig.asset.type or "Package",
 
 		-- Only provide the assetId from the manifest if there's a matching
 		-- asset on the Creator Store. We need this check in case the manifest

src/requests/publishAssetAsync.luau

@@ -2,8 +2,11 @@ local serde = require("@lune/serde")
 
 local createFormData = require("@root/requests/forms/createFormData")
 local fetch = require("@root/requests/fetch")
+local types = require("@root/types")
 local waitForAssetOperationAsync = require("@root/requests/waitForAssetOperationAsync")
 
+type OperationResponse = types.OperationResponse
+
 type AssetDetails = {
 	displayName: string,
 	description: string?,
@@ -30,9 +33,13 @@ local function setAssetDetailsAsync(assetId: string, apiKey: string, details: As
 		body = formData.body,
 	})
 
-	local body = serde.decode("json", res.body)
+	local body: OperationResponse = serde.decode("json", res.body)
 
-	waitForAssetOperationAsync(body.operationId, apiKey)
+	if body.message then
+		error(body.message)
+	else
+		waitForAssetOperationAsync(body.operationId, apiKey)
+	end
 end
 
 return setAssetDetailsAsync

src/requests/setAssetDetailsAsync.luau

@@ -2,19 +2,12 @@ local serde = require("@lune/serde")
 local task = require("@lune/task")
 
 local fetch = require("@root/requests/fetch")
+local types = require("@root/types")
 
 local MAX_RETRIES = 5
 local RETRY_MULTIPLIER = 2
 
-type OperationResponse = {
-	done: boolean,
-	operationId: string,
-	path: string,
-	response: { [string]: any },
-} | {
-	code: string,
-	message: string,
-}
+type OperationResponse = types.OperationResponse
 
 local function waitForAssetOperationAsync(operationId: string, apiKey: string): OperationResponse
 	local currentRetries = 0