@luciq/react-native 18.0.0

package/cli/upload/uploadEasUpdatesSourcemaps.ts

@@ -0,0 +1,74 @@
+import fs from 'fs';
+import { uploadSourcemaps } from './uploadSourcemaps';
+import * as path from 'path';
+
+export interface UploadEasUpdatesSourcemapsOptions {
+  file: string;
+  token: string;
+  name: string;
+  code: string;
+  androidUpdateId?: string;
+  iosUpdateId?: string;
+  /**
+   * Disables logging to the console and prevents process exit on error.
+   *
+   * @default false
+   * */
+  silent?: boolean;
+}
+
+function getMapFile(folderPath: string): string | null {
+  try {
+    if (fs.existsSync(folderPath)) {
+      const files = fs.readdirSync(folderPath);
+      const mapFile = files.find((file) => file.endsWith('.map'));
+      if (!mapFile) {
+        return null;
+      }
+      return path.join(folderPath, mapFile);
+    }
+    return null;
+  } catch (err) {
+    console.error('Failed to read folder:', err);
+    return null;
+  }
+}
+
+/**
+ * Uploads JavaScript sourcemaps to Luciq.
+ *
+ * @param opts Options for the sourcemaps upload process.
+ * @returns A promise that resolves to a boolean indicating whether the upload was successful.
+ */
+export const UploadEasUpdatesSourcemaps = async (
+  opts: UploadEasUpdatesSourcemapsOptions,
+): Promise<boolean> => {
+  const jsFolderPath = path.join(opts.file, '_expo', 'static', 'js');
+
+  const androidFile = getMapFile(path.join(jsFolderPath, 'android'));
+  const iosFile = getMapFile(path.join(jsFolderPath, 'ios'));
+  if (androidFile && fs.existsSync(androidFile)) {
+    await uploadSourcemaps({
+      platform: 'android',
+      name: opts.name,
+      code: opts.code,
+      token: opts.token,
+      label: opts.androidUpdateId,
+      file: androidFile,
+      silent: opts.silent,
+    });
+  }
+
+  if (iosFile && fs.existsSync(iosFile)) {
+    await uploadSourcemaps({
+      platform: 'ios',
+      name: opts.name,
+      code: opts.code,
+      token: opts.token,
+      label: opts.iosUpdateId,
+      file: iosFile,
+      silent: opts.silent,
+    });
+  }
+  return true;
+};

package/cli/upload/uploadSoFiles.ts

@@ -0,0 +1,112 @@
+import axios from 'axios';
+import FormData from 'form-data';
+import fs from 'fs';
+
+export interface UploadSoFilesOptions {
+  arch: 'x86' | 'x86_64' | 'arm64-v8a' | 'armeabi-v7a';
+  file: string;
+  token: string;
+  name: string;
+  api_key: string;
+
+  /**
+   * Disables logging to the console and prevents process exit on error.
+   *
+   * @default false
+   * */
+  silent?: boolean;
+}
+
+/**
+ * Uploads NDK `.so` files to Luciq.
+ *
+ * @param opts Options for the `.so` files upload process.
+ * @returns A promise that resolves to a boolean indicating whether the upload was successful.
+ */
+export const uploadSoFiles = async (opts: UploadSoFilesOptions): Promise<boolean> => {
+  const fileName = opts.file;
+
+  const validFilePath = assert(
+    fileName != null,
+    'Failed to upload So Files: invalid file path',
+    opts.silent,
+  );
+
+  if (!validFilePath) {
+    return false;
+  }
+
+  const fileExists = assert(
+    fs.existsSync(fileName),
+    'Failed to upload So Files: File not found',
+    opts.silent,
+  );
+
+  if (!fileExists) {
+    return false;
+  }
+
+  const fileExt = fileName.split('.').pop();
+
+  const isZipFile = assert(
+    fileExt === 'zip',
+    'Failed to upload So Files: You can only upload ZIP files',
+    opts.silent,
+  );
+
+  if (!isZipFile) {
+    return false;
+  }
+
+  const fileBlob = fs.readFileSync(opts.file);
+
+  const form = new FormData();
+  form.append('app_version', opts.name);
+  form.append('so_file', fileBlob, fileName);
+  form.append('application_token', opts.token);
+  form.append('api_key', opts.api_key);
+  form.append('arch', opts.arch);
+
+  if (!opts.silent) {
+    console.log('Uploading So files...');
+  }
+
+  const uploadEndpoint = 'https://api.instabug.com/api/web/public/so_files';
+  try {
+    await axios.post(uploadEndpoint, form, {
+      headers: form.getHeaders(),
+    });
+
+    if (!opts.silent) {
+      console.log(
+        `Successfully uploaded So Files for version: ${opts.name} with arch ${opts.arch}`,
+      );
+    }
+
+    return true;
+  } catch (err) {
+    if (!opts.silent) {
+      console.error(
+        'Failed to upload So Files:',
+        axios.isAxiosError(err) ? err.response?.data : err,
+      );
+
+      process.exit(1);
+    }
+
+    return false;
+  }
+};
+
+export const assert = (condition: unknown, message: string, silent?: boolean): boolean => {
+  if (silent) {
+    return Boolean(condition);
+  }
+
+  if (!condition) {
+    console.error(message);
+    process.exit(1);
+  }
+
+  return true;
+};

package/cli/upload/uploadSourcemaps.ts

@@ -0,0 +1,73 @@
+import axios from 'axios';
+import FormData from 'form-data';
+import fs from 'fs';
+
+export interface UploadSourcemapsOptions {
+  platform: 'android' | 'ios';
+  file: string;
+  token: string;
+  name: string;
+  code: string;
+  label?: string;
+
+  /**
+   * Disables logging to the console and prevents process exit on error.
+   *
+   * @default false
+   * */
+  silent?: boolean;
+}
+
+/**
+ * Uploads JavaScript sourcemaps to Luciq.
+ *
+ * @param opts Options for the sourcemaps upload process.
+ * @returns A promise that resolves to a boolean indicating whether the upload was successful.
+ */
+export const uploadSourcemaps = async (opts: UploadSourcemapsOptions): Promise<boolean> => {
+  const fileName = `${opts.platform}-sourcemap.json`;
+  const fileBlob = fs.readFileSync(opts.file);
+
+  const version = {
+    code: opts.code,
+    name: opts.name,
+    codepush: opts.label,
+  };
+
+  const form = new FormData();
+  form.append('app_version', JSON.stringify(version));
+  form.append('symbols_file', fileBlob, fileName);
+  form.append('application_token', opts.token);
+  form.append('platform', 'react_native');
+  form.append('os', opts.platform);
+
+  if (!opts.silent) {
+    console.log('Uploading Source map file...');
+  }
+
+  try {
+    const response = await axios.post('https://api.instabug.com/api/sdk/v3/symbols_files', form, {
+      headers: form.getHeaders(),
+    });
+
+    const appVersion = version.codepush
+      ? `${version.name} (${version.code})+codepush:${version.codepush}`
+      : `${version.name} (${version.code})`;
+
+    if (!opts.silent) {
+      console.log(`Successfully uploaded Source maps for version: ${appVersion}`);
+      console.log(response.data);
+    }
+
+    return true;
+  } catch (err) {
+    if (!opts.silent) {
+      console.error(
+        'Failed to upload source maps:',
+        axios.isAxiosError(err) ? err.response?.data : err,
+      );
+    }
+
+    return false;
+  }
+};

package/dangerfile.ts

@@ -0,0 +1,44 @@
+import collectCoverage, { ReportType } from '@luciq/danger-plugin-coverage';
+import { danger, fail, schedule, warn } from 'danger';
+
+const hasSourceChanges = danger.git.modified_files.some((file) => file.startsWith('src/'));
+const declaredTrivial =
+  !hasSourceChanges || danger.github.issue.labels.some((label) => label.name === 'trivial');
+
+// Make sure PR has a description.
+async function hasDescription() {
+  const linesOfCode = (await danger.git.linesOfCode()) ?? 0;
+  const hasNoDiscription = danger.github.pr.body.includes('> Description goes here');
+  if (hasNoDiscription && linesOfCode > 10) {
+    fail('Please provide a summary of the changes in the pull request description.');
+  }
+
+  if (!danger.git.modified_files.includes('CHANGELOG.md') && !declaredTrivial) {
+    warn(
+      'You have not included a CHANGELOG entry! \nYou can find it at [CHANGELOG.md](https://github.com/luciqai/luciq-reactnative-sdk/blob/master/CHANGELOG.md).',
+    );
+  }
+}
+
+schedule(hasDescription());
+
+collectCoverage([
+  {
+    label: 'JavaScript',
+    type: ReportType.LCOV,
+    filePath: 'coverage/lcov.info',
+    threshold: 90,
+  },
+  {
+    label: 'Android',
+    type: ReportType.JACOCO,
+    filePath: 'coverage/jacocoTestReport.xml',
+    threshold: 40,
+  },
+  {
+    label: 'iOS',
+    type: ReportType.XCODE,
+    filePath: 'coverage/xcode.json',
+    threshold: 30,
+  },
+]);

package/dist/index.d.ts

@@ -0,0 +1,19 @@
+import type { LuciqConfig } from './models/LuciqConfig';
+import Report from './models/Report';
+import type { ThemeConfig } from './models/ThemeConfig';
+import * as APM from './modules/APM';
+import * as BugReporting from './modules/BugReporting';
+import * as CrashReporting from './modules/CrashReporting';
+import * as FeatureRequests from './modules/FeatureRequests';
+import * as Luciq from './modules/Luciq';
+import * as NetworkLogger from './modules/NetworkLogger';
+import type { NetworkData, NetworkDataObfuscationHandler } from './modules/NetworkLogger';
+import * as Replies from './modules/Replies';
+import type { Survey } from './modules/Surveys';
+import * as Surveys from './modules/Surveys';
+import * as SessionReplay from './modules/SessionReplay';
+import type { SessionMetadata } from './models/SessionMetadata';
+export * from './utils/Enums';
+export { Report, APM, BugReporting, CrashReporting, FeatureRequests, NetworkLogger, SessionReplay, Replies, Surveys, };
+export type { LuciqConfig, Survey, NetworkData, NetworkDataObfuscationHandler, SessionMetadata, ThemeConfig, };
+export default Luciq;

package/dist/index.js

@@ -0,0 +1,14 @@
+import Report from './models/Report';
+// Modules
+import * as APM from './modules/APM';
+import * as BugReporting from './modules/BugReporting';
+import * as CrashReporting from './modules/CrashReporting';
+import * as FeatureRequests from './modules/FeatureRequests';
+import * as Luciq from './modules/Luciq';
+import * as NetworkLogger from './modules/NetworkLogger';
+import * as Replies from './modules/Replies';
+import * as Surveys from './modules/Surveys';
+import * as SessionReplay from './modules/SessionReplay';
+export * from './utils/Enums';
+export { Report, APM, BugReporting, CrashReporting, FeatureRequests, NetworkLogger, SessionReplay, Replies, Surveys, };
+export default Luciq;

package/dist/models/FeatureFlag.d.ts

@@ -0,0 +1,11 @@
+export interface FeatureFlag {
+    /**
+     * the name of feature flag
+     */
+    name: string;
+    /**
+     * The variant of the feature flag.
+     * Leave it `undefined` for boolean (kill switch) feature flags.
+     */
+    variant?: string;
+}

package/dist/models/FeatureFlag.js

@@ -0,0 +1 @@
+export {};

package/dist/models/LuciqConfig.d.ts

@@ -0,0 +1,42 @@
+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/dist/models/LuciqConfig.js

@@ -0,0 +1 @@
+export {};

package/dist/models/NonFatalOptions.d.ts

@@ -0,0 +1,15 @@
+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/dist/models/NonFatalOptions.js

@@ -0,0 +1 @@
+export {};

package/dist/models/OverAirUpdate.d.ts

@@ -0,0 +1,12 @@
+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/dist/models/OverAirUpdate.js

@@ -0,0 +1 @@
+export {};

package/dist/models/Report.d.ts

@@ -0,0 +1,70 @@
+interface LogInfo {
+    log: string;
+    type: 'verbose' | 'debug' | 'warn' | 'info' | 'error';
+}
+interface FileAttachmentInfo {
+    file: string;
+    type: 'url' | 'data';
+}
+export default class Report {
+    tags: string[];
+    consoleLogs: string[];
+    luciqLogs: LogInfo[];
+    userAttributes: Record<string, string>;
+    fileAttachments: FileAttachmentInfo[];
+    constructor(tags?: string[], consoleLogs?: string[], luciqLogs?: LogInfo[], userAttributes?: Record<string, string>, fileAttachments?: FileAttachmentInfo[]);
+    /**
+     * Append a tag to the report to be sent.
+     * @param tag
+     */
+    appendTag(tag: string): void;
+    /**
+     * Append a console log to the report to be sent.
+     * @param consoleLog
+     */
+    appendConsoleLog(consoleLog: string): void;
+    /**
+     * Add a user attribute with key and value to the report to be sent.
+     * @param key
+     * @param value
+     */
+    setUserAttribute(key: string, value: string): void;
+    /**
+     * Attach debug log to the report to be sent.
+     * @param log
+     */
+    logDebug(log: string): void;
+    /**
+     * Attach verbose log to the report to be sent.
+     * @param log
+     */
+    logVerbose(log: string): void;
+    /**
+     * Attach warn log to the report to be sent.
+     * @param log
+     */
+    logWarn(log: string): void;
+    /**
+     * Attach error log to the report to be sent.
+     * @param log
+     */
+    logError(log: string): void;
+    /**
+     * Attach info log to the report to be sent.
+     * @param log
+     */
+    logInfo(log: string): void;
+    /**
+     * Attach a file to the report to be sent.
+     * @param url
+     * @param fileName
+     */
+    addFileAttachmentWithUrl(url: string, fileName: string): void;
+    /**
+     * Attach a file to the report to be sent.
+     * @param data
+     * @param fileName
+     */
+    addFileAttachmentWithData(data: string, fileName: string): void;
+}
+export {};

package/dist/models/Report.js

@@ -0,0 +1,109 @@
+import { Platform } from 'react-native';
+import { NativeLuciq } from '../native/NativeLuciq';
+export default class Report {
+    tags;
+    consoleLogs;
+    luciqLogs;
+    userAttributes;
+    fileAttachments;
+    constructor(tags = [], consoleLogs = [], luciqLogs = [], userAttributes = {}, fileAttachments = []) {
+        this.tags = tags;
+        this.consoleLogs = consoleLogs;
+        this.luciqLogs = luciqLogs;
+        this.userAttributes = userAttributes;
+        this.fileAttachments = fileAttachments;
+    }
+    /**
+     * Append a tag to the report to be sent.
+     * @param tag
+     */
+    appendTag(tag) {
+        NativeLuciq.appendTagToReport(tag);
+        this.tags = [...this.tags, tag];
+    }
+    /**
+     * Append a console log to the report to be sent.
+     * @param consoleLog
+     */
+    appendConsoleLog(consoleLog) {
+        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, value) {
+        NativeLuciq.setUserAttributeToReport(key, value);
+        this.userAttributes[key] = value;
+    }
+    /**
+     * Attach debug log to the report to be sent.
+     * @param log
+     */
+    logDebug(log) {
+        NativeLuciq.logDebugToReport(log);
+        this.luciqLogs = [...this.luciqLogs, { log: log, type: 'debug' }];
+    }
+    /**
+     * Attach verbose log to the report to be sent.
+     * @param log
+     */
+    logVerbose(log) {
+        NativeLuciq.logVerboseToReport(log);
+        this.luciqLogs = [...this.luciqLogs, { log: log, type: 'verbose' }];
+    }
+    /**
+     * Attach warn log to the report to be sent.
+     * @param log
+     */
+    logWarn(log) {
+        NativeLuciq.logWarnToReport(log);
+        this.luciqLogs = [...this.luciqLogs, { log: log, type: 'warn' }];
+    }
+    /**
+     * Attach error log to the report to be sent.
+     * @param log
+     */
+    logError(log) {
+        NativeLuciq.logErrorToReport(log);
+        this.luciqLogs = [...this.luciqLogs, { log: log, type: 'error' }];
+    }
+    /**
+     * Attach info log to the report to be sent.
+     * @param log
+     */
+    logInfo(log) {
+        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, fileName) {
+        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, fileName) {
+        if (Platform.OS === 'ios') {
+            NativeLuciq.addFileAttachmentWithDataToReport(data);
+        }
+        else {
+            NativeLuciq.addFileAttachmentWithDataToReport(data, fileName);
+        }
+        this.fileAttachments = [...this.fileAttachments, { file: data, type: 'data' }];
+    }
+}

package/dist/models/ReproConfig.d.ts

@@ -0,0 +1,27 @@
+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/dist/models/ReproConfig.js

@@ -0,0 +1 @@
+export {};