From 0cb83451deb14c12d734329b26c1a72eba52d328 Mon Sep 17 00:00:00 2001 From: bombillazo Date: Sun, 25 Jan 2026 17:57:31 -0400 Subject: [PATCH] chore: release version 1.0.0 with stable API and enhanced observability features --- CHANGELOG.md | 32 +++++++++++++++++++++++++++++++- README.md | 6 ++---- package.json | 2 +- 3 files changed, 34 insertions(+), 6 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 1fcd30f..0b47e75 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -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 @@ -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 diff --git a/README.md b/README.md index 5213f70..0a83ba2 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/package.json b/package.json index cc6ee5c..6dc3f04 100644 --- a/package.json +++ b/package.json @@ -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 ", "dependencies": { "deepmerge-ts": "^7.1.5",