beavuck-time 2.4.0 → 2.4.1

package/README.md

@@ -87,9 +87,13 @@ If you want to run this service programmatically in your Node.js project:
 import { startServer } from 'beavuck-time'
 
 startServer({
-  port: 3000,
   hostUrl: 'https://time-api.example.com',
-  trustedOrigins: 'https://my.app.com,https://my-other.app.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',
 })
 ```
 
@@ -130,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

@@ -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/server.js

@@ -10,31 +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);
-    }
-}
-function propagateOptionsInEnv(HOST_URL, TRUSTED_ORIGINS, API_PORT) {
-    process.env.BEAVUCK_TIME_HOST_URL = HOST_URL;
-    process.env.BEAVUCK_TIME_TRUSTED_ORIGINS = TRUSTED_ORIGINS;
-    process.env.BEAVUCK_TIME_API_PORT = String(API_PORT);
-}
 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 ?? '';
-    propagateOptionsInEnv(HOST_URL, TRUSTED_ORIGINS, API_PORT);
-    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".___
@@ -45,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) => {
@@ -65,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

@@ -7,10 +7,12 @@ 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;

package/openapi/swagger.json

@@ -32,7 +32,7 @@
 	},
 	"info": {
 		"title": "beavuck-time",
-		"version": "2.4.0",
+		"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.4.0",
+  "version": "2.4.1",
   "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
   "keywords": [
     "time",