CHANGELOG.md

Changelog

[16.0.0] - 2023-10-17

Fixed

• Upgraded hyperswarm to latest and added several community-run bootstrap nodes.

15.0.1 - 2022-05-24

Fixed

• Sanitize PMs (#109) (Daniel Chiquito)

15.0.0 - 2021-11-22

The major bump is due to breaking compat with the previously defined PM API; this change does bump the protocol version & is technically wire-compatible with clients running cabal-core versions 14.x.x.

Changed

The private messages API is now:

• cabal.publishPrivate(message, recipientKey, cb)
• it now only takes objects, instead of previously only accepting strings
• it accepts message types conforming to chat/* e.g. chat/text or chat/emote
• a property private is injected into all private messages published via publishPrivate

Before this change the API was cabal.publishPrivateMessage(text, recipientKey, cb), this has now been removed.

Change by @hackergrrl and @cblgh.

Fixed

• fixed a race condition when initializing async views (#108) (@cblgh)

14.1.2 - 2021-10-18

Added

• Docs: Add Table of Contents (fc66637) (@ralphtheninja)
• Docs: Add CHANGELOG.md, documenting all versions since start of project ((d3f157a) -> d8c83ae) (@ralphtheninja)
• Docs: Document changelog under Developing section (2b6b8f7) (@ralphtheninja)
• Docs: Add changelog:fix script (to fill in details) (3dcf1b0) (@ralphtheninja)
• Docs: Add changelog scripts to package.json (e64244c) (@ralphtheninja)

Fixed

• revert removal of hyperswarm-web (0f7389a) (@cblgh).
• Fixes author field in package.json. (57e76c6) (@hackergrrl)

14.1.1 - 2021-09-15

Changed

• Upgrade sodium-universal for faster installs (#106) (@ralphtheninja)

Added

• Add missing kappa-view dependency (@hackergrrl)

Removed

• Remove unused dependencies (@hackergrrl)

14.1.0 - 2021-08-21

Added

• Export Cabal.isHypercoreKey (#105) (@cblgh)

14.0.0 - 2021-05-18

Breaking change since kappa-core indirectly pulls in hypercore@9.x. Also see comment.

Changed

• Breaking: update core dependencies and set browser field in package.json (#104) (@cblgh)

Added

• Add private messages (#69) (@hackergrrl)

Fixed

• Use swarm.js's passed in opts (#104) (@cblgh)

13.2.0 - 2021-03-06

Added

• Implement the basics of a channel archiving view (#103) (@cblgh)

13.1.0 - 2021-01-12

Changed

• Document possible flags for listByFlag() (#94) (@garbados)

Added

• Add .preferredPort (default 13331) to core opts (#101) (@cblgh)

13.0.2 - 2020-06-24

Fixed

• Change duplexify to object mode for moderation streams (#95) (9ab9c74) (@garbados)

13.0.1 - 2020-06-22

Fixed

• Wait for core to pause before closing (a70505b) (@hackergrrl)

13.0.0 - 2020-06-07

Fixed

• Breaking: fix crypto server/client orientation (2132439) (@hackergrrl)

12.0.1 - 2020-06-05

Fixed

• Change sublevel names for moderation view to force index regen (4f35ed1) (@hackergrrl)
• Add clearIndex lifecycle to channel-membership (3b6eaeb) (@hackergrrl)

12.0.0 - 2020-05-22

This was released as a new major since 11.2.1 most likely contained breaking changes.

Changed

• Update ocumentation (e6052a4) (@hackergrrl)

11.2.1 - 2020-05-22

This version was never published to npm.

Changed

• Skip failing moderation tests (e231a73) (@hackergrrl)
• Update tests to use opts.{mod,admin}Keys (5f122b7) (@hackergrrl)
• Bump version in moderation view (d0ad002) (@hackergrrl)

Fixed

• Fix skipped failing tests (e233483) (@substack)
• Remove admins/mods if they are no longer in {admin,mod}Keys (626d65f) (@hackergrrl)
• Fix some more mod view lifecycle things (d6d577b) (@hackergrrl)
• Fix moderation view clearing race condition (d997041) (@hackergrrl)
• Receive admin/mod keys intead of parsing them (5c7cb7a) (@hackergrrl)
• Add lifecycle management to mod view (70c86c4) (@hackergrrl)
• Have list wait for the view to be ready (0214803) (@hackergrrl)

11.2.0 - 2020-05-22

Changes in this version were based on top of 11.0.2 but with functionality from 11.1.1 merged in.

Added

• Add listModerationBy() and secondary index (#87) (@substack)

11.1.1 - 2020-05-22

Fixed

• Use regex to capture cabal key instead of URL (#89) (@cblgh)

11.1.0 - 2020-05-21

Changed

• Use admin for admins, instead of mod (@cblgh)

Added

• Add test for setting multiple admins and mods in the cabal addr (@substack)

Fixed

• Add fixes for admin and mod keys in cabal urls (@substack)

11.0.2 - 2020-05-21

Changed

• Drop node 8 support, add node 12 (@hackergrrl)
• Move moderation events to api (@hackergrrl)

11.0.1 - 2020-05-20

Fixed

• Remove flag for moderation (@substack)

11.0.0 - 2020-05-20

Added

• Breaking: add moderation based on flags (#83) (@substack)
• Add support for mod and admin keys in cabal key uri (@cblgh)
• Add cabal.close() (@hackergrrl)

Removed

• Remove package-lock.json (#84) (@substack)

10.0.1 - 2020-05-01

Changed

• Update hyperswarm to 2.13.x (#74) (@nikolaiwarner)
• Update package-lock.json (here we go again) (#74) (@nikolaiwarner)

10.0.0 - 2020-03-23

Changed

• Breaking: use hyperswarm. This removes discovery-swarm for finding peers. Peers before this commit will not be able to discover peers from this commit onwards (#71) (@hackergrrl)

Added

• Add FUNDING.yml (@cblgh)

9.0.3 - 2020-04-09

Removed

• Remove block logic (@hackergrrl)

9.0.2 - 2019-12-11

Fixed

• Add missing parameter in isFutureMonotonicTimestamp() (#68) (@okdistribute)

9.0.1 - 2019-12-04

Added

• Add cblgh.org (#67) (@cblgh)
• Add nick disco server (#67) (@hackergrrl)
• Add dns-discovery server: eight45.net (#67) (@hackergrrl)

9.0.0 - 2019-11-21

Changed

• Breaking: upgrade hypercore (via multifeed) (#61) (@hackergrrl)
• Update kappa-core to 6.x (@hackergrrl)
• Use hypercore-crypto to generate test key (@hackergrrl)

Added

• Add node 10 (#61) (@hackergrrl)

Fixed

• Wait for view to be ready on mod api (#61) (@hackergrrl)
• Encode now-timestamps to avoid overwrites (#62) (@hackergrrl)

8.0.1 - 2019-10-09

Fixed

• Fix swarm hashing (@hackergrrl)

8.0.0 - 2019-10-09

Changed

• Breaking: hash cabal key with blake2b (@hackergrrl)
• Replace memdb with level-mem (#57) (@vweevers)

7.2.1 - 2019-08-27

Added

• Add moderation view (#45) (@substack, @hackergrrl)

Fixed

• Set max listeners for Cabal event emitter (#50) (@cblgh)
• Fix a case where channel membership indexing hangs (@hackergrrl)
• Let the network test ignore swarm blocking logic (blocking on remote key instead of host and port) (@hackergrrl)

7.2.0 - 2019-08-20

Added

• Add channel membership view (#52) (@cblgh)

7.1.0 - 2019-08-19

Changed

• Throttle or block misbehaving peers by host and port (@hackergrrl)

7.0.1 - 2019-08-04

Changed

• Use the same cabal key consistently (@hackergrrl)

7.0.0 - 2019-08-04

Changed

• Breaking: enable multifeed protocol encryption (@hackergrrl)

Fixed

• Fix net swarm test by using a real hypercore key (@hackergrrl)

6.0.2 - 2019-08-03

• Remove package-lock.json (again) (@hackergrrl)

6.0.1 - 2019-07-31

Added

• Add debug logging under cabal for network errors (@hackergrrl)

6.0.0 - 2019-07-03

Changed

• Breaking: update kappa-core to 4.x (@hackergrrl)
• Update discovery-swarm to 6.x (@hackergrrl)

Removed

• Remove package-lock.json (again) (@hackergrrl)

5.1.2 - 2019-06-03

Removed

• Remove package-lock.json (@hackergrrl)

Fixed

• Set .maxFeeds default to 1024 in cabal.replicate() (@hackergrrl)

5.1.1 - 2019-05-26

Changed

• Update kappa-view-level to ^2.0.0 (@hackergrrl)

Fixed

• Use base64 for channel view state (@hackergrrl)

5.1.0 - 2019-05-26

Added

• Add .db option to Cabal constructor for durable storage (#41) (@substack)
• Add cabal.ready(cb) (#41) (@substack)

5.0.1 - 2019-05-21

Changed

• Update kappa-core to ^3.0.1 (@hackergrrl)
• Update concat-stream to ^2.0.0 (@hackergrrl)
• Update through2 to ^3.0.1 (@hackergrrl)

5.0.0 - 2019-05-21

Changed

• Breaking: use discovery-swarm to shuttle around peer id (swarm function now calls back with swarm) (#39) (@hackergrrl)
• Breaking: add options parameter to cabal.replicate(opts) (.maxFeeds no longer passed indirectly via the Cabal constructor) (#39) (@hackergrrl)

Added

• Expose swarm functionality via cabal.swarm(cb) (#39) (@hackergrrl)

Removed

• Remove node 6 from travis (@hackergrrl)
• Remove multifeed dependency (@hackergrrl)

4.0.1 - 2019-05-08

Added

• Add an option to set the .maxFeeds option of hypercore-protocol when replicating (#33) (@nikolaiwarner)

Fixed

• Allow options for messages.read() to take priority over defaults (#29) (@telamon)
• Fix error propagation bug in topics view (#30) (@telamon)

4.0.0 - 2018-11-16

This release was based partly from 3.0.4 but also merged in changes from 3.1.0. Check git history for more fine grained details.

Changed

• Breaking: renamed cabal.protocolVersion to cabal.databaseVersion (#28) (@cblgh)
• Breaking: renamed cabal.getProtocolVersion() to cabal.getDatabaseVersion() (#28) (@cblgh)

3.0.4 - 2018-11-11

This version was published to npm after 3.1.0 and is almost identical. We therefore only list the changes for 3.0.4 and omit the 3.1.0 version.

Added

• Add view for topics (#24) (@nikolaiwarner)
• Add cabal.publishChannelTopic() (#24) (@nikolaiwarner)

Removed

• Remove unused requires (#25) (@cblgh)

Fixed

• Fix reliable key exchange (#27) (@hackergrrl)

3.0.3 - 2018-11-06

Added

• Add cabal.protocolVersion as 1.0.0 (#25) (@cblgh)
• Add cabal.getProtocolVersion() (#25) (@cblgh)

Removed

• Remove unused crypto dependency (#21) (@lachenmayer)

Fixed

• Reorder function calls in cabal.publishNick() (#25) (@cblgh)

3.0.2 - 2018-09-05

There were several tags in between version 3.0.0 and 2.3.0 where @hackergrrl were developing on a separate branch while things were happening on master. Versions 2.3.1, 3.0.0 and 3.0.1 never got published to npm. Major API rewrite.

Changed

• Rename module from cabal-node to cabal-core (@hackergrrl)
• Base storage on kappa instead of hyperdb (@hackergrrl)

Added

• Add cabal.getUser() (@hackergrrl)
• Add cabal.publish() (@hackergrrl)
• Add cabal.publishNick() (@hackergrrl)
• Add cabal.getLocalKey() (@hackergrrl)
• Add views for channels, messages and users (@hackergrrl)

Removed

• Breaking: remove cabal.onconnection() (@hackergrrl)
• Breaking: remove cabal.watch() (@hackergrrl)
• Breaking: remove cabal.getMessages() (@hackergrrl)
• Breaking: remove cabal.getChannels() (@hackergrrl)
• Breaking: remove cabal.joinChannel() (@hackergrrl)
• Breaking: remove cabal.leaveChannel() (@hackergrrl)
• Breaking: remove cabal.createReadStream() (@hackergrrl)
• Breaking: remove cabal.metadata() (@hackergrrl)
• Breaking: remove cabal.message() (@hackergrrl)

2.3.0 - 2018-08-13

This version was published both as cabal-node and cabal-core.

Changed

• Sort the channel list alphabetically (#8) (@cinnamon-bun)

2.2.0 - 2018-06-23

This version was published as cabal-node. Should have been a patch instead of a minor version.

Fixed

• Update hyperdb to 3.1.2 to fix a connection issue (@cblgh)

2.1.1 - 2018-05-29

This version was published as cabal-node.

Fixed

• Fix bug where cabal.leaveChannel() didn't actually leave the channel (@okdistribute)

2.1.0 - 2018-05-29

This should have been a patch instead of a minor version. Not published to npm.

Changed

• Change how channels are stored internally (@okdistribute)

2.0.1 - 2018-05-27

This version was published as cabal-node. Should have been a minor instead of a patch version.

Added

• Add message type. Defaults to 'chat/text' (@cblgh)

2.0.0 - 2018-05-24

This version was published as cabal-node.

Changed

• Breaking: change on-disk format to improve performance getting channel list (#2) (@okdistribute)
• Batch multiple transactions (@cblgh)

Added

• Add methods for getting messages and channels (#1) (@cblgh)
• Add watch function for db messages (@okdistribute)

Fixed

• Don't store timezone offset in database messages (@cblgh)
• Return the largest value on conflict (@cblgh)
• Fix database keys and channel regex (@cblgh)

1.0.0 - 2018-05-16

This version was published as cabal-node.

🌱 Initial release.