Feature/rename Platform to platform in Account database schema (#4999)

* Rename Platform to platform in Account database schema

* Update changelog

CHANGELOG.md

@@ -14,6 +14,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Changed
 
 - Migrated the `@ghostfolio/ui/value` component to control flow
+- Renamed `Platform` to `platform` in the `Account` database schema
 - Refactored the health check endpoint for data enhancers
 - Refactored the health check endpoint for data providers
 

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

@@ -152,7 +152,7 @@ export class AccountController {
       return this.accountService.createAccount(
         {
           ...data,
-          Platform: { connect: { id: platformId } },
+          platform: { connect: { id: platformId } },
           user: { connect: { id: this.request.user.id } }
         },
         this.request.user.id
@@ -250,7 +250,7 @@ export class AccountController {
         {
           data: {
             ...data,
-            Platform: { connect: { id: platformId } },
+            platform: { connect: { id: platformId } },
             user: { connect: { id: this.request.user.id } }
           },
           where: {
@@ -270,7 +270,7 @@ export class AccountController {
         {
           data: {
             ...data,
-            Platform: originalAccount.platformId
+            platform: originalAccount.platformId
               ? { disconnect: true }
               : undefined,
             user: { connect: { id: this.request.user.id } }

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

@@ -64,7 +64,7 @@ export class AccountService {
     (Account & {
       activities?: Order[];
       balances?: AccountBalance[];
-      Platform?: Platform;
+      platform?: Platform;
     })[]
   > {
     const { include = {}, skip, take, cursor, where, orderBy } = params;
@@ -140,7 +140,10 @@ export class AccountService {
 
   public async getAccounts(aUserId: string): Promise<Account[]> {
     const accounts = await this.accounts({
-      include: { activities: true, Platform: true },
+      include: {
+        activities: true,
+        platform: true
+      },
       orderBy: { name: 'asc' },
       where: { userId: aUserId }
     });

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

@@ -48,7 +48,7 @@ export class ExportService {
       await this.accountService.accounts({
         include: {
           balances: true,
-          Platform: true
+          platform: true
         },
         orderBy: {
           name: 'asc'
@@ -72,7 +72,7 @@ export class ExportService {
           id,
           isExcluded,
           name,
-          Platform: platform,
+          platform,
           platformId
         }) => {
           if (platformId) {

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

@@ -207,7 +207,7 @@ export class ImportService {
           ) {
             accountObject = {
               ...accountObject,
-              Platform: { connect: { id: platformId } }
+              platform: { connect: { id: platformId } }
             };
           }
 

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

@@ -490,7 +490,7 @@ export class OrderService {
           // eslint-disable-next-line @typescript-eslint/naming-convention
           Account: {
             include: {
-              Platform: true
+              platform: true
             }
           },
           // eslint-disable-next-line @typescript-eslint/naming-convention

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

@@ -158,7 +158,10 @@ export class PortfolioService {
     const [accounts, details] = await Promise.all([
       this.accountService.accounts({
         where,
-        include: { activities: true, Platform: true },
+        include: {
+          activities: true,
+          platform: true
+        },
         orderBy: { name: 'asc' }
       }),
       this.getDetails({
@@ -2107,14 +2110,14 @@ export class PortfolioService {
 
     let currentAccounts: (Account & {
       Order?: Order[];
-      Platform?: Platform;
+      platform?: Platform;
     })[] = [];
 
     if (filters.length === 0) {
       currentAccounts = await this.accountService.getAccounts(userId);
     } else if (filters.length === 1 && filters[0].type === 'ACCOUNT') {
       currentAccounts = await this.accountService.accounts({
-        include: { Platform: true },
+        include: { platform: true },
         where: { id: filters[0].id }
       });
     } else {
@@ -2131,7 +2134,7 @@ export class PortfolioService {
       );
 
       currentAccounts = await this.accountService.accounts({
-        include: { Platform: true },
+        include: { platform: true },
         where: { id: { in: accountIds } }
       });
     }
@@ -2156,18 +2159,18 @@ export class PortfolioService {
         )
       };
 
-      if (platforms[account.Platform?.id || UNKNOWN_KEY]?.valueInBaseCurrency) {
-        platforms[account.Platform?.id || UNKNOWN_KEY].valueInBaseCurrency +=
+      if (platforms[account.platformId || UNKNOWN_KEY]?.valueInBaseCurrency) {
+        platforms[account.platformId || UNKNOWN_KEY].valueInBaseCurrency +=
           this.exchangeRateDataService.toCurrency(
             account.balance,
             account.currency,
             userCurrency
           );
       } else {
-        platforms[account.Platform?.id || UNKNOWN_KEY] = {
+        platforms[account.platformId || UNKNOWN_KEY] = {
           balance: account.balance,
           currency: account.currency,
-          name: account.Platform?.name,
+          name: account.platform?.name,
           valueInBaseCurrency: this.exchangeRateDataService.toCurrency(
             account.balance,
             account.currency,
@@ -2201,15 +2204,15 @@ export class PortfolioService {
         }
 
         if (
-          platforms[Account?.Platform?.id || UNKNOWN_KEY]?.valueInBaseCurrency
+          platforms[Account?.platformId || UNKNOWN_KEY]?.valueInBaseCurrency
         ) {
-          platforms[Account?.Platform?.id || UNKNOWN_KEY].valueInBaseCurrency +=
+          platforms[Account?.platformId || UNKNOWN_KEY].valueInBaseCurrency +=
             currentValueOfSymbolInBaseCurrency;
         } else {
-          platforms[Account?.Platform?.id || UNKNOWN_KEY] = {
+          platforms[Account?.platformId || UNKNOWN_KEY] = {
             balance: 0,
             currency: Account?.currency,
-            name: account.Platform?.name,
+            name: account.platform?.name,
             valueInBaseCurrency: currentValueOfSymbolInBaseCurrency
           };
         }

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

@@ -196,7 +196,7 @@ export class UserService {
       include: {
         Access: true,
         accounts: {
-          include: { Platform: true }
+          include: { platform: true }
         },
         Analytics: true,
         Settings: true,

apps/client/src/app/components/account-detail-dialog/account-detail-dialog.component.ts

@@ -174,7 +174,7 @@ export class AccountDetailDialog implements OnDestroy, OnInit {
           balance,
           currency,
           name,
-          Platform,
+          platform,
           transactionCount,
           value,
           valueInBaseCurrency
@@ -189,7 +189,7 @@ export class AccountDetailDialog implements OnDestroy, OnInit {
           }
 
           this.name = name;
-          this.platformName = Platform?.name ?? '-';
+          this.platformName = platform?.name ?? '-';
           this.transactionCount = transactionCount;
           this.valueInBaseCurrency = valueInBaseCurrency;
 

apps/client/src/app/components/accounts-table/accounts-table.component.html

@@ -43,11 +43,11 @@
         <ng-container i18n>Name</ng-container>
       </th>
       <td *matCellDef="let element" class="px-1" mat-cell>
-        @if (element.Platform?.url) {
+        @if (element.platform?.url) {
           <gf-entity-logo
             class="d-inline d-sm-none mr-1"
-            [tooltip]="element.Platform?.name"
-            [url]="element.Platform.url"
+            [tooltip]="element.platform?.name"
+            [url]="element.platform.url"
           />
         }
         <span>{{ element.name }}</span>
@@ -81,7 +81,7 @@
         *matHeaderCellDef
         class="d-none d-lg-table-cell px-1"
         mat-header-cell
-        mat-sort-header="Platform.name"
+        mat-sort-header="platform.name"
       >
         <ng-container i18n>Platform</ng-container>
       </th>
@@ -91,14 +91,14 @@
         mat-cell
       >
         <div class="d-flex">
-          @if (element.Platform?.url) {
+          @if (element.platform?.url) {
             <gf-entity-logo
               class="mr-1"
-              [tooltip]="element.Platform?.name"
-              [url]="element.Platform.url"
+              [tooltip]="element.platform?.name"
+              [url]="element.platform.url"
             />
           }
-          <span>{{ element.Platform?.name }}</span>
+          <span>{{ element.platform?.name }}</span>
         </div>
       </td>
       <td

apps/client/src/app/pages/accounts/transfer-balance/transfer-balance-dialog.html

@@ -13,11 +13,11 @@
           @for (account of accounts; track account) {
             <mat-option [value]="account.id">
               <div class="d-flex">
-                @if (account.Platform?.url) {
+                @if (account.platform?.url) {
                   <gf-entity-logo
                     class="mr-1"
-                    [tooltip]="account.Platform?.name"
-                    [url]="account.Platform?.url"
+                    [tooltip]="account.platform?.name"
+                    [url]="account.platform?.url"
                   />
                 }
                 <span>{{ account.name }}</span>
@@ -34,11 +34,11 @@
           @for (account of accounts; track account) {
             <mat-option [value]="account.id">
               <div class="d-flex">
-                @if (account.Platform?.url) {
+                @if (account.platform?.url) {
                   <gf-entity-logo
                     class="mr-1"
-                    [tooltip]="account.Platform?.name"
-                    [url]="account.Platform?.url"
+                    [tooltip]="account.platform?.name"
+                    [url]="account.platform?.url"
                   />
                 }
                 <span>{{ account.name }}</span>

apps/client/src/app/pages/portfolio/activities/create-or-update-activity-dialog/create-or-update-activity-dialog.html

@@ -93,11 +93,11 @@
           @for (account of data.accounts; track account) {
             <mat-option [value]="account.id">
               <div class="d-flex">
-                @if (account.Platform?.url) {
+                @if (account.platform?.url) {
                   <gf-entity-logo
                     class="mr-1"
-                    [tooltip]="account.Platform?.name"
-                    [url]="account.Platform?.url"
+                    [tooltip]="account.platform?.name"
+                    [url]="account.platform?.url"
                   />
                 }
                 <span>{{ account.name }}</span>

libs/common/src/lib/types/account-with-platform.type.ts

@@ -1,3 +1,3 @@
 import { Account, Platform } from '@prisma/client';
 
-export type AccountWithPlatform = Account & { Platform?: Platform };
+export type AccountWithPlatform = Account & { platform?: Platform };

libs/common/src/lib/types/account-with-value.type.ts

@@ -2,7 +2,7 @@ import { Account as AccountModel, Platform } from '@prisma/client';
 
 export type AccountWithValue = AccountModel & {
   balanceInBaseCurrency: number;
-  Platform?: Platform;
+  platform?: Platform;
   transactionCount: number;
   value: number;
   valueInBaseCurrency: number;

libs/ui/src/lib/activities-table/activities-table.component.html

@@ -309,11 +309,11 @@
       </th>
       <td *matCellDef="let element" class="px-1" mat-cell>
         <div class="d-flex">
-          @if (element.Account?.Platform?.url) {
+          @if (element.Account?.platform?.url) {
             <gf-entity-logo
               class="mr-1"
-              [tooltip]="element.Account?.Platform?.name"
-              [url]="element.Account?.Platform?.url"
+              [tooltip]="element.Account?.platform?.name"
+              [url]="element.Account?.platform?.url"
             />
           }
           <span class="d-none d-lg-block">{{ element.Account?.name }}</span>

libs/ui/src/lib/assistant/assistant.html

@@ -149,11 +149,11 @@
               @for (account of accounts; track account.id) {
                 <mat-option [value]="account.id">
                   <div class="d-flex">
-                    @if (account.Platform?.url) {
+                    @if (account.platform?.url) {
                       <gf-entity-logo
                         class="mr-1"
-                        [tooltip]="account.Platform?.name"
-                        [url]="account.Platform?.url"
+                        [tooltip]="account.platform?.name"
+                        [url]="account.platform?.url"
                       />
                     }
                     <span>{{ account.name }}</span>

prisma/schema.prisma

@@ -35,11 +35,11 @@ model Account {
   id         String           @default(uuid())
   isExcluded Boolean          @default(false)
   name       String?
+  platform   Platform?        @relation(fields: [platformId], references: [id])
   platformId String?
   updatedAt  DateTime         @updatedAt
   user       User             @relation(fields: [userId], onDelete: Cascade, references: [id])
   userId     String
-  Platform   Platform?        @relation(fields: [platformId], references: [id])
 
   @@id([id, userId])
   @@index([currency])