Add Email Login: Update

users/login-user.js

@@ -191,18 +191,18 @@ async function loginUser({
                  *
                  * @description https request callback
                  */
-                (response) => {
+                (res) => {
                     var str = "";
 
-                    response.on("data", function (chunk) {
+                    res.on("data", function (chunk) {
                         str += chunk;
                     });
 
-                    response.on("end", function () {
+                    res.on("end", function () {
                         resolve(JSON.parse(str));
                     });
 
-                    response.on("error", (err) => {
+                    res.on("error", (err) => {
                         reject(err);
                     });
                 }

users/send-email-code.js

@@ -0,0 +1,198 @@
+// @ts-check
+
+/**
+ * ==============================================================================
+ * Imports
+ * ==============================================================================
+ */
+const http = require("http");
+const https = require("https");
+const fs = require("fs");
+const path = require("path");
+const encrypt = require("../functions/encrypt");
+const loginLocalUser = require("../engine/user/login-user");
+const localSendEmailCode = require("../engine/user/send-email-code");
+
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+
+/**
+ * @typedef {object} AuthenticatedUser
+ * @property {boolean} success - Did the function run successfully?
+ * @property {import("../types/user.td").DATASQUIREL_LoggedInUser  | null} payload - Payload of the response
+ * @property {string} [msg] - An optional message
+ * @property {number} [userId] - An optional message
+ */
+
+/**
+ * Send Email Code to a User
+ * ==============================================================================
+ * @async
+ *
+ * @param {object} params - Single Param object containing params
+ * @param {String} params.key - FULL ACCESS API Key
+ * @param {String} params.database - Target Database
+ * @param {string} params.email Login Email/Username and Password
+ * @param {http.ServerResponse} params.response - Http response object
+ * @param {String} params.encryptionKey - Encryption Key
+ * @param {String} params.encryptionSalt - Encryption Salt
+ * @param {string} [params.temp_code_field] - Database table field name for temporary code
+ *
+ * @returns { Promise<boolean>}
+ */
+async function sendEmailCode({
+    key,
+    email,
+    database,
+    encryptionKey,
+    encryptionSalt,
+    temp_code_field,
+}) {
+    const scheme = process.env.DSQL_HTTP_SCHEME;
+    const localHost = process.env.DSQL_LOCAL_HOST;
+    const localHostPort = process.env.DSQL_LOCAL_HOST_PORT;
+
+    const defaultTempLoginFieldName = "temp_login_code";
+    const emailLoginTempCodeFieldName = temp_code_field
+        ? temp_code_field
+        : defaultTempLoginFieldName;
+
+    /**
+     * Check Encryption Keys
+     *
+     * @description Check Encryption Keys
+     */
+    if (!encryptionKey?.match(/./)) return false;
+
+    if (!encryptionSalt?.match(/./)) return false;
+
+    if (encryptionKey.length < 24) return false;
+
+    if (encryptionSalt.length < 8) return false;
+
+    /**
+     * Initialize HTTP response variable
+     */
+    let httpResponse;
+
+    /**
+     * Check for local DB settings
+     *
+     * @description Look for local db settings in `.env` file and by pass the http request if available
+     */
+    const {
+        DSQL_HOST,
+        DSQL_USER,
+        DSQL_PASS,
+        DSQL_DB_NAME,
+        DSQL_KEY,
+        DSQL_REF_DB_NAME,
+        DSQL_FULL_SYNC,
+    } = process.env;
+
+    if (
+        DSQL_HOST?.match(/./) &&
+        DSQL_USER?.match(/./) &&
+        DSQL_PASS?.match(/./) &&
+        DSQL_DB_NAME?.match(/./)
+    ) {
+        /** @type {import("../types/database-schema.td").DSQL_DatabaseSchemaType | undefined} */
+        let dbSchema;
+
+        try {
+            const localDbSchemaPath = path.resolve(
+                process.cwd(),
+                "dsql.schema.json"
+            );
+            dbSchema = JSON.parse(fs.readFileSync(localDbSchemaPath, "utf8"));
+        } catch (error) {}
+
+        if (dbSchema) {
+            httpResponse = await localSendEmailCode({
+                email,
+                dbSchema,
+                email_login_field: emailLoginTempCodeFieldName,
+            });
+        }
+    } else {
+        /**
+         * Make https request
+         *
+         * @description make a request to datasquirel.com
+         *
+         * @type {{ success: boolean, payload: import("../types/user.td").DATASQUIREL_LoggedInUser | null, userId?: number, msg?: string }}
+         */
+        httpResponse = await new Promise((resolve, reject) => {
+            const reqPayload = JSON.stringify({
+                email,
+                database,
+                email_login_field: emailLoginTempCodeFieldName,
+            });
+
+            const httpsRequest = (
+                scheme?.match(/^http$/i) ? http : https
+            ).request(
+                {
+                    method: "POST",
+                    headers: {
+                        "Content-Type": "application/json",
+                        "Content-Length": Buffer.from(reqPayload).length,
+                        Authorization: key,
+                    },
+                    port: localHostPort || 443,
+                    hostname: localHost || "datasquirel.com",
+                    path: `/api/user/send-email-code`,
+                },
+
+                /**
+                 * Callback Function
+                 *
+                 * @description https request callback
+                 */
+                (res) => {
+                    var str = "";
+
+                    res.on("data", function (chunk) {
+                        str += chunk;
+                    });
+
+                    res.on("end", function () {
+                        resolve(JSON.parse(str));
+                    });
+
+                    res.on("error", (err) => {
+                        reject(err);
+                    });
+                }
+            );
+
+            httpsRequest.write(reqPayload);
+            httpsRequest.end();
+        });
+    }
+
+    /** ********************************************** */
+    /** ********************************************** */
+    /** ********************************************** */
+
+    /**
+     * Make https request
+     *
+     * @description make a request to datasquirel.com
+     */
+    if (httpResponse?.success) {
+        return true;
+    } else {
+        return false;
+    }
+}
+
+/** ********************************************** */
+/** ********************************************** */
+/** ********************************************** */
+
+module.exports = sendEmailCode;