@trackunit/react-core-hooks 1.12.64 → 1.12.65

package/index.cjs.js

@@ -821,7 +821,6 @@ const useCurrentUser = () => {
 /**
  * This is a hook providing the Current User language.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
  * const { language, setLanguage } = useCurrentUserLanguage();
@@ -849,7 +848,6 @@ const useCurrentUserLanguage = () => {
 /**
  * This is a hook providing the Current User TimeZone Preference.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
  * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
@@ -873,7 +871,6 @@ const useCurrentUserTimeZonePreference = () => {
 /**
  * This is a hook providing the Current User language.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
  * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
@@ -894,6 +891,52 @@ const useCurrentUserSystemOfMeasurement = () => {
         };
     }, [context.systemOfMeasurement, context.setSystemOfMeasurement]);
 };
+/**
+ * This is a hook providing the Current User Favorite Insights.
+ *
+ * @example
+ * import { useCurrentUserFavoriteInsights } from "@trackunit/react-core-hooks";
+ * const { favoriteInsights, setFavoriteInsights } = useCurrentUserFavoriteInsights();
+ *
+ * favoriteInsights: Gets the favorite insights of the current user.
+ * setFavoriteInsights: Sets the favorite insights of the current user.
+ * @see { CurrentUserPreferenceState}
+ */
+const useCurrentUserFavoriteInsights = () => {
+    const context = react.useContext(reactCoreContextsApi.CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserFavoriteInsights must be used within the CurrentUserPreferenceProvider");
+    }
+    return react.useMemo(() => {
+        return {
+            favoriteInsights: context.favoriteInsights || null,
+            setFavoriteInsights: context.setFavoriteInsights,
+        };
+    }, [context.favoriteInsights, context.setFavoriteInsights]);
+};
+/**
+ * This is a hook providing the Current User Favorite Advanced Sensors.
+ *
+ * @example
+ * import { useCurrentUserFavoriteAdvancedSensors } from "@trackunit/react-core-hooks";
+ * const { favoriteAdvancedSensors, setFavoriteAdvancedSensors } = useCurrentUserFavoriteAdvancedSensors();
+ *
+ * favoriteAdvancedSensors: Gets the favorite advanced sensors of the current user.
+ * setFavoriteAdvancedSensors: Sets the favorite advanced sensors of the current user.
+ * @see { CurrentUserPreferenceState}
+ */
+const useCurrentUserFavoriteAdvancedSensors = () => {
+    const context = react.useContext(reactCoreContextsApi.CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserFavoriteAdvancedSensors must be used within the CurrentUserPreferenceProvider");
+    }
+    return react.useMemo(() => {
+        return {
+            favoriteAdvancedSensors: context.favoriteAdvancedSensors || null,
+            setFavoriteAdvancedSensors: context.setFavoriteAdvancedSensors,
+        };
+    }, [context.favoriteAdvancedSensors, context.setFavoriteAdvancedSensors]);
+};
 const setGlobalLanguage = (language) => {
     if (typeof global !== "undefined") {
         Object.defineProperty(global, "language", {
@@ -1021,6 +1064,8 @@ exports.useAssetRuntime = useAssetRuntime;
 exports.useAssetSorting = useAssetSorting;
 exports.useConfirmationDialog = useConfirmationDialog;
 exports.useCurrentUser = useCurrentUser;
+exports.useCurrentUserFavoriteAdvancedSensors = useCurrentUserFavoriteAdvancedSensors;
+exports.useCurrentUserFavoriteInsights = useCurrentUserFavoriteInsights;
 exports.useCurrentUserLanguage = useCurrentUserLanguage;
 exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
 exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;

package/index.esm.js

@@ -819,7 +819,6 @@ const useCurrentUser = () => {
 /**
  * This is a hook providing the Current User language.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
  * const { language, setLanguage } = useCurrentUserLanguage();
@@ -847,7 +846,6 @@ const useCurrentUserLanguage = () => {
 /**
  * This is a hook providing the Current User TimeZone Preference.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
  * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
@@ -871,7 +869,6 @@ const useCurrentUserTimeZonePreference = () => {
 /**
  * This is a hook providing the Current User language.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
  * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
@@ -892,6 +889,52 @@ const useCurrentUserSystemOfMeasurement = () => {
         };
     }, [context.systemOfMeasurement, context.setSystemOfMeasurement]);
 };
+/**
+ * This is a hook providing the Current User Favorite Insights.
+ *
+ * @example
+ * import { useCurrentUserFavoriteInsights } from "@trackunit/react-core-hooks";
+ * const { favoriteInsights, setFavoriteInsights } = useCurrentUserFavoriteInsights();
+ *
+ * favoriteInsights: Gets the favorite insights of the current user.
+ * setFavoriteInsights: Sets the favorite insights of the current user.
+ * @see { CurrentUserPreferenceState}
+ */
+const useCurrentUserFavoriteInsights = () => {
+    const context = useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserFavoriteInsights must be used within the CurrentUserPreferenceProvider");
+    }
+    return useMemo(() => {
+        return {
+            favoriteInsights: context.favoriteInsights || null,
+            setFavoriteInsights: context.setFavoriteInsights,
+        };
+    }, [context.favoriteInsights, context.setFavoriteInsights]);
+};
+/**
+ * This is a hook providing the Current User Favorite Advanced Sensors.
+ *
+ * @example
+ * import { useCurrentUserFavoriteAdvancedSensors } from "@trackunit/react-core-hooks";
+ * const { favoriteAdvancedSensors, setFavoriteAdvancedSensors } = useCurrentUserFavoriteAdvancedSensors();
+ *
+ * favoriteAdvancedSensors: Gets the favorite advanced sensors of the current user.
+ * setFavoriteAdvancedSensors: Sets the favorite advanced sensors of the current user.
+ * @see { CurrentUserPreferenceState}
+ */
+const useCurrentUserFavoriteAdvancedSensors = () => {
+    const context = useContext(CurrentUserPreferenceContext);
+    if (!context) {
+        throw new Error("useCurrentUserFavoriteAdvancedSensors must be used within the CurrentUserPreferenceProvider");
+    }
+    return useMemo(() => {
+        return {
+            favoriteAdvancedSensors: context.favoriteAdvancedSensors || null,
+            setFavoriteAdvancedSensors: context.setFavoriteAdvancedSensors,
+        };
+    }, [context.favoriteAdvancedSensors, context.setFavoriteAdvancedSensors]);
+};
 const setGlobalLanguage = (language) => {
     if (typeof global !== "undefined") {
         Object.defineProperty(global, "language", {
@@ -1013,4 +1056,4 @@ const useWidgetConfig = () => {
     return result;
 };
 
-export { fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserPermission, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };
+export { fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserFavoriteAdvancedSensors, useCurrentUserFavoriteInsights, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useErrorHandlerOrNull, useEventRuntime, useExportDataContext, useFeatureBranchQueryString, useFeatureFlags, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTimeRange, useToast, useToken, useUserPermission, useUserSubscription, useWidgetConfig, useWidgetConfigAsync };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@trackunit/react-core-hooks",
-  "version": "1.12.64",
+  "version": "1.12.65",
   "repository": "https://github.com/Trackunit/manager",
   "license": "SEE LICENSE IN LICENSE.txt",
   "engines": {
@@ -11,7 +11,7 @@
     "es-toolkit": "^1.39.10",
     "@trackunit/iris-app-runtime-core": "1.13.59",
     "@trackunit/iris-app-runtime-core-api": "1.12.56",
-    "@trackunit/react-core-contexts-api": "1.13.56"
+    "@trackunit/react-core-contexts-api": "1.13.57"
   },
   "module": "./index.esm.js",
   "main": "./index.cjs.js",

package/src/user/useCurrentUserPreference.d.ts

@@ -1,7 +1,6 @@
 /**
  * This is a hook providing the Current User language.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
  * const { language, setLanguage } = useCurrentUserLanguage();
@@ -17,7 +16,6 @@ export declare const useCurrentUserLanguage: () => {
 /**
  * This is a hook providing the Current User TimeZone Preference.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
  * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
@@ -33,7 +31,6 @@ export declare const useCurrentUserTimeZonePreference: () => {
 /**
  * This is a hook providing the Current User language.
  *
- * @requires CurrentUserPreferenceProvider
  * @example
  * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
  * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
@@ -46,3 +43,33 @@ export declare const useCurrentUserSystemOfMeasurement: () => {
     systemOfMeasurement: import("@trackunit/iris-app-runtime-core-api").SystemOfMeasurementType | null;
     setSystemOfMeasurement: ((systemOfMeasurement: import("@trackunit/iris-app-runtime-core-api").SystemOfMeasurementType) => void) | undefined;
 };
+/**
+ * This is a hook providing the Current User Favorite Insights.
+ *
+ * @example
+ * import { useCurrentUserFavoriteInsights } from "@trackunit/react-core-hooks";
+ * const { favoriteInsights, setFavoriteInsights } = useCurrentUserFavoriteInsights();
+ *
+ * favoriteInsights: Gets the favorite insights of the current user.
+ * setFavoriteInsights: Sets the favorite insights of the current user.
+ * @see { CurrentUserPreferenceState}
+ */
+export declare const useCurrentUserFavoriteInsights: () => {
+    favoriteInsights: string[] | null;
+    setFavoriteInsights: ((favoriteInsights: Array<string>) => void) | undefined;
+};
+/**
+ * This is a hook providing the Current User Favorite Advanced Sensors.
+ *
+ * @example
+ * import { useCurrentUserFavoriteAdvancedSensors } from "@trackunit/react-core-hooks";
+ * const { favoriteAdvancedSensors, setFavoriteAdvancedSensors } = useCurrentUserFavoriteAdvancedSensors();
+ *
+ * favoriteAdvancedSensors: Gets the favorite advanced sensors of the current user.
+ * setFavoriteAdvancedSensors: Sets the favorite advanced sensors of the current user.
+ * @see { CurrentUserPreferenceState}
+ */
+export declare const useCurrentUserFavoriteAdvancedSensors: () => {
+    favoriteAdvancedSensors: string[] | null;
+    setFavoriteAdvancedSensors: ((favoriteAdvancedSensors: Array<string>) => void) | undefined;
+};