mongo-realtime 1.1.0 → 1.1.2

package/README.md

@@ -259,7 +259,8 @@ MongoRealtime.init({
 The server will automatically emit a list of filtered documents from the specified collections after each change.\
 Each list stream requires an unique `streamId`, the `collection` name, and an optional `filter` function that returns a boolean or a promise resolving to a boolean.
 Clients receive the list on the event `db:stream:{streamId}`.\
-For best practice, two list streams can't have the same `streamId` or else an error will be thrown. This will prevent accidental overrides. You can still remove a stream with `MongoRealtime.removeListStream(streamId)` and add it again or use inside a `try-catch` scope.
+
+On init, when `safeListStream` is `true`(default), two list streams can't have the same `streamId` or else an error will be thrown. This will prevent accidental overrides. You can still remove a stream with `MongoRealtime.removeListStream(streamId)` and add it again or use inside a `try-catch` scope.
 
 ```javascript
 MongoRealtime.init({
@@ -280,15 +281,28 @@ MongoRealtime.addListStream("usersWithEmail", "users", (doc) => !!doc.email); //
 
 When `autoListStream` is not set, all collections are automatically streamed and WITHOUT any filter.\
 That means that if you have a `posts` collection, all documents from this collection will be sent to the clients on each change.\
-And as two list streams can't have the same `streamId`, if you want to add a filtered list stream with id `posts`, you must set `autoListStream` to an array NOT containing `"posts"`or `MongoRealtime.removeListStream("posts")` after initialization.\
+
+Also, `safeListStream` is enabled by default. So, you can't add a list stream with id `posts` if `autoListStream` contains `"posts"` or is not set.\
+
+If you want to add a filtered list stream with id `posts`, you must set `autoListStream` to an array NOT containing `"posts"`or call `MongoRealtime.removeListStream("posts")` after initialization.\
 Therefore, if you want to add a filtered list stream for all collections, you must set `autoListStream` to an empty array.
 
+To avoid all these issues, you can set `safeListStream` to `false` in the init options but be careful as this will allow you to override existing streams.
+
 ```javascript
 MongoRealtime.init({
   connection: mongoose.connection,
   server: server,
   autoListStream: [], // stream no collection automatically (you can add your own filtered streams later)
 });
+// or
+MongoRealtime.init({
+  connection: mongoose.connection,
+  server: server,
+  safeListStream: false, // disable safe mode (you can override existing streams)
+  // Still stream all collections automatically but you can override them 
+}):
+
 MongoRealtime.addListStream("posts", "posts", (doc) => !!doc.title); // client can listen to db:stream:posts
 MongoRealtime.addListStream("users", "users", (doc) => !!doc.email); // will not throw an error
 ```

package/index.js

@@ -51,6 +51,8 @@ class MongoRealtime {
   /** @type {[String]} - All DB collections */
   static collections = [];
 
+  static #safeListStream = true;
+
   /**
    * Initializes the socket system.
    *
@@ -64,6 +66,7 @@ class MongoRealtime {
    * @param {[String]} options.autoListStream - Collections to stream automatically. If empty, will stream no collection. If null, will stream all collections.
    * @param {[String]} options.watch - Collections to watch. If empty, will watch all collections
    * @param {[String]} options.ignore - Collections to ignore. Can override `watch`
+   * @param {bool} options.safeListStream -  If true(default), declaring an existing streamId will throw an error
    *
    */
   static init({
@@ -74,12 +77,14 @@ class MongoRealtime {
     autoListStream,
     onSocket,
     offSocket,
+    safeListStream = true,
     watch = [],
     ignore = [],
   }) {
     if (this.io) this.io.close();
     this.io = new Server(server);
     this.connection = connection;
+    this.#safeListStream = !!safeListStream;
 
     watch = watch.map((s) => s.toLowerCase());
     ignore = ignore.map((s) => s.toLowerCase());
@@ -111,6 +116,20 @@ class MongoRealtime {
     this.io.on("connection", (socket) => {
       if (onSocket) onSocket(socket);
 
+      socket.on("db:stream[register]", async (streamId, registerId) => {
+        const stream = this.#streams[streamId];
+        if (!stream) return;
+        const coll = stream.collection;
+
+        if (!this.#cache[coll]) {
+          this.#cache[coll] = await connection.db
+            .collection(coll)
+            .find({})
+            .toArray();
+        }
+        this.io.emit(`db:stream[register][${registerId}]`, this.#cache[coll]);
+      });
+
       socket.on("disconnect", (r) => {
         if (offSocket) offSocket(socket, r);
       });
@@ -198,6 +217,7 @@ class MongoRealtime {
           );
 
           this.io.emit(`db:stream:${key}`, filtered);
+          this.notifyListeners(`db:stream:${key}`, filtered);
         });
       });
 
@@ -273,7 +293,7 @@ class MongoRealtime {
     if (!collection) throw new Error("Collection is required");
 
     filter ??= (_, __) => true;
-    if (this.#streams[streamId]) {
+    if (this.#safeListStream && this.#streams[streamId]) {
       throw new Error(
         `Stream '${streamId}' already registered or is reserved.`
       );
@@ -282,7 +302,7 @@ class MongoRealtime {
       collection,
       filter,
     };
-  }
+  } 
 
   /**
    * @param {String} streamId - StreamId of the stream

package/package.json

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