@trackunit/react-core-hooks 1.3.79 → 1.3.81

package/index.cjs.js

@@ -4,6 +4,7 @@ var react = require('react');
 var jsxRuntime = require('react/jsx-runtime');
 var irisAppRuntimeCore = require('@trackunit/iris-app-runtime-core');
 var sharedUtils = require('@trackunit/shared-utils');
+var reactRouter = require('@tanstack/react-router');
 
 const AnalyticsContext = react.createContext(null);
 const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
@@ -1064,6 +1065,77 @@ function useTextSearch(items, props) {
     return [result, searchText, setSearchText];
 }
 
+const WidgetConfigContext = react.createContext(null);
+/**
+ * This is a hook to use the WidgetConfigProvider.
+ *
+ * @requires WidgetConfigProvider
+ * @example
+ * import { useWidgetConfigAsync } from "@trackunit/react-core-hooks";
+ *
+ * export const useWidgetConfigAsync = () => {
+ *   const { widgetConfig } = useWidgetConfigAsync();
+ *
+ *   ...
+ * };
+ * @see {@link WidgetConfigContext}
+ */
+const useWidgetConfigAsync = () => {
+    const context = react.useContext(WidgetConfigContext);
+    if (!context) {
+        throw new Error("useWidgetConfig must be used within the WidgetConfigContext");
+    }
+    return context;
+};
+/**
+ * This is a provider for the WidgetConfigContext.
+ */
+const WidgetConfigProvider = (props) => jsxRuntime.jsx(WidgetConfigContext.Provider, { ...props });
+/**
+ * This is a hook to use the WidgetConfigContext.
+ *
+ * @example
+ * import { useWidgetConfig } from "@trackunit/react-core-hooks";
+ *
+ * export const useWidgetConfig = () => {
+ *   const { widgetConfig } = useWidgetConfig();
+ *
+ *   ...
+ * };
+ * @see {@link WidgetConfigContext}
+ */
+const useWidgetConfig = () => {
+    const [data, setData] = react.useState(null);
+    const [dataVersion, setDataVersion] = react.useState(null);
+    const [title, setTitle] = react.useState(null);
+    const filters = useFilterBarContext();
+    const { timeRange } = useTimeRange();
+    const { edit } = reactRouter.useSearch({ from: "/", select: params => params });
+    react.useEffect(() => {
+        irisAppRuntimeCore.WidgetConfigRuntime.getData().then(d => setData(d));
+        irisAppRuntimeCore.WidgetConfigRuntime.getDataVersion().then(dv => setDataVersion(dv));
+        irisAppRuntimeCore.WidgetConfigRuntime.getTitle().then(t => setTitle(t));
+    }, []);
+    const result = react.useMemo(() => ({
+        data,
+        setData: async (newData, newDataVersion) => {
+            await irisAppRuntimeCore.WidgetConfigRuntime.setData(newData, newDataVersion);
+            setData(newData);
+            setDataVersion(newDataVersion);
+        },
+        dataVersion,
+        title,
+        setTitle: async (newTitle) => {
+            await irisAppRuntimeCore.WidgetConfigRuntime.setTitle(newTitle);
+            setTitle(newTitle);
+        },
+        filters,
+        timeRange,
+        isEditMode: edit,
+    }), [data, dataVersion, title, filters, timeRange, edit]);
+    return result;
+};
+
 exports.AnalyticsContext = AnalyticsContext;
 exports.AnalyticsContextProvider = AnalyticsContextProvider;
 exports.AssetSortingProvider = AssetSortingProvider;
@@ -1081,6 +1153,7 @@ exports.TimeRangeProvider = TimeRangeProvider;
 exports.ToastProvider = ToastProvider;
 exports.TokenProvider = TokenProvider;
 exports.UserSubscriptionProvider = UserSubscriptionProvider;
+exports.WidgetConfigProvider = WidgetConfigProvider;
 exports.fetchAssetBlobUrl = fetchAssetBlobUrl;
 exports.useAnalytics = useAnalytics;
 exports.useAssetRuntime = useAssetRuntime;
@@ -1113,3 +1186,5 @@ exports.useTimeRange = useTimeRange;
 exports.useToast = useToast;
 exports.useToken = useToken;
 exports.useUserSubscription = useUserSubscription;
+exports.useWidgetConfig = useWidgetConfig;
+exports.useWidgetConfigAsync = useWidgetConfigAsync;

package/index.esm.js

@@ -1,7 +1,8 @@
 import { createContext, useContext, useMemo, useState, useCallback, useRef, useEffect, useReducer } from 'react';
 import { jsx } from 'react/jsx-runtime';
-import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
+import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime, WidgetConfigRuntime } from '@trackunit/iris-app-runtime-core';
 import { filterByMultiple } from '@trackunit/shared-utils';
+import { useSearch } from '@tanstack/react-router';
 
 const AnalyticsContext = createContext(null);
 const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
@@ -1062,4 +1063,75 @@ function useTextSearch(items, props) {
     return [result, searchText, setSearchText];
 }
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription };
+const WidgetConfigContext = createContext(null);
+/**
+ * This is a hook to use the WidgetConfigProvider.
+ *
+ * @requires WidgetConfigProvider
+ * @example
+ * import { useWidgetConfigAsync } from "@trackunit/react-core-hooks";
+ *
+ * export const useWidgetConfigAsync = () => {
+ *   const { widgetConfig } = useWidgetConfigAsync();
+ *
+ *   ...
+ * };
+ * @see {@link WidgetConfigContext}
+ */
+const useWidgetConfigAsync = () => {
+    const context = useContext(WidgetConfigContext);
+    if (!context) {
+        throw new Error("useWidgetConfig must be used within the WidgetConfigContext");
+    }
+    return context;
+};
+/**
+ * This is a provider for the WidgetConfigContext.
+ */
+const WidgetConfigProvider = (props) => jsx(WidgetConfigContext.Provider, { ...props });
+/**
+ * This is a hook to use the WidgetConfigContext.
+ *
+ * @example
+ * import { useWidgetConfig } from "@trackunit/react-core-hooks";
+ *
+ * export const useWidgetConfig = () => {
+ *   const { widgetConfig } = useWidgetConfig();
+ *
+ *   ...
+ * };
+ * @see {@link WidgetConfigContext}
+ */
+const useWidgetConfig = () => {
+    const [data, setData] = useState(null);
+    const [dataVersion, setDataVersion] = useState(null);
+    const [title, setTitle] = useState(null);
+    const filters = useFilterBarContext();
+    const { timeRange } = useTimeRange();
+    const { edit } = useSearch({ from: "/", select: params => params });
+    useEffect(() => {
+        WidgetConfigRuntime.getData().then(d => setData(d));
+        WidgetConfigRuntime.getDataVersion().then(dv => setDataVersion(dv));
+        WidgetConfigRuntime.getTitle().then(t => setTitle(t));
+    }, []);
+    const result = useMemo(() => ({
+        data,
+        setData: async (newData, newDataVersion) => {
+            await WidgetConfigRuntime.setData(newData, newDataVersion);
+            setData(newData);
+            setDataVersion(newDataVersion);
+        },
+        dataVersion,
+        title,
+        setTitle: async (newTitle) => {
+            await WidgetConfigRuntime.setTitle(newTitle);
+            setTitle(newTitle);
+        },
+        filters,
+        timeRange,
+        isEditMode: edit,
+    }), [data, dataVersion, title, filters, timeRange, edit]);
+    return result;
+};
+
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, TimeRangeProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, WidgetConfigProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useLocalStorage, useLocalStorageReducer, useModalDialogContext, useNavigateInHost, useOemBrandingContext, usePrevious, useSiteRuntime, useTextSearch, useTimeRange, useToast, useToken, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.3.79",
+  "version": "1.3.81",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -10,9 +10,10 @@
     "react": "19.0.0",
     "jest-fetch-mock": "^3.0.3",
     "zod": "3.22.4",
-    "@trackunit/react-core-contexts-api": "1.4.77",
-    "@trackunit/iris-app-runtime-core": "1.4.78",
-    "@trackunit/shared-utils": "1.5.75"
+    "@trackunit/react-core-contexts-api": "1.4.79",
+    "@trackunit/iris-app-runtime-core": "1.4.80",
+    "@trackunit/shared-utils": "1.5.76",
+    "@tanstack/react-router": "1.114.29"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/index.d.ts

@@ -26,3 +26,4 @@ export * from "./usePrevious";
 export * from "./user/CurrentUserPreferenceProvider";
 export * from "./user/CurrentUserProvider";
 export * from "./useTextSearch";
+export * from "./widgetConfig/WidgetConfigProvider";

package/src/widgetConfig/WidgetConfigProvider.d.ts

@@ -0,0 +1,50 @@
+import { WidgetConfigRuntime } from "@trackunit/iris-app-runtime-core";
+import { WidgetConfigContext as WidgetConfigContextType } from "@trackunit/react-core-contexts-api";
+import { ReactNode } from "react";
+/**
+ * This is a hook to use the WidgetConfigProvider.
+ *
+ * @requires WidgetConfigProvider
+ * @example
+ * import { useWidgetConfigAsync } from "@trackunit/react-core-hooks";
+ *
+ * export const useWidgetConfigAsync = () => {
+ *   const { widgetConfig } = useWidgetConfigAsync();
+ *
+ *   ...
+ * };
+ * @see {@link WidgetConfigContext}
+ */
+export declare const useWidgetConfigAsync: () => WidgetConfigContextType;
+interface WidgetConfigContextProps {
+    value: typeof WidgetConfigRuntime;
+    children?: ReactNode;
+}
+/**
+ * This is a provider for the WidgetConfigContext.
+ */
+export declare const WidgetConfigProvider: (props: WidgetConfigContextProps) => import("react/jsx-runtime").JSX.Element;
+/**
+ * This is a hook to use the WidgetConfigContext.
+ *
+ * @example
+ * import { useWidgetConfig } from "@trackunit/react-core-hooks";
+ *
+ * export const useWidgetConfig = () => {
+ *   const { widgetConfig } = useWidgetConfig();
+ *
+ *   ...
+ * };
+ * @see {@link WidgetConfigContext}
+ */
+export declare const useWidgetConfig: () => {
+    data: Record<string, unknown> | null;
+    setData: (newData: Record<string, unknown>, newDataVersion: number) => Promise<void>;
+    dataVersion: number | null;
+    title: string | null;
+    setTitle: (newTitle: string) => Promise<void>;
+    filters: import("@trackunit/react-core-contexts-api").FilterBarContext;
+    timeRange: import("@trackunit/react-core-contexts-api").TimeRange | null;
+    isEditMode: any;
+};
+export {};