@revenium/perplexity 2.0.4 → 2.0.6

package/CHANGELOG.md

@@ -1,98 +1,113 @@
-# Changelog
-
-All notable changes to this project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [Unreleased]
-
-## [2.0.4] - 2025-11-07
-
-### Changed
-- Aligned package.json files array with template standards (use dist/ and examples/ wildcards)
-- Updated documentation badge format to match template standards
-- Improved README header with consistent badge styling
-
-### Fixed
-- Removed dist/ build artifacts from version control
-- Added dist/ to .gitignore to prevent future commits of build artifacts
-- Updated API URL to api.revenium.ai in examples/README.md
-
-### Added
-
-- New `getting_started.ts` example for quick onboarding
-- New `advanced-features.ts` example with streaming and metadata
-- Comprehensive metadata fields documentation
-- Support for new Perplexity models (sonar-reasoning-pro, sonar-deep-research)
-
-### Changed
-
-- Updated model definitions to current Perplexity API
-- Improved example scripts in package.json
-
-### Fixed
-
-- Corrected metadata field names throughout documentation
-- Added TypeScript support for subscriptionId and responseQualityScore fields
-- Removed hardcoded credentials from all documentation examples
-- Corrected Revenium platform URLs (app.revenium.ai)
-
-## [2.0.3] - 2025-10-21
-
-### Changed
-
-- Enhanced package.json with examples in files array
-- Added community health files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md)
-- Updated .gitignore with security report patterns (including package-lock.json)
-- Added CHANGELOG.md for version tracking
-- Added engines field for Node.js version requirements
-
-## [2.0.2] - 2025-10-17
-
-### Changed
-
-- Documentation improvements with absolute path references
-
-## [2.0.1] - 2025-10-09
-
-### Changed
-
-- Internal updates and improvements
-
-## [2.0.0] - 2025-10-09
-
-### Added
-
-- Complete code restructuring with core/ directory organization
-- Dual package exports (ESM + CommonJS) support
-- TypeScript declaration maps for better debugging
-- Enhanced build system with separate CJS, ESM, and types builds
-- New examples structure (basic.ts, chat.ts, streaming.ts, metadata.ts)
-
-### Changed
-
-- Restructured src/ directory with core/config, core/tracking, core/wrapper
-- Updated examples to use new structure
-- Enhanced README with comprehensive documentation
-
-## [1.0.0] - 2025-09-23
-
-### Added
-
-- Initial release of Perplexity AI middleware
-- Automatic token counting and usage tracking
-- Support for all Perplexity models
-- Streaming support with automatic tracking
-- Custom metadata integration
-- TypeScript support with full type safety
-- Multiple client options
-- Comprehensive error handling
-- Background processing for non-blocking tracking
-- Debug logging support
-
-[2.0.3]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.3
-[2.0.2]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.2
-[2.0.1]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.1
-[2.0.0]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.0
-[1.0.0]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v1.0.0
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [3.0.0] - 2025-11-08
+
+### Added
+
+- Initialize()/GetClient() pattern
+- Configure() function for manual configuration
+- IsInitialized() function to check initialization state
+- Reset() function for testing scenarios
+- Automatic .env file loading via dotenv
+- Complete modular architecture with core/ directory structure
+- New examples: basic.ts, metadata.ts, advanced.ts, stream.ts (renamed from streaming.ts)
+- COST_LIMIT and COMPLETION_LIMIT stop reasons to mapper (per API spec)
+- Support for all 7 operationType enum values (CHAT, GENERATE, EMBED, CLASSIFY, SUMMARIZE, TRANSLATE, OTHER)
+
+### Changed
+
+- **BREAKING:** Complete API redesign to pattern (Initialize/GetClient)
+- **BREAKING:** Removed old initialization functions (initializeReveniumFromEnv, initializePerplexityFromEnv)
+- **BREAKING:** Removed old wrapper functions (createChatCompletion, createStreamingChatCompletion)
+- **BREAKING:** responseQualityScore now uses 0.0-1.0 scale (was 0-100) per updated API specification
+- **API Compliance:** provider value changed from 'PERPLEXITY' to 'Perplexity' (proper casing per spec)
+- **API Compliance:** modelSource changed to 'PERPLEXITY' for consistency
+- **API Compliance:** middlewareSource changed from 'nodejs' to 'revenium-perplexity-node' per spec format
+- **API Compliance:** cacheCreationTokenCount now undefined (not 0) when provider doesn't report
+- **API Compliance:** cacheReadTokenCount now uses ?? operator (not ||) to preserve 0 values
+- **API Compliance:** timeToFirstToken now undefined (not hardcoded) until real TTFB tracking implemented
+- Restructured src/ with modular core/client, core/config, core/middleware, core/providers, core/tracking
+- Email addresses now masked in debug logs for PII protection
+- All examples updated to use 0.0-1.0 scale for responseQualityScore
+- Removed hardcoded model lists - middleware now accepts any model name
+
+### Fixed
+
+- Removed broken file references from examples documentation
+- Removed non-existent config options from documentation (apiTimeout, failSilent, maxRetries)
+- config.debug property now properly enables debug logging
+- Updated OpenAI version requirement to match peer dependency (v5.0.0+)
+- Removed taskId field from all files (field does not exist in API spec)
+- Added CANCELLED stop reason to mapper for completeness
+- validateMetadata now checks 0.0-1.0 scale for responseQualityScore
+- Fallback provider detection now uses 'Perplexity' not 'PERPLEXITY' (proper casing)
+- reasoningTokenCount now optional (undefined when not reported, per spec)
+
+## [2.0.4] - 2025-10-21
+
+### Changed
+
+- Enhanced package.json with examples in files array
+- Added community health files (CODE_OF_CONDUCT.md, CONTRIBUTING.md, SECURITY.md)
+- Updated .gitignore with security report patterns
+- Added engines field for Node.js version requirements
+
+## [2.0.3] - 2025-10-17
+
+### Changed
+
+- Documentation improvements with absolute path references
+
+## [2.0.2] - 2025-10-09
+
+### Changed
+
+- Internal updates and improvements
+
+## [2.0.1] - 2025-10-09
+
+### Changed
+
+- Bug fixes and stability improvements
+
+## [2.0.0] - 2025-10-09
+
+### Added
+
+- Complete code restructuring with core/ directory organization
+- Dual package exports (ESM + CommonJS) support
+- TypeScript declaration maps for better debugging
+- Enhanced build system with separate CJS, ESM, and types builds
+
+### Changed
+
+- Restructured src/ directory with core/config, core/tracking, core/wrapper
+- Enhanced README with comprehensive documentation
+
+## [1.0.0] - 2025-09-23
+
+### Added
+
+- Initial release of Perplexity AI middleware
+- Automatic token counting and usage tracking
+- Streaming support with automatic tracking
+- Custom metadata integration
+- TypeScript support with full type safety
+- Comprehensive error handling
+- Background processing for non-blocking tracking
+- Debug logging support
+
+[3.0.0]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v3.0.0
+[2.0.4]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.4
+[2.0.3]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.3
+[2.0.2]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.2
+[2.0.1]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.1
+[2.0.0]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v2.0.0
+[1.0.0]: https://github.com/revenium/revenium-middleware-perplexity-node/releases/tag/v1.0.0

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Revenium
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2025 Revenium
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.