@twin.org/messaging-connector-entity-storage 0.0.1-next.2

package/dist/esm/index.mjs

@@ -0,0 +1,252 @@
+import { Is, Guards, Converter, RandomHelper, GeneralError } from '@twin.org/core';
+import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
+import { LoggingConnectorFactory } from '@twin.org/logging-models';
+
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Class for connecting to the email messaging operations of the Entity Storage.
+ */
+class EntityStorageMessagingEmailConnector {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "EntityStorageMessagingEmailConnector";
+    /**
+     * The logging connector.
+     * @internal
+     */
+    _logging;
+    /**
+     * The entity storage for the emails entries.
+     * @internal
+     */
+    _messagingEntryStorage;
+    /**
+     * Create a new instance of EntityStorageMessagingEmailConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.messagingEntryStorageConnectorType The type of entity storage connector to use for the email entries.
+     * @param options.config The configuration for the email connector.
+     */
+    constructor(options) {
+        if (Is.stringValue(options?.loggingConnectorType)) {
+            this._logging = LoggingConnectorFactory.get(options.loggingConnectorType);
+        }
+        this._messagingEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "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(this.CLASS_NAME, "sender", sender);
+        Guards.arrayValue(this.CLASS_NAME, "recipients", recipients);
+        Guards.stringValue(this.CLASS_NAME, "subject", subject);
+        Guards.stringValue(this.CLASS_NAME, "content", content);
+        try {
+            await this._logging?.log({
+                level: "info",
+                source: this.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._messagingEntryStorage.set(entity);
+            return true;
+        }
+        catch (err) {
+            throw new GeneralError(this.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 {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "EntityStorageMessagingPushNotificationConnector";
+    /**
+     * The logging connector.
+     * @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.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.messagingEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries.
+     * @param options.config The configuration for the push notifications connector.
+     */
+    constructor(options) {
+        if (Is.stringValue(options?.loggingConnectorType)) {
+            this._logging = LoggingConnectorFactory.get(options.loggingConnectorType);
+        }
+        this._messagingDeviceEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "push-notifications-device-entry");
+        this._messagingMessageEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "push-notifications-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(this.CLASS_NAME, "applicationId", applicationId);
+        Guards.stringValue(this.CLASS_NAME, "deviceToken", deviceToken);
+        try {
+            await this._logging?.log({
+                level: "info",
+                source: this.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(this.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(this.CLASS_NAME, "deviceAddress", deviceAddress);
+        Guards.stringValue(this.CLASS_NAME, "title", title);
+        Guards.stringValue(this.CLASS_NAME, "message", message);
+        try {
+            await this._logging?.log({
+                level: "info",
+                source: this.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(this.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 {
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "EntityStorageMessagingSmsConnector";
+    /**
+     * The logging connector.
+     * @internal
+     */
+    _logging;
+    /**
+     * The entity storage for the sms entries.
+     * @internal
+     */
+    _messagingEntryStorage;
+    /**
+     * Create a new instance of EntityStorageMessagingSmsConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.messagingEntryStorageConnectorType The type of entity storage connector to use for the sms entries.
+     * @param options.config The configuration for the sms connector.
+     */
+    constructor(options) {
+        if (Is.stringValue(options?.loggingConnectorType)) {
+            this._logging = LoggingConnectorFactory.get(options.loggingConnectorType);
+        }
+        this._messagingEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "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(this.CLASS_NAME, "phoneNumber", phoneNumber);
+        Guards.stringValue(this.CLASS_NAME, "message", message);
+        try {
+            await this._logging?.log({
+                level: "info",
+                source: this.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._messagingEntryStorage.set(entity);
+            return true;
+        }
+        catch (err) {
+            throw new GeneralError(this.CLASS_NAME, "sendSMSFailed", undefined, err);
+        }
+    }
+}
+
+export { EntityStorageMessagingEmailConnector, EntityStorageMessagingPushNotificationConnector, EntityStorageMessagingSmsConnector };

package/dist/types/entities/emailEntry.d.ts

@@ -0,0 +1,38 @@
+import type { IError } from "@twin.org/core";
+/**
+ * Call defining an email entry.
+ */
+export declare class EmailEntry {
+    /**
+     * The id.
+     */
+    id: string;
+    /**
+     * The sender email address.
+     */
+    sender: string;
+    /**
+     * The recipient email addresses.
+     */
+    recipients: string[];
+    /**
+     * The timestamp of the email entry.
+     */
+    ts: number;
+    /**
+     * The message.
+     */
+    message: string;
+    /**
+     * The subject.
+     */
+    subject: string;
+    /**
+     * The status.
+     */
+    status: string;
+    /**
+     * The error.
+     */
+    error?: IError;
+}

package/dist/types/entities/pushNotificationDeviceEntry.d.ts

@@ -0,0 +1,30 @@
+import type { IError } from "@twin.org/core";
+/**
+ * Call defining an push notification device entry.
+ */
+export declare class PushNotificationDeviceEntry {
+    /**
+     * The id.
+     */
+    id: string;
+    /**
+     * The applicationId.
+     */
+    applicationId: string;
+    /**
+     * The device token.
+     */
+    deviceToken: string;
+    /**
+     * The timestamp of the push notification device entry.
+     */
+    ts: number;
+    /**
+     * The status.
+     */
+    status: string;
+    /**
+     * The error.
+     */
+    error?: IError;
+}

package/dist/types/entities/pushNotificationMessageEntry.d.ts

@@ -0,0 +1,34 @@
+import type { IError } from "@twin.org/core";
+/**
+ * Call defining an push notification message entry.
+ */
+export declare class PushNotificationMessageEntry {
+    /**
+     * The id.
+     */
+    id: string;
+    /**
+     * The device address.
+     */
+    deviceAddress: string;
+    /**
+     * The title.
+     */
+    title: string;
+    /**
+     * The message.
+     */
+    message: string;
+    /**
+     * The timestamp of the push notification entry.
+     */
+    ts: number;
+    /**
+     * The status.
+     */
+    status: string;
+    /**
+     * The error.
+     */
+    error?: IError;
+}

package/dist/types/entities/smsEntry.d.ts

@@ -0,0 +1,30 @@
+import type { IError } from "@twin.org/core";
+/**
+ * Call defining an sms entry.
+ */
+export declare class SmsEntry {
+    /**
+     * The id.
+     */
+    id: string;
+    /**
+     * The phone number to deliver the message.
+     */
+    phoneNumber: string;
+    /**
+     * The timestamp of the sms entry.
+     */
+    ts: number;
+    /**
+     * The message.
+     */
+    message: string;
+    /**
+     * The status.
+     */
+    status: string;
+    /**
+     * The error.
+     */
+    error?: IError;
+}

package/dist/types/entityStorageMessagingEmailConnector.d.ts

@@ -0,0 +1,32 @@
+import type { IMessagingEmailConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingEmailConnectorConfig } from "./models/IEntityStorageMessagingEmailConnectorConfig";
+/**
+ * Class for connecting to the email messaging operations of the Entity Storage.
+ */
+export declare class EntityStorageMessagingEmailConnector implements IMessagingEmailConnector {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageMessagingEmailConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.messagingEntryStorageConnectorType The type of entity storage connector to use for the email entries.
+     * @param options.config The configuration for the email connector.
+     */
+    constructor(options?: {
+        loggingConnectorType?: string;
+        messagingEntryStorageConnectorType: string;
+        config?: IEntityStorageMessagingEmailConnectorConfig;
+    });
+    /**
+     * 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.
+     */
+    sendCustomEmail(sender: string, recipients: string[], subject: string, content: string): Promise<boolean>;
+}

package/dist/types/entityStorageMessagingPushNotificationConnector.d.ts

@@ -0,0 +1,38 @@
+import type { IMessagingPushNotificationsConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingPushNotificationsConnectorConfig } from "./models/IEntityStorageMessagingPushNotificationsConnectorConfig";
+/**
+ * Class for connecting to the push notifications messaging operations of the Entity Storage.
+ */
+export declare class EntityStorageMessagingPushNotificationConnector implements IMessagingPushNotificationsConnector {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageMessagingPushNotificationConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.messagingEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries.
+     * @param options.config The configuration for the push notifications connector.
+     */
+    constructor(options?: {
+        loggingConnectorType?: string;
+        messagingEntryStorageConnectorType: string;
+        config?: IEntityStorageMessagingPushNotificationsConnectorConfig;
+    });
+    /**
+     * 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.
+     */
+    registerDevice(applicationId: string, deviceToken: string): Promise<string>;
+    /**
+     * 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.
+     */
+    sendSinglePushNotification(deviceAddress: string, title: string, message: string): Promise<boolean>;
+}

package/dist/types/entityStorageMessagingSmsConnector.d.ts

@@ -0,0 +1,30 @@
+import type { IMessagingSmsConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingSmsConnectorConfig } from "./models/IEntityStorageMessagingSmsConnectorConfig";
+/**
+ * Class for connecting to the SMS messaging operations of the Entity Storage.
+ */
+export declare class EntityStorageMessagingSmsConnector implements IMessagingSmsConnector {
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageMessagingSmsConnector.
+     * @param options The options for the connector.
+     * @param options.loggingConnectorType The type of logging connector to use, defaults to no logging.
+     * @param options.messagingEntryStorageConnectorType The type of entity storage connector to use for the sms entries.
+     * @param options.config The configuration for the sms connector.
+     */
+    constructor(options?: {
+        loggingConnectorType?: string;
+        messagingEntryStorageConnectorType: string;
+        config?: IEntityStorageMessagingSmsConnectorConfig;
+    });
+    /**
+     * 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.
+     */
+    sendSMS(phoneNumber: string, message: string): Promise<boolean>;
+}

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+export * from "./entityStorageMessagingEmailConnector";
+export * from "./entityStorageMessagingPushNotificationConnector";
+export * from "./entityStorageMessagingSmsConnector";
+export * from "./models/IEntityStorageMessagingEmailConnectorConfig";
+export * from "./models/IEntityStorageMessagingPushNotificationsConnectorConfig";
+export * from "./models/IEntityStorageMessagingSmsConnectorConfig";

package/dist/types/models/IEntityStorageMessagingEmailConnectorConfig.d.ts

@@ -0,0 +1,5 @@
+import type { IMessagingEmailConnector } from "@twin.org/messaging-models";
+/**
+ * Configuration for the Entity Storage Messaging Email Connector.
+ */
+export type IEntityStorageMessagingEmailConnectorConfig = IMessagingEmailConnector;

package/dist/types/models/IEntityStorageMessagingPushNotificationsConnectorConfig.d.ts

@@ -0,0 +1,5 @@
+import type { IMessagingPushNotificationsConnector } from "@twin.org/messaging-models";
+/**
+ * Configuration for the Entity Storage Messaging Push Notifications Connector.
+ */
+export type IEntityStorageMessagingPushNotificationsConnectorConfig = IMessagingPushNotificationsConnector;

package/dist/types/models/IEntityStorageMessagingSmsConnectorConfig.d.ts

@@ -0,0 +1,5 @@
+import type { IMessagingSmsConnector } from "@twin.org/messaging-models";
+/**
+ * Configuration for the Entity Storage Messaging Sms Connector.
+ */
+export type IEntityStorageMessagingSmsConnectorConfig = IMessagingSmsConnector;

package/dist/types/schema.d.ts

@@ -0,0 +1,4 @@
+/**
+ * Initialize the schema for the messaging connector entity storage.
+ */
+export declare function initSchema(): void;

package/docs/changelog.md

@@ -0,0 +1,5 @@
+# @twin.org/messaging-connector-entity-storage - Changelog
+
+## v0.0.1-next.2
+
+- Initial Release

package/docs/examples.md

@@ -0,0 +1 @@
+# @twin.org/messaging-connector-entity-storage - Examples

package/docs/reference/classes/EntityStorageMessagingEmailConnector.md

@@ -0,0 +1,85 @@
+# Class: EntityStorageMessagingEmailConnector
+
+Class for connecting to the email messaging operations of the Entity Storage.
+
+## Implements
+
+- `IMessagingEmailConnector`
+
+## Constructors
+
+### new EntityStorageMessagingEmailConnector()
+
+> **new EntityStorageMessagingEmailConnector**(`options`?): [`EntityStorageMessagingEmailConnector`](EntityStorageMessagingEmailConnector.md)
+
+Create a new instance of EntityStorageMessagingEmailConnector.
+
+#### Parameters
+
+• **options?**
+
+The options for the connector.
+
+• **options.loggingConnectorType?**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+• **options.messagingEntryStorageConnectorType?**: `string`
+
+The type of entity storage connector to use for the email entries.
+
+• **options.config?**: `IMessagingEmailConnector`
+
+The configuration for the email connector.
+
+#### Returns
+
+[`EntityStorageMessagingEmailConnector`](EntityStorageMessagingEmailConnector.md)
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IMessagingEmailConnector.CLASS_NAME`
+
+## Methods
+
+### sendCustomEmail()
+
+> **sendCustomEmail**(`sender`, `recipients`, `subject`, `content`): `Promise`\<`boolean`\>
+
+Store a custom email using Entity Storage.
+
+#### Parameters
+
+• **sender**: `string`
+
+The sender email address.
+
+• **recipients**: `string`[]
+
+An array of recipients email addresses.
+
+• **subject**: `string`
+
+The subject of the email.
+
+• **content**: `string`
+
+The html content of the email.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the email was send successfully, otherwise undefined.
+
+#### Implementation of
+
+`IMessagingEmailConnector.sendCustomEmail`