Skip to content

Open Source Wealth Management Software. Angular + NestJS + Prisma + Nx + TypeScript 🤍

7.3 KB
Raw Blame
import { UserWithSettings } from '@ghostfolio/common/types';
import { Role } from '@ghostfolio/prisma/enums';

export const permissions = {
  accessAdminControl: 'accessAdminControl',
  accessAdminControlBullBoard: 'accessAdminControlBullBoard',
  accessAssistant: 'accessAssistant',
  accessHoldingsChart: 'accessHoldingsChart',
  createAccess: 'createAccess',
  createAccount: 'createAccount',
  createAccountBalance: 'createAccountBalance',
  createActivity: 'createActivity',
  createApiKey: 'createApiKey',
  createAssetProfileSplit: 'createAssetProfileSplit',
  createAssetProfileSplitOfOwnAssetProfile:
    'createAssetProfileSplitOfOwnAssetProfile',
  createMarketData: 'createMarketData',
  createMarketDataOfOwnAssetProfile: 'createMarketDataOfOwnAssetProfile',
  createOwnTag: 'createOwnTag',
  createPlatform: 'createPlatform',
  createTag: 'createTag',
  createUserAccount: 'createUserAccount',
  createWatchlistItem: 'createWatchlistItem',
  deleteAccess: 'deleteAccess',
  deleteAccount: 'deleteAccount',
  deleteAccountBalance: 'deleteAccountBalance',
  deleteActivity: 'deleteActivity',
  deleteAssetProfileSplit: 'deleteAssetProfileSplit',
  deleteAssetProfileSplitOfOwnAssetProfile:
    'deleteAssetProfileSplitOfOwnAssetProfile',
  deleteAuthDevice: 'deleteAuthDevice',
  deleteOwnUser: 'deleteOwnUser',
  deletePlatform: 'deletePlatform',
  deleteTag: 'deleteTag',
  deleteUser: 'deleteUser',
  deleteWatchlistItem: 'deleteWatchlistItem',
  enableAuthGoogle: 'enableAuthGoogle',
  enableAuthOidc: 'enableAuthOidc',
  enableAuthToken: 'enableAuthToken',
  enableDataProviderGhostfolio: 'enableDataProviderGhostfolio',
  enableFearAndGreedIndex: 'enableFearAndGreedIndex',
  enableGhostfolioAi: 'enableGhostfolioAi',
  enableImport: 'enableImport',
  enableMcp: 'enableMcp',
  enableBlog: 'enableBlog',
  enableStatistics: 'enableStatistics',
  enableSubscription: 'enableSubscription',
  enableSubscriptionInterstitial: 'enableSubscriptionInterstitial',
  enableSystemMessage: 'enableSystemMessage',
  impersonateAllUsers: 'impersonateAllUsers',
  readAiPrompt: 'readAiPrompt',
  readMarketData: 'readMarketData',
  readMarketDataOfMarkets: 'readMarketDataOfMarkets',
  readMarketDataOfOwnAssetProfile: 'readMarketDataOfOwnAssetProfile',
  readPlatforms: 'readPlatforms',
  readPlatformsWithAccountCount: 'readPlatformsWithAccountCount',
  readTags: 'readTags',
  readWatchlist: 'readWatchlist',
  reportDataGlitch: 'reportDataGlitch',
  requestOwnUserDeletion: 'requestOwnUserDeletion',
  syncDemoUserAccount: 'syncDemoUserAccount',
  toggleReadOnlyMode: 'toggleReadOnlyMode',
  updateAccount: 'updateAccount',
  updateAccess: 'updateAccess',
  updateActivity: 'updateActivity',
  updateAuthDevice: 'updateAuthDevice',
  updateMarketData: 'updateMarketData',
  updateMarketDataOfOwnAssetProfile: 'updateMarketDataOfOwnAssetProfile',
  updateOwnAccessToken: 'updateOwnAccessToken',
  updatePlatform: 'updatePlatform',
  updateTag: 'updateTag',
  updateUserSettings: 'updateUserSettings',
  updateViewMode: 'updateViewMode'
} as const;

export function getPermissions(aRole: Role): string[] {
  switch (aRole) {
    case 'ADMIN':
      return [
        permissions.accessAdminControl,
        permissions.accessAssistant,
        permissions.accessHoldingsChart,
        permissions.createAccess,
        permissions.createAccount,
        permissions.createAccountBalance,
        permissions.createActivity,
        permissions.createWatchlistItem,
        permissions.deleteAccountBalance,
        permissions.deleteWatchlistItem,
        permissions.createAssetProfileSplit,
        permissions.createAssetProfileSplitOfOwnAssetProfile,
        permissions.createMarketData,
        permissions.createMarketDataOfOwnAssetProfile,
        permissions.createOwnTag,
        permissions.createPlatform,
        permissions.createTag,
        permissions.deleteAccess,
        permissions.deleteAccount,
        permissions.deleteActivity,
        permissions.deleteAssetProfileSplit,
        permissions.deleteAssetProfileSplitOfOwnAssetProfile,
        permissions.deleteAuthDevice,
        permissions.deletePlatform,
        permissions.deleteTag,
        permissions.deleteUser,
        permissions.readAiPrompt,
        permissions.readMarketData,
        permissions.readMarketDataOfOwnAssetProfile,
        permissions.readPlatforms,
        permissions.readPlatformsWithAccountCount,
        permissions.readTags,
        permissions.readWatchlist,
        permissions.updateAccount,
        permissions.updateAccess,
        permissions.updateActivity,
        permissions.updateAuthDevice,
        permissions.updateMarketData,
        permissions.updateMarketDataOfOwnAssetProfile,
        permissions.updatePlatform,
        permissions.updateTag,
        permissions.updateUserSettings,
        permissions.updateViewMode
      ];

    case 'DEMO':
      return [
        permissions.accessAssistant,
        permissions.accessHoldingsChart,
        permissions.createUserAccount,
        permissions.readAiPrompt,
        permissions.readWatchlist
      ];

    case 'USER':
      return [
        permissions.accessAssistant,
        permissions.accessHoldingsChart,
        permissions.createAccess,
        permissions.createAccount,
        permissions.createAccountBalance,
        permissions.createActivity,
        // TODO: Grant createAssetProfileSplitOfOwnAssetProfile and
        // deleteAssetProfileSplitOfOwnAssetProfile once the stock splits
        // feature is no longer experimental
        permissions.createMarketDataOfOwnAssetProfile,
        permissions.createOwnTag,
        permissions.createWatchlistItem,
        permissions.deleteAccess,
        permissions.deleteAccount,
        permissions.deleteAccountBalance,
        permissions.deleteActivity,
        permissions.deleteAuthDevice,
        permissions.deleteWatchlistItem,
        permissions.readAiPrompt,
        permissions.readMarketDataOfOwnAssetProfile,
        permissions.readPlatforms,
        permissions.readWatchlist,
        permissions.updateAccount,
        permissions.updateAccess,
        permissions.updateActivity,
        permissions.updateAuthDevice,
        permissions.updateMarketDataOfOwnAssetProfile,
        permissions.updateUserSettings,
        permissions.updateViewMode
      ];

    default:
      return [];
  }
}

export function filterGlobalPermissions(
  aGlobalPermissions: string[],
  aUtmSource: 'ios' | 'trusted-web-activity'
) {
  const globalPermissions = aGlobalPermissions;

  if (aUtmSource === 'ios') {
    return globalPermissions.filter((permission) => {
      return (
        permission !== permissions.enableAuthGoogle &&
        permission !== permissions.enableAuthOidc &&
        permission !== permissions.enableSubscription
      );
    });
  } else if (aUtmSource === 'trusted-web-activity') {
    return globalPermissions.filter((permission) => {
      return permission !== permissions.enableSubscription;
    });
  }

  return globalPermissions;
}

export function hasPermission(
  aPermissions: string[] = [],
  aPermission: string
) {
  return aPermissions.includes(aPermission);
}

export function hasRole(aUser: UserWithSettings, aRole: Role) {
  return aUser?.role === aRole;
}

export function isRestrictedView(aUser: UserWithSettings) {
  if (!aUser) {
    return true;
  }

  return aUser?.settings?.settings?.isRestrictedView ?? false;
}