@trackunit/react-core-hooks 1.6.6 → 1.6.11

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
@@ -22,7 +22,7 @@ const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
22
22
  *
23
23
  * // log event when appropriate
24
24
  * logEvent("Login", { loginPage: "New Manager" });
25
- * @see {@link IAnalyticsContext}
25
+ * @see { IAnalyticsContext}
26
26
  */
27
27
  const useAnalytics = (events) => {
28
28
  const context = react.useContext(AnalyticsContext);
@@ -87,7 +87,7 @@ const AssetSortingProvider = AssetSortingContext.Provider;
87
87
  * headerInitialSort={initialSort}
88
88
  * />
89
89
  * );
90
- * @see {@link AssetSortingContextValue}
90
+ * @see { AssetSortingContextValue}
91
91
  */
92
92
  const useAssetSorting = () => {
93
93
  const context = react.useContext(AssetSortingContext);
@@ -151,7 +151,7 @@ const ErrorHandlingContextProvider = ErrorHandlingContext.Provider; // easy impo
151
151
  * catch(ex) {
152
152
  * logError(ex);
153
153
  * }
154
- * @see {@link ErrorHandlingContext}
154
+ * @see { ErrorHandlingContext}
155
155
  */
156
156
  const useErrorHandler = () => {
157
157
  const context = react.useContext(ErrorHandlingContext);
@@ -207,7 +207,7 @@ const FilterBarContext = react.createContext(null);
207
207
  *
208
208
  * ...
209
209
  * };
210
- * @see {@link FilterBarContext}
210
+ * @see { FilterBarContext}
211
211
  */
212
212
  const useFilterBarContext = () => {
213
213
  const context = react.useContext(FilterBarContext);
@@ -229,7 +229,7 @@ const TokenContext = react.createContext(null);
229
229
  * @example
230
230
  * import { useToken } from "@trackunit/react-core-hooks";
231
231
  * const { token } = useToken();
232
- * @see {@link ITokenContext}
232
+ * @see {ITokenContext}
233
233
  */
234
234
  const useToken = () => {
235
235
  const context = react.useContext(TokenContext);
@@ -376,7 +376,7 @@ const OEMBrandingService = react.createContext(null);
376
376
  * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
377
377
  * // use oem branding
378
378
  * const branding = getOemBranding("some brand")
379
- * @see {@link OemBrandingContext}
379
+ * @see { OemBrandingContext}
380
380
  */
381
381
  const useOemBrandingContext = () => {
382
382
  const context = react.useContext(OEMBrandingService);
@@ -869,7 +869,7 @@ const UserSubscriptionProvider = (props) => {
869
869
  * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
870
870
  * // use it for something
871
871
  * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
872
- * @see {@link IUserSubscriptionContext}
872
+ * @see { IUserSubscriptionContext}
873
873
  */
874
874
  const useUserSubscription = () => {
875
875
  const context = react.useContext(UserSubscriptionContext);
@@ -892,7 +892,7 @@ const TimeRangeContext = react.createContext(null);
892
892
  *
893
893
  * ...
894
894
  * };
895
- * @see {@link TimeRangeContext}
895
+ * @see { TimeRangeContext}
896
896
  */
897
897
  const useTimeRange = () => {
898
898
  const context = react.useContext(TimeRangeContext);
@@ -926,7 +926,7 @@ const ToastProvider = (props) => jsxRuntime.jsx(ToastContext.Provider, { ...prop
926
926
  * description: error?.message,
927
927
  * duration: 3000,
928
928
  * });
929
- * @see {@link IToastContext}
929
+ * @see { IToastContext}
930
930
  */
931
931
  const useToast = () => {
932
932
  const toastContext = react.useContext(ToastContext);
@@ -953,7 +953,7 @@ const CurrentUserPreferenceProvider = (props) => {
953
953
  *
954
954
  * language: Gets the language setting of the current user.
955
955
  * setLanguage: Sets the language setting of the current user.
956
- * @see {@link IUserPreferencesContext}
956
+ * @see { IUserPreferencesContext}
957
957
  */
958
958
  const useCurrentUserLanguage = () => {
959
959
  const context = react.useContext(CurrentUserPreferenceContext);
@@ -981,7 +981,7 @@ const useCurrentUserLanguage = () => {
981
981
  *
982
982
  * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
983
983
  * setTimeZonePreference: Sets the timezone preference of the current user.
984
- * @see {@link IUserPreferencesContext}
984
+ * @see { IUserPreferencesContext}
985
985
  */
986
986
  const useCurrentUserTimeZonePreference = () => {
987
987
  const context = react.useContext(CurrentUserPreferenceContext);
@@ -1005,7 +1005,7 @@ const useCurrentUserTimeZonePreference = () => {
1005
1005
  *
1006
1006
  * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
1007
1007
  * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
1008
- * @see {@link IUserPreferencesContext}
1008
+ * @see { IUserPreferencesContext}
1009
1009
  */
1010
1010
  const useCurrentUserSystemOfMeasurement = () => {
1011
1011
  const context = react.useContext(CurrentUserPreferenceContext);
@@ -1048,7 +1048,7 @@ const CurrentUserProvider = (props) => {
1048
1048
  * const { data, loading } = useGetAccountByIdQuery({
1049
1049
  * variables: { accountId: assumedUser?.accountId || accountId || "" },
1050
1050
  * });
1051
- * @see {@link CurrentUserContext}
1051
+ * @see { CurrentUserContext}
1052
1052
  */
1053
1053
  const useCurrentUser = () => {
1054
1054
  const context = react.useContext(CurrentUserContext);
@@ -1092,7 +1092,7 @@ const WidgetConfigContext = react.createContext(null);
1092
1092
  *
1093
1093
  * ...
1094
1094
  * };
1095
- * @see {@link WidgetConfigContext}
1095
+ * @see { WidgetConfigContext}
1096
1096
  */
1097
1097
  const useWidgetConfigAsync = () => {
1098
1098
  const context = react.useContext(WidgetConfigContext);
@@ -1116,7 +1116,7 @@ const WidgetConfigProvider = (props) => jsxRuntime.jsx(WidgetConfigContext.Provi
1116
1116
  *
1117
1117
  * ...
1118
1118
  * };
1119
- * @see {@link WidgetConfigContext}
1119
+ * @see { WidgetConfigContext}
1120
1120
  */
1121
1121
  const useWidgetConfig = () => {
1122
1122
  const [data, setData] = react.useState(null);
package/index.esm.js CHANGED
@@ -20,7 +20,7 @@ const AnalyticsContextProvider = AnalyticsContext.Provider; // easy import
20
20
  *
21
21
  * // log event when appropriate
22
22
  * logEvent("Login", { loginPage: "New Manager" });
23
- * @see {@link IAnalyticsContext}
23
+ * @see { IAnalyticsContext}
24
24
  */
25
25
  const useAnalytics = (events) => {
26
26
  const context = useContext(AnalyticsContext);
@@ -85,7 +85,7 @@ const AssetSortingProvider = AssetSortingContext.Provider;
85
85
  * headerInitialSort={initialSort}
86
86
  * />
87
87
  * );
88
- * @see {@link AssetSortingContextValue}
88
+ * @see { AssetSortingContextValue}
89
89
  */
90
90
  const useAssetSorting = () => {
91
91
  const context = useContext(AssetSortingContext);
@@ -149,7 +149,7 @@ const ErrorHandlingContextProvider = ErrorHandlingContext.Provider; // easy impo
149
149
  * catch(ex) {
150
150
  * logError(ex);
151
151
  * }
152
- * @see {@link ErrorHandlingContext}
152
+ * @see { ErrorHandlingContext}
153
153
  */
154
154
  const useErrorHandler = () => {
155
155
  const context = useContext(ErrorHandlingContext);
@@ -205,7 +205,7 @@ const FilterBarContext = createContext(null);
205
205
  *
206
206
  * ...
207
207
  * };
208
- * @see {@link FilterBarContext}
208
+ * @see { FilterBarContext}
209
209
  */
210
210
  const useFilterBarContext = () => {
211
211
  const context = useContext(FilterBarContext);
@@ -227,7 +227,7 @@ const TokenContext = createContext(null);
227
227
  * @example
228
228
  * import { useToken } from "@trackunit/react-core-hooks";
229
229
  * const { token } = useToken();
230
- * @see {@link ITokenContext}
230
+ * @see {ITokenContext}
231
231
  */
232
232
  const useToken = () => {
233
233
  const context = useContext(TokenContext);
@@ -374,7 +374,7 @@ const OEMBrandingService = createContext(null);
374
374
  * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
375
375
  * // use oem branding
376
376
  * const branding = getOemBranding("some brand")
377
- * @see {@link OemBrandingContext}
377
+ * @see { OemBrandingContext}
378
378
  */
379
379
  const useOemBrandingContext = () => {
380
380
  const context = useContext(OEMBrandingService);
@@ -867,7 +867,7 @@ const UserSubscriptionProvider = (props) => {
867
867
  * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
868
868
  * // use it for something
869
869
  * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
870
- * @see {@link IUserSubscriptionContext}
870
+ * @see { IUserSubscriptionContext}
871
871
  */
872
872
  const useUserSubscription = () => {
873
873
  const context = useContext(UserSubscriptionContext);
@@ -890,7 +890,7 @@ const TimeRangeContext = createContext(null);
890
890
  *
891
891
  * ...
892
892
  * };
893
- * @see {@link TimeRangeContext}
893
+ * @see { TimeRangeContext}
894
894
  */
895
895
  const useTimeRange = () => {
896
896
  const context = useContext(TimeRangeContext);
@@ -924,7 +924,7 @@ const ToastProvider = (props) => jsx(ToastContext.Provider, { ...props });
924
924
  * description: error?.message,
925
925
  * duration: 3000,
926
926
  * });
927
- * @see {@link IToastContext}
927
+ * @see { IToastContext}
928
928
  */
929
929
  const useToast = () => {
930
930
  const toastContext = useContext(ToastContext);
@@ -951,7 +951,7 @@ const CurrentUserPreferenceProvider = (props) => {
951
951
  *
952
952
  * language: Gets the language setting of the current user.
953
953
  * setLanguage: Sets the language setting of the current user.
954
- * @see {@link IUserPreferencesContext}
954
+ * @see { IUserPreferencesContext}
955
955
  */
956
956
  const useCurrentUserLanguage = () => {
957
957
  const context = useContext(CurrentUserPreferenceContext);
@@ -979,7 +979,7 @@ const useCurrentUserLanguage = () => {
979
979
  *
980
980
  * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
981
981
  * setTimeZonePreference: Sets the timezone preference of the current user.
982
- * @see {@link IUserPreferencesContext}
982
+ * @see { IUserPreferencesContext}
983
983
  */
984
984
  const useCurrentUserTimeZonePreference = () => {
985
985
  const context = useContext(CurrentUserPreferenceContext);
@@ -1003,7 +1003,7 @@ const useCurrentUserTimeZonePreference = () => {
1003
1003
  *
1004
1004
  * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
1005
1005
  * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
1006
- * @see {@link IUserPreferencesContext}
1006
+ * @see { IUserPreferencesContext}
1007
1007
  */
1008
1008
  const useCurrentUserSystemOfMeasurement = () => {
1009
1009
  const context = useContext(CurrentUserPreferenceContext);
@@ -1046,7 +1046,7 @@ const CurrentUserProvider = (props) => {
1046
1046
  * const { data, loading } = useGetAccountByIdQuery({
1047
1047
  * variables: { accountId: assumedUser?.accountId || accountId || "" },
1048
1048
  * });
1049
- * @see {@link CurrentUserContext}
1049
+ * @see { CurrentUserContext}
1050
1050
  */
1051
1051
  const useCurrentUser = () => {
1052
1052
  const context = useContext(CurrentUserContext);
@@ -1090,7 +1090,7 @@ const WidgetConfigContext = createContext(null);
1090
1090
  *
1091
1091
  * ...
1092
1092
  * };
1093
- * @see {@link WidgetConfigContext}
1093
+ * @see { WidgetConfigContext}
1094
1094
  */
1095
1095
  const useWidgetConfigAsync = () => {
1096
1096
  const context = useContext(WidgetConfigContext);
@@ -1114,7 +1114,7 @@ const WidgetConfigProvider = (props) => jsx(WidgetConfigContext.Provider, { ...p
1114
1114
  *
1115
1115
  * ...
1116
1116
  * };
1117
- * @see {@link WidgetConfigContext}
1117
+ * @see { WidgetConfigContext}
1118
1118
  */
1119
1119
  const useWidgetConfig = () => {
1120
1120
  const [data, setData] = useState(null);
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@trackunit/react-core-hooks",
3
- "version": "1.6.6",
3
+ "version": "1.6.11",
4
4
  "repository": "https://github.com/Trackunit/manager",
5
5
  "license": "SEE LICENSE IN LICENSE.txt",
6
6
  "engines": {
@@ -10,11 +10,11 @@
10
10
  "react": "19.0.0",
11
11
  "jest-fetch-mock": "^3.0.3",
12
12
  "zod": "^3.23.8",
13
- "@trackunit/react-core-contexts-api": "1.7.6",
14
- "@trackunit/iris-app-runtime-core": "1.7.6",
15
- "@trackunit/shared-utils": "1.8.6",
13
+ "@trackunit/react-core-contexts-api": "1.7.11",
14
+ "@trackunit/iris-app-runtime-core": "1.7.11",
15
+ "@trackunit/shared-utils": "1.8.11",
16
16
  "@tanstack/react-router": "1.114.29",
17
- "@trackunit/react-test-setup": "1.3.6"
17
+ "@trackunit/react-test-setup": "1.3.11"
18
18
  },
19
19
  "module": "./index.esm.js",
20
20
  "main": "./index.cjs.js",
@@ -15,6 +15,6 @@ export declare const AnalyticsContextProvider: import("react").Provider<IAnalyti
15
15
  *
16
16
  * // log event when appropriate
17
17
  * logEvent("Login", { loginPage: "New Manager" });
18
- * @see {@link IAnalyticsContext}
18
+ * @see { IAnalyticsContext}
19
19
  */
20
20
  export declare const useAnalytics: <TEvents extends EventDictionary = never>(events: TEvents) => IAnalyticsContext<TEvents>;
@@ -29,6 +29,6 @@ export declare const AssetSortingProvider: import("react").Provider<AssetSorting
29
29
  * headerInitialSort={initialSort}
30
30
  * />
31
31
  * );
32
- * @see {@link AssetSortingContextValue}
32
+ * @see { AssetSortingContextValue}
33
33
  */
34
34
  export declare const useAssetSorting: () => AssetSortingContextValue;
@@ -12,7 +12,7 @@ export declare const ErrorHandlingContextProvider: import("react").Provider<Erro
12
12
  * catch(ex) {
13
13
  * logError(ex);
14
14
  * }
15
- * @see {@link ErrorHandlingContext}
15
+ * @see { ErrorHandlingContext}
16
16
  */
17
17
  export declare const useErrorHandler: () => ErrorHandlingContextValue;
18
18
  /**
@@ -12,7 +12,7 @@ import { ReactNode } from "react";
12
12
  *
13
13
  * ...
14
14
  * };
15
- * @see {@link FilterBarContext}
15
+ * @see { FilterBarContext}
16
16
  */
17
17
  export declare const useFilterBarContext: () => FilterBarContextType;
18
18
  interface FilterBarContextProps {
@@ -8,7 +8,7 @@ import { OemBrandingContext } from "@trackunit/react-core-contexts-api";
8
8
  * const { getOemBranding, getImageByBrand } = useOemBrandingContext();
9
9
  * // use oem branding
10
10
  * const branding = getOemBranding("some brand")
11
- * @see {@link OemBrandingContext}
11
+ * @see { OemBrandingContext}
12
12
  */
13
13
  export declare const useOemBrandingContext: () => OemBrandingContext;
14
14
  interface OemBrandingContextProviderProps {
@@ -17,7 +17,7 @@ export declare const UserSubscriptionProvider: (props: UserSubscriptionProviderP
17
17
  * const { numberOfDaysWithAccessToHistoricalData, packageType } = useUserSubscription();
18
18
  * // use it for something
19
19
  * const data = fetchData(numberOfDaysWithAccessToHistoricalData)
20
- * @see {@link IUserSubscriptionContext}
20
+ * @see { IUserSubscriptionContext}
21
21
  */
22
22
  export declare const useUserSubscription: () => IUserSubscriptionContext;
23
23
  export {};
@@ -12,7 +12,7 @@ import { ReactNode } from "react";
12
12
  *
13
13
  * ...
14
14
  * };
15
- * @see {@link TimeRangeContext}
15
+ * @see { TimeRangeContext}
16
16
  */
17
17
  export declare const useTimeRange: () => TimeRangeContextType;
18
18
  interface TimeRangeContextProps {
@@ -23,6 +23,6 @@ export declare const ToastProvider: (props: ToastContextProviderProps) => import
23
23
  * description: error?.message,
24
24
  * duration: 3000,
25
25
  * });
26
- * @see {@link IToastContext}
26
+ * @see { IToastContext}
27
27
  */
28
28
  export declare const useToast: () => IToastContext;
@@ -7,7 +7,7 @@ import { ReactNode } from "react";
7
7
  * @example
8
8
  * import { useToken } from "@trackunit/react-core-hooks";
9
9
  * const { token } = useToken();
10
- * @see {@link ITokenContext}
10
+ * @see {ITokenContext}
11
11
  */
12
12
  export declare const useToken: () => ITokenContext;
13
13
  interface TokenProviderProps {
@@ -18,7 +18,7 @@ export declare const CurrentUserPreferenceProvider: (props: Props) => import("re
18
18
  *
19
19
  * language: Gets the language setting of the current user.
20
20
  * setLanguage: Sets the language setting of the current user.
21
- * @see {@link IUserPreferencesContext}
21
+ * @see { IUserPreferencesContext}
22
22
  */
23
23
  export declare const useCurrentUserLanguage: () => {
24
24
  language: string | undefined;
@@ -34,7 +34,7 @@ export declare const useCurrentUserLanguage: () => {
34
34
  *
35
35
  * timeZonePreference: Determines if the user has a timezone preference of "CUSTOM_TIME_ZONE" | "LOCAL_TIME_ZONE" | "MACHINE_TIME_ZONE"
36
36
  * setTimeZonePreference: Sets the timezone preference of the current user.
37
- * @see {@link IUserPreferencesContext}
37
+ * @see { IUserPreferencesContext}
38
38
  */
39
39
  export declare const useCurrentUserTimeZonePreference: () => {
40
40
  timeZonePreference: import("@trackunit/react-core-contexts-api").TimeZonePreferenceType | undefined;
@@ -50,7 +50,7 @@ export declare const useCurrentUserTimeZonePreference: () => {
50
50
  *
51
51
  * systemOfMeasurement: Gets the system of measurement setting of the current user. "SI" | "US_CUSTOMARY"
52
52
  * setSystemOfMeasurement: Sets the system of measurement setting of the current user.
53
- * @see {@link IUserPreferencesContext}
53
+ * @see { IUserPreferencesContext}
54
54
  */
55
55
  export declare const useCurrentUserSystemOfMeasurement: () => {
56
56
  systemOfMeasurement: import("@trackunit/react-core-contexts-api").SystemOfMeasurementType | null;
@@ -20,7 +20,7 @@ export declare const CurrentUserProvider: (props: Props) => import("react/jsx-ru
20
20
  * const { data, loading } = useGetAccountByIdQuery({
21
21
  * variables: { accountId: assumedUser?.accountId || accountId || "" },
22
22
  * });
23
- * @see {@link CurrentUserContext}
23
+ * @see { CurrentUserContext}
24
24
  */
25
25
  export declare const useCurrentUser: () => CurrentUserContextInterface;
26
26
  export {};
@@ -13,7 +13,7 @@ import { ReactNode } from "react";
13
13
  *
14
14
  * ...
15
15
  * };
16
- * @see {@link WidgetConfigContext}
16
+ * @see { WidgetConfigContext}
17
17
  */
18
18
  export declare const useWidgetConfigAsync: () => WidgetConfigContextType;
19
19
  interface WidgetConfigContextProps {
@@ -35,7 +35,7 @@ export declare const WidgetConfigProvider: (props: WidgetConfigContextProps) =>
35
35
  *
36
36
  * ...
37
37
  * };
38
- * @see {@link WidgetConfigContext}
38
+ * @see { WidgetConfigContext}
39
39
  */
40
40
  export declare const useWidgetConfig: () => {
41
41
  data: Record<string, unknown> | null;