typeorm
Version:
Data-Mapper ORM for TypeScript, ES7, ES6, ES5. Supports MySQL, PostgreSQL, MariaDB, SQLite, MS SQL Server, Oracle, MongoDB databases.
243 lines (241 loc) • 11.8 kB
JavaScript
import { __awaiter, __generator } from "tslib";
import appRootPath from "app-root-path";
import { PlatformTools } from "../platform/PlatformTools";
import { ConnectionOptionsEnvReader } from "./options-reader/ConnectionOptionsEnvReader";
import { ConnectionOptionsYmlReader } from "./options-reader/ConnectionOptionsYmlReader";
import { ConnectionOptionsXmlReader } from "./options-reader/ConnectionOptionsXmlReader";
import { TypeORMError } from "../error";
/**
* Reads connection options from the ormconfig.
* Can read from multiple file extensions including env, json, js, xml and yml.
*/
var ConnectionOptionsReader = /** @class */ (function () {
// -------------------------------------------------------------------------
// Constructor
// -------------------------------------------------------------------------
function ConnectionOptionsReader(options) {
this.options = options;
}
// -------------------------------------------------------------------------
// Public Methods
// -------------------------------------------------------------------------
/**
* Returns all connection options read from the ormconfig.
*/
ConnectionOptionsReader.prototype.all = function () {
return __awaiter(this, void 0, void 0, function () {
var options;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.load()];
case 1:
options = _a.sent();
if (!options)
throw new TypeORMError("No connection options were found in any orm configuration files.");
return [2 /*return*/, options];
}
});
});
};
/**
* Gets a connection with a given name read from ormconfig.
* If connection with such name would not be found then it throw error.
*/
ConnectionOptionsReader.prototype.get = function (name) {
return __awaiter(this, void 0, void 0, function () {
var allOptions, targetOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.all()];
case 1:
allOptions = _a.sent();
targetOptions = allOptions.find(function (options) { return options.name === name || (name === "default" && !options.name); });
if (!targetOptions)
throw new TypeORMError("Cannot find connection " + name + " because its not defined in any orm configuration files.");
return [2 /*return*/, targetOptions];
}
});
});
};
/**
* Checks if there is a TypeORM configuration file.
*/
ConnectionOptionsReader.prototype.has = function (name) {
return __awaiter(this, void 0, void 0, function () {
var allOptions, targetOptions;
return __generator(this, function (_a) {
switch (_a.label) {
case 0: return [4 /*yield*/, this.load()];
case 1:
allOptions = _a.sent();
if (!allOptions)
return [2 /*return*/, false];
targetOptions = allOptions.find(function (options) { return options.name === name || (name === "default" && !options.name); });
return [2 /*return*/, !!targetOptions];
}
});
});
};
// -------------------------------------------------------------------------
// Protected Methods
// -------------------------------------------------------------------------
/**
* Loads all connection options from a configuration file.
*
* todo: get in count NODE_ENV somehow
*/
ConnectionOptionsReader.prototype.load = function () {
return __awaiter(this, void 0, void 0, function () {
var connectionOptions, fileFormats, possibleExtension, fileExtension, foundFileFormat, configFile, configModule;
var _this = this;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
connectionOptions = undefined;
fileFormats = ["env", "js", "cjs", "ts", "json", "yml", "yaml", "xml"];
possibleExtension = this.baseFilePath.substr(this.baseFilePath.lastIndexOf("."));
fileExtension = fileFormats.find(function (extension) { return "." + extension === possibleExtension; });
foundFileFormat = fileExtension || fileFormats.find(function (format) {
return PlatformTools.fileExist(_this.baseFilePath + "." + format);
});
configFile = fileExtension ? this.baseFilePath : this.baseFilePath + "." + foundFileFormat;
// if .env file found then load all its variables into process.env using dotenv package
if (foundFileFormat === "env") {
PlatformTools.dotenv(configFile);
}
else if (PlatformTools.fileExist(this.baseDirectory + "/.env")) {
PlatformTools.dotenv(this.baseDirectory + "/.env");
}
if (!(PlatformTools.getEnvVariable("TYPEORM_CONNECTION") || PlatformTools.getEnvVariable("TYPEORM_URL"))) return [3 /*break*/, 2];
return [4 /*yield*/, new ConnectionOptionsEnvReader().read()];
case 1:
connectionOptions = _a.sent();
return [3 /*break*/, 11];
case 2:
if (!(foundFileFormat === "js" || foundFileFormat === "cjs" || foundFileFormat === "ts")) return [3 /*break*/, 4];
return [4 /*yield*/, require(configFile)];
case 3:
configModule = _a.sent();
if (configModule && "__esModule" in configModule && "default" in configModule) {
connectionOptions = configModule.default;
}
else {
connectionOptions = configModule;
}
return [3 /*break*/, 11];
case 4:
if (!(foundFileFormat === "json")) return [3 /*break*/, 5];
connectionOptions = require(configFile);
return [3 /*break*/, 11];
case 5:
if (!(foundFileFormat === "yml")) return [3 /*break*/, 7];
return [4 /*yield*/, new ConnectionOptionsYmlReader().read(configFile)];
case 6:
connectionOptions = _a.sent();
return [3 /*break*/, 11];
case 7:
if (!(foundFileFormat === "yaml")) return [3 /*break*/, 9];
return [4 /*yield*/, new ConnectionOptionsYmlReader().read(configFile)];
case 8:
connectionOptions = _a.sent();
return [3 /*break*/, 11];
case 9:
if (!(foundFileFormat === "xml")) return [3 /*break*/, 11];
return [4 /*yield*/, new ConnectionOptionsXmlReader().read(configFile)];
case 10:
connectionOptions = _a.sent();
_a.label = 11;
case 11:
// normalize and return connection options
if (connectionOptions) {
return [2 /*return*/, this.normalizeConnectionOptions(connectionOptions)];
}
return [2 /*return*/, undefined];
}
});
});
};
/**
* Normalize connection options.
*/
ConnectionOptionsReader.prototype.normalizeConnectionOptions = function (connectionOptions) {
var _this = this;
if (!(Array.isArray(connectionOptions)))
connectionOptions = [connectionOptions];
connectionOptions.forEach(function (options) {
if (options.entities) {
var entities = options.entities.map(function (entity) {
if (typeof entity === "string" && entity.substr(0, 1) !== "/")
return _this.baseDirectory + "/" + entity;
return entity;
});
Object.assign(connectionOptions, { entities: entities });
}
if (options.subscribers) {
var subscribers = options.subscribers.map(function (subscriber) {
if (typeof subscriber === "string" && subscriber.substr(0, 1) !== "/")
return _this.baseDirectory + "/" + subscriber;
return subscriber;
});
Object.assign(connectionOptions, { subscribers: subscribers });
}
if (options.migrations) {
var migrations = options.migrations.map(function (migration) {
if (typeof migration === "string" && migration.substr(0, 1) !== "/")
return _this.baseDirectory + "/" + migration;
return migration;
});
Object.assign(connectionOptions, { migrations: migrations });
}
// make database path file in sqlite relative to package.json
if (options.type === "sqlite" || options.type === "better-sqlite3") {
if (typeof options.database === "string" &&
options.database.substr(0, 1) !== "/" && // unix absolute
options.database.substr(1, 2) !== ":\\" && // windows absolute
options.database !== ":memory:") {
Object.assign(options, {
database: _this.baseDirectory + "/" + options.database
});
}
}
});
return connectionOptions;
};
Object.defineProperty(ConnectionOptionsReader.prototype, "baseFilePath", {
/**
* Gets directory where configuration file should be located and configuration file name.
*/
get: function () {
return this.baseDirectory + "/" + this.baseConfigName;
},
enumerable: false,
configurable: true
});
Object.defineProperty(ConnectionOptionsReader.prototype, "baseDirectory", {
/**
* Gets directory where configuration file should be located.
*/
get: function () {
if (this.options && this.options.root)
return this.options.root;
return appRootPath.path;
},
enumerable: false,
configurable: true
});
Object.defineProperty(ConnectionOptionsReader.prototype, "baseConfigName", {
/**
* Gets configuration file name.
*/
get: function () {
if (this.options && this.options.configName)
return this.options.configName;
return "ormconfig";
},
enumerable: false,
configurable: true
});
return ConnectionOptionsReader;
}());
export { ConnectionOptionsReader };
//# sourceMappingURL=ConnectionOptionsReader.js.map