@etainabl/nodejs-sdk 1.2.42 → 1.2.44

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

@@ -0,0 +1,118 @@
+interface Values {
+    friendlyInvoiceNumber?: string;
+    friendlySupplierRef?: string;
+    friendlyStartDate?: string;
+    friendlyEndDate?: string;
+    friendlyInvoiceDate?: string;
+    friendlyMeterPointNumber?: string;
+    friendlyMeterPointNumber2?: string;
+    friendlyMeterSerialNumber?: string;
+    friendlyPipeSize?: string;
+    friendlyTotalUnitCost?: number;
+    friendlyTotalWaterCost?: number;
+    friendlyTotalWasteCost?: number;
+    friendlyTotalDaily?: number;
+    friendlyTotalLevy?: number;
+    friendlyTotalKva?: number;
+    friendlyTotalUnits?: number;
+    friendlyTotalWaterVolume?: number;
+    friendlyTotalWasteVolume?: number;
+    friendlyNetTotalCost?: number;
+    friendlyTotalTax?: number;
+    friendlyTotalCost?: number;
+    friendlyMeteredConsumption?: string;
+    friendlyCorrectedConsumption?: string;
+    friendlyCorrectionFactor?: string;
+    friendlyCalorificValue?: string;
+    friendlyReadFactor?: string;
+    friendlyType?: string;
+    friendlyStartRead?: string;
+    friendlyEndRead?: string;
+    invoiceNumber?: string;
+    supplierRef?: string;
+    startDate?: Date;
+    endDate?: Date;
+    invoiceDate?: Date;
+    meterPointNumber?: string;
+    meterPointNumber2?: string;
+    meterSerialNumber?: string;
+    pipeSize?: string;
+    totalUnitCost?: number;
+    totalWaterCost?: number;
+    totalWasteCost?: number;
+    totalDaily?: number;
+    totalLevy?: number;
+    totalKva?: number;
+    totalUnits?: number;
+    totalWaterVolume?: number;
+    totalWasteVolume?: number;
+    netTotalCost?: number;
+    totalTax?: number;
+    totalCost?: number;
+    meteredConsumption?: string;
+    correctedConsumption?: string;
+    correctionFactor?: string;
+    calorificValue?: string;
+    readFactor?: string;
+    type?: string;
+    startRead?: string;
+    endRead?: string;
+}
+interface Rate {
+    consumption?: string;
+    cost?: string;
+    endDate?: Date | null;
+    endRead?: string | null;
+    endReadType?: string | null;
+    rateName?: string | null;
+    startDate?: Date | null;
+    startRead?: string | null;
+    startReadType?: string | null;
+    type: RateType | null;
+    unitRate?: string | null;
+}
+type InvoiceStatus = 'processing' | 'pending' | 'uploading' | 'queued' | 'captured' | 'error' | 'completed';
+type FinancialStatus = 'approved' | 'new' | 'not-approved' | 'paid' | 'sent-for-payment';
+type RateType = 'unitRate' | 'daily' | 'levy' | 'tax' | 'kva' | 'waterRate' | 'wasteRate' | 'discount';
+export interface Invoice {
+    _id: string;
+    jobId?: string | null;
+    startTime?: Date;
+    endTime?: Date | null;
+    s3Key: string;
+    s3TextractKey?: string | null;
+    stampedS3Key: string | null;
+    fileName?: string | null;
+    status: InvoiceStatus;
+    financialStatus: FinancialStatus;
+    completed?: boolean;
+    type?: string | null;
+    tags?: string[];
+    manualResults?: Record<string, any>;
+    values?: Values;
+    rates?: Rate[];
+    detailedResults?: Record<string, any>;
+    templateVersion?: string | null;
+    error?: Record<string, any>;
+    isPaid?: boolean;
+    isCreditNote?: boolean;
+    isConvertedCreditNote?: boolean;
+    isManual?: boolean;
+    uploaderStatus?: string;
+    simulated?: boolean;
+    notes?: string | null;
+    assignedTo?: string;
+    noScrape?: boolean;
+    scraperInvoiceId?: string;
+    confirmedAt?: Date | null;
+    confirmedBy?: string | null;
+    supplierId?: string | null;
+    sisterId?: string | null;
+    batchId?: string | null;
+    accountId?: string | null;
+    entityId?: string;
+    companyId: string;
+    userSub: string;
+    validation?: any[];
+}
+export {};

package/dist/mjs/types/invoice.js

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

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

@@ -0,0 +1,10 @@
+export interface Log {
+    _id: string;
+    message: string;
+    context?: {};
+    linkedId?: string;
+    linkedType?: string;
+    type: string;
+    userSub?: string;
+    companyId?: string;
+}

package/dist/mjs/types/log.js

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

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

@@ -0,0 +1,8 @@
+export interface Portal {
+    username?: string;
+    password?: string;
+    scraperEnabled?: boolean;
+    url?: string;
+    scraperId?: string;
+    scraperStartDate?: Date;
+}

package/dist/mjs/types/portal.js

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

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

@@ -0,0 +1,17 @@
+export interface Reading {
+    _id: string;
+    submittedAt: Date;
+    value: number;
+    type?: string;
+    invoiceStartRead?: number;
+    source: string;
+    invoiceId?: string;
+    rateId?: string;
+    contractRateType?: string;
+    invoiceBatchId?: string;
+    batchId?: string;
+    accountId: string;
+    entityId: string;
+    companyId: string;
+    userSub?: string;
+}

package/dist/mjs/types/reading.js

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

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

@@ -0,0 +1,21 @@
+export interface Report {
+    _id: string;
+    type: 'dynamic' | 'spreadsheet' | 'table' | 'pdf';
+    subType?: string;
+    fileFormat: 'pdf' | 'xlsx' | 'csv' | 'png' | 'jpg' | 'chart';
+    fileName?: string;
+    status: 'preparing' | 'ready';
+    scheduled?: boolean;
+    version?: number;
+    metadata?: Record<string, any>;
+    data?: Record<string, any>;
+    requestedAt: Date;
+    availableAt?: Date;
+    s3Key: string | null;
+    batchId?: string;
+    scheduledReportId?: string;
+    reportTemplateId?: string;
+    entityId: string;
+    companyId: string;
+    userSub?: string;
+}

package/dist/mjs/types/report.js

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

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

@@ -0,0 +1,15 @@
+export interface CreateScraperRunParams {
+    supplierId: string;
+    accountId: string;
+    companyId: string;
+}
+export interface ScraperRun {
+    _id: string;
+    logs?: {}[];
+    supplierId: string;
+    accountId: string;
+    companyId: string;
+    invoiceData?: [];
+    status: string[];
+    error?: string;
+}

package/dist/mjs/types/scraperRun.js

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

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

@@ -0,0 +1,5 @@
+export interface StatusHistory {
+    date: Date;
+    value: 'active' | 'inactive';
+    notes?: string;
+}

package/dist/mjs/types/statusHistory.js

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

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

@@ -0,0 +1,28 @@
+import { Portal } from './portal.js';
+interface PortalSupplierSchema extends Portal {
+    concurrent: boolean;
+    checkInvoiceFilenames: boolean;
+    supplierRefRequired: boolean;
+}
+interface InvoiceOptionsSchema {
+    stampPositionX?: number;
+    stampPositionY?: number;
+}
+export interface Supplier {
+    _id: string;
+    name: string;
+    logoUrl?: string;
+    websiteUrl?: string;
+    portalUrl?: string;
+    identifier?: string;
+    type: 'supplier' | 'distributor';
+    region?: string;
+    countryCode: string;
+    defaultScraper?: string;
+    active: boolean;
+    transferSupplier: boolean;
+    transferSupplierId?: string;
+    portal: PortalSupplierSchema;
+    invoiceOptions?: InvoiceOptionsSchema;
+}
+export {};

package/dist/mjs/types/supplier.js

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

package/dist/mjs/units.d.ts

@@ -0,0 +1,22 @@
+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/mjs/units.js

@@ -0,0 +1,89 @@
+export const 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
+    }
+};
+export const 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
+export const convertItems = (items, type, defaultUnits, accountFactor) => {
+    if (!type)
+        throw new Error('Account type is required');
+    const baseUnit = 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 { ...item, value: convertedValue, units: baseUnit };
+    });
+    return convertedItems;
+};
+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];
+};
+export 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 = 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 };
+};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@etainabl/nodejs-sdk",
-  "version": "1.2.42",
+  "version": "1.2.44",
   "main": "dist/cjs/index.js",
   "module": "dist/mjs/index.js",
   "types": "dist/mjs/index.d.ts",
@@ -17,16 +17,17 @@
     "@types/node": "^20.4.5",
     "@typescript-eslint/eslint-plugin": "^8.29.0",
     "@typescript-eslint/parser": "^8.29.0",
-    "eslint": "^9.23.0",
+    "eslint": "^8.57.1",
     "eslint-config-airbnb": "^19.0.4",
     "eslint-config-airbnb-base": "^15.0.0",
     "eslint-config-prettier": "^10.1.1",
     "eslint-plugin-import": "^2.31.0",
     "prettier-eslint": "^16.3.0",
-    "vitest": "^2.1.1"
+    "typescript": "^4.8.4",
+    "vitest": "^3.1.1"
   },
   "scripts": {
-    "process": "vitest run && yarn build && yarn publish",
+    "process": "vitest run && npm run build && npm version patch && npm publish",
     "build": "rm -rf dist/* && tsc -p tsconfig.json && tsc -p tsconfig.cjs.json && ./fixup.sh",
     "test": "vitest",
     "postinstall": "npm run build"
@@ -36,5 +37,9 @@
       "import": "./dist/mjs/index.js",
       "require": "./dist/cjs/index.js"
     }
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "restricted"
   }
 }