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

package/dist/types/entityStorageMessagingPushNotificationConnector.d.ts

@@ -0,0 +1,35 @@
+import type { IMessagingPushNotificationsConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingPushNotificationConnectorConstructorOptions } from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions";
+/**
+ * Class for connecting to the push notifications messaging operations of the Entity Storage.
+ */
+export declare class EntityStorageMessagingPushNotificationConnector implements IMessagingPushNotificationsConnector {
+    /**
+     * The namespace for the connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageMessagingPushNotificationConnector.
+     * @param options The options for the connector.
+     */
+    constructor(options?: IEntityStorageMessagingPushNotificationConnectorConstructorOptions);
+    /**
+     * 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,27 @@
+import type { IMessagingSmsConnector } from "@twin.org/messaging-models";
+import type { IEntityStorageMessagingSmsConnectorConstructorOptions } from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions";
+/**
+ * Class for connecting to the SMS messaging operations of the Entity Storage.
+ */
+export declare class EntityStorageMessagingSmsConnector implements IMessagingSmsConnector {
+    /**
+     * The namespace for the connector.
+     */
+    static readonly NAMESPACE: string;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of EntityStorageMessagingSmsConnector.
+     * @param options The options for the connector.
+     */
+    constructor(options?: IEntityStorageMessagingSmsConnectorConstructorOptions);
+    /**
+     * 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,11 @@
+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/IEntityStorageMessagingEmailConnectorConstructorOptions";
+export * from "./models/IEntityStorageMessagingPushNotificationConnectorConstructorOptions";
+export * from "./models/IEntityStorageMessagingSmsConnectorConstructorOptions";
+export * from "./schema";

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

@@ -0,0 +1,14 @@
+/**
+ * Options for the entity storage messaging email connector.
+ */
+export interface IEntityStorageMessagingEmailConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the email entries.
+     * @default email-entry
+     */
+    messagingEmailEntryStorageConnectorType?: string;
+}

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

@@ -0,0 +1,19 @@
+/**
+ * Options for the entity storage messaging push notification connector.
+ */
+export interface IEntityStorageMessagingPushNotificationConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the push notifications entries.
+     * @default push-notification-device-entry
+     */
+    messagingDeviceEntryStorageConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the push notifications entries.
+     * @default push-notification-message-entry
+     */
+    messagingMessageEntryStorageConnectorType?: string;
+}

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

@@ -0,0 +1,14 @@
+/**
+ * Options for the entity storage messaging SMS connector.
+ */
+export interface IEntityStorageMessagingSmsConnectorConstructorOptions {
+    /**
+     * The type of logging connector to use, defaults to no logging.
+     */
+    loggingConnectorType?: string;
+    /**
+     * The type of entity storage connector to use for the sms entries.
+     * @default sms-entry
+     */
+    messagingSmsEntryStorageConnectorType?: string;
+}

package/dist/types/schema.d.ts

@@ -0,0 +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(options?: {
+    email?: boolean;
+    sms?: boolean;
+    pushNotification?: boolean;
+}): void;

package/docs/changelog.md

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

package/docs/examples.md

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

package/docs/reference/classes/EmailEntry.md

@@ -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

@@ -0,0 +1,91 @@
+# 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?
+
+[`IEntityStorageMessagingEmailConnectorConstructorOptions`](../interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+[`EntityStorageMessagingEmailConnector`](EntityStorageMessagingEmailConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
+
+The namespace for the connector.
+
+***
+
+### 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`

package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md

@@ -0,0 +1,117 @@
+# Class: EntityStorageMessagingPushNotificationConnector
+
+Class for connecting to the push notifications messaging operations of the Entity Storage.
+
+## Implements
+
+- `IMessagingPushNotificationsConnector`
+
+## Constructors
+
+### new EntityStorageMessagingPushNotificationConnector()
+
+> **new EntityStorageMessagingPushNotificationConnector**(`options`?): [`EntityStorageMessagingPushNotificationConnector`](EntityStorageMessagingPushNotificationConnector.md)
+
+Create a new instance of EntityStorageMessagingPushNotificationConnector.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageMessagingPushNotificationConnectorConstructorOptions`](../interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+[`EntityStorageMessagingPushNotificationConnector`](EntityStorageMessagingPushNotificationConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
+
+The namespace for the connector.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IMessagingPushNotificationsConnector.CLASS_NAME`
+
+## Methods
+
+### registerDevice()
+
+> **registerDevice**(`applicationId`, `deviceToken`): `Promise`\<`string`\>
+
+Registers a device to an specific app in order to send notifications to it.
+
+#### Parameters
+
+##### applicationId
+
+`string`
+
+The application address.
+
+##### deviceToken
+
+`string`
+
+The device token.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+If the device was registered successfully.
+
+#### Implementation of
+
+`IMessagingPushNotificationsConnector.registerDevice`
+
+***
+
+### sendSinglePushNotification()
+
+> **sendSinglePushNotification**(`deviceAddress`, `title`, `message`): `Promise`\<`boolean`\>
+
+Send a push notification to a device.
+
+#### Parameters
+
+##### deviceAddress
+
+`string`
+
+The address of the device.
+
+##### title
+
+`string`
+
+The title of the notification.
+
+##### message
+
+`string`
+
+The message to send.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+If the notification was sent successfully.
+
+#### Implementation of
+
+`IMessagingPushNotificationsConnector.sendSinglePushNotification`

package/docs/reference/classes/EntityStorageMessagingSmsConnector.md

@@ -0,0 +1,79 @@
+# Class: EntityStorageMessagingSmsConnector
+
+Class for connecting to the SMS messaging operations of the Entity Storage.
+
+## Implements
+
+- `IMessagingSmsConnector`
+
+## Constructors
+
+### new EntityStorageMessagingSmsConnector()
+
+> **new EntityStorageMessagingSmsConnector**(`options`?): [`EntityStorageMessagingSmsConnector`](EntityStorageMessagingSmsConnector.md)
+
+Create a new instance of EntityStorageMessagingSmsConnector.
+
+#### Parameters
+
+##### options?
+
+[`IEntityStorageMessagingSmsConnectorConstructorOptions`](../interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+[`EntityStorageMessagingSmsConnector`](EntityStorageMessagingSmsConnector.md)
+
+## Properties
+
+### NAMESPACE
+
+> `readonly` `static` **NAMESPACE**: `string` = `"entity-storage"`
+
+The namespace for the connector.
+
+***
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IMessagingSmsConnector.CLASS_NAME`
+
+## Methods
+
+### sendSMS()
+
+> **sendSMS**(`phoneNumber`, `message`): `Promise`\<`boolean`\>
+
+Send a SMS message to a phone number.
+
+#### Parameters
+
+##### phoneNumber
+
+`string`
+
+The recipient phone number.
+
+##### message
+
+`string`
+
+The message to send.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+If the SMS was sent successfully.
+
+#### Implementation of
+
+`IMessagingSmsConnector.sendSMS`

package/docs/reference/classes/PushNotificationDeviceEntry.md

@@ -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

@@ -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

@@ -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.