@trackunit/react-core-hooks 1.12.62-alpha-c2a1dc6c53b.0 → 1.12.62

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/index.cjs.js CHANGED
@@ -821,6 +821,7 @@ const useCurrentUser = () => {
821
821
  /**
822
822
  * This is a hook providing the Current User language.
823
823
  *
824
+ * @requires CurrentUserPreferenceProvider
824
825
  * @example
825
826
  * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
826
827
  * const { language, setLanguage } = useCurrentUserLanguage();
@@ -848,6 +849,7 @@ const useCurrentUserLanguage = () => {
848
849
  /**
849
850
  * This is a hook providing the Current User TimeZone Preference.
850
851
  *
852
+ * @requires CurrentUserPreferenceProvider
851
853
  * @example
852
854
  * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
853
855
  * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
@@ -871,6 +873,7 @@ const useCurrentUserTimeZonePreference = () => {
871
873
  /**
872
874
  * This is a hook providing the Current User language.
873
875
  *
876
+ * @requires CurrentUserPreferenceProvider
874
877
  * @example
875
878
  * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
876
879
  * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
@@ -891,52 +894,6 @@ const useCurrentUserSystemOfMeasurement = () => {
891
894
  };
892
895
  }, [context.systemOfMeasurement, context.setSystemOfMeasurement]);
893
896
  };
894
- /**
895
- * This is a hook providing the Current User Favorite Insights.
896
- *
897
- * @example
898
- * import { useCurrentUserFavoriteInsights } from "@trackunit/react-core-hooks";
899
- * const { favoriteInsights, setFavoriteInsights } = useCurrentUserFavoriteInsights();
900
- *
901
- * favoriteInsights: Gets the favorite insights of the current user.
902
- * setFavoriteInsights: Sets the favorite insights of the current user.
903
- * @see { CurrentUserPreferenceState}
904
- */
905
- const useCurrentUserFavoriteInsights = () => {
906
- const context = react.useContext(reactCoreContextsApi.CurrentUserPreferenceContext);
907
- if (!context) {
908
- throw new Error("useCurrentUserFavoriteInsights must be used within the CurrentUserPreferenceProvider");
909
- }
910
- return react.useMemo(() => {
911
- return {
912
- favoriteInsights: context.favoriteInsights || null,
913
- setFavoriteInsights: context.setFavoriteInsights,
914
- };
915
- }, [context.favoriteInsights, context.setFavoriteInsights]);
916
- };
917
- /**
918
- * This is a hook providing the Current User Favorite Advanced Sensors.
919
- *
920
- * @example
921
- * import { useCurrentUserFavoriteAdvancedSensors } from "@trackunit/react-core-hooks";
922
- * const { favoriteAdvancedSensors, setFavoriteAdvancedSensors } = useCurrentUserFavoriteAdvancedSensors();
923
- *
924
- * favoriteAdvancedSensors: Gets the favorite advanced sensors of the current user.
925
- * setFavoriteAdvancedSensors: Sets the favorite advanced sensors of the current user.
926
- * @see { CurrentUserPreferenceState}
927
- */
928
- const useCurrentUserFavoriteAdvancedSensors = () => {
929
- const context = react.useContext(reactCoreContextsApi.CurrentUserPreferenceContext);
930
- if (!context) {
931
- throw new Error("useCurrentUserFavoriteAdvancedSensors must be used within the CurrentUserPreferenceProvider");
932
- }
933
- return react.useMemo(() => {
934
- return {
935
- favoriteAdvancedSensors: context.favoriteAdvancedSensors || null,
936
- setFavoriteAdvancedSensors: context.setFavoriteAdvancedSensors,
937
- };
938
- }, [context.favoriteAdvancedSensors, context.setFavoriteAdvancedSensors]);
939
- };
940
897
  const setGlobalLanguage = (language) => {
941
898
  if (typeof global !== "undefined") {
942
899
  Object.defineProperty(global, "language", {
@@ -1064,8 +1021,6 @@ exports.useAssetRuntime = useAssetRuntime;
1064
1021
  exports.useAssetSorting = useAssetSorting;
1065
1022
  exports.useConfirmationDialog = useConfirmationDialog;
1066
1023
  exports.useCurrentUser = useCurrentUser;
1067
- exports.useCurrentUserFavoriteAdvancedSensors = useCurrentUserFavoriteAdvancedSensors;
1068
- exports.useCurrentUserFavoriteInsights = useCurrentUserFavoriteInsights;
1069
1024
  exports.useCurrentUserLanguage = useCurrentUserLanguage;
1070
1025
  exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
1071
1026
  exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
package/index.esm.js CHANGED
@@ -819,6 +819,7 @@ const useCurrentUser = () => {
819
819
  /**
820
820
  * This is a hook providing the Current User language.
821
821
  *
822
+ * @requires CurrentUserPreferenceProvider
822
823
  * @example
823
824
  * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
824
825
  * const { language, setLanguage } = useCurrentUserLanguage();
@@ -846,6 +847,7 @@ const useCurrentUserLanguage = () => {
846
847
  /**
847
848
  * This is a hook providing the Current User TimeZone Preference.
848
849
  *
850
+ * @requires CurrentUserPreferenceProvider
849
851
  * @example
850
852
  * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
851
853
  * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
@@ -869,6 +871,7 @@ const useCurrentUserTimeZonePreference = () => {
869
871
  /**
870
872
  * This is a hook providing the Current User language.
871
873
  *
874
+ * @requires CurrentUserPreferenceProvider
872
875
  * @example
873
876
  * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
874
877
  * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
@@ -889,52 +892,6 @@ const useCurrentUserSystemOfMeasurement = () => {
889
892
  };
890
893
  }, [context.systemOfMeasurement, context.setSystemOfMeasurement]);
891
894
  };
892
- /**
893
- * This is a hook providing the Current User Favorite Insights.
894
- *
895
- * @example
896
- * import { useCurrentUserFavoriteInsights } from "@trackunit/react-core-hooks";
897
- * const { favoriteInsights, setFavoriteInsights } = useCurrentUserFavoriteInsights();
898
- *
899
- * favoriteInsights: Gets the favorite insights of the current user.
900
- * setFavoriteInsights: Sets the favorite insights of the current user.
901
- * @see { CurrentUserPreferenceState}
902
- */
903
- const useCurrentUserFavoriteInsights = () => {
904
- const context = useContext(CurrentUserPreferenceContext);
905
- if (!context) {
906
- throw new Error("useCurrentUserFavoriteInsights must be used within the CurrentUserPreferenceProvider");
907
- }
908
- return useMemo(() => {
909
- return {
910
- favoriteInsights: context.favoriteInsights || null,
911
- setFavoriteInsights: context.setFavoriteInsights,
912
- };
913
- }, [context.favoriteInsights, context.setFavoriteInsights]);
914
- };
915
- /**
916
- * This is a hook providing the Current User Favorite Advanced Sensors.
917
- *
918
- * @example
919
- * import { useCurrentUserFavoriteAdvancedSensors } from "@trackunit/react-core-hooks";
920
- * const { favoriteAdvancedSensors, setFavoriteAdvancedSensors } = useCurrentUserFavoriteAdvancedSensors();
921
- *
922
- * favoriteAdvancedSensors: Gets the favorite advanced sensors of the current user.
923
- * setFavoriteAdvancedSensors: Sets the favorite advanced sensors of the current user.
924
- * @see { CurrentUserPreferenceState}
925
- */
926
- const useCurrentUserFavoriteAdvancedSensors = () => {
927
- const context = useContext(CurrentUserPreferenceContext);
928
- if (!context) {
929
- throw new Error("useCurrentUserFavoriteAdvancedSensors must be used within the CurrentUserPreferenceProvider");
930
- }
931
- return useMemo(() => {
932
- return {
933
- favoriteAdvancedSensors: context.favoriteAdvancedSensors || null,
934
- setFavoriteAdvancedSensors: context.setFavoriteAdvancedSensors,
935
- };
936
- }, [context.favoriteAdvancedSensors, context.setFavoriteAdvancedSensors]);
937
- };
938
895
  const setGlobalLanguage = (language) => {
939
896
  if (typeof global !== "undefined") {
940
897
  Object.defineProperty(global, "language", {
@@ -1056,4 +1013,4 @@ const useWidgetConfig = () => {
1056
1013
  return result;
1057
1014
  };
1058
1015
 
1059
- 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 };
1016
+ 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 };
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-core-hooks",
3
- "version": "1.12.62-alpha-c2a1dc6c53b.0",
3
+ "version": "1.12.62",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "engines": {
@@ -9,9 +9,9 @@
9
9
  "dependencies": {
10
10
  "react": "19.0.0",
11
11
  "es-toolkit": "^1.39.10",
12
- "@trackunit/iris-app-runtime-core": "1.13.57-alpha-c2a1dc6c53b.0",
13
- "@trackunit/iris-app-runtime-core-api": "1.12.54-alpha-c2a1dc6c53b.0",
14
- "@trackunit/react-core-contexts-api": "1.13.54-alpha-c2a1dc6c53b.0"
12
+ "@trackunit/iris-app-runtime-core": "1.13.57",
13
+ "@trackunit/iris-app-runtime-core-api": "1.12.54",
14
+ "@trackunit/react-core-contexts-api": "1.13.54"
15
15
  },
16
16
  "module": "./index.esm.js",
17
17
  "main": "./index.cjs.js",
@@ -1,6 +1,7 @@
1
1
  /**
2
2
  * This is a hook providing the Current User language.
3
3
  *
4
+ * @requires CurrentUserPreferenceProvider
4
5
  * @example
5
6
  * import { useCurrentUserLanguage } from "@trackunit/react-core-hooks";
6
7
  * const { language, setLanguage } = useCurrentUserLanguage();
@@ -16,6 +17,7 @@ export declare const useCurrentUserLanguage: () => {
16
17
  /**
17
18
  * This is a hook providing the Current User TimeZone Preference.
18
19
  *
20
+ * @requires CurrentUserPreferenceProvider
19
21
  * @example
20
22
  * import { useCurrentUserTimeZonePreference } from "@trackunit/react-core-hooks";
21
23
  * const { timeZonePreference, setTimeZonePreference } = useCurrentUserTimeZonePreference();
@@ -31,6 +33,7 @@ export declare const useCurrentUserTimeZonePreference: () => {
31
33
  /**
32
34
  * This is a hook providing the Current User language.
33
35
  *
36
+ * @requires CurrentUserPreferenceProvider
34
37
  * @example
35
38
  * import { useCurrentUserSystemOfMeasurement } from "@trackunit/react-core-hooks";
36
39
  * const { systemOfMeasurement, setSystemOfMeasurement } = useCurrentUserSystemOfMeasurement();
@@ -43,33 +46,3 @@ export declare const useCurrentUserSystemOfMeasurement: () => {
43
46
  systemOfMeasurement: import("@trackunit/iris-app-runtime-core-api").SystemOfMeasurementType | null;
44
47
  setSystemOfMeasurement: ((systemOfMeasurement: import("@trackunit/iris-app-runtime-core-api").SystemOfMeasurementType) => void) | undefined;
45
48
  };
46
- /**
47
- * This is a hook providing the Current User Favorite Insights.
48
- *
49
- * @example
50
- * import { useCurrentUserFavoriteInsights } from "@trackunit/react-core-hooks";
51
- * const { favoriteInsights, setFavoriteInsights } = useCurrentUserFavoriteInsights();
52
- *
53
- * favoriteInsights: Gets the favorite insights of the current user.
54
- * setFavoriteInsights: Sets the favorite insights of the current user.
55
- * @see { CurrentUserPreferenceState}
56
- */
57
- export declare const useCurrentUserFavoriteInsights: () => {
58
- favoriteInsights: string[] | null;
59
- setFavoriteInsights: ((favoriteInsights: Array<string>) => void) | undefined;
60
- };
61
- /**
62
- * This is a hook providing the Current User Favorite Advanced Sensors.
63
- *
64
- * @example
65
- * import { useCurrentUserFavoriteAdvancedSensors } from "@trackunit/react-core-hooks";
66
- * const { favoriteAdvancedSensors, setFavoriteAdvancedSensors } = useCurrentUserFavoriteAdvancedSensors();
67
- *
68
- * favoriteAdvancedSensors: Gets the favorite advanced sensors of the current user.
69
- * setFavoriteAdvancedSensors: Sets the favorite advanced sensors of the current user.
70
- * @see { CurrentUserPreferenceState}
71
- */
72
- export declare const useCurrentUserFavoriteAdvancedSensors: () => {
73
- favoriteAdvancedSensors: string[] | null;
74
- setFavoriteAdvancedSensors: ((favoriteAdvancedSensors: Array<string>) => void) | undefined;
75
- };