@atlaskit/react-ufo 4.5.4 → 4.5.5

package/CHANGELOG.md

@@ -1,5 +1,12 @@
 # @atlaskit/ufo-interaction-ignore
 
+## 4.5.5
+
+### Patch Changes
+
+- [`d2a5fe501a90f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/d2a5fe501a90f) -
+  useUFOReportError hook for centrally managed error reporting for UFO
+
 ## 4.5.4
 
 ### Patch Changes

package/dist/cjs/report-error/index.js

@@ -0,0 +1,35 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useUFOReportError = useUFOReportError;
+var _interactionContext = require("../interaction-context");
+var _interactionMetrics = require("../interaction-metrics");
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+function useUFOReportError() {
+  var interaction = (0, _interactionMetrics.getActiveInteraction)();
+  var ufoContext = (0, _interactionContext.useInteractionContext)();
+  var reportError = function reportError(error) {
+    if (interaction !== null && interaction !== void 0 && interaction.id) {
+      (0, _interactionMetrics.addError)(interaction.id, error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack, error.forcedError);
+    } else {
+      (0, _interactionMetrics.addErrorToAll)(error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack);
+    }
+  };
+  return reportError;
+}

package/dist/es2019/report-error/index.js

@@ -0,0 +1,30 @@
+import { useInteractionContext } from '../interaction-context';
+import { addError, addErrorToAll, getActiveInteraction } from '../interaction-metrics';
+
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export function useUFOReportError() {
+  const interaction = getActiveInteraction();
+  const ufoContext = useInteractionContext();
+  const reportError = error => {
+    if (interaction !== null && interaction !== void 0 && interaction.id) {
+      addError(interaction.id, error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack, error.forcedError);
+    } else {
+      addErrorToAll(error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack);
+    }
+  };
+  return reportError;
+}

package/dist/esm/report-error/index.js

@@ -0,0 +1,30 @@
+import { useInteractionContext } from '../interaction-context';
+import { addError, addErrorToAll, getActiveInteraction } from '../interaction-metrics';
+
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export function useUFOReportError() {
+  var interaction = getActiveInteraction();
+  var ufoContext = useInteractionContext();
+  var reportError = function reportError(error) {
+    if (interaction !== null && interaction !== void 0 && interaction.id) {
+      addError(interaction.id, error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack, error.forcedError);
+    } else {
+      addErrorToAll(error.name, (ufoContext === null || ufoContext === void 0 ? void 0 : ufoContext.labelStack) || null, error.name, error.errorMessage, error.errorStack);
+    }
+  };
+  return reportError;
+}

package/dist/types/report-error/index.d.ts

@@ -0,0 +1,17 @@
+import { type InteractionError } from '../interaction-metrics';
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export declare function useUFOReportError(): (error: InteractionError) => void;

package/dist/types-ts4.5/report-error/index.d.ts

@@ -0,0 +1,17 @@
+import { type InteractionError } from '../interaction-metrics';
+/**
+ * Usage:
+ * ```
+ * import { useUFOReportError } from '@atlaskit/react-ufo/use-error-handler';
+ *
+ * const reportError = useUFOReportError();
+ *
+ * try {
+ *   // something that can throw an error
+ * } catch (error) {
+ *   reportError(error)
+ * }
+ * ```
+ * @returns `reportError` function
+ */
+export declare function useUFOReportError(): (error: InteractionError) => void;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/react-ufo",
-	"version": "4.5.4",
+	"version": "4.5.5",
 	"description": "Parts of React UFO that are publicly available",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",

package/report-error/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@atlaskit/react-ufo/report-error",
+  "main": "../dist/cjs/report-error/index.js",
+  "module": "../dist/esm/report-error/index.js",
+  "module:es2019": "../dist/es2019/report-error/index.js",
+  "sideEffects": false,
+  "types": "../dist/types/report-error/index.d.ts",
+  "typesVersions": {
+    ">=4.5 <5.9": {
+      "*": [
+        "../dist/types-ts4.5/report-error/index.d.ts"
+      ]
+    }
+  }
+}