Add endpoints for managing custom props in Sites API

Author: zoldar

extra/lib/plausible_web/controllers/api/external_sites_controller.ex

@@ -8,6 +8,7 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
   alias Plausible.Sites
   alias Plausible.Goal
   alias Plausible.Goals
+  alias Plausible.Props
   alias Plausible.Teams
   alias PlausibleWeb.Api.Helpers, as: H
 
@@ -445,6 +446,68 @@ defmodule PlausibleWeb.Api.ExternalSitesController do
     end
   end
 
+  def custom_props_index(conn, params) do
+    user = conn.assigns.current_user
+    team = conn.assigns.current_team
+
+    with {:ok, site_id} <- expect_param_key(params, "site_id"),
+         {:ok, site} <- find_site(user, team, site_id, [:owner, :admin, :editor]) do
+      properties =
+        (site.allowed_event_props || [])
+        |> Enum.map(fn prop -> %{property: prop} end)
+
+      json(conn, %{custom_properties: properties})
+    else
+      {:error, :site_not_found} ->
+        H.not_found(conn, "Site could not be found")
+
+      {:missing, "site_id"} ->
+        H.bad_request(conn, "Parameter `site_id` is required to list custom properties")
+    end
+  end
+
+  def add_custom_prop(conn, params) do
+    user = conn.assigns.current_user
+    team = conn.assigns.current_team
+
+    with {:ok, site_id} <- expect_param_key(params, "site_id"),
+         {:ok, property} <- expect_param_key(params, "property"),
+         {:ok, site} <- find_site(user, team, site_id, [:owner, :admin, :editor]),
+         {:ok, _} <- Props.allow(site, property) do
+      json(conn, %{"created" => true})
+    else
+      {:error, :site_not_found} ->
+        H.not_found(conn, "Site could not be found")
+
+      {:missing, param} ->
+        H.bad_request(conn, "Parameter `#{param}` is required to create a custom property")
+
+      e ->
+        H.bad_request(conn, "Something went wrong: #{inspect(e)}")
+    end
+  end
+
+  def delete_custom_prop(conn, params) do
+    user = conn.assigns.current_user
+    team = conn.assigns.current_team
+
+    with {:ok, site_id} <- expect_param_key(params, "site_id"),
+         {:ok, property} <- expect_param_key(params, "property"),
+         {:ok, site} <- find_site(user, team, site_id, [:owner, :admin, :editor]),
+         {:ok, _} <- Props.disallow(site, property) do
+      json(conn, %{"deleted" => true})
+    else
+      {:error, :site_not_found} ->
+        H.not_found(conn, "Site could not be found")
+
+      {:missing, param} ->
+        H.bad_request(conn, "Parameter `#{param}` is required to delete a custom property")
+
+      e ->
+        H.bad_request(conn, "Something went wrong: #{inspect(e)}")
+    end
+  end
+
   defp pagination_meta(meta) do
     %{
       after: meta.after,

lib/plausible_web/router.ex

@@ -337,6 +337,7 @@ defmodule PlausibleWeb.Router do
 
         scope assigns: %{api_context: :site} do
           get "/goals", ExternalSitesController, :goals_index
+          get "/custom-props", ExternalSitesController, :custom_props_index
           get "/guests", ExternalSitesController, :guests_index
           get "/:site_id", ExternalSitesController, :get_site
         end
@@ -353,6 +354,9 @@ defmodule PlausibleWeb.Router do
           put "/goals", ExternalSitesController, :find_or_create_goal
           delete "/goals/:goal_id", ExternalSitesController, :delete_goal
 
+          put "/custom-props", ExternalSitesController, :add_custom_prop
+          delete "/custom-props/*property", ExternalSitesController, :delete_custom_prop
+
           put "/guests", ExternalSitesController, :find_or_create_guest
           delete "/guests/:email", ExternalSitesController, :delete_guest