Skip to content

v1.3.0 - HTTP Agent Support for Custom SSL Configuration

Latest

Choose a tag to compare

@iraycd iraycd released this 16 Aug 04:31
· 3 commits to main since this release

πŸš€ New Features

HTTP Agent Configuration Support

  • ✨ Custom HTTPS Agent Support: Configure custom HTTP/HTTPS agents for advanced network configurations
  • πŸ”’ SSL Certificate Management: Support for custom CA certificates and SSL options
  • πŸ”„ Connection Pooling: Configure keep-alive and connection pooling settings
  • 🏒 Corporate Environment Ready: Perfect for environments with custom SSL requirements

Usage Example

import { OdooClient } from 'odoo-xmlrpc-ts';
import https from 'node:https';

const httpsAgent = new https.Agent({
  ca: fs.readFileSync('/path/to/ca-certificate.pem'),
  keepAlive: true,
  maxSockets: 10,
});

const client = new OdooClient({
  url: 'https://your-odoo-instance.com',
  db: 'your-database',
  username: 'admin',
  password: 'admin',
  agent: httpsAgent, // πŸ†• New agent configuration
});

πŸ“š Documentation Improvements

  • πŸ“– HTTPS Deployment Guide: Added comprehensive notes about Odoo's reverse proxy requirements
  • πŸ”— Protocol Clarification: Better explanation of XML-RPC vs JSON-RPC endpoints
  • πŸ’‘ Practical Examples: Real-world usage scenarios and deployment considerations
  • ⚑ Quick Reference: Enhanced code comments and configuration examples

πŸ”§ Technical Details

  • Compatibility: Works with existing Odoo deployments behind reverse proxies (Nginx/Apache)
  • Security: Enables proper SSL verification for corporate environments
  • Performance: Supports connection pooling and keep-alive configurations
  • Type Safety: Full TypeScript support for agent configuration

πŸ“¦ What's Changed

  • feat: support custom HTTP agents for XML-RPC connections by @villalobos-05 in #11
  • docs: improve HTTP agent documentation with HTTPS deployment context

πŸ™ Contributors

Thanks to @villalobos-05 for implementing the HTTP agent feature!

Full Changelog: v1.2.1...v1.3.0