beavuck-time 2.3.8 → 2.3.10

package/README.md

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

package/build/config/logger.js

@@ -11,7 +11,7 @@ const dotenvx_1 = __importDefault(require("@dotenvx/dotenvx"));
 dotenvx_1.default.config({
     ignore: ['MISSING_ENV_FILE'],
 });
-const LOGS_DIR = 'logs';
+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;
 const MAX_SIZE_LOG_FILES = process.env.BEAVUCK_TIME_MAX_SIZE_LOG_FILES ?? '1m';

package/build/server.js

@@ -23,6 +23,7 @@ function validateEnv({ hostUrl, trustedOrigins, }) {
         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 ?? '';

package/openapi/swagger.json

@@ -32,7 +32,7 @@
 	},
 	"info": {
 		"title": "beavuck-time",
-		"version": "2.3.8",
+		"version": "2.3.10",
 		"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.8",
+  "version": "2.3.10",
   "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
   "keywords": [
     "time",
@@ -20,7 +20,7 @@
   "license": "Unlicense",
   "author": "Alexis Drai",
   "type": "commonjs",
-  "main": "build/api.js",
+  "main": "build/server.js",
   "files": [
     "build/",
     "openapi/swagger.json",