hoffmation-base 3.8.0 → 4.1.0

package/lib/services/dbo/actuator-state-row.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/services/dbo/battery-level-row.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The raw shape the driver hands back for a stored battery level.
+ *
+ * Numeric columns arrive as a number or a string depending on their postgres type, so they are converted
+ * rather than passed through. The timestamp column is `timestamp without time zone` and therefore a Date built
+ * from naive components. It is deliberately not typed as `string | Date`: the driver never hands a string back
+ * for that column, and pretending otherwise is what hid a timezone offset for a long time.
+ *
+ * Not part of the published surface - a database row shape is not an interface anyone implements.
+ */
+export type BatteryLevelRow = {
+    /** The stored state of charge, as the driver hands it back */
+    batteryLevel: string | number | null;
+    /** End of the interval the reading closes, built from naive components */
+    endDate: Date | null;
+};

package/lib/services/dbo/battery-level-row.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/services/dbo/energy-consumption-row.d.ts

@@ -0,0 +1,16 @@
+/**
+ * The raw shape the driver hands back for one stored energy calculation interval.
+ *
+ * Same conversion rules as {@link BatteryLevelRow}: numeric columns may arrive as a string, and the timestamp
+ * is a Date built from naive components because the column carries no zone.
+ *
+ * Not part of the published surface - a database row shape is not an interface anyone implements.
+ */
+export type EnergyConsumptionRow = {
+    /** Energy the house took from its own production over the interval, in kWh */
+    selfConsumedKwH: string | number | null;
+    /** Energy the house took from the grid over the interval, in kWh */
+    drawnKwH: string | number | null;
+    /** End of the interval the reading closes, built from naive components */
+    endDate: Date | null;
+};

package/lib/services/dbo/energy-consumption-row.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/lib/services/dbo/postgreSqlPersist.d.ts

@@ -1,5 +1,5 @@
 import { PoolConfig } from 'pg';
-import { iAcDevice, iActuator, iBaseDevice, iBatteryDevice, iButtonSwitch, iDesiredShutterPosition, iHandle, iHeater, iAirQualityCollector, iHumidityCollector, iIlluminationSensor, iMotionSensor, iPersist, iRoomBase, iShutter, iShutterCalibration, iTemperatureCollector, iTemperatureMeasurement, iZigbeeDevice } from '../../interfaces';
+import { iAcDevice, iActuator, iActuatorStateSample, iBaseDevice, iBatteryDevice, iBatteryLevelSample, iButtonSwitch, iConsumptionWindowSample, iDesiredShutterPosition, iHandle, iHeater, iAirQualityCollector, iHumidityCollector, iIlluminationSensor, iMotionSensor, iPersist, iRoomBase, iShutter, iShutterCalibration, iSoilCollector, iSoilMoistureSample, iTemperatureCollector, iTemperatureMeasurement, iWeatherDaySummary, iZigbeeDevice } from '../../interfaces';
 import { CountToday, EnergyCalculation } from '../../models';
 import { ButtonPressType } from '../../enums';
 export declare class PostgreSqlPersist implements iPersist {
@@ -22,6 +22,16 @@ export declare class PostgreSqlPersist implements iPersist {
     /** @inheritDoc */
     getTemperatureHistory(deviceId: string, startDate?: Date, endDate?: Date): Promise<iTemperatureMeasurement[]>;
     /** @inheritDoc */
+    getBatteryLevelHistory(startDate: Date, endDate: Date): Promise<iBatteryLevelSample[]>;
+    /** @inheritDoc */
+    getEnergyConsumptionHistory(startDate: Date, endDate: Date): Promise<iConsumptionWindowSample[]>;
+    /** @inheritDoc */
+    getActuatorHistory(deviceId: string, startDate: Date, endDate: Date): Promise<iActuatorStateSample[]>;
+    /** @inheritDoc */
+    getWeatherDaySummaries(startDate: Date, endDate: Date): Promise<iWeatherDaySummary[]>;
+    /** @inheritDoc */
+    persistWeatherDaySummary(summary: iWeatherDaySummary): void;
+    /** @inheritDoc */
     initialize(): Promise<void>;
     /** @inheritDoc */
     persistAC(device: iAcDevice): void;
@@ -44,6 +54,10 @@ export declare class PostgreSqlPersist implements iPersist {
     /** @inheritDoc */
     persistAirQualitySensor(device: iAirQualityCollector): void;
     /** @inheritDoc */
+    persistSoilSensor(device: iSoilCollector): void;
+    /** @inheritDoc */
+    getSoilMoistureHistory(deviceId: string, startDate: Date, endDate: Date): Promise<iSoilMoistureSample[]>;
+    /** @inheritDoc */
     persistBatteryDevice(device: iBatteryDevice): void;
     /** @inheritDoc */
     persistZigbeeDevice(device: iZigbeeDevice): void;
@@ -57,6 +71,43 @@ export declare class PostgreSqlPersist implements iPersist {
     persistSettings(id: string, settings: string, customName: string): void;
     /** @inheritDoc */
     loadSettings(id: string): Promise<string | undefined>;
+    /**
+     * Runs a statement, optionally with bind values.
+     *
+     * `values` is what makes a statement able to carry data that did not come from this process: the driver
+     * sends text and values apart, so a value is never parsed as SQL, whatever it spells. Anything that is not
+     * a literal fixed by this file belongs in there rather than in the string.
+     * @param query - The statement, with `$1..$n` where values are bound
+     * @param values - The values to bind, in the order of their placeholders
+     * @returns - The rows, or null when the statement did not come back
+     */
     private query;
+    /**
+     * A missing or unreadable history is a defined state of the history based decisions, not a failure - but it
+     * has to be visible once, otherwise "no answer" and "nothing recorded" look the same from the outside.
+     * @param reader - The reader that came up empty
+     * @param dbResult - null when the query itself did not come back, an empty set otherwise
+     * @param startDate - Start of the requested window
+     * @param endDate - End of the requested window
+     */
+    private static logEmptyAnswer;
+    private static logDroppedRows;
+    /**
+     * Turns what the driver made of a `timestamp without time zone` back into the instant it was stored for.
+     *
+     * The write path stores `new Date(...).toISOString()`. For a naive column PostgreSQL silently drops the
+     * zone suffix of the literal and keeps the UTC wall clock. Reading it back, the driver rebuilds those
+     * components with the **local** multi argument Date constructor (`postgres-date/index.js:49-50`, registered
+     * for OID 1114 in `pg-types/lib/textParsers.js:175`), so the Date is off by the machine's zone offset - one
+     * hour or two in Berlin, and the offset changes inside a single 90 day window at the daylight saving
+     * switch. Reading the local components back out as UTC undoes exactly that.
+     *
+     * Only the read side compensates: `toISOString()` already stores the UTC wall clock and three years of
+     * recorded history are written that way, so changing the write path would put old and new rows at odds.
+     * @param value - The Date the driver produced, or null for an absent timestamp
+     * @returns - The instant, or undefined when there is none to be had
+     */
+    private static fromNaiveTimestamp;
+    private static toFiniteNumber;
     private isPsqlReady;
 }