buster/apps/web/src/routes/busterRoutes/busterAppRoutes.ts

import type { DashboardFileViewSecondary, MetricFileViewSecondary } from '@/layouts/ChatLayout';

export enum BusterAppRoutes {
  APP_HOME = '/app/home',
  APP_COLLECTIONS = '/app/collections',
  APP_COLLECTIONS_ID = '/app/collections/:collectionId',
  APP_METRIC = '/app/metrics',
  APP_METRIC_ID_CHART = '/app/metrics/:metricId/chart?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_METRIC_ID_RESULTS = '/app/metrics/:metricId/results?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_METRIC_ID_SQL = '/app/metrics/:metricId/sql?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_DASHBOARDS = '/app/dashboards',
  APP_DASHBOARD_ID = '/app/dashboards/:dashboardId?secondary_view=:secondaryView&dashboard_version_number=:dashboardVersionNumber',
  APP_DASHBOARD_ID_FILE = '/app/dashboards/:dashboardId/file?dashboard_version_number=:dashboardVersionNumber&secondary_view=:secondaryView',
  APP_LOGS = '/app/logs',
  APP_DATASETS = '/app/datasets',
  APP_DATASETS_ID = '/app/datasets/:datasetId',
  APP_DATASETS_ID_OVERVIEW = '/app/datasets/:datasetId/overview',
  APP_DATASETS_ID_PERMISSIONS_OVERVIEW = '/app/datasets/:datasetId/permissions/overview',
  APP_DATASETS_ID_PERMISSIONS_PERMISSION_GROUPS = '/app/datasets/:datasetId/permissions/permission-groups',
  APP_DATASETS_ID_PERMISSIONS_USERS = '/app/datasets/:datasetId/permissions/users',
  APP_DATASETS_ID_PERMISSIONS_DATASET_GROUPS = '/app/datasets/:datasetId/permissions/dataset-groups',
  APP_DATASETS_ID_EDITOR = '/app/datasets/:datasetId/editor',
  APP_TERMS = '/app/terms',
  APP_TERMS_ID = '/app/terms/:termId',

  APP_CHAT = '/app/chats',
  APP_CHAT_ID = '/app/chats/:chatId',
  APP_CHAT_ID_REASONING_ID = '/app/chats/:chatId/reasoning/:messageId',
  APP_CHAT_ID_METRIC_ID = '/app/chats/:chatId/metrics/:metricId?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_CHAT_ID_METRIC_ID_CHART = '/app/chats/:chatId/metrics/:metricId/chart?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_CHAT_ID_METRIC_ID_SQL = '/app/chats/:chatId/metrics/:metricId/sql?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_CHAT_ID_METRIC_ID_RESULTS = '/app/chats/:chatId/metrics/:metricId/results?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber',
  APP_CHAT_ID_COLLECTION_ID = '/app/chats/:chatId/collections/:collectionId',
  APP_CHAT_ID_DASHBOARD_ID = '/app/chats/:chatId/dashboards/:dashboardId?secondary_view=:secondaryView&dashboard_version_number=:dashboardVersionNumber',
  APP_CHAT_ID_DASHBOARD_ID_FILE = '/app/chats/:chatId/dashboards/:dashboardId/file?secondary_view=:secondaryView&dashboard_version_number=:dashboardVersionNumber',
  APP_CHAT_ID_DASHBOARD_ID_METRIC_ID = '/app/chats/:chatId/dashboards/:dashboardId/metric_files/:metricId?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber&dashboard_version_number=:dashboardVersionNumber',
  APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_CHART = '/app/chats/:chatId/dashboards/:dashboardId/metrics/:metricId/chart?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber&dashboard_version_number=:dashboardVersionNumber',
  APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_SQL = '/app/chats/:chatId/dashboards/:dashboardId/metrics/:metricId/sql?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber&dashboard_version_number=:dashboardVersionNumber',
  APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_RESULTS = '/app/chats/:chatId/dashboards/:dashboardId/metrics/:metricId/results?secondary_view=:secondaryView&metric_version_number=:metricVersionNumber&dashboard_version_number=:dashboardVersionNumber',
  APP_CHAT_ID_DATASET_ID = '/app/chats/:chatId/datasets/:datasetId',
  APP_CHAT_ID_TERM_ID = '/app/chats/:chatId/term/:termId',
  APP_CHAT_ID_VALUE_ID = '/app/chats/:chatId/value/:valueId',
  APP_VALUE_ID = '/app/value/:valueId',
  NEW_USER = '/app/new-user'
}

export type BusterAppRoutesWithArgs = {
  [BusterAppRoutes.APP_HOME]: { route: BusterAppRoutes.APP_HOME };
  [BusterAppRoutes.APP_COLLECTIONS]: { route: BusterAppRoutes.APP_COLLECTIONS };
  [BusterAppRoutes.APP_COLLECTIONS_ID]: {
    route: BusterAppRoutes.APP_COLLECTIONS_ID;
    collectionId: string;
  };
  [BusterAppRoutes.APP_METRIC]: {
    route: BusterAppRoutes.APP_METRIC;
  };
  [BusterAppRoutes.APP_METRIC_ID_CHART]: {
    route: BusterAppRoutes.APP_METRIC_ID_CHART;
    metricId: string;
    metricVersionNumber?: number;
    secondaryView?: MetricFileViewSecondary;
  };
  [BusterAppRoutes.APP_METRIC_ID_SQL]: {
    route: BusterAppRoutes.APP_METRIC_ID_SQL;
    metricId: string;
    metricVersionNumber?: number;
  };
  [BusterAppRoutes.APP_METRIC_ID_RESULTS]: {
    route: BusterAppRoutes.APP_METRIC_ID_RESULTS;
    metricId: string;
    metricVersionNumber?: number;
    secondaryView?: MetricFileViewSecondary | null;
  };
  [BusterAppRoutes.APP_DASHBOARDS]: {
    route: BusterAppRoutes.APP_DASHBOARDS;
  };
  [BusterAppRoutes.APP_DASHBOARD_ID]: {
    route: BusterAppRoutes.APP_DASHBOARD_ID;
    dashboardId: string;
    dashboardVersionNumber?: number;
    secondaryView?: DashboardFileViewSecondary;
  };
  [BusterAppRoutes.APP_DASHBOARD_ID_FILE]: {
    route: BusterAppRoutes.APP_DASHBOARD_ID_FILE;
    dashboardId: string;
    dashboardVersionNumber?: number;
  };
  [BusterAppRoutes.APP_DATASETS]: { route: BusterAppRoutes.APP_DATASETS };
  [BusterAppRoutes.APP_TERMS]: { route: BusterAppRoutes.APP_TERMS };
  [BusterAppRoutes.APP_DATASETS_ID]: { route: BusterAppRoutes.APP_DATASETS_ID; datasetId: string };
  [BusterAppRoutes.APP_LOGS]: { route: BusterAppRoutes.APP_LOGS };
  [BusterAppRoutes.APP_TERMS_ID]: { route: BusterAppRoutes.APP_TERMS_ID; termId: string };
  [BusterAppRoutes.APP_DATASETS_ID_OVERVIEW]: {
    route: BusterAppRoutes.APP_DATASETS_ID_OVERVIEW;
    datasetId: string;
  };
  [BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_OVERVIEW]: {
    route: BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_OVERVIEW;
    datasetId: string;
  };
  [BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_PERMISSION_GROUPS]: {
    route: BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_PERMISSION_GROUPS;
    datasetId: string;
  };
  [BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_USERS]: {
    route: BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_USERS;
    datasetId: string;
  };
  [BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_DATASET_GROUPS]: {
    route: BusterAppRoutes.APP_DATASETS_ID_PERMISSIONS_DATASET_GROUPS;
    datasetId: string;
  };
  [BusterAppRoutes.APP_DATASETS_ID_EDITOR]: {
    route: BusterAppRoutes.APP_DATASETS_ID_EDITOR;
    datasetId: string;
  };
  [BusterAppRoutes.NEW_USER]: { route: BusterAppRoutes.NEW_USER };
  [BusterAppRoutes.APP_CHAT]: { route: BusterAppRoutes.APP_CHAT };
  [BusterAppRoutes.APP_CHAT_ID]: { route: BusterAppRoutes.APP_CHAT_ID; chatId: string };
  [BusterAppRoutes.APP_CHAT_ID_REASONING_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_REASONING_ID;
    chatId: string;
    messageId: string;
  };
  [BusterAppRoutes.APP_CHAT_ID_METRIC_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_METRIC_ID;
    chatId: string;
    metricId: string;
    metricVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_METRIC_ID_SQL]: {
    route: BusterAppRoutes.APP_CHAT_ID_METRIC_ID_SQL;
    chatId: string;
    metricId: string;
    metricVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_METRIC_ID_CHART]: {
    route: BusterAppRoutes.APP_CHAT_ID_METRIC_ID_CHART;
    chatId: string;
    metricId: string;
    metricVersionNumber?: number;
    secondaryView?: MetricFileViewSecondary;
  };
  [BusterAppRoutes.APP_CHAT_ID_METRIC_ID_RESULTS]: {
    route: BusterAppRoutes.APP_CHAT_ID_METRIC_ID_RESULTS;
    chatId: string;
    metricId: string;
    metricVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_COLLECTION_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_COLLECTION_ID;
    chatId: string;
    collectionId: string;
  };
  [BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID;
    chatId: string;
    dashboardId: string;
    dashboardVersionNumber?: number;
    secondaryView?: DashboardFileViewSecondary;
  };
  [BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_FILE]: {
    route: BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_FILE;
    chatId: string;
    dashboardId: string;
    dashboardVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID;
    chatId: string;
    dashboardId: string;
    metricId: string;
    metricVersionNumber?: number;
    dashboardVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_CHART]: {
    route: BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_CHART;
    chatId: string;
    dashboardId: string;
    metricId: string;
    metricVersionNumber?: number;
    dashboardVersionNumber?: number;
    secondaryView?: MetricFileViewSecondary;
  };
  [BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_SQL]: {
    route: BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_SQL;
    chatId: string;
    dashboardId: string;
    metricId: string;
    metricVersionNumber?: number;
    dashboardVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_RESULTS]: {
    route: BusterAppRoutes.APP_CHAT_ID_DASHBOARD_ID_METRIC_ID_RESULTS;
    chatId: string;
    dashboardId: string;
    metricId: string;
    metricVersionNumber?: number;
    dashboardVersionNumber?: number;
  };
  [BusterAppRoutes.APP_CHAT_ID_DATASET_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_DATASET_ID;
    chatId: string;
    datasetId: string;
  };
  [BusterAppRoutes.APP_CHAT_ID_TERM_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_TERM_ID;
    chatId: string;
    termId: string;
  };
  [BusterAppRoutes.APP_CHAT_ID_VALUE_ID]: {
    route: BusterAppRoutes.APP_CHAT_ID_VALUE_ID;
    chatId: string;
    valueId: string;
  };
  [BusterAppRoutes.APP_VALUE_ID]: { route: BusterAppRoutes.APP_VALUE_ID; valueId: string };
};