Merge remote-tracking branch 'origin/main' into feature/new-theme

Author: coladarci

CHANGELOG.md

@@ -0,0 +1,38 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [2025-10-15]
+
+### Changed
+- **BREAKING**: Configuration key `peek_app_key` has been renamed to `peek_api_key`
+- **BREAKING**: Configuration key `peek_api_url` has been deprecated in favor of `peek_api_base_url`
+  - The new `peek_api_base_url` should contain only the base URL (e.g., `"https://apps.peekapis.com"`)
+  - The SDK automatically appends appropriate paths (e.g., `/backoffice-gql`) for different API endpoints
+  - **Migration path**:
+    - Existing apps using `peek_api_url` will continue to work for backoffice calls with deprecation warnings
+    - New features like `update_configuration_status` will fail with clear migration instructions if `peek_api_url` is configured
+    - Update your configuration from:
+      ```elixir
+      config :peek_app_sdk,
+        peek_api_url: "https://apps.peekapis.com/backoffice-gql"
+      ```
+      to:
+      ```elixir
+      config :peek_app_sdk,
+        peek_api_base_url: "https://apps.peekapis.com"
+      ```
+
+### Added
+- Support for passing `x-peek-auth` token in request body parameters for scenarios where custom headers cannot be controlled (e.g., form submissions, third-party integrations)
+  - Body parameters take precedence over headers when both are present
+  - Enables authentication in form submission scenarios and legacy systems
+- Configuration validation that prevents use of deprecated `peek_api_url` with new features
+- Deprecation warnings when using legacy `peek_api_url` configuration for backoffice calls
+- Clear error messages with migration instructions for deprecated configuration
+
+### Fixed
+- URL construction now properly handles base URLs without hardcoded paths

README.md

@@ -11,8 +11,8 @@ writing apps.
 config :peek_app_sdk,
   peek_app_secret: "APP_SECRET",
   peek_app_id: "APP_ID",
-  peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-  peek_app_key: "APP_KEY"
+  peek_api_base_url: "https://apps.peekapis.com/",
+  peek_api_key: "API_KEY"
 ```
 
 ### Multiple Application Configurations
@@ -24,8 +24,8 @@ PeekAppSDK supports multiple configurations, allowing different applications to
 config :peek_app_sdk,
   peek_app_secret: "DEFAULT_SECRET",
   peek_app_id: "DEFAULT_APP_ID",
-  peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-  peek_app_key: "DEFAULT_APP_KEY",
+  peek_api_base_url: "https://apps.peekapis.com/",
+  peek_api_key: "DEFAULT_API_KEY",
   # Centralized app configurations
   apps: [
     project_name: [peek_app_id: "project_name_APP_ID", peek_app_secret: "project_name_APP_SECRET"],
@@ -43,7 +43,7 @@ PeekAppSDK.query_peek_pro("install_id", "query { test }")
 PeekAppSDK.query_peek_pro("install_id", "query { test }", %{}, :project_name)
 ```
 
-Note that `peek_api_url` and `peek_app_key` are always taken from the default configuration.
+Note that `peek_api_base_url` and `peek_api_key` are always taken from the default configuration.
 
 ## Some setup tips:
 

config/test.exs

@@ -4,14 +4,14 @@ import Config
 config :peek_app_sdk,
   peek_app_secret: "test_secret",
   peek_app_id: "test_app_id",
-  peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-  peek_app_key: "test_app_key",
+  peek_api_base_url: "https://apps.peekapis.com",
+  peek_api_key: "test_api_key",
   client_secret_token: "test_client_secret",
   # Centralized configuration structure
   apps: [
     project_name: [
       peek_app_id: "project_name_app_id",
-      peek_app_key: "project_name_app_key",
+      peek_api_key: "project_name_api_key",
       peek_app_secret: "project_name_app_secret",
       client_secret_token: "project_name_client_secret"
     ],

lib/peek_app_sdk.ex

@@ -24,16 +24,16 @@ defmodule PeekAppSDK do
   config :peek_app_sdk,
     peek_app_secret: "DEFAULT_SECRET",
     peek_app_id: "DEFAULT_APP_ID",
-    peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-    peek_app_key: "APP_KEY",
+    peek_api_base_url: "https://apps.peekapis.com/",
+    peek_api_key: "API_KEY",
     # Centralized app configurations
     apps: [
       project_name: [peek_app_id: "project_name_APP_ID", peek_app_secret: "project_name_APP_SECRET"],
       another_app: [peek_app_id: "ANOTHER_APP_ID", peek_app_secret: "ANOTHER_APP_SECRET"]
     ]
   ```
 
-  Note that `peek_api_url` and `peek_app_key` are always taken from the default
+  Note that `peek_api_base_url` and `peek_api_key` are always taken from the default
   `:peek_app_sdk` configuration, regardless of which application identifier is used.
   """
 
@@ -49,8 +49,8 @@ defmodule PeekAppSDK do
       %{
         peek_app_secret: "project_name_secret",
         peek_app_id: "project_name_app_id",
-        peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-        peek_app_key: "default_app_key"
+        peek_api_base_url: "https://apps.peekapis.com",
+        peek_api_key: "default_api_key"
       }
 
   Using the default configuration:
@@ -59,8 +59,8 @@ defmodule PeekAppSDK do
       %{
         peek_app_secret: "default_secret",
         peek_app_id: "default_app_id",
-        peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-        peek_app_key: "default_app_key"
+        peek_api_base_url: "https://apps.peekapis.com",
+        peek_api_key: "default_api_key"
       }
   """
   @spec get_config(atom() | nil) :: map()

lib/peek_app_sdk/client.ex

@@ -39,16 +39,17 @@ defmodule PeekAppSDK.Client do
 
     config = Config.get_config(config_id)
     peek_app_id = config.peek_app_id
-    peek_app_key = config.peek_app_key
+    peek_api_key = config.peek_api_key
 
     operation_name = operation_name(gql_query)
-    url = "#{config.peek_api_url |> String.trim()}/#{peek_app_id}/#{operation_name}"
+
+    url = build_backoffice_url(config, peek_app_id, operation_name)
 
     case Tesla.request(client(),
            method: :post,
            url: url,
            body: body_params,
-           headers: headers(install_id, config_id, peek_app_key)
+           headers: headers(install_id, config_id, peek_api_key)
          ) do
       # If we get back an error, fail the whole thing and return the error for now.
       {:ok, %Tesla.Env{status: 200, body: %{errors: [_error | _rest] = errors}}} ->
@@ -97,15 +98,39 @@ defmodule PeekAppSDK.Client do
     [x_peek_auth_header(install_id, config_id)]
   end
 
-  defp headers(install_id, config_id, peek_app_key) do
+  defp headers(install_id, config_id, peek_api_key) do
     [
       x_peek_auth_header(install_id, config_id),
-      {"pk-api-key", peek_app_key}
+      {"pk-api-key", peek_api_key}
     ]
   end
 
   defp x_peek_auth_header(install_id, config_id),
     do:
       {"X-Peek-Auth",
        "Bearer #{PeekAppSDK.Token.new_for_app_installation!(install_id, nil, config_id)}"}
+
+  # Migration helper for building backoffice URLs
+  defp build_backoffice_url(config, peek_app_id, operation_name) do
+    # Check if legacy peek_api_url is configured
+    legacy_url = Application.get_env(:peek_app_sdk, :peek_api_url)
+
+    if legacy_url do
+      Logger.warning("""
+      DEPRECATION WARNING: peek_api_url configuration is deprecated.
+      Please update your configuration to use peek_api_base_url instead.
+
+      Current (deprecated): peek_api_url: "#{legacy_url}"
+      Recommended: peek_api_base_url: "https://apps.peekapis.com"
+
+      Using legacy URL for backoffice calls: #{legacy_url}
+      """)
+
+      # Use the legacy URL directly without appending /backoffice-gql
+      "#{String.trim(legacy_url)}/#{peek_app_id}/#{operation_name}"
+    else
+      # Use the new base URL and append /backoffice-gql
+      "#{String.trim(config.peek_api_base_url)}/backoffice-gql/#{peek_app_id}/#{operation_name}"
+    end
+  end
 end

lib/peek_app_sdk/config.ex

@@ -13,21 +13,28 @@ defmodule PeekAppSDK.Config do
   config :peek_app_sdk,
     peek_app_secret: "DEFAULT_SECRET",
     peek_app_id: "DEFAULT_APP_ID",
-    peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-    peek_app_key: "APP_KEY",
+    peek_api_base_url: "https://apps.peekapis.com",
+    peek_api_key: "API_KEY",
     client_secret_token: "CLIENT_SECRET_TOKEN",
     apps: [
       project_name: [peek_app_id: "project_name_app_id", peek_app_secret: "project_name_secret", client_secret_token: "base64_key"],
       another_app: [peek_app_id: "another_app_id", peek_app_secret: "another_app_secret"]
     ]
   ```
 
-  Note that `peek_api_url` and `peek_app_key` are always taken from the default
+  Note that `peek_api_base_url` and `peek_api_key` are always taken from the default
   `:peek_app_sdk` configuration, regardless of which application identifier is used.
   """
 
-  @default_peek_url "https://apps.peekapis.com/backoffice-gql"
+  @default_peek_api_base_url "https://apps.peekapis.com"
 
+  @spec get_config() :: %{
+          client_secret_token: any(),
+          peek_api_base_url: any(),
+          peek_app_id: any(),
+          peek_api_key: any(),
+          peek_app_secret: any()
+        }
   @doc """
   Gets the configuration for the given identifier.
   If no identifier is provided, returns the default configuration from :peek_app_sdk.
@@ -40,8 +47,8 @@ defmodule PeekAppSDK.Config do
       %{
         peek_app_secret: "project_name_secret",
         peek_app_id: "project_name_app_id",
-        peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-        peek_app_key: "default_app_key"
+        peek_api_base_url: "https://apps.peekapis.com",
+        peek_api_key: "default_api_key"
       }
 
   Using the default configuration:
@@ -50,11 +57,11 @@ defmodule PeekAppSDK.Config do
       %{
         peek_app_secret: "default_secret",
         peek_app_id: "default_app_id",
-        peek_api_url: "https://apps.peekapis.com/backoffice-gql",
-        peek_app_key: "default_app_key"
+        peek_api_base_url: "https://apps.peekapis.com",
+        peek_api_key: "default_api_key"
       }
 
-  Note that `peek_api_url` and `peek_app_key` are always taken from the default
+  Note that `peek_api_base_url` and `peek_api_key` are always taken from the default
   `:peek_app_sdk` configuration, regardless of which application identifier is used.
   """
   @spec get_config(atom() | nil) :: map()
@@ -65,8 +72,9 @@ defmodule PeekAppSDK.Config do
     %{
       peek_app_secret: Application.get_env(:peek_app_sdk, :peek_app_secret),
       peek_app_id: Application.get_env(:peek_app_sdk, :peek_app_id),
-      peek_api_url: Application.get_env(:peek_app_sdk, :peek_api_url, @default_peek_url),
-      peek_app_key: Application.get_env(:peek_app_sdk, :peek_app_key),
+      peek_api_base_url:
+        Application.get_env(:peek_app_sdk, :peek_api_base_url, @default_peek_api_base_url),
+      peek_api_key: Application.get_env(:peek_app_sdk, :peek_api_key),
       client_secret_token: Application.get_env(:peek_app_sdk, :client_secret_token)
     }
   end
@@ -81,13 +89,39 @@ defmodule PeekAppSDK.Config do
       %{
         peek_app_secret: Keyword.get(app_config, :peek_app_secret),
         peek_app_id: Keyword.get(app_config, :peek_app_id),
-        peek_api_url: Application.get_env(:peek_app_sdk, :peek_api_url, @default_peek_url),
-        peek_app_key: Keyword.get(app_config, :peek_app_key),
+        peek_api_base_url:
+          Application.get_env(:peek_app_sdk, :peek_api_base_url, @default_peek_api_base_url),
+        peek_api_key: Keyword.get(app_config, :peek_api_key),
         client_secret_token: Keyword.get(app_config, :client_secret_token)
       }
     else
       # Fall back to default configuration if the app is not configured
       get_config(nil)
     end
   end
+
+  # Migration helper functions
+  @doc """
+  Checks for deprecated peek_api_url configuration and raises an error if found.
+  This is called when using the update_configuration_status feature.
+  """
+  def check_deprecated_config! do
+    if Application.get_env(:peek_app_sdk, :peek_api_url) do
+      raise """
+      Configuration error: peek_api_url is deprecated and no longer supported.
+
+      Please update your configuration to use peek_api_base_url instead:
+
+      OLD (deprecated):
+        config :peek_app_sdk,
+          peek_api_url: "https://apps.peekapis.com/backoffice-gql"
+
+      NEW (required):
+        config :peek_app_sdk,
+          peek_api_base_url: "https://apps.peekapis.com"
+
+      The SDK will automatically append the appropriate path (/backoffice-gql) when making API calls.
+      """
+    end
+  end
 end

lib/peek_app_sdk/metrics.ex

@@ -9,6 +9,9 @@ defmodule PeekAppSDK.Metrics do
   defdelegate track_uninstall(external_refid, name, is_test, opts \\ []),
     to: PeekAppSDK.Metrics.Client
 
+  defdelegate update_configuration_status(install_id, status, notes \\ nil),
+    to: PeekAppSDK.Metrics.Client
+
   @doc """
   Tracks an event with the given event ID and payload.
 

lib/peek_app_sdk/metrics/client.ex

@@ -1,4 +1,6 @@
 defmodule PeekAppSDK.Metrics.Client do
+  alias PeekAppSDK.Config
+
   @moduledoc """
   Client for sending metrics to the Peek Pro metrics service.
   """
@@ -16,6 +18,32 @@ defmodule PeekAppSDK.Metrics.Client do
     Tesla.client(middleware)
   end
 
+  def update_configuration_status(install_id, status, notes \\ nil, config_id \\ nil) do
+    # Check for deprecated configuration when using the new update_configuration_status feature
+    Config.check_deprecated_config!()
+
+    body = %{
+      status: status,
+      notes: notes
+    }
+
+    config = Config.get_config(config_id)
+    peek_api_key = config.peek_api_key
+    peek_app_id = config.peek_app_id
+    peek_api_base_url = config.peek_api_base_url
+
+    url =
+      "#{peek_api_base_url}/registry/installations/#{peek_app_id}/#{install_id}/configuration_status"
+
+    case Tesla.put!(client(), url, body, headers: headers(install_id, config_id, peek_api_key)) do
+      %Tesla.Env{status: 200} ->
+        :ok
+
+      %Tesla.Env{status: status, body: body} ->
+        {:error, {status, body}}
+    end
+  end
+
   @doc """
   Tracks an event with the given event ID and payload.
 
@@ -136,4 +164,20 @@ defmodule PeekAppSDK.Metrics.Client do
         {:error, {status, body}}
     end
   end
+
+  defp headers(install_id, config_id, nil) do
+    [x_peek_auth_header(install_id, config_id)]
+  end
+
+  defp headers(install_id, config_id, peek_api_key) do
+    [
+      x_peek_auth_header(install_id, config_id),
+      {"pk-api-key", peek_api_key}
+    ]
+  end
+
+  defp x_peek_auth_header(install_id, config_id),
+    do:
+      {"X-Peek-Auth",
+       "Bearer #{PeekAppSDK.Token.new_for_app_installation!(install_id, nil, config_id)}"}
 end

lib/peek_app_sdk/plugs/client_auth.ex

@@ -20,9 +20,15 @@ defmodule PeekAppSDK.Plugs.ClientAuth do
       plug :set_peek_install_id_from_client, config_id: {:project, :project_name}
   """
   def set_peek_install_id_from_client(conn, opts) do
-    case Plug.Conn.get_req_header(conn, "x-peek-auth") do
-      ["Bearer " <> token] -> do_set(conn, token, opts)
-      _ -> conn
+    case conn.body_params do
+      %{"x-peek-auth" => token} ->
+        do_set(conn, token, opts)
+
+      _ ->
+        case Plug.Conn.get_req_header(conn, "x-peek-auth") do
+          ["Bearer " <> token] -> do_set(conn, token, opts)
+          _ -> conn
+        end
     end
   end