@tracktor/shared-module 0.23.4 → 1.0.0-beta.0

package/CHANGELOG.md

@@ -1,4 +1,5 @@
 # [Versions](https://github.com/Tracktor/shared-module/releases)
 
-## v0.23.4
-- **[fix]** : QueryClientConfigProvider default options for react query v5
+## v1.0.0-beta.0
+- **[feat]** : add date adapter
+- **[refactor]** : all dependencies are now peer dependencies 

package/README.md

@@ -1,7 +1,7 @@
 # shared-module
 
 > This package contains shared components, hooks and utilities for the Tracktor project.  
-> This package don't use any external dependencies.  
+> This package don't use any external dependencies, only peer dependencies.  
 > This package is not intended to be used outside the Tracktor project.
 
 - [Installation](#Installation)
@@ -17,34 +17,18 @@ yarn add @tracktor/shared-module
 ## Usage
 
 ```typescript jsx
-import { RequireAuth } from "@tracktor/shared-module";
+import { AxiosConfig } from "@tracktor/shared-module";
 ```
 
 ## Inject dependencies with provider
 
-On this exemple below, dependencies are injected with the 
-provider `InjectDependenciesProvider` for the component `RequireAuth`:
-
 ```typescript jsx
-import { InjectDependenciesProvider, RequireAuth } from "@tracktor/shared-module";
-import { Navigate, Outlet, Route, RouterProvider, useLocation } from "react-router-dom";
-import { t } from "i18next";
-
-const MyComponent = () => (
-  <InjectDependenciesProvider t={t} Navigate={Navigate}>
-    <RequireAuth />
-  </InjectDependenciesProvider>
-)
+import { AxiosConfig, InjectDependenciesProvider } from "@tracktor/shared-module";
 
 const App = () => (
-  <InjectDependenciesProvider
-          translate={t}
-          useAuth={useAuth}
-          useLocation={useLocation}
-          Outlet={Outlet}
-          Navigate={Navigate}
-  >
-    <MyComponent/>
+  <InjectDependenciesProvider apiURL={import.meta.env.VITE_API_URL}>
+    <AxiosConfig baseURL={import.meta.env.VITE_API_URL} />
+    ...
   </InjectDependenciesProvider>
 );
 
@@ -52,28 +36,37 @@ export default App;
 ```
 
 ## Providers
-| Module                     | Description                                                             |
-|----------------------------|-------------------------------------------------------------------------|
-| InjectDependenciesProvider | Inject dependencies for other shared component                          |
-| QueryClientConfigProvider  | This provider is QueryClientProvider with custom default config options |
+| Module                     | Description                                    | Dependencies |
+|----------------------------|------------------------------------------------|--------------|
+| InjectDependenciesProvider | Inject dependencies for other shared component | -            |
+| QueryClientConfigProvider  | React Query provider with default config       | React Query  |
 
 
 ## Components
-| 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                                                       |
+| Module          | Type            | Description                                                  | Dependencies                                               |
+|-----------------|-----------------|--------------------------------------------------------------|------------------------------------------------------------|
+| RequireAuth     | React Component | Component for protected routing                              | Axios & react-router-dom                                   |
+| GTMSendPageView | React Component | Send page view event to Google Tag Manager                   | @tracktor/react-google-tag-manager & react-router-dom      |
+| AxiosConfig     | React Component | Initialize Axios instance with custom default config options | Axios                                                      |
+| I18nConfig      | React Component | Initialize i18n instance with custom config options          | i18next & react-i18next & i18next-browser-languagedetector |
+| SentryConfig    | React Component | Initialize Sentry                                            | @sentry/react & react-router-dom                           |
+| MapBoxConfig    | React Component | Initialize MapBox                                            | mapbox-gl                                                  |
 
 ## Hooks
-| Module               | Description                                                               |
-|----------------------|---------------------------------------------------------------------------|
-| useResponseError     | This hook is used to print error messages from the API                    |
-| useInfiniteDataGrid  | his hook is used to handle the infinite scroll of the DataGrid component. |
+| Module              | Description                                                               | Dependencies |
+|---------------------|---------------------------------------------------------------------------|--------------|
+| useAdapter          | Hook with several adapter                                                 | -            |
+| useAuth             | Hook for authentification management                                      | Axios        |
+| useResponseError    | This hook is used to print error messages from the API                    | i18next      |
+| useInfiniteDataGrid | his hook is used to handle the infinite scroll of the DataGrid component. | -            |
 
 ## Config
 | Module                | Description                        |
 |-----------------------|------------------------------------|
 | getOrvalOperationName | Get config for orval operationName |
+
+## Utils
+| Module          | Description          |
+|-----------------|----------------------|
+| dateAdapter     | Adapt given date     |
+| distanceAdapter | Adapt given distance |

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

@@ -1,20 +1,4 @@
-interface AxiosConfigProps<T> {
-    /**
-     * Axios instance
-     */
-    axios: T & {
-        defaults: {
-            baseURL?: string;
-            headers: {
-                common: {
-                    Authorization?: any;
-                };
-                post: {
-                    "Content-Type"?: any;
-                };
-            };
-        };
-    };
+interface AxiosConfigProps {
     /**
      * User local storage key
      * @default user
@@ -43,12 +27,11 @@ interface AxiosConfigProps<T> {
 /**
  * This component initialize Axios instance with custom default config options
  * @param axios
- * @param baseURL
  * @param tokenTypeKey
  * @param userLocalStorageKey
  * @param tokenKey
  * @param postContentType
  * @constructor
  */
-declare const AxiosConfig: <T extends unknown>({ axios, baseURL, tokenTypeKey, userLocalStorageKey, tokenKey, postContentType, }: AxiosConfigProps<T>) => null;
+declare const AxiosConfig: ({ tokenTypeKey, userLocalStorageKey, tokenKey, postContentType, ...props }: AxiosConfigProps) => null;
 export default AxiosConfig;

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

@@ -0,0 +1,6 @@
+/**
+ * Initialize dayjs
+ * @constructor
+ */
+declare const DaysJSConfig: () => null;
+export default DaysJSConfig;

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

@@ -1,22 +1,6 @@
-import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
-export interface GTMSendPageViewProps {
-    /**
-     * useGoogleTagManager is the hook that will be used to send page view
-     */
-    useGoogleTagManager?: InjectDependenciesContextProps["useGoogleTagManager"];
-    /**
-     * Outlet is the component that will be rendered
-     */
-    Outlet?: InjectDependenciesContextProps["Outlet"];
-    /**
-     * useLocation is the hook that will be used to get current pathname
-     */
-    useLocation?: InjectDependenciesContextProps["useLocation"];
-}
 /**
  * This component send page view to Google Tag Manager
- * @param props
  * @constructor
  */
-declare const GTMSendPageView: ({ ...props }: GTMSendPageViewProps) => import("react/jsx-runtime").JSX.Element;
+declare const GTMSendPageView: () => import("react/jsx-runtime").JSX.Element;
 export default GTMSendPageView;

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

@@ -1,45 +1,21 @@
-interface I18nConfigProps<I, L, R> {
+interface I18nConfigProps {
     /**
-     * i18n instance
-     */
-    i18n: I & {
-        use: (plugin: any) => any;
-        init: (options: any) => any;
-        on: (event: string, callback: (lng: string) => void) => void;
-        resolvedLanguage?: string;
-        isInitialized?: boolean;
-    };
-    /**
-     * i18next language detector dependency
-     */
-    LanguageDetector?: L;
-    /**
-     * i18next ressources
-     * exemple
-     * {
-     *   en: {
-     *     roles: {...},
-     *     translation: {...},
-     *   },
-     * }
+     * Resources to initialize with (if not using loading or not appending using addResourceBundle)
      */
     resources?: {
         [language: string]: any;
     };
     /**
-     * i18next innit react plugin dependency
+     * Enable debug mode
      */
-    initReactI18next?: R;
     debug?: boolean;
 }
 /**
  * This component initializes i18n instance with custom config options
  * @param i18n
  * @param debug
- * @param initReactI18next
  * @param resources
- * @param LanguageDetector
  * @constructor
  */
-declare const I18nConfig: <I extends unknown, L extends unknown, R extends unknown>({ i18n, debug, initReactI18next, resources, LanguageDetector, }: I18nConfigProps<I, L, R>) => null;
+declare const I18nConfig: ({ debug, resources }: I18nConfigProps) => null;
 export default I18nConfig;

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

@@ -1,10 +1,4 @@
-interface MapBoxConfigProps<T> {
-    /**
-     * Mapbox instance
-     */
-    mapbox: T & {
-        accessToken: string;
-    };
+interface MapBoxConfigProps {
     /**
      * MapBox access token
      */
@@ -16,5 +10,5 @@ interface MapBoxConfigProps<T> {
  * @param accessToken
  * @constructor
  */
-declare const MapBoxConfig: <T extends unknown>({ mapbox, accessToken }: MapBoxConfigProps<T>) => null;
+declare const MapBoxConfig: ({ accessToken }: MapBoxConfigProps) => null;
 export default MapBoxConfig;

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

@@ -1,35 +1,10 @@
 import { ReactNode } from "react";
-import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 export interface RequireAuthProps {
     /**
      * Login path
      * @default /login
      */
     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
      * @default user
@@ -40,16 +15,23 @@ export interface RequireAuthProps {
      * @default /login
      */
     redirect401Path?: string;
+    /**
+     * Is user logged in
+     */
+    isLogged?: boolean;
+    /**
+     * Fallback component for Suspense
+     */
+    Fallback?: ReactNode;
 }
 /**
  * RequireAuth component for protected routing
- * @param axios
  * @param Fallback
  * @param loginPath
  * @param localStorageKey
  * @param redirect401Path
- * @param props
+ * @param isLogged
  * @constructor
  */
-declare const RequireAuth: ({ Fallback, loginPath, localStorageKey, redirect401Path, ...props }: RequireAuthProps) => import("react/jsx-runtime").JSX.Element;
+declare const RequireAuth: ({ Fallback, loginPath, localStorageKey, redirect401Path, isLogged, }: RequireAuthProps) => import("react/jsx-runtime").JSX.Element;
 export default RequireAuth;

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

@@ -1,67 +1,4 @@
-interface SentryConfigProps<T> {
-    /**
-     * Sentry instance
-     */
-    sentry: T & {
-        init: (config: {
-            /**
-             * Enable debug mode.
-             */
-            debug?: boolean;
-            /**
-             * The Dsn used to connect to Sentry and identify the project. If omitted, the SDK will not send any data to Sentry.
-             */
-            dsn: string;
-            /**
-             * List of integrations that should be installed after SDK was initialized.
-             */
-            integrations: any[];
-            /**
-             * Sample rate to determine trace sampling.
-             *
-             * 0.0 = 0% chance of a given trace being sent (send no traces) 1.0 = 100% chance of a given trace being sent (send
-             * all traces)
-             *
-             * Tracing is enabled if either this or `tracesSampler` is defined. If both are defined, `tracesSampleRate` is
-             * ignored.
-             */
-            tracesSampleRate: number;
-            /**
-             * Sample rate to determine session sampling.
-             */
-            replaysOnErrorSampleRate: number;
-            /**
-             * Sample rate to determine session sampling.
-             */
-            replaysSessionSampleRate: number;
-            /**
-             * List of strings/regex controlling to which outgoing requests the SDK will attach tracing headers.
-             */
-            tracePropagationTargets?: (string | RegExp)[];
-            /**
-             * A pattern for error messages which should not be sent to Sentry.
-             * By default, all errors will be sent.
-             */
-            ignoreErrors?: Array<string | RegExp>;
-            /**
-             * The current environment of your application (e.g. "production").
-             */
-            environment?: string;
-        }) => void;
-        BrowserTracing: any;
-        /**
-         * This function is used to instrument React Router v6.
-         */
-        replayIntegration: any;
-        /**
-         * This function is used to instrument React Router v6.
-         */
-        reactRouterV6Instrumentation: any;
-        /**
-         * Returns true if the SDK is already initialized.
-         */
-        isInitialized: () => boolean;
-    };
+interface SentryConfigProps {
     /**
      * Sentry DSN
      */
@@ -69,13 +6,6 @@ interface SentryConfigProps<T> {
     /**
      * List of integrations that should be installed after SDK was initialized.
      */
-    routingInstrumentationDependencies: {
-        useEffect: any;
-        useLocation: any;
-        useNavigationType: any;
-        createRoutesFromChildren: any;
-        matchRoutes: any;
-    };
     /**
      * List of integrations that should be installed after SDK was initialized.
      */
@@ -125,7 +55,6 @@ interface SentryConfigProps<T> {
  * @param sentry
  * @param integrations
  * @param tracesSampleRate
- * @param routingInstrumentationDependencies
  * @param replaysSessionSampleRate
  * @param replaysOnErrorSampleRate
  * @param tracePropagationTargets
@@ -134,5 +63,5 @@ interface SentryConfigProps<T> {
  * @param environment
  * @constructor
  */
-declare const SentryConfig: <T extends unknown>({ dsn, sentry, integrations, tracesSampleRate, routingInstrumentationDependencies, replaysSessionSampleRate, replaysOnErrorSampleRate, tracePropagationTargets, ignoreErrors, debug, environment, }: SentryConfigProps<T>) => null;
+declare const SentryConfig: ({ dsn, integrations, tracesSampleRate, replaysSessionSampleRate, replaysOnErrorSampleRate, tracePropagationTargets, ignoreErrors, debug, environment, }: SentryConfigProps) => null;
 export default SentryConfig;

package/dist/config/orval/mutator/axiosCustomInstance.d.ts

@@ -1,4 +1,4 @@
-import { AxiosError } from "axios";
+import { AxiosError, AxiosRequestConfig } from "axios";
 export declare const axiosCustomInstance: <T>(config: AxiosRequestConfig) => Promise<T>;
 export default axiosCustomInstance;
 export interface ErrorType<Error> extends AxiosError<Error> {

package/dist/config/orval/mutator/axiosCustomInstance.ts

@@ -1,4 +1,3 @@
-// @ts-ignore
 import axios, { AxiosError, AxiosRequestConfig } from "axios";
 
 axios.create();

package/dist/context/InjectDependenciesProvider.d.ts

@@ -1,72 +1,21 @@
-import { ReactElement, ReactNode } from "react";
+import { ReactNode } from "react";
 export interface InjectDependenciesContextProps {
     /**
      * Children
      */
     children?: ReactNode;
-    /**
-     * Axios instance dependency
-     */
-    axios?: any;
     /**
      * API URL dependency for useAdapter hook
      */
     apiURL?: string;
-    /**
-     * Translate function dependency for useResponseError hook
-     * @param key
-     */
-    translate?(key: any): string;
-    /**
-     * Outlet dependency for RequireAuth component
-     */
-    Outlet?(props: {
-        context?: unknown;
-    }): ReactElement | null;
-    /**
-     * Navigate dependency for RequireAuth component
-     */
-    Navigate?(props: {
-        to: string;
-        replace?: boolean;
-        state?: any;
-    }): null;
-    /**
-     * useLocation dependency for RequireAuth component
-     */
-    useLocation?(): {
-        state: any;
-        pathname: string;
-    };
-    /**
-     * useAuth dependency for RequireAuth component
-     */
-    useAuth?(): {
-        isLogged: boolean;
-    };
-    /**
-     * useGoogleTagManager dependency for GTMSendPageView component
-     */
-    useGoogleTagManager?(): {
-        sendEvent: (event: {
-            event: string;
-            pathname: string;
-        }) => void;
-    };
 }
 export declare const InjectDependenciesContext: import("react").Context<InjectDependenciesContextProps>;
 /**
- * This provider is used to inject major dependencies
- * @param axios
+ *
  * @param children
  * @param translate
- * @param useAuth
- * @param Outlet
- * @param Navigate
- * @param useLocation
- * @param useGoogleTagManager
  * @param apiURL
  * @constructor
  */
-declare const InjectDependenciesProvider: ({ axios, children, translate, useAuth, Outlet, Navigate, useLocation, useGoogleTagManager, apiURL, }: InjectDependenciesContextProps) => import("react/jsx-runtime").JSX.Element;
+declare const InjectDependenciesProvider: ({ children, apiURL }: InjectDependenciesContextProps) => import("react/jsx-runtime").JSX.Element;
 export default InjectDependenciesProvider;

package/dist/context/QueryClientConfigProvider.d.ts

@@ -1,4 +1,4 @@
-import { PropsWithChildren, ReactNode } from "react";
+import { PropsWithChildren } from "react";
 interface QueryClientConfigProviderProps<T> extends PropsWithChildren {
     /**
      * QueryClient instance
@@ -17,13 +17,6 @@ interface QueryClientConfigProviderProps<T> extends PropsWithChildren {
             };
         }): T;
     };
-    /**
-     * QueryClientProvider component
-     */
-    QueryClientProvider: ({ client, children }: {
-        client: T;
-        children: ReactNode;
-    }) => any;
     /**
      * Default options for queries
      */
@@ -37,10 +30,10 @@ interface QueryClientConfigProviderProps<T> extends PropsWithChildren {
 /**
  * This provider is QueryClientProvider with custom default config options
  * @param children
- * @param options
+ * @param defaultQueriesOptions
+ * @param defaultMutationsOptions
  * @param QueryClient
- * @param QueryClientProvider
  * @constructor
  */
-declare const QueryClientConfigProvider: <T extends unknown>({ children, defaultQueriesOptions, defaultMutationsOptions, QueryClient, QueryClientProvider, }: QueryClientConfigProviderProps<T>) => import("react/jsx-runtime").JSX.Element;
+declare const QueryClientConfigProvider: <T extends unknown>({ children, defaultQueriesOptions, defaultMutationsOptions, QueryClient, }: QueryClientConfigProviderProps<T>) => import("react/jsx-runtime").JSX.Element;
 export default QueryClientConfigProvider;

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

@@ -1,4 +1,9 @@
+/**
+ * Use adapter
+ * @returns
+ */
 export declare const useAdapter: () => {
+    dateAdapter: (date: string | number | Date | import("dayjs").Dayjs | null | undefined, format?: string) => string;
     distanceAdapter: (distance?: string | number | null | undefined, metric?: string) => string;
     filePathAdapter: (href?: string | null | {
         pathname: string;

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

@@ -1,17 +1,4 @@
-export interface useAuthParams {
-    /**
-     * Axios instance
-     */
-    defaults: {
-        baseURL?: string;
-        headers: {
-            common: {
-                Authorization?: any;
-            };
-        };
-    };
-}
-declare const useAuth: <T>(axios: useAuthParams & T) => {
+declare const useAuth: () => {
     clearAuthenticationToken: () => void;
     setAuthenticationToken: ({ tokenType, accessToken }: {
         tokenType: string;

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

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

package/dist/main.d.ts

@@ -26,3 +26,5 @@ export { default as useAdapter } from './hooks/useAdapter';
 export * from './hooks/useAdapter';
 export { default as getOrvalConfig } from './config/orval';
 export * from './config/orval';
+export { default as dateAdapter } from './utils/adapter/dateAdapter';
+export { default as distanceAdapter } from './utils/adapter/distanceAdapter';