moonlifedb
Version:
A JSON database with a bunch of tools and typescript support.
430 lines (429 loc) • 19 kB
JavaScript
'use strict';
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
__setModuleDefault(result, mod);
return result;
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.Database = void 0;
const fs = __importStar(require("fs"));
const _ = __importStar(require("lodash"));
const CoreCheck_1 = require("./CoreCheck");
const AdapterExporter_1 = require("./AdapterExporter");
const EventConstructor_1 = require("./constructors/EventConstructor");
const node_events_1 = require("node:events");
const lib = new CoreCheck_1.Memory();
// event = new EventManager()
var getDeepKeys = (obj) => {
var keys = [];
for (var key in obj) {
keys.push(key);
if (typeof obj[key] === "object") {
var subkeys = getDeepKeys(obj[key]);
keys = keys.concat(subkeys.map(function (subkey) {
return key + "." + subkey;
}));
}
}
return keys;
};
function deepFind(obj, path) {
var paths = path.split('.'), current = obj, i;
for (let i = 0; i < paths.length; i++) {
if (current[paths[i]] == undefined) {
return undefined;
}
else {
current = current[paths[i]];
}
}
return current;
}
class Database extends node_events_1.EventEmitter {
adapter;
tablePath;
ip;
port;
alerts;
ignore;
useTabulation;
type;
/**
* The main class of an insta-write database app.
* @example const database = new Database(adapter, { alerts: true, overwrite: false, useTabulation: tabulationResolvable });
*
* @param adapter
* @param settings
* @param alerts - Alert writes and removes to the console.
* @param useTabulation - Use tabulation when formatting json file
*/
constructor(adapter, settings) {
super();
this.adapter = adapter;
switch (true) {
case this.adapter instanceof AdapterExporter_1.ExternalConnection: {
this.tablePath = this.adapter.tablePath;
this.adapter instanceof AdapterExporter_1.ExternalConnection
? this.ip = this.adapter.localip
: this.ip = undefined;
this.adapter instanceof AdapterExporter_1.ExternalConnection
? this.port = this.adapter.port
: this.port = undefined;
break;
}
case this.adapter instanceof AdapterExporter_1.LocalStorage: {
this.tablePath = this.adapter.tablePath;
break;
}
default: {
const adapterError = 'adapter must be instance of LocalStorage or ExternalConnection';
throw new Error(adapterError);
}
}
settings && settings.type
? this.type = settings.type
: this.type = 'SingleFile';
settings && settings.alerts
? this.alerts = settings.alerts
: this.alerts = false;
settings && settings.useTabulation
? this.useTabulation = settings.useTabulation
: this.useTabulation = undefined;
settings && settings.ignoreDeprecations
? this.ignore = settings.ignoreDeprecations
: this.ignore = false;
lib.checkDir(this.tablePath);
}
// MAIN METHODS
get(table, options) {
let data = fs.readFileSync(this.tablePath + '/' + table + '.json', 'utf8');
data = JSON.parse(data);
if ((options.key).includes('.') || (options.key).includes('~')) {
var uniq = (options.key).split((options.key).includes('~') ? '~' : /[.]/gi);
var uniqq = [...uniq];
uniqq.shift();
if (uniq.includes(''))
uniq.splice(uniq.indexOf(''), 1);
if (uniq.length < 1) {
const syntaxError = 'key with pointer must have 2 or more sides. ' + (options.key).includes('~') ? '"~" - finds all occurences and returns an object.\nSyntax is "MainKey~YouSubKey"' : 'Amount of dots mean how deep it is: "MainKey.SubKey1.Subkey2" etc.';
throw new Error(syntaxError);
}
var deepkeys = getDeepKeys(data[uniq[0]]);
if (deepkeys != undefined) {
var filter = [];
if (uniq.length > 1) {
deepkeys.forEach((deepkey) => {
if (deepkey == uniqq.join('.'))
filter.push(deepkey);
});
}
else {
deepkeys.forEach((deepkey) => {
if (deepkey.endsWith(uniq[uniq.length - 1]))
filter.push(deepkey);
});
}
if ((options.key).includes('~')) {
var result = {};
filter.forEach((item) => {
result[item] = deepFind(data[uniq[0]], item);
});
return Object.keys(result).length == 1 ? result[Object.keys(result)[0]] : result;
}
else {
var result = {};
var amount = ((options.key).split('')).filter((e) => e === '.').length;
filter.forEach((item) => {
if (item.split('.').length == amount) {
result[item] = deepFind(data[uniq[0]], item);
}
});
return Object.keys(result).length == 1 ? result[Object.keys(result)[0]] : result;
}
}
else if (this.alerts == true)
return console.log("Couldn't find anything with such key.");
}
else
return data[options.key];
}
async put(table, action) {
return new Promise((resolve, reject) => {
var data = fs.readFileSync(this.tablePath + '/' + table + '.json', 'utf8');
data = JSON.parse(data);
if ((action.key).includes('.')) {
if (action.newline && action.newline == true) {
_.set(data, action.key, action.value);
if (this.useTabulation != undefined) {
fs.writeFileSync(this.tablePath + '/' + table + '.json', JSON.stringify(data, null, this.useTabulation.whitespace));
resolve(this.get(table, { key: (action.key).length > 1 ? action.key.split('.')[0] : action.key }));
}
else {
fs.writeFileSync(this.tablePath + '/' + table + '.json', JSON.stringify(data));
resolve(this.get(table, { key: (action.key).length > 1 ? action.key.split('.')[0] : action.key }));
}
}
else {
let result = deepFind(data, action.key);
if (result != undefined) {
_.set(data, action.key, action.value);
if (this.useTabulation != undefined) {
fs.writeFileSync(this.tablePath + '/' + table + '.json', JSON.stringify(data, null, this.useTabulation.whitespace));
resolve(this.get(table, { key: (action.key).length > 1 ? action.key.split('.')[0] : action.key }));
}
else {
fs.writeFileSync(this.tablePath + '/' + table + '.json', JSON.stringify(data));
resolve(this.get(table, { key: (action.key).length > 1 ? action.key.split('.')[0] : action.key }));
}
}
else
return;
}
}
else {
data[action.key] = action.value;
if (this.useTabulation != undefined) {
fs.writeFileSync(this.tablePath + '/' + table + '.json', JSON.stringify(data, null, this.useTabulation.whitespace));
resolve(this.get(table, { key: (action.key).length > 1 ? action.key.split('.')[0] : action.key }));
}
else {
fs.writeFileSync(this.tablePath + '/' + table + '.json', JSON.stringify(data));
resolve(this.get(table, { key: (action.key).length > 1 ? action.key.split('.')[0] : action.key }));
}
}
});
}
// PUBLIC METHODS
// CREATE
/**
* Creates a new line in database.
* @note It's async, so it returns a promise.
* @warning Pointers are not allowed in this method.
* @example const result = await Database.create('table', { key: "example", value: "exampleValue" })
* @param action.resolve resolves value of this key after it's creation in database.
* @returns {Promise<any|void>}
* @async
* @deprecated This method is marked as deprecated. Use create() instead.
*/
async write(table, action) {
lib.checkFile(this.tablePath, table);
if ((action.key).includes('~') || (action.key).includes('.')) {
const pointerError = "Pointers are not allowed in this method.";
throw new Error(pointerError);
}
return new Promise(async (resolve, reject) => {
await this.put(table, { key: action.key, value: action.value, newline: true });
this.emit("access", new EventConstructor_1.Event('create', 'put', {
table: table,
key: action.key,
value: action.value,
resolve: action.resolve ? action.resolve : false,
newline: true
}));
if (action.resolve && action.resolve == true)
resolve(this.get(table, { key: action.key }));
if (this.ignore !== true)
console.error('Database#write() is marked as deprecated since v1.0.0.alpha-9-6/24/23\nUse Database#ignoreDeprecations in the constructor to silence this error.');
});
}
/**
* Creates a new line in database.
* @note It's async, so it returns a promise.
* @warning Pointers are not allowed in this method.
* @example const result = await Database.create('table', { key: "example", value: "exampleValue" })
* @param action.resolve resolves value of this key after it's creation in database.
* @returns {Promise<any|void>}
* @async
*/
async create(table, action) {
lib.checkFile(this.tablePath, table);
if ((action.key).includes('~') || (action.key).includes('.')) {
const pointerError = "Pointers are not allowed in this method.";
throw new Error(pointerError);
}
return new Promise(async (resolve, reject) => {
await this.put(table, { key: action.key, value: action.value, newline: true });
this.emit("access", new EventConstructor_1.Event('create', 'put', {
table: table,
key: action.key,
value: action.value,
resolve: action.resolve ? action.resolve : false,
newline: true
}));
if (action.resolve == true)
resolve(this.get(table, { key: action.key }));
});
}
// EDIT
/**
* Edits a line in database.
* @note It's async, so it returns a promise.
* @warning "~" pointer is not allowed here.
* @example const result = await Database.edit('table', { key: "example", value: "exampleValue" })
* @param action.newline if true and if this key/subkey does not exist, it creates it instead.
* @param action.resolve resolves value of this key after changes in database.
* @returns {Promise<any|void>}
* @async
*/
async edit(table, action) {
lib.checkFile(this.tablePath, table);
if ((action.key).includes('~')) {
const pointerError = "Pointer \"~\" is not allowed in this method.";
throw new Error(pointerError);
}
return new Promise(async (resolve, reject) => {
this.emit("access", new EventConstructor_1.Event('edit', 'put', {
table: table,
key: action.key,
value: action.value,
resolve: action.resolve ? action.resolve : false,
newline: action.newline ? action.newline : false
}));
await this.put(table, { key: action.key, value: action.value, newline: action.newline });
if (action.resolve == true)
resolve(this.get(table, { key: (action.key).split('.')[0] }));
});
}
// REMOVE
/**
* Removes a line in database or subkey.
* @note It's async, so it returns a promise.
* @warning "~" pointer is not allowed here.
* @example const result = await Database.remove('table', { key: "example" })
* @note you can use it without await, because it's a void method.
* @returns {Promise<void>}
* @async
*/
async remove(table, action) {
lib.checkFile(this.tablePath, table);
if ((action.key).includes('~')) {
const pointerError = "Pointer \"~\" is not allowed in this method.";
throw new Error(pointerError);
}
return new Promise(async (resolve, reject) => {
await this.put(table, { key: action.key, value: undefined });
this.emit("access", new EventConstructor_1.Event('remove', 'put', {
table: table,
key: action.key,
value: undefined,
resolve: false,
newline: true
}));
});
}
// READ
/**
* Returns a value of this key.
* @warning Any pointer is allowed.
* @example const result = Database.read('table', { key: "example" })
* @note And it should return value of this key. Otherwise it returns undefined.
* @returns {any|object|undefined}
*/
read(table, action) {
lib.checkFile(this.tablePath, table);
let _r = this.get(table, { key: action.key });
this.emit("access", new EventConstructor_1.Event('read', 'get', {
table: table,
key: action.key,
value: _r,
resolve: false,
newline: false
}));
return _r;
}
// CHECK
/**
* Checks if this key exists in this table.
* @note Returns boolean value.
* @warning "~" pointer is not allowed here. If using "." pointer it returns an object
* @example const result = Database.check('table', { key: "example" })
* @note And it should return true, if exists. Otherwise it returns false.
* @returns {Boolean}
*/
check(table, action) {
lib.checkFile(this.tablePath, table);
if ((action.key).includes('~')) {
const pointerError = "Pointer \"~\" is not allowed in this method.";
throw new Error(pointerError);
}
let _r = this.get(table, { key: action.key });
if (_r instanceof Object) {
this.emit("access", new EventConstructor_1.Event('check', 'get', {
table: table,
key: action.key,
value: (Object.keys(_r).length > 0 ? true : false),
resolve: false,
newline: false
}));
return (Object.keys(_r).length > 0 ? true : false);
}
else {
this.emit("access", new EventConstructor_1.Event('check', 'get', {
table: table,
key: action.key,
value: (_r !== undefined ? true : false),
resolve: false,
newline: false
}));
return (_r !== undefined ? true : false);
}
}
/**
* Same as Database#check(), but resolvable.
* @note It means that it returns a promise. If key is not undefined, it resolves it and can be accessed with await or .then() construction.
* @warning "~" pointer is not allowed here. If using "." pointer it returns an object
* @example const result = await Database.checkres('table', { key: "example" })
* @note And it should return value of this key, if exists. Otherwise it returns undefined.
* @returns {Promise<any|undefined>}
* @async
*/
async checkres(table, action) {
lib.checkFile(this.tablePath, table);
if ((action.key).includes('~')) {
const pointerError = "Pointer \"~\" is not allowed in this method.";
throw new Error(pointerError);
}
return new Promise(async (resolve, reject) => {
let _r = this.get(table, { key: action.key });
if (_r instanceof Object) {
this.emit("access", new EventConstructor_1.Event('check', 'get', {
table: table,
key: action.key,
value: (Object.keys(_r).length > 0 ? true : false),
resolve: true,
newline: false
}));
resolve(Object.keys(_r).length > 0 ? _r : undefined);
}
else {
this.emit("access", new EventConstructor_1.Event('check', 'get', {
table: table,
key: action.key,
value: (_r !== undefined ? true : false),
resolve: true,
newline: false
}));
resolve(_r !== undefined ? _r : undefined);
}
});
}
}
exports.Database = Database;