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

package/docs/reference/classes/EntityStorageMessagingPushNotificationConnector.md

@@ -0,0 +1,109 @@
+# 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?**
+
+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 push notifications entries.
+
+• **options.config?**: `IMessagingPushNotificationsConnector`
+
+The configuration for the push notifications connector.
+
+#### Returns
+
+[`EntityStorageMessagingPushNotificationConnector`](EntityStorageMessagingPushNotificationConnector.md)
+
+## Properties
+
+### 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,77 @@
+# 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?**
+
+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 sms entries.
+
+• **options.config?**: `IMessagingSmsConnector`
+
+The configuration for the sms connector.
+
+#### Returns
+
+[`EntityStorageMessagingSmsConnector`](EntityStorageMessagingSmsConnector.md)
+
+## Properties
+
+### 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/index.md

@@ -0,0 +1,13 @@
+# @twin.org/messaging-connector-entity-storage
+
+## Classes
+
+- [EntityStorageMessagingEmailConnector](classes/EntityStorageMessagingEmailConnector.md)
+- [EntityStorageMessagingPushNotificationConnector](classes/EntityStorageMessagingPushNotificationConnector.md)
+- [EntityStorageMessagingSmsConnector](classes/EntityStorageMessagingSmsConnector.md)
+
+## Type Aliases
+
+- [IEntityStorageMessagingEmailConnectorConfig](type-aliases/IEntityStorageMessagingEmailConnectorConfig.md)
+- [IEntityStorageMessagingPushNotificationsConnectorConfig](type-aliases/IEntityStorageMessagingPushNotificationsConnectorConfig.md)
+- [IEntityStorageMessagingSmsConnectorConfig](type-aliases/IEntityStorageMessagingSmsConnectorConfig.md)

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

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

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

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

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

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

package/locales/en.json

@@ -0,0 +1,19 @@
+{
+	"info": {
+		"entityStorageMessagingConnector": {
+			"emailSending": "Sending email",
+			"smsSending": "Sending SMS",
+			"deviceRegistering": "Registering device",
+			"pushNotificationSending": "Sending push notification"
+		}
+	},
+	"error": {
+		"entityStorageMessagingConnector": {
+			"sendCustomEmailFailed": "Failed to send custom email",
+			"readEmailEntryFailed": "Failed to read email entry",
+			"sendSMSFailed": "Failed to send SMS",
+			"deviceTokenRegisterFailed": "Failed to register device token",
+			"sendPushNotificationFailed": "Failed to send push notification"
+		}
+	}
+}

package/package.json

@@ -0,0 +1,41 @@
+{
+	"name": "@twin.org/messaging-connector-entity-storage",
+	"version": "0.0.1-next.2",
+	"description": "Messaging connector implementation using the Entity Storage",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/twinfoundation/messaging.git",
+		"directory": "packages/messaging-connector-entity-storage"
+	},
+	"author": "adrian.sanchez.sequeira@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=20.0.0"
+	},
+	"dependencies": {
+		"@twin.org/core": "next",
+		"@twin.org/entity": "next",
+		"@twin.org/logging-models": "next",
+		"@twin.org/messaging-models": "0.0.1-next.2",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs",
+			"types": "./dist/types/index.d.ts"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}