@trackunit/react-core-hooks 0.2.137 → 0.2.138

package/index.cjs.js

@@ -292,14 +292,24 @@ const useURLSynchronization = () => {
  */
 const useAssetRuntime = () => {
     const [assetInfo, setAssetInfo] = React.useState();
+    const [loading, setLoading] = React.useState(true);
+    const [error, setError] = React.useState();
     React.useEffect(() => {
         const getAssetInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-            const updatedAssetInfo = yield irisAppRuntimeCore.AssetRuntime.getAssetInfo();
-            setAssetInfo(updatedAssetInfo);
+            setLoading(true);
+            try {
+                const updatedAssetInfo = yield irisAppRuntimeCore.AssetRuntime.getAssetInfo();
+                setLoading(false);
+                setAssetInfo(updatedAssetInfo);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get asset info"));
+            }
         });
         getAssetInfo();
     }, []);
-    return { assetInfo };
+    return { assetInfo, loading, error };
 };
 
 /**
@@ -358,12 +368,32 @@ const useCustomFieldRuntimeForEntity = (entity) => {
 };
 
 /**
- * A hook to expose rest runtime to be used in React components
+ * A hook to expose event runtime for React components
  *
- * @returns {UseRestRuntime} a RestRuntime
+ * @requires EventRuntime
+ * @returns {UseEventRuntime} eventRuntime
+ * @example
+ * import { useEventRuntime } from "@trackunit/react-core-hooks";
+ * const { eventInfo } = useEventRuntime();
+ * // use eventInfo to get events for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (eventInfo?.id) {
+ *       getEventQuery({ variables: { eventId: eventInfo?.id } });
+ *     }
+ *   })();
+ * }, [getEventQuery, eventInfo]);
  */
-const useRestRuntime = () => {
-    return irisAppRuntimeCore.RestRuntime;
+const useEventRuntime = () => {
+    const [eventInfo, setEventInfo] = React.useState();
+    React.useEffect(() => {
+        const getEventInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            const updatedEventInfo = yield irisAppRuntimeCore.EventRuntime.getEventInfo();
+            setEventInfo(updatedEventInfo);
+        });
+        getEventInfo();
+    }, []);
+    return { eventInfo };
 };
 
 /**
@@ -395,35 +425,6 @@ const useSiteRuntime = () => {
     return { siteInfo };
 };
 
-/**
- * A hook to expose event runtime for React components
- *
- * @requires EventRuntime
- * @returns {UseEventRuntime} eventRuntime
- * @example
- * import { useEventRuntime } from "@trackunit/react-core-hooks";
- * const { eventInfo } = useEventRuntime();
- * // use eventInfo to get events for instance.
- * useEffect(() => {
- *   (async () => {
- *     if (eventInfo?.id) {
- *       getEventQuery({ variables: { eventId: eventInfo?.id } });
- *     }
- *   })();
- * }, [getEventQuery, eventInfo]);
- */
-const useEventRuntime = () => {
-    const [eventInfo, setEventInfo] = React.useState();
-    React.useEffect(() => {
-        const getEventInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-            const updatedEventInfo = yield irisAppRuntimeCore.EventRuntime.getEventInfo();
-            setEventInfo(updatedEventInfo);
-        });
-        getEventInfo();
-    }, []);
-    return { eventInfo };
-};
-
 const UserSubscriptionContext = React__namespace.createContext(null);
 /**
  * This is a provider for the UserSubscriptionContext.
@@ -654,7 +655,6 @@ exports.useFilterBarContext = useFilterBarContext;
 exports.useHasAccessTo = useHasAccessTo;
 exports.useNavigateInHost = useNavigateInHost;
 exports.useOemBrandingContext = useOemBrandingContext;
-exports.useRestRuntime = useRestRuntime;
 exports.useSiteRuntime = useSiteRuntime;
 exports.useTextSearch = useTextSearch;
 exports.useToast = useToast;

package/index.esm.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import React__default, { createContext, useContext, useState, useEffect, useMemo } from 'react';
 import { jsx } from 'react/jsx-runtime';
-import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteRuntime, EventRuntime } from '@trackunit/iris-app-runtime-core';
+import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, EventRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { useLocation } from 'react-router-dom';
 import { filterByMultiple } from '@trackunit/shared-utils';
 
@@ -266,14 +266,24 @@ const useURLSynchronization = () => {
  */
 const useAssetRuntime = () => {
     const [assetInfo, setAssetInfo] = useState();
+    const [loading, setLoading] = useState(true);
+    const [error, setError] = useState();
     useEffect(() => {
         const getAssetInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-            const updatedAssetInfo = yield AssetRuntime.getAssetInfo();
-            setAssetInfo(updatedAssetInfo);
+            setLoading(true);
+            try {
+                const updatedAssetInfo = yield AssetRuntime.getAssetInfo();
+                setLoading(false);
+                setAssetInfo(updatedAssetInfo);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get asset info"));
+            }
         });
         getAssetInfo();
     }, []);
-    return { assetInfo };
+    return { assetInfo, loading, error };
 };
 
 /**
@@ -332,12 +342,32 @@ const useCustomFieldRuntimeForEntity = (entity) => {
 };
 
 /**
- * A hook to expose rest runtime to be used in React components
+ * A hook to expose event runtime for React components
  *
- * @returns {UseRestRuntime} a RestRuntime
+ * @requires EventRuntime
+ * @returns {UseEventRuntime} eventRuntime
+ * @example
+ * import { useEventRuntime } from "@trackunit/react-core-hooks";
+ * const { eventInfo } = useEventRuntime();
+ * // use eventInfo to get events for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (eventInfo?.id) {
+ *       getEventQuery({ variables: { eventId: eventInfo?.id } });
+ *     }
+ *   })();
+ * }, [getEventQuery, eventInfo]);
  */
-const useRestRuntime = () => {
-    return RestRuntime;
+const useEventRuntime = () => {
+    const [eventInfo, setEventInfo] = useState();
+    useEffect(() => {
+        const getEventInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            const updatedEventInfo = yield EventRuntime.getEventInfo();
+            setEventInfo(updatedEventInfo);
+        });
+        getEventInfo();
+    }, []);
+    return { eventInfo };
 };
 
 /**
@@ -369,35 +399,6 @@ const useSiteRuntime = () => {
     return { siteInfo };
 };
 
-/**
- * A hook to expose event runtime for React components
- *
- * @requires EventRuntime
- * @returns {UseEventRuntime} eventRuntime
- * @example
- * import { useEventRuntime } from "@trackunit/react-core-hooks";
- * const { eventInfo } = useEventRuntime();
- * // use eventInfo to get events for instance.
- * useEffect(() => {
- *   (async () => {
- *     if (eventInfo?.id) {
- *       getEventQuery({ variables: { eventId: eventInfo?.id } });
- *     }
- *   })();
- * }, [getEventQuery, eventInfo]);
- */
-const useEventRuntime = () => {
-    const [eventInfo, setEventInfo] = useState();
-    useEffect(() => {
-        const getEventInfo = () => __awaiter(void 0, void 0, void 0, function* () {
-            const updatedEventInfo = yield EventRuntime.getEventInfo();
-            setEventInfo(updatedEventInfo);
-        });
-        getEventInfo();
-    }, []);
-    return { eventInfo };
-};
-
 const UserSubscriptionContext = React.createContext(null);
 /**
  * This is a provider for the UserSubscriptionContext.
@@ -601,4 +602,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useEventRuntime, useFilterBarContext, useHasAccessTo, useNavigateInHost, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useEventRuntime, useFilterBarContext, useHasAccessTo, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "0.2.137",
+  "version": "0.2.138",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {

package/src/index.d.ts

@@ -8,9 +8,8 @@ export * from "./navigation/useURLSynchronization";
 export * from "./runtimes/useAssetRuntime";
 export * from "./runtimes/useCustomFieldRuntime";
 export * from "./runtimes/useCustomFieldRuntimeForEntity";
-export * from "./runtimes/useRestRuntime";
-export * from "./runtimes/useSiteRuntime";
 export * from "./runtimes/useEventRuntime";
+export * from "./runtimes/useSiteRuntime";
 export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";

package/src/runtimes/useAssetRuntime.d.ts

@@ -1,6 +1,8 @@
 import { AssetInfo } from "@trackunit/iris-app-runtime-core";
 export interface UseAssetRuntime {
     assetInfo: AssetInfo | undefined;
+    loading: boolean;
+    error: Error | undefined;
 }
 /**
  * A hook to expose asset runtime for React components

package/src/runtimes/useRestRuntime.d.ts

@@ -1,10 +0,0 @@
-import { IRestRuntime } from "@trackunit/iris-app-runtime-core";
-interface UseRestRuntime extends IRestRuntime {
-}
-/**
- * A hook to expose rest runtime to be used in React components
- *
- * @returns {UseRestRuntime} a RestRuntime
- */
-export declare const useRestRuntime: () => UseRestRuntime;
-export {};