zibri 2.2.1 → 2.3.0

package/src/plugin/invoicing/services/conformance/en16931/peppol-conformance.service.test.ts

@@ -1,22 +1,23 @@
 import { afterAll, beforeAll, describe, it } from '@jest/globals';
-import { PostgreSqlContainer } from '@testcontainers/postgresql';
-import { StartedTestContainer } from 'testcontainers';
 
 import { PeppolConformanceService } from './peppol-conformance.service';
-import { POSTGRES_TEST_IMAGE, testFileFolder } from '../../../../../__testing__/constants';
-import { PostgresDataSource, PostgresOptions } from '../../../../../data-source/data-sources/postgres-data-source.model';
-import { DataSource } from '../../../../../data-source/decorators/data-source.decorator';
-import { MigrationEntity } from '../../../../../data-source/migration/migration-entity.model';
+import { testFileFolder } from '../../../../../__testing__/constants';
+import { createTestDataSource, defaultTestServerEntities } from '../../../../../__testing__/test-server/create-test-data-source.function';
+import { defaultTestServerProviders } from '../../../../../__testing__/test-server/providers';
+import { StartedTestServer, startTestServer } from '../../../../../__testing__/test-server/start-test-server.function';
 import { Repository } from '../../../../../data-source/repository';
+import { repositoryTokenFor } from '../../../../../di/decorators/inject-repository.decorator';
+import { inject } from '../../../../../di/inject.function';
+import { defineProvider } from '../../../../../di/models/di-provider.model';
 import { XML } from '../../../../../document/xml.utilities';
-import { BaseEntity } from '../../../../../entity/base-entity.model';
-import { Newable } from '../../../../../types/newable.type';
 import { OmitStrict } from '../../../../../types/omit-strict.type';
 import { FsUtilities } from '../../../../../utilities/fs.utilities';
 import { Ms } from '../../../../../utilities/ms';
+import { ZibriInvoicingPlugin } from '../../../invoicing.plugin';
+import { ZIBRI_INVOICING_PLUGIN_DI_TOKENS } from '../../../invoicing.tokens';
 import { Invoice } from '../../../models/invoice.model';
 import { InvoicingOptions } from '../../../models/invoicing-options.model';
-import { InvoiceCalcService } from '../../invoice-calc.service';
+import { NumberInvoices } from '../../../models/number-invoices.model';
 
 const invoicingOptions: InvoicingOptions = {
     footerFontSize: 10,
@@ -72,44 +73,28 @@ const invoicingOptions: InvoicingOptions = {
     taxOffice: 'Tax Office Example City'
 };
 
-const invoiceCalcService: InvoiceCalcService = new InvoiceCalcService();
-const conformanceService: PeppolConformanceService = new PeppolConformanceService(invoicingOptions, invoiceCalcService);
+let conformanceService: PeppolConformanceService;
 
-@DataSource()
-class DbDataSource extends PostgresDataSource {
-    options: PostgresOptions = {
-        host: 'localhost',
-        username: 'postgres',
-        password: 'password',
-        database: 'db',
-        synchronize: true
-    };
-    entities: Newable<BaseEntity>[] = [Invoice, MigrationEntity];
-}
-
-let container: StartedTestContainer;
-let dataSource: DbDataSource;
+let server: StartedTestServer;
 let repo: Repository<Invoice, OmitStrict<Invoice, 'id'>>;
 
 describe('generateXml', () => {
     beforeAll(async () => {
         await FsUtilities.mkdir(testFileFolder);
-        container = await new PostgreSqlContainer(POSTGRES_TEST_IMAGE)
-            .withDatabase('db')
-            .withUsername('postgres')
-            .withPassword('password')
-            .start();
-        dataSource = new DbDataSource();
-        dataSource.options = {
-            ...dataSource.options,
-            port: container.getMappedPort(5432)
-        };
-        await dataSource.init();
-        repo = dataSource.getRepository(Invoice);
+        server = await startTestServer({
+            plugins: [new ZibriInvoicingPlugin()],
+            dataSources: [createTestDataSource({ entities: [...defaultTestServerEntities, Invoice, NumberInvoices] })],
+            providers: [
+                ...defaultTestServerProviders,
+                defineProvider({ token: ZIBRI_INVOICING_PLUGIN_DI_TOKENS.OPTIONS_INPUT, useValue: invoicingOptions })
+            ]
+        });
+        repo = inject(repositoryTokenFor(Invoice));
+        conformanceService = inject(PeppolConformanceService);
     }, 15000);
 
     afterAll(async () => {
-        await container.stop();
+        await server.shutdown();
     });
 
     it('should create the expected result', async () => {

package/src/plugin/invoicing/services/conformance/en16931/peppol-conformance.service.ts

@@ -5,7 +5,7 @@ import { EN16931ConformanceService, EN16931DocumentContextId } from './en16931-c
 /**
  * Handles conforming to the peppol standard.
  */
-@Injectable()
+@Injectable({ register: 'onUse' })
 export class PeppolConformanceService extends EN16931ConformanceService {
     override readonly name: InvoiceConformance = 'peppol';
     // eslint-disable-next-line stylistic/max-len

package/src/plugin/invoicing/services/conformance/en16931/x-rechnung-conformance.service.test.ts

@@ -1,22 +1,23 @@
 import { afterAll, beforeAll, describe, it } from '@jest/globals';
-import { PostgreSqlContainer } from '@testcontainers/postgresql';
-import { StartedTestContainer } from 'testcontainers';
 
 import { XRechnungConformanceService } from './x-rechnung-conformance.service';
-import { POSTGRES_TEST_IMAGE, testFileFolder } from '../../../../../__testing__/constants';
-import { PostgresDataSource, PostgresOptions } from '../../../../../data-source/data-sources/postgres-data-source.model';
-import { DataSource } from '../../../../../data-source/decorators/data-source.decorator';
-import { MigrationEntity } from '../../../../../data-source/migration/migration-entity.model';
+import { testFileFolder } from '../../../../../__testing__/constants';
+import { createTestDataSource, defaultTestServerEntities } from '../../../../../__testing__/test-server/create-test-data-source.function';
+import { defaultTestServerProviders } from '../../../../../__testing__/test-server/providers';
+import { StartedTestServer, startTestServer } from '../../../../../__testing__/test-server/start-test-server.function';
 import { Repository } from '../../../../../data-source/repository';
+import { repositoryTokenFor } from '../../../../../di/decorators/inject-repository.decorator';
+import { inject } from '../../../../../di/inject.function';
+import { defineProvider } from '../../../../../di/models/di-provider.model';
 import { XML } from '../../../../../document/xml.utilities';
-import { BaseEntity } from '../../../../../entity/base-entity.model';
-import { Newable } from '../../../../../types/newable.type';
 import { OmitStrict } from '../../../../../types/omit-strict.type';
 import { FsUtilities } from '../../../../../utilities/fs.utilities';
 import { Ms } from '../../../../../utilities/ms';
+import { ZibriInvoicingPlugin } from '../../../invoicing.plugin';
+import { ZIBRI_INVOICING_PLUGIN_DI_TOKENS } from '../../../invoicing.tokens';
 import { Invoice } from '../../../models/invoice.model';
 import { InvoicingOptions } from '../../../models/invoicing-options.model';
-import { InvoiceCalcService } from '../../invoice-calc.service';
+import { NumberInvoices } from '../../../models/number-invoices.model';
 
 const invoicingOptions: InvoicingOptions = {
     footerFontSize: 10,
@@ -72,44 +73,28 @@ const invoicingOptions: InvoicingOptions = {
     taxOffice: 'Tax Office Example City'
 };
 
-const invoiceCalcService: InvoiceCalcService = new InvoiceCalcService();
-const conformanceService: XRechnungConformanceService = new XRechnungConformanceService(invoicingOptions, invoiceCalcService);
-
-@DataSource()
-class DbDataSource extends PostgresDataSource {
-    options: PostgresOptions = {
-        host: 'localhost',
-        username: 'postgres',
-        password: 'password',
-        database: 'db',
-        synchronize: true
-    };
-    entities: Newable<BaseEntity>[] = [Invoice, MigrationEntity];
-}
-
-let container: StartedTestContainer;
-let dataSource: DbDataSource;
+let server: StartedTestServer;
 let repo: Repository<Invoice, OmitStrict<Invoice, 'id'>>;
+let conformanceService: XRechnungConformanceService;
 
 describe('generateXml', () => {
     beforeAll(async () => {
         await FsUtilities.mkdir(testFileFolder);
-        container = await new PostgreSqlContainer(POSTGRES_TEST_IMAGE)
-            .withDatabase('db')
-            .withUsername('postgres')
-            .withPassword('password')
-            .start();
-        dataSource = new DbDataSource();
-        dataSource.options = {
-            ...dataSource.options,
-            port: container.getMappedPort(5432)
-        };
-        await dataSource.init();
-        repo = dataSource.getRepository(Invoice);
+        server = await startTestServer({
+            plugins: [new ZibriInvoicingPlugin()],
+            dataSources: [createTestDataSource({ entities: [...defaultTestServerEntities, Invoice, NumberInvoices] })],
+            providers: [
+                ...defaultTestServerProviders,
+                defineProvider({ token: ZIBRI_INVOICING_PLUGIN_DI_TOKENS.OPTIONS_INPUT, useValue: invoicingOptions })
+            ]
+        });
+
+        repo = inject(repositoryTokenFor(Invoice));
+        conformanceService = inject(XRechnungConformanceService);
     }, 15000);
 
     afterAll(async () => {
-        await container.stop();
+        await server.shutdown();
     });
 
     it('should create the expected result', async () => {

package/src/plugin/invoicing/services/conformance/en16931/x-rechnung-conformance.service.ts

@@ -5,7 +5,7 @@ import { EN16931ConformanceService, EN16931DocumentContextId } from './en16931-c
 /**
  * Handles conforming to the X-Rechnung standard.
  */
-@Injectable()
+@Injectable({ register: 'onUse' })
 export class XRechnungConformanceService extends EN16931ConformanceService {
     override readonly name: InvoiceConformance = 'x-rechnung';
     override readonly documentContextId: EN16931DocumentContextId = 'urn:cen.eu:en16931:2017#compliant#urn:xrechnung:3.0';

package/src/plugin/invoicing/services/invoice-calc.service.ts

@@ -1,5 +1,6 @@
 
 import { InvoiceCalcServiceInterface } from './invoice-calc-service.interface';
+import { Injectable } from '../../../di/decorators/injectable.decorator';
 import { BigNumberUtilities } from '../../../utilities/big-number.utilities';
 import { InvoiceItem } from '../models/invoice-item.model';
 import { Invoice as BaseInvoice, Invoice } from '../models/invoice.model';
@@ -8,6 +9,7 @@ import { Vat } from '../models/vat.model';
 /**
  * Default implementation of the invoice calculation service.
  */
+@Injectable({ register: 'onUse' })
 export class InvoiceCalcService implements InvoiceCalcServiceInterface<Invoice> {
     // eslint-disable-next-line jsdoc/require-jsdoc
     getItemTotalPriceBeforeTax(item: InvoiceItem): BigNumber {

package/src/plugin/invoicing/services/invoice-number.service.test.ts

@@ -1,18 +1,18 @@
 /* eslint-disable cspell/spellchecker */
 import { afterAll, beforeAll, describe, expect, it } from '@jest/globals';
-import { PostgreSqlContainer } from '@testcontainers/postgresql';
-import { StartedTestContainer } from 'testcontainers';
 
-import { InvoiceCalcService } from './invoice-calc.service';
 import { InvoiceNumberService } from './invoice-number.service';
-import { POSTGRES_TEST_IMAGE } from '../../../__testing__/constants';
-import { PostgresDataSource, PostgresOptions } from '../../../data-source/data-sources/postgres-data-source.model';
-import { DataSource } from '../../../data-source/decorators/data-source.decorator';
-import { MigrationEntity } from '../../../data-source/migration/migration-entity.model';
+import { createTestDataSource, defaultTestServerEntities } from '../../../__testing__/test-server/create-test-data-source.function';
+import { defaultTestServerPlugins } from '../../../__testing__/test-server/plugins';
+import { defaultTestServerProviders } from '../../../__testing__/test-server/providers';
+import { StartedTestServer, startTestServer } from '../../../__testing__/test-server/start-test-server.function';
 import { Repository } from '../../../data-source/repository';
-import { BaseEntity } from '../../../entity/base-entity.model';
-import { Newable } from '../../../types/newable.type';
+import { repositoryTokenFor } from '../../../di/decorators/inject-repository.decorator';
+import { inject } from '../../../di/inject.function';
+import { defineProvider } from '../../../di/models/di-provider.model';
 import { OmitStrict } from '../../../types/omit-strict.type';
+import { ZibriInvoicingPlugin } from '../invoicing.plugin';
+import { ZIBRI_INVOICING_PLUGIN_DI_TOKENS } from '../invoicing.tokens';
 import { InvoiceAddress } from '../models/invoice-address.model';
 import { Invoice } from '../models/invoice.model';
 import { InvoicingOptions } from '../models/invoicing-options.model';
@@ -101,47 +101,26 @@ const privateCustomerData: InvoiceAddress = {
     countryId: 'DE'
 };
 
-// eslint-disable-next-line unusedImports/no-unused-vars
-const invoiceCalcService: InvoiceCalcService = new InvoiceCalcService();
-
-@DataSource()
-class DbDataSource extends PostgresDataSource {
-    options: PostgresOptions = {
-        host: 'localhost',
-        username: 'postgres',
-        password: 'password',
-        database: 'db',
-        synchronize: true
-    };
-    entities: Newable<BaseEntity>[] = [Invoice, NumberInvoices, MigrationEntity];
-}
-
-let container: StartedTestContainer;
-let dataSource: DbDataSource;
+let testServer: StartedTestServer;
 let invoiceRepo: Repository<Invoice, OmitStrict<Invoice, 'id'>>;
-let numberInvoicesRepo: Repository<NumberInvoices, OmitStrict<NumberInvoices, 'id'>>;
 let invoiceNumberService: InvoiceNumberService;
 
 describe('generateInvoiceNumber', () => {
     beforeAll(async () => {
-        container = await new PostgreSqlContainer(POSTGRES_TEST_IMAGE)
-            .withDatabase('db')
-            .withUsername('postgres')
-            .withPassword('password')
-            .start();
-        dataSource = new DbDataSource();
-        dataSource.options = {
-            ...dataSource.options,
-            port: container.getMappedPort(5432)
-        };
-        await dataSource.init();
-        invoiceRepo = dataSource.getRepository(Invoice);
-        numberInvoicesRepo = dataSource.getRepository(NumberInvoices);
-        invoiceNumberService = new InvoiceNumberService(invoiceRepo, numberInvoicesRepo, invoicingOptions);
+        testServer = await startTestServer({
+            dataSources: [createTestDataSource({ entities: [...defaultTestServerEntities, Invoice, NumberInvoices] })],
+            plugins: [...defaultTestServerPlugins, new ZibriInvoicingPlugin()],
+            providers: [
+                ...defaultTestServerProviders,
+                defineProvider({ token: ZIBRI_INVOICING_PLUGIN_DI_TOKENS.OPTIONS_INPUT, useValue: invoicingOptions })
+            ]
+        });
+        invoiceRepo = inject(repositoryTokenFor(Invoice));
+        invoiceNumberService = inject(InvoiceNumberService);
     }, 15000);
 
     afterAll(async () => {
-        await container.stop();
+        await testServer.shutdown();
     });
 
     it('should generate the expected number for a company customer', async () => {

package/src/plugin/invoicing/services/invoice-number.service.ts

@@ -1,11 +1,12 @@
-import { ZIBRI_INVOICING_DI_TOKENS } from '../invoicing.tokens';
 import { InvoiceNumberServiceInterface } from './invoice-number-service.interface';
 import { Repository } from '../../../data-source/repository';
 import { Transaction } from '../../../data-source/transaction/transaction.model';
 import { InjectRepository } from '../../../di/decorators/inject-repository.decorator';
 import { Inject } from '../../../di/decorators/inject.decorator';
+import { Injectable } from '../../../di/decorators/injectable.decorator';
 import { ConflictError } from '../../../error-handling/errors/conflict.error';
 import { OmitStrict } from '../../../types/omit-strict.type';
+import { ZIBRI_INVOICING_PLUGIN_DI_TOKENS } from '../invoicing.tokens';
 import { InvoiceAddress } from '../models/invoice-address.model';
 import { Invoice } from '../models/invoice.model';
 import { type InvoicingOptions } from '../models/invoicing-options.model';
@@ -14,6 +15,7 @@ import { NumberInvoices } from '../models/number-invoices.model';
 /**
  * Default implementation of the invoice number service.
  */
+@Injectable({ register: 'onUse' })
 export class InvoiceNumberService implements InvoiceNumberServiceInterface<InvoiceAddress> {
     constructor(
         @InjectRepository(Invoice)
@@ -23,7 +25,7 @@ export class InvoiceNumberService implements InvoiceNumberServiceInterface<Invoi
             NumberInvoices,
             OmitStrict<NumberInvoices, 'id'>
         >,
-        @Inject(ZIBRI_INVOICING_DI_TOKENS.OPTIONS)
+        @Inject(ZIBRI_INVOICING_PLUGIN_DI_TOKENS.OPTIONS)
         protected readonly options: InvoicingOptions
     ) {}
 

package/src/plugin/invoicing/services/invoice-pdf.service.test.ts

@@ -1,28 +1,25 @@
 import { WriteStream } from 'node:fs';
 
 import { afterAll, beforeAll, describe, it } from '@jest/globals';
-import { PostgreSqlContainer } from '@testcontainers/postgresql';
-import { StartedTestContainer } from 'testcontainers';
 
-import { XRechnungConformanceService } from './conformance/en16931/x-rechnung-conformance.service';
-import { InvoiceCalcService } from './invoice-calc.service';
 import { InvoicePdfService } from './invoice-pdf.service';
-import { POSTGRES_TEST_IMAGE, testFileFolder } from '../../../__testing__/constants';
-import { PostgresDataSource, PostgresOptions } from '../../../data-source/data-sources/postgres-data-source.model';
-import { DataSource } from '../../../data-source/decorators/data-source.decorator';
-import { MigrationEntity } from '../../../data-source/migration/migration-entity.model';
+import { testFileFolder } from '../../../__testing__/constants';
+import { createTestDataSource, defaultTestServerEntities } from '../../../__testing__/test-server/create-test-data-source.function';
+import { defaultTestServerProviders } from '../../../__testing__/test-server/providers';
+import { StartedTestServer, startTestServer } from '../../../__testing__/test-server/start-test-server.function';
 import { Repository } from '../../../data-source/repository';
+import { repositoryTokenFor } from '../../../di/decorators/inject-repository.decorator';
+import { inject } from '../../../di/inject.function';
+import { defineProvider } from '../../../di/models/di-provider.model';
 import { PdfDocument } from '../../../document/pdf.utilities';
-import { BaseEntity } from '../../../entity/base-entity.model';
-import { formatDate } from '../../../localization/formatting/format-date.function';
-import { formatPercent } from '../../../localization/formatting/format-percent.function';
-import { formatPrice } from '../../../localization/formatting/format-price.function';
-import { Newable } from '../../../types/newable.type';
 import { OmitStrict } from '../../../types/omit-strict.type';
 import { FsUtilities } from '../../../utilities/fs.utilities';
 import { Ms } from '../../../utilities/ms';
+import { ZibriInvoicingPlugin } from '../invoicing.plugin';
+import { ZIBRI_INVOICING_PLUGIN_DI_TOKENS } from '../invoicing.tokens';
 import { Invoice } from '../models/invoice.model';
 import { InvoicingOptions } from '../models/invoicing-options.model';
+import { NumberInvoices } from '../models/number-invoices.model';
 
 const invoicingOptions: InvoicingOptions = {
     footerFontSize: 10,
@@ -78,52 +75,27 @@ const invoicingOptions: InvoicingOptions = {
     taxOffice: 'Tax Office Example City'
 };
 
-const invoiceCalcService: InvoiceCalcService = new InvoiceCalcService();
-const xRechnungConformanceService: XRechnungConformanceService = new XRechnungConformanceService(invoicingOptions, invoiceCalcService);
-const invoicePdfService: InvoicePdfService = new InvoicePdfService(
-    invoicingOptions,
-    invoiceCalcService,
-    [xRechnungConformanceService],
-    formatDate,
-    formatPrice,
-    formatPercent
-);
-
-@DataSource()
-class DbDataSource extends PostgresDataSource {
-    options: PostgresOptions = {
-        host: 'localhost',
-        username: 'postgres',
-        password: 'password',
-        database: 'db',
-        synchronize: true
-    };
-    entities: Newable<BaseEntity>[] = [Invoice, MigrationEntity];
-}
-
-let container: StartedTestContainer;
-let dataSource: DbDataSource;
+let server: StartedTestServer;
+let invoicePdfService: InvoicePdfService;
 let repo: Repository<Invoice, OmitStrict<Invoice, 'id'>>;
 
 describe('createInvoicePdf', () => {
     beforeAll(async () => {
         await FsUtilities.mkdir(testFileFolder);
-        container = await new PostgreSqlContainer(POSTGRES_TEST_IMAGE)
-            .withDatabase('db')
-            .withUsername('postgres')
-            .withPassword('password')
-            .start();
-        dataSource = new DbDataSource();
-        dataSource.options = {
-            ...dataSource.options,
-            port: container.getMappedPort(5432)
-        };
-        await dataSource.init();
-        repo = dataSource.getRepository(Invoice);
+        server = await startTestServer({
+            dataSources: [createTestDataSource({ entities: [...defaultTestServerEntities, Invoice, NumberInvoices] })],
+            plugins: [new ZibriInvoicingPlugin()],
+            providers: [
+                ...defaultTestServerProviders,
+                defineProvider({ token: ZIBRI_INVOICING_PLUGIN_DI_TOKENS.OPTIONS_INPUT, useValue: invoicingOptions })
+            ]
+        });
+        repo = inject(repositoryTokenFor(Invoice));
+        invoicePdfService = inject(InvoicePdfService);
     }, 15000);
 
     afterAll(async () => {
-        await container.stop();
+        await server.shutdown();
     });
 
     it('should create the expected result', async () => {

package/src/plugin/invoicing/services/invoice-pdf.service.ts

@@ -2,12 +2,13 @@ import { InvoiceConformanceServiceInterface, InvoiceConformance } from './confor
 import { type InvoiceCalcServiceInterface } from './invoice-calc-service.interface';
 import { InvoicePdfServiceInterface } from './invoice-pdf-service.interface';
 import { Inject } from '../../../di/decorators/inject.decorator';
+import { Injectable } from '../../../di/decorators/injectable.decorator';
 import { ZIBRI_DI_TOKENS } from '../../../di/default/zibri-di-tokens.default';
 import { PdfContentDefinition, PdfColumnDefinition, PdfDocument, PdfDocumentDefinition, PdfUtilities, PdfTableCellDefinition, PdfContentSize } from '../../../document/pdf.utilities';
 import { type FormatDateFn } from '../../../localization/formatting/format-date-fn.model';
 import { type FormatPercentFn } from '../../../localization/formatting/format-percent-fn.model';
 import { type FormatPriceFn } from '../../../localization/formatting/format-price-fn.model';
-import { ZIBRI_INVOICING_DI_TOKENS } from '../invoicing.tokens';
+import { ZIBRI_INVOICING_PLUGIN_DI_TOKENS } from '../invoicing.tokens';
 import { Invoice } from '../models/invoice.model';
 import { type InvoicingOptions } from '../models/invoicing-options.model';
 import { Vat } from '../models/vat.model';
@@ -15,6 +16,7 @@ import { Vat } from '../models/vat.model';
 /**
  * Default implementation of the invoice pdf service.
  */
+@Injectable({ register: 'onUse' })
 export class InvoicePdfService implements InvoicePdfServiceInterface<Invoice> {
     /**
      * The definition of the header of the pdf.
@@ -30,11 +32,11 @@ export class InvoicePdfService implements InvoicePdfServiceInterface<Invoice> {
     protected readonly companyLetterheadColumn: PdfColumnDefinition;
 
     constructor(
-        @Inject(ZIBRI_INVOICING_DI_TOKENS.OPTIONS)
+        @Inject(ZIBRI_INVOICING_PLUGIN_DI_TOKENS.OPTIONS)
         protected readonly options: InvoicingOptions,
-        @Inject(ZIBRI_INVOICING_DI_TOKENS.INVOICE_CALC_SERVICE)
+        @Inject(ZIBRI_INVOICING_PLUGIN_DI_TOKENS.INVOICE_CALC_SERVICE)
         private readonly invoiceCalcService: InvoiceCalcServiceInterface<Invoice>,
-        @Inject(ZIBRI_INVOICING_DI_TOKENS.INVOICE_CONFORMANCE_SERVICES)
+        @Inject(ZIBRI_INVOICING_PLUGIN_DI_TOKENS.INVOICE_CONFORMANCE_SERVICES)
         private readonly invoiceConformanceServices: InvoiceConformanceServiceInterface<Invoice>[],
         @Inject(ZIBRI_DI_TOKENS.FORMAT_DATE)
         private readonly formatDate: FormatDateFn,

package/src/plugin/mailing-list/mailing-list.controller.ts

@@ -0,0 +1,114 @@
+import { ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS } from './mailing-list.tokens';
+import { MailingListSubscriber } from './models/mailing-list-subscriber.model';
+import { MailingList } from './models/mailing-list.model';
+import { UpdateMailingListPreferences } from './models/update-mailing-list-preferences.model';
+import { type MailingListServiceInterface } from './services/mailing-list-service.interface';
+import { ZibriApplication } from '../../application';
+import { type MailingListPreferencesPageTemplate } from './models/mailing-list-preferences-page-template.model';
+import { type MailingListSubscribeSuccessPageTemplate } from './models/mailing-list-subscribe-success-page-template.model';
+import { type MailingListUnsubscribeConfirmationPageTemplate } from './models/mailing-list-unsubscribe-confirmation-page-template.model';
+import { Repository } from '../../data-source/repository';
+import { InjectRepository } from '../../di/decorators/inject-repository.decorator';
+import { Inject } from '../../di/decorators/inject.decorator';
+import { NoProviderError } from '../../di/errors/no-provider.error';
+import { inject } from '../../di/inject.function';
+import { OnAppInit } from '../../global/on-app-init.interface';
+import { Response } from '../../open-api/decorators/response.decorator';
+import { HtmlResponse } from '../../parsing/html/html-response.model';
+import { PreactUtilities } from '../../preact/preact.utilities';
+import { Body } from '../../routing/decorators/body.decorator';
+import { Controller } from '../../routing/decorators/controller.decorator';
+import { Get } from '../../routing/decorators/get.decorator';
+import { Param } from '../../routing/decorators/param.decorator';
+import { Patch } from '../../routing/decorators/patch.decorator';
+
+@Controller('/mailing-lists', { allowOrphan: true })
+export class MailingListController implements OnAppInit {
+
+    constructor(
+        @InjectRepository(MailingListSubscriber)
+        private readonly subscriberRepository: Repository<MailingListSubscriber>,
+        @InjectRepository(MailingList)
+        private readonly mailingListRepository: Repository<MailingList>,
+        @Inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.MAILING_LIST_SERVICE)
+        private readonly mailingListService: MailingListServiceInterface,
+        @Inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.PREFERENCES_PAGE_TEMPLATE)
+        private readonly PreferencesPage: MailingListPreferencesPageTemplate,
+        @Inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.UNSUBSCRIBE_CONFIRMATION_PAGE_TEMPLATE)
+        private readonly UnsubscribeConfirmationPage: MailingListUnsubscribeConfirmationPageTemplate,
+        @Inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.SUBSCRIBE_SUCCESS_PAGE_TEMPLATE)
+        private readonly SubscribeSuccessPage: MailingListSubscribeSuccessPageTemplate
+    ) {}
+
+    onAppInit(app: ZibriApplication): void {
+        if (app.options.controllers.find(c => c === MailingListController)) {
+            if (inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.PREFERENCES_PAGE_TEMPLATE) == undefined) {
+                throw new NoProviderError(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.PREFERENCES_PAGE_TEMPLATE, []);
+            }
+            if (inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.UNSUBSCRIBE_CONFIRMATION_PAGE_TEMPLATE) == undefined) {
+                throw new NoProviderError(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.UNSUBSCRIBE_CONFIRMATION_PAGE_TEMPLATE, []);
+            }
+            if (inject(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.SUBSCRIBE_SUCCESS_PAGE_TEMPLATE) == undefined) {
+                throw new NoProviderError(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS.SUBSCRIBE_SUCCESS_PAGE_TEMPLATE, []);
+            }
+        }
+    }
+
+    @Response.html()
+    @Get('/:id/subscribe/:token')
+    async subscribe(
+        @Param.path('id')
+        id: string,
+        @Param.path('token')
+        token: string
+    ): Promise<HtmlResponse> {
+        const mailingList: MailingList = await this.mailingListRepository.findById(id);
+
+        const subscriber: MailingListSubscriber = await this.mailingListService.confirmSubscribeToList(token);
+        const managePreferencesLink: string = this.mailingListService.getManagePreferencesLink(subscriber.id);
+
+        return PreactUtilities.renderResponse(this.SubscribeSuccessPage, { subscriber, mailingList, managePreferencesLink });
+    }
+
+    @Response.html()
+    @Get('/:id/unsubscribe')
+    async unsubscribe(
+        @Param.path('id')
+        id: string,
+        @Param.query('subscriberId', { type: 'string', format: 'uuid' })
+        subscriberId: string
+    ): Promise<HtmlResponse> {
+        const subscriber: MailingListSubscriber = await this.subscriberRepository.findById(subscriberId);
+        const mailingList: MailingList = await this.mailingListRepository.findById(id);
+
+        await this.mailingListService.unsubscribeFromList(id, subscriberId);
+        const managePreferencesLink: string = this.mailingListService.getManagePreferencesLink(subscriberId);
+
+        return PreactUtilities.renderResponse(this.UnsubscribeConfirmationPage, { subscriber, mailingList, managePreferencesLink });
+    }
+
+    @Response.html()
+    @Get('/preferences')
+    async preferences(
+        @Param.query('subscriberId', { type: 'string', format: 'uuid' })
+        subscriberId: string
+    ): Promise<HtmlResponse> {
+        const subscriber: MailingListSubscriber = await this.subscriberRepository.findById(subscriberId);
+        const mailingLists: MailingList[] = await this.mailingListRepository.findAll();
+        const managePreferencesApiUrl: string = this.mailingListService.getManagePreferencesLink(subscriberId);
+
+        return PreactUtilities.renderResponse(this.PreferencesPage, { subscriber, mailingLists, managePreferencesApiUrl });
+    }
+
+    @Response.empty()
+    @Patch('/preferences')
+    async changePreferences(
+        @Param.query('subscriberId', { type: 'string', format: 'uuid' })
+        subscriberId: string,
+        @Body(UpdateMailingListPreferences)
+        body: UpdateMailingListPreferences
+    ): Promise<void> {
+        const mailingLists: MailingList[] = await this.mailingListRepository.findAll({ where: { id: { oneOf: body.mailingListIds } } });
+        await this.subscriberRepository.updateById(subscriberId, { mailingLists });
+    }
+}

package/src/plugin/mailing-list/mailing-list.plugin.ts

@@ -0,0 +1,37 @@
+import { ZibriApplication } from '../../application';
+import { DiProvider } from '../../di/models/di-provider.model';
+import { DiTokenProviderRecord, providersFromTokenRecord } from '../../di/models/di-token.model';
+import { Ms } from '../../utilities/ms';
+import { validateEntitiesRegistered } from '../../utilities/validate-entities-registered.function';
+import { validateTokensRegistered } from '../../utilities/validate-tokens-registered.function';
+import { ZibriPlugin } from '../plugin.model';
+import { ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS } from './mailing-list.tokens';
+import { MailingListSubscriber } from './models/mailing-list-subscriber.model';
+import { MailingListSubscriptionConfirmationToken } from './models/mailing-list-subscription-confirmation-token.model';
+import { MailingList } from './models/mailing-list.model';
+import { MailingListService } from './services/mailing-list.service';
+
+/**
+ * Plugin that includes everything for handling mailing lists.
+ */
+export class ZibriMailingListPlugin extends ZibriPlugin {
+    private readonly defaultDiProviders: DiTokenProviderRecord<typeof ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS> = {
+        MAILING_LIST_SERVICE: { useClass: MailingListService },
+        CONFIRMATION_TOKEN_EXPIRES_IN_MS: { useFactory: () => Ms.DAY },
+        SUBSCRIBE_CONFIRMATION_EMAIL_TEMPLATE: { useFactory: () => undefined },
+        PREFERENCES_PAGE_TEMPLATE: { useFactory: () => undefined },
+        UNSUBSCRIBE_CONFIRMATION_PAGE_TEMPLATE: { useFactory: () => undefined },
+        SUBSCRIBE_SUCCESS_PAGE_TEMPLATE: { useFactory: () => undefined },
+        BASE_EMAIL_TEMPLATE: { useFactory: () => undefined }
+    };
+
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    providers: DiProvider<unknown>[] = providersFromTokenRecord(ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS, this.defaultDiProviders);
+
+    // eslint-disable-next-line jsdoc/require-jsdoc
+    validate(app: ZibriApplication): void {
+        // eslint-disable-next-line stylistic/max-len
+        validateEntitiesRegistered(this.constructor.name, app, MailingList, MailingListSubscriber, MailingListSubscriptionConfirmationToken);
+        validateTokensRegistered(this.constructor.name, ZIBRI_MAILING_LIST_PLUGIN_DI_TOKENS);
+    }
+}