@expressots/core 3.0.0 → 4.0.0-preview.1

package/package.json

@@ -1,151 +1,152 @@
-{
-  "name": "@expressots/core",
-  "version": "3.0.0",
-  "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
-  "author": "Richard Zampieri",
-  "main": "./lib/cjs/index.js",
-  "types": "./lib/cjs/types/index.d.ts",
-  "exports": {
-    ".": {
-      "import": {
-        "types": "./lib/esm/types/index.d.ts",
-        "default": "./lib/esm/index.mjs"
-      },
-      "require": {
-        "types": "./lib/cjs/types/index.d.ts",
-        "default": "./lib/cjs/index.js"
-      }
-    }
-  },
-  "files": [
-    "lib/**/*"
-  ],
-  "license": "MIT",
-  "homepage": "https://expresso-ts.com",
-  "funding": {
-    "type": "github",
-    "url": "https://github.com/sponsors/expressots"
-  },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/expressots/expressots"
-  },
-  "bugs": {
-    "url": "https://github.com/expressots/expressots/issues"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "keywords": [
-    "expressots",
-    "nodejs",
-    "microservices",
-    "typescript",
-    "clean-architecture",
-    "typescript-framework",
-    "framework",
-    "server-side"
-  ],
-  "scripts": {
-    "prepare": "husky",
-    "clean": "node scripts/rm.js lib",
-    "copy": "node scripts/copy.js package.json README.md CHANGELOG.md lib",
-    "rename:esm": "node scripts/mv.js lib/esm/index.js lib/esm/index.mjs",
-    "build:full": "npm run clean && npm run build:esm && npm run build:cjs && npm run copy",
-    "build": "npm run clean && npm run build:cjs && npm run copy",
-    "build:esm": "tsc -p tsconfig.esm.json && npm run rename:esm",
-    "build:cjs": "tsc -p tsconfig.cjs.json",
-    "prepublish": "npm run build && npm pack",
-    "release": "release-it",
-    "test": "jest",
-    "test:watch": "jest --watch",
-    "coverage": "jest --coverage",
-    "format": "prettier --write \"packages/**/*.ts\" --cache",
-    "lint": "eslint \"packages/**/*.ts\"",
-    "lint:fix": "eslint \"packages/**/*.ts\" --fix"
-  },
-  "dependencies": {
-    "reflect-metadata": "0.2.2"
-  },
-  "devDependencies": {
-    "@codecov/vite-plugin": "0.0.1-beta.5",
-    "@commitlint/cli": "19.2.1",
-    "@commitlint/config-conventional": "19.1.0",
-    "@expressots/shared": "3.0.0",
-    "@release-it/conventional-changelog": "8.0.1",
-    "@types/express": "4.17.21",
-    "@types/jest": "29.5.14",
-    "@types/node": "20.14.10",
-    "@typescript-eslint/eslint-plugin": "7.16.0",
-    "@typescript-eslint/parser": "7.16.0",
-    "eslint": "8.57.0",
-    "eslint-config-prettier": "9.1.0",
-    "husky": "9.0.11",
-    "jest": "29.7.0",
-    "prettier": "3.3.3",
-    "release-it": "17.6.0",
-    "ts-jest": "29.2.5",
-    "typescript": "5.5.3"
-  },
-  "release-it": {
-    "git": {
-      "commitMessage": "chore(release): ${version}"
-    },
-    "github": {
-      "release": true
-    },
-    "npm": {
-      "publish": false
-    },
-    "plugins": {
-      "@release-it/conventional-changelog": {
-        "infile": "CHANGELOG.md",
-        "preset": {
-          "name": "conventionalcommits",
-          "types": [
-            {
-              "type": "feat",
-              "section": "Features"
-            },
-            {
-              "type": "fix",
-              "section": "Bug Fixes"
-            },
-            {
-              "type": "perf",
-              "section": "Performance Improvements"
-            },
-            {
-              "type": "revert",
-              "section": "Reverts"
-            },
-            {
-              "type": "docs",
-              "section": "Documentation"
-            },
-            {
-              "type": "refactor",
-              "section": "Code Refactoring"
-            },
-            {
-              "type": "test",
-              "section": "Tests"
-            },
-            {
-              "type": "build",
-              "section": "Build System"
-            },
-            {
-              "type": "ci",
-              "section": "Continuous Integrations"
-            },
-            {
-              "type": "chore",
-              "hidden": true
-            }
-          ]
-        }
-      }
-    }
-  }
-}
+{
+  "name": "@expressots/core",
+  "version": "4.0.0-preview.1",
+  "description": "Expressots - modern, fast, lightweight nodejs web framework (@core)",
+  "author": "Richard Zampieri",
+  "main": "./lib/cjs/index.js",
+  "types": "./lib/cjs/types/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./lib/esm/types/index.d.ts",
+        "default": "./lib/esm/index.mjs"
+      },
+      "require": {
+        "types": "./lib/cjs/types/index.d.ts",
+        "default": "./lib/cjs/index.js"
+      }
+    }
+  },
+  "files": [
+    "lib/**/*"
+  ],
+  "license": "MIT",
+  "homepage": "https://expresso-ts.com",
+  "funding": {
+    "type": "github",
+    "url": "https://github.com/sponsors/expressots"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/expressots/expressots"
+  },
+  "bugs": {
+    "url": "https://github.com/expressots/expressots/issues"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "expressots",
+    "nodejs",
+    "microservices",
+    "typescript",
+    "clean-architecture",
+    "typescript-framework",
+    "framework",
+    "server-side"
+  ],
+  "scripts": {
+    "prepare": "husky",
+    "clean": "node scripts/rm.js lib",
+    "copy": "node scripts/copy.js package.json README.md CHANGELOG.md lib",
+    "build": "npm run clean && npm run build:cjs && npm run build:esm && npm run copy",
+    "build:esm": "node scripts/build-esm.js",
+    "build:cjs": "tsc -p tsconfig.cjs.json",
+    "prepublish": "npm run build && npm pack",
+    "release": "release-it",
+    "test": "jest",
+    "test:watch": "jest --watch",
+    "coverage": "jest --coverage",
+    "format": "prettier --write \"packages/**/*.ts\" --cache",
+    "lint": "eslint \"packages/**/*.ts\"",
+    "lint:fix": "eslint \"packages/**/*.ts\" --fix",
+    "docs:generate": "node scripts/generate-docs.js",
+    "docs:clean": "node scripts/rm.js docs"
+  },
+  "dependencies": {
+    "reflect-metadata": "0.2.2"
+  },
+  "devDependencies": {
+    "@codecov/vite-plugin": "0.0.1-beta.5",
+    "@commitlint/cli": "19.2.1",
+    "@commitlint/config-conventional": "19.1.0",
+    "@expressots/shared": "file:../shared/expressots-shared-4.0.0-preview.1.tgz",
+    "@release-it/conventional-changelog": "8.0.1",
+    "@types/express": "4.17.21",
+    "@types/jest": "^29.5.14",
+    "@types/node": "20.14.10",
+    "@typescript-eslint/eslint-plugin": "7.16.0",
+    "@typescript-eslint/parser": "7.16.0",
+    "eslint": "8.57.0",
+    "eslint-config-prettier": "9.1.0",
+    "husky": "9.0.11",
+    "jest": "29.7.0",
+    "prettier": "3.3.3",
+    "release-it": "17.6.0",
+    "ts-jest": "29.2.5",
+    "typedoc": "^0.28.15",
+    "typescript": "5.5.3"
+  },
+  "release-it": {
+    "git": {
+      "commitMessage": "chore(release): ${version}"
+    },
+    "github": {
+      "release": true
+    },
+    "npm": {
+      "publish": false
+    },
+    "plugins": {
+      "@release-it/conventional-changelog": {
+        "infile": "CHANGELOG.md",
+        "preset": {
+          "name": "conventionalcommits",
+          "types": [
+            {
+              "type": "feat",
+              "section": "Features"
+            },
+            {
+              "type": "fix",
+              "section": "Bug Fixes"
+            },
+            {
+              "type": "perf",
+              "section": "Performance Improvements"
+            },
+            {
+              "type": "revert",
+              "section": "Reverts"
+            },
+            {
+              "type": "docs",
+              "section": "Documentation"
+            },
+            {
+              "type": "refactor",
+              "section": "Code Refactoring"
+            },
+            {
+              "type": "test",
+              "section": "Tests"
+            },
+            {
+              "type": "build",
+              "section": "Build System"
+            },
+            {
+              "type": "ci",
+              "section": "Continuous Integrations"
+            },
+            {
+              "type": "chore",
+              "hidden": true
+            }
+          ]
+        }
+      }
+    }
+  }
+}

package/lib/cjs/provider/environment/env-validator.provider.js

@@ -1,100 +0,0 @@
-"use strict";
-var __decorate = (this && this.__decorate) || function (decorators, target, key, desc) {
-    var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;
-    if (typeof Reflect === "object" && typeof Reflect.decorate === "function") r = Reflect.decorate(decorators, target, key, desc);
-    else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;
-    return c > 3 && r && Object.defineProperty(target, key, r), r;
-};
-var __metadata = (this && this.__metadata) || function (k, v) {
-    if (typeof Reflect === "object" && typeof Reflect.metadata === "function") return Reflect.metadata(k, v);
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.EnvValidatorProvider = void 0;
-const fs_1 = __importDefault(require("fs"));
-const path_1 = __importDefault(require("path"));
-const inversify_1 = require("../../di/inversify");
-const logger_provider_1 = require("../logger/logger.provider");
-const shared_1 = require("@expressots/shared");
-/**
- * The EnvValidatorProvider class provides utility methods for working with environment variables.
- * It validates, loads, and retrieves environment variables from the .env file.
- * @provide EnvValidatorProvider
- * @public API
- */
-let EnvValidatorProvider = class EnvValidatorProvider {
-    constructor() {
-        this.name = "Env Validator Provider";
-        this.version = "3.0.0";
-        this.author = "Richard Zampieri";
-        this.repo = "https://github.com/expressots/expressots";
-        this.logger = new logger_provider_1.Logger();
-    }
-    /**
-     * Retrieves the value of an environment variable, or a default value if the variable is not set.
-     * @param key - The key of the environment variable.
-     * @param defaultValue - The default value to return if the environment variable is not set.
-     * @returns The value of the environment variable, or the default value if not set.
-     * @public API
-     */
-    get(key, defaultValue = undefined) {
-        return process.env[key] ?? defaultValue;
-    }
-    /**
-     * Validates and loads all environment variables from the .env file.
-     * If the .env file does not exist or any environment variables are not set, the process will exit with an error.
-     * @param envFile -
-     * @public API
-     */
-    checkFile(envFile) {
-        // Get the full path of the .env file
-        const envFilePath = path_1.default.join(process.cwd(), ".", envFile);
-        // Check if the .env file exists
-        if (!fs_1.default.existsSync(envFilePath)) {
-            this.logger.error(`Environment file [${envFile}] is not defined.`, "environment-provider");
-            process.exit(1);
-        }
-        const dotEnvParsed = (0, shared_1.parse)(fs_1.default.readFileSync(envFilePath, "utf8"));
-        /* Verify if all environment variables are defined */
-        let hasError = false;
-        if (dotEnvParsed) {
-            for (const key of Object.keys(dotEnvParsed)) {
-                // Check if the environment variable is not defined or is an empty string
-                if (!process.env[key] || process.env[key] === "") {
-                    this.logger.error(`Environment variable [ ${key} ] is not defined.`, "environment-provider");
-                    hasError = true;
-                }
-            }
-        }
-        if (hasError) {
-            process.exit(1);
-        }
-    }
-};
-exports.EnvValidatorProvider = EnvValidatorProvider;
-exports.EnvValidatorProvider = EnvValidatorProvider = __decorate([
-    (0, inversify_1.injectable)(),
-    __metadata("design:paramtypes", [])
-], EnvValidatorProvider);
-String.prototype.AsBoolean = function () {
-    switch (this.toLowerCase().trim()) {
-        case "true":
-        case "1":
-        case "yes":
-            return true;
-        case "false":
-        case "0":
-        case "no":
-            return false;
-        default:
-            return undefined;
-    }
-};
-String.prototype.AsNumber = function () {
-    return Number(this);
-};
-String.prototype.AsString = function () {
-    return String(this);
-};

package/lib/cjs/types/provider/environment/env-validator.provider.d.ts

@@ -1,39 +0,0 @@
-import { IProvider } from "../provider-manager";
-type DefaultValueType = string | number | boolean | undefined;
-/**
- * The EnvValidatorProvider class provides utility methods for working with environment variables.
- * It validates, loads, and retrieves environment variables from the .env file.
- * @provide EnvValidatorProvider
- * @public API
- */
-export declare class EnvValidatorProvider implements IProvider {
-    name: string;
-    version: string;
-    author: string;
-    repo: string;
-    private logger;
-    constructor();
-    /**
-     * Retrieves the value of an environment variable, or a default value if the variable is not set.
-     * @param key - The key of the environment variable.
-     * @param defaultValue - The default value to return if the environment variable is not set.
-     * @returns The value of the environment variable, or the default value if not set.
-     * @public API
-     */
-    get(key: string, defaultValue?: DefaultValueType): DefaultValueType;
-    /**
-     * Validates and loads all environment variables from the .env file.
-     * If the .env file does not exist or any environment variables are not set, the process will exit with an error.
-     * @param envFile -
-     * @public API
-     */
-    checkFile(envFile: string): void;
-}
-declare global {
-    interface String {
-        AsBoolean(): boolean | undefined;
-        AsNumber(): number | undefined;
-        AsString(): string | undefined;
-    }
-}
-export {};