@trackunit/react-core-hooks 0.2.64 → 0.2.65

package/index.js

@@ -2,189 +2,363 @@ import * as React from 'react';
 import React__default, { createContext, useContext, useState, useEffect } from 'react';
 import { jsx } from 'react/jsx-runtime';
 import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
-import { useLocation } from 'react-router-dom';
-
-const AnalyticsContext = createContext(null);
-const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
-/**
- * Hook to get the analytics context.
- *
- * @requires AnalyticsProvider
- * @example
- * import { useAnalytics, useEnvironment } from "@trackunit/react-core-hooks";
- * const { logPageView, logEvent } = useAnalytics(AllEvents);
- *
- * // log page view event
- * useEffect(() => {
- *   logPageView({ pageName: "login" });
- * }, [logPageView]);
- *
- * // log event when appropriate
- * logEvent("Login", { loginPage: "New Manager" });
- *
- * @see {@link IAnalyticsContext}
- */
-const useAnalytics = (type) => {
-    const context = useContext(AnalyticsContext);
-    if (!context) {
-        throw new Error("useAnalytics must be used within an AnalyticsProvider");
-    }
-    return context;
+
+const AnalyticsContext = createContext(null);
+const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
+/**
+ * Hook to get the analytics context.
+ *
+ * @requires AnalyticsProvider
+ * @example
+ * import { useAnalytics, useEnvironment } from "@trackunit/react-core-hooks";
+ * const { logPageView, logEvent } = useAnalytics(AllEvents);
+ *
+ * // log page view event
+ * useEffect(() => {
+ *   logPageView({ pageName: "login" });
+ * }, [logPageView]);
+ *
+ * // log event when appropriate
+ * logEvent("Login", { loginPage: "New Manager" });
+ *
+ * @see {@link IAnalyticsContext}
+ */
+const useAnalytics = (type) => {
+    const context = useContext(AnalyticsContext);
+    if (!context) {
+        throw new Error("useAnalytics must be used within an AnalyticsProvider");
+    }
+    return context;
 };
 
-const AssetSortingContext = createContext(null);
-/**
- * This is a provider for the AssetSortingContext.
- */
-const AssetSortingProvider = AssetSortingContext.Provider;
-/**
- * This is a hook to use the AssetSortingContext.
- *
- * @requires AssetSortingProvider
- * @example
- * import { useAssetSorting } from "@trackunit/react-core-hooks";
- * const { sortingState, setSortBy } = useAssetSorting();
- *
- * const initialSort = useMemo(
- *   () => ({
- *     property: {
- *       label: sortingState.sortBy,
- *       value: sortingState.sortBy,
- *     },
- *     order: sortingState.order,
- *   }),
- *   [sortingState]
- * );
- *
- * return (
- *   <Table
- *     ...
- *     headerOnSort={setSortBy}
- *     headerInitialSort={initialSort}
- *   />
- * );
- *
- * @see {@link IAssetSortingContext}
- */
-const useAssetSorting = () => {
-    const context = useContext(AssetSortingContext);
-    if (!context) {
-        throw new Error("useAssetSorting must be used within a AssetSortingProvider");
-    }
-    return context;
+const AssetSortingContext = createContext(null);
+/**
+ * This is a provider for the AssetSortingContext.
+ */
+const AssetSortingProvider = AssetSortingContext.Provider;
+/**
+ * This is a hook to use the AssetSortingContext.
+ *
+ * @requires AssetSortingProvider
+ * @example
+ * import { useAssetSorting } from "@trackunit/react-core-hooks";
+ * const { sortingState, setSortBy } = useAssetSorting();
+ *
+ * const initialSort = useMemo(
+ *   () => ({
+ *     property: {
+ *       label: sortingState.sortBy,
+ *       value: sortingState.sortBy,
+ *     },
+ *     order: sortingState.order,
+ *   }),
+ *   [sortingState]
+ * );
+ *
+ * return (
+ *   <Table
+ *     ...
+ *     headerOnSort={setSortBy}
+ *     headerInitialSort={initialSort}
+ *   />
+ * );
+ *
+ * @see {@link IAssetSortingContext}
+ */
+const useAssetSorting = () => {
+    const context = useContext(AssetSortingContext);
+    if (!context) {
+        throw new Error("useAssetSorting must be used within a AssetSortingProvider");
+    }
+    return context;
 };
 
-const EnvironmentContext = createContext(null);
-/**
- * This is a provider for the EnvironmentContext.
- */
-const EnvironmentContextProvider = (props) => {
-    return jsx(EnvironmentContext.Provider, Object.assign({}, props));
-};
-/**
- * This is a hook to use the EnvironmentContext.
- *
- * @requires EnvironmentContext
- * @example
- * import { useEnvironment } from "@trackunit/react-core-hooks";
- * const { googleMapsApiKey } = useEnvironment();
- * // use api key for something...
- *
- * @see (@link IEnvironmentContext)
- */
-const useEnvironment = () => {
-    const context = useContext(EnvironmentContext);
-    if (!context) {
-        throw new Error("useEnvironment must be used within an EnvironmentContext");
-    }
-    return context;
+const EnvironmentContext = createContext(null);
+/**
+ * This is a provider for the EnvironmentContext.
+ */
+const EnvironmentContextProvider = (props) => {
+    return jsx(EnvironmentContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook to use the EnvironmentContext.
+ *
+ * @requires EnvironmentContext
+ * @example
+ * import { useEnvironment } from "@trackunit/react-core-hooks";
+ * const { googleMapsApiKey } = useEnvironment();
+ * // use api key for something...
+ *
+ * @see (@link IEnvironmentContext)
+ */
+const useEnvironment = () => {
+    const context = useContext(EnvironmentContext);
+    if (!context) {
+        throw new Error("useEnvironment must be used within an EnvironmentContext");
+    }
+    return context;
 };
 
-const GlobalSelectionContext = React.createContext(null);
-/**
- * This is a hook to use the GlobalSelectionContext.
- *
- * @requires GlobalSelectionProvider
- * @example
- * import { useGlobalSelection } from "@trackunit/react-core-hooks";
- *
- * export const useActiveGlobalGroupIdFilter = () => {
- *   const { selection } = useGlobalSelection();
- *   return (selection?.type === "group") ? selection.groupId : undefined;
- * };
- *
- * @see {@link IGlobalSelectionContext}
- */
-const useGlobalSelection = () => {
-    const context = React.useContext(GlobalSelectionContext);
-    if (!context) {
-        throw new Error("useGlobalSelection must be used within the GlobalSelectionContext");
-    }
-    return context;
-};
-/**
- * This is a provider for the GlobalSelectionContext.
- */
+const GlobalSelectionContext = React.createContext(null);
+/**
+ * This is a hook to use the GlobalSelectionContext.
+ *
+ * @requires GlobalSelectionProvider
+ * @example
+ * import { useGlobalSelection } from "@trackunit/react-core-hooks";
+ *
+ * export const useActiveGlobalGroupIdFilter = () => {
+ *   const { selection } = useGlobalSelection();
+ *   return (selection?.type === "group") ? selection.groupId : undefined;
+ * };
+ *
+ * @see {@link IGlobalSelectionContext}
+ */
+const useGlobalSelection = () => {
+    const context = React.useContext(GlobalSelectionContext);
+    if (!context) {
+        throw new Error("useGlobalSelection must be used within the GlobalSelectionContext");
+    }
+    return context;
+};
+/**
+ * This is a provider for the GlobalSelectionContext.
+ */
 const GlobalSelectionProvider = (props) => jsx(GlobalSelectionContext.Provider, Object.assign({}, props));
 
-const OemBrandingContext = createContext(null);
-/**
- * This is a hook to use the IOemBrandingContext.
- *
- * @requires OemBrandingContextProvider
- * @example
- * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
- * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
- * // use oem branding
- * const branding = getOemBranding("some brand")
- *
- * @see {@link IOemBrandingContext}
- */
-const useOemBrandingContext = () => {
-    const context = useContext(OemBrandingContext);
-    if (!context) {
-        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
-    }
-    return context;
-};
-/**
- * This is a provider for the IOemBrandingContext.
- */
-const OemBrandingContextProvider = (props) => {
-    return jsx(OemBrandingContext.Provider, Object.assign({}, props));
+const OemBrandingContext = createContext(null);
+/**
+ * This is a hook to use the IOemBrandingContext.
+ *
+ * @requires OemBrandingContextProvider
+ * @example
+ * import { useOemBrandingContext } from "@trackunit/react-core-hooks";
+ * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
+ * // use oem branding
+ * const branding = getOemBranding("some brand")
+ *
+ * @see {@link IOemBrandingContext}
+ */
+const useOemBrandingContext = () => {
+    const context = useContext(OemBrandingContext);
+    if (!context) {
+        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
+    }
+    return context;
+};
+/**
+ * This is a provider for the IOemBrandingContext.
+ */
+const OemBrandingContextProvider = (props) => {
+    return jsx(OemBrandingContext.Provider, Object.assign({}, props));
 };
 
-/**
- * A react hook for notifying host about location changes
- */
-const useURLSynchronization = () => {
-    const location = useLocation();
-    React__default.useEffect(() => {
-        const deepLink = {
-            path: location.pathname,
-            search: location.search,
-            hash: location.hash,
-            pathname: "",
-        };
-        NavigationRuntime.setDeepLink(deepLink);
-    }, [location]);
+/**
+ * @remix-run/router v1.6.2
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+
+////////////////////////////////////////////////////////////////////////////////
+//#region Types and Constants
+////////////////////////////////////////////////////////////////////////////////
+
+/**
+ * Actions represent the type of change to a location value.
+ */
+var Action;
+
+(function (Action) {
+  /**
+   * A POP indicates a change to an arbitrary index in the history stack, such
+   * as a back or forward navigation. It does not describe the direction of the
+   * navigation, only that the current index changed.
+   *
+   * Note: This is the default action for newly created history objects.
+   */
+  Action["Pop"] = "POP";
+  /**
+   * A PUSH indicates a new entry being added to the history stack, such as when
+   * a link is clicked and a new page loads. When this happens, all subsequent
+   * entries in the stack are lost.
+   */
+
+  Action["Push"] = "PUSH";
+  /**
+   * A REPLACE indicates the entry at the current index in the history stack
+   * being replaced by a new one.
+   */
+
+  Action["Replace"] = "REPLACE";
+})(Action || (Action = {}));
+function invariant(value, message) {
+  if (value === false || value === null || typeof value === "undefined") {
+    throw new Error(message);
+  }
+}
+
+var ResultType;
+
+(function (ResultType) {
+  ResultType["data"] = "data";
+  ResultType["deferred"] = "deferred";
+  ResultType["redirect"] = "redirect";
+  ResultType["error"] = "error";
+})(ResultType || (ResultType = {}));
+
+const validMutationMethodsArr = ["post", "put", "patch", "delete"];
+["get", ...validMutationMethodsArr];
+
+/**
+ * React Router v6.11.2
+ *
+ * Copyright (c) Remix Software Inc.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE.md file in the root directory of this source tree.
+ *
+ * @license MIT
+ */
+
+const DataRouterContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== "production") {
+  DataRouterContext.displayName = "DataRouter";
+}
+
+const DataRouterStateContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== "production") {
+  DataRouterStateContext.displayName = "DataRouterState";
+}
+
+const AwaitContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== "production") {
+  AwaitContext.displayName = "Await";
+}
+
+const NavigationContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== "production") {
+  NavigationContext.displayName = "Navigation";
+}
+
+const LocationContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== "production") {
+  LocationContext.displayName = "Location";
+}
+
+const RouteContext = /*#__PURE__*/React.createContext({
+  outlet: null,
+  matches: [],
+  isDataRoute: false
+});
+
+if (process.env.NODE_ENV !== "production") {
+  RouteContext.displayName = "Route";
+}
+
+const RouteErrorContext = /*#__PURE__*/React.createContext(null);
+
+if (process.env.NODE_ENV !== "production") {
+  RouteErrorContext.displayName = "RouteError";
+}
+/**
+ * Returns true if this component is a descendant of a <Router>.
+ *
+ * @see https://reactrouter.com/hooks/use-in-router-context
+ */
+
+function useInRouterContext() {
+  return React.useContext(LocationContext) != null;
+}
+/**
+ * Returns the current location object, which represents the current URL in web
+ * browsers.
+ *
+ * Note: If you're using this it may mean you're doing some of your own
+ * "routing" in your app, and we'd like to know what your use case is. We may
+ * be able to provide something higher-level to better suit your needs.
+ *
+ * @see https://reactrouter.com/hooks/use-location
+ */
+
+function useLocation() {
+  !useInRouterContext() ? process.env.NODE_ENV !== "production" ? invariant(false, // TODO: This error is probably because they somehow have 2 versions of the
+  // router loaded. We can help them understand how to avoid that.
+  "useLocation() may be used only in the context of a <Router> component.") : invariant(false) : void 0;
+  return React.useContext(LocationContext).location;
+}
+var DataRouterHook;
+
+(function (DataRouterHook) {
+  DataRouterHook["UseBlocker"] = "useBlocker";
+  DataRouterHook["UseRevalidator"] = "useRevalidator";
+  DataRouterHook["UseNavigateStable"] = "useNavigate";
+})(DataRouterHook || (DataRouterHook = {}));
+
+var DataRouterStateHook;
+
+(function (DataRouterStateHook) {
+  DataRouterStateHook["UseBlocker"] = "useBlocker";
+  DataRouterStateHook["UseLoaderData"] = "useLoaderData";
+  DataRouterStateHook["UseActionData"] = "useActionData";
+  DataRouterStateHook["UseRouteError"] = "useRouteError";
+  DataRouterStateHook["UseNavigation"] = "useNavigation";
+  DataRouterStateHook["UseRouteLoaderData"] = "useRouteLoaderData";
+  DataRouterStateHook["UseMatches"] = "useMatches";
+  DataRouterStateHook["UseRevalidator"] = "useRevalidator";
+  DataRouterStateHook["UseNavigateStable"] = "useNavigate";
+  DataRouterStateHook["UseRouteId"] = "useRouteId";
+})(DataRouterStateHook || (DataRouterStateHook = {}));
+var AwaitRenderStatus;
+
+(function (AwaitRenderStatus) {
+  AwaitRenderStatus[AwaitRenderStatus["pending"] = 0] = "pending";
+  AwaitRenderStatus[AwaitRenderStatus["success"] = 1] = "success";
+  AwaitRenderStatus[AwaitRenderStatus["error"] = 2] = "error";
+})(AwaitRenderStatus || (AwaitRenderStatus = {}));
+
+new Promise(() => {});
+
+/**
+ * A react hook for notifying host about location changes
+ */
+const useURLSynchronization = () => {
+    const location = useLocation();
+    React__default.useEffect(() => {
+        const deepLink = {
+            path: location.pathname,
+            search: location.search,
+            hash: location.hash,
+            pathname: "",
+        };
+        NavigationRuntime.setDeepLink(deepLink);
+    }, [location]);
 };
 
-/**
- * A hook to expose navigation runtime for React components
- *
- * @requires NavigationRuntime
- * @returns {UseNavigationRuntime} navigationRuntime
- * @example
- * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
- * const { navigateTo } = useNavigationRuntime();
- * // ...
- * <Link onClick={() => gotoAssetHome(asset.id)} to="">
- *   {asset.name}
- * </Link>
- */
-const useNavigationRuntime = () => {
-    return NavigationRuntime;
+/**
+ * A hook to expose navigation runtime for React components
+ *
+ * @requires NavigationRuntime
+ * @returns {UseNavigationRuntime} navigationRuntime
+ * @example
+ * import { useNavigationRuntime } from "@trackunit/react-core-hooks";
+ * const { navigateTo } = useNavigationRuntime();
+ * // ...
+ * <Link onClick={() => gotoAssetHome(asset.id)} to="">
+ *   {asset.name}
+ * </Link>
+ */
+const useNavigationRuntime = () => {
+    return NavigationRuntime;
 };
 
 /******************************************************************************
@@ -212,240 +386,240 @@ function __awaiter(thisArg, _arguments, P, generator) {
     });
 }
 
-/**
- * A hook to expose asset runtime for React components
- *
- * @requires AssetRuntime
- * @returns {UseAssetRuntime} assetRuntime
- * @example
- * import { useAssetRuntime } from "@trackunit/react-core-hooks";
- * const { assetInfo } = useAssetRuntime();
- * useEffect(() => {
- *   (async () => {
- *     if (assetInfo) {
- *       getAssetLocation({ variables: { id: assetInfo.assetId } });
- *     }
- *   })();
- * }, [assetInfo, getAssetLocation]);
- *
- */
-const useAssetRuntime = () => {
-    const [assetInfo, setAssetInfo] = useState();
-    useEffect(() => {
-        const getAssetInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-            const updatedAssetInfo = yield AssetRuntime.getAssetInfo();
-            setAssetInfo(updatedAssetInfo);
-        });
-        getAssetInfo();
-    }, []);
-    return { assetInfo };
+/**
+ * A hook to expose asset runtime for React components
+ *
+ * @requires AssetRuntime
+ * @returns {UseAssetRuntime} assetRuntime
+ * @example
+ * import { useAssetRuntime } from "@trackunit/react-core-hooks";
+ * const { assetInfo } = useAssetRuntime();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (assetInfo) {
+ *       getAssetLocation({ variables: { id: assetInfo.assetId } });
+ *     }
+ *   })();
+ * }, [assetInfo, getAssetLocation]);
+ *
+ */
+const useAssetRuntime = () => {
+    const [assetInfo, setAssetInfo] = useState();
+    useEffect(() => {
+        const getAssetInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            const updatedAssetInfo = yield AssetRuntime.getAssetInfo();
+            setAssetInfo(updatedAssetInfo);
+        });
+        getAssetInfo();
+    }, []);
+    return { assetInfo };
 };
 
-/**
- * A hook to expose custom field runtime methods
- *
- * @returns {UseCustomFieldRuntime} CustomFieldRuntime
- */
-const useCustomFieldRuntime = () => {
-    return CustomFieldRuntime;
+/**
+ * A hook to expose custom field runtime methods
+ *
+ * @returns {UseCustomFieldRuntime} CustomFieldRuntime
+ */
+const useCustomFieldRuntime = () => {
+    return CustomFieldRuntime;
 };
 
-/**
- * This hook is a wrapper around useCustomFieldRuntime that automatically fetches and sets custom fields for a given entity.
- *
- * @param entity The entity to fetch and set custom fields for.
- * @returns The custom fields for the entity, and functions to set custom fields for the entity.
- * @example
- * import { useAssetRuntime, useCustomFieldRuntimeForEntity } from '@trackunit/react-core-hooks';
- * const { assetInfo } = useAssetRuntime();
- * const { customFields, setCustomFieldsForEntity } = useCustomFieldRuntimeForEntity( {
- *   id: assetInfo?.assetId || '',
- *   type: 'ASSET'
- * });
- *
- * // set custom field data
- * setCustomFieldsForEntity({"key": "value"});
- */
-const useCustomFieldRuntimeForEntity = (entity) => {
-    const { getCustomFieldsFor, setCustomFieldsFromFormData, setCustomFieldsFor } = useCustomFieldRuntime();
-    const [customFields, setCustomFields] = useState();
-    useEffect(() => {
-        if (entity.id) {
-            (() => __awaiter(void 0, void 0, void 0, function* () {
-                setCustomFields(yield getCustomFieldsFor(entity));
-            }))();
-        }
-        else {
-            setCustomFields([]);
-        }
-    }, [entity, getCustomFieldsFor]);
-    const setCustomFieldsForEntity = (values) => __awaiter(void 0, void 0, void 0, function* () {
-        if (entity.id) {
-            yield setCustomFieldsFor(entity, values);
-        }
-    });
-    const setCustomFieldsFromFormDataForEntity = (formData) => __awaiter(void 0, void 0, void 0, function* () {
-        if (entity.id) {
-            yield setCustomFieldsFromFormData(entity, formData, customFields || []);
-        }
-    });
-    return {
-        customFields,
-        setCustomFieldsFromFormDataForEntity,
-        setCustomFieldsForEntity,
-    };
+/**
+ * This hook is a wrapper around useCustomFieldRuntime that automatically fetches and sets custom fields for a given entity.
+ *
+ * @param entity The entity to fetch and set custom fields for.
+ * @returns The custom fields for the entity, and functions to set custom fields for the entity.
+ * @example
+ * import { useAssetRuntime, useCustomFieldRuntimeForEntity } from '@trackunit/react-core-hooks';
+ * const { assetInfo } = useAssetRuntime();
+ * const { customFields, setCustomFieldsForEntity } = useCustomFieldRuntimeForEntity( {
+ *   id: assetInfo?.assetId || '',
+ *   type: 'ASSET'
+ * });
+ *
+ * // set custom field data
+ * setCustomFieldsForEntity({"key": "value"});
+ */
+const useCustomFieldRuntimeForEntity = (entity) => {
+    const { getCustomFieldsFor, setCustomFieldsFromFormData, setCustomFieldsFor } = useCustomFieldRuntime();
+    const [customFields, setCustomFields] = useState();
+    useEffect(() => {
+        if (entity.id) {
+            (() => __awaiter(void 0, void 0, void 0, function* () {
+                setCustomFields(yield getCustomFieldsFor(entity));
+            }))();
+        }
+        else {
+            setCustomFields([]);
+        }
+    }, [entity, getCustomFieldsFor]);
+    const setCustomFieldsForEntity = (values) => __awaiter(void 0, void 0, void 0, function* () {
+        if (entity.id) {
+            yield setCustomFieldsFor(entity, values);
+        }
+    });
+    const setCustomFieldsFromFormDataForEntity = (formData) => __awaiter(void 0, void 0, void 0, function* () {
+        if (entity.id) {
+            yield setCustomFieldsFromFormData(entity, formData, customFields || []);
+        }
+    });
+    return {
+        customFields,
+        setCustomFieldsFromFormDataForEntity,
+        setCustomFieldsForEntity,
+    };
 };
 
-/**
- * A hook to expose rest runtime to be used in React components
- *
- * @returns {UseRestRuntime} a RestRuntime
- */
-const useRestRuntime = () => {
-    return RestRuntime;
+/**
+ * A hook to expose rest runtime to be used in React components
+ *
+ * @returns {UseRestRuntime} a RestRuntime
+ */
+const useRestRuntime = () => {
+    return RestRuntime;
 };
 
-/**
- * A hook to expose site runtime for React components
- *
- * @requires SiteRuntime
- * @returns {UseSiteRuntime} siteRuntime
- * @example
- * import { useSiteRuntime } from "@trackunit/react-core-hooks";
- * const { siteInfo } = useSiteRuntime();
- * // use siteInfo to get assets for instance.
- * useEffect(() => {
- *   (async () => {
- *     if (siteInfo?.siteId) {
- *       getSiteAssets({ variables: { siteId: siteInfo?.siteId, siteIdStr: siteInfo?.siteId } });
- *     }
- *   })();
- * }, [getSiteAssets, siteInfo]);
- *
- */
-const useSiteRuntime = () => {
-    const [siteInfo, setSiteInfo] = useState();
-    useEffect(() => {
-        const getSiteInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-            const updatedSiteInfo = yield SiteRuntime.getSiteInfo();
-            setSiteInfo(updatedSiteInfo);
-        });
-        getSiteInfo();
-    }, []);
-    return { siteInfo };
+/**
+ * A hook to expose site runtime for React components
+ *
+ * @requires SiteRuntime
+ * @returns {UseSiteRuntime} siteRuntime
+ * @example
+ * import { useSiteRuntime } from "@trackunit/react-core-hooks";
+ * const { siteInfo } = useSiteRuntime();
+ * // use siteInfo to get assets for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (siteInfo?.siteId) {
+ *       getSiteAssets({ variables: { siteId: siteInfo?.siteId, siteIdStr: siteInfo?.siteId } });
+ *     }
+ *   })();
+ * }, [getSiteAssets, siteInfo]);
+ *
+ */
+const useSiteRuntime = () => {
+    const [siteInfo, setSiteInfo] = useState();
+    useEffect(() => {
+        const getSiteInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            const updatedSiteInfo = yield SiteRuntime.getSiteInfo();
+            setSiteInfo(updatedSiteInfo);
+        });
+        getSiteInfo();
+    }, []);
+    return { siteInfo };
 };
 
-const UserSubscriptionContext = React.createContext(null);
-/**
- * This is a provider for the UserSubscriptionContext.
- */
-const UserSubscriptionProvider = (props) => {
-    return jsx(UserSubscriptionContext.Provider, Object.assign({}, props));
-};
-/**
- * This is a hook to use the UserSubscriptionContext.
- *
- * @requires UserSubscriptionProvider
- * @example
- * import { useUserSubscription } from "@trackunit/react-core-hooks";
- * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
- * // use it for something
- * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
- *
- * @see {@link IUserSubscriptionContext}
- */
-const useUserSubscription = () => {
-    const context = React.useContext(UserSubscriptionContext);
-    if (!context) {
-        throw new Error("Cannot use useUserSubscription outside UserSubscriptionProvider");
-    }
-    return context;
+const UserSubscriptionContext = React.createContext(null);
+/**
+ * This is a provider for the UserSubscriptionContext.
+ */
+const UserSubscriptionProvider = (props) => {
+    return jsx(UserSubscriptionContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook to use the UserSubscriptionContext.
+ *
+ * @requires UserSubscriptionProvider
+ * @example
+ * import { useUserSubscription } from "@trackunit/react-core-hooks";
+ * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
+ * // use it for something
+ * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
+ *
+ * @see {@link IUserSubscriptionContext}
+ */
+const useUserSubscription = () => {
+    const context = React.useContext(UserSubscriptionContext);
+    if (!context) {
+        throw new Error("Cannot use useUserSubscription outside UserSubscriptionProvider");
+    }
+    return context;
 };
 
-const ToastContext = React.createContext(null);
-/**
- * This is a provider for the ToastContext.
- */
-const ToastProvider = (props) => jsx(ToastContext.Provider, Object.assign({}, props));
-/**
- * This is a hook to use the ToastContext.
- *
- * @requires ToastProvider
- * @example
- * import { useToast } from "@trackunit/react-core-hooks";
- * const { addToast } = useToast();
- * // use the toast
- * error &&
- *  addToast({
- *    intent: "warning",
- *    title: t("assetHome.specification.failedToSave"),
- *    description: error?.message,
- *    duration: 3000,
- *  });
- *
- * @see {@link IToastContext}
- */
-const useToast = () => {
-    const toastContext = React.useContext(ToastContext);
-    if (!toastContext) {
-        throw new Error("useToast must be used within the ToastProvider");
-    }
-    return toastContext;
+const ToastContext = React.createContext(null);
+/**
+ * This is a provider for the ToastContext.
+ */
+const ToastProvider = (props) => jsx(ToastContext.Provider, Object.assign({}, props));
+/**
+ * This is a hook to use the ToastContext.
+ *
+ * @requires ToastProvider
+ * @example
+ * import { useToast } from "@trackunit/react-core-hooks";
+ * const { addToast } = useToast();
+ * // use the toast
+ * error &&
+ *  addToast({
+ *    intent: "warning",
+ *    title: t("assetHome.specification.failedToSave"),
+ *    description: error?.message,
+ *    duration: 3000,
+ *  });
+ *
+ * @see {@link IToastContext}
+ */
+const useToast = () => {
+    const toastContext = React.useContext(ToastContext);
+    if (!toastContext) {
+        throw new Error("useToast must be used within the ToastProvider");
+    }
+    return toastContext;
 };
 
-const TokenContext = React.createContext(null);
-/**
- * This is a hook to use the TokenContext.
- *
- * @requires TokenProvider
- * @example
- * import { useToken } from "@trackunit/react-core-hooks";
- * const { token } = useToken();
- *
- * @see {@link ITokenContext}
- */
-const useToken = () => {
-    const context = React.useContext(TokenContext);
-    if (!context) {
-        throw new Error("useToken must be used within the TokenContext");
-    }
-    return context;
-};
-/**
- * This is a provider for the TokenContext.
- */
-const TokenProvider = (props) => {
-    return jsx(TokenContext.Provider, Object.assign({}, props));
+const TokenContext = React.createContext(null);
+/**
+ * This is a hook to use the TokenContext.
+ *
+ * @requires TokenProvider
+ * @example
+ * import { useToken } from "@trackunit/react-core-hooks";
+ * const { token } = useToken();
+ *
+ * @see {@link ITokenContext}
+ */
+const useToken = () => {
+    const context = React.useContext(TokenContext);
+    if (!context) {
+        throw new Error("useToken must be used within the TokenContext");
+    }
+    return context;
+};
+/**
+ * This is a provider for the TokenContext.
+ */
+const TokenProvider = (props) => {
+    return jsx(TokenContext.Provider, Object.assign({}, props));
 };
 
-const CurrentUserContext = React.createContext(null);
-/**
- * This is a provider for the CurrentUserContext.
- */
-const CurrentUserProvider = (props) => {
-    return jsx(CurrentUserContext.Provider, Object.assign({}, props));
-};
-/**
- * This is a hook providing the CurrentUserContext.
- *
- * @requires CurrentUserProvider
- * @example
- * import { useCurrentUser } from "@trackunit/react-core-hooks";
- * const { assumedUser, accountId } = useCurrentUser();
- *
- * //use it for something
- * const { data, loading } = useGetAccountByIdQuery({
- *    variables: { accountId: assumedUser?.accountId || accountId || "" },
- * });
- *
- * @see {@link ICurrentUserContext}
- */
-const useCurrentUser = () => {
-    const context = React.useContext(CurrentUserContext);
-    if (!context) {
-        throw new Error("useCurrentUser must be used within the CurrentUserProvider");
-    }
-    return context;
+const CurrentUserContext = React.createContext(null);
+/**
+ * This is a provider for the CurrentUserContext.
+ */
+const CurrentUserProvider = (props) => {
+    return jsx(CurrentUserContext.Provider, Object.assign({}, props));
+};
+/**
+ * This is a hook providing the CurrentUserContext.
+ *
+ * @requires CurrentUserProvider
+ * @example
+ * import { useCurrentUser } from "@trackunit/react-core-hooks";
+ * const { assumedUser, accountId } = useCurrentUser();
+ *
+ * //use it for something
+ * const { data, loading } = useGetAccountByIdQuery({
+ *    variables: { accountId: assumedUser?.accountId || accountId || "" },
+ * });
+ *
+ * @see {@link ICurrentUserContext}
+ */
+const useCurrentUser = () => {
+    const context = React.useContext(CurrentUserContext);
+    if (!context) {
+        throw new Error("useCurrentUser must be used within the CurrentUserProvider");
+    }
+    return context;
 };
 
 export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserProvider, EnvironmentContextProvider, GlobalSelectionProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useGlobalSelection, useNavigationRuntime, useOemBrandingContext, useRestRuntime, useSiteRuntime, useToast, useToken, useURLSynchronization, useUserSubscription };