Merge pull request #17 from EyeSeeTea/feat/header-footer-settings-cha…

…nges feat: Custom header and footer. Move settings to its own page
EyeSeeTea · Jan 9, 2025 · 09fdb42 · 09fdb42
2 parents 8082b48 + 4d5f71d
commit 09fdb42
Show file tree

Hide file tree

Showing 24 changed files with 425 additions and 191 deletions.
diff --git a/README.md b/README.md
@@ -181,3 +181,28 @@ Now you can start the server and check if every visualization is working properl
 ### Storage
 
 Settings can be saved in the data store (default) or as constants. Use the env variable **REACT_APP_STORAGE** to select which one to use (`datastore` or `constants`).
+
+### Custom Header and Footer
+
+The header and footer can be configured in `src/app-config.ts`. They can be disabled by setting their values to `false`.
+See `HeaderOptions` and `FooterOptions` types for supported options.
+
+Example config:
+
+```typescript
+{
+ header: {
+     title: "Dashboard Reports - Custom Header Title",
+     background: "rgba(19,52,59,1)",
+     color: "white",
+ },
+ footer: {
+     text: `Dashboard Reports - Custom Footer.
+     Multi-line text is allowed.
+     TBD: More customization options.
+     `,
+     background: "linear-gradient(90deg, rgba(31,41,30,1) 0%, rgba(20,50,28,1) 50%, rgba(31,41,30,1) 100%)",
+     color: "white",
+ }
+}
+```
diff --git a/i18n/ar.po b/i18n/ar.po
@@ -1,13 +1,16 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: i18next-conv\n"
-"POT-Creation-Date: 2024-12-30T12:25:50.318Z\n"
+"POT-Creation-Date: 2025-01-08T17:04:38.103Z\n"
 "PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
 
+msgid "Not authorized - only admins can save settings"
+msgstr ""
+
 msgid "Select Dashboard"
 msgstr ""
 
@@ -26,19 +29,16 @@ msgstr ""
 msgid "Export to Word"
 msgstr ""
 
-msgid "App Settings"
-msgstr ""
-
 msgid "Font Size"
 msgstr ""
 
 msgid "Show/Hide Feedback"
 msgstr ""
 
-msgid "Save"
+msgid "Cancel"
 msgstr ""
 
-msgid "Close"
+msgid "Save"
 msgstr ""
 
 msgid "Loading..."
@@ -50,9 +50,6 @@ msgstr ""
 msgid "Select Organization Units"
 msgstr ""
 
-msgid "Cancel"
-msgstr ""
-
 msgid "Select"
 msgstr ""
 
@@ -71,6 +68,9 @@ msgstr ""
 msgid "Templates not found"
 msgstr ""
 
+msgid "Settings saved"
+msgstr ""
+
 msgid "Distributed under GNU GLPv3"
 msgstr ""
 
@@ -99,3 +99,6 @@ msgstr ""
 
 msgid "EyeSeeTea"
 msgstr ""
+
+msgid "App Settings"
+msgstr ""
diff --git a/i18n/en.pot b/i18n/en.pot
@@ -5,8 +5,11 @@ msgstr ""
 "Content-Type: text/plain; charset=utf-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
-"POT-Creation-Date: 2024-12-30T12:25:50.318Z\n"
-"PO-Revision-Date: 2024-12-30T12:25:50.318Z\n"
+"POT-Creation-Date: 2025-01-08T17:04:38.103Z\n"
+"PO-Revision-Date: 2025-01-08T17:04:38.103Z\n"
+
+msgid "Not authorized - only admins can save settings"
+msgstr ""
 
 msgid "Select Dashboard"
 msgstr ""
@@ -26,19 +29,16 @@ msgstr ""
 msgid "Export to Word"
 msgstr ""
 
-msgid "App Settings"
-msgstr ""
-
 msgid "Font Size"
 msgstr ""
 
 msgid "Show/Hide Feedback"
 msgstr ""
 
-msgid "Save"
+msgid "Cancel"
 msgstr ""
 
-msgid "Close"
+msgid "Save"
 msgstr ""
 
 msgid "Loading..."
@@ -50,9 +50,6 @@ msgstr ""
 msgid "Select Organization Units"
 msgstr ""
 
-msgid "Cancel"
-msgstr ""
-
 msgid "Select"
 msgstr ""
 
@@ -71,6 +68,9 @@ msgstr ""
 msgid "Templates not found"
 msgstr ""
 
+msgid "Settings saved"
+msgstr ""
+
 msgid "Distributed under GNU GLPv3"
 msgstr ""
 
@@ -99,3 +99,6 @@ msgstr ""
 
 msgid "EyeSeeTea"
 msgstr ""
+
+msgid "App Settings"
+msgstr ""
diff --git a/i18n/es.po b/i18n/es.po
@@ -1,13 +1,16 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: i18next-conv\n"
-"POT-Creation-Date: 2024-12-30T12:25:50.318Z\n"
+"POT-Creation-Date: 2025-01-08T17:04:38.103Z\n"
 "PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
 
+msgid "Not authorized - only admins can save settings"
+msgstr ""
+
 msgid "Select Dashboard"
 msgstr "Seleccionar panel"
 
@@ -26,19 +29,16 @@ msgstr ""
 msgid "Export to Word"
 msgstr ""
 
-msgid "App Settings"
-msgstr ""
-
 msgid "Font Size"
 msgstr ""
 
 msgid "Show/Hide Feedback"
 msgstr ""
 
-msgid "Save"
+msgid "Cancel"
 msgstr ""
 
-msgid "Close"
+msgid "Save"
 msgstr ""
 
 msgid "Loading..."
@@ -50,9 +50,6 @@ msgstr ""
 msgid "Select Organization Units"
 msgstr ""
 
-msgid "Cancel"
-msgstr ""
-
 msgid "Select"
 msgstr ""
 
@@ -71,6 +68,9 @@ msgstr ""
 msgid "Templates not found"
 msgstr ""
 
+msgid "Settings saved"
+msgstr ""
+
 msgid "Distributed under GNU GLPv3"
 msgstr ""
 
@@ -100,6 +100,9 @@ msgstr ""
 msgid "EyeSeeTea"
 msgstr ""
 
+msgid "App Settings"
+msgstr ""
+
 #~ msgid "Add"
 #~ msgstr "Añadir"
 

diff --git a/i18n/fr.po b/i18n/fr.po
@@ -1,13 +1,16 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: i18next-conv\n"
-"POT-Creation-Date: 2024-12-30T12:25:50.318Z\n"
+"POT-Creation-Date: 2025-01-08T17:04:38.103Z\n"
 "PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
 
+msgid "Not authorized - only admins can save settings"
+msgstr ""
+
 msgid "Select Dashboard"
 msgstr ""
 
@@ -26,19 +29,16 @@ msgstr ""
 msgid "Export to Word"
 msgstr ""
 
-msgid "App Settings"
-msgstr ""
-
 msgid "Font Size"
 msgstr ""
 
 msgid "Show/Hide Feedback"
 msgstr ""
 
-msgid "Save"
+msgid "Cancel"
 msgstr ""
 
-msgid "Close"
+msgid "Save"
 msgstr ""
 
 msgid "Loading..."
@@ -50,9 +50,6 @@ msgstr ""
 msgid "Select Organization Units"
 msgstr ""
 
-msgid "Cancel"
-msgstr ""
-
 msgid "Select"
 msgstr ""
 
@@ -71,6 +68,9 @@ msgstr ""
 msgid "Templates not found"
 msgstr ""
 
+msgid "Settings saved"
+msgstr ""
+
 msgid "Distributed under GNU GLPv3"
 msgstr ""
 
@@ -99,3 +99,6 @@ msgstr ""
 
 msgid "EyeSeeTea"
 msgstr ""
+
+msgid "App Settings"
+msgstr ""
diff --git a/i18n/pt.po b/i18n/pt.po
@@ -1,13 +1,16 @@
 msgid ""
 msgstr ""
 "Project-Id-Version: i18next-conv\n"
-"POT-Creation-Date: 2024-12-30T12:25:50.318Z\n"
+"POT-Creation-Date: 2025-01-08T17:04:38.103Z\n"
 "PO-Revision-Date: 2018-10-25T09:02:35.143Z\n"
 "MIME-Version: 1.0\n"
 "Content-Type: text/plain; charset=UTF-8\n"
 "Content-Transfer-Encoding: 8bit\n"
 "Plural-Forms: nplurals=2; plural=(n != 1)\n"
 
+msgid "Not authorized - only admins can save settings"
+msgstr ""
+
 msgid "Select Dashboard"
 msgstr ""
 
@@ -26,19 +29,16 @@ msgstr ""
 msgid "Export to Word"
 msgstr ""
 
-msgid "App Settings"
-msgstr ""
-
 msgid "Font Size"
 msgstr ""
 
 msgid "Show/Hide Feedback"
 msgstr ""
 
-msgid "Save"
+msgid "Cancel"
 msgstr ""
 
-msgid "Close"
+msgid "Save"
 msgstr ""
 
 msgid "Loading..."
@@ -50,9 +50,6 @@ msgstr ""
 msgid "Select Organization Units"
 msgstr ""
 
-msgid "Cancel"
-msgstr ""
-
 msgid "Select"
 msgstr ""
 
@@ -71,6 +68,9 @@ msgstr ""
 msgid "Templates not found"
 msgstr ""
 
+msgid "Settings saved"
+msgstr ""
+
 msgid "Distributed under GNU GLPv3"
 msgstr ""
 
@@ -99,3 +99,6 @@ msgstr ""
 
 msgid "EyeSeeTea"
 msgstr ""
+
+msgid "App Settings"
+msgstr ""
diff --git a/src/CompositionRoot.ts b/src/CompositionRoot.ts
@@ -18,6 +18,8 @@ import { GetPluginVisualizationUseCase } from "./domain/usecases/GetPluginVisual
 import { GetRootOrgUnitsUseCase } from "./domain/usecases/GetRootOrgUnitsUseCase";
 import { OrgUnitD2Repository } from "./data/repositories/OrgUnitD2Repository";
 import { GetOrgUnitsByIdsUseCase } from "./domain/usecases/GetOrgUnitsByIdsUseCase";
+import { InitDefaultSettingsUseCase } from "./domain/usecases/InitDefaultSettingsUseCase";
+import { DefaultSettingsHTTPRepository } from "./data/repositories/DefaultSettingsHTTPRepository";
 
 export function getCompositionRoot(api: D2Api, instance: Instance, storageName: StorageName) {
     const instanceRepository = new InstanceDefaultRepository(instance);
@@ -28,6 +30,7 @@ export function getCompositionRoot(api: D2Api, instance: Instance, storageName:
     const exportDocxRepository = new DashboardExportDocxRepository();
     const pluginVisualizationsRepository = new PluginVisualizationD2Repository(api);
     const orgUnitsRepository = new OrgUnitD2Repository(api);
+    const defaultSettingsRepository = new DefaultSettingsHTTPRepository();
 
     return {
         instance: {
@@ -45,6 +48,7 @@ export function getCompositionRoot(api: D2Api, instance: Instance, storageName:
         settings: {
             get: new GetSettingsUseCase(settingsRepository),
             save: new SaveSettingsUseCase(settingsRepository),
+            initDefaults: new InitDefaultSettingsUseCase(settingsRepository, defaultSettingsRepository),
         },
         export: {
             save: new SaveRawReportUseCase(exportDocxRepository),