zibri 2.2.0 → 2.3.0

package/src/change-sets/change-set-repository.model.ts

@@ -1,455 +0,0 @@
-import { setTimeout } from 'timers/promises';
-import { isDeepStrictEqual } from 'util';
-
-import { Repository as TORepository } from 'typeorm';
-
-import { BaseRepositoryOptions, CreateAllOptions, CreateOptions, UpdateAllOptions, UpdateByIdOptions, Where } from '../data-source';
-import { Repository } from '../data-source/repository';
-import { DeepPartial, Newable } from '../types';
-import { ChangeSet, ChangeSetEntity, ChangeSetType, CreateChangeSetData, NewChange } from './models';
-import { AuthServiceInterface, BaseUser } from '../auth';
-import { inject, repositoryTokenFor, ZIBRI_DI_TOKENS } from '../di';
-import { PropertyMetadata } from '../entity';
-import { BadRequestError } from '../error-handling';
-import { HttpRequest } from '../http';
-import { MetadataUtilities, ObjectUtilities, PromiseUtilities } from '../utilities';
-
-/**
- * The result for resetting a change set on an entity.
- */
-export type ResetChangeSetResult<T extends ChangeSetEntity> = {
-    /**
-     * The entity after the change set has been reset.
-     */
-    entity: T,
-    /**
-     * The values that were changed by resetting the change set.
-     */
-    changedValues: DeepPartial<T>
-};
-
-/**
- * A base repository that automatically handles creation of change sets.
- */
-export class ChangeSetRepository<
-    T extends ChangeSetEntity,
-    CreateData extends DeepPartial<T> = DeepPartial<T>,
-    UpdateData extends DeepPartial<T> = DeepPartial<T>
-> extends Repository<T, CreateData, UpdateData> {
-
-    /**
-     * Any keys that should be excluded from the change set.
-     */
-    protected readonly keysToExcludeFromChangeSets: (keyof T)[];
-
-    private get changeSetRepository(): Repository<ChangeSet, CreateChangeSetData> {
-        return inject(repositoryTokenFor(ChangeSet));
-    }
-
-    private get authService(): AuthServiceInterface {
-        return inject(ZIBRI_DI_TOKENS.AUTH_SERVICE);
-    }
-
-    constructor(entityClass: Newable<T>, repo: TORepository<T> | Repository<T>) {
-        super(entityClass, repo);
-
-        this.keysToExcludeFromChangeSets = ['changeSets'];
-        const props: Record<string, PropertyMetadata> = MetadataUtilities.getModelProperties(entityClass);
-        for (const [key, m] of ObjectUtilities.entries(props)) {
-            if (m.excludeFromChangeSets) {
-                this.keysToExcludeFromChangeSets.push(key as keyof T);
-            }
-        }
-    }
-
-    override async create(data: CreateData, options?: CreateOptions): Promise<T> {
-        const res: T = await super.create(data, options);
-        await this.createChangeSet(res, res, ChangeSetType.CREATE, options);
-        return res;
-    }
-
-    override async createAll(data: CreateData[], options?: CreateAllOptions): Promise<T[]> {
-        const res: T[] = await super.createAll(data, options);
-        await this.createAllChangeSets(res, res, ChangeSetType.CREATE, options);
-        return res;
-    }
-
-    override async updateById(id: T['id'], data: UpdateData, options?: UpdateByIdOptions): Promise<T> {
-        const res: T = await super.updateById(id, data, options);
-        await this.createChangeSet(res, data, ChangeSetType.UPDATE, options);
-        return res;
-    }
-
-    override async updateAll(where: Where<T>, data: UpdateData, options?: UpdateAllOptions): Promise<T[]> {
-        const res: T[] = await super.updateAll(where, data, options);
-        await this.createAllChangeSets(res, res.map(() => data), ChangeSetType.UPDATE, options);
-        return res;
-    }
-
-    /**
-     * Update an entity by id with property/value pairs in the data object.
-     * @param id - Value for the entity id.
-     * @param data - Data attributes to be updated.
-     * @param options - Options for the operations.
-     * @returns
-     * A promise that will be resolve if the operation succeeded or will be rejected if the entity was not found.
-     */
-    async updateByIdWithoutChangeSet(id: T['id'], data: UpdateData, options?: UpdateByIdOptions): Promise<T> {
-        return await super.updateById(id, data, options);
-    }
-
-    /**
-     * Updates all entities that match the provided where filter.
-     * @param where - The where filter to find the entities that should be updated.
-     * @param data - The data to update the entities with.
-     * @param options - Additional options, like a transaction.
-     * @returns An array of all the updated entities.
-     */
-    async updateAllWithoutChangeSet(where: Where<T>, data: UpdateData, options?: UpdateAllOptions): Promise<T[]> {
-        return await super.updateAll(where, data, options);
-    }
-
-    /**
-     * Resets the changes of a single change set on the given entity to the state before the change set.
-     * This DOES preserve any changes that happened after the change set.
-     * The given change set gets deleted afterwards.
-     * @param entity - The entity that should be reset.
-     * @param changeSetId - The id of the changeSet to reset.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async resetSingleChangeSet(
-        entity: T,
-        changeSetId: string,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<ResetChangeSetResult<T>> {
-        const changeSet: ChangeSet = await this.changeSetRepository.findById(changeSetId, { relations: ['changes'], ...options });
-        if (changeSet.changeSetEntityId !== entity.id) {
-            throw new BadRequestError(
-                'Could not reset the changes from the change set: The changeSet doesn\'t belong to the entity with the given id.'
-            );
-        }
-        const data: DeepPartial<T> = {} as DeepPartial<T>;
-        for (const change of changeSet.changes) {
-            const key: keyof DeepPartial<T> = change.key as keyof DeepPartial<T>;
-            data[key] = preserveCreateChangeSet && changeSet.type === ChangeSetType.CREATE
-                ? change.newValue as DeepPartial<T>[keyof DeepPartial<T>]
-                : change.previousValue as DeepPartial<T>[keyof DeepPartial<T>];
-        }
-        await this.updateByIdWithoutChangeSet(entity.id, data as UpdateData, options);
-        if (createChangeSet) {
-            await this.createChangeSet(entity, data, ChangeSetType.RESET, options);
-        }
-        if (!preserveCreateChangeSet || changeSet.type !== ChangeSetType.CREATE) {
-            await this.changeSetRepository.deleteById(changeSet.id, options);
-        }
-        return { entity: await this.findById(entity.id, options), changedValues: data };
-    }
-
-    /**
-     * Resets the changes of a single change set on the entity with the given id to the state before the oldest change set.
-     * This DOES preserve any changes that happened after the change set.
-     * The given change set gets deleted afterwards.
-     * @param id - The id of the entity that should be reset.
-     * @param changeSetId - The id of the changeSet to reset.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async resetSingleChangeSetById(
-        id: T['id'],
-        changeSetId: string,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<ResetChangeSetResult<T>> {
-        const entity: T = await this.findById(id, options);
-        return this.resetSingleChangeSet(entity, changeSetId, createChangeSet, preserveCreateChangeSet, options);
-    }
-
-    /**
-     * Rolls back all changes on the given entity that have happened since the given change set.
-     * This DOES NOT preserve any changes that happened after the change set.
-     * The given change set and any change sets after that will be deleted in the end.
-     * Calls rollbackByDate on the change set date internally.
-     * @param entity - The entity to rollback.
-     * @param changeSetId - The id of the changeSet to rollback to.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async rollbackToChangeSet(
-        entity: T,
-        changeSetId: string,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<T> {
-        const changeSet: ChangeSet = await this.changeSetRepository.findById(changeSetId, options);
-        return this.rollbackToDate(entity, changeSet.createdAt, createChangeSet, preserveCreateChangeSet, options);
-    }
-
-    /**
-     * Rolls back all changes on the entity with the given id that have happened since the given change set.
-     * This DOES NOT preserve any changes that happened after the change set.
-     * The given change set and any change sets after that will be deleted in the end.
-     * Calls rollbackByDate on the change set date internally.
-     * @param id - The id of the entity to rollback.
-     * @param changeSetId - The id of the changeSet to rollback to.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async rollbackToChangeSetById(
-        id: T['id'],
-        changeSetId: string,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<T> {
-        const changeSet: ChangeSet = await this.changeSetRepository.findById(changeSetId);
-        if (changeSet.changeSetEntityId !== id) {
-            throw new BadRequestError(
-                'Could not rollback to the given change set: The changeSet doesn\'t belong to the entity with the given id.'
-            );
-        }
-        return this.rollbackToDateById(id, changeSet.createdAt, createChangeSet, preserveCreateChangeSet, options);
-    }
-
-    /**
-     * Rolls back all changes on the given entity that have happened since the given date.
-     * This DOES NOT preserve any changes that happened after the date.
-     * Any change sets after the given date will be deleted in the end.
-     * @param entity - The entity to rollback.
-     * @param date - The date to which the rollback should happen.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async rollbackToDate(
-        entity: T,
-        date: Date,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<T> {
-        const changeSets: ChangeSet[] = await this.changeSetRepository.findAll({
-            where: { changeSetEntityId: entity.id, createdAt: { after: date } },
-            relations: ['changes'],
-            order: { createdAt: 'ASC' }
-        });
-        let data: DeepPartial<T> = {} as DeepPartial<T>;
-        for (const changeSet of changeSets) {
-            const changedValues: DeepPartial<T> = (await this.resetSingleChangeSet(
-                entity,
-                changeSet.id,
-                false,
-                preserveCreateChangeSet,
-                options
-            )).changedValues;
-            data = { ...data, ...changedValues };
-        }
-        if (createChangeSet) {
-            await this.createChangeSet(entity, data, ChangeSetType.RESET, options);
-        }
-        return await this.findById(entity.id, options);
-    }
-
-    /**
-     * Rolls back all changes on the entity with the given id that have happened since the given date.
-     * This DOES NOT preserve any changes that happened after the date.
-     * Any change sets after the given date will be deleted in the end.
-     * @param id - The id of the entity to rollback.
-     * @param date - The date to which the rollback should happen.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async rollbackToDateById(
-        id: T['id'],
-        date: Date,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<T> {
-        const entity: T = await this.findById(id, options);
-        return this.rollbackToDate(entity, date, createChangeSet, preserveCreateChangeSet, options);
-    }
-
-    /**
-     * Rolls back all changes on the entities found with the given where filter to the state of the given date.
-     * This DOES NOT preserve any changes that happened after the date.
-     * Any change sets after the given date will be deleted in the end.
-     * @param date - The date to which the rollback should happen.
-     * @param where - A filter to only rollback some entities.
-     * @param createChangeSet - Whether or not a change set should be created.
-     * @param preserveCreateChangeSet - Whether or not create change sets should be preserved.
-     * In that case the entity gets reset to the state after the create change set. Also, the create change set isn't deleted.
-     * @param options - Additional options, eg. Transaction.
-     * @returns The updated entity.
-     */
-    async rollbackAllToDate(
-        date: Date,
-        where?: Where<T>,
-        createChangeSet: boolean = true,
-        preserveCreateChangeSet: boolean = true,
-        options?: BaseRepositoryOptions
-    ): Promise<number> {
-        const entitiesToRollback: T[] = await this.findAll({ where: where, ...options });
-        await PromiseUtilities.allChunked(
-            entitiesToRollback,
-            e => this.rollbackToDate(e, date, createChangeSet, preserveCreateChangeSet, options)
-        );
-        return entitiesToRollback.length;
-    }
-
-    /**
-     * Creates a change set for the related entity id.
-     * Also generates the changes from the given data.
-     * @param entityPriorChanges - The entity for which the change set gets created.
-     * @param data - The data of the operation eg. The update body.
-     * @param type - Whether the change set is for create, update or delete.
-     * @param options - Additional options (e.g. Transaction etc.).
-     * @param force - Whether or not the creation of a change set without changes should be forced.
-     */
-    protected async createChangeSet(
-        entityPriorChanges: T,
-        data: CreateData | UpdateData | DeepPartial<T>,
-        type: ChangeSetType,
-        options?: CreateOptions,
-        force: boolean = false
-    ): Promise<void> {
-        await setTimeout(1); // TODO: Better way to guarantee a different time stamp on change sets.
-        const changeSetData: CreateChangeSetData = {
-            changeSetEntityId: entityPriorChanges.id,
-            type: type,
-            createdAt: new Date(),
-            createdBy: await this.getCreatedBy(),
-            changes: this.getChangesFromData(entityPriorChanges, data, type)
-        };
-        if (!force && !changeSetData.changes.length) {
-            return;
-        }
-        await this.changeSetRepository.create(changeSetData, options);
-    }
-
-    /**
-     * Creates all change sets for the related entities.
-     * Also generates the changes from the given data.
-     * @param entitiesPriorChanges - The entities to create the change sets for.
-     * @param data - The data of the operation eg. The update bodies.
-     * @param type - Whether the change set is for create, update or delete.
-     * @param options - Additional options (e.g. Transaction etc.).
-     * @param force - Whether or not the creation of a change set without changes should be forced.
-     */
-    protected async createAllChangeSets(
-        entitiesPriorChanges: T[],
-        data: (CreateData | UpdateData | DeepPartial<T>)[],
-        type: ChangeSetType,
-        options?: CreateOptions,
-        force: boolean = false
-    ): Promise<void> {
-        const userId: string | undefined = await this.getCreatedBy();
-        await setTimeout(1); // TODO: Better way to guarantee a different time stamp on change sets.
-        let changeSetData: CreateChangeSetData[] = entitiesPriorChanges.map((e, i) => ({
-            changeSetEntityId: e.id,
-            type: type,
-            createdAt: new Date(),
-            createdByUserId: userId,
-            changes: this.getChangesFromData(e, data[i], type)
-        }));
-        if (!force) {
-            changeSetData = changeSetData.filter(d => d.changes.length);
-        }
-        if (!force && !changeSetData.length) {
-            return;
-        }
-        await this.changeSetRepository.createAll(changeSetData, options);
-    }
-
-    /**
-     * Get all changes from the given data that should be added to a new change set.
-     * @param entityPriorChanges - The entity that has been changed.
-     * @param data - The changed data.
-     * @param type - The type of the change set to create.
-     * @returns An array of changes for the change set.
-     * Filtered by values that have actually changed and aren't in the "keysToExcludeFromChangeSets" array.
-     */
-    protected getChangesFromData(entityPriorChanges: T, data: CreateData | UpdateData | DeepPartial<T>, type: ChangeSetType): NewChange[] {
-        const res: NewChange[] = [];
-        for (const key of this.getKeysToIncludeInChangeSet(data)) {
-            const previousValue: T[keyof T] | undefined = type === ChangeSetType.CREATE ? undefined : entityPriorChanges[key];
-            if (this.hasValueChanged(previousValue, data[key] as CreateData[keyof CreateData])) {
-                res.push({
-                    key: String(key),
-                    previousValue: previousValue,
-                    newValue: data[key]
-                });
-            }
-        }
-        return res;
-    }
-
-    /**
-     * Tries to get a currently logged in user.
-     * @returns The id of the currently logged in user or undefined if that didn't work.
-     */
-    protected async getCreatedBy(): Promise<string | undefined> {
-        const currentRequest: HttpRequest = inject(ZIBRI_DI_TOKENS.CURRENT_REQUEST);
-        const user: BaseUser<string> | undefined = await this.authService.getCurrentUser(
-            currentRequest,
-            this.authService.strategies,
-            false
-        );
-        return user?.id;
-    }
-
-    /**
-     * Gets the keys of values that should be included in change sets.
-     * @param data - The new values.
-     * @returns The keys that should be included in the change set.
-     */
-    protected getKeysToIncludeInChangeSet(
-        data: CreateData | UpdateData | DeepPartial<T>
-    ): (keyof (CreateData | UpdateData | DeepPartial<T>))[] {
-        const keys: (keyof (CreateData | UpdateData | DeepPartial<T>))[] = [];
-        for (const key in data) {
-            if (!this.keysToExcludeFromChangeSets.includes(key as keyof T)) {
-                keys.push(key as keyof (CreateData | UpdateData | DeepPartial<T>));
-            }
-        }
-        return keys;
-    }
-
-    /**
-     * Checks whether or not a value has actually changed.
-     * This is used to determine whether or not a change should be created or not.
-     * @param previousValue - The value before any changes.
-     * @param newValue - The value after changes.
-     * @returns Whether or not the given values are not equal.
-     */
-    protected hasValueChanged(
-        previousValue?: T[keyof T],
-        newValue?: CreateData[keyof CreateData] | UpdateData[keyof UpdateData] | DeepPartial<T>[keyof DeepPartial<T>]
-    ): boolean {
-        return !(
-            isDeepStrictEqual(previousValue, newValue)
-            || JSON.stringify(previousValue) === JSON.stringify(newValue)
-        );
-    }
-}

package/src/change-sets/index.ts

@@ -1,3 +0,0 @@
-export * from './models';
-export * from './change-set-repository.model';
-export * from './soft-delete-repository';

package/src/change-sets/models/index.ts

@@ -1,12 +0,0 @@
-export * from './change-set-entity.model';
-export * from './change-set-type.enum';
-export * from './change-set.model';
-export * from './change.model';
-export * from './soft-delete-entity.model';
-export * from './soft-delete-find-all-options.model';
-export * from './soft-delete-find-by-id-options.model';
-export * from './soft-delete-find-one-options.model';
-export * from './soft-delete-where.model';
-export * from './soft-delete-find-all-paginated-options.model';
-export * from './soft-delete-update-all-options.model';
-export * from './soft-delete-update-by-id-options.model';

package/src/cron/index.ts

@@ -1,4 +0,0 @@
-export * from './cron-job-entity.model';
-export * from './cron-job.model';
-export * from './cron-service.interface';
-export * from './cron.service';

package/src/data-source/data-sources/index.ts

@@ -1,2 +0,0 @@
-export * from './data-source.interface';
-export * from './postgres-data-source.model';

package/src/data-source/decorators/index.ts

@@ -1 +0,0 @@
-export * from './data-source.decorator';

package/src/data-source/index.ts

@@ -1,10 +0,0 @@
-export * from './data-source.service';
-export * from './data-source-service.interface';
-export * from './decorators';
-export * from './data-sources';
-export * from './decorators';
-export * from './repository';
-export * from './transaction';
-export * from './models';
-export * from './migration';
-export * from './query-failed.error';

package/src/data-source/migration/index.ts

@@ -1,2 +0,0 @@
-export * from './migration.model';
-export * from './migration-entity.model';

package/src/data-source/models/index.ts

@@ -1,4 +0,0 @@
-export * from './data-source-options.model';
-export * from './column-type.model';
-export * from './options';
-export * from './where';

package/src/data-source/models/options/index.ts

@@ -1,12 +0,0 @@
-export * from './base-repository-options.model';
-export * from './create-options.model';
-export * from './create-all-options.model';
-export * from './delete-all-options.model';
-export * from './delete-by-id-options.model';
-export * from './find-all-options.model';
-export * from './find-all-paginated-options.model';
-export * from './find-by-id-options.model';
-export * from './find-one-options.model';
-export * from './update-all-options.model';
-export * from './update-by-id-options.model';
-export * from './count-options.model';

package/src/data-source/models/where/index.ts

@@ -1,7 +0,0 @@
-export * from './where-filter.model';
-export * from './array-where-filter.model';
-export * from './boolean-where-filter.model';
-export * from './date-where-filter.model';
-export * from './number-where-filter.model';
-export * from './object-where-filter.model';
-export * from './string-where-filter.model';

package/src/data-source/transaction/index.ts

@@ -1 +0,0 @@
-export * from './transaction.model';

package/src/di/decorators/index.ts

@@ -1,3 +0,0 @@
-export * from './injectable.decorator';
-export * from './inject.decorator';
-export * from './inject-repository.decorator';

package/src/di/default/index.ts

@@ -1 +0,0 @@
-export * from './zibri-di-tokens.default';

package/src/di/errors/index.ts

@@ -1,2 +0,0 @@
-export * from './get-dependency-stack-trace.function';
-export * from './no-provider.error';

package/src/di/index.ts

@@ -1,5 +0,0 @@
-export * from './decorators';
-export * from './models';
-export * from './default';
-export * from './inject.function';
-export * from './errors';

package/src/di/models/index.ts

@@ -1,3 +0,0 @@
-export * from './di-token.model';
-export * from './di-provider.model';
-export * from './injection-token.model';

package/src/document/index.ts

@@ -1,3 +0,0 @@
-
-export * from './pdf.utilities';
-export * from './xml.utilities';

package/src/email/index.ts

@@ -1,4 +0,0 @@
-export * from './models';
-export * from './email-service.interface';
-export * from './email.service';
-export * from './mailing-list';

package/src/email/mailing-list/index.ts

@@ -1,3 +0,0 @@
-export * from './mailing-list-service.interface';
-export * from './mailing-list.service';
-export * from './models';

package/src/email/mailing-list/mailing-list-service.interface.ts

@@ -1,72 +0,0 @@
-import { MailingListSubscriber } from './models';
-import { ZibriApplication } from '../../application';
-import { OmitClass } from '../../entity';
-import { BaseEmailTemplateData } from '../../handlebars';
-import { Route } from '../../routing';
-import { OmitStrict } from '../../types';
-import { QueueEmailData } from '../models';
-
-/**
- * The data required to queue a new mailing list email.
- */
-export type MailingListQueueEmailData<T extends Record<string, unknown>> = OmitStrict<
-    QueueEmailData,
-    'bcc' | 'cc' | 'recipients' | 'userId' | 'priority' | 'html'
-> & {
-    /**
-     * The template string in handlebars format.
-     */
-    templateString: string,
-    /**
-     * The data to use inside the template string.
-     */
-    templateData: T
-};
-
-/**
- * The required data to create a new mailing list subscriber.
- */
-export class MailingListSubscriberCreateData extends OmitClass(MailingListSubscriber, ['id']) {}
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type BaseMailingListEmailTemplateData = OmitStrict<BaseEmailTemplateData, 'base'> & {
-    /**
-     * The base data shared by all mailing list email templates.
-     */
-    base: OmitStrict<BaseEmailTemplateData['base'], 'mailingListData'>
-};
-
-/**
- * Interface for a mailing list service.
- */
-export interface MailingListServiceInterface {
-    /**
-     * The base route for everything regarding mailing lists.
-     */
-    readonly mailingListBaseRoute: Route,
-    /**
-     * Attaches the service to the Zibri application.
-     */
-    attachTo: (app: ZibriApplication) => void,
-    /**
-     * Queues a new email for the mailing list with the provided id.
-     */
-    queueEmailForList: <T extends BaseMailingListEmailTemplateData>(listId: string, data: MailingListQueueEmailData<T>) => Promise<void>,
-    /**
-     * Requests for a new subscriber to the be added to the mailing list with the provided id.
-     * This should initialize a two step process required by the GDPR.
-     */
-    requestSubscribeToList: <T extends BaseMailingListEmailTemplateData>(
-        listId: string,
-        subscriber: MailingListSubscriberCreateData,
-        emailData: MailingListQueueEmailData<T>
-    ) => Promise<void>,
-    /**
-     * Confirms that a new subscriber is added to the mailing list.
-     */
-    confirmSubscribeToList: (confirmationTokenValue: string) => Promise<void>,
-    /**
-     * Removes a subscriber with the given id from the mailing list with the provided id.
-     */
-    unsubscribeFromList: (listId: string, subscriberId: string) => Promise<void>
-}