EasyPost / easypost-node / 21646930104

86%

push

github

fix: Comprehensive TypeScript definitions audit and fixes (#534)

## Summary
This PR addresses multiple critical issues with TypeScript definitions
found during a comprehensive audit of the codebase.

> NOTE: AI was used to generate these changes which would have been
difficult to identify by hand.

Closes #438 (partially)
Closes #515 

## Fixes
- Fixes #515 - ReferralCustomer type export issue
- Property now correctly exported as `ReferralCustomer` (not `Referral`)
to match JavaScript implementation
  - Added missing `api_keys` field to Referral interface

## Changes

### Critical Issues Fixed

#### 1. Duplicate Rate Definitions
- **Problem**: Two separate IRate interfaces in `types/Rate/Rate.d.ts`
and `types/Shipment/Rate.d.ts`
- **Fix**: Consolidated into single canonical definition, removed
duplicate
- **Files**: Deleted `types/Shipment/Rate.d.ts`, updated
`types/Shipment/index.d.ts` to re-export from `../Rate`

#### 2. Missing Exports
Added missing exports to `types/index.d.ts`:
- Referral
- Claim
- CustomerPortal
- Embeddable
- SmartRate
- Luma

#### 3. Missing Service Definitions
Added missing services to EasyPost client (`types/EasyPost.d.ts`):
- Luma
- Claim
- CustomerPortal (as CustomerPortalAccountLink)
- Embeddable (as EmbeddablesSession)
- SmartRate
- ReferralCustomer (as Referral) ← **Fixes #515**

#### 4. Missing Type Definitions
- **Luma**: Created complete type definitions based on
`src/services/luma_service.js`
  - `types/Luma/Luma.d.ts`
  - `types/Luma/index.d.ts`
- **SmartRate**: Created missing `types/SmartRate/index.d.ts`
- **TaxIdentifier**: Created `types/Shipment/TaxIdentifier.d.ts` for
embedded tax identifier objects

### High Priority Fixes

#### 5. Interface/Class Property Mismatches
- **Pickup.instructions**: Made class property optional nullable to
match interface
- **Order**: Fixed `return_address`, `buyer_address`, `is_return` to be
optional nullable
- **User.reference**: Added missing field to IUser interface

#### 6. ... (continued)

178 of 259 branches covered (68.73%)

Branch coverage included in aggregate %.

736 of 810 relevant lines covered (90.86%)

260.0 hits per line