mosquito-transport 1.4.3 → 1.4.5

package/README.md

@@ -6,25 +6,19 @@ Under the hood, mosquito-transport uses Mongodb to store it data and [express](h
 
 ## Key features of mosquito-transport include:
 
-- ### Data Persistence and Synchronization 🔁: 
+- Data Persistence and Synchronization 🔁: 
     - Seamlessly persist and synchronize data between MongoDB and frontend applications, ensuring consistency across all clients.
-
-- ### Self-Hosted Server 💾: 
+- Self-Hosted Server 💾: 
     - Host your own server infrastructure, giving you full control over data storage, access, and management.
-
-- ### User Authentication and Authorization 🔐:
+- User Authentication and Authorization 🔐:
     - Easily implement user authentication and authorization using JWT (JSON Web Tokens), providing secure access control to your application's resources.
-
-- ### End-to-End Encryption 🔗:
+- End-to-End Encryption 🔗:
     - Optionally enforce end-to-end encryption by allowing only encrypted data to be transmitted between client and server, ensuring data privacy and security.
-
-- ### Real-Time Data Updates 🚨:
+- Real-Time Data Updates 🚨:
     - Enable real-time updates to keep data synchronized across all clients in real-time, providing a seamless user experience.
-
-- ### Scalability and Performance 🚛:
+- Scalability and Performance 🚛:
     - Benefit from auto-scaling and high performance, allowing your application to handle varying workloads with ease.
-
-- ### Cross-Platform Compatibility 📱:
+- Cross-Platform Compatibility 📱:
     - Compatible with React Native and web applications, allowing you to build cross-platform solutions with ease.
 
 

package/TODO

@@ -0,0 +1,3 @@
+- add method for creating user account
+- add method for login user account
+- server favicon for api

package/lib/helpers/listeners.js

@@ -2,4 +2,5 @@ import SubscriptionListener from "subscription-listener";
 
 export const StorageListener = new SubscriptionListener();
 export const DisconnectionWriteTaskListener = new SubscriptionListener();
-export const UserCountReadyListener = new SubscriptionListener();;
+export const UserCountReadyListener = new SubscriptionListener();
+export const SignoutUserSignal = new SubscriptionListener();

package/lib/helpers/utils.js

@@ -53,7 +53,7 @@ export const deserializeE2E = (data, projectName) => {
         const [clientPubKey, clientNonce, clientData] = data.split('.'),
             [_, serverPrivateKey] = Scoped.InstancesData[projectName].E2E_BufferPair || [];
 
-        if (serverPrivateKey) throw '"e2eKeyPair" is required for decrypting a e2e messages';
+        if (!serverPrivateKey) throw '"e2eKeyPair" is required for decrypting a e2e messages';
         const baseArray = box.open(
             Buffer.from(clientData, 'base64'),
             Buffer.from(clientNonce, 'base64'),

package/lib/index.d.ts

@@ -1,4 +1,4 @@
-import { Auth, Db, Document, MongoClient, SortDirection, UpdateDescription } from "mongodb";
+import { Db, Document, MongoClient, SortDirection, UpdateDescription } from "mongodb";
 import express from "express";
 import { CorsOptions } from "cors";
 import { Sort } from "mongodb";
@@ -223,6 +223,8 @@ interface MSocketHandshake {
     };
     /**
      * the access token of the user that initiated this handshake
+     * 
+     * N/B: make sure to always revalidate this when making sensitive request
      */
     userToken: string | undefined;
 }
@@ -279,7 +281,7 @@ interface MosquitoServerConfig {
     mongoInstances: MongoInstancesMap;
     mergeAuthAccount?: boolean;
     transformMediaRoute?: '*' | TransformMediaRoute[];
-    transformMediaCleanupTimeout?: string;
+    transformMediaCleanupTimeout?: number;
     sneakSignupAuth?: (config: SneakSignupAuthConfig) => SneakSignupAuthResult;
     googleAuthConfig?: GoogleAuthConfig;
     appleAuthConfig?: AppleAuthConfig;
@@ -297,6 +299,10 @@ interface MosquitoServerConfig {
     accessTokenInterval?: number;
     refreshTokenExpiry?: number;
     dumpsterPath?: string;
+    /**
+     * require an e2e public and private key like:
+     * `['public key', 'private key']`
+     */
     e2eKeyPair?: string[] | undefined;
     enforceE2E?: boolean;
     preMiddlewares?: Function[] | Function;
@@ -397,8 +403,25 @@ interface RawBodyRequest extends express.Request {
 export default class MosquitoDbServer {
     constructor(config: MosquitoServerConfig);
 
+    /**
+     * the directory where storage files are saved
+     */
+    get storagePath(): string;
+
+    /**
+     * quickly generate an end-to-end encryption key for your server
+     * @returns [public_string, private_string]
+     */
+    get sampleE2E(): string[];
+
     getDatabase(dbName?: string, dbUrl?: string): Db;
 
+    /**
+     * purge all tokens references for a user and sign-out the user immediately
+     * @param uid uid of the user you are signing out
+     */
+    signOutUser(uid: string): Promise<void>;
+
     /**
      * verify token to check if it was trully created using signerKey without checking against the expiry or local token reference
      * 

package/lib/index.js

@@ -14,11 +14,11 @@ import { validateFacebookAuthConfig } from "./products/auth/facebookAuth.js";
 import { validateGithubAuthConfig } from "./products/auth/githubAuth.js";
 import { validateTwitterAuthConfig } from "./products/auth/twitterAuth.js";
 import { validateFallbackAuthConfig } from "./products/auth/fallbackAuth.js";
-import { DisconnectionWriteTaskListener, StorageListener, UserCountReadyListener } from "./helpers/listeners.js";
+import { DisconnectionWriteTaskListener, SignoutUserSignal, StorageListener, UserCountReadyListener } from "./helpers/listeners.js";
 import EnginePath from "./helpers/EnginePath.js";
 import { Server } from "socket.io";
 import http from 'http';
-import { mkdir, readFile, unlink, writeFile, rm as rmdir } from "fs/promises";
+import { mkdir, readFile, unlink, writeFile, rm } from "fs/promises";
 import { cleanUserToken } from "./products/auth/customAuth.js";
 import { invalidateToken } from "./products/auth/customAuth.js";
 import cors from 'cors';
@@ -26,6 +26,9 @@ import { parse, stringify } from 'json-buffer';
 import { exec } from "child_process";
 import { createRequire } from 'node:module';
 import { MongoClient } from "mongodb";
+import naclPkg from 'tweetnacl';
+
+const { sign: e2eSign } = naclPkg;
 
 const _require = createRequire(import.meta.url);
 
@@ -356,7 +359,18 @@ const useMosquitoServer = (app, config) => {
         authLiveRoutes({ ...config }).map(e => e(socket, scope));
         databaseLiveRoutes({ ...config }).map(e => e(socket, scope));
 
-        if (initAuthHandshake?._m_internal || !onSocketSnapshot) return;
+        if (initAuthHandshake?._m_internal || !onSocketSnapshot) {
+            if (initAuthHandshake?._from_base) {
+                const signoutSignal = SignoutUserSignal.listenTo('d', () => {
+                    socket.emit('_signal_signout');
+                });
+
+                socket.on('disconnect', () => {
+                    signoutSignal();
+                });
+            }
+            return;
+        }
         try {
             const { e2e, ugly, accessKey: ak } = initAuthHandshake;
 
@@ -555,7 +569,7 @@ export default class MosquitoTransportServer {
 
         (async () => {
             try {
-                await rmdir(`${STORAGE_PREFIX_PATH(this.projectName)}/.vid_freezer`, {
+                await rm(`${STORAGE_PREFIX_PATH(this.projectName)}/.vid_freezer`, {
                     recursive: true,
                     force: true
                 });
@@ -567,6 +581,24 @@ export default class MosquitoTransportServer {
     get storagePath() {
         return STORAGE_PATH(this.projectName);
     }
+
+    get sampleE2E() {
+        const keyPair = e2eSign.keyPair();
+        return [
+            keyPair.publicKey,
+            keyPair.secretKey
+        ].map(v => Buffer.from(v).toString('base64'));
+    }
+
+    signOutUser = async (uid) => {
+        const db = getDB(this.projectName, ADMIN_DB_NAME, ADMIN_DB_URL);
+        await Promise.all([
+            db.collection(EnginePath.refreshTokenStore).deleteMany({ uid }),
+            db.collection(EnginePath.tokenStore).deleteMany({ uid })
+        ]);
+        SignoutUserSignal.dispatch('d', uid);
+    }
+
     verifyToken = (token, isRefreshToken) => verifyJWT(token, this.projectName, isRefreshToken);
     validateToken = (token, isRefreshToken) => validateJWT(token, this.projectName, isRefreshToken);
     invalidateToken = (token, isRefreshToken) => invalidateToken(token, this.projectName, isRefreshToken);
@@ -720,7 +752,7 @@ export default class MosquitoTransportServer {
         path = `${STORAGE_PATH(this.projectName)}/${path}`;
 
         removeVideoFreezer(path, true);
-        await rmdir(path, {
+        await rm(path, {
             recursive: true,
             force: true
         });

package/lib/products/database/index.js

@@ -325,6 +325,8 @@ const validateDbBody = (body, route) => {
                         if (!b.scope) throw simplifyError('required_field', `scope is required field at index ${i}`);
                     });
                 } else throw simplifyError('invalid_field_type', `"value" must be an array`);
+            } else if (k === 'stepping') {
+                if (typeof v !== 'boolean') throw simplifyError('invalid_value', `Invalid value supplied to stepping, expected a boolean but got ${v}`);
             } else throw simplifyError('invalid_field', `Unknown field "${k}"`);
         });
     } else if (route === '_readDocument' || route === '_listenDocument') {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mosquito-transport",
-  "version": "1.4.3",
+  "version": "1.4.5",
   "description": "MosquitoTransport is a powerful tool that helps persist and synchronize data between your MongoDB database and frontend applications",
   "main": "lib/index.js",
   "type": "module",
@@ -46,7 +46,6 @@
     "jsonwebtoken": "^9.0.0",
     "lodash": "^4.17.21",
     "mkdirp": "^3.0.1",
-    "mongodb": "^5.3.0",
     "node-fetch": "^3.3.1",
     "set-large-timeout": "^1.0.1",
     "socket.io": "^4.6.1",
@@ -54,6 +53,7 @@
     "tweetnacl": "^1.0.3"
   },
   "devDependencies": {
+    "@types/mongodb": "^4.0.7",
     "@babel/cli": "^7.21.5",
     "@babel/core": "^7.21.5",
     "@babel/node": "^7.20.7",