Moduletrace/dsql-admin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updates

Browse Source
This commit is contained in:
Benjamin Toby
2025-01-13 09:00:21 +01:00
parent 6364f6a312
commit e0a030f10d
859 changed files with 5397 additions and 10163 deletions
Download Patch File Download Diff File Expand all files Collapse all files
dsql-app/package-shared/utils/backend/global-db/DB_HANDLER.js
-45
View File
@@ -1,45 +0,0 @@
// @ts-check
const mysql = require("serverless-mysql");
const grabDbSSL = require("../grabDbSSL");
const MASTER = mysql({
config: {
host: process.env.DSQL_DB_HOST,
user: process.env.DSQL_DB_USERNAME,
password: process.env.DSQL_DB_PASSWORD,
database: process.env.DSQL_DB_NAME,
port: process.env.DSQL_DB_PORT
? Number(process.env.DSQL_DB_PORT)
: undefined,
charset: "utf8mb4",
ssl: grabDbSSL(),
},
});
/**
* DSQL user read-only DB handler
* @param {object} params
* @param {string} params.paradigm
* @param {string} params.database
* @param {string} params.queryString
* @param {string[]} [params.queryValues]
*/ // @ts-ignore
async function DB_HANDLER(...args) {
try {
const results = await MASTER.query(...args);
/** ********************* Clean up */
await MASTER.end();
return JSON.parse(JSON.stringify(results));
} catch (/** @type {any} */ error) {
console.log("DB Error =>", error);
return {
success: false,
error: error.message,
};
}
}
module.exports = DB_HANDLER;
dsql-app/package-shared/utils/backend/global-db/DB_HANDLER.ts
+24
View File
@@ -0,0 +1,24 @@
/**
* # DSQL user read-only DB handler
* @requires DSQL_DB_CONN - Gobal Variable for Datasquirel Database
*/
export default async function DB_HANDLER(...args: any[]) {
const CONNECTION = global.DSQL_DB_CONN;
try {
if (!CONNECTION)
throw new Error("No Connection provided to DB_HANDLER function!");
const results = await CONNECTION.query(...args);
return JSON.parse(JSON.stringify(results));
} catch (error: any) {
console.log("DB Error =>", error);
return {
success: false,
error: error.message,
};
} finally {
await CONNECTION?.end();
}
}
dsql-app/package-shared/utils/backend/global-db/DSQL_USER_DB_HANDLER.js
-122
View File
@@ -1,122 +0,0 @@
// @ts-check
const fs = require("fs");
const path = require("path");
const mysql = require("serverless-mysql");
const grabDbSSL = require("../grabDbSSL");
let DSQL_USER = mysql({
config: {
host: process.env.DSQL_DB_HOST,
user: process.env.DSQL_DB_READ_ONLY_USERNAME,
password: process.env.DSQL_DB_READ_ONLY_PASSWORD,
charset: "utf8mb4",
ssl: grabDbSSL(),
},
});
/**
* DSQL user read-only DB handler
* @param {object} params
* @param {"Full Access" | "FA" | "Read Only"} params.paradigm
* @param {string} params.database
* @param {string} params.queryString
* @param {string[]} [params.queryValues]
*/
function DSQL_USER_DB_HANDLER({
paradigm,
database,
queryString,
queryValues,
}) {
try {
return new Promise((resolve, reject) => {
const fullAccess = paradigm?.match(/full.access|^fa$/i)
? true
: false;
try {
if (fullAccess) {
DSQL_USER = mysql({
config: {
host: process.env.DSQL_DB_HOST,
user: process.env.DSQL_DB_FULL_ACCESS_USERNAME,
password: process.env.DSQL_DB_FULL_ACCESS_PASSWORD,
database: database,
ssl: grabDbSSL(),
},
});
} else {
DSQL_USER = mysql({
config: {
host: process.env.DSQL_DB_HOST,
user: process.env.DSQL_DB_READ_ONLY_USERNAME,
password: process.env.DSQL_DB_READ_ONLY_PASSWORD,
database: database,
ssl: grabDbSSL(),
},
});
}
/**
* ### Run query Function
* @param {any} results
*/
function runQuery(results) {
DSQL_USER.end();
resolve(JSON.parse(JSON.stringify(results)));
}
/**
* ### Query Error
* @param {any} err
*/
function queryError(err) {
DSQL_USER.end();
resolve({
error: err.message,
queryStringGenerated: queryString,
queryValuesGenerated: queryValues,
sql: err.sql,
});
}
if (
queryValues &&
Array.isArray(queryValues) &&
queryValues[0]
) {
DSQL_USER.query(queryString, queryValues)
.then(runQuery)
.catch(queryError);
} else {
DSQL_USER.query(queryString)
.then(runQuery)
.catch(queryError);
}
////////////////////////////////////////
} catch (/** @type {any} */ error) {
////////////////////////////////////////
fs.appendFileSync(
"./.tmp/dbErrorLogs.txt",
error.message + "\n" + Date() + "\n\n\n",
"utf8"
);
resolve({
error: error.message,
});
}
});
} catch (/** @type {any} */ error) {
return {
success: false,
error: error.message,
};
}
}
module.exports = DSQL_USER_DB_HANDLER;
dsql-app/package-shared/utils/backend/global-db/DSQL_USER_DB_HANDLER.ts
+135
View File
@@ -0,0 +1,135 @@
import connDbHandler from "../../db/conn-db-handler";
type Param = {
paradigm: "Full Access" | "FA" | "Read Only";
queryString: string;
queryValues?: string[];
};
/**
* # DSQL user read-only DB handler
*/
export default async function DSQL_USER_DB_HANDLER({
paradigm,
queryString,
queryValues,
}: Param) {
try {
switch (paradigm) {
case "Read Only":
return await connDbHandler(
global.DSQL_READ_ONLY_DB_CONN,
queryString,
queryValues
);
case "Full Access":
return await connDbHandler(
global.DSQL_FULL_ACCESS_DB_CONN,
queryString,
queryValues
);
case "FA":
return await connDbHandler(
global.DSQL_FULL_ACCESS_DB_CONN,
queryString,
queryValues
);
default:
return null;
}
} catch (error: any) {
console.log(`DSQL_USER_DB_HANDLER Error: ${error.message}`);
return null;
}
// try {
// return new Promise((resolve, reject) => {
// const fullAccess = paradigm?.match(/full.access|^fa$/i)
// ? true
// : false;
// try {
// if (fullAccess) {
// DSQL_USER = mysql({
// config: {
// host: process.env.DSQL_DB_HOST,
// user: process.env.DSQL_DB_FULL_ACCESS_USERNAME,
// password: process.env.DSQL_DB_FULL_ACCESS_PASSWORD,
// database: database,
// ssl: grabDbSSL(),
// },
// });
// } else {
// DSQL_USER = mysql({
// config: {
// host: process.env.DSQL_DB_HOST,
// user: process.env.DSQL_DB_READ_ONLY_USERNAME,
// password: process.env.DSQL_DB_READ_ONLY_PASSWORD,
// database: database,
// ssl: grabDbSSL(),
// },
// });
// }
// /**
// * ### Run query Function
// * @param {any} results
// */
// function runQuery(results: any) {
// DSQL_USER.end();
// resolve(JSON.parse(JSON.stringify(results)));
// }
// /**
// * ### Query Error
// * @param {any} err
// */
// function queryError(err: any) {
// DSQL_USER.end();
// resolve({
// error: err.message,
// queryStringGenerated: queryString,
// queryValuesGenerated: queryValues,
// sql: err.sql,
// });
// }
// if (
// queryValues &&
// Array.isArray(queryValues) &&
// queryValues[0]
// ) {
// DSQL_USER.query(queryString, queryValues)
// .then(runQuery)
// .catch(queryError);
// } else {
// DSQL_USER.query(queryString)
// .then(runQuery)
// .catch(queryError);
// }
// ////////////////////////////////////////
// } catch (/** @type {any} */ error: any) {
// ////////////////////////////////////////
// fs.appendFileSync(
// "./.tmp/dbErrorLogs.txt",
// error.message + "\n" + Date() + "\n\n\n",
// "utf8"
// );
// resolve({
// error: error.message,
// });
// }
// });
// } catch (/** @type {any} */ error: any) {
// return {
// success: false,
// error: error.message,
// };
// }
}
dsql-app/package-shared/utils/backend/global-db/LOCAL_DB_HANDLER.js → dsql-app/package-shared/utils/backend/global-db/LOCAL_DB_HANDLER.ts
+7 -16
View File
@@ -1,17 +1,10 @@
// @ts-check
const mysql = require("serverless-mysql");
const grabDbSSL = require("../grabDbSSL");
import mysql from "serverless-mysql";
import grabDbSSL from "../grabDbSSL";
/**
* DSQL user read-only DB handler
* @param {object} params
* @param {string} params.paradigm
* @param {string} params.database
* @param {string} params.queryString
* @param {string[]} [params.queryValues]
* # DSQL user read-only DB handler
*/
async function LOCAL_DB_HANDLER(/** @type {any[]} */ ...args) {
export default async function LOCAL_DB_HANDLER(...args: any[]) {
const MASTER = mysql({
config: {
host: process.env.DSQL_DB_HOST,
@@ -27,10 +20,10 @@ async function LOCAL_DB_HANDLER(/** @type {any[]} */ ...args) {
onConnect: () => {
console.log("Connection Successful!");
},
onConnectError: (/** @type {any} */ err) => {
onConnectError: (/** @type {any} */ err: any) => {
console.log("Connection Error", err.message);
},
onError: (/** @type {any} */ err) => {
onError: (/** @type {any} */ err: any) => {
console.log("Client Error", err.message);
},
});
@@ -42,7 +35,7 @@ async function LOCAL_DB_HANDLER(/** @type {any[]} */ ...args) {
await MASTER.end();
return JSON.parse(JSON.stringify(results));
} catch (/** @type {any} */ error) {
} catch (/** @type {any} */ error: any) {
console.log("DB Error =>", error.message);
return {
success: false,
@@ -50,5 +43,3 @@ async function LOCAL_DB_HANDLER(/** @type {any[]} */ ...args) {
};
}
}
module.exports = LOCAL_DB_HANDLER;
dsql-app/package-shared/utils/backend/global-db/NO_DB_HANDLER.js
-48
View File
@@ -1,48 +0,0 @@
// @ts-check
const mysql = require("serverless-mysql");
const grabDbSSL = require("../grabDbSSL");
let NO_DB = mysql({
config: {
host: process.env.DSQL_DB_HOST,
user: process.env.DSQL_DB_USERNAME,
password: process.env.DSQL_DB_PASSWORD,
charset: "utf8mb4",
ssl: grabDbSSL(),
},
});
/**
* DSQL user read-only DB handler
* @param {object} params
* @param {string} params.paradigm
* @param {string} params.database
* @param {string} params.queryString
* @param {string[]} [params.queryValues]
*/ // @ts-ignore
function NO_DB_HANDLER(...args) {
try {
return new Promise((resolve, reject) => {
NO_DB.query(...args)
.then((results) => {
NO_DB.end();
resolve(JSON.parse(JSON.stringify(results)));
})
.catch((err) => {
NO_DB.end();
resolve({
error: err.message,
sql: err.sql,
});
});
});
} catch (/** @type {any} */ error) {
return {
success: false,
error: error.message,
};
}
}
module.exports = NO_DB_HANDLER;
dsql-app/package-shared/utils/backend/global-db/NO_DB_HANDLER.ts
+31
View File
@@ -0,0 +1,31 @@
import mysql from "serverless-mysql";
import grabDbSSL from "../grabDbSSL";
/**
* # DSQL user read-only DB handler
*/
export default function NO_DB_HANDLER(...args: any[]) {
const NO_DB = global.DSQL_DB_CONN;
try {
return new Promise((resolve, reject) => {
NO_DB.query(...args)
.then((results) => {
NO_DB.end();
resolve(JSON.parse(JSON.stringify(results)));
})
.catch((err) => {
NO_DB.end();
resolve({
error: err.message,
sql: err.sql,
});
});
});
} catch (error: any) {
return {
success: false,
error: error.message,
};
}
}
dsql-app/package-shared/utils/backend/global-db/ROOT_DB_HANDLER.js
-48
View File
@@ -1,48 +0,0 @@
// @ts-check
const mysql = require("serverless-mysql");
const grabDbSSL = require("../grabDbSSL");
let NO_DB = mysql({
config: {
host: process.env.DSQL_DB_HOST,
user: process.env.DSQL_DB_USERNAME,
password: process.env.DSQL_DB_PASSWORD,
charset: "utf8mb4",
ssl: grabDbSSL(),
},
});
/**
* DSQL user read-only DB handler
* @param {object} params
* @param {string} params.paradigm
* @param {string} params.database
* @param {string} params.queryString
* @param {string[]} [params.queryValues]
*/ // @ts-ignore
function ROOT_DB_HANDLER(...args) {
try {
return new Promise((resolve, reject) => {
NO_DB.query(...args)
.then((results) => {
NO_DB.end();
resolve(JSON.parse(JSON.stringify(results)));
})
.catch((err) => {
NO_DB.end();
resolve({
error: err.message,
sql: err.sql,
});
});
});
} catch (/** @type {any} */ error) {
return {
success: false,
error: error.message,
};
}
}
module.exports = ROOT_DB_HANDLER;
dsql-app/package-shared/utils/backend/global-db/ROOT_DB_HANDLER.ts
+28
View File
@@ -0,0 +1,28 @@
/**
* # Root DB handler
*/
export default function ROOT_DB_HANDLER(...args: any[]) {
const NO_DB = global.DSQL_DB_CONN;
try {
return new Promise((resolve, reject) => {
NO_DB.query(...args)
.then((results) => {
NO_DB.end();
resolve(JSON.parse(JSON.stringify(results)));
})
.catch((err) => {
NO_DB.end();
resolve({
error: err.message,
sql: err.sql,
});
});
});
} catch (error: any) {
return {
success: false,
error: error.message,
};
}
}
dsql-app/package-shared/utils/backend/grabDbSSL.js
-24
View File
@@ -1,24 +0,0 @@
// @ts-check
const fs = require("fs");
/**
* @returns {string | (import("tls").SecureContextOptions & { rejectUnauthorized?: boolean | undefined;}) | undefined}
*/
module.exports = function grabDbSSL() {
const SSL_DIR = process.env.DSQL_SSL_DIR;
if (!SSL_DIR?.match(/./)) {
return undefined;
}
const caFilePath = `${SSL_DIR}/ca-cert.pem`;
if (!fs.existsSync(caFilePath)) {
console.log(`${caFilePath} does not exist`);
return undefined;
}
return {
ca: fs.readFileSync(`${SSL_DIR}/ca-cert.pem`),
};
};
dsql-app/package-shared/utils/backend/grabDbSSL.ts
+32
View File
@@ -0,0 +1,32 @@
import fs from "fs";
type Return =
| string
| (import("tls").SecureContextOptions & {
rejectUnauthorized?: boolean | undefined;
})
| undefined;
/**
* # Grall SSL
*/
export default function grabDbSSL(): Return {
const SSL_DIR = process.env.DSQL_SSL_DIR;
if (!SSL_DIR?.match(/./)) {
return undefined;
}
const caFilePath = `${SSL_DIR}/ca-cert.pem`;
if (!fs.existsSync(caFilePath)) {
console.log(`${caFilePath} does not exist`);
return undefined;
}
return {
ca: fs.readFileSync(`${SSL_DIR}/ca-cert.pem`),
// key: fs.readFileSync(`${SSL_DIR}/client-key.pem`),
// cert: fs.readFileSync(`${SSL_DIR}/client-cert.pem`),
rejectUnauthorized: false,
};
}
dsql-app/package-shared/utils/backend/parseCookies.js → dsql-app/package-shared/utils/backend/parseCookies.ts
+12 -18
View File
@@ -1,6 +1,4 @@
// @ts-check
const http = require("http");
import { IncomingMessage } from "http";
/**
* Parse request cookies
@@ -8,16 +6,14 @@ const http = require("http");
*
* @description This function takes in a request object and
* returns the cookies as a JS object
*
* @async
*
* @param {object} params - main params object
* @param {http.IncomingMessage & Object<string, any>} [params.request] - HTTPS request object
* @param {string} [params.cookieString]
*
* @returns {Object<string, string>}
*/
module.exports = function parseCookies({ request, cookieString }) {
export default function parseCookies({
request,
cookieString,
}: {
request?: IncomingMessage & { [s: string]: any };
cookieString?: string;
}): { [s: string]: string } {
try {
/** @type {string | undefined} */
const cookieStr = request
@@ -32,11 +28,9 @@ module.exports = function parseCookies({ request, cookieString }) {
return {};
}
/** @type {string[]} */
const cookieSplitArray = cookieStr.split(";");
const cookieSplitArray: string[] = cookieStr.split(";");
/** @type {Object<string, string>} */
let cookieObject = {};
let cookieObject: { [k: string]: string } = {};
cookieSplitArray.forEach((keyValueString) => {
const [key, value] = keyValueString.split("=");
@@ -50,9 +44,9 @@ module.exports = function parseCookies({ request, cookieString }) {
});
return cookieObject;
} catch (/** @type {any} */ error) {
} catch (error: any) {
console.log(`ERROR parsing cookies: ${error.message}`);
return {};
}
};
}
dsql-app/package-shared/utils/camelJoinedtoCamelSpace.js → dsql-app/package-shared/utils/camelJoinedtoCamelSpace.ts
+10 -11
View File
@@ -1,16 +1,10 @@
// @ts-check
/**
* Convert Camel Joined Text to Camel Spaced Text
* ==============================================================================
* @description this function takes a camel cased text without spaces, and returns
* a camel-case-spaced text
*
* @param {string} text - text string without spaces
*
* @returns {string | null}
*/
function camelJoinedtoCamelSpace(text) {
export default function camelJoinedtoCamelSpace(text: string): string | null {
if (!text?.match(/./)) {
return "";
}
@@ -33,7 +27,9 @@ function camelJoinedtoCamelSpace(text) {
}
}
let textChunks = [`${textArray[0].toUpperCase()}${text.substring(1, capIndexes[0])}`];
let textChunks = [
`${textArray[0].toUpperCase()}${text.substring(1, capIndexes[0])}`,
];
for (let j = 0; j < capIndexes.length; j++) {
const capIndex = capIndexes[j];
@@ -42,7 +38,12 @@ function camelJoinedtoCamelSpace(text) {
const startIndex = capIndex + 1;
const endIndex = capIndexes[j + 1];
textChunks.push(`${textArray[capIndex].toUpperCase()}${text.substring(startIndex, endIndex)}`);
textChunks.push(
`${textArray[capIndex].toUpperCase()}${text.substring(
startIndex,
endIndex
)}`
);
}
return textChunks.join(" ");
@@ -50,5 +51,3 @@ function camelJoinedtoCamelSpace(text) {
return null;
}
}
module.exports = camelJoinedtoCamelSpace;
dsql-app/package-shared/utils/db/conn-db-handler.ts
+62
View File
@@ -0,0 +1,62 @@
import { ServerlessMysql } from "serverless-mysql";
type QueryObject = {
query: string;
values?: (string | number | undefined)[];
};
type Return<ReturnType = any> = ReturnType | null;
/**
* # Run Query From MySQL Connection
* @description Run a query from a pre-existing MySQL/Mariadb Connection
* setup with `serverless-mysql` npm module
*/
export default async function connDbHandler<ReturnType = any>(
/**
* ServerlessMySQL Connection Object
*/
conn: ServerlessMysql,
/**
* String Or `QueryObject` Array
*/
query: QueryObject["query"] | QueryObject[],
/**
* Array of Values to Sanitize and Inject
*/
values?: QueryObject["values"]
): Promise<Return<ReturnType>> {
try {
if (typeof query == "string") {
const res = await conn.query(trimQuery(query), values);
return JSON.parse(JSON.stringify(res));
} else if (typeof query == "object") {
const resArray = [];
for (let i = 0; i < query.length; i++) {
try {
const queryObj = query[i];
const queryObjRes = await conn.query(
trimQuery(queryObj.query),
queryObj.values
);
resArray.push(JSON.parse(JSON.stringify(queryObjRes)));
} catch (error) {
resArray.push(null);
}
}
return resArray as any;
} else {
return null;
}
} catch (error) {
return null;
} finally {
conn.end();
}
}
function trimQuery(query: string) {
return query.replace(/\n/gm, "").replace(/ {2,}/g, "").trim();
}
dsql-app/package-shared/utils/deserialize-query.ts
+29
View File
@@ -0,0 +1,29 @@
import EJSON from "./ejson";
/**
* # Convert Serialized Query back to object
*/
export default function deserializeQuery(
query: string | { [s: string]: any }
): {
[s: string]: any;
} {
/** @type {Object<string,any>} */
let queryObject: { [s: string]: any } =
typeof query == "object" ? query : Object(EJSON.parse(query));
const keys = Object.keys(queryObject);
for (let i = 0; i < keys.length; i++) {
const key = keys[i];
const value = queryObject[key];
if (typeof value == "string") {
if (value.match(/^\{|^\[/)) {
queryObject[key] = EJSON.parse(value);
}
}
}
return queryObject;
}
dsql-app/package-shared/utils/ejson.js
-38
View File
@@ -1,38 +0,0 @@
/**
*
* @param {string | null | number} string
* @param {(this: any, key: string, value: any) => any} [reviver]
* @returns {Object<string, any> | Object<string, any>[] | undefined}
*/
function parse(string, reviver) {
if (!string) return undefined;
if (typeof string == "object") return string;
if (typeof string !== "string") return undefined;
try {
return JSON.parse(string, reviver);
} catch (error) {
return undefined;
}
}
/**
*
* @param {any} value
* @param {((this: any, key: string, value: any) => any) | null} [replacer]
* @param { string | number } [space]
* @returns {string | undefined}
*/
function stringify(value, replacer, space) {
try {
return JSON.stringify(value, replacer, space);
} catch (error) {
return undefined;
}
}
const EJSON = {
parse,
stringify,
};
module.exports = EJSON;
dsql-app/package-shared/utils/ejson.ts
+38
View File
@@ -0,0 +1,38 @@
/**
* # EJSON parse string
*/
function parse(
string: string | null | number,
reviver?: (this: any, key: string, value: any) => any
): { [s: string]: any } | { [s: string]: any }[] | undefined {
if (!string) return undefined;
if (typeof string == "object") return string;
if (typeof string !== "string") return undefined;
try {
return JSON.parse(string, reviver);
} catch (error) {
return undefined;
}
}
/**
* # EJSON stringify object
*/
function stringify(
value: any,
replacer?: ((this: any, key: string, value: any) => any) | null,
space?: string | number
): string | undefined {
try {
return JSON.stringify(value, replacer || undefined, space);
} catch (error) {
return undefined;
}
}
const EJSON = {
parse,
stringify,
};
export default EJSON;
dsql-app/package-shared/utils/empty-dir.ts
+23
View File
@@ -0,0 +1,23 @@
import fs from "fs";
import path from "path";
export default function emptyDirectory(dir: string) {
try {
const dirContent = fs.readdirSync(dir);
for (let i = 0; i < dirContent.length; i++) {
const fileFolder = dirContent[i];
const fullFileFolderPath = path.join(dir, fileFolder);
const stat = fs.statSync(fullFileFolderPath);
if (stat.isDirectory()) {
emptyDirectory(fullFileFolderPath);
continue;
}
fs.unlinkSync(fullFileFolderPath);
}
} catch (error: any) {
console.log(`Error Emptying ${dir}: ${error.message}`);
}
}
dsql-app/package-shared/utils/endConnection.js
-16
View File
@@ -1,16 +0,0 @@
// @ts-check
const mysql = require("mysql");
/**
* @param {mysql.Connection} connection - the active MYSQL connection
*/
function endConnection(connection) {
if (connection.state !== "disconnected") {
connection.end((err) => {
console.log(err?.message);
});
}
}
module.exports = endConnection;
dsql-app/package-shared/utils/endConnection.ts
+14
View File
@@ -0,0 +1,14 @@
import mysql from "mysql";
/**
* # End MYSQL Connection
*/
function endConnection(connection: mysql.Connection) {
if (connection.state !== "disconnected") {
connection.end((err) => {
console.log(err?.message);
});
}
}
export default endConnection;
dsql-app/package-shared/utils/generateColumnDescription.js → dsql-app/package-shared/utils/generateColumnDescription.ts
+7 -10
View File
@@ -8,18 +8,15 @@
/** ****************************************************************************** */
/**
* Generate SQL text for Field
* ==============================================================================
* @param {object} params - Single object params
* @param {import("../types").DSQL_FieldSchemaType} params.columnData - Field object
* @param {boolean} [params.primaryKeySet] - Table Name(slug)
*
* @returns {{fieldEntryText: string, newPrimaryKeySet: boolean}}
* # Generate SQL text for Field
*/
module.exports = function generateColumnDescription({
export default function generateColumnDescription({
columnData,
primaryKeySet,
}) {
}: {
columnData: import("../types").DSQL_FieldSchemaType;
primaryKeySet?: boolean;
}): { fieldEntryText: string; newPrimaryKeySet: boolean } {
/**
* Format tableInfoArray
*
@@ -71,7 +68,7 @@ module.exports = function generateColumnDescription({
////////////////////////////////////////
return { fieldEntryText, newPrimaryKeySet: primaryKeySet || false };
};
}
/** ****************************************************************************** */
/** ****************************************************************************** */
dsql-app/package-shared/utils/grab-host-names.js → dsql-app/package-shared/utils/grab-host-names.ts
+9 -13
View File
@@ -1,21 +1,19 @@
// @ts-check
const https = require("https");
const http = require("http");
import https from "https";
import http from "http";
/**
* @typedef {object} GrabHostNamesReturn
* @property {string} host
* @property {number | string} port
* @property {typeof http | typeof https} scheme
* @property {string | number} user_id
*/
type GrabHostNamesReturn = {
host: string;
port: number | string;
scheme: typeof http | typeof https;
user_id: string | number;
};
/**
* # Grab Names For Query
* @returns {GrabHostNamesReturn}
*/
function grabHostNames() {
export default function grabHostNames(): GrabHostNamesReturn {
const scheme = process.env.DSQL_HTTP_SCHEME;
const localHost = process.env.DSQL_LOCAL_HOST;
const localHostPort = process.env.DSQL_LOCAL_HOST_PORT;
@@ -33,5 +31,3 @@ function grabHostNames() {
user_id: String(process.env.DSQL_API_USER_ID || 0),
};
}
module.exports = grabHostNames;
dsql-app/package-shared/utils/numberfy.js → dsql-app/package-shared/utils/numberfy.ts
+3 -8
View File
@@ -1,10 +1,5 @@
// @ts-check
/**
* # Get Number from any input
* @param {any} num input
* @param {number} [decimals] number of decimals to round to
* @returns {number} number or 0 in case of error
* @example
* numberfy("123") // 123
* numberfy("123.456") // 123
@@ -12,15 +7,15 @@
* numberfy("123.456", 0) // 123
* numberfy("123.456", 3) // 123.456
*/
module.exports = function numberfy(num, decimals) {
export default function numberfy(num: any, decimals: number): number {
try {
const numberfiedNum = Number(num);
if (typeof numberfiedNum !== "number") return 0;
if (isNaN(numberfiedNum)) return 0;
if (decimals) return Number(numberfiedNum.toFixed(decimals));
return Math.round(numberfiedNum);
} catch (/** @type {any} */ error) {
} catch (/** @type {any} */ error: any) {
console.log(`Numberfy ERROR: ${error.message}`);
return 0;
}
};
}
dsql-app/package-shared/utils/serialize-cookies.js → dsql-app/package-shared/utils/serialize-cookies.ts
+10 -9
View File
@@ -1,14 +1,17 @@
// @ts-check
import { CookieObject } from "../types";
/**
*
* @param {object} params
* @param {import("../types").CookieObject[]} params.cookies
* @returns {string[]}
* # Serialize Cookies
* @description Convert cookie object to string array
*/
function serializeCookies({ cookies }) {
/** @type {string[]} */
let cookiesStringsArray = [];
export default function serializeCookies({
cookies,
}: {
cookies: CookieObject[];
}): string[] {
let cookiesStringsArray: string[] = [];
for (let i = 0; i < cookies.length; i++) {
const cookieObject = cookies[i];
@@ -44,5 +47,3 @@ function serializeCookies({ cookies }) {
return cookiesStringsArray;
}
module.exports = serializeCookies;
dsql-app/package-shared/utils/serialize-query.js → dsql-app/package-shared/utils/serialize-query.ts
+8 -9
View File
@@ -1,9 +1,9 @@
// @ts-check
import EJSON from "./ejson";
const EJSON = require("./ejson");
/** @type {import("../types").SerializeQueryFnType} */
function serializeQuery(query) {
/**
* # Serialize Query
*/
export default function serializeQuery(query: any): string {
let str = "?";
if (typeof query !== "object") {
@@ -21,8 +21,7 @@ function serializeQuery(query) {
const keys = Object.keys(query);
/** @type {string[]} */
const queryArr = [];
const queryArr: string[] = [];
keys.forEach((key) => {
if (!key || !query[key]) return;
@@ -33,11 +32,11 @@ function serializeQuery(query) {
queryArr.push(`${key}=${encodeURIComponent(String(jsonStr))}`);
} else if (typeof value === "string" || typeof value === "number") {
queryArr.push(`${key}=${encodeURIComponent(value)}`);
} else {
queryArr.push(`${key}=${String(value)}`);
}
});
str += queryArr.join("&");
return str;
}
module.exports = serializeQuery;
dsql-app/package-shared/utils/slugToCamelTitle.js → dsql-app/package-shared/utils/slugToCamelTitle.ts
+5 -8
View File
@@ -1,16 +1,13 @@
// @ts-check
/**
*
* @param {string} text
* @returns
* # Slug to Camel case Title
*/
module.exports = function slugToCamelTitle(text) {
export default function slugToCamelTitle(text: String) {
if (text) {
let addArray = text.split("-").filter((item) => item !== "");
let camelArray = addArray.map((item) => {
return (
item.substr(0, 1).toUpperCase() + item.substr(1).toLowerCase()
item.substring(0, 1).toUpperCase() +
item.substring(1).toLowerCase()
);
});
@@ -20,4 +17,4 @@ module.exports = function slugToCamelTitle(text) {
} else {
return null;
}
};
}
dsql-app/package-shared/utils/slugify.js → dsql-app/package-shared/utils/slugify.ts
+4 -5
View File
@@ -2,14 +2,13 @@
/**
* # Return the slug of a string
* @param {string} str input
* @returns {string} slug or empty string in case of error
*
* @example
* slugify("Hello World") // "hello-world"
* slugify("Yes!") // "yes"
* slugify("Hello!!! World!") // "hello-world"
*/
module.exports = function slugify(str) {
export default function slugify(str: string): string {
try {
return String(str)
.trim()
@@ -20,8 +19,8 @@ module.exports = function slugify(str) {
.replace(/-{2,}/g, "-")
.replace(/^-/, "")
.replace(/-$/, "");
} catch (/** @type {any} */ error) {
} catch (/** @type {any} */ error: any) {
console.log(`Slugify ERROR: ${error.message}`);
return "";
}
};
}
dsql-app/package-shared/utils/trim-sql.js
-26
View File
@@ -1,26 +0,0 @@
// @ts-check
const https = require("https");
const http = require("http");
/**
* @typedef {object} GrabHostNamesReturn
* @property {string} host
* @property {number | string} port
* @property {typeof http | typeof https} scheme
*/
/**
* # Trim SQL
* @description Remove Returns and miltiple spaces from SQL Query
* @param {string} sql
* @returns {string}
*/
function trimSql(sql) {
return sql
.replace(/\n|\r|\n\r|\r\n/gm, " ")
.replace(/ {2,}/g, " ")
.trim();
}
module.exports = trimSql;
dsql-app/package-shared/utils/trim-sql.ts
+10
View File
@@ -0,0 +1,10 @@
/**
* # Trim SQL
* @description Remove Returns and miltiple spaces from SQL Query
*/
export default function trimSql(sql: string) {
return sql
.replace(/\n|\r|\n\r|\r\n/gm, " ")
.replace(/ {2,}/g, " ")
.trim();
}