node-server-engine 1.0.5

package/dist/utils/tlsConfig/tlsConfig.validate.js

@@ -0,0 +1,48 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.validateTlsConfig = validateTlsConfig;
+var _ = require("./..");
+/**
+ * Verify that the environment variables
+ */
+function validateTlsConfig() {
+  // We only check if there is at least the host specified
+  if (process.env.TLS_REQUEST_CERT) {
+    (0, _.assertEnvironment)({
+      TLS_REQUEST_KEY: _.envAssert.isPath()
+    });
+    (0, _.assertEnvironment)({
+      TLS_REQUEST_CERT: _.envAssert.isPath()
+    });
+    (0, _.assertEnvironment)({
+      TLS_REQUEST_CA: _.envAssert.isPath()
+    });
+    // Optional variables
+    if (process.env.TLS_REQUEST_KEY_PASSPHRASE) {
+      (0, _.assertEnvironment)({
+        TLS_REQUEST_KEY_PASSPHRASE: _.envAssert.isString()
+      });
+    }
+  } else if (process.env.TLS_SERVER_CERT) {
+    // if no TLS Request setting, TLS Server setting is essential.
+    (0, _.assertEnvironment)({
+      TLS_SERVER_KEY: _.envAssert.isPath()
+    });
+    (0, _.assertEnvironment)({
+      TLS_SERVER_CERT: _.envAssert.isPath()
+    });
+    (0, _.assertEnvironment)({
+      TLS_CA: _.envAssert.isPath()
+    });
+    // Optional variables
+    if (process.env.TLS_SERVER_KEY_PASSPHRASE) {
+      (0, _.assertEnvironment)({
+        TLS_SERVER_KEY_PASSPHRASE: _.envAssert.isString()
+      });
+    }
+  }
+}
+//# sourceMappingURL=tlsConfig.validate.js.map

package/dist/utils/tlsConfig/tlsConfig.validate.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tlsConfig.validate.js","names":["_","require","validateTlsConfig","process","env","TLS_REQUEST_CERT","assertEnvironment","TLS_REQUEST_KEY","envAssert","isPath","TLS_REQUEST_CA","TLS_REQUEST_KEY_PASSPHRASE","isString","TLS_SERVER_CERT","TLS_SERVER_KEY","TLS_CA","TLS_SERVER_KEY_PASSPHRASE"],"sources":["../../../src/utils/tlsConfig/tlsConfig.validate.ts"],"sourcesContent":["import { assertEnvironment, envAssert } from 'utils';\n/**\n * Verify that the environment variables\n */\nexport function validateTlsConfig(): void {\n  // We only check if there is at least the host specified\n  if (process.env.TLS_REQUEST_CERT) {\n    assertEnvironment({ TLS_REQUEST_KEY: envAssert.isPath() });\n    assertEnvironment({ TLS_REQUEST_CERT: envAssert.isPath() });\n    assertEnvironment({ TLS_REQUEST_CA: envAssert.isPath() });\n    // Optional variables\n    if (process.env.TLS_REQUEST_KEY_PASSPHRASE) {\n      assertEnvironment({ TLS_REQUEST_KEY_PASSPHRASE: envAssert.isString() });\n    }\n  } else if (process.env.TLS_SERVER_CERT) {\n    // if no TLS Request setting, TLS Server setting is essential.\n    assertEnvironment({ TLS_SERVER_KEY: envAssert.isPath() });\n    assertEnvironment({ TLS_SERVER_CERT: envAssert.isPath() });\n    assertEnvironment({ TLS_CA: envAssert.isPath() });\n    // Optional variables\n    if (process.env.TLS_SERVER_KEY_PASSPHRASE) {\n      assertEnvironment({ TLS_SERVER_KEY_PASSPHRASE: envAssert.isString() });\n    }\n  }\n}\n"],"mappings":";;;;;;AAAA,IAAAA,CAAA,GAAAC,OAAA;AACA;AACA;AACA;AACO,SAASC,iBAAiBA,CAAA,EAAS;EACxC;EACA,IAAIC,OAAO,CAACC,GAAG,CAACC,gBAAgB,EAAE;IAChC,IAAAC,mBAAiB,EAAC;MAAEC,eAAe,EAAEC,WAAS,CAACC,MAAM,CAAC;IAAE,CAAC,CAAC;IAC1D,IAAAH,mBAAiB,EAAC;MAAED,gBAAgB,EAAEG,WAAS,CAACC,MAAM,CAAC;IAAE,CAAC,CAAC;IAC3D,IAAAH,mBAAiB,EAAC;MAAEI,cAAc,EAAEF,WAAS,CAACC,MAAM,CAAC;IAAE,CAAC,CAAC;IACzD;IACA,IAAIN,OAAO,CAACC,GAAG,CAACO,0BAA0B,EAAE;MAC1C,IAAAL,mBAAiB,EAAC;QAAEK,0BAA0B,EAAEH,WAAS,CAACI,QAAQ,CAAC;MAAE,CAAC,CAAC;IACzE;EACF,CAAC,MAAM,IAAIT,OAAO,CAACC,GAAG,CAACS,eAAe,EAAE;IACtC;IACA,IAAAP,mBAAiB,EAAC;MAAEQ,cAAc,EAAEN,WAAS,CAACC,MAAM,CAAC;IAAE,CAAC,CAAC;IACzD,IAAAH,mBAAiB,EAAC;MAAEO,eAAe,EAAEL,WAAS,CAACC,MAAM,CAAC;IAAE,CAAC,CAAC;IAC1D,IAAAH,mBAAiB,EAAC;MAAES,MAAM,EAAEP,WAAS,CAACC,MAAM,CAAC;IAAE,CAAC,CAAC;IACjD;IACA,IAAIN,OAAO,CAACC,GAAG,CAACY,yBAAyB,EAAE;MACzC,IAAAV,mBAAiB,EAAC;QAAEU,yBAAyB,EAAER,WAAS,CAACI,QAAQ,CAAC;MAAE,CAAC,CAAC;IACxE;EACF;AACF","ignoreList":[]}

package/dist/utils/tlsRequest/index.d.ts

@@ -0,0 +1 @@
+export * from './tlsRequest';

package/dist/utils/tlsRequest/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _tlsRequest = require("./tlsRequest");
+Object.keys(_tlsRequest).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _tlsRequest[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _tlsRequest[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/dist/utils/tlsRequest/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_tlsRequest","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["../../../src/utils/tlsRequest/index.ts"],"sourcesContent":["export * from './tlsRequest';\n"],"mappings":";;;;;AAAA,IAAAA,WAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,WAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,WAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,WAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/utils/tlsRequest/tlsRequest.d.ts

@@ -0,0 +1,3 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+/** Make a network request using TLS, this exposes the server client certificates to the destination */
+export declare function tlsRequest<T = unknown>(options: AxiosRequestConfig): Promise<AxiosResponse<T>>;

package/dist/utils/tlsRequest/tlsRequest.js

@@ -0,0 +1,18 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.tlsRequest = tlsRequest;
+var _request = require("../request");
+var _tlsConfig = require("../tlsConfig");
+/** Make a network request using TLS, this exposes the server client certificates to the destination */
+async function tlsRequest(options) {
+  // if the config is not initial, will do that.
+  if (!_tlsConfig.httpsAgent) (0, _tlsConfig.loadTlsConfig)();
+  return (0, _request.request)({
+    httpsAgent: _tlsConfig.httpsAgent,
+    ...options
+  });
+}
+//# sourceMappingURL=tlsRequest.js.map

package/dist/utils/tlsRequest/tlsRequest.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tlsRequest.js","names":["_request","require","_tlsConfig","tlsRequest","options","httpsAgent","loadTlsConfig","request"],"sources":["../../../src/utils/tlsRequest/tlsRequest.ts"],"sourcesContent":["import { AxiosRequestConfig, AxiosResponse } from 'axios';\nimport { request } from 'utils/request';\nimport { httpsAgent, loadTlsConfig } from 'utils/tlsConfig';\n\n/** Make a network request using TLS, this exposes the server client certificates to the destination */\nexport async function tlsRequest<T = unknown>(\n  options: AxiosRequestConfig\n): Promise<AxiosResponse<T>> {\n  // if the config is not initial, will do that.\n  if (!httpsAgent) loadTlsConfig();\n  return request<T>({ httpsAgent, ...options });\n}\n"],"mappings":";;;;;;AACA,IAAAA,QAAA,GAAAC,OAAA;AACA,IAAAC,UAAA,GAAAD,OAAA;AAEA;AACO,eAAeE,UAAUA,CAC9BC,OAA2B,EACA;EAC3B;EACA,IAAI,CAACC,qBAAU,EAAE,IAAAC,wBAAa,EAAC,CAAC;EAChC,OAAO,IAAAC,gBAAO,EAAI;IAAEF,UAAU,EAAVA,qBAAU;IAAE,GAAGD;EAAQ,CAAC,CAAC;AAC/C","ignoreList":[]}

package/dist/utils/trimPathSlash/index.d.ts

@@ -0,0 +1 @@
+export * from './trimPathSlash';

package/dist/utils/trimPathSlash/index.js

@@ -0,0 +1,17 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+var _trimPathSlash = require("./trimPathSlash");
+Object.keys(_trimPathSlash).forEach(function (key) {
+  if (key === "default" || key === "__esModule") return;
+  if (key in exports && exports[key] === _trimPathSlash[key]) return;
+  Object.defineProperty(exports, key, {
+    enumerable: true,
+    get: function () {
+      return _trimPathSlash[key];
+    }
+  });
+});
+//# sourceMappingURL=index.js.map

package/dist/utils/trimPathSlash/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":["_trimPathSlash","require","Object","keys","forEach","key","exports","defineProperty","enumerable","get"],"sources":["../../../src/utils/trimPathSlash/index.ts"],"sourcesContent":["export * from './trimPathSlash';\n"],"mappings":";;;;;AAAA,IAAAA,cAAA,GAAAC,OAAA;AAAAC,MAAA,CAAAC,IAAA,CAAAH,cAAA,EAAAI,OAAA,WAAAC,GAAA;EAAA,IAAAA,GAAA,kBAAAA,GAAA;EAAA,IAAAA,GAAA,IAAAC,OAAA,IAAAA,OAAA,CAAAD,GAAA,MAAAL,cAAA,CAAAK,GAAA;EAAAH,MAAA,CAAAK,cAAA,CAAAD,OAAA,EAAAD,GAAA;IAAAG,UAAA;IAAAC,GAAA,WAAAA,CAAA;MAAA,OAAAT,cAAA,CAAAK,GAAA;IAAA;EAAA;AAAA","ignoreList":[]}

package/dist/utils/trimPathSlash/trimPathSlash.d.ts

@@ -0,0 +1,6 @@
+/**
+ * Remove slashes if they are the first or last chars of a string
+ * @param url - URL to which slashes should be stripped
+ * @return Cleaned-up string
+ */
+export declare function trimPathSlash(url: string): string;

package/dist/utils/trimPathSlash/trimPathSlash.js

@@ -0,0 +1,15 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.trimPathSlash = trimPathSlash;
+/**
+ * Remove slashes if they are the first or last chars of a string
+ * @param url - URL to which slashes should be stripped
+ * @return Cleaned-up string
+ */
+function trimPathSlash(url) {
+  return url.replace(/\/$/, '').replace(/^\//, '');
+}
+//# sourceMappingURL=trimPathSlash.js.map

package/dist/utils/trimPathSlash/trimPathSlash.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trimPathSlash.js","names":["trimPathSlash","url","replace"],"sources":["../../../src/utils/trimPathSlash/trimPathSlash.ts"],"sourcesContent":["/**\n * Remove slashes if they are the first or last chars of a string\n * @param url - URL to which slashes should be stripped\n * @return Cleaned-up string\n */\nexport function trimPathSlash(url: string): string {\n  return url.replace(/\\/$/, '').replace(/^\\//, '');\n}\n"],"mappings":";;;;;;AAAA;AACA;AACA;AACA;AACA;AACO,SAASA,aAAaA,CAACC,GAAW,EAAU;EACjD,OAAOA,GAAG,CAACC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAACA,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;AAClD","ignoreList":[]}

package/eslint.config.mjs

@@ -0,0 +1,11 @@
+import globals from 'globals';
+import pluginJs from '@eslint/js';
+import tseslint from 'typescript-eslint';
+
+export default [
+  { files: ['.src/', '**/*.{js,mjs,cjs,ts}'] },
+  { languageOptions: { globals: { ...globals.browser, ...globals.node } } },
+  pluginJs.configs.recommended,
+  { ignores: ['**/*.test.ts', '**/*.d.ts'] },
+  ...tseslint.configs.recommended
+];

package/package.json

@@ -0,0 +1,157 @@
+{
+  "name": "node-server-engine",
+  "version": "1.0.5",
+  "description": "Framework used to develop backend services. This package ships with a lot of features to standardize the creation of services, letting you focus on the business logic.",
+  "main": "dist/index.js",
+  "scripts": {
+    "build": "rimraf dist && tsc -p tsconfig.build.json && mv dist/src/* dist && rimraf dist/src && tsc-alias -p tsconfig.build.json && npx babel src --out-dir dist --source-maps --extensions \".ts\" --ignore \"**/*.test.ts\" --copy-files --no-copy-ignored",
+    "format": "prettier --write .",
+    "lint": "eslint ./src",
+    "lint:fix": "eslint ./src --fix",
+    "prepublish": "npm run build",
+    "test": "NODE_ENV=test nyc --reporter=none mocha test/hooks.ts \"src/**/*.test.ts\"",
+    "coverage": "nyc report --reporter=text",
+    "coverage:ci": "nyc report --reporter=text-summary",
+    "prepublishOnly": "npm run build",
+    "test:ci": "npm run test -- --reporter spec",
+    "test:compose": "docker-compose up --abort-on-container-exit --build"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged && npm run test && npm run coverage"
+    }
+  },
+  "lint-staged": {
+    "*.js": "eslint",
+    "*.ts": "eslint"
+  },
+  "keywords": [],
+  "author": "Ram",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/prakashmahendran/node-server-engine.git"
+  },
+  "bugs": {
+    "url": "https://github.com/prakashmahendran/node-server-engine/issues"
+  },
+  "homepage": "https://github.com/prakashmahendran/node-server-engine#readme",
+  "dependencies": {
+    "@babel/runtime": "^7.25.7",
+    "@elastic/elasticsearch": "^8.15.0",
+    "@google-cloud/pubsub": "^4.7.2",
+    "@google-cloud/storage": "^7.13.0",
+    "@opentelemetry/api": "^1.9.0",
+    "@opentelemetry/core": "^1.26.0",
+    "@opentelemetry/exporter-prometheus": "^0.53.0",
+    "@opentelemetry/metrics": "^0.24.0",
+    "ajv": "^8.17.1",
+    "axios": "^1.7.7",
+    "backend-test-tools": "^1.0.0",
+    "body-parser": "^1.20.3",
+    "busboy": "^1.6.0",
+    "callsite": "^1.0.0",
+    "cors": "^2.8.5",
+    "device": "^0.3.12",
+    "dotenv": "^16.4.5",
+    "envalid": "^8.0.0",
+    "express": "^4.21.1",
+    "express-jwt": "^8.4.1",
+    "express-validator": "^7.2.0",
+    "filesize-parser": "^1.5.1",
+    "flat": "^6.0.1",
+    "form-data": "^4.0.1",
+    "glob": "^11.0.0",
+    "intl-messageformat": "^10.7.0",
+    "ioredis": "^5.4.1",
+    "json-stringify-safe": "^5.0.1",
+    "jsonwebtoken": "^9.0.2",
+    "jwks-rsa": "^3.1.0",
+    "mime-types": "^2.1.35",
+    "morgan": "^1.10.0",
+    "ms": "^2.1.3",
+    "mysql2": "^3.11.3",
+    "nock": "^13.5.5",
+    "nodemon": "^3.1.7",
+    "pg": "^8.13.0",
+    "prom-client": "^15.1.3",
+    "request-ip": "^3.3.0",
+    "response-time": "^2.3.3",
+    "semver-compare": "^1.0.0",
+    "sequelize": "^6.37.5",
+    "sequelize-cli": "^6.6.2",
+    "sequelize-typescript": "^2.1.6",
+    "sharp": "^0.33.5",
+    "swagger-ui-express": "^5.0.1",
+    "umzug": "^3.8.2",
+    "useragent": "^2.3.0",
+    "validator": "^13.12.0",
+    "ws": "^8.18.0",
+    "yamljs": "^0.3.0",
+    "yamlparser": "^0.0.2"
+  },
+  "devDependencies": {
+    "@babel/cli": "^7.25.7",
+    "@babel/core": "^7.25.8",
+    "@babel/plugin-proposal-class-properties": "^7.18.6",
+    "@babel/plugin-proposal-decorators": "^7.25.9",
+    "@babel/plugin-transform-class-properties": "^7.25.7",
+    "@babel/plugin-transform-runtime": "^7.25.7",
+    "@babel/preset-env": "^7.25.8",
+    "@babel/preset-typescript": "^7.25.7",
+    "@babel/register": "^7.25.7",
+    "@faker-js/faker": "^9.0.3",
+    "@google-cloud/precise-date": "^4.0.0",
+    "@types/busboy": "^1.5.4",
+    "@types/callsite": "^1.0.34",
+    "@types/chai": "^4.3.0",
+    "@types/chai-as-promised": "^7.1.4",
+    "@types/express": "^5.0.0",
+    "@types/filesize-parser": "^1.5.3",
+    "@types/flat": "^5.0.5",
+    "@types/glob": "^8.1.0",
+    "@types/json-stringify-safe": "^5.0.3",
+    "@types/jsonwebtoken": "^9.0.7",
+    "@types/mime-types": "^2.1.4",
+    "@types/mocha": "^10.0.9",
+    "@types/mock-fs": "^4.13.4",
+    "@types/mock-require": "^2.0.3",
+    "@types/morgan": "^1.9.9",
+    "@types/node": "^22.8.4",
+    "@types/response-time": "^2.3.8",
+    "@types/sequelize": "^4.28.20",
+    "@types/sinon-chai": "^3.2.6",
+    "@types/supertest": "^6.0.2",
+    "@types/swagger-ui-express": "^4.1.6",
+    "@types/umzug": "^2.3.7",
+    "@types/validator": "^13.12.2",
+    "@types/ws": "^8.5.12",
+    "@types/yamljs": "^0.2.34",
+    "@typescript-eslint/eslint-plugin": "^8.8.1",
+    "babel-plugin-istanbul": "^7.0.0",
+    "babel-plugin-module-resolver": "^5.0.2",
+    "chai": "^4.3.0",
+    "chai-as-promised": "^7.1.1",
+    "cpy-cli": "^5.0.0",
+    "eslint": "^9.13.0",
+    "factory-waifu": "^1.0.1",
+    "globals": "^15.11.0",
+    "husky": "^9.1.6",
+    "lint-staged": "^15.2.10",
+    "mocha": "^10.7.3",
+    "mock-fs": "^5.4.0",
+    "mock-require": "^3.0.3",
+    "move-cli": "^2.0.0",
+    "nyc": "^17.1.0",
+    "prettier": "^3.3.3",
+    "rimraf": "^6.0.1",
+    "sinon": "^9.2.4",
+    "sinon-chai": "^3.5.0",
+    "supertest": "^7.0.0",
+    "ts-node": "^10.9.2",
+    "tsc-alias": "^1.8.10",
+    "tsconfig-paths": "^4.2.0",
+    "typescript": "^5.5.4",
+    "typescript-eslint": "^8.8.1"
+  }
+}

package/src/const/DebeziumEvent.ts

@@ -0,0 +1,6 @@
+/** Debezium event types */
+export enum DebeziumEvent {
+  Create = 'c',
+  Update = 'u',
+  Delete = 'd'
+}

package/src/const/LogSeverity.ts

@@ -0,0 +1,7 @@
+export enum LogSeverity {
+  DEBUG = 'DEBUG',
+  INFO = 'INFO',
+  WARNING = 'WARNING',
+  ERROR = 'ERROR',
+  CRITICAL = 'CRITICAL'
+}

package/src/const/index.ts

@@ -0,0 +1,5 @@
+export * from './mime';
+export * from './metrics';
+export * from './DebeziumEvent';
+export * from './LogSeverity';
+export * from './tokenIssuer';

package/src/const/metrics.ts

@@ -0,0 +1,6 @@
+import { Registry } from 'prom-client';
+
+// Registry for metrics that apply to this specific instance of the service
+export const instanceRegistry = new Registry();
+// Registry for metrics that apply to the service as a whole
+export const serviceRegistry = new Registry();

package/src/const/mime.ts

@@ -0,0 +1,37 @@
+export const IMAGE_BASIC_MIME = ['image/jpeg', 'image/png'];
+
+export const IMAGE_MIME = [...IMAGE_BASIC_MIME, 'image/gif', 'image/bmp'];
+
+export const AUDIO_MIME = [
+  'audio/aac',
+  'audio/mpeg',
+  'audio/wave',
+  'audio/wav'
+];
+
+export const VIDEO_MIME = [
+  'video/mpeg',
+  'video/mp4',
+  'video/3gpp',
+  'video/3gp2'
+];
+
+export const PDF_MIME = ['application/pdf'];
+
+export const WORD_MIME = [
+  'application/msword',
+  'application/vnd.openxmlformats-officedocument.wordprocessingml.document'
+];
+
+export const EXCEL_MIME = [
+  'application/vnd.ms-excel',
+  'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet'
+];
+
+export const POWERPOINT_MIME = [
+  'application/vnd.ms-powerpoint',
+  'application/vnd.openxmlformats-officedocument.presentationml.presentation',
+  'application/vnd.openxmlformats-officedocument.presentationml.slideshow'
+];
+
+export const OFFICE_MIME = [...WORD_MIME, ...EXCEL_MIME, ...POWERPOINT_MIME];

package/src/const/tokenIssuer.ts

@@ -0,0 +1,9 @@
+/** Enum to identify access tokens JWT issuers */
+export enum TokenIssuer {
+  /** For tokens issued by the auth service */
+  AUTH_SERVICE,
+  /** For tokens issued by the admin API */
+  ADMIN_API
+}
+
+export const TOKEN_ISSUERS = Object.values(TokenIssuer);

package/src/db/migrations/20241030121500-create-sequelize-meta-table.ts

@@ -0,0 +1,29 @@
+import { QueryInterface, DataTypes } from 'sequelize';
+
+export async function up(queryInterface: QueryInterface): Promise<void> {
+  await queryInterface.createTable(
+    'SequelizeMeta',
+    {
+      id: {
+        type: DataTypes.INTEGER,
+        autoIncrement: true,
+        primaryKey: true
+      },
+      name: {
+        type: DataTypes.STRING,
+        allowNull: false
+      },
+      version: {
+        type: DataTypes.STRING,
+        allowNull: false
+      }
+    },
+    {
+      charset: 'utf8mb4',
+      collate: 'utf8mb4_unicode_ci' // Change this to a valid collation
+    }
+  );
+}
+export async function down(queryInterface: QueryInterface): Promise<void> {
+  await queryInterface.dropTable('SequelizeMeta');
+}

package/src/db/models/SequelizeMeta.ts

@@ -0,0 +1,16 @@
+import { Table, Column, Model, DataType } from 'sequelize-typescript';
+
+@Table
+export class SequelizeMeta extends Model {
+  @Column({
+    type: DataType.STRING,
+    allowNull: false
+  })
+  name!: string;
+
+  @Column({
+    type: DataType.STRING,
+    allowNull: false
+  })
+  version!: string;
+}

package/src/db/models/index.ts

@@ -0,0 +1,2 @@
+export * from './SequelizeMeta';
+

package/src/entities/ElasticSearch/ElasticSearch.ts

@@ -0,0 +1,103 @@
+import { readdirSync } from 'fs';
+import path from 'path';
+import { Client } from '@elastic/elasticsearch';
+import { ElasticSearchMigration } from './ElasticSearch.types';
+import { EngineError } from 'entities/EngineError';
+import { LifecycleController } from 'entities/LifecycleController';
+import { envAssert, reportError, reportInfo } from 'utils';
+import { checkEnvironment } from 'utils/checkEnvironment';
+
+/** Elastic search client */
+let client: undefined | Client;
+
+export const ElasticSearch = {
+  /**
+   * Init function that should be called on server startup to establish the connection
+   */
+  async init(): Promise<void> {
+    checkEnvironment({
+      ELASTIC_SEARCH_HOST: envAssert.isString(),
+      ELASTIC_SEARCH_USERNAME: envAssert.isString(),
+      ELASTIC_SEARCH_PASSWORD: envAssert.isString(),
+      ELASTIC_SEARCH_MIGRATION_PATH: envAssert.isString()
+    });
+
+    if (!process.env.ELASTIC_SEARCH_HOST)
+      throw new EngineError({
+        message: 'ElasticSearch Hosts not set in environment'
+      });
+
+    client = new Client({
+      node: process.env.ELASTIC_SEARCH_HOST,
+      auth: {
+        username: process.env.ELASTIC_SEARCH_USERNAME as string,
+        password: process.env.ELASTIC_SEARCH_PASSWORD as string
+      }
+    });
+    // In test environment flush the database before running migrations
+    if (process.env.NODE_ENV === 'test')
+      await client.indices.delete({ index: '*' });
+    await this.migrate();
+    LifecycleController.register(this);
+  },
+
+  /**
+   * Migration function called during the init process
+   * Manages the database structure
+   */
+  async migrate(): Promise<void> {
+    if (!client) throw new EngineError('ElasticSearch was not initialized');
+    const migrationPath = path.resolve(
+      process.env.ELASTIC_SEARCH_MIGRATION_PATH as string
+    );
+    const files = readdirSync(`${migrationPath}`);
+    const indexExists = await client.indices.exists({
+      index: 'migrations'
+    });
+    const ran = [];
+    for (const file of files) {
+      if (indexExists) {
+        const {
+          hits: { total }
+        } = await client.search({
+          index: 'migrations',
+          body: { query: { match: { file } } }
+        });
+        let tot = 0;
+        if (typeof total === 'number') {
+          tot = total;
+        } else {
+          tot = total?.value ?? 0;
+        }
+        if (tot > 0) continue;
+      }
+      ran.push(file);
+      const migration = (await import(
+        `${migrationPath}/${file}`
+      )) as ElasticSearchMigration;
+      try {
+        await migration.migrate(client);
+      } catch (error) {
+        reportError(error);
+        process.exit(1);
+      }
+
+      await client.create({
+        index: 'migrations',
+        id: file,
+        body: { file, ranAt: new Date() }
+      });
+    }
+    reportInfo({
+      message: `ElasticSearch: ran ${ran.length} migrations`,
+      data: { files: ran }
+    });
+  },
+
+  /**
+   * Shutdown function that should be called on server stop to close the connection
+   */
+  async shutdown(): Promise<void> {
+    if (client) await client.close();
+  }
+};

package/src/entities/ElasticSearch/ElasticSearch.types.ts

@@ -0,0 +1,7 @@
+import { Client } from '@elastic/elasticsearch';
+
+/** Represents a migration that should be executed on ElasticSearch */
+export interface ElasticSearchMigration {
+  /** Migration function */
+  migrate: (client: Client) => Promise<void>;
+}

package/src/entities/ElasticSearch/index.ts

@@ -0,0 +1,2 @@
+export * from './ElasticSearch';
+export * from './ElasticSearch.types';