@frontegg/react-hooks 6.161.0 → 6.162.0-alpha.0

package/auth/index.d.ts

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

package/auth/index.js

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

package/auth/stepUp/consts.d.ts

@@ -0,0 +1,4 @@
+/**
+ * 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,4 @@
+/**
+ * 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/index.d.ts

@@ -0,0 +1,2 @@
+export * from './stepUp';
+export * from './interfaces';

package/auth/stepUp/index.js

@@ -0,0 +1,2 @@
+export * from './stepUp';
+export * from './interfaces';

package/auth/stepUp/interfaces.d.ts

@@ -0,0 +1,14 @@
+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;
+}
+/**
+ * useIsSteppedUp hook options
+ */
+export interface UseIsSteppedUpOptions {
+    maxAge?: number;
+}

package/auth/stepUp/interfaces.js

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

package/auth/stepUp/stepUp.d.ts

@@ -0,0 +1,27 @@
+import { StepUpState, StepUpActions } from '@frontegg/redux-store';
+import { RedirectOptions } from '@frontegg/rest-api';
+import { StepUpStateMapper, UseIsSteppedUpOptions } 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 }?: UseIsSteppedUpOptions) => boolean;

package/auth/stepUp/stepUp.js

@@ -0,0 +1,66 @@
+import { FRONTEGG_AFTER_AUTH_REDIRECT_URL, stepUpReducers, stepUpActions, getSearchParam, isSteppedUp } from '@frontegg/redux-store';
+import { reducerActionsGenerator, stateHookGenerator, useAuthRoutes, useAuthUser, useOnRedirectTo } from '../hooks';
+import { useCallback } from 'react';
+import { 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();
+  return isSteppedUp({
+    amr,
+    acr,
+    auth_time,
+    maxAge
+  });
+};

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.161.0
+/** @license Frontegg v6.162.0-alpha.0
  *
  * 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

@@ -141,6 +141,18 @@ Object.keys(_login).forEach(function (key) {
     }
   });
 });
+var _stepUp = require("./stepUp");
+Object.keys(_stepUp).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (Object.prototype.hasOwnProperty.call(_exportNames, key)) return;
+  if (key in exports && exports[key] === _stepUp[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _stepUp[key];
+    }
+  });
+});
 var _mfa = require("./mfa");
 Object.keys(_mfa).forEach(function (key) {
   if (key === "default" || key === "__esModule") return;

package/node/auth/stepUp/consts.js

@@ -0,0 +1,11 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.STEP_UP_MAX_AGE_PARAM_NAME = void 0;
+/**
+ * The name of the query param that contains the max age of the step up
+ */
+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/index.js

@@ -0,0 +1,27 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _stepUp = require("./stepUp");
+Object.keys(_stepUp).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _stepUp[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _stepUp[key];
+    }
+  });
+});
+var _interfaces = require("./interfaces");
+Object.keys(_interfaces).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _interfaces[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _interfaces[key];
+    }
+  });
+});

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,78 @@
+"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)();
+  return (0, _reduxStore.isSteppedUp)({
+    amr,
+    acr,
+    auth_time,
+    maxAge
+  });
+};
+exports.useIsSteppedUp = useIsSteppedUp;

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.161.0
+/** @license Frontegg v6.162.0-alpha.0
  *
  * 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.161.0",
+  "version": "6.162.0-alpha.0",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",
   "dependencies": {
     "@babel/runtime": "^7.18.6",
-    "@frontegg/redux-store": "6.161.0",
-    "@frontegg/types": "6.161.0",
+    "@frontegg/redux-store": "6.162.0-alpha.0",
+    "@frontegg/types": "6.162.0-alpha.0",
     "@types/react": "*",
     "get-value": "^3.0.1",
     "react-redux": "^7.x"