@etainabl/nodejs-sdk 1.2.44 → 1.2.46

package/dist/mjs/db.js

@@ -1,53 +0,0 @@
-import { MongoClient } from 'mongodb';
-import logger from './logger.js';
-const log = logger('dbHelpers');
-let cachedDb;
-async function connectToDatabase(retryAttempt = 1) {
-    if (!process.env.ETAINABL_DB_URL)
-        throw new Error("ETAINABL_DB_URL is not set");
-    if (!process.env.AWS_ACCESS_KEY_ID)
-        throw new Error("AWS_ACCESS_KEY_ID is not set");
-    if (!process.env.AWS_SECRET_ACCESS_KEY)
-        throw new Error("AWS_SECRET_ACCESS_KEY is not set");
-    if (cachedDb) {
-        log.debug('Using cached MongoDB connection.');
-        return Promise.resolve(cachedDb);
-    }
-    const uri = `mongodb+srv://${process.env.ETAINABL_DB_URL}`;
-    try {
-        if (process.env.DB_BASIC_AUTH === 'true') {
-            log.debug('Connecting to MongoDB server... (Auth: Basic)');
-            const client = new MongoClient(uri);
-            await client.connect();
-            log.debug('Connected successfully to MongoDB server! (Auth: Basic)');
-            cachedDb = client.db('etainabl');
-            return cachedDb;
-        }
-        log.debug('Connecting to MongoDB server... (Auth: AWS)');
-        const client = new MongoClient(uri, {
-            auth: {
-                username: process.env.AWS_ACCESS_KEY_ID,
-                password: process.env.AWS_SECRET_ACCESS_KEY
-            },
-            authSource: '$external',
-            authMechanism: 'MONGODB-AWS'
-        });
-        await client.connect();
-        log.debug('Connected successfully to MongoDB server! (Auth: AWS)');
-        cachedDb = client.db('etainabl');
-        return cachedDb;
-    }
-    catch (e) {
-        // Retry
-        if (retryAttempt > 5) {
-            console.log(`Error connecting to MongoDB server after 5 attempts...`);
-            throw e;
-        }
-        console.log(`MongoDB Connection error: ${e.message}`);
-        console.log(`Error connecting to MongoDB server... Retrying in 3 seconds... (Attempt ${retryAttempt})`);
-        return connectToDatabase(retryAttempt + 1);
-    }
-}
-export default {
-    connectToDatabase
-};

package/dist/mjs/etainabl.d.ts

@@ -1,10 +0,0 @@
-export interface AuthorizerContext {
-    companyId: string;
-    isAdmin: boolean;
-    isKiosk: boolean;
-    isPublicApiRequest: boolean;
-    isService: boolean;
-    scope: string;
-    sub: string;
-    token: string;
-}

package/dist/mjs/etainabl.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/index.d.ts

@@ -1,10 +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';
-export { api, logger, consumption, monitoring, db, slack, units, reporting };
-export * from './types/index.js';

package/dist/mjs/index.js

@@ -1,10 +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';
-export { api, logger, consumption, monitoring, db, slack, units, reporting };
-export * from './types/index.js';

package/dist/mjs/logger.d.ts

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

package/dist/mjs/logger.js

@@ -1,9 +0,0 @@
-import winston from 'winston';
-export default (namespace) => winston.createLogger({
-    level: 'debug',
-    format: winston.format.combine(winston.format.timestamp(), winston.format.json()),
-    defaultMeta: { service: process.env.AWS_LAMBDA_FUNCTION_NAME, script: namespace },
-    transports: [
-        new winston.transports.Console()
-    ]
-});

package/dist/mjs/monitoring.d.ts

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

package/dist/mjs/monitoring.js

@@ -1,15 +0,0 @@
-import axios from 'axios';
-import logger from './logger.js';
-const log = logger('monitoring');
-export const sendHeartbeat = async () => {
-    if (!process.env.HEARTBEAT_URL || process.env.HEARTBEAT_URL.endsWith('/'))
-        return false;
-    try {
-        await axios.post(process.env.HEARTBEAT_URL);
-        return true;
-    }
-    catch (e) {
-        log.warn(`Failed to send heartbeat: ${e.message || e}`);
-        return false;
-    }
-};

package/dist/mjs/package.json

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

package/dist/mjs/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/mjs/reporting.js

@@ -1,62 +0,0 @@
-import moment from 'moment';
-moment.locale('en', {
-    week: {
-        dow: 1
-    }
-});
-const getNextRunTime = (startDate, schedule, taskTime) => {
-    const [num, freq] = schedule.frequency.split('|');
-    const targetDate = moment(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;
-};
-export const getScheduledReportRunTimes = (schedule, limit = 1, taskTime = moment()) => {
-    if (!schedule.startDate || !schedule.enabled)
-        return [];
-    const originalStartDate = moment.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];
-};

package/dist/mjs/slack.d.ts

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

package/dist/mjs/slack.js

@@ -1,14 +0,0 @@
-import axios from 'axios';
-const postMessage = async (message) => {
-    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.post(url, data, { headers });
-};
-export default {
-    postMessage
-};

package/dist/mjs/types/account.d.ts

@@ -1,112 +0,0 @@
-import type { Portal } from './portal.js';
-import type { StatusHistory } from './statusHistory.js';
-interface PortalAccountSchema extends Portal {
-    invoiceFilenames: any[];
-}
-interface RateSchema {
-    type: string;
-    value: number;
-    description: string;
-}
-interface ContractSchema {
-    startDate: Date;
-    endDate: Date;
-    terminationDate?: Date;
-    paymentTerms?: string;
-    duration?: string;
-    tariffName?: string;
-    contractConsumption?: number;
-    volumeTolerance?: any[];
-    renewablePercentage?: number;
-    marketBasedEmissionFactor?: number;
-    chargeableCclPercentage?: number;
-    commissionRates?: number;
-    rates: any[];
-    s3Key?: string;
-    rateTypeMapping?: object;
-    batchId?: string;
-    supplierId?: string;
-    status: 'active' | 'inactive';
-    userSub?: string;
-    deletedOn?: Date;
-}
-interface CreditNoteSchema {
-    name: string;
-    type: string;
-    amount: number;
-    netAmount: number;
-    taxAmount: number;
-    date: Date;
-    isPaid: boolean;
-    s3Key: string;
-    stampedS3Key: string;
-    fileName: string;
-    invoiceData: object;
-    userSub: string;
-    readingIds: any[];
-    supplierId: string;
-    totalUnits: number;
-    endDate: Date;
-    startDate: Date;
-    stampDate: Date;
-    totalWaterVolume: number;
-    totalWasteVolume: number;
-    totalWaterCost: number;
-    totalWasteCost: number;
-}
-export interface Account {
-    _id: string;
-    name: string;
-    modifiedBy?: string;
-    siteCode?: string;
-    type: 'gas' | 'electricity' | 'water' | 'waste' | 'solar';
-    supplierRef?: string;
-    financialCode?: string;
-    propertyCode?: string;
-    meterPointNumber?: string;
-    meterSerialNumber?: string;
-    meterPointNumber2?: string;
-    meterUnits: 'kwh' | 'm3' | 'ft3';
-    automaticMeterRead?: boolean;
-    status?: 'active' | 'inactive';
-    statusHistory?: StatusHistory[];
-    rates?: RateSchema[];
-    capacity?: string;
-    meterOperator?: string;
-    meterLocation?: string;
-    meterOperatorType?: 'lease' | 'purchase';
-    meterOperatorExpiryDate?: Date;
-    dataCollector?: string;
-    parentAccountId?: string;
-    processingInvoices?: object[];
-    contracts?: ContractSchema[];
-    creditNotes?: CreditNoteSchema[];
-    meterUser?: string;
-    isTrc?: boolean;
-    floorArea?: string;
-    floorAreaUnit?: 'metric' | 'imperial';
-    reportingType?: string;
-    solarType?: 'generation' | 'export';
-    consumptionSource?: 'primary' | 'sub' | 'primary-sub';
-    esec?: 'a' | 'b' | 'c' | 'd' | 'e' | 'g' | 'h' | 'j' | 'k' | 'l' | 'm' | 'n' | 'p' | 'q' | 'r' | 's' | 't' | 'u';
-    portal?: PortalAccountSchema;
-    deviceId?: string;
-    gridfetchLoa?: {
-        s3Key?: string;
-        name?: string;
-        uploadedBy?: string;
-        uploadedAt?: Date;
-        expiryDate?: Date;
-        error?: string;
-        uploaded?: boolean;
-    };
-    automationIds?: string[];
-    customIntegrations?: object;
-    supplierId?: string;
-    batchId?: string;
-    assetId: string;
-    entityId: string;
-    companyId: string;
-    userSub: string;
-}
-export {};

package/dist/mjs/types/account.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/types/address.d.ts

@@ -1,11 +0,0 @@
-export interface Address {
-    streetAddress: string;
-    locality?: string;
-    region?: string;
-    postCode: string;
-    province?: string;
-    countryCode?: string;
-    jurisdictionCode?: string;
-    latitude?: string;
-    longitude?: string;
-}

package/dist/mjs/types/address.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/types/asset.d.ts

@@ -1,122 +0,0 @@
-import type { Address } from './address.js';
-import type { StatusHistory } from './statusHistory.js';
-interface Image {
-    url?: string;
-    label?: string;
-    type?: string;
-    isHidden?: boolean;
-    isPrimary?: boolean;
-}
-interface FloodRisk {
-    url?: string;
-    description?: string;
-    label?: string;
-    latitude?: number;
-    longitude?: number;
-    fetchedAt?: Date;
-}
-interface Crime {
-    category?: string;
-    month?: string;
-    crimeId?: string;
-    outcomeCategory?: string;
-    outcomeDate?: string;
-    location?: {
-        latitude: string;
-        longitude: string;
-        street: string;
-    };
-    fetchedAt?: Date;
-}
-interface AirQuality {
-    index?: number;
-    indexColour?: string;
-    indexRating?: string;
-    details?: object;
-    location?: object;
-    lastMeasured?: Date;
-    fetchedAt?: Date;
-}
-interface Benchmark {
-    benchmarkId: string;
-    fieldCode: string;
-    fieldValue: string;
-}
-interface Document {
-    s3Key?: string;
-    name: string;
-    extension?: string;
-    type: string;
-    status: string;
-    score?: string;
-    providerId?: string;
-    providerData?: object;
-    certificate?: object;
-    createdAt: Date;
-    accountIds?: string[];
-}
-interface TimelineEvent {
-    date: Date;
-    title: string;
-    status: string;
-    content?: string;
-    icon?: string;
-    accountIds?: string[];
-}
-interface AssetRecommendation {
-    recommendationId: string;
-    documentIds?: string[];
-}
-interface AssetSettings {
-    consumptionSources: {
-        electricity: string;
-        solar: string;
-        gas: string;
-        water: string;
-    };
-}
-export interface Asset {
-    _id: string;
-    siteName: string;
-    address: Address;
-    assetType: string;
-    floorArea: number;
-    floorAreaUnit: 'metric' | 'imperial';
-    noOfFloors?: number;
-    energyRating: string;
-    gav: string;
-    gavCurrency: string;
-    currency: string;
-    occupationStatus: 'occupied' | 'vacant' | 'other' | 'n/a';
-    type: 'new construction' | 'major renovation' | 'standing investment' | 'n/a';
-    vacancyRate?: number;
-    constructionYear?: number;
-    ownedSince?: Date;
-    disposalDate?: Date;
-    tenure: 'freehold' | 'leasehold';
-    tenantControlledPercent?: number;
-    landlordControlledPercent?: number;
-    occupancyLevel?: number;
-    images: Image[];
-    pricePaid?: number;
-    floodRisks: FloodRisk[];
-    recentCrimes: Crime[];
-    recentAirQuality: AirQuality;
-    documents?: Document[];
-    epbCertificates: any[];
-    status?: string;
-    settings: AssetSettings;
-    recommendations?: AssetRecommendation[];
-    statusHistory: StatusHistory[];
-    timelineEvents: TimelineEvent[];
-    benchmarks: Benchmark[];
-    lastPopulated?: Date;
-    deletedOn?: Date;
-    batchId?: string;
-    companyId: string;
-    entityId: string;
-    assetGroupIds: string[];
-    userSub: string;
-    gresbId?: string;
-}
-export {};

package/dist/mjs/types/asset.js

@@ -1,2 +0,0 @@
-;
-export {};

package/dist/mjs/types/automation.d.ts

@@ -1,33 +0,0 @@
-interface Log {
-    message: string;
-    timestamp: Date;
-    batchId?: string;
-    source?: string;
-}
-interface LastCollection {
-    collectedAt: Date | null;
-    data: Record<string, any> | null;
-    error: Record<string, any> | null;
-    status: 'success' | 'error' | 'pending';
-    source: Record<string, any> | null;
-}
-type FrequencyType = 'never' | 'trigger' | 'hourly' | 'daily' | 'weekly' | 'monthly';
-export interface Automation {
-    _id: string;
-    description?: string;
-    service: string;
-    source: string;
-    category: string;
-    active: boolean;
-    status?: 'running' | 'pending';
-    lastCollection: LastCollection;
-    logs: Log[];
-    data: Record<string, any>;
-    sourceData: Record<string, any>;
-    frequency?: FrequencyType;
-    accountIds?: string[];
-    assetIds?: string[];
-    userSub: string;
-    companyId: string;
-}
-export {};

package/dist/mjs/types/automation.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/types/company.d.ts

@@ -1,42 +0,0 @@
-import { Address } from './address.js';
-import { Portal } from './portal.js';
-interface SupplierPortals {
-    supplierId: string;
-    portal: Portal;
-}
-interface CustomIntegrations {
-    account: any[];
-    asset: any[];
-    entity: any[];
-}
-interface DefaultSources {
-    electricity: 'invoice' | 'consumption' | 'reading';
-    solar: 'invoice' | 'consumption' | 'reading';
-    gas: 'invoice' | 'consumption' | 'reading';
-    water: 'invoice' | 'consumption' | 'reading';
-}
-interface CompanySettings {
-    showLogo?: boolean;
-    invoiceCategories?: any[];
-    miscInvoiceCategories?: any[];
-    messageCategories?: any[];
-    documentCategories?: any[];
-    assetDataSchemas?: any[];
-    hideCostData?: boolean;
-    calendarPeriod?: string;
-    customIntegrations?: CustomIntegrations;
-    supplierPortals?: SupplierPortals[];
-    defaultSources?: DefaultSources;
-    scraperCounter?: number;
-}
-export interface Company {
-    _id: string;
-    name: string;
-    address?: Address;
-    invoiceEmail?: string;
-    users?: string[];
-    settings: CompanySettings;
-    logoS3Key: string;
-    logoUrl?: string;
-}
-export {};

package/dist/mjs/types/company.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/types/dataIngest.d.ts

@@ -1,8 +0,0 @@
-export interface DataIngest {
-    _id: string;
-    messageId: string;
-    status: 'started' | 'processing' | 'importing' | 'completed' | 'failed' | 'dlq';
-    context: any;
-    startTime: string;
-    remainingTime: number;
-}

package/dist/mjs/types/dataIngest.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/types/email.d.ts

@@ -1,18 +0,0 @@
-interface Attachment {
-    filename: string;
-    s3Key: string;
-}
-export interface Email {
-    _id: string;
-    destinations: string[];
-    service: string;
-    subject: string;
-    body: string;
-    from: string;
-    attachments?: Attachment[];
-    sesMessageId: string;
-    s3Key: string;
-    userSub?: string;
-    companyId?: string;
-}
-export {};

package/dist/mjs/types/email.js

@@ -1 +0,0 @@
-export {};

package/dist/mjs/types/entity.d.ts

@@ -1,16 +0,0 @@
-import { Address } from './address.js';
-type EntityType = 'fund' | 'company' | 'charity' | 'school/university' | 'council' | 'other';
-export interface Entity {
-    _id: string;
-    legalName: string;
-    type: EntityType;
-    companyNumber?: string;
-    companyLogo?: string;
-    billingAddress: Address;
-    parentEntityId?: string;
-    ultimateParentEntityId?: string;
-    companyId: string;
-    batchId?: string;
-    userSub: string;
-}
-export {};

package/dist/mjs/types/entity.js

@@ -1 +0,0 @@
-export {};

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

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

package/dist/mjs/types/index.js

@@ -1 +0,0 @@
-export {};