updates

utils/get-schema.js

@@ -0,0 +1,89 @@
+// @ts-check
+
+/**
+ * ==============================================================================
+ * Imports
+ * ==============================================================================
+ */
+const https = require("https");
+
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+/** ****************************************************************************** */
+
+/**
+ * @typedef {Object} GetSchemaReturn
+ * @property {boolean} success - Did the function run successfully?
+ * @property {import("../types/database-schema.td").DSQL_DatabaseSchemaType[] | import("../types/database-schema.td").DSQL_DatabaseSchemaType | null} payload - Response payload
+ */
+
+/**
+ * Make a get request to Datasquirel API
+ * ==============================================================================
+ * @async
+ *
+ * @param {Object} params - Single object passed
+ * @param {string} params.key - `FULL ACCESS` API Key
+ * @param {string} [params.database] - The database schema to get
+ *
+ * @returns { Promise<GetSchemaReturn> } - Return Object
+ */
+async function getSchema({ key, database }) {
+    /**
+     * Make https request
+     *
+     * @description make a request to datasquirel.com
+     */
+    const httpResponse = await new Promise((resolve, reject) => {
+        https
+            .request(
+                {
+                    method: "GET",
+                    headers: {
+                        "Content-Type": "application/json",
+                        Authorization: key,
+                    },
+                    port: 443,
+                    hostname: "datasquirel.com",
+                    path: "/api/query/get-schema" + (database ? `?database=${database}` : ""),
+                },
+
+                /**
+                 * Callback Function
+                 *
+                 * @description https request callback
+                 */
+                (response) => {
+                    var str = "";
+
+                    response.on("data", function (chunk) {
+                        str += chunk;
+                    });
+
+                    response.on("end", function () {
+                        resolve(JSON.parse(str));
+                    });
+
+                    response.on("error", (err) => {
+                        reject(err);
+                    });
+                }
+            )
+            .end();
+    });
+
+    /** ********************************************** */
+    /** ********************************************** */
+    /** ********************************************** */
+
+    return httpResponse;
+}
+
+/** ********************************************** */
+/** ********************************************** */
+/** ********************************************** */
+
+module.exports = getSchema;

utils/get.js

@@ -1,9 +1,14 @@
+// @ts-check
+
 /**
  * ==============================================================================
  * Imports
  * ==============================================================================
  */
 const https = require("https");
+const path = require("path");
+const fs = require("fs");
+const localGet = require("../bin/query/get");
 
 /** ****************************************************************************** */
 /** ****************************************************************************** */
@@ -15,7 +20,9 @@ const https = require("https");
 /**
  * @typedef {Object} GetReturn
  * @property {boolean} success - Did the function run successfully?
- * @property {(Object[]|string)} [payload=[]] - GET request results
+ * @property {(Object[]|string|null|object)} [payload] - GET request results
+ * @property {string} [msg] - Message
+ * @property {string} [error] - Error Message
  */
 
 /**
@@ -33,6 +40,34 @@ const https = require("https");
  * @returns { Promise<GetReturn> } - Return Object
  */
 async function get({ key, db, query, queryValues, tableName }) {
+    /**
+     * 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) {}
+
+        console.log("Reading from local database ...");
+
+        return await localGet({
+            dbSchema: dbSchema,
+            options: {
+                query: query,
+                queryValues: queryValues,
+                tableName: tableName,
+            },
+        });
+    }
+
     /**
      * Make https request
      *