npm - @twin.org/messaging-connector-entity-storage - Versions diffs - 0.0.1-next.2 → 0.0.1-next.4 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (24) hide show

package/dist/cjs/index.cjs CHANGED Viewed

@@ -1,9 +1,262 @@
 'use strict';
+var entity = require('@twin.org/entity');
 var core = require('@twin.org/core');
 var entityStorageModels = require('@twin.org/entity-storage-models');
 var loggingModels = require('@twin.org/logging-models');
+/**
+ * Call defining an email entry.
+ */
+exports.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([
+    entity.property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], exports.EmailEntry.prototype, "id", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.EmailEntry.prototype, "sender", void 0);
+__decorate([
+    entity.property({ type: "array", itemType: "string" }),
+    __metadata("design:type", Array)
+], exports.EmailEntry.prototype, "recipients", void 0);
+__decorate([
+    entity.property({ type: "integer" }),
+    __metadata("design:type", Number)
+], exports.EmailEntry.prototype, "ts", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.EmailEntry.prototype, "message", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.EmailEntry.prototype, "subject", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.EmailEntry.prototype, "status", void 0);
+__decorate([
+    entity.property({ type: "object" }),
+    __metadata("design:type", Object)
+], exports.EmailEntry.prototype, "error", void 0);
+exports.EmailEntry = __decorate([
+    entity.entity()
+], exports.EmailEntry);
+/**
+ * Call defining an push notification device entry.
+ */
+exports.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([
+    entity.property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], exports.PushNotificationDeviceEntry.prototype, "id", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationDeviceEntry.prototype, "applicationId", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationDeviceEntry.prototype, "deviceToken", void 0);
+__decorate([
+    entity.property({ type: "integer" }),
+    __metadata("design:type", Number)
+], exports.PushNotificationDeviceEntry.prototype, "ts", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationDeviceEntry.prototype, "status", void 0);
+__decorate([
+    entity.property({ type: "object" }),
+    __metadata("design:type", Object)
+], exports.PushNotificationDeviceEntry.prototype, "error", void 0);
+exports.PushNotificationDeviceEntry = __decorate([
+    entity.entity()
+], exports.PushNotificationDeviceEntry);
+/**
+ * Call defining an push notification message entry.
+ */
+exports.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([
+    entity.property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], exports.PushNotificationMessageEntry.prototype, "id", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationMessageEntry.prototype, "deviceAddress", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationMessageEntry.prototype, "title", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationMessageEntry.prototype, "message", void 0);
+__decorate([
+    entity.property({ type: "integer" }),
+    __metadata("design:type", Number)
+], exports.PushNotificationMessageEntry.prototype, "ts", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.PushNotificationMessageEntry.prototype, "status", void 0);
+__decorate([
+    entity.property({ type: "object" }),
+    __metadata("design:type", Object)
+], exports.PushNotificationMessageEntry.prototype, "error", void 0);
+exports.PushNotificationMessageEntry = __decorate([
+    entity.entity()
+], exports.PushNotificationMessageEntry);
+/**
+ * Call defining an sms entry.
+ */
+exports.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([
+    entity.property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], exports.SmsEntry.prototype, "id", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.SmsEntry.prototype, "phoneNumber", void 0);
+__decorate([
+    entity.property({ type: "integer" }),
+    __metadata("design:type", Number)
+], exports.SmsEntry.prototype, "ts", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.SmsEntry.prototype, "message", void 0);
+__decorate([
+    entity.property({ type: "string" }),
+    __metadata("design:type", String)
+], exports.SmsEntry.prototype, "status", void 0);
+__decorate([
+    entity.property({ type: "object" }),
+    __metadata("design:type", Object)
+], exports.SmsEntry.prototype, "error", void 0);
+exports.SmsEntry = __decorate([
+    entity.entity()
+], exports.SmsEntry);
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -23,19 +276,19 @@ class EntityStorageMessagingEmailConnector {
      * The entity storage for the emails entries.
      * @internal
      */
-    _messagingEntryStorage;
+    _messagingEmailEntryStorage;
     /**
      * 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.
+     * @param options.messagingEmailEntryStorageConnectorType The type of entity storage connector to use for the email entries, defaults to "email-entry".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.loggingConnectorType)) {
             this._logging = loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType);
         }
-        this._messagingEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "email-entry");
+        this._messagingEmailEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingEmailEntryStorageConnectorType ??
+            core.StringHelper.kebabCase("EmailEntry"));
     }
     /**
      * Store a custom email using Entity Storage.
@@ -70,7 +323,7 @@ class EntityStorageMessagingEmailConnector {
                 subject,
                 status: "pending"
             };
-            await this._messagingEntryStorage.set(entity);
+            await this._messagingEmailEntryStorage.set(entity);
             return true;
         }
         catch (err) {
@@ -108,15 +361,17 @@ class EntityStorageMessagingPushNotificationConnector {
      * 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.
+     * @param options.messagingDeviceEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
+     * @param options.messagingMessageEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.loggingConnectorType)) {
             this._logging = loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType);
         }
-        this._messagingDeviceEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "push-notifications-device-entry");
-        this._messagingMessageEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "push-notifications-message-entry");
+        this._messagingDeviceEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingDeviceEntryStorageConnectorType ??
+            core.StringHelper.kebabCase("PushNotificationDeviceEntry"));
+        this._messagingMessageEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingMessageEntryStorageConnectorType ??
+            core.StringHelper.kebabCase("PushNotificationMessageEntry"));
     }
     /**
      * Registers a device to an specific app in order to send notifications to it.
@@ -204,19 +459,18 @@ class EntityStorageMessagingSmsConnector {
      * The entity storage for the sms entries.
      * @internal
      */
-    _messagingEntryStorage;
+    _messagingSmsEntryStorage;
     /**
      * 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.
+     * @param options.messagingSmsEntryStorageConnectorType The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.loggingConnectorType)) {
             this._logging = loggingModels.LoggingConnectorFactory.get(options.loggingConnectorType);
         }
-        this._messagingEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "sms-entry");
+        this._messagingSmsEntryStorage = entityStorageModels.EntityStorageConnectorFactory.get(options?.messagingSmsEntryStorageConnectorType ?? core.StringHelper.kebabCase("SmsEntry"));
     }
     /**
      * Send a SMS message to a phone number.
@@ -242,7 +496,7 @@ class EntityStorageMessagingSmsConnector {
                 ts: Date.now(),
                 status: "sent"
             };
-            await this._messagingEntryStorage.set(entity);
+            await this._messagingSmsEntryStorage.set(entity);
             return true;
         }
         catch (err) {
@@ -251,6 +505,29 @@ class EntityStorageMessagingSmsConnector {
     }
 }
+// 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) {
+        entity.EntitySchemaFactory.register("EmailEntry", () => entity.EntitySchemaHelper.getSchema(exports.EmailEntry));
+    }
+    if (options?.pushNotification ?? true) {
+        entity.EntitySchemaFactory.register("PushNotificationDeviceEntry", () => entity.EntitySchemaHelper.getSchema(exports.PushNotificationDeviceEntry));
+        entity.EntitySchemaFactory.register("PushNotificationMessageEntry", () => entity.EntitySchemaHelper.getSchema(exports.PushNotificationMessageEntry));
+    }
+    if (options?.sms ?? true) {
+        entity.EntitySchemaFactory.register("SmsEntry", () => entity.EntitySchemaHelper.getSchema(exports.SmsEntry));
+    }
+}
 exports.EntityStorageMessagingEmailConnector = EntityStorageMessagingEmailConnector;
 exports.EntityStorageMessagingPushNotificationConnector = EntityStorageMessagingPushNotificationConnector;
 exports.EntityStorageMessagingSmsConnector = EntityStorageMessagingSmsConnector;
+exports.initSchema = initSchema;

package/dist/esm/index.mjs CHANGED Viewed

@@ -1,7 +1,260 @@
-import { Is, Guards, Converter, RandomHelper, GeneralError } from '@twin.org/core';
+import { property, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
+import { Is, StringHelper, Guards, Converter, RandomHelper, GeneralError } from '@twin.org/core';
 import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
 import { LoggingConnectorFactory } from '@twin.org/logging-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" }),
+    __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" }),
+    __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" }),
+    __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" }),
+    __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" }),
+    __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" }),
+    __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" }),
+    __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" }),
+    __metadata("design:type", Object)
+], SmsEntry.prototype, "error", void 0);
+SmsEntry = __decorate([
+    entity()
+], SmsEntry);
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -21,19 +274,19 @@ class EntityStorageMessagingEmailConnector {
      * The entity storage for the emails entries.
      * @internal
      */
-    _messagingEntryStorage;
+    _messagingEmailEntryStorage;
     /**
      * 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.
+     * @param options.messagingEmailEntryStorageConnectorType The type of entity storage connector to use for the email entries, defaults to "email-entry".
      */
     constructor(options) {
         if (Is.stringValue(options?.loggingConnectorType)) {
             this._logging = LoggingConnectorFactory.get(options.loggingConnectorType);
         }
-        this._messagingEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "email-entry");
+        this._messagingEmailEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEmailEntryStorageConnectorType ??
+            StringHelper.kebabCase("EmailEntry"));
     }
     /**
      * Store a custom email using Entity Storage.
@@ -68,7 +321,7 @@ class EntityStorageMessagingEmailConnector {
                 subject,
                 status: "pending"
             };
-            await this._messagingEntryStorage.set(entity);
+            await this._messagingEmailEntryStorage.set(entity);
             return true;
         }
         catch (err) {
@@ -106,15 +359,17 @@ class EntityStorageMessagingPushNotificationConnector {
      * 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.
+     * @param options.messagingDeviceEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
+     * @param options.messagingMessageEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
      */
     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");
+        this._messagingDeviceEntryStorage = EntityStorageConnectorFactory.get(options?.messagingDeviceEntryStorageConnectorType ??
+            StringHelper.kebabCase("PushNotificationDeviceEntry"));
+        this._messagingMessageEntryStorage = EntityStorageConnectorFactory.get(options?.messagingMessageEntryStorageConnectorType ??
+            StringHelper.kebabCase("PushNotificationMessageEntry"));
     }
     /**
      * Registers a device to an specific app in order to send notifications to it.
@@ -202,19 +457,18 @@ class EntityStorageMessagingSmsConnector {
      * The entity storage for the sms entries.
      * @internal
      */
-    _messagingEntryStorage;
+    _messagingSmsEntryStorage;
     /**
      * 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.
+     * @param options.messagingSmsEntryStorageConnectorType The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
      */
     constructor(options) {
         if (Is.stringValue(options?.loggingConnectorType)) {
             this._logging = LoggingConnectorFactory.get(options.loggingConnectorType);
         }
-        this._messagingEntryStorage = EntityStorageConnectorFactory.get(options?.messagingEntryStorageConnectorType ?? "sms-entry");
+        this._messagingSmsEntryStorage = EntityStorageConnectorFactory.get(options?.messagingSmsEntryStorageConnectorType ?? StringHelper.kebabCase("SmsEntry"));
     }
     /**
      * Send a SMS message to a phone number.
@@ -240,7 +494,7 @@ class EntityStorageMessagingSmsConnector {
                 ts: Date.now(),
                 status: "sent"
             };
-            await this._messagingEntryStorage.set(entity);
+            await this._messagingSmsEntryStorage.set(entity);
             return true;
         }
         catch (err) {
@@ -249,4 +503,26 @@ class EntityStorageMessagingSmsConnector {
     }
 }
-export { EntityStorageMessagingEmailConnector, EntityStorageMessagingPushNotificationConnector, EntityStorageMessagingSmsConnector };
+// 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 };

package/dist/types/entityStorageMessagingEmailConnector.d.ts CHANGED Viewed

@@ -1,5 +1,4 @@
 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.
  */
@@ -12,13 +11,11 @@ export declare class EntityStorageMessagingEmailConnector implements IMessagingE
      * 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.
+     * @param options.messagingEmailEntryStorageConnectorType The type of entity storage connector to use for the email entries, defaults to "email-entry".
      */
     constructor(options?: {
         loggingConnectorType?: string;
-        messagingEntryStorageConnectorType: string;
-        config?: IEntityStorageMessagingEmailConnectorConfig;
+        messagingEmailEntryStorageConnectorType?: string;
     });
     /**
      * Store a custom email using Entity Storage.

package/dist/types/entityStorageMessagingPushNotificationConnector.d.ts CHANGED Viewed

@@ -1,5 +1,4 @@
 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.
  */
@@ -12,13 +11,13 @@ export declare class EntityStorageMessagingPushNotificationConnector implements
      * 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.
+     * @param options.messagingDeviceEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
+     * @param options.messagingMessageEntryStorageConnectorType The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
      */
     constructor(options?: {
         loggingConnectorType?: string;
-        messagingEntryStorageConnectorType: string;
-        config?: IEntityStorageMessagingPushNotificationsConnectorConfig;
+        messagingDeviceEntryStorageConnectorType?: string;
+        messagingMessageEntryStorageConnectorType?: string;
     });
     /**
      * Registers a device to an specific app in order to send notifications to it.

package/dist/types/entityStorageMessagingSmsConnector.d.ts CHANGED Viewed

@@ -1,5 +1,4 @@
 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.
  */
@@ -12,13 +11,11 @@ export declare class EntityStorageMessagingSmsConnector implements IMessagingSms
      * 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.
+     * @param options.messagingSmsEntryStorageConnectorType The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
      */
     constructor(options?: {
         loggingConnectorType?: string;
-        messagingEntryStorageConnectorType: string;
-        config?: IEntityStorageMessagingSmsConnectorConfig;
+        messagingSmsEntryStorageConnectorType?: string;
     });
     /**
      * Send a SMS message to a phone number.

package/dist/types/index.d.ts CHANGED Viewed

@@ -1,6 +1,8 @@
+export * from "./entities/emailEntry";
+export * from "./entities/pushNotificationDeviceEntry";
+export * from "./entities/pushNotificationMessageEntry";
+export * from "./entities/smsEntry";
 export * from "./entityStorageMessagingEmailConnector";
 export * from "./entityStorageMessagingPushNotificationConnector";
 export * from "./entityStorageMessagingSmsConnector";
-export * from "./models/IEntityStorageMessagingEmailConnectorConfig";
-export * from "./models/IEntityStorageMessagingPushNotificationsConnectorConfig";
-export * from "./models/IEntityStorageMessagingSmsConnectorConfig";
+export * from "./schema";

package/dist/types/schema.d.ts CHANGED Viewed

@@ -1,4 +1,12 @@
 /**
  * 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.
  */
-export declare function initSchema(): void;
+export declare function initSchema(options?: {
+    email?: boolean;
+    sms?: boolean;
+    pushNotification?: boolean;
+}): void;

package/docs/changelog.md CHANGED Viewed

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

package/docs/reference/classes/EmailEntry.md ADDED Viewed

@@ -0,0 +1,77 @@
+# Class: EmailEntry
+Call defining an email entry.
+## Constructors
+### new EmailEntry()
+> **new EmailEntry**(): [`EmailEntry`](EmailEntry.md)
+#### Returns
+[`EmailEntry`](EmailEntry.md)
+## Properties
+### id
+> **id**: `string`
+The id.
+***
+### sender
+> **sender**: `string`
+The sender email address.
+***
+### recipients
+> **recipients**: `string`[]
+The recipient email addresses.
+***
+### ts
+> **ts**: `number`
+The timestamp of the email entry.
+***
+### message
+> **message**: `string`
+The message.
+***
+### subject
+> **subject**: `string`
+The subject.
+***
+### status
+> **status**: `string`
+The status.
+***
+### error?
+> `optional` **error**: `IError`
+The error.

package/docs/reference/classes/EntityStorageMessagingEmailConnector.md CHANGED Viewed

@@ -24,13 +24,9 @@ The options for the connector.
 The type of logging connector to use, defaults to no logging.
-• **options.messagingEntryStorageConnectorType?**: `string`
+• **options.messagingEmailEntryStorageConnectorType?**: `string`
-The type of entity storage connector to use for the email entries.
-• **options.config?**: `IMessagingEmailConnector`
-The configuration for the email connector.
+The type of entity storage connector to use for the email entries, defaults to "email-entry".
 #### Returns

package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md CHANGED Viewed

@@ -24,13 +24,13 @@ The options for the connector.
 The type of logging connector to use, defaults to no logging.
-• **options.messagingEntryStorageConnectorType?**: `string`
+• **options.messagingDeviceEntryStorageConnectorType?**: `string`
-The type of entity storage connector to use for the push notifications entries.
+The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-device-entry".
-• **options.config?**: `IMessagingPushNotificationsConnector`
+• **options.messagingMessageEntryStorageConnectorType?**: `string`
-The configuration for the push notifications connector.
+The type of entity storage connector to use for the push notifications entries, defaults to "push-notification-message-entry".
 #### Returns

package/docs/reference/classes/EntityStorageMessagingSmsConnector.md CHANGED Viewed

@@ -24,13 +24,9 @@ The options for the connector.
 The type of logging connector to use, defaults to no logging.
-• **options.messagingEntryStorageConnectorType?**: `string`
+• **options.messagingSmsEntryStorageConnectorType?**: `string`
-The type of entity storage connector to use for the sms entries.
-• **options.config?**: `IMessagingSmsConnector`
-The configuration for the sms connector.
+The type of entity storage connector to use for the sms entries, defaults to "sms-entry".
 #### Returns

package/docs/reference/classes/PushNotificationDeviceEntry.md ADDED Viewed

@@ -0,0 +1,61 @@
+# Class: PushNotificationDeviceEntry
+Call defining an push notification device entry.
+## Constructors
+### new PushNotificationDeviceEntry()
+> **new PushNotificationDeviceEntry**(): [`PushNotificationDeviceEntry`](PushNotificationDeviceEntry.md)
+#### Returns
+[`PushNotificationDeviceEntry`](PushNotificationDeviceEntry.md)
+## Properties
+### id
+> **id**: `string`
+The id.
+***
+### applicationId
+> **applicationId**: `string`
+The applicationId.
+***
+### deviceToken
+> **deviceToken**: `string`
+The device token.
+***
+### ts
+> **ts**: `number`
+The timestamp of the push notification device entry.
+***
+### status
+> **status**: `string`
+The status.
+***
+### error?
+> `optional` **error**: `IError`
+The error.

package/docs/reference/classes/PushNotificationMessageEntry.md ADDED Viewed

@@ -0,0 +1,69 @@
+# Class: PushNotificationMessageEntry
+Call defining an push notification message entry.
+## Constructors
+### new PushNotificationMessageEntry()
+> **new PushNotificationMessageEntry**(): [`PushNotificationMessageEntry`](PushNotificationMessageEntry.md)
+#### Returns
+[`PushNotificationMessageEntry`](PushNotificationMessageEntry.md)
+## Properties
+### id
+> **id**: `string`
+The id.
+***
+### deviceAddress
+> **deviceAddress**: `string`
+The device address.
+***
+### title
+> **title**: `string`
+The title.
+***
+### message
+> **message**: `string`
+The message.
+***
+### ts
+> **ts**: `number`
+The timestamp of the push notification entry.
+***
+### status
+> **status**: `string`
+The status.
+***
+### error?
+> `optional` **error**: `IError`
+The error.

package/docs/reference/classes/SmsEntry.md ADDED Viewed

@@ -0,0 +1,61 @@
+# Class: SmsEntry
+Call defining an sms entry.
+## Constructors
+### new SmsEntry()
+> **new SmsEntry**(): [`SmsEntry`](SmsEntry.md)
+#### Returns
+[`SmsEntry`](SmsEntry.md)
+## Properties
+### id
+> **id**: `string`
+The id.
+***
+### phoneNumber
+> **phoneNumber**: `string`
+The phone number to deliver the message.
+***
+### ts
+> **ts**: `number`
+The timestamp of the sms entry.
+***
+### message
+> **message**: `string`
+The message.
+***
+### status
+> **status**: `string`
+The status.
+***
+### error?
+> `optional` **error**: `IError`
+The error.

package/docs/reference/functions/initSchema.md ADDED Viewed

@@ -0,0 +1,27 @@
+# Function: initSchema()
+> **initSchema**(`options`?): `void`
+Initialize the schema for the messaging connector entity storage.
+## Parameters
+• **options?**
+The options for the initialisation.
+• **options.email?**: `boolean`
+Should we register email schemas.
+• **options.sms?**: `boolean`
+Should we register sms schemas.
+• **options.pushNotification?**: `boolean`
+Should we register push notification schemas.
+## Returns
+`void`

package/docs/reference/index.md CHANGED Viewed

@@ -2,12 +2,14 @@
 ## Classes
+- [EmailEntry](classes/EmailEntry.md)
+- [PushNotificationDeviceEntry](classes/PushNotificationDeviceEntry.md)
+- [PushNotificationMessageEntry](classes/PushNotificationMessageEntry.md)
+- [SmsEntry](classes/SmsEntry.md)
 - [EntityStorageMessagingEmailConnector](classes/EntityStorageMessagingEmailConnector.md)
 - [EntityStorageMessagingPushNotificationConnector](classes/EntityStorageMessagingPushNotificationConnector.md)
 - [EntityStorageMessagingSmsConnector](classes/EntityStorageMessagingSmsConnector.md)
-## Type Aliases
+## Functions
-- [IEntityStorageMessagingEmailConnectorConfig](type-aliases/IEntityStorageMessagingEmailConnectorConfig.md)
-- [IEntityStorageMessagingPushNotificationsConnectorConfig](type-aliases/IEntityStorageMessagingPushNotificationsConnectorConfig.md)
-- [IEntityStorageMessagingSmsConnectorConfig](type-aliases/IEntityStorageMessagingSmsConnectorConfig.md)
+- [initSchema](functions/initSchema.md)

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/messaging-connector-entity-storage",
-	"version": "0.0.1-next.2",
+	"version": "0.0.1-next.4",
 	"description": "Messaging connector implementation using the Entity Storage",
 	"repository": {
 		"type": "git",
@@ -17,7 +17,7 @@
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
 		"@twin.org/logging-models": "next",
-		"@twin.org/messaging-models": "0.0.1-next.2",
+		"@twin.org/messaging-models": "0.0.1-next.4",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",

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

@@ -1,5 +0,0 @@
-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 DELETED Viewed

@@ -1,5 +0,0 @@
-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 DELETED Viewed

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

package/docs/reference/type-aliases/IEntityStorageMessagingEmailConnectorConfig.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Type Alias: IEntityStorageMessagingEmailConnectorConfig
-> **IEntityStorageMessagingEmailConnectorConfig**: `IMessagingEmailConnector`
-Configuration for the Entity Storage Messaging Email Connector.

package/docs/reference/type-aliases/IEntityStorageMessagingPushNotificationsConnectorConfig.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Type Alias: IEntityStorageMessagingPushNotificationsConnectorConfig
-> **IEntityStorageMessagingPushNotificationsConnectorConfig**: `IMessagingPushNotificationsConnector`
-Configuration for the Entity Storage Messaging Push Notifications Connector.

package/docs/reference/type-aliases/IEntityStorageMessagingSmsConnectorConfig.md DELETED Viewed

@@ -1,5 +0,0 @@
-# Type Alias: IEntityStorageMessagingSmsConnectorConfig
-> **IEntityStorageMessagingSmsConnectorConfig**: `IMessagingSmsConnector`
-Configuration for the Entity Storage Messaging Sms Connector.