typeorm
Version:
Data-Mapper ORM for TypeScript, ES7, ES6, ES5. Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, MongoDB databases.
215 lines (213 loc) • 7.17 kB
JavaScript
import { __awaiter, __generator } from "tslib";
import * as path from "path";
import * as fs from "fs";
import dotenv from "dotenv";
import chalk from "chalk";
import { highlight } from "cli-highlight";
export { ReadStream } from "fs";
export { EventEmitter } from "events";
export { Readable, Writable } from "stream";
/**
* Platform-specific tools.
*/
var PlatformTools = /** @class */ (function () {
function PlatformTools() {
}
/**
* Gets global variable where global stuff can be stored.
*/
PlatformTools.getGlobalVariable = function () {
return global;
};
/**
* Loads ("require"-s) given file or package.
* This operation only supports on node platform
*/
PlatformTools.load = function (name) {
// if name is not absolute or relative, then try to load package from the node_modules of the directory we are currently in
// this is useful when we are using typeorm package globally installed and it accesses drivers
// that are not installed globally
try {
// switch case to explicit require statements for webpack compatibility.
switch (name) {
/**
* mongodb
*/
case "mongodb":
return require("mongodb");
/**
* hana
*/
case "@sap/hana-client":
return require("@sap/hana-client");
case "hdb-pool":
return require("hdb-pool");
/**
* mysql
*/
case "mysql":
return require("mysql");
case "mysql2":
return require("mysql2");
/**
* oracle
*/
case "oracledb":
return require("oracledb");
/**
* postgres
*/
case "pg":
return require("pg");
case "pg-native":
return require("pg-native");
case "pg-query-stream":
return require("pg-query-stream");
case "typeorm-aurora-data-api-driver":
return require("typeorm-aurora-data-api-driver");
/**
* redis
*/
case "redis":
return require("redis");
case "ioredis":
return require("ioredis");
/**
* better-sqlite3
*/
case "better-sqlite3":
return require("better-sqlite3");
/**
* sqlite
*/
case "sqlite3":
return require("sqlite3");
/**
* sql.js
*/
case "sql.js":
return require("sql.js");
/**
* sqlserver
*/
case "mssql":
return require("mssql");
/**
* react-native-sqlite
*/
case "react-native-sqlite-storage":
return require("react-native-sqlite-storage");
}
}
catch (err) {
return require(path.resolve(process.cwd() + "/node_modules/" + name));
}
// If nothing above matched and we get here, the package was not listed within PlatformTools
// and is an Invalid Package. To make it explicit that this is NOT the intended use case for
// PlatformTools.load - it's not just a way to replace `require` all willy-nilly - let's throw
// an error.
throw new TypeError("Invalid Package for PlatformTools.load: " + name);
};
/**
* Normalizes given path. Does "path.normalize".
*/
PlatformTools.pathNormalize = function (pathStr) {
return path.normalize(pathStr);
};
/**
* Gets file extension. Does "path.extname".
*/
PlatformTools.pathExtname = function (pathStr) {
return path.extname(pathStr);
};
/**
* Resolved given path. Does "path.resolve".
*/
PlatformTools.pathResolve = function (pathStr) {
return path.resolve(pathStr);
};
/**
* Synchronously checks if file exist. Does "fs.existsSync".
*/
PlatformTools.fileExist = function (pathStr) {
return fs.existsSync(pathStr);
};
PlatformTools.readFileSync = function (filename) {
return fs.readFileSync(filename);
};
PlatformTools.appendFileSync = function (filename, data) {
fs.appendFileSync(filename, data);
};
PlatformTools.writeFile = function (path, data) {
return __awaiter(this, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, new Promise(function (ok, fail) {
fs.writeFile(path, data, function (err) {
if (err)
fail(err);
ok();
});
})];
});
});
};
/**
* Loads a dotenv file into the environment variables.
*
* @param path The file to load as a dotenv configuration
*/
PlatformTools.dotenv = function (pathStr) {
dotenv.config({ path: pathStr });
};
/**
* Gets environment variable.
*/
PlatformTools.getEnvVariable = function (name) {
return process.env[name];
};
/**
* Highlights sql string to be print in the console.
*/
PlatformTools.highlightSql = function (sql) {
var theme = {
"keyword": chalk.blueBright,
"literal": chalk.blueBright,
"string": chalk.white,
"type": chalk.magentaBright,
"built_in": chalk.magentaBright,
"comment": chalk.gray,
};
return highlight(sql, { theme: theme, language: "sql" });
};
/**
* Highlights json string to be print in the console.
*/
PlatformTools.highlightJson = function (json) {
return highlight(json, { language: "json" });
};
/**
* Logging functions needed by AdvancedConsoleLogger
*/
PlatformTools.logInfo = function (prefix, info) {
console.log(chalk.gray.underline(prefix), info);
};
PlatformTools.logError = function (prefix, error) {
console.log(chalk.underline.red(prefix), error);
};
PlatformTools.logWarn = function (prefix, warning) {
console.log(chalk.underline.yellow(prefix), warning);
};
PlatformTools.log = function (message) {
console.log(chalk.underline(message));
};
PlatformTools.warn = function (message) {
return chalk.yellow(message);
};
/**
* Type of the currently running platform.
*/
PlatformTools.type = "node";
return PlatformTools;
}());
export { PlatformTools };
//# sourceMappingURL=PlatformTools.js.map