@luciq/react-native 18.0.0

package/src/utils/AppStatesHandler.ts

@@ -0,0 +1,19 @@
+import { AppState, type AppStateStatus } from 'react-native';
+
+let subscription: any = null;
+
+// Register the event listener manually
+export const addAppStateListener = (handleAppStateChange: (state: AppStateStatus) => void) => {
+  if (!subscription) {
+    subscription = AppState.addEventListener('change', handleAppStateChange);
+  }
+};
+
+// Unregister the event listener manually
+//todo: find where to Unregister appState listener
+export const removeAppStateListener = () => {
+  if (subscription) {
+    subscription.remove();
+    subscription = null;
+  }
+};

package/src/utils/Enums.ts

@@ -0,0 +1,266 @@
+import { NativeLuciq } from '../native/NativeLuciq';
+
+const constants = NativeLuciq.getConstants();
+
+/**
+ * Verbosity level of the SDK debug logs. This has nothing to do with `Luciq.log`,
+ * and only affect the logs used to debug the SDK itself.
+ */
+export enum LogLevel {
+  verbose = constants.sdkDebugLogsLevelVerbose,
+  debug = constants.sdkDebugLogsLevelDebug,
+  error = constants.sdkDebugLogsLevelError,
+  none = constants.sdkDebugLogsLevelNone,
+}
+/**
+ * Enum representing the available user consent action types.
+ *
+ */
+export enum userConsentActionType {
+  dropAutoCapturedMedia = constants.dropAutoCapturedMedia,
+  dropLogs = constants.dropLogs,
+  noChat = constants.noChat,
+}
+
+/**
+ * The event used to invoke the feedback form.
+ */
+export enum InvocationEvent {
+  none = constants.invocationEventNone,
+  shake = constants.invocationEventShake,
+  screenshot = constants.invocationEventScreenshot,
+  twoFingersSwipe = constants.invocationEventTwoFingersSwipeLeft,
+  floatingButton = constants.invocationEventFloatingButton,
+}
+
+/**
+ * The network interceptor to use.
+ */
+export enum NetworkInterceptionMode {
+  javascript,
+  native,
+}
+
+/**
+ * Options added while invoking bug reporting.
+ */
+export enum InvocationOption {
+  emailFieldHidden = constants.optionEmailFieldHidden,
+  emailFieldOptional = constants.optionEmailFieldOptional,
+  commentFieldRequired = constants.optionCommentFieldRequired,
+  disablePostSendingDialog = constants.optionDisablePostSendingDialog,
+}
+
+/**
+ * The color theme of the different UI elements.
+ */
+export enum ColorTheme {
+  light = constants.colorThemeLight,
+  dark = constants.colorThemeDark,
+}
+
+/**
+ * Floating button positions.
+ */
+export enum FloatingButtonPosition {
+  left = constants.rectMinXEdge,
+  right = constants.rectMaxXEdge,
+}
+
+/**
+ * Video recording button positions.
+ */
+export enum RecordingButtonPosition {
+  bottomRight = constants.bottomRight,
+  topRight = constants.topRight,
+  bottomLeft = constants.bottomLeft,
+  topLeft = constants.topLeft,
+}
+
+/**
+ * The welcome message mode.
+ */
+export enum WelcomeMessageMode {
+  live = constants.welcomeMessageModeLive,
+  beta = constants.welcomeMessageModeBeta,
+  disabled = constants.welcomeMessageModeDisabled,
+}
+
+/**
+ * Type of the report either feedback or bug.
+ */
+export enum ReportType {
+  bug = constants.bugReportingReportTypeBug,
+  feedback = constants.bugReportingReportTypeFeedback,
+  question = constants.bugReportingReportTypeQuestion,
+}
+
+/**
+ * Type of SDK dismiss.
+ */
+export enum DismissType {
+  submit = constants.dismissTypeSubmit,
+  cancel = constants.dismissTypeCancel,
+  addAttachment = constants.dismissTypeAddAttachment,
+}
+
+/**
+ * Types of possible actions inside Feature Requests.
+ */
+export enum ActionType {
+  all = constants.allActions,
+  reportBug = constants.reportBugAction,
+  requestNewFeature = constants.requestNewFeature,
+  addCommentToFeature = constants.addCommentToFeature,
+}
+
+/**
+ * The extended bug report mode.
+ */
+export enum ExtendedBugReportMode {
+  enabledWithRequiredFields = constants.enabledWithRequiredFields,
+  enabledWithOptionalFields = constants.enabledWithOptionalFields,
+  disabled = constants.disabled,
+}
+
+/**
+ * The user steps option.
+ */
+export enum ReproStepsMode {
+  enabledWithNoScreenshots = constants.reproStepsEnabledWithNoScreenshots,
+  enabled = constants.reproStepsEnabled,
+  disabled = constants.reproStepsDisabled,
+}
+
+/**
+ * The non fatal error level.
+ */
+export enum NonFatalErrorLevel {
+  error = constants.nonFatalErrorLevelError,
+  critical = constants.nonFatalErrorLevelCritical,
+  info = constants.nonFatalErrorLevelInfo,
+  warning = constants.nonFatalErrorLevelWarning,
+}
+
+/**
+ * Supported locales
+ */
+export enum Locale {
+  arabic = constants.localeArabic,
+  azerbaijani = constants.localeAzerbaijani,
+  chineseSimplified = constants.localeChineseSimplified,
+  chineseTraditional = constants.localeChineseTraditional,
+  czech = constants.localeCzech,
+  danish = constants.localeDanish,
+  dutch = constants.localeDutch,
+  english = constants.localeEnglish,
+  french = constants.localeFrench,
+  german = constants.localeGerman,
+  italian = constants.localeItalian,
+  japanese = constants.localeJapanese,
+  korean = constants.localeKorean,
+  polish = constants.localePolish,
+  portugueseBrazil = constants.localePortugueseBrazil,
+  romanian = constants.localeRomanian,
+  russian = constants.localeRussian,
+  spanish = constants.localeSpanish,
+  swedish = constants.localeSwedish,
+  turkish = constants.localeTurkish,
+}
+
+/**
+ * Overridable strings in Luciq's UI
+ */
+export enum StringKey {
+  addAttachmentButtonTitleStringName = constants.addAttachmentButtonTitleStringName,
+  addExtraScreenshot = constants.addExtraScreenshot,
+  addImageFromGallery = constants.addImageFromGallery,
+  addVideoMessage = constants.addVideoMessage,
+  addVoiceMessage = constants.addVoiceMessage,
+  audio = constants.audio,
+  audioRecordingPermissionDeniedMessage = constants.audioRecordingPermissionDeniedMessage,
+  audioRecordingPermissionDeniedTitle = constants.audioRecordingPermissionDeniedTitle,
+  cancelButtonText = constants.cancelButtonTitle,
+  collectingDataText = constants.collectingDataText,
+  commentFieldHintForBugReport = constants.commentFieldHintForBugReport,
+  commentFieldHintForFeedback = constants.commentFieldHintForFeedback,
+  commentFieldHintForQuestion = constants.commentFieldHintForQuestion,
+  conversationsHeaderTitle = constants.conversationsHeaderTitle,
+  conversationTextFieldHint = constants.conversationTextFieldHint,
+  discardAlertDiscard = constants.discardAlertDiscard,
+  discardAlertStay = constants.discardAlertStay,
+  discardAlertMessage = constants.discardAlertMessage,
+  discardAlertTitle = constants.discardAlertTitle,
+  edgeSwipeStartHint = constants.edgeSwipeStartHint,
+  emailFieldHint = constants.emailFieldHint,
+  image = constants.image,
+
+  insufficientContentMessage = constants.insufficientContentMessage,
+  /** iOS only */
+  insufficientContentTitle = constants.insufficientContentTitle,
+  invalidEmailMessage = constants.invalidEmailMessage,
+  invalidEmailTitle = constants.invalidEmailTitle,
+  invocationHeader = constants.invocationHeader,
+  messagesNotification = constants.messagesNotification,
+  messagesNotificationAndOthers = constants.messagesNotificationAndOthers,
+  microphonePermissionAlertSettingsButtonText = constants.microphonePermissionAlertSettingsButtonTitle,
+  okButtonText = constants.okButtonTitle,
+  recordingMessageToHoldText = constants.recordingMessageToHoldText,
+  recordingMessageToReleaseText = constants.recordingMessageToReleaseText,
+  reportBug = constants.reportBug,
+  reportBugDescription = constants.reportBugDescription,
+  reportFeedback = constants.reportFeedback,
+  reportFeedbackDescription = constants.reportFeedbackDescription,
+  reportQuestion = constants.reportQuestion,
+  reportQuestionDescription = constants.reportQuestionDescription,
+  reportReproStepsDisclaimerBody = constants.reportReproStepsDisclaimerBody,
+  reportReproStepsDisclaimerLink = constants.reportReproStepsDisclaimerLink,
+  reproStepsListDescription = constants.reproStepsListDescription,
+  reproStepsListEmptyStateDescription = constants.reproStepsListEmptyStateDescription,
+  reproStepsListHeader = constants.reproStepsListHeader,
+  reproStepsListItemNumberingTitle = constants.reproStepsListItemNumberingTitle,
+  reproStepsProgressDialogBody = constants.reproStepsProgressDialogBody,
+  requestFeatureDescription = constants.requestFeatureDescription,
+  screenRecording = constants.screenRecording,
+  screenshotHeaderTitle = constants.screenshotHeaderTitle,
+  shakeHint = constants.shakeHint,
+  startAlertText = constants.startAlertText,
+  surveysStoreRatingThanksSubtitle = constants.surveysStoreRatingThanksSubtitle,
+  surveysStoreRatingThanksTitle = constants.surveysStoreRatingThanksTitle,
+  swipeHint = constants.swipeHint,
+  team = constants.team,
+  thankYouAlertText = constants.thankYouAlertText,
+  thankYouText = constants.thankYouText,
+  videoPressRecord = constants.videoPressRecord,
+  welcomeMessageBetaFinishStepContent = constants.welcomeMessageBetaFinishStepContent,
+  welcomeMessageBetaFinishStepTitle = constants.welcomeMessageBetaFinishStepTitle,
+  welcomeMessageBetaHowToReportStepContent = constants.welcomeMessageBetaHowToReportStepContent,
+  welcomeMessageBetaHowToReportStepTitle = constants.welcomeMessageBetaHowToReportStepTitle,
+  welcomeMessageBetaWelcomeStepContent = constants.welcomeMessageBetaWelcomeStepContent,
+  welcomeMessageBetaWelcomeStepTitle = constants.welcomeMessageBetaWelcomeStepTitle,
+  welcomeMessageLiveWelcomeStepContent = constants.welcomeMessageLiveWelcomeStepContent,
+  welcomeMessageLiveWelcomeStepTitle = constants.welcomeMessageLiveWelcomeStepTitle,
+}
+
+export enum LaunchType {
+  cold = constants.cold,
+  unknown = constants.unknown,
+  /**
+   *  Android only
+   */
+  warm = constants.warm,
+}
+
+/**
+ * Over Air Update Service
+ */
+export enum OverAirUpdateServices {
+  codePush = constants.codePush,
+  expo = constants.expo,
+}
+export enum AutoMaskingType {
+  labels = constants.labels,
+  textInputs = constants.textInputs,
+  media = constants.media,
+  none = constants.none,
+}

package/src/utils/FeatureFlags.ts

@@ -0,0 +1,33 @@
+import { NativeLuciq } from '../native/NativeLuciq';
+import { _registerFeatureFlagsChangeListener } from '../modules/Luciq';
+
+export const FeatureFlags = {
+  isW3ExternalTraceID: () => NativeLuciq.isW3ExternalTraceIDEnabled(),
+  isW3ExternalGeneratedHeader: () => NativeLuciq.isW3ExternalGeneratedHeaderEnabled(),
+  isW3CaughtHeader: () => NativeLuciq.isW3CaughtHeaderEnabled(),
+  networkLogLimit: () => NativeLuciq.getNetworkBodyMaxSize(),
+};
+
+export const registerFeatureFlagsListener = () => {
+  _registerFeatureFlagsChangeListener(
+    (res: {
+      isW3ExternalTraceIDEnabled: boolean;
+      isW3ExternalGeneratedHeaderEnabled: boolean;
+      isW3CaughtHeaderEnabled: boolean;
+      networkBodyLimit: number;
+    }) => {
+      FeatureFlags.isW3ExternalTraceID = async () => {
+        return res.isW3ExternalTraceIDEnabled;
+      };
+      FeatureFlags.isW3ExternalGeneratedHeader = async () => {
+        return res.isW3ExternalGeneratedHeaderEnabled;
+      };
+      FeatureFlags.isW3CaughtHeader = async () => {
+        return res.isW3CaughtHeaderEnabled;
+      };
+      FeatureFlags.networkLogLimit = async () => {
+        return res.networkBodyLimit;
+      };
+    },
+  );
+};

package/src/utils/LuciqConstants.ts

@@ -0,0 +1,24 @@
+const LuciqConstants = {
+  GRAPHQL_HEADER: 'lcq-graphql-header',
+
+  // TODO: dyanmically get the max size from the native SDK and update the error message to reflect the dynamic size.
+  MAX_NETWORK_BODY_SIZE_IN_BYTES: 1024 * 10, // 10 KB
+  MAX_RESPONSE_BODY_SIZE_EXCEEDED_MESSAGE:
+    'The response body has not been logged because it exceeds the maximum size of ',
+  MAX_REQUEST_BODY_SIZE_EXCEEDED_MESSAGE:
+    'The request body has not been logged because it exceeds the maximum size of ',
+  SET_USER_ATTRIBUTES_ERROR_TYPE_MESSAGE:
+    'LCQ-RN: Expected key and value passed to setUserAttribute to be of type string',
+  REMOVE_USER_ATTRIBUTES_ERROR_TYPE_MESSAGE:
+    'LCQ-RN: Expected key and value passed to removeUserAttribute to be of type string',
+  DEFAULT_METRO_PORT: '8081',
+  LCQ_APM_TAG: 'LCQ-APM: ',
+  SWITCHED_TO_NATIVE_INTERCEPTION_MESSAGE:
+    'Android Plugin Detected. Switched to Native Interception.',
+  PLUGIN_NOT_INSTALLED_MESSAGE:
+    'Network Spans will not be captured as Android Plugin is not installed. Disabling Native Interception to minimize data loss.',
+  NATIVE_INTERCEPTION_DISABLED_MESSAGE:
+    'Network Spans capture is disabled by Luciq. Disabling native interception to avoid data loss.',
+};
+
+export default LuciqConstants;