keycloak-scim/src/route-config.ts

import type { TFunction } from "i18next";
import type { AccessType } from "keycloak-admin/lib/defs/whoAmIRepresentation";
import type { ComponentType } from "react";
import type { MatchOptions } from "use-react-router-breadcrumbs";
import { AuthenticationSection } from "./authentication/AuthenticationSection";
import { RoleMappingForm } from "./client-scopes/add/RoleMappingForm";
import { ClientScopesSection } from "./client-scopes/ClientScopesSection";
import { MappingDetails } from "./client-scopes/details/MappingDetails";
import { ClientScopeForm } from "./client-scopes/form/ClientScopeForm";
import { NewClientForm } from "./clients/add/NewClientForm";
import { ClientDetails } from "./clients/ClientDetails";
import { ClientsSection } from "./clients/ClientsSection";
import { ImportForm } from "./clients/import/ImportForm";
import { CreateInitialAccessToken } from "./clients/initial-access/CreateInitialAccessToken";
import { DashboardSection } from "./dashboard/Dashboard";
import { EventsSection } from "./events/EventsSection";
import { GroupsSection } from "./groups/GroupsSection";
import { SearchGroups } from "./groups/SearchGroups";
import {
  AddIdentityProvider,
  IdentityProviderCrumb,
} from "./identity-providers/add/AddIdentityProvider";
import { AddOpenIdConnect } from "./identity-providers/add/AddOpenIdConnect";
import { DetailSettings } from "./identity-providers/add/DetailSettings";
import { IdentityProvidersSection } from "./identity-providers/IdentityProvidersSection";
import { PageNotFoundSection } from "./PageNotFoundSection";
import { RealmRolesSection } from "./realm-roles/RealmRolesSection";
import { RealmRoleTabs } from "./realm-roles/RealmRoleTabs";
import { AESGeneratedSettings } from "./realm-settings/key-providers/aes-generated/AESGeneratedForm";
import { ECDSAGeneratedSettings } from "./realm-settings/key-providers/ecdsa-generated/ECDSAGeneratedForm";
import { HMACGeneratedSettings } from "./realm-settings/key-providers/hmac-generated/HMACGeneratedForm";
import { JavaKeystoreSettings } from "./realm-settings/key-providers/java-keystore/JavaKeystoreForm";
import { RSAGeneratedSettings } from "./realm-settings/key-providers/rsa-generated/RSAGeneratedForm";
import { RSASettings } from "./realm-settings/key-providers/rsa/RSAForm";
import {
  EditProviderCrumb,
  RealmSettingsSection,
} from "./realm-settings/RealmSettingsSection";
import { NewRealmForm } from "./realm/add/NewRealmForm";
import { SessionsSection } from "./sessions/SessionsSection";
import { LdapMapperDetails } from "./user-federation/ldap/mappers/LdapMapperDetails";
import { UserFederationKerberosSettings } from "./user-federation/UserFederationKerberosSettings";
import { UserFederationLdapSettings } from "./user-federation/UserFederationLdapSettings";
import { UserFederationSection } from "./user-federation/UserFederationSection";
import { UserGroups } from "./user/UserGroups";
import { UsersSection } from "./user/UsersSection";
import { UsersTabs } from "./user/UsersTabs";

export type RouteDef = {
  path: string;
  component: ComponentType;
  breadcrumb: ((t: TFunction) => string | ComponentType<any>) | null;
  access: AccessType;
  matchOptions?: MatchOptions;
};

export const routes: RouteDef[] = [
  {
    path: "/:realm/add-realm",
    component: NewRealmForm,
    breadcrumb: (t) => t("realm:createRealm"),
    access: "manage-realm",
  },
  {
    path: "/:realm/clients/add-client",
    component: NewClientForm,
    breadcrumb: (t) => t("clients:createClient"),
    access: "manage-clients",
  },
  {
    path: "/:realm/clients/import-client",
    component: ImportForm,
    breadcrumb: (t) => t("clients:importClient"),
    access: "manage-clients",
  },
  {
    path: "/:realm/clients/:tab?",
    component: ClientsSection,
    breadcrumb: (t) => t("clients:clientList"),
    access: "query-clients",
  },
  {
    path: "/:realm/clients/initialAccessToken/create",
    component: CreateInitialAccessToken,
    breadcrumb: (t) => t("clients:createToken"),
    access: "manage-clients",
  },
  {
    path: "/:realm/clients/:clientId/roles/add-role",
    component: RealmRoleTabs,
    breadcrumb: (t) => t("roles:createRole"),
    access: "manage-realm",
  },
  {
    path: "/:realm/clients/:clientId/roles/:id/:tab?",
    component: RealmRoleTabs,
    breadcrumb: (t) => t("roles:roleDetails"),
    access: "view-realm",
  },
  {
    path: "/:realm/clients/:clientId/:tab",
    component: ClientDetails,
    breadcrumb: (t) => t("clients:clientSettings"),
    access: "view-clients",
  },
  {
    path: "/:realm/client-scopes/new",
    component: ClientScopeForm,
    breadcrumb: (t) => t("client-scopes:createClientScope"),
    access: "manage-clients",
  },
  {
    path: "/:realm/client-scopes/:id/mappers/oidc-role-name-mapper",
    component: RoleMappingForm,
    breadcrumb: (t) => t("common:mappingDetails"),
    access: "view-clients",
  },
  {
    path: "/:realm/client-scopes/:id/mappers/:mapperId",
    component: MappingDetails,
    breadcrumb: (t) => t("common:mappingDetails"),
    access: "view-clients",
  },
  {
    path: "/:realm/client-scopes/:id/:type/:tab",
    component: ClientScopeForm,
    breadcrumb: (t) => t("client-scopes:clientScopeDetails"),
    access: "view-clients",
  },
  {
    path: "/:realm/client-scopes",
    component: ClientScopesSection,
    breadcrumb: (t) => t("client-scopes:clientScopeList"),
    access: "view-clients",
  },
  {
    path: "/:realm/roles",
    component: RealmRolesSection,
    breadcrumb: (t) => t("roles:roleList"),
    access: "view-realm",
  },
  {
    path: "/:realm/roles/add-role",
    component: RealmRoleTabs,
    breadcrumb: (t) => t("roles:createRole"),
    access: "manage-realm",
  },
  {
    path: "/:realm/roles/:id/:tab?",
    component: RealmRoleTabs,
    breadcrumb: (t) => t("roles:roleDetails"),
    access: "view-realm",
  },
  {
    path: "/:realm/users",
    component: UsersSection,
    breadcrumb: (t) => t("users:title"),
    access: "query-users",
  },
  {
    path: "/:realm/users/add-user",
    component: UsersTabs,
    breadcrumb: (t) => t("users:createUser"),
    access: "manage-users",
  },
  {
    path: "/:realm/users/:id",
    component: UserGroups,
    breadcrumb: (t) => t("users:userDetails"),
    access: "manage-users",
  },
  {
    path: "/:realm/users/:id/:tab",
    component: UsersTabs,
    breadcrumb: (t) => t("users:userDetails"),
    access: "manage-users",
  },
  {
    path: "/:realm/sessions",
    component: SessionsSection,
    breadcrumb: (t) => t("sessions:title"),
    access: "view-realm",
  },
  {
    path: "/:realm/events/:tab?",
    component: EventsSection,
    breadcrumb: (t) => t("events:title"),
    access: "view-events",
  },
  {
    path: "/:realm/realm-settings/:tab?",
    component: RealmSettingsSection,
    breadcrumb: (t) => t("realmSettings"),
    access: "view-realm",
  },
  {
    path: "/:realm/realm-settings/keys/:id?/aes-generated/settings",
    component: AESGeneratedSettings,
    breadcrumb: () => EditProviderCrumb,
    access: "view-realm",
  },
  {
    path: "/:realm/realm-settings/keys/:id?/ecdsa-generated/settings",
    component: ECDSAGeneratedSettings,
    breadcrumb: () => EditProviderCrumb,
    access: "view-realm",
  },
  {
    path: "/:realm/realm-settings/keys/:id?/hmac-generated/settings",
    component: HMACGeneratedSettings,
    breadcrumb: () => EditProviderCrumb,
    access: "view-realm",
  },
  {
    path: "/:realm/realm-settings/keys/:id?/java-keystore/settings",
    component: JavaKeystoreSettings,
    breadcrumb: () => EditProviderCrumb,
    access: "view-realm",
  },
  {
    path: "/:realm/realm-settings/keys/:id?/rsa-generated/settings",
    component: RSAGeneratedSettings,
    breadcrumb: () => EditProviderCrumb,
    access: "view-realm",
  },
  {
    path: "/:realm/realm-settings/keys/:id?/rsa/settings",
    component: RSASettings,
    breadcrumb: () => EditProviderCrumb,
    access: "view-realm",
  },
  {
    path: "/:realm/authentication",
    component: AuthenticationSection,
    breadcrumb: (t) => t("authentication"),
    access: "view-realm",
  },
  {
    path: "/:realm/identity-providers",
    component: IdentityProvidersSection,
    breadcrumb: (t) => t("identityProviders"),
    access: "view-identity-providers",
  },
  {
    path: "/:realm/identity-providers/oidc",
    component: AddOpenIdConnect,
    breadcrumb: (t) => t("identity-providers:addOpenIdProvider"),
    access: "manage-identity-providers",
  },
  {
    path: "/:realm/identity-providers/keycloak-oidc",
    component: AddOpenIdConnect,
    breadcrumb: (t) => t("identity-providers:addKeycloakOpenIdProvider"),
    access: "manage-identity-providers",
  },
  {
    path: "/:realm/identity-providers/:id",
    component: AddIdentityProvider,
    breadcrumb: () => IdentityProviderCrumb,
    access: "manage-identity-providers",
  },
  {
    path: "/:realm/identity-providers/:id/:tab?",
    component: DetailSettings,
    breadcrumb: null,
    access: "manage-identity-providers",
  },
  {
    path: "/:realm/user-federation",
    component: UserFederationSection,
    breadcrumb: (t) => t("userFederation"),
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/kerberos",
    component: UserFederationSection,
    breadcrumb: null,
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/kerberos/:id",
    component: UserFederationKerberosSettings,
    breadcrumb: (t) => t("common:settings"),
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/kerberos/new",
    component: UserFederationKerberosSettings,
    breadcrumb: (t) => t("common:settings"),
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/ldap",
    component: UserFederationSection,
    breadcrumb: null,
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/ldap/new",
    component: UserFederationLdapSettings,
    breadcrumb: (t) => t("user-federation:addOneLdap"),
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/ldap/:id/:tab?",
    component: UserFederationLdapSettings,
    breadcrumb: (t) => t("common:settings"),
    access: "view-realm",
  },
  {
    path: "/:realm/user-federation/ldap/:id/:tab/:mapperId",
    component: LdapMapperDetails,
    breadcrumb: (t) => t("common:mappingDetails"),
    access: "view-realm",
  },
  {
    path: "/:realm/",
    component: DashboardSection,
    breadcrumb: (t) => t("common:home"),
    access: "anyone",
  },
  {
    path: "/:realm/groups/search",
    component: SearchGroups,
    breadcrumb: (t) => t("groups:searchGroups"),
    access: "query-groups",
  },
  {
    path: "/:realm/groups",
    component: GroupsSection,
    breadcrumb: null,
    access: "query-groups",
    matchOptions: {
      exact: false,
    },
  },
  {
    path: "/",
    component: DashboardSection,
    breadcrumb: (t) => t("common:home"),
    access: "anyone",
  },
  {
    path: "*",
    component: PageNotFoundSection,
    breadcrumb: null,
    access: "anyone",
  },
];