@luciq/react-native 18.0.0

package/dist/modules/CrashReporting.js

@@ -0,0 +1,40 @@
+import { NativeCrashReporting } from '../native/NativeCrashReporting';
+import LuciqUtils from '../utils/LuciqUtils';
+import { Platform } from 'react-native';
+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) => {
+    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, 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) => {
+    if (Platform.OS === 'android') {
+        NativeCrashReporting.setNDKCrashesEnabled(isEnabled);
+    }
+};

package/dist/modules/FeatureRequests.d.ts

@@ -0,0 +1,20 @@
+import type { ActionType } from '../utils/Enums';
+/**
+ * Enables and disables everything related to feature requests.
+ *
+ * @param isEnabled
+ */
+export declare const setEnabled: (isEnabled: boolean) => void;
+/**
+ * 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 declare const setEmailFieldRequired: (isEmailFieldRequired: boolean, type: ActionType) => void;
+/**
+ * Shows the UI for feature requests list
+ */
+export declare const show: () => void;

package/dist/modules/FeatureRequests.js

@@ -0,0 +1,28 @@
+import { NativeFeatureRequests } from '../native/NativeFeatureRequests';
+/**
+ * Enables and disables everything related to feature requests.
+ *
+ * @param isEnabled
+ */
+export const setEnabled = (isEnabled) => {
+    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, type) => {
+    NativeFeatureRequests.setEmailFieldRequiredForFeatureRequests(isEmailFieldRequired, [
+        type,
+    ]);
+};
+/**
+ * Shows the UI for feature requests list
+ */
+export const show = () => {
+    NativeFeatureRequests.show();
+};

package/dist/modules/Luciq.d.ts

@@ -0,0 +1,362 @@
+import type { NavigationContainerRefWithCurrent, NavigationState as NavigationStateV5 } from '@react-navigation/native';
+import type { ComponentDidAppearEvent } from 'react-native-navigation';
+import type { NavigationAction, NavigationState as NavigationStateV4 } from 'react-navigation';
+import type { LuciqConfig } from '../models/LuciqConfig';
+import Report from '../models/Report';
+import { AutoMaskingType, ColorTheme, Locale, StringKey, WelcomeMessageMode } from '../utils/Enums';
+import type { ReproConfig } from '../models/ReproConfig';
+import type { FeatureFlag } from '../models/FeatureFlag';
+import type { OverAirUpdate } from '../models/OverAirUpdate';
+import type { ThemeConfig } from '../models/ThemeConfig';
+/**
+ * Enables or disables Luciq functionality.
+ * @param isEnabled A boolean to enable/disable Luciq.
+ */
+export declare const setEnabled: (isEnabled: boolean) => void;
+/**
+ * Initializes the SDK.
+ * This is the main SDK method that does all the magic. This is the only
+ * method that SHOULD be called.
+ * Should be called in constructor of the AppRegistry component
+ * @param config SDK configurations. See {@link LuciqConfig} for more info.
+ */
+export declare const init: (config: LuciqConfig) => void;
+/**
+ * Set Current App Variant.
+ * @param appVariant the current App variant name
+ */
+export declare const setAppVariant: (appVariant: string) => void;
+/**
+ * Sets the Code Push version to be sent with each report.
+ * @param version the Code Push version.
+ *
+ * @deprecated Use {@link setOverAirVersion} instead.
+ */
+export declare const setCodePushVersion: (version: string) => void;
+/**
+ * Sets over air update version to be sent with each report.
+ * @param version the OTA version.
+ *
+ */
+export declare const setOverAirVersion: (OTAserviceVersion: OverAirUpdate) => void;
+/**
+ * Attaches user data to each report being sent.
+ * Each call to this method overrides the user data to be attached.
+ * Maximum size of the string is 1,000 characters.
+ * @param data A string to be attached to each report, with a maximum size of 1,000 characters.
+ */
+export declare const setUserData: (data: string) => void;
+/**
+ * Sets whether the SDK is tracking user steps or not.
+ * Enabling user steps would give you an insight on the scenario a user has
+ * performed before encountering a bug or a crash. User steps are attached
+ * with each report being sent.
+ * @param isEnabled A boolean to set user steps tracking to being enabled or disabled.
+ */
+export declare const setTrackUserSteps: (isEnabled: boolean) => void;
+/**
+ * Sets whether LCQLog should also print to Xcode's console log or not.
+ * @param printsToConsole A boolean to set whether printing to
+ * Xcode's console is enabled or not.
+ */
+export declare const setLCQLogPrintsToConsole: (printsToConsole: boolean) => void;
+/**
+ * The session profiler is enabled by default and it attaches to the bug and
+ * crash reports the following information during the last 60 seconds before the report is sent.
+ * @param isEnabled A boolean parameter to enable or disable the feature.
+ */
+export declare const setSessionProfilerEnabled: (isEnabled: boolean) => void;
+/**
+ * Sets the SDK's locale.
+ * Use to change the SDK's UI to different language.
+ * Defaults to the device's current locale.
+ * @param sdkLocale A locale to set the SDK to.
+ */
+export declare const setLocale: (sdkLocale: Locale) => void;
+/**
+ * Sets the color theme of the SDK's whole UI.
+ * @param sdkTheme
+ */
+export declare const setColorTheme: (sdkTheme: ColorTheme) => void;
+/**
+ * Sets the primary color of the SDK's UI.
+ * Sets the color of UI elements indicating interactivity or call to action.
+ * To use, import processColor and pass to it with argument the color hex
+ * as argument.
+ * @param color A color to set the UI elements of the SDK to.
+ * @deprecated Please migrate to the new UI customization API: {@link setTheme}
+ */
+export declare const setPrimaryColor: (color: string) => void;
+/**
+ * Appends a set of tags to previously added tags of reported feedback,
+ * bug or crash.
+ * @param tags An array of tags to append to current tags.
+ */
+export declare const appendTags: (tags: string[]) => void;
+/**
+ * Manually removes all tags of reported feedback, bug or crash.
+ */
+export declare const resetTags: () => void;
+/**
+ * Gets all tags of reported feedback, bug or crash.
+ */
+export declare const getTags: () => Promise<string[] | null>;
+/**
+ * Overrides any of the strings shown in the SDK with custom ones.
+ * Allows you to customize any of the strings shown to users in the SDK.
+ * @param key Key of string to override.
+ * @param string String value to override the default one.
+ */
+export declare const setString: (key: StringKey, string: string) => void;
+/**
+ * Sets the default value of the user's email and ID and hides the email field from the reporting UI
+ * and set the user's name to be included with all reports.
+ * It also reset the chats on device to that email and removes user attributes,
+ * user data and completed surveys.
+ * @param email Email address to be set as the user's email.
+ * @param name Name of the user to be set.
+ * @param [id] ID of the user to be set.
+ */
+export declare const identifyUser: (email: string, name: string, id?: string) => void;
+/**
+ * Sets the default value of the user's email to nil and show email field and remove user name
+ * from all reports
+ * It also reset the chats on device and removes user attributes, user data and completed surveys.
+ */
+export declare const logOut: () => void;
+/**
+ * Logs a user event that happens through the lifecycle of the application.
+ * Logged user events are going to be sent with each report, as well as at the end of a session.
+ * @param name Event name.
+ */
+export declare const logUserEvent: (name: string) => void;
+/**
+ * Appends a log message to Luciq internal log.
+ * These logs are then sent along the next uploaded report.
+ * All log messages are timestamped.
+ * Logs aren't cleared per single application run.
+ * If you wish to reset the logs, use {@link clearLogs()}
+ * Note: logs passed to this method are **NOT** printed to Logcat.
+ *
+ * @param message the message
+ */
+export declare const logVerbose: (message: string) => void;
+/**
+ * Appends a log message to Luciq internal log.
+ * These logs are then sent along the next uploaded report.
+ * All log messages are timestamped.
+ * Logs aren't cleared per single application run.
+ * If you wish to reset the logs, use {@link clearLogs()}
+ * Note: logs passed to this method are **NOT** printed to Logcat.
+ *
+ * @param message the message
+ */
+export declare const logInfo: (message: string) => void;
+/**
+ * Appends a log message to Luciq internal log.
+ * These logs are then sent along the next uploaded report.
+ * All log messages are timestamped.
+ * Logs aren't cleared per single application run.
+ * If you wish to reset the logs, use {@link clearLogs()}
+ * Note: logs passed to this method are **NOT** printed to Logcat.
+ *
+ * @param message the message
+ */
+export declare const logDebug: (message: string) => void;
+/**
+ * Appends a log message to Luciq internal log.
+ * These logs are then sent along the next uploaded report.
+ * All log messages are timestamped.
+ * Logs aren't cleared per single application run.
+ * If you wish to reset the logs, use {@link clearLogs()}
+ * Note: logs passed to this method are **NOT** printed to Logcat.
+ *
+ * @param message the message
+ */
+export declare const logError: (message: string) => void;
+/**
+ * Appends a log message to Luciq internal log.
+ * These logs are then sent along the next uploaded report.
+ * All log messages are timestamped.
+ * Logs aren't cleared per single application run.
+ * If you wish to reset the logs, use {@link clearLogs()}
+ * Note: logs passed to this method are **NOT** printed to Logcat.
+ *
+ * @param message the message
+ */
+export declare const logWarn: (message: string) => void;
+/**
+ * Clear all Luciq logs, console logs, network logs and user steps.
+ */
+export declare const clearLogs: () => void;
+/**
+ * Sets the repro steps mode for bugs and crashes.
+ *
+ * @param config The repro steps config.
+ *
+ * @example
+ * ```js
+ * Luciq.setReproStepsConfig({
+ *   bug: ReproStepsMode.enabled,
+ *   crash: ReproStepsMode.disabled,
+ *   sessionReplay: ReproStepsMode.enabled,
+ * });
+ * ```
+ */
+export declare const setReproStepsConfig: (config: ReproConfig) => void;
+/**
+ * Sets user attribute to overwrite it's value or create a new one if it doesn't exist.
+ *
+ * @param key the attribute
+ * @param value the value
+ */
+export declare const setUserAttribute: (key: string, value: string) => void;
+/**
+ * Returns the user attribute associated with a given key.
+ * @param key The attribute key as string
+ */
+export declare const getUserAttribute: (key: string) => Promise<string | null>;
+/**
+ * Removes user attribute if exists.
+ *
+ * @param key the attribute key as string
+ * @see {@link setUserAttribute}
+ */
+export declare const removeUserAttribute: (key: string) => void;
+/**
+ * Returns all user attributes.
+ * set user attributes, or an empty dictionary if no user attributes have been set.
+ */
+export declare const getAllUserAttributes: () => Promise<Record<string, string>>;
+/**
+ * Clears all user attributes if exists.
+ */
+export declare const clearAllUserAttributes: () => void;
+/**
+ * Shows the welcome message in a specific mode.
+ * @param mode An enum to set the welcome message mode to live, or beta.
+ */
+export declare const showWelcomeMessage: (mode: WelcomeMessageMode) => void;
+/**
+ * Sets the welcome message mode to live, beta or disabled.
+ * @param mode An enum to set the welcome message mode to live, beta or disabled.
+ */
+export declare const setWelcomeMessageMode: (mode: WelcomeMessageMode) => void;
+/**
+ * Add file to be attached to the bug report.
+ * @param filePath
+ * @param fileName
+ */
+export declare const addFileAttachment: (filePath: string, fileName: string) => void;
+/**
+ * Hides component from screenshots, screen recordings and view hierarchy.
+ * @param viewRef the ref of the component to hide
+ */
+export declare const addPrivateView: (viewRef: number | React.Component | React.ComponentClass) => void;
+/**
+ * Removes component from the set of hidden views. The component will show again in
+ * screenshots, screen recordings and view hierarchy.
+ * @param viewRef the ref of the component to remove from hidden views
+ */
+export declare const removePrivateView: (viewRef: number | React.Component | React.ComponentClass) => void;
+/**
+ * Shows default Luciq prompt.
+ */
+export declare const show: () => void;
+export declare const onReportSubmitHandler: (handler?: ((report: Report) => void) | undefined) => void;
+export declare const onNavigationStateChange: (prevState: NavigationStateV4, currentState: NavigationStateV4, _action: NavigationAction) => void;
+export declare const onStateChange: (state?: NavigationStateV5) => void;
+/**
+ * Sets a listener for screen change
+ *  @param navigationRef a refrence of a navigation container
+ *
+ */
+export declare const setNavigationListener: (navigationRef: NavigationContainerRefWithCurrent<ReactNavigation.RootParamList>) => () => void;
+export declare const reportScreenChange: (screenName: string) => void;
+/**
+ * Add feature flags to the next report.
+ * @param featureFlags An array of feature flags to add to the next report.
+ */
+export declare const addFeatureFlags: (featureFlags: FeatureFlag[]) => void;
+/**
+ * Add a feature flag to the to next report.
+ */
+export declare const addFeatureFlag: (featureFlag: FeatureFlag) => void;
+/**
+ * Remove feature flags from the next report.
+ * @param featureFlags An array of  feature flags to remove from the next report.
+ */
+export declare const removeFeatureFlags: (featureFlags: string[]) => void;
+/**
+ * Remove a feature flag from the next report.
+ * @param name the name of the feature flag to remove from the next report.
+ */
+export declare const removeFeatureFlag: (name: string) => void;
+/**
+ * Clear all feature flags
+ */
+export declare const removeAllFeatureFlags: () => void;
+/**
+ * This API has to be call when using custom app rating prompt
+ */
+export declare const willRedirectToStore: () => void;
+/**
+ * This API has be called when changing the default Metro server port (8081) to exclude the DEV URL from network logging.
+ */
+export declare const setMetroDevServerPort: (port: number) => void;
+export declare const componentDidAppearListener: (event: ComponentDidAppearEvent) => void;
+/**
+ * Sets listener to feature flag changes
+ * @param handler A callback that gets the update value of the flag
+ */
+export declare const _registerFeatureFlagsChangeListener: (handler: (payload: {
+    isW3ExternalTraceIDEnabled: boolean;
+    isW3ExternalGeneratedHeaderEnabled: boolean;
+    isW3CaughtHeaderEnabled: boolean;
+    networkBodyLimit: number;
+}) => void) => void;
+/**
+ * Sets the auto mask screenshots types.
+ * @param autoMaskingTypes The masking type to be applied.
+ */
+export declare const enableAutoMasking: (autoMaskingTypes: AutoMaskingType[]) => void;
+/**
+ * Sets a custom theme for Luciq UI elements.
+ *
+ * This method provides comprehensive theming support. It will automatically use LCQTheme
+ * if available in the SDK version, otherwise falls back to individual theming methods.
+ *
+ * @param theme - Configuration object containing theme properties
+ *
+ * @example
+ * ```typescript
+ * // Basic usage with primary color (always supported)
+ * Luciq.setTheme({
+ *   primaryColor: '#FF6B6B'
+ * });
+ *
+ * // Comprehensive theming (uses LCQTheme when available)
+ * Luciq.setTheme({
+ *   primaryColor: '#FF6B6B',
+ *   secondaryTextColor: '#666666',
+ *   primaryTextColor: '#333333',
+ *   titleTextColor: '#000000',
+ *   backgroundColor: '#FFFFFF',
+ *   primaryTextStyle: 'bold',
+ *   secondaryTextStyle: 'normal',
+ *   titleTextStyle: 'bold',
+ *   ctaTextStyle: 'bold',
+ *   primaryFontPath: '/data/user/0/ai.yourapp/files/fonts/YourFont.ttf',
+ *   secondaryFontPath: '/data/user/0/ai.yourapp/files/fonts/YourFont.ttf',
+ *   ctaTextType: '/data/user/0/ai.yourapp/files/fonts/YourFont.ttf',
+ *   primaryFontAsset: 'fonts/YourFont.ttf',
+ *   secondaryFontAsset: 'fonts/YourFont.ttf'
+ * });
+ * ```
+ */
+export declare const setTheme: (theme: ThemeConfig) => void;
+/**
+ * Enables or disables displaying in full-screen mode, hiding the status and navigation bars.
+ * @param isEnabled A boolean to enable/disable setFullscreen.
+ */
+export declare const setFullscreen: (isEnabled: boolean) => void;