@stamhoofd/backend 2.143.1 → 2.145.0

package/src/services/PeppolDirectoryService.test.ts

@@ -1,139 +0,0 @@
-import { PeppolEndointId } from '@stamhoofd/structures';
-import { STExpect } from '@stamhoofd/test-utils';
-import nock from 'nock';
-import { PeppolDirectoryService } from './PeppolDirectoryService.js';
-
-const DIRECTORY_HOST = 'https://directory.peppol.eu';
-const DIRECTORY_PATH = '/search/1.0/json';
-
-describe('PeppolDirectoryService', () => {
-    /**
-     * Mocks the PEPPOL directory search endpoint for a given participant query.
-     * Returns the nock scope so tests can assert whether it was actually called.
-     */
-    function mockDirectory(participant: string, response: unknown, statusCode = 200) {
-        return nock(DIRECTORY_HOST)
-            .get(DIRECTORY_PATH)
-            .query({ participant })
-            .reply(statusCode, response as nock.Body);
-    }
-
-    /**
-     * A directory response that contains a single match for the given participant value.
-     */
-    function matchResponse(value: string) {
-        return {
-            version: '1.0',
-            'total-result-count': 1,
-            matches: [
-                {
-                    participantID: { scheme: 'iso6523-actorid-upis', value },
-                    entities: [{ name: [{ name: 'Demo Company' }], countryCode: 'BE' }],
-                },
-            ],
-        };
-    }
-
-    afterEach(() => {
-        nock.cleanAll();
-        nock.disableNetConnect();
-    });
-
-    test('resolves when the participant is registered in the directory', async () => {
-        const scope = mockDirectory('iso6523-actorid-upis::0208:0123456789', matchResponse('0208:0123456789'));
-
-        const endpointId = PeppolEndointId.create({ schemeID: '0208', id: '0123456789' });
-        await expect(PeppolDirectoryService.validate(endpointId)).resolves.toBeUndefined();
-
-        expect(scope.isDone()).toBe(true);
-        // The registered entity name from the directory is stored on the endpoint id.
-        expect(endpointId.entityName).toBe('Demo Company');
-    });
-
-    test('overwrites a pre-existing entityName with the value from the directory', async () => {
-        mockDirectory('iso6523-actorid-upis::0208:0123456789', matchResponse('0208:0123456789'));
-
-        const endpointId = PeppolEndointId.create({ schemeID: '0208', id: '0123456789', entityName: 'Client supplied name' });
-        await PeppolDirectoryService.validate(endpointId);
-
-        expect(endpointId.entityName).toBe('Demo Company');
-    });
-
-    test('sets entityName to null when the directory match has no entity name', async () => {
-        mockDirectory('iso6523-actorid-upis::0208:0123456789', {
-            'total-result-count': 1,
-            matches: [{ participantID: { scheme: 'iso6523-actorid-upis', value: '0208:0123456789' }, entities: [] }],
-        });
-
-        const endpointId = PeppolEndointId.create({ schemeID: '0208', id: '0123456789', entityName: 'stale' });
-        await PeppolDirectoryService.validate(endpointId);
-
-        expect(endpointId.entityName).toBeNull();
-    });
-
-    test('trims whitespace around the scheme and id before querying', async () => {
-        const scope = mockDirectory('iso6523-actorid-upis::0088:5412345000013', matchResponse('0088:5412345000013'));
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: ' 0088 ', id: ' 5412345000013 ' })),
-        ).resolves.toBeUndefined();
-
-        expect(scope.isDone()).toBe(true);
-    });
-
-    test('rejects an unsupported scheme without contacting the directory', async () => {
-        const scope = mockDirectory('iso6523-actorid-upis::9999:123', matchResponse('9999:123'));
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: '9999', id: '123' })),
-        ).rejects.toThrow(STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }));
-
-        expect(scope.isDone()).toBe(false);
-    });
-
-    test('rejects an empty id without contacting the directory', async () => {
-        const scope = mockDirectory('iso6523-actorid-upis::0208:', matchResponse('0208:'));
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: '0208', id: '   ' })),
-        ).rejects.toThrow(STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }));
-
-        expect(scope.isDone()).toBe(false);
-    });
-
-    test('rejects when the participant is not found in the directory', async () => {
-        mockDirectory('iso6523-actorid-upis::0060:123456789', {
-            version: '1.0',
-            'total-result-count': 0,
-            matches: [],
-        });
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: '0060', id: '123456789' })),
-        ).rejects.toThrow(STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }));
-    });
-
-    test('rejects when the directory only returns a different participant', async () => {
-        mockDirectory('iso6523-actorid-upis::0208:0123456789', matchResponse('0208:9999999999'));
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: '0208', id: '0123456789' })),
-        ).rejects.toThrow(STExpect.simpleError({ code: 'invalid_field', field: 'customPeppolEndpointId' }));
-    });
-
-    test('throws service_unavailable when the directory errors out', async () => {
-        mockDirectory('iso6523-actorid-upis::0208:0123456789', { message: 'Internal Server Error' }, 500);
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: '0208', id: '0123456789' })),
-        ).rejects.toThrow(STExpect.simpleError({ code: 'service_unavailable', field: 'customPeppolEndpointId' }));
-    });
-
-    test('throws service_unavailable when the directory returns an unexpected response', async () => {
-        mockDirectory('iso6523-actorid-upis::0208:0123456789', { unexpected: true });
-
-        await expect(
-            PeppolDirectoryService.validate(PeppolEndointId.create({ schemeID: '0208', id: '0123456789' })),
-        ).rejects.toThrow(STExpect.simpleError({ code: 'service_unavailable', field: 'customPeppolEndpointId' }));
-    });
-});

package/src/services/PeppolDirectoryService.ts

@@ -1,111 +0,0 @@
-import { SimpleError } from '@simonbackx/simple-errors';
-import type { PeppolEndointId } from '@stamhoofd/structures';
-import { PeppolScheme } from '@stamhoofd/structures';
-import axios from 'axios';
-
-/**
- * The PEPPOL schemes (ISO 6523 ICD codes) we currently support for a custom
- * PEPPOL endpoint id. The scheme identifier is the numeric code used in the
- * PEPPOL participant identifier (e.g. `iso6523-actorid-upis::0208:...`).
- */
-export const supportedPeppolSchemes: string[] = Object.values(PeppolScheme);
-
-export class PeppolDirectoryServiceStatic {
-    /**
-     * Validates a custom PEPPOL endpoint id: the scheme must be supported and the
-     * participant must be registered in the PEPPOL directory. Throws a SimpleError
-     * (with field `customPeppolEndpointId`) when the id is invalid or unknown.
-     */
-    async validate(endpointId: PeppolEndointId): Promise<void> {
-        const schemeID = endpointId.schemeID.trim();
-        const id = endpointId.id.trim();
-
-        if (!supportedPeppolSchemes.includes(schemeID)) {
-            throw new SimpleError({
-                code: 'invalid_field',
-                message: 'Unsupported PEPPOL scheme ' + schemeID,
-                human: $t('%ZcX'),
-                field: 'customPeppolEndpointId',
-            });
-        }
-
-        if (id.length === 0) {
-            throw new SimpleError({
-                code: 'invalid_field',
-                message: 'Missing PEPPOL endpoint id',
-                human: $t('%ZcY'),
-                field: 'customPeppolEndpointId',
-            });
-        }
-
-        const participant = `iso6523-actorid-upis::${schemeID}:${id}`;
-
-        let data: any;
-        try {
-            const response = await axios.request({
-                method: 'GET',
-                url: 'https://directory.peppol.eu/search/1.0/json',
-                params: { participant },
-            });
-            data = response.data;
-        } catch (e) {
-            // The directory is unavailable: we can't validate the id right now.
-            console.error('PEPPOL directory error', e);
-            throw new SimpleError({
-                code: 'service_unavailable',
-                message: 'PEPPOL directory unavailable',
-                human: $t('%Zcf'),
-                field: 'customPeppolEndpointId',
-            });
-        }
-
-        if (typeof data !== 'object' || data === null || !Array.isArray(data.matches)) {
-            throw new SimpleError({
-                code: 'service_unavailable',
-                message: 'Invalid response from PEPPOL directory',
-                human: $t('%Zcf'),
-                field: 'customPeppolEndpointId',
-            });
-        }
-
-        console.log('PEPPOL lookup', participant, data);
-
-        const expected = `${schemeID}:${id}`.toLowerCase();
-        const match = data.matches.find((m: any) => {
-            return typeof m?.participantID?.value === 'string'
-                && m.participantID.value.toLowerCase() === expected;
-        });
-
-        if (!match) {
-            throw new SimpleError({
-                code: 'invalid_field',
-                message: 'PEPPOL participant not found in directory: ' + participant,
-                human: $t('%Zcr', { id: `${schemeID}:${id}` }),
-                field: 'customPeppolEndpointId',
-            });
-        }
-
-        // Store the registered entity name from the directory. This is server-controlled
-        // and overwrites any value the client may have sent (see ViesHelper.checkCompany).
-        endpointId.entityName = this.extractEntityName(match);
-    }
-
-    /**
-     * Best-effort extraction of the registered entity name from a PEPPOL directory match.
-     * The directory returns one or more entities, each with a list of localized names.
-     */
-    private extractEntityName(match: any): string | null {
-        const entities = Array.isArray(match?.entities) ? match.entities : [];
-        for (const entity of entities) {
-            const names = Array.isArray(entity?.name) ? entity.name : [];
-            for (const n of names) {
-                if (typeof n?.name === 'string' && n.name.trim().length > 0) {
-                    return n.name.trim();
-                }
-            }
-        }
-        return null;
-    }
-}
-
-export const PeppolDirectoryService = new PeppolDirectoryServiceStatic();