Skip to content

Latest commit

 

History

History
145 lines (120 loc) · 5.12 KB

CHANGELOG.md

File metadata and controls

145 lines (120 loc) · 5.12 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

0.9.0 - 2025-07-07

🎉 Initial Public Release

First public release of the unofficial ProxyCheck.io TypeScript SDK. This SDK provides a modern, type-safe interface for the ProxyCheck.io API with comprehensive error handling, automatic retries, and full TypeScript support.

Added

Core Features

  • Full API Coverage: Complete implementation of all ProxyCheck.io API endpoints
    • Check Service: IP address and email validation
    • Listing Service: Whitelist and blacklist management
    • Rules Service: Custom detection rules
    • Stats Service: Usage statistics and data export

TypeScript & JavaScript Support

  • Full TypeScript support with comprehensive type definitions
  • Dual module support (CommonJS and ESM)
  • Strict type safety with intelligent IntelliSense
  • Zod schema validation for all inputs

Error Handling & Reliability

  • Comprehensive error hierarchy with specific error types:
    • ProxyCheckError: Base error class
    • ProxyCheckAPIError: API-specific errors
    • ProxyCheckValidationError: Input validation errors
    • ProxyCheckRateLimitError: Rate limiting errors
    • ProxyCheckNetworkError: Network errors
    • ProxyCheckAuthenticationError: Authentication errors
    • ProxyCheckTimeoutError: Timeout errors
  • Automatic retry logic with exponential backoff
  • Built-in rate limit detection and handling

Developer Experience

  • Environment variable support for configuration
  • Comprehensive logging system with customizable output
  • Batch operations for efficient multiple IP/email checks
  • Convenient helper methods for common operations
  • Well-documented API with JSDoc comments
  • Extensive examples for all major use cases

Testing & Quality

  • Comprehensive test suite with >90% code coverage
  • Unit tests for all services and utilities
  • Integration test examples
  • Compatibility tests for different environments

Configuration Options

  • apiKey: ProxyCheck.io API key (required)
  • baseUrl: API base URL (default: 'proxycheck.io')
  • timeout: Request timeout in milliseconds (default: 30000)
  • retries: Number of retry attempts (default: 3)
  • retryDelay: Initial retry delay in milliseconds (default: 1000)
  • tlsSecurity: Use HTTPS connections (default: true)
  • userAgent: Custom user agent string
  • logging: Comprehensive logging configuration

Supported Environment Variables

  • PROXYCHECK_API_KEY
  • PROXYCHECK_BASE_URL
  • PROXYCHECK_TIMEOUT
  • PROXYCHECK_RETRIES
  • PROXYCHECK_RETRY_DELAY
  • PROXYCHECK_TLS_SECURITY

API Methods

Check Service

  • checkAddress(address, options?): Check single IP/email
  • checkAddresses(addresses, options?): Check multiple addresses
  • getDetailedInfo(address, options?): Get comprehensive information
  • isProxy(address, options?): Quick proxy check
  • isVPN(address, options?): Quick VPN check
  • isDisposableEmail(email, options?): Check disposable email
  • getRiskScore(address, options?): Get risk assessment

Listing Service

  • addToWhitelist(entries): Add to whitelist
  • removeFromWhitelist(entries): Remove from whitelist
  • getWhitelist(): Get whitelist entries
  • setWhitelist(entries): Replace whitelist
  • clearWhitelist(): Clear all whitelist entries
  • addToBlacklist(entries): Add to blacklist
  • removeFromBlacklist(entries): Remove from blacklist
  • getBlacklist(): Get blacklist entries
  • setBlacklist(entries): Replace blacklist
  • clearBlacklist(): Clear all blacklist entries

Rules Service

  • createRule(name, conditions): Create custom rule
  • testRule(name): Test a rule
  • listRules(): List all rules
  • updateRule(name, conditions): Update existing rule
  • deleteRule(name): Delete a rule

Stats Service

  • getDetections(limit?, offset?): Get detection statistics
  • getQueries(limit?, offset?): Get query logs
  • getQueriesPaginated(page, pageSize): Get paginated queries
  • getUsage(): Get usage statistics
  • exportDetections(options): Export detection data
  • exportQueries(options): Export query data
  • exportUsage(): Export usage data
  • getAllStats(): Get all statistics at once

Project Structure

proxycheck-sdk/
├── src/              # Source code
├── tests/            # Test files
├── examples/         # Usage examples
├── dist/             # Build output
└── docs/             # Documentation

Dependencies

  • axios: HTTP client for API requests
  • zod: Runtime type validation

Development Tools

  • TypeScript 5.8+
  • Jest for testing
  • Biome for linting and formatting
  • Rollup for building
  • TypeDoc for API documentation

License

MIT License - See LICENSE file for details

Notes

  • This is an unofficial third-party SDK not affiliated with ProxyCheck.io
  • Minimum Node.js version: 14.0.0
  • Full API documentation available in the README
  • Contributions welcome - see CONTRIBUTING.md