beavuck-time 2.3.13 → 2.4.1

package/README.md

@@ -86,12 +86,19 @@ If you want to run this service programmatically in your Node.js project:
 ```js
 import { startServer } from 'beavuck-time'
 
-startServer()
+startServer({
+  hostUrl: 'https://time-api.example.com',
+  trustedOrigins: 'https://my.app.com, https://my.app.com/*, https://my-other.app.com, https://my-other.app.com/*',
+  apiPort: 3000,
+  rateLimit: -1,
+  logLevel: 'info',
+  maxLogFiles: 64,
+  maxSizeLogFiles: '1m',
+})
 ```
 
-You can rely on environment variables (BEAVUCK_TIME_HOST_URL, etc.) stored in a `.env` file at the root of your project.
-It is a known limitation -- work is in progress to allow passing those options directly as parameters to `startServer()`.
-Refer to the Docker Compose example below to see an exhaustive list of available environment variables and what they do.
+You can rely on environment variables (BEAVUCK_TIME_HOST_URL, etc.) instead of passing an options object. Refer to
+the Docker Compose example below to see an exhaustive list of available environment variables and what they do.
 
 #### CLI
 
@@ -127,7 +134,7 @@ time:
         # BEAVUCK_TIME_TRUSTED_ORIGINS: To allow requests from any origin, include * (not recommended). If empty, will only allow requests from the HOST_URL's origin. Defaults to the HOST_URL's origin
         - BEAVUCK_TIME_API_PORT: 3000
         # BEAVUCK_TIME_API_PORT: Optional. Internal port when in a container. Defaults to 3000
-        - BEAVUCK_TIME_RATE_LIMIT: 100
+        - BEAVUCK_TIME_RATE_LIMIT: -1
         # BEAVUCK_TIME_RATE_LIMIT: Optional. Max allowed number of requests per minute for each IP address. If negative or 0, no limit. Defaults to no limit
         - BEAVUCK_TIME_LOG_LEVEL: info
         # BEAVUCK_TIME_LOG_LEVEL: Optional. Logging levels include error, warn, info, http, verbose, debug, silly. Defaults to info

package/build/config/corsOptions.js

@@ -11,7 +11,7 @@ exports.getTrustedOrigins = getTrustedOrigins;
 exports.initTrustedOrigins = initTrustedOrigins;
 exports.isAllTrusted = isAllTrusted;
 exports.isOriginAbsentOrTrusted = isOriginAbsentOrTrusted;
-const CorsError_1 = require("../errors/CorsError");
+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"));
@@ -27,7 +27,7 @@ exports.corsOptions = {
             callback(null, true);
         }
         else {
-            callback(new CorsError_1.CorsError(origin), false);
+            callback(new corsError_1.CorsError(origin), false);
         }
     },
 };
@@ -50,11 +50,16 @@ function getTrustedOrigins() {
 }
 function initTrustedOrigins() {
     const trustedOrigins = process.env.BEAVUCK_TIME_TRUSTED_ORIGINS;
-    TRUSTED_ORIGINS = trustedOrigins.split(',');
+    TRUSTED_ORIGINS = trustedOrigins
+        .split(',')
+        .map(to => to.trim())
+        .filter(to => to.length > 0);
 }
 function isAllTrusted() {
     return getTrustedOrigins().includes('*');
 }
 function isOriginAbsentOrTrusted(origin) {
-    return !origin || getTrustedOrigins().includes(origin);
+    return (!origin ||
+        getTrustedOrigins().includes(origin) ||
+        getTrustedOrigins().some(to => to.includes('/*') && origin.startsWith(to)));
 }

package/build/errors/base/{BeavuckTimeError.js → beavuckTimeError.js}

@@ -1,5 +1,5 @@
 "use strict";
-// src/errors/base/BeavuckTimeError.ts
+// src/errors/base/beavuckTimeError.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BeavuckTimeError = void 0;
 class BeavuckTimeError extends Error {

package/build/errors/{BeavuckTimeClientError.js → beavuckTimeClientError.js}

@@ -1,10 +1,10 @@
 "use strict";
-// src/errors/BeavuckTimeClientError.ts
+// src/errors/beavuckTimeClientError.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BeavuckTimeClientError = void 0;
-const BeavuckTimeError_1 = require("./base/BeavuckTimeError");
+const beavuckTimeError_1 = require("./base/beavuckTimeError");
 const http_status_codes_1 = require("http-status-codes");
-class BeavuckTimeClientError extends BeavuckTimeError_1.BeavuckTimeError {
+class BeavuckTimeClientError extends beavuckTimeError_1.BeavuckTimeError {
     static baseMessage = 'Client Error';
     constructor(message, code = http_status_codes_1.StatusCodes.BAD_REQUEST) {
         super(`${BeavuckTimeClientError.baseMessage}: ${message}`, code);

package/build/errors/{BeavuckTimeServerError.js → beavuckTimeServerError.js}

@@ -1,10 +1,10 @@
 "use strict";
-// src/errors/BeavuckTimeServerError.ts
+// src/errors/beavuckTimeServerError.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.BeavuckTimeServerError = void 0;
-const BeavuckTimeError_1 = require("./base/BeavuckTimeError");
+const beavuckTimeError_1 = require("./base/beavuckTimeError");
 const http_status_codes_1 = require("http-status-codes");
-class BeavuckTimeServerError extends BeavuckTimeError_1.BeavuckTimeError {
+class BeavuckTimeServerError extends beavuckTimeError_1.BeavuckTimeError {
     static baseMessage = 'Internal Server Error';
     constructor(message, code = http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR) {
         super(`${BeavuckTimeServerError.baseMessage}: ${message}`, code);

package/build/errors/{CorsError.js → corsError.js}

@@ -1,10 +1,10 @@
 "use strict";
-// src/errors/CorsError.ts
+// src/errors/corsError.ts
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.CorsError = void 0;
 const http_status_codes_1 = require("http-status-codes");
-const BeavuckTimeClientError_1 = require("./BeavuckTimeClientError");
-class CorsError extends BeavuckTimeClientError_1.BeavuckTimeClientError {
+const beavuckTimeClientError_1 = require("./beavuckTimeClientError");
+class CorsError extends beavuckTimeClientError_1.BeavuckTimeClientError {
     static baseMessage = 'Origin forbidden by CORS';
     constructor(origin) {
         super(`${CorsError.baseMessage}: ${origin}`, http_status_codes_1.StatusCodes.FORBIDDEN);

package/build/errors/errorResponse.js

@@ -0,0 +1,14 @@
+"use strict";
+// src/errors/errorResponse.ts
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ErrorResponse = void 0;
+const beavuckTimeServerError_1 = require("./beavuckTimeServerError");
+class ErrorResponse {
+    message;
+    details;
+    constructor(message = beavuckTimeServerError_1.BeavuckTimeServerError.baseMessage, details) {
+        this.message = message;
+        this.details = details;
+    }
+}
+exports.ErrorResponse = ErrorResponse;

package/build/middlewares/corsMiddleware.js

@@ -7,9 +7,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.corsMiddleware = void 0;
 const cors_1 = __importDefault(require("cors"));
 const urlUtil_1 = require("../utils/urlUtil");
-const CorsError_1 = require("../errors/CorsError");
+const corsError_1 = require("../errors/corsError");
 const logger_1 = require("../config/logger");
-const BeavuckTimeServerError_1 = require("../errors/BeavuckTimeServerError");
+const beavuckTimeServerError_1 = require("../errors/beavuckTimeServerError");
 const corsOptions_1 = require("../config/corsOptions");
 const corsMiddleware = (req, res, next) => {
     const HOST_URL = (0, urlUtil_1.tryParseUrl)(process.env.BEAVUCK_TIME_HOST_URL ?? '');
@@ -21,14 +21,14 @@ const corsMiddleware = (req, res, next) => {
     }
     else if (!HOST_URL) {
         const noHostUrl = 'Host URL not set';
-        next(new BeavuckTimeServerError_1.BeavuckTimeServerError(noHostUrl));
+        next(new beavuckTimeServerError_1.BeavuckTimeServerError(noHostUrl));
     }
     else if ((0, urlUtil_1.isSameOrigin)(HOST_URL, (0, urlUtil_1.tryParseUrl)(referrerHeader ?? ''))) {
         next();
     }
     else {
         const badOriginAndOrReferrer = `origin: ${req.headers.origin}, referrer: ${referrerHeader}`;
-        next(new CorsError_1.CorsError(badOriginAndOrReferrer));
+        next(new corsError_1.CorsError(badOriginAndOrReferrer));
     }
 };
 exports.corsMiddleware = corsMiddleware;

package/build/middlewares/errorHandler.js

@@ -3,10 +3,11 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.errorHandler = void 0;
 const logger_1 = require("../config/logger");
-const BeavuckTimeClientError_1 = require("../errors/BeavuckTimeClientError");
-const BeavuckTimeServerError_1 = require("../errors/BeavuckTimeServerError");
+const beavuckTimeClientError_1 = require("../errors/beavuckTimeClientError");
+const beavuckTimeServerError_1 = require("../errors/beavuckTimeServerError");
 const http_status_codes_1 = require("http-status-codes");
 const tsoa_1 = require("tsoa");
+const errorResponse_1 = require("../errors/errorResponse");
 const errorHandler = (err, req, res, next) => {
     if (err instanceof tsoa_1.ValidateError) {
         const logMsg = `Validation error on ${req.path}: ${err.fields}`;
@@ -14,11 +15,11 @@ const errorHandler = (err, req, res, next) => {
         const resMsgObj = { message: 'Validation Error', details: err.fields };
         handleOtherError(res, logMsg, resStatus, resMsgObj);
     }
-    else if (err instanceof BeavuckTimeClientError_1.BeavuckTimeClientError) {
+    else if (err instanceof beavuckTimeClientError_1.BeavuckTimeClientError) {
         handleBeavuckClientError(res, err);
     }
-    else if (err instanceof BeavuckTimeServerError_1.BeavuckTimeServerError || err instanceof Error) {
-        handleBeavuckServerError(res, BeavuckTimeServerError_1.BeavuckTimeServerError.fromError(err));
+    else if (err instanceof beavuckTimeServerError_1.BeavuckTimeServerError || err instanceof Error) {
+        handleBeavuckServerError(res, beavuckTimeServerError_1.BeavuckTimeServerError.fromError(err));
     }
     else if (err) {
         handleOtherError(res);
@@ -39,9 +40,7 @@ function handleBeavuckServerError(res, err) {
     logger_1.logger.error(err);
     sendErrorResponse(res, err);
 }
-function handleOtherError(res, logMsg = `Unknown error`, resStatus = http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR, resMsg = {
-    message: BeavuckTimeServerError_1.BeavuckTimeServerError.baseMessage,
-}) {
+function handleOtherError(res, logMsg = `Unknown error`, resStatus = http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR, resMsg = new errorResponse_1.ErrorResponse()) {
     logger_1.logger.error(`${logMsg}: ${JSON.stringify(resMsg)}`);
     res.status(resStatus).json(resMsg);
 }

package/build/middlewares/rateLimiter.js

@@ -7,7 +7,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.rateLimiter = void 0;
 const express_rate_limit_1 = __importDefault(require("express-rate-limit"));
 const NO_RATE_LIMIT = '-1';
-const RATE_LIMIT = parseInt(process.env.BEAVUCK_TIME_RATE_LIMIT ?? NO_RATE_LIMIT, 10);
+const RATE_LIMIT = Number.parseInt(process.env.BEAVUCK_TIME_RATE_LIMIT ?? NO_RATE_LIMIT, 10);
 const SECONDS_IN_ONE_MINUTE = 60;
 const MILLISECONDS_IN_ONE_SECOND = 1000;
 const ONE_MINUTE = SECONDS_IN_ONE_MINUTE * MILLISECONDS_IN_ONE_SECOND;

package/build/server.js

@@ -10,26 +10,14 @@ 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'],
 });
-function validateEnv({ hostUrl, trustedOrigins, }) {
-    if (!hostUrl || !(0, urlUtil_1.tryParseUrl)(hostUrl)) {
-        logger_1.logger.error('HOST_URL not set or is not a valid URL');
-        process.exit(1);
-    }
-    if (!trustedOrigins) {
-        logger_1.logger.error('TRUSTED_ORIGINS not set');
-        process.exit(1);
-    }
-}
-// FIXME the server options method causes an exception, npm users will have to use a .env file for now
 function startServer(options = {}) {
-    const API_PORT = options.port ?? process.env.BEAVUCK_TIME_API_PORT ?? 3000;
-    const HOST_URL = options.hostUrl ?? process.env.BEAVUCK_TIME_HOST_URL ?? '';
-    const TRUSTED_ORIGINS = options.trustedOrigins ?? process.env.BEAVUCK_TIME_TRUSTED_ORIGINS ?? '';
-    validateEnv({ hostUrl: HOST_URL, trustedOrigins: TRUSTED_ORIGINS });
-    const server = api_1.api.listen(API_PORT, () => {
+    manageEnvVars(options);
+    const server = api_1.api.listen(process.env.BEAVUCK_TIME_API_PORT, () => {
         logger_1.logger.info(`
 | |                               | |                                          ,=.
 | |__   ___  __ ___   ___   _  ___| | __                        ,=""""==.__.="  o".___
@@ -40,7 +28,7 @@ function startServer(options = {}) {
 
  Beavuck Time microservice started successfully
 
- Ready on API port ${API_PORT} (if this is running in a container, this port number is internal to the container)
+ Ready on API port ${process.env.BEAVUCK_TIME_API_PORT} (if this is running in a container, this port number is internal to the container)
       `);
     });
     server.on('error', (err) => {
@@ -60,6 +48,39 @@ function startServer(options = {}) {
     process.on(SIGINT, () => gracefulShutdown(SIGINT));
     return server;
 }
+function manageEnvVars(options) {
+    process.env.BEAVUCK_TIME_API_PORT =
+        options.apiPort === undefined
+            ? '3000'
+            : String(options.apiPort);
+    process.env.BEAVUCK_TIME_HOST_URL =
+        options.hostUrl ?? process.env.BEAVUCK_TIME_HOST_URL;
+    process.env.BEAVUCK_TIME_TRUSTED_ORIGINS =
+        options.trustedOrigins ?? process.env.BEAVUCK_TIME_TRUSTED_ORIGINS;
+    process.env.BEAVUCK_TIME_RATE_LIMIT =
+        options.rateLimit === undefined
+            ? process.env.BEAVUCK_TIME_RATE_LIMIT
+            : String(options.rateLimit);
+    process.env.BEAVUCK_TIME_LOG_LEVEL =
+        options.logLevel ?? process.env.BEAVUCK_TIME_LOG_LEVEL;
+    process.env.BEAVUCK_TIME_MAX_LOG_FILES =
+        options.maxLogFiles === undefined
+            ? process.env.BEAVUCK_TIME_MAX_LOG_FILES
+            : String(options.maxLogFiles);
+    process.env.BEAVUCK_TIME_MAX_SIZE_LOG_FILES =
+        options.maxSizeLogFiles ?? process.env.BEAVUCK_TIME_MAX_SIZE_LOG_FILES;
+    validateEnv();
+}
+function validateEnv() {
+    if (!process.env.BEAVUCK_TIME_HOST_URL || !(0, urlUtil_1.tryParseUrl)(process.env.BEAVUCK_TIME_HOST_URL)) {
+        logger_1.logger.error('HOST_URL not set or is not a valid URL');
+        process.exit(1);
+    }
+    if (!process.env.BEAVUCK_TIME_TRUSTED_ORIGINS) {
+        logger_1.logger.error('TRUSTED_ORIGINS not set');
+        process.exit(1);
+    }
+}
 // Support running as standalone binary
 if (require.main === module) {
     startServer();

package/build/utils/urlUtil.js

@@ -3,14 +3,16 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.isSameOrigin = isSameOrigin;
 exports.tryParseUrl = tryParseUrl;
-const url_1 = require("url");
+const node_url_1 = require("node:url");
 const logger_1 = require("../config/logger");
 function isSameOrigin(thisUrl, thatUrl) {
     logger_1.logger.debug(`Comparing origins: ${thisUrl?.origin} and ${thatUrl?.origin}`);
-    if (!thisUrl || !thatUrl)
+    if (!thisUrl || !thatUrl) {
         return false;
-    if (thisUrl.origin === thatUrl.origin)
+    }
+    if (thisUrl.origin === thatUrl.origin) {
         return true;
+    }
     const isSameProtocol = thisUrl.protocol === thatUrl.protocol;
     const isSameHost = thisUrl.hostname === thatUrl.hostname;
     const isSamePort = thisUrl.port === thatUrl.port;
@@ -22,7 +24,7 @@ function tryParseUrl(urlString) {
         return undefined;
     }
     try {
-        return new url_1.URL(urlString);
+        return new node_url_1.URL(urlString);
     }
     catch (error) {
         logger_1.logger.warn(`Invalid URL string: ${urlString} (${error})`);

package/openapi/swagger.json

@@ -32,7 +32,7 @@
 	},
 	"info": {
 		"title": "beavuck-time",
-		"version": "2.3.13",
+		"version": "2.4.1",
 		"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.3.13",
+  "version": "2.4.1",
   "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
   "keywords": [
     "time",
@@ -46,7 +46,7 @@
     "test": "DOTENV_CONFIG_PATH=./.env.test 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 start"
+    "go": "rm -rf build && npm install && npm run build && npm run clean && npm run test && npm run start"
   },
   "dependencies": {
     "@dotenvx/dotenvx": "^1.51.0",