reporting-lib/README.md

A comprehensive monitoring and reporting library for web applications

# reporting-lib

A comprehensive monitoring and reporting library for web applications. This library provides error tracking, performance monitoring, and API request data collection capabilities.

## Features

- **Error Monitoring**: Automatic error capture and reporting
- **Performance Monitoring**: Track page load times and route changes
- **API Monitoring**: Monitor remote API requests and responses
- **Configurable**: Easy to configure and customize monitoring behavior

## Installation

```bash
npm install reporting-lib
# or
yarn add reporting-lib
# or
pnpm add reporting-lib
```

## Usage

### Basic Setup

```javascript
import monitor from 'reporting-lib';

// Initialize the monitoring system
monitor.init({
  // Your configuration options here
  reportUrl: 'https://your-api.com/collect',
  source: 'web',
  userId: 'user123',
  trackerAll: true,
  version: '1.0.0'
});
```

### Configuration Options

The `init` method accepts the following configuration options:

- `reportUrl`: URL where monitoring data will be sent (default: 'http://localhost:3001/report/actions')
- `source`: Platform identifier (default: 'mbp')
- `userId`: User identifier (default: '')
- `trackerAll`: Whether to enable full tracking (default: false)
- `version`: Version string for the application (optional)

### Example

```javascript
import monitor from 'reporting-lib';

monitor.init({
  reportUrl: 'https://analytics.myapp.com/events',
  source: 'web',
  userId: 'user123',
  trackerAll: true,
  version: '1.0.0'
});
```

## API Reference

### `monitor.init(options)`

Initializes the monitoring system with the specified configuration.

## Development

```bash
# Install dependencies
pnpm install

# Build the project
pnpm build

# Watch mode for development
pnpm dev

# Lint the code
pnpm lint
```

## License

MIT