@3sixty/messaging-models 0.20.0-next.0 → 0.20.0-next.1
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/dist/es/factories/messagingEmailConnectorFactory.js.map +1 -1
- package/dist/es/factories/messagingPushNotificationsConnectorFactory.js.map +1 -1
- package/dist/es/factories/messagingSmsConnectorFactory.js.map +1 -1
- package/dist/es/index.js.map +1 -1
- package/dist/es/models/IMessagingAdminComponent.js.map +1 -1
- package/dist/es/models/IMessagingComponent.js.map +1 -1
- package/dist/es/models/IMessagingEmailConnector.js.map +1 -1
- package/dist/es/models/IMessagingPushNotificationsConnector.js.map +1 -1
- package/dist/es/models/IMessagingSmsConnector.js.map +1 -1
- package/docs/changelog.md +9 -0
- package/docs/reference/interfaces/IMessagingComponent.md +6 -0
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messagingEmailConnectorFactory.js","
|
|
1
|
+
{"version":3,"file":"messagingEmailConnectorFactory.js","sources":["../../../src/factories/messagingEmailConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,8BAA8B,GAC1C,OAAO,CAAC,aAAa,CAA2B,iBAAiB,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IMessagingEmailConnector } from \"../models/IMessagingEmailConnector.js\";\n\n/**\n * Factory for creating messaging email connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MessagingEmailConnectorFactory =\n\tFactory.createFactory<IMessagingEmailConnector>(\"messaging-email\");\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messagingPushNotificationsConnectorFactory.js","
|
|
1
|
+
{"version":3,"file":"messagingPushNotificationsConnectorFactory.js","sources":["../../../src/factories/messagingPushNotificationsConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,0CAA0C,GACtD,OAAO,CAAC,aAAa,CAAuC,8BAA8B,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IMessagingPushNotificationsConnector } from \"../models/IMessagingPushNotificationsConnector.js\";\n\n/**\n * Factory for creating messaging push notification connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MessagingPushNotificationsConnectorFactory =\n\tFactory.createFactory<IMessagingPushNotificationsConnector>(\"messaging-push-notifications\");\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"messagingSmsConnectorFactory.js","
|
|
1
|
+
{"version":3,"file":"messagingSmsConnectorFactory.js","sources":["../../../src/factories/messagingSmsConnectorFactory.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAGvC;;GAEG;AACH,gEAAgE;AAChE,MAAM,CAAC,MAAM,4BAA4B,GACxC,OAAO,CAAC,aAAa,CAAyB,eAAe,CAAC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { Factory } from \"@3sixty/core\";\nimport type { IMessagingSmsConnector } from \"../models/IMessagingSmsConnector.js\";\n\n/**\n * Factory for creating messaging sms connectors.\n */\n// eslint-disable-next-line @typescript-eslint/naming-convention\nexport const MessagingSmsConnectorFactory =\n\tFactory.createFactory<IMessagingSmsConnector>(\"messaging-sms\");\n"]}
|
package/dist/es/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","
|
|
1
|
+
{"version":3,"file":"index.js","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,+CAA+C,CAAC;AAC9D,cAAc,2DAA2D,CAAC;AAC1E,cAAc,6CAA6C,CAAC;AAC5D,cAAc,sCAAsC,CAAC;AACrD,cAAc,iCAAiC,CAAC;AAChD,cAAc,sCAAsC,CAAC;AACrD,cAAc,kDAAkD,CAAC;AACjE,cAAc,oCAAoC,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./factories/messagingEmailConnectorFactory.js\";\nexport * from \"./factories/messagingPushNotificationsConnectorFactory.js\";\nexport * from \"./factories/messagingSmsConnectorFactory.js\";\nexport * from \"./models/IMessagingAdminComponent.js\";\nexport * from \"./models/IMessagingComponent.js\";\nexport * from \"./models/IMessagingEmailConnector.js\";\nexport * from \"./models/IMessagingPushNotificationsConnector.js\";\nexport * from \"./models/IMessagingSmsConnector.js\";\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IMessagingAdminComponent.js","
|
|
1
|
+
{"version":3,"file":"IMessagingAdminComponent.js","sources":["../../../src/models/IMessagingAdminComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing the messaging admin component.\n */\nexport interface IMessagingAdminComponent extends IComponent {\n\t/**\n\t * Create or update a template.\n\t * @param templateId The id of the template.\n\t * @param locale The locale of the template.\n\t * @param title The title of the template.\n\t * @param content The content of the template.\n\t * @returns A promise that resolves when the template has been stored.\n\t */\n\tsetTemplate(templateId: string, locale: string, title: string, content: string): Promise<void>;\n\n\t/**\n\t * Get the email template by id and locale.\n\t * @param templateId The id of the email template.\n\t * @param locale The locale of the email template.\n\t * @returns The email template.\n\t */\n\tgetTemplate(templateId: string, locale: string): Promise<{ title: string; content: string }>;\n\n\t/**\n\t * Remove a template.\n\t * @param templateId The id of the template.\n\t * @param locale The locale of the template.\n\t * @returns A promise that resolves when the template has been removed.\n\t */\n\tremoveTemplate(templateId: string, locale: string): Promise<void>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IMessagingComponent.js","
|
|
1
|
+
{"version":3,"file":"IMessagingComponent.js","sources":["../../../src/models/IMessagingComponent.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing the messaging component.\n */\nexport interface IMessagingComponent extends IComponent {\n\t/**\n\t * Send a custom email.\n\t * @param sender The sender email address.\n\t * @param recipients An array of recipients email addresses.\n\t * @param templateId The id of the email template.\n\t * @param data The data to populate the email template.\n\t * @param locale The locale of the email template.\n\t * @returns True if the email was sent successfully.\n\t */\n\tsendCustomEmail(\n\t\tsender: string,\n\t\trecipients: string[],\n\t\ttemplateId: string,\n\t\tdata: { [key: string]: string },\n\t\tlocale: string\n\t): Promise<boolean>;\n\n\t/**\n\t * Registers a device to a specific application in order to send notifications to it.\n\t * @param applicationAddress The application address.\n\t * @param deviceToken The device token.\n\t * @returns The address assigned to the registered device.\n\t */\n\tregisterDevice(applicationAddress: string, deviceToken: string): Promise<string>;\n\n\t/**\n\t * Send a push notification to a device.\n\t * @param deviceAddress The address of the device.\n\t * @param templateId The id of the push notification template.\n\t * @param data The data to populate the push notification template.\n\t * @param locale The locale of the push notification template.\n\t * @returns True if the notification was sent successfully.\n\t */\n\tsendSinglePushNotification(\n\t\tdeviceAddress: string,\n\t\ttemplateId: string,\n\t\tdata: { [key: string]: string },\n\t\tlocale: string\n\t): Promise<boolean>;\n\n\t/**\n\t * Send a SMS message to a phone number.\n\t * @param phoneNumber The recipient phone number.\n\t * @param templateId The id of the SMS template.\n\t * @param data The data to populate the SMS template.\n\t * @param locale The locale of the SMS template.\n\t * @returns True if the SMS was sent successfully.\n\t */\n\tsendSMS(\n\t\tphoneNumber: string,\n\t\ttemplateId: string,\n\t\tdata: { [key: string]: string },\n\t\tlocale: string\n\t): Promise<boolean>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IMessagingEmailConnector.js","
|
|
1
|
+
{"version":3,"file":"IMessagingEmailConnector.js","sources":["../../../src/models/IMessagingEmailConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing the email messaging connector functionalities.\n */\nexport interface IMessagingEmailConnector extends IComponent {\n\t/**\n\t * Send a custom email.\n\t * @param sender The sender email address.\n\t * @param recipients An array of recipients email addresses.\n\t * @param subject The subject of the email.\n\t * @param content The html content of the email.\n\t * @returns True if the email was sent successfully.\n\t */\n\tsendCustomEmail(\n\t\tsender: string,\n\t\trecipients: string[],\n\t\tsubject: string,\n\t\tcontent: string\n\t): Promise<boolean>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IMessagingPushNotificationsConnector.js","
|
|
1
|
+
{"version":3,"file":"IMessagingPushNotificationsConnector.js","sources":["../../../src/models/IMessagingPushNotificationsConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing the push notifications messaging connector functionalities.\n */\nexport interface IMessagingPushNotificationsConnector extends IComponent {\n\t/**\n\t * Registers a device to a specific application in order to send notifications to it.\n\t * @param applicationAddress The application address.\n\t * @param deviceToken The device token.\n\t * @returns The address assigned to the registered device.\n\t */\n\tregisterDevice(applicationAddress: string, deviceToken: string): Promise<string>;\n\n\t/**\n\t * Send a push notification to a device.\n\t * @param deviceAddress The address of the device.\n\t * @param title The title of the notification.\n\t * @param message The message to send.\n\t * @returns True if the notification was sent successfully.\n\t */\n\tsendSinglePushNotification(\n\t\tdeviceAddress: string,\n\t\ttitle: string,\n\t\tmessage: string\n\t): Promise<boolean>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"IMessagingSmsConnector.js","
|
|
1
|
+
{"version":3,"file":"IMessagingSmsConnector.js","sources":["../../../src/models/IMessagingSmsConnector.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IComponent } from \"@3sixty/core\";\n\n/**\n * Interface describing the SMS messaging connector functionalities.\n */\nexport interface IMessagingSmsConnector extends IComponent {\n\t/**\n\t * Send a SMS message to a phone number.\n\t * @param phoneNumber The recipient phone number.\n\t * @param message The message to send.\n\t * @returns True if the SMS was sent successfully.\n\t */\n\tsendSMS(phoneNumber: string, message: string): Promise<boolean>;\n}\n"]}
|
package/docs/changelog.md
CHANGED
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# Changelog
|
|
2
|
+
|
|
3
|
+
## [0.20.0-next.1](https://github.com/3sixtyglobal/messaging/compare/messaging-models-v0.20.0-next.0...messaging-models-v0.20.0-next.1) (2026-10-23)
|
|
4
|
+
|
|
5
|
+
|
|
6
|
+
### Features
|
|
7
|
+
|
|
8
|
+
* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([8fd187c](https://github.com/3sixtyglobal/messaging/commit/8fd187cab6f54f164628d1d2a0129d4b7a1ba87d))
|
|
9
|
+
* updated ts compile ([293701e](https://github.com/3sixtyglobal/messaging/commit/293701e2acc20bb6bbcf2e2ff1a0d03f0b9a7a76))
|
|
@@ -36,6 +36,8 @@ The id of the email template.
|
|
|
36
36
|
|
|
37
37
|
##### data
|
|
38
38
|
|
|
39
|
+
\{\[`key`: `string`\]: `string`; \}
|
|
40
|
+
|
|
39
41
|
The data to populate the email template.
|
|
40
42
|
|
|
41
43
|
##### locale
|
|
@@ -102,6 +104,8 @@ The id of the push notification template.
|
|
|
102
104
|
|
|
103
105
|
##### data
|
|
104
106
|
|
|
107
|
+
\{\[`key`: `string`\]: `string`; \}
|
|
108
|
+
|
|
105
109
|
The data to populate the push notification template.
|
|
106
110
|
|
|
107
111
|
##### locale
|
|
@@ -140,6 +144,8 @@ The id of the SMS template.
|
|
|
140
144
|
|
|
141
145
|
##### data
|
|
142
146
|
|
|
147
|
+
\{\[`key`: `string`\]: `string`; \}
|
|
148
|
+
|
|
143
149
|
The data to populate the SMS template.
|
|
144
150
|
|
|
145
151
|
##### locale
|
package/package.json
CHANGED