@3sixty/messaging-models 0.0.0-stage → 0.20.0-next.1

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2024 IOTA Stiftung.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -1,3 +1,25 @@
-# Temporary Holding Version
+# 3Sixty Messaging Models
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+This package defines the shared models and factory helpers used by messaging connectors and services.
+
+## Installation
+
+```shell
+npm install @3sixty/messaging-models
+```
+
+## Examples
+
+Usage of the APIs is shown in the examples [docs/examples.md](docs/examples.md)
+
+## Reference
+
+Detailed reference documentation for the API can be found in [docs/reference/index.md](docs/reference/index.md)
+
+## Changelog
+
+The changes between each version can be found in [docs/changelog.md](docs/changelog.md)
+
+## Origin
+
+This package is derived from the original [iotaledger/twin-messaging](https://github.com/iotaledger/twin-messaging/tree/next/packages/messaging-models) repository.

package/dist/es/factories/messagingEmailConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating messaging email connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const MessagingEmailConnectorFactory = Factory.createFactory("messaging-email");
+//# sourceMappingURL=messagingEmailConnectorFactory.js.map

package/dist/es/factories/messagingEmailConnectorFactory.js.map

@@ -0,0 +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"]}

package/dist/es/factories/messagingPushNotificationsConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating messaging push notification connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const MessagingPushNotificationsConnectorFactory = Factory.createFactory("messaging-push-notifications");
+//# sourceMappingURL=messagingPushNotificationsConnectorFactory.js.map

package/dist/es/factories/messagingPushNotificationsConnectorFactory.js.map

@@ -0,0 +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"]}

package/dist/es/factories/messagingSmsConnectorFactory.js

@@ -0,0 +1,9 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { Factory } from "@3sixty/core";
+/**
+ * Factory for creating messaging sms connectors.
+ */
+// eslint-disable-next-line @typescript-eslint/naming-convention
+export const MessagingSmsConnectorFactory = Factory.createFactory("messaging-sms");
+//# sourceMappingURL=messagingSmsConnectorFactory.js.map

package/dist/es/factories/messagingSmsConnectorFactory.js.map

@@ -0,0 +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

@@ -0,0 +1,11 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./factories/messagingEmailConnectorFactory.js";
+export * from "./factories/messagingPushNotificationsConnectorFactory.js";
+export * from "./factories/messagingSmsConnectorFactory.js";
+export * from "./models/IMessagingAdminComponent.js";
+export * from "./models/IMessagingComponent.js";
+export * from "./models/IMessagingEmailConnector.js";
+export * from "./models/IMessagingPushNotificationsConnector.js";
+export * from "./models/IMessagingSmsConnector.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +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"]}

package/dist/es/models/IMessagingAdminComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMessagingAdminComponent.js.map

package/dist/es/models/IMessagingAdminComponent.js.map

@@ -0,0 +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"]}

package/dist/es/models/IMessagingComponent.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMessagingComponent.js.map

package/dist/es/models/IMessagingComponent.js.map

@@ -0,0 +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"]}

package/dist/es/models/IMessagingEmailConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMessagingEmailConnector.js.map

package/dist/es/models/IMessagingEmailConnector.js.map

@@ -0,0 +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"]}

package/dist/es/models/IMessagingPushNotificationsConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMessagingPushNotificationsConnector.js.map

package/dist/es/models/IMessagingPushNotificationsConnector.js.map

@@ -0,0 +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"]}

package/dist/es/models/IMessagingSmsConnector.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=IMessagingSmsConnector.js.map

package/dist/es/models/IMessagingSmsConnector.js.map

@@ -0,0 +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/dist/types/factories/messagingEmailConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IMessagingEmailConnector } from "../models/IMessagingEmailConnector.js";
+/**
+ * Factory for creating messaging email connectors.
+ */
+export declare const MessagingEmailConnectorFactory: Factory<IMessagingEmailConnector>;

package/dist/types/factories/messagingPushNotificationsConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IMessagingPushNotificationsConnector } from "../models/IMessagingPushNotificationsConnector.js";
+/**
+ * Factory for creating messaging push notification connectors.
+ */
+export declare const MessagingPushNotificationsConnectorFactory: Factory<IMessagingPushNotificationsConnector>;

package/dist/types/factories/messagingSmsConnectorFactory.d.ts

@@ -0,0 +1,6 @@
+import { Factory } from "@3sixty/core";
+import type { IMessagingSmsConnector } from "../models/IMessagingSmsConnector.js";
+/**
+ * Factory for creating messaging sms connectors.
+ */
+export declare const MessagingSmsConnectorFactory: Factory<IMessagingSmsConnector>;

package/dist/types/index.d.ts

@@ -0,0 +1,8 @@
+export * from "./factories/messagingEmailConnectorFactory.js";
+export * from "./factories/messagingPushNotificationsConnectorFactory.js";
+export * from "./factories/messagingSmsConnectorFactory.js";
+export * from "./models/IMessagingAdminComponent.js";
+export * from "./models/IMessagingComponent.js";
+export * from "./models/IMessagingEmailConnector.js";
+export * from "./models/IMessagingPushNotificationsConnector.js";
+export * from "./models/IMessagingSmsConnector.js";

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

@@ -0,0 +1,32 @@
+import type { IComponent } from "@3sixty/core";
+/**
+ * Interface describing the messaging admin component.
+ */
+export interface IMessagingAdminComponent extends IComponent {
+    /**
+     * Create or update a template.
+     * @param templateId The id of the template.
+     * @param locale The locale of the template.
+     * @param title The title of the template.
+     * @param content The content of the template.
+     * @returns A promise that resolves when the template has been stored.
+     */
+    setTemplate(templateId: string, locale: string, title: string, content: string): Promise<void>;
+    /**
+     * Get the email template by id and locale.
+     * @param templateId The id of the email template.
+     * @param locale The locale of the email template.
+     * @returns The email template.
+     */
+    getTemplate(templateId: string, locale: string): Promise<{
+        title: string;
+        content: string;
+    }>;
+    /**
+     * Remove a template.
+     * @param templateId The id of the template.
+     * @param locale The locale of the template.
+     * @returns A promise that resolves when the template has been removed.
+     */
+    removeTemplate(templateId: string, locale: string): Promise<void>;
+}

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

@@ -0,0 +1,47 @@
+import type { IComponent } from "@3sixty/core";
+/**
+ * Interface describing the messaging component.
+ */
+export interface IMessagingComponent extends IComponent {
+    /**
+     * Send a custom email.
+     * @param sender The sender email address.
+     * @param recipients An array of recipients email addresses.
+     * @param templateId The id of the email template.
+     * @param data The data to populate the email template.
+     * @param locale The locale of the email template.
+     * @returns True if the email was sent successfully.
+     */
+    sendCustomEmail(sender: string, recipients: string[], templateId: string, data: {
+        [key: string]: string;
+    }, locale: string): Promise<boolean>;
+    /**
+     * Registers a device to a specific application in order to send notifications to it.
+     * @param applicationAddress The application address.
+     * @param deviceToken The device token.
+     * @returns The address assigned to the registered device.
+     */
+    registerDevice(applicationAddress: string, deviceToken: string): Promise<string>;
+    /**
+     * Send a push notification to a device.
+     * @param deviceAddress The address of the device.
+     * @param templateId The id of the push notification template.
+     * @param data The data to populate the push notification template.
+     * @param locale The locale of the push notification template.
+     * @returns True if the notification was sent successfully.
+     */
+    sendSinglePushNotification(deviceAddress: string, templateId: string, data: {
+        [key: string]: string;
+    }, locale: string): Promise<boolean>;
+    /**
+     * Send a SMS message to a phone number.
+     * @param phoneNumber The recipient phone number.
+     * @param templateId The id of the SMS template.
+     * @param data The data to populate the SMS template.
+     * @param locale The locale of the SMS template.
+     * @returns True if the SMS was sent successfully.
+     */
+    sendSMS(phoneNumber: string, templateId: string, data: {
+        [key: string]: string;
+    }, locale: string): Promise<boolean>;
+}

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

@@ -0,0 +1,15 @@
+import type { IComponent } from "@3sixty/core";
+/**
+ * Interface describing the email messaging connector functionalities.
+ */
+export interface IMessagingEmailConnector extends IComponent {
+    /**
+     * Send a custom email.
+     * @param sender The sender email address.
+     * @param recipients An array of recipients email addresses.
+     * @param subject The subject of the email.
+     * @param content The html content of the email.
+     * @returns True if the email was sent successfully.
+     */
+    sendCustomEmail(sender: string, recipients: string[], subject: string, content: string): Promise<boolean>;
+}

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

@@ -0,0 +1,21 @@
+import type { IComponent } from "@3sixty/core";
+/**
+ * Interface describing the push notifications messaging connector functionalities.
+ */
+export interface IMessagingPushNotificationsConnector extends IComponent {
+    /**
+     * Registers a device to a specific application in order to send notifications to it.
+     * @param applicationAddress The application address.
+     * @param deviceToken The device token.
+     * @returns The address assigned to the registered device.
+     */
+    registerDevice(applicationAddress: 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 True if the notification was sent successfully.
+     */
+    sendSinglePushNotification(deviceAddress: string, title: string, message: string): Promise<boolean>;
+}

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

@@ -0,0 +1,13 @@
+import type { IComponent } from "@3sixty/core";
+/**
+ * Interface describing the SMS messaging connector functionalities.
+ */
+export interface IMessagingSmsConnector extends IComponent {
+    /**
+     * Send a SMS message to a phone number.
+     * @param phoneNumber The recipient phone number.
+     * @param message The message to send.
+     * @returns True if the SMS was sent successfully.
+     */
+    sendSMS(phoneNumber: string, message: string): Promise<boolean>;
+}

package/docs/changelog.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [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)
+
+
+### Features
+
+* publish packages under the [@3sixty](https://github.com/3sixty) namespace ([8fd187c](https://github.com/3sixtyglobal/messaging/commit/8fd187cab6f54f164628d1d2a0129d4b7a1ba87d))
+* updated ts compile ([293701e](https://github.com/3sixtyglobal/messaging/commit/293701e2acc20bb6bbcf2e2ff1a0d03f0b9a7a76))

package/docs/examples.md

@@ -0,0 +1,73 @@
+# Messaging Models Examples
+
+Use these examples to register connector implementations and resolve them through the shared factories.
+
+## MessagingPushNotificationsConnectorFactory
+
+```typescript
+import {
+  MessagingPushNotificationsConnectorFactory,
+  type IMessagingPushNotificationsConnector
+} from '@3sixty/messaging-models';
+
+MessagingPushNotificationsConnectorFactory.register(
+  'in-memory-push',
+  () =>
+    ({
+      registerDevice: async (applicationId: string, deviceToken: string) =>
+        `${applicationId}:${deviceToken}`,
+      sendSinglePushNotification: async () => true
+    }) as IMessagingPushNotificationsConnector
+);
+
+const pushConnector = MessagingPushNotificationsConnectorFactory.get('in-memory-push');
+const deviceAddress = await pushConnector.registerDevice('orders-app', 'token-001');
+console.log(deviceAddress); // orders-app:token-001
+```
+
+## MessagingEmailConnectorFactory
+
+```typescript
+import {
+  MessagingEmailConnectorFactory,
+  type IMessagingEmailConnector
+} from '@3sixty/messaging-models';
+
+MessagingEmailConnectorFactory.register(
+  'in-memory-email',
+  () =>
+    ({
+      sendCustomEmail: async () => true
+    }) as IMessagingEmailConnector
+);
+
+const emailConnector = MessagingEmailConnectorFactory.get('in-memory-email');
+const emailQueued = await emailConnector.sendCustomEmail(
+  'service@example.org',
+  ['recipient@example.org'],
+  'Welcome',
+  '<p>Thanks for signing up.</p>'
+);
+console.log(emailQueued); // true
+```
+
+## MessagingSmsConnectorFactory
+
+```typescript
+import {
+  MessagingSmsConnectorFactory,
+  type IMessagingSmsConnector
+} from '@3sixty/messaging-models';
+
+MessagingSmsConnectorFactory.register(
+  'in-memory-sms',
+  () =>
+    ({
+      sendSMS: async () => true
+    }) as IMessagingSmsConnector
+);
+
+const smsConnector = MessagingSmsConnectorFactory.get('in-memory-sms');
+const smsQueued = await smsConnector.sendSMS('+441234567890', 'Your one-time code is 482931');
+console.log(smsQueued); // true
+```

package/docs/reference/index.md

@@ -0,0 +1,15 @@
+# @3sixty/messaging-models
+
+## Interfaces
+
+- [IMessagingAdminComponent](interfaces/IMessagingAdminComponent.md)
+- [IMessagingComponent](interfaces/IMessagingComponent.md)
+- [IMessagingEmailConnector](interfaces/IMessagingEmailConnector.md)
+- [IMessagingPushNotificationsConnector](interfaces/IMessagingPushNotificationsConnector.md)
+- [IMessagingSmsConnector](interfaces/IMessagingSmsConnector.md)
+
+## Variables
+
+- [MessagingEmailConnectorFactory](variables/MessagingEmailConnectorFactory.md)
+- [MessagingPushNotificationsConnectorFactory](variables/MessagingPushNotificationsConnectorFactory.md)
+- [MessagingSmsConnectorFactory](variables/MessagingSmsConnectorFactory.md)

package/docs/reference/interfaces/IMessagingAdminComponent.md

@@ -0,0 +1,103 @@
+# Interface: IMessagingAdminComponent
+
+Interface describing the messaging admin component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### setTemplate() {#settemplate}
+
+> **setTemplate**(`templateId`, `locale`, `title`, `content`): `Promise`\<`void`\>
+
+Create or update a template.
+
+#### Parameters
+
+##### templateId
+
+`string`
+
+The id of the template.
+
+##### locale
+
+`string`
+
+The locale of the template.
+
+##### title
+
+`string`
+
+The title of the template.
+
+##### content
+
+`string`
+
+The content of the template.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the template has been stored.
+
+***
+
+### getTemplate() {#gettemplate}
+
+> **getTemplate**(`templateId`, `locale`): `Promise`\<\{ `title`: `string`; `content`: `string`; \}\>
+
+Get the email template by id and locale.
+
+#### Parameters
+
+##### templateId
+
+`string`
+
+The id of the email template.
+
+##### locale
+
+`string`
+
+The locale of the email template.
+
+#### Returns
+
+`Promise`\<\{ `title`: `string`; `content`: `string`; \}\>
+
+The email template.
+
+***
+
+### removeTemplate() {#removetemplate}
+
+> **removeTemplate**(`templateId`, `locale`): `Promise`\<`void`\>
+
+Remove a template.
+
+#### Parameters
+
+##### templateId
+
+`string`
+
+The id of the template.
+
+##### locale
+
+`string`
+
+The locale of the template.
+
+#### Returns
+
+`Promise`\<`void`\>
+
+A promise that resolves when the template has been removed.

package/docs/reference/interfaces/IMessagingComponent.md

@@ -0,0 +1,161 @@
+# Interface: IMessagingComponent
+
+Interface describing the messaging component.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### sendCustomEmail() {#sendcustomemail}
+
+> **sendCustomEmail**(`sender`, `recipients`, `templateId`, `data`, `locale`): `Promise`\<`boolean`\>
+
+Send a custom email.
+
+#### Parameters
+
+##### sender
+
+`string`
+
+The sender email address.
+
+##### recipients
+
+`string`[]
+
+An array of recipients email addresses.
+
+##### templateId
+
+`string`
+
+The id of the email template.
+
+##### data
+
+\{\[`key`: `string`\]: `string`; \}
+
+The data to populate the email template.
+
+##### locale
+
+`string`
+
+The locale of the email template.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the email was sent successfully.
+
+***
+
+### registerDevice() {#registerdevice}
+
+> **registerDevice**(`applicationAddress`, `deviceToken`): `Promise`\<`string`\>
+
+Registers a device to a specific application in order to send notifications to it.
+
+#### Parameters
+
+##### applicationAddress
+
+`string`
+
+The application address.
+
+##### deviceToken
+
+`string`
+
+The device token.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The address assigned to the registered device.
+
+***
+
+### sendSinglePushNotification() {#sendsinglepushnotification}
+
+> **sendSinglePushNotification**(`deviceAddress`, `templateId`, `data`, `locale`): `Promise`\<`boolean`\>
+
+Send a push notification to a device.
+
+#### Parameters
+
+##### deviceAddress
+
+`string`
+
+The address of the device.
+
+##### templateId
+
+`string`
+
+The id of the push notification template.
+
+##### data
+
+\{\[`key`: `string`\]: `string`; \}
+
+The data to populate the push notification template.
+
+##### locale
+
+`string`
+
+The locale of the push notification template.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the notification was sent successfully.
+
+***
+
+### sendSMS() {#sendsms}
+
+> **sendSMS**(`phoneNumber`, `templateId`, `data`, `locale`): `Promise`\<`boolean`\>
+
+Send a SMS message to a phone number.
+
+#### Parameters
+
+##### phoneNumber
+
+`string`
+
+The recipient phone number.
+
+##### templateId
+
+`string`
+
+The id of the SMS template.
+
+##### data
+
+\{\[`key`: `string`\]: `string`; \}
+
+The data to populate the SMS template.
+
+##### locale
+
+`string`
+
+The locale of the SMS template.
+
+#### Returns
+
+`Promise`\<`boolean`\>
+
+True if the SMS was sent successfully.

package/docs/reference/interfaces/IMessagingEmailConnector.md

@@ -0,0 +1,47 @@
+# Interface: IMessagingEmailConnector
+
+Interface describing the email messaging connector functionalities.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### sendCustomEmail() {#sendcustomemail}
+
+> **sendCustomEmail**(`sender`, `recipients`, `subject`, `content`): `Promise`\<`boolean`\>
+
+Send a custom email.
+
+#### 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 sent successfully.

package/docs/reference/interfaces/IMessagingPushNotificationsConnector.md

@@ -0,0 +1,69 @@
+# Interface: IMessagingPushNotificationsConnector
+
+Interface describing the push notifications messaging connector functionalities.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### registerDevice() {#registerdevice}
+
+> **registerDevice**(`applicationAddress`, `deviceToken`): `Promise`\<`string`\>
+
+Registers a device to a specific application in order to send notifications to it.
+
+#### Parameters
+
+##### applicationAddress
+
+`string`
+
+The application address.
+
+##### deviceToken
+
+`string`
+
+The device token.
+
+#### Returns
+
+`Promise`\<`string`\>
+
+The address assigned to the registered device.
+
+***
+
+### sendSinglePushNotification() {#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`\>
+
+True if the notification was sent successfully.

package/docs/reference/interfaces/IMessagingSmsConnector.md

@@ -0,0 +1,35 @@
+# Interface: IMessagingSmsConnector
+
+Interface describing the SMS messaging connector functionalities.
+
+## Extends
+
+- `IComponent`
+
+## Methods
+
+### sendSMS() {#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`\>
+
+True if the SMS was sent successfully.

package/docs/reference/variables/MessagingEmailConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: MessagingEmailConnectorFactory
+
+> `const` **MessagingEmailConnectorFactory**: `Factory`\<[`IMessagingEmailConnector`](../interfaces/IMessagingEmailConnector.md)\>
+
+Factory for creating messaging email connectors.

package/docs/reference/variables/MessagingPushNotificationsConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: MessagingPushNotificationsConnectorFactory
+
+> `const` **MessagingPushNotificationsConnectorFactory**: `Factory`\<[`IMessagingPushNotificationsConnector`](../interfaces/IMessagingPushNotificationsConnector.md)\>
+
+Factory for creating messaging push notification connectors.

package/docs/reference/variables/MessagingSmsConnectorFactory.md

@@ -0,0 +1,5 @@
+# Variable: MessagingSmsConnectorFactory
+
+> `const` **MessagingSmsConnectorFactory**: `Factory`\<[`IMessagingSmsConnector`](../interfaces/IMessagingSmsConnector.md)\>
+
+Factory for creating messaging sms connectors.

package/locales/en.json

@@ -0,0 +1 @@
+{}

package/package.json

@@ -1,6 +1,50 @@
 {
-  "name": "@3sixty/messaging-models",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+	"name": "@3sixty/messaging-models",
+	"version": "0.20.0-next.1",
+	"description": "Defines the shared models and factory helpers used by messaging connectors and services.",
+	"repository": {
+		"type": "git",
+		"url": "git+https://github.com/3sixtyglobal/messaging.git",
+		"directory": "packages/messaging-models"
+	},
+	"author": "adrian.sanchez.sequeira@iota.org",
+	"license": "Apache-2.0",
+	"type": "module",
+	"engines": {
+		"node": ">=24.0.0"
+	},
+	"dependencies": {
+		"@3sixty/core": "next",
+		"@3sixty/nameof": "next"
+	},
+	"main": "./dist/es/index.js",
+	"types": "./dist/types/index.d.ts",
+	"exports": {
+		".": {
+			"types": "./dist/types/index.d.ts",
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		}
+	},
+	"files": [
+		"dist/es",
+		"dist/types",
+		"locales",
+		"docs"
+	],
+	"keywords": [
+		"twin",
+		"trade",
+		"iota",
+		"framework",
+		"blockchain",
+		"messaging",
+		"models",
+		"types",
+		"schemas"
+	],
+	"bugs": {
+		"url": "git+https://github.com/3sixtyglobal/messaging/issues"
+	},
+	"homepage": "https://3sixty.global"
+}