@leancodepl/kratos 9.2.0 → 9.2.1

package/README.md

@@ -71,16 +71,24 @@ Manages Ory Kratos session and identity state with React Query integration.
 To use the library, you need to create new instance of Kratos client with `mkKratos` factory:
 
 ```typescript
-// kratosService.ts
-
-import { queryClient } from "./queryService"
+// traits.ts
 
-const traitsConfig = {
+export const traitsConfig = {
   Email: { trait: "email", type: "string" },
   GivenName: { trait: "given_name", type: "string" },
   RegulationsAccepted: { trait: "regulations_accepted", type: "boolean" },
 } as const
 
+export type AuthTraitsConfig = typeof traitsConfig
+```
+
+```typescript
+// kratosService.ts
+
+import { environment } from "./environments"
+import { queryClient } from "./queryService"
+import { traitsConfig } from "./traits"
+
 const {
   session: { sessionManager },
   providers: { KratosProviders },
@@ -99,9 +107,6 @@ export { KratosProviders }
 
 // flows
 export { LoginFlow, RecoveryFlow, RegistrationFlow, SettingsFlow, useLogout, VerificationFlow }
-
-// traits
-export type AuthTraitsConfig = typeof traitsConfig
 ```
 
 And then wrap your app with `KratosProviders` from `mkKratos`:
@@ -128,6 +133,74 @@ function App() {
 }
 ```
 
+### Extending session manager
+
+You can add new functionalities to the session manager by extending `BaseSessionManager` class:
+
+```typescript
+// session.ts
+
+import { BaseSessionManager } from "@leancodepl/kratos"
+import { queryClient } from "./queryService"
+import type { AuthTraitsConfig } from "./traits"
+
+export class SessionManager extends BaseSessionManager<AuthTraitsConfig> {
+  getTraits = async () => {
+    const identity = await this.getIdentity()
+
+    return identity?.traits
+  }
+
+  getEmail = async () => {
+    const traits = await this.getTraits()
+
+    return traits?.email
+  }
+
+  // Hooks for React components
+
+  useTraits = () => {
+    const { identity, isLoading, error } = this.useIdentity()
+
+    return {
+      traits: identity?.traits,
+      isLoading,
+      error,
+    }
+  }
+
+  useEmail = () => {
+    const { traits, isLoading, error } = this.useTraits()
+
+    return {
+      email: traits?.email,
+      isLoading,
+      error,
+    }
+  }
+}
+```
+
+```typescript
+// kratosService.ts
+
+import { environment } from "./environments"
+import { queryClient } from "./queryService"
+import { SessionManager } from "./session"
+import { traitsConfig } from "./traits"
+
+const {
+  session: { sessionManager },
+  providers: { KratosProviders },
+  flows: { LoginFlow, RegistrationFlow, SettingsFlow, VerificationFlow, RecoveryFlow, useLogout },
+} = mkKratos({
+  queryClient,
+  basePath: environment.authUrl,
+  traits: traitsConfig,
+  SessionManager,
+})
+```
+
 ### Session Management
 
 ```tsx
@@ -352,7 +425,7 @@ export const Input = ({ errors, ...props }: InputProps) => (
 ```tsx
 import { loginFlow } from "@leancodepl/kratos"
 import { LoginFlow, getErrorMessage } from "./kratosService"
-import type { AuthTraitsConfig } from "./kratosService"
+import type { AuthTraitsConfig } from "./traits"
 
 function LoginPage() {
   return (
@@ -481,7 +554,7 @@ function ChooseMethodForm(props: loginFlow.ChooseMethodFormProps) {
 ```tsx
 import { registrationFlow } from "@leancodepl/kratos"
 import { RegistrationFlow, getErrorMessage } from "./kratosService"
-import type { AuthTraitsConfig } from "./kratosService"
+import type { AuthTraitsConfig } from "./traits"
 
 function RegisterPage() {
   return (

package/index.cjs.js

@@ -32,6 +32,29 @@ var GetFlowError;
     GetFlowError[GetFlowError["FlowRestartRequired"] = 1] = "FlowRestartRequired";
 })(GetFlowError || (GetFlowError = {}));
 
+var kratosSessionContext = /*#__PURE__*/ react.createContext(undefined);
+function useKratosSessionContext() {
+    var context = react.useContext(kratosSessionContext);
+    if (context === undefined) {
+        throw new Error("useKratosSessionContext must be used within a KratosSessionContextProvider");
+    }
+    return context;
+}
+function KratosSessionProvider(param) {
+    var children = param.children, sessionManager = param.sessionManager;
+    var kratosSessionContextData = react.useMemo(function() {
+        return {
+            sessionManager: sessionManager
+        };
+    }, [
+        sessionManager
+    ]);
+    return /*#__PURE__*/ jsxRuntime.jsx(kratosSessionContext.Provider, {
+        value: kratosSessionContextData,
+        children: children
+    });
+}
+
 function _array_like_to_array$b(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
@@ -79,15 +102,18 @@ function _unsupported_iterable_to_array$b(o, minLen) {
     if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array$b(o, minLen);
 }
 var useFlowManager = function(param) {
-    var initialFlowId = param.initialFlowId, currentFlowId = param.currentFlowId, error = param.error, onFlowRestart = param.onFlowRestart, createFlow = param.createFlow, setFlowId = param.setFlowId;
+    var initialFlowId = param.initialFlowId, currentFlowId = param.currentFlowId, error = param.error, onFlowRestart = param.onFlowRestart, createFlow = param.createFlow, setFlowId = param.setFlowId, waitForSession = param.waitForSession;
     var _useState = _sliced_to_array$7(react.useState(false), 2), initialFlowIdUsed = _useState[0], setInitialFlowIdUsed = _useState[1];
     var _useState1 = _sliced_to_array$7(react.useState(initialFlowId), 2), prevInitialFlowId = _useState1[0], setPrevInitialFlowId = _useState1[1];
+    var sessionManager = useKratosSessionContext().sessionManager;
+    var isLoading = sessionManager.useSession().isLoading;
     if (prevInitialFlowId !== initialFlowId) {
         setInitialFlowIdUsed(false);
         setPrevInitialFlowId(initialFlowId);
     }
+    var shouldWait = !!waitForSession && isLoading;
     react.useEffect(function() {
-        if (currentFlowId) {
+        if (currentFlowId || shouldWait) {
             return;
         }
         if (initialFlowId && !initialFlowIdUsed) {
@@ -102,7 +128,8 @@ var useFlowManager = function(param) {
         currentFlowId,
         setFlowId,
         onFlowRestart,
-        initialFlowIdUsed
+        initialFlowIdUsed,
+        shouldWait
     ]);
     react.useEffect(function() {
         if (error && error.cause === GetFlowError.FlowRestartRequired) {
@@ -6982,7 +7009,7 @@ var mapToAuthError = function(error) {
             return createRecoveryFlowError("InvalidRecoveryCodeOrAlreadyUsed");
         // Verification Flow Errors
         case 4070001:
-            return createVerificationFlowError("InvalidVerifivactionCodeOrAlreadyUsed");
+            return createVerificationFlowError("InvalidVerificationCodeOrAlreadyUsed");
         case 4070002:
             return createVerificationFlowError("VerificationRequestAlreadyCompletedSuccessfully");
         case 4070003:
@@ -7374,29 +7401,6 @@ function KratosClientProvider(param) {
     });
 }
 
-var kratosSessionContext = /*#__PURE__*/ react.createContext(undefined);
-function useKratosSessionContext() {
-    var context = react.useContext(kratosSessionContext);
-    if (context === undefined) {
-        throw new Error("useKratosSessionContext must be used within a KratosSessionContextProvider");
-    }
-    return context;
-}
-function KratosSessionProvider(param) {
-    var children = param.children, sessionManager = param.sessionManager;
-    var kratosSessionContextData = react.useMemo(function() {
-        return {
-            sessionManager: sessionManager
-        };
-    }, [
-        sessionManager
-    ]);
-    return /*#__PURE__*/ jsxRuntime.jsx(kratosSessionContext.Provider, {
-        value: kratosSessionContextData,
-        children: children
-    });
-}
-
 var emailVerificationFormContext = /*#__PURE__*/ react.createContext(undefined);
 function EmailVerificationFormProvider(param) {
     var children = param.children, emailVerificationForm = param.emailVerificationForm;
@@ -10638,7 +10642,8 @@ function LoginFlowWrapper(param) {
         error: getLoginFlowError !== null && getLoginFlowError !== void 0 ? getLoginFlowError : undefined,
         onFlowRestart: onFlowRestart,
         createFlow: createLoginFlow,
-        setFlowId: setLoginFlowId
+        setFlowId: setLoginFlowId,
+        waitForSession: true
     });
     react.useEffect(function() {
         if (isSessionAlreadyAvailable(createLoginFlowError)) {

package/index.esm.js

@@ -1,5 +1,5 @@
 import { jsx, jsxs, Fragment } from 'react/jsx-runtime';
-import { useState, useEffect, useMemo, useContext, createContext, useCallback } from 'react';
+import { useContext, createContext, useMemo, useState, useEffect, useCallback } from 'react';
 import * as Slot from '@radix-ui/react-slot';
 import { useQueryClient, useMutation, useQuery } from '@tanstack/react-query';
 import { useForm } from '@tanstack/react-form';
@@ -11,6 +11,29 @@ var GetFlowError;
     GetFlowError[GetFlowError["FlowRestartRequired"] = 1] = "FlowRestartRequired";
 })(GetFlowError || (GetFlowError = {}));
 
+var kratosSessionContext = /*#__PURE__*/ createContext(undefined);
+function useKratosSessionContext() {
+    var context = useContext(kratosSessionContext);
+    if (context === undefined) {
+        throw new Error("useKratosSessionContext must be used within a KratosSessionContextProvider");
+    }
+    return context;
+}
+function KratosSessionProvider(param) {
+    var children = param.children, sessionManager = param.sessionManager;
+    var kratosSessionContextData = useMemo(function() {
+        return {
+            sessionManager: sessionManager
+        };
+    }, [
+        sessionManager
+    ]);
+    return /*#__PURE__*/ jsx(kratosSessionContext.Provider, {
+        value: kratosSessionContextData,
+        children: children
+    });
+}
+
 function _array_like_to_array$b(arr, len) {
     if (len == null || len > arr.length) len = arr.length;
     for(var i = 0, arr2 = new Array(len); i < len; i++)arr2[i] = arr[i];
@@ -58,15 +81,18 @@ function _unsupported_iterable_to_array$b(o, minLen) {
     if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _array_like_to_array$b(o, minLen);
 }
 var useFlowManager = function(param) {
-    var initialFlowId = param.initialFlowId, currentFlowId = param.currentFlowId, error = param.error, onFlowRestart = param.onFlowRestart, createFlow = param.createFlow, setFlowId = param.setFlowId;
+    var initialFlowId = param.initialFlowId, currentFlowId = param.currentFlowId, error = param.error, onFlowRestart = param.onFlowRestart, createFlow = param.createFlow, setFlowId = param.setFlowId, waitForSession = param.waitForSession;
     var _useState = _sliced_to_array$7(useState(false), 2), initialFlowIdUsed = _useState[0], setInitialFlowIdUsed = _useState[1];
     var _useState1 = _sliced_to_array$7(useState(initialFlowId), 2), prevInitialFlowId = _useState1[0], setPrevInitialFlowId = _useState1[1];
+    var sessionManager = useKratosSessionContext().sessionManager;
+    var isLoading = sessionManager.useSession().isLoading;
     if (prevInitialFlowId !== initialFlowId) {
         setInitialFlowIdUsed(false);
         setPrevInitialFlowId(initialFlowId);
     }
+    var shouldWait = !!waitForSession && isLoading;
     useEffect(function() {
-        if (currentFlowId) {
+        if (currentFlowId || shouldWait) {
             return;
         }
         if (initialFlowId && !initialFlowIdUsed) {
@@ -81,7 +107,8 @@ var useFlowManager = function(param) {
         currentFlowId,
         setFlowId,
         onFlowRestart,
-        initialFlowIdUsed
+        initialFlowIdUsed,
+        shouldWait
     ]);
     useEffect(function() {
         if (error && error.cause === GetFlowError.FlowRestartRequired) {
@@ -6961,7 +6988,7 @@ var mapToAuthError = function(error) {
             return createRecoveryFlowError("InvalidRecoveryCodeOrAlreadyUsed");
         // Verification Flow Errors
         case 4070001:
-            return createVerificationFlowError("InvalidVerifivactionCodeOrAlreadyUsed");
+            return createVerificationFlowError("InvalidVerificationCodeOrAlreadyUsed");
         case 4070002:
             return createVerificationFlowError("VerificationRequestAlreadyCompletedSuccessfully");
         case 4070003:
@@ -7353,29 +7380,6 @@ function KratosClientProvider(param) {
     });
 }
 
-var kratosSessionContext = /*#__PURE__*/ createContext(undefined);
-function useKratosSessionContext() {
-    var context = useContext(kratosSessionContext);
-    if (context === undefined) {
-        throw new Error("useKratosSessionContext must be used within a KratosSessionContextProvider");
-    }
-    return context;
-}
-function KratosSessionProvider(param) {
-    var children = param.children, sessionManager = param.sessionManager;
-    var kratosSessionContextData = useMemo(function() {
-        return {
-            sessionManager: sessionManager
-        };
-    }, [
-        sessionManager
-    ]);
-    return /*#__PURE__*/ jsx(kratosSessionContext.Provider, {
-        value: kratosSessionContextData,
-        children: children
-    });
-}
-
 var emailVerificationFormContext = /*#__PURE__*/ createContext(undefined);
 function EmailVerificationFormProvider(param) {
     var children = param.children, emailVerificationForm = param.emailVerificationForm;
@@ -10617,7 +10621,8 @@ function LoginFlowWrapper(param) {
         error: getLoginFlowError !== null && getLoginFlowError !== void 0 ? getLoginFlowError : undefined,
         onFlowRestart: onFlowRestart,
         createFlow: createLoginFlow,
-        setFlowId: setLoginFlowId
+        setFlowId: setLoginFlowId,
+        waitForSession: true
     });
     useEffect(function() {
         if (isSessionAlreadyAvailable(createLoginFlowError)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leancodepl/kratos",
-  "version": "9.2.0",
+  "version": "9.2.1",
   "license": "Apache-2.0",
   "publishConfig": {
     "access": "public",
@@ -10,7 +10,7 @@
     "node": ">=18.0.0"
   },
   "dependencies": {
-    "@leancodepl/utils": "9.2.0",
+    "@leancodepl/utils": "9.2.1",
     "@radix-ui/react-slot": ">=1.0.0",
     "@tanstack/react-form": ">=1.0.0",
     "@tanstack/react-query": ">=5.0.0"

package/src/lib/hooks/useFlowManager.d.ts

@@ -5,6 +5,7 @@ type UseFlowManagerProps = {
     onFlowRestart?: () => void;
     createFlow: () => void;
     setFlowId: (flowId: string | undefined) => void;
+    waitForSession?: boolean;
 };
-export declare const useFlowManager: ({ initialFlowId, currentFlowId, error, onFlowRestart, createFlow, setFlowId, }: UseFlowManagerProps) => void;
+export declare const useFlowManager: ({ initialFlowId, currentFlowId, error, onFlowRestart, createFlow, setFlowId, waitForSession, }: UseFlowManagerProps) => void;
 export {};

package/src/lib/utils/errors.d.ts

@@ -353,7 +353,7 @@ export declare const mapToAuthError: (error: UiTextError) => {
     id: "RecoveryFlowError_InvalidRecoveryCodeOrAlreadyUsed";
     originalError: UiTextError;
 } | {
-    id: "VerificationFlowError_InvalidVerifivactionCodeOrAlreadyUsed";
+    id: "VerificationFlowError_InvalidVerificationCodeOrAlreadyUsed";
     originalError: UiTextError;
 } | {
     id: "VerificationFlowError_VerificationRequestAlreadyCompletedSuccessfully";
@@ -371,9 +371,6 @@ export declare const mapToAuthError: (error: UiTextError) => {
 } | {
     id: "VerificationFlowError_VerificationFlowExpired";
     originalError: UiTextError;
-} | {
-    id: "VerificationFlowError_InvalidVerificationCodeOrAlreadyUsed";
-    originalError: UiTextError;
 } | {
     id: "Error_Generic_WithContext";
     context: {