@twin.org/messaging-service 0.0.2-next.5 → 0.0.3-next.1

package/dist/esm/index.mjs

@@ -1,319 +0,0 @@
-import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { Is, Guards, GeneralError, ComponentFactory } from '@twin.org/core';
-import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
-import { MessagingEmailConnectorFactory, MessagingPushNotificationsConnectorFactory, MessagingSmsConnectorFactory } from '@twin.org/messaging-models';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Call defining a template message entry.
- */
-let TemplateEntry = class TemplateEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The title.
-     */
-    title;
-    /**
-     * The content.
-     */
-    content;
-    /**
-     * The timestamp of the template entry.
-     */
-    dateCreated;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "title", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "content", void 0);
-__decorate([
-    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "dateCreated", void 0);
-TemplateEntry = __decorate([
-    entity()
-], TemplateEntry);
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing email messaging operations to a connector.
- */
-class MessagingAdminService {
-    /**
-     * Default locale for the messaging service.
-     */
-    static _DEFAULT_LOCALE = "en";
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "MessagingAdminService";
-    /**
-     * Entity storage connector used by the service.
-     * @internal
-     */
-    _entityStorageConnector;
-    /**
-     * The default locale to use for the messaging service.
-     * @internal
-     */
-    _defaultLocale;
-    /**
-     * Initial set of templates to create on startup.
-     * @internal
-     */
-    _initialTemplates;
-    /**
-     * Create a new instance of MessagingAdminService.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._entityStorageConnector = EntityStorageConnectorFactory.get(options?.templateEntryStorageConnectorType ?? "template-entry");
-        this._defaultLocale = options?.config?.defaultLocale ?? MessagingAdminService._DEFAULT_LOCALE;
-        this._initialTemplates = options?.config?.templates;
-    }
-    /**
-     * The component needs to be started when the node is initialized.
-     * @param nodeIdentity The identity of the node starting the component.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
-     */
-    async start(nodeIdentity, nodeLoggingComponentType) {
-        if (Is.arrayValue(this._initialTemplates)) {
-            for (const template of this._initialTemplates) {
-                for (const locale of Object.keys(template.content)) {
-                    await this.setTemplate(template.templateId, locale, template.title, template.content[locale]);
-                }
-            }
-        }
-    }
-    /**
-     * Create or update a template.
-     * @param templateId The id of the template.
-     * @param locale The locale of the template.
-     * @param title The title of the template.
-     * @param content The content of the template.
-     * @returns Nothing.
-     */
-    async setTemplate(templateId, locale, title, content) {
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        Guards.stringValue(this.CLASS_NAME, "title", title);
-        Guards.stringValue(this.CLASS_NAME, "content", content);
-        const templateEntry = new TemplateEntry();
-        templateEntry.id = `${templateId}:${locale}`;
-        templateEntry.dateCreated = new Date(Date.now()).toISOString();
-        templateEntry.title = title;
-        templateEntry.content = content;
-        await this._entityStorageConnector.set(templateEntry);
-    }
-    /**
-     * Get the email template by id and locale.
-     * @param templateId The id of the email template.
-     * @param locale The locale of the email template.
-     * @returns The email template.
-     */
-    async getTemplate(templateId, locale) {
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        let templateEntry;
-        try {
-            // First try to get the template for the requested locale
-            templateEntry = await this._entityStorageConnector.get(`${templateId}:${locale}`);
-        }
-        catch { }
-        // If the template is not found for the requested locale, try to get it for the default locale
-        // only if the requested locale is different from the default locale
-        if (Is.empty(templateEntry) && this._defaultLocale !== locale) {
-            try {
-                templateEntry = await this._entityStorageConnector.get(`${templateId}:${this._defaultLocale}`);
-            }
-            catch { }
-        }
-        if (Is.empty(templateEntry)) {
-            throw new GeneralError(this.CLASS_NAME, "getTemplateFailed", { templateId, locale });
-        }
-        return templateEntry;
-    }
-    /**
-     * Remove a template.
-     * @param templateId The id of the template.
-     * @param locale The locale of the template.
-     * @returns Nothing
-     */
-    async removeTemplate(templateId, locale) {
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        return this._entityStorageConnector.remove(`${templateId}:${locale}`);
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing email messaging operations to a connector.
- */
-class MessagingService {
-    /**
-     * Runtime name for the class.
-     */
-    CLASS_NAME = "MessagingService";
-    /**
-     * Emails messaging connector used by the service.
-     * @internal
-     */
-    _emailMessagingConnector;
-    /**
-     * Push notifications messaging connector used by the service.
-     * @internal
-     */
-    _pushNotificationMessagingConnector;
-    /**
-     * SMS messaging connector used by the service.
-     * @internal
-     */
-    _smsMessagingConnector;
-    /**
-     * The admin component for the messaging.
-     * @internal
-     */
-    _messagingAdminComponent;
-    /**
-     * Create a new instance of MessagingService.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        if (Is.stringValue(options?.messagingEmailConnectorType)) {
-            this._emailMessagingConnector = MessagingEmailConnectorFactory.get(options.messagingEmailConnectorType);
-        }
-        if (Is.stringValue(options?.messagingPushNotificationConnectorType)) {
-            this._pushNotificationMessagingConnector = MessagingPushNotificationsConnectorFactory.get(options.messagingPushNotificationConnectorType);
-        }
-        if (Is.stringValue(options?.messagingSmsConnectorType)) {
-            this._smsMessagingConnector = MessagingSmsConnectorFactory.get(options.messagingSmsConnectorType);
-        }
-        this._messagingAdminComponent = ComponentFactory.get(options?.messagingAdminComponentType ?? "messaging-admin");
-    }
-    /**
-     * Send a custom email.
-     * @param sender The sender email address.
-     * @param recipients An array of recipients email addresses.
-     * @param templateId The id of the email template.
-     * @param data The data to populate the email template.
-     * @param locale The locale of the email template.
-     * @returns If the email was sent successfully.
-     */
-    async sendCustomEmail(sender, recipients, templateId, data, locale) {
-        if (Is.empty(this._emailMessagingConnector)) {
-            throw new GeneralError(this.CLASS_NAME, "notConfiguredEmailMessagingConnector");
-        }
-        Guards.stringValue(this.CLASS_NAME, "sender", sender);
-        Guards.arrayValue(this.CLASS_NAME, "recipients", recipients);
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.object(this.CLASS_NAME, "data", data);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
-        const populatedTemplate = this.populateTemplate(template, data);
-        return this._emailMessagingConnector.sendCustomEmail(sender, recipients, populatedTemplate.title, populatedTemplate.content);
-    }
-    /**
-     * Registers a device to an specific app in order to send notifications to it.
-     * @param applicationId The application address.
-     * @param deviceToken The device token.
-     * @returns If the device was registered successfully.
-     */
-    async registerDevice(applicationId, deviceToken) {
-        if (Is.empty(this._pushNotificationMessagingConnector)) {
-            throw new GeneralError(this.CLASS_NAME, "notConfiguredPushNotificationMessagingConnector");
-        }
-        Guards.stringValue(this.CLASS_NAME, "applicationId", applicationId);
-        Guards.stringValue(this.CLASS_NAME, "deviceToken", deviceToken);
-        return this._pushNotificationMessagingConnector.registerDevice(applicationId, deviceToken);
-    }
-    /**
-     * Send a push notification to a device.
-     * @param deviceAddress The address of the device.
-     * @param templateId The id of the push notification template.
-     * @param data The data to populate the push notification template.
-     * @param locale The locale of the push notification template.
-     * @returns If the notification was sent successfully.
-     */
-    async sendSinglePushNotification(deviceAddress, templateId, data, locale) {
-        if (Is.empty(this._pushNotificationMessagingConnector)) {
-            throw new GeneralError(this.CLASS_NAME, "notConfiguredPushNotificationMessagingConnector");
-        }
-        Guards.stringValue(this.CLASS_NAME, "deviceAddress", deviceAddress);
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.object(this.CLASS_NAME, "data", data);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
-        const populatedTemplate = this.populateTemplate(template, data);
-        return this._pushNotificationMessagingConnector.sendSinglePushNotification(deviceAddress, populatedTemplate.title, populatedTemplate.content);
-    }
-    /**
-     * Send a SMS message to a phone number.
-     * @param phoneNumber The recipient phone number.
-     * @param templateId The id of the SMS template.
-     * @param data The data to populate the SMS template.
-     * @param locale The locale of the SMS template.
-     * @returns If the SMS was sent successfully.
-     */
-    async sendSMS(phoneNumber, templateId, data, locale) {
-        if (Is.empty(this._smsMessagingConnector)) {
-            throw new GeneralError(this.CLASS_NAME, "notConfiguredSmsMessagingConnector");
-        }
-        Guards.stringValue(this.CLASS_NAME, "phoneNumber", phoneNumber);
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.object(this.CLASS_NAME, "data", data);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
-        const populatedTemplate = this.populateTemplate(template, data);
-        return this._smsMessagingConnector.sendSMS(phoneNumber, populatedTemplate.content);
-    }
-    /**
-     * Populate the template with data.
-     * @param template The template.
-     * @param template.title The title of the template.
-     * @param template.content The content of the template.
-     * @param data The data to populate the template.
-     * @internal
-     * @returns The populated template.
-     */
-    populateTemplate(template, data) {
-        let populatedTitle = template.title;
-        let populatedContent = template.content;
-        for (const key in data) {
-            const value = data[key];
-            const placeholder = `{{${key}}}`;
-            populatedTitle = populatedTitle.replace(new RegExp(placeholder, "g"), value);
-            populatedContent = populatedContent.replace(new RegExp(placeholder, "g"), value);
-        }
-        return {
-            title: populatedTitle,
-            content: populatedContent
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialize the schema for the messaging service.
- */
-function initSchema() {
-    EntitySchemaFactory.register("TemplateEntry", () => EntitySchemaHelper.getSchema(TemplateEntry));
-}
-
-export { MessagingAdminService, MessagingService, TemplateEntry, initSchema };