node-server-engine 1.1.2 → 1.1.3

package/package.json

@@ -1,161 +1,164 @@
-{
-  "name": "node-server-engine",
-  "version": "1.1.2",
-  "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",
-    "@google/generative-ai": "^0.21.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.2",
-    "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",
-    "multer": "^1.4.5-lts.1",
-    "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/multer": "^1.4.12",
-    "@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/tmp": "^0.2.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",
-    "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",
-    "tmp": "^0.2.3",
-    "ts-node": "^10.9.2",
-    "tsc-alias": "^1.8.10",
-    "tsconfig-paths": "^4.2.0",
-    "typescript": "^5.5.4",
-    "typescript-eslint": "^8.8.1"
-  }
-}
+{
+  "name": "node-server-engine",
+  "version": "1.1.3",
+  "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 && shx 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": "cross-env 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",
+    "@google/generative-ai": "^0.21.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.2",
+    "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",
+    "multer": "^1.4.5-lts.1",
+    "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",
+    "tedious": "^18.6.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/multer": "^1.4.12",
+    "@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/tmp": "^0.2.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",
+    "cross-env": "^7.0.3",
+    "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",
+    "shx": "^0.3.4",
+    "sinon": "^9.2.4",
+    "sinon-chai": "^3.5.0",
+    "supertest": "^7.0.0",
+    "tmp": "^0.2.3",
+    "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

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

package/src/const/LogSeverity.ts

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

package/src/const/index.ts

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

package/src/const/metrics.ts

@@ -1,6 +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();
+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

@@ -1,37 +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];
+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

@@ -1,9 +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);
+/** 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

@@ -1,29 +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');
-}
+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

@@ -1,16 +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;
-}
+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

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