@twin.org/messaging-service 0.0.1-next.10
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.
- package/LICENSE +201 -0
- package/README.md +21 -0
- package/dist/cjs/index.cjs +248 -0
- package/dist/esm/index.mjs +245 -0
- package/dist/types/entities/templateEntry.d.ts +21 -0
- package/dist/types/index.d.ts +4 -0
- package/dist/types/messagingService.d.ts +70 -0
- package/dist/types/models/IMessagingServiceConstructorOptions.d.ts +22 -0
- package/dist/types/schema.d.ts +4 -0
- package/docs/changelog.md +5 -0
- package/docs/examples.md +1 -0
- package/docs/open-api/spec.json +403 -0
- package/docs/reference/classes/MessagingService.md +251 -0
- package/docs/reference/classes/TemplateEntry.md +45 -0
- package/docs/reference/functions/initSchema.md +9 -0
- package/docs/reference/index.md +14 -0
- package/docs/reference/interfaces/IMessagingServiceConstructorOptions.md +41 -0
- package/locales/en.json +13 -0
- package/package.json +42 -0
|
@@ -0,0 +1,14 @@
|
|
|
1
|
+
# @twin.org/messaging-service
|
|
2
|
+
|
|
3
|
+
## Classes
|
|
4
|
+
|
|
5
|
+
- [TemplateEntry](classes/TemplateEntry.md)
|
|
6
|
+
- [MessagingService](classes/MessagingService.md)
|
|
7
|
+
|
|
8
|
+
## Interfaces
|
|
9
|
+
|
|
10
|
+
- [IMessagingServiceConstructorOptions](interfaces/IMessagingServiceConstructorOptions.md)
|
|
11
|
+
|
|
12
|
+
## Functions
|
|
13
|
+
|
|
14
|
+
- [initSchema](functions/initSchema.md)
|
|
@@ -0,0 +1,41 @@
|
|
|
1
|
+
# Interface: IMessagingServiceConstructorOptions
|
|
2
|
+
|
|
3
|
+
Options for the messaging service.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
### messagingEmailConnectorType?
|
|
8
|
+
|
|
9
|
+
> `optional` **messagingEmailConnectorType**: `string`
|
|
10
|
+
|
|
11
|
+
The type of the email messaging connector to use, defaults to not configured.
|
|
12
|
+
|
|
13
|
+
***
|
|
14
|
+
|
|
15
|
+
### messagingPushNotificationConnectorType?
|
|
16
|
+
|
|
17
|
+
> `optional` **messagingPushNotificationConnectorType**: `string`
|
|
18
|
+
|
|
19
|
+
The type of the push notifications messaging connector to use, defaults to not configured.
|
|
20
|
+
|
|
21
|
+
***
|
|
22
|
+
|
|
23
|
+
### messagingSmsConnectorType?
|
|
24
|
+
|
|
25
|
+
> `optional` **messagingSmsConnectorType**: `string`
|
|
26
|
+
|
|
27
|
+
The type of the sms messaging connector to use, defaults to not configured.
|
|
28
|
+
|
|
29
|
+
***
|
|
30
|
+
|
|
31
|
+
### templateEntryStorageConnectorType?
|
|
32
|
+
|
|
33
|
+
> `optional` **templateEntryStorageConnectorType**: `string`
|
|
34
|
+
|
|
35
|
+
The type of the entity connector to use.
|
|
36
|
+
|
|
37
|
+
#### Default
|
|
38
|
+
|
|
39
|
+
```ts
|
|
40
|
+
template-entry
|
|
41
|
+
```
|
package/locales/en.json
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
{
|
|
2
|
+
"info": {
|
|
3
|
+
"messagingService": {}
|
|
4
|
+
},
|
|
5
|
+
"error": {
|
|
6
|
+
"messagingService": {
|
|
7
|
+
"getTemplateFailed": "Failed to get template with id: \"{templateId}\" and locale: \"{locale}\"",
|
|
8
|
+
"notConfiguredEmailMessagingConnector": "Email messaging connector was not configured",
|
|
9
|
+
"notConfiguredPushNotificationMessagingConnector": "Push notification messaging connector was not configured",
|
|
10
|
+
"notConfiguredSmsMessagingConnector": "SMS messaging connector was not configured"
|
|
11
|
+
}
|
|
12
|
+
}
|
|
13
|
+
}
|
package/package.json
ADDED
|
@@ -0,0 +1,42 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@twin.org/messaging-service",
|
|
3
|
+
"version": "0.0.1-next.10",
|
|
4
|
+
"description": "Messaging service implementation",
|
|
5
|
+
"repository": {
|
|
6
|
+
"type": "git",
|
|
7
|
+
"url": "git+https://github.com/twinfoundation/messaging.git",
|
|
8
|
+
"directory": "packages/messaging-service"
|
|
9
|
+
},
|
|
10
|
+
"author": "adrian.sanchez.sequeira@iota.org",
|
|
11
|
+
"license": "Apache-2.0",
|
|
12
|
+
"type": "module",
|
|
13
|
+
"engines": {
|
|
14
|
+
"node": ">=20.0.0"
|
|
15
|
+
},
|
|
16
|
+
"dependencies": {
|
|
17
|
+
"@twin.org/core": "next",
|
|
18
|
+
"@twin.org/entity": "next",
|
|
19
|
+
"@twin.org/entity-storage-models": "^0.0.1-next.10",
|
|
20
|
+
"@twin.org/logging-models": "next",
|
|
21
|
+
"@twin.org/messaging-models": "0.0.1-next.10",
|
|
22
|
+
"@twin.org/nameof": "next"
|
|
23
|
+
},
|
|
24
|
+
"main": "./dist/cjs/index.cjs",
|
|
25
|
+
"module": "./dist/esm/index.mjs",
|
|
26
|
+
"types": "./dist/types/index.d.ts",
|
|
27
|
+
"exports": {
|
|
28
|
+
".": {
|
|
29
|
+
"types": "./dist/types/index.d.ts",
|
|
30
|
+
"require": "./dist/cjs/index.cjs",
|
|
31
|
+
"import": "./dist/esm/index.mjs"
|
|
32
|
+
},
|
|
33
|
+
"./locales": "./locales"
|
|
34
|
+
},
|
|
35
|
+
"files": [
|
|
36
|
+
"dist/cjs",
|
|
37
|
+
"dist/esm",
|
|
38
|
+
"dist/types",
|
|
39
|
+
"locales",
|
|
40
|
+
"docs"
|
|
41
|
+
]
|
|
42
|
+
}
|