@trackunit/react-core-hooks 0.2.57 → 0.2.58

package/index.cjs

@@ -34,6 +34,21 @@ const AnalyticsContext = React.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 = React.useContext(AnalyticsContext);
@@ -50,6 +65,32 @@ const AssetSortingContext = React.createContext(null);
 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 = React.useContext(AssetSortingContext);
@@ -68,6 +109,14 @@ const EnvironmentContextProvider = (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 = React.useContext(EnvironmentContext);
@@ -80,6 +129,17 @@ const useEnvironment = () => {
 const GlobalSelectionContext = React__namespace.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__namespace.useContext(GlobalSelectionContext);
@@ -96,11 +156,20 @@ const GlobalSelectionProvider = (props) => jsxRuntime.jsx(GlobalSelectionContext
 const OemBrandingContext = React.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 = React.useContext(OemBrandingContext);
     if (!context) {
-        throw new Error("useOemBranding must be used within an IOemBrandingContext");
+        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
     }
     return context;
 };
@@ -130,7 +199,15 @@ const useURLSynchronization = () => {
 /**
  * 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 irisAppRuntimeCore.NavigationRuntime;
@@ -164,7 +241,19 @@ 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] = React.useState();
@@ -192,6 +281,16 @@ const useCustomFieldRuntime = () => {
  *
  * @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();
@@ -235,7 +334,20 @@ const useRestRuntime = () => {
 /**
  * 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] = React.useState();
@@ -258,6 +370,15 @@ const UserSubscriptionProvider = (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__namespace.useContext(UserSubscriptionContext);
@@ -274,6 +395,21 @@ const ToastContext = React__namespace.createContext(null);
 const ToastProvider = (props) => jsxRuntime.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__namespace.useContext(ToastContext);
@@ -286,6 +422,13 @@ const useToast = () => {
 const TokenContext = React__namespace.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__namespace.useContext(TokenContext);
@@ -309,7 +452,19 @@ const CurrentUserProvider = (props) => {
     return jsxRuntime.jsx(CurrentUserContext.Provider, Object.assign({}, props));
 };
 /**
- * This is a hook to use the CurrentUserContext.
+ * 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__namespace.useContext(CurrentUserContext);

package/index.js

@@ -8,6 +8,21 @@ 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);
@@ -24,6 +39,32 @@ const AssetSortingContext = createContext(null);
 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);
@@ -42,6 +83,14 @@ const EnvironmentContextProvider = (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);
@@ -54,6 +103,17 @@ const useEnvironment = () => {
 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);
@@ -70,11 +130,20 @@ const GlobalSelectionProvider = (props) => jsx(GlobalSelectionContext.Provider,
 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 IOemBrandingContext");
+        throw new Error("useOemBranding must be used within an OemBrandingContextProvider");
     }
     return context;
 };
@@ -104,7 +173,15 @@ const useURLSynchronization = () => {
 /**
  * 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;
@@ -138,7 +215,19 @@ 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();
@@ -166,6 +255,16 @@ const useCustomFieldRuntime = () => {
  *
  * @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();
@@ -209,7 +308,20 @@ const useRestRuntime = () => {
 /**
  * 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();
@@ -232,6 +344,15 @@ const UserSubscriptionProvider = (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);
@@ -248,6 +369,21 @@ const ToastContext = React.createContext(null);
 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);
@@ -260,6 +396,13 @@ const useToast = () => {
 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);
@@ -283,7 +426,19 @@ const CurrentUserProvider = (props) => {
     return jsx(CurrentUserContext.Provider, Object.assign({}, props));
 };
 /**
- * This is a hook to use the CurrentUserContext.
+ * 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);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.57",
+  "version": "0.2.58",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "module": "./index.js",

package/src/analytics/AnalyticsProvider.d.ts

@@ -4,5 +4,20 @@ export declare const AnalyticsContext: import("react").Context<IAnalyticsContext
 export declare const AnalyticsContextProvider: import("react").Provider<IAnalyticsContext<{}> | null>;
 /**
  * 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}
  */
 export declare const useAnalytics: <T extends Record<string, Event<BaseEvent | UnspecifiedEvent>>>(type: T) => IAnalyticsContext<T>;

package/src/assetSorting/AssetSortingProvider.d.ts

@@ -6,5 +6,31 @@ import { IAssetSortingContext } from "@trackunit/react-core-contexts-api";
 export declare const AssetSortingProvider: import("react").Provider<IAssetSortingContext | null>;
 /**
  * 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}
  */
 export declare const useAssetSorting: () => IAssetSortingContext;

package/src/environment/EnvironmentContextProvider.d.ts

@@ -10,6 +10,14 @@ interface IProps {
 export declare const EnvironmentContextProvider: (props: IProps) => JSX.Element;
 /**
  * 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)
  */
 export declare const useEnvironment: () => IEnvironmentContext;
 export {};

package/src/global-selection/GlobalSelectionProvider.d.ts

@@ -2,6 +2,17 @@ import { IGlobalSelectionContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 /**
  * 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}
  */
 export declare const useGlobalSelection: () => IGlobalSelectionContext;
 interface IProps {

package/src/irisOemApp/IrisOemAppContextProvider.d.ts

@@ -2,6 +2,15 @@
 import { IOemBrandingContext } from "@trackunit/react-core-contexts-api";
 /**
  * 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}
  */
 export declare const useOemBrandingContext: () => IOemBrandingContext;
 interface IProps {

package/src/runtimes/navigation/useNavigationRuntime.d.ts

@@ -4,6 +4,14 @@ export interface UseNavigationRuntime extends INavigationRuntime {
 /**
  * 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>
  */
 export declare const useNavigationRuntime: () => UseNavigationRuntime;

package/src/runtimes/useAssetRuntime.d.ts

@@ -5,6 +5,18 @@ export interface UseAssetRuntime {
 /**
  * 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]);
+ *
  */
 export declare const useAssetRuntime: () => UseAssetRuntime;

package/src/runtimes/useCustomFieldRuntimeForEntity.d.ts

@@ -5,6 +5,16 @@ import { EntityIdentity, ValueAndDefinitionKey } from "@trackunit/iris-app-runti
  *
  * @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"});
  */
 export declare const useCustomFieldRuntimeForEntity: (entity: EntityIdentity) => {
     customFields: ValueAndDefinition[] | undefined;

package/src/runtimes/useSiteRuntime.d.ts

@@ -5,6 +5,19 @@ export interface UseSiteRuntime {
 /**
  * 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]);
+ *
  */
 export declare const useSiteRuntime: () => UseSiteRuntime;

package/src/subscription/UserSubscriptionProvider.d.ts

@@ -10,6 +10,15 @@ interface IProps {
 export declare const UserSubscriptionProvider: (props: IProps) => JSX.Element;
 /**
  * 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}
  */
 export declare const useUserSubscription: () => IUserSubscriptionContext;
 export {};

package/src/toast/ToastProvider.d.ts

@@ -10,5 +10,20 @@ export interface ContextProviderProps {
 export declare const ToastProvider: (props: ContextProviderProps) => JSX.Element;
 /**
  * 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}
  */
 export declare const useToast: () => IToastContext;

package/src/token/TokenProvider.d.ts

@@ -2,6 +2,13 @@ import { ITokenContext } from "@trackunit/react-core-contexts-api";
 import * as React from "react";
 /**
  * This is a hook to use the TokenContext.
+ *
+ * @requires TokenProvider
+ * @example
+ * import { useToken } from "@trackunit/react-core-hooks";
+ * const { token } = useToken();
+ *
+ * @see {@link ITokenContext}
  */
 export declare const useToken: () => ITokenContext;
 interface IProps {

package/src/user/CurrentUserProvider.d.ts

@@ -9,7 +9,19 @@ interface Props {
  */
 export declare const CurrentUserProvider: (props: Props) => JSX.Element;
 /**
- * This is a hook to use the CurrentUserContext.
+ * 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}
  */
 export declare const useCurrentUser: () => ICurrentUserContext;
 export {};