@revenium/openai 1.0.9 → 1.0.11

package/CHANGELOG.md

@@ -0,0 +1,78 @@
+# 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).
+
+## [1.0.11] - 2025-10-21
+
+### Added
+- Examples now included in npm package for offline access
+- New `examples/README.md` with comprehensive step-by-step guide
+- Step 4: Protect Your API Keys - Security best practices in main README
+- TypeScript and JavaScript examples for getting started
+
+### Changed
+- Removed internal QA environment references from documentation
+- Documentation standardized for public repository
+- Improved README structure with enhanced security guidance
+
+### Security
+- Added `.gitignore` best practices to protect API keys
+- Enhanced environment variable security documentation
+
+## [1.0.10] - 2025-10-17
+
+### Added
+- Support for OpenAI Responses API (SDK 5.8+)
+- New example files for Responses API with Azure and standard OpenAI
+- Enhanced TypeScript type definitions for Responses API
+
+### Changed
+- README documentation significantly expanded with step-by-step guides
+- Improved examples structure and organization
+- Package maintenance and stability improvements
+
+## [1.0.9] - 2025-10-16
+
+### Changed
+- Internal improvements and bug fixes
+- Enhanced error handling and logging
+
+## [1.0.8] - 2025-10-15
+
+### Added
+- Initial release of @revenium/openai scoped package
+- Migration from revenium-middleware-openai-node to @revenium/openai
+- Transparent OpenAI API usage tracking middleware
+- Support for streaming responses
+- Support for function/tool calling
+- Automatic metadata collection and forwarding
+- Azure OpenAI support with automatic detection
+- Full TypeScript support with native type integration
+- Zero configuration setup from environment variables
+
+### Changed
+- Package name migrated to scoped format (@revenium/openai)
+
+---
+
+## Package Migration Notice
+
+This package was previously published as `revenium-middleware-openai-node` up to v1.1.0.
+
+Starting with v1.0.8, the package has been migrated to the scoped format `@revenium/openai`.
+
+The old package has been deprecated with a notice directing users to the new scoped package.
+
+To upgrade:
+```bash
+npm uninstall revenium-middleware-openai-node
+npm install @revenium/openai
+```
+
+[1.0.11]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.11
+[1.0.10]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.10
+[1.0.9]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.9
+[1.0.8]: https://github.com/revenium/revenium-middleware-openai-node/releases/tag/v1.0.8

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2025 Revenium, Inc.
-
-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, Inc.
+
+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.