@luciq/react-native 18.0.0

package/src/models/LuciqConfig.ts

@@ -0,0 +1,48 @@
+import type { InvocationEvent, LogLevel, NetworkInterceptionMode } from '../utils/Enums';
+import type { OverAirUpdate } from './OverAirUpdate';
+
+export interface LuciqConfig {
+  /**
+   * The token that identifies the app. You can find it on your dashboard.
+   */
+  token: string;
+  /**
+   * An array of events that invoke the SDK's UI.
+   */
+  invocationEvents: InvocationEvent[];
+  /**
+   * An optional LogLevel to indicate the verbosity of SDK logs. Default is Error.
+   */
+  debugLogsLevel?: LogLevel;
+
+  /**
+   * An optional code push version to be used for all reports.
+   */
+  codePushVersion?: string;
+
+  /**
+   * An optional flag to override SDK screenshot security behavior.
+   */
+  ignoreAndroidSecureFlag?: boolean;
+
+  /**
+   * An optional current App variant to be used for filtering data.
+   */
+  appVariant?: string;
+
+  /**
+   * An optional network interception mode, this determines whether network interception
+   * is done in the JavaScript side or in the native Android and iOS SDK side.
+   *
+   * When set to `NetworkInterceptionMode.native`, configuring network logging
+   * should be done through native code not JavaScript (e.g. network request obfuscation).
+   *
+   * @default NetworkInterceptionMode.javascript
+   */
+  networkInterceptionMode?: NetworkInterceptionMode;
+
+  /**
+   * An optional over air service update version to be used for all reports.
+   */
+  overAirVersion?: OverAirUpdate;
+}

package/src/models/NonFatalOptions.ts

@@ -0,0 +1,16 @@
+import type { NonFatalErrorLevel } from '../utils/Enums';
+
+export interface NonFatalOptions {
+  /**
+   * An Optional extra user attributes attached to the crash
+   * */
+  userAttributes?: Record<string, string>;
+  /**
+   * An Optional key used to customize how crashes are grouped together
+   * */
+  fingerprint?: string;
+  /**
+   * An Optional different severity levels for errors
+   * */
+  level?: NonFatalErrorLevel;
+}

package/src/models/OverAirUpdate.ts

@@ -0,0 +1,14 @@
+import type { OverAirUpdateServices } from '../utils/Enums';
+export interface OverAirUpdate {
+  /**
+   * the name of OTA service
+   * e.g. `codePush` or `expo`
+   */
+  service: OverAirUpdateServices;
+
+  /**
+   * The version or UUID of the OTA service
+   */
+
+  version: string;
+}

package/src/models/Report.ts

@@ -0,0 +1,124 @@
+import { Platform } from 'react-native';
+
+import { NativeLuciq } from '../native/NativeLuciq';
+
+interface LogInfo {
+  log: string;
+  type: 'verbose' | 'debug' | 'warn' | 'info' | 'error';
+}
+
+interface FileAttachmentInfo {
+  file: string;
+  type: 'url' | 'data';
+}
+
+export default class Report {
+  constructor(
+    public tags: string[] = [],
+    public consoleLogs: string[] = [],
+    public luciqLogs: LogInfo[] = [],
+    public userAttributes: Record<string, string> = {},
+    public fileAttachments: FileAttachmentInfo[] = [],
+  ) {}
+
+  /**
+   * Append a tag to the report to be sent.
+   * @param tag
+   */
+  appendTag(tag: string) {
+    NativeLuciq.appendTagToReport(tag);
+    this.tags = [...this.tags, tag];
+  }
+
+  /**
+   * Append a console log to the report to be sent.
+   * @param consoleLog
+   */
+  appendConsoleLog(consoleLog: string) {
+    NativeLuciq.appendConsoleLogToReport(consoleLog);
+    this.consoleLogs = [...this.consoleLogs, consoleLog];
+  }
+
+  /**
+   * Add a user attribute with key and value to the report to be sent.
+   * @param key
+   * @param value
+   */
+  setUserAttribute(key: string, value: string) {
+    NativeLuciq.setUserAttributeToReport(key, value);
+    this.userAttributes[key] = value;
+  }
+
+  /**
+   * Attach debug log to the report to be sent.
+   * @param log
+   */
+  logDebug(log: string) {
+    NativeLuciq.logDebugToReport(log);
+    this.luciqLogs = [...this.luciqLogs, { log: log, type: 'debug' }];
+  }
+
+  /**
+   * Attach verbose log to the report to be sent.
+   * @param log
+   */
+  logVerbose(log: string) {
+    NativeLuciq.logVerboseToReport(log);
+    this.luciqLogs = [...this.luciqLogs, { log: log, type: 'verbose' }];
+  }
+
+  /**
+   * Attach warn log to the report to be sent.
+   * @param log
+   */
+  logWarn(log: string) {
+    NativeLuciq.logWarnToReport(log);
+    this.luciqLogs = [...this.luciqLogs, { log: log, type: 'warn' }];
+  }
+
+  /**
+   * Attach error log to the report to be sent.
+   * @param log
+   */
+  logError(log: string) {
+    NativeLuciq.logErrorToReport(log);
+    this.luciqLogs = [...this.luciqLogs, { log: log, type: 'error' }];
+  }
+
+  /**
+   * Attach info log to the report to be sent.
+   * @param log
+   */
+  logInfo(log: string) {
+    NativeLuciq.logInfoToReport(log);
+    this.luciqLogs = [...this.luciqLogs, { log: log, type: 'info' }];
+  }
+
+  /**
+   * Attach a file to the report to be sent.
+   * @param url
+   * @param fileName
+   */
+  addFileAttachmentWithUrl(url: string, fileName: string) {
+    if (Platform.OS === 'ios') {
+      NativeLuciq.addFileAttachmentWithURLToReport(url);
+    } else {
+      NativeLuciq.addFileAttachmentWithURLToReport(url, fileName);
+    }
+    this.fileAttachments = [...this.fileAttachments, { file: url, type: 'url' }];
+  }
+
+  /**
+   * Attach a file to the report to be sent.
+   * @param data
+   * @param fileName
+   */
+  addFileAttachmentWithData(data: string, fileName: string) {
+    if (Platform.OS === 'ios') {
+      NativeLuciq.addFileAttachmentWithDataToReport(data);
+    } else {
+      NativeLuciq.addFileAttachmentWithDataToReport(data, fileName);
+    }
+    this.fileAttachments = [...this.fileAttachments, { file: data, type: 'data' }];
+  }
+}

package/src/models/ReproConfig.ts

@@ -0,0 +1,31 @@
+import type { ReproStepsMode } from '../utils/Enums';
+
+export interface ReproConfig {
+  /**
+   * Repro steps mode for Bug Reporting.
+   *
+   * @default ReproStepsMode.enabled
+   */
+  bug?: ReproStepsMode;
+
+  /**
+   * Repro steps mode for Crash Reporting.
+   *
+   * @default ReproStepsMode.enabledWithNoScreenshots
+   */
+  crash?: ReproStepsMode;
+
+  /**
+   * Repro steps mode for Session Replay.
+   *
+   * @default ReproStepsMode.enabled
+   */
+  sessionReplay?: ReproStepsMode;
+
+  /**
+   * Repro steps mode for Bug Reporting, Crash Reporting, and Session Replay.
+   *
+   * When this is set, `bug`, `crash`, and `sessionReplay` will be ignored.
+   */
+  all?: ReproStepsMode;
+}

package/src/models/SessionMetadata.ts

@@ -0,0 +1,57 @@
+import type { LaunchType } from '../utils/Enums';
+
+/**
+ * network log item
+ */
+export interface NetworkLog {
+  url: string;
+  duration: number;
+  statusCode: number;
+}
+
+export interface SessionMetadata {
+  /**
+   * app version of the session
+   */
+  appVersion: string;
+  /**
+   * operating system of the session
+   */
+  OS: string;
+  /**
+   * mobile device model of the session
+   */
+  device: string;
+  /**
+   * session duration in seconds
+   */
+  sessionDurationInSeconds: number;
+  /**
+   * list of netwrok requests occurred during the session
+   */
+  networkLogs: NetworkLog[];
+  /**
+   * launch type of the session
+   */
+  launchType: LaunchType;
+  /**
+   * is an in-app review occurred in the previous session.
+   */
+  hasLinkToAppReview: boolean;
+  /**
+   * app launch duration
+   */
+  launchDuration: number;
+  /**
+   * number of bugs in the session (iOS only)
+   */
+  bugsCount?: number;
+  /**
+   * number of fetal crashes in the session (iOS only)
+   */
+  fatalCrashCount?: number;
+  /**
+   * number of out of memory crashes in the session (iOS only)
+   */
+  oomCrashCount?: number;
+}

package/src/models/ThemeConfig.ts

@@ -0,0 +1,34 @@
+export type ThemeConfig = {
+  // Colors
+  primaryColor?: string;
+  backgroundColor?: string;
+  titleTextColor?: string;
+  subtitleTextColor?: string;
+  primaryTextColor?: string;
+  secondaryTextColor?: string;
+  callToActionTextColor?: string;
+  headerBackgroundColor?: string;
+  footerBackgroundColor?: string;
+  rowBackgroundColor?: string;
+  selectedRowBackgroundColor?: string;
+  rowSeparatorColor?: string;
+
+  // Text Styles (Android only)
+  primaryTextStyle?: 'bold' | 'italic' | 'normal';
+  secondaryTextStyle?: 'bold' | 'italic' | 'normal';
+  titleTextStyle?: 'bold' | 'italic' | 'normal';
+  ctaTextStyle?: 'bold' | 'italic' | 'normal';
+
+  // Fonts
+  primaryFontPath?: string;
+  primaryFontAsset?: string;
+  secondaryFontPath?: string;
+  secondaryFontAsset?: string;
+  ctaFontPath?: string;
+  ctaFontAsset?: string;
+
+  // Legacy properties (deprecated)
+  primaryTextType?: string;
+  secondaryTextType?: string;
+  ctaTextType?: string;
+};

package/src/models/W3cExternalTraceAttributes.ts

@@ -0,0 +1,22 @@
+export type W3cExternalTraceAttributes = {
+  /**
+   * A key that determines if the traceparent header was found
+   */
+  isW3cHeaderFound: boolean | null;
+  /**
+   * A unique identifier for the trace generated by the SDK in case of no cought header found
+   */
+  partialId: number | null;
+  /**
+   * The start time of the network request
+   */
+  networkStartTimeInSeconds: number | null;
+  /**
+   * The traceparent header generated by the SDK
+   */
+  w3cGeneratedHeader: string | null;
+  /**
+   * The traceparent header received by the server
+   */
+  w3cCaughtHeader: string | null;
+};

package/src/modules/APM.ts

@@ -0,0 +1,117 @@
+import { Platform } from 'react-native';
+
+import { NativeAPM } from '../native/NativeAPM';
+import { NativeLuciq } from '../native/NativeLuciq';
+
+/**
+ * Enables or disables APM
+ * @param isEnabled
+ */
+export const setEnabled = (isEnabled: boolean) => {
+  NativeAPM.setEnabled(isEnabled);
+};
+
+/**
+ * If APM is enabled, Luciq SDK starts collecting data about the app launch time by default.
+ * This API is used to give user more control over this behavior.
+ * @param isEnabled
+ */
+export const setAppLaunchEnabled = (isEnabled: boolean) => {
+  NativeAPM.setAppLaunchEnabled(isEnabled);
+};
+
+/**
+ * To define when an app launch is complete,
+ * such as when it's intractable, use the end app launch API.
+ * You can then view this data with the automatic cold app launch.
+ */
+export const endAppLaunch = () => {
+  NativeAPM.endAppLaunch();
+};
+
+/**
+ * Enables or disables APM Network Metric
+ * @param isEnabled - a boolean indicates either iOS monitoring is enabled or disabled.
+ */
+export const setNetworkEnabledIOS = (isEnabled: boolean) => {
+  if (Platform.OS === 'ios') {
+    NativeLuciq.setNetworkLoggingEnabled(isEnabled);
+  }
+};
+
+/**
+ * Enables or disables APM UI Responsiveness tracking feature
+ * @param isEnabled
+ */
+export const setAutoUITraceEnabled = (isEnabled: boolean) => {
+  NativeAPM.setAutoUITraceEnabled(isEnabled);
+};
+
+/**
+ * Starts an AppFlow with the specified name.
+ *
+ * On starting two flows with the same name, the older flow will end with a force abandon end reason.
+ * The AppFlow name cannot exceed 150 characters; otherwise, it's truncated,
+ * leading and trailing whitespaces are also ignored.
+ *
+ * @param name - The name of the AppFlow. It cannot be an empty string or null.
+ *               A new AppFlow is started if APM is enabled, the feature is enabled,
+ *               and the Luciq SDK is initialized.
+ */
+export const startFlow = (name: string) => {
+  NativeAPM.startFlow(name);
+};
+
+/**
+ * Ends an AppFlow with the given name.
+ *
+ * @param name - The name of the AppFlow to end. It cannot be an empty string or null.
+ */
+export const endFlow = (name: string) => {
+  NativeAPM.endFlow(name);
+};
+
+/**
+ * Sets custom attributes for an AppFlow with a given name.
+ *
+ * Setting an attribute value to null will remove the corresponding key if it already exists.
+ * Attribute keys cannot exceed 30 characters and leading/trailing whitespaces are ignored.
+ * Empty strings or null for attribute keys are not accepted.
+ *
+ * Attribute values cannot exceed 60 characters and leading/trailing whitespaces are ignored.
+ * Empty strings for attribute values are not accepted, but null can be used to remove an attribute.
+ *
+ * If an AppFlow is ended, attributes will not be added and existing ones will not be updated.
+ *
+ * @param name - The name of the AppFlow. It cannot be an empty string or null.
+ * @param key - The key of the attribute. It cannot be an empty string or null.
+ * @param [value] - The value of the attribute. It cannot be an empty string. Use null to remove the attribute.
+ */
+
+export const setFlowAttribute = (name: string, key: string, value?: string | null) => {
+  NativeAPM.setFlowAttribute(name, key, value);
+};
+
+/**
+ * Initiates a UI trace with the specified name using a native module.
+ * @param {string} name - The `name` parameter in the `startUITrace` function is a string that
+ * represents the name of the UI trace that you want to start. This name is used to identify and track
+ * the specific UI trace within the application.
+ */
+export const startUITrace = (name: string) => {
+  NativeAPM.startUITrace(name);
+};
+
+/**
+ * Ends the currently running custom trace.
+ */
+export const endUITrace = () => {
+  NativeAPM.endUITrace();
+};
+
+/**
+ * Used for internal testing.
+ */
+export const _lcqSleep = () => {
+  NativeAPM.lcqSleep();
+};