@luciq/react-native 18.0.0

package/src/modules/BugReporting.ts

@@ -0,0 +1,254 @@
+import { Platform } from 'react-native';
+
+import { NativeBugReporting, NativeEvents, emitter } from '../native/NativeBugReporting';
+
+import type {
+  DismissType,
+  ExtendedBugReportMode,
+  FloatingButtonPosition,
+  InvocationEvent,
+  InvocationOption,
+  RecordingButtonPosition,
+  ReportType,
+  userConsentActionType,
+} from '../utils/Enums';
+
+/**
+ * Enables and disables manual invocation and prompt options for bug and feedback.
+ * @param isEnabled
+ */
+export const setEnabled = (isEnabled: boolean) => {
+  NativeBugReporting.setEnabled(isEnabled);
+};
+
+/**
+ * Sets the events that invoke the feedback form.
+ * Default is set by `Luciq.init`.
+ * @param events Array of events that invokes the feedback form.
+ */
+export const setInvocationEvents = (events: InvocationEvent[]) => {
+  NativeBugReporting.setInvocationEvents(events);
+};
+
+/**
+ * Sets the invocation options.
+ * Default is set by `Luciq.init`.
+ * @param options Array of invocation options
+ */
+export const setOptions = (options: InvocationOption[]) => {
+  NativeBugReporting.setOptions(options);
+};
+
+/**
+ * Sets a block of code to be executed just before the SDK's UI is presented.
+ * This block is executed on the UI thread. Could be used for performing any
+ * UI changes before the SDK's UI is shown.
+ * @param handler A callback that gets executed before invoking the SDK
+ */
+export const onInvokeHandler = (handler: () => void) => {
+  emitter.addListener(NativeEvents.ON_INVOKE_HANDLER, handler);
+  NativeBugReporting.setOnInvokeHandler(handler);
+};
+
+/**
+ * Sets a block of code to be executed right after the SDK's UI is dismissed.
+ * This block is executed on the UI thread. Could be used for performing any
+ * UI changes after the SDK's UI is dismissed.
+ * @param handler A callback to get executed after dismissing the SDK.
+ */
+export const onSDKDismissedHandler = (
+  handler: (dismissType: DismissType, reportType: ReportType) => void,
+) => {
+  emitter.addListener(NativeEvents.ON_DISMISS_HANDLER, (payload) => {
+    handler(payload.dismissType, payload.reportType);
+  });
+  NativeBugReporting.setOnSDKDismissedHandler(handler);
+};
+
+/**
+ * Sets the threshold value of the shake gesture for iPhone/iPod Touch
+ * Default for iPhone is 2.5.
+ * @param threshold Threshold for iPhone.
+ */
+export const setShakingThresholdForiPhone = (threshold: number) => {
+  if (Platform.OS === 'ios') {
+    NativeBugReporting.setShakingThresholdForiPhone(threshold);
+  }
+};
+
+/**
+ * Sets the threshold value of the shake gesture for iPad.
+ * Default for iPad is 0.6.
+ * @param threshold Threshold for iPad.
+ */
+export const setShakingThresholdForiPad = (threshold: number) => {
+  if (Platform.OS === 'ios') {
+    NativeBugReporting.setShakingThresholdForiPad(threshold);
+  }
+};
+
+/**
+ * Sets the threshold value of the shake gesture for android devices.
+ * Default for android is an integer value equals 350.
+ * you could increase the shaking difficulty level by
+ * increasing the `350` value and vice versa
+ * @param threshold Threshold for android devices.
+ */
+export const setShakingThresholdForAndroid = (threshold: number) => {
+  if (Platform.OS === 'android') {
+    NativeBugReporting.setShakingThresholdForAndroid(threshold);
+  }
+};
+
+/**
+ * Sets whether the extended bug report mode should be disabled, enabled with
+ * required fields or enabled with optional fields.
+ * @param mode An enum to disable the extended bug report mode,
+ * enable it with required or with optional fields.
+ */
+export const setExtendedBugReportMode = (mode: ExtendedBugReportMode) => {
+  NativeBugReporting.setExtendedBugReportMode(mode);
+};
+
+/**
+ * Sets what type of reports, bug or feedback, should be invoked.
+ * @param types Array of reportTypes
+ */
+export const setReportTypes = (types: ReportType[]) => {
+  NativeBugReporting.setReportTypes(types);
+};
+
+/**
+ * Invoke bug reporting with report type and options.
+ * @param type
+ * @param options
+ */
+export const show = (type: ReportType, options: InvocationOption[]) => {
+  NativeBugReporting.show(type, options ?? []);
+};
+
+/**
+ * Enable/Disable screen recording
+ * @param isEnabled enable/disable screen recording on crash feature
+ */
+export const setAutoScreenRecordingEnabled = (isEnabled: boolean) => {
+  NativeBugReporting.setAutoScreenRecordingEnabled(isEnabled);
+};
+
+/**
+ * Sets auto screen recording maximum duration
+ *
+ * @param maxDuration maximum duration of the screen recording video in seconds.
+ * The maximum duration is 30 seconds
+ */
+export const setAutoScreenRecordingDurationIOS = (maxDuration: number) => {
+  if (Platform.OS !== 'ios') {
+    return;
+  }
+  NativeBugReporting.setAutoScreenRecordingDuration(maxDuration);
+};
+
+/**
+ * Sets the default position at which the Luciq screen recording button will be shown.
+ * Different orientations are already handled.
+ * (Default for `position` is `bottomRight`)
+ *
+ * @param buttonPosition is of type position `topLeft` to show on the top left
+ * of screen, or `bottomRight` to show on the bottom right of screen.
+ */
+export const setVideoRecordingFloatingButtonPosition = (
+  buttonPosition: RecordingButtonPosition,
+) => {
+  NativeBugReporting.setVideoRecordingFloatingButtonPosition(buttonPosition);
+};
+
+/**
+ * Enables/disables inspect view hierarchy when reporting a bug/feedback.
+ * @param isEnabled A boolean to set whether view hierarchy are enabled or disabled.
+ */
+export const setViewHierarchyEnabled = (isEnabled: boolean) => {
+  NativeBugReporting.setViewHierarchyEnabled(isEnabled);
+};
+
+/**
+ * Adds a user consent item to the bug reporting form.
+ * @param key A unique identifier string for the consent item.
+ * @param description The text shown to the user describing the consent item.
+ * @param mandatory Whether the user must agree to this item before submitting a report.
+ * @param checked Whether the consent checkbox is pre-selected.
+ * @param actionType A string representing the action type to map to SDK behavior.
+ */
+export const addUserConsent = (
+  key: string,
+  description: string,
+  mandatory: boolean,
+  checked: boolean,
+  actionType?: userConsentActionType,
+) => {
+  NativeBugReporting.addUserConsent(key, description, mandatory, checked, actionType);
+};
+/**
+ * Sets a block of code to be executed when a prompt option is selected.
+ * @param handler - A callback that gets executed when a prompt option is selected.
+ */
+export const setDidSelectPromptOptionHandler = (handler: (promptOption: string) => void) => {
+  if (Platform.OS === 'android') {
+    return;
+  }
+  emitter.addListener(NativeEvents.DID_SELECT_PROMPT_OPTION_HANDLER, (payload) => {
+    handler(payload.promptOption);
+  });
+  NativeBugReporting.setDidSelectPromptOptionHandler(handler);
+};
+
+/**
+ * Sets the default edge and offset from the top at which the floating button
+ * will be shown. Different orientations are already handled.
+ * @param edge The screen edge to show the floating button onto. Default is `floatingButtonEdge.right`.
+ * @param offset The offset of the floating button from the top of the screen. Default is 50.
+ */
+export const setFloatingButtonEdge = (edge: FloatingButtonPosition, offset: number) => {
+  NativeBugReporting.setFloatingButtonEdge(edge, offset);
+};
+
+/**
+ * Sets whether attachments in bug reporting and in-app messaging are enabled or not.
+ * @param screenshot A boolean to enable or disable screenshot attachments.
+ * @param extraScreenshot A boolean to enable or disable extra screenshot attachments.
+ * @param galleryImage A boolean to enable or disable gallery image attachments. In iOS 10+,
+ * NSPhotoLibraryUsageDescription should be set in info.plist to enable gallery image attachments.
+ * @param screenRecording A boolean to enable or disable screen recording attachments.
+ */
+export const setEnabledAttachmentTypes = (
+  screenshot: boolean,
+  extraScreenshot: boolean,
+  galleryImage: boolean,
+  screenRecording: boolean,
+) => {
+  NativeBugReporting.setEnabledAttachmentTypes(
+    screenshot,
+    extraScreenshot,
+    galleryImage,
+    screenRecording,
+  );
+};
+
+/**
+ * Adds a disclaimer text within the bug reporting form, which can include hyperlinked text.
+ * @param text String text.
+ */
+export const setDisclaimerText = (text: string) => {
+  NativeBugReporting.setDisclaimerText(text);
+};
+
+/**
+ * Sets a minimum number of characters as a requirement for the comments field in the different report types.
+ * @param limit int number of characters.
+ * @param reportTypes (Optional) Array of reportType. If it's not passed, the limit will apply to all report types.
+ * @platform iOS
+ */
+export const setCommentMinimumCharacterCount = (limit: number, reportTypes?: ReportType[]) => {
+  if (Platform.OS === 'ios') {
+    NativeBugReporting.setCommentMinimumCharacterCount(limit, reportTypes ?? []);
+  }
+};

package/src/modules/CrashReporting.ts

@@ -0,0 +1,54 @@
+import type { ExtendedError } from 'react-native/Libraries/Core/Devtools/parseErrorStack';
+
+import { NativeCrashReporting } from '../native/NativeCrashReporting';
+import LuciqUtils from '../utils/LuciqUtils';
+import { Platform } from 'react-native';
+import type { NonFatalOptions } from '../models/NonFatalOptions';
+import { NonFatalErrorLevel } from '../utils/Enums';
+import { Logger } from '../utils/logger';
+
+/**
+ * Enables and disables everything related to crash reporting including intercepting
+ * errors in the global error handler. It is enabled by default.
+ * @param isEnabled
+ */
+export const setEnabled = (isEnabled: boolean) => {
+  NativeCrashReporting.setEnabled(isEnabled);
+};
+
+/**
+ * Send handled JS error object
+ * @param error Error object to be sent to Luciq's servers
+ * @param nonFatalOptions extra config for the non-fatal error sent with Error Object
+ */
+export const reportError = (error: ExtendedError, nonFatalOptions: NonFatalOptions = {}) => {
+  if (error instanceof Error) {
+    let level = NonFatalErrorLevel.error;
+    if (nonFatalOptions.level != null) {
+      level = nonFatalOptions.level;
+    }
+    return LuciqUtils.sendCrashReport(error, (data) =>
+      NativeCrashReporting.sendHandledJSCrash(
+        data,
+        nonFatalOptions.userAttributes,
+        nonFatalOptions.fingerprint,
+        level,
+      ),
+    );
+  } else {
+    Logger.warn(
+      `LCQ-RN: The error ${error} has been omitted because only error type is supported.`,
+    );
+    return;
+  }
+};
+
+/**
+ * Enables and disables capturing native C++ NDK crashes.
+ * @param isEnabled
+ */
+export const setNDKCrashesEnabled = (isEnabled: boolean) => {
+  if (Platform.OS === 'android') {
+    NativeCrashReporting.setNDKCrashesEnabled(isEnabled);
+  }
+};

package/src/modules/FeatureRequests.ts

@@ -0,0 +1,32 @@
+import { NativeFeatureRequests } from '../native/NativeFeatureRequests';
+import type { ActionType } from '../utils/Enums';
+
+/**
+ * Enables and disables everything related to feature requests.
+ *
+ * @param isEnabled
+ */
+export const setEnabled = (isEnabled: boolean) => {
+  NativeFeatureRequests.setEnabled(isEnabled);
+};
+
+/**
+ * Sets whether users are required to enter an email address or not when
+ * sending reports.
+ * Defaults to YES.
+ *
+ * @param isEmailFieldRequired A boolean to indicate whether email field is required or not.
+ * @param types An enum that indicates which action types will have the isEmailFieldRequired
+ */
+export const setEmailFieldRequired = (isEmailFieldRequired: boolean, type: ActionType) => {
+  NativeFeatureRequests.setEmailFieldRequiredForFeatureRequests(isEmailFieldRequired, [
+    type,
+  ] as ActionType[]);
+};
+
+/**
+ * Shows the UI for feature requests list
+ */
+export const show = () => {
+  NativeFeatureRequests.show();
+};