ProjectOpenSea / opensea-js / 19312829602

88%

master: 30%

Build Type

push

github

Committed by web-flow

Commit Message

fix: correct getCollectionOffers return type and add pagination support (#1818)

* fix: correct getCollectionOffers return type and fix AssetEventType enum

- Change getCollectionOffers return type from ListCollectionOffersResponse to GetOffersResponse
- Add pagination parameters (limit, next) to getCollectionOffers method
- Remove unused ListCollectionOffersResponse import from api.ts
- Update all related unit and integration tests to use correct response type
- Add tests for pagination parameters
- Add null check for offer.criteria in integration test
- Remove invalid AssetEventType enum values (CANCEL, REDEMPTION)
- Update documentation to reflect only valid event types (ORDER, SALE, TRANSFER)
- Bump package version from 8.0.5 to 8.0.6

The API returns { "offers": [...], "next": "..." } which matches GetOffersResponse, not ListCollectionOffersResponse which lacks the pagination cursor.

API testing confirmed only 3 valid event types: order, sale, transfer. The CANCEL and REDEMPTION enum values returned API errors.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

* Update null address terminology in API reference

* Update null address terminology in documentation

* fix: correct AssetEventType enum to match actual OpenSea API behavior

This commit updates the event types to accurately reflect the OpenSea API's
actual behavior based on live API testing with the boredapeyachtclub collection.

Key changes:
- AssetEventType enum now has: SALE, TRANSFER, ORDER (not individual listing/offer types)
- Added OrderEventType enum to distinguish order types: LISTING, ITEM_OFFER,
  COLLECTION_OFFER, TRAIT_OFFER
- OrderEvent type now includes order_type field to specify the kind of order
- Updated documentation to clarify that ORDER cannot be used as a filter parameter
- All tests updated to use correct event structure with order_type field

API behavior discovered:
- The API returns event_type "ord... (continued)

Run Details

453 of 665 branches covered (68.12%)

Branch coverage included in aggregate %.

28 of 29 new or added lines in 5 files covered. (96.55%)

4 existing lines in 1 file now uncovered.

4019 of 4462 relevant lines covered (90.07%)

4.16 hits per line