From 9c4396ef492b3a54bcf849da1db25ef3925ed6fd Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Franti=C5=A1ek=20Boh=C3=A1=C4=8Dek?=
 <fandabohacek@gmail.com>
Date: Sat, 29 Jan 2022 19:05:12 +0100
Subject: [PATCH] feat(data): add translatable string

---
 .../Language/ILanguageService.cs              | 10 +++++-
 .../Language/TranslatableString.cs            | 33 +++++++++++++++++++
 2 files changed, 42 insertions(+), 1 deletion(-)
 create mode 100644 Data/NosSmooth.Data.Abstractions/Language/TranslatableString.cs

diff --git a/Data/NosSmooth.Data.Abstractions/Language/ILanguageService.cs b/Data/NosSmooth.Data.Abstractions/Language/ILanguageService.cs
index 1afc2b3..f97e27c 100644
--- a/Data/NosSmooth.Data.Abstractions/Language/ILanguageService.cs
+++ b/Data/NosSmooth.Data.Abstractions/Language/ILanguageService.cs
@@ -25,5 +25,13 @@ public interface ILanguageService
     /// <param name="key">The key to translate.</param>
     /// <param name="language">The language, <see cref="CurrentLanguage"/> will be used if null.</param>
     /// <returns>The translated string or an error.</returns>
-    public Result<string> GetTranslation(TranslationRoot root, LanguageKey key, Language? language = default);
+    public Result<string> GetTranslation(TranslationRoot root, string key, Language? language = default);
+
+    /// <summary>
+    /// Gets the translation of the given key.
+    /// </summary>
+    /// <param name="translatableString">The translatable string containing .</param>
+    /// <param name="language">The language, <see cref="CurrentLanguage"/> will be used if null.</param>
+    /// <returns>The translated string or an error.</returns>
+    public Result<string> GetTranslation(TranslatableString translatableString, Language? language = default);
 }
\ No newline at end of file
diff --git a/Data/NosSmooth.Data.Abstractions/Language/TranslatableString.cs b/Data/NosSmooth.Data.Abstractions/Language/TranslatableString.cs
new file mode 100644
index 0000000..51bb4b9
--- /dev/null
+++ b/Data/NosSmooth.Data.Abstractions/Language/TranslatableString.cs
@@ -0,0 +1,33 @@
+//
+//  TranslatableString.cs
+//
+//  Copyright (c) František Boháček. All rights reserved.
+//  Licensed under the MIT license. See LICENSE file in the project root for full license information.
+
+using System.Diagnostics.CodeAnalysis;
+
+namespace NosSmooth.Data.Abstractions.Language;
+
+/// <summary>
+/// Represents a string that may be translated.
+/// </summary>
+/// <param name="Root">The root key of the translations.</param>
+/// <param name="Key">The key of the string translation.</param>
+[SuppressMessage("StyleCop.CSharp.NamingRules", "SA1313:Parameter names should begin with lower-case letter", Justification = "Standard.")]
+public record struct TranslatableString(TranslationRoot Root, string Key)
+{
+    /// <summary>
+    /// Gets the translated string, if available.
+    /// If not available, the key will be returned.
+    /// </summary>
+    public string Translated { get; private set; } = Key;
+
+    /// <summary>
+    /// Fill this translatable string with a translation.
+    /// </summary>
+    /// <param name="translation">The translation to fill.</param>
+    public void Fill(string translation)
+    {
+        Translated = translation;
+    }
+}
\ No newline at end of file
-- 
2.49.0