zibri 2.2.1 → 2.4.0

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

@@ -1,72 +0,0 @@
-import { ZibriApplication } from '../../application';
-import { MailingListSubscriber } from './models/mailing-list-subscriber.model';
-import { OmitClass } from '../../entity/omit-class.model';
-import { BaseEmailTemplateData } from '../../handlebars/render-template.function';
-import { Route } from '../../routing/controller-route-configuration.model';
-import { OmitStrict } from '../../types/omit-strict.type';
-import { QueueEmailData } from '../models/create-email-data.model';
-
-/**
- * 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>
-}

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

@@ -1,175 +0,0 @@
-import { randomBytes } from 'crypto';
-
-import { MailingListSubscriberCreateData, MailingListQueueEmailData, MailingListServiceInterface, BaseMailingListEmailTemplateData } from './mailing-list-service.interface';
-import { AssetServiceInterface } from '../../assets/asset-service.interface';
-import { Repository } from '../../data-source/repository';
-import { repositoryTokenFor } from '../../di/decorators/inject-repository.decorator';
-import { ZIBRI_DI_TOKENS } from '../../di/default/zibri-di-tokens.default';
-import { inject } from '../../di/inject.function';
-import { GlobalRegistry } from '../../global/global-registry';
-import { BaseEmailTemplateData, renderTemplateString, renderTemplate } from '../../handlebars/render-template.function';
-import { Route } from '../../routing/controller-route-configuration.model';
-import { FsUtilities, Path } from '../../utilities/fs.utilities';
-import { PromiseUtilities } from '../../utilities/promise.utilities';
-import { validateEntitiesRegistered } from '../../utilities/validate-entities-registered.function';
-import { EmailServiceInterface } from '../email-service.interface';
-import { EmailPriority } from '../models/email-priority.enum';
-import { MailingListSubscriber } from './models/mailing-list-subscriber.model';
-import { MailingListSubscriptionConfirmationToken, MailingListSubscriptionConfirmationTokenCreateData } from './models/mailing-list-subscription-confirmation-token.model';
-import { MailingList } from './models/mailing-list.model';
-
-/**
- * Default mailing list service implementation of Zibri.
- */
-export class MailingListService implements MailingListServiceInterface {
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    readonly mailingListBaseRoute: Route = '/mailing-lists';
-    /**
-     * The email service.
-     */
-    protected readonly emailService: EmailServiceInterface;
-    /**
-     * The asset service.
-     */
-    protected readonly assetService: AssetServiceInterface;
-    /**
-     * The time in ms after which the token to confirm a new mailing list subscription expires.
-     */
-    protected readonly mailingListSubscriptionConfirmationTokenExpiresInMs: number;
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    protected get mailingListRepository(): Repository<MailingList> {
-        return inject(repositoryTokenFor(MailingList));
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    protected get subscriberRepository(): Repository<MailingListSubscriber, MailingListSubscriberCreateData> {
-        return inject(repositoryTokenFor(MailingListSubscriber));
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    protected get confirmationTokenRepository(): Repository<
-        MailingListSubscriptionConfirmationToken,
-        MailingListSubscriptionConfirmationTokenCreateData
-    > {
-        return inject(repositoryTokenFor(MailingListSubscriptionConfirmationToken));
-    }
-
-    constructor() {
-        this.emailService = inject(ZIBRI_DI_TOKENS.EMAIL_SERVICE);
-        this.assetService = inject(ZIBRI_DI_TOKENS.ASSET_SERVICE);
-        this.mailingListSubscriptionConfirmationTokenExpiresInMs = inject(
-            ZIBRI_DI_TOKENS.MAILING_LIST_SUBSCRIPTION_CONFIRMATION_TOKEN_EXPIRES_IN_MS
-        );
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    attachTo(): void {
-        validateEntitiesRegistered(this.constructor.name, MailingList, MailingListSubscriber, MailingListSubscriptionConfirmationToken);
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    async queueEmailForList<T extends BaseMailingListEmailTemplateData>(listId: string, data: MailingListQueueEmailData<T>): Promise<void> {
-        const list: MailingList = await this.mailingListRepository.findById(listId);
-        await PromiseUtilities.allChunked(
-            list.subscribers,
-            async s => {
-                const base: BaseEmailTemplateData['base'] = {
-                    ...data.templateData.base,
-                    baseUrl: GlobalRegistry.getAppData('baseUrl') ?? '',
-                    mailingListData: {
-                        list,
-                        subscriber: s,
-                        mailingListBaseRoute: this.mailingListBaseRoute
-                    }
-                };
-                const content: string = renderTemplateString(data.templateString, {
-                    ...data.templateData,
-                    base
-                });
-                const html: string = await renderTemplate(
-                    FsUtilities.getPath(this.assetService.emailTemplatePath, 'base-email.hbs') as `${Path}.hbs`,
-                    { content, base }
-                );
-                await this.emailService.queue({
-                    html,
-                    priority: EmailPriority.LOW,
-                    recipients: [s.email],
-                    persist: false,
-                    ...data
-                });
-            }
-        );
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    async requestSubscribeToList<T extends BaseMailingListEmailTemplateData>(
-        listId: string,
-        subscriber: MailingListSubscriberCreateData,
-        emailData: MailingListQueueEmailData<T>
-    ): Promise<void> {
-
-        const foundSubscriber: MailingListSubscriber | undefined = await this.subscriberRepository.findOne(
-            { where: { email: subscriber.email } },
-            false
-        );
-        if (foundSubscriber) {
-            const list: MailingList = await this.mailingListRepository.findById(listId);
-            await this.subscriberRepository.updateById(foundSubscriber.id, { mailingLists: [...foundSubscriber.mailingLists, list] });
-            return;
-        }
-
-        await this.confirmationTokenRepository.create({
-            email: subscriber.email,
-            value: randomBytes(16).toString('hex'),
-            expirationDate: new Date(Date.now() + this.mailingListSubscriptionConfirmationTokenExpiresInMs),
-            name: subscriber.name,
-            listId
-        });
-
-        const content: string = renderTemplateString(emailData.templateString, {
-            ...emailData.templateData,
-            base: emailData.templateData.base
-        });
-        const html: string = await renderTemplate(
-            FsUtilities.getPath(this.assetService.emailTemplatePath, 'base-email.hbs') as `${Path}.hbs`,
-            { content, base: emailData.templateData.base }
-        );
-        await this.emailService.queue({ ...emailData, html, recipients: [subscriber.email] });
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    async confirmSubscribeToList(confirmationTokenValue: string): Promise<void> {
-        const foundToken: MailingListSubscriptionConfirmationToken = await this.confirmationTokenRepository.findOne(
-            { where: { value: confirmationTokenValue } }
-        );
-        const mailingList: MailingList = await this.mailingListRepository.findById(foundToken.listId);
-        const foundSubscriber: MailingListSubscriber | undefined = await this.subscriberRepository.findOne(
-            { where: { email: foundToken.email }, relations: ['mailingLists'] },
-            false
-        );
-        if (!foundSubscriber) {
-            await this.subscriberRepository.create({ email: foundToken.email, name: foundToken.name, mailingLists: [mailingList] });
-            return;
-        }
-        if (foundSubscriber.mailingLists.find(l => l.id === mailingList.id)) {
-            // already subscribed, do nothing
-            return;
-        }
-        await this.subscriberRepository.updateById(foundSubscriber.id, { mailingLists: [...foundSubscriber.mailingLists, mailingList] });
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    async unsubscribeFromList(listId: string, subscriberId: string): Promise<void> {
-        await this.mailingListRepository.findById(listId);
-        const foundSubscriber: MailingListSubscriber = await this.subscriberRepository.findOne(
-            { where: { id: subscriberId }, relations: ['mailingLists'] }
-        );
-        if (!foundSubscriber.mailingLists.find(l => l.id === listId)) {
-            // Is not subscribed to the mailing list.
-            return;
-        }
-        const newMailingLists: MailingList[] = foundSubscriber.mailingLists.filter(l => l.id !== listId);
-        await this.subscriberRepository.updateById(subscriberId, { mailingLists: newMailingLists });
-    }
-}

package/src/handlebars/render-template.function.ts

@@ -1,118 +0,0 @@
-import { HandlebarUtilities } from './handlebar.utilities';
-import { AssetServiceInterface } from '../assets/asset-service.interface';
-import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
-import { inject } from '../di/inject.function';
-import { MailingListSubscriber } from '../email/mailing-list/models/mailing-list-subscriber.model';
-import { MailingList } from '../email/mailing-list/models/mailing-list.model';
-import { GlobalRegistry } from '../global/global-registry';
-import { OmitStrict } from '../types/omit-strict.type';
-import { FsUtilities, Path } from '../utilities/fs.utilities';
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type BaseEmailTemplateData = {
-    /**
-     * The base data shared by all email templates.
-     */
-    base: {
-        /**
-         * The title of the email.
-         */
-        title: string,
-        /**
-         * The base url of the app.
-         */
-        baseUrl: string,
-        /**
-         * Data about the mailing list that this email belongs to. If any.
-         */
-        mailingListData?: {
-            /**
-             * The base route for everything regarding mailing lists.
-             */
-            mailingListBaseRoute: string,
-            /**
-             * The subscriber if the email belongs to a mailing list.
-             */
-            subscriber: MailingListSubscriber,
-            /**
-             * The mailing list that the email belongs to, if any.
-             */
-            list: MailingList
-        }
-    }
-};
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type BaseEmailTemplateDataInput = {
-    /**
-     * The base data shared by all email templates.
-     */
-    base: OmitStrict<BaseEmailTemplateData['base'], 'baseUrl'>
-};
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type BasePageTemplateData = {
-    /**
-     * The base data shared by all page templates.
-     */
-    base: {
-        /**
-         * The base url of the app.
-         */
-        baseUrl: string,
-        /**
-         * The title of the page.
-         */
-        title: string
-    }
-};
-
-// eslint-disable-next-line jsdoc/require-jsdoc
-export type BasePageTemplateDataInput = {
-    /**
-     * The base data shared by all page templates.
-     */
-    base: OmitStrict<BasePageTemplateData['base'], 'baseUrl'>
-};
-
-/**
- * Renders the email template with the given name.
- * @param templateName - The name of the template.
- * @param data - The data to fill into the template.
- * @returns The rendered html.
- */
-export async function renderEmailTemplate<T extends BaseEmailTemplateDataInput>(templateName: `${string}.hbs`, data: T): Promise<string> {
-    (data.base as BasePageTemplateData['base']).baseUrl = GlobalRegistry.getAppData('baseUrl') ?? '';
-    const assetService: AssetServiceInterface = inject(ZIBRI_DI_TOKENS.ASSET_SERVICE);
-    const content: string = await renderTemplate(FsUtilities.getPath(assetService.emailTemplatePath, templateName) as `${Path}.hbs`, data);
-    return await renderTemplate(
-        FsUtilities.getPath(assetService.emailTemplatePath, 'base-email.hbs') as `${Path}.hbs`,
-        { content, base: data.base }
-    );
-}
-
-/**
- * Renders the template at the given path with the given data.
- * @param path - The path of the handlebars template file.
- * @param data - The data to fill into the template.
- * @returns The rendered html string.
- */
-export async function renderTemplate<T extends Record<string, unknown>>(path: `${Path}.hbs`, data: T): Promise<string> {
-    const source: string = await FsUtilities.readFile(path as Path);
-    return renderTemplateString(source, data);
-}
-
-/**
- * Renders the given handlebars template string as html, using the provided data as variables.
- * @param templateString - The handlebars template string.
- * @param data - The data to use inside the template.
- * @returns The rendered html content.
- */
-export function renderTemplateString<T extends Record<string, unknown>>(
-    templateString: string,
-    data: T
-): string {
-    const template: HandlebarsTemplateDelegate<T> = HandlebarUtilities.render(templateString);
-    const html: string = template(data);
-    return html;
-}

package/src/metrics/scrape-metrics.cron-job.ts

@@ -1,31 +0,0 @@
-import { MetricsServiceInterface } from './metrics-service.interface';
-import { CronJob, InitialCronConfig } from '../cron/cron-job.model';
-import { Injectable } from '../di/decorators/injectable.decorator';
-import { ZIBRI_DI_TOKENS } from '../di/default/zibri-di-tokens.default';
-import { inject } from '../di/inject.function';
-
-/**
- * CronJob that cleans up the temp folder of the form data body parser.
- */
-@Injectable()
-export class ScrapeMetricsCronJob extends CronJob {
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    initialConfig: InitialCronConfig = {
-        name: 'Scrape Metrics',
-        cron: '*/5 * * * * *',
-        runOnInit: false
-    };
-
-    private readonly metricsService: MetricsServiceInterface;
-
-    constructor() {
-        super();
-        this.metricsService = inject(ZIBRI_DI_TOKENS.METRICS_SERVICE);
-    }
-
-    // eslint-disable-next-line jsdoc/require-jsdoc
-    async onTick(): Promise<void> {
-        await this.logger.debug('scrapes metrics');
-        await this.metricsService.collect();
-    }
-}

package/src/routing/request.context.ts

@@ -1,38 +0,0 @@
-import { AsyncLocalStorage } from 'async_hooks';
-
-import { HttpRequest } from '../http/http-request.model';
-
-/**
- * The data stored in async local storage.
- */
-type AslData = {
-    /**
-     * The current http request.
-     */
-    request: HttpRequest
-};
-
-const als: AsyncLocalStorage<AslData> = new AsyncLocalStorage<AslData>();
-
-/**
- * Runs the given function with the request saved in async local storage.
- * @param req - The request.
- * @param fn - The function to run.
- * @returns The result of the function.
- */
-export function runWithRequest<T>(req: HttpRequest, fn: () => T): T {
-    return als.run({ request: req }, fn);
-}
-
-/**
- * Resolves the currently active request from the async local storage.
- * @returns The currently active http request.
- * @throws When the async local storage store has not been initialized yet.
- */
-export function getCurrentRequest(): HttpRequest {
-    const store: AslData | undefined = als.getStore();
-    if (!store) {
-        throw new Error('No request in context');
-    }
-    return store.request;
-}