chore: release 3.3.0

[bee-worker]

🤖 I have created a release *beep* *boop*

3.3.0 (2022-02-09)

This is a smaller update with two main changes.

🧱 EcmaScript Modules support

We plan to migrate our bee-js package to ES Modules (see the issue for more info) when Node v12 will reach its end-of-life (on 30th of April). With this release, we are starting a transition period by supporting both ES Modules and CommonJS builds. Please start migrating your applications to the ESM stack otherwise, you won't be able to upgrade bee-js after we drop support for CommonJS.

❓ Is supported version?

Since we are in a fast-paced environment where Bee's versions can be incompatible with each other, it is important that in your application you check whether the Bee that you connect to has the correct version that you expect and support (through bee-js).

Untill now we had the isSupportedVersion() function that indicated if the Bee node version is not matching the one that bee-js was tested and built against. This implementation has its downside because it is very strict and if for example there is a small Bee's release that patches only something internal and does not touch the API, which means that the bee-js should be compatible, you will still get a false with this check.

Except for Bee's version itself, there are two other versions that version the Bee endpoint's API and the Bee Debug endpoint's API. We have decided to implement methods that do compatibility checks using these versions and hence should be more relaxed towards Bee's small patches but might pose some risk if some change will be unnoticed and API versions not bumped accordingly.

These methods are:

• BeeDebug.isSupportedExactVersion() - renamed isSupportedVersion which is now deprecated
• BeeDebug.isSupportedMainApiVersion() which checks compatibility only for the main Bee endpoint
• BeeDebug.isSupportedDebugApiVersion() which checks compatibility only for the Bee Debug endpoint
• BeeDebug.isSupportedApiVersion() which checks compatibility for both endpoints

The compatibility is checked using the major versions of the API. If you would like to make your own assertions you can get all the versions (both from Bee itself and the one that bee-js should support) using the method BeeDebug.getVersions()

Features

• add owner property to SOCReader interface (#534) (15581ce)
• api versions support (#543) (d9e5973)
• hybrid esm build (#533) (2305fc6

---

This PR was generated with Release Please. See documentation.

[bee-runner]

🚀 Release checklist

Before release

• Ensure the release works with the intended bee version
• Verify all the example code works with the release code
• Verify Bee JS Docs API update PR passes and contains all needed documentation
• Have two approval for this PR
• Write small summary for the release and verify changelog
• Verify that changes to release PR comment is synchronized to CHANGELOG with manual commit

After release

• Release new Bee JS Docs version
• Update example's bee-js version

[AuHau]

3.3.0 (2022-02-09)

This is a smaller update with two main changes.

🧱 EcmaScript Modules support

We plan to migrate our bee-js package to ES Modules (see the issue for more info) when Node v12 will reach its end-of-life (on 30th of April). With this release, we are starting a transition period by supporting both ES Modules and CommonJS builds. Please start migrating your applications to the ESM stack otherwise, you won't be able to upgrade bee-js after we drop support for CommonJS.

###❓ Is supported version?

Since we are in a fast-paced environment where Bee's versions can be incompatible with each other, it is important that in your application you check where the Bee that you connect to has the correct version that you expect and support (through bee-js).

Till now we had the isSupportedVersion() function that indicated if the Bee node version is not matching the one that bee-js was tested and built against. This implementation has its downside because it is very strict and if for example there is a small Bee's release that patches only something internal and does not touch the API, which means that the bee-js should be compatible, you will still get a false with this check.

Except for Bee's version itself, there are two other versions that version the Bee endpoint's API and the Bee Debug endpoint's API. We have decided to implement methods that do compatibility checks using these versions and hence should be more relaxed towards Bee's small patches but might pose some risk if some change will be unnoticed and API versions not bumped accordingly.

These methods are:

• BeeDebug.isSupportedExactVersion() - renamed isSupportedVersion which is now deprecated
• BeeDebug.isSupportedMainApiVersion() which checks compatibility only for the main Bee endpoint
• BeeDebug.isSupportedDebugApiVersion() which checks compatibility only for the Bee Debug endpoint
• BeeDebug.isSupportedApiVersion() which checks compatibility for both endpoints

The compatibility is checked using the major versions of the API. If you would like to make your own assertions you can get all the versions (both from Bee itself and the one that bee-js should support) using the method BeeDebug.getVersions()

Features

• add owner property to SOCReader interface (#534) (15581ce)
• api versions support (#543) (d9e5973)
• hybrid esm build (#533) (2305fc6)

[bee-worker]

🤖 Release is at https://github.com/ethersphere/bee-js/releases/tag/v3.3.0 🌻