@asgardeo/react-router/dist/components/ProtectedRoute.d.ts

React Router integration for Asgardeo React SDK with protected routes.

/**
 * Copyright (import React, {FC, ReactElement, ReactNode} from 'react';
import {Navigate} from 'react-router';
import {useAsgardeo} from '@asgardeo/react';
import {AsgardeoRuntimeError} from '@asgardeo/browser';2025, WSO2 LLC. (https://www.wso2.com).
 *
 * WSO2 LLC. licenses this file to you under the Apache License,
 * Version 2.0 (the "License"); you may not use this file except
 * in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing,
 * software distributed under the License is distributed on an
 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
 * KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations
 * under the License.
 */
import { FC, ReactElement, ReactNode } from 'react';
/**
 * Props for the ProtectedRoute component.
 */
export interface ProtectedRouteProps {
    /**
     * The element to render when the user is authenticated.
     */
    children: ReactElement;
    /**
     * Custom fallback element to render when the user is not authenticated.
     * If provided, this takes precedence over redirectTo.
     */
    fallback?: ReactElement;
    /**
     * URL to redirect to when the user is not authenticated.
     * Required unless a fallback element is provided.
     */
    redirectTo?: string;
    /**
     * Custom loading element to render while authentication status is being determined.
     */
    loader?: ReactNode;
    /**
     * Custom sign-in function to override the default behavior.
     * If provided, this function will be called instead of the default signIn method
     * when the user is not authenticated and no fallback or redirectTo is specified.
     * This allows you to pass additional parameters or implement custom sign-in logic.
     *
     * @param defaultSignIn - The default signIn method from useAsgardeo hook
     * @param signInOptions - Merged sign-in options (context + component props)
     */
    onSignIn?: (defaultSignIn: (options?: Record<string, any>) => void, signInOptions?: Record<string, any>) => void;
    /**
     * Additional parameters to pass to the authorize request.
     * These will be merged with the default signInOptions from the Asgardeo context.
     * Common options include:
     * - prompt: "login" | "none" | "consent" | "select_account"
     * - fidp: Federation Identity Provider identifier
     * - kc_idp_hint: Keycloak identity provider hint
     * - login_hint: Hint to help with the username/identifier in the login form
     * - max_age: Maximum authentication age in seconds
     * - ui_locales: End-user's preferred languages and scripts for the user interface
     *
     * @example
     * ```tsx
     * signInOptions={{
     *   prompt: "login",
     *   fidp: "OrganizationSSO",
     *   login_hint: "user@example.com"
     * }}
     * ```
     */
    signInOptions?: Record<string, any>;
}
/**
 * A protected route component that requires authentication to access.
 *
 * This component should be used as the element prop of a Route component.
 * It checks authentication status and either renders the protected content,
 * shows a loading state, redirects, or shows a fallback.
 *
 * Either a `redirectTo` prop or a `fallback` prop must be provided to handle
 * unauthenticated users.
 *
 * @example Basic usage with redirect
 * ```tsx
 * <Route
 *   path="/dashboard"
 *   element={
 *     <ProtectedRoute redirectTo="/signin">
 *       <Dashboard />
 *     </ProtectedRoute>
 *   }
 * />
 * ```
 *
 * @example With custom fallback
 * ```tsx
 * <Route
 *   path="/admin"
 *   element={
 *     <ProtectedRoute fallback={<div>Access denied</div>}>
 *       <AdminPanel />
 *     </ProtectedRoute>
 *   }
 * />
 * ```
 *
 * @example With custom sign-in parameters
 * ```tsx
 * <Route
 *   path="/secure"
 *   element={
 *     <ProtectedRoute signInOptions={{ prompt: "login", fidp: "OrganizationSSO" }}>
 *       <SecureContent />
 *     </ProtectedRoute>
 *   }
 * />
 * ```
 *
 * @example With custom sign-in handler
 * ```tsx
 * <Route
 *   path="/custom"
 *   element={
 *     <ProtectedRoute
 *       onSignIn={(defaultSignIn, options) => {
 *         // Custom logic before sign-in
 *         console.log('Initiating custom sign-in');
 *         defaultSignIn({ ...options, prompt: "login" });
 *       }}
 *       signInOptions={{ fidp: "CustomIDP" }}
 *     >
 *       <CustomContent />
 *     </ProtectedRoute>
 *   }
 * />
 * ```
 */
declare const ProtectedRoute: FC<ProtectedRouteProps>;
export default ProtectedRoute;
//# sourceMappingURL=ProtectedRoute.d.ts.map