instabug-reactnative/src/models/Report.ts

React Native plugin for integrating the Instabug SDK

import { Platform } from 'react-native';

import { NativeInstabug } from '../native/NativeInstabug';

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 instabugLogs: LogInfo[] = [],
    public userAttributes: Record<string, string> = {},
    public fileAttachments: FileAttachmentInfo[] = [],
  ) {}

  /**
   * Append a tag to the report to be sent.
   * @param tag
   */
  appendTag(tag: string) {
    NativeInstabug.appendTagToReport(tag);
    this.tags = [...this.tags, tag];
  }

  /**
   * Append a console log to the report to be sent.
   * @param consoleLog
   */
  appendConsoleLog(consoleLog: string) {
    NativeInstabug.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) {
    NativeInstabug.setUserAttributeToReport(key, value);
    this.userAttributes[key] = value;
  }

  /**
   * Attach debug log to the report to be sent.
   * @param log
   */
  logDebug(log: string) {
    NativeInstabug.logDebugToReport(log);
    this.instabugLogs = [...this.instabugLogs, { log: log, type: 'debug' }];
  }

  /**
   * Attach verbose log to the report to be sent.
   * @param log
   */
  logVerbose(log: string) {
    NativeInstabug.logVerboseToReport(log);
    this.instabugLogs = [...this.instabugLogs, { log: log, type: 'verbose' }];
  }

  /**
   * Attach warn log to the report to be sent.
   * @param log
   */
  logWarn(log: string) {
    NativeInstabug.logWarnToReport(log);
    this.instabugLogs = [...this.instabugLogs, { log: log, type: 'warn' }];
  }

  /**
   * Attach error log to the report to be sent.
   * @param log
   */
  logError(log: string) {
    NativeInstabug.logErrorToReport(log);
    this.instabugLogs = [...this.instabugLogs, { log: log, type: 'error' }];
  }

  /**
   * Attach info log to the report to be sent.
   * @param log
   */
  logInfo(log: string) {
    NativeInstabug.logInfoToReport(log);
    this.instabugLogs = [...this.instabugLogs, { 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') {
      NativeInstabug.addFileAttachmentWithURLToReport(url);
    } else {
      NativeInstabug.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') {
      NativeInstabug.addFileAttachmentWithDataToReport(data);
    } else {
      NativeInstabug.addFileAttachmentWithDataToReport(data, fileName);
    }
    this.fileAttachments = [...this.fileAttachments, { file: data, type: 'data' }];
  }
}