@ihyeon/browser-error-log-protocol

English | 한국어

Versioned TypeScript contracts for Browser Error Log SDKs, collectors, and viewers. Use them when connecting the SDK to your own backend or implementing a viewer data source.

Install directly when implementing your own collector or viewer; @ihyeon/browser-error-log also brings this package in as a dependency:

npm install @ihyeon/browser-error-log-protocol

For local source-checkout development, use Node.js 24, npm ci, and npm run check:package, then install output/packages/ihyeon-browser-error-log-protocol-0.1.10.tgz by absolute path. See the SDK guide.

Event and query contracts

import {
  SCHEMA_VERSION,
  EVENT_LABELS,
  type ErrorEventRecord,
  type EventBatch,
  type EventFilter,
  type EventPage,
  type EventDataSource,
} from '@ihyeon/browser-error-log-protocol';

function makeBatch(events: ErrorEventRecord[]): EventBatch {
  return { schemaVersion: SCHEMA_VERSION, events };
}

• ErrorEventRecord describes a v1 event, including project, environment, release, event ID, occurrence time, type, message, page, runtime, and optional stack, network, and custom context fields.
• EventBatch wraps events as { schemaVersion: 1, events: [...] } for ingestion.
• EventFilter supports project, environment, type, text query, time range, cursor, and limit.
• EventPage returns events and an optional nextCursor.
• EventDataSource exposes listEvents(filter, signal?) and getEvent(project, eventId, signal?) for the viewer.
• EVENT_LABELS provides English display labels. The underlying event type identifiers stay unchanged.

These are types and constants, not a runtime validator, database, or HTTP server. Treat all incoming data as untrusted and validate it at your collector. Scope deduplication and event lookup by (project, eventId); different projects may use the same event ID. Use ISO timestamps and distinguish client-supplied occurredAt from server-owned receivedAt.

The integration contract describes the HTTP API; examples/micro-server implements a small self-hosted collector with persistent SQLite or log-only JSONL storage. The in-memory development collector is only a demo.

Hosting and costs

Infrastructure is not included. Hosting, servers, databases, storage, bandwidth, domains, backups, and third-party services are selected and paid for by each operator. Any charges are billed independently by their providers, not by this project or its maintainers.