@trackunit/react-core-hooks 0.2.118 → 0.2.121

package/index.cjs.js

@@ -421,6 +421,35 @@ 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.
@@ -647,6 +676,7 @@ exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
 exports.useCustomFieldRuntime = useCustomFieldRuntime;
 exports.useCustomFieldRuntimeForEntity = useCustomFieldRuntimeForEntity;
 exports.useEnvironment = useEnvironment;
+exports.useEventRuntime = useEventRuntime;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useGlobalSelection = useGlobalSelection;
 exports.useHasAccessTo = useHasAccessTo;

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 } from '@trackunit/iris-app-runtime-core';
+import { NavigationRuntime, AssetRuntime, CustomFieldRuntime, RestRuntime, SiteRuntime, EventRuntime } from '@trackunit/iris-app-runtime-core';
 import { useLocation } from 'react-router-dom';
 import { filterByMultiple } from '@trackunit/shared-utils';
 
@@ -395,6 +395,35 @@ 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.
@@ -598,4 +627,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useFilterBarContext, useGlobalSelection, useHasAccessTo, useNavigateInHost, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, GlobalSelectionProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomFieldRuntime, useCustomFieldRuntimeForEntity, useEnvironment, useEventRuntime, useFilterBarContext, useGlobalSelection, useHasAccessTo, useNavigateInHost, useOemBrandingContext, useRestRuntime, useSiteRuntime, useTextSearch, useToast, useToken, useURLSynchronization, useUserSubscription };

package/package.json

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

package/src/index.d.ts

@@ -11,6 +11,7 @@ export * from "./runtimes/useCustomFieldRuntime";
 export * from "./runtimes/useCustomFieldRuntimeForEntity";
 export * from "./runtimes/useRestRuntime";
 export * from "./runtimes/useSiteRuntime";
+export * from "./runtimes/useEventRuntime";
 export * from "./subscription/UserSubscriptionProvider";
 export * from "./toast/ToastProvider";
 export * from "./token/TokenProvider";

package/src/runtimes/useEventRuntime.d.ts

@@ -0,0 +1,22 @@
+import { EventInfo } from "@trackunit/iris-app-runtime-core";
+export interface UseEventRuntime {
+    eventInfo: EventInfo | undefined;
+}
+/**
+ * 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]);
+ */
+export declare const useEventRuntime: () => UseEventRuntime;