@tracktor/shared-module 0.3.0 → 0.5.0

package/CHANGELOG.md

@@ -1,4 +1,7 @@
 # [Versions](https://github.com/Tracktor/react-google-tag-manager/releases)
 
-## v0.3.0
-- **[feat]** : Add GTMSendPageView
+## v0.5.0
+- **[feat]** : add config component `AxiosConfig`
+- **[feat]** : add config component `I18nConfig`
+- **[feat]** : add config component `SentryConfig`
+- **[feat]** : add provider `QueryClientConfigProvider`

package/README.md

@@ -50,3 +50,17 @@ const App = () => (
 
 export default App;
 ```
+
+## Exported module
+
+
+| Module                     | Type            | Description                                                             |
+|----------------------------|-----------------|-------------------------------------------------------------------------|
+| RequireAuth                | React Component | Component for protected routing                                         |
+| GTMSendPageView            | React Component | Send page view event to Google Tag Manager                              |
+| AxiosConfig                | React Component | Initialize Axios instance with custom default config options            |
+| I18nConfig                 | React Component | Initialize i18n instance with custom config options                     |
+| SentryConfig               | React Component | Initialize Sentry                                                       |
+| InjectDependenciesProvider | React Provider  | Inject dependencies for other shared component                          |
+| QueryClientConfigProvider  | React Provider  | This provider is QueryClientProvider with custom default config options |
+| useResponseError           | React Hook      | This hook is used to print error messages from the API                  |

package/dist/components/utils/AxiosConfig.d.ts

@@ -0,0 +1,40 @@
+interface AxiosConfigProps<T> {
+    /**
+     * Axios instance
+     */
+    axios: T & {
+        defaults: {
+            baseURL?: string;
+            headers: {
+                common: {
+                    Authorization?: any;
+                };
+                post: {
+                    "Content-Type"?: any;
+                };
+            };
+        };
+    };
+    /**
+     * User local storage key
+     */
+    userLocalStorageKey?: string;
+    /**
+     * Base URL for Axios instance
+     */
+    baseURL?: string;
+    /**
+     * Post content type for Axios instance
+     */
+    postContentType?: string;
+}
+/**
+ * This component initialize Axios instance with custom default config options
+ * @param axios
+ * @param baseURL
+ * @param userLocalStorageKey
+ * @param postContentType
+ * @constructor
+ */
+declare const AxiosConfig: <T extends unknown>({ axios, baseURL, userLocalStorageKey, postContentType, }: AxiosConfigProps<T>) => null;
+export default AxiosConfig;

package/dist/components/{GTMSendPageView → utils}/GTMSendPageView.d.ts

@@ -4,5 +4,10 @@ export interface GTMSendPageViewProps {
     Outlet?: InjectDependenciesContextProps["Outlet"];
     useLocation?: InjectDependenciesContextProps["useLocation"];
 }
+/**
+ * This component send page view to Google Tag Manager
+ * @param props
+ * @constructor
+ */
 declare const GTMSendPageView: ({ ...props }: GTMSendPageViewProps) => JSX.Element;
 export default GTMSendPageView;

package/dist/components/utils/I18nConfig.d.ts

@@ -0,0 +1,26 @@
+interface I18nConfigProps<I, L, R> {
+    /**
+     * i18n instance
+     */
+    i18n: I & {
+        use: (plugin: any) => any;
+        init: (options: any) => any;
+        on: (event: string, callback: (lng: string) => void) => void;
+        resolvedLanguage?: string;
+    };
+    LanguageDetector?: L;
+    resources?: {
+        [language: string]: any;
+    };
+    initReactI18next?: R;
+}
+/**
+ * This component initializes i18n instance with custom config options
+ * @param i18n
+ * @param initReactI18next
+ * @param resources
+ * @param LanguageDetector
+ * @constructor
+ */
+declare const I18nConfig: <I extends unknown, L extends unknown, R extends unknown>({ i18n, initReactI18next, resources, LanguageDetector, }: I18nConfigProps<I, L, R>) => null;
+export default I18nConfig;

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

@@ -0,0 +1,52 @@
+import { ReactNode } from "react";
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+export interface RequireAuthProps {
+    /**
+     *
+     */
+    loginPath?: string;
+    /**
+     * Fallback component for Suspense
+     */
+    Fallback?: ReactNode;
+    /**
+     * 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, localStorageKey, redirect401Path, ...props }: RequireAuthProps) => JSX.Element;
+export default RequireAuth;

package/dist/components/utils/SentryConfig.d.ts

@@ -0,0 +1,22 @@
+interface SentryConfigProps<T> {
+    /**
+     * Sentry instance
+     */
+    sentry: T & {
+        init: (config: {
+            dsn: string;
+            integrations: any[];
+            tracesSampleRate: number;
+        }) => void;
+        BrowserTracing: any;
+    };
+    dsn: string;
+}
+/**
+ * This component is used to initialize Sentry
+ * @param dsn
+ * @param sentry
+ * @constructor
+ */
+declare const SentryConfig: <T extends unknown>({ dsn, sentry }: SentryConfigProps<T>) => null;
+export default SentryConfig;

package/dist/context/InjectDependenciesProvider.d.ts

@@ -4,6 +4,10 @@ export interface InjectDependenciesContextProps {
      * Children
      */
     children?: ReactNode;
+    /**
+     * Axios instance dependency
+     */
+    axios?: any;
     /**
      * Translate function dependency for useResponseError hook
      * @param str
@@ -47,5 +51,17 @@ export interface InjectDependenciesContextProps {
     };
 }
 export declare const InjectDependenciesContext: import("react").Context<InjectDependenciesContextProps>;
-declare const InjectDependenciesProvider: ({ children, translate, useAuth, Outlet, Navigate, useLocation, useGoogleTagManager, }: InjectDependenciesContextProps) => JSX.Element;
+/**
+ * This provider is used to inject dependencies to components
+ * @param axios
+ * @param children
+ * @param translate
+ * @param useAuth
+ * @param Outlet
+ * @param Navigate
+ * @param useLocation
+ * @param useGoogleTagManager
+ * @constructor
+ */
+declare const InjectDependenciesProvider: ({ axios, children, translate, useAuth, Outlet, Navigate, useLocation, useGoogleTagManager, }: InjectDependenciesContextProps) => JSX.Element;
 export default InjectDependenciesProvider;

package/dist/context/QueryClientProvider.d.ts

@@ -0,0 +1,36 @@
+import { PropsWithChildren, ReactNode } from "react";
+interface QueryClientConfigProviderProps<T> extends PropsWithChildren {
+    /**
+     * QueryClient instance
+     */
+    QueryClient: {
+        new (config: {
+            defaultOptions: {
+                queries: {
+                    refetchOnWindowFocus: boolean;
+                    retry: number;
+                };
+            };
+        }): T;
+    };
+    /**
+     * QueryClientProvider component
+     */
+    QueryClientProvider: ({ client, children }: {
+        client: T;
+        children: ReactNode;
+    }) => any;
+    defaultOptions?: {
+        [key: string]: any;
+    };
+}
+/**
+ * This provider is QueryClientProvider with custom default config options
+ * @param children
+ * @param options
+ * @param QueryClient
+ * @param QueryClientProvider
+ * @constructor
+ */
+declare const QueryClientConfigProvider: <T extends unknown>({ children, defaultOptions, QueryClient, QueryClientProvider, }: QueryClientConfigProviderProps<T>) => JSX.Element;
+export default QueryClientConfigProvider;

package/dist/main.d.ts

@@ -1,8 +1,16 @@
-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 RequireAuth } from './components/utils/RequireAuth';
+export * from './components/utils/RequireAuth';
+export { default as GTMSendPageView } from './components/utils/GTMSendPageView';
+export * from './components/utils/GTMSendPageView';
+export { default as AxiosConfig } from './components/utils/AxiosConfig';
+export * from './components/utils/AxiosConfig';
+export { default as I18nConfig } from './components/utils/I18nConfig';
+export * from './components/utils/I18nConfig';
+export { default as SentryConfig } from './components/utils/SentryConfig';
+export * from './components/utils/SentryConfig';
 export { default as InjectDependenciesProvider } from './context/InjectDependenciesProvider';
 export * from './context/InjectDependenciesProvider';
+export { default as QueryClientProvider } from './context/QueryClientProvider';
+export * from './context/QueryClientProvider';
 export { default as useResponseError } from './hooks/useResponseError';
 export * from './hooks/useResponseError';