@frontegg/react-hooks 4.40.1 → 4.42.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/auth/hooks.d.ts CHANGED
@@ -9,6 +9,24 @@ export declare type AuthStateMapper<S extends object> = (state: AuthState) => S;
9
9
  export declare type AuthActionsMapper<A> = (state: AuthActions) => A;
10
10
  export declare type StateHookFunction<T> = (() => T) & (<S extends object>(mapper: (state: T) => S) => S);
11
11
  export declare const useAuth: <S extends object>(stateMapper?: AuthStateMapper<S>) => S;
12
+ /**
13
+ * ```jsx
14
+ * export const MyFunctionComponent = () => {
15
+ * const { isAuthenticated, user } = useAuth();
16
+ * const loginWithRedirect = useLoginWithRedirect();
17
+ *
18
+ * if (!isAuthenticated) {
19
+ * loginWithRedirect();
20
+ * return <></>;
21
+ * }
22
+ *
23
+ * return (<div>Hello User {user.name}</div>);
24
+ * }
25
+ * ```
26
+ *
27
+ * use this frontegg hook function to get if user is "Authenticated"
28
+ */
29
+ export declare const useLoginWithRedirect: () => import("@reduxjs/toolkit").ActionCreatorWithoutPayload<string>;
12
30
  export declare const useAuthActions: () => AuthActions;
13
31
  export declare const useOnRedirectTo: () => (path: string, opts?: RedirectOptions | undefined) => void;
14
32
  export declare const useAuthRoutes: () => AuthPageRoutes;
package/auth/index.d.ts CHANGED
@@ -1,4 +1,4 @@
1
- export { useAuth, useAuthActions, useOnRedirectTo, useAuthRoutes, useIsAuthenticated, useAuthUser, useAuthUserOrNull, } from './hooks';
1
+ export { useAuth, useAuthActions, useOnRedirectTo, useAuthRoutes, useIsAuthenticated, useAuthUser, useAuthUserOrNull, useLoginWithRedirect } from './hooks';
2
2
  export * from './acceptInvitation';
3
3
  export * from './activateAccount';
4
4
  export * from './apiTokens';
package/auth/index.js CHANGED
@@ -1,4 +1,4 @@
1
- export { s as reloadProfileIfNeeded, h as useAcceptInvitationActions, g as useAcceptInvitationState, j as useActivateAccountActions, i as useActivateAccountState, l as useApiTokensActions, k as useApiTokensState, u as useAuth, a as useAuthActions, c as useAuthRoutes, B as useAuthTeamActions, A as useAuthTeamState, e as useAuthUser, f as useAuthUserOrNull, n as useForgotPasswordActions, m as useForgotPasswordState, d as useIsAuthenticated, p as useLoginActions, o as useLoginState, r as useMfaActions, q as useMfaState, b as useOnRedirectTo, v as useProfileActions, t as useProfileState, J as useRolesActions, I as useRolesState, D as useSSOActions, C as useSSOState, F as useSecurityPolicyActions, E as useSecurityPolicyState, x as useSignUpActions, w as useSignUpState, z as useSocialLoginActions, y as useSocialLoginState, H as useTenantsActions, G as useTenantsState } from '../roles-7f45d6b7.js';
1
+ export { t as reloadProfileIfNeeded, i as useAcceptInvitationActions, h as useAcceptInvitationState, k as useActivateAccountActions, j as useActivateAccountState, m as useApiTokensActions, l as useApiTokensState, u as useAuth, a as useAuthActions, c as useAuthRoutes, C as useAuthTeamActions, B as useAuthTeamState, e as useAuthUser, f as useAuthUserOrNull, o as useForgotPasswordActions, n as useForgotPasswordState, d as useIsAuthenticated, q as useLoginActions, p as useLoginState, g as useLoginWithRedirect, s as useMfaActions, r as useMfaState, b as useOnRedirectTo, w as useProfileActions, v as useProfileState, K as useRolesActions, J as useRolesState, E as useSSOActions, D as useSSOState, G as useSecurityPolicyActions, F as useSecurityPolicyState, y as useSignUpActions, x as useSignUpState, A as useSocialLoginActions, z as useSocialLoginState, I as useTenantsActions, H as useTenantsState } from '../roles-38be93b4.js';
2
2
  import '@frontegg/redux-store';
3
3
  import 'react';
4
4
  import 'react-redux';
package/index.js CHANGED
@@ -6,8 +6,8 @@ import { createFronteggStore } from '@frontegg/redux-store';
6
6
  import { ContextHolder } from '@frontegg/rest-api';
7
7
  import { F as FronteggStoreContext } from './FronteggStoreContext-d6c3b684.js';
8
8
  export { F as FronteggStoreContext, a as useDispatch, u as useSelector, b as useStore } from './FronteggStoreContext-d6c3b684.js';
9
- import { u as useAuth, c as useAuthRoutes } from './roles-7f45d6b7.js';
10
- export { s as reloadProfileIfNeeded, h as useAcceptInvitationActions, g as useAcceptInvitationState, j as useActivateAccountActions, i as useActivateAccountState, l as useApiTokensActions, k as useApiTokensState, u as useAuth, a as useAuthActions, c as useAuthRoutes, B as useAuthTeamActions, A as useAuthTeamState, e as useAuthUser, f as useAuthUserOrNull, n as useForgotPasswordActions, m as useForgotPasswordState, d as useIsAuthenticated, p as useLoginActions, o as useLoginState, r as useMfaActions, q as useMfaState, b as useOnRedirectTo, v as useProfileActions, t as useProfileState, J as useRolesActions, I as useRolesState, D as useSSOActions, C as useSSOState, F as useSecurityPolicyActions, E as useSecurityPolicyState, x as useSignUpActions, w as useSignUpState, z as useSocialLoginActions, y as useSocialLoginState, H as useTenantsActions, G as useTenantsState } from './roles-7f45d6b7.js';
9
+ import { u as useAuth, c as useAuthRoutes } from './roles-38be93b4.js';
10
+ export { t as reloadProfileIfNeeded, i as useAcceptInvitationActions, h as useAcceptInvitationState, k as useActivateAccountActions, j as useActivateAccountState, m as useApiTokensActions, l as useApiTokensState, u as useAuth, a as useAuthActions, c as useAuthRoutes, C as useAuthTeamActions, B as useAuthTeamState, e as useAuthUser, f as useAuthUserOrNull, o as useForgotPasswordActions, n as useForgotPasswordState, d as useIsAuthenticated, q as useLoginActions, p as useLoginState, g as useLoginWithRedirect, s as useMfaActions, r as useMfaState, b as useOnRedirectTo, w as useProfileActions, v as useProfileState, K as useRolesActions, J as useRolesState, E as useSSOActions, D as useSSOState, G as useSecurityPolicyActions, F as useSecurityPolicyState, y as useSignUpActions, x as useSignUpState, A as useSocialLoginActions, z as useSocialLoginState, I as useTenantsActions, H as useTenantsState } from './roles-38be93b4.js';
11
11
  export { c as useAuditLogsActions, b as useAuditLogsState, a as useAuditsActions, e as useAuditsMetadataActions, d as useAuditsMetadataState, u as useAuditsState } from './auditsMetadata-9ab88593.js';
12
12
  export { u as useConnectivityActions, a as useConnectivityState } from './hooks-6400e233.js';
13
13
  export { f as useBillingInformation, g as useBillingInformationActions, h as useBillingPaymentMethod, i as useBillingPaymentMethodActions, d as useCheckout, e as useCheckoutActions, j as useInvoices, k as useInvoicesActions, u as usePaymentProvider, a as usePaymentProviderActions, b as usePlans, c as usePlansActions, m as useStripeActions, l as useStripeState } from './hooks-6e92ca1b.js';
@@ -2,7 +2,7 @@
2
2
 
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
- var roles = require('../roles-21e16ab5.js');
5
+ var roles = require('../roles-1ae8d25b.js');
6
6
  require('@frontegg/redux-store');
7
7
  require('react');
8
8
  require('react-redux');
@@ -30,6 +30,7 @@ exports.useForgotPasswordState = roles.useForgotPasswordState;
30
30
  exports.useIsAuthenticated = roles.useIsAuthenticated;
31
31
  exports.useLoginActions = roles.useLoginActions;
32
32
  exports.useLoginState = roles.useLoginState;
33
+ exports.useLoginWithRedirect = roles.useLoginWithRedirect;
33
34
  exports.useMfaActions = roles.useMfaActions;
34
35
  exports.useMfaState = roles.useMfaState;
35
36
  exports.useOnRedirectTo = roles.useOnRedirectTo;
package/node/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  Object.defineProperty(exports, '__esModule', { value: true });
4
4
 
5
5
  var auditsMetadata = require('./auditsMetadata-d15799a1.js');
6
- var roles = require('./roles-21e16ab5.js');
6
+ var roles = require('./roles-1ae8d25b.js');
7
7
  var hooks = require('./hooks-5d5a445e.js');
8
8
  var hooks$1 = require('./hooks-d88513e5.js');
9
9
  var hooks$2 = require('./hooks-cf739b27.js');
@@ -113,6 +113,7 @@ exports.useForgotPasswordState = roles.useForgotPasswordState;
113
113
  exports.useIsAuthenticated = roles.useIsAuthenticated;
114
114
  exports.useLoginActions = roles.useLoginActions;
115
115
  exports.useLoginState = roles.useLoginState;
116
+ exports.useLoginWithRedirect = roles.useLoginWithRedirect;
116
117
  exports.useMfaActions = roles.useMfaActions;
117
118
  exports.useMfaState = roles.useMfaState;
118
119
  exports.useOnRedirectTo = roles.useOnRedirectTo;
@@ -13,6 +13,27 @@ const defaultMapper = {
13
13
  const useAuth = (stateMapper = defaultMapper.state) => {
14
14
  return FronteggStoreContext.useSelector((state) => stateMapper(state[reduxStore.authStoreName]), reactRedux.shallowEqual);
15
15
  };
16
+ /**
17
+ * ```jsx
18
+ * export const MyFunctionComponent = () => {
19
+ * const { isAuthenticated, user } = useAuth();
20
+ * const loginWithRedirect = useLoginWithRedirect();
21
+ *
22
+ * if (!isAuthenticated) {
23
+ * loginWithRedirect();
24
+ * return <></>;
25
+ * }
26
+ *
27
+ * return (<div>Hello User {user.name}</div>);
28
+ * }
29
+ * ```
30
+ *
31
+ * use this frontegg hook function to get if user is "Authenticated"
32
+ */
33
+ const useLoginWithRedirect = () => {
34
+ const dispatch = FronteggStoreContext.useDispatch();
35
+ return React.useMemo(() => reduxStore.bindActionCreators(reduxStore.authActions.requestHostedLoginAuthorize, dispatch), [reduxStore.authActions.requestHostedLoginAuthorize]);
36
+ };
16
37
  const useAuthActions = () => {
17
38
  const dispatch = FronteggStoreContext.useDispatch();
18
39
  return React.useMemo(() => reduxStore.bindActionCreators(reduxStore.authActions, dispatch), [reduxStore.authActions]);
@@ -139,6 +160,7 @@ exports.useForgotPasswordState = useForgotPasswordState;
139
160
  exports.useIsAuthenticated = useIsAuthenticated;
140
161
  exports.useLoginActions = useLoginActions;
141
162
  exports.useLoginState = useLoginState;
163
+ exports.useLoginWithRedirect = useLoginWithRedirect;
142
164
  exports.useMfaActions = useMfaActions;
143
165
  exports.useMfaState = useMfaState;
144
166
  exports.useOnRedirectTo = useOnRedirectTo;
package/package.json CHANGED
@@ -1,13 +1,13 @@
1
1
  {
2
2
  "name": "@frontegg/react-hooks",
3
3
  "libName": "FronteggReactHooks",
4
- "version": "4.40.1",
4
+ "version": "4.42.2",
5
5
  "author": "Frontegg LTD",
6
6
  "main": "./node/index.js",
7
7
  "module": "./index.js",
8
8
  "types": "./index.d.ts",
9
9
  "dependencies": {
10
- "@frontegg/redux-store": "4.40.1",
10
+ "@frontegg/redux-store": "4.42.2",
11
11
  "react-redux": "^7.x"
12
12
  }
13
13
  }
@@ -11,6 +11,27 @@ const defaultMapper = {
11
11
  const useAuth = (stateMapper = defaultMapper.state) => {
12
12
  return useSelector((state) => stateMapper(state[authStoreName]), shallowEqual);
13
13
  };
14
+ /**
15
+ * ```jsx
16
+ * export const MyFunctionComponent = () => {
17
+ * const { isAuthenticated, user } = useAuth();
18
+ * const loginWithRedirect = useLoginWithRedirect();
19
+ *
20
+ * if (!isAuthenticated) {
21
+ * loginWithRedirect();
22
+ * return <></>;
23
+ * }
24
+ *
25
+ * return (<div>Hello User {user.name}</div>);
26
+ * }
27
+ * ```
28
+ *
29
+ * use this frontegg hook function to get if user is "Authenticated"
30
+ */
31
+ const useLoginWithRedirect = () => {
32
+ const dispatch = useDispatch();
33
+ return useMemo(() => bindActionCreators(authActions.requestHostedLoginAuthorize, dispatch), [authActions.requestHostedLoginAuthorize]);
34
+ };
14
35
  const useAuthActions = () => {
15
36
  const dispatch = useDispatch();
16
37
  return useMemo(() => bindActionCreators(authActions, dispatch), [authActions]);
@@ -118,4 +139,4 @@ const useTenantsActions = () => reducerActionsGenerator(tenantsActions, tenantsR
118
139
  const useRolesState = (stateMapper) => stateHookGenerator(stateMapper, 'rolesState');
119
140
  const useRolesActions = () => reducerActionsGenerator(rolesActions, rolesReducers);
120
141
 
121
- export { useAuthTeamState as A, useAuthTeamActions as B, useSSOState as C, useSSOActions as D, useSecurityPolicyState as E, useSecurityPolicyActions as F, useTenantsState as G, useTenantsActions as H, useRolesState as I, useRolesActions as J, useAuthActions as a, useOnRedirectTo as b, useAuthRoutes as c, useIsAuthenticated as d, useAuthUser as e, useAuthUserOrNull as f, useAcceptInvitationState as g, useAcceptInvitationActions as h, useActivateAccountState as i, useActivateAccountActions as j, useApiTokensState as k, useApiTokensActions as l, useForgotPasswordState as m, useForgotPasswordActions as n, useLoginState as o, useLoginActions as p, useMfaState as q, useMfaActions as r, reloadProfileIfNeeded as s, useProfileState as t, useAuth as u, useProfileActions as v, useSignUpState as w, useSignUpActions as x, useSocialLoginState as y, useSocialLoginActions as z };
142
+ export { useSocialLoginActions as A, useAuthTeamState as B, useAuthTeamActions as C, useSSOState as D, useSSOActions as E, useSecurityPolicyState as F, useSecurityPolicyActions as G, useTenantsState as H, useTenantsActions as I, useRolesState as J, useRolesActions as K, useAuthActions as a, useOnRedirectTo as b, useAuthRoutes as c, useIsAuthenticated as d, useAuthUser as e, useAuthUserOrNull as f, useLoginWithRedirect as g, useAcceptInvitationState as h, useAcceptInvitationActions as i, useActivateAccountState as j, useActivateAccountActions as k, useApiTokensState as l, useApiTokensActions as m, useForgotPasswordState as n, useForgotPasswordActions as o, useLoginState as p, useLoginActions as q, useMfaState as r, useMfaActions as s, reloadProfileIfNeeded as t, useAuth as u, useProfileState as v, useProfileActions as w, useSignUpState as x, useSignUpActions as y, useSocialLoginState as z };