src/routes/routes.ts

   1 // Copyright (C) The Arvados Authors. All rights reserved.
   2 //
   3 // SPDX-License-Identifier: AGPL-3.0
   4
   5 import { matchPath } from 'react-router';
   6 import { ResourceKind, RESOURCE_UUID_PATTERN, extractUuidKind } from '~/models/resource';
   7 import { getProjectUrl } from '~/models/project';
   8 import { getCollectionUrl } from '~/models/collection';
   9
  10 export const Routes = {
  11     ROOT: '/',
  12     TOKEN: '/token',
  13     PROJECTS: `/projects/:id(${RESOURCE_UUID_PATTERN})`,
  14     COLLECTIONS: `/collections/:id(${RESOURCE_UUID_PATTERN})`,
  15     PROCESSES: `/processes/:id(${RESOURCE_UUID_PATTERN})`,
  16     FAVORITES: '/favorites',
  17     TRASH: '/trash',
  18     PROCESS_LOGS: `/process-logs/:id(${RESOURCE_UUID_PATTERN})`,
  19     REPOSITORIES: '/repositories',
  20     SHARED_WITH_ME: '/shared-with-me',
  21     RUN_PROCESS: '/run-process',
  22     VIRTUAL_MACHINES_ADMIN: '/virtual-machines-admin',
  23     VIRTUAL_MACHINES_USER: '/virtual-machines-user',
  24     WORKFLOWS: '/workflows',
  25     SEARCH_RESULTS: '/search-results',
  26     SSH_KEYS_ADMIN: `/ssh-keys-admin`,
  27     SSH_KEYS_USER: `/ssh-keys-user`,
  28     SITE_MANAGER: `/site-manager`,
  29     MY_ACCOUNT: '/my-account',
  30     KEEP_SERVICES: `/keep-services`,
  31     COMPUTE_NODES: `/nodes`,
  32     USERS: '/users',
  33     API_CLIENT_AUTHORIZATIONS: `/api_client_authorizations`,
  34     GROUPS: '/groups',
  35     GROUP_DETAILS: `/group/:id(${RESOURCE_UUID_PATTERN})`,
  36     LINKS: '/links',
  37     PUBLIC_FAVORITES: '/public-favorites'
  38 };
  39
  40 export const getResourceUrl = (uuid: string) => {
  41     const kind = extractUuidKind(uuid);
  42     switch (kind) {
  43         case ResourceKind.PROJECT:
  44             return getProjectUrl(uuid);
  45         case ResourceKind.COLLECTION:
  46             return getCollectionUrl(uuid);
  47         case ResourceKind.PROCESS:
  48             return getProcessUrl(uuid);
  49         default:
  50             return undefined;
  51     }
  52 };
  53
  54 export const getProcessUrl = (uuid: string) => `/processes/${uuid}`;
  55
  56 export const getProcessLogUrl = (uuid: string) => `/process-logs/${uuid}`;
  57
  58 export const getGroupUrl = (uuid: string) => `/group/${uuid}`;
  59
  60 export interface ResourceRouteParams {
  61     id: string;
  62 }
  63
  64 export const matchRootRoute = (route: string) =>
  65     matchPath(route, { path: Routes.ROOT, exact: true });
  66
  67 export const matchFavoritesRoute = (route: string) =>
  68     matchPath(route, { path: Routes.FAVORITES });
  69
  70 export const matchTrashRoute = (route: string) =>
  71     matchPath(route, { path: Routes.TRASH });
  72
  73 export const matchProjectRoute = (route: string) =>
  74     matchPath<ResourceRouteParams>(route, { path: Routes.PROJECTS });
  75
  76 export const matchCollectionRoute = (route: string) =>
  77     matchPath<ResourceRouteParams>(route, { path: Routes.COLLECTIONS });
  78
  79 export const matchProcessRoute = (route: string) =>
  80     matchPath<ResourceRouteParams>(route, { path: Routes.PROCESSES });
  81
  82 export const matchProcessLogRoute = (route: string) =>
  83     matchPath<ResourceRouteParams>(route, { path: Routes.PROCESS_LOGS });
  84
  85 export const matchSharedWithMeRoute = (route: string) =>
  86     matchPath(route, { path: Routes.SHARED_WITH_ME });
  87
  88 export const matchRunProcessRoute = (route: string) =>
  89     matchPath(route, { path: Routes.RUN_PROCESS });
  90
  91 export const matchWorkflowRoute = (route: string) =>
  92     matchPath<ResourceRouteParams>(route, { path: Routes.WORKFLOWS });
  93
  94 export const matchSearchResultsRoute = (route: string) =>
  95     matchPath<ResourceRouteParams>(route, { path: Routes.SEARCH_RESULTS });
  96
  97 export const matchUserVirtualMachineRoute = (route: string) =>
  98     matchPath<ResourceRouteParams>(route, { path: Routes.VIRTUAL_MACHINES_USER });
  99
 100 export const matchAdminVirtualMachineRoute = (route: string) =>
 101     matchPath<ResourceRouteParams>(route, { path: Routes.VIRTUAL_MACHINES_ADMIN });
 102
 103 export const matchRepositoriesRoute = (route: string) =>
 104     matchPath<ResourceRouteParams>(route, { path: Routes.REPOSITORIES });
 105
 106 export const matchSshKeysUserRoute = (route: string) =>
 107     matchPath(route, { path: Routes.SSH_KEYS_USER });
 108
 109 export const matchSshKeysAdminRoute = (route: string) =>
 110     matchPath(route, { path: Routes.SSH_KEYS_ADMIN });
 111
 112 export const matchSiteManagerRoute = (route: string) =>
 113     matchPath(route, { path: Routes.SITE_MANAGER });
 114
 115 export const matchMyAccountRoute = (route: string) =>
 116     matchPath(route, { path: Routes.MY_ACCOUNT });
 117
 118 export const matchKeepServicesRoute = (route: string) =>
 119     matchPath(route, { path: Routes.KEEP_SERVICES });
 120
 121 export const matchUsersRoute = (route: string) =>
 122     matchPath(route, { path: Routes.USERS });
 123
 124 export const matchComputeNodesRoute = (route: string) =>
 125     matchPath(route, { path: Routes.COMPUTE_NODES });
 126
 127 export const matchApiClientAuthorizationsRoute = (route: string) =>
 128     matchPath(route, { path: Routes.API_CLIENT_AUTHORIZATIONS });
 129
 130 export const matchGroupsRoute = (route: string) =>
 131     matchPath(route, { path: Routes.GROUPS });
 132
 133 export const matchGroupDetailsRoute = (route: string) =>
 134     matchPath<ResourceRouteParams>(route, { path: Routes.GROUP_DETAILS });
 135
 136 export const matchLinksRoute = (route: string) =>
 137     matchPath(route, { path: Routes.LINKS });
 138
 139 export const matchPublicFavorites = (route: string) =>
 140     matchPath(route, { path: Routes.PUBLIC_FAVORITES });