@frontegg/react-hooks 6.155.0-alpha.0 → 6.155.0-alpha.2

package/auth/index.d.ts

@@ -5,7 +5,7 @@ export * from './apiTokens';
 export * from './forgotPassword';
 export * from './resetPhoneNumber';
 export * from './login';
-export * from './stepUp';
+export * from './stepUp/stepUp';
 export * from './mfa';
 export * from './profile';
 export * from './signup';

package/auth/index.js

@@ -5,7 +5,7 @@ export * from './apiTokens';
 export * from './forgotPassword';
 export * from './resetPhoneNumber';
 export * from './login';
-export * from './stepUp';
+export * from './stepUp/stepUp';
 export * from './mfa';
 export * from './profile';
 export * from './signup';

package/auth/stepUp/consts.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The required ACR (Authorization Context Reference) value for the step up flow
+ */
+export declare const ACR_VALUE = "http://schemas.openid.net/pape/policies/2007/06/multi-factor";
+/**
+ * One of the required AMR (Authentication Methods References) values for the step up flow
+ */
+export declare const AMR_MFA_VALUE = "mfa";
+/**
+ * One of the required AMR (Authentication Methods References) values should be from the array for the step up flow
+ */
+export declare const AMR_ADDITIONAL_VALUE: string[];
+/**
+ * The name of the query param that contains the max age of the step up
+ */
+export declare const STEP_UP_MAX_AGE_PARAM_NAME = "maxAge";

package/auth/stepUp/consts.js

@@ -0,0 +1,19 @@
+/**
+ * The required ACR (Authorization Context Reference) value for the step up flow
+ */
+export const ACR_VALUE = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor';
+
+/**
+ * One of the required AMR (Authentication Methods References) values for the step up flow
+ */
+export const AMR_MFA_VALUE = 'mfa';
+
+/**
+ * One of the required AMR (Authentication Methods References) values should be from the array for the step up flow
+ */
+export const AMR_ADDITIONAL_VALUE = ['otp', 'sms', 'hwk'];
+
+/**
+ * The name of the query param that contains the max age of the step up
+ */
+export const STEP_UP_MAX_AGE_PARAM_NAME = 'maxAge';

package/auth/stepUp/interfaces.d.ts

@@ -0,0 +1,8 @@
+import { StepUpState } from '@frontegg/redux-store';
+export declare type StepUpStateMapper<S> = (state: StepUpState) => S;
+/**
+ * Step up options (for stepUp function)
+ */
+export interface StepUpOptions {
+    maxAge?: number;
+}

package/auth/stepUp/interfaces.js

@@ -0,0 +1 @@
+export {};

package/auth/stepUp/stepUp.d.ts

@@ -0,0 +1,29 @@
+import { StepUpState, StepUpActions } from '@frontegg/redux-store';
+import { RedirectOptions } from '@frontegg/rest-api';
+import { StepUpStateMapper } from './interfaces';
+export declare function useStepUpState(): StepUpState;
+export declare function useStepUpState<S>(stateMapper: StepUpStateMapper<S>): S;
+export declare const useStepUpActions: () => StepUpActions;
+/**
+ * Redirects to the step up url with the max age param and set the redirect url in the local storage
+ * The redirect url will be used after the step up flow is done
+ * @param stepUpUrl - step up url to redirect to
+ * @param onRedirectTo - redirect to function
+ * @param maxAge - max age of step up
+ */
+export declare const redirectByStepUpUrl: (stepUpUrl: string, onRedirectTo: (path: string, opts?: RedirectOptions | undefined) => void, maxAge?: number | undefined) => void;
+/**
+ * @returns max age from the query param as a number or null if not exists
+ */
+export declare const getMaxAgeFromQueryParam: () => number | undefined;
+/**
+ * @returns step up function that redirects to the step up url with the max age param and set the redirect url in the local storage
+ */
+export declare const useStepUp: () => any;
+/**
+ * @param options.maxAge - max age of step up
+ * @returns true when the user is stepped up, false otherwise
+ */
+export declare const useIsSteppedUp: ({ maxAge }?: {
+    maxAge?: number | undefined;
+}) => boolean;

package/auth/stepUp/stepUp.js

@@ -0,0 +1,69 @@
+import { FRONTEGG_AFTER_AUTH_REDIRECT_URL, stepUpReducers, stepUpActions, getSearchParam } from '@frontegg/redux-store';
+import { reducerActionsGenerator, stateHookGenerator, useAuthRoutes, useAuthUser, useOnRedirectTo } from '../hooks';
+import { useCallback } from 'react';
+import { ACR_VALUE, AMR_MFA_VALUE, AMR_ADDITIONAL_VALUE, STEP_UP_MAX_AGE_PARAM_NAME } from './consts';
+const defaultMapper = state => state;
+export function useStepUpState(stateMapper = defaultMapper) {
+  return stateHookGenerator(stateMapper, 'stepUpState');
+}
+export const useStepUpActions = () => reducerActionsGenerator(stepUpActions, stepUpReducers);
+
+/**
+ * Redirects to the step up url with the max age param and set the redirect url in the local storage
+ * The redirect url will be used after the step up flow is done
+ * @param stepUpUrl - step up url to redirect to
+ * @param onRedirectTo - redirect to function
+ * @param maxAge - max age of step up
+ */
+export const redirectByStepUpUrl = (stepUpUrl, onRedirectTo, maxAge) => {
+  const encodedRedirectUrl = window.location.pathname + window.location.search;
+  const maxAgePart = maxAge !== undefined ? `?${STEP_UP_MAX_AGE_PARAM_NAME}=${maxAge}` : '';
+  window.localStorage.setItem(FRONTEGG_AFTER_AUTH_REDIRECT_URL, encodedRedirectUrl);
+  onRedirectTo(`${stepUpUrl}${maxAgePart}`, {
+    refresh: false
+  });
+};
+
+/**
+ * @returns max age from the query param as a number or null if not exists
+ */
+export const getMaxAgeFromQueryParam = () => {
+  const str = getSearchParam(STEP_UP_MAX_AGE_PARAM_NAME);
+  return str === undefined ? undefined : +str;
+};
+
+/**
+ * @returns step up function that redirects to the step up url with the max age param and set the redirect url in the local storage
+ */
+export const useStepUp = () => {
+  const {
+    stepUpUrl
+  } = useAuthRoutes();
+  const onRedirectTo = useOnRedirectTo();
+  return useCallback(options => {
+    redirectByStepUpUrl(stepUpUrl, onRedirectTo, options == null ? void 0 : options.maxAge);
+  }, [stepUpUrl, onRedirectTo]);
+};
+
+/**
+ * @param options.maxAge - max age of step up
+ * @returns true when the user is stepped up, false otherwise
+ */
+export const useIsSteppedUp = ({
+  maxAge
+} = {}) => {
+  const {
+    amr = [],
+    acr = '',
+    auth_time
+  } = useAuthUser();
+  if (maxAge && auth_time) {
+    // when user is logged in for a long time (more than maxAge, but jwt is still valid because it's not refreshed yet)
+    const isMaxAgeValid = Date.now() / 1000 - auth_time <= maxAge;
+    if (!isMaxAgeValid) return false;
+  }
+  const isACRValid = acr === ACR_VALUE;
+  const isAMRIncludesMFA = amr.indexOf(AMR_MFA_VALUE) !== -1;
+  const isAMRIncludesMethod = AMR_ADDITIONAL_VALUE.find(method => amr.indexOf(method)) !== undefined;
+  return isACRValid && isAMRIncludesMFA && isAMRIncludesMethod;
+};

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.155.0-alpha.0
+/** @license Frontegg v6.155.0-alpha.2
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/node/auth/index.js

@@ -134,7 +134,7 @@ Object.keys(_login).forEach(function (key) {
     }
   });
 });
-var _stepUp = require("./stepUp");
+var _stepUp = require("./stepUp/stepUp");
 Object.keys(_stepUp).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;
   if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;

package/node/auth/stepUp/consts.js

@@ -0,0 +1,29 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.STEP_UP_MAX_AGE_PARAM_NAME = exports.AMR_MFA_VALUE = exports.AMR_ADDITIONAL_VALUE = exports.ACR_VALUE = void 0;
+/**
+ * The required ACR (Authorization Context Reference) value for the step up flow
+ */
+const ACR_VALUE = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor';
+
+/**
+ * One of the required AMR (Authentication Methods References) values for the step up flow
+ */
+exports.ACR_VALUE = ACR_VALUE;
+const AMR_MFA_VALUE = 'mfa';
+
+/**
+ * One of the required AMR (Authentication Methods References) values should be from the array for the step up flow
+ */
+exports.AMR_MFA_VALUE = AMR_MFA_VALUE;
+const AMR_ADDITIONAL_VALUE = ['otp', 'sms', 'hwk'];
+
+/**
+ * The name of the query param that contains the max age of the step up
+ */
+exports.AMR_ADDITIONAL_VALUE = AMR_ADDITIONAL_VALUE;
+const STEP_UP_MAX_AGE_PARAM_NAME = 'maxAge';
+exports.STEP_UP_MAX_AGE_PARAM_NAME = STEP_UP_MAX_AGE_PARAM_NAME;

package/node/auth/stepUp/interfaces.js

@@ -0,0 +1,5 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});

package/node/auth/stepUp/stepUp.js

@@ -0,0 +1,81 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useStepUpActions = exports.useStepUp = exports.useIsSteppedUp = exports.redirectByStepUpUrl = exports.getMaxAgeFromQueryParam = void 0;
+exports.useStepUpState = useStepUpState;
+var _reduxStore = require("@frontegg/redux-store");
+var _hooks = require("../hooks");
+var _react = require("react");
+var _consts = require("./consts");
+const defaultMapper = state => state;
+function useStepUpState(stateMapper = defaultMapper) {
+  return (0, _hooks.stateHookGenerator)(stateMapper, 'stepUpState');
+}
+const useStepUpActions = () => (0, _hooks.reducerActionsGenerator)(_reduxStore.stepUpActions, _reduxStore.stepUpReducers);
+
+/**
+ * Redirects to the step up url with the max age param and set the redirect url in the local storage
+ * The redirect url will be used after the step up flow is done
+ * @param stepUpUrl - step up url to redirect to
+ * @param onRedirectTo - redirect to function
+ * @param maxAge - max age of step up
+ */
+exports.useStepUpActions = useStepUpActions;
+const redirectByStepUpUrl = (stepUpUrl, onRedirectTo, maxAge) => {
+  const encodedRedirectUrl = window.location.pathname + window.location.search;
+  const maxAgePart = maxAge !== undefined ? `?${_consts.STEP_UP_MAX_AGE_PARAM_NAME}=${maxAge}` : '';
+  window.localStorage.setItem(_reduxStore.FRONTEGG_AFTER_AUTH_REDIRECT_URL, encodedRedirectUrl);
+  onRedirectTo(`${stepUpUrl}${maxAgePart}`, {
+    refresh: false
+  });
+};
+
+/**
+ * @returns max age from the query param as a number or null if not exists
+ */
+exports.redirectByStepUpUrl = redirectByStepUpUrl;
+const getMaxAgeFromQueryParam = () => {
+  const str = (0, _reduxStore.getSearchParam)(_consts.STEP_UP_MAX_AGE_PARAM_NAME);
+  return str === undefined ? undefined : +str;
+};
+
+/**
+ * @returns step up function that redirects to the step up url with the max age param and set the redirect url in the local storage
+ */
+exports.getMaxAgeFromQueryParam = getMaxAgeFromQueryParam;
+const useStepUp = () => {
+  const {
+    stepUpUrl
+  } = (0, _hooks.useAuthRoutes)();
+  const onRedirectTo = (0, _hooks.useOnRedirectTo)();
+  return (0, _react.useCallback)(options => {
+    redirectByStepUpUrl(stepUpUrl, onRedirectTo, options == null ? void 0 : options.maxAge);
+  }, [stepUpUrl, onRedirectTo]);
+};
+
+/**
+ * @param options.maxAge - max age of step up
+ * @returns true when the user is stepped up, false otherwise
+ */
+exports.useStepUp = useStepUp;
+const useIsSteppedUp = ({
+  maxAge
+} = {}) => {
+  const {
+    amr = [],
+    acr = '',
+    auth_time
+  } = (0, _hooks.useAuthUser)();
+  if (maxAge && auth_time) {
+    // when user is logged in for a long time (more than maxAge, but jwt is still valid because it's not refreshed yet)
+    const isMaxAgeValid = Date.now() / 1000 - auth_time <= maxAge;
+    if (!isMaxAgeValid) return false;
+  }
+  const isACRValid = acr === _consts.ACR_VALUE;
+  const isAMRIncludesMFA = amr.indexOf(_consts.AMR_MFA_VALUE) !== -1;
+  const isAMRIncludesMethod = _consts.AMR_ADDITIONAL_VALUE.find(method => amr.indexOf(method)) !== undefined;
+  return isACRValid && isAMRIncludesMFA && isAMRIncludesMethod;
+};
+exports.useIsSteppedUp = useIsSteppedUp;

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.155.0-alpha.0
+/** @license Frontegg v6.155.0-alpha.2
  *
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@frontegg/react-hooks",
-  "version": "6.155.0-alpha.0",
+  "version": "6.155.0-alpha.2",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@frontegg/redux-store": "6.155.0-alpha.0",
-    "@frontegg/types": "6.155.0-alpha.0",
+    "@frontegg/redux-store": "6.155.0-alpha.2",
+    "@frontegg/types": "6.155.0-alpha.2",
     "@types/react": "*",
     "get-value": "^3.0.1",
     "react-redux": "^7.x"

package/auth/stepUp.d.ts

@@ -1,10 +0,0 @@
-import { StepUpState, StepUpActions } from '@frontegg/redux-store';
-import { RedirectOptions } from '@frontegg/rest-api';
-export declare type StepUpStateMapper<S> = (state: StepUpState) => S;
-export declare function useStepUpState(): StepUpState;
-export declare function useStepUpState<S>(stateMapper: StepUpStateMapper<S>): S;
-export declare const useStepUpActions: () => StepUpActions;
-export declare const redirectByStepUpUrl: (stepUpUrl: string, onRedirectTo: (path: string, opts?: RedirectOptions | undefined) => void, maxAge?: number | undefined) => void;
-export declare const getMaxAgeFromQueryParam: () => number | null;
-export declare const useStepUp: () => any;
-export declare const useIsSteppedUp: () => boolean;

package/auth/stepUp.js

@@ -1,55 +0,0 @@
-import { STEP_UP_REDIRECT_URL_QUERY_PARAM, stepUpReducers, stepUpActions, getQueryParam } from '@frontegg/redux-store';
-import { reducerActionsGenerator, stateHookGenerator, useAuth, useAuthRoutes, useOnRedirectTo } from './hooks';
-import { useCallback } from 'react';
-const defaultMapper = state => state;
-const STEP_UP_MAX_AGE_PARAM_NAME = 'maxAge';
-export function useStepUpState(stateMapper = defaultMapper) {
-  return stateHookGenerator(stateMapper, 'stepUpState');
-}
-export const useStepUpActions = () => reducerActionsGenerator(stepUpActions, stepUpReducers);
-export const redirectByStepUpUrl = (stepUpUrl, onRedirectTo, maxAge) => {
-  const encodedRedirectUrl = encodeURIComponent(window.location.pathname + window.location.search);
-  onRedirectTo(`${stepUpUrl}?${STEP_UP_REDIRECT_URL_QUERY_PARAM}=${encodedRedirectUrl}&${STEP_UP_MAX_AGE_PARAM_NAME}=${maxAge}`, {
-    refresh: false
-  });
-};
-export const getMaxAgeFromQueryParam = () => {
-  const str = getQueryParam(STEP_UP_MAX_AGE_PARAM_NAME);
-  return str === null ? null : +str;
-};
-export const useStepUp = () => {
-  // also custom url?
-  const {
-    stepUpUrl
-  } = useAuthRoutes();
-  const onRedirectTo = useOnRedirectTo();
-
-  // SHOULD CHECK IF USER IS AUTHENTICATED? If not what to do?
-  // WHAT TO DO IF USER IS NOT AUTHENTICATED AND ENTERED DIRECTLY TO THE ROUTE OF STEP UP?
-
-  return useCallback(options => {
-    // SSR handling?
-
-    // A hack because of double calls to useEffect.
-    // It keeps us also when there is a usage of multiple HOCs on the same page -> multiple calls to stepUp
-    // TODO no window for SSR - what to do?
-    if (window.location.search.indexOf(STEP_UP_REDIRECT_URL_QUERY_PARAM) !== -1) return;
-    redirectByStepUpUrl(stepUpUrl, onRedirectTo, options == null ? void 0 : options.maxAge);
-  }, [stepUpUrl, onRedirectTo]);
-};
-const ACR_VALUE = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor';
-const AMR_MFA_VALUE = 'mfa';
-const AMR_ADDITIONAL_VALUE = ['otp', 'sms', 'hwk'];
-export const useIsSteppedUp = () => {
-  // only if don't have amr acr ?? max age???
-  const {
-    amr = [],
-    acr = ''
-  } = useAuth(({
-    user
-  }) => user || {});
-  const isACRValid = acr === ACR_VALUE;
-  const isAMRIncludesMFA = amr.indexOf(AMR_MFA_VALUE) !== -1;
-  const isAMRIncludesMethod = AMR_ADDITIONAL_VALUE.find(method => amr.indexOf(method)) !== undefined;
-  return isACRValid && isAMRIncludesMFA && isAMRIncludesMethod;
-};

package/node/auth/stepUp.js

@@ -1,67 +0,0 @@
-"use strict";
-
-Object.defineProperty(exports, "__esModule", {
-  value: true
-});
-exports.useStepUpActions = exports.useStepUp = exports.useIsSteppedUp = exports.redirectByStepUpUrl = exports.getMaxAgeFromQueryParam = void 0;
-exports.useStepUpState = useStepUpState;
-var _reduxStore = require("@frontegg/redux-store");
-var _hooks = require("./hooks");
-var _react = require("react");
-const defaultMapper = state => state;
-const STEP_UP_MAX_AGE_PARAM_NAME = 'maxAge';
-function useStepUpState(stateMapper = defaultMapper) {
-  return (0, _hooks.stateHookGenerator)(stateMapper, 'stepUpState');
-}
-const useStepUpActions = () => (0, _hooks.reducerActionsGenerator)(_reduxStore.stepUpActions, _reduxStore.stepUpReducers);
-exports.useStepUpActions = useStepUpActions;
-const redirectByStepUpUrl = (stepUpUrl, onRedirectTo, maxAge) => {
-  const encodedRedirectUrl = encodeURIComponent(window.location.pathname + window.location.search);
-  onRedirectTo(`${stepUpUrl}?${_reduxStore.STEP_UP_REDIRECT_URL_QUERY_PARAM}=${encodedRedirectUrl}&${STEP_UP_MAX_AGE_PARAM_NAME}=${maxAge}`, {
-    refresh: false
-  });
-};
-exports.redirectByStepUpUrl = redirectByStepUpUrl;
-const getMaxAgeFromQueryParam = () => {
-  const str = (0, _reduxStore.getQueryParam)(STEP_UP_MAX_AGE_PARAM_NAME);
-  return str === null ? null : +str;
-};
-exports.getMaxAgeFromQueryParam = getMaxAgeFromQueryParam;
-const useStepUp = () => {
-  // also custom url?
-  const {
-    stepUpUrl
-  } = (0, _hooks.useAuthRoutes)();
-  const onRedirectTo = (0, _hooks.useOnRedirectTo)();
-
-  // SHOULD CHECK IF USER IS AUTHENTICATED? If not what to do?
-  // WHAT TO DO IF USER IS NOT AUTHENTICATED AND ENTERED DIRECTLY TO THE ROUTE OF STEP UP?
-
-  return (0, _react.useCallback)(options => {
-    // SSR handling?
-
-    // A hack because of double calls to useEffect.
-    // It keeps us also when there is a usage of multiple HOCs on the same page -> multiple calls to stepUp
-    // TODO no window for SSR - what to do?
-    if (window.location.search.indexOf(_reduxStore.STEP_UP_REDIRECT_URL_QUERY_PARAM) !== -1) return;
-    redirectByStepUpUrl(stepUpUrl, onRedirectTo, options == null ? void 0 : options.maxAge);
-  }, [stepUpUrl, onRedirectTo]);
-};
-exports.useStepUp = useStepUp;
-const ACR_VALUE = 'http://schemas.openid.net/pape/policies/2007/06/multi-factor';
-const AMR_MFA_VALUE = 'mfa';
-const AMR_ADDITIONAL_VALUE = ['otp', 'sms', 'hwk'];
-const useIsSteppedUp = () => {
-  // only if don't have amr acr ?? max age???
-  const {
-    amr = [],
-    acr = ''
-  } = (0, _hooks.useAuth)(({
-    user
-  }) => user || {});
-  const isACRValid = acr === ACR_VALUE;
-  const isAMRIncludesMFA = amr.indexOf(AMR_MFA_VALUE) !== -1;
-  const isAMRIncludesMethod = AMR_ADDITIONAL_VALUE.find(method => amr.indexOf(method)) !== undefined;
-  return isACRValid && isAMRIncludesMFA && isAMRIncludesMethod;
-};
-exports.useIsSteppedUp = useIsSteppedUp;