datasquirel/engine/query/get.js

101 lines
3.0 KiB
JavaScript
Raw Normal View History

2023-08-15 04:13:25 +00:00
/** # MODULE TRACE
======================================================================
* No imports found for this Module
==== MODULE TRACE END ==== */
2023-08-12 13:36:18 +00:00
// @ts-check
const runQuery = require("./utils/runQuery");
/**
* @typedef {Object} LocalGetReturn
* @property {boolean} success - Did the function run successfully?
2023-08-12 15:46:00 +00:00
* @property {*} [payload] - GET request results
2023-08-12 13:36:18 +00:00
* @property {string} [msg] - Message
* @property {string} [error] - Error Message
*/
/**
* @typedef {Object} LocalQueryObject
* @property {string} query - Table Name
* @property {string} [tableName] - Table Name
* @property {string[]} [queryValues] - GET request results
*/
/**
* Make a get request to Datasquirel API
* ==============================================================================
* @async
*
* @param {Object} params - Single object passed
* @param {LocalQueryObject} params.options - SQL Query
* @param {import("../../types/database-schema.td").DSQL_DatabaseSchemaType} [params.dbSchema] - Name of the table to query
*
* @returns { Promise<LocalGetReturn> } - Return Object
*/
async function localGet({ options, dbSchema }) {
try {
2023-08-12 16:23:52 +00:00
const { query, queryValues } = options;
2023-08-12 13:36:18 +00:00
/** @type {string | undefined | any } */
const tableName = options?.tableName ? options.tableName : undefined;
const dbFullName = process.env.DSQL_DB_NAME || "";
/**
* Input Validation
*
* @description Input Validation
*/
if (typeof query == "string" && (query.match(/^alter|^delete|information_schema|databases|^create/i) || !query.match(/^select/i))) {
return { success: false, msg: "Wrong Input" };
}
/**
* Create new user folder and file
*
* @description Create new user folder and file
*/
let results;
try {
let { result, error } = await runQuery({
dbFullName: dbFullName,
query: query,
queryValuesArray: queryValues,
dbSchema,
tableName,
});
if (error) throw error;
2023-08-15 04:13:25 +00:00
if (result?.error) throw new Error(result.error);
2023-08-12 13:36:18 +00:00
results = result;
return { success: true, payload: results };
////////////////////////////////////////
2023-08-13 13:56:56 +00:00
} catch (/** @type {*} */ error) {
2023-08-12 13:36:18 +00:00
////////////////////////////////////////
console.log("Error in local get Request =>", error.message);
2023-08-15 04:13:25 +00:00
return {
success: false,
payload: null,
error: error.message,
};
2023-08-12 13:36:18 +00:00
}
////////////////////////////////////////
2023-08-13 13:56:56 +00:00
} catch (/** @type {*} */ error) {
2023-08-12 13:36:18 +00:00
////////////////////////////////////////
console.log("Error in local get Request =>", error.message);
return { success: false, msg: "Something went wrong!" };
////////////////////////////////////////
}
}
module.exports = localGet;