@etainabl/nodejs-sdk 1.1.21 → 1.1.23

package/dist/consumption.d.ts

@@ -1,18 +1,9 @@
-import moment from 'moment';
-export interface Reading {
-    submittedAt: string;
-    value: number;
+interface ConsumptionData {
+    date: Date;
+    consumption: number;
 }
-export interface ApportionedReading {
-    date: moment.Moment;
-    reading: number;
-    consumption?: number;
-}
-declare const _default: {
-    apportionedReadings: (readings: Reading[], granularity?: moment.unitOfTime.Diff, interpolationMethod?: string, startDate?: string | undefined, endDate?: string | undefined) => ApportionedReading[];
-    consumptionFromReadings: (readings: Reading[], startDate: string, endDate: string, granularity?: moment.unitOfTime.Diff, interpolationMethod?: string) => {
-        totalConsumption: any;
-        apportioned: ApportionedReading[];
-    };
-};
-export default _default;
+export declare const dayNightConsumption: (data: ConsumptionData[]) => any;
+export declare const calcMaxConsumptionValue: (data: ConsumptionData[]) => number;
+export declare const calcMaxDemand: (data: ConsumptionData[]) => number;
+export declare const calcPeakLoad: (consumption: number, maxDemand: number, startDate: Date, endDate: Date) => number;
+export {};

package/dist/consumption.js

@@ -1,47 +1,23 @@
 import moment from 'moment';
-import { interpolate } from './lib/readingsInterpolate.js';
-const apportionedReadings = (readings, granularity = 'days', interpolationMethod = 'linear', startDate, endDate) => {
-    // Readings sorted from newest to oldest
-    const sortedReadings = [...readings].sort((a, b) => moment(a.submittedAt).diff(b.submittedAt));
-    // Array of every hour/day etc between the first and last reading
-    const intervals = moment(sortedReadings[sortedReadings.length - 1].submittedAt).diff(moment(sortedReadings[0].submittedAt), granularity);
-    const dates = [...Array(intervals).keys()]
-        .slice(1)
-        .map((interval) => moment(sortedReadings[0].submittedAt).startOf(granularity).add(interval, granularity));
-    let interpolatedReadings = dates.map((date) => {
-        const reading = interpolate(sortedReadings, date, interpolationMethod);
-        return {
-            date,
-            reading
-        };
-    });
-    interpolatedReadings = interpolatedReadings.map((reading, index) => {
-        const prevReading = interpolatedReadings[index - 1];
-        if (prevReading) {
-            return {
-                ...reading,
-                consumption: reading.reading - prevReading.reading
-            };
-        }
-        return reading;
-    });
-    if (startDate) {
-        interpolatedReadings = interpolatedReadings.filter((reading) => moment(reading.date).isSameOrAfter(startDate, granularity));
+export const dayNightConsumption = (data) => data.reduce((acc, item) => {
+    const hour = moment(item.date).hour(); // End Time of HH consumption period
+    if (hour >= 0 && hour < 7) {
+        acc.nightConsumption += item.consumption;
     }
-    if (endDate) {
-        interpolatedReadings = interpolatedReadings.filter((reading) => moment(reading.date).isSameOrBefore(endDate, granularity));
+    else {
+        acc.dayConsumption += item.consumption;
     }
-    return interpolatedReadings;
-};
-const consumptionFromReadings = (readings, startDate, endDate, granularity = 'hours', interpolationMethod = 'linear') => {
-    // Split the readings into hourly readings and calculate the consumption for each hour
-    const apportioned = apportionedReadings(readings, granularity, interpolationMethod, startDate, endDate);
-    // Calculate the total consumption between the start and end dates
-    const totalConsumption = apportioned.reduce((acc, reading) => acc + reading.consumption, 0);
-    return { totalConsumption, apportioned };
-};
-export default {
-    apportionedReadings,
-    consumptionFromReadings
+    acc.consumption += item.consumption;
+    return acc;
+}, {
+    dayConsumption: 0,
+    nightConsumption: 0,
+    consumption: 0
+});
+export const calcMaxConsumptionValue = (data) => Math.max(...data.map((item) => item.consumption));
+export const calcMaxDemand = (data) => calcMaxConsumptionValue(data) * 2;
+export const calcPeakLoad = (consumption, maxDemand, startDate, endDate) => {
+    const days = Math.ceil(moment(endDate).diff(moment(startDate), 'days', true));
+    return maxDemand === 0 ? 0 : ((consumption / (maxDemand * 24 * days)) * 100);
 };
 //# sourceMappingURL=consumption.js.map

package/dist/consumption.js.map

@@ -1 +1 @@
-{"version":3,"file":"consumption.js","sourceRoot":"","sources":["../src/consumption.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAC5B,OAAO,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAa3D,MAAM,mBAAmB,GAAG,CAAC,QAAmB,EAAE,cAAsC,MAAM,EAAE,sBAA8B,QAAQ,EAAE,SAAkB,EAAE,OAAgB,EAAwB,EAAE;IACpM,wCAAwC;IACxC,MAAM,cAAc,GAAG,CAAC,GAAG,QAAQ,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC;IAE/F,iEAAiE;IACjE,MAAM,SAAS,GAAG,MAAM,CAAC,cAAc,CAAC,cAAc,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,EAAE,WAAW,CAAC,CAAC;IAEzI,MAAM,KAAK,GAAG,CAAC,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,CAAC;SACvC,KAAK,CAAC,CAAC,CAAC;SACR,GAAG,CAAC,CAAC,QAAgB,EAAE,EAAE,CAAC,MAAM,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,QAAQ,EAAE,WAAW,CAAC,CAAC,CAAC;IAEpH,IAAI,oBAAoB,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAmB,EAAE,EAAE;QAC3D,MAAM,OAAO,GAAG,WAAW,CAAC,cAAc,EAAE,IAAI,EAAE,mBAAmB,CAAC,CAAC;QAEvE,OAAO;YACL,IAAI;YACJ,OAAO;SACR,CAAC;IACJ,CAAC,CAAC,CAAC;IAEH,oBAAoB,GAAG,oBAAoB,CAAC,GAAG,CAAC,CAAC,OAA2B,EAAE,KAAa,EAAE,EAAE;QAC7F,MAAM,WAAW,GAAG,oBAAoB,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC;QAEpD,IAAI,WAAW,EAAE;YACf,OAAO;gBACL,GAAG,OAAO;gBACV,WAAW,EAAE,OAAO,CAAC,OAAO,GAAG,WAAW,CAAC,OAAO;aACnD,CAAC;SACH;QAED,OAAO,OAAO,CAAC;IAEjB,CAAC,CAAC,CAAC;IAEH,IAAI,SAAS,EAAE;QACb,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,OAA2B,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,aAAa,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;KACjJ;IAED,IAAI,OAAO,EAAE;QACX,oBAAoB,GAAG,oBAAoB,CAAC,MAAM,CAAC,CAAC,OAA2B,EAAE,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,cAAc,CAAC,OAAO,EAAE,WAAW,CAAC,CAAC,CAAC;KAChJ;IAED,OAAO,oBAAoB,CAAC;AAC9B,CAAC,CAAC;AAEF,MAAM,uBAAuB,GAAG,CAAC,QAAmB,EAAE,SAAiB,EAAE,OAAe,EAAE,cAAsC,OAAO,EAAE,sBAA8B,QAAQ,EAAE,EAAE;IACjL,sFAAsF;IACtF,MAAM,WAAW,GAAG,mBAAmB,CAAC,QAAQ,EAAE,WAAW,EAAE,mBAAmB,EAAE,SAAS,EAAE,OAAO,CAAC,CAAC;IAExG,kEAAkE;IAClE,MAAM,gBAAgB,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,OAAO,EAAE,EAAE,CAAC,GAAG,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC,CAAC,CAAC;IAEjG,OAAO,EAAE,gBAAgB,EAAE,WAAW,EAAE,CAAC;AAC3C,CAAC,CAAC;AAEF,eAAe;IACb,mBAAmB;IACnB,uBAAuB;CACxB,CAAC"}
+{"version":3,"file":"consumption.js","sourceRoot":"","sources":["../src/consumption.ts"],"names":[],"mappings":"AAAA,OAAO,MAAM,MAAM,QAAQ,CAAC;AAO5B,MAAM,CAAC,MAAM,mBAAmB,GAAG,CAAC,IAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,GAAQ,EAAE,IAAqB,EAAE,EAAE;IAC9G,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,oCAAoC;IAE3E,IAAI,IAAI,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE;QACzB,GAAG,CAAC,gBAAgB,IAAI,IAAI,CAAC,WAAW,CAAC;KAC1C;SAAM;QACL,GAAG,CAAC,cAAc,IAAI,IAAI,CAAC,WAAW,CAAC;KACxC;IAED,GAAG,CAAC,WAAW,IAAI,IAAI,CAAC,WAAW,CAAC;IAEpC,OAAO,GAAG,CAAC;AACb,CAAC,EAAE;IACD,cAAc,EAAE,CAAC;IACjB,gBAAgB,EAAE,CAAC;IACnB,WAAW,EAAE,CAAC;CACf,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAuB,EAAE,EAAE,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,IAAqB,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC;AAEvI,MAAM,CAAC,MAAM,aAAa,GAAG,CAAC,IAAuB,EAAE,EAAE,CAAC,uBAAuB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAE5F,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,WAAmB,EAAE,SAAiB,EAAE,SAAe,EAAE,OAAa,EAAE,EAAE;IACrG,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,CAAC,CAAC;IAE9E,OAAO,SAAS,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,WAAW,GAAG,CAAC,SAAS,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC,GAAG,GAAG,CAAC,CAAC;AAC/E,CAAC,CAAC"}

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 import api from './api.js';
-import consumption from './consumption.js';
 import logger from './logger.js';
 import db from './db.js';
 import slack from './slack.js';
 import * as units from './units.js';
+import * as consumption from './consumption.js';
 export { api, logger, consumption, db, slack, units };

package/dist/index.js

@@ -1,8 +1,8 @@
 import api from './api.js';
-import consumption from './consumption.js';
 import logger from './logger.js';
 import db from './db.js';
 import slack from './slack.js';
 import * as units from './units.js';
+import * as consumption from './consumption.js';
 export { api, logger, consumption, db, slack, units };
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,WAAW,MAAM,kBAAkB,CAAC;AAC3C,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AAEpC,OAAO,EACL,GAAG,EACH,MAAM,EACN,WAAW,EACX,EAAE,EACF,KAAK,EACL,KAAK,EACN,CAAA"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,GAAG,MAAM,UAAU,CAAC;AAC3B,OAAO,MAAM,MAAM,aAAa,CAAC;AACjC,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,KAAK,MAAM,YAAY,CAAC;AAC/B,OAAO,KAAK,KAAK,MAAM,YAAY,CAAC;AACpC,OAAO,KAAK,WAAW,MAAM,kBAAkB,CAAC;AAEhD,OAAO,EACL,GAAG,EACH,MAAM,EACN,WAAW,EACX,EAAE,EACF,KAAK,EACL,KAAK,EACN,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etainabl/nodejs-sdk",
-  "version": "1.1.21",
+  "version": "1.1.23",
   "main": "dist/index.js",
   "author": "Jonathan Lambert <jonathan@etainabl.com>",
   "type": "module",

package/src/consumption.ts

@@ -1,73 +1,34 @@
 import moment from 'moment';
-import { interpolate } from './lib/readingsInterpolate.js';
 
-export interface Reading {
-  submittedAt: string,
-  value: number
+interface ConsumptionData {
+  date: Date;
+  consumption: number;
 }
 
-export interface ApportionedReading {
-  date: moment.Moment,
-  reading: number,
-  consumption?: number
-}
-
-const apportionedReadings = (readings: Reading[], granularity: moment.unitOfTime.Diff = 'days', interpolationMethod: string = 'linear', startDate?: string, endDate?: string): ApportionedReading[] => {
-  // Readings sorted from newest to oldest
-  const sortedReadings = [...readings].sort((a, b) => moment(a.submittedAt).diff(b.submittedAt));
-
-  // Array of every hour/day etc between the first and last reading
-  const intervals = moment(sortedReadings[sortedReadings.length - 1].submittedAt).diff(moment(sortedReadings[0].submittedAt), granularity);
-
-  const dates = [...Array(intervals).keys()]
-    .slice(1)
-    .map((interval: number) => moment(sortedReadings[0].submittedAt).startOf(granularity).add(interval, granularity));
-
-  let interpolatedReadings = dates.map((date: moment.Moment) => {
-    const reading = interpolate(sortedReadings, date, interpolationMethod);
-
-    return {
-      date,
-      reading
-    };
-  });
+export const dayNightConsumption = (data: ConsumptionData[]) => data.reduce((acc: any, item: ConsumptionData) => {
+  const hour = moment(item.date).hour(); // End Time of HH consumption period
 
-  interpolatedReadings = interpolatedReadings.map((reading: ApportionedReading, index: number) => {
-    const prevReading = interpolatedReadings[index - 1];
-
-    if (prevReading) {
-      return {
-        ...reading,
-        consumption: reading.reading - prevReading.reading
-      };
-    }
-
-    return reading;
-
-  });
-
-  if (startDate) {
-    interpolatedReadings = interpolatedReadings.filter((reading: ApportionedReading) => moment(reading.date).isSameOrAfter(startDate, granularity));
+  if (hour >= 0 && hour < 7) {
+    acc.nightConsumption += item.consumption;
+  } else {
+    acc.dayConsumption += item.consumption;
   }
 
-  if (endDate) {
-    interpolatedReadings = interpolatedReadings.filter((reading: ApportionedReading) => moment(reading.date).isSameOrBefore(endDate, granularity));
-  }
+  acc.consumption += item.consumption;
 
-  return interpolatedReadings;
-};
+  return acc;
+}, {
+  dayConsumption: 0,
+  nightConsumption: 0,
+  consumption: 0
+});
 
-const consumptionFromReadings = (readings: Reading[], startDate: string, endDate: string, granularity: moment.unitOfTime.Diff = 'hours', interpolationMethod: string = 'linear') => {
-  // Split the readings into hourly readings and calculate the consumption for each hour
-  const apportioned = apportionedReadings(readings, granularity, interpolationMethod, startDate, endDate);
+export const calcMaxConsumptionValue = (data: ConsumptionData[]) => Math.max(...data.map((item: ConsumptionData) => item.consumption));
 
-  // Calculate the total consumption between the start and end dates
-  const totalConsumption = apportioned.reduce((acc: any, reading) => acc + reading.consumption, 0);
+export const calcMaxDemand = (data: ConsumptionData[]) => calcMaxConsumptionValue(data) * 2;
 
-  return { totalConsumption, apportioned };
-};
+export const calcPeakLoad = (consumption: number, maxDemand: number, startDate: Date, endDate: Date) => {
+  const days = Math.ceil(moment(endDate).diff(moment(startDate), 'days', true));
 
-export default {
-  apportionedReadings,
-  consumptionFromReadings
-};
+  return maxDemand === 0 ? 0 : ((consumption / (maxDemand * 24 * days)) * 100);
+};

package/src/index.ts

@@ -1,9 +1,9 @@
 import api from './api.js';
-import consumption from './consumption.js';
 import logger from './logger.js';
 import db from './db.js';
 import slack from './slack.js';
 import * as units from './units.js';
+import * as consumption from './consumption.js';
 
 export {
   api,