🚀 Additions

• Verbose RX/TX debugging
  • Can be turned on via $BadgeAPI.badge.debug.rx = true / $BadgeAPI.badge.debug.tx = true

✨ Improvements

• RX data is now handled completely asynchronously
• Code readability
• Return type of BadgeFileSystemApi.list() is now a discriminated union FSListing of FileListing and DirListing to allow type narrowing

⚠️ Breaking change ⚠️

The type export FileListing of api/filesystem has been renamed to FSListing. The new export FileListing only represents actual files instead of both files and folders, and is complemented by DirListing. FSListing is a union of FileListing and DirListing. This allows type narrowing when consuming an FSListing, e.g. from BadgeAPI.fileSystem.list():

const items = await $BadgeAPI.fileSystem.list('/internal');
items.forEach(item => {
  if (item.type == 'file') {
    /* type of `item` is narrowed to FileListing */
  }
  else {
    /* type of `item` narrowed to DirListing */
  }
})

🚀 Additions

• path in BadgeAPI.fileSystem.list() return type
• BadgeAPI.onConnect() hook
• crcErrors in BadgeUSB.connectionStats

✨ Improvements

• BadgeUSB.transaction()
  • Implemented transaction queueing
  • Fixed error call stacks
  • Much better debug logging
  • Error response decoding with BadgeUSBError

⚠️ Breaking change ⚠️

BadgeAPI.onConnectionLost is a callable function now instead of a setter.
This is in order to allow setting multiple callbacks.

Before:

badgeApi.onConnect = () => {
  /* callback */
}

After:

badgeApi.onConnect(() => {
  /* callback */
});

https://www.npmjs.com/package/@badge.team/badge-webusb/v/1.0.0-RC1