hoffmation-base 3.0.0-alpha.4 → 3.0.0-alpha.40

package/lib/server/services/govee/own-govee-device.js

@@ -15,18 +15,24 @@ const blockAutomaticHandler_1 = require("../blockAutomaticHandler");
 class OwnGoveeDevice {
     constructor(deviceId, ownDeviceName, roomName, device) {
         this.device = device;
+        /** @inheritDoc */
         this.settings = new models_1.LedSettings();
+        /** @inheritDoc */
         this.deviceType = devices_1.DeviceType.GoveeLed;
+        /** @inheritDoc */
         this.deviceCapabilities = [
             DeviceCapability_1.DeviceCapability.ledLamp,
             DeviceCapability_1.DeviceCapability.lamp,
             DeviceCapability_1.DeviceCapability.dimmablelamp,
             DeviceCapability_1.DeviceCapability.blockAutomatic,
         ];
-        this.on = false;
+        /** @inheritDoc */
         this.queuedValue = null;
+        /** @inheritDoc */
         this.brightness = -1;
+        /** @inheritDoc */
         this.targetAutomaticState = false;
+        this._actuatorOn = false;
         this._color = '#fcba32';
         this._colortemp = 500;
         this._room = undefined;
@@ -38,7 +44,7 @@ class OwnGoveeDevice {
         this._info.allDevicesKey = `govee-${roomName}-${deviceId}`;
         devices_1.Devices.alLDevices[`govee-${roomName}-${deviceId}`] = this;
         this.persistDeviceInfo();
-        this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this));
+        this.blockAutomationHandler = new blockAutomaticHandler_1.BlockAutomaticHandler(this.restoreTargetAutomaticValue.bind(this), this.log.bind(this));
         utils_1.Utils.guardedTimeout(this.loadDeviceSettings, 300, this);
     }
     get color() {
@@ -57,17 +63,11 @@ class OwnGoveeDevice {
         return this.info.customName;
     }
     get actuatorOn() {
-        return this.on;
-    }
-    get lightOn() {
-        return this.on;
+        return this._actuatorOn;
     }
     get info() {
         return this._info;
     }
-    set info(info) {
-        this._info = info;
-    }
     get id() {
         var _a;
         return (_a = this.info.allDevicesKey) !== null && _a !== void 0 ? _a : `govee-${this.info.room}-${this.info.customName}`;
@@ -77,7 +77,7 @@ class OwnGoveeDevice {
     }
     log(level, message, debugType = log_service_1.LogDebugType.None) {
         var _a, _b;
-        log_service_1.ServerLogService.writeLog(level, `${this.name}: ${message}`, {
+        log_service_1.ServerLogService.writeLog(level, message, {
             debugType: debugType,
             room: (_b = (_a = this._room) === null || _a === void 0 ? void 0 : _a.roomName) !== null && _b !== void 0 ? _b : '',
             deviceId: this.name,
@@ -96,20 +96,16 @@ class OwnGoveeDevice {
     loadDeviceSettings() {
         this.settings.initializeFromDb(this);
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setTimeBased(c) {
         this.setLight(models_1.LedSetLightCommand.byTimeBased(this.settings, c));
     }
-    /**
-     * @inheritDoc
-     */
+    /** @inheritDoc */
     setLight(c) {
         if (c.on && c.brightness === -1 && this.brightness < 10) {
             c.brightness = 10;
         }
-        this.log(models_1.LogLevel.Debug, c.logMessage);
+        this.log(models_1.LogLevel.Debug, c.logMessage, log_service_1.LogDebugType.SetActuator);
         const formattedColor = utils_1.Utils.formatHex(c.color);
         if (formattedColor !== null) {
             this.setColor(c.color);
@@ -118,10 +114,15 @@ class OwnGoveeDevice {
         if (devices_1.LampUtils.checkBlockActive(this, c)) {
             return;
         }
-        this.log(models_1.LogLevel.Debug, `Set Light Acutator to "${c.on}" with brightness ${c.brightness}`, log_service_1.LogDebugType.SetActuator);
+        if (c.isAutomaticAction) {
+            // Preserve the target state for the automatic handler, as
+            this.targetAutomaticState = c.on;
+        }
+        if (devices_1.LampUtils.canDimmerChangeBeSkipped(this, c)) {
+            return;
+        }
         if (c.brightness > -1 && c.on) {
             this.setBrightness(c.brightness, () => {
-                this.log(models_1.LogLevel.Debug, `Brightness set to ${c.brightness}`);
                 this.turnOn();
             });
         }
@@ -131,16 +132,15 @@ class OwnGoveeDevice {
         else {
             this.turnOff();
         }
-        if (c.timeout > -1 && !dontBlock) {
-            this.blockAutomationHandler.disableAutomatic(c.timeout, models_1.CollisionSolving.overrideIfGreater);
+        if (c.disableAutomaticCommand && !dontBlock) {
+            this.blockAutomationHandler.disableAutomatic(c.disableAutomaticCommand);
         }
     }
     setActuator(c) {
         this.setLight(new models_1.LedSetLightCommand(c, c.on, c.reason));
     }
     restoreTargetAutomaticValue(c) {
-        this.log(models_1.LogLevel.Debug, `Restore Target Automatic value`);
-        this.setActuator(new models_1.ActuatorSetStateCommand(c, this.targetAutomaticState, 'Restore Target Automatic value'));
+        this.setActuator(new models_1.ActuatorSetStateCommand(c, this.targetAutomaticState));
     }
     persist() {
         var _a;
@@ -165,7 +165,7 @@ class OwnGoveeDevice {
     }
     update(data) {
         this.queuedValue = null;
-        this.on = data.onOff === 1;
+        this._actuatorOn = data.onOff === 1;
         this.brightness = data.brightness;
         this._color = `#${data.color.r.toString(16)}${data.color.g.toString(16)}${data.color.b.toString(16)}`;
         this._colortemp = data.colorTemInKelvin;
@@ -196,12 +196,12 @@ class OwnGoveeDevice {
     }
     turnOn() {
         var _a;
-        if (this.on) {
+        if (this._actuatorOn) {
             return;
         }
         this.queuedValue = true;
         (_a = this.device) === null || _a === void 0 ? void 0 : _a.turnOn().then(() => {
-            this.log(models_1.LogLevel.Debug, `Govee turned on`, log_service_1.LogDebugType.SetActuator);
+            this.log(models_1.LogLevel.Debug, 'Govee turned on', log_service_1.LogDebugType.SetActuator);
         }).catch((error) => {
             this.log(models_1.LogLevel.Error, `Govee turn on resulted in error: ${error}`);
         });
@@ -210,7 +210,7 @@ class OwnGoveeDevice {
         var _a;
         this.queuedValue = false;
         (_a = this.device) === null || _a === void 0 ? void 0 : _a.turnOff().then(() => {
-            this.log(models_1.LogLevel.Debug, `Govee turned off`, log_service_1.LogDebugType.SetActuator);
+            this.log(models_1.LogLevel.Debug, 'Govee turned off', log_service_1.LogDebugType.SetActuator);
         }).catch((error) => {
             this.log(models_1.LogLevel.Error, `Govee turn off resulted in error: ${error}`);
         });

package/lib/server/services/govee/own-govee-devices.d.ts

@@ -1,5 +1,8 @@
 import { OwnGoveeDevice } from './own-govee-device';
 export declare class OwnGoveeDevices {
+    /**
+     * A Dictionary of all own Govee devices
+     */
     static ownDevices: {
         [name: string]: OwnGoveeDevice;
     };

package/lib/server/services/govee/own-govee-devices.js

@@ -10,4 +10,7 @@ class OwnGoveeDevices {
     }
 }
 exports.OwnGoveeDevices = OwnGoveeDevices;
+/**
+ * A Dictionary of all own Govee devices
+ */
 OwnGoveeDevices.ownDevices = {};

package/lib/server/services/https-service.d.ts

@@ -4,8 +4,9 @@ export declare class HTTPSService {
     /**
      * Downloads a file from a given url to the given location.
      * If the location doesn't exist, it will be created quietly.
-     * @param url URL to download file from
-     * @param filePath Path to save file to
+     * @param url - URL to download file from
+     * @param filePath - Path to save file to
+     * @returns A promise that resolves to true if the file was downloaded successfully, false otherwise
      */
     static downloadFile(url: string, filePath: string): Promise<boolean>;
     private static defaultCallback;

package/lib/server/services/https-service.js

@@ -54,7 +54,7 @@ class HTTPSService {
                 }, 100);
             }
             else {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `HTTPS request failed after retries`);
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, 'HTTPS request failed after retries');
             }
         });
         if (postData !== '') {
@@ -65,8 +65,9 @@ class HTTPSService {
     /**
      * Downloads a file from a given url to the given location.
      * If the location doesn't exist, it will be created quietly.
-     * @param url URL to download file from
-     * @param filePath Path to save file to
+     * @param url - URL to download file from
+     * @param filePath - Path to save file to
+     * @returns A promise that resolves to true if the file was downloaded successfully, false otherwise
      */
     static async downloadFile(url, filePath) {
         return new Promise((resolve, reject) => {

package/lib/server/services/index.d.ts

@@ -19,3 +19,4 @@ export * from './ShutterService';
 export * from './tibber-service';
 export * from './victron/index';
 export * from './time-callback-service';
+export { FileInfo } from './file-info';

package/lib/server/services/index.js

@@ -14,6 +14,7 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.FileInfo = void 0;
 __exportStar(require("./ac/index"), exports);
 __exportStar(require("./api/index"), exports);
 __exportStar(require("./calendar/index"), exports);
@@ -35,3 +36,5 @@ __exportStar(require("./ShutterService"), exports);
 __exportStar(require("./tibber-service"), exports);
 __exportStar(require("./victron/index"), exports);
 __exportStar(require("./time-callback-service"), exports);
+var file_info_1 = require("./file-info");
+Object.defineProperty(exports, "FileInfo", { enumerable: true, get: function () { return file_info_1.FileInfo; } });

package/lib/server/services/log-service/index.d.ts

@@ -1,3 +1,4 @@
 export * from './log-service';
 export * from './log-object';
 export * from './log-filter-data';
+export { LogDebugType } from './log-debug-type';

package/lib/server/services/log-service/index.js

@@ -14,6 +14,9 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogDebugType = void 0;
 __exportStar(require("./log-service"), exports);
 __exportStar(require("./log-object"), exports);
 __exportStar(require("./log-filter-data"), exports);
+var log_debug_type_1 = require("./log-debug-type");
+Object.defineProperty(exports, "LogDebugType", { enumerable: true, get: function () { return log_debug_type_1.LogDebugType; } });

package/lib/server/services/log-service/log-debug-type.d.ts

@@ -0,0 +1,12 @@
+export declare enum LogDebugType {
+    None = 0,
+    SkipUnchangedActuatorCommand = 1,
+    SkipUnchangedRolloPosition = 2,
+    SetActuator = 3,
+    ShutterPositionChange = 4,
+    NewMovementState = 5,
+    SkipUnchangedMovementState = 6,
+    DaikinSuccessfullControlInfo = 7,
+    EuroHeaterValveLogging = 8,
+    Trilateration = 9
+}

package/lib/server/services/log-service/log-debug-type.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogDebugType = void 0;
+var LogDebugType;
+(function (LogDebugType) {
+    LogDebugType[LogDebugType["None"] = 0] = "None";
+    LogDebugType[LogDebugType["SkipUnchangedActuatorCommand"] = 1] = "SkipUnchangedActuatorCommand";
+    LogDebugType[LogDebugType["SkipUnchangedRolloPosition"] = 2] = "SkipUnchangedRolloPosition";
+    LogDebugType[LogDebugType["SetActuator"] = 3] = "SetActuator";
+    LogDebugType[LogDebugType["ShutterPositionChange"] = 4] = "ShutterPositionChange";
+    LogDebugType[LogDebugType["NewMovementState"] = 5] = "NewMovementState";
+    LogDebugType[LogDebugType["SkipUnchangedMovementState"] = 6] = "SkipUnchangedMovementState";
+    LogDebugType[LogDebugType["DaikinSuccessfullControlInfo"] = 7] = "DaikinSuccessfullControlInfo";
+    LogDebugType[LogDebugType["EuroHeaterValveLogging"] = 8] = "EuroHeaterValveLogging";
+    LogDebugType[LogDebugType["Trilateration"] = 9] = "Trilateration";
+})(LogDebugType || (exports.LogDebugType = LogDebugType = {}));

package/lib/server/services/log-service/log-filter-data.d.ts

@@ -1,21 +1,30 @@
 import { LogSource } from '../../../models/logSource';
-export declare enum LogDebugType {
-    None = 0,
-    SkipUnchangedActuatorCommand = 1,
-    SkipUnchangedRolloPosition = 2,
-    SetActuator = 3,
-    ShutterPositionChange = 4,
-    NewMovementState = 5,
-    SkipUnchangedMovementState = 6,
-    DaikinSuccessfullControlInfo = 7,
-    EuroHeaterValveLogging = 8,
-    Trilateration = 9
-}
+import { LogDebugType } from './log-debug-type';
 export declare class LogFilterData {
+    /**
+     * If given, the room this log-item is related to
+     */
     room?: string;
+    /**
+     * If given, the device this log-item is related to identified by its ID
+     */
     deviceId?: string;
+    /**
+     * If given, the name of the device this log-item is related to
+     */
     deviceName?: string;
+    /**
+     * If given, the group this log-item can be associated with
+     * @example WindowGroup
+     */
     groupType?: string;
+    /**
+     * If given, a source identifying the origin of the log-item
+     * TODO: Add further sources
+     */
     source?: LogSource;
+    /**
+     * If given, the debug-type which in accordance to {@link iLogSettings} might result in this being filtered out
+     */
     debugType?: LogDebugType;
 }

package/lib/server/services/log-service/log-filter-data.js

@@ -1,22 +1,13 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.LogFilterData = exports.LogDebugType = void 0;
-var LogDebugType;
-(function (LogDebugType) {
-    LogDebugType[LogDebugType["None"] = 0] = "None";
-    LogDebugType[LogDebugType["SkipUnchangedActuatorCommand"] = 1] = "SkipUnchangedActuatorCommand";
-    LogDebugType[LogDebugType["SkipUnchangedRolloPosition"] = 2] = "SkipUnchangedRolloPosition";
-    LogDebugType[LogDebugType["SetActuator"] = 3] = "SetActuator";
-    LogDebugType[LogDebugType["ShutterPositionChange"] = 4] = "ShutterPositionChange";
-    LogDebugType[LogDebugType["NewMovementState"] = 5] = "NewMovementState";
-    LogDebugType[LogDebugType["SkipUnchangedMovementState"] = 6] = "SkipUnchangedMovementState";
-    LogDebugType[LogDebugType["DaikinSuccessfullControlInfo"] = 7] = "DaikinSuccessfullControlInfo";
-    LogDebugType[LogDebugType["EuroHeaterValveLogging"] = 8] = "EuroHeaterValveLogging";
-    LogDebugType[LogDebugType["Trilateration"] = 9] = "Trilateration";
-})(LogDebugType || (exports.LogDebugType = LogDebugType = {}));
+exports.LogFilterData = void 0;
+const log_debug_type_1 = require("./log-debug-type");
 class LogFilterData {
     constructor() {
-        this.debugType = LogDebugType.None;
+        /**
+         * If given, the debug-type which in accordance to {@link iLogSettings} might result in this being filtered out
+         */
+        this.debugType = log_debug_type_1.LogDebugType.None;
     }
 }
 exports.LogFilterData = LogFilterData;

package/lib/server/services/log-service/log-service.d.ts

@@ -1,13 +1,26 @@
 import { LogLevel } from '../../../models';
 import { DeviceType } from '../../devices';
 import { iLogSettings } from '../../config';
-import { ringStorage } from '../utils';
+import { RingStorage } from '../utils';
 import { LogObject } from './log-object';
 import { LogFilterData } from './log-filter-data';
 export declare class ServerLogService {
+    /**
+     * The level at which messages are sent to telegram
+     * @remarks defined at {@link iConfig.telegram.logLevel}
+     */
     static telegramLevel: number;
+    /**
+     * The threshold above which messages are stored in the ring-storage to be retrieved e.g. using {@link API.getLog}
+     */
     static storageLevel: number;
-    static storage: ringStorage<LogObject>;
+    /**
+     * The storage for the log messages
+     */
+    static storage: RingStorage<LogObject>;
+    /**
+     * The settings for the logging system.
+     */
     static settings: iLogSettings;
     static getLog(amount?: number): LogObject[];
     static initialize(logSettings: iLogSettings): void;
@@ -17,8 +30,8 @@ export declare class ServerLogService {
     static missingRoomIndexHandling(pRoomName: string, pIndex: number, pDeviceType: DeviceType): void;
     /**
      * Checks if this message is of a debugtype which should be skipped according to settings
-     * @param {LogDebugType} debugType
-     * @returns {boolean} If the Message should be skipped
+     * @param debugType - {LogDebugType}
+     * @returns If the Message should be skipped
      */
     private static checkDebugLogSkip;
 }

package/lib/server/services/log-service/log-service.js

@@ -6,9 +6,9 @@ const models_1 = require("../../../models");
 const devices_1 = require("../../devices");
 const utils_1 = require("../utils");
 const log_object_1 = require("./log-object");
-const log_filter_data_1 = require("./log-filter-data");
 const logSource_1 = require("../../../models/logSource");
 const settings_service_1 = require("../settings-service");
+const log_debug_type_1 = require("./log-debug-type");
 class ServerLogService {
     static getLog(amount = 5000) {
         return this.storage.readAmount(amount);
@@ -44,7 +44,7 @@ class ServerLogService {
             console.log(message);
             if (pLevel <= ServerLogService.telegramLevel) {
                 const title = models_1.LogLevel[pLevel];
-                Telegram_1.TelegramService.sendMessage(Telegram_1.TelegramService.subscribedIDs, `${title}: ${message}`);
+                Telegram_1.TelegramService.sendMessageToSubscriber(`${title}: ${message}`);
             }
         }
     }
@@ -60,55 +60,55 @@ class ServerLogService {
     }
     /**
      * Checks if this message is of a debugtype which should be skipped according to settings
-     * @param {LogDebugType} debugType
-     * @returns {boolean} If the Message should be skipped
+     * @param debugType - {LogDebugType}
+     * @returns If the Message should be skipped
      */
     static checkDebugLogSkip(debugType) {
         var _a, _b, _c, _d, _e, _f, _g, _h, _j;
         switch (debugType) {
-            case log_filter_data_1.LogDebugType.None:
+            case log_debug_type_1.LogDebugType.None:
                 return false;
-            case log_filter_data_1.LogDebugType.SkipUnchangedActuatorCommand:
+            case log_debug_type_1.LogDebugType.SkipUnchangedActuatorCommand:
                 if (((_a = settings_service_1.SettingsService.settings.logSettings) === null || _a === void 0 ? void 0 : _a.debugUnchangedActuator) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.SkipUnchangedRolloPosition:
+            case log_debug_type_1.LogDebugType.SkipUnchangedRolloPosition:
                 if (((_b = settings_service_1.SettingsService.settings.logSettings) === null || _b === void 0 ? void 0 : _b.debugUchangedShutterPosition) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.SetActuator:
+            case log_debug_type_1.LogDebugType.SetActuator:
                 if (((_c = settings_service_1.SettingsService.settings.logSettings) === null || _c === void 0 ? void 0 : _c.debugActuatorChange) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.ShutterPositionChange:
+            case log_debug_type_1.LogDebugType.ShutterPositionChange:
                 if (((_d = settings_service_1.SettingsService.settings.logSettings) === null || _d === void 0 ? void 0 : _d.debugShutterPositionChange) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.NewMovementState:
+            case log_debug_type_1.LogDebugType.NewMovementState:
                 if (((_e = settings_service_1.SettingsService.settings.logSettings) === null || _e === void 0 ? void 0 : _e.debugNewMovementState) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.SkipUnchangedMovementState:
+            case log_debug_type_1.LogDebugType.SkipUnchangedMovementState:
                 if (((_f = settings_service_1.SettingsService.settings.logSettings) === null || _f === void 0 ? void 0 : _f.debugNewMovementState) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.DaikinSuccessfullControlInfo:
+            case log_debug_type_1.LogDebugType.DaikinSuccessfullControlInfo:
                 if (((_g = settings_service_1.SettingsService.settings.logSettings) === null || _g === void 0 ? void 0 : _g.debugDaikinSuccessfullControlInfo) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.EuroHeaterValveLogging:
+            case log_debug_type_1.LogDebugType.EuroHeaterValveLogging:
                 if (((_h = settings_service_1.SettingsService.settings.logSettings) === null || _h === void 0 ? void 0 : _h.debugEuroHeaterValve) === true) {
                     return false;
                 }
                 break;
-            case log_filter_data_1.LogDebugType.Trilateration:
+            case log_debug_type_1.LogDebugType.Trilateration:
                 if (((_j = settings_service_1.SettingsService.settings.logSettings) === null || _j === void 0 ? void 0 : _j.debugTrilateration) === true) {
                     return false;
                 }
@@ -118,10 +118,23 @@ class ServerLogService {
     }
 }
 exports.ServerLogService = ServerLogService;
+/**
+ * The level at which messages are sent to telegram
+ * @remarks defined at {@link iConfig.telegram.logLevel}
+ */
 ServerLogService.telegramLevel = -1; // Controlled from within Config File
-ServerLogService.storageLevel = 5; // Controlled from within Config File
-ServerLogService.storage = new utils_1.ringStorage(10000);
+/**
+ * The threshold above which messages are stored in the ring-storage to be retrieved e.g. using {@link API.getLog}
+ */
+ServerLogService.storageLevel = models_1.LogLevel.Trace; // Controlled from within Config File
+/**
+ * The storage for the log messages
+ */
+ServerLogService.storage = new utils_1.RingStorage(10000);
+/**
+ * The settings for the logging system.
+ */
 ServerLogService.settings = {
-    logLevel: 4,
+    logLevel: models_1.LogLevel.Debug,
     useTimestamp: false,
 };

package/lib/server/services/news-service.d.ts

@@ -1,6 +1,9 @@
 import { iNewsSettings } from '../config';
 import { iSpeaker } from '../devices';
 export declare class NewsService {
+    /**
+     * Path to the most recently downloaded news audio file
+     */
     static lastNewsAudioFile: string;
     private static readonly newsFilePrefix;
     private static interval;
@@ -11,7 +14,7 @@ export declare class NewsService {
     static initialize(config?: Partial<iNewsSettings>): void;
     /**
      * Stops the regular check for new news feed items.
-     * @deprecated Use stopInterval instead
+     * @deprecated Use {@link stopInterval} instead
      */
     static stopHourlyInterval(): void;
     static startInterval(): void;
@@ -25,17 +28,16 @@ export declare class NewsService {
     static getLatestNews(): void;
     /**
      * Plays the latest news on a sonos device
-     * @param speaker Sonos device to play from
-     * @param volume volume to play at
-     * @param retries Number of times playing should be tried if there is currently no audio file available
+     * @param speaker - Sonos device to play from
+     * @param volume - volume to play at
+     * @param retries - Number of times playing should be tried if there is currently no audio file available
      */
     static playLastNews(speaker: iSpeaker, volume?: number, retries?: number): void;
     private static downloadLatestFileFromFeed;
     /**
      * Deletes all files in the given directory that are older than the given age.
-     * @param rootDir Directory to search in
-     * @param keepMaxAge Maximum age in minutes until a file gets deleted
-     * @private
+     * @param rootDir - Directory to search in
+     * @param keepMaxAge - Maximum age in minutes until a file gets deleted
      */
     private static cleanOldFiles;
 }

package/lib/server/services/news-service.js

@@ -41,7 +41,7 @@ class NewsService {
     static initialize(config) {
         var _a, _b;
         if (config === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Service disabled.`, { source: logSource_1.LogSource.News });
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'Service disabled.', { source: logSource_1.LogSource.News });
             return;
         }
         NewsService.keepMaxAge = (_a = config.keepMaxAge) !== null && _a !== void 0 ? _a : 120;
@@ -51,7 +51,7 @@ class NewsService {
     }
     /**
      * Stops the regular check for new news feed items.
-     * @deprecated Use stopInterval instead
+     * @deprecated Use {@link stopInterval} instead
      */
     static stopHourlyInterval() {
         NewsService.stopInterval();
@@ -80,14 +80,14 @@ class NewsService {
      */
     static getLatestNews() {
         if (settings_service_1.SettingsService.settings.mp3Server === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Not checking for newest news file, no download directory defined.`, {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'Not checking for newest news file, no download directory defined.', {
                 source: logSource_1.LogSource.News,
             });
             return;
         }
         NewsService.cleanOldFiles(settings_service_1.SettingsService.settings.mp3Server.path, NewsService.keepMaxAge);
         if (NewsService.rssUrl === undefined) {
-            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `No rss feed set, not searching for new news.`, {
+            log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, 'No rss feed set, not searching for new news.', {
                 source: logSource_1.LogSource.News,
             });
             return;
@@ -96,9 +96,9 @@ class NewsService {
     }
     /**
      * Plays the latest news on a sonos device
-     * @param speaker Sonos device to play from
-     * @param volume volume to play at
-     * @param retries Number of times playing should be tried if there is currently no audio file available
+     * @param speaker - Sonos device to play from
+     * @param volume - volume to play at
+     * @param retries - Number of times playing should be tried if there is currently no audio file available
      */
     static playLastNews(speaker, volume = 30, retries = 5) {
         if (!NewsService.lastNewsAudioFile) {
@@ -111,7 +111,7 @@ class NewsService {
                 }, 1000);
             }
             else {
-                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, `Service not ready despite waiting --> Abort.`, {
+                log_service_1.ServerLogService.writeLog(models_1.LogLevel.Error, 'Service not ready despite waiting --> Abort.', {
                     source: logSource_1.LogSource.News,
                 });
             }
@@ -128,7 +128,7 @@ class NewsService {
                 const currentFeedItem = feed.items[0];
                 log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Most recent news on ${feed.title} is "${currentFeedItem.title}"`);
                 if (currentFeedItem.enclosure === undefined) {
-                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, `Couldn't find audio in last item of the rss feed.`, {
+                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Warn, "Couldn't find audio in last item of the rss feed.", {
                         source: logSource_1.LogSource.News,
                     });
                     return;
@@ -137,14 +137,14 @@ class NewsService {
                 // check for both path and pubdate in case the file name is always the same one
                 if (fs.existsSync(filePath) && NewsService.lastFetchedPubDate == currentFeedItem.pubDate) {
                     NewsService.lastNewsAudioFile = path_1.default.basename(filePath);
-                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Newest file already downloaded.`, { source: logSource_1.LogSource.News });
+                    log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Newest file already downloaded.', { source: logSource_1.LogSource.News });
                     return;
                 }
                 log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Current news download Link: "${currentFeedItem.enclosure.url}"`);
                 https_service_1.HTTPSService.downloadFile(currentFeedItem.enclosure.url, filePath)
                     .then((success) => {
                     if (!success) {
-                        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, `Error while downloading audio file.`, {
+                        log_service_1.ServerLogService.writeLog(models_1.LogLevel.Debug, 'Error while downloading audio file.', {
                             source: logSource_1.LogSource.News,
                         });
                         return;
@@ -167,9 +167,8 @@ class NewsService {
     }
     /**
      * Deletes all files in the given directory that are older than the given age.
-     * @param rootDir Directory to search in
-     * @param keepMaxAge Maximum age in minutes until a file gets deleted
-     * @private
+     * @param rootDir - Directory to search in
+     * @param keepMaxAge - Maximum age in minutes until a file gets deleted
      */
     static cleanOldFiles(rootDir, keepMaxAge) {
         let deleteCount = 0;
@@ -205,4 +204,4 @@ class NewsService {
 }
 exports.NewsService = NewsService;
 // prefix for all downloaded files of the news service
-NewsService.newsFilePrefix = `news$`;
+NewsService.newsFilePrefix = 'news$';