@tracktor/shared-module 1.0.9 → 2.0.0-beta.1

package/CHANGELOG.md

@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/shared-module/releases)
 
-## v1.0.9
-- **[fix]** : fix and improvement
+## v2.0.0-beta.1
+- **[chore]** : refactor module injection

package/README.md

@@ -1,6 +1,7 @@
-# shared-module
+# @tracktor/shared-module
 
-> This package contains shared components, hooks and utilities for the Tracktor project.
+> This package contains shared components, hooks and utilities for the Tracktor project.  
+> This package use dependencies only with injection.
 > This package is not intended to be used outside the Tracktor project.
 
 - [Installation](#Installation)
@@ -16,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 { InitializeAxiosConfig, InjectDependenciesProvider } from "@tracktor/shared-module";
+import { InjectDependenciesProvider, InitializeAxiosConfig } from "@tracktor/shared-module";
 
 const App = () => (
-  <InjectDependenciesProvider apiURL={import.meta.env.VITE_API_URL}>
-    <InitializeAxiosConfig />
+  <InjectDependenciesProvider apiURL={import.meta.env.VITE_API_URL} libraries={{
+    axios,
+  }}>
+    <InitializeAxiosConfig/>
     ...
   </InjectDependenciesProvider>
 );
@@ -35,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/_commonjsHelpers-f3sTPFkQ.js

@@ -0,0 +1,8 @@
+var o = typeof globalThis < "u" ? globalThis : typeof window < "u" ? window : typeof global < "u" ? global : typeof self < "u" ? self : {};
+function l(e) {
+  return e && e.__esModule && Object.prototype.hasOwnProperty.call(e, "default") ? e.default : e;
+}
+export {
+  o as c,
+  l as g
+};

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;
+declare const GTMSendPageView: ({ ...props }: GTMSendPageViewProps) => import("react/jsx-runtime").JSX.Element;
 export default GTMSendPageView;

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

@@ -1,4 +1,9 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 interface InitializeAxiosConfigProps {
+    /**
+     * Axios library
+     */
+    axios?: NonNullable<InjectDependenciesContextProps["libraries"]>["axios"];
     /**
      * User local storage key
      * @default user

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

@@ -1,10 +1,19 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 interface InitializeDaysJSConfigProps {
+    /**
+     * Dayjs library
+     */
+    dayjs?: NonNullable<InjectDependenciesContextProps["libraries"]>["dayjs"];
+    /**
+     * Language
+     */
     language?: "fr" | "en";
 }
 /**
  * Initialize dayjs
  * @param language
+ * @param props
  * @constructor
  */
-declare const InitializeDaysJSConfig: ({ language }: InitializeDaysJSConfigProps) => null;
+declare const InitializeDaysJSConfig: ({ language, ...props }: InitializeDaysJSConfigProps) => null;
 export default InitializeDaysJSConfig;

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

@@ -1,4 +1,9 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 interface InitializeI18nConfigProps {
+    /**
+     * i18 library
+     */
+    i18?: NonNullable<InjectDependenciesContextProps["libraries"]>["i18"];
     /**
      * Resources to initialize with (if not using loading or not appending using addResourceBundle)
      */
@@ -17,5 +22,5 @@ interface InitializeI18nConfigProps {
  * @param resources
  * @constructor
  */
-declare const InitializeI18nConfig: ({ debug, resources }: InitializeI18nConfigProps) => null;
+declare const InitializeI18nConfig: ({ debug, resources, ...props }: InitializeI18nConfigProps) => null;
 export default InitializeI18nConfig;

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

@@ -1,4 +1,9 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 interface InitializeMapBoxConfigProps {
+    /**
+     * MapBox library
+     */
+    mapbox?: NonNullable<InjectDependenciesContextProps["libraries"]>["mapbox"];
     /**
      * MapBox access token
      */
@@ -6,8 +11,9 @@ interface InitializeMapBoxConfigProps {
 }
 /**
  * This component is used to initialize MapBox
+ * @param mapbox
  * @param accessToken
  * @constructor
  */
-declare const InitializeMapBoxConfig: ({ accessToken }: InitializeMapBoxConfigProps) => null;
+declare const InitializeMapBoxConfig: ({ accessToken, ...props }: InitializeMapBoxConfigProps) => null;
 export default InitializeMapBoxConfig;

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

@@ -1,4 +1,13 @@
+import { InjectDependenciesContextProps } from '../../context/InjectDependenciesProvider';
 interface InitializeSentryConfigProps {
+    /**
+     * Sentry library
+     */
+    sentry?: NonNullable<InjectDependenciesContextProps["libraries"]>["mapbox"];
+    /**
+     * React Router library
+     */
+    reactRouter?: NonNullable<InjectDependenciesContextProps["libraries"]>["reactRouter"];
     /**
      * Sentry DSN
      */
@@ -63,5 +72,5 @@ interface InitializeSentryConfigProps {
  * @param environment
  * @constructor
  */
-declare const InitializeSentryConfig: ({ dsn, integrations, tracesSampleRate, replaysSessionSampleRate, replaysOnErrorSampleRate, tracePropagationTargets, ignoreErrors, debug, environment, }: InitializeSentryConfigProps) => null;
+declare const InitializeSentryConfig: ({ dsn, integrations, tracesSampleRate, replaysSessionSampleRate, replaysOnErrorSampleRate, tracePropagationTargets, ignoreErrors, debug, environment, ...props }: 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

@@ -5,17 +5,55 @@ export interface InjectDependenciesContextProps {
      */
     children?: ReactNode;
     /**
-     * API URL dependency for apiURL
+     * API URL dependency for useAdapter hook
      */
     apiURL?: string;
+    /**
+     * List of dependencies for libraries
+     */
+    libraries?: {
+        axios?: any;
+        dayjs?: 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/QueryClientProviderWithConfig.d.ts

@@ -1,5 +1,14 @@
 import { PropsWithChildren } from "react";
+import { InjectDependenciesContextProps } from './InjectDependenciesProvider';
 interface QueryClientProviderWithConfigProps extends PropsWithChildren {
+    /**
+     * QueryClientProvider from react-query
+     */
+    QueryClientProvider?: NonNullable<NonNullable<InjectDependenciesContextProps["libraries"]>["reactQuery"]>["QueryClientProvider"];
+    /**
+     * QueryClient from react-query
+     */
+    QueryClient?: NonNullable<NonNullable<InjectDependenciesContextProps["libraries"]>["reactQuery"]>["QueryClient"];
     /**
      * Default options for queries
      */
@@ -14,11 +23,10 @@ interface QueryClientProviderWithConfigProps extends PropsWithChildren {
     };
 }
 /**
- * This provider is QueryClientProvider with custom default config options
+ * This provider is QueryClientProviderWithConfig with custom default config options
  * @param children
- * @param defaultQueriesOptions
- * @param defaultMutationsOptions
+ * @param options
  * @constructor
  */
-declare const QueryClientProviderWithConfig: ({ children, defaultQueriesOptions, defaultMutationsOptions, }: QueryClientProviderWithConfigProps) => import("react/jsx-runtime").JSX.Element;
+declare const QueryClientProviderWithConfig: ({ children, defaultQueriesOptions, defaultMutationsOptions, ...props }: QueryClientProviderWithConfigProps) => import("react/jsx-runtime").JSX.Element;
 export default QueryClientProviderWithConfig;

package/dist/{en-bFWwYyLH.js → en-0dymtpPB.js}

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

package/dist/{fr-WPlDe-ow.js → fr-gOnMbGck.js}

@@ -1,6 +1,6 @@
-import { c as m } from "./main-YTkqJNOe.js";
+import { c as m } from "./_commonjsHelpers-f3sTPFkQ.js";
 import o from "dayjs";
-var i = { exports: {} };
+var a = { exports: {} };
 (function(n, s) {
   (function(t, r) {
     n.exports = r(o);
@@ -8,12 +8,12 @@ var i = { exports: {} };
     function r(e) {
       return e && typeof e == "object" && "default" in e ? e : { default: e };
     }
-    var a = r(t), _ = { name: "fr", weekdays: "dimanche_lundi_mardi_mercredi_jeudi_vendredi_samedi".split("_"), weekdaysShort: "dim._lun._mar._mer._jeu._ven._sam.".split("_"), weekdaysMin: "di_lu_ma_me_je_ve_sa".split("_"), months: "janvier_février_mars_avril_mai_juin_juillet_août_septembre_octobre_novembre_décembre".split("_"), monthsShort: "janv._févr._mars_avr._mai_juin_juil._août_sept._oct._nov._déc.".split("_"), weekStart: 1, yearStart: 4, formats: { LT: "HH:mm", LTS: "HH:mm:ss", L: "DD/MM/YYYY", LL: "D MMMM YYYY", LLL: "D MMMM YYYY HH:mm", LLLL: "dddd D MMMM YYYY HH:mm" }, relativeTime: { future: "dans %s", past: "il y a %s", s: "quelques secondes", m: "une minute", mm: "%d minutes", h: "une heure", hh: "%d heures", d: "un jour", dd: "%d jours", M: "un mois", MM: "%d mois", y: "un an", yy: "%d ans" }, ordinal: function(e) {
+    var i = r(t), _ = { name: "fr", weekdays: "dimanche_lundi_mardi_mercredi_jeudi_vendredi_samedi".split("_"), weekdaysShort: "dim._lun._mar._mer._jeu._ven._sam.".split("_"), weekdaysMin: "di_lu_ma_me_je_ve_sa".split("_"), months: "janvier_février_mars_avril_mai_juin_juillet_août_septembre_octobre_novembre_décembre".split("_"), monthsShort: "janv._févr._mars_avr._mai_juin_juil._août_sept._oct._nov._déc.".split("_"), weekStart: 1, yearStart: 4, formats: { LT: "HH:mm", LTS: "HH:mm:ss", L: "DD/MM/YYYY", LL: "D MMMM YYYY", LLL: "D MMMM YYYY HH:mm", LLLL: "dddd D MMMM YYYY HH:mm" }, relativeTime: { future: "dans %s", past: "il y a %s", s: "quelques secondes", m: "une minute", mm: "%d minutes", h: "une heure", hh: "%d heures", d: "un jour", dd: "%d jours", M: "un mois", MM: "%d mois", y: "un an", yy: "%d ans" }, ordinal: function(e) {
       return "" + e + (e === 1 ? "er" : "");
     } };
-    return a.default.locale(_, null, !0), _;
+    return i.default.locale(_, null, !0), _;
   });
-})(i);
+})(a);
 const l = /* @__PURE__ */ Object.freeze(/* @__PURE__ */ Object.defineProperty({
   __proto__: null
 }, Symbol.toStringTag, { value: "Module" }));

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;

package/dist/localizedFormat-EVzQkWw5.js

@@ -0,0 +1,48 @@
+import { g as v, c as y } from "./_commonjsHelpers-f3sTPFkQ.js";
+function b(o, c) {
+  for (var t = 0; t < c.length; t++) {
+    const e = c[t];
+    if (typeof e != "string" && !Array.isArray(e)) {
+      for (const r in e)
+        if (r !== "default" && !(r in o)) {
+          const n = Object.getOwnPropertyDescriptor(e, r);
+          n && Object.defineProperty(o, r, n.get ? n : {
+            enumerable: !0,
+            get: () => e[r]
+          });
+        }
+    }
+  }
+  return Object.freeze(Object.defineProperty(o, Symbol.toStringTag, { value: "Module" }));
+}
+var m = { exports: {} };
+(function(o, c) {
+  (function(t, e) {
+    o.exports = e();
+  })(y, function() {
+    var t = { LTS: "h:mm:ss A", LT: "h:mm A", L: "MM/DD/YYYY", LL: "MMMM D, YYYY", LLL: "MMMM D, YYYY h:mm A", LLLL: "dddd, MMMM D, YYYY h:mm A" };
+    return function(e, r, n) {
+      var s = r.prototype, M = s.format;
+      n.en.formats = t, s.format = function(i) {
+        i === void 0 && (i = "YYYY-MM-DDTHH:mm:ssZ");
+        var l = this.$locale().formats, p = function(d, f) {
+          return d.replace(/(\[[^\]]+])|(LTS?|l{1,4}|L{1,4})/g, function(x, Y, a) {
+            var L = a && a.toUpperCase();
+            return Y || f[a] || t[a] || f[L].replace(/(\[[^\]]+])|(MMMM|MM|DD|dddd)/g, function(j, g, D) {
+              return g || D.slice(1);
+            });
+          });
+        }(i, l === void 0 ? {} : l);
+        return M.call(this, p);
+      };
+    };
+  });
+})(m);
+var u = m.exports;
+const h = /* @__PURE__ */ v(u), z = /* @__PURE__ */ b({
+  __proto__: null,
+  default: h
+}, [u]);
+export {
+  z as l
+};