@trackunit/react-core-hooks 0.2.218 → 0.2.220

package/index.cjs.js

@@ -135,6 +135,29 @@ const useEnvironment = () => {
     return context;
 };
 
+const ErrorHandlingContext = React.createContext(null);
+const ErrorHandlingContextProvider = ErrorHandlingContext.Provider; // easy import
+/**
+ * Hook to get the error handling context.
+ *
+ * @example
+ * import { useErrorHandler } from "@trackunit/react-core-hooks";
+ * const { logError } = useErrorHandler();
+ *
+ * try { ... }
+ * catch(ex) {
+ *   logError(ex);
+ * }
+ * @see {@link ErrorHandlingContext}
+ */
+const useErrorHandler = () => {
+    const context = React.useContext(ErrorHandlingContext);
+    if (!context) {
+        throw new Error("useErrorHandler must be used within an ErrorHandlingContextProvider");
+    }
+    return context;
+};
+
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -872,6 +895,8 @@ exports.ConfirmationDialogProvider = ConfirmationDialogProvider;
 exports.CurrentUserPreferenceProvider = CurrentUserPreferenceProvider;
 exports.CurrentUserProvider = CurrentUserProvider;
 exports.EnvironmentContextProvider = EnvironmentContextProvider;
+exports.ErrorHandlingContext = ErrorHandlingContext;
+exports.ErrorHandlingContextProvider = ErrorHandlingContextProvider;
 exports.FilterBarProvider = FilterBarProvider;
 exports.ModalDialogContextProvider = ModalDialogContextProvider;
 exports.NavigationContextProvider = NavigationContextProvider;
@@ -890,6 +915,7 @@ exports.useCurrentUserSystemOfMeasurement = useCurrentUserSystemOfMeasurement;
 exports.useCurrentUserTimeZonePreference = useCurrentUserTimeZonePreference;
 exports.useCustomerRuntime = useCustomerRuntime;
 exports.useEnvironment = useEnvironment;
+exports.useErrorHandler = useErrorHandler;
 exports.useEventRuntime = useEventRuntime;
 exports.useFeatureBranchQueryString = useFeatureBranchQueryString;
 exports.useFilterBarContext = useFilterBarContext;

package/index.esm.js

@@ -112,6 +112,29 @@ const useEnvironment = () => {
     return context;
 };
 
+const ErrorHandlingContext = createContext(null);
+const ErrorHandlingContextProvider = ErrorHandlingContext.Provider; // easy import
+/**
+ * Hook to get the error handling context.
+ *
+ * @example
+ * import { useErrorHandler } from "@trackunit/react-core-hooks";
+ * const { logError } = useErrorHandler();
+ *
+ * try { ... }
+ * catch(ex) {
+ *   logError(ex);
+ * }
+ * @see {@link ErrorHandlingContext}
+ */
+const useErrorHandler = () => {
+    const context = useContext(ErrorHandlingContext);
+    if (!context) {
+        throw new Error("useErrorHandler must be used within an ErrorHandlingContextProvider");
+    }
+    return context;
+};
+
 /******************************************************************************
 Copyright (c) Microsoft Corporation.
 
@@ -842,4 +865,4 @@ const useCurrentUser = () => {
     return context;
 };
 
-export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };
+export { AnalyticsContext, AnalyticsContextProvider, AssetSortingProvider, ConfirmationDialogProvider, CurrentUserPreferenceProvider, CurrentUserProvider, EnvironmentContextProvider, ErrorHandlingContext, ErrorHandlingContextProvider, FilterBarProvider, ModalDialogContextProvider, NavigationContextProvider, OemBrandingContextProvider, ToastProvider, TokenProvider, UserSubscriptionProvider, fetchAssetBlobUrl, useAnalytics, useAssetRuntime, useAssetSorting, useConfirmationDialog, useCurrentUser, useCurrentUserLanguage, useCurrentUserSystemOfMeasurement, useCurrentUserTimeZonePreference, useCustomerRuntime, useEnvironment, useErrorHandler, useEventRuntime, useFeatureBranchQueryString, useFilterBarContext, useHasAccessTo, useImageUploader, useIrisAppId, useIrisAppImage, useIrisAppName, useModalDialogContext, useNavigateInHost, useOemBrandingContext, useSiteRuntime, useTextSearch, useToast, useToken, useUserSubscription };

package/package.json

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

package/src/errorHandling/ErrorHandlingProvider.d.ts

@@ -0,0 +1,18 @@
+/// <reference types="react" />
+import { ErrorHandlingContextValue } from "@trackunit/react-core-contexts-api";
+export declare const ErrorHandlingContext: import("react").Context<ErrorHandlingContextValue | null>;
+export declare const ErrorHandlingContextProvider: import("react").Provider<ErrorHandlingContextValue | null>;
+/**
+ * Hook to get the error handling context.
+ *
+ * @example
+ * import { useErrorHandler } from "@trackunit/react-core-hooks";
+ * const { logError } = useErrorHandler();
+ *
+ * try { ... }
+ * catch(ex) {
+ *   logError(ex);
+ * }
+ * @see {@link ErrorHandlingContext}
+ */
+export declare const useErrorHandler: () => ErrorHandlingContextValue;

package/src/index.d.ts

@@ -2,6 +2,7 @@ export * from "./analytics/AnalyticsProvider";
 export * from "./assetSorting/AssetSortingProvider";
 export * from "./confirmationDialog/ConfirmationDialogProvider";
 export * from "./environment/EnvironmentContextProvider";
+export * from "./errorHandling/ErrorHandlingProvider";
 export * from "./fetchAssetBlobUrl";
 export * from "./filter-bar/FilterBarProvider";
 export * from "./images/useImageUploader";