Browse Source

Feature/extend MCP access to support view permission (#8112)

* Extend MCP access to support (non-restricted) view permission

* Update changelog
pull/8115/merge
Thomas Kaul 5 hours ago
committed by GitHub
parent
commit
ff03b4c238
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
  1. 6
      CHANGELOG.md
  2. 2
      README.md
  3. 162
      apps/api/src/app/endpoints/mcp/mcp.controller.spec.ts
  4. 61
      apps/api/src/app/endpoints/mcp/mcp.controller.ts
  5. 16
      apps/api/src/app/endpoints/mcp/mcp.module.ts
  6. 48
      apps/api/src/app/endpoints/mcp/mcp.service.spec.ts
  7. 37
      apps/api/src/app/endpoints/mcp/mcp.service.ts
  8. 209
      apps/api/src/services/portfolio-table/portfolio-table.service.spec.ts
  9. 235
      apps/api/src/services/portfolio-table/portfolio-table.service.ts
  10. 16
      apps/client/src/app/components/user-account-access/create-or-update-access-dialog/create-or-update-access-dialog.component.ts
  11. 2
      apps/client/src/app/components/user-account-access/create-or-update-access-dialog/create-or-update-access-dialog.html
  12. 37
      libs/common/src/lib/scopes.spec.ts
  13. 13
      libs/common/src/lib/scopes.ts

6
CHANGELOG.md

@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## Unreleased
### Changed
- Extended the access to share the portfolio with the Model Context Protocol (MCP) to support the _View_ and the _View and manage_ permissions (experimental)
## 3.83.0 - 2026-10-10
### Added

2
README.md

@ -407,7 +407,7 @@ The _Model Context Protocol_ (MCP) server lets an AI client read your portfolio
- Set `ROOT_URL` to the public URL of your instance if a client calls the endpoint from a browser page. The host name of `ROOT_URL` is the only accepted origin.
- Grant an access of the type _MCP_ in _My Ghostfolio_ under _Access_ and copy its token
An _MCP_ access has (restricted) read scopes and never reads the monetary values. Grant the _Restricted view and manage_ permission to let the client also import activities.
An _MCP_ access with the _Restricted view_ permission reads the portfolio without the monetary values. Grant the _View_ permission to let the client also read the monetary values. Grant the _Restricted view and manage_ or the _View and manage_ permission to let the client also import activities.
### Connect a client

162
apps/api/src/app/endpoints/mcp/mcp.controller.spec.ts

@ -2,12 +2,17 @@ import { REQUIRES_SCOPE_KEY } from '@ghostfolio/api/decorators/requires-scope.de
import { McpToolExceptionFilter } from '@ghostfolio/api/filters/mcp-tool-exception.filter';
import { AccessGuard } from '@ghostfolio/api/guards/access.guard';
import { getMcpUserOfBearerToken } from '@ghostfolio/api/helper/bearer-token.helper';
import { SubscriptionType } from '@ghostfolio/common/enums';
import {
getScopesOfAccess,
getScopesOfAccessLevel,
Scope,
scopes
} from '@ghostfolio/common/scopes';
import type {
AccessLevel,
ImpersonationContext
} from '@ghostfolio/common/types';
import {
EXCEPTION_FILTERS_METADATA,
@ -23,6 +28,7 @@ import {
} from '@rekog/mcp-nest';
import { GhostfolioMcpController } from './mcp.controller';
import { McpService } from './mcp.service';
/**
* Gives the metadata which a decorator sets on the method of a tool. The
@ -83,6 +89,86 @@ function getNamesOfListedTools(request: unknown) {
});
}
/**
* Gives for each tool which reads the portfolio whether the controller asks
* the service for the monetary values
*/
async function getWithValuesOfReadTools(accessLevel: AccessLevel) {
const mcpService = {
getAccounts: jest.fn(),
getActivities: jest.fn(),
getPerformance: jest.fn(),
getPortfolio: jest.fn()
};
const controller = new GhostfolioMcpController(
mcpService as unknown as McpService
);
const impersonationContext = {
isActive: true,
scopes: getScopesOfAccess({
scopes: getScopesOfAccessLevel(accessLevel),
type: 'MCP'
}),
userId: 'user-id',
userSettings: { baseCurrency: 'CHF' }
} as ImpersonationContext;
await controller.getAccounts(impersonationContext, {});
await controller.getActivities(
impersonationContext,
{} as Parameters<GhostfolioMcpController['getActivities']>[1]
);
await controller.getPerformance(
impersonationContext,
{} as Parameters<GhostfolioMcpController['getPerformance']>[1]
);
await controller.getPortfolio(impersonationContext);
return Object.values(mcpService).map((method) => {
return (method.mock.calls[0][0] as { withValues: boolean }).withValues;
});
}
/**
* Gives whether the controller asks the service for the asset performance in
* base currency of an access with the permission "View"
*/
async function getWithAssetPerformanceInBaseCurrency(
subscriptionType?: SubscriptionType
) {
const mcpService = { getPerformance: jest.fn() };
const controller = new GhostfolioMcpController(
mcpService as unknown as McpService
);
await controller.getPerformance(
{
isActive: true,
scopes: getScopesOfAccess({
scopes: getScopesOfAccessLevel('READ'),
type: 'MCP'
}),
userId: 'user-id',
userSettings: { baseCurrency: 'CHF' },
userSubscription: subscriptionType
? ({
type: subscriptionType
} as ImpersonationContext['userSubscription'])
: undefined
},
{} as Parameters<GhostfolioMcpController['getPerformance']>[1]
);
return (
mcpService.getPerformance.mock.calls[0][0] as {
withAssetPerformanceInBaseCurrency: boolean;
}
).withAssetPerformanceInBaseCurrency;
}
describe('GhostfolioMcpController', () => {
// A tool without the decorator of the scope would be open to every access,
// hence a new tool has to declare its scope
@ -163,6 +249,82 @@ describe('GhostfolioMcpController', () => {
]);
});
it('Lists only the tools to read for an access with the permission "View"', () => {
expect(
getNamesOfListedTools({
impersonationOfBearerToken: {
isActive: true,
scopes: getScopesOfAccess({
scopes: getScopesOfAccessLevel('READ'),
type: 'MCP'
})
}
})
).toEqual([
'get-accounts',
'get-activities',
'get-performance',
'get-portfolio',
'get-watchlist'
]);
});
it('Lists every tool for an access with the permission "View and manage"', () => {
expect(
getNamesOfListedTools({
impersonationOfBearerToken: {
isActive: true,
scopes: getScopesOfAccess({
scopes: getScopesOfAccessLevel('CREATE_READ_UPDATE_DELETE'),
type: 'MCP'
})
}
})
).toEqual([
'get-accounts',
'get-activities',
'get-performance',
'get-portfolio',
'get-watchlist',
'import-activities',
'search-asset-profiles'
]);
});
it('Gives the monetary values for an access with the permission "View"', async () => {
expect(await getWithValuesOfReadTools('READ')).toEqual([
true,
true,
true,
true
]);
});
it('Gives no monetary values for an access with the permission "Restricted view"', async () => {
expect(await getWithValuesOfReadTools('READ_RESTRICTED')).toEqual([
false,
false,
false,
false
]);
});
it('Gives the asset performance in base currency for a Premium subscription', async () => {
expect(
await getWithAssetPerformanceInBaseCurrency(SubscriptionType.Premium)
).toBe(true);
});
it('Gives the asset performance in base currency if the subscription is disabled', async () => {
expect(await getWithAssetPerformanceInBaseCurrency()).toBe(true);
});
it('Gives no asset performance in base currency for a Basic subscription', async () => {
expect(
await getWithAssetPerformanceInBaseCurrency(SubscriptionType.Basic)
).toBe(false);
});
it('Lists no tool for an inactive access', () => {
expect(
getNamesOfListedTools({

61
apps/api/src/app/endpoints/mcp/mcp.controller.ts

@ -3,7 +3,8 @@ import { RequiresScopeOfAccess } from '@ghostfolio/api/decorators/requires-scope
import { McpToolExceptionFilter } from '@ghostfolio/api/filters/mcp-tool-exception.filter';
import { PortfolioTableService } from '@ghostfolio/api/services/portfolio-table/portfolio-table.service';
import { MCP_MAX_ACTIVITIES } from '@ghostfolio/common/config';
import { scopes } from '@ghostfolio/common/scopes';
import { SubscriptionType } from '@ghostfolio/common/enums';
import { hasScope, scopes } from '@ghostfolio/common/scopes';
import type { ImpersonationContext } from '@ghostfolio/common/types';
import { UseFilters } from '@nestjs/common';
@ -35,15 +36,22 @@ export class GhostfolioMcpController {
},
description: `Gives the accounts of the portfolio with these columns: ${PortfolioTableService.getAccountsTableColumnNames().join(
', '
)}. The allocation in percentage is relative to the accounts of the result, hence the parameters change it.`,
)}. If the access reads the monetary values, these columns are given in addition: ${PortfolioTableService.getAccountsTableValueColumnNames().join(
', '
)}. The allocation in percentage is relative to the accounts of the result, hence the parameters change it. The parameters change the value in base currency as well. With the holding parameter, it is the value of the holding in the account without the cash balance. Without the holding parameter, it includes the full cash balance of the account, also with the assetClasses parameter. The balance is always the full cash balance of the account in the currency of the account.`,
name: 'get-accounts',
parameters: GET_ACCOUNTS_PARAMETERS
})
public async getAccounts(
@Impersonation() { userId }: ImpersonationContext,
@Impersonation()
{ scopes: impersonationScopes, userId }: ImpersonationContext,
@Payload() parameters: z.infer<typeof GET_ACCOUNTS_PARAMETERS>
) {
return this.mcpService.getAccounts({ ...parameters, userId });
return this.mcpService.getAccounts({
...parameters,
userId,
withValues: this.hasScopeToReadValues(impersonationScopes)
});
}
@RequiresScopeOfAccess(scopes.activityRead)
@ -55,18 +63,22 @@ export class GhostfolioMcpController {
},
description: `Gives the activities of the portfolio, the most recent first, with these columns: ${PortfolioTableService.getActivitiesTableColumnNames().join(
', '
)}. At most ${MCP_MAX_ACTIVITIES} activities are given per call, hence narrow the result with the parameters or get the further activities with the skip parameter.`,
)}. If the access reads the monetary values, these columns are given in addition: ${PortfolioTableService.getActivitiesTableValueColumnNames().join(
', '
)}. The unit price and the fee are in the currency of the activity. At most ${MCP_MAX_ACTIVITIES} activities are given per call, hence narrow the result with the parameters or get the further activities with the skip parameter.`,
name: 'get-activities',
parameters: GET_ACTIVITIES_PARAMETERS
})
public async getActivities(
@Impersonation() { userId, userSettings }: ImpersonationContext,
@Impersonation()
{ scopes: impersonationScopes, userId, userSettings }: ImpersonationContext,
@Payload() parameters: z.infer<typeof GET_ACTIVITIES_PARAMETERS>
) {
return this.mcpService.getActivities({
...parameters,
userId,
userCurrency: userSettings.baseCurrency
userCurrency: userSettings.baseCurrency,
withValues: this.hasScopeToReadValues(impersonationScopes)
});
}
@ -79,15 +91,28 @@ export class GhostfolioMcpController {
},
description: `Gives the performance of the portfolio in the date range with these columns: ${PortfolioTableService.getPerformanceTableColumnNames().join(
', '
)}. The asset performance excludes the effect of the exchange rates, the currency performance is that effect, and the net performance is the sum of both in the base currency of the user. Each performance is the return on average investment (ROAI) and includes the dividends (total return). The accounts and the activities which are excluded from analysis are not part of the performance. The parameters limit the performance to the holdings of the accounts, of the asset classes or of the asset profile.`,
)}. If the access reads the monetary values, these columns are given in addition: ${PortfolioTableService.getPerformanceTableValueColumnNames().join(
', '
)}. The value in base currency is the value at the end of the date range. The asset performance excludes the effect of the exchange rates, the currency performance is that effect, and the net performance is the sum of both in the base currency of the user. Each performance is the return on average investment (ROAI) and includes the dividends (total return). The accounts and the activities which are excluded from analysis are not part of the performance. The parameters limit the performance to the holdings of the accounts, of the asset classes or of the asset profile.`,
name: 'get-performance',
parameters: GET_PERFORMANCE_PARAMETERS
})
public async getPerformance(
@Impersonation() { userId }: ImpersonationContext,
@Impersonation()
{
scopes: impersonationScopes,
userId,
userSubscription
}: ImpersonationContext,
@Payload() parameters: z.infer<typeof GET_PERFORMANCE_PARAMETERS>
) {
return this.mcpService.getPerformance({ ...parameters, userId });
return this.mcpService.getPerformance({
...parameters,
userId,
withAssetPerformanceInBaseCurrency:
userSubscription?.type !== SubscriptionType.Basic,
withValues: this.hasScopeToReadValues(impersonationScopes)
});
}
@RequiresScopeOfAccess(scopes.portfolioRead)
@ -99,11 +124,19 @@ export class GhostfolioMcpController {
},
description: `Gives the holdings of the portfolio with these columns: ${PortfolioTableService.getHoldingsTableColumnNames().join(
', '
)}. If the access reads the monetary values, these columns are given in addition: ${PortfolioTableService.getHoldingsTableValueColumnNames().join(
', '
)}.`,
name: 'get-portfolio'
})
public async getPortfolio(@Impersonation() { userId }: ImpersonationContext) {
return this.mcpService.getPortfolio({ userId });
public async getPortfolio(
@Impersonation()
{ scopes: impersonationScopes, userId }: ImpersonationContext
) {
return this.mcpService.getPortfolio({
userId,
withValues: this.hasScopeToReadValues(impersonationScopes)
});
}
@RequiresScopeOfAccess(scopes.watchlistRead)
@ -159,4 +192,8 @@ export class GhostfolioMcpController {
) {
return this.mcpService.searchAssetProfiles({ ...parameters, userId });
}
private hasScopeToReadValues(impersonationScopes: string[]) {
return hasScope(impersonationScopes, scopes.portfolioReadValues);
}
}

16
apps/api/src/app/endpoints/mcp/mcp.module.ts

@ -7,6 +7,7 @@ import { ApiModule } from '@ghostfolio/api/services/api/api.module';
import { ConfigurationModule } from '@ghostfolio/api/services/configuration/configuration.module';
import { ConfigurationService } from '@ghostfolio/api/services/configuration/configuration.service';
import { PortfolioTableModule } from '@ghostfolio/api/services/portfolio-table/portfolio-table.module';
import { PortfolioTableService } from '@ghostfolio/api/services/portfolio-table/portfolio-table.service';
import { MCP_ENDPOINT } from '@ghostfolio/common/config';
import { Module } from '@nestjs/common';
@ -37,9 +38,20 @@ import { McpService } from './mcp.service';
useFactory: (configurationService: ConfigurationService) => {
const { hostname } = new URL(configurationService.get('ROOT_URL'));
const instructions = [
'Ghostfolio is a wealth management application. The tools read the portfolio and the watchlist of the user who granted the access and import activities into the portfolio. They give the quantities and the monetary values only if the access has the permission "View" or "View and manage", otherwise no quantity and no monetary value (except the unit price of an activity). Only the tools which the permission of the access covers are listed. To import activities, the access needs the permission "Restricted view and manage" or "View and manage".'
];
if (configurationService.get('ENABLE_FEATURE_SUBSCRIPTION')) {
instructions.push(
`With the Basic subscription, the tool get-performance does not give these columns: ${PortfolioTableService.getAssetPerformanceInBaseCurrencyColumnNames().join(
', '
)}.`
);
}
return new McpStrategy({
instructions:
'Ghostfolio is a wealth management application. The tools read the portfolio and the watchlist of the user who granted the access and import activities into the portfolio. They give no quantity and no monetary value (except the unit price of an activity). Only the tools which the permission of the access covers are listed. To import activities, the access needs the permission "Restricted view and manage".',
instructions: instructions.join(' '),
name: 'ghostfolio',
resolveUser: getMcpUserOfBearerToken,
title: 'Ghostfolio',

48
apps/api/src/app/endpoints/mcp/mcp.service.spec.ts

@ -169,6 +169,14 @@ describe('McpService', () => {
userId
});
});
it('Gives the values if the access reads them', async () => {
await mcpService.getAccounts({ userId, withValues: true });
expect(portfolioTableService.getAccountsTable).toHaveBeenCalledWith(
expect.objectContaining({ withValues: true })
);
});
});
describe('getActivities', () => {
@ -272,6 +280,14 @@ describe('McpService', () => {
types: [ActivityType.BUY]
});
});
it('Gives the values if the access reads them', async () => {
await getActivities({ withValues: true });
expect(portfolioTableService.getActivitiesTable).toHaveBeenCalledWith(
expect.objectContaining({ withValues: true })
);
});
});
describe('getPerformance', () => {
@ -350,6 +366,30 @@ describe('McpService', () => {
dateRange: '2024'
});
});
it('Gives the values if the access reads them', async () => {
await mcpService.getPerformance({
userId,
range: '2024',
withValues: true
});
expect(portfolioTableService.getPerformanceTable).toHaveBeenCalledWith(
expect.objectContaining({ withValues: true })
);
});
it('Gives the asset performance in base currency if the subscription permits it', async () => {
await mcpService.getPerformance({
userId,
range: '2024',
withAssetPerformanceInBaseCurrency: true
});
expect(portfolioTableService.getPerformanceTable).toHaveBeenCalledWith(
expect.objectContaining({ withAssetPerformanceInBaseCurrency: true })
);
});
});
describe('getPortfolio', () => {
@ -364,6 +404,14 @@ describe('McpService', () => {
withDataSource: true
});
});
it('Gives the values if the access reads them', async () => {
await mcpService.getPortfolio({ userId, withValues: true });
expect(portfolioTableService.getHoldingsTable).toHaveBeenCalledWith(
expect.objectContaining({ withValues: true })
);
});
});
describe('getWatchlist', () => {

37
apps/api/src/app/endpoints/mcp/mcp.service.ts

@ -39,8 +39,12 @@ export class McpService {
accountIds,
assetClasses,
holding,
userId
}: z.infer<typeof GET_ACCOUNTS_PARAMETERS> & { userId: string }) {
userId,
withValues
}: z.infer<typeof GET_ACCOUNTS_PARAMETERS> & {
userId: string;
withValues?: boolean;
}) {
const filters = this.apiService.buildFiltersFromQueryParams({
...this.getHoldingFilterParameters({ holding }),
filterByAccounts: accountIds,
@ -49,7 +53,8 @@ export class McpService {
const table = await this.portfolioTableService.getAccountsTable({
filters,
userId
userId,
withValues
});
return this.getTextResult(table);
@ -63,10 +68,12 @@ export class McpService {
skip,
take,
userCurrency,
userId
userId,
withValues
}: z.infer<typeof GET_ACTIVITIES_PARAMETERS> & {
userCurrency: string;
userId: string;
withValues?: boolean;
}) {
let endDate: Date | undefined;
let startDate: Date | undefined;
@ -90,6 +97,7 @@ export class McpService {
take,
userCurrency,
userId,
withValues,
types: activityTypes
});
@ -101,8 +109,14 @@ export class McpService {
assetClasses,
holding,
range,
userId
}: z.infer<typeof GET_PERFORMANCE_PARAMETERS> & { userId: string }) {
userId,
withAssetPerformanceInBaseCurrency,
withValues
}: z.infer<typeof GET_PERFORMANCE_PARAMETERS> & {
userId: string;
withAssetPerformanceInBaseCurrency?: boolean;
withValues?: boolean;
}) {
const filters = this.apiService.buildFiltersFromQueryParams({
...this.getHoldingFilterParameters({ holding }),
filterByAccounts: accountIds,
@ -112,15 +126,24 @@ export class McpService {
const table = await this.portfolioTableService.getPerformanceTable({
filters,
userId,
withAssetPerformanceInBaseCurrency,
withValues,
dateRange: range
});
return this.getTextResult(table);
}
public async getPortfolio({ userId }: { userId: string }) {
public async getPortfolio({
userId,
withValues
}: {
userId: string;
withValues?: boolean;
}) {
const table = await this.portfolioTableService.getHoldingsTable({
userId,
withValues,
languageCode: DEFAULT_LANGUAGE_CODE,
withDataSource: true
});

209
apps/api/src/services/portfolio-table/portfolio-table.service.spec.ts

@ -84,7 +84,8 @@ function createAccount({
currency: 'CHF',
platform: { name: 'Platform A' },
tags: isExcluded ? [{ id: TAG_ID_EXCLUDE_FROM_ANALYSIS }] : [],
value: 2000
value: 2000,
valueInBaseCurrency: 1800
} as unknown as AccountWithValue;
}
@ -105,8 +106,11 @@ function createActivity({
},
currency: 'CHF',
date: new Date('2024-01-01'),
fee: 1.5,
quantity: 5,
type: 'BUY',
unitPrice: 100
unitPrice: 100,
valueInBaseCurrency: 512.3456
} as unknown as Activity;
}
@ -143,20 +147,24 @@ function createHolding({
}
function createPerformance({
netPerformance = 200,
netPerformancePercentage = 0.1,
netPerformancePercentageWithCurrencyEffect = 0.15
netPerformancePercentageWithCurrencyEffect = 0.15,
netPerformanceWithCurrencyEffect = 300
}: {
netPerformance?: number;
netPerformancePercentage?: number;
netPerformancePercentageWithCurrencyEffect?: number;
netPerformanceWithCurrencyEffect?: number;
} = {}): PortfolioPerformanceResponse['performance'] {
return {
netPerformance,
netPerformancePercentage,
netPerformancePercentageWithCurrencyEffect,
netPerformanceWithCurrencyEffect,
currentNetWorth: 3000,
currentValueInBaseCurrency: 2000,
dividendInBaseCurrency: 50,
netPerformance: 200,
netPerformanceWithCurrencyEffect: 300,
totalInvestment: 1700,
totalInvestmentValueWithCurrencyEffect: 1700
};
@ -246,9 +254,8 @@ function createPortfolioTableService({
}
describe('PortfolioTableService', () => {
// The tools of the model context protocol are the only callers, and an
// access of that type never grants the scope to read the monetary values,
// hence no table has a column with such a value
// A column with a monetary value is given only with the values, hence the
// names of these columns are given separately
describe('getAccountsTableColumnNames', () => {
it('gives no column with a monetary value', () => {
expect(PortfolioTableService.getAccountsTableColumnNames()).toEqual([
@ -263,6 +270,15 @@ describe('PortfolioTableService', () => {
});
});
describe('getAccountsTableValueColumnNames', () => {
it('gives the columns with a monetary value', () => {
expect(PortfolioTableService.getAccountsTableValueColumnNames()).toEqual([
'Balance',
'Value in Base Currency'
]);
});
});
describe('getActivitiesTableColumnNames', () => {
it('gives no column with a monetary value', () => {
expect(PortfolioTableService.getActivitiesTableColumnNames()).toEqual([
@ -278,6 +294,25 @@ describe('PortfolioTableService', () => {
});
});
describe('getActivitiesTableValueColumnNames', () => {
it('gives the columns with a quantity or with a monetary value', () => {
expect(
PortfolioTableService.getActivitiesTableValueColumnNames()
).toEqual(['Quantity', 'Fee', 'Value in Base Currency']);
});
});
describe('getAssetPerformanceInBaseCurrencyColumnNames', () => {
it('gives the value columns of the performance which give the asset performance', () => {
expect(
PortfolioTableService.getAssetPerformanceInBaseCurrencyColumnNames()
).toEqual([
'Asset Performance in Base Currency',
'Currency Performance in Base Currency'
]);
});
});
describe('getHoldingsTableColumnNames', () => {
it('gives no column with a monetary value', () => {
expect(PortfolioTableService.getHoldingsTableColumnNames()).toEqual([
@ -294,6 +329,15 @@ describe('PortfolioTableService', () => {
});
});
describe('getHoldingsTableValueColumnNames', () => {
it('gives the columns with a quantity or with a monetary value', () => {
expect(PortfolioTableService.getHoldingsTableValueColumnNames()).toEqual([
'Quantity',
'Value in Base Currency'
]);
});
});
describe('getPerformanceTableColumnNames', () => {
it('gives no column with a monetary value', () => {
expect(PortfolioTableService.getPerformanceTableColumnNames()).toEqual([
@ -304,6 +348,19 @@ describe('PortfolioTableService', () => {
});
});
describe('getPerformanceTableValueColumnNames', () => {
it('gives the columns with a monetary value', () => {
expect(
PortfolioTableService.getPerformanceTableValueColumnNames()
).toEqual([
'Value in Base Currency',
'Asset Performance in Base Currency',
'Currency Performance in Base Currency',
'Net Performance in Base Currency'
]);
});
});
describe('getWatchlistTableColumnNames', () => {
it('gives no column with a monetary value', () => {
expect(PortfolioTableService.getWatchlistTableColumnNames()).toEqual([
@ -331,9 +388,27 @@ describe('PortfolioTableService', () => {
expect(result).not.toContain('Cash Balance');
expect(result).not.toContain('1000');
expect(result).not.toContain('1800');
expect(result).not.toContain('2000');
});
it('gives the balance and the value with the values', async () => {
const portfolioTableService = createPortfolioTableService({
accounts: [createAccount()]
});
const result = await portfolioTableService.getAccountsTable({
userId: 'user-id',
withValues: true
});
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| account-a-id');
});
expect(row).toMatch(/\| false \| 1000 \| 1800\.00 \|$/);
});
// The accountIds parameter of the tool takes the identifiers, hence the
// table has to give them
it('gives the identifier of an account', async () => {
@ -405,6 +480,40 @@ describe('PortfolioTableService', () => {
expect(rowOfAapl).toContain(`| ${encodeDataSource(DataSource.YAHOO)} |`);
expect(rowOfGold).toContain(`| ${DataSource.MANUAL} |`);
});
it('gives no quantity, no fee and no value by default', async () => {
const result = await createPortfolioTableService({
activities: [createActivity()]
}).getActivitiesTable({
take: 50,
userCurrency: 'CHF',
userId: 'user-id'
});
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| 2024-01-01');
});
expect(result).not.toContain('Quantity');
expect(row).toMatch(/\| 100 \| Account A \|$/);
});
it('gives the quantity, the fee and the value with the values', async () => {
const result = await createPortfolioTableService({
activities: [createActivity()]
}).getActivitiesTable({
take: 50,
userCurrency: 'CHF',
userId: 'user-id',
withValues: true
});
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| 2024-01-01');
});
expect(row).toMatch(/\| Account A \| 5 \| 1\.5 \| 512\.35 \|$/);
});
});
describe('getHoldingsTable', () => {
@ -412,10 +521,12 @@ describe('PortfolioTableService', () => {
holdings: PortfolioPosition[],
{
configuration,
withDataSource
withDataSource,
withValues
}: {
configuration?: Record<string, unknown>;
withDataSource?: boolean;
withValues?: boolean;
} = {}
) {
return createPortfolioTableService({
@ -423,6 +534,7 @@ describe('PortfolioTableService', () => {
holdings
}).getHoldingsTable({
withDataSource,
withValues,
languageCode: DEFAULT_LANGUAGE_CODE,
userId: 'user-id'
});
@ -516,13 +628,45 @@ describe('PortfolioTableService', () => {
expect(firstRow).toContain('AAPL');
expect(secondRow).toContain('MSFT');
});
it('gives no quantity and no value by default', async () => {
const result = await getHoldingsTable([createHolding()]);
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| Name of AAPL');
});
expect(result).not.toContain('Quantity');
expect(row).toMatch(/\| 75\.000% \|$/);
});
it('gives the quantity and the value with the values', async () => {
const result = await getHoldingsTable([createHolding()], {
withValues: true
});
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| Name of AAPL');
});
expect(row).toMatch(/\| 75\.000% \| 5 \| 2000\.00 \|$/);
});
});
describe('getPerformanceTable', () => {
function getPerformanceTable(
parameters: Parameters<typeof createPortfolioTableService>[0] = {}
parameters: Parameters<typeof createPortfolioTableService>[0] = {},
{
withAssetPerformanceInBaseCurrency,
withValues
}: {
withAssetPerformanceInBaseCurrency?: boolean;
withValues?: boolean;
} = {}
) {
return createPortfolioTableService(parameters).getPerformanceTable({
withAssetPerformanceInBaseCurrency,
withValues,
dateRange: 'ytd',
userId: 'user-id'
});
@ -565,6 +709,51 @@ describe('PortfolioTableService', () => {
}
});
it('gives the value and the performance in base currency with the values', async () => {
const result = await getPerformanceTable(
{},
{ withAssetPerformanceInBaseCurrency: true, withValues: true }
);
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| 10.000%');
});
expect(row).toBe(
'| 10.000% | 5.000% | 15.000% | 2000.00 | 200.00 | 100.00 | 300.00 |'
);
});
it('gives no asset performance and no currency performance in base currency without the asset performance in base currency', async () => {
const result = await getPerformanceTable({}, { withValues: true });
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| 10.000%');
});
expect(result).not.toContain('Asset Performance in Base Currency');
expect(result).not.toContain('Currency Performance in Base Currency');
expect(row).toBe('| 10.000% | 5.000% | 15.000% | 2000.00 | 300.00 |');
});
it('gives a currency performance in base currency of zero without a sign', async () => {
const result = await getPerformanceTable(
{
performance: createPerformance({
netPerformance: 200.000001,
netPerformanceWithCurrencyEffect: 200
})
},
{ withAssetPerformanceInBaseCurrency: true, withValues: true }
);
const [row] = result.split('\n').filter((line) => {
return line.startsWith('| 10.000%');
});
expect(row).toMatch(/\| 200\.00 \| 0\.00 \| 200\.00 \|$/);
});
it('tells that no performance is found if the chart is empty', async () => {
const result = await getPerformanceTable({ chart: [] });

235
apps/api/src/services/portfolio-table/portfolio-table.service.ts

@ -31,6 +31,17 @@ import { format } from 'date-fns';
import { DataSourceTableContext } from './interfaces/data-source-table-context.interface';
import { HoldingsTableColumnDefinition } from './types/holdings-table-column-definition.type';
const ASSET_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAME =
'Asset Performance in Base Currency';
const CURRENCY_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAME =
'Currency Performance in Base Currency';
const ASSET_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAMES = [
ASSET_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAME,
CURRENCY_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAME
];
const DATA_SOURCE_COLUMN_NAME = 'Data Source';
function getDataSourceColumnDefinition<T>(
@ -48,15 +59,21 @@ function getDataSourceColumnDefinition<T>(
};
}
function getAmount(value: number) {
const amount = value.toFixed(2);
return Number.parseFloat(amount) === 0 ? (0).toFixed(2) : amount;
}
function getPercentage(value: number) {
return `${(value * 100).toFixed(3)}%`;
}
/**
* Renders the accounts, the activities, the holdings and the performance of a
* portfolio and the watchlist of its user as a markdown table. No table has a
* column with a quantity or with a monetary value, except the unit price of an
* activity.
* portfolio and the watchlist of its user as a markdown table. A column with a
* quantity or with a monetary value, except the unit price of an activity, is
* given only with the values.
*/
@Injectable()
export class PortfolioTableService {
@ -108,6 +125,24 @@ export class PortfolioTableService {
}
];
private static readonly ACCOUNTS_TABLE_VALUE_COLUMN_DEFINITIONS: TableColumnDefinition<AccountWithValue>[] =
[
{
align: 'right',
getValue: ({ balance }) => {
return balance.toString();
},
name: 'Balance'
},
{
align: 'right',
getValue: ({ valueInBaseCurrency }) => {
return getAmount(valueInBaseCurrency);
},
name: 'Value in Base Currency'
}
];
private static readonly ACTIVITIES_TABLE_COLUMN_DEFINITIONS: TableColumnDefinition<
Activity,
DataSourceTableContext
@ -160,6 +195,33 @@ export class PortfolioTableService {
}
];
private static readonly ACTIVITIES_TABLE_VALUE_COLUMN_DEFINITIONS: TableColumnDefinition<
Activity,
DataSourceTableContext
>[] = [
{
align: 'right',
getValue: ({ quantity }) => {
return quantity.toString();
},
name: 'Quantity'
},
{
align: 'right',
getValue: ({ fee }) => {
return fee.toString();
},
name: 'Fee'
},
{
align: 'right',
getValue: ({ valueInBaseCurrency }) => {
return getAmount(valueInBaseCurrency);
},
name: 'Value in Base Currency'
}
];
private static readonly HOLDINGS_TABLE_COLUMN_DEFINITIONS: HoldingsTableColumnDefinition[] =
[
{
@ -221,6 +283,26 @@ export class PortfolioTableService {
}
];
private static readonly HOLDINGS_TABLE_VALUE_COLUMN_DEFINITIONS: HoldingsTableColumnDefinition[] =
[
{
align: 'right',
getValue: ({ quantity }) => {
return quantity.toString();
},
name: 'Quantity'
},
{
align: 'right',
getValue: ({ valueInBaseCurrency }) => {
return valueInBaseCurrency === undefined
? ''
: getAmount(valueInBaseCurrency);
},
name: 'Value in Base Currency'
}
];
private static readonly PERFORMANCE_TABLE_COLUMN_DEFINITIONS: TableColumnDefinition<PortfolioPerformance>[] =
[
{
@ -256,6 +338,38 @@ export class PortfolioTableService {
}
];
private static readonly PERFORMANCE_TABLE_VALUE_COLUMN_DEFINITIONS: TableColumnDefinition<PortfolioPerformance>[] =
[
{
align: 'right',
getValue: ({ currentValueInBaseCurrency }) => {
return getAmount(currentValueInBaseCurrency);
},
name: 'Value in Base Currency'
},
{
align: 'right',
getValue: ({ netPerformance }) => {
return getAmount(netPerformance);
},
name: ASSET_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAME
},
{
align: 'right',
getValue: ({ netPerformance, netPerformanceWithCurrencyEffect }) => {
return getAmount(netPerformanceWithCurrencyEffect - netPerformance);
},
name: CURRENCY_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAME
},
{
align: 'right',
getValue: ({ netPerformanceWithCurrencyEffect }) => {
return getAmount(netPerformanceWithCurrencyEffect);
},
name: 'Net Performance in Base Currency'
}
];
private static readonly WATCHLIST_TABLE_COLUMN_DEFINITIONS: TableColumnDefinition<
WatchlistResponse['watchlist'][number],
DataSourceTableContext
@ -326,6 +440,14 @@ export class PortfolioTableService {
);
}
public static getAccountsTableValueColumnNames() {
return PortfolioTableService.ACCOUNTS_TABLE_VALUE_COLUMN_DEFINITIONS.map(
({ name }) => {
return name;
}
);
}
public static getActivitiesTableColumnNames() {
return PortfolioTableService.ACTIVITIES_TABLE_COLUMN_DEFINITIONS.map(
({ name }) => {
@ -334,6 +456,18 @@ export class PortfolioTableService {
);
}
public static getActivitiesTableValueColumnNames() {
return PortfolioTableService.ACTIVITIES_TABLE_VALUE_COLUMN_DEFINITIONS.map(
({ name }) => {
return name;
}
);
}
public static getAssetPerformanceInBaseCurrencyColumnNames() {
return [...ASSET_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAMES];
}
public static getHoldingsTableColumnNames() {
return PortfolioTableService.HOLDINGS_TABLE_COLUMN_DEFINITIONS.map(
({ name }) => {
@ -342,6 +476,14 @@ export class PortfolioTableService {
);
}
public static getHoldingsTableValueColumnNames() {
return PortfolioTableService.HOLDINGS_TABLE_VALUE_COLUMN_DEFINITIONS.map(
({ name }) => {
return name;
}
);
}
public static getPerformanceTableColumnNames() {
return PortfolioTableService.PERFORMANCE_TABLE_COLUMN_DEFINITIONS.map(
({ name }) => {
@ -350,6 +492,14 @@ export class PortfolioTableService {
);
}
public static getPerformanceTableValueColumnNames() {
return PortfolioTableService.PERFORMANCE_TABLE_VALUE_COLUMN_DEFINITIONS.map(
({ name }) => {
return name;
}
);
}
public static getWatchlistTableColumnNames() {
return PortfolioTableService.WATCHLIST_TABLE_COLUMN_DEFINITIONS.map(
({ name }) => {
@ -360,10 +510,12 @@ export class PortfolioTableService {
public async getAccountsTable({
filters,
userId
userId,
withValues = false
}: {
filters?: Filter[];
userId: string;
withValues?: boolean;
}) {
const { accounts } =
await this.portfolioService.getAccountsWithAggregations({
@ -377,8 +529,13 @@ export class PortfolioTableService {
if (accounts.length > 0) {
accountsSection.push(
await getMarkdownTable({
columnDefinitions:
PortfolioTableService.ACCOUNTS_TABLE_COLUMN_DEFINITIONS,
columnDefinitions: this.getColumnDefinitions({
withValues,
columnDefinitions:
PortfolioTableService.ACCOUNTS_TABLE_COLUMN_DEFINITIONS,
valueColumnDefinitions:
PortfolioTableService.ACCOUNTS_TABLE_VALUE_COLUMN_DEFINITIONS
}),
rows: accounts
})
);
@ -397,7 +554,8 @@ export class PortfolioTableService {
take,
types,
userCurrency,
userId
userId,
withValues = false
}: {
endDate?: Date;
filters?: Filter[];
@ -407,6 +565,7 @@ export class PortfolioTableService {
types?: ActivityType[];
userCurrency: string;
userId: string;
withValues?: boolean;
}) {
const { activities, count } = await this.activitiesService.getActivities({
endDate,
@ -437,8 +596,13 @@ export class PortfolioTableService {
activitiesSection.push(
'',
await getMarkdownTable({
columnDefinitions:
PortfolioTableService.ACTIVITIES_TABLE_COLUMN_DEFINITIONS,
columnDefinitions: this.getColumnDefinitions({
withValues,
columnDefinitions:
PortfolioTableService.ACTIVITIES_TABLE_COLUMN_DEFINITIONS,
valueColumnDefinitions:
PortfolioTableService.ACTIVITIES_TABLE_VALUE_COLUMN_DEFINITIONS
}),
context: { configurationService: this.configurationService },
rows: activities
})
@ -452,12 +616,14 @@ export class PortfolioTableService {
filters,
languageCode,
userId,
withDataSource = false
withDataSource = false,
withValues = false
}: {
filters?: Filter[];
languageCode: string;
userId: string;
withDataSource?: boolean;
withValues?: boolean;
}) {
const { holdings } = await this.portfolioService.getDetails({
filters,
@ -484,12 +650,15 @@ export class PortfolioTableService {
'## Holdings',
'',
await getMarkdownTable({
columnDefinitions:
PortfolioTableService.HOLDINGS_TABLE_COLUMN_DEFINITIONS.filter(
({ name }) => {
return withDataSource || name !== DATA_SOURCE_COLUMN_NAME;
}
),
columnDefinitions: this.getColumnDefinitions({
withValues,
columnDefinitions:
PortfolioTableService.HOLDINGS_TABLE_COLUMN_DEFINITIONS,
valueColumnDefinitions:
PortfolioTableService.HOLDINGS_TABLE_VALUE_COLUMN_DEFINITIONS
}).filter(({ name }) => {
return withDataSource || name !== DATA_SOURCE_COLUMN_NAME;
}),
context: {
assetClassTranslations,
assetSubClassTranslations,
@ -503,11 +672,15 @@ export class PortfolioTableService {
public async getPerformanceTable({
dateRange,
filters,
userId
userId,
withAssetPerformanceInBaseCurrency = false,
withValues = false
}: {
dateRange: DateRange;
filters?: Filter[];
userId: string;
withAssetPerformanceInBaseCurrency?: boolean;
withValues?: boolean;
}) {
const { chart, performance } = await this.portfolioService.getPerformance({
dateRange,
@ -520,8 +693,18 @@ export class PortfolioTableService {
if (chart?.length > 0) {
performanceSection.push(
await getMarkdownTable({
columnDefinitions:
PortfolioTableService.PERFORMANCE_TABLE_COLUMN_DEFINITIONS,
columnDefinitions: this.getColumnDefinitions({
withValues,
columnDefinitions:
PortfolioTableService.PERFORMANCE_TABLE_COLUMN_DEFINITIONS,
valueColumnDefinitions:
PortfolioTableService.PERFORMANCE_TABLE_VALUE_COLUMN_DEFINITIONS
}).filter(({ name }) => {
return (
withAssetPerformanceInBaseCurrency ||
!ASSET_PERFORMANCE_IN_BASE_CURRENCY_COLUMN_NAMES.includes(name)
);
}),
rows: [performance]
})
);
@ -587,6 +770,20 @@ export class PortfolioTableService {
return `${summary} Get the further activities by raising the skip parameter or narrow the result with the other parameters.`;
}
private getColumnDefinitions<T>({
columnDefinitions,
valueColumnDefinitions,
withValues
}: {
columnDefinitions: T[];
valueColumnDefinitions: T[];
withValues: boolean;
}) {
return withValues
? [...columnDefinitions, ...valueColumnDefinitions]
: columnDefinitions;
}
private getEnumTranslations<T extends string>({
id,
languageCode,

16
apps/client/src/app/components/user-account-access/create-or-update-access-dialog/create-or-update-access-dialog.component.ts

@ -7,6 +7,7 @@ import { hasPermission, permissions } from '@ghostfolio/common/permissions';
import {
Scope,
canGrantRestrictedWriteAccess,
canGrantUnrestrictedReadAccess,
getAccessLevel,
getScopesOfAccess,
getScopesOfAccessLevel,
@ -139,6 +140,10 @@ export class GfCreateOrUpdateAccessDialogComponent implements OnInit {
return canGrantRestrictedWriteAccess({ type: this.accessType });
}
public get canGrantUnrestrictedReadAccess() {
return canGrantUnrestrictedReadAccess({ type: this.accessType });
}
public get canGrantWriteAccess() {
return this.hasExperimentalFeatures;
}
@ -202,13 +207,16 @@ export class GfCreateOrUpdateAccessDialogComponent implements OnInit {
granteeUserIdControl?.setValue(null);
}
// Narrow the permission to the scopes which the type permits, because
// an access which is not granted to a user never exposes the monetary
// values and a public access never changes data
// Narrow the permission to the scopes which the type permits and drop
// the monetary values, which have to be granted after the type
this.accessForm.get('accessLevel')?.setValue(
getAccessLevel(
getScopesOfAccess({
scopes: getScopesOfAccessLevel(this.accessLevel),
scopes: getScopesOfAccessLevel(this.accessLevel).filter(
(scope) => {
return scope !== scopes.portfolioReadValues;
}
),
type: accessType
})
)

2
apps/client/src/app/components/user-account-access/create-or-update-access-dialog/create-or-update-access-dialog.html

@ -92,7 +92,7 @@
/>
</mat-option>
}
@if (accessForm.get('type')?.value === 'PRIVATE') {
@if (canGrantUnrestrictedReadAccess) {
<mat-option value="READ">
<gf-access-level-icon accessLevel="READ" />
</mat-option>

37
libs/common/src/lib/scopes.spec.ts

@ -3,6 +3,7 @@ import {
SCOPES_OF_READ_ACCESS,
SCOPES_OF_READ_RESTRICTED_ACCESS,
SCOPES_OF_WRITE_ACCESS,
canGrantUnrestrictedReadAccess,
getAccessLevel,
getScopesOfAccess,
getScopesOfAccessLevel,
@ -239,12 +240,21 @@ describe('Scopes', () => {
expect(scopesOfAccess).toContain(scopes.watchlistRead);
});
it('Cannot expose the monetary values', () => {
it('Allows reading the monetary values', () => {
expect(
getScopesOfAccess({
scopes: [...SCOPES_OF_READ_ACCESS],
type: 'MCP'
})
).toContain(scopes.portfolioReadValues);
});
it('Without the scope to read the values', () => {
expect(
getScopesOfAccess({
scopes: [...SCOPES_OF_READ_RESTRICTED_ACCESS],
type: 'MCP'
})
).not.toContain(scopes.portfolioReadValues);
});
@ -276,6 +286,31 @@ describe('Scopes', () => {
)
).toEqual('CREATE_READ_RESTRICTED_UPDATE_DELETE');
});
it('Keeps the access level to change the data with the monetary values', () => {
expect(
getAccessLevel(
getScopesOfAccess({
scopes: getScopesOfAccessLevel('CREATE_READ_UPDATE_DELETE'),
type: 'MCP'
})
)
).toEqual('CREATE_READ_UPDATE_DELETE');
});
});
describe('Can grant unrestricted read access', () => {
it('Model context protocol', () => {
expect(canGrantUnrestrictedReadAccess({ type: 'MCP' })).toEqual(true);
});
it('Private', () => {
expect(canGrantUnrestrictedReadAccess({ type: 'PRIVATE' })).toEqual(true);
});
it('Public', () => {
expect(canGrantUnrestrictedReadAccess({ type: 'PUBLIC' })).toEqual(false);
});
});
describe('Get scopes of own access', () => {

13
libs/common/src/lib/scopes.ts

@ -68,19 +68,26 @@ export const SCOPES_OF_READ_RESTRICTED_ACCESS: readonly Scope[] =
* monetary values.
*/
const SCOPES_OF_TYPE: Record<AccessType, readonly Scope[]> = {
MCP: [...SCOPES_OF_READ_RESTRICTED_ACCESS, scopes.activityCreate],
MCP: [...SCOPES_OF_READ_ACCESS, scopes.activityCreate],
PRIVATE: Object.values(scopes),
PUBLIC: SCOPES_OF_PUBLIC_ACCESS
};
/**
* Access types which combine a write scope with the restricted read access,
* because their tools change data without exposing the monetary values
* Access types which can combine a write scope with the restricted read access,
* because their tools which change data do not expose the monetary values
*/
export function canGrantRestrictedWriteAccess({ type }: { type: AccessType }) {
return type === 'MCP';
}
/**
* Access types which can expose the monetary values
*/
export function canGrantUnrestrictedReadAccess({ type }: { type: AccessType }) {
return SCOPES_OF_TYPE[type].includes(scopes.portfolioReadValues);
}
/**
* Access level which the scopes of an access grant
*/

Loading…
Cancel
Save