@frontegg/react-hooks 6.0.3-alpha.2 → 6.1.0

package/FronteggProvider.js

@@ -67,7 +67,7 @@ const HideChildrenIfFronteggRoutes = ({
     return null;
   }
 
-  return _jsx(_Fragment, {
+  return /*#__PURE__*/_jsx(_Fragment, {
     children: children
   });
 };
@@ -100,12 +100,12 @@ const FronteggContent = ({
   }
 
   if (alwaysShowChildren) {
-    return _jsx(_Fragment, {
+    return /*#__PURE__*/_jsx(_Fragment, {
       children: children
     });
   }
 
-  return _jsx(HideChildrenIfFronteggRoutes, {
+  return /*#__PURE__*/_jsx(HideChildrenIfFronteggRoutes, {
     basename: app == null ? void 0 : app.options.basename,
     children: children
   });
@@ -119,7 +119,8 @@ export const FronteggStoreProvider = props => {
     app,
     contextOptions,
     setLoading: setLoadingProps
-  } = props;
+  } = props; // TODO: make this optionals more readable
+
   const context = (_app$options$contextO = app == null ? void 0 : (_app$options4 = app.options) == null ? void 0 : _app$options4.contextOptions) != null ? _app$options$contextO : contextOptions;
   const previewMode = (_app$options$previewM = app == null ? void 0 : (_app$options5 = app.options) == null ? void 0 : _app$options5.previewMode) != null ? _app$options$previewM : false;
   const authOptions = app != null && (_app$options6 = app.options) != null && _app$options6.authOptions ? _extends({}, app.options.authOptions, {
@@ -131,10 +132,10 @@ export const FronteggStoreProvider = props => {
   const store = useMemo(() => createFronteggStore({
     context: context
   }, app, previewMode, authOptions), [app, previewMode]);
-  return _jsx(Provider, {
+  return /*#__PURE__*/_jsx(Provider, {
     context: FronteggStoreContext,
     store: store,
-    children: _jsx(FronteggContent, {
+    children: /*#__PURE__*/_jsx(FronteggContent, {
       setLoading: setLoadingProps != null ? setLoadingProps : setLoading,
       app: app,
       children: children

package/FronteggStoreContext.js

@@ -1,6 +1,6 @@
 import React from 'react';
 import { createSelectorHook, createDispatchHook, createStoreHook } from 'react-redux';
-export const FronteggStoreContext = React.createContext(null);
+export const FronteggStoreContext = /*#__PURE__*/React.createContext(null); // @ts-ignore
 
 if (process.env.NODE_ENV !== 'production') {
   FronteggStoreContext.displayName = 'FronteggStoreContext';

package/audits/hooks.js

@@ -15,6 +15,10 @@ export const useAuditsActions = () => {
   const dispatch = useDispatch();
   return useMemo(() => bindActionCreators(auditsActions, dispatch), [auditsActions]);
 };
+/**
+ * hooks helpers
+ */
+
 export const sliceReducerActionsBy = reducer => {
   const reducerKeys = Object.keys(reducer);
   const reducerActions = reducerKeys.map(key => ({

package/auth/hooks.js

@@ -13,6 +13,24 @@ const defaultMapper = {
 export const useAuth = (stateMapper = defaultMapper.state) => {
   return useSelector(state => stateMapper(state[authStoreName]), shallowEqual);
 };
+/**
+ * ```jsx
+ * export const MyFunctionComponent = () => {
+ *   const { isAuthenticated, user } = useAuth();
+ *   const loginWithRedirect = useLoginWithRedirect();
+ *
+ *   if (!isAuthenticated) {
+ *     loginWithRedirect();
+ *     return <></>;
+ *   }
+ *
+ *   return (<div>Hello User {user.name}</div>);
+ * }
+ * ```
+ *
+ * use this frontegg hook function to get if user is "Authenticated"
+ */
+
 export const useLoginWithRedirect = () => {
   const dispatch = useDispatch();
   return useMemo(() => bindActionCreators(authActions.requestHostedLoginAuthorize, dispatch), [authActions.requestHostedLoginAuthorize]);
@@ -28,11 +46,34 @@ export const useOnRedirectTo = () => {
   return (_context$onRedirectTo = context == null ? void 0 : context.onRedirectTo) != null ? _context$onRedirectTo : ContextHolder.onRedirectTo;
 };
 export const useAuthRoutes = () => useAuth(state => _extends({}, state.routes));
+/**
+ * ```jsx
+ * export const MyFunctionComponent = () => {
+ *   const isAuthenticated  = useIsAuthenticated();
+ *   return isAuthenticated ? <div>Hello User</div> : <Redirect to={'/login'}/>
+ * }
+ * ```
+ *
+ * use this frontegg hook function to get if user is "Authenticated"
+ */
+
 export const useIsAuthenticated = () => useSelector(({
   [authStoreName]: {
     isAuthenticated
   }
 }) => isAuthenticated, shallowEqual);
+/**
+ * ```jsx
+ * export const MyFunctionComponent = () => {
+ *   const user = useAuthUser();
+ *   return user ? <div>Hello {user.name}!</div> : <div>Hello Guest!</div>
+ * }
+ * ```
+ *
+ * use this frontegg hook function to get the authenticated user
+ * the return user is null if not authenticated
+ */
+
 export const useAuthUser = () => {
   const routes = useAuthRoutes();
   const onRedirectTo = useOnRedirectTo();
@@ -59,6 +100,10 @@ export const useAuthUserOrNull = () => {
   }), shallowEqual);
   return user || null;
 };
+/**
+ * hooks helpers
+ */
+
 export const sliceReducerActionsBy = reducer => {
   const reducerKeys = Object.keys(reducer);
   const reducerActions = reducerKeys.map(key => ({

package/auth/securityPolicy.js

@@ -14,7 +14,7 @@ export const usePublicPolicySettings = (loadOnMount = false) => {
     loadPublicSecurityPolicy
   } = useSecurityPolicyActions();
   useEffect(() => {
-    (loadOnMount || !policy) && loadPublicSecurityPolicy();
+    (loadOnMount || !policy) && loadPublicSecurityPolicy(); // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [loadOnMount, loadPublicSecurityPolicy]);
   return {
     loading,
@@ -34,7 +34,7 @@ export const usePublicAuthStrategiesPolicySettings = (loadOnMount = false) => {
     loadPublicAuthStrategiesPolicy
   } = useSecurityPolicyActions();
   useEffect(() => {
-    (loadOnMount || !policy) && loadPublicAuthStrategiesPolicy();
+    (loadOnMount || !policy) && loadPublicAuthStrategiesPolicy(); // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [loadOnMount, loadPublicAuthStrategiesPolicy]);
   return {
     loading,

package/common/index.js

@@ -2,7 +2,7 @@ import _extends from "@babel/runtime/helpers/esm/extends";
 import _objectWithoutPropertiesLoose from "@babel/runtime/helpers/esm/objectWithoutPropertiesLoose";
 const _excluded = ["urlStrategy", "onRedirectTo", "renderByRoute", "customLoader", "customStyles", "contextOptions"];
 import { createContext, useContext } from 'react';
-export const ShadowDomContext = createContext({});
+export const ShadowDomContext = /*#__PURE__*/createContext({});
 export const useShadowDom = () => {
   const context = useContext(ShadowDomContext);
 

package/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.0.3-alpha.2
+/** @license Frontegg v6.1.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/FronteggProvider.js

@@ -88,7 +88,7 @@ const HideChildrenIfFronteggRoutes = ({
     return null;
   }
 
-  return (0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
     children: children
   });
 };
@@ -121,12 +121,12 @@ const FronteggContent = ({
   }
 
   if (alwaysShowChildren) {
-    return (0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
+    return /*#__PURE__*/(0, _jsxRuntime.jsx)(_jsxRuntime.Fragment, {
       children: children
     });
   }
 
-  return (0, _jsxRuntime.jsx)(HideChildrenIfFronteggRoutes, {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(HideChildrenIfFronteggRoutes, {
     basename: app == null ? void 0 : app.options.basename,
     children: children
   });
@@ -140,7 +140,8 @@ const FronteggStoreProvider = props => {
     app,
     contextOptions,
     setLoading: setLoadingProps
-  } = props;
+  } = props; // TODO: make this optionals more readable
+
   const context = (_app$options$contextO = app == null ? void 0 : (_app$options4 = app.options) == null ? void 0 : _app$options4.contextOptions) != null ? _app$options$contextO : contextOptions;
   const previewMode = (_app$options$previewM = app == null ? void 0 : (_app$options5 = app.options) == null ? void 0 : _app$options5.previewMode) != null ? _app$options$previewM : false;
   const authOptions = app != null && (_app$options6 = app.options) != null && _app$options6.authOptions ? (0, _extends2.default)({}, app.options.authOptions, {
@@ -154,10 +155,10 @@ const FronteggStoreProvider = props => {
   const store = (0, _react.useMemo)(() => (0, _reduxStore.createFronteggStore)({
     context: context
   }, app, previewMode, authOptions), [app, previewMode]);
-  return (0, _jsxRuntime.jsx)(Provider, {
+  return /*#__PURE__*/(0, _jsxRuntime.jsx)(Provider, {
     context: _FronteggStoreContext.FronteggStoreContext,
     store: store,
-    children: (0, _jsxRuntime.jsx)(FronteggContent, {
+    children: /*#__PURE__*/(0, _jsxRuntime.jsx)(FronteggContent, {
       setLoading: setLoadingProps != null ? setLoadingProps : setLoading,
       app: app,
       children: children

package/node/FronteggStoreContext.js

@@ -31,7 +31,8 @@ var _react = _interopRequireDefault(require("react"));
 
 var _reactRedux = require("react-redux");
 
-const FronteggStoreContext = _react.default.createContext(null);
+const FronteggStoreContext = /*#__PURE__*/_react.default.createContext(null); // @ts-ignore
+
 
 exports.FronteggStoreContext = FronteggStoreContext;
 

package/node/audits/hooks.js

@@ -31,6 +31,10 @@ const useAuditsActions = () => {
   const dispatch = (0, _FronteggStoreContext.useDispatch)();
   return (0, _react.useMemo)(() => (0, _reduxStore.bindActionCreators)(_reduxStore.auditsActions, dispatch), [_reduxStore.auditsActions]);
 };
+/**
+ * hooks helpers
+ */
+
 
 exports.useAuditsActions = useAuditsActions;
 

package/node/auth/hooks.js

@@ -29,6 +29,24 @@ const defaultMapper = {
 const useAuth = (stateMapper = defaultMapper.state) => {
   return (0, _FronteggStoreContext.useSelector)(state => stateMapper(state[_reduxStore.authStoreName]), _reactRedux.shallowEqual);
 };
+/**
+ * ```jsx
+ * export const MyFunctionComponent = () => {
+ *   const { isAuthenticated, user } = useAuth();
+ *   const loginWithRedirect = useLoginWithRedirect();
+ *
+ *   if (!isAuthenticated) {
+ *     loginWithRedirect();
+ *     return <></>;
+ *   }
+ *
+ *   return (<div>Hello User {user.name}</div>);
+ * }
+ * ```
+ *
+ * use this frontegg hook function to get if user is "Authenticated"
+ */
+
 
 exports.useAuth = useAuth;
 
@@ -56,6 +74,17 @@ const useOnRedirectTo = () => {
 exports.useOnRedirectTo = useOnRedirectTo;
 
 const useAuthRoutes = () => useAuth(state => (0, _extends2.default)({}, state.routes));
+/**
+ * ```jsx
+ * export const MyFunctionComponent = () => {
+ *   const isAuthenticated  = useIsAuthenticated();
+ *   return isAuthenticated ? <div>Hello User</div> : <Redirect to={'/login'}/>
+ * }
+ * ```
+ *
+ * use this frontegg hook function to get if user is "Authenticated"
+ */
+
 
 exports.useAuthRoutes = useAuthRoutes;
 
@@ -64,6 +93,18 @@ const useIsAuthenticated = () => (0, _FronteggStoreContext.useSelector)(({
     isAuthenticated
   }
 }) => isAuthenticated, _reactRedux.shallowEqual);
+/**
+ * ```jsx
+ * export const MyFunctionComponent = () => {
+ *   const user = useAuthUser();
+ *   return user ? <div>Hello {user.name}!</div> : <div>Hello Guest!</div>
+ * }
+ * ```
+ *
+ * use this frontegg hook function to get the authenticated user
+ * the return user is null if not authenticated
+ */
+
 
 exports.useIsAuthenticated = useIsAuthenticated;
 
@@ -96,6 +137,10 @@ const useAuthUserOrNull = () => {
   }), _reactRedux.shallowEqual);
   return user || null;
 };
+/**
+ * hooks helpers
+ */
+
 
 exports.useAuthUserOrNull = useAuthUserOrNull;
 

package/node/auth/securityPolicy.js

@@ -30,7 +30,7 @@ const usePublicPolicySettings = (loadOnMount = false) => {
     loadPublicSecurityPolicy
   } = useSecurityPolicyActions();
   (0, _react.useEffect)(() => {
-    (loadOnMount || !policy) && loadPublicSecurityPolicy();
+    (loadOnMount || !policy) && loadPublicSecurityPolicy(); // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [loadOnMount, loadPublicSecurityPolicy]);
   return {
     loading,
@@ -53,7 +53,7 @@ const usePublicAuthStrategiesPolicySettings = (loadOnMount = false) => {
     loadPublicAuthStrategiesPolicy
   } = useSecurityPolicyActions();
   (0, _react.useEffect)(() => {
-    (loadOnMount || !policy) && loadPublicAuthStrategiesPolicy();
+    (loadOnMount || !policy) && loadPublicAuthStrategiesPolicy(); // eslint-disable-next-line react-hooks/exhaustive-deps
   }, [loadOnMount, loadPublicAuthStrategiesPolicy]);
   return {
     loading,

package/node/common/index.js

@@ -14,7 +14,7 @@ var _objectWithoutPropertiesLoose2 = _interopRequireDefault(require("@babel/runt
 var _react = require("react");
 
 const _excluded = ["urlStrategy", "onRedirectTo", "renderByRoute", "customLoader", "customStyles", "contextOptions"];
-const ShadowDomContext = (0, _react.createContext)({});
+const ShadowDomContext = /*#__PURE__*/(0, _react.createContext)({});
 exports.ShadowDomContext = ShadowDomContext;
 
 const useShadowDom = () => {

package/node/index.js

@@ -1,4 +1,4 @@
-/** @license Frontegg v6.0.3-alpha.2
+/** @license Frontegg v6.1.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.0.3-alpha.2",
+  "version": "6.1.0",
   "main": "./node/index.js",
   "license": "MIT",
   "author": "Frontegg LTD",
   "dependencies": {
     "@babel/runtime": "^7.17.2",
-    "@frontegg/redux-store": "6.0.3-alpha.2",
-    "@frontegg/types": "6.0.3-alpha.2",
+    "@frontegg/redux-store": "6.1.0",
+    "@frontegg/types": "6.1.0",
     "@types/react": "^17.0.0 || ^18.0.0",
     "react-redux": "^7.x"
   },