@leancodepl/kratos 8.4.0 → 8.5.1

package/src/lib/flows/useReauthenticationFlow.d.ts

@@ -1,4 +1,27 @@
 import { FrontendApi, LoginFlow, Session, UpdateLoginFlowBody } from "@ory/client";
+/**
+ * Manages Kratos reauthentication flow for elevated security operations.
+ *
+ * Handles reauthentication flow creation and submission for operations requiring
+ * fresh authentication, such as changing passwords or accessing sensitive data.
+ *
+ * @param kratosClient - Configured Kratos FrontendApi client
+ * @param onReauthenticated - Callback executed with session after successful reauthentication
+ * @returns Object with current flow and submit function
+ * @example
+ * ```typescript
+ * import { useReauthenticationFlow } from '@leancodepl/kratos';
+ *
+ * function ReauthForm() {
+ *   const { flow, submit } = useReauthenticationFlow({
+ *     kratosClient,
+ *     onReauthenticated: (session) => navigate('/secure-area')
+ *   });
+ *
+ *   return <form onSubmit={submit}>...</form>;
+ * }
+ * ```
+ */
 export declare function useReauthenticationFlow({ kratosClient, onReauthenticated, }: {
     kratosClient: FrontendApi;
     onReauthenticated: (session: Session) => void;

package/src/lib/flows/useRecoveryFlow.d.ts

@@ -4,6 +4,33 @@ type RecoveryFlowSearchParams = {
     [flowIdParameterName]?: string;
     [returnToParameterName]?: string;
 };
+/**
+ * Manages Kratos account recovery flow state and form submission.
+ *
+ * Handles recovery flow creation, retrieval, and submission with automatic error handling,
+ * URL parameter management, and continue-with callbacks for post-recovery actions.
+ *
+ * @param kratosClient - Configured Kratos FrontendApi client
+ * @param onSessionAlreadyAvailable - Callback when session already exists
+ * @param onContinueWith - Optional callback for post-recovery actions
+ * @param searchParams - URL search parameters for flow state
+ * @param updateSearchParams - Function to update URL search parameters
+ * @returns Object with current flow, submit function, and recovery status
+ * @example
+ * ```typescript
+ * import { useRecoveryFlow } from '@leancodepl/kratos';
+ *
+ * function RecoveryForm() {
+ *   const { flow, submit, isRecovering } = useRecoveryFlow({
+ *     kratosClient,
+ *     onSessionAlreadyAvailable: () => navigate('/dashboard'),
+ *     updateSearchParams: (params) => setSearchParams(params)
+ *   });
+ *
+ *   return <form onSubmit={submit}>...</form>;
+ * }
+ * ```
+ */
 export declare function useRecoveryFlow({ kratosClient, onSessionAlreadyAvailable, onContinueWith, searchParams, updateSearchParams, }: {
     kratosClient: FrontendApi;
     onSessionAlreadyAvailable: () => void;

package/src/lib/flows/useRegistrationFlow.d.ts

@@ -4,6 +4,33 @@ type RegistrationFlowSearchParams = {
     [flowIdParameterName]?: string;
     [returnToParameterName]?: string;
 };
+/**
+ * Manages Kratos registration flow state and form submission.
+ *
+ * Handles registration flow creation, retrieval, and submission with automatic error handling,
+ * URL parameter management, and continue-with callbacks for post-registration actions.
+ *
+ * @param kratosClient - Configured Kratos FrontendApi client
+ * @param onSessionAlreadyAvailable - Callback when session already exists
+ * @param onContinueWith - Optional callback for post-registration actions
+ * @param searchParams - URL search parameters for flow state
+ * @param updateSearchParams - Function to update URL search parameters
+ * @returns Object with current flow, submit function, and registration status
+ * @example
+ * ```typescript
+ * import { useRegisterFlow } from '@leancodepl/kratos';
+ *
+ * function RegisterForm() {
+ *   const { flow, submit, isRegistered } = useRegisterFlow({
+ *     kratosClient,
+ *     onSessionAlreadyAvailable: () => navigate('/dashboard'),
+ *     updateSearchParams: (params) => setSearchParams(params)
+ *   });
+ *
+ *   return <form onSubmit={submit}>...</form>;
+ * }
+ * ```
+ */
 export declare function useRegisterFlow({ kratosClient, onSessionAlreadyAvailable, onContinueWith, searchParams, updateSearchParams, }: {
     kratosClient: FrontendApi;
     onSessionAlreadyAvailable: () => void;

package/src/lib/flows/useSettingsFlow.d.ts

@@ -5,6 +5,33 @@ type SettingsFlowSearchParams = {
     [flowIdParameterName]?: string;
     [returnToParameterName]?: string;
 };
+/**
+ * Manages Kratos user settings flow state and form submission.
+ *
+ * Handles settings flow creation, retrieval, and submission for profile updates,
+ * password changes, and security settings management.
+ *
+ * @param kratosClient - Configured Kratos FrontendApi client
+ * @param params - Optional Axios request parameters
+ * @param onContinueWith - Optional callback for post-settings actions
+ * @param searchParams - URL search parameters for flow state
+ * @param updateSearchParams - Function to update URL search parameters
+ * @returns Object with current flow and submit function
+ * @example
+ * ```typescript
+ * import { useSettingsFlow } from '@leancodepl/kratos';
+ *
+ * function UserSettingsForm() {
+ *   const { flow, submit } = useSettingsFlow({
+ *     kratosClient,
+ *     onContinueWith: (actions) => console.log('Settings updated'),
+ *     updateSearchParams: (params) => setSearchParams(params)
+ *   });
+ *
+ *   return <form onSubmit={submit}>...</form>;
+ * }
+ * ```
+ */
 export declare function useSettingsFlow({ kratosClient, params, onContinueWith, searchParams, updateSearchParams, }: {
     kratosClient: FrontendApi;
     params?: AxiosRequestConfig["params"];

package/src/lib/flows/useVerificationFlow.d.ts

@@ -4,6 +4,33 @@ type RecoveryFlowSearchParams = {
     [flowIdParameterName]?: string;
     [returnToParameterName]?: string;
 };
+/**
+ * Manages Kratos email/phone verification flow state and form submission.
+ *
+ * Handles verification flow creation, retrieval, and submission with automatic error handling,
+ * URL parameter management, and verification status tracking.
+ *
+ * @param initialFlowId - Optional initial flow ID to start with
+ * @param kratosClient - Configured Kratos FrontendApi client
+ * @param onVerified - Callback executed when verification is successful
+ * @param searchParams - URL search parameters for flow state
+ * @param updateSearchParams - Function to update URL search parameters
+ * @returns Object with current flow, submit function, and reset function
+ * @example
+ * ```typescript
+ * import { useVerificationFlow } from '@leancodepl/kratos';
+ *
+ * function VerifyEmailForm() {
+ *   const { flow, submit, reset } = useVerificationFlow({
+ *     kratosClient,
+ *     onVerified: () => navigate('/dashboard'),
+ *     updateSearchParams: (params) => setSearchParams(params)
+ *   });
+ *
+ *   return <form onSubmit={submit}>...</form>;
+ * }
+ * ```
+ */
 export declare function useVerificationFlow({ initialFlowId, kratosClient, onVerified, searchParams, updateSearchParams, }: {
     initialFlowId?: string;
     kratosClient: FrontendApi;

package/src/lib/kratosContext.d.ts

@@ -6,6 +6,24 @@ export type KratosContextData = {
     excludeScripts: boolean;
 };
 export declare const kratosContext: import("react").Context<KratosContextData>;
+/**
+ * Access Kratos context data with components and error handling.
+ *
+ * Retrieves the current Kratos context including UI components, error handlers,
+ * and configuration. Throws error if components are not initialized.
+ *
+ * @returns Kratos context data with initialized components
+ * @throws Error when Kratos context components are not initialized
+ * @example
+ * ```typescript
+ * import { useKratosContext } from '@leancodepl/kratos';
+ *
+ * function LoginComponent() {
+ *   const { components, useHandleFlowError } = useKratosContext();
+ *   // Use components and error handling...
+ * }
+ * ```
+ */
 export declare function useKratosContext(): KratosContextData & {
     components: KratosComponents;
 };

package/src/lib/kratosContextProvider.d.ts

@@ -7,4 +7,28 @@ export type KratosContextProviderProps = {
     excludeScripts?: boolean;
     children?: ReactNode;
 };
+/**
+ * Provides Kratos context to child components with customizable configuration.
+ *
+ * Sets up the React context for Kratos integration, allowing customization of
+ * UI components, error handling, and script loading behavior.
+ *
+ * @param components - Partial override of default Kratos UI components
+ * @param useHandleFlowError - Custom error handler for authentication flows
+ * @param excludeScripts - Whether to exclude script node execution
+ * @param children - Child React components
+ * @returns JSX element providing Kratos context
+ * @example
+ * ```typescript
+ * import { KratosContextProvider } from '@leancodepl/kratos';
+ *
+ * function App() {
+ *   return (
+ *     <KratosContextProvider>
+ *       <LoginPage />
+ *     </KratosContextProvider>
+ *   );
+ * }
+ * ```
+ */
 export declare function KratosContextProvider({ components, useHandleFlowError, excludeScripts, children, }: KratosContextProviderProps): import("react/jsx-runtime").JSX.Element;

package/src/lib/sessionManager/baseSessionManager.d.ts

@@ -1,5 +1,27 @@
 import { Session } from "@ory/client";
 import { Subject } from "rxjs";
+/**
+ * Manages Kratos session state with RxJS observables for authentication status.
+ *
+ * Provides reactive session management with automatic status checking, user identity
+ * tracking, and AAL (Authenticator Assurance Level) handling for multi-factor authentication.
+ *
+ * @param authUrl - Base URL for Kratos authentication endpoints
+ * @param loginRoute - Application route for login page
+ * @example
+ * ```typescript
+ * import { BaseSessionManager } from '@leancodepl/kratos';
+ *
+ * const sessionManager = new BaseSessionManager(
+ *   'https://auth.example.com',
+ *   '/login'
+ * );
+ *
+ * sessionManager.isLoggedIn.subscribe(loggedIn => {
+ *   console.log('User logged in:', loggedIn);
+ * });
+ * ```
+ */
 export declare class BaseSessionManager {
     authUrl: string;
     loginRoute: string;

package/index.esm.d.ts

@@ -1 +0,0 @@
-export * from "./src/index";