Skip to content

Releases: ValidKit/validkit-typescript-sdk

v1.0.1

15 Jul 09:10
@jesse-validkit jesse-validkit
v1.0.1
82377c2
Compare
Choose a tag to compare
v1.0.1 Latest
Latest

Release Date: July 15, 2025

This patch release includes important bug fixes, documentation improvements, and better development tooling support.

🐛 Bug Fixes

API Compatibility

  • Fixed compact format responses - Added client-side transformation for V1 API compatibility
  • V1 API always returns full format; SDK now properly transforms to compact when requested
  • Fixed batch response parsing - Correctly handles actual API response structure
  • Fixed error code handling - Properly checks for 'BATCH_SIZE_EXCEEDED' instead of 'BATCH_SIZE_ERROR'

Documentation & Repository

  • Fixed GitHub repository URLs - All links now correctly point to ValidKit/validkit-typescript-sdk
  • Updated package repository - Corrected repository URL in package.json

✨ Improvements

Testing & Quality

  • Comprehensive test suite - Added full test coverage achieving 80% branch coverage
  • Added tests for verifyBatchAgent - Complete coverage of agent-optimized endpoint
  • Added tests for share_signals - Ensures Signal Pool contribution works correctly
  • Fixed error scenario tests - Proper testing of all error conditions

Developer Experience

  • Added CHANGELOG.md - Now tracking all changes between versions
  • Updated contribution guidelines - Clearer instructions for contributors
  • ESLint configuration - Consistent code style enforcement
  • Jest configuration - Proper test setup for TypeScript

Type Definitions

  • Added trace_id to responses - Properly typed in batch response interfaces
  • Added request_id field - Available in response types
  • Fixed field mappings - processing_time_ms correctly mapped from validation_time_ms

📝 Notes

  • The V1 API always returns full format responses. When compact format is requested, the SDK automatically transforms the response client-side to provide the expected compact format.
  • This is a backward-compatible patch release - no breaking changes.

🔧 Upgrading

npm update @validkit/sdk
# or
yarn upgrade @validkit/sdk

No code changes required when upgrading from v1.0.0.

🙏 Acknowledgments

Thanks to our early users for the feedback that helped identify these issues!

🔗 Links

Assets 2
Loading

v1.0.0

15 Jul 08:26
@jesse-validkit jesse-validkit
v1.0.0
b8db139
Compare
Choose a tag to compare
v1.0.0

Release Date: June 26, 2025

We're excited to announce the first release of the official ValidKit TypeScript SDK! This SDK is designed specifically for AI agents and developers who need high-performance email verification at scale.

🎉 Features

Core Functionality

  • Single Email Verification - Simple verifyEmail() method for individual email checks
  • Batch Processing - Verify up to 10,000 emails in a single request with verifyBatch()
  • Agent-Optimized Endpoint - High-performance verifyBatchAgent() for AI agent workloads
  • Async Processing - Handle massive lists with verifyBatchAsync() and webhook notifications

Developer Experience

  • Full TypeScript Support - Comprehensive type definitions for excellent IDE support
  • Dual Package Support - Works with both CommonJS and ES Modules
  • Cross-Platform - Compatible with Node.js 14+ and modern browsers
  • Automatic Retries - Built-in exponential backoff for transient failures
  • Rate Limit Handling - Graceful handling of rate limits with retry delays

Performance Features

  • Token-Optimized Responses - Compact format reduces response size by 80%
  • Progress Tracking - Real-time callbacks for batch processing progress
  • Agent-Scale Rate Limits - Support for 1,000+ requests per minute
  • Multi-Agent Tracing - Track requests across distributed systems with trace_id

AI Framework Examples

  • LangChain integration example
  • AutoGPT plugin implementation
  • Vercel AI SDK integration
  • Custom agent implementations

📦 Installation

npm install @validkit/sdk
# or
yarn add @validkit/sdk

🚀 Quick Start

import { ValidKit } from '@validkit/sdk';

const client = new ValidKit({
  api_key: 'your-api-key'
});

// Simple verification
const result = await client.verifyEmail('test@example.com');
console.log(result.valid); // true or false

// Batch verification
const emails = ['email1@test.com', 'email2@test.com'];
const results = await client.verifyBatch(emails, {
  format: 'compact'
});

📖 Documentation

Full documentation available at: https://docs.validkit.com

🔗 Links

Loading