Greenfield: Add brandColor to store APIs

Closes #5946.
btcpayserver · Apr 23, 2024 · dc48116 · dc48116
1 parent c61676a
commit dc48116
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 0 deletions.
diff --git a/BTCPayServer.Client/Models/StoreBaseData.cs b/BTCPayServer.Client/Models/StoreBaseData.cs
@@ -16,6 +16,8 @@ public abstract class StoreBaseData
 
         public string Website { get; set; }
 
+        public string BrandColor { get; set; }
+
         public string SupportUrl { get; set; }
 
         [JsonConverter(typeof(TimeSpanJsonConverter.Seconds))]

diff --git a/BTCPayServer/Controllers/GreenField/GreenfieldStoresController.cs b/BTCPayServer/Controllers/GreenField/GreenfieldStoresController.cs
@@ -116,6 +116,7 @@ internal static Client.Models.StoreData FromModel(StoreData data)
                 Name = data.StoreName,
                 Website = data.StoreWebsite,
                 Archived = data.Archived,
+                BrandColor = storeBlob.BrandColor,
                 SupportUrl = storeBlob.StoreSupportUrl,
                 SpeedPolicy = data.SpeedPolicy,
                 DefaultPaymentMethod = data.GetDefaultPaymentId()?.ToString(),
@@ -192,6 +193,7 @@ private void ToModel(StoreBaseData restModel, StoreData model, PaymentMethodId d
             blob.LightningDescriptionTemplate = restModel.LightningDescriptionTemplate;
             blob.PaymentTolerance = restModel.PaymentTolerance;
             blob.PayJoinEnabled = restModel.PayJoinEnabled;
+            blob.BrandColor = restModel.BrandColor;
             if (restModel.AutoDetectLanguage.HasValue)
                 blob.AutoDetectLanguage = restModel.AutoDetectLanguage.Value;
             if (restModel.ShowPayInWalletButton.HasValue)
@@ -237,6 +239,10 @@ private IActionResult Validate(StoreBaseData request)
             {
                 ModelState.AddModelError(nameof(request.Website), "Website is not a valid url");
             }
+            if (!string.IsNullOrEmpty(request.BrandColor) && !ColorPalette.IsValid(request.BrandColor))
+            {
+                ModelState.AddModelError(nameof(request.BrandColor), "Brand color is not a valid HEX Color (e.g. #F7931A)");
+            }
             if (request.InvoiceExpiration < TimeSpan.FromMinutes(1) && request.InvoiceExpiration > TimeSpan.FromMinutes(60 * 24 * 24))
                 ModelState.AddModelError(nameof(request.InvoiceExpiration), "InvoiceExpiration can only be between 1 and 34560 mins");
             if (request.DisplayExpirationTimer < TimeSpan.FromMinutes(1) && request.DisplayExpirationTimer > TimeSpan.FromMinutes(60 * 24 * 24))

diff --git a/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json b/BTCPayServer/wwwroot/swagger/v1/swagger.template.stores.json
@@ -411,6 +411,12 @@
                         "description": "The support URI of the store, can contain the placeholders `{OrderId}` and `{InvoiceId}`. Can be any valid URI, such as a website, email, and nostr.",
                         "format": "uri"
                     },
+                    "brandColor": {
+                        "type": "string",
+                        "description": "The brand color of the store in HEX format",
+                        "nullable": true,
+                        "example": "#F7931A"
+                    },
                     "defaultCurrency": {
                         "type": "string",
                         "description": "The default currency of the store",