Changelog
All notable changes to this project are documented in this file.
0.19.0
Breaking Changes ⚠️
- [Drops] The
Drop.getTotalMinted()
function is now a computed property namedDrop.collectorsCount
to better reflect its purpose. It includes the total number of POAPs collected, including mints and email reservations.
0.18.0
Breaking Changes ⚠️
- [Providers]
AuthenticationProvider.getJWT
has been changed forgetAuthToken
that returns an object with the whole OAuth token information, throwsUnauthorizedClientError
. It is now cached by audience so many clients could share the same provider.
0.17.0
Features
- [Drops] Introduce a dedicated
DropsClient.get
method to retrieve a single drop by its ID.
Breaking Changes ⚠️
- [Drops] The
DropsClient.fetch
method has been renamed toDropsClient.list
to better reflect its functionality.
0.16.0
Features
- [Collections] New Collections module added. See the Collections documentation (opens in a new tab) for details.
0.15.0
Maintenance
- Upgraded to Node.js LTS (v22).
- Upgraded GitHub Action
checkout
to v5. - Migrated package management from
yarn
topnpm
.
0.14.0
Features
- [POAPs] Added
PoapsClient.fetchCount
method to get the total count of POAPs based on provided filters.
0.13.0
Breaking Changes ⚠️
- Subpath imports (e.g.,
@poap-xyz/poap-sdk/utils
) are no longer supported. Import directly from@poap-xyz/poap-sdk
instead.
Maintenance
- Removed multi-package build configuration; the SDK is now built as a single, monolithic package.
- Removed the
@poap-xyz/frames
package from this monorepo (still available as a standalone package on npm).
0.12.0
Features
- [Profiles] Bulk profile fetching now includes errors in its response to support robust retry strategies.
Breaking Changes ⚠️
- [Profiles] The
ProfilesClient.fetchBulk
method now returns an object containingprofiles
anderrors
maps instead of a simple array.
Maintenance
- Upgraded to Yarn 4.
- [Moments] Replaced
Buffer
withUint8Array
for media uploads and removed Node.js polyfills for better browser compatibility.
0.11.0
Breaking Changes ⚠️
- [Drops] The
DropsClient.fetch
method has been updated:- Removed the
name
filter (useDropsClient.search
instead). - Removed the
isPrivate
filter. - The
from
andto
parameters now filter by the drop's event date, not its creation date.
- Removed the
Versions 0.10.6 - 0.10.0
Features
- Added
nulls_first
andnulls_last
options to theOrder
enum. (0.10.6) - [Profiles] Added serializable profile types and related conversion methods. (0.10.5)
- [Profiles] Enhanced deduplication to return only one profile per query. (0.10.4)
- [Drops] Added HTTP request options parameter to
DropsClient.fetch
. (0.10.3) - [Profiles] Reduced the bulk request limit from 100 to 50 addresses. (0.10.2)
- [Profiles] Added HTTP request options to
ProfilesClient.fetch
. (0.10.1) - [Profiles] Introduced the new Profiles API client. See Profiles docs (opens in a new tab). (0.10.0)
Versions 0.9.3 - 0.9.0
Maintenance
- Avoided subpackage imports to preserve CommonJS compatibility. (0.9.3)
- Ensured entrypoint file is included in package exports. (0.9.2)
- Updated import style examples in documentation. (0.9.2)
- Supported alias imports in declaration files. (0.9.1)
Breaking Changes ⚠️
- Merged all SDK packages into a single NPM package:
@poap-xyz/poap-sdk
. (0.9.0)
Earlier Versions (0.8.4 - 0.1.0)
Notable Features
- [Moments] Removed
axios
dependency. (0.8.4) - Relaxed query utility value validations. (0.8.3)
- Added
_is_null
filter to query helpers. (0.7.4) - [Drops] Added missing image field to the Drop Compass response. (0.7.4)
- [Moments] Made
dropIds
optional when creating a Moment. (0.7.2) - [Drops] Added method to transform a Serializable Drop into a Drop. (0.7.1)
Significant Breaking Changes ⚠️
- [Moments] Adapted to the POAP Moments API v2, changing
dropId
todropIds[]
and removing several fields and methods. (0.7.0) - [Moments] Separated media upload from moment creation. (0.6.0)
- Removed
createBoolFilter
; usecreateEqFilter
instead. (0.8.0) - Replaced loose
any
types with strict definitions and refactored provider architecture. (0.2.0)
Maintenance
- Ongoing improvements to documentation, type declarations, export patterns, and dependency management.
- Enhanced error handling and validation across all Compass API interactions.