Mobile Invue Core SDK (React Native)

A high-performance, robust logging library for React Native applications that require reliable telemetry. Built on the New Architecture (TurboModules), this SDK ensures logs survive app crashes and network issues via local persistence and smart background uploads.

Key Features

• Durability: Logs are persisted to local .jsonl files immediately.
• Performance: Built as a TurboModule for synchronous-like efficiency.
• Smart Uploads: Supports background scheduled syncing (via WorkManager/BackgroundTasks) and immediate flushes.
• Centralized Registry: Acts as a central logging bridge for other native Invue SDKs (e.g., LiveLock).
• Observability: Emits native events for monitoring upload health and sync status.

Documentation

For detailed information on architecture, API reference, and platform-specific implementation status (including iOS bridge requirements), please refer to the:

👉 Detailed SDK Working and Usage Guide

Installation

npm install @invue/mobile-invue-core-sdk-rn

Quick Start

1. Configure the SDK

Initialize the logger at the root of your application:

import { configure } from '@invue/mobile-invue-core-sdk-rn';

await configure({
  endpointUrl: 'https://api.yourdomain.com/logs',
  minLevel: 'info',
  enableConsole: true,
  enableFileLogging: true,
  uploadIntervalSeconds: 300, // Sync every 5 minutes
});

2. Log Events

import { log } from '@invue/mobile-invue-core-sdk-rn';

// Basic logging
log('info', 'Auth', 'User logged in');

// Logging with metadata
log('error', 'Network', 'API Call Failed', { 
  statusCode: 500, 
  endpoint: '/user/profile' 
});

3. Manual Sync

import { flush, triggerUpload } from '@invue/mobile-invue-core-sdk-rn';

await flush();         // Force write buffer to disk
await triggerUpload(); // Initiate immediate upload

Example App

The repository includes an example app that demonstrates all SDK features, including a mock server for testing log uploads locally.

Contributing

Please see our Contributing Guide for development workflow and commit conventions.

License

MIT