@tracktor/shared-module 2.31.0 → 2.32.0

package/README.md

@@ -39,10 +39,10 @@ export default App;
 ```
 
 ## Providers
-| Module                        | Description                                         | Dependencies |
-|-------------------------------|-----------------------------------------------------|--------------|
-| InjectDependenciesProvider    | Inject dependencies for other shared component      | -            |
-| QueryClientProviderWithConfig | 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  |
 | ChatProvider                  | Shared WebSocket chat connection provider via context | -            |
 
 
@@ -56,22 +56,26 @@ export default App;
 | InitializeSentryConfig | React Component | Initialize Sentry                                   | @sentry/react & react-router-dom                           |
 | InitializeMapBoxConfig | React Component | Initialize MapBox                                   | mapbox-gl                                                  |
 | InitializeDaysJSConfig | React Component | Initialize DayJS                                    | dayjs                                                      |
+| InitializeHubSpot      | React Component | Initialize HubSpot chat widget                      | -                                                          |
 | PreloadErrorHandler    | React Component | his component is used to handle preload error.      | dayjs                                                      |
 
 ## Hooks
-| 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 | This hook is used to handle the infinite scroll of the DataGrid component. | -            |
-| useCurrentLanguage  | This get the current language of app                                       | -            |
-| useFilters          | Hook to handle filter                                                      | -            |
-| useChat             | Hook to consume the ChatProvider context (threads, messaging, presence)    | ChatProvider |
+| Module              | Description                                                                | Dependencies      |
+|---------------------|----------------------------------------------------------------------------|-------------------|
+| useAdapter          | Hook with several adapter                                                  | -                 |
+| useAuth             | Hook for authentification management                                       | Axios             |
+| useHubSpot          | Hook to interact with the HubSpot chat widget (toggle, availability)       | InitializeHubSpot |
+| useResponseError    | This hook is used to print error messages from the API                     | i18next           |
+| useInfiniteDataGrid | This hook is used to handle the infinite scroll of the DataGrid component. | -                 |
+| useCurrentLanguage  | This get the current language of app                                       | -                 |
+| useFilters          | Hook to handle filter                                                      | -                 |
+| useChat             | Hook to consume the ChatProvider context (threads, messaging, presence)    | ChatProvider      |
 
 
 ## WebSocket
 
+### Chat
+
 The chat module provides a WebSocket client for the Tracktor chat protocol (`/v2/threads/ws`). It supports thread subscription, messaging, read receipts, and presence events.
 
 **With the React provider** (recommended):
@@ -131,12 +135,11 @@ client.joinThread("thread-1");
 client.sendMessage("thread-1", "Hello!");
 ```
 
-### Chat WebSocket
-| Module     | Description                                               | Dependencies |
-|------------|-----------------------------------------------------------|--------------|
-| ChatClient   | Framework-agnostic WebSocket client for the chat protocol   | -            |
-| ChatProvider | Provider for shared WebSocket connection via context         | -            |
-| useChat      | React hook to consume the ChatProvider context               | ChatProvider |
+| Module       | Description                                               | Dependencies |
+|--------------|-----------------------------------------------------------|--------------|
+| ChatClient   | Framework-agnostic WebSocket client for the chat protocol | -            |
+| ChatProvider | Provider for shared WebSocket connection via context      | -            |
+| useChat      | React hook to consume the ChatProvider context            | ChatProvider |
 
 
 ## Config

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

@@ -0,0 +1,25 @@
+declare global {
+    interface Window {
+        hsConversationsOnReady?: Array<() => void>;
+        HubSpotConversations?: {
+            widget: {
+                close: () => void;
+                open: () => void;
+            };
+            on: (event: string, callback: () => void) => void;
+        };
+    }
+}
+interface InitializeHubSpotProps {
+    /**
+     * HubSpot account ID used to load the chat widget script
+     */
+    hubId: string;
+}
+/**
+ * Initializes the HubSpot chat widget by injecting the script and CSS.
+ * The default launcher bubble is hidden via CSS (div#id beats HubSpot's #id !important).
+ * Use the `useHubSpot` hook to interact with the widget.
+ */
+declare const InitializeHubSpot: ({ hubId }: InitializeHubSpotProps) => null;
+export default InitializeHubSpot;

package/dist/constants/hubspot.d.ts

@@ -0,0 +1,8 @@
+/**
+ * ID of the HubSpot chat widget container element in the DOM
+ */
+export declare const HUBSPOT_CONTAINER_ID = "hubspot-messages-iframe-container";
+/**
+ * CSS class added to the container to make the widget visible
+ */
+export declare const HUBSPOT_SHOW_CLASS = "hs-show";

package/dist/hooks/useHubSpot.d.ts

@@ -0,0 +1,9 @@
+/**
+ * Hook to interact with the HubSpot chat widget.
+ * Returns `isAvailable` (true once HubSpot is loaded) and `toggle` to open/close the chat.
+ */
+declare const useHubSpot: () => {
+    isAvailable: boolean;
+    toggle: () => void;
+};
+export default useHubSpot;

package/dist/main.d.ts

@@ -9,6 +9,8 @@ export * from './components/Utils/InitializeAxiosConfig';
 export { default as InitializeAxiosConfig } from './components/Utils/InitializeAxiosConfig';
 export * from './components/Utils/InitializeDaysJSConfig';
 export { default as InitializeDaysJSConfig } from './components/Utils/InitializeDaysJSConfig';
+export * from './components/Utils/InitializeHubSpot';
+export { default as InitializeHubSpot } from './components/Utils/InitializeHubSpot';
 export * from './components/Utils/InitializeI18nConfig';
 export { default as InitializeI18nConfig } from './components/Utils/InitializeI18nConfig';
 export * from './components/Utils/InitializeSentryConfig';
@@ -35,6 +37,8 @@ export * from './hooks/useCurrentLanguage/useCurrentLanguage';
 export { default as useCurrentLanguage } from './hooks/useCurrentLanguage/useCurrentLanguage';
 export * from './hooks/useFilters';
 export { default as useFilters } from './hooks/useFilters';
+export * from './hooks/useHubSpot';
+export { default as useHubSpot } from './hooks/useHubSpot';
 export * from './hooks/useInfiniteDataGrid';
 export { default as useInfiniteDataGrid } from './hooks/useInfiniteDataGrid';
 export * from './hooks/useResponseError/useResponseError';