@etainabl/nodejs-sdk 1.3.147 → 1.3.148

package/dist/index.d.cts

@@ -7,6 +7,7 @@ import { S3Client } from '@aws-sdk/client-s3';
 import { Context, SQSEvent, SNSEvent, APIGatewayEvent, S3Event } from 'aws-lambda';
 import { SQSClient } from '@aws-sdk/client-sqs';
 import winston from 'winston';
+import { Logtail } from '@logtail/node';
 import moment from 'moment';
 import { ZodObject } from 'zod';
 import OpenAI from 'openai';
@@ -277,8 +278,9 @@ interface Item {
     value: number;
     [key: string]: any;
 }
+declare const unitTypes: readonly ["kwh", "kg", "m3", "lbs", "tonnes", "wh", "mwh", "ft3", "hcf", "m3/h", "qty", "l", "C", "mcuf", "hcuf", "tcuf", "ocuf", "hm3", "tm3", "nm3", "%", "lux", "ppm", "db", "hpa", "ppb", "count"];
 type AccountType = UtilityType;
-type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3' | '%' | 'lux' | 'ppm' | 'db' | 'hpa' | 'ppb' | 'count';
+type ETNUnit = typeof unitTypes[number];
 type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h' | 'l' | 'ppm' | 'lux' | 'db' | 'hpa' | 'ppb' | 'count' | '%';
 declare const accountTypeMap: {
     [key: string]: BaseUnit;
@@ -290,7 +292,7 @@ declare const convertItems: (items: Item[], type: AccountType, defaultUnits: ETN
 declare const simpleConvert: (value: number, fromUnit: string, toUnit: string) => number;
 declare const checkAccountTypeVsUnits: (type: string, unit: string, additionalLog?: number | "") => {
     type: AccountType;
-    unit: ETNUnit;
+    unit: "lux" | "kwh" | "m3" | "hcf" | "ft3" | "mcuf" | "hcuf" | "tcuf" | "ocuf" | "hm3" | "tm3" | "nm3" | "kg" | "tonnes" | "lbs" | "wh" | "mwh" | "qty" | "l" | "m3/h" | "C" | "%" | "ppm" | "db" | "hpa" | "ppb" | "count";
 };
 
 type units_AccountType = AccountType;
@@ -301,8 +303,9 @@ declare const units_accountTypeUnitMap: typeof accountTypeUnitMap;
 declare const units_checkAccountTypeVsUnits: typeof checkAccountTypeVsUnits;
 declare const units_convertItems: typeof convertItems;
 declare const units_simpleConvert: typeof simpleConvert;
+declare const units_unitTypes: typeof unitTypes;
 declare namespace units {
-  export { type units_AccountType as AccountType, type units_BaseUnit as BaseUnit, type units_ETNUnit as ETNUnit, units_accountTypeMap as accountTypeMap, units_accountTypeUnitMap as accountTypeUnitMap, units_checkAccountTypeVsUnits as checkAccountTypeVsUnits, units_convertItems as convertItems, units_simpleConvert as simpleConvert };
+  export { type units_AccountType as AccountType, type units_BaseUnit as BaseUnit, type units_ETNUnit as ETNUnit, units_accountTypeMap as accountTypeMap, units_accountTypeUnitMap as accountTypeUnitMap, units_checkAccountTypeVsUnits as checkAccountTypeVsUnits, units_convertItems as convertItems, units_simpleConvert as simpleConvert, units_unitTypes as unitTypes };
 }
 
 interface Portal {
@@ -617,7 +620,14 @@ interface HandleErrorParams {
     automation: Automation<string>;
 }
 declare const collectionTypes: readonly ["readings", "consumptions", "invoices"];
-declare const errorCodes: readonly ["ACCOUNT_NOT_FOUND", "INVALID_DATE_FORMAT", "INVALID_TIME_FORMAT", "COLUMN_LIMIT_EXCEEDED", "INVALID_TIMESTAMP", "MISSING_DEVICE_ID", "UNSUPPORTED_UTILITY_TYPE", "VALIDATION_ERROR", "METER_READS_ZERO"];
+declare const errorCodes: ProblemCodes[];
+type ErrorMap = Record<ProblemCodes, {
+    status: 'error' | 'warning';
+    message: string;
+    unique?: boolean;
+    isUnique?: (params: Problem, problems: Problem[]) => boolean;
+}>;
+declare const errorCodeMap: ErrorMap;
 declare const dataFetchersIds: AutomationService[];
 type CollectionType = 'readings' | 'consumptions' | 'invoices';
 interface UploadCsv {
@@ -641,12 +651,13 @@ declare const integrations_collectionTypes: typeof collectionTypes;
 declare const integrations_createCsv: typeof createCsv;
 declare const integrations_dataFetchersIds: typeof dataFetchersIds;
 declare const integrations_deleteMessage: typeof deleteMessage;
+declare const integrations_errorCodeMap: typeof errorCodeMap;
 declare const integrations_errorCodes: typeof errorCodes;
 declare const integrations_handleError: typeof handleError;
 declare const integrations_sendEmail: typeof sendEmail;
 declare const integrations_uploadCsv: typeof uploadCsv;
 declare namespace integrations {
-  export { type integrations_CollectionType as CollectionType, type integrations_FormattedConsumption as FormattedConsumption, type integrations_FormattedInvoice as FormattedInvoice, type integrations_FormattedReading as FormattedReading, integrations_collectionTypes as collectionTypes, integrations_createCsv as createCsv, integrations_dataFetchersIds as dataFetchersIds, integrations_deleteMessage as deleteMessage, integrations_errorCodes as errorCodes, integrations_handleError as handleError, integrations_sendEmail as sendEmail, integrations_uploadCsv as uploadCsv };
+  export { type integrations_CollectionType as CollectionType, type integrations_FormattedConsumption as FormattedConsumption, type integrations_FormattedInvoice as FormattedInvoice, type integrations_FormattedReading as FormattedReading, integrations_collectionTypes as collectionTypes, integrations_createCsv as createCsv, integrations_dataFetchersIds as dataFetchersIds, integrations_deleteMessage as deleteMessage, integrations_errorCodeMap as errorCodeMap, integrations_errorCodes as errorCodes, integrations_handleError as handleError, integrations_sendEmail as sendEmail, integrations_uploadCsv as uploadCsv };
 }
 
 interface AutomationRunLog<DateType = Date | string> {
@@ -1446,11 +1457,11 @@ declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     getCompanyInvoiceValidationRules: (id: string, options?: AxiosRequestConfig) => Promise<CompanyInvoiceValidationRule<string>[]>;
     listCompanies: <P = Company<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateCompany: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Company<string>>;
-    getConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listConsumptions: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
-    updateConsumption: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createConsumption: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
+    getConsumption: (id: string, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
+    listConsumptions: <P = Consumption<string, Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
+    updateConsumption: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
+    createConsumption: (data: any, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
+    removeConsumption: (id: string, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
     getConsumptionSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getEmail: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     listEmails: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
@@ -1559,7 +1570,15 @@ interface EmailTemplateOptions {
 }
 declare const _default$3: (options: EmailTemplateOptions) => string;
 
-declare const _default$2: (namespace: string) => winston.Logger;
+interface LoggerOptions {
+    betterstack: boolean;
+    betterStackToken: string;
+    betterStackHost: string;
+}
+interface ExtendedLogger extends winston.Logger {
+    logtail?: Logtail;
+}
+declare const _default$2: (namespace: string, betterStackOptions?: LoggerOptions) => ExtendedLogger;
 
 declare function connectToDatabase(retryAttempt?: number): Promise<Db>;
 declare const _default$1: {

package/dist/index.d.ts

@@ -7,6 +7,7 @@ import { S3Client } from '@aws-sdk/client-s3';
 import { Context, SQSEvent, SNSEvent, APIGatewayEvent, S3Event } from 'aws-lambda';
 import { SQSClient } from '@aws-sdk/client-sqs';
 import winston from 'winston';
+import { Logtail } from '@logtail/node';
 import moment from 'moment';
 import { ZodObject } from 'zod';
 import OpenAI from 'openai';
@@ -277,8 +278,9 @@ interface Item {
     value: number;
     [key: string]: any;
 }
+declare const unitTypes: readonly ["kwh", "kg", "m3", "lbs", "tonnes", "wh", "mwh", "ft3", "hcf", "m3/h", "qty", "l", "C", "mcuf", "hcuf", "tcuf", "ocuf", "hm3", "tm3", "nm3", "%", "lux", "ppm", "db", "hpa", "ppb", "count"];
 type AccountType = UtilityType;
-type ETNUnit = 'kwh' | 'kg' | 'm3' | 'lbs' | 'tonnes' | 'wh' | 'mwh' | 'ft3' | 'hcf' | 'm3/h' | 'qty' | 'l' | 'C' | 'mcuf' | 'hcuf' | 'tcuf' | 'ocuf' | 'hm3' | 'tm3' | 'nm3' | '%' | 'lux' | 'ppm' | 'db' | 'hpa' | 'ppb' | 'count';
+type ETNUnit = typeof unitTypes[number];
 type BaseUnit = 'kwh' | 'm3' | 'C' | 'kg' | 'm3/h' | 'l' | 'ppm' | 'lux' | 'db' | 'hpa' | 'ppb' | 'count' | '%';
 declare const accountTypeMap: {
     [key: string]: BaseUnit;
@@ -290,7 +292,7 @@ declare const convertItems: (items: Item[], type: AccountType, defaultUnits: ETN
 declare const simpleConvert: (value: number, fromUnit: string, toUnit: string) => number;
 declare const checkAccountTypeVsUnits: (type: string, unit: string, additionalLog?: number | "") => {
     type: AccountType;
-    unit: ETNUnit;
+    unit: "lux" | "kwh" | "m3" | "hcf" | "ft3" | "mcuf" | "hcuf" | "tcuf" | "ocuf" | "hm3" | "tm3" | "nm3" | "kg" | "tonnes" | "lbs" | "wh" | "mwh" | "qty" | "l" | "m3/h" | "C" | "%" | "ppm" | "db" | "hpa" | "ppb" | "count";
 };
 
 type units_AccountType = AccountType;
@@ -301,8 +303,9 @@ declare const units_accountTypeUnitMap: typeof accountTypeUnitMap;
 declare const units_checkAccountTypeVsUnits: typeof checkAccountTypeVsUnits;
 declare const units_convertItems: typeof convertItems;
 declare const units_simpleConvert: typeof simpleConvert;
+declare const units_unitTypes: typeof unitTypes;
 declare namespace units {
-  export { type units_AccountType as AccountType, type units_BaseUnit as BaseUnit, type units_ETNUnit as ETNUnit, units_accountTypeMap as accountTypeMap, units_accountTypeUnitMap as accountTypeUnitMap, units_checkAccountTypeVsUnits as checkAccountTypeVsUnits, units_convertItems as convertItems, units_simpleConvert as simpleConvert };
+  export { type units_AccountType as AccountType, type units_BaseUnit as BaseUnit, type units_ETNUnit as ETNUnit, units_accountTypeMap as accountTypeMap, units_accountTypeUnitMap as accountTypeUnitMap, units_checkAccountTypeVsUnits as checkAccountTypeVsUnits, units_convertItems as convertItems, units_simpleConvert as simpleConvert, units_unitTypes as unitTypes };
 }
 
 interface Portal {
@@ -617,7 +620,14 @@ interface HandleErrorParams {
     automation: Automation<string>;
 }
 declare const collectionTypes: readonly ["readings", "consumptions", "invoices"];
-declare const errorCodes: readonly ["ACCOUNT_NOT_FOUND", "INVALID_DATE_FORMAT", "INVALID_TIME_FORMAT", "COLUMN_LIMIT_EXCEEDED", "INVALID_TIMESTAMP", "MISSING_DEVICE_ID", "UNSUPPORTED_UTILITY_TYPE", "VALIDATION_ERROR", "METER_READS_ZERO"];
+declare const errorCodes: ProblemCodes[];
+type ErrorMap = Record<ProblemCodes, {
+    status: 'error' | 'warning';
+    message: string;
+    unique?: boolean;
+    isUnique?: (params: Problem, problems: Problem[]) => boolean;
+}>;
+declare const errorCodeMap: ErrorMap;
 declare const dataFetchersIds: AutomationService[];
 type CollectionType = 'readings' | 'consumptions' | 'invoices';
 interface UploadCsv {
@@ -641,12 +651,13 @@ declare const integrations_collectionTypes: typeof collectionTypes;
 declare const integrations_createCsv: typeof createCsv;
 declare const integrations_dataFetchersIds: typeof dataFetchersIds;
 declare const integrations_deleteMessage: typeof deleteMessage;
+declare const integrations_errorCodeMap: typeof errorCodeMap;
 declare const integrations_errorCodes: typeof errorCodes;
 declare const integrations_handleError: typeof handleError;
 declare const integrations_sendEmail: typeof sendEmail;
 declare const integrations_uploadCsv: typeof uploadCsv;
 declare namespace integrations {
-  export { type integrations_CollectionType as CollectionType, type integrations_FormattedConsumption as FormattedConsumption, type integrations_FormattedInvoice as FormattedInvoice, type integrations_FormattedReading as FormattedReading, integrations_collectionTypes as collectionTypes, integrations_createCsv as createCsv, integrations_dataFetchersIds as dataFetchersIds, integrations_deleteMessage as deleteMessage, integrations_errorCodes as errorCodes, integrations_handleError as handleError, integrations_sendEmail as sendEmail, integrations_uploadCsv as uploadCsv };
+  export { type integrations_CollectionType as CollectionType, type integrations_FormattedConsumption as FormattedConsumption, type integrations_FormattedInvoice as FormattedInvoice, type integrations_FormattedReading as FormattedReading, integrations_collectionTypes as collectionTypes, integrations_createCsv as createCsv, integrations_dataFetchersIds as dataFetchersIds, integrations_deleteMessage as deleteMessage, integrations_errorCodeMap as errorCodeMap, integrations_errorCodes as errorCodes, integrations_handleError as handleError, integrations_sendEmail as sendEmail, integrations_uploadCsv as uploadCsv };
 }
 
 interface AutomationRunLog<DateType = Date | string> {
@@ -1446,11 +1457,11 @@ declare const _default$4: (auth: AuthOptions, instanceOptions?: CreateAxiosDefau
     getCompanyInvoiceValidationRules: (id: string, options?: AxiosRequestConfig) => Promise<CompanyInvoiceValidationRule<string>[]>;
     listCompanies: <P = Company<string>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
     updateCompany: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Company<string>>;
-    getConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
-    listConsumptions: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
-    updateConsumption: (id: string, data: any, options?: AxiosRequestConfig) => Promise<any>;
-    createConsumption: (data: any, options?: AxiosRequestConfig) => Promise<any>;
-    removeConsumption: (id: string, options?: AxiosRequestConfig) => Promise<any>;
+    getConsumption: (id: string, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
+    listConsumptions: <P = Consumption<string, Date>>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
+    updateConsumption: (id: string, data: any, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
+    createConsumption: (data: any, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
+    removeConsumption: (id: string, options?: AxiosRequestConfig) => Promise<Consumption<string, Date>>;
     getConsumptionSchema: (options?: AxiosRequestConfig) => Promise<any>;
     getEmail: (id: string, options?: AxiosRequestConfig) => Promise<any>;
     listEmails: <P = any>(options?: AxiosRequestConfig) => Promise<ETNPagedResponse<P>>;
@@ -1559,7 +1570,15 @@ interface EmailTemplateOptions {
 }
 declare const _default$3: (options: EmailTemplateOptions) => string;
 
-declare const _default$2: (namespace: string) => winston.Logger;
+interface LoggerOptions {
+    betterstack: boolean;
+    betterStackToken: string;
+    betterStackHost: string;
+}
+interface ExtendedLogger extends winston.Logger {
+    logtail?: Logtail;
+}
+declare const _default$2: (namespace: string, betterStackOptions?: LoggerOptions) => ExtendedLogger;
 
 declare function connectToDatabase(retryAttempt?: number): Promise<Db>;
 declare const _default$1: {

package/dist/index.js

@@ -16213,6 +16213,8 @@ var import_https = __toESM(require("https"), 1);
 
 // src/logger.ts
 var import_winston = __toESM(require("winston"), 1);
+var import_node = require("@logtail/node");
+var import_winston2 = require("@logtail/winston");
 var localFormat = import_winston.default.format.combine(
   import_winston.default.format.timestamp({ format: "HH:mm:ss" }),
   import_winston.default.format.colorize(),
@@ -16223,12 +16225,24 @@ var localFormat = import_winston.default.format.combine(
     return `${timestamp} ${level} ${namespace} ${message}${metaStr}`;
   })
 );
-var logger_default = (namespace) => import_winston.default.createLogger({
-  level: "debug",
-  format: process.env.ENV === "local" ? localFormat : import_winston.default.format.combine(import_winston.default.format.timestamp(), import_winston.default.format.json()),
-  defaultMeta: { service: process.env.AWS_LAMBDA_FUNCTION_NAME, script: namespace },
-  transports: [new import_winston.default.transports.Console()]
-});
+var logger_default = (namespace, betterStackOptions) => {
+  const transports = [new import_winston.default.transports.Console()];
+  let logtail;
+  if (betterStackOptions?.betterstack && betterStackOptions?.betterStackToken && betterStackOptions?.betterStackHost) {
+    logtail = new import_node.Logtail(betterStackOptions.betterStackToken, {
+      endpoint: betterStackOptions.betterStackHost
+    });
+    transports.push(new import_winston2.LogtailTransport(logtail));
+  }
+  const logger2 = import_winston.default.createLogger({
+    level: "debug",
+    format: process.env.ENV === "local" ? localFormat : import_winston.default.format.combine(import_winston.default.format.timestamp(), import_winston.default.format.json()),
+    defaultMeta: { service: process.env.AWS_LAMBDA_FUNCTION_NAME, script: namespace },
+    transports
+  });
+  logger2.logtail = logtail;
+  return logger2;
+};
 
 // src/api.ts
 var log = logger_default("etainablApi");
@@ -16845,8 +16859,38 @@ __export(units_exports, {
   accountTypeUnitMap: () => accountTypeUnitMap,
   checkAccountTypeVsUnits: () => checkAccountTypeVsUnits,
   convertItems: () => convertItems,
-  simpleConvert: () => simpleConvert
-});
+  simpleConvert: () => simpleConvert,
+  unitTypes: () => unitTypes
+});
+var unitTypes = [
+  "kwh",
+  "kg",
+  "m3",
+  "lbs",
+  "tonnes",
+  "wh",
+  "mwh",
+  "ft3",
+  "hcf",
+  "m3/h",
+  "qty",
+  "l",
+  "C",
+  "mcuf",
+  "hcuf",
+  "tcuf",
+  "ocuf",
+  "hm3",
+  "tm3",
+  "nm3",
+  "%",
+  "lux",
+  "ppm",
+  "db",
+  "hpa",
+  "ppb",
+  "count"
+];
 var accountTypeMap = {
   electricity: "kwh",
   gas: "kwh",
@@ -23438,6 +23482,7 @@ __export(integrations_exports, {
   createCsv: () => createCsv,
   dataFetchersIds: () => dataFetchersIds,
   deleteMessage: () => deleteMessage,
+  errorCodeMap: () => errorCodeMap,
   errorCodes: () => errorCodes,
   handleError: () => handleError,
   sendEmail: () => sendEmail,
@@ -25354,6 +25399,51 @@ var errorCodes = [
   "VALIDATION_ERROR",
   "METER_READS_ZERO"
 ];
+var errorCodeMap = {
+  ACCOUNT_NOT_FOUND: {
+    status: "error",
+    message: "Account not found for the provided device ID or MPAN.",
+    isUnique: ({ details }, problems) => {
+      return !problems.some((p7) => p7.code === "ACCOUNT_NOT_FOUND" && p7.details?.value === details?.value) || true;
+    }
+  },
+  INVALID_DATE_FORMAT: {
+    status: "error",
+    message: "The date format in the file is invalid"
+  },
+  INVALID_TIME_FORMAT: {
+    status: "error",
+    message: "The time format in the file is invalid"
+  },
+  COLUMN_LIMIT_EXCEEDED: {
+    status: "error",
+    message: "The number of columns in the file exceeds the allowed limit.",
+    unique: true
+  },
+  INVALID_TIMESTAMP: {
+    status: "error",
+    message: "The timestamp in the file is invalid."
+  },
+  MISSING_DEVICE_ID: {
+    status: "error",
+    message: "The device ID is missing in the file.",
+    unique: true
+  },
+  UNSUPPORTED_UTILITY_TYPE: {
+    status: "error",
+    message: "The utility type in the file is not supported.",
+    unique: true
+  },
+  VALIDATION_ERROR: {
+    status: "error",
+    message: "There was a validation error with the data in the file."
+  },
+  METER_READS_ZERO: {
+    status: "warning",
+    message: "Some meter reads are zero, which may indicate an issue with the data.",
+    unique: true
+  }
+};
 var dataFetchersIds = ["bacnet", "solis", "solarman", "gridfetch", "smartflow", "smartvatten", "beringar", "4dmonitoring"];
 function sendEmail(lambdaSource, context, error, destinations) {
   const sesClient = new SESClient({ region: "eu-west-1" });