beavuck-time 3.2.13 → 3.3.1

package/openapi/swagger.json

@@ -27,7 +27,7 @@
 	},
 	"info": {
 		"title": "beavuck-time",
-		"version": "3.2.13",
+		"version": "3.3.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": "3.2.13",
+  "version": "3.3.1",
   "description": "Get time in ISO format, in UTC timezone, from a simple, lightweight node server",
   "keywords": [
     "time",
@@ -33,12 +33,12 @@
     "beavuck-time": "build/server.js"
   },
   "scripts": {
-    "run-integration-tests": "cd api_tests/time_api_tests && npx --yes @usebruno/cli run --env local --bail",
+    "run-integration-tests": "cd api_tests/time_api_tests && npm i -g --ignore-scripts --allow-git=none --min-release-age=10 @usebruno/cli && bru run --delay 50 --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",
-    "upgrade-dependencies": "ncu --cooldown=10d --format group && ncu -u --cooldown=10d && npm run safe-install && npm prune --verbose && npm run audit",
-    "audit": "npm audit fix --verbose",
+    "upgrade-dependencies": "ncu --format group && ncu -u --cooldown=10d -x typescript && npm run safe-install && npm prune --verbose && npm run audit",
+    "audit": "npm audit fix --omit=dev --ignore-scripts --allow-git=none --min-release-age=10 --verbose",
     "prepublishOnly": "npm run safe-install && npm run build",
     "safe-install": "npm install --ignore-scripts --allow-git=none --min-release-age=10",
     "safe-install:ci": "npm ci --ignore-scripts --allow-git=none --min-release-age=10",
@@ -55,9 +55,9 @@
     "@tsoa/runtime": "^6.6.0",
     "cors": "^2.8.6",
     "express": "^5.2.1",
-    "express-rate-limit": "^8.6.2",
+    "express-rate-limit": "^8.7.0",
     "http-status-codes": "^2.3.0",
-    "joi": "^18.2.3",
+    "joi": "^18.2.5",
     "tsoa": "^7.0.0-alpha.0",
     "winston": "^3.19.0",
     "winston-daily-rotate-file": "^5.0.0"
@@ -67,21 +67,22 @@
     "@types/cors": "^2.8.19",
     "@types/express": "^5.0.6",
     "@types/jest": "^30.0.0",
-    "@types/node": "^26.1.2",
+    "@types/node": "^26.4.1",
     "@types/supertest": "^7.2.1",
-    "eslint": "^10.8.0",
-    "globals": "^17.9.0",
-    "jest": "^30.4.2",
-    "jest-util": "^30.4.1",
-    "npm-check-updates": "^23.0.1",
+    "eslint": "^10.9.1",
+    "eslint-plugin-import-x": "^4.17.1",
+    "globals": "^17.12.0",
+    "jest": "^30.5.1",
+    "jest-util": "^30.5.1",
+    "npm-check-updates": "^23.1.0",
     "prettier": "3.9.6",
     "supertest": "^7.2.2",
     "ts-jest": "^29.4.12",
     "typescript": "^6.0.3",
-    "typescript-eslint": "^8.66.0"
+    "typescript-eslint": "^8.69.0"
   },
   "engines": {
-    "node": ">=20.12.0"
+    "node": ">=22"
   },
   "prettier": {
     "experimentalTernaries": true,

package/build/__tests__/api.test.js

@@ -1,74 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const supertest_1 = __importDefault(require("supertest"));
-const api_1 = require("../api");
-const http_status_codes_1 = require("http-status-codes");
-const isoTimestamp_1 = require("../types/isoTimestamp");
-function getSomeTrustedOrigin() {
-    return process.env.BEAVUCK_TIME_TRUSTED_ORIGINS?.split(',')[0] ?? '';
-}
-/**
- * Increments the callsMadeSoFar counter and returns the response and trusted origin
- */
-async function makeSuccessfulCallToNowEndpoint() {
-    const trustedOrigin = getSomeTrustedOrigin();
-    const res = await (0, supertest_1.default)(api_1.api).get('/now').set('Origin', trustedOrigin);
-    return { res, trustedOrigin };
-}
-describe('App Initialization', () => {
-    it('should disable x-powered-by header', async () => {
-        const res = await (0, supertest_1.default)(api_1.api).get('/now');
-        expect(res.header['x-powered-by']).toBeUndefined();
-    });
-    it('should allow requests from trusted origins', async () => {
-        const { res, trustedOrigin } = await makeSuccessfulCallToNowEndpoint();
-        expect(res.header['access-control-allow-origin']).toBe(trustedOrigin);
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.OK);
-    });
-    it('should block requests from non-trusted origins', async () => {
-        const res = await (0, supertest_1.default)(api_1.api).get('/now').set('Origin', 'https://non-trusted.com');
-        expect(res.header['access-control-allow-origin']).toBeUndefined();
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.FORBIDDEN);
-    });
-    it('should block requests with no origin header', async () => {
-        const res = await (0, supertest_1.default)(api_1.api).get('/now');
-        expect(res.header['access-control-allow-origin']).toBeUndefined();
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.FORBIDDEN);
-    });
-    it('should allow requests with no origin header but a referrer header identical to server url', async () => {
-        const REFERRER = process.env.BEAVUCK_TIME_HOST_URL;
-        const res = await (0, supertest_1.default)(api_1.api).get('/now').set('Referrer', REFERRER);
-        expect(res.header['access-control-allow-origin']).toBeUndefined();
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.OK);
-    });
-    it('should allow requests with no origin header but a referer (sic) header identical to server url', async () => {
-        const REFERER = process.env.BEAVUCK_TIME_HOST_URL;
-        const res = await (0, supertest_1.default)(api_1.api).get('/now').set('Referer', REFERER);
-        expect(res.header['access-control-allow-origin']).toBeUndefined();
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.OK);
-    });
-    it('should handle errors using errorHandler middleware', async () => {
-        const res = await (0, supertest_1.default)(api_1.api).get('/nope').set('Origin', getSomeTrustedOrigin());
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.NOT_FOUND);
-    });
-    it('should return the current time in ISO format', async () => {
-        const { res } = await makeSuccessfulCallToNowEndpoint();
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.OK);
-        expect(res.body).toHaveProperty('now');
-        expect(res.body.now).toMatch(isoTimestamp_1.RFC_3339_FORMAT);
-    });
-    it('should return 500 if HOST_URL is not set', async () => {
-        const originalHostUrl = process.env.BEAVUCK_TIME_HOST_URL;
-        delete process.env.BEAVUCK_TIME_HOST_URL;
-        const res = await (0, supertest_1.default)(api_1.api).get('/now');
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR);
-        process.env.BEAVUCK_TIME_HOST_URL = originalHostUrl;
-    });
-    it('should block requests with non-trusted referrer header if origin is not OK', async () => {
-        const res = await (0, supertest_1.default)(api_1.api).get('/now').set('Referrer', 'https://non-trusted.com');
-        expect(res.status).toBe(http_status_codes_1.StatusCodes.FORBIDDEN);
-    });
-});

package/build/__tests__/config/corsOptions.test.js

@@ -1,34 +0,0 @@
-"use strict";
-// src/__tests__/config/corsOptions.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const corsOptions_1 = require("../../config/corsOptions");
-function setTrustedOrigins(...origins) {
-    process.env.BEAVUCK_TIME_TRUSTED_ORIGINS = origins.join(',');
-    (0, corsOptions_1.initTrustedOrigins)();
-}
-describe('isOriginTrusted', () => {
-    it('returns true for an exact match', () => {
-        setTrustedOrigins('https://app.example.com');
-        expect((0, corsOptions_1.isOriginTrusted)('https://app.example.com')).toBe(true);
-    });
-    it('returns true for a wildcard pattern matching the origin host', () => {
-        setTrustedOrigins('https://app.example.com/*');
-        expect((0, corsOptions_1.isOriginTrusted)('https://app.example.com')).toBe(true);
-    });
-    it('does not allow a domain that merely shares a prefix with a trusted origin', () => {
-        setTrustedOrigins('https://app.example.com');
-        expect((0, corsOptions_1.isOriginTrusted)('https://app.example.com.evil.com')).toBe(false);
-    });
-    it('does not allow a domain that shares a prefix with a wildcard trusted origin', () => {
-        setTrustedOrigins('https://app.example.com/*');
-        expect((0, corsOptions_1.isOriginTrusted)('https://app.example.com.evil.com')).toBe(false);
-    });
-    it('returns false for an untrusted origin', () => {
-        setTrustedOrigins('https://app.example.com');
-        expect((0, corsOptions_1.isOriginTrusted)('https://other.com')).toBe(false);
-    });
-    it('returns false when the trusted origin pattern is malformed', () => {
-        setTrustedOrigins('not-a-url/*');
-        expect((0, corsOptions_1.isOriginTrusted)('not-a-url')).toBe(false);
-    });
-});

package/build/__tests__/middlewares/corsMiddleware.test.js

@@ -1,63 +0,0 @@
-"use strict";
-// src/__tests__/middlewares/corsMiddleware.test.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const cors_1 = __importDefault(require("cors"));
-const corsMiddleware_1 = require("../../middlewares/corsMiddleware");
-const corsError_1 = require("../../errors/corsError");
-const beavuckTimeServerError_1 = require("../../errors/beavuckTimeServerError");
-const logger_1 = require("../../config/logger");
-jest.mock('cors');
-jest.mock('../../config/logger');
-const mockCors = cors_1.default;
-describe('corsMiddleware', () => {
-    let req;
-    let res;
-    let next;
-    beforeEach(() => {
-        req = { headers: {} };
-        res = {};
-        next = jest.fn();
-        mockCors.mockReturnValue((_req, _res, n) => n());
-        process.env.BEAVUCK_TIME_HOST_URL = 'http://localhost:3000';
-    });
-    afterEach(() => {
-        jest.clearAllMocks();
-    });
-    it('delegates to cors() when origin header is present', () => {
-        req.headers.origin = 'http://trusted.com';
-        (0, corsMiddleware_1.corsMiddleware)(req, res, next);
-        expect(mockCors).toHaveBeenCalled();
-        expect(next).toHaveBeenCalledWith();
-    });
-    it('logs the sanitized origin on CORS requests', () => {
-        req.headers.origin = 'http://evil.com\x01injected';
-        (0, corsMiddleware_1.corsMiddleware)(req, res, next);
-        expect(logger_1.logger.debug).toHaveBeenCalledWith('CORS request from http://evil.cominjected');
-    });
-    it('calls next with BeavuckTimeServerError when HOST_URL is not set', () => {
-        delete process.env.BEAVUCK_TIME_HOST_URL;
-        (0, corsMiddleware_1.corsMiddleware)(req, res, next);
-        expect(next).toHaveBeenCalledWith(expect.any(beavuckTimeServerError_1.BeavuckTimeServerError));
-    });
-    it('calls next without error when referrer matches the host', () => {
-        req.headers.referer = 'http://localhost:3000/page';
-        (0, corsMiddleware_1.corsMiddleware)(req, res, next);
-        expect(next).toHaveBeenCalledWith();
-    });
-    it('calls next with CorsError when neither origin nor referrer is trusted', () => {
-        req.headers.referer = 'http://untrusted.com';
-        (0, corsMiddleware_1.corsMiddleware)(req, res, next);
-        expect(next).toHaveBeenCalledWith(expect.any(corsError_1.CorsError));
-    });
-    it('sanitizes control characters from the CorsError message', () => {
-        req.headers.referer = 'http://evil.com\x0ainjected';
-        (0, corsMiddleware_1.corsMiddleware)(req, res, next);
-        const error = next.mock.calls[0][0];
-        // eslint-disable-next-line no-control-regex
-        expect(error.message).not.toMatch(/\x0a/);
-        expect(error.message).toContain('http://evil.cominjected');
-    });
-});

package/build/__tests__/middlewares/errorHandler.test.js

@@ -1,80 +0,0 @@
-"use strict";
-// src/__tests__/middlewares/errorHandler.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const errorHandler_1 = require("../../middlewares/errorHandler");
-const beavuckTimeClientError_1 = require("../../errors/beavuckTimeClientError");
-const beavuckTimeServerError_1 = require("../../errors/beavuckTimeServerError");
-const corsError_1 = require("../../errors/corsError");
-const http_status_codes_1 = require("http-status-codes");
-const logger_1 = require("../../config/logger");
-const tsoa_1 = require("tsoa");
-jest.mock('../../config/logger');
-describe('errorHandler', () => {
-    let req;
-    let res;
-    let next;
-    beforeEach(() => {
-        req = {};
-        res = {
-            status: jest.fn().mockReturnThis(),
-            json: jest.fn().mockReturnThis(),
-        };
-        next = jest.fn();
-    });
-    it('should handle BeavuckTimeClientError', () => {
-        const err = new beavuckTimeClientError_1.BeavuckTimeClientError('Some message');
-        (0, errorHandler_1.errorHandler)(err, req, res, next);
-        expect(logger_1.logger.warn).toHaveBeenCalledWith(err);
-        expect(res.status).toHaveBeenCalledWith(err.code);
-        expect(res.json).toHaveBeenCalledWith({ message: `${err.message}` });
-    });
-    it('should handle CorsError', () => {
-        const err = new corsError_1.CorsError('Some message');
-        (0, errorHandler_1.errorHandler)(err, req, res, next);
-        expect(logger_1.logger.warn).toHaveBeenCalledWith(err);
-        expect(res.status).toHaveBeenCalledWith(err.code);
-        expect(res.json).toHaveBeenCalledWith({ message: `${err.message}` });
-    });
-    it('should handle BeavuckTimeServerError', () => {
-        const err = new beavuckTimeServerError_1.BeavuckTimeServerError('Some message');
-        (0, errorHandler_1.errorHandler)(err, req, res, next);
-        expect(logger_1.logger.error).toHaveBeenCalledWith(err);
-        expect(res.status).toHaveBeenCalledWith(err.code);
-        expect(res.json).toHaveBeenCalledWith({ message: beavuckTimeServerError_1.BeavuckTimeServerError.baseMessage });
-    });
-    it('should handle non-specific error', () => {
-        const err = new Error('Some message');
-        (0, errorHandler_1.errorHandler)(err, req, res, next);
-        const beavuckError = beavuckTimeServerError_1.BeavuckTimeServerError.fromError(err);
-        expect(logger_1.logger.error).toHaveBeenCalledWith(beavuckError);
-        expect(res.status).toHaveBeenCalledWith(http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR);
-        expect(res.json).toHaveBeenCalledWith({ message: beavuckTimeServerError_1.BeavuckTimeServerError.baseMessage });
-    });
-    it('should call next if no error', () => {
-        (0, errorHandler_1.errorHandler)(undefined, req, res, next);
-        expect(next).toHaveBeenCalled();
-    });
-    it('should handle ValidateError', () => {
-        const err = new tsoa_1.ValidateError({}, 'Some message');
-        (0, errorHandler_1.errorHandler)(err, req, res, next);
-        expect(logger_1.logger.error).toHaveBeenCalled();
-        expect(res.status).toHaveBeenCalledWith(http_status_codes_1.StatusCodes.UNPROCESSABLE_ENTITY);
-        expect(res.json).toHaveBeenCalledWith({
-            message: 'Validation Error',
-            details: err.fields,
-        });
-    });
-    it('should handle unknown error type', () => {
-        const err = { some: 'unknown error' };
-        (0, errorHandler_1.errorHandler)(err, req, res, next);
-        expect(logger_1.logger.error).toHaveBeenCalled();
-        expect(res.status).toHaveBeenCalledWith(http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR);
-        expect(res.json).toHaveBeenCalledWith({
-            message: 'Internal Server Error',
-        });
-    });
-    it('should handle null error', () => {
-        (0, errorHandler_1.errorHandler)(undefined, req, res, next);
-        expect(next).toHaveBeenCalled();
-    });
-});

package/build/__tests__/utils/stringUtil.test.js

@@ -1,15 +0,0 @@
-"use strict";
-// src/__tests__/utils/stringUtil.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const stringUtil_1 = require("../../utils/stringUtil");
-describe('sanitizeForLog', () => {
-    it('strips C0 control characters', () => {
-        expect((0, stringUtil_1.sanitizeForLog)('foo\x00\x01\x1fbar')).toBe('foobar');
-    });
-    it('strips DEL and C1 control characters', () => {
-        expect((0, stringUtil_1.sanitizeForLog)('foo\x7f\x80\x9fbar')).toBe('foobar');
-    });
-    it('leaves printable characters untouched', () => {
-        expect((0, stringUtil_1.sanitizeForLog)('https://evil.com')).toBe('https://evil.com');
-    });
-});

package/build/__tests__/utils/urlUtil.test.js

@@ -1,46 +0,0 @@
-"use strict";
-// src/__tests__/utils/urlUtil.test.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-const urlUtil_1 = require("../../utils/urlUtil");
-const node_url_1 = require("node:url");
-const A_VALID_URL_STRING = 'https://example.com:1234';
-const SAME_VALID_URL_DIFFERENT_PORT = 'https://example.com:81';
-const SOME_OTHER_VALID_URL_STRING = 'https://different.com:1234';
-const AN_INVALID_URL_STRING = 'invalid';
-describe('urlUtil', () => {
-    describe('isSameOrigin', () => {
-        it('returns false when either URL is undefined', () => {
-            const url = new node_url_1.URL(A_VALID_URL_STRING);
-            expect((0, urlUtil_1.isSameOrigin)(url)).toBe(false);
-            expect((0, urlUtil_1.isSameOrigin)(undefined, url)).toBe(false);
-        });
-        it('returns true when URLs have the same origin', () => {
-            const url1 = new node_url_1.URL(A_VALID_URL_STRING);
-            const url2 = new node_url_1.URL(A_VALID_URL_STRING);
-            expect((0, urlUtil_1.isSameOrigin)(url1, url2)).toBe(true);
-        });
-        it('returns false when URLs have the same origin but different ports', () => {
-            const url1 = new node_url_1.URL(A_VALID_URL_STRING);
-            const url2 = new node_url_1.URL(SAME_VALID_URL_DIFFERENT_PORT);
-            expect((0, urlUtil_1.isSameOrigin)(url1, url2)).toBe(false);
-        });
-        it('returns false when URLs have different origins', () => {
-            const url1 = new node_url_1.URL(A_VALID_URL_STRING);
-            const url2 = new node_url_1.URL(SOME_OTHER_VALID_URL_STRING);
-            expect((0, urlUtil_1.isSameOrigin)(url1, url2)).toBe(false);
-        });
-    });
-    describe('tryParseUrl', () => {
-        it('returns undefined when URL string is undefined', () => {
-            expect((0, urlUtil_1.tryParseUrl)()).toBeUndefined();
-        });
-        it('returns a URL object when URL string is valid', () => {
-            const url = (0, urlUtil_1.tryParseUrl)(A_VALID_URL_STRING);
-            expect(url).toBeInstanceOf(node_url_1.URL);
-            expect(url?.origin).toBe(A_VALID_URL_STRING);
-        });
-        it('returns undefined when URL string is invalid', () => {
-            expect((0, urlUtil_1.tryParseUrl)(AN_INVALID_URL_STRING)).toBeUndefined();
-        });
-    });
-});

package/build/api.js

@@ -1,20 +0,0 @@
-"use strict";
-// src/api.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.api = void 0;
-const express_1 = __importDefault(require("express"));
-const corsMiddleware_1 = require("./middlewares/corsMiddleware");
-const errorHandler_1 = require("./middlewares/errorHandler");
-const rateLimiter_1 = require("./middlewares/rateLimiter");
-const notFoundHandler_1 = require("./middlewares/notFoundHandler");
-const routes_1 = require("./routes/routes");
-exports.api = (0, express_1.default)();
-exports.api.disable('x-powered-by');
-exports.api.use(corsMiddleware_1.corsMiddleware);
-exports.api.use(errorHandler_1.errorHandler);
-exports.api.use(rateLimiter_1.rateLimiter);
-(0, routes_1.RegisterRoutes)(exports.api);
-exports.api.use(notFoundHandler_1.notFoundHandler);

package/build/config/corsOptions.js

@@ -1,71 +0,0 @@
-"use strict";
-// src/config/corsOptions.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.corsOptions = void 0;
-exports.getHostUrl = getHostUrl;
-exports.initHostUrl = initHostUrl;
-exports.getTrustedOrigins = getTrustedOrigins;
-exports.initTrustedOrigins = initTrustedOrigins;
-exports.isAllTrusted = isAllTrusted;
-exports.isOriginTrusted = isOriginTrusted;
-const corsError_1 = require("../errors/corsError");
-const urlUtil_1 = require("../utils/urlUtil");
-const http_status_codes_1 = require("http-status-codes");
-exports.corsOptions = {
-    methods: ['GET', 'OPTIONS'],
-    optionsSuccessStatus: http_status_codes_1.StatusCodes.OK,
-    origin: (origin, callback) => {
-        if (!origin || isAllTrusted() || (0, urlUtil_1.isSameOrigin)(getHostUrl(), (0, urlUtil_1.tryParseUrl)(origin)) || isOriginTrusted(origin)) {
-            // eslint-disable-next-line no-restricted-syntax -- the http external library expects null
-            callback(null, true);
-        }
-        else {
-            callback(new corsError_1.CorsError(origin), false);
-        }
-    },
-};
-let HOST_URL;
-let TRUSTED_ORIGINS;
-function getHostUrl() {
-    if (!HOST_URL) {
-        initHostUrl();
-    }
-    return HOST_URL;
-}
-function initHostUrl() {
-    HOST_URL = new URL(process.env.BEAVUCK_TIME_HOST_URL);
-}
-function getTrustedOrigins() {
-    if (!TRUSTED_ORIGINS || TRUSTED_ORIGINS.length === 0) {
-        initTrustedOrigins();
-    }
-    return TRUSTED_ORIGINS;
-}
-function initTrustedOrigins() {
-    const trustedOrigins = process.env.BEAVUCK_TIME_TRUSTED_ORIGINS;
-    TRUSTED_ORIGINS = trustedOrigins
-        .split(',')
-        .map(to => to.trim())
-        .filter(to => to.length > 0);
-}
-function isAllTrusted() {
-    return getTrustedOrigins().includes('*');
-}
-function isOriginTrusted(origin) {
-    if (getTrustedOrigins().includes(origin)) {
-        return true;
-    }
-    return getTrustedOrigins().some(trusted => {
-        const trustedPattern = trusted.replace(/\/\*$/, '');
-        try {
-            const trustedUrl = new URL(trustedPattern);
-            const originUrl = new URL(origin);
-            return (trustedUrl.protocol === originUrl.protocol &&
-                trustedUrl.hostname === originUrl.hostname &&
-                trustedUrl.port === originUrl.port);
-        }
-        catch {
-            return false;
-        }
-    });
-}

package/build/config/logger.js

@@ -1,31 +0,0 @@
-"use strict";
-// src/config/logger.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.logger = void 0;
-const winston_1 = require("winston");
-require("winston-daily-rotate-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;
-const MAX_SIZE_LOG_FILES = process.env.BEAVUCK_TIME_MAX_SIZE_LOG_FILES ?? '1m';
-const dailyRotateFileTransport = new winston_1.transports.DailyRotateFile({
-    filename: `${LOGS_DIR}/%DATE%-combined.log`,
-    datePattern: 'YYYY-MM-DD',
-    zippedArchive: true,
-    maxSize: MAX_SIZE_LOG_FILES,
-    maxFiles: MAX_LOG_FILES,
-});
-exports.logger = (0, winston_1.createLogger)({
-    level: LOG_LEVEL,
-    format: winston_1.format.combine(winston_1.format.timestamp(), winston_1.format.printf(({ timestamp, level, message }) => {
-        return `${timestamp} [${level.toUpperCase()}]: ${message}`;
-    })),
-    transports: [
-        new winston_1.transports.Console(),
-        new winston_1.transports.File({
-            filename: `${LOGS_DIR}/error.log`,
-            level: 'error',
-        }),
-        dailyRotateFileTransport,
-    ],
-});

package/build/controllers/nowController.js

@@ -1,30 +0,0 @@
-"use strict";
-// src/controllers/nowController.ts
-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;
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NowController = void 0;
-const tsoa_1 = require("tsoa");
-const nowService_1 = require("../services/nowService");
-let NowController = class NowController extends tsoa_1.Controller {
-    /**
-     * Get the current time in ISO format, in UTC timezone
-     * @summary Get current time
-     */
-    async getNow() {
-        return new nowService_1.NowService().get();
-    }
-};
-exports.NowController = NowController;
-__decorate([
-    (0, tsoa_1.Tags)('now'),
-    (0, tsoa_1.Get)(),
-    (0, tsoa_1.OperationId)('getNow')
-], NowController.prototype, "getNow", null);
-exports.NowController = NowController = __decorate([
-    (0, tsoa_1.Route)('now')
-], NowController);

package/build/errors/base/beavuckTimeError.js

@@ -1,14 +0,0 @@
-"use strict";
-// src/errors/base/beavuckTimeError.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BeavuckTimeError = void 0;
-class BeavuckTimeError extends Error {
-    code;
-    constructor(message, code) {
-        super(message);
-        this.name = this.constructor.name;
-        this.code = code;
-        Error.captureStackTrace(this, this.constructor);
-    }
-}
-exports.BeavuckTimeError = BeavuckTimeError;

package/build/errors/beavuckTimeClientError.js

@@ -1,13 +0,0 @@
-"use strict";
-// src/errors/beavuckTimeClientError.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BeavuckTimeClientError = void 0;
-const beavuckTimeError_1 = require("./base/beavuckTimeError");
-const http_status_codes_1 = require("http-status-codes");
-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);
-    }
-}
-exports.BeavuckTimeClientError = BeavuckTimeClientError;

package/build/errors/beavuckTimeServerError.js

@@ -1,16 +0,0 @@
-"use strict";
-// src/errors/beavuckTimeServerError.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.BeavuckTimeServerError = void 0;
-const beavuckTimeError_1 = require("./base/beavuckTimeError");
-const http_status_codes_1 = require("http-status-codes");
-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);
-    }
-    static fromError(error) {
-        return error instanceof BeavuckTimeServerError ? error : new BeavuckTimeServerError(error.message);
-    }
-}
-exports.BeavuckTimeServerError = BeavuckTimeServerError;

package/build/errors/corsError.js

@@ -1,13 +0,0 @@
-"use strict";
-// 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 {
-    static baseMessage = 'Origin forbidden by CORS';
-    constructor(origin) {
-        super(`${CorsError.baseMessage}: ${origin}`, http_status_codes_1.StatusCodes.FORBIDDEN);
-    }
-}
-exports.CorsError = CorsError;

package/build/errors/errorResponse.js

@@ -1,14 +0,0 @@
-"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

@@ -1,35 +0,0 @@
-"use strict";
-// src/middlewares/corsMiddleware.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-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 logger_1 = require("../config/logger");
-const beavuckTimeServerError_1 = require("../errors/beavuckTimeServerError");
-const corsOptions_1 = require("../config/corsOptions");
-const stringUtil_1 = require("../utils/stringUtil");
-const corsMiddleware = (req, res, next) => {
-    const HOST_URL = (0, urlUtil_1.tryParseUrl)(process.env.BEAVUCK_TIME_HOST_URL ?? '');
-    const origin = req.headers.origin;
-    // 'referer' is a misspelling that was kept for compatibility: https://en.wikipedia.org/wiki/HTTP_referer
-    const referrerHeader = req.headers.referrer || req.headers.referer;
-    if (origin) {
-        logger_1.logger.debug(`CORS request from ${(0, stringUtil_1.sanitizeForLog)(origin)}`);
-        (0, cors_1.default)(corsOptions_1.corsOptions)(req, res, next);
-    }
-    else if (!HOST_URL) {
-        next(new beavuckTimeServerError_1.BeavuckTimeServerError('Host URL not set'));
-    }
-    else if ((0, urlUtil_1.isSameOrigin)(HOST_URL, (0, urlUtil_1.tryParseUrl)(referrerHeader ?? ''))) {
-        next();
-    }
-    else {
-        const sanitizedReferrer = referrerHeader === undefined ? undefined : (0, stringUtil_1.sanitizeForLog)(referrerHeader);
-        next(new corsError_1.CorsError(`origin: ${origin}, referrer: ${sanitizedReferrer}`));
-    }
-};
-exports.corsMiddleware = corsMiddleware;

package/build/middlewares/errorHandler.js

@@ -1,52 +0,0 @@
-"use strict";
-// src/middlewares/errorHandler.ts
-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 http_status_codes_1 = require("http-status-codes");
-const tsoa_1 = require("tsoa");
-const errorResponse_1 = require("../errors/errorResponse");
-const stringUtil_1 = require("../utils/stringUtil");
-const errorHandler = (err, req, res, next) => {
-    if (err instanceof tsoa_1.ValidateError) {
-        const logMsg = `Validation error on ${req.path}: ${JSON.stringify(err.fields)}`;
-        const resStatus = http_status_codes_1.StatusCodes.UNPROCESSABLE_ENTITY;
-        const resMsgObj = { message: 'Validation Error', details: err.fields };
-        handleOtherError(res, logMsg, resStatus, resMsgObj);
-    }
-    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) {
-        handleOtherError(res);
-    }
-    else {
-        next();
-    }
-};
-exports.errorHandler = errorHandler;
-function sendErrorResponse(res, err) {
-    res.status(err.code).json({ message: err.message });
-}
-function handleBeavuckClientError(res, err) {
-    logger_1.logger.warn(err);
-    sendErrorResponse(res, err);
-}
-function handleBeavuckServerError(res, err) {
-    logger_1.logger.error(err);
-    res.status(err.code).json({ 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()) {
-    if (resStatus === http_status_codes_1.StatusCodes.INTERNAL_SERVER_ERROR) {
-        handleBeavuckServerError(res, new beavuckTimeServerError_1.BeavuckTimeServerError(logMsg));
-    }
-    else {
-        logger_1.logger.error(`${(0, stringUtil_1.sanitizeForLog)(logMsg)}: ${JSON.stringify(resMsg)}`);
-        res.status(resStatus).json(resMsg);
-    }
-}

package/build/middlewares/notFoundHandler.js

@@ -1,9 +0,0 @@
-"use strict";
-// src/middlewares/notFoundHandler.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.notFoundHandler = void 0;
-const http_status_codes_1 = require("http-status-codes");
-const notFoundHandler = (_req, res) => {
-    res.status(http_status_codes_1.StatusCodes.NOT_FOUND).send({ message: 'Not Found' });
-};
-exports.notFoundHandler = notFoundHandler;

package/build/middlewares/rateLimiter.js

@@ -1,14 +0,0 @@
-"use strict";
-// src/middlewares/rateLimiter.ts
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-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 = 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;
-exports.rateLimiter = RATE_LIMIT > 0 ? (0, express_rate_limit_1.default)({ windowMs: ONE_MINUTE, limit: RATE_LIMIT }) : (_req, _res, next) => next();

package/build/models/now.js

@@ -1,14 +0,0 @@
-"use strict";
-// src/models/now.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Now = void 0;
-/**
- * @example {"now": "2019-08-24T14:15:22Z"}
- */
-class Now {
-    now;
-    constructor() {
-        this.now = new Date().toISOString();
-    }
-}
-exports.Now = Now;

package/build/routes/routes.js

@@ -1,49 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RegisterRoutes = RegisterRoutes;
-const runtime_1 = require("@tsoa/runtime");
-// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-const nowController_1 = require("./../controllers/nowController");
-// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-const models = {
-    "Now": {
-        "dataType": "refObject",
-        "properties": {
-            "now": { "dataType": "string", "required": true },
-        },
-        "additionalProperties": false,
-    },
-    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-};
-const templateService = new runtime_1.ExpressTemplateService(models, { "noImplicitAdditionalProperties": "throw-on-extras", "bodyCoercion": true });
-// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-function RegisterRoutes(app) {
-    // ###########################################################################################################
-    //  NOTE: If you do not see routes for all of your controllers in this file, then you might not have informed tsoa of where to look
-    //      Please look into the "controllerPathGlobs" config option described in the readme: https://github.com/lukeautry/tsoa
-    // ###########################################################################################################
-    const argsNowController_getNow = {};
-    app.get('/now', ...((0, runtime_1.fetchMiddlewares)(nowController_1.NowController)), ...((0, runtime_1.fetchMiddlewares)(nowController_1.NowController.prototype.getNow)), async function NowController_getNow(request, response, next) {
-        // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-        let validatedArgs = [];
-        try {
-            validatedArgs = templateService.getValidatedArgs({ args: argsNowController_getNow, request, response });
-            const controller = new nowController_1.NowController();
-            await templateService.apiHandler({
-                methodName: 'getNow',
-                controller,
-                response,
-                next,
-                validatedArgs,
-                successStatus: undefined,
-            });
-        }
-        catch (err) {
-            return next(err);
-        }
-    });
-    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-    // WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa
-}
-// WARNING: This file was auto-generated with tsoa. Please do not modify it. Re-run tsoa to re-generate this file: https://github.com/lukeautry/tsoa

package/build/server.js

@@ -1,79 +0,0 @@
-#!/usr/bin/env node
-"use strict";
-// src/server.ts
-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");
-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, () => {
-        logger_1.logger.info(`
-| |                               | |                                          ,=.
-| |__   ___  __ ___   ___   _  ___| | __                        ,=""""==.__.="  o".___
-| '_ \\ / _ \\/ _\` \\ \\ / / | | |/ __| |/ /                  ,=.=="                  ___/
-| |_) |  __/ (_| |\\ V /| |_| | (__|   <             ,==.,"    ,          , \\,===""
-|_.__/ \\___|\\__,_| \\_/  \\__,_|\\___|_|\\_\\          <     ,==)  \\"'"=._.==)  \\
-                                                    \`==''    \`"           \`"
-                            888   d8b                      
-                            888   Y8P                      
-                            888                            
-                            88888888888888b.d88b.  .d88b.  
-                            888   888888 "888 "88bd8P  Y8b 
-                            888   888888  888  88888888888 
-                            Y88b. 888888  888  888Y8b.     
-                             "Y888888888  888  888 "Y8888  
-                               
- Beavuck Time started successfully
-
- Ready on 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) => {
-        logger_1.logger.error(`Beavuck Time Server error [${err.code}]: ${err.message}`);
-        process.exit(1);
-    });
-    const gracefulShutdown = (signal) => {
-        logger_1.logger.info(`${signal} signal received: closing HTTP server`);
-        server.close(() => {
-            logger_1.logger.info('HTTP server closed');
-            process.exit(0);
-        });
-    };
-    const SIGTERM = 'SIGTERM';
-    const SIGINT = 'SIGINT';
-    process.on(SIGTERM, () => gracefulShutdown(SIGTERM));
-    process.on(SIGINT, () => gracefulShutdown(SIGINT));
-    return server;
-}
-function manageEnvVars(options) {
-    logger_1.logger.info('serverOptions: ' + JSON.stringify(options));
-    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;
-    logger_1.logger.debug('TRUSTED_ORIGINS: ' + process.env.BEAVUCK_TIME_TRUSTED_ORIGINS);
-    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/services/nowService.js

@@ -1,11 +0,0 @@
-"use strict";
-// src/services/nowService.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.NowService = void 0;
-const now_1 = require("../models/now");
-class NowService {
-    get() {
-        return new now_1.Now();
-    }
-}
-exports.NowService = NowService;

package/build/types/isoTimestamp.js

@@ -1,10 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.RFC_3339_FORMAT = void 0;
-/**
- * Stringified date-time in RFC 3339 format (often referred to as ISO 8601 format)
- * See [RFC 3339 section 5.6](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6)
- * @example 2019-08-24T14:15:22Z
- * @format date-time
- */
-exports.RFC_3339_FORMAT = /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{3}Z$/;

package/build/utils/stringUtil.js

@@ -1,10 +0,0 @@
-"use strict";
-// src/utils/stringUtil.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sanitizeForLog = sanitizeForLog;
-function sanitizeForLog(value) {
-    // About the warning suppression: we're specifically working on control characters here,
-    // to sanitize strings for protection against log injection
-    // eslint-disable-next-line no-control-regex
-    return value.replaceAll(/[\u0000-\u001F\u007F-\u009F]/g, '');
-}

package/build/utils/urlUtil.js

@@ -1,34 +0,0 @@
-"use strict";
-// src/utils/urlUtil.ts
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.isSameOrigin = isSameOrigin;
-exports.tryParseUrl = tryParseUrl;
-const node_url_1 = require("node:url");
-const logger_1 = require("../config/logger");
-const stringUtil_1 = require("./stringUtil");
-function isSameOrigin(thisUrl, thatUrl) {
-    logger_1.logger.debug(`Comparing origins: ${thisUrl?.origin ? (0, stringUtil_1.sanitizeForLog)(thisUrl?.origin) : undefined} and ${thatUrl?.origin ? (0, stringUtil_1.sanitizeForLog)(thatUrl?.origin) : undefined}`);
-    if (!thisUrl || !thatUrl) {
-        return false;
-    }
-    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;
-    return isSameProtocol && isSameHost && isSamePort;
-}
-function tryParseUrl(urlString) {
-    if (!urlString) {
-        logger_1.logger.debug('Empty URL string');
-        return undefined;
-    }
-    try {
-        return new node_url_1.URL(urlString);
-    }
-    catch (error) {
-        logger_1.logger.warn(`Invalid URL string: ${(0, stringUtil_1.sanitizeForLog)(urlString)} (${error})`);
-    }
-    return undefined;
-}