Task/refactor subscription types (#6735)

Refactor subscription types

apps/api/src/app/access/access.controller.ts

@@ -2,6 +2,7 @@ import { HasPermission } from '@ghostfolio/api/decorators/has-permission.decorat
 import { HasPermissionGuard } from '@ghostfolio/api/guards/has-permission.guard';
 import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';
 import { CreateAccessDto, UpdateAccessDto } from '@ghostfolio/common/dtos';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import { Access } from '@ghostfolio/common/interfaces';
 import { permissions } from '@ghostfolio/common/permissions';
 import type { RequestWithUser } from '@ghostfolio/common/types';
@@ -75,7 +76,7 @@ export class AccessController {
   ): Promise<AccessModel> {
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      this.request.user.subscription.type === 'Basic'
+      this.request.user.subscription.type === SubscriptionType.Basic
     ) {
       throw new HttpException(
         getReasonPhrase(StatusCodes.FORBIDDEN),
@@ -130,7 +131,7 @@ export class AccessController {
   ): Promise<AccessModel> {
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      this.request.user.subscription.type === 'Basic'
+      this.request.user.subscription.type === SubscriptionType.Basic
     ) {
       throw new HttpException(
         getReasonPhrase(StatusCodes.FORBIDDEN),

apps/api/src/app/endpoints/public/public.controller.ts

@@ -7,6 +7,7 @@ import { TransformDataSourceInResponseInterceptor } from '@ghostfolio/api/interc
 import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';
 import { ExchangeRateDataService } from '@ghostfolio/api/services/exchange-rate-data/exchange-rate-data.service';
 import { DEFAULT_CURRENCY } from '@ghostfolio/common/config';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import { getSum } from '@ghostfolio/common/helper';
 import { PublicPortfolioResponse } from '@ghostfolio/common/interfaces';
 import type { RequestWithUser } from '@ghostfolio/common/types';
@@ -58,7 +59,7 @@ export class PublicController {
     });
 
     if (this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION')) {
-      hasDetails = user.subscription.type === 'Premium';
+      hasDetails = user.subscription.type === SubscriptionType.Premium;
     }
 
     const [

apps/api/src/app/portfolio/portfolio.controller.ts

@@ -17,6 +17,7 @@ import {
   HEADER_KEY_IMPERSONATION,
   UNKNOWN_KEY
 } from '@ghostfolio/common/config';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   PortfolioDetails,
   PortfolioDividendsResponse,
@@ -92,7 +93,8 @@ export class PortfolioController {
     let hasError = false;
 
     if (this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION')) {
-      hasDetails = this.request.user.subscription.type === 'Premium';
+      hasDetails =
+        this.request.user.subscription.type === SubscriptionType.Premium;
     }
 
     const filters = this.apiService.buildFiltersFromQueryParams({
@@ -356,7 +358,7 @@ export class PortfolioController {
 
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      this.request.user.subscription.type === 'Basic'
+      this.request.user.subscription.type === SubscriptionType.Basic
     ) {
       dividends = dividends.map((item) => {
         return nullifyValuesInObject(item, ['investment']);
@@ -484,7 +486,7 @@ export class PortfolioController {
 
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      this.request.user.subscription.type === 'Basic'
+      this.request.user.subscription.type === SubscriptionType.Basic
     ) {
       investments = investments.map((item) => {
         return nullifyValuesInObject(item, ['investment']);
@@ -596,7 +598,7 @@ export class PortfolioController {
 
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      this.request.user.subscription.type === 'Basic'
+      this.request.user.subscription.type === SubscriptionType.Basic
     ) {
       performanceInformation.chart = performanceInformation.chart.map(
         (item) => {
@@ -624,7 +626,7 @@ export class PortfolioController {
 
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      this.request.user.subscription.type === 'Basic'
+      this.request.user.subscription.type === SubscriptionType.Basic
     ) {
       for (const category of report.xRay.categories) {
         category.rules = null;

apps/api/src/app/user/user.service.ts

@@ -32,6 +32,7 @@ import {
   TAG_ID_EXCLUDE_FROM_ANALYSIS,
   locale as defaultLocale
 } from '@ghostfolio/common/config';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   User as IUser,
   SystemMessage,
@@ -156,7 +157,7 @@ export class UserService {
 
     if (
       this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-      subscription.type === 'Basic'
+      subscription.type === SubscriptionType.Basic
     ) {
       tags = [];
     }
@@ -443,7 +444,7 @@ export class UserService {
         createdAt: user.createdAt
       });
 
-      if (user.subscription?.type === 'Basic') {
+      if (user.subscription?.type === SubscriptionType.Basic) {
         const daysSinceRegistration = differenceInDays(
           new Date(),
           user.createdAt
@@ -485,7 +486,7 @@ export class UserService {
 
         // Reset holdings view mode
         user.settings.settings.holdingsViewMode = undefined;
-      } else if (user.subscription?.type === 'Premium') {
+      } else if (user.subscription?.type === SubscriptionType.Premium) {
         if (!hasRole(user, Role.DEMO)) {
           currentPermissions.push(permissions.createApiKey);
           currentPermissions.push(permissions.enableDataProviderGhostfolio);

apps/api/src/services/data-provider/data-provider.service.ts

@@ -12,6 +12,7 @@ import {
   PROPERTY_DATA_SOURCE_MAPPING
 } from '@ghostfolio/common/config';
 import { CreateOrderDto } from '@ghostfolio/common/dtos';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   DATE_FORMAT,
   getAssetProfileIdentifier,
@@ -227,7 +228,7 @@ export class DataProviderService implements OnModuleInit {
 
       if (
         this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-        user.subscription.type === 'Basic'
+        user.subscription.type === SubscriptionType.Basic
       ) {
         const dataProvider = this.getDataProvider(DataSource[dataSource]);
 
@@ -591,7 +592,7 @@ export class DataProviderService implements OnModuleInit {
           } else if (
             dataProvider.getDataProviderInfo().isPremium &&
             this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION') &&
-            user?.subscription.type === 'Basic'
+            user?.subscription.type === SubscriptionType.Basic
           ) {
             // Skip symbols of Premium data providers for users without subscription
             return false;
@@ -780,7 +781,7 @@ export class DataProviderService implements OnModuleInit {
       })
       .map((lookupItem) => {
         if (this.configurationService.get('ENABLE_FEATURE_SUBSCRIPTION')) {
-          if (user.subscription.type === 'Premium') {
+          if (user.subscription.type === SubscriptionType.Premium) {
             lookupItem.dataProviderInfo.isPremium = false;
           }
 

apps/client/src/app/components/admin-overview/admin-overview.component.ts

@@ -8,7 +8,10 @@ import {
   PROPERTY_SYSTEM_MESSAGE,
   ghostfolioPrefix
 } from '@ghostfolio/common/config';
-import { ConfirmationDialogType } from '@ghostfolio/common/enums';
+import {
+  ConfirmationDialogType,
+  SubscriptionType
+} from '@ghostfolio/common/enums';
 import { getDateFnsLocale } from '@ghostfolio/common/helper';
 import {
   Coupon,
@@ -255,7 +258,7 @@ export class GfAdminOverviewComponent implements OnInit {
         this.systemMessage ??
           ({
             message: '⚒️ Scheduled maintenance in progress...',
-            targetGroups: ['Basic', 'Premium']
+            targetGroups: [SubscriptionType.Basic, SubscriptionType.Premium]
           } as SystemMessage)
       )
     );

apps/client/src/app/pages/portfolio/fire/fire-page.component.ts

@@ -1,5 +1,6 @@
 import { ImpersonationStorageService } from '@ghostfolio/client/services/impersonation-storage.service';
 import { UserService } from '@ghostfolio/client/services/user/user.service';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   FireCalculationCompleteEvent,
   FireWealth,
@@ -80,7 +81,7 @@ export class GfFirePageComponent implements OnInit {
               : 0
           }
         };
-        if (this.user.subscription?.type === 'Basic') {
+        if (this.user.subscription?.type === SubscriptionType.Basic) {
           this.fireWealth = {
             today: {
               valueInBaseCurrency: 10000
@@ -113,7 +114,7 @@ export class GfFirePageComponent implements OnInit {
           this.user = state.user;
 
           this.hasPermissionToUpdateUserSettings =
-            this.user.subscription?.type === 'Basic'
+            this.user.subscription?.type === SubscriptionType.Basic
               ? false
               : hasPermission(
                   this.user.permissions,

apps/client/src/app/pages/portfolio/x-ray/x-ray-page.component.ts

@@ -2,6 +2,7 @@ import { GfRulesComponent } from '@ghostfolio/client/components/rules/rules.comp
 import { ImpersonationStorageService } from '@ghostfolio/client/services/impersonation-storage.service';
 import { UserService } from '@ghostfolio/client/services/user/user.service';
 import { UpdateUserSettingDto } from '@ghostfolio/common/dtos';
+import { SubscriptionType } from '@ghostfolio/common/enums';
 import {
   PortfolioReportResponse,
   PortfolioReportRule
@@ -73,7 +74,7 @@ export class GfXRayPageComponent {
           this.user = state.user;
 
           this.hasPermissionToUpdateUserSettings =
-            this.user.subscription?.type === 'Basic'
+            this.user.subscription?.type === SubscriptionType.Basic
               ? false
               : hasPermission(
                   this.user.permissions,