mosquito-transport 1.4.3

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Anthony
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,138 @@
+# mosquito-transport
+
+MosquitoTransport is a powerful tool that enables developers to persist and synchronize data between their MongoDB database and frontend applications. It offers a centralized and self-hosted solution for managing server infrastructure and data, along with robust authentication, real-time data updates, scalability, and cross-platform compatibility.
+
+Under the hood, mosquito-transport uses Mongodb to store it data and [express](https://www.npmjs.com/package/express), [socket.io](https://www.npmjs.com/package/socket.io) for making request and [jwt](https://www.npmjs.com/package/jsonwebtoken) for signing authentication token, so make sure you have [mongodb](https://www.mongodb.com/docs/manual/installation/) installed before using this package.
+
+## Key features of mosquito-transport include:
+
+- ### Data Persistence and Synchronization 🔁: 
+    - Seamlessly persist and synchronize data between MongoDB and frontend applications, ensuring consistency across all clients.
+
+- ### Self-Hosted Server 💾: 
+    - Host your own server infrastructure, giving you full control over data storage, access, and management.
+
+- ### 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 🔗:
+    - 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 🚨:
+    - Enable real-time updates to keep data synchronized across all clients in real-time, providing a seamless user experience.
+
+- ### Scalability and Performance 🚛:
+    - Benefit from auto-scaling and high performance, allowing your application to handle varying workloads with ease.
+
+- ### Cross-Platform Compatibility 📱:
+    - Compatible with React Native and web applications, allowing you to build cross-platform solutions with ease.
+
+
+## Installation
+
+```sh
+npm install mosquito-transport
+```
+
+or using yarn
+
+```sh
+yarn add mosquito-transport
+```
+
+## Usage
+
+```js
+import MosquitoTransportServer from "mosquito-transport";
+import { MongoClient } from 'mongodb';
+
+// create a mongodb instance
+const dbInstance = new MongoClient('mongodb://127.0.0.1:27017', {
+    useNewUrlParser: true,
+    useUnifiedTopology: true
+});
+
+dbInstance.connect().then(() => {
+    console.log('connected to mongodb at');
+}).catch(e => {
+    console.error('failed to connected to mongodb at');
+});
+
+// setup your server
+const serverApp = new MosquitoTransportServer({
+  projectName: 'app_name',
+  port: 4534, // defaults to 4291
+  signerKey: 'random_90_hash_key_for_signing_jwt_tokens', // must be 90 length
+  accessKey: 'this_is_my_private_password', // keep this private if you don't provide databaseRules or storageRules
+  mongoInstances: {
+      // this is where user info and tokens is stored
+      admin: {
+          instance: dbInstance,
+          defaultName: 'ADMIN_DB_NAME'
+      },
+      // this will be the default db if no dbName was provided
+      default: {
+          instance: dbInstance,
+          defaultName: 'DEFAULT_DB_NAME'
+      }
+  },
+  databaseRules: ({ auth, collection, value, afterData, beforeData, operation, ...otherProps })=> new Promise((resolve, reject)=> {
+    // validate and authorize all incoming request to the database
+    if (collection === 'user') {
+        if (afterData && auth && auth.uid === value._id) {
+            resolve(); // allow read/write
+        } else reject('You don`t own this data, stay away'); // reject read/write
+    } else if (collection === 'other_paths') {
+      // blah, blah, other algorithm ...
+    }
+  }),
+  storageRules: ({...props})=> new Promise(resolve=> {
+    // validate and authorize all uploads/downloads
+    resolve(true) // handle read/write yourself here
+  }),
+  googleAuthConfig: {
+    clientID: 'your_google_authentication_clientID.apps.googleusercontent.com'
+  },
+  appleAuthConfig: {
+    ...props
+  },
+  ...otherProps
+});
+```
+
+your server is now ready to be deploy on node.js! 🚀. Now install any mosquito-transport client sdk and start making requests to the server.
+
+### SDKs And Hacks
+- [react-native-mosquito-transport](https://github.com/deflexable/react-native-mosquito-transport) for react native apps
+- [mosquito-transport-web](https://github.com/brainbehindx/mosquito-transport-js) for web platform
+- [mongodb-hack-middleware](https://github.com/deflexable/mongodb-middleware-utils) for random query hack and fulltext search hack
+
+## Additional Documentations
+- [Logging Level](#logging-levels)
+- [Database Rules](#database-rules)
+- [Storage Rules](#storage-rules)
+- [Authentication](#authentication)
+   - [Merge Auth Account](#google-auth-setup)
+   - [Google Auth Setup](#google-auth-setup)
+   - [Apple Auth Setup](#apple-auth-setup)
+   - [Facebook Auth Setup](#facebook-auth-setup)
+   - [Twitter Auth Setup](#twitter-auth-setup)
+   - [Github Auth Setup](#google-auth-setup)
+   - [Fallback Auth Setup](#fallback-auth-setup)
+   - [Google Auth Setup](#google-auth-setup)
+
+
+<!-- ## Platform using MosquitoTransport in production
+- [Heavenya - christian events](https://heavenya.com)
+- [Inspire - christian audio](https://inspire.com)
+- [ExamJoint - learn, study and prepare for exam](https://examjoint.com) -->
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT
+
+---

package/lib/helpers/EnginePath.js

@@ -0,0 +1,8 @@
+
+const path = {
+    userAcct: 'userAcct',
+    tokenStore: 'tokenStore',
+    refreshTokenStore: 'refreshTokenStore'
+}
+
+export default { ...path };

package/lib/helpers/SocketHandler.d.ts

@@ -0,0 +1,6 @@
+import { Socket } from "socket.io";
+
+
+// export const handleSocketPlug: Server['on'];
+
+export function handleSocketPlug(path: string, callback: (socket: Socket, roof?: any, ...response: any) => void): (socket: Socket) => void;

package/lib/helpers/SocketHandler.js

@@ -0,0 +1,5 @@
+export const handleSocketPlug = (path, callback) => (socket, scope) => {
+    socket.on(path, function () {
+        callback(socket, scope, ...arguments);
+    });
+}

package/lib/helpers/listeners.js

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

package/lib/helpers/utils.js

@@ -0,0 +1,105 @@
+import naclPkg from 'tweetnacl';
+import { Scoped } from './variables';
+
+const { box, randomBytes } = naclPkg;
+
+export const simplifyError = (error, message) => ({
+    simpleError: { error, message }
+});
+
+export const simplifyCaughtError = (e) => e?.simpleError ? e : simplifyError('unexpected_error', `${e}`);
+
+export const getRandomString = (length = 20, number = true, capLetter = true, smallLetter = true) => {
+    const randomChars = `${capLetter ? 'ABCDEFGHIJKLMNOPQRSTUVWXYZ' : ''}${smallLetter ? 'abcdefghijklmnopqrstuvwxyz' : ''}${number ? '0123456789' : ''}`;
+
+    return Array(length).fill(0).map(() => randomChars.charAt(Math.round(Math.random() * randomChars.length))).join('');
+}
+
+export const IS_RAW_OBJECT = (e) => e && typeof e === 'object' && !Array.isArray(e);
+
+export const IS_JSON_OBJECT = (o) => o !== null &&
+    typeof o === 'object' &&
+    (Object.prototype.toString.call(o) === '[object Object]' ||
+        Object.prototype.toString.call(o) === '[object Array]' ||
+        Array.isArray(o));
+
+export const IS_WHOLE_NUMBER = (v) => typeof v === 'number' && !`${v}`.includes('.');
+
+export const queryEntries = (obj, lastPath = '', exceptions = [], seperator = '.') => {
+    let o = [];
+
+    Object.entries(obj).forEach(([key, value]) => {
+        if (IS_RAW_OBJECT(value) && !exceptions.includes(key)) {
+            o = [...o, ...queryEntries(value, `${lastPath}${key}${seperator}`, exceptions, seperator)];
+        } else o.push([`${lastPath}${key}`, value]);
+    });
+
+    return o;
+}
+
+export const niceTry = (promise) => new Promise(async resolve => {
+
+    try {
+        const r = await promise();
+        resolve(r);
+    } catch (e) {
+        console.error('niceTry encounter an error: ', e);
+        resolve();
+    }
+});
+
+export const deserializeE2E = (data, projectName) => {
+    try {
+        const [clientPubKey, clientNonce, clientData] = data.split('.'),
+            [_, serverPrivateKey] = Scoped.InstancesData[projectName].E2E_BufferPair || [];
+
+        if (serverPrivateKey) throw '"e2eKeyPair" is required for decrypting a e2e messages';
+        const baseArray = box.open(
+            Buffer.from(clientData, 'base64'),
+            Buffer.from(clientNonce, 'base64'),
+            Buffer.from(clientPubKey, 'base64'),
+            serverPrivateKey
+        );
+        if (!baseArray) throw 'The server was unable to decrypt the reqest body';
+
+        const decryptedData = JSON.parse(Buffer.from(baseArray).toString('utf8'));
+
+        return [decryptedData[0], clientPubKey, decryptedData[1]];
+    } catch (e) {
+        throw simplifyError('decryption_failed', `${e}`);
+    }
+}
+
+export const serializeE2E = (message, clientPublicKey, projectName) => {
+    const nonce = randomBytes(box.nonceLength),
+        nonceBase64 = Buffer.from(nonce).toString('base64');
+
+    const [_, serverPrivateKey] = Scoped.InstancesData[projectName].E2E_BufferPair || [];
+
+    return `${nonceBase64}.${Buffer.from(
+        box(
+            Buffer.from(JSON.stringify([
+                message
+            ]), 'utf8'),
+            nonce,
+            Buffer.from(clientPublicKey, 'base64'),
+            serverPrivateKey
+        )
+    ).toString('base64')}`;
+}
+
+export const requestURL = (request) => {
+    return new URL(request.url, `http://${request.headers.host}`);
+}
+
+export const getStringExtension = (url) => {
+    const r = url.split(/[#?]/)[0].split(".").pop().trim();
+    return r === url ? '' : r;
+}
+
+export const interpolate = (x, [y1, x1], [y2, x2]) => {
+    return y1 + ((x - x1) * ((y2 - y1) / (x2 - x1)));
+}
+
+export const encodeBinary = (s) => Buffer.from(s, 'utf8').toString('base64');
+export const decodeBinary = (s) => Buffer.from(s, 'base64').toString('utf8');

package/lib/helpers/values.js

@@ -0,0 +1,76 @@
+import { Scoped } from "./variables";
+import { join } from 'path';
+
+export const DEFAULT_DB = Symbol('default_db');
+export const ADMIN_DB_NAME = Symbol('admin_db_name');
+export const ADMIN_DB_URL = Symbol('admin_db');
+
+export const DEFAULT_STORAGE_PATH = '';
+export const BACKUP_STORAGE_PATH = '';
+
+export const one_day = 86400000,
+    one_week = 604800000,
+    one_month = 2419200000,
+    one_hour = 3600000,
+    one_minute = 60000;
+
+export const one_mb = 1048576;
+
+export const STORAGE_ROUTE = '/storage';
+
+export const STORAGE_URL_TO_FILE = (link = '', projectName) => {
+    try {
+        const url = new URL(link);
+        if (!url) throw '';
+        return `${STORAGE_PATH(projectName)}${url.pathname.substring(STORAGE_ROUTE.length)}`;
+    } catch (e) {
+        return null;
+    }
+}
+
+export const STORAGE_PATH = (projectName) => `${STORAGE_PREFIX_PATH(projectName)}/.dump/${projectName}`;
+export const STORAGE_PREFIX_PATH = (projectName) => `${Scoped.InstancesData[projectName].dumpsterPath || process.cwd()}`;
+export const STORAGE_FREEZER_DIR = (projectName) => join(STORAGE_PREFIX_PATH(projectName), '.vid_freezer');
+
+export const TOKEN_EXPIRY = (projectName) => (Scoped.InstancesData[projectName].accessTokenInterval || one_hour);
+export const REFRESH_TOKEN_EXPIRY = (projectName) => (Scoped.InstancesData[projectName]?.refreshTokenExpiry || one_month);
+
+export const REGEX = {
+    LINK_REGEX: () => /(\b(https?|ftp|file):\/\/[-A-Z0-9+&@#\/%?=~_|!:,.;]*[-A-Z0-9+&@#\/%=~_|])/ig,
+    EMAIL: () => ({
+        test: (t) => typeof t === 'string' &&
+            /^\w+([\.-]?\w+)*@\w+([\.-]?\w+)*(\.\w{2,3})+$/.test(t) &&
+            !!t.trim() &&
+            t.trim().length <= 1000
+    }),
+    USERNAME_REGEX: () => /^[a-zA-Z0-9](_(?!(\.|_))|\.(?!(_|\.))|[a-zA-Z0-9]){2,30}[a-zA-Z0-9]$/,
+    PHONE_NUMBER: () => /^[+]?[\s./0-9]*[(]?[0-9]{1,4}[)]?[-\s./0-9]*$/g,
+    NAME: () => ({ test: (t) => typeof t === 'string' && !!t.trim() && t.trim().length <= 500 })
+};
+
+export const EngineRoutes = {
+    _listenUserVerification: '_listenUserVerification',
+    _customSignin: '_customSignin',
+    _customSignup: '_customSignup',
+    _refreshAuthToken: '_refreshAuthToken',
+    _googleSignin: '_googleSignin',
+    _appleSignin: '_appleSignin',
+    _facebookSignin: '_facebookSignin',
+    _twitterSignin: '_twitterSignin',
+    _githubSignin: '_githubSignin',
+    _signOut: '_signOut',
+    _invalidateToken: '_invalidateToken',
+    _uploadFile: '_uploadFile',
+    _deleteFile: '_deleteFile',
+    _deleteFolder: '_deleteFolder',
+    _listenCollection: '_listenCollection',
+    _listenDocument: '_listenDocument',
+    _startDisconnectWriteTask: '_startDisconnectWriteTask',
+    _cancelDisconnectWriteTask: '_cancelDisconnectWriteTask',
+    _readDocument: '_readDocument',
+    _queryCollection: '_queryCollection',
+    _writeDocument: '_writeDocument',
+    _writeMapDocument: '_writeMapDocument',
+    _documentCount: '_documentCount',
+    _areYouOk: '_areYouOk'
+};

package/lib/helpers/variables.js

@@ -0,0 +1,13 @@
+export const Scoped = {
+    pendingSignups: {},
+    TokenSelfDestruction: {
+        RefreshToken: {},
+        AccessToken: {}
+    },
+    cacheTranformVideoTimer: {},
+    SequentialUid: {},
+    Databases: {},
+    serverInstances: {},
+    expressInstances: {},
+    InstancesData: {}
+}