beavuck-time 2.5.4 → 3.0.0

package/README.md

@@ -68,7 +68,7 @@ projects. On Docker Hub, while you're developing, you should use the `beavuck/ti
 version.
 
 When the time comes to go to production, to protect yourself from surprise breaking changes, you should instead point to
-specific minor version tags, such as `beavuck/time:2.0` : those will not get breaking changes, but they will get
+specific minor version tags, such as `beavuck/time:3.0` : those will not get breaking changes, but they will get
 security upgrades and bug fixes while they're active.
 
 ### Ⓝ NPM
@@ -115,6 +115,8 @@ Refer to the Docker Compose example below to see an exhaustive list of available
 (The section below supposes you're using a Docker image. If using the npm package, you can set those environment variable
 on the host directly, instead of doing so in the container like detailed below)
 
+> **Note:** The Docker image does not include a `.env` file. All configuration must be passed via environment variables at runtime.
+
 To run the service in a docker-compose environment, add this in your `docker-compose.yml`'s services section:
 
 ```yaml
@@ -164,7 +166,7 @@ docker compose up -d
 
 Now, when you run:
 
-```shell
+```
 curl --location 'http://localhost:{{SOME_PORT_NUMBER}}/now' \
 --header 'Origin: {{SOME_TRUSTED_ORIGIN}}'
 ```

package/build/config/corsOptions.js

@@ -1,8 +1,5 @@
 "use strict";
 // src/config/corsOptions.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.corsOptions = void 0;
 exports.getHostUrl = getHostUrl;
@@ -14,20 +11,12 @@ exports.isOriginAbsentOrTrusted = isOriginAbsentOrTrusted;
 const corsError_1 = require("../errors/corsError");
 const urlUtil_1 = require("../utils/urlUtil");
 const http_status_codes_1 = require("http-status-codes");
-const dotenvx_1 = __importDefault(require("@dotenvx/dotenvx"));
-// Load environment variables from .env file, if available
-// but don't error if the file is missing
-dotenvx_1.default.config({
-    ignore: ['MISSING_ENV_FILE'],
-});
 exports.corsOptions = {
     methods: ['GET', 'OPTIONS'],
     optionsSuccessStatus: http_status_codes_1.StatusCodes.OK,
     origin: (origin, callback) => {
-        if (isAllTrusted() ||
-            (0, urlUtil_1.isSameOrigin)(getHostUrl(), (0, urlUtil_1.tryParseUrl)(origin)) ||
-            isOriginAbsentOrTrusted(origin)) {
-            // eslint-disable-next-line no-restricted-syntax
+        if (isAllTrusted() || (0, urlUtil_1.isSameOrigin)(getHostUrl(), (0, urlUtil_1.tryParseUrl)(origin)) || isOriginAbsentOrTrusted(origin)) {
+            // eslint-disable-next-line no-restricted-syntax -- the http external library expects null
             callback(null, true);
         }
         else {

package/build/config/logger.js

@@ -1,18 +1,9 @@
 "use strict";
 // src/config/logger.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.logger = void 0;
 const winston_1 = require("winston");
 require("winston-daily-rotate-file");
-const dotenvx_1 = __importDefault(require("@dotenvx/dotenvx"));
-// Load environment variables from .env file, if available
-// but don't error if the file is missing
-dotenvx_1.default.config({
-    ignore: ['MISSING_ENV_FILE'],
-});
 const LOGS_DIR = 'beavuck-time-logs';
 const LOG_LEVEL = process.env.BEAVUCK_TIME_LOG_LEVEL ?? 'info';
 const MAX_LOG_FILES = process.env.BEAVUCK_TIME_MAX_LOG_FILES ?? 64;

package/build/errors/beavuckTimeServerError.js

@@ -10,7 +10,7 @@ class BeavuckTimeServerError extends beavuckTimeError_1.BeavuckTimeError {
         super(`${BeavuckTimeServerError.baseMessage}: ${message}`, code);
     }
     static fromError(error) {
-        return error instanceof BeavuckTimeServerError ? error : (new BeavuckTimeServerError(error.message));
+        return error instanceof BeavuckTimeServerError ? error : new BeavuckTimeServerError(error.message);
     }
 }
 exports.BeavuckTimeServerError = BeavuckTimeServerError;

package/build/middlewares/corsMiddleware.js

@@ -20,8 +20,7 @@ const corsMiddleware = (req, res, next) => {
         (0, cors_1.default)(corsOptions_1.corsOptions)(req, res, next);
     }
     else if (!HOST_URL) {
-        const noHostUrl = 'Host URL not set';
-        next(new beavuckTimeServerError_1.BeavuckTimeServerError(noHostUrl));
+        next(new beavuckTimeServerError_1.BeavuckTimeServerError('Host URL not set'));
     }
     else if ((0, urlUtil_1.isSameOrigin)(HOST_URL, (0, urlUtil_1.tryParseUrl)(referrerHeader ?? ''))) {
         next();

package/build/middlewares/rateLimiter.js

@@ -11,6 +11,4 @@ const RATE_LIMIT = Number.parseInt(process.env.BEAVUCK_TIME_RATE_LIMIT ?? NO_RAT
 const SECONDS_IN_ONE_MINUTE = 60;
 const MILLISECONDS_IN_ONE_SECOND = 1000;
 const ONE_MINUTE = SECONDS_IN_ONE_MINUTE * MILLISECONDS_IN_ONE_SECOND;
-exports.rateLimiter = RATE_LIMIT > 0 ?
-    (0, express_rate_limit_1.default)({ windowMs: ONE_MINUTE, limit: RATE_LIMIT })
-    : (_req, _res, next) => next();
+exports.rateLimiter = RATE_LIMIT > 0 ? (0, express_rate_limit_1.default)({ windowMs: ONE_MINUTE, limit: RATE_LIMIT }) : (_req, _res, next) => next();

package/build/server.js

@@ -1,20 +1,17 @@
 #!/usr/bin/env node
 "use strict";
 // src/server.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.startServer = startServer;
 const api_1 = require("./api");
 const logger_1 = require("./config/logger");
 const urlUtil_1 = require("./utils/urlUtil");
-const dotenvx_1 = __importDefault(require("@dotenvx/dotenvx"));
-// Load environment variables from .env file, if available
-// but don't error if the file is missing
-dotenvx_1.default.config({
-    ignore: ['MISSING_ENV_FILE'],
-});
+try {
+    process.loadEnvFile();
+}
+catch {
+    // .env file is optional
+}
 function startServer(options = {}) {
     manageEnvVars(options);
     const server = api_1.api.listen(process.env.BEAVUCK_TIME_API_PORT, () => {
@@ -50,13 +47,11 @@ function startServer(options = {}) {
 }
 function manageEnvVars(options) {
     logger_1.logger.info('serverOptions: ' + JSON.stringify(options));
-    process.env.BEAVUCK_TIME_API_PORT =
-        options.apiPort === undefined ? '3000' : String(options.apiPort);
+    process.env.BEAVUCK_TIME_API_PORT = options.apiPort === undefined ? '3000' : String(options.apiPort);
     logger_1.logger.debug('API_PORT: ' + process.env.BEAVUCK_TIME_API_PORT);
     process.env.BEAVUCK_TIME_HOST_URL = options.hostUrl ?? process.env.BEAVUCK_TIME_HOST_URL;
     logger_1.logger.debug('HOST_URL: ' + process.env.BEAVUCK_TIME_HOST_URL);
-    process.env.BEAVUCK_TIME_TRUSTED_ORIGINS =
-        options.trustedOrigins ?? process.env.BEAVUCK_TIME_TRUSTED_ORIGINS;
+    process.env.BEAVUCK_TIME_TRUSTED_ORIGINS = options.trustedOrigins ?? process.env.BEAVUCK_TIME_TRUSTED_ORIGINS;
     logger_1.logger.debug('TRUSTED_ORIGINS: ' + process.env.BEAVUCK_TIME_TRUSTED_ORIGINS);
     validateEnv();
 }

package/openapi/swagger.json

@@ -32,7 +32,7 @@
 	},
 	"info": {
 		"title": "beavuck-time",
-		"version": "2.5.4",
+		"version": "3.0.0",
 		"description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
 		"license": {
 			"name": "Unlicense"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "beavuck-time",
-  "version": "2.5.4",
+  "version": "3.0.0",
   "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
   "keywords": [
     "time",
@@ -33,7 +33,7 @@
     "beavuck-time": "build/server.js"
   },
   "scripts": {
-    "run-integration-tests": "cd api-tests/bruno && npm install -g @usebruno/cli && bru run --env local --bail",
+    "run-integration-tests": "cd api-tests/bruno && npx --yes @usebruno/cli run --env local --bail",
     "up-patch": "npm version patch --no-git-tag-version",
     "up-minor": "npm version minor --no-git-tag-version",
     "up-major": "npm version major --no-git-tag-version",
@@ -43,13 +43,12 @@
     "typecheck": "tsc --noEmit",
     "format": "prettier --write src/ --log-level warn",
     "clean": "npm run lint && npm run typecheck && npm run format",
-    "test": "DOTENV_CONFIG_PATH=./.env.test jest --coverage",
+    "test": "node --env-file=.env.test node_modules/.bin/jest --coverage",
     "build": "tsoa spec-and-routes && tsc",
     "start": "node build/server.js",
     "go": "rm -rf build && npm install && npm run build && npm run clean && npm run test && npm run start"
   },
   "dependencies": {
-    "@dotenvx/dotenvx": "^1.52.0",
     "cors": "^2.8.6",
     "express": "^5.2.1",
     "express-rate-limit": "^8.2.1",
@@ -64,10 +63,10 @@
     "@types/cors": "^2.8.19",
     "@types/express": "^5.0.6",
     "@types/jest": "^30.0.0",
-    "@types/node": "^25.1.0",
+    "@types/node": "^25.2.3",
     "@types/supertest": "^6.0.3",
     "eslint": "^9.39.2",
-    "globals": "^17.2.0",
+    "globals": "^17.3.0",
     "jest": "^30.2.0",
     "nodemon": "^3.1.11",
     "npm-check-updates": "^19.3.2",
@@ -76,15 +75,15 @@
     "ts-jest": "^29.4.6",
     "ts-node": "^10.9.2",
     "typescript": "^5.9.3",
-    "typescript-eslint": "^8.54.0"
+    "typescript-eslint": "^8.56.0"
   },
   "engines": {
-    "node": ">=18.20.8"
+    "node": ">=20.12.0"
   },
   "prettier": {
     "experimentalTernaries": true,
     "semi": false,
-    "printWidth": 96,
+    "printWidth": 120,
     "tabWidth": 2,
     "useTabs": false,
     "singleQuote": true,