@tracktor/shared-module 0.0.3 → 0.2.0

package/CHANGELOG.md

@@ -1,4 +1,4 @@
 # [Versions](https://github.com/Tracktor/react-google-tag-manager/releases)
 
-## v0.0.3
-- **[docs]** : readme.md
+## v0.2.0
+- **[refactor]** : export module structure

package/README.md

@@ -1,14 +1,12 @@
 # shared-module
 
-> This package contains shared components and utilities for the Tracktor project.
-> This package don't use any external dependencies.
-> Note: This package is not intended to be used outside the Tracktor project.
+> This package contains shared components, hooks and utilities for the Tracktor project.  
+> This package don't use any external dependencies.  
+> This package is not intended to be used outside the Tracktor project.
 
 - [Installation](#Installation)
 - [Usage](#Usage)
 - [Inject dependencies with provider](#Inject-dependencies-with-provider)
-- [Package](#Package)
-
 
 ## Installation
 
@@ -21,12 +19,6 @@ yarn add @tracktor/shared-module
 ```typescript jsx
 import { RequireAuth } from "@tracktor/shared-module";
 ```
-Or you can import only the package do you 
-need with `@tracktor/shared-module/{package}` like this:
-
-```typescript jsx
-import { RequireAuth } from "@tracktor/shared-module/auth";
-```
 
 ## Inject dependencies with provider
 
@@ -34,8 +26,7 @@ On this exemple below, dependencies are injected with the
 provider `InjectDependenciesProvider` for the component `RequireAuth`:
 
 ```typescript jsx
-import { RequireAuth } from "@tracktor/shared-module/auth"
-import { InjectDependenciesProvider } from "@tracktor/shared-module/context";
+import { InjectDependenciesProvider, RequireAuth } from "@tracktor/shared-module";
 import { Navigate, Outlet, Route, RouterProvider, useLocation } from "react-router-dom";
 import { t } from "i18next";
 
@@ -59,11 +50,3 @@ const App = () => (
 
 export default App;
 ```
-
-## Package
-
-| Package | Description                                                                                              |
-|---------|----------------------------------------------------------------------------------------------------------|
-| api     | This package contains the api to communicate with the backend.                                           |
-| auth    | This package contains the component `RequireAuth` that can be used to protect routes.                    |
-| context | This package contains the provider `InjectDependenciesProvider` that can be used to inject dependencies. |

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

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

package/dist/context/InjectDependenciesProvider.d.ts

@@ -1,6 +1,6 @@
 import { ReactNode } from "react";
-import type { useResponseErrorParams } from '../api/hooks/useResponseError';
-import type { RequireAuthProps } from '../auth/components/RequireAuth';
+import type { RequireAuthProps } from '../components/RequireAuth';
+import type { useResponseErrorParams } from '../hooks/useResponseError';
 export interface InjectDependenciesContextProps {
     /**
      * Children

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

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

package/dist/{api/hooks → hooks/useResponseError}/useResponseError.d.ts

@@ -1,4 +1,16 @@
-import type ResponseError from '../../api/types/error';
+export interface ResponseError {
+    data?: {
+        code?: number;
+        message?: string;
+        payload?: any;
+        reason?: string;
+        detail?: {
+            loc?: [];
+            msg?: string;
+            type?: string;
+        }[];
+    };
+}
 export interface useResponseErrorParams {
     /**
      * Translation function if you want to use your own translation function
@@ -13,7 +25,7 @@ export interface useResponseErrorParams {
 /**
  * This hook is used to print error messages from the API
  */
-export declare const useResponseError: (params?: useResponseErrorParams) => {
-    printError: (response?: ResponseError) => string;
+export declare const useResponseError: <T = ResponseError>(params?: useResponseErrorParams) => {
+    printError: (response?: any) => string;
 };
 export default useResponseError;

package/dist/main.d.ts

@@ -1,3 +1,6 @@
-export * from './api/main';
-export * from './auth/main';
-export * from './context/main';
+export { default as RequireAuth } from './components/RequireAuth';
+export * from './components/RequireAuth';
+export { default as InjectDependenciesProvider } from './context/InjectDependenciesProvider';
+export * from './context/InjectDependenciesProvider';
+export { default as useResponseError } from './hooks/useResponseError';
+export * from './hooks/useResponseError';