@stamhoofd/backend 2.143.1 → 2.145.0

package/src/helpers/ViesHelper.test.ts

@@ -1,401 +0,0 @@
-import { Address, Company, PeppolEndointId } from '@stamhoofd/structures';
-import { STExpect, TestUtils } from '@stamhoofd/test-utils';
-import { Country } from '@stamhoofd/types/Country';
-import nock from 'nock';
-import { ViesHelper } from './ViesHelper.js';
-
-const VIES_HOST = 'https://ec.europa.eu';
-const VIES_PATH = '/taxation_customs/vies/rest-api/check-vat-number';
-
-const DIRECTORY_HOST = 'https://directory.peppol.eu';
-const DIRECTORY_PATH = '/search/1.0/json';
-
-describe('ViesHelper', () => {
-    /**
-     * Registers a mock for the (only) external dependency: the VIES check-vat-number endpoint.
-     * Returns the nock scope so tests can assert whether it was actually called.
-     */
-    function mockVies(response: unknown, statusCode = 200) {
-        return nock(VIES_HOST).post(VIES_PATH).reply(statusCode, response as nock.Body);
-    }
-
-    /**
-     * Captures the JSON body that was sent to the VIES endpoint, so we can assert
-     * what we send without depending on the internals of the helper.
-     */
-    function mockViesCapturingBody(response: unknown, statusCode = 200): { getBody: () => any } {
-        let body: any;
-        nock(VIES_HOST)
-            .post(VIES_PATH, (requestBody) => {
-                body = requestBody;
-                return true;
-            })
-            .reply(statusCode, response as nock.Body);
-        return { getBody: () => body };
-    }
-
-    afterEach(() => {
-        nock.cleanAll();
-        nock.disableNetConnect();
-    });
-
-    describe('checkVATNumber', () => {
-        describe('rejects invalid numbers before contacting the API', () => {
-            test('an invalid Belgian VAT number is rejected without a request', async () => {
-                const scope = mockVies({ valid: true });
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0123')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'VATNumber' }),
-                );
-
-                // The VIES endpoint must not have been called.
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('an invalid Dutch VAT number is rejected without a request', async () => {
-                const scope = mockVies({ valid: true });
-
-                await expect(ViesHelper.checkVATNumber(Country.Netherlands, 'NL123456789B01')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'VATNumber' }),
-                );
-
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('garbage input is rejected without a request', async () => {
-                const scope = mockVies({ valid: true });
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'not-a-vat-number')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'VATNumber' }),
-                );
-
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('the error message contains the rejected number', async () => {
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0123')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'VATNumber', message: /Ongeldig BTW-nummer.*BE0123/ }),
-                );
-            });
-        });
-
-        describe('parses the API response', () => {
-            test('returns the formatted number when VIES confirms it is valid', async () => {
-                const scope = mockVies({ valid: true });
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0411905847')).resolves.toBe('BE0411905847');
-
-                // The number was actually validated against VIES.
-                expect(scope.isDone()).toBe(true);
-            });
-
-            test('sends the country code and the cleaned number (without country prefix) to VIES', async () => {
-                const mock = mockViesCapturingBody({ valid: true });
-
-                await ViesHelper.checkVATNumber(Country.Belgium, 'BE0411905847');
-
-                expect(mock.getBody()).toEqual({
-                    countryCode: 'BE',
-                    vatNumber: '0411905847',
-                });
-            });
-
-            test('validates Dutch numbers against VIES as well', async () => {
-                const mock = mockViesCapturingBody({ valid: true });
-
-                await expect(ViesHelper.checkVATNumber(Country.Netherlands, 'NL301828519B01')).resolves.toBe('NL301828519B01');
-
-                expect(mock.getBody()).toEqual({
-                    countryCode: 'NL',
-                    vatNumber: '301828519B01',
-                });
-            });
-
-            test('throws an invalid_field error when VIES reports the number as not valid', async () => {
-                mockVies({ valid: false });
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0411905847')).rejects.toThrow(
-                    STExpect.simpleError({
-                        code: 'invalid_field',
-                        field: 'VATNumber',
-                        message: /BTW-plichtig.*BE0411905847/,
-                    }),
-                );
-            });
-
-            test('throws service_unavailable when VIES returns a response without a valid boolean', async () => {
-                mockVies({ somethingElse: true });
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0411905847')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'service_unavailable', field: 'VATNumber' }),
-                );
-            });
-
-            test('throws service_unavailable when VIES returns a non-object response', async () => {
-                mockVies('"plain string"');
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0411905847')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'service_unavailable', field: 'VATNumber' }),
-                );
-            });
-
-            test('throws service_unavailable when the VIES endpoint errors out', async () => {
-                mockVies({ message: 'Internal Server Error' }, 500);
-
-                await expect(ViesHelper.checkVATNumber(Country.Belgium, 'BE0411905847')).rejects.toThrow(
-                    STExpect.simpleError({ code: 'service_unavailable', field: 'VATNumber' }),
-                );
-            });
-        });
-
-        test('skips the API in development for the known development number', async () => {
-            TestUtils.setEnvironment('environment', 'development');
-            const scope = mockVies({ valid: false });
-
-            await expect(ViesHelper.checkVATNumber(Country.Netherlands, 'NL301828519B01')).resolves.toBe('NL301828519B01');
-
-            // No request was made, even though VIES would have reported it invalid.
-            expect(scope.isDone()).toBe(false);
-        });
-    });
-
-    describe('checkCompanyNumber', () => {
-        test('returns the number unchanged for non-Belgian countries without contacting the API', async () => {
-            const scope = mockVies({ valid: true });
-
-            const result = await ViesHelper.checkCompanyNumber(Country.Netherlands, '12345678');
-
-            expect(result).toEqual({ companyNumber: '12345678' });
-            expect(scope.isDone()).toBe(false);
-        });
-
-        test('rejects an invalid Belgian company number without contacting the API', async () => {
-            const scope = mockVies({ valid: true });
-
-            await expect(ViesHelper.checkCompanyNumber(Country.Belgium, '123')).rejects.toThrow(
-                STExpect.simpleError({ code: 'invalid_field', field: 'companyNumber', message: /Ongeldig ondernemingsnummer: 123/ }),
-            );
-
-            expect(scope.isDone()).toBe(false);
-        });
-
-        test('promotes a valid Belgian company number to a VAT number when VIES confirms it', async () => {
-            mockVies({ valid: true });
-
-            const result = await ViesHelper.checkCompanyNumber(Country.Belgium, '0411905847');
-
-            expect(result).toEqual({
-                companyNumber: '0411905847',
-                VATNumber: 'BE0411905847',
-            });
-        });
-
-        test('keeps the company number but clears the VAT number when VIES does not recognise it', async () => {
-            mockVies({ valid: false });
-
-            const result = await ViesHelper.checkCompanyNumber(Country.Belgium, '0411905847');
-
-            expect(result).toEqual({
-                companyNumber: '0411905847',
-                VATNumber: null,
-            });
-        });
-    });
-
-    describe('checkCompany', () => {
-        const belgianAddress = () => Address.create({
-            street: 'Demostraat',
-            number: '12',
-            city: 'Gent',
-            postalCode: '9000',
-            country: Country.Belgium,
-        });
-
-        test('clears both numbers when the company has no address, without contacting the API', async () => {
-            const scope = mockVies({ valid: true });
-
-            const company = Company.create({
-                name: 'Demo Company',
-                VATNumber: 'BE0411905847',
-                companyNumber: '0411905847',
-                address: null,
-            });
-            const patch = Company.create({});
-
-            await ViesHelper.checkCompany(company, patch);
-
-            expect(patch.VATNumber).toBeNull();
-            expect(patch.companyNumber).toBeNull();
-            expect(scope.isDone()).toBe(false);
-        });
-
-        test('rejects a company name that is too short', async () => {
-            const company = Company.create({
-                name: 'ab',
-                address: belgianAddress(),
-            });
-
-            await expect(ViesHelper.checkCompany(company, Company.create({}))).rejects.toThrow(
-                STExpect.simpleError({ code: 'invalid_company_name', field: 'companyName' }),
-            );
-        });
-
-        test('validates the VAT number and derives the company number for a Belgian company', async () => {
-            mockVies({ valid: true });
-
-            const company = Company.create({
-                name: 'Demo Company',
-                VATNumber: 'BE0411905847',
-                companyNumber: null,
-                address: belgianAddress(),
-            });
-            const patch = Company.create({});
-
-            await ViesHelper.checkCompany(company, patch);
-
-            expect(patch.VATNumber).toBe('BE0411905847');
-            expect(patch.companyNumber).toBe('0411905847');
-        });
-
-        describe('custom PEPPOL endpoint id', () => {
-            function mockDirectoryFound(participant: string, entityName = 'Directory Name') {
-                return nock(DIRECTORY_HOST)
-                    .get(DIRECTORY_PATH)
-                    .query({ participant })
-                    .reply(200, {
-                        'total-result-count': 1,
-                        matches: [{
-                            participantID: { scheme: 'iso6523-actorid-upis', value: participant.split('::')[1] },
-                            entities: [{ name: [{ name: entityName }] }],
-                        }],
-                    } as nock.Body);
-            }
-
-            function mockDirectoryNotFound(participant: string) {
-                return nock(DIRECTORY_HOST)
-                    .get(DIRECTORY_PATH)
-                    .query({ participant })
-                    .reply(200, { 'total-result-count': 0, matches: [] } as nock.Body);
-            }
-
-            // Use a GLN endpoint id for the generic directory/entityName tests: it has no
-            // extra constraints, unlike a KBO (0208) id which must match the company number.
-            const companyWithPeppol = () => Company.create({
-                name: 'Demo Company',
-                address: belgianAddress(),
-                customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0088', id: '5412345000013' }),
-            });
-
-            test('validates the id against the directory when it was changed', async () => {
-                const scope = mockDirectoryFound('iso6523-actorid-upis::0088:5412345000013');
-
-                const company = companyWithPeppol();
-                const patch = Company.patch({ customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0088', id: '5412345000013' }) });
-
-                await expect(ViesHelper.checkCompany(company, patch)).resolves.toBeUndefined();
-                expect(scope.isDone()).toBe(true);
-                // The registered entity name is stored from the directory.
-                expect(company.customPeppolEndpointId?.entityName).toBe('Directory Name');
-            });
-
-            test('overwrites a client-supplied entityName with the value from the directory', async () => {
-                mockDirectoryFound('iso6523-actorid-upis::0088:5412345000013');
-
-                const company = Company.create({
-                    name: 'Demo Company',
-                    address: belgianAddress(),
-                    customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0088', id: '5412345000013', entityName: 'Client supplied name' }),
-                });
-                const patch = Company.patch({ customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0088', id: '5412345000013', entityName: 'Client supplied name' }) });
-
-                await ViesHelper.checkCompany(company, patch);
-
-                // entityName is server-controlled: the client value is discarded.
-                expect(company.customPeppolEndpointId?.entityName).toBe('Directory Name');
-                expect(patch.customPeppolEndpointId).not.toBeNull();
-                expect((patch.customPeppolEndpointId as PeppolEndointId | undefined)?.entityName).toBe('Directory Name');
-            });
-
-            test('does not contact the directory when the id did not change', async () => {
-                const scope = mockDirectoryFound('iso6523-actorid-upis::0088:5412345000013');
-
-                const company = companyWithPeppol();
-                const patch = Company.patch({ name: 'Renamed Company' });
-
-                await ViesHelper.checkCompany(company, patch);
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('rejects an id that is unknown to the directory', async () => {
-                mockDirectoryNotFound('iso6523-actorid-upis::0088:5412345000013');
-
-                const company = companyWithPeppol();
-                const patch = Company.patch({ customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0088', id: '5412345000013' }) });
-
-                await expect(ViesHelper.checkCompany(company, patch)).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }),
-                );
-            });
-
-            test('does not contact the directory when the id is cleared', async () => {
-                const scope = mockDirectoryFound('iso6523-actorid-upis::0088:5412345000013');
-
-                const company = Company.create({ name: 'Demo Company', address: belgianAddress() });
-                const patch = Company.patch({ customPeppolEndpointId: null });
-
-                await ViesHelper.checkCompany(company, patch);
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('rejects a KBO endpoint id for a non-Belgian company before contacting the directory', async () => {
-                const scope = mockDirectoryFound('iso6523-actorid-upis::0208:0411905847');
-
-                const company = Company.create({
-                    name: 'Demo Company',
-                    address: Address.create({ street: 'Damstraat', number: '1', city: 'Amsterdam', postalCode: '1012', country: Country.Netherlands }),
-                    customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0208', id: '0411905847' }),
-                });
-                const patch = Company.patch({ customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0208', id: '0411905847' }) });
-
-                await expect(ViesHelper.checkCompany(company, patch)).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }),
-                );
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('rejects a KBO endpoint id that does not match the company number before contacting the directory', async () => {
-                const scope = mockDirectoryFound('iso6523-actorid-upis::0208:9999999999');
-
-                const company = Company.create({
-                    name: 'Demo Company',
-                    address: belgianAddress(),
-                    companyNumber: '0411905847',
-                    customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0208', id: '9999999999' }),
-                });
-                const patch = Company.patch({ customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0208', id: '9999999999' }) });
-
-                await expect(ViesHelper.checkCompany(company, patch)).rejects.toThrow(
-                    STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }),
-                );
-                expect(scope.isDone()).toBe(false);
-            });
-
-            test('accepts a KBO endpoint id that matches the company number', async () => {
-                mockVies({ valid: true });
-                const scope = mockDirectoryFound('iso6523-actorid-upis::0208:0411905847');
-
-                const company = Company.create({
-                    name: 'Demo Company',
-                    address: belgianAddress(),
-                    companyNumber: '0411905847',
-                    customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0208', id: '0411905847' }),
-                });
-                const patch = Company.patch({ customPeppolEndpointId: PeppolEndointId.create({ schemeID: '0208', id: '0411905847' }) });
-
-                await expect(ViesHelper.checkCompany(company, patch)).resolves.toBeUndefined();
-                expect(scope.isDone()).toBe(true);
-                expect(company.customPeppolEndpointId?.entityName).toBe('Directory Name');
-            });
-        });
-    });
-});

package/src/helpers/ViesHelper.ts

@@ -1,215 +0,0 @@
-import type { AutoEncoderPatchType } from '@simonbackx/simple-encoding';
-import { isSimpleError, isSimpleErrors, SimpleError } from '@simonbackx/simple-errors';
-import type { Company } from '@stamhoofd/structures';
-import { PeppolScheme } from '@stamhoofd/structures';
-import { Country } from '@stamhoofd/types/Country';
-import axios from 'axios';
-import jsvat from 'jsvat-next';
-import { PeppolDirectoryService } from '../services/PeppolDirectoryService.js';
-
-export class ViesHelperStatic {
-    testMode = false;
-
-    async request(method: 'GET' | 'POST', url: string, content: any) {
-        const json = content ? JSON.stringify(content) : '';
-
-        console.log('[VIES REQUEST]', method, url, content ? '\n [VIES REQUEST] ' : undefined, json);
-
-        const response = await axios.request({
-            method,
-            url,
-            headers: {
-                'Content-Type': json.length > 0 ? 'application/json' : 'text/plain',
-            },
-            data: json,
-
-        });
-        console.log('[VIES RESPONSE]', method, url, '\n[VIES RESPONSE]', JSON.stringify(response.data));
-        return response.data;
-    }
-
-    async checkCompany(company: Company, patch: AutoEncoderPatchType<Company> | Company) {
-        // Validate the custom PEPPOL endpoint id, but only when it actually changed.
-        // In a patch, `customPeppolEndpointId` is undefined unless the client changed it;
-        // for a full company it is always set (null or a value), so we validate a set value.
-        if (patch.customPeppolEndpointId !== undefined && company.customPeppolEndpointId) {
-            const endpointId = company.customPeppolEndpointId;
-
-            // A KBO (0208) endpoint id is the Belgian enterprise number, so it must belong to a
-            // Belgian company and be identical to this company's own company number.
-            if (endpointId.schemeID === (PeppolScheme.KBO as string)) {
-                if (company.address?.country !== Country.Belgium) {
-                    throw new SimpleError({
-                        code: 'invalid_field',
-                        message: 'A KBO PEPPOL id can only be used for a Belgian company',
-                        human: $t('%Zck'),
-                        field: 'customPeppolEndpointId',
-                    });
-                }
-
-                const companyPeppolId = company.peppolCompanyId;
-                if (!companyPeppolId || endpointId.id.replace(/\D+/g, '') !== companyPeppolId.id.replace(/\D+/g, '')) {
-                    throw new SimpleError({
-                        code: 'invalid_field',
-                        message: 'A KBO PEPPOL id must match the company number',
-                        human: $t('%ZcZ'),
-                        field: 'customPeppolEndpointId',
-                    });
-                }
-            }
-
-            // validate() fills in the server-controlled entityName from the PEPPOL directory.
-            await PeppolDirectoryService.validate(endpointId);
-
-            // Write the validated endpoint id back as a full replacement so any client-supplied
-            // entityName is discarded: entityName can only ever be set by the server.
-            patch.customPeppolEndpointId = endpointId;
-        }
-
-        if (!company.address) {
-            // Not allowed to set
-            patch.companyNumber = null;
-            patch.VATNumber = null;
-            return;
-        }
-
-        if (company.name.length < 3 || company.name.toLowerCase() === 'vzw') {
-            throw new SimpleError({
-                code: 'invalid_company_name',
-                message: 'Company name is too short',
-                human: $t('%1LF'),
-                field: 'companyName',
-            });
-        }
-
-        if (company.VATNumber !== null) {
-            // Changed VAT number
-            patch.VATNumber = await ViesHelper.checkVATNumber(company.address.country, company.VATNumber);
-
-            if (company.address.country === Country.Belgium) {
-                patch.companyNumber = company.VATNumber.substring(2);
-            }
-        }
-
-        if (company.companyNumber) {
-            if (company.VATNumber !== null && company.address.country === Country.Belgium) {
-                // Already validated
-            } else {
-                // Need to validate
-                const result = await ViesHelper.checkCompanyNumber(company.address.country, company.companyNumber);
-                patch.companyNumber = result.companyNumber;
-                if (result.VATNumber !== undefined) {
-                    patch.VATNumber = result.VATNumber;
-                }
-            }
-        }
-    }
-
-    async checkCompanyNumber(country: Country, companyNumber: string): Promise<{ companyNumber: string | null; VATNumber?: string | null }> {
-        if (country !== Country.Belgium) {
-            // Not supported
-            return {
-                companyNumber,
-            };
-        }
-
-        // In Belgium, the company number syntax is the same as VAT number
-        let correctedVATNumber = companyNumber;
-
-        // eslint-disable-next-line @typescript-eslint/no-unsafe-enum-comparison
-        if (companyNumber.length > 2 && companyNumber.substr(0, 2).toUpperCase() !== country) {
-            // Add required country in VAT number
-            correctedVATNumber = country + companyNumber;
-        }
-
-        const result = jsvat.checkVAT(correctedVATNumber, [jsvat.belgium]);
-
-        if (!result.isValid) {
-            throw new SimpleError({
-                code: 'invalid_field',
-                message: 'Ongeldig ondernemingsnummer: ' + companyNumber,
-                field: 'companyNumber',
-            });
-        }
-
-        // If this is a valid VAT number, we can assume it's a valid company number
-        try {
-            const corrected = await this.checkVATNumber(Country.Belgium, correctedVATNumber);
-
-            // this is a VAT number, not a company number
-            return {
-                companyNumber: corrected.substring(2),
-                VATNumber: corrected,
-            };
-        } catch (e) {
-            if (isSimpleError(e) || isSimpleErrors(e)) {
-                // Ignore: normal that it is not a valid VAT number
-            } else {
-                // Other errors should be thrown
-                throw e;
-            }
-        }
-
-        return {
-            companyNumber: result.value?.substring(2) ?? companyNumber,
-
-            // VATNumber should always be set to null if it is not a valid VAT number
-            VATNumber: null,
-        };
-    }
-
-    async checkVATNumber(country: Country, vatNumber: string): Promise<string> {
-        const result = jsvat.checkVAT(vatNumber, country === Country.Belgium ? [jsvat.belgium] : [jsvat.netherlands]);
-
-        if (!result.isValid) {
-            throw new SimpleError({
-                code: 'invalid_field',
-                message: $t('%1To', { number: vatNumber }),
-                field: 'VATNumber',
-            });
-        }
-
-        const formatted = result.value ?? vatNumber;
-
-        if (STAMHOOFD.environment === 'development' && formatted === 'NL301828519B01') {
-            return formatted;
-        }
-
-        try {
-            const cleaned = formatted.substring(2).replace(/(?:\.-\s)+/g, '');
-            const response = await this.request('POST', 'https://ec.europa.eu/taxation_customs/vies/rest-api/check-vat-number', {
-                countryCode: country,
-                vatNumber: cleaned,
-            });
-
-            if (typeof response !== 'object' || response === null || typeof response.valid !== 'boolean') {
-                // APi error
-                throw new Error('Invalid response from VIES');
-            }
-
-            if (!response.valid) {
-                throw new SimpleError({
-                    code: 'invalid_field',
-                    message: $t('%1TG', { 'vat-number': formatted }),
-                    field: 'VATNumber',
-                });
-            }
-        } catch (e) {
-            if (isSimpleError(e) || isSimpleErrors(e)) {
-                throw e;
-            }
-            // Unavailable: ignore for now
-            console.error('VIES error', e);
-
-            throw new SimpleError({
-                code: 'service_unavailable',
-                message: $t('%1Sf'),
-                field: 'VATNumber',
-            });
-        }
-
-        return formatted;
-    }
-}
-
-export const ViesHelper = new ViesHelperStatic();