@tracktor/shared-module 0.2.1 → 0.4.0

package/CHANGELOG.md

@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/react-google-tag-manager/releases)
 
-## v0.2.1
-- **[fix]** : `printError` inside `useResponseError` 
+## v0.4.0
+- **[feat]** : redirect 401 with router in component `RequireAuth`

package/dist/components/GTMSendPageView/GTMSendPageView.d.ts

@@ -0,0 +1,8 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+export interface GTMSendPageViewProps {
+    useGoogleTagManager?: InjectDependenciesContextProps["useGoogleTagManager"];
+    Outlet?: InjectDependenciesContextProps["Outlet"];
+    useLocation?: InjectDependenciesContextProps["useLocation"];
+}
+declare const GTMSendPageView: ({ ...props }: GTMSendPageViewProps) => JSX.Element;
+export default GTMSendPageView;

package/dist/components/GTMSendPageView/index.d.ts

@@ -0,0 +1,3 @@
+import GTMSendPageView from "./GTMSendPageView";
+export default GTMSendPageView;
+export * from "./GTMSendPageView";

package/dist/components/RequireAuth/RequireAuth.d.ts

@@ -1,32 +1,52 @@
-import { ReactElement, ReactNode } from "react";
-interface NavigateProps {
-    to: string;
-    replace?: boolean;
-    state?: any;
-}
-interface Location {
-    state: any;
-}
-interface Auth {
-    isLogged: boolean;
-}
-interface OutletProps {
-    context?: unknown;
-}
+import { ReactNode } from "react";
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 export interface RequireAuthProps {
-    Outlet?: (props: OutletProps) => ReactElement | null;
-    Navigate?: (props: NavigateProps) => null;
+    /**
+     *
+     */
     loginPath?: string;
+    /**
+     * Fallback component for Suspense
+     */
     Fallback?: ReactNode;
-    useLocation?(): Location;
-    useAuth?(): Auth;
+    /**
+     * Outlet dependency for RequireAuth component
+     */
+    Outlet?: InjectDependenciesContextProps["Outlet"];
+    /**
+     * Navigate dependency for RequireAuth component
+     */
+    Navigate?: InjectDependenciesContextProps["Navigate"];
+    /**
+     * useLocation dependency for RequireAuth component
+     */
+    useLocation?: InjectDependenciesContextProps["useLocation"];
+    /**
+     * useAuth dependency for RequireAuth component
+     */
+    useAuth?: InjectDependenciesContextProps["useAuth"];
+    /**
+     * Axios instance dependency is used for intercepting 401 responses
+     */
+    axios?: InjectDependenciesContextProps["axios"];
+    /**
+     * Local storage key for user data
+     */
+    localStorageKey?: string;
+    /**
+     * Redirect path for 401 responses
+     */
+    redirect401Path?: string;
 }
 /**
  * RequireAuth component for protected routing
+ * @param axios
  * @param Fallback
  * @param loginPath
+ * @param localStorageKey
+ * @param redirect401Path
  * @param props
  * @constructor
  */
-declare const RequireAuth: ({ Fallback, loginPath, ...props }: RequireAuthProps) => JSX.Element;
+declare const RequireAuth: ({ Fallback, loginPath, localStorageKey, redirect401Path, ...props }: RequireAuthProps) => JSX.Element;
 export default RequireAuth;

package/dist/context/InjectDependenciesProvider.d.ts

@@ -1,33 +1,55 @@
-import { ReactNode } from "react";
-import type { RequireAuthProps } from '../components/RequireAuth';
-import type { useResponseErrorParams } from '../hooks/useResponseError';
+import { ReactElement, ReactNode } from "react";
 export interface InjectDependenciesContextProps {
     /**
      * Children
      */
     children?: ReactNode;
+    /**
+     * Axios instance dependency
+     */
+    axios?: any;
     /**
      * Translate function dependency for useResponseError hook
      * @param str
      */
-    translate?: useResponseErrorParams["translate"];
+    translate?(str: string): string;
     /**
      * Outlet dependency for RequireAuth component
      */
-    Outlet?: RequireAuthProps["Outlet"];
+    Outlet?(props: {
+        context?: unknown;
+    }): ReactElement | null;
     /**
      * Navigate dependency for RequireAuth component
      */
-    Navigate?: RequireAuthProps["Navigate"];
+    Navigate?(props: {
+        to: string;
+        replace?: boolean;
+        state?: any;
+    }): null;
     /**
      * useLocation dependency for RequireAuth component
      */
-    useLocation?: RequireAuthProps["useLocation"];
+    useLocation?(): {
+        state: any;
+        pathname: string;
+    };
     /**
      * useAuth dependency for RequireAuth component
      */
-    useAuth?: RequireAuthProps["useAuth"];
+    useAuth?(): {
+        isLogged: boolean;
+    };
+    /**
+     * useGoogleTagManager dependency for GTMSendPageView component
+     */
+    useGoogleTagManager?(): {
+        sendEvent: (event: {
+            event: string;
+            pathname: string;
+        }) => void;
+    };
 }
 export declare const InjectDependenciesContext: import("react").Context<InjectDependenciesContextProps>;
-declare const InjectDependenciesProvider: ({ children, translate, useAuth, Outlet, Navigate, useLocation }: InjectDependenciesContextProps) => JSX.Element;
+declare const InjectDependenciesProvider: ({ axios, children, translate, useAuth, Outlet, Navigate, useLocation, useGoogleTagManager, }: InjectDependenciesContextProps) => JSX.Element;
 export default InjectDependenciesProvider;

package/dist/hooks/useResponseError/useResponseError.d.ts

@@ -1,3 +1,4 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 export interface ResponseError {
     data?: {
         code?: number;
@@ -16,7 +17,7 @@ export interface useResponseErrorParams {
      * Translation function if you want to use your own translation function
      * @param str
      */
-    translate?: (str: string) => string;
+    translate?: InjectDependenciesContextProps["translate"];
     /**
      * Translation key returned for the unknown error
      */

package/dist/main.d.ts

@@ -1,5 +1,7 @@
 export { default as RequireAuth } from './components/RequireAuth';
 export * from './components/RequireAuth';
+export { default as GTMSendPageView } from './components/GTMSendPageView';
+export * from './components/GTMSendPageView';
 export { default as InjectDependenciesProvider } from './context/InjectDependenciesProvider';
 export * from './context/InjectDependenciesProvider';
 export { default as useResponseError } from './hooks/useResponseError';