@twin.org/messaging-service 0.0.2-next.6 → 0.0.3-next.2

package/dist/es/entities/templateEntry.js

@@ -0,0 +1,45 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { entity, property, SortDirection } from "@twin.org/entity";
+/**
+ * Call defining a template message entry.
+ */
+let TemplateEntry = class TemplateEntry {
+    /**
+     * The id.
+     */
+    id;
+    /**
+     * The title.
+     */
+    title;
+    /**
+     * The content.
+     */
+    content;
+    /**
+     * The timestamp of the template entry.
+     */
+    dateCreated;
+};
+__decorate([
+    property({ type: "string", isPrimary: true }),
+    __metadata("design:type", String)
+], TemplateEntry.prototype, "id", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TemplateEntry.prototype, "title", void 0);
+__decorate([
+    property({ type: "string" }),
+    __metadata("design:type", String)
+], TemplateEntry.prototype, "content", void 0);
+__decorate([
+    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
+    __metadata("design:type", String)
+], TemplateEntry.prototype, "dateCreated", void 0);
+TemplateEntry = __decorate([
+    entity()
+], TemplateEntry);
+export { TemplateEntry };
+//# sourceMappingURL=templateEntry.js.map

package/dist/es/entities/templateEntry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templateEntry.js","sourceRoot":"","sources":["../../../src/entities/templateEntry.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAC;AAEnE;;GAEG;AAEI,IAAM,aAAa,GAAnB,MAAM,aAAa;IACzB;;OAEG;IAEI,EAAE,CAAU;IAEnB;;OAEG;IAEI,KAAK,CAAU;IAEtB;;OAEG;IAEI,OAAO,CAAU;IAExB;;OAEG;IAEI,WAAW,CAAU;CAC5B,CAAA;AAnBO;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC;;yCAC3B;AAMZ;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;4CACP;AAMf;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,CAAC;;8CACL;AAMjB;IADN,QAAQ,CAAC,EAAE,IAAI,EAAE,QAAQ,EAAE,MAAM,EAAE,WAAW,EAAE,aAAa,EAAE,aAAa,CAAC,UAAU,EAAE,CAAC;;kDAC/D;AAvBhB,aAAa;IADzB,MAAM,EAAE;GACI,aAAa,CAwBzB","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { entity, property, SortDirection } from \"@twin.org/entity\";\n\n/**\n * Call defining a template message entry.\n */\n@entity()\nexport class TemplateEntry {\n\t/**\n\t * The id.\n\t */\n\t@property({ type: \"string\", isPrimary: true })\n\tpublic id!: string;\n\n\t/**\n\t * The title.\n\t */\n\t@property({ type: \"string\" })\n\tpublic title!: string;\n\n\t/**\n\t * The content.\n\t */\n\t@property({ type: \"string\" })\n\tpublic content!: string;\n\n\t/**\n\t * The timestamp of the template entry.\n\t */\n\t@property({ type: \"string\", format: \"date-time\", sortDirection: SortDirection.Descending })\n\tpublic dateCreated!: string;\n}\n"]}

package/dist/es/index.js

@@ -0,0 +1,10 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export * from "./entities/templateEntry.js";
+export * from "./messagingAdminService.js";
+export * from "./messagingService.js";
+export * from "./models/IMessagingAdminServiceConfig.js";
+export * from "./models/IMessagingAdminServiceConstructorOptions.js";
+export * from "./models/IMessagingServiceConstructorOptions.js";
+export * from "./schema.js";
+//# sourceMappingURL=index.js.map

package/dist/es/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,4BAA4B,CAAC;AAC3C,cAAc,uBAAuB,CAAC;AACtC,cAAc,0CAA0C,CAAC;AACzD,cAAc,sDAAsD,CAAC;AACrE,cAAc,iDAAiD,CAAC;AAChE,cAAc,aAAa,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nexport * from \"./entities/templateEntry.js\";\nexport * from \"./messagingAdminService.js\";\nexport * from \"./messagingService.js\";\nexport * from \"./models/IMessagingAdminServiceConfig.js\";\nexport * from \"./models/IMessagingAdminServiceConstructorOptions.js\";\nexport * from \"./models/IMessagingServiceConstructorOptions.js\";\nexport * from \"./schema.js\";\n"]}

package/dist/es/messagingAdminService.js

@@ -0,0 +1,106 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { GeneralError, Guards, Is } from "@twin.org/core";
+import { EntityStorageConnectorFactory } from "@twin.org/entity-storage-models";
+import { TemplateEntry } from "./entities/templateEntry.js";
+/**
+ * Service for performing email messaging operations to a connector.
+ */
+export class MessagingAdminService {
+    /**
+     * Runtime name for the class.
+     */
+    static CLASS_NAME = "MessagingAdminService";
+    /**
+     * Default locale for the messaging service.
+     */
+    static _DEFAULT_LOCALE = "en";
+    /**
+     * Entity storage connector used by the service.
+     * @internal
+     */
+    _entityStorageConnector;
+    /**
+     * The default locale to use for the messaging service.
+     * @internal
+     */
+    _defaultLocale;
+    /**
+     * Create a new instance of MessagingAdminService.
+     * @param options The options for the connector.
+     */
+    constructor(options) {
+        this._entityStorageConnector = EntityStorageConnectorFactory.get(options?.templateEntryStorageConnectorType ?? "template-entry");
+        this._defaultLocale = options?.config?.defaultLocale ?? MessagingAdminService._DEFAULT_LOCALE;
+    }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return MessagingAdminService.CLASS_NAME;
+    }
+    /**
+     * 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 Nothing.
+     */
+    async setTemplate(templateId, locale, title, content) {
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "title", title);
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "content", content);
+        const templateEntry = new TemplateEntry();
+        templateEntry.id = `${templateId}:${locale}`;
+        templateEntry.dateCreated = new Date(Date.now()).toISOString();
+        templateEntry.title = title;
+        templateEntry.content = content;
+        await this._entityStorageConnector.set(templateEntry);
+    }
+    /**
+     * 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.
+     */
+    async getTemplate(templateId, locale) {
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
+        let templateEntry;
+        try {
+            // First try to get the template for the requested locale
+            templateEntry = await this._entityStorageConnector.get(`${templateId}:${locale}`);
+        }
+        catch { }
+        // If the template is not found for the requested locale, try to get it for the default locale
+        // only if the requested locale is different from the default locale
+        if (Is.empty(templateEntry) && this._defaultLocale !== locale) {
+            try {
+                templateEntry = await this._entityStorageConnector.get(`${templateId}:${this._defaultLocale}`);
+            }
+            catch { }
+        }
+        if (Is.empty(templateEntry)) {
+            throw new GeneralError(MessagingAdminService.CLASS_NAME, "getTemplateFailed", {
+                templateId,
+                locale
+            });
+        }
+        return templateEntry;
+    }
+    /**
+     * Remove a template.
+     * @param templateId The id of the template.
+     * @param locale The locale of the template.
+     * @returns Nothing
+     */
+    async removeTemplate(templateId, locale) {
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
+        Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
+        return this._entityStorageConnector.remove(`${templateId}:${locale}`);
+    }
+}
+//# sourceMappingURL=messagingAdminService.js.map

package/dist/es/messagingAdminService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messagingAdminService.js","sourceRoot":"","sources":["../../src/messagingAdminService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAC1D,OAAO,EACN,6BAA6B,EAE7B,MAAM,iCAAiC,CAAC;AAGzC,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAG5D;;GAEG;AACH,MAAM,OAAO,qBAAqB;IACjC;;OAEG;IACI,MAAM,CAAU,UAAU,2BAA2C;IAE5E;;OAEG;IACK,MAAM,CAAU,eAAe,GAAW,IAAI,CAAC;IAEvD;;;OAGG;IACc,uBAAuB,CAAyC;IAEjF;;;OAGG;IACc,cAAc,CAAS;IAExC;;;OAGG;IACH,YAAY,OAAkD;QAC7D,IAAI,CAAC,uBAAuB,GAAG,6BAA6B,CAAC,GAAG,CAC/D,OAAO,EAAE,iCAAiC,IAAI,gBAAgB,CAC9D,CAAC;QAEF,IAAI,CAAC,cAAc,GAAG,OAAO,EAAE,MAAM,EAAE,aAAa,IAAI,qBAAqB,CAAC,eAAe,CAAC;IAC/F,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,qBAAqB,CAAC,UAAU,CAAC;IACzC,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,WAAW,CACvB,UAAkB,EAClB,MAAc,EACd,KAAa,EACb,OAAe;QAEf,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QACrF,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAC7E,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,WAAiB,KAAK,CAAC,CAAC;QAC3E,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,aAAmB,OAAO,CAAC,CAAC;QAE/E,MAAM,aAAa,GAAG,IAAI,aAAa,EAAE,CAAC;QAC1C,aAAa,CAAC,EAAE,GAAG,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC;QAC7C,aAAa,CAAC,WAAW,GAAG,IAAI,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC/D,aAAa,CAAC,KAAK,GAAG,KAAK,CAAC;QAC5B,aAAa,CAAC,OAAO,GAAG,OAAO,CAAC;QAEhC,MAAM,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,aAAa,CAAC,CAAC;IACvD,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,WAAW,CACvB,UAAkB,EAClB,MAAc;QAEd,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QACrF,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAE7E,IAAI,aAAa,CAAC;QAElB,IAAI,CAAC;YACJ,yDAAyD;YACzD,aAAa,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,GAAG,CAAC,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC,CAAC;QACnF,CAAC;QAAC,MAAM,CAAC,CAAA,CAAC;QAEV,8FAA8F;QAC9F,oEAAoE;QACpE,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,IAAI,IAAI,CAAC,cAAc,KAAK,MAAM,EAAE,CAAC;YAC/D,IAAI,CAAC;gBACJ,aAAa,GAAG,MAAM,IAAI,CAAC,uBAAuB,CAAC,GAAG,CACrD,GAAG,UAAU,IAAI,IAAI,CAAC,cAAc,EAAE,CACtC,CAAC;YACH,CAAC;YAAC,MAAM,CAAC,CAAA,CAAC;QACX,CAAC;QAED,IAAI,EAAE,CAAC,KAAK,CAAC,aAAa,CAAC,EAAE,CAAC;YAC7B,MAAM,IAAI,YAAY,CAAC,qBAAqB,CAAC,UAAU,EAAE,mBAAmB,EAAE;gBAC7E,UAAU;gBACV,MAAM;aACN,CAAC,CAAC;QACJ,CAAC;QAED,OAAO,aAAa,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,UAAkB,EAAE,MAAc;QAC7D,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QACrF,MAAM,CAAC,WAAW,CAAC,qBAAqB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAE7E,OAAO,IAAI,CAAC,uBAAuB,CAAC,MAAM,CAAC,GAAG,UAAU,IAAI,MAAM,EAAE,CAAC,CAAC;IACvE,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { GeneralError, Guards, Is } from \"@twin.org/core\";\nimport {\n\tEntityStorageConnectorFactory,\n\ttype IEntityStorageConnector\n} from \"@twin.org/entity-storage-models\";\nimport type { IMessagingAdminComponent } from \"@twin.org/messaging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { TemplateEntry } from \"./entities/templateEntry.js\";\nimport type { IMessagingAdminServiceConstructorOptions } from \"./models/IMessagingAdminServiceConstructorOptions.js\";\n\n/**\n * Service for performing email messaging operations to a connector.\n */\nexport class MessagingAdminService implements IMessagingAdminComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<MessagingAdminService>();\n\n\t/**\n\t * Default locale for the messaging service.\n\t */\n\tprivate static readonly _DEFAULT_LOCALE: string = \"en\";\n\n\t/**\n\t * Entity storage connector used by the service.\n\t * @internal\n\t */\n\tprivate readonly _entityStorageConnector: IEntityStorageConnector<TemplateEntry>;\n\n\t/**\n\t * The default locale to use for the messaging service.\n\t * @internal\n\t */\n\tprivate readonly _defaultLocale: string;\n\n\t/**\n\t * Create a new instance of MessagingAdminService.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options?: IMessagingAdminServiceConstructorOptions) {\n\t\tthis._entityStorageConnector = EntityStorageConnectorFactory.get(\n\t\t\toptions?.templateEntryStorageConnectorType ?? \"template-entry\"\n\t\t);\n\n\t\tthis._defaultLocale = options?.config?.defaultLocale ?? MessagingAdminService._DEFAULT_LOCALE;\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn MessagingAdminService.CLASS_NAME;\n\t}\n\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 Nothing.\n\t */\n\tpublic async setTemplate(\n\t\ttemplateId: string,\n\t\tlocale: string,\n\t\ttitle: string,\n\t\tcontent: string\n\t): Promise<void> {\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(templateId), templateId);\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(locale), locale);\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(title), title);\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(content), content);\n\n\t\tconst templateEntry = new TemplateEntry();\n\t\ttemplateEntry.id = `${templateId}:${locale}`;\n\t\ttemplateEntry.dateCreated = new Date(Date.now()).toISOString();\n\t\ttemplateEntry.title = title;\n\t\ttemplateEntry.content = content;\n\n\t\tawait this._entityStorageConnector.set(templateEntry);\n\t}\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\tpublic async getTemplate(\n\t\ttemplateId: string,\n\t\tlocale: string\n\t): Promise<{ title: string; content: string }> {\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(templateId), templateId);\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(locale), locale);\n\n\t\tlet templateEntry;\n\n\t\ttry {\n\t\t\t// First try to get the template for the requested locale\n\t\t\ttemplateEntry = await this._entityStorageConnector.get(`${templateId}:${locale}`);\n\t\t} catch {}\n\n\t\t// If the template is not found for the requested locale, try to get it for the default locale\n\t\t// only if the requested locale is different from the default locale\n\t\tif (Is.empty(templateEntry) && this._defaultLocale !== locale) {\n\t\t\ttry {\n\t\t\t\ttemplateEntry = await this._entityStorageConnector.get(\n\t\t\t\t\t`${templateId}:${this._defaultLocale}`\n\t\t\t\t);\n\t\t\t} catch {}\n\t\t}\n\n\t\tif (Is.empty(templateEntry)) {\n\t\t\tthrow new GeneralError(MessagingAdminService.CLASS_NAME, \"getTemplateFailed\", {\n\t\t\t\ttemplateId,\n\t\t\t\tlocale\n\t\t\t});\n\t\t}\n\n\t\treturn templateEntry;\n\t}\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 Nothing\n\t */\n\tpublic async removeTemplate(templateId: string, locale: string): Promise<void> {\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(templateId), templateId);\n\t\tGuards.stringValue(MessagingAdminService.CLASS_NAME, nameof(locale), locale);\n\n\t\treturn this._entityStorageConnector.remove(`${templateId}:${locale}`);\n\t}\n}\n"]}

package/dist/{esm/index.mjs → es/messagingService.js}

@@ -1,174 +1,11 @@
-import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { Is, Guards, GeneralError, ComponentFactory } from '@twin.org/core';
-import { EntityStorageConnectorFactory } from '@twin.org/entity-storage-models';
-import { MessagingEmailConnectorFactory, MessagingPushNotificationsConnectorFactory, MessagingSmsConnectorFactory } from '@twin.org/messaging-models';
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Call defining a template message entry.
- */
-let TemplateEntry = class TemplateEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The title.
-     */
-    title;
-    /**
-     * The content.
-     */
-    content;
-    /**
-     * The timestamp of the template entry.
-     */
-    dateCreated;
-};
-__decorate([
-    property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "id", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "title", void 0);
-__decorate([
-    property({ type: "string" }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "content", void 0);
-__decorate([
-    property({ type: "string", format: "date-time", sortDirection: SortDirection.Descending }),
-    __metadata("design:type", String)
-], TemplateEntry.prototype, "dateCreated", void 0);
-TemplateEntry = __decorate([
-    entity()
-], TemplateEntry);
-
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
+import { ComponentFactory, GeneralError, Guards, Is } from "@twin.org/core";
+import { MessagingEmailConnectorFactory, MessagingPushNotificationsConnectorFactory, MessagingSmsConnectorFactory } from "@twin.org/messaging-models";
 /**
  * Service for performing email messaging operations to a connector.
  */
-class MessagingAdminService {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "MessagingAdminService";
-    /**
-     * Default locale for the messaging service.
-     */
-    static _DEFAULT_LOCALE = "en";
-    /**
-     * Entity storage connector used by the service.
-     * @internal
-     */
-    _entityStorageConnector;
-    /**
-     * The default locale to use for the messaging service.
-     * @internal
-     */
-    _defaultLocale;
-    /**
-     * Initial set of templates to create on startup.
-     * @internal
-     */
-    _initialTemplates;
-    /**
-     * Create a new instance of MessagingAdminService.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._entityStorageConnector = EntityStorageConnectorFactory.get(options?.templateEntryStorageConnectorType ?? "template-entry");
-        this._defaultLocale = options?.config?.defaultLocale ?? MessagingAdminService._DEFAULT_LOCALE;
-        this._initialTemplates = options?.config?.templates;
-    }
-    /**
-     * The component needs to be started when the node is initialized.
-     * @param nodeIdentity The identity of the node starting the component.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
-     */
-    async start(nodeIdentity, nodeLoggingComponentType) {
-        if (Is.arrayValue(this._initialTemplates)) {
-            for (const template of this._initialTemplates) {
-                for (const locale of Object.keys(template.content)) {
-                    await this.setTemplate(template.templateId, locale, template.title, template.content[locale]);
-                }
-            }
-        }
-    }
-    /**
-     * 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 Nothing.
-     */
-    async setTemplate(templateId, locale, title, content) {
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "title", title);
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "content", content);
-        const templateEntry = new TemplateEntry();
-        templateEntry.id = `${templateId}:${locale}`;
-        templateEntry.dateCreated = new Date(Date.now()).toISOString();
-        templateEntry.title = title;
-        templateEntry.content = content;
-        await this._entityStorageConnector.set(templateEntry);
-    }
-    /**
-     * 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.
-     */
-    async getTemplate(templateId, locale) {
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
-        let templateEntry;
-        try {
-            // First try to get the template for the requested locale
-            templateEntry = await this._entityStorageConnector.get(`${templateId}:${locale}`);
-        }
-        catch { }
-        // If the template is not found for the requested locale, try to get it for the default locale
-        // only if the requested locale is different from the default locale
-        if (Is.empty(templateEntry) && this._defaultLocale !== locale) {
-            try {
-                templateEntry = await this._entityStorageConnector.get(`${templateId}:${this._defaultLocale}`);
-            }
-            catch { }
-        }
-        if (Is.empty(templateEntry)) {
-            throw new GeneralError(MessagingAdminService.CLASS_NAME, "getTemplateFailed", {
-                templateId,
-                locale
-            });
-        }
-        return templateEntry;
-    }
-    /**
-     * Remove a template.
-     * @param templateId The id of the template.
-     * @param locale The locale of the template.
-     * @returns Nothing
-     */
-    async removeTemplate(templateId, locale) {
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
-        return this._entityStorageConnector.remove(`${templateId}:${locale}`);
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing email messaging operations to a connector.
- */
-class MessagingService {
+export class MessagingService {
     /**
      * Runtime name for the class.
      */
@@ -209,6 +46,13 @@ class MessagingService {
         }
         this._messagingAdminComponent = ComponentFactory.get(options?.messagingAdminComponentType ?? "messaging-admin");
     }
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className() {
+        return MessagingService.CLASS_NAME;
+    }
     /**
      * Send a custom email.
      * @param sender The sender email address.
@@ -309,14 +153,4 @@ class MessagingService {
         };
     }
 }
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialize the schema for the messaging service.
- */
-function initSchema() {
-    EntitySchemaFactory.register("TemplateEntry", () => EntitySchemaHelper.getSchema(TemplateEntry));
-}
-
-export { MessagingAdminService, MessagingService, TemplateEntry, initSchema };
+//# sourceMappingURL=messagingService.js.map

package/dist/es/messagingService.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"messagingService.js","sourceRoot":"","sources":["../../src/messagingService.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,gBAAgB,EAAE,YAAY,EAAE,MAAM,EAAE,EAAE,EAAE,MAAM,gBAAgB,CAAC;AAC5E,OAAO,EAEN,8BAA8B,EAC9B,0CAA0C,EAC1C,4BAA4B,EAK5B,MAAM,4BAA4B,CAAC;AAIpC;;GAEG;AACH,MAAM,OAAO,gBAAgB;IAC5B;;OAEG;IACI,MAAM,CAAU,UAAU,sBAAsC;IAEvE;;;OAGG;IACc,wBAAwB,CAA4B;IAErE;;;OAGG;IACc,mCAAmC,CAAwC;IAE5F;;;OAGG;IACc,sBAAsB,CAA0B;IAEjE;;;OAGG;IACc,wBAAwB,CAA2B;IAEpE;;;OAGG;IACH,YAAY,OAA6C;QACxD,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,2BAA2B,CAAC,EAAE,CAAC;YAC1D,IAAI,CAAC,wBAAwB,GAAG,8BAA8B,CAAC,GAAG,CACjE,OAAO,CAAC,2BAA2B,CACnC,CAAC;QACH,CAAC;QAED,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,sCAAsC,CAAC,EAAE,CAAC;YACrE,IAAI,CAAC,mCAAmC,GAAG,0CAA0C,CAAC,GAAG,CACxF,OAAO,CAAC,sCAAsC,CAC9C,CAAC;QACH,CAAC;QAED,IAAI,EAAE,CAAC,WAAW,CAAC,OAAO,EAAE,yBAAyB,CAAC,EAAE,CAAC;YACxD,IAAI,CAAC,sBAAsB,GAAG,4BAA4B,CAAC,GAAG,CAC7D,OAAO,CAAC,yBAAyB,CACjC,CAAC;QACH,CAAC;QAED,IAAI,CAAC,wBAAwB,GAAG,gBAAgB,CAAC,GAAG,CACnD,OAAO,EAAE,2BAA2B,IAAI,iBAAiB,CACzD,CAAC;IACH,CAAC;IAED;;;OAGG;IACI,SAAS;QACf,OAAO,gBAAgB,CAAC,UAAU,CAAC;IACpC,CAAC;IAED;;;;;;;;OAQG;IACI,KAAK,CAAC,eAAe,CAC3B,MAAc,EACd,UAAoB,EACpB,UAAkB,EAClB,IAA+B,EAC/B,MAAc;QAEd,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC7C,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,UAAU,EAAE,sCAAsC,CAAC,CAAC;QAC7F,CAAC;QAED,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QACxE,MAAM,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAC/E,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAChF,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACrF,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEhE,OAAO,IAAI,CAAC,wBAAwB,CAAC,eAAe,CACnD,MAAM,EACN,UAAU,EACV,iBAAiB,CAAC,KAAK,EACvB,iBAAiB,CAAC,OAAO,CACzB,CAAC;IACH,CAAC;IAED;;;;;OAKG;IACI,KAAK,CAAC,cAAc,CAAC,aAAqB,EAAE,WAAmB;QACrE,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAmC,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,YAAY,CACrB,gBAAgB,CAAC,UAAU,EAC3B,iDAAiD,CACjD,CAAC;QACH,CAAC;QAED,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,mBAAyB,aAAa,CAAC,CAAC;QACtF,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAElF,OAAO,IAAI,CAAC,mCAAmC,CAAC,cAAc,CAAC,aAAa,EAAE,WAAW,CAAC,CAAC;IAC5F,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,0BAA0B,CACtC,aAAqB,EACrB,UAAkB,EAClB,IAA+B,EAC/B,MAAc;QAEd,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,mCAAmC,CAAC,EAAE,CAAC;YACxD,MAAM,IAAI,YAAY,CACrB,gBAAgB,CAAC,UAAU,EAC3B,iDAAiD,CACjD,CAAC;QACH,CAAC;QAED,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,mBAAyB,aAAa,CAAC,CAAC;QACtF,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAChF,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACrF,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEhE,OAAO,IAAI,CAAC,mCAAmC,CAAC,0BAA0B,CACzE,aAAa,EACb,iBAAiB,CAAC,KAAK,EACvB,iBAAiB,CAAC,OAAO,CACzB,CAAC;IACH,CAAC;IAED;;;;;;;OAOG;IACI,KAAK,CAAC,OAAO,CACnB,WAAmB,EACnB,UAAkB,EAClB,IAA+B,EAC/B,MAAc;QAEd,IAAI,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,sBAAsB,CAAC,EAAE,CAAC;YAC3C,MAAM,IAAI,YAAY,CAAC,gBAAgB,CAAC,UAAU,EAAE,oCAAoC,CAAC,CAAC;QAC3F,CAAC;QAED,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,iBAAuB,WAAW,CAAC,CAAC;QAClF,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,gBAAsB,UAAU,CAAC,CAAC;QAChF,MAAM,CAAC,MAAM,CAAC,gBAAgB,CAAC,UAAU,UAAgB,IAAI,CAAC,CAAC;QAC/D,MAAM,CAAC,WAAW,CAAC,gBAAgB,CAAC,UAAU,YAAkB,MAAM,CAAC,CAAC;QAExE,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,wBAAwB,CAAC,WAAW,CAAC,UAAU,EAAE,MAAM,CAAC,CAAC;QACrF,MAAM,iBAAiB,GAAG,IAAI,CAAC,gBAAgB,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEhE,OAAO,IAAI,CAAC,sBAAsB,CAAC,OAAO,CAAC,WAAW,EAAE,iBAAiB,CAAC,OAAO,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACK,gBAAgB,CACvB,QAA4C,EAC5C,IAA+B;QAE/B,IAAI,cAAc,GAAG,QAAQ,CAAC,KAAK,CAAC;QACpC,IAAI,gBAAgB,GAAG,QAAQ,CAAC,OAAO,CAAC;QAExC,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;YACxB,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC;YACxB,MAAM,WAAW,GAAG,KAAK,GAAG,IAAI,CAAC;YACjC,cAAc,GAAG,cAAc,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;YAC7E,gBAAgB,GAAG,gBAAgB,CAAC,OAAO,CAAC,IAAI,MAAM,CAAC,WAAW,EAAE,GAAG,CAAC,EAAE,KAAK,CAAC,CAAC;QAClF,CAAC;QAED,OAAO;YACN,KAAK,EAAE,cAAc;YACrB,OAAO,EAAE,gBAAgB;SACzB,CAAC;IACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { ComponentFactory, GeneralError, Guards, Is } from \"@twin.org/core\";\nimport {\n\ttype IMessagingAdminComponent,\n\tMessagingEmailConnectorFactory,\n\tMessagingPushNotificationsConnectorFactory,\n\tMessagingSmsConnectorFactory,\n\ttype IMessagingComponent,\n\ttype IMessagingEmailConnector,\n\ttype IMessagingPushNotificationsConnector,\n\ttype IMessagingSmsConnector\n} from \"@twin.org/messaging-models\";\nimport { nameof } from \"@twin.org/nameof\";\nimport type { IMessagingServiceConstructorOptions } from \"./models/IMessagingServiceConstructorOptions.js\";\n\n/**\n * Service for performing email messaging operations to a connector.\n */\nexport class MessagingService implements IMessagingComponent {\n\t/**\n\t * Runtime name for the class.\n\t */\n\tpublic static readonly CLASS_NAME: string = nameof<MessagingService>();\n\n\t/**\n\t * Emails messaging connector used by the service.\n\t * @internal\n\t */\n\tprivate readonly _emailMessagingConnector?: IMessagingEmailConnector;\n\n\t/**\n\t * Push notifications messaging connector used by the service.\n\t * @internal\n\t */\n\tprivate readonly _pushNotificationMessagingConnector?: IMessagingPushNotificationsConnector;\n\n\t/**\n\t * SMS messaging connector used by the service.\n\t * @internal\n\t */\n\tprivate readonly _smsMessagingConnector?: IMessagingSmsConnector;\n\n\t/**\n\t * The admin component for the messaging.\n\t * @internal\n\t */\n\tprivate readonly _messagingAdminComponent: IMessagingAdminComponent;\n\n\t/**\n\t * Create a new instance of MessagingService.\n\t * @param options The options for the connector.\n\t */\n\tconstructor(options?: IMessagingServiceConstructorOptions) {\n\t\tif (Is.stringValue(options?.messagingEmailConnectorType)) {\n\t\t\tthis._emailMessagingConnector = MessagingEmailConnectorFactory.get(\n\t\t\t\toptions.messagingEmailConnectorType\n\t\t\t);\n\t\t}\n\n\t\tif (Is.stringValue(options?.messagingPushNotificationConnectorType)) {\n\t\t\tthis._pushNotificationMessagingConnector = MessagingPushNotificationsConnectorFactory.get(\n\t\t\t\toptions.messagingPushNotificationConnectorType\n\t\t\t);\n\t\t}\n\n\t\tif (Is.stringValue(options?.messagingSmsConnectorType)) {\n\t\t\tthis._smsMessagingConnector = MessagingSmsConnectorFactory.get(\n\t\t\t\toptions.messagingSmsConnectorType\n\t\t\t);\n\t\t}\n\n\t\tthis._messagingAdminComponent = ComponentFactory.get(\n\t\t\toptions?.messagingAdminComponentType ?? \"messaging-admin\"\n\t\t);\n\t}\n\n\t/**\n\t * Returns the class name of the component.\n\t * @returns The class name of the component.\n\t */\n\tpublic className(): string {\n\t\treturn MessagingService.CLASS_NAME;\n\t}\n\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 If the email was sent successfully.\n\t */\n\tpublic async sendCustomEmail(\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\t\tif (Is.empty(this._emailMessagingConnector)) {\n\t\t\tthrow new GeneralError(MessagingService.CLASS_NAME, \"notConfiguredEmailMessagingConnector\");\n\t\t}\n\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(sender), sender);\n\t\tGuards.arrayValue(MessagingService.CLASS_NAME, nameof(recipients), recipients);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(templateId), templateId);\n\t\tGuards.object(MessagingService.CLASS_NAME, nameof(data), data);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(locale), locale);\n\n\t\tconst template = await this._messagingAdminComponent.getTemplate(templateId, locale);\n\t\tconst populatedTemplate = this.populateTemplate(template, data);\n\n\t\treturn this._emailMessagingConnector.sendCustomEmail(\n\t\t\tsender,\n\t\t\trecipients,\n\t\t\tpopulatedTemplate.title,\n\t\t\tpopulatedTemplate.content\n\t\t);\n\t}\n\n\t/**\n\t * Registers a device to an specific app in order to send notifications to it.\n\t * @param applicationId The application address.\n\t * @param deviceToken The device token.\n\t * @returns If the device was registered successfully.\n\t */\n\tpublic async registerDevice(applicationId: string, deviceToken: string): Promise<string> {\n\t\tif (Is.empty(this._pushNotificationMessagingConnector)) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tMessagingService.CLASS_NAME,\n\t\t\t\t\"notConfiguredPushNotificationMessagingConnector\"\n\t\t\t);\n\t\t}\n\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(applicationId), applicationId);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(deviceToken), deviceToken);\n\n\t\treturn this._pushNotificationMessagingConnector.registerDevice(applicationId, deviceToken);\n\t}\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 If the notification was sent successfully.\n\t */\n\tpublic async sendSinglePushNotification(\n\t\tdeviceAddress: string,\n\t\ttemplateId: string,\n\t\tdata: { [key: string]: string },\n\t\tlocale: string\n\t): Promise<boolean> {\n\t\tif (Is.empty(this._pushNotificationMessagingConnector)) {\n\t\t\tthrow new GeneralError(\n\t\t\t\tMessagingService.CLASS_NAME,\n\t\t\t\t\"notConfiguredPushNotificationMessagingConnector\"\n\t\t\t);\n\t\t}\n\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(deviceAddress), deviceAddress);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(templateId), templateId);\n\t\tGuards.object(MessagingService.CLASS_NAME, nameof(data), data);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(locale), locale);\n\n\t\tconst template = await this._messagingAdminComponent.getTemplate(templateId, locale);\n\t\tconst populatedTemplate = this.populateTemplate(template, data);\n\n\t\treturn this._pushNotificationMessagingConnector.sendSinglePushNotification(\n\t\t\tdeviceAddress,\n\t\t\tpopulatedTemplate.title,\n\t\t\tpopulatedTemplate.content\n\t\t);\n\t}\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 If the SMS was sent successfully.\n\t */\n\tpublic async sendSMS(\n\t\tphoneNumber: string,\n\t\ttemplateId: string,\n\t\tdata: { [key: string]: string },\n\t\tlocale: string\n\t): Promise<boolean> {\n\t\tif (Is.empty(this._smsMessagingConnector)) {\n\t\t\tthrow new GeneralError(MessagingService.CLASS_NAME, \"notConfiguredSmsMessagingConnector\");\n\t\t}\n\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(phoneNumber), phoneNumber);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(templateId), templateId);\n\t\tGuards.object(MessagingService.CLASS_NAME, nameof(data), data);\n\t\tGuards.stringValue(MessagingService.CLASS_NAME, nameof(locale), locale);\n\n\t\tconst template = await this._messagingAdminComponent.getTemplate(templateId, locale);\n\t\tconst populatedTemplate = this.populateTemplate(template, data);\n\n\t\treturn this._smsMessagingConnector.sendSMS(phoneNumber, populatedTemplate.content);\n\t}\n\n\t/**\n\t * Populate the template with data.\n\t * @param template The template.\n\t * @param template.title The title of the template.\n\t * @param template.content The content of the template.\n\t * @param data The data to populate the template.\n\t * @internal\n\t * @returns The populated template.\n\t */\n\tprivate populateTemplate(\n\t\ttemplate: { title: string; content: string },\n\t\tdata: { [key: string]: string }\n\t): { title: string; content: string } {\n\t\tlet populatedTitle = template.title;\n\t\tlet populatedContent = template.content;\n\n\t\tfor (const key in data) {\n\t\t\tconst value = data[key];\n\t\t\tconst placeholder = `{{${key}}}`;\n\t\t\tpopulatedTitle = populatedTitle.replace(new RegExp(placeholder, \"g\"), value);\n\t\t\tpopulatedContent = populatedContent.replace(new RegExp(placeholder, \"g\"), value);\n\t\t}\n\n\t\treturn {\n\t\t\ttitle: populatedTitle,\n\t\t\tcontent: populatedContent\n\t\t};\n\t}\n}\n"]}

package/dist/es/models/IMessagingAdminServiceConfig.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMessagingAdminServiceConfig.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IMessagingAdminServiceConfig.js","sourceRoot":"","sources":["../../../src/models/IMessagingAdminServiceConfig.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the messaging service.\n */\nexport interface IMessagingAdminServiceConfig {\n\t/**\n\t * The default locale to use for the messaging service.\n\t * @default en\n\t */\n\tdefaultLocale?: string;\n}\n"]}

package/dist/es/models/IMessagingAdminServiceConstructorOptions.js

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

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

@@ -0,0 +1 @@
+{"version":3,"file":"IMessagingAdminServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IMessagingAdminServiceConstructorOptions.ts"],"names":[],"mappings":"","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport type { IMessagingAdminServiceConfig } from \"./IMessagingAdminServiceConfig.js\";\n\n/**\n * Options for the messaging admin service.\n */\nexport interface IMessagingAdminServiceConstructorOptions {\n\t/**\n\t * The type of the entity connector to use.\n\t * @default template-entry\n\t */\n\ttemplateEntryStorageConnectorType?: string;\n\n\t/**\n\t * The configuration for the messaging admin service.\n\t */\n\tconfig?: IMessagingAdminServiceConfig;\n}\n"]}

package/dist/es/models/IMessagingServiceConstructorOptions.js

@@ -0,0 +1,4 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+export {};
+//# sourceMappingURL=IMessagingServiceConstructorOptions.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"IMessagingServiceConstructorOptions.js","sourceRoot":"","sources":["../../../src/models/IMessagingServiceConstructorOptions.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\n\n/**\n * Options for the messaging service.\n */\nexport interface IMessagingServiceConstructorOptions {\n\t/**\n\t * The type of the email messaging connector to use, defaults to not configured.\n\t */\n\tmessagingEmailConnectorType?: string;\n\n\t/**\n\t * The type of the push notifications messaging connector to use, defaults to not configured.\n\t */\n\tmessagingPushNotificationConnectorType?: string;\n\n\t/**\n\t * The type of the sms messaging connector to use, defaults to not configured.\n\t */\n\tmessagingSmsConnectorType?: string;\n\n\t/**\n\t * The type of the messaging admin component to use.\n\t * @default messaging-admin\n\t */\n\tmessagingAdminComponentType?: string;\n}\n"]}

package/dist/es/schema.js

@@ -0,0 +1,11 @@
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+import { EntitySchemaFactory, EntitySchemaHelper } from "@twin.org/entity";
+import { TemplateEntry } from "./entities/templateEntry.js";
+/**
+ * Initialize the schema for the messaging service.
+ */
+export function initSchema() {
+    EntitySchemaFactory.register("TemplateEntry", () => EntitySchemaHelper.getSchema(TemplateEntry));
+}
+//# sourceMappingURL=schema.js.map

package/dist/es/schema.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../src/schema.ts"],"names":[],"mappings":"AAAA,gCAAgC;AAChC,uCAAuC;AACvC,OAAO,EAAE,mBAAmB,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAC;AAE3E,OAAO,EAAE,aAAa,EAAE,MAAM,6BAA6B,CAAC;AAE5D;;GAEG;AACH,MAAM,UAAU,UAAU;IACzB,mBAAmB,CAAC,QAAQ,kBAA0B,GAAG,EAAE,CAC1D,kBAAkB,CAAC,SAAS,CAAC,aAAa,CAAC,CAC3C,CAAC;AACH,CAAC","sourcesContent":["// Copyright 2024 IOTA Stiftung.\n// SPDX-License-Identifier: Apache-2.0.\nimport { EntitySchemaFactory, EntitySchemaHelper } from \"@twin.org/entity\";\nimport { nameof } from \"@twin.org/nameof\";\nimport { TemplateEntry } from \"./entities/templateEntry.js\";\n\n/**\n * Initialize the schema for the messaging service.\n */\nexport function initSchema(): void {\n\tEntitySchemaFactory.register(nameof<TemplateEntry>(), () =>\n\t\tEntitySchemaHelper.getSchema(TemplateEntry)\n\t);\n}\n"]}

package/dist/types/index.d.ts

@@ -1,7 +1,7 @@
-export * from "./entities/templateEntry";
-export * from "./messagingAdminService";
-export * from "./messagingService";
-export * from "./models/IMessagingAdminServiceConfig";
-export * from "./models/IMessagingAdminServiceConstructorOptions";
-export * from "./models/IMessagingServiceConstructorOptions";
-export * from "./schema";
+export * from "./entities/templateEntry.js";
+export * from "./messagingAdminService.js";
+export * from "./messagingService.js";
+export * from "./models/IMessagingAdminServiceConfig.js";
+export * from "./models/IMessagingAdminServiceConstructorOptions.js";
+export * from "./models/IMessagingServiceConstructorOptions.js";
+export * from "./schema.js";

package/dist/types/messagingAdminService.d.ts

@@ -1,5 +1,5 @@
 import type { IMessagingAdminComponent } from "@twin.org/messaging-models";
-import type { IMessagingAdminServiceConstructorOptions } from "./models/IMessagingAdminServiceConstructorOptions";
+import type { IMessagingAdminServiceConstructorOptions } from "./models/IMessagingAdminServiceConstructorOptions.js";
 /**
  * Service for performing email messaging operations to a connector.
  */
@@ -18,12 +18,10 @@ export declare class MessagingAdminService implements IMessagingAdminComponent {
      */
     constructor(options?: IMessagingAdminServiceConstructorOptions);
     /**
-     * The component needs to be started when the node is initialized.
-     * @param nodeIdentity The identity of the node starting the component.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
+     * Returns the class name of the component.
+     * @returns The class name of the component.
      */
-    start(nodeIdentity?: string, nodeLoggingComponentType?: string): Promise<void>;
+    className(): string;
     /**
      * Create or update a template.
      * @param templateId The id of the template.

package/dist/types/messagingService.d.ts

@@ -1,5 +1,5 @@
 import { type IMessagingComponent } from "@twin.org/messaging-models";
-import type { IMessagingServiceConstructorOptions } from "./models/IMessagingServiceConstructorOptions";
+import type { IMessagingServiceConstructorOptions } from "./models/IMessagingServiceConstructorOptions.js";
 /**
  * Service for performing email messaging operations to a connector.
  */
@@ -13,6 +13,11 @@ export declare class MessagingService implements IMessagingComponent {
      * @param options The options for the connector.
      */
     constructor(options?: IMessagingServiceConstructorOptions);
+    /**
+     * Returns the class name of the component.
+     * @returns The class name of the component.
+     */
+    className(): string;
     /**
      * Send a custom email.
      * @param sender The sender email address.

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

@@ -7,14 +7,4 @@ export interface IMessagingAdminServiceConfig {
      * @default en
      */
     defaultLocale?: string;
-    /**
-     * Initial set of templates to create on startup.
-     */
-    templates?: {
-        templateId: string;
-        title: string;
-        content: {
-            [locale: string]: string;
-        };
-    }[];
 }

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

@@ -1,4 +1,4 @@
-import type { IMessagingAdminServiceConfig } from "./IMessagingAdminServiceConfig";
+import type { IMessagingAdminServiceConfig } from "./IMessagingAdminServiceConfig.js";
 /**
  * Options for the messaging admin service.
  */

package/docs/changelog.md

@@ -1,5 +1,47 @@
 # @twin.org/messaging-service - Changelog
 
+## [0.0.3-next.2](https://github.com/twinfoundation/messaging/compare/messaging-service-v0.0.3-next.1...messaging-service-v0.0.3-next.2) (2026-01-20)
+
+
+### Miscellaneous Chores
+
+* **messaging-service:** Synchronize repo versions
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/messaging-models bumped from 0.0.3-next.1 to 0.0.3-next.2
+
+## [0.0.3-next.1](https://github.com/twinfoundation/messaging/compare/messaging-service-v0.0.3-next.0...messaging-service-v0.0.3-next.1) (2025-11-11)
+
+
+### Features
+
+* add context id features ([#24](https://github.com/twinfoundation/messaging/issues/24)) ([42b94e8](https://github.com/twinfoundation/messaging/commit/42b94e8be32c86db6afc5ccf5e9ff2c93d15d05d))
+* add initial templates config ([66b40eb](https://github.com/twinfoundation/messaging/commit/66b40eb57a478d9f79de540eb847a4fb37894235))
+* add messaging admin component ([cbaaca3](https://github.com/twinfoundation/messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
+* add validate-locales ([5eeff9b](https://github.com/twinfoundation/messaging/commit/5eeff9b9bf6cecf93b249b56c4bb74b4c5bf86c9))
+* eslint migration to flat config ([faa02ec](https://github.com/twinfoundation/messaging/commit/faa02ec0ef450db88b08e938415e40cf13625d15))
+* Messaging services ([#3](https://github.com/twinfoundation/messaging/issues/3)) ([32571b5](https://github.com/twinfoundation/messaging/commit/32571b5abf5d3fc3b168074c23507e926c5d00b0))
+* remove unused namespace ([2201898](https://github.com/twinfoundation/messaging/commit/22018988b84e4b3e76da1a1e16f29bfde7e6f0e6))
+* update dependencies ([53dcde6](https://github.com/twinfoundation/messaging/commit/53dcde60d6efaee5957296f6d097cb97c0fb2f9d))
+* update framework core ([fc476b4](https://github.com/twinfoundation/messaging/commit/fc476b48e6075de0ae871e3cec1fa179aa04b5eb))
+* use shared store mechanism ([#8](https://github.com/twinfoundation/messaging/issues/8)) ([9ad65c2](https://github.com/twinfoundation/messaging/commit/9ad65c239ba77bb75604a1f6e51b975357f3228d))
+
+
+### Bug Fixes
+
+* Adding format to the MessagingEntries ts number ([8b99d4f](https://github.com/twinfoundation/messaging/commit/8b99d4f01c4f2b08da8d2affc1b9554fcb0d3690))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/messaging-models bumped from 0.0.3-next.0 to 0.0.3-next.1
+
 ## [0.0.2-next.6](https://github.com/twinfoundation/messaging/compare/messaging-service-v0.0.2-next.5...messaging-service-v0.0.2-next.6) (2025-10-09)
 
 

package/docs/reference/classes/MessagingAdminService.md

@@ -36,35 +36,21 @@ Runtime name for the class.
 
 ## Methods
 
-### start()
+### className()
 
-> **start**(`nodeIdentity?`, `nodeLoggingComponentType?`): `Promise`\<`void`\>
+> **className**(): `string`
 
-The component needs to be started when the node is initialized.
-
-#### Parameters
-
-##### nodeIdentity?
-
-`string`
-
-The identity of the node starting the component.
-
-##### nodeLoggingComponentType?
-
-`string`
-
-The node logging component type.
+Returns the class name of the component.
 
 #### Returns
 
-`Promise`\<`void`\>
+`string`
 
-Nothing.
+The class name of the component.
 
 #### Implementation of
 
-`IMessagingAdminComponent.start`
+`IMessagingAdminComponent.className`
 
 ***
 

package/docs/reference/classes/MessagingService.md

@@ -36,6 +36,24 @@ Runtime name for the class.
 
 ## Methods
 
+### className()
+
+> **className**(): `string`
+
+Returns the class name of the component.
+
+#### Returns
+
+`string`
+
+The class name of the component.
+
+#### Implementation of
+
+`IMessagingComponent.className`
+
+***
+
 ### sendCustomEmail()
 
 > **sendCustomEmail**(`sender`, `recipients`, `templateId`, `data`, `locale`): `Promise`\<`boolean`\>

package/docs/reference/interfaces/IMessagingAdminServiceConfig.md

@@ -15,27 +15,3 @@ The default locale to use for the messaging service.
 ```ts
 en
 ```
-
-***
-
-### templates?
-
-> `optional` **templates**: `object`[]
-
-Initial set of templates to create on startup.
-
-#### templateId
-
-> **templateId**: `string`
-
-#### title
-
-> **title**: `string`
-
-#### content
-
-> **content**: `object`
-
-##### Index Signature
-
-\[`locale`: `string`\]: `string`

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/messaging-service",
-	"version": "0.0.2-next.6",
+	"version": "0.0.3-next.2",
 	"description": "Messaging service implementation",
 	"repository": {
 		"type": "git",
@@ -18,23 +18,20 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/logging-models": "next",
-		"@twin.org/messaging-models": "0.0.2-next.6",
+		"@twin.org/messaging-models": "0.0.3-next.2",
 		"@twin.org/nameof": "next"
 	},
-	"main": "./dist/cjs/index.cjs",
-	"module": "./dist/esm/index.mjs",
+	"main": "./dist/es/index.js",
 	"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"
+			"import": "./dist/es/index.js",
+			"default": "./dist/es/index.js"
+		}
 	},
 	"files": [
-		"dist/cjs",
-		"dist/esm",
+		"dist/es",
 		"dist/types",
 		"locales",
 		"docs"

package/dist/cjs/index.cjs

@@ -1,326 +0,0 @@
-'use strict';
-
-var entity = require('@twin.org/entity');
-var core = require('@twin.org/core');
-var entityStorageModels = require('@twin.org/entity-storage-models');
-var messagingModels = require('@twin.org/messaging-models');
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Call defining a template message entry.
- */
-exports.TemplateEntry = class TemplateEntry {
-    /**
-     * The id.
-     */
-    id;
-    /**
-     * The title.
-     */
-    title;
-    /**
-     * The content.
-     */
-    content;
-    /**
-     * The timestamp of the template entry.
-     */
-    dateCreated;
-};
-__decorate([
-    entity.property({ type: "string", isPrimary: true }),
-    __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "id", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "title", void 0);
-__decorate([
-    entity.property({ type: "string" }),
-    __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "content", void 0);
-__decorate([
-    entity.property({ type: "string", format: "date-time", sortDirection: entity.SortDirection.Descending }),
-    __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "dateCreated", void 0);
-exports.TemplateEntry = __decorate([
-    entity.entity()
-], exports.TemplateEntry);
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing email messaging operations to a connector.
- */
-class MessagingAdminService {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "MessagingAdminService";
-    /**
-     * Default locale for the messaging service.
-     */
-    static _DEFAULT_LOCALE = "en";
-    /**
-     * Entity storage connector used by the service.
-     * @internal
-     */
-    _entityStorageConnector;
-    /**
-     * The default locale to use for the messaging service.
-     * @internal
-     */
-    _defaultLocale;
-    /**
-     * Initial set of templates to create on startup.
-     * @internal
-     */
-    _initialTemplates;
-    /**
-     * Create a new instance of MessagingAdminService.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        this._entityStorageConnector = entityStorageModels.EntityStorageConnectorFactory.get(options?.templateEntryStorageConnectorType ?? "template-entry");
-        this._defaultLocale = options?.config?.defaultLocale ?? MessagingAdminService._DEFAULT_LOCALE;
-        this._initialTemplates = options?.config?.templates;
-    }
-    /**
-     * The component needs to be started when the node is initialized.
-     * @param nodeIdentity The identity of the node starting the component.
-     * @param nodeLoggingComponentType The node logging component type.
-     * @returns Nothing.
-     */
-    async start(nodeIdentity, nodeLoggingComponentType) {
-        if (core.Is.arrayValue(this._initialTemplates)) {
-            for (const template of this._initialTemplates) {
-                for (const locale of Object.keys(template.content)) {
-                    await this.setTemplate(template.templateId, locale, template.title, template.content[locale]);
-                }
-            }
-        }
-    }
-    /**
-     * 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 Nothing.
-     */
-    async setTemplate(templateId, locale, title, content) {
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "title", title);
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "content", content);
-        const templateEntry = new exports.TemplateEntry();
-        templateEntry.id = `${templateId}:${locale}`;
-        templateEntry.dateCreated = new Date(Date.now()).toISOString();
-        templateEntry.title = title;
-        templateEntry.content = content;
-        await this._entityStorageConnector.set(templateEntry);
-    }
-    /**
-     * 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.
-     */
-    async getTemplate(templateId, locale) {
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
-        let templateEntry;
-        try {
-            // First try to get the template for the requested locale
-            templateEntry = await this._entityStorageConnector.get(`${templateId}:${locale}`);
-        }
-        catch { }
-        // If the template is not found for the requested locale, try to get it for the default locale
-        // only if the requested locale is different from the default locale
-        if (core.Is.empty(templateEntry) && this._defaultLocale !== locale) {
-            try {
-                templateEntry = await this._entityStorageConnector.get(`${templateId}:${this._defaultLocale}`);
-            }
-            catch { }
-        }
-        if (core.Is.empty(templateEntry)) {
-            throw new core.GeneralError(MessagingAdminService.CLASS_NAME, "getTemplateFailed", {
-                templateId,
-                locale
-            });
-        }
-        return templateEntry;
-    }
-    /**
-     * Remove a template.
-     * @param templateId The id of the template.
-     * @param locale The locale of the template.
-     * @returns Nothing
-     */
-    async removeTemplate(templateId, locale) {
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "templateId", templateId);
-        core.Guards.stringValue(MessagingAdminService.CLASS_NAME, "locale", locale);
-        return this._entityStorageConnector.remove(`${templateId}:${locale}`);
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Service for performing email messaging operations to a connector.
- */
-class MessagingService {
-    /**
-     * Runtime name for the class.
-     */
-    static CLASS_NAME = "MessagingService";
-    /**
-     * Emails messaging connector used by the service.
-     * @internal
-     */
-    _emailMessagingConnector;
-    /**
-     * Push notifications messaging connector used by the service.
-     * @internal
-     */
-    _pushNotificationMessagingConnector;
-    /**
-     * SMS messaging connector used by the service.
-     * @internal
-     */
-    _smsMessagingConnector;
-    /**
-     * The admin component for the messaging.
-     * @internal
-     */
-    _messagingAdminComponent;
-    /**
-     * Create a new instance of MessagingService.
-     * @param options The options for the connector.
-     */
-    constructor(options) {
-        if (core.Is.stringValue(options?.messagingEmailConnectorType)) {
-            this._emailMessagingConnector = messagingModels.MessagingEmailConnectorFactory.get(options.messagingEmailConnectorType);
-        }
-        if (core.Is.stringValue(options?.messagingPushNotificationConnectorType)) {
-            this._pushNotificationMessagingConnector = messagingModels.MessagingPushNotificationsConnectorFactory.get(options.messagingPushNotificationConnectorType);
-        }
-        if (core.Is.stringValue(options?.messagingSmsConnectorType)) {
-            this._smsMessagingConnector = messagingModels.MessagingSmsConnectorFactory.get(options.messagingSmsConnectorType);
-        }
-        this._messagingAdminComponent = core.ComponentFactory.get(options?.messagingAdminComponentType ?? "messaging-admin");
-    }
-    /**
-     * 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 If the email was sent successfully.
-     */
-    async sendCustomEmail(sender, recipients, templateId, data, locale) {
-        if (core.Is.empty(this._emailMessagingConnector)) {
-            throw new core.GeneralError(MessagingService.CLASS_NAME, "notConfiguredEmailMessagingConnector");
-        }
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "sender", sender);
-        core.Guards.arrayValue(MessagingService.CLASS_NAME, "recipients", recipients);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "templateId", templateId);
-        core.Guards.object(MessagingService.CLASS_NAME, "data", data);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "locale", locale);
-        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
-        const populatedTemplate = this.populateTemplate(template, data);
-        return this._emailMessagingConnector.sendCustomEmail(sender, recipients, populatedTemplate.title, populatedTemplate.content);
-    }
-    /**
-     * Registers a device to an specific app in order to send notifications to it.
-     * @param applicationId The application address.
-     * @param deviceToken The device token.
-     * @returns If the device was registered successfully.
-     */
-    async registerDevice(applicationId, deviceToken) {
-        if (core.Is.empty(this._pushNotificationMessagingConnector)) {
-            throw new core.GeneralError(MessagingService.CLASS_NAME, "notConfiguredPushNotificationMessagingConnector");
-        }
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "applicationId", applicationId);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "deviceToken", deviceToken);
-        return this._pushNotificationMessagingConnector.registerDevice(applicationId, deviceToken);
-    }
-    /**
-     * 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 If the notification was sent successfully.
-     */
-    async sendSinglePushNotification(deviceAddress, templateId, data, locale) {
-        if (core.Is.empty(this._pushNotificationMessagingConnector)) {
-            throw new core.GeneralError(MessagingService.CLASS_NAME, "notConfiguredPushNotificationMessagingConnector");
-        }
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "deviceAddress", deviceAddress);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "templateId", templateId);
-        core.Guards.object(MessagingService.CLASS_NAME, "data", data);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "locale", locale);
-        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
-        const populatedTemplate = this.populateTemplate(template, data);
-        return this._pushNotificationMessagingConnector.sendSinglePushNotification(deviceAddress, populatedTemplate.title, populatedTemplate.content);
-    }
-    /**
-     * 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 If the SMS was sent successfully.
-     */
-    async sendSMS(phoneNumber, templateId, data, locale) {
-        if (core.Is.empty(this._smsMessagingConnector)) {
-            throw new core.GeneralError(MessagingService.CLASS_NAME, "notConfiguredSmsMessagingConnector");
-        }
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "phoneNumber", phoneNumber);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "templateId", templateId);
-        core.Guards.object(MessagingService.CLASS_NAME, "data", data);
-        core.Guards.stringValue(MessagingService.CLASS_NAME, "locale", locale);
-        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
-        const populatedTemplate = this.populateTemplate(template, data);
-        return this._smsMessagingConnector.sendSMS(phoneNumber, populatedTemplate.content);
-    }
-    /**
-     * Populate the template with data.
-     * @param template The template.
-     * @param template.title The title of the template.
-     * @param template.content The content of the template.
-     * @param data The data to populate the template.
-     * @internal
-     * @returns The populated template.
-     */
-    populateTemplate(template, data) {
-        let populatedTitle = template.title;
-        let populatedContent = template.content;
-        for (const key in data) {
-            const value = data[key];
-            const placeholder = `{{${key}}}`;
-            populatedTitle = populatedTitle.replace(new RegExp(placeholder, "g"), value);
-            populatedContent = populatedContent.replace(new RegExp(placeholder, "g"), value);
-        }
-        return {
-            title: populatedTitle,
-            content: populatedContent
-        };
-    }
-}
-
-// Copyright 2024 IOTA Stiftung.
-// SPDX-License-Identifier: Apache-2.0.
-/**
- * Initialize the schema for the messaging service.
- */
-function initSchema() {
-    entity.EntitySchemaFactory.register("TemplateEntry", () => entity.EntitySchemaHelper.getSchema(exports.TemplateEntry));
-}
-
-exports.MessagingAdminService = MessagingAdminService;
-exports.MessagingService = MessagingService;
-exports.initSchema = initSchema;