@etainabl/nodejs-sdk 1.2.33 → 1.2.35

package/dist/cjs/index.d.ts

@@ -1,11 +0,0 @@
-import api from './api.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';
-import * as monitoring from './monitoring.js';
-import * as reporting from './reporting.js';
-import type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier } from './types/index.js';
-export { api, logger, consumption, monitoring, db, slack, units, reporting };
-export type { Account, Asset, Automation, Company, DataIngest, Invoice, Log, Reading, Supplier };

package/dist/cjs/logger.d.ts

@@ -1,3 +0,0 @@
-import winston from 'winston';
-declare const _default: (namespace: string) => winston.Logger;
-export default _default;

package/dist/cjs/logger.js

@@ -1,14 +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 winston_1 = __importDefault(require("winston"));
-exports.default = (namespace) => winston_1.default.createLogger({
-    level: 'debug',
-    format: winston_1.default.format.combine(winston_1.default.format.timestamp(), winston_1.default.format.json()),
-    defaultMeta: { service: process.env.AWS_LAMBDA_FUNCTION_NAME, script: namespace },
-    transports: [
-        new winston_1.default.transports.Console()
-    ]
-});

package/dist/cjs/monitoring.d.ts

@@ -1 +0,0 @@
-export declare const sendHeartbeat: () => Promise<boolean>;

package/dist/cjs/monitoring.js

@@ -1,31 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.sendHeartbeat = void 0;
-const axios_1 = __importDefault(require("axios"));
-const logger_js_1 = __importDefault(require("./logger.js"));
-const log = (0, logger_js_1.default)('monitoring');
-const sendHeartbeat = () => __awaiter(void 0, void 0, void 0, function* () {
-    if (!process.env.HEARTBEAT_URL || process.env.HEARTBEAT_URL.endsWith('/'))
-        return false;
-    try {
-        yield axios_1.default.post(process.env.HEARTBEAT_URL);
-        return true;
-    }
-    catch (e) {
-        log.warn(`Failed to send heartbeat: ${e.message || e}`);
-        return false;
-    }
-});
-exports.sendHeartbeat = sendHeartbeat;

package/dist/cjs/package.json

@@ -1,3 +0,0 @@
-{
-    "type": "commonjs"
-}

package/dist/cjs/reporting.d.ts

@@ -1,2 +0,0 @@
-import moment from 'moment';
-export declare const getScheduledReportRunTimes: (schedule: any, limit?: number, taskTime?: moment.Moment) => moment.Moment[];

package/dist/cjs/reporting.js

@@ -1,69 +0,0 @@
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getScheduledReportRunTimes = void 0;
-const moment_1 = __importDefault(require("moment"));
-moment_1.default.locale('en', {
-    week: {
-        dow: 1
-    }
-});
-const getNextRunTime = (startDate, schedule, taskTime) => {
-    const [num, freq] = schedule.frequency.split('|');
-    const targetDate = (0, moment_1.default)(startDate).add(num, freq);
-    if (schedule.frequencyPeriod === 'first') {
-        targetDate.startOf(freq);
-    }
-    else if (schedule.frequencyPeriod === 'last') {
-        targetDate.endOf(freq);
-    }
-    const isWeekday = targetDate.isoWeekday() > 0 && targetDate.isoWeekday() < 6;
-    const isSaturday = targetDate.isoWeekday() === 6;
-    // The weekday or weekend chosen should be within the same month as the target date
-    if (schedule.frequencyDay === 'weekdays' && !isWeekday) {
-        if ((targetDate.date() / 7) < 2) {
-            targetDate.add(isSaturday ? 2 : 1, 'days');
-        }
-        else {
-            targetDate.subtract(isSaturday ? 1 : 2, 'days');
-        }
-    }
-    else if (schedule.frequencyDay === 'weekends' && isWeekday) {
-        if ((targetDate.date() / 7) < 2) {
-            targetDate.isoWeekday(6);
-        }
-        else {
-            targetDate.isoWeekday(0);
-        }
-    }
-    if (taskTime.isAfter(targetDate, 'minute')) {
-        return getNextRunTime(targetDate, schedule, taskTime);
-    }
-    return targetDate;
-};
-const getScheduledReportRunTimes = (schedule, limit = 1, taskTime = (0, moment_1.default)()) => {
-    if (!schedule.startDate || !schedule.enabled)
-        return [];
-    const originalStartDate = moment_1.default.utc(schedule.startDate);
-    let startDate = originalStartDate;
-    const includeStartDate = taskTime.isSameOrBefore(originalStartDate, 'minute');
-    let runTimes = [];
-    if (includeStartDate) {
-        runTimes = [originalStartDate];
-    }
-    const [, freq] = schedule.frequency.split('|');
-    if (freq === 'once') {
-        const nextRunTime = runTimes[0];
-        // If this is now beyond the start date, return an empty array
-        return taskTime.isAfter(nextRunTime, 'minute') ? [] : runTimes;
-    }
-    const scheduleRunTimes = Array.from(Array(includeStartDate ? limit - 1 : limit).keys()).map(() => {
-        const nextRunTime = getNextRunTime(startDate, schedule, taskTime);
-        startDate = nextRunTime.hour(originalStartDate.hour()).minute(originalStartDate.minute());
-        return nextRunTime;
-    });
-    return [...runTimes, ...scheduleRunTimes];
-};
-exports.getScheduledReportRunTimes = getScheduledReportRunTimes;

package/dist/cjs/slack.d.ts

@@ -1,4 +0,0 @@
-declare const _default: {
-    postMessage: (message: string) => Promise<import("axios").AxiosResponse<any, any>>;
-};
-export default _default;

package/dist/cjs/slack.js

@@ -1,28 +0,0 @@
-"use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-const axios_1 = __importDefault(require("axios"));
-const postMessage = (message) => __awaiter(void 0, void 0, void 0, function* () {
-    const url = 'https://hooks.slack.com/services/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';
-    const data = {
-        text: `[${(process.env.ENV || '').toUpperCase()}][${process.env.AWS_LAMBDA_FUNCTION_NAME}] ${message}`
-    };
-    const headers = {
-        'Content-Type': 'application/json'
-    };
-    return axios_1.default.post(url, data, { headers });
-});
-exports.default = {
-    postMessage
-};

package/dist/cjs/types/index.d.ts

@@ -1,20 +0,0 @@
-import type { Account } from './account.js';
-import type { Asset } from './asset.js';
-import type { Automation } from './automation.js';
-import type { Company } from './company.js';
-import type { CreateScraperRunParams, ScraperRun } from './scraperRun.js';
-import type { DataIngest } from './dataIngest.js';
-import type { Entity } from './entity.js';
-import type { Email } from './email.js';
-import type { Invoice } from './invoice.js';
-import type { Log } from './log.js';
-import type { Reading } from './reading.js';
-import type { Report } from './report.js';
-import type { Supplier } from './supplier.js';
-export type { Account, Asset, Automation, Company, CreateScraperRunParams, DataIngest, Email, Entity, Invoice, Log, Reading, Report, ScraperRun, Supplier };
-export interface ETNPagedResponse<T = any> {
-    data: T[];
-    total: number;
-    limit: number;
-    skip: number;
-}

package/dist/cjs/types/index.js

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

package/dist/cjs/units.d.ts

@@ -1,22 +0,0 @@
-interface Item {
-    units?: string | null;
-    unit?: string | null;
-    factor?: number | null;
-    value: number;
-    [key: string]: any;
-}
-export type AccountType = 'electricity' | 'gas' | 'water' | 'waste' | 'solar' | 'heating' | 'flow' | 'cooling' | 'temperature' | 'oil' | 'other';
-export type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3';
-export type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h' | 'l';
-export declare const accountTypeMap: {
-    [key: string]: BaseUnit;
-};
-export declare const accountTypeUnitMap: {
-    [key: string]: ETNUnit[];
-};
-export declare const convertItems: (items: Item[], type: AccountType, defaultUnits: ETNUnit | undefined, accountFactor: number | undefined) => any;
-export declare const checkAccountTypeVsUnits: (type: string, unit: string, additionalLog?: number | "") => {
-    type: AccountType;
-    unit: ETNUnit;
-};
-export {};

package/dist/cjs/units.js

@@ -1,94 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.checkAccountTypeVsUnits = exports.convertItems = exports.accountTypeUnitMap = exports.accountTypeMap = void 0;
-exports.accountTypeMap = {
-    electricity: 'kwh',
-    gas: 'kwh',
-    water: 'm3',
-    waste: 'kg',
-    solar: 'kwh',
-    heating: 'kwh',
-    flow: 'm3/h',
-    cooling: 'kwh',
-    temperature: 'C',
-    oil: 'l'
-};
-const unitConversionFactors = {
-    kwh: {
-        kwh: 1,
-        mwh: 1000,
-        wh: 0.001,
-        m3: (39 * 1.02264) / 3.6,
-        ft3: (0.0283 * 39 * 1.02264) / 3.6,
-        hcf: (2.83 * 39 * 1.02264) / 3.6
-    },
-    m3: {
-        m3: 1,
-        l: 0.001
-    },
-    C: {
-        C: 1
-    },
-    kg: {
-        kg: 1,
-        lbs: 0.45359237,
-        tonnes: 1000
-    },
-    'm3/h': {
-        'm3/h': 1
-    }
-};
-exports.accountTypeUnitMap = {
-    electricity: ['kwh', 'mwh', 'wh'],
-    gas: ['kwh', 'm3', 'ft3', 'hcf'],
-    water: ['m3', 'l'],
-    waste: ['kg', 'lbs', 'tonnes'],
-    solar: ['kwh', 'mwh', 'wh'],
-    heating: ['kwh', 'mwh', 'wh'],
-    flow: ['m3/h'],
-    cooling: ['kwh', 'mwh', 'wh'],
-    temperature: ['C'],
-    oil: ['l']
-};
-// Convert units to base format
-const convertItems = (items, type, defaultUnits, accountFactor) => {
-    if (!type)
-        throw new Error('Account type is required');
-    const baseUnit = exports.accountTypeMap[type];
-    if (!baseUnit)
-        throw new Error(`Account type ${type} is not supported`);
-    const convertedItems = items.map(item => {
-        const factor = item.factor || accountFactor || 1;
-        const units = item.units || item.unit || defaultUnits || baseUnit;
-        const convertedValue = item.value * _getConversionFactor(units, baseUnit) * factor;
-        return Object.assign(Object.assign({}, item), { value: convertedValue, units: baseUnit });
-    });
-    return convertedItems;
-};
-exports.convertItems = convertItems;
-const _getConversionFactor = (fromUnit = 'kwh', toUnit) => {
-    const conversionFactors = unitConversionFactors[toUnit];
-    if (!conversionFactors) {
-        throw new Error(`Conversion factor base unit ${toUnit} is not defined`);
-    }
-    if (!conversionFactors[fromUnit]) {
-        throw new Error(`Conversion factor from unit ${fromUnit} is not defined`);
-    }
-    return conversionFactors[fromUnit];
-};
-const checkAccountTypeVsUnits = (type, unit, additionalLog = '') => {
-    if (!type)
-        throw new Error('Account type is required');
-    if (!unit)
-        throw new Error('Unit is required');
-    const parsedType = type.toLowerCase().trim();
-    const accountTypeUnits = exports.accountTypeUnitMap[parsedType];
-    if (!accountTypeUnits)
-        throw new Error(`Account type "${parsedType}" is not supported ${additionalLog}`);
-    const parsedUnit = unit.toLowerCase().trim();
-    if (!accountTypeUnits.includes(parsedUnit)) {
-        throw new Error(`Account type "${parsedType}" does not support unit "${parsedUnit}" ${additionalLog}`);
-    }
-    return { type: parsedType, unit: parsedUnit };
-};
-exports.checkAccountTypeVsUnits = checkAccountTypeVsUnits;

package/dist/mjs/api.d.ts

@@ -1,110 +0,0 @@
-import type { AxiosRequestConfig, AxiosInstance, CreateAxiosDefaults } from 'axios';
-import type { Account, Asset, Automation, Entity, Company, DataIngest, Invoice, Log, Reading, Report } from './types/index.js';
-export interface ETNPagedResponse<T = any> {
-    data: T[];
-    total: number;
-    limit: number;
-    skip: number;
-}
-export interface ETNReq {
-    method: string;
-    url: string;
-}
-interface AuthOptions {
-    key?: string;
-    token?: string;
-}
-declare const _default: (auth: AuthOptions, instanceOptions?: CreateAxiosDefaults) => {
-    instance: AxiosInstance;
-    getAccount: (id: string, options?: AxiosRequestConfig) => Promise<Account>;
-    listAccounts: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Account>>;
-    updateAccount: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createAccount: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeAccount: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getAccountSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    invalidateAccountCache: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    getAsset: (id: string, options?: AxiosRequestConfig) => Promise<Asset>;
-    listAssets: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Asset>>;
-    updateAsset: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createAsset: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeAsset: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getAssetSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getAssetGroup: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listAssetGroups: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
-    updateAssetGroup: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createAssetGroup: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeAssetGroup: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getAssetGroupAssets: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getAssetGroupSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getAutomation: (id: string, options?: AxiosRequestConfig) => Promise<Automation>;
-    listAutomations: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Automation>>;
-    updateAutomation: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createAutomation: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeAutomation: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    createAutomationLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    updateAutomationLog: (id: string, subId: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeAutomationLog: (id: string, subId: string, options?: AxiosRequestConfig) => Promise<any>;
-    getCompany: (id: string, options?: AxiosRequestConfig) => Promise<Company>;
-    getConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listConsumptions: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
-    updateConsumption: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createConsumption: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getConsumptionSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getEmail: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listEmails: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
-    updateEmail: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createEmail: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeEmail: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getEmissionFactor: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listEmissionFactors: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
-    updateEmissionFactor: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createEmissionFactor: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeEmissionFactor: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getEntity: (id: string, options?: AxiosRequestConfig) => Promise<Entity>;
-    listEntities: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Entity>>;
-    updateEntity: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createEntity: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeEntity: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getEntitiesSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getLog: (id: string, options?: AxiosRequestConfig) => Promise<Log>;
-    listLogs: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Log>>;
-    updateLog: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createLog: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeLog: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getReading: (id: string, options?: AxiosRequestConfig) => Promise<Reading>;
-    listReadings: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Reading>>;
-    updateReading: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createReading: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeReading: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getReadingSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getReport: (id: string, options?: AxiosRequestConfig) => Promise<Report>;
-    listReports: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Report>>;
-    updateReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createReport: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeReport: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    sendReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    getReportTemplate: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listReportTemplates: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
-    updateReportTemplate: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createReportTemplate: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeReportTemplate: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getScheduledReport: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listScheduledReports: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<any>>;
-    updateScheduledReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createScheduledReport: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeScheduledReport: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    sendScheduledReport: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    getInvoice: (id: string, options?: AxiosRequestConfig) => Promise<Invoice>;
-    listInvoices: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<Invoice>>;
-    updateInvoice: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createInvoice: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeInvoice: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    getInvoiceSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getSupplierSchema: (options?: AxiosRequestConfig) => Promise<any>;
-    getImportTemplate: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    updateDataIngest: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createDataIngest: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    listDataIngest: (options?: AxiosRequestConfig) => Promise<ETNPagedResponse<DataIngest>>;
-};
-export default _default;