@vulog/aima-billing 1.2.34 → 1.2.36

package/dist/index.cjs

@@ -82,6 +82,21 @@ const getInvoiceById = async (client, id) => {
 	return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${id}`).then(({ data }) => data);
 };
 //#endregion
+//#region src/getInvoicePdf.ts
+const getInvoicePdf = async (client, invoiceId) => {
+	const result = zod.z.string().trim().min(1).uuid().safeParse(invoiceId);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	const { data } = await client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${invoiceId}/pdf`, { responseType: "arraybuffer" });
+	return data && data.byteLength > 0 ? data : null;
+};
+//#endregion
+//#region src/getInvoicesByTripId.ts
+const getInvoicesByTripId = async (client, tripId) => {
+	const result = zod.z.string().trim().min(1).safeParse(tripId);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/trips/${result.data}/invoices`).then(({ data }) => data);
+};
+//#endregion
 //#region src/getRefundableAmount.ts
 const schema$3 = zod.default.string().trim().min(1);
 const getRefundableAmount = async (client, invoiceId) => {
@@ -149,6 +164,8 @@ const payInvoice = async (client, invoiceId, manualPayment) => {
 exports.addCredits = addCredits;
 exports.chargeProduct = chargeProduct;
 exports.getInvoiceById = getInvoiceById;
+exports.getInvoicePdf = getInvoicePdf;
+exports.getInvoicesByTripId = getInvoicesByTripId;
 exports.getRefundableAmount = getRefundableAmount;
 exports.getUserCreditsByEntityId = getUserCreditsByEntityId;
 exports.getWalletsByEntity = getWalletsByEntity;

package/dist/index.d.cts

@@ -153,6 +153,12 @@ declare const addCredits: (client: Client, payload: Payload$1) => Promise<Credit
 //#region src/getInvoiceById.d.ts
 declare const getInvoiceById: (client: Client, id: string) => Promise<Invoice>;
 //#endregion
+//#region src/getInvoicePdf.d.ts
+declare const getInvoicePdf: (client: Client, invoiceId: string) => Promise<ArrayBuffer | null>;
+//#endregion
+//#region src/getInvoicesByTripId.d.ts
+declare const getInvoicesByTripId: (client: Client, tripId: string) => Promise<Invoice[]>;
+//#endregion
 //#region src/getRefundableAmount.d.ts
 declare const getRefundableAmount: (client: Client, invoiceId: string) => Promise<RefundableAmount>;
 //#endregion
@@ -176,4 +182,4 @@ declare const updateWallet: (client: Client, walletId: string, actions: PatchAct
 //#region src/payInvoice.d.ts
 declare const payInvoice: (client: Client, invoiceId: string, manualPayment: ManualPayment) => Promise<Invoice>;
 //#endregion
-export { ChargeProductInfo, Credit, Invoice, ManualPayment, Paths, Receipt, RefundableAmount, Wallet, addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };
+export { ChargeProductInfo, Credit, Invoice, ManualPayment, Paths, Receipt, RefundableAmount, Wallet, addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };

package/dist/index.d.mts

@@ -153,6 +153,12 @@ declare const addCredits: (client: Client, payload: Payload$1) => Promise<Credit
 //#region src/getInvoiceById.d.ts
 declare const getInvoiceById: (client: Client, id: string) => Promise<Invoice>;
 //#endregion
+//#region src/getInvoicePdf.d.ts
+declare const getInvoicePdf: (client: Client, invoiceId: string) => Promise<ArrayBuffer | null>;
+//#endregion
+//#region src/getInvoicesByTripId.d.ts
+declare const getInvoicesByTripId: (client: Client, tripId: string) => Promise<Invoice[]>;
+//#endregion
 //#region src/getRefundableAmount.d.ts
 declare const getRefundableAmount: (client: Client, invoiceId: string) => Promise<RefundableAmount>;
 //#endregion
@@ -176,4 +182,4 @@ declare const updateWallet: (client: Client, walletId: string, actions: PatchAct
 //#region src/payInvoice.d.ts
 declare const payInvoice: (client: Client, invoiceId: string, manualPayment: ManualPayment) => Promise<Invoice>;
 //#endregion
-export { ChargeProductInfo, Credit, Invoice, ManualPayment, Paths, Receipt, RefundableAmount, Wallet, addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };
+export { ChargeProductInfo, Credit, Invoice, ManualPayment, Paths, Receipt, RefundableAmount, Wallet, addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };

package/dist/index.mjs

@@ -58,6 +58,21 @@ const getInvoiceById = async (client, id) => {
 	return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${id}`).then(({ data }) => data);
 };
 //#endregion
+//#region src/getInvoicePdf.ts
+const getInvoicePdf = async (client, invoiceId) => {
+	const result = z.string().trim().min(1).uuid().safeParse(invoiceId);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	const { data } = await client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${invoiceId}/pdf`, { responseType: "arraybuffer" });
+	return data && data.byteLength > 0 ? data : null;
+};
+//#endregion
+//#region src/getInvoicesByTripId.ts
+const getInvoicesByTripId = async (client, tripId) => {
+	const result = z.string().trim().min(1).safeParse(tripId);
+	if (!result.success) throw new TypeError("Invalid args", { cause: result.error.issues });
+	return client.get(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/trips/${result.data}/invoices`).then(({ data }) => data);
+};
+//#endregion
 //#region src/getRefundableAmount.ts
 const schema$3 = z$1.string().trim().min(1);
 const getRefundableAmount = async (client, invoiceId) => {
@@ -122,4 +137,4 @@ const payInvoice = async (client, invoiceId, manualPayment) => {
 	return client.post(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${result.data.invoiceId}/payment`, result.data.manualPayment).then(({ data }) => data);
 };
 //#endregion
-export { addCredits, chargeProduct, getInvoiceById, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };
+export { addCredits, chargeProduct, getInvoiceById, getInvoicePdf, getInvoicesByTripId, getRefundableAmount, getUserCreditsByEntityId, getWalletsByEntity, payInvoice, refund, updateWallet };

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@vulog/aima-billing",
     "type": "module",
-    "version": "1.2.34",
+    "version": "1.2.36",
     "main": "dist/index.cjs",
     "module": "dist/index.mjs",
     "types": "dist/index.d.cts",
@@ -22,7 +22,7 @@
         "dev": "tsdown --watch",
         "test": "vitest run",
         "test:watch": "vitest",
-        "lint": "eslint src/**/* --ext .ts"
+        "lint": "eslint src/"
     },
     "keywords": [
         "AIMA",
@@ -32,8 +32,8 @@
     "author": "Vulog",
     "license": "MIT",
     "dependencies": {
-        "@vulog/aima-client": "1.2.34",
-        "@vulog/aima-core": "1.2.34"
+        "@vulog/aima-client": "1.2.36",
+        "@vulog/aima-core": "1.2.36"
     },
     "peerDependencies": {
         "zod": "^3.25.76"

package/src/getInvoicePdf.test.ts

@@ -0,0 +1,57 @@
+import { describe, test, expect, vi, beforeEach } from 'vitest';
+import { Client } from '@vulog/aima-client';
+import { randomUUID } from 'crypto';
+import { getInvoicePdf } from './getInvoicePdf';
+
+describe('getInvoicePdf', () => {
+    const getMock = vi.fn();
+    const client = {
+        get: getMock,
+        clientOptions: {
+            fleetId: 'FLEET_ID',
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        getMock.mockReset();
+    });
+
+    test('throws Invalid args when invoiceId is not a valid UUID', async () => {
+        await expect(getInvoicePdf(client, 'not-a-uuid')).rejects.toThrow(TypeError);
+        await expect(getInvoicePdf(client, 'not-a-uuid')).rejects.toMatchObject({
+            message: 'Invalid args',
+        });
+        expect(getMock).not.toHaveBeenCalled();
+    });
+
+    test('throws Invalid args when invoiceId is empty', async () => {
+        await expect(getInvoicePdf(client, '')).rejects.toThrow(TypeError);
+        expect(getMock).not.toHaveBeenCalled();
+    });
+
+    test('calls GET with correct URL and responseType arraybuffer, returns ArrayBuffer when data has length', async () => {
+        const invoiceId = randomUUID();
+        const pdfBuffer = new ArrayBuffer(1024);
+        getMock.mockResolvedValueOnce({ data: pdfBuffer });
+
+        const result = await getInvoicePdf(client, invoiceId);
+
+        expect(getMock).toHaveBeenCalledTimes(1);
+        expect(getMock).toHaveBeenCalledWith(
+            `/boapi/proxy/billing/fleets/FLEET_ID/invoices/${invoiceId}/pdf`,
+            { responseType: 'arraybuffer' }
+        );
+        expect(result).toBe(pdfBuffer);
+        expect(result).toBeInstanceOf(ArrayBuffer);
+        expect((result as ArrayBuffer).byteLength).toBe(1024);
+    });
+
+    test('returns null when response data is empty or zero length', async () => {
+        const invoiceId = randomUUID();
+        getMock.mockResolvedValueOnce({ data: new ArrayBuffer(0) });
+
+        const result = await getInvoicePdf(client, invoiceId);
+
+        expect(result).toBeNull();
+    });
+});

package/src/getInvoicePdf.ts

@@ -0,0 +1,18 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+export const getInvoicePdf = async (client: Client, invoiceId: string): Promise<ArrayBuffer | null> => {
+    const result = z.string().trim().min(1).uuid().safeParse(invoiceId);
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    const { data } = await client.get<ArrayBuffer>(
+        `/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/invoices/${invoiceId}/pdf`,
+        { responseType: 'arraybuffer' }
+    );
+
+    return data && data.byteLength > 0 ? data : null;
+};

package/src/getInvoicesByTripId.test.ts

@@ -0,0 +1,73 @@
+import { describe, test, expect, vi, beforeEach } from 'vitest';
+import { Client } from '@vulog/aima-client';
+import { getInvoicesByTripId } from './getInvoicesByTripId';
+import type { Invoice } from './types';
+
+describe('getInvoicesByTripId', () => {
+    const getMock = vi.fn();
+    const client = {
+        get: getMock,
+        clientOptions: {
+            fleetId: 'FLEET_ID',
+        },
+    } as unknown as Client;
+
+    beforeEach(() => {
+        getMock.mockReset();
+    });
+
+    test('throws Invalid args when tripId is empty', async () => {
+        await expect(getInvoicesByTripId(client, '')).rejects.toThrow(TypeError);
+        await expect(getInvoicesByTripId(client, '')).rejects.toMatchObject({
+            message: 'Invalid args',
+        });
+        expect(getMock).not.toHaveBeenCalled();
+    });
+
+    test('throws Invalid args when tripId is whitespace only', async () => {
+        await expect(getInvoicesByTripId(client, '   ')).rejects.toThrow(TypeError);
+        expect(getMock).not.toHaveBeenCalled();
+    });
+
+    test('calls GET with correct URL and returns invoices', async () => {
+        const tripId = 'BEBD00056A9A16103D418CC36D940E26';
+        const invoices: Invoice[] = [
+            {
+                id: '66bcbd77-37ef-47bd-b9af-877e5d213b8f',
+                sequence: 1,
+                userId: '20fb98a3-b60d-491a-9359-62e55f51fcb9',
+                invoiceDate: '2026-03-03',
+                updateDate: '2026-03-03T09:46:50Z',
+                fleetId: 'FLEET_ID',
+                invoiceYear: 2026,
+                invoicesStatus: 'PAID',
+                amount: 100,
+                currency: 'EUR',
+                entityId: 'entity-1',
+                attempts: 0,
+                pspReference: 'ref-1',
+                withTaxRefundAmount: 0,
+            },
+        ];
+        getMock.mockResolvedValueOnce({ data: invoices });
+
+        const result = await getInvoicesByTripId(client, tripId);
+
+        expect(getMock).toHaveBeenCalledTimes(1);
+        expect(getMock).toHaveBeenCalledWith(
+            `/boapi/proxy/billing/fleets/FLEET_ID/trips/${tripId}/invoices`
+        );
+        expect(result).toEqual(invoices);
+        expect(result).toHaveLength(1);
+        expect(result[0].id).toBe(invoices[0].id);
+    });
+
+    test('returns empty array when no invoices', async () => {
+        const tripId = 'some-trip-id';
+        getMock.mockResolvedValueOnce({ data: [] });
+
+        const result = await getInvoicesByTripId(client, tripId);
+
+        expect(result).toEqual([]);
+    });
+});

package/src/getInvoicesByTripId.ts

@@ -0,0 +1,17 @@
+import { Client } from '@vulog/aima-client';
+import { z } from 'zod';
+
+import { Invoice } from './types';
+
+export const getInvoicesByTripId = async (client: Client, tripId: string): Promise<Invoice[]> => {
+    const result = z.string().trim().min(1).safeParse(tripId);
+    if (!result.success) {
+        throw new TypeError('Invalid args', {
+            cause: result.error.issues,
+        });
+    }
+
+    return client
+        .get<Invoice[]>(`/boapi/proxy/billing/fleets/${client.clientOptions.fleetId}/trips/${result.data}/invoices`)
+        .then(({ data }) => data);
+};

package/src/index.ts

@@ -3,6 +3,8 @@ export * from './types';
 export * from './getUserCreditsByEntityId';
 export * from './addCredits';
 export * from './getInvoiceById';
+export * from './getInvoicePdf';
+export * from './getInvoicesByTripId';
 export * from './getRefundableAmount';
 export * from './refund';
 export * from './getWalletsByEntity';

package/src/refund.ts

@@ -24,7 +24,6 @@ export const refund = async (client: Client, payload: Payload): Promise<void> =>
     }
 
     const filteredData = Object.fromEntries(
-        // eslint-disable-next-line @typescript-eslint/no-unused-vars
         Object.entries(result.data).filter(([_, value]) => value !== undefined && value !== null)
     );
 

package/.eslintrc.cjs

@@ -1,112 +0,0 @@
-module.exports = {
-    parser: '@typescript-eslint/parser',
-    parserOptions: {
-        // Indicates the location of the TypeScript configuration file
-        project: 'tsconfig.json',
-        // Sets the root directory for the TypeScript configuration
-        tsconfigRootDir: __dirname,
-        // Specifies the version of ECMAScript syntax to be used
-        ecmaVersion: 'latest',
-        // Indicates the type of source code (script or module)
-        sourceType: 'module',
-    },
-    plugins: ['@typescript-eslint', 'prettier', 'import'],
-    extends: [
-        'airbnb-base',
-        'airbnb-typescript/base',
-        'plugin:@typescript-eslint/recommended',
-        'prettier',
-        'plugin:prettier/recommended',
-    ],
-    root: true,
-    env: {
-        es6: true,
-        node: true,
-    },
-    ignorePatterns: [
-        '/dist/**/*', // Ignore built files.
-        '.eslintrc.js',
-        '**/*.test.ts',
-    ],
-    rules: {
-        // Configures the Prettier integration with ESLint
-        'prettier/prettier': ['error', { endOfLine: 'auto' }],
-        // Disables the rule requiring an 'I' prefix for interfaces
-        '@typescript-eslint/interface-name-prefix': 'off',
-        // Configures the naming conventions for various code constructs
-        '@typescript-eslint/naming-convention': [
-            // ... various naming convention configurations ...
-            'error',
-            // Allows any naming format for destructured variables
-            {
-                selector: 'variable',
-                modifiers: ['destructured'],
-                format: null,
-            },
-            // Requires strict camelCase for function names
-            {
-                selector: 'function',
-                format: ['strictCamelCase'],
-            },
-            // Requires boolean variables to have one of the specified prefixes
-            {
-                selector: 'variable',
-                format: null,
-                types: ['boolean'],
-                prefix: ['is', 'should', 'has', 'can', 'did', 'will'],
-            },
-            // Requires enum names to have a strict PascalCase format
-            {
-                selector: 'enum',
-                format: ['StrictPascalCase'],
-            },
-        ],
-        'import/extensions': 'off',
-        // Disables the rule requiring explicit return types for functions
-        '@typescript-eslint/explicit-function-return-type': 'off',
-        // Disables the rule requiring explicit boundary types for modules
-        '@typescript-eslint/explicit-module-boundary-types': 'off',
-        // Disables the rule prohibiting the use of 'any' type
-        '@typescript-eslint/no-explicit-any': 'off',
-        // Disables the rule detecting unused variables
-        'no-unused-vars': 0,
-        // Disables the rule disallowing named exports used as a default export
-        'import/no-named-as-default': 0,
-        // Configures the order and formatting of import statements
-        'import/order': [
-            // ... import order configuration ...
-            'error',
-            {
-                // Configure the alphabetization settings
-                alphabetize: {
-                    // Enforce ascending alphabetical order
-                    order: 'asc',
-                    // Do not ignore the case while sorting
-                    caseInsensitive: false,
-                },
-                // Enforce newlines between different groups and inside groups of imports
-                'newlines-between': 'always-and-inside-groups',
-                // Warn when there is an import statement that is not part of any group
-                warnOnUnassignedImports: true,
-            },
-        ],
-        // Configures the rule detecting extraneous dependencies
-        'import/no-extraneous-dependencies': [
-            // ... extraneous dependencies configuration ...
-            'error',
-            {
-                // Specify the file patterns where devDependencies imports are allowed
-                devDependencies: [
-                    // Allow devDependencies imports in test and spec files
-                    '**/*.test.{ts,js}',
-                    '**/*.spec.{ts,js}',
-                    // Allow devDependencies imports in the 'test' folder
-                    './test/**.{ts,js}',
-                    // Allow devDependencies imports in the 'scripts' folder
-                    './scripts/**/*.{ts,js}',
-                ],
-            },
-        ],
-        'import/prefer-default-export': 'off',
-    },
-};