@etainabl/nodejs-sdk 1.1.20 → 1.1.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/units.d.ts CHANGED
@@ -11,6 +11,9 @@ export declare type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h';
11
11
  export declare const accountTypeMap: {
12
12
  [key: string]: BaseUnit;
13
13
  };
14
+ export declare const accountTypeUnitMap: {
15
+ [key: string]: ETNUnit[];
16
+ };
14
17
  export declare const convertItems: (items: Item[], type: AccountType, defaultUnits: ETNUnit | undefined) => any;
15
18
  export declare const checkAccountTypeVsUnits: (type: string, unit: string, additionalLog?: number | '') => {
16
19
  type: AccountType;
package/dist/units.js CHANGED
@@ -34,7 +34,7 @@ const unitConversionFactors = {
34
34
  'm3/h': 1
35
35
  }
36
36
  };
37
- const accountTypeUnitMap = {
37
+ export const accountTypeUnitMap = {
38
38
  electricity: ['kwh', 'mwh', 'wh'],
39
39
  gas: ['kwh', 'm3', 'ft3', 'hcf'],
40
40
  water: ['m3', 'l'],
package/dist/units.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"units.js","sourceRoot":"","sources":["../src/units.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,MAAM,cAAc,GAAgC;IACzD,WAAW,EAAE,KAAK;IAClB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,KAAK;IACZ,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,GAAG;CACjB,CAAC;AAEF,MAAM,qBAAqB,GAA2B;IACpD,GAAG,EAAE;QACH,GAAG,EAAE,CAAC;QACN,GAAG,EAAE,IAAI;QACT,EAAE,EAAE,KAAK;QACT,EAAE,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,GAAG;QACxB,GAAG,EAAE,CAAC,MAAM,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,GAAG;QAClC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,GAAG;KACjC;IACD,EAAE,EAAE;QACF,EAAE,EAAE,CAAC;QACL,CAAC,EAAE,KAAK;KACT;IACD,CAAC,EAAE;QACD,CAAC,EAAE,CAAC;KACL;IACD,EAAE,EAAE;QACF,EAAE,EAAE,CAAC;QACL,GAAG,EAAE,UAAU;QACf,MAAM,EAAE,IAAI;KACb;IACD,MAAM,EAAE;QACN,MAAM,EAAE,CAAC;KACV;CACF,CAAC;AAEF,MAAM,kBAAkB,GAAiC;IACvD,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IACjC,GAAG,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC;IAChC,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IAClB,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC;IAC9B,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAC3B,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAC7B,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAC7B,WAAW,EAAE,CAAC,GAAG,CAAC;CACnB,CAAC;AAEF,+BAA+B;AAC/B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,IAAiB,EAAE,YAAiC,EAAO,EAAE;IACvG,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAEvD,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,mBAAmB,CAAC,CAAC;IAExE,MAAM,cAAc,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,IAAI,YAAY,IAAI,QAAQ,CAAC;QAClE,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC;QACnF,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,WAAmB,KAAK,EAAE,MAAc,EAAE,EAAE;IACxE,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAExD,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,iBAAiB,CAAC,CAAC;KACzE;IAED,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,iBAAiB,CAAC,CAAC;KAC3E;IAED,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,gBAA6B,EAAE,EAAE,EAAE;IACrG,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IACvD,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE/C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAE7C,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACxD,IAAI,CAAC,gBAAgB;QAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,UAAU,sBAAsB,aAAa,EAAE,CAAC,CAAC;IAEzG,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAa,CAAC;IAExD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,iBAAiB,UAAU,4BAA4B,UAAU,KAAK,aAAa,EAAE,CAAC,CAAC;KACxG;IAED,OAAO,EAAE,IAAI,EAAE,UAAyB,EAAE,IAAI,EAAE,UAAU,EAAC,CAAC;AAC9D,CAAC,CAAC"}
1
+ {"version":3,"file":"units.js","sourceRoot":"","sources":["../src/units.ts"],"names":[],"mappings":"AAWA,MAAM,CAAC,MAAM,cAAc,GAAgC;IACzD,WAAW,EAAE,KAAK;IAClB,GAAG,EAAE,KAAK;IACV,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,IAAI;IACX,KAAK,EAAE,KAAK;IACZ,OAAO,EAAE,KAAK;IACd,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,KAAK;IACd,WAAW,EAAE,GAAG;CACjB,CAAC;AAEF,MAAM,qBAAqB,GAA2B;IACpD,GAAG,EAAE;QACH,GAAG,EAAE,CAAC;QACN,GAAG,EAAE,IAAI;QACT,EAAE,EAAE,KAAK;QACT,EAAE,EAAE,CAAC,EAAE,GAAG,OAAO,CAAC,GAAG,GAAG;QACxB,GAAG,EAAE,CAAC,MAAM,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,GAAG;QAClC,GAAG,EAAE,CAAC,IAAI,GAAG,EAAE,GAAG,OAAO,CAAC,GAAG,GAAG;KACjC;IACD,EAAE,EAAE;QACF,EAAE,EAAE,CAAC;QACL,CAAC,EAAE,KAAK;KACT;IACD,CAAC,EAAE;QACD,CAAC,EAAE,CAAC;KACL;IACD,EAAE,EAAE;QACF,EAAE,EAAE,CAAC;QACL,GAAG,EAAE,UAAU;QACf,MAAM,EAAE,IAAI;KACb;IACD,MAAM,EAAE;QACN,MAAM,EAAE,CAAC;KACV;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,kBAAkB,GAAiC;IAC9D,WAAW,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IACjC,GAAG,EAAE,CAAC,KAAK,EAAE,IAAI,EAAE,KAAK,EAAE,KAAK,CAAC;IAChC,KAAK,EAAE,CAAC,IAAI,EAAE,GAAG,CAAC;IAClB,KAAK,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,QAAQ,CAAC;IAC9B,KAAK,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAC3B,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAC7B,IAAI,EAAE,CAAC,MAAM,CAAC;IACd,OAAO,EAAE,CAAC,KAAK,EAAE,KAAK,EAAE,IAAI,CAAC;IAC7B,WAAW,EAAE,CAAC,GAAG,CAAC;CACnB,CAAC;AAEF,+BAA+B;AAC/B,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,KAAa,EAAE,IAAiB,EAAE,YAAiC,EAAO,EAAE;IACvG,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IAEvD,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,CAAC,CAAC;IACtC,IAAI,CAAC,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,gBAAgB,IAAI,mBAAmB,CAAC,CAAC;IAExE,MAAM,cAAc,GAAG,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE;QACtC,MAAM,MAAM,GAAG,IAAI,CAAC,MAAM,IAAI,CAAC,CAAC;QAChC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,IAAI,YAAY,IAAI,QAAQ,CAAC;QAClE,MAAM,cAAc,GAAG,IAAI,CAAC,KAAK,GAAG,oBAAoB,CAAC,KAAK,EAAE,QAAQ,CAAC,GAAG,MAAM,CAAC;QACnF,OAAO,EAAE,GAAG,IAAI,EAAE,KAAK,EAAE,cAAc,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC;IAC7D,CAAC,CAAC,CAAC;IAEH,OAAO,cAAc,CAAC;AACxB,CAAC,CAAC;AAEF,MAAM,oBAAoB,GAAG,CAAC,WAAmB,KAAK,EAAE,MAAc,EAAE,EAAE;IACxE,MAAM,iBAAiB,GAAG,qBAAqB,CAAC,MAAM,CAAC,CAAC;IAExD,IAAI,CAAC,iBAAiB,EAAE;QACtB,MAAM,IAAI,KAAK,CAAC,+BAA+B,MAAM,iBAAiB,CAAC,CAAC;KACzE;IAED,IAAI,CAAC,iBAAiB,CAAC,QAAQ,CAAC,EAAE;QAChC,MAAM,IAAI,KAAK,CAAC,+BAA+B,QAAQ,iBAAiB,CAAC,CAAC;KAC3E;IAED,OAAO,iBAAiB,CAAC,QAAQ,CAAC,CAAC;AACrC,CAAC,CAAC;AAEF,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,gBAA6B,EAAE,EAAE,EAAE;IACrG,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,0BAA0B,CAAC,CAAC;IACvD,IAAI,CAAC,IAAI;QAAE,MAAM,IAAI,KAAK,CAAC,kBAAkB,CAAC,CAAC;IAE/C,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAE,CAAC;IAE7C,MAAM,gBAAgB,GAAG,kBAAkB,CAAC,UAAU,CAAC,CAAC;IACxD,IAAI,CAAC,gBAAgB;QAAE,MAAM,IAAI,KAAK,CAAC,iBAAiB,UAAU,sBAAsB,aAAa,EAAE,CAAC,CAAC;IAEzG,MAAM,UAAU,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC,IAAI,EAAa,CAAC;IAExD,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,UAAU,CAAC,EAAE;QAC1C,MAAM,IAAI,KAAK,CAAC,iBAAiB,UAAU,4BAA4B,UAAU,KAAK,aAAa,EAAE,CAAC,CAAC;KACxG;IAED,OAAO,EAAE,IAAI,EAAE,UAAyB,EAAE,IAAI,EAAE,UAAU,EAAC,CAAC;AAC9D,CAAC,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@etainabl/nodejs-sdk",
3
- "version": "1.1.20",
3
+ "version": "1.1.22",
4
4
  "main": "dist/index.js",
5
5
  "author": "Jonathan Lambert <jonathan@etainabl.com>",
6
6
  "type": "module",
@@ -1,73 +1,34 @@
1
1
  import moment from 'moment';
2
- import { interpolate } from './lib/readingsInterpolate.js';
3
2
 
4
- export interface Reading {
5
- submittedAt: string,
6
- value: number
3
+ interface ConsumptionData {
4
+ date: Date;
5
+ consumption: number;
7
6
  }
8
7
 
9
- export interface ApportionedReading {
10
- date: moment.Moment,
11
- reading: number,
12
- consumption?: number
13
- }
14
-
15
- const apportionedReadings = (readings: Reading[], granularity: moment.unitOfTime.Diff = 'days', interpolationMethod: string = 'linear', startDate?: string, endDate?: string): ApportionedReading[] => {
16
- // Readings sorted from newest to oldest
17
- const sortedReadings = [...readings].sort((a, b) => moment(a.submittedAt).diff(b.submittedAt));
18
-
19
- // Array of every hour/day etc between the first and last reading
20
- const intervals = moment(sortedReadings[sortedReadings.length - 1].submittedAt).diff(moment(sortedReadings[0].submittedAt), granularity);
21
-
22
- const dates = [...Array(intervals).keys()]
23
- .slice(1)
24
- .map((interval: number) => moment(sortedReadings[0].submittedAt).startOf(granularity).add(interval, granularity));
25
-
26
- let interpolatedReadings = dates.map((date: moment.Moment) => {
27
- const reading = interpolate(sortedReadings, date, interpolationMethod);
28
-
29
- return {
30
- date,
31
- reading
32
- };
33
- });
8
+ export const dayNightConsumption = (data: ConsumptionData[]) => data.reduce((acc: any, item: ConsumptionData) => {
9
+ const hour = moment(item.date).hour(); // End Time of HH consumption period
34
10
 
35
- interpolatedReadings = interpolatedReadings.map((reading: ApportionedReading, index: number) => {
36
- const prevReading = interpolatedReadings[index - 1];
37
-
38
- if (prevReading) {
39
- return {
40
- ...reading,
41
- consumption: reading.reading - prevReading.reading
42
- };
43
- }
44
-
45
- return reading;
46
-
47
- });
48
-
49
- if (startDate) {
50
- interpolatedReadings = interpolatedReadings.filter((reading: ApportionedReading) => moment(reading.date).isSameOrAfter(startDate, granularity));
11
+ if (hour >= 0 && hour < 7) {
12
+ acc.nightConsumption += item.consumption;
13
+ } else {
14
+ acc.dayConsumption += item.consumption;
51
15
  }
52
16
 
53
- if (endDate) {
54
- interpolatedReadings = interpolatedReadings.filter((reading: ApportionedReading) => moment(reading.date).isSameOrBefore(endDate, granularity));
55
- }
17
+ acc.consumption += item.consumption;
56
18
 
57
- return interpolatedReadings;
58
- };
19
+ return acc;
20
+ }, {
21
+ dayConsumption: 0,
22
+ nightConsumption: 0,
23
+ consumption: 0
24
+ });
59
25
 
60
- const consumptionFromReadings = (readings: Reading[], startDate: string, endDate: string, granularity: moment.unitOfTime.Diff = 'hours', interpolationMethod: string = 'linear') => {
61
- // Split the readings into hourly readings and calculate the consumption for each hour
62
- const apportioned = apportionedReadings(readings, granularity, interpolationMethod, startDate, endDate);
26
+ export const calcMaxConsumptionValue = (data: ConsumptionData[]) => Math.max(...data.map((item: ConsumptionData) => item.consumption));
63
27
 
64
- // Calculate the total consumption between the start and end dates
65
- const totalConsumption = apportioned.reduce((acc: any, reading) => acc + reading.consumption, 0);
28
+ export const calcMaxDemand = (data: ConsumptionData[]) => calcMaxConsumptionValue(data) * 2;
66
29
 
67
- return { totalConsumption, apportioned };
68
- };
30
+ export const calcPeakLoad = (consumption: number, maxDemand: number, startDate: Date, endDate: Date) => {
31
+ const days = Math.ceil(moment(endDate).diff(moment(startDate), 'days', true));
69
32
 
70
- export default {
71
- apportionedReadings,
72
- consumptionFromReadings
73
- };
33
+ return maxDemand === 0 ? 0 : ((consumption / (maxDemand * 24 * days)) * 100);
34
+ };
package/src/units.ts CHANGED
@@ -47,7 +47,7 @@ const unitConversionFactors: { [key: string]: any } = {
47
47
  }
48
48
  };
49
49
 
50
- const accountTypeUnitMap: { [key: string]: ETNUnit[] } = {
50
+ export const accountTypeUnitMap: { [key: string]: ETNUnit[] } = {
51
51
  electricity: ['kwh', 'mwh', 'wh'],
52
52
  gas: ['kwh', 'm3', 'ft3', 'hcf'],
53
53
  water: ['m3', 'l'],