ghostfolio/libs/common/src/lib/routes/routes.ts

import { User } from '@ghostfolio/common/interfaces';
import { hasPermission, permissions } from '@ghostfolio/common/permissions';

import { InternalRoute } from './interfaces/internal-route.interface';
import { PublicRoute } from './interfaces/public-route.interface';

if (typeof window !== 'undefined') {
  import('@angular/localize/init');
} else {
  (global as any).$localize = (
    messageParts: TemplateStringsArray,
    ...expressions: any[]
  ) => {
    return String.raw({ raw: messageParts }, ...expressions);
  };
}

export const internalRoutes: Record<string, InternalRoute> = {
  account: {
    path: 'account',
    routerLink: ['/account'],
    subRoutes: {
      access: {
        path: 'access',
        routerLink: ['/account', 'access'],
        title: $localize`Access`
      },
      membership: {
        path: 'membership',
        routerLink: ['/account', 'membership'],
        title: $localize`Membership`
      }
    },
    title: $localize`Settings`
  },
  adminControl: {
    excludeFromAssistant: (aUser: User) => {
      return hasPermission(aUser?.permissions, permissions.accessAdminControl);
    },
    path: 'admin',
    routerLink: ['/admin'],
    subRoutes: {
      jobs: {
        path: 'jobs',
        routerLink: ['/admin', 'jobs'],
        title: $localize`Job Queue`
      },
      marketData: {
        path: 'market-data',
        routerLink: ['/admin', 'market-data'],
        title: $localize`Market Data`
      },
      settings: {
        path: 'settings',
        routerLink: ['/admin', 'settings'],
        title: $localize`Settings`
      },
      users: {
        path: 'users',
        routerLink: ['/admin', 'users'],
        title: $localize`Users`
      }
    },
    title: $localize`Admin Control`
  },
  accounts: {
    path: 'accounts',
    routerLink: ['/accounts'],
    title: $localize`Accounts`
  },
  api: {
    excludeFromAssistant: true,
    path: 'api',
    routerLink: ['/api'],
    title: 'Ghostfolio API'
  },
  auth: {
    excludeFromAssistant: true,
    path: 'auth',
    routerLink: ['/auth'],
    title: $localize`Sign in`
  },
  home: {
    path: 'home',
    routerLink: ['/home'],
    subRoutes: {
      holdings: {
        path: 'holdings',
        routerLink: ['/home', 'holdings'],
        title: $localize`Holdings`
      },
      markets: {
        path: 'markets',
        routerLink: ['/home', 'markets'],
        title: $localize`Markets`
      },
      marketsPremium: {
        path: 'markets-premium',
        routerLink: ['/home', 'markets-premium'],
        title: $localize`Markets`
      },
      summary: {
        path: 'summary',
        routerLink: ['/home', 'summary'],
        title: $localize`Summary`
      },
      watchlist: {
        path: 'watchlist',
        routerLink: ['/home', 'watchlist'],
        title: $localize`Watchlist`
      }
    },
    title: $localize`Overview`
  },
  i18n: {
    excludeFromAssistant: true,
    path: 'i18n',
    routerLink: ['/i18n'],
    title: $localize`Internationalization`
  },
  portfolio: {
    path: 'portfolio',
    routerLink: ['/portfolio'],
    subRoutes: {
      activities: {
        path: 'activities',
        routerLink: ['/portfolio', 'activities'],
        title: $localize`Activities`
      },
      allocations: {
        path: 'allocations',
        routerLink: ['/portfolio', 'allocations'],
        title: $localize`Allocations`
      },
      analysis: {
        path: undefined, // Default sub route
        routerLink: ['/portfolio'],
        title: $localize`Analysis`
      },
      fire: {
        path: 'fire',
        routerLink: ['/portfolio', 'fire'],
        title: 'FIRE'
      },
      xRay: {
        path: 'x-ray',
        routerLink: ['/portfolio', 'x-ray'],
        title: 'X-ray'
      }
    },
    title: $localize`Portfolio`
  },
  webauthn: {
    excludeFromAssistant: true,
    path: 'webauthn',
    routerLink: ['/webauthn'],
    title: $localize`Sign in`
  },
  zen: {
    excludeFromAssistant: true,
    path: 'zen',
    routerLink: ['/zen'],
    subRoutes: {
      holdings: {
        path: 'holdings',
        routerLink: ['/zen', 'holdings'],
        title: $localize`Holdings`
      }
    },
    title: $localize`Overview`
  }
};

export const publicRoutes: Record<string, PublicRoute> = {
  about: {
    path: $localize`:kebab-case@@routes.about:about`,
    routerLink: ['/' + $localize`:kebab-case@@routes.about:about`],
    subRoutes: {
      changelog: {
        path: $localize`:kebab-case@@routes.about.changelog:changelog`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.about:about`,
          $localize`:kebab-case@@routes.about.changelog:changelog`
        ],
        title: $localize`Changelog`
      },
      license: {
        path: $localize`:kebab-case@@routes.about.license:license`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.about:about`,
          $localize`:kebab-case@@routes.about.license:license`
        ],
        title: $localize`License`
      },
      ossFriends: {
        path: 'oss-friends',
        routerLink: [
          '/' + $localize`:kebab-case@@routes.about:about`,
          'oss-friends'
        ],
        title: 'OSS Friends'
      },
      privacyPolicy: {
        path: $localize`:kebab-case@@routes.about.privacyPolicy:privacy-policy`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.about:about`,
          $localize`:kebab-case@@routes.about.privacyPolicy:privacy-policy`
        ],
        title: $localize`Privacy Policy`
      },
      termsOfService: {
        path: $localize`:kebab-case@@routes.about.termsOfService:terms-of-service`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.about:about`,
          $localize`:kebab-case@@routes.about.termsOfService:terms-of-service`
        ],
        title: $localize`Terms of Service`
      }
    },
    title: $localize`About`
  },
  blog: {
    path: 'blog',
    routerLink: ['/blog'],
    title: $localize`Blog`
  },
  demo: {
    excludeFromSitemap: true,
    path: 'demo',
    routerLink: ['/demo'],
    title: $localize`Live Demo`
  },
  faq: {
    path: $localize`:kebab-case@@routes.faq:faq`,
    routerLink: ['/' + $localize`:kebab-case@@routes.faq:faq`],
    subRoutes: {
      saas: {
        path: 'saas',
        routerLink: ['/' + $localize`:kebab-case@@routes.faq:faq`, 'saas'],
        title: $localize`Cloud` + ' (SaaS)'
      },
      selfHosting: {
        path: $localize`:kebab-case@@routes.faq.selfHosting:self-hosting`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.faq:faq`,
          $localize`:kebab-case@@routes.faq.selfHosting:self-hosting`
        ],
        title: $localize`Self-Hosting`
      }
    },
    title: $localize`Frequently Asked Questions (FAQ)`
  },
  features: {
    path: $localize`:kebab-case@@routes.features:features`,
    routerLink: ['/' + $localize`:kebab-case@@routes.features:features`],
    title: $localize`Features`
  },
  markets: {
    path: $localize`:kebab-case@@routes.markets:markets`,
    routerLink: ['/' + $localize`:kebab-case@@routes.markets:markets`],
    title: $localize`Markets`
  },
  openStartup: {
    path: 'open',
    routerLink: ['/open'],
    title: 'Open Startup'
  },
  pricing: {
    path: $localize`:kebab-case@@routes.pricing:pricing`,
    routerLink: ['/' + $localize`:kebab-case@@routes.pricing:pricing`],
    title: $localize`Pricing`
  },
  public: {
    excludeFromSitemap: true,
    path: 'p',
    routerLink: ['/p']
  },
  register: {
    path: $localize`:kebab-case@@routes.register:register`,
    routerLink: ['/' + $localize`:kebab-case@@routes.register:register`],
    title: $localize`Registration`
  },
  resources: {
    path: $localize`:kebab-case@@routes.resources:resources`,
    routerLink: ['/' + $localize`:kebab-case@@routes.resources:resources`],
    subRoutes: {
      glossary: {
        path: $localize`:kebab-case@@routes.resources.glossary:glossary`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.resources:resources`,
          $localize`:kebab-case@@routes.resources.glossary:glossary`
        ],
        title: $localize`Glossary`
      },
      guides: {
        path: $localize`:kebab-case@@routes.resources.guides:guides`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.resources:resources`,
          $localize`:kebab-case@@routes.resources.guides:guides`
        ],
        title: $localize`Guides`
      },
      markets: {
        path: $localize`:kebab-case@@routes.resources.markets:markets`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.resources:resources`,
          $localize`:kebab-case@@routes.resources.markets:markets`
        ],
        title: $localize`Markets`
      },
      personalFinanceTools: {
        path: $localize`:kebab-case@@routes.resources.personalFinanceTools:personal-finance-tools`,
        routerLink: [
          '/' + $localize`:kebab-case@@routes.resources:resources`,
          $localize`:kebab-case@@routes.resources.personalFinanceTools:personal-finance-tools`
        ],
        subRoutes: {
          product: {
            excludeFromSitemap: true,
            path: $localize`:kebab-case@@routes.resources.personalFinanceTools.openSourceAlternativeTo:open-source-alternative-to`,
            routerLink: [
              '/' + $localize`:kebab-case@@routes.resources:resources`,
              $localize`:kebab-case@@routes.resources.personalFinanceTools:personal-finance-tools`,
              $localize`:kebab-case@@routes.resources.personalFinanceTools.openSourceAlternativeTo:open-source-alternative-to`
            ],
            title: $localize`Open Source Alternative to`
          }
        },
        title: $localize`Personal Finance Tools`
      }
    },
    title: $localize`Resources`
  },
  start: {
    excludeFromSitemap: true,
    path: $localize`:kebab-case@@routes.start:start`,
    routerLink: ['/' + $localize`:kebab-case@@routes.start:start`]
  }
};