Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 31 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,35 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## [Unreleased]

## [1.0.0] - 2026-01-25

### Added

- **Observability module** (`src/observability.ts`) for production error monitoring:
- `generateFingerprint()` - Create unique error fingerprints for deduplication
- `toLogEntry()` - Convert errors to structured log entries (pino/winston/bunyan compatible)
- `toOtelAttributes()` - Generate OpenTelemetry-compatible span attributes
- `recordError()` - Helper for recording errors on OTel spans with proper status codes
- **Framework integration examples**:
- Express middleware integration
- Hono middleware integration
- GraphQL error handling
- React error boundaries
- tRPC error handling
- Zod validation integration
- Logging integration patterns

### Changed

- **API is now stable** - This is the first stable release following semantic versioning
- Package metadata improved with proper `repository` object format and `bugs` field

### Security

- Verified no prototype pollution vulnerabilities (uses `deepmerge-ts`)
- Safe handling of untrusted input in `ErrorX.from()` (safe property access patterns)
- Metadata serialization uses `safe-stringify` for circular reference handling

## [0.6.0] - 2026-01-20

### Added
Expand Down Expand Up @@ -205,7 +234,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Comprehensive test suite
- Initial documentation

[Unreleased]: https://github.com/bombillazo/error-x/compare/v0.6.0...HEAD
[Unreleased]: https://github.com/bombillazo/error-x/compare/v1.0.0...HEAD
[1.0.0]: https://github.com/bombillazo/error-x/compare/v0.6.0...v1.0.0
[0.6.0]: https://github.com/bombillazo/error-x/compare/v0.5.1...v0.6.0
[0.5.1]: https://github.com/bombillazo/error-x/compare/v0.5.0...v0.5.1
[0.5.0]: https://github.com/bombillazo/error-x/compare/v0.4.6...v0.5.0
Expand Down
6 changes: 2 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,11 +46,9 @@ yarn add @bombillazo/error-x

This library uses modern JavaScript features and ES2022 APIs. For browser compatibility, ensure your build tool (e.g., Vite, webpack, esbuild) is configured to target ES2022 or transpile accordingly.

> [!WARNING]
> [!NOTE]
>
> This library is currently in pre-v1.0 development. Breaking changes may occur. We recommend pinning to specific versions and reviewing release notes when updating.
>
> Once we reach version 1.0, we plan to minimize API changes and follow semantic versioning.
> This library follows [Semantic Versioning](https://semver.org/). The API is now stable - breaking changes will only occur in major version updates.

## Quick Start

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@bombillazo/error-x",
"description": "A simple and consistent error handling library for TypeScript applications. Provides type-safe error handling with great DX, solving common pain points like unknown error types, lost stack traces, async error handling, and error serialization. Isomorphic and framework-agnostic.",
"version": "0.6.1",
"version": "1.0.0",
"author": "Hector Ayala <hran@bombillazo.com>",
"dependencies": {
"deepmerge-ts": "^7.1.5",
Expand Down