@trackunit/react-core-hooks 0.2.189 → 0.2.191

package/index.cjs.js

@@ -313,6 +313,45 @@ const useAssetRuntime = () => {
     return { assetInfo, loading, error };
 };
 
+/**
+ * A hook to expose customer runtime for React components
+ *
+ * @requires CustomerRuntime
+ * @returns {UseCustomerRuntime} customerRuntime
+ * @example
+ * import { useCustomerRuntime } from "@trackunit/react-core-hooks";
+ * const { customerInfo } = useCustomerRuntime();
+ * // use customerInfo to get customer info for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (customerInfo?.customerId) {
+ *       // use graphql to get data for the customerId
+ *     }
+ *   })();
+ * }, [customerInfo]);
+ */
+const useCustomerRuntime = () => {
+    const [customerInfo, setCustomerInfo] = React.useState();
+    const [loading, setLoading] = React.useState(true);
+    const [error, setError] = React.useState();
+    React.useEffect(() => {
+        const getCustomerInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            setLoading(true);
+            try {
+                const updatedCustomerInfo = yield irisAppRuntimeCore.CustomerRuntime.getCustomerInfo();
+                setLoading(false);
+                setCustomerInfo(updatedCustomerInfo);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get customer info"));
+            }
+        });
+        getCustomerInfo();
+    }, []);
+    return { customerInfo, loading, error };
+};
+
 /**
  * A hook to expose event runtime for React components
  *
@@ -389,6 +428,44 @@ const useIrisAppName = () => {
     }, []);
     return { appName, loading, error };
 };
+/**
+ * A hook to expose irisAppId using ParamsRuntime's getAppName and getOrgName for React components
+ *
+ * @requires ParamsRuntime
+ * @returns {UseIrisAppId} irisAppId, loading, error
+ * @example
+ * import { useIrisAppName } from "@trackunit/react-core-hooks";
+ * const { irisAppId } = useIrisAppName();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (irisAppId) {
+ *       // do something with irisAppId
+ *     }
+ *   })();
+ * }, [irisAppId]);
+ */
+const useIrisAppId = () => {
+    const [irisAppId, setIrisAppId] = React.useState();
+    const [loading, setLoading] = React.useState(true);
+    const [error, setError] = React.useState();
+    React.useEffect(() => {
+        const getAppName = () => __awaiter(void 0, void 0, void 0, function* () {
+            setLoading(true);
+            try {
+                const updatedAppName = yield irisAppRuntimeCore.ParamsRuntime.getAppName();
+                const updatedOrgName = yield irisAppRuntimeCore.ParamsRuntime.getOrgName();
+                setLoading(false);
+                setIrisAppId(`${updatedOrgName}/${updatedAppName}`);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get iris app name"));
+            }
+        });
+        getAppName();
+    }, []);
+    return { irisAppId, loading, error };
+};
 
 /**
  * A hook to expose site runtime for React components
@@ -661,10 +738,12 @@ exports.useCurrentUser = useCurrentUser;
 exports.useCurrentUserLanguage = useCurrentUserLanguage;
 exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
 exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
+exports.useCustomerRuntime = useCustomerRuntime;
 exports.useEnvironment = useEnvironment;
 exports.useEventRuntime = useEventRuntime;
 exports.useFilterBarContext = useFilterBarContext;
 exports.useHasAccessTo = useHasAccessTo;
+exports.useIrisAppId = useIrisAppId;
 exports.useIrisAppName = useIrisAppName;
 exports.useNavigateInHost = useNavigateInHost;
 exports.useOemBrandingContext = useOemBrandingContext;

package/index.esm.js

@@ -1,7 +1,7 @@
 import * as React from 'react';
 import { createContext, useContext, useState, useEffect, useMemo } from 'react';
 import { jsx } from 'react/jsx-runtime';
-import { AssetRuntime, EventRuntime, ParamsRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
+import { AssetRuntime, CustomerRuntime, EventRuntime, ParamsRuntime, SiteRuntime } from '@trackunit/iris-app-runtime-core';
 import { filterByMultiple } from '@trackunit/shared-utils';
 
 const AnalyticsContext = createContext(null);
@@ -290,6 +290,45 @@ const useAssetRuntime = () => {
     return { assetInfo, loading, error };
 };
 
+/**
+ * A hook to expose customer runtime for React components
+ *
+ * @requires CustomerRuntime
+ * @returns {UseCustomerRuntime} customerRuntime
+ * @example
+ * import { useCustomerRuntime } from "@trackunit/react-core-hooks";
+ * const { customerInfo } = useCustomerRuntime();
+ * // use customerInfo to get customer info for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (customerInfo?.customerId) {
+ *       // use graphql to get data for the customerId
+ *     }
+ *   })();
+ * }, [customerInfo]);
+ */
+const useCustomerRuntime = () => {
+    const [customerInfo, setCustomerInfo] = useState();
+    const [loading, setLoading] = useState(true);
+    const [error, setError] = useState();
+    useEffect(() => {
+        const getCustomerInfo = () => __awaiter(void 0, void 0, void 0, function* () {
+            setLoading(true);
+            try {
+                const updatedCustomerInfo = yield CustomerRuntime.getCustomerInfo();
+                setLoading(false);
+                setCustomerInfo(updatedCustomerInfo);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get customer info"));
+            }
+        });
+        getCustomerInfo();
+    }, []);
+    return { customerInfo, loading, error };
+};
+
 /**
  * A hook to expose event runtime for React components
  *
@@ -366,6 +405,44 @@ const useIrisAppName = () => {
     }, []);
     return { appName, loading, error };
 };
+/**
+ * A hook to expose irisAppId using ParamsRuntime's getAppName and getOrgName for React components
+ *
+ * @requires ParamsRuntime
+ * @returns {UseIrisAppId} irisAppId, loading, error
+ * @example
+ * import { useIrisAppName } from "@trackunit/react-core-hooks";
+ * const { irisAppId } = useIrisAppName();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (irisAppId) {
+ *       // do something with irisAppId
+ *     }
+ *   })();
+ * }, [irisAppId]);
+ */
+const useIrisAppId = () => {
+    const [irisAppId, setIrisAppId] = useState();
+    const [loading, setLoading] = useState(true);
+    const [error, setError] = useState();
+    useEffect(() => {
+        const getAppName = () => __awaiter(void 0, void 0, void 0, function* () {
+            setLoading(true);
+            try {
+                const updatedAppName = yield ParamsRuntime.getAppName();
+                const updatedOrgName = yield ParamsRuntime.getOrgName();
+                setLoading(false);
+                setIrisAppId(`${updatedOrgName}/${updatedAppName}`);
+            }
+            catch (e) {
+                setLoading(false);
+                setError(new Error("Failed to get iris app name"));
+            }
+        });
+        getAppName();
+    }, []);
+    return { irisAppId, loading, error };
+};
 
 /**
  * A hook to expose site runtime for React components
@@ -617,4 +694,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useEnvironment, useEventRuntime, useFilterBarContext, useHasAccessTo, useIrisAppName, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useEventRuntime, useFilterBarContext, useHasAccessTo, useIrisAppId, useIrisAppName, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };

package/package.json

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

package/src/index.d.ts

@@ -6,6 +6,7 @@ export * from "./filter-bar/FilterBarProvider";
 export * from "./irisOemApp/IrisOemAppContextProvider";
 export * from "./navigation/NavigationContextProvider";
 export * from "./runtimes/useAssetRuntime";
+export * from "./runtimes/useCustomerRuntime";
 export * from "./runtimes/useEventRuntime";
 export * from "./runtimes/useParamsRuntime";
 export * from "./runtimes/useSiteRuntime";

package/src/runtimes/useCustomerRuntime.d.ts

@@ -0,0 +1,24 @@
+import { CustomerInfo } from "@trackunit/iris-app-runtime-core";
+export interface UseCustomerRuntime {
+    customerInfo?: CustomerInfo;
+    loading: boolean;
+    error: Error | undefined;
+}
+/**
+ * A hook to expose customer runtime for React components
+ *
+ * @requires CustomerRuntime
+ * @returns {UseCustomerRuntime} customerRuntime
+ * @example
+ * import { useCustomerRuntime } from "@trackunit/react-core-hooks";
+ * const { customerInfo } = useCustomerRuntime();
+ * // use customerInfo to get customer info for instance.
+ * useEffect(() => {
+ *   (async () => {
+ *     if (customerInfo?.customerId) {
+ *       // use graphql to get data for the customerId
+ *     }
+ *   })();
+ * }, [customerInfo]);
+ */
+export declare const useCustomerRuntime: () => UseCustomerRuntime;

package/src/runtimes/useParamsRuntime.d.ts

@@ -20,3 +20,25 @@ export interface UseIrisAppName {
  * }, [appName]);
  */
 export declare const useIrisAppName: () => UseIrisAppName;
+export interface UseIrisAppId {
+    irisAppId: string | undefined;
+    loading: boolean;
+    error: Error | undefined;
+}
+/**
+ * A hook to expose irisAppId using ParamsRuntime's getAppName and getOrgName for React components
+ *
+ * @requires ParamsRuntime
+ * @returns {UseIrisAppId} irisAppId, loading, error
+ * @example
+ * import { useIrisAppName } from "@trackunit/react-core-hooks";
+ * const { irisAppId } = useIrisAppName();
+ * useEffect(() => {
+ *   (async () => {
+ *     if (irisAppId) {
+ *       // do something with irisAppId
+ *     }
+ *   })();
+ * }, [irisAppId]);
+ */
+export declare const useIrisAppId: () => UseIrisAppId;