@trackunit/react-core-contexts 1.30.3 → 1.30.5

package/index.cjs.js

@@ -352,16 +352,57 @@ const AnalyticsProviderIrisApp = ({ children }) => {
 };
 
 /**
- * Subscribe to methods initiated by changes in the host
+ * Subscribe to methods initiated by changes in the host.
  *
- * @param methods STABLE object with the methods you'd want to subscribe to. Wrap in useMemo for instance to make it stable
+ * Handlers are registered on the singleton `host-runtime` penpal channel via
+ * {@link registerHostChangeHandler}, so push events from the host
+ * (`onTokenChanged`, `onTimeRangeChanged`, filter-bar updates, …) reach every
+ * mounted provider in the iris-app without forcing the host to open one
+ * penpal connection per subscription channel.
+ *
+ * @param methods STABLE object with the methods you'd want to subscribe to.
+ *   Wrap in `useMemo` (or build with stable callback references) so the
+ *   effect doesn't re-register on every render.
+ * @param _channel Deprecated. Pre-v7 builds used a dedicated penpal channel
+ *   per subscription provider (e.g. `token-subscription`); v7 collapses all
+ *   subscriptions onto the singleton's `host-runtime` channel through a
+ *   handler registry. The argument is accepted for source-compatibility with
+ *   the v6 API and is ignored.
  */
-const useSubscribeToHostChanges = (methods) => {
+const useSubscribeToHostChanges = (methods, _channel) => {
     react.useEffect(() => {
-        const connection = irisAppRuntimeCore.setupHostConnector(methods);
-        return () => {
-            connection.destroy();
-        };
+        const unregisters = [];
+        // Listed explicitly (rather than via `Object.entries`) so each call to
+        // `registerHostChangeHandler<K>` keeps the K → handler-type connection,
+        // which a runtime iteration over keys would erase.
+        if (methods.onTokenChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onTokenChanged", methods.onTokenChanged));
+        }
+        if (methods.onTimeRangeChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onTimeRangeChanged", methods.onTimeRangeChanged));
+        }
+        if (methods.onFilterBarValuesChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onFilterBarValuesChanged", methods.onFilterBarValuesChanged));
+        }
+        if (methods.onAssetsFilterBarValuesChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onAssetsFilterBarValuesChanged", methods.onAssetsFilterBarValuesChanged));
+        }
+        if (methods.onCustomersFilterBarValuesChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onCustomersFilterBarValuesChanged", methods.onCustomersFilterBarValuesChanged));
+        }
+        if (methods.onSitesFilterBarValuesChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onSitesFilterBarValuesChanged", methods.onSitesFilterBarValuesChanged));
+        }
+        if (methods.onTablePersistenceStateChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onTablePersistenceStateChanged", methods.onTablePersistenceStateChanged));
+        }
+        if (methods.onAssetSortingStateChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onAssetSortingStateChanged", methods.onAssetSortingStateChanged));
+        }
+        if (methods.onWidgetPollIntervalChanged) {
+            unregisters.push(irisAppRuntimeCore.registerHostChangeHandler("onWidgetPollIntervalChanged", methods.onWidgetPollIntervalChanged));
+        }
+        return () => unregisters.forEach(unregister => unregister());
     }, [methods]);
 };
 
@@ -378,7 +419,7 @@ const AssetSortingProviderIrisApp = ({ children }) => {
     const methods = react.useMemo(() => ({
         onAssetSortingStateChanged: setAssetSortingState,
     }), [setAssetSortingState]);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, irisAppRuntimeCoreApi.Channels.AssetSortingSubscription);
     const contextValue = react.useMemo(() => ({
         sortingState: assetSortingState ?? {
             sortBy: irisAppRuntimeCoreApi.AssetSortByProperty.Criticality,
@@ -493,7 +534,7 @@ const FilterBarProviderIrisApp = ({ children }) => {
             setSitesFilterBarValues(values);
         },
     }), []);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, irisAppRuntimeCoreApi.Channels.FilterBarSubscription);
     const isLoading = react.useMemo(() => assetsFilterBarValues === undefined ||
         customersFilterBarValues === undefined ||
         sitesFilterBarValues === undefined, [assetsFilterBarValues, customersFilterBarValues, sitesFilterBarValues]);
@@ -596,7 +637,7 @@ const TimeRangeProviderIrisApp = ({ children }) => {
             }));
         },
     }), []);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, irisAppRuntimeCoreApi.Channels.TimeRangeSubscription);
     if (!timeRangeContext) {
         return null;
     }
@@ -634,7 +675,7 @@ const TokenProviderIrisApp = ({ children }) => {
     const methods = react.useMemo(() => ({
         onTokenChanged,
     }), [onTokenChanged]);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, irisAppRuntimeCoreApi.Channels.TokenSubscription);
     if (state.status === "error") {
         throw new Error("Token context is invalid");
     }
@@ -762,7 +803,7 @@ const WidgetConfigProviderIrisApp = ({ children }) => {
     const methods = react.useMemo(() => ({
         onWidgetPollIntervalChanged: setPollInterval,
     }), [setPollInterval]);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, irisAppRuntimeCoreApi.Channels.WidgetConfigSubscription);
     const widgetConfigContextValue = react.useMemo(() => ({
         getData: irisAppRuntimeCore.WidgetConfigRuntime.getWidgetData,
         setData: irisAppRuntimeCore.WidgetConfigRuntime.setWidgetData,

package/index.esm.js

@@ -8,11 +8,11 @@ import { print } from 'graphql';
 import { createClient } from 'graphql-sse';
 import { useState, useMemo, useEffect, useCallback, useReducer, Suspense } from 'react';
 import { onError } from '@apollo/client/link/error';
-import { ToastRuntime, AnalyticsRuntime, setupHostConnector, AssetSortingRuntime, ConfirmationDialogRuntime, EnvironmentRuntime, ExportDataRuntime, AssetsFilterBarRuntime, CustomersFilterBarRuntime, SitesFilterBarRuntime, GeolocationRuntime, ModalDialogRuntime, NavigationRuntime, OemBrandingRuntime, ThemeCssRuntime, TimeRangeRuntime, TokenRuntime, CurrentUserRuntime, CurrentUserPreferenceRuntime, UserSubscriptionRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
+import { ToastRuntime, AnalyticsRuntime, registerHostChangeHandler, AssetSortingRuntime, ConfirmationDialogRuntime, EnvironmentRuntime, ExportDataRuntime, AssetsFilterBarRuntime, CustomersFilterBarRuntime, SitesFilterBarRuntime, GeolocationRuntime, ModalDialogRuntime, NavigationRuntime, OemBrandingRuntime, ThemeCssRuntime, TimeRangeRuntime, TokenRuntime, CurrentUserRuntime, CurrentUserPreferenceRuntime, UserSubscriptionRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
 import { ToastProvider, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, EnvironmentContextProvider, ErrorHandlingContextProvider, ExportDataContext, FilterBarProvider, GeolocationProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, TokenProvider, CurrentUserProvider, CurrentUserPreferenceProvider, UserSubscriptionProvider, WidgetConfigProvider } from '@trackunit/react-core-contexts-api';
 import { registerTranslations, initializeTranslationsForApp } from '@trackunit/i18n-library-translation';
 import { Spinner } from '@trackunit/react-components';
-import { SortOrder, AssetSortByProperty } from '@trackunit/iris-app-runtime-core-api';
+import { Channels, SortOrder, AssetSortByProperty } from '@trackunit/iris-app-runtime-core-api';
 
 /**
  * This error link is used to capture error information, i. e. traceId, graphQL errors, network errors, etc.
@@ -350,16 +350,57 @@ const AnalyticsProviderIrisApp = ({ children }) => {
 };
 
 /**
- * Subscribe to methods initiated by changes in the host
+ * Subscribe to methods initiated by changes in the host.
  *
- * @param methods STABLE object with the methods you'd want to subscribe to. Wrap in useMemo for instance to make it stable
+ * Handlers are registered on the singleton `host-runtime` penpal channel via
+ * {@link registerHostChangeHandler}, so push events from the host
+ * (`onTokenChanged`, `onTimeRangeChanged`, filter-bar updates, …) reach every
+ * mounted provider in the iris-app without forcing the host to open one
+ * penpal connection per subscription channel.
+ *
+ * @param methods STABLE object with the methods you'd want to subscribe to.
+ *   Wrap in `useMemo` (or build with stable callback references) so the
+ *   effect doesn't re-register on every render.
+ * @param _channel Deprecated. Pre-v7 builds used a dedicated penpal channel
+ *   per subscription provider (e.g. `token-subscription`); v7 collapses all
+ *   subscriptions onto the singleton's `host-runtime` channel through a
+ *   handler registry. The argument is accepted for source-compatibility with
+ *   the v6 API and is ignored.
  */
-const useSubscribeToHostChanges = (methods) => {
+const useSubscribeToHostChanges = (methods, _channel) => {
     useEffect(() => {
-        const connection = setupHostConnector(methods);
-        return () => {
-            connection.destroy();
-        };
+        const unregisters = [];
+        // Listed explicitly (rather than via `Object.entries`) so each call to
+        // `registerHostChangeHandler<K>` keeps the K → handler-type connection,
+        // which a runtime iteration over keys would erase.
+        if (methods.onTokenChanged) {
+            unregisters.push(registerHostChangeHandler("onTokenChanged", methods.onTokenChanged));
+        }
+        if (methods.onTimeRangeChanged) {
+            unregisters.push(registerHostChangeHandler("onTimeRangeChanged", methods.onTimeRangeChanged));
+        }
+        if (methods.onFilterBarValuesChanged) {
+            unregisters.push(registerHostChangeHandler("onFilterBarValuesChanged", methods.onFilterBarValuesChanged));
+        }
+        if (methods.onAssetsFilterBarValuesChanged) {
+            unregisters.push(registerHostChangeHandler("onAssetsFilterBarValuesChanged", methods.onAssetsFilterBarValuesChanged));
+        }
+        if (methods.onCustomersFilterBarValuesChanged) {
+            unregisters.push(registerHostChangeHandler("onCustomersFilterBarValuesChanged", methods.onCustomersFilterBarValuesChanged));
+        }
+        if (methods.onSitesFilterBarValuesChanged) {
+            unregisters.push(registerHostChangeHandler("onSitesFilterBarValuesChanged", methods.onSitesFilterBarValuesChanged));
+        }
+        if (methods.onTablePersistenceStateChanged) {
+            unregisters.push(registerHostChangeHandler("onTablePersistenceStateChanged", methods.onTablePersistenceStateChanged));
+        }
+        if (methods.onAssetSortingStateChanged) {
+            unregisters.push(registerHostChangeHandler("onAssetSortingStateChanged", methods.onAssetSortingStateChanged));
+        }
+        if (methods.onWidgetPollIntervalChanged) {
+            unregisters.push(registerHostChangeHandler("onWidgetPollIntervalChanged", methods.onWidgetPollIntervalChanged));
+        }
+        return () => unregisters.forEach(unregister => unregister());
     }, [methods]);
 };
 
@@ -376,7 +417,7 @@ const AssetSortingProviderIrisApp = ({ children }) => {
     const methods = useMemo(() => ({
         onAssetSortingStateChanged: setAssetSortingState,
     }), [setAssetSortingState]);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, Channels.AssetSortingSubscription);
     const contextValue = useMemo(() => ({
         sortingState: assetSortingState ?? {
             sortBy: AssetSortByProperty.Criticality,
@@ -491,7 +532,7 @@ const FilterBarProviderIrisApp = ({ children }) => {
             setSitesFilterBarValues(values);
         },
     }), []);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, Channels.FilterBarSubscription);
     const isLoading = useMemo(() => assetsFilterBarValues === undefined ||
         customersFilterBarValues === undefined ||
         sitesFilterBarValues === undefined, [assetsFilterBarValues, customersFilterBarValues, sitesFilterBarValues]);
@@ -594,7 +635,7 @@ const TimeRangeProviderIrisApp = ({ children }) => {
             }));
         },
     }), []);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, Channels.TimeRangeSubscription);
     if (!timeRangeContext) {
         return null;
     }
@@ -632,7 +673,7 @@ const TokenProviderIrisApp = ({ children }) => {
     const methods = useMemo(() => ({
         onTokenChanged,
     }), [onTokenChanged]);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, Channels.TokenSubscription);
     if (state.status === "error") {
         throw new Error("Token context is invalid");
     }
@@ -760,7 +801,7 @@ const WidgetConfigProviderIrisApp = ({ children }) => {
     const methods = useMemo(() => ({
         onWidgetPollIntervalChanged: setPollInterval,
     }), [setPollInterval]);
-    useSubscribeToHostChanges(methods);
+    useSubscribeToHostChanges(methods, Channels.WidgetConfigSubscription);
     const widgetConfigContextValue = useMemo(() => ({
         getData: WidgetConfigRuntime.getWidgetData,
         setData: WidgetConfigRuntime.setWidgetData,

package/package.json

@@ -1,20 +1,20 @@
 {
   "name": "@trackunit/react-core-contexts",
-  "version": "1.30.3",
+  "version": "1.30.5",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
     "node": ">=24.x"
   },
   "dependencies": {
-    "@trackunit/iris-app-api": "1.20.7",
-    "@trackunit/iris-app-runtime-core-api": "1.16.6",
-    "@trackunit/react-core-hooks": "1.17.10",
-    "@trackunit/i18n-library-translation": "1.22.1",
-    "@trackunit/react-components": "1.26.3",
-    "@trackunit/iris-app-runtime-core": "1.17.6",
+    "@trackunit/iris-app-api": "1.20.8",
+    "@trackunit/iris-app-runtime-core-api": "1.16.7",
+    "@trackunit/react-core-hooks": "1.17.11",
+    "@trackunit/i18n-library-translation": "1.22.2",
+    "@trackunit/react-components": "1.26.5",
+    "@trackunit/iris-app-runtime-core": "1.17.7",
     "graphql-sse": "^2.5.4",
-    "@trackunit/react-core-contexts-api": "1.17.6"
+    "@trackunit/react-core-contexts-api": "1.17.7"
   },
   "peerDependencies": {
     "@apollo/client": "^3.13.8",

package/src/useSubscribeToHostChanges.d.ts

@@ -1,9 +1,20 @@
-import { setupHostConnector } from "@trackunit/iris-app-runtime-core";
-type ChildConnectorApi = Parameters<typeof setupHostConnector>[0];
+import { ChildConnectorApi } from "@trackunit/iris-app-runtime-core-api";
 /**
- * Subscribe to methods initiated by changes in the host
+ * Subscribe to methods initiated by changes in the host.
  *
- * @param methods STABLE object with the methods you'd want to subscribe to. Wrap in useMemo for instance to make it stable
+ * Handlers are registered on the singleton `host-runtime` penpal channel via
+ * {@link registerHostChangeHandler}, so push events from the host
+ * (`onTokenChanged`, `onTimeRangeChanged`, filter-bar updates, …) reach every
+ * mounted provider in the iris-app without forcing the host to open one
+ * penpal connection per subscription channel.
+ *
+ * @param methods STABLE object with the methods you'd want to subscribe to.
+ *   Wrap in `useMemo` (or build with stable callback references) so the
+ *   effect doesn't re-register on every render.
+ * @param _channel Deprecated. Pre-v7 builds used a dedicated penpal channel
+ *   per subscription provider (e.g. `token-subscription`); v7 collapses all
+ *   subscriptions onto the singleton's `host-runtime` channel through a
+ *   handler registry. The argument is accepted for source-compatibility with
+ *   the v6 API and is ignored.
  */
-export declare const useSubscribeToHostChanges: (methods: ChildConnectorApi) => void;
-export {};
+export declare const useSubscribeToHostChanges: (methods: Partial<ChildConnectorApi>, _channel?: string) => void;