From 3194ed2145fb4dbdc4f1dc94841a9e4ce7516cbe Mon Sep 17 00:00:00 2001
From: Thomas Kaul <4159106+dtslvr@users.noreply.github.com>
Date: Sat, 30 Nov 2024 17:30:49 +0100
Subject: [PATCH] Feature/improve usability of Ghostfolio data provider (#4086)

* Improve usability
---
 .../ghostfolio/ghostfolio.controller.ts       |  5 +---
 .../ghostfolio/ghostfolio.service.ts          |  9 ++++++
 .../admin-settings.component.html             | 30 +++++++++++++++----
 .../admin-settings.component.ts               |  6 ++++
 .../admin-settings/admin-settings.module.ts   |  2 ++
 ...er-ghostfolio-status-response.interface.ts |  3 ++
 6 files changed, 46 insertions(+), 9 deletions(-)

diff --git a/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.controller.ts b/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.controller.ts
index 3ccef28c8..788cfd1bc 100644
--- a/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.controller.ts
+++ b/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.controller.ts
@@ -191,9 +191,6 @@ export class GhostfolioController {
   @HasPermission(permissions.enableDataProviderGhostfolio)
   @UseGuards(AuthGuard('jwt'), HasPermissionGuard)
   public async getStatus(): Promise<DataProviderGhostfolioStatusResponse> {
-    return {
-      dailyRequests: this.request.user.dataProviderGhostfolioDailyRequests,
-      dailyRequestsMax: await this.ghostfolioService.getMaxDailyRequests()
-    };
+    return this.ghostfolioService.getStatus({ user: this.request.user });
   }
 }
diff --git a/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.service.ts b/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.service.ts
index 875a13c98..7858e24f0 100644
--- a/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.service.ts
+++ b/apps/api/src/app/endpoints/data-providers/ghostfolio/ghostfolio.service.ts
@@ -22,6 +22,7 @@ import {
   LookupResponse,
   QuotesResponse
 } from '@ghostfolio/common/interfaces';
+import { UserWithSettings } from '@ghostfolio/common/types';
 
 import { Injectable, Logger } from '@nestjs/common';
 import { DataSource } from '@prisma/client';
@@ -208,6 +209,14 @@ export class GhostfolioService {
     }
   }
 
+  public async getStatus({ user }: { user: UserWithSettings }) {
+    return {
+      dailyRequests: user.dataProviderGhostfolioDailyRequests,
+      dailyRequestsMax: await this.getMaxDailyRequests(),
+      subscription: user.subscription
+    };
+  }
+
   public async incrementDailyRequests({ userId }: { userId: string }) {
     await this.prismaService.analytics.update({
       data: {
diff --git a/apps/client/src/app/components/admin-settings/admin-settings.component.html b/apps/client/src/app/components/admin-settings/admin-settings.component.html
index 35ed556b6..f9a6084cc 100644
--- a/apps/client/src/app/components/admin-settings/admin-settings.component.html
+++ b/apps/client/src/app/components/admin-settings/admin-settings.component.html
@@ -20,23 +20,43 @@
                   [enableLink]="false"
                 />
               </a>
+              @if (isGhostfolioApiKeyValid === true) {
+                <div class="line-height-1">
+                  <small class="text-muted">
+                    <ng-container i18n>Valid until</ng-container>
+                    {{
+                      ghostfolioApiStatus?.subscription?.expiresAt
+                        | date: defaultDateFormat
+                    }}</small
+                  >
+                </div>
+              }
             </div>
             <div class="w-50">
               @if (isGhostfolioApiKeyValid === true) {
                 <div class="align-items-center d-flex flex-wrap">
-                  <div class="mr-3">
+                  <div class="flex-grow-1 mr-3">
                     {{ ghostfolioApiStatus.dailyRequests }}
                     <ng-container i18n>of</ng-container>
                     {{ ghostfolioApiStatus.dailyRequestsMax }}
                     <ng-container i18n>daily requests</ng-container>
                   </div>
                   <button
-                    color="warn"
-                    mat-flat-button
-                    (click)="onRemoveGhostfolioApiKey()"
+                    class="mx-1 no-min-width px-2"
+                    mat-button
+                    [matMenuTriggerFor]="ghostfolioApiMenu"
+                    (click)="$event.stopPropagation()"
                   >
-                    <span i18n>Remove API key</span>
+                    <ion-icon name="ellipsis-horizontal" />
                   </button>
+                  <mat-menu #ghostfolioApiMenu="matMenu" xPosition="before">
+                    <button mat-menu-item (click)="onRemoveGhostfolioApiKey()">
+                      <span class="align-items-center d-flex">
+                        <ion-icon class="mr-2" name="trash-outline" />
+                        <span i18n>Remove API key</span>
+                      </span>
+                    </button>
+                  </mat-menu>
                 </div>
               } @else if (isGhostfolioApiKeyValid === false) {
                 <button
diff --git a/apps/client/src/app/components/admin-settings/admin-settings.component.ts b/apps/client/src/app/components/admin-settings/admin-settings.component.ts
index 68256bf98..1ff67e01a 100644
--- a/apps/client/src/app/components/admin-settings/admin-settings.component.ts
+++ b/apps/client/src/app/components/admin-settings/admin-settings.component.ts
@@ -7,6 +7,7 @@ import {
   DEFAULT_LANGUAGE_CODE,
   PROPERTY_API_KEY_GHOSTFOLIO
 } from '@ghostfolio/common/config';
+import { getDateFormatString } from '@ghostfolio/common/helper';
 import {
   DataProviderGhostfolioStatusResponse,
   User
@@ -32,6 +33,7 @@ import { GfGhostfolioPremiumApiDialogComponent } from './ghostfolio-premium-api-
   templateUrl: './admin-settings.component.html'
 })
 export class AdminSettingsComponent implements OnDestroy, OnInit {
+  public defaultDateFormat: string;
   public ghostfolioApiStatus: DataProviderGhostfolioStatusResponse;
   public isGhostfolioApiKeyValid: boolean;
   public pricingUrl: string;
@@ -59,6 +61,10 @@ export class AdminSettingsComponent implements OnDestroy, OnInit {
         if (state?.user) {
           this.user = state.user;
 
+          this.defaultDateFormat = getDateFormatString(
+            this.user?.settings?.locale
+          );
+
           const languageCode =
             this.user?.settings?.language ?? DEFAULT_LANGUAGE_CODE;
 
diff --git a/apps/client/src/app/components/admin-settings/admin-settings.module.ts b/apps/client/src/app/components/admin-settings/admin-settings.module.ts
index 3a3e04a2d..5a5c39cde 100644
--- a/apps/client/src/app/components/admin-settings/admin-settings.module.ts
+++ b/apps/client/src/app/components/admin-settings/admin-settings.module.ts
@@ -6,6 +6,7 @@ import { CommonModule } from '@angular/common';
 import { CUSTOM_ELEMENTS_SCHEMA, NgModule } from '@angular/core';
 import { MatButtonModule } from '@angular/material/button';
 import { MatCardModule } from '@angular/material/card';
+import { MatMenuModule } from '@angular/material/menu';
 import { RouterModule } from '@angular/router';
 
 import { AdminSettingsComponent } from './admin-settings.component';
@@ -19,6 +20,7 @@ import { AdminSettingsComponent } from './admin-settings.component';
     GfPremiumIndicatorComponent,
     MatButtonModule,
     MatCardModule,
+    MatMenuModule,
     RouterModule
   ],
   schemas: [CUSTOM_ELEMENTS_SCHEMA]
diff --git a/libs/common/src/lib/interfaces/responses/data-provider-ghostfolio-status-response.interface.ts b/libs/common/src/lib/interfaces/responses/data-provider-ghostfolio-status-response.interface.ts
index 11e9779d2..9330adaa7 100644
--- a/libs/common/src/lib/interfaces/responses/data-provider-ghostfolio-status-response.interface.ts
+++ b/libs/common/src/lib/interfaces/responses/data-provider-ghostfolio-status-response.interface.ts
@@ -1,4 +1,7 @@
+import { UserWithSettings } from '@ghostfolio/common/types';
+
 export interface DataProviderGhostfolioStatusResponse {
   dailyRequests: number;
   dailyRequestsMax: number;
+  subscription: UserWithSettings['subscription'];
 }