Trading Assistant API Documentation - v0.1.0
    Preparing search index...

    Variable PERMISSIONSConst

    PERMISSIONS: {
        ROUTES: {
            APP_AREA: readonly ["customer", "admin", "superadmin"];
            ANALYST_AREA: readonly ["analyst", "admin", "superadmin"];
            ADMIN_AREA: readonly ["admin", "superadmin"];
            SUPERADMIN_AREA: readonly ["superadmin"];
        };
        CUSTOMER: {
            VIEW_PORTFOLIO: readonly ["customer", "admin", "superadmin"];
            VIEW_TRADES: readonly ["customer", "admin", "superadmin"];
            VIEW_PERFORMANCE: readonly ["customer", "admin", "superadmin"];
            EXECUTE_TRADES: readonly ["customer"];
            MANAGE_WATCHLIST: readonly ["customer", "admin", "superadmin"];
            SET_ALERTS: readonly ["customer", "admin", "superadmin"];
            EXPORT_DATA: readonly ["customer", "admin", "superadmin"];
        };
        ANALYST: {
            VIEW_MARKET_DATA: readonly ["analyst", "admin", "superadmin"];
            CREATE_SIGNALS: readonly ["analyst", "admin", "superadmin"];
            RUN_BACKTESTS: readonly ["analyst", "admin", "superadmin"];
            VIEW_REPORTS: readonly ["analyst", "admin", "superadmin"];
            CREATE_REPORTS: readonly ["analyst", "admin", "superadmin"];
            MANAGE_STRATEGIES: readonly ["admin", "superadmin"];
            ACCESS_RESEARCH_TOOLS: readonly ["analyst", "admin", "superadmin"];
        };
        ADMIN: {
            VIEW_CUSTOMERS: readonly ["admin", "superadmin"];
            IMPERSONATE_USERS: readonly ["admin", "superadmin"];
            MANAGE_WORKFLOWS: readonly ["admin", "superadmin"];
            VIEW_DATA_PIPELINE: readonly ["admin", "superadmin"];
            MANAGE_CONTENT: readonly ["admin", "superadmin"];
            VIEW_ANALYTICS: readonly ["admin", "superadmin"];
            MANAGE_USERS: readonly ["superadmin"];
        };
        SUPERADMIN: {
            SYSTEM_CONFIG: readonly ["superadmin"];
            USER_MANAGEMENT_ALL: readonly ["superadmin"];
            DATABASE_ADMIN: readonly ["superadmin"];
            BILLING_MANAGEMENT: readonly ["superadmin"];
            DEPLOYMENT_CONTROLS: readonly ["superadmin"];
            VIEW_AUDIT_LOGS: readonly ["superadmin"];
            SECURITY_SETTINGS: readonly ["superadmin"];
        };
        DASHBOARD: {
            HOME: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
            PORTFOLIO: readonly ["customer", "superadmin"];
            WORKFLOWS: readonly ["admin", "superadmin"];
            REPORTS: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
            ANALYTICS: readonly ["analyst", "admin", "superadmin"];
            ALERTS: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
            CUSTOMERS: readonly ["admin", "superadmin"];
            ADMIN_DASHBOARD: readonly ["admin", "superadmin"];
            SETTINGS: readonly [
                "viewer",
                "customer",
                "analyst",
                "admin",
                "superadmin",
            ];
        };
    } = ...

    Permission Definitions

    Defines what each role can do in the system. Always use these constants for permission checks.

    Type Declaration

    • ReadonlyROUTES: {
          APP_AREA: readonly ["customer", "admin", "superadmin"];
          ANALYST_AREA: readonly ["analyst", "admin", "superadmin"];
          ADMIN_AREA: readonly ["admin", "superadmin"];
          SUPERADMIN_AREA: readonly ["superadmin"];
      }
    • ReadonlyCUSTOMER: {
          VIEW_PORTFOLIO: readonly ["customer", "admin", "superadmin"];
          VIEW_TRADES: readonly ["customer", "admin", "superadmin"];
          VIEW_PERFORMANCE: readonly ["customer", "admin", "superadmin"];
          EXECUTE_TRADES: readonly ["customer"];
          MANAGE_WATCHLIST: readonly ["customer", "admin", "superadmin"];
          SET_ALERTS: readonly ["customer", "admin", "superadmin"];
          EXPORT_DATA: readonly ["customer", "admin", "superadmin"];
      }
    • ReadonlyANALYST: {
          VIEW_MARKET_DATA: readonly ["analyst", "admin", "superadmin"];
          CREATE_SIGNALS: readonly ["analyst", "admin", "superadmin"];
          RUN_BACKTESTS: readonly ["analyst", "admin", "superadmin"];
          VIEW_REPORTS: readonly ["analyst", "admin", "superadmin"];
          CREATE_REPORTS: readonly ["analyst", "admin", "superadmin"];
          MANAGE_STRATEGIES: readonly ["admin", "superadmin"];
          ACCESS_RESEARCH_TOOLS: readonly ["analyst", "admin", "superadmin"];
      }
    • ReadonlyADMIN: {
          VIEW_CUSTOMERS: readonly ["admin", "superadmin"];
          IMPERSONATE_USERS: readonly ["admin", "superadmin"];
          MANAGE_WORKFLOWS: readonly ["admin", "superadmin"];
          VIEW_DATA_PIPELINE: readonly ["admin", "superadmin"];
          MANAGE_CONTENT: readonly ["admin", "superadmin"];
          VIEW_ANALYTICS: readonly ["admin", "superadmin"];
          MANAGE_USERS: readonly ["superadmin"];
      }
    • ReadonlySUPERADMIN: {
          SYSTEM_CONFIG: readonly ["superadmin"];
          USER_MANAGEMENT_ALL: readonly ["superadmin"];
          DATABASE_ADMIN: readonly ["superadmin"];
          BILLING_MANAGEMENT: readonly ["superadmin"];
          DEPLOYMENT_CONTROLS: readonly ["superadmin"];
          VIEW_AUDIT_LOGS: readonly ["superadmin"];
          SECURITY_SETTINGS: readonly ["superadmin"];
      }
    • ReadonlyDASHBOARD: {
          HOME: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
          PORTFOLIO: readonly ["customer", "superadmin"];
          WORKFLOWS: readonly ["admin", "superadmin"];
          REPORTS: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
          ANALYTICS: readonly ["analyst", "admin", "superadmin"];
          ALERTS: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
          CUSTOMERS: readonly ["admin", "superadmin"];
          ADMIN_DASHBOARD: readonly ["admin", "superadmin"];
          SETTINGS: readonly ["viewer", "customer", "analyst", "admin", "superadmin"];
      }