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     LINK_ACCOUNT: '/link_account',
  31     KEEP_SERVICES: `/keep-services`,
  32     COMPUTE_NODES: `/nodes`,
  33     USERS: '/users',
  34     API_CLIENT_AUTHORIZATIONS: `/api_client_authorizations`,
  35     GROUPS: '/groups',
  36     GROUP_DETAILS: `/group/:id(${RESOURCE_UUID_PATTERN})`,
  37     LINKS: '/links',
  38     PUBLIC_FAVORITES: '/public-favorites'
  39 };
  40
  41 export const getResourceUrl = (uuid: string) => {
  42     const kind = extractUuidKind(uuid);
  43     switch (kind) {
  44         case ResourceKind.PROJECT:
  45             return getProjectUrl(uuid);
  46         case ResourceKind.COLLECTION:
  47             return getCollectionUrl(uuid);
  48         case ResourceKind.PROCESS:
  49             return getProcessUrl(uuid);
  50         default:
  51             return undefined;
  52     }
  53 };
  54
  55 export const getProcessUrl = (uuid: string) => `/processes/${uuid}`;
  56
  57 export const getProcessLogUrl = (uuid: string) => `/process-logs/${uuid}`;
  58
  59 export const getGroupUrl = (uuid: string) => `/group/${uuid}`;
  60
  61 export interface ResourceRouteParams {
  62     id: string;
  63 }
  64
  65 export const matchRootRoute = (route: string) =>
  66     matchPath(route, { path: Routes.ROOT, exact: true });
  67
  68 export const matchFavoritesRoute = (route: string) =>
  69     matchPath(route, { path: Routes.FAVORITES });
  70
  71 export const matchTrashRoute = (route: string) =>
  72     matchPath(route, { path: Routes.TRASH });
  73
  74 export const matchProjectRoute = (route: string) =>
  75     matchPath<ResourceRouteParams>(route, { path: Routes.PROJECTS });
  76
  77 export const matchCollectionRoute = (route: string) =>
  78     matchPath<ResourceRouteParams>(route, { path: Routes.COLLECTIONS });
  79
  80 export const matchProcessRoute = (route: string) =>
  81     matchPath<ResourceRouteParams>(route, { path: Routes.PROCESSES });
  82
  83 export const matchProcessLogRoute = (route: string) =>
  84     matchPath<ResourceRouteParams>(route, { path: Routes.PROCESS_LOGS });
  85
  86 export const matchSharedWithMeRoute = (route: string) =>
  87     matchPath(route, { path: Routes.SHARED_WITH_ME });
  88
  89 export const matchRunProcessRoute = (route: string) =>
  90     matchPath(route, { path: Routes.RUN_PROCESS });
  91
  92 export const matchWorkflowRoute = (route: string) =>
  93     matchPath<ResourceRouteParams>(route, { path: Routes.WORKFLOWS });
  94
  95 export const matchSearchResultsRoute = (route: string) =>
  96     matchPath<ResourceRouteParams>(route, { path: Routes.SEARCH_RESULTS });
  97
  98 export const matchUserVirtualMachineRoute = (route: string) =>
  99     matchPath<ResourceRouteParams>(route, { path: Routes.VIRTUAL_MACHINES_USER });
 100
 101 export const matchAdminVirtualMachineRoute = (route: string) =>
 102     matchPath<ResourceRouteParams>(route, { path: Routes.VIRTUAL_MACHINES_ADMIN });
 103
 104 export const matchRepositoriesRoute = (route: string) =>
 105     matchPath<ResourceRouteParams>(route, { path: Routes.REPOSITORIES });
 106
 107 export const matchSshKeysUserRoute = (route: string) =>
 108     matchPath(route, { path: Routes.SSH_KEYS_USER });
 109
 110 export const matchSshKeysAdminRoute = (route: string) =>
 111     matchPath(route, { path: Routes.SSH_KEYS_ADMIN });
 112
 113 export const matchSiteManagerRoute = (route: string) =>
 114     matchPath(route, { path: Routes.SITE_MANAGER });
 115
 116 export const matchMyAccountRoute = (route: string) =>
 117     matchPath(route, { path: Routes.MY_ACCOUNT });
 118
 119 export const matchLinkAccountRoute = (route: string) =>
 120     matchPath(route, { path: Routes.LINK_ACCOUNT });
 121
 122 export const matchKeepServicesRoute = (route: string) =>
 123     matchPath(route, { path: Routes.KEEP_SERVICES });
 124
 125 export const matchUsersRoute = (route: string) =>
 126     matchPath(route, { path: Routes.USERS });
 127
 128 export const matchComputeNodesRoute = (route: string) =>
 129     matchPath(route, { path: Routes.COMPUTE_NODES });
 130
 131 export const matchApiClientAuthorizationsRoute = (route: string) =>
 132     matchPath(route, { path: Routes.API_CLIENT_AUTHORIZATIONS });
 133
 134 export const matchGroupsRoute = (route: string) =>
 135     matchPath(route, { path: Routes.GROUPS });
 136
 137 export const matchGroupDetailsRoute = (route: string) =>
 138     matchPath<ResourceRouteParams>(route, { path: Routes.GROUP_DETAILS });
 139
 140 export const matchLinksRoute = (route: string) =>
 141     matchPath(route, { path: Routes.LINKS });
 142
 143 export const matchPublicFavorites = (route: string) =>
 144     matchPath(route, { path: Routes.PUBLIC_FAVORITES });