mongo-realtime 1.0.0 → 1.0.2

package/README.md

@@ -95,6 +95,37 @@ The package automatically emits six types of events for each database change:
 | `db:change:{collection}:{id}` | Specific document | `db:change:users:507f1f77bcf86cd799439011` |
 | `db:{type}:{collection}:{id}` | Type + document | `db:insert:users:507f1f77bcf86cd799439011` |
 
+### Event listeners
+
+You can add serverside listeners to those db events to trigger specific actions on the server:
+
+```js
+function sendNotification(change){
+  const userId = change.docId; // or change.documentKey._id
+  NotificationService.send(userId,"Welcome to DB"); 
+}
+
+MongoRealtime.listen("db:insert:users",sendNotification);
+```
+
+#### Adding many callback to one event
+
+```js
+MongoRealtime.listen("db:insert:users",anotherAction);
+MongoRealtime.listen("db:insert:users",anotherAction2);
+```
+
+#### Removing event listeners
+
+```js
+MongoRealtime.removeListener("db:insert:users",sendNotification); // remove this specific action from this event
+
+MongoRealtime.removeListener("db:insert:users"); // remove all actions from this event
+
+MongoRealtime.removeAllListeners(); // remove all listeners
+
+```
+
 ### Event Payload Structure
 
 Each event contains the full MongoDB change object:
@@ -102,6 +133,8 @@ Each event contains the full MongoDB change object:
 ```javascript
 {
   "_id": {...},
+  "col":"users", // same as ns.coll
+  "docId":"...", // same as documentKey._id 
   "operationType": "insert|update|delete|replace",
   "documentKey": { "_id": "..." },
   "ns": { "db": "mydb", "coll": "users" },

package/index.js

@@ -4,6 +4,8 @@ class MongoRealtime {
   /** @type {import("socket.io").Server} */ static io;
   /** @type {import("mongoose").Connection} */ static connection;
   /** @type {[import("socket.io").Socket]} */ static sockets = [];
+  /** @type {Record<String, [(change:ChangeStreamDocument)=>void]>} */ static #listeners =
+    {};
 
   /**
    * Initializes the socket system.
@@ -71,6 +73,8 @@ class MongoRealtime {
 
       changeStream.on("change", (change) => {
         const colName = change.ns.coll.toLowerCase();
+        change.col = colName;
+
         const type = change.operationType;
         const id = change.documentKey?._id;
 
@@ -87,16 +91,61 @@ class MongoRealtime {
         ];
 
         if (id) {
+          change.docId = id;
           const e_change_doc = `${e_change_col}:${id}`;
           const e_change_type_doc = `${e_change_type_col}:${id}`;
           events.push(e_change_doc, e_change_type_doc);
         }
         for (let e of events) {
           this.io.emit(e, change);
+          this.notifyListeners(e, change);
         }
       });
     });
   }
+
+  /**
+   * Notify all event listeners
+   *
+   * @param {String} e - Name of the event
+   * @param {ChangeStreamDocument} change - Change Stream
+   */
+  static notifyListeners(e, change) {
+    if (this.#listeners[e]) {
+      for (let c of this.#listeners[e]) {
+        c(change);
+      }
+    }
+  }
+
+  /**
+   * Subscribe to an event
+   *
+   * @param {String} key - Name of the event
+   * @param {(change:ChangeStreamDocument)=>void} cb - Callback
+   */
+  static listen(key, cb) {
+    if (!this.#listeners[key]) this.#listeners[key] = [];
+    this.#listeners[key].push(cb);
+  }
+
+  /**
+   * Remove one or all listeners of an event
+   *
+   * @param {String} key - Name of the event
+   * @param {(change:ChangeStreamDocument)=>void} cb - Callback
+   */
+  static removeListener(key, cb) {
+    if (cb) this.#listeners[key] = this.#listeners[key].filter((c) => c != cb);
+    else this.#listeners[key] = [];
+  }
+
+  /**
+   * Unsubscribe to all events
+   */
+  static removeAllListeners() {
+    this.#listeners = {};
+  }
 }
 
 module.exports = MongoRealtime;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mongo-realtime",
-  "version": "1.0.0",
+  "version": "1.0.2",
   "main": "index.js",
   "scripts": {},
   "keywords": [