@tracktor/shared-module 1.0.3 → 1.0.5

package/CHANGELOG.md

@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/shared-module/releases)
 
-## v1.0.3
-- **[fix]** : `MapBoxConfig` & `GTMSendPageView`
+## v1.0.5
+- **[fix]** : name export

package/README.md

@@ -1,7 +1,7 @@
-# shared-module
+# @tracktor/shared-module
 
 > This package contains shared components, hooks and utilities for the Tracktor project.  
-> This package don't use any external dependencies, only peer dependencies.  
+> This package use dependencies only with injection.
 > This package is not intended to be used outside the Tracktor project.
 
 - [Installation](#Installation)
@@ -17,17 +17,19 @@ yarn add @tracktor/shared-module
 ## Usage
 
 ```typescript jsx
-import { AxiosConfig } from "@tracktor/shared-module";
+import { InitializeAxiosConfig } from "@tracktor/shared-module";
 ```
 
 ## Inject dependencies with provider
 
 ```typescript jsx
-import { AxiosConfig, InjectDependenciesProvider } from "@tracktor/shared-module";
+import { InjectDependenciesProvider, InitializeAxiosConfig } from "@tracktor/shared-module";
 
 const App = () => (
-  <InjectDependenciesProvider apiURL={import.meta.env.VITE_API_URL}>
-    <AxiosConfig baseURL={import.meta.env.VITE_API_URL} />
+  <InjectDependenciesProvider apiURL={import.meta.env.VITE_API_URL} libraries={{
+    axios,
+  }}>
+    <InitializeAxiosConfig/>
     ...
   </InjectDependenciesProvider>
 );
@@ -36,10 +38,10 @@ export default App;
 ```
 
 ## Providers
-| Module                     | Description                                    | Dependencies |
-|----------------------------|------------------------------------------------|--------------|
-| InjectDependenciesProvider | Inject dependencies for other shared component | -            |
-| QueryClientConfigProvider  | React Query provider with default config       | React Query  |
+| Module                        | Description                                    | Dependencies |
+|-------------------------------|------------------------------------------------|--------------|
+| InjectDependenciesProvider    | Inject dependencies for other shared component | -            |
+| QueryClientProviderWithConfig | React Query provider with default config       | React Query  |
 
 
 ## Components

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

@@ -1,6 +1,18 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+export interface GTMSendPageViewProps {
+    /**
+     * GTM library from @tracktor
+     */
+    gtm?: NonNullable<InjectDependenciesContextProps["libraries"]>["gtm"];
+    /**
+     * React Router library
+     */
+    reactRouter?: NonNullable<InjectDependenciesContextProps["libraries"]>["reactRouter"];
+}
 /**
  * This component send page view to Google Tag Manager
+ * @param props
  * @constructor
  */
-declare const GTMSendPageView: () => import("react/jsx-runtime").JSX.Element | null;
+declare const GTMSendPageView: ({ ...props }: GTMSendPageViewProps) => import("react/jsx-runtime").JSX.Element;
 export default GTMSendPageView;

package/dist/components/Utils/{AxiosConfig.d.ts → InitializeAxiosConfig.d.ts}

@@ -1,4 +1,4 @@
-interface AxiosConfigProps {
+interface InitializeAxiosConfigProps {
     /**
      * User local storage key
      * @default user
@@ -7,7 +7,7 @@ interface AxiosConfigProps {
     /**
      * Base URL for Axios instance
      */
-    baseURL?: string;
+    apiURL?: string;
     /**
      * Post content type for Axios instance
      * @default application/json
@@ -33,5 +33,5 @@ interface AxiosConfigProps {
  * @param postContentType
  * @constructor
  */
-declare const AxiosConfig: ({ tokenTypeKey, userLocalStorageKey, tokenKey, postContentType, ...props }: AxiosConfigProps) => null;
-export default AxiosConfig;
+declare const InitializeAxiosConfig: ({ tokenTypeKey, userLocalStorageKey, tokenKey, postContentType, ...props }: InitializeAxiosConfigProps) => null;
+export default InitializeAxiosConfig;

package/dist/components/Utils/InitializeDaysJSConfig.d.ts

@@ -0,0 +1,10 @@
+interface InitializeDaysJSConfigProps {
+    language?: "fr" | "en";
+}
+/**
+ * Initialize dayjs
+ * @param language
+ * @constructor
+ */
+declare const InitializeDaysJSConfig: ({ language }: InitializeDaysJSConfigProps) => null;
+export default InitializeDaysJSConfig;

package/dist/components/Utils/{I18nConfig.d.ts → InitializeI18nConfig.d.ts}

@@ -1,4 +1,4 @@
-interface I18nConfigProps {
+interface InitializeI18nConfigProps {
     /**
      * Resources to initialize with (if not using loading or not appending using addResourceBundle)
      */
@@ -17,5 +17,5 @@ interface I18nConfigProps {
  * @param resources
  * @constructor
  */
-declare const I18nConfig: ({ debug, resources }: I18nConfigProps) => null;
-export default I18nConfig;
+declare const InitializeI18nConfig: ({ debug, resources }: InitializeI18nConfigProps) => null;
+export default InitializeI18nConfig;

package/dist/components/Utils/{MapBoxConfig.d.ts → InitializeMapBoxConfig.d.ts}

@@ -1,4 +1,4 @@
-interface MapBoxConfigProps {
+interface InitializeMapBoxConfigProps {
     /**
      * MapBox access token
      */
@@ -10,5 +10,5 @@ interface MapBoxConfigProps {
  * @param accessToken
  * @constructor
  */
-declare const MapBoxConfig: ({ accessToken }: MapBoxConfigProps) => null;
-export default MapBoxConfig;
+declare const InitializeMapBoxConfig: ({ accessToken }: InitializeMapBoxConfigProps) => null;
+export default InitializeMapBoxConfig;

package/dist/components/Utils/{SentryConfig.d.ts → InitializeSentryConfig.d.ts}

@@ -1,4 +1,4 @@
-interface SentryConfigProps {
+interface InitializeSentryConfigProps {
     /**
      * Sentry DSN
      */
@@ -63,5 +63,5 @@ interface SentryConfigProps {
  * @param environment
  * @constructor
  */
-declare const SentryConfig: ({ dsn, integrations, tracesSampleRate, replaysSessionSampleRate, replaysOnErrorSampleRate, tracePropagationTargets, ignoreErrors, debug, environment, }: SentryConfigProps) => null;
-export default SentryConfig;
+declare const InitializeSentryConfig: ({ dsn, integrations, tracesSampleRate, replaysSessionSampleRate, replaysOnErrorSampleRate, tracePropagationTargets, ignoreErrors, debug, environment, }: InitializeSentryConfigProps) => null;
+export default InitializeSentryConfig;

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

@@ -1,10 +1,29 @@
 import { ReactNode } from "react";
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 export interface RequireAuthProps {
+    /**
+     * React router is a libraries dependencies
+     */
+    reactRouter?: NonNullable<InjectDependenciesContextProps["libraries"]>["reactRouter"];
+    /**
+     * Axios is a libraries dependencies
+     */
+    axios?: NonNullable<InjectDependenciesContextProps["libraries"]>["axios"];
+    /**
+     * Is user logged in
+     */
+    isLogged?: () => {
+        isLogged: boolean;
+    } | boolean;
     /**
      * Login path
      * @default /login
      */
     loginPath?: string;
+    /**
+     * Fallback component for Suspense
+     */
+    Fallback?: ReactNode;
     /**
      * Local storage key for user data
      * @default user
@@ -15,25 +34,16 @@ export interface RequireAuthProps {
      * @default /login
      */
     redirect401Path?: string;
-    /**
-     * Is user logged in
-     */
-    isLogged?: () => {
-        isLogged: boolean;
-    } | boolean;
-    /**
-     * Fallback component for Suspense
-     */
-    Fallback?: ReactNode;
 }
 /**
  * RequireAuth component for protected routing
  * @param Fallback
+ * @param isLogged
  * @param loginPath
  * @param localStorageKey
  * @param redirect401Path
- * @param isLogged
+ * @param props
  * @constructor
  */
-declare const RequireAuth: ({ Fallback, loginPath, localStorageKey, redirect401Path, isLogged, }: RequireAuthProps) => import("react/jsx-runtime").JSX.Element;
+declare const RequireAuth: ({ Fallback, isLogged, loginPath, localStorageKey, redirect401Path, ...props }: RequireAuthProps) => import("react/jsx-runtime").JSX.Element;
 export default RequireAuth;

package/dist/context/InjectDependenciesProvider.d.ts

@@ -8,14 +8,53 @@ export interface InjectDependenciesContextProps {
      * API URL dependency for useAdapter hook
      */
     apiURL?: string;
+    /**
+     * List of dependencies for libraries
+     */
+    libraries?: {
+        axios?: any;
+        dayjs?: any;
+        dayjsPlugin?: any[];
+        gtm?: {
+            useGoogleTagManager: () => any;
+        };
+        mapbox?: any;
+        reactRouter?: any;
+        sentry?: any;
+        i18?: {
+            i18next?: any;
+            initReactI18next?: any;
+            languageDetector?: any;
+        };
+        reactQuery?: {
+            QueryClientProvider: ({ client, children }: {
+                client: any;
+                children: ReactNode;
+            }) => any;
+            QueryClient: {
+                new (config: {
+                    defaultOptions: {
+                        queries: {
+                            refetchOnWindowFocus: boolean;
+                            retry: number;
+                            getNextPageParam: (lastPage: [], allPages: [], lastPageParam: number) => number;
+                        };
+                        mutations: {
+                            [key: string]: any;
+                        };
+                    };
+                }): any;
+            };
+        };
+    };
 }
 export declare const InjectDependenciesContext: import("react").Context<InjectDependenciesContextProps>;
 /**
- *
+ * This provider is used to inject major dependencies
  * @param children
- * @param translate
+ * @param librariesDependencies
  * @param apiURL
  * @constructor
  */
-declare const InjectDependenciesProvider: ({ children, apiURL }: InjectDependenciesContextProps) => import("react/jsx-runtime").JSX.Element;
+declare const InjectDependenciesProvider: ({ children, apiURL, libraries }: InjectDependenciesContextProps) => import("react/jsx-runtime").JSX.Element;
 export default InjectDependenciesProvider;

package/dist/context/{QueryClientConfigProvider.d.ts → QueryClientProviderWithConfig.d.ts}

@@ -1,5 +1,5 @@
 import { PropsWithChildren } from "react";
-interface QueryClientConfigProviderProps extends PropsWithChildren {
+interface QueryClientProviderWithConfigProps extends PropsWithChildren {
     /**
      * Default options for queries
      */
@@ -17,5 +17,5 @@ interface QueryClientConfigProviderProps extends PropsWithChildren {
  * @param defaultMutationsOptions
  * @constructor
  */
-declare const QueryClientConfigProvider: ({ children, defaultQueriesOptions, defaultMutationsOptions }: QueryClientConfigProviderProps) => import("react/jsx-runtime").JSX.Element;
-export default QueryClientConfigProvider;
+declare const QueryClientProviderWithConfig: ({ children, defaultQueriesOptions, defaultMutationsOptions, }: QueryClientProviderWithConfigProps) => import("react/jsx-runtime").JSX.Element;
+export default QueryClientProviderWithConfig;

package/dist/{en-NkuEPb7W.js → en-1o5U8jiL.js}

@@ -1,4 +1,4 @@
-import { c as o } from "./main-PeA08MpJ.js";
+import { c as o } from "./main-EkPM5n5x.js";
 var a = { exports: {} };
 (function(t, _) {
   (function(r, e) {

package/dist/{fr-zJ2AMR0z.js → fr-EMqEUav3.js}

@@ -1,4 +1,4 @@
-import { c as m } from "./main-PeA08MpJ.js";
+import { c as m } from "./main-EkPM5n5x.js";
 import o from "dayjs";
 var i = { exports: {} };
 (function(n, s) {

package/dist/hooks/useAdapter/useAdapter.d.ts

@@ -1,9 +1,20 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+export interface useAdapterParams {
+    /**
+     * Dayjs library
+     */
+    dayjs?: NonNullable<InjectDependenciesContextProps["libraries"]>["dayjs"];
+    /**
+     * Translation key returned for the unknown error
+     */
+    unknownErrorTranslationKey?: string;
+}
 /**
  * Use adapter
  * @returns
  */
-export declare const useAdapter: () => {
-    dateAdapter: (date: string | number | import("dayjs").Dayjs | Date | null | undefined, format?: string) => string;
+export declare const useAdapter: (params?: useAdapterParams) => {
+    dateAdapter: (date: string | number | Date | null | undefined, format?: string) => any;
     distanceAdapter: (distance?: string | number | null | undefined, metric?: string) => string;
     filePathAdapter: (href?: string | null | {
         pathname: string;

package/dist/hooks/useAuth/useAuth.d.ts

@@ -1,4 +1,11 @@
-declare const useAuth: () => {
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
+interface useAuthParams {
+    /**
+     * Axios library
+     */
+    axios?: NonNullable<InjectDependenciesContextProps["libraries"]>["axios"];
+}
+declare const useAuth: (params?: useAuthParams) => {
     clearAuthenticationToken: () => void;
     setAuthenticationToken: ({ tokenType, accessToken }: {
         tokenType: string;

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

@@ -1,3 +1,4 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 export interface ResponseError {
     data?: {
         code?: number;
@@ -12,6 +13,10 @@ export interface ResponseError {
     };
 }
 export interface useResponseErrorParams {
+    /**
+     * i18 library
+     */
+    i18?: NonNullable<InjectDependenciesContextProps["libraries"]>["i18"];
     /**
      * Translation key returned for the unknown error
      */
@@ -23,6 +28,6 @@ export interface useResponseErrorParams {
  */
 export declare const useResponseError: <T = ResponseError>(params?: useResponseErrorParams) => {
     getErrorCode: (error?: any) => string;
-    printError: (error?: any) => string;
+    printError: (error?: any) => any;
 };
 export default useResponseError;