From f6144f9634482d6bd0ed88a31495c6c6c88add96 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=C3=81lvaro=20Cuesta?=
 <1827495+alvaro-cuesta@users.noreply.github.com>
Date: Thu, 2 Jan 2025 20:38:40 +0100
Subject: feat: sync with local plugin status in store (#733)
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* fix: useDeckyState proper type and safety

* refactor: plugin list

Avoids unneeded re-renders. See https://react.dev/learn/you-might-not-need-an-effect#caching-expensive-calculations

* feat: sync with local plugin status in store

Adds some QoL changes to the plugin store browser:

- Add ✓ icon to currently installed plugin version in version selector
- Change install button label depending on the install type that the
  button would trigger
- Adds icon to install button for clarity

The goal is to make it clear to the user what the current state of the
installed plugin is, and what would be the impact of installing the
selected version.

Resolves #360

* lint: prettier

* fix: add missing translations

* refactor: safer translation strings on install

Prefer using `t(...)` instead of `TranslationHelper` since it ensures
that the translation keys are not missing in the locale files when
running the `extractext` task.

By adding comments with `t(...)` calls, `i18next-parser` will generate
the strings as if they were present as literals in the code (see
https://github.com/i18next/i18next-parser#caveats).

This does _not_ suppress the warnings (since `i18next-parser` does not
have access to TS types, so it cannot infer template literals) but it at
least makes it less likely that a translation will be missed by mistake,
have typos, etc.
---
 .../modals/MultiplePluginsInstallModal.tsx         | 37 ++++++++++++++++------
 1 file changed, 27 insertions(+), 10 deletions(-)

(limited to 'frontend/src/components/modals/MultiplePluginsInstallModal.tsx')

diff --git a/frontend/src/components/modals/MultiplePluginsInstallModal.tsx b/frontend/src/components/modals/MultiplePluginsInstallModal.tsx
index ba49ba92..9c86f3db 100644
--- a/frontend/src/components/modals/MultiplePluginsInstallModal.tsx
+++ b/frontend/src/components/modals/MultiplePluginsInstallModal.tsx
@@ -3,7 +3,7 @@ import { FC, useEffect, useMemo, useState } from 'react';
 import { useTranslation } from 'react-i18next';
 import { FaCheck, FaDownload } from 'react-icons/fa';
 
-import { InstallType } from '../../plugin';
+import { InstallType, InstallTypeTranslationMapping } from '../../plugin';
 
 interface MultiplePluginsInstallModalProps {
   requests: { name: string; version: string; hash: string; install_type: InstallType }[];
@@ -12,13 +12,7 @@ interface MultiplePluginsInstallModalProps {
   closeModal?(): void;
 }
 
-// values are the JSON keys used in the translation file
-const InstallTypeTranslationMapping = {
-  [InstallType.INSTALL]: 'install',
-  [InstallType.REINSTALL]: 'reinstall',
-  [InstallType.UPDATE]: 'update',
-} as const satisfies Record<InstallType, string>;
-
+// IMPORTANT! Keep in sync with `t(...)` comments below
 type TitleTranslationMapping = 'mixed' | (typeof InstallTypeTranslationMapping)[InstallType];
 
 const MultiplePluginsInstallModal: FC<MultiplePluginsInstallModalProps> = ({
@@ -70,6 +64,8 @@ const MultiplePluginsInstallModal: FC<MultiplePluginsInstallModalProps> = ({
     if (requests.every(({ install_type }) => install_type === InstallType.INSTALL)) return 'install';
     if (requests.every(({ install_type }) => install_type === InstallType.REINSTALL)) return 'reinstall';
     if (requests.every(({ install_type }) => install_type === InstallType.UPDATE)) return 'update';
+    if (requests.every(({ install_type }) => install_type === InstallType.DOWNGRADE)) return 'downgrade';
+    if (requests.every(({ install_type }) => install_type === InstallType.OVERWRITE)) return 'overwrite';
     return 'mixed';
   }, [requests]);
 
@@ -86,14 +82,35 @@ const MultiplePluginsInstallModal: FC<MultiplePluginsInstallModalProps> = ({
       onCancel={async () => {
         await onCancel();
       }}
-      strTitle={<div>{t(`MultiplePluginsInstallModal.title.${installTypeGrouped}`, { count: requests.length })}</div>}
-      strOKButtonText={t(`MultiplePluginsInstallModal.ok_button.${loading ? 'loading' : 'idle'}`)}
+      strTitle={
+        <div>
+          {
+            // IMPORTANT! These comments are not cosmetic and are needed for `extracttext` task to work
+            // t('MultiplePluginsInstallModal.title.install', { count: n })
+            // t('MultiplePluginsInstallModal.title.reinstall', { count: n })
+            // t('MultiplePluginsInstallModal.title.update', { count: n })
+            // t('MultiplePluginsInstallModal.title.downgrade', { count: n })
+            // t('MultiplePluginsInstallModal.title.overwrite', { count: n })
+            // t('MultiplePluginsInstallModal.title.mixed', { count: n })
+            t(`MultiplePluginsInstallModal.title.${installTypeGrouped}`, { count: requests.length })
+          }
+        </div>
+      }
+      strOKButtonText={
+        loading ? t('MultiplePluginsInstallModal.ok_button.loading') : t('MultiplePluginsInstallModal.ok_button.idle')
+      }
     >
       <div>
         {t('MultiplePluginsInstallModal.confirm')}
         <ul style={{ listStyle: 'none', display: 'flex', flexDirection: 'column', gap: '4px' }}>
           {requests.map(({ name, version, install_type, hash }, i) => {
             const installTypeStr = InstallTypeTranslationMapping[install_type];
+            // IMPORTANT! These comments are not cosmetic and are needed for `extracttext` task to work
+            // t('MultiplePluginsInstallModal.description.install')
+            // t('MultiplePluginsInstallModal.description.reinstall')
+            // t('MultiplePluginsInstallModal.description.update')
+            // t('MultiplePluginsInstallModal.description.downgrade')
+            // t('MultiplePluginsInstallModal.description.overwrite')
             const description = t(`MultiplePluginsInstallModal.description.${installTypeStr}`, {
               name,
               version,
-- 
cgit v1.2.3

