From b600d56e9591d5ee7af2381e3d990ae5ba8a0df9 Mon Sep 17 00:00:00 2001
From: Myzel394 <50424412+Myzel394@users.noreply.github.com>
Date: Sun, 5 Mar 2023 10:33:44 +0100
Subject: [PATCH] refactor: Improve i18n for admin create reserved aliases
---
.../locales/en-US/admin-reserved-aliases.json | 38 ++++++++
public/locales/en-US/common.json | 3 +
public/locales/en-US/translation.json | 92 +++++++++++++++++++
.../AliasExplanation.tsx | 8 +-
.../UsersSelectField.tsx | 15 ++-
.../ReservedAliasesRoute/EmptyStateScreen.tsx | 12 +--
src/routes/AdminRoute.tsx | 2 +-
src/routes/CreateReservedAliasRoute.tsx | 24 ++---
src/routes/ReservedAliasesRoute.tsx | 14 ++-
9 files changed, 164 insertions(+), 44 deletions(-)
create mode 100644 public/locales/en-US/admin-reserved-aliases.json
diff --git a/public/locales/en-US/admin-reserved-aliases.json b/public/locales/en-US/admin-reserved-aliases.json
new file mode 100644
index 0000000..f8cf123
--- /dev/null
+++ b/public/locales/en-US/admin-reserved-aliases.json
@@ -0,0 +1,38 @@
+{
+ "title": "Reserved Aliases",
+ "pageActions": {
+ "search": {
+ "placeholder": "Search for aliases"
+ }
+ },
+ "actions": {
+ "create": {
+ "label": "Create new Reserved Alias"
+ }
+ },
+ "userAmount_one": "Forwards to one user",
+ "userAmount_other": "Forwards to {{count}} users",
+ "emptyState": {
+ "title": "Create your first reserved alias",
+ "description": "Reserved aliases are aliases that will be forwarded to selected admin users. This is useful if you want to create aliases that are meant to be public, like contact@example.com or hello@example.com."
+ },
+ "createNew": {
+ "title": "Reserved Aliases",
+ "description": "Define what alias should forward to whom.",
+ "continueActionLabel": "Create Reserved Alias",
+ "fields": {
+ "active": {
+ "label": "Active"
+ },
+ "users": {
+ "label": "Users",
+ "me": "{{email}} (Me)"
+ }
+ },
+ "explanation": {
+ "step1": "User from outside",
+ "step2": "Sends mail to",
+ "step4": "KleckRelay forwards to"
+ }
+ }
+}
diff --git a/public/locales/en-US/common.json b/public/locales/en-US/common.json
index ebc82d5..d93c5be 100644
--- a/public/locales/en-US/common.json
+++ b/public/locales/en-US/common.json
@@ -32,6 +32,9 @@
"label": "Address",
"placeholder": "awesome-fish"
},
+ "local": {
+ "label": "Address"
+ },
"search": {
"label": "Search"
}
diff --git a/public/locales/en-US/translation.json b/public/locales/en-US/translation.json
index bcfb7d6..5610130 100644
--- a/public/locales/en-US/translation.json
+++ b/public/locales/en-US/translation.json
@@ -129,6 +129,98 @@
"reservedAliases": "Reserved Aliases",
"settings": "Global Settings"
},
+ "forms": {
+ "reservedAliases": {
+ "title": "Reserved Aliases",
+ "description": "Define what alias should forward to whom.",
+ "saveAction": "Create Alias",
+ "fields": {
+ "local": {
+ "label": "Local"
+ },
+ "users": {
+ "label": "Users",
+ "me": "{{email}} (Me)"
+ }
+ },
+ "explanation": {
+ "step1": "User from outside",
+ "step2": "Sends mail to",
+ "step4": "KleckRelay forwards to"
+ }
+ },
+ "settings": {
+ "randomEmailIdMinLength": {
+ "label": "Minimum random alias ID length",
+ "description": "The minimum length for randomly generated emails. The server will automatically increase the length if required so."
+ },
+ "randomEmailIdChars": {
+ "label": "Random alias character pool",
+ "description": "Characters that are used to generate random emails."
+ },
+ "randomEmailLengthIncreaseOnPercentage": {
+ "label": "Percentage of used aliases",
+ "description": "If the percentage of used random email IDs is higher than this value, the length of the random email ID will be increased. This is used to prevent spammers from guessing the email ID."
+ },
+ "customEmailSuffixLength": {
+ "label": "Custom email suffix length",
+ "description": "The length of the custom email suffix."
+ },
+ "customEmailSuffixChars": {
+ "label": "Custom email suffix character pool",
+ "description": "Characters that are used to generate custom email suffixes."
+ },
+ "imageProxyStorageLifeTimeInHours": {
+ "label": "Image proxy storage lifetime",
+ "description": "The lifetime of images that are stored on the server in hours. After this time, the image will be deleted.",
+ "unit_one": "hour",
+ "unit_other": "hours"
+ },
+ "enableImageProxy": {
+ "label": "Enable image proxy",
+ "description": "If enabled, images will be proxied through the server. This enhances your user's privacy as their ip address will not be leaked."
+ },
+ "enableImageProxyStorage": {
+ "label": "Enable image proxy storage",
+ "description": "If enabled, images will be stored on the server and forwarded to the user. This makes email tracking nearly impossible as every message will be marked as read instantly, which is obviously not true as a user is typically not able to view an email in just a few seconds after it has been sent. This will only affect new images."
+ },
+ "userEmailEnableDisposableEmails": {
+ "label": "Enable disposable emails for new accounts",
+ "description": "If enabled, users will be able to use disposable emails when creating a new account. This will only affect new accounts."
+ },
+ "userEmailEnableOtherRelays": {
+ "label": "Enable other relays for new accounts",
+ "description": "If enabled, users will be able to use other relays (such as SimpleLogin or DuckDuckGo's Email Tracking Protection) when creating a new account. This will only affect new accounts."
+ },
+ "allowStatistics": {
+ "label": "Allow statistics",
+ "description": "If enabled, your instance will collect anonymous statistics and share them. They will only be stored locally on this instance but made public."
+ },
+ "allowAliasDeletion": {
+ "label": "Allow alias deletion",
+ "description": "If enabled, users will be able to delete their aliases."
+ },
+ "maxAliasesPerUser": {
+ "label": "Maximum aliases per user",
+ "description": "The maximum number of aliases a user can create. 0 means unlimited. Existing aliases will not be affected."
+ }
+ }
+ },
+ "settings": {
+ "title": "Global Settings",
+ "description": "Configure global settings for your instance.",
+ "successMessage": "Settings have been saved successfully!",
+ "randomAliasesPreview": {
+ "title": "Random aliases will look like this",
+ "helperText": "This is just a preview. Those are not real aliases."
+ },
+ "randomAliasesIncreaseExplanation": "Random aliases' length will be increased from {{originalLength}} to {{increasedLength}} characters after {{amount}} aliases have been created.",
+ "resetLabel": "Reset to defaults",
+ "disabled": {
+ "title": "Global settings are disabled",
+ "description": "Global settings have been disabled. You can enable them in the configuration file."
+ }
+ },
"reservedAlias": {
"actions": {
"delete": {
diff --git a/src/route-widgets/CreateReservedAliasRoute/AliasExplanation.tsx b/src/route-widgets/CreateReservedAliasRoute/AliasExplanation.tsx
index 6e538ab..1d5f199 100644
--- a/src/route-widgets/CreateReservedAliasRoute/AliasExplanation.tsx
+++ b/src/route-widgets/CreateReservedAliasRoute/AliasExplanation.tsx
@@ -14,7 +14,7 @@ export interface AliasExplanationProps {
}
export default function AliasExplanation({local, emails}: AliasExplanationProps): ReactElement {
- const {t} = useTranslation()
+ const {t} = useTranslation("admin-reserved-aliases")
const theme = useTheme()
const serverSettings = useLoaderData() as ServerSettings
@@ -37,7 +37,7 @@ export default function AliasExplanation({local, emails}: AliasExplanationProps)
- {t("routes.AdminRoute.forms.reservedAliases.explanation.step1")}
+ {t("createNew.explanation.step1")}
@@ -49,7 +49,7 @@ export default function AliasExplanation({local, emails}: AliasExplanationProps)
- {t("routes.AdminRoute.forms.reservedAliases.explanation.step2")}
+ {t("createNew.explanation.step2")}
@@ -76,7 +76,7 @@ export default function AliasExplanation({local, emails}: AliasExplanationProps)
- {t("routes.AdminRoute.forms.reservedAliases.explanation.step4")}
+ {t("createNew.explanation.step4")}
diff --git a/src/route-widgets/CreateReservedAliasRoute/UsersSelectField.tsx b/src/route-widgets/CreateReservedAliasRoute/UsersSelectField.tsx
index 9fb60f9..e7657b7 100644
--- a/src/route-widgets/CreateReservedAliasRoute/UsersSelectField.tsx
+++ b/src/route-widgets/CreateReservedAliasRoute/UsersSelectField.tsx
@@ -37,7 +37,7 @@ export default function UsersSelectField({
error,
...props
}: UsersSelectFieldProps): ReactElement {
- const {t} = useTranslation()
+ const {t} = useTranslation("admin-reserved-aliases")
const meUser = useUser()
const {data: {users} = {}} = useQuery(
["getAdminUsers"],
@@ -49,7 +49,7 @@ export default function UsersSelectField({
return (
- {t("routes.AdminRoute.forms.reservedAliases.fields.users.label")}
+ {t("createNew.fields.users.label")}
{...props}
@@ -98,7 +98,7 @@ export default function UsersSelectField({
name="users"
id="users"
error={error}
- label={t("routes.AdminRoute.forms.reservedAliases.fields.users.label")}
+ label={t("createNew.fields.users.label")}
>
{users ? (
users.map(user => (
@@ -108,12 +108,9 @@ export default function UsersSelectField({
primary={(() => {
// Check if user is me
if (user.id === meUser.id) {
- return t(
- "routes.AdminRoute.forms.reservedAliases.fields.users.me",
- {
- email: user.email.address,
- },
- )
+ return t("createNew.fields.users.me", {
+ email: user.email.address,
+ })
}
return user.email.address
diff --git a/src/route-widgets/ReservedAliasesRoute/EmptyStateScreen.tsx b/src/route-widgets/ReservedAliasesRoute/EmptyStateScreen.tsx
index ee300e9..b3299c8 100644
--- a/src/route-widgets/ReservedAliasesRoute/EmptyStateScreen.tsx
+++ b/src/route-widgets/ReservedAliasesRoute/EmptyStateScreen.tsx
@@ -1,11 +1,11 @@
import {ReactElement} from "react"
import {useTranslation} from "react-i18next"
-
-import {Container, Grid, Typography} from "@mui/material"
import {BsStarFill} from "react-icons/bs"
+import {Container, Grid, Typography} from "@mui/material"
+
export default function EmptyStateScreen(): ReactElement {
- const {t} = useTranslation()
+ const {t} = useTranslation("admin-reserved-aliases")
return (
@@ -20,16 +20,14 @@ export default function EmptyStateScreen(): ReactElement {
>
- {t("routes.ReservedAliasesRoute.emptyState.title")}
+ {t("emptyState.title")}
-
- {t("routes.ReservedAliasesRoute.emptyState.description")}
-
+ {t("emptyState.description")}
diff --git a/src/routes/AdminRoute.tsx b/src/routes/AdminRoute.tsx
index e1eab67..f87f3f2 100644
--- a/src/routes/AdminRoute.tsx
+++ b/src/routes/AdminRoute.tsx
@@ -11,7 +11,7 @@ import {useNavigateToNext, useUser} from "~/hooks"
import ServerStatus from "~/route-widgets/AdminRoute/ServerStatus"
export default function AdminRoute(): ReactElement {
- const {t} = useTranslation("title")
+ const {t} = useTranslation("admin")
const navigateToNext = useNavigateToNext()
const user = useUser()
diff --git a/src/routes/CreateReservedAliasRoute.tsx b/src/routes/CreateReservedAliasRoute.tsx
index 7e9f933..9d28a2a 100644
--- a/src/routes/CreateReservedAliasRoute.tsx
+++ b/src/routes/CreateReservedAliasRoute.tsx
@@ -26,7 +26,7 @@ interface Form {
}
export default function CreateReservedAliasRoute(): ReactElement {
- const {t} = useTranslation()
+ const {t} = useTranslation(["admin-reserved-aliases", "common"])
const {showSuccess} = useErrorSuccessSnacks()
const navigateToNext = useNavigateToNext("/admin/reserved-aliases")
const {mutateAsync: createAlias} = useMutation<
@@ -35,7 +35,7 @@ export default function CreateReservedAliasRoute(): ReactElement {
CreateReservedAliasData
>(createReservedAlias, {
onSuccess: () => {
- showSuccess(t("relations.alias.mutations.success.aliasCreation"))
+ showSuccess(t("messages.alias.created", {ns: "common"}))
navigateToNext()
},
})
@@ -44,10 +44,8 @@ export default function CreateReservedAliasRoute(): ReactElement {
local: yup
.string()
.required()
- .label(t("routes.AdminRoute.forms.reservedAliases.fields.local.label")),
- isActive: yup
- .boolean()
- .label(t("routes.AdminRoute.forms.reservedAliases.fields.isActive.label")),
+ .label(t("fields.local.label", {ns: "common"})),
+ isActive: yup.boolean().label(t("fields.active.label")),
// Only store IDs of users, as they provide a reference to the user
users: yup
.array()
@@ -60,7 +58,7 @@ export default function CreateReservedAliasRoute(): ReactElement {
}),
}),
)
- .label(t("routes.AdminRoute.forms.reservedAliases.fields.users.label")),
+ .label(t("fields.users.label")),
})
const formik = useFormik