Enhancement: add net worth field for ghostfolio (#5958)

Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>

docs/configs/settings.md

@@ -571,3 +571,18 @@ or per service widget (`services.yaml`) with:
 ```
 
 If either value is set to true, the error message will be hidden.
+
+## Disable Search Engine Indexing
+
+You can request that search engines not to index your Homepage instance by enabling the `disableIndexing` setting.
+
+```yaml
+disableIndexing: true
+```
+
+When enabled, this will:
+
+- Disallow all crawlers in `robots.txt`
+- Add `<meta name="robots" content="noindex, nofollow">` tags to prevent indexing
+
+By default this feature is disabled.

docs/widgets/services/ghostfolio.md

@@ -15,7 +15,7 @@ See the [official docs](https://github.com/ghostfolio/ghostfolio#authorization-b
 
 _Note that the Bearer token is valid for 6 months, after which a new one must be generated._
 
-Allowed fields: `["gross_percent_today", "gross_percent_1y", "gross_percent_max"]`
+Allowed fields: `["gross_percent_today", "gross_percent_1y", "gross_percent_max", "net_worth"]`
 
 ```yaml
 widget:

public/locales/en/common.json

@@ -759,7 +759,8 @@
     "ghostfolio": {
         "gross_percent_today": "Today",
         "gross_percent_1y": "One year",
-        "gross_percent_max": "All time"
+        "gross_percent_max": "All time",
+        "net_worth": "Net Worth"
     },
     "audiobookshelf": {
         "podcasts": "Podcasts",

src/pages/index.jsx

@@ -400,6 +400,7 @@ function Home({ initialSettings }) {
             "A highly customizable homepage (or startpage / application dashboard) with Docker and service API integrations."
           }
         />
+        {settings.disableIndexing && <meta name="robots" content="noindex, nofollow" />}
         {settings.base && <base href={settings.base} />}
         {settings.favicon ? (
           <>

src/pages/robots.txt.js

@@ -0,0 +1,19 @@
+import { getSettings } from "utils/config/config";
+
+export async function getServerSideProps({ res }) {
+  const settings = getSettings();
+  const content = ["User-agent: *", !!settings.disableIndexing ? "Disallow: /" : "Allow: /"].join("\n");
+
+  res.setHeader("Content-Type", "text/plain");
+  res.write(content);
+  res.end();
+
+  return {
+    props: {},
+  };
+}
+
+export default function RobotsTxt() {
+  // placeholder component
+  return null;
+}

src/widgets/ghostfolio/component.jsx

@@ -20,13 +20,15 @@ function getPerformancePercent(t, performanceRange) {
 export default function Component({ service }) {
   const { t } = useTranslation();
   const { widget } = service;
+  const includeNetWorth = widget.fields?.includes("net_worth");
 
   const { data: performanceToday, error: ghostfolioErrorToday } = useWidgetAPI(widget, "today");
   const { data: performanceYear, error: ghostfolioErrorYear } = useWidgetAPI(widget, "year");
   const { data: performanceMax, error: ghostfolioErrorMax } = useWidgetAPI(widget, "max");
+  const { data: userInfo, error: ghostfolioErrorUserInfo } = useWidgetAPI(widget, includeNetWorth ? "userInfo" : "");
 
-  if (ghostfolioErrorToday || ghostfolioErrorYear || ghostfolioErrorMax) {
+  if (ghostfolioErrorToday || ghostfolioErrorYear || ghostfolioErrorMax || ghostfolioErrorUserInfo) {
-    const finalError = ghostfolioErrorToday ?? ghostfolioErrorYear ?? ghostfolioErrorMax;
+    const finalError = ghostfolioErrorToday ?? ghostfolioErrorYear ?? ghostfolioErrorMax ?? ghostfolioErrorUserInfo;
     return <Container service={service} error={finalError} />;
   }
 
@@ -34,12 +36,13 @@ export default function Component({ service }) {
     return <Container service={service} error={performanceToday} />;
   }
 
-  if (!performanceToday || !performanceYear || !performanceMax) {
+  if (!performanceToday || !performanceYear || !performanceMax || (includeNetWorth && !userInfo)) {
     return (
       <Container service={service}>
         <Block label="ghostfolio.gross_percent_today" />
         <Block label="ghostfolio.gross_percent_1y" />
         <Block label="ghostfolio.gross_percent_max" />
+        {includeNetWorth && <Block label="ghostfolio.net_worth" />}
       </Container>
     );
   }
@@ -49,6 +52,12 @@ export default function Component({ service }) {
       <Block label="ghostfolio.gross_percent_today" value={getPerformancePercent(t, performanceToday)} />
       <Block label="ghostfolio.gross_percent_1y" value={getPerformancePercent(t, performanceYear)} />
       <Block label="ghostfolio.gross_percent_max" value={getPerformancePercent(t, performanceMax)} />
+      {includeNetWorth && (
+        <Block
+          label="ghostfolio.net_worth"
+          value={`${performanceToday.performance.currentNetWorth.toFixed(2)} ${userInfo?.settings?.currency ?? ""}`}
+        />
+      )}
     </Container>
   );
 }

src/widgets/ghostfolio/widget.js

@@ -1,18 +1,21 @@
 import credentialedProxyHandler from "utils/proxy/handlers/credentialed";
 
 const widget = {
-  api: "{url}/api/v2/portfolio/performance?range={endpoint}",
+  api: "{url}/api/{endpoint}",
   proxyHandler: credentialedProxyHandler,
 
   mappings: {
     today: {
-      endpoint: "1d",
+      endpoint: "v2/portfolio/performance?range=1d",
     },
     year: {
-      endpoint: "1y",
+      endpoint: "v2/portfolio/performance?range=1y",
     },
     max: {
-      endpoint: "max",
+      endpoint: "v2/portfolio/performance?range=max",
+    },
+    userInfo: {
+      endpoint: "v1/user",
     },
   },
 };