Merge branch 'master' into cabal-web

CHANGELOG.md

@@ -0,0 +1,17 @@
+# Changelog
+
+## [7.0.0] - 2021-09-26
+
+_The updated version of `cabal-core` indirectly contains major changes to the underlying protocol. See the release of [`cabal-core@14.0.0`](https://github.com/cabal-club/cabal-core/blob/master/CHANGELOG.md#1400---2021-05-18) for more detailed information._
+
+### Changed
+
+- **Breaking:** upgrade `cabal-core` to `14.x` ([#79](https://github.com/cabal-club/cabal-client/issues/79)) (Lars-Magnus Skog)
+
+## [6.3.2] - 2021-05-01
+
+_This is not the first version, but the first version in this changelog to save some time._
+
+[7.0.0]: https://github.com/cabal-club/cabal-client/compare/v6.3.2...v7.0.0
+
+[6.3.2]: https://github.com/cabal-club/cabal-client/releases/tag/v6.3.2

README.md

@@ -1,22 +1,24 @@
-
 # cabal-client
+
 `cabal-client` is a new type of client library for cabal chat clients.
 
 New chat clients can be implemented using _only_ this library, without having
 to mess around with [`cabal-core`](https://github.com/cabal-club/cabal-core/)
 anymore.
 
 Some of its features:
-* consolidates logic common to all chat clients
-* leaving and joining of channels
-* virtual messages (such as status messages) and virtual channels (currently only the `!status` channel)
-* handling multiple cabal instances
-* receiving unread notifications and mentions for channels
-* resolving of DNS shortnames (cabal.chat) to cabal keys
+
+- consolidates logic common to all chat clients
+- leaving and joining of channels
+- virtual messages (such as status messages) and virtual channels (currently only the `!status` channel)
+- handling multiple cabal instances
+- receiving unread notifications and mentions for channels
+- resolving of DNS shortnames (cabal.chat) to cabal keys
 
 For a couple of brief examples, see the [`examples/`](examples/) directory.
 
 ## Usage
+
 See [`cabal-cli`](https://github.com/cabal-club/cabal-cli/) for an example client implementation.
 
 [Read the API documentation](./api.md)

api.md

@@ -61,6 +61,12 @@ Create a client instance from which to manage multiple
 **Params**
 
 - *opts* <code>object</code>
+    - aliases <code>object</code> - key/value pairs of `alias` -> `command name`
+    - commands <code>object</code> - key/value pairs of `command name` -> `command object`, which has the following properties:
+        - call <code>function</code> - command function with the following signature `command.call(cabal, res, arg)`
+        - help <code>function</code> - return the help string for this command
+        - category <code>Array.&lt;string&gt;</code> - a list of categories this commands belongs to
+        - alias <code>Array.&lt;string&gt;</code> - a list of command aliases
     - config <code>object</code>
         - temp <code>boolean</code> - if `temp` is true no data is persisted to disk.
         - *dbdir* <code>string</code> - the directory to store the cabal data

package.json

@@ -2,7 +2,7 @@
   "name": "cabal-client",
   "description": "helper module for cabal clients",
   "author": "Cabal Club",
-  "version": "6.3.1",
+  "version": "7.0.0",
   "repository": {
     "url": "git://github.com/cabal-club/cabal-client.git"
   },
@@ -18,6 +18,10 @@
     "lint": "standard",
     "doc": "jsdoc2md --files src/client.js src/cabal-details.js --param-list-format list --separators --partial doc-gen/scope.hbs --helper doc-gen/helpers.js > api.md",
     "build": "browserify index.js --standalone CabalClient > bundle.js"
+    "changelog:patch": "hallmark bump patch -i api.md",
+    "changelog:minor": "hallmark bump minor -i api.md",
+    "changelog:major": "hallmark bump major -i api.md",
+    "markdown:fix": "hallmark --fix README.md CHANGELOG.md"
   },
   "keywords": [],
   "dependencies": {
@@ -40,6 +44,7 @@
   },
   "devDependencies": {
     "browserify": "^17.0.0",
+    "hallmark": "^3.1.0",
     "jsdoc-to-markdown": "^5.0.2",
     "rimraf": "^3.0.2",
     "standard": "~12.0.0",

src/cabal-details.js

@@ -800,10 +800,9 @@ class CabalDetails extends EventEmitter {
       const details = this.channels[channel]
       if (!details) {
         this.channels[channel] = new ChannelDetails(cabal, channel)
+        // note: only add listener if we don't have a channel registered (=> prevent duplicate listeners)
+        cabal.messages.events.on(channel, this.messageListener.bind(this))
       }
-      // TODO: only do this for our joined channels, instead of all channels
-      // Calls fn with every new message that arrives in channel.
-      cabal.messages.events.on(channel, this.messageListener.bind(this))
       this._emitUpdate('new-channel', { channel })
     })
   }

src/client.js

@@ -19,6 +19,12 @@ class Client {
    * [`cabal-core`](https://github.com/cabal-club/cabal-core/) instances.
    * @constructor
    * @param {object} [opts]
+   * @param {object} opts.aliases key/value pairs of `alias` -> `command name`
+   * @param {object} opts.commands key/value pairs of `command name` -> `command object`, which has the following properties:
+   * @param {function} opts.commands[].call command function with the following signature `command.call(cabal, res, arg)`
+   * @param {function} opts.commands[].help return the help string for this command
+   * @param {string[]} opts.commands[].category a list of categories this commands belongs to
+   * @param {string[]} opts.commands[].alias a list of command aliases
    * @param {object} opts.config
    * @param {boolean} opts.config.temp if `temp` is true no data is persisted to disk.
    * @param {string} [opts.config.dbdir] the directory to store the cabal data

src/initialization-callbacks.js

@@ -14,13 +14,14 @@ module.exports.getArchivesCallback = function (err, archivedChannels) {
       const details = this.channels[channel]
       if (!details) {
         this.channels[channel] = new ChannelDetails(cabal, channel)
+        // listen for updates that happen within the channel
+        // note: only add listener if we don't have a channel registered (=> prevent duplicate listeners)
+        cabal.messages.events.on(channel, this.messageListener.bind(this))
       }
       // mark archived channels as such
       if (archivedChannels.indexOf(channel) >= 0) {
         this.channels[channel].archive()
       }
-      // listen for updates that happen within the channel
-      cabal.messages.events.on(channel, this.messageListener.bind(this))
 
       // add all users joined to a channel
       cabal.memberships.getUsers(channel, (err, users) => {