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

package/docs/reference/functions/initSchema.md

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

package/docs/reference/index.md

@@ -0,0 +1,21 @@
+# @twin.org/messaging-connector-entity-storage
+
+## 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)
+
+## Interfaces
+
+- [IEntityStorageMessagingEmailConnectorConstructorOptions](interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md)
+- [IEntityStorageMessagingPushNotificationConnectorConstructorOptions](interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md)
+- [IEntityStorageMessagingSmsConnectorConstructorOptions](interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md)
+
+## Functions
+
+- [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IEntityStorageMessagingEmailConnectorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IEntityStorageMessagingEmailConnectorConstructorOptions
+
+Options for the entity storage messaging email connector.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### messagingEmailEntryStorageConnectorType?
+
+> `optional` **messagingEmailEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the email entries.
+
+#### Default
+
+```ts
+email-entry
+```

package/docs/reference/interfaces/IEntityStorageMessagingPushNotificationConnectorConstructorOptions.md

@@ -0,0 +1,39 @@
+# Interface: IEntityStorageMessagingPushNotificationConnectorConstructorOptions
+
+Options for the entity storage messaging push notification connector.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### messagingDeviceEntryStorageConnectorType?
+
+> `optional` **messagingDeviceEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the push notifications entries.
+
+#### Default
+
+```ts
+push-notification-device-entry
+```
+
+***
+
+### messagingMessageEntryStorageConnectorType?
+
+> `optional` **messagingMessageEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the push notifications entries.
+
+#### Default
+
+```ts
+push-notification-message-entry
+```

package/docs/reference/interfaces/IEntityStorageMessagingSmsConnectorConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IEntityStorageMessagingSmsConnectorConstructorOptions
+
+Options for the entity storage messaging SMS connector.
+
+## Properties
+
+### loggingConnectorType?
+
+> `optional` **loggingConnectorType**: `string`
+
+The type of logging connector to use, defaults to no logging.
+
+***
+
+### messagingSmsEntryStorageConnectorType?
+
+> `optional` **messagingSmsEntryStorageConnectorType**: `string`
+
+The type of entity storage connector to use for the sms entries.
+
+#### Default
+
+```ts
+sms-entry
+```

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.10",
+	"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.10",
+		"@twin.org/nameof": "next"
+	},
+	"main": "./dist/cjs/index.cjs",
+	"module": "./dist/esm/index.mjs",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"require": "./dist/cjs/index.cjs",
+			"import": "./dist/esm/index.mjs"
+		},
+		"./locales": "./locales"
+	},
+	"files": [
+		"dist/cjs",
+		"dist/esm",
+		"dist/types",
+		"locales",
+		"docs"
+	]
+}