@twin.org/messaging-connector-entity-storage 0.0.2-next.6 → 0.0.3-next.2

package/dist/esm/index.mjs

@@ -1,523 +0,0 @@
-import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { ComponentFactory, Guards, Converter, RandomHelper, GeneralError } from '@twin.org/core';
-import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
-
-/**
- * Call defining an email entry.
- */
-let EmailEntry = class EmailEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The sender email address.
-     */
-    sender;
-    /**
-     * The recipient email addresses.
-     */
-    recipients;
-    /**
-     * The timestamp of the email entry.
-     */
-    ts;
-    /**
-     * The message.
-     */
-    message;
-    /**
-     * The subject.
-     */
-    subject;
-    /**
-     * The status.
-     */
-    status;
-    /**
-     * The error.
-     */
-    error;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], EmailEntry.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], EmailEntry.prototype, "sender", void 0);
-__decorate([
-    property({ type: "array", itemType: "string" }),
-    __metadata("design:type", Array)
-], EmailEntry.prototype, "recipients", void 0);
-__decorate([
-    property({ type: "integer", format: "uint64", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", Number)
-], EmailEntry.prototype, "ts", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], EmailEntry.prototype, "message", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], EmailEntry.prototype, "subject", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], EmailEntry.prototype, "status", void 0);
-__decorate([
-    property({ type: "object", optional: true }),
-    __metadata("design:type", Object)
-], EmailEntry.prototype, "error", void 0);
-EmailEntry = __decorate([
-    entity()
-], EmailEntry);
-
-/**
- * Call defining an push notification device entry.
- */
-let PushNotificationDeviceEntry = class PushNotificationDeviceEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The applicationId.
-     */
-    applicationId;
-    /**
-     * The device token.
-     */
-    deviceToken;
-    /**
-     * The timestamp of the push notification device entry.
-     */
-    ts;
-    /**
-     * The status.
-     */
-    status;
-    /**
-     * The error.
-     */
-    error;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "applicationId", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "deviceToken", void 0);
-__decorate([
-    property({ type: "integer", format: "uint64", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", Number)
-], PushNotificationDeviceEntry.prototype, "ts", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationDeviceEntry.prototype, "status", void 0);
-__decorate([
-    property({ type: "object", optional: true }),
-    __metadata("design:type", Object)
-], PushNotificationDeviceEntry.prototype, "error", void 0);
-PushNotificationDeviceEntry = __decorate([
-    entity()
-], PushNotificationDeviceEntry);
-
-/**
- * Call defining an push notification message entry.
- */
-let PushNotificationMessageEntry = class PushNotificationMessageEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The device address.
-     */
-    deviceAddress;
-    /**
-     * The title.
-     */
-    title;
-    /**
-     * The message.
-     */
-    message;
-    /**
-     * The timestamp of the push notification entry.
-     */
-    ts;
-    /**
-     * The status.
-     */
-    status;
-    /**
-     * The error.
-     */
-    error;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "deviceAddress", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "title", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "message", void 0);
-__decorate([
-    property({ type: "integer", format: "uint64", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", Number)
-], PushNotificationMessageEntry.prototype, "ts", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], PushNotificationMessageEntry.prototype, "status", void 0);
-__decorate([
-    property({ type: "object", optional: true }),
-    __metadata("design:type", Object)
-], PushNotificationMessageEntry.prototype, "error", void 0);
-PushNotificationMessageEntry = __decorate([
-    entity()
-], PushNotificationMessageEntry);
-
-/**
- * Call defining an sms entry.
- */
-let SmsEntry = class SmsEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The phone number to deliver the message.
-     */
-    phoneNumber;
-    /**
-     * The timestamp of the sms entry.
-     */
-    ts;
-    /**
-     * The message.
-     */
-    message;
-    /**
-     * The status.
-     */
-    status;
-    /**
-     * The error.
-     */
-    error;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], SmsEntry.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], SmsEntry.prototype, "phoneNumber", void 0);
-__decorate([
-    property({ type: "integer", format: "uint64", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", Number)
-], SmsEntry.prototype, "ts", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], SmsEntry.prototype, "message", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], SmsEntry.prototype, "status", void 0);
-__decorate([
-    property({ type: "object", optional: true }),
-    __metadata("design:type", Object)
-], SmsEntry.prototype, "error", void 0);
-SmsEntry = __decorate([
-    entity()
-], SmsEntry);
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for connecting to the email messaging operations of the Entity Storage.
- */
-class EntityStorageMessagingEmailConnector {
-    /**
-     * The namespace for the connector.
-     */
-    static NAMESPACE = "entity-storage";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EntityStorageMessagingEmailConnector";
-    /**
-     * The logging component.
-     * @internal
-     */
-    _logging;
-    /**
-     * The entity storage for the emails entries.
-     * @internal
-     */
-    _messagingEmailEntryStorage;
-    /**
-     * Create a new instance of EntityStorageMessagingEmailConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
-        this._messagingEmailEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEmailEntryStorageConnectorType ?? "email-entry");
-    }
-    /**
-     * Store a custom email using Entity Storage.
-     * @param sender The sender email address.
-     * @param recipients An array of recipients email addresses.
-     * @param subject The subject of the email.
-     * @param content The html content of the email.
-     * @returns True if the email was send successfully, otherwise undefined.
-     */
-    async sendCustomEmail(sender, recipients, subject, content) {
-        Guards.stringValue(EntityStorageMessagingEmailConnector.CLASS_NAME, "sender", sender);
-        Guards.arrayValue(EntityStorageMessagingEmailConnector.CLASS_NAME, "recipients", recipients);
-        Guards.stringValue(EntityStorageMessagingEmailConnector.CLASS_NAME, "subject", subject);
-        Guards.stringValue(EntityStorageMessagingEmailConnector.CLASS_NAME, "content", content);
-        try {
-            await this._logging?.log({
-                level: "info",
-                source: EntityStorageMessagingEmailConnector.CLASS_NAME,
-                ts: Date.now(),
-                message: "emailSending",
-                data: {
-                    type: "Custom Email"
-                }
-            });
-            const id = Converter.bytesToHex(RandomHelper.generate(32));
-            const entity = {
-                id,
-                sender,
-                recipients,
-                ts: Date.now(),
-                message: content,
-                subject,
-                status: "pending"
-            };
-            await this._messagingEmailEntryStorage.set(entity);
-            return true;
-        }
-        catch (err) {
-            throw new GeneralError(EntityStorageMessagingEmailConnector.CLASS_NAME, "sendCustomEmailFailed", undefined, err);
-        }
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for connecting to the push notifications messaging operations of the Entity Storage.
- */
-class EntityStorageMessagingPushNotificationConnector {
-    /**
-     * The namespace for the connector.
-     */
-    static NAMESPACE = "entity-storage";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EntityStorageMessagingPushNotificationConnector";
-    /**
-     * The logging component.
-     * @internal
-     */
-    _logging;
-    /**
-     * The entity storage for the push notifications device entries.
-     * @internal
-     */
-    _messagingDeviceEntryStorage;
-    /**
-     * The entity storage for the push notifications message entries.
-     * @internal
-     */
-    _messagingMessageEntryStorage;
-    /**
-     * Create a new instance of EntityStorageMessagingPushNotificationConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
-        this._messagingDeviceEntryStorage = EntityStorageConnectorFactory.get(options?.messagingDeviceEntryStorageConnectorType ?? "push-notification-device-entry");
-        this._messagingMessageEntryStorage = EntityStorageConnectorFactory.get(options?.messagingMessageEntryStorageConnectorType ?? "push-notification-message-entry");
-    }
-    /**
-     * 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) {
-        Guards.stringValue(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "applicationId", applicationId);
-        Guards.stringValue(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "deviceToken", deviceToken);
-        try {
-            await this._logging?.log({
-                level: "info",
-                source: EntityStorageMessagingPushNotificationConnector.CLASS_NAME,
-                ts: Date.now(),
-                message: "deviceRegistering"
-            });
-            const id = Converter.bytesToHex(RandomHelper.generate(32));
-            const entity = {
-                id,
-                applicationId,
-                deviceToken,
-                ts: Date.now(),
-                status: "pending"
-            };
-            await this._messagingDeviceEntryStorage.set(entity);
-            return id;
-        }
-        catch (err) {
-            throw new GeneralError(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "deviceTokenRegisterFailed", { property: "applicationId", value: applicationId }, err);
-        }
-    }
-    /**
-     * Send a push notification to a device.
-     * @param deviceAddress The address of the device.
-     * @param title The title of the notification.
-     * @param message The message to send.
-     * @returns If the notification was sent successfully.
-     */
-    async sendSinglePushNotification(deviceAddress, title, message) {
-        Guards.stringValue(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "deviceAddress", deviceAddress);
-        Guards.stringValue(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "title", title);
-        Guards.stringValue(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "message", message);
-        try {
-            await this._logging?.log({
-                level: "info",
-                source: EntityStorageMessagingPushNotificationConnector.CLASS_NAME,
-                ts: Date.now(),
-                message: "pushNotificationSending"
-            });
-            const id = Converter.bytesToHex(RandomHelper.generate(32));
-            const entity = {
-                id,
-                deviceAddress,
-                title,
-                message,
-                ts: Date.now(),
-                status: "pending"
-            };
-            await this._messagingMessageEntryStorage.set(entity);
-            return true;
-        }
-        catch (err) {
-            throw new GeneralError(EntityStorageMessagingPushNotificationConnector.CLASS_NAME, "sendPushNotificationFailed", { value: deviceAddress }, err);
-        }
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Class for connecting to the SMS messaging operations of the Entity Storage.
- */
-class EntityStorageMessagingSmsConnector {
-    /**
-     * The namespace for the connector.
-     */
-    static NAMESPACE = "entity-storage";
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "EntityStorageMessagingSmsConnector";
-    /**
-     * The logging component.
-     * @internal
-     */
-    _logging;
-    /**
-     * The entity storage for the sms entries.
-     * @internal
-     */
-    _messagingSmsEntryStorage;
-    /**
-     * Create a new instance of EntityStorageMessagingSmsConnector.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._logging = ComponentFactory.getIfExists(options?.loggingComponentType ?? "logging");
-        this._messagingSmsEntryStorage = EntityStorageConnectorFactory.get(options?.messagingSmsEntryStorageConnectorType ?? "sms-entry");
-    }
-    /**
-     * Send a SMS message to a phone number.
-     * @param phoneNumber The recipient phone number.
-     * @param message The message to send.
-     * @returns If the SMS was sent successfully.
-     */
-    async sendSMS(phoneNumber, message) {
-        Guards.stringValue(EntityStorageMessagingSmsConnector.CLASS_NAME, "phoneNumber", phoneNumber);
-        Guards.stringValue(EntityStorageMessagingSmsConnector.CLASS_NAME, "message", message);
-        try {
-            await this._logging?.log({
-                level: "info",
-                source: EntityStorageMessagingSmsConnector.CLASS_NAME,
-                ts: Date.now(),
-                message: "smsSending"
-            });
-            const id = Converter.bytesToHex(RandomHelper.generate(32));
-            const entity = {
-                id,
-                phoneNumber,
-                message,
-                ts: Date.now(),
-                status: "sent"
-            };
-            await this._messagingSmsEntryStorage.set(entity);
-            return true;
-        }
-        catch (err) {
-            throw new GeneralError(EntityStorageMessagingSmsConnector.CLASS_NAME, "sendSMSFailed", undefined, err);
-        }
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialize the schema for the messaging connector entity storage.
- * @param options The options for the initialisation.
- * @param options.email Should we register email schemas.
- * @param options.sms Should we register sms schemas.
- * @param options.pushNotification Should we register push notification schemas.
- */
-function initSchema(options) {
-    if (options?.email ?? true) {
-        EntitySchemaFactory.register("EmailEntry", () => EntitySchemaHelper.getSchema(EmailEntry));
-    }
-    if (options?.pushNotification ?? true) {
-        EntitySchemaFactory.register("PushNotificationDeviceEntry", () => EntitySchemaHelper.getSchema(PushNotificationDeviceEntry));
-        EntitySchemaFactory.register("PushNotificationMessageEntry", () => EntitySchemaHelper.getSchema(PushNotificationMessageEntry));
-    }
-    if (options?.sms ?? true) {
-        EntitySchemaFactory.register("SmsEntry", () => EntitySchemaHelper.getSchema(SmsEntry));
-    }
-}
-
-export { EmailEntry, EntityStorageMessagingEmailConnector, EntityStorageMessagingPushNotificationConnector, EntityStorageMessagingSmsConnector, PushNotificationDeviceEntry, PushNotificationMessageEntry, SmsEntry, initSchema };