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

package/dist/cjs/index.cjs

@@ -48,6 +48,120 @@ 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 {
+    /**
+     * Default locale for the messaging service.
+     */
+    static _DEFAULT_LOCALE = "en";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "MessagingAdminService";
+    /**
+     * 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(this.CLASS_NAME, "templateId", templateId);
+        core.Guards.stringValue(this.CLASS_NAME, "locale", locale);
+        core.Guards.stringValue(this.CLASS_NAME, "title", title);
+        core.Guards.stringValue(this.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(this.CLASS_NAME, "templateId", templateId);
+        core.Guards.stringValue(this.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(this.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(this.CLASS_NAME, "templateId", templateId);
+        core.Guards.stringValue(this.CLASS_NAME, "locale", locale);
+        return this._entityStorageConnector.remove(`${templateId}:${locale}`);
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -74,10 +188,10 @@ class MessagingService {
      */
     _smsMessagingConnector;
     /**
-     * Entity storage connector used by the service.
+     * The admin component for the messaging.
      * @internal
      */
-    _entityStorageConnector;
+    _messagingAdminComponent;
     /**
      * Create a new instance of MessagingService.
      * @param options The options for the connector.
@@ -92,7 +206,7 @@ class MessagingService {
         if (core.Is.stringValue(options?.messagingSmsConnectorType)) {
             this._smsMessagingConnector = messagingModels.MessagingSmsConnectorFactory.get(options.messagingSmsConnectorType);
         }
-        this._entityStorageConnector = entityStorageModels.EntityStorageConnectorFactory.get(options?.templateEntryStorageConnectorType ?? "template-entry");
+        this._messagingAdminComponent = core.ComponentFactory.get(options?.messagingAdminComponentType ?? "messaging-admin");
     }
     /**
      * Send a custom email.
@@ -112,7 +226,7 @@ class MessagingService {
         core.Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
         core.Guards.object(this.CLASS_NAME, "data", data);
         core.Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this.getTemplate(templateId, 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);
     }
@@ -146,7 +260,7 @@ class MessagingService {
         core.Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
         core.Guards.object(this.CLASS_NAME, "data", data);
         core.Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this.getTemplate(templateId, locale);
+        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
         const populatedTemplate = this.populateTemplate(template, data);
         return this._pushNotificationMessagingConnector.sendSinglePushNotification(deviceAddress, populatedTemplate.title, populatedTemplate.content);
     }
@@ -166,46 +280,10 @@ class MessagingService {
         core.Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
         core.Guards.object(this.CLASS_NAME, "data", data);
         core.Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this.getTemplate(templateId, locale);
+        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
         const populatedTemplate = this.populateTemplate(template, data);
         return this._smsMessagingConnector.sendSMS(phoneNumber, populatedTemplate.content);
     }
-    /**
-     * 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 If the template was created or updated successfully.
-     */
-    async createOrUpdateTemplate(templateId, locale, title, content) {
-        core.Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        core.Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        core.Guards.stringValue(this.CLASS_NAME, "title", title);
-        core.Guards.stringValue(this.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);
-        return true;
-    }
-    /**
-     * 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.
-     * @internal
-     */
-    async getTemplate(templateId, locale) {
-        const entityId = `${templateId}:${locale}`;
-        const templateInfo = await this._entityStorageConnector.get(entityId);
-        if (!templateInfo) {
-            throw new core.GeneralError(this.CLASS_NAME, "getTemplateFailed", { templateId, locale });
-        }
-        return templateInfo;
-    }
     /**
      * Populate the template with data.
      * @param template The template.
@@ -240,5 +318,6 @@ function initSchema() {
     entity.EntitySchemaFactory.register("TemplateEntry", () => entity.EntitySchemaHelper.getSchema(exports.TemplateEntry));
 }
 
+exports.MessagingAdminService = MessagingAdminService;
 exports.MessagingService = MessagingService;
 exports.initSchema = initSchema;

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { Is, GeneralError, Guards } from '@twin.org/core';
+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';
 
@@ -46,6 +46,120 @@ TemplateEntry = __decorate([
     entity()
 ], TemplateEntry);
 
+// Copyright 2024 IOTA Stiftung.
+// SPDX-License-Identifier: Apache-2.0.
+/**
+ * Service for performing email messaging operations to a connector.
+ */
+class MessagingAdminService {
+    /**
+     * Default locale for the messaging service.
+     */
+    static _DEFAULT_LOCALE = "en";
+    /**
+     * Runtime name for the class.
+     */
+    CLASS_NAME = "MessagingAdminService";
+    /**
+     * 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(this.CLASS_NAME, "templateId", templateId);
+        Guards.stringValue(this.CLASS_NAME, "locale", locale);
+        Guards.stringValue(this.CLASS_NAME, "title", title);
+        Guards.stringValue(this.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(this.CLASS_NAME, "templateId", templateId);
+        Guards.stringValue(this.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(this.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(this.CLASS_NAME, "templateId", templateId);
+        Guards.stringValue(this.CLASS_NAME, "locale", locale);
+        return this._entityStorageConnector.remove(`${templateId}:${locale}`);
+    }
+}
+
 // Copyright 2024 IOTA Stiftung.
 // SPDX-License-Identifier: Apache-2.0.
 /**
@@ -72,10 +186,10 @@ class MessagingService {
      */
     _smsMessagingConnector;
     /**
-     * Entity storage connector used by the service.
+     * The admin component for the messaging.
      * @internal
      */
-    _entityStorageConnector;
+    _messagingAdminComponent;
     /**
      * Create a new instance of MessagingService.
      * @param options The options for the connector.
@@ -90,7 +204,7 @@ class MessagingService {
         if (Is.stringValue(options?.messagingSmsConnectorType)) {
             this._smsMessagingConnector = MessagingSmsConnectorFactory.get(options.messagingSmsConnectorType);
         }
-        this._entityStorageConnector = EntityStorageConnectorFactory.get(options?.templateEntryStorageConnectorType ?? "template-entry");
+        this._messagingAdminComponent = ComponentFactory.get(options?.messagingAdminComponentType ?? "messaging-admin");
     }
     /**
      * Send a custom email.
@@ -110,7 +224,7 @@ class MessagingService {
         Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
         Guards.object(this.CLASS_NAME, "data", data);
         Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this.getTemplate(templateId, 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);
     }
@@ -144,7 +258,7 @@ class MessagingService {
         Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
         Guards.object(this.CLASS_NAME, "data", data);
         Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this.getTemplate(templateId, locale);
+        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
         const populatedTemplate = this.populateTemplate(template, data);
         return this._pushNotificationMessagingConnector.sendSinglePushNotification(deviceAddress, populatedTemplate.title, populatedTemplate.content);
     }
@@ -164,46 +278,10 @@ class MessagingService {
         Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
         Guards.object(this.CLASS_NAME, "data", data);
         Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        const template = await this.getTemplate(templateId, locale);
+        const template = await this._messagingAdminComponent.getTemplate(templateId, locale);
         const populatedTemplate = this.populateTemplate(template, data);
         return this._smsMessagingConnector.sendSMS(phoneNumber, populatedTemplate.content);
     }
-    /**
-     * 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 If the template was created or updated successfully.
-     */
-    async createOrUpdateTemplate(templateId, locale, title, content) {
-        Guards.stringValue(this.CLASS_NAME, "templateId", templateId);
-        Guards.stringValue(this.CLASS_NAME, "locale", locale);
-        Guards.stringValue(this.CLASS_NAME, "title", title);
-        Guards.stringValue(this.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);
-        return true;
-    }
-    /**
-     * 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.
-     * @internal
-     */
-    async getTemplate(templateId, locale) {
-        const entityId = `${templateId}:${locale}`;
-        const templateInfo = await this._entityStorageConnector.get(entityId);
-        if (!templateInfo) {
-            throw new GeneralError(this.CLASS_NAME, "getTemplateFailed", { templateId, locale });
-        }
-        return templateInfo;
-    }
     /**
      * Populate the template with data.
      * @param template The template.
@@ -238,4 +316,4 @@ function initSchema() {
     EntitySchemaFactory.register("TemplateEntry", () => EntitySchemaHelper.getSchema(TemplateEntry));
 }
 
-export { MessagingService, TemplateEntry, initSchema };
+export { MessagingAdminService, MessagingService, TemplateEntry, initSchema };

package/dist/types/index.d.ts

@@ -1,4 +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";

package/dist/types/messagingAdminService.d.ts

@@ -0,0 +1,53 @@
+import type { IMessagingAdminComponent } from "@twin.org/messaging-models";
+import type { IMessagingAdminServiceConstructorOptions } from "./models/IMessagingAdminServiceConstructorOptions";
+/**
+ * Service for performing email messaging operations to a connector.
+ */
+export declare class MessagingAdminService implements IMessagingAdminComponent {
+    /**
+     * Default locale for the messaging service.
+     */
+    private static readonly _DEFAULT_LOCALE;
+    /**
+     * Runtime name for the class.
+     */
+    readonly CLASS_NAME: string;
+    /**
+     * Create a new instance of MessagingAdminService.
+     * @param options The options for the connector.
+     */
+    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.
+     */
+    start(nodeIdentity?: string, nodeLoggingComponentType?: string): Promise<void>;
+    /**
+     * 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.
+     */
+    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 Nothing
+     */
+    removeTemplate(templateId: string, locale: string): Promise<void>;
+}

package/dist/types/messagingService.d.ts

@@ -54,13 +54,4 @@ export declare class MessagingService implements IMessagingComponent {
     sendSMS(phoneNumber: string, templateId: string, data: {
         [key: string]: string;
     }, locale: string): Promise<boolean>;
-    /**
-     * 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 If the template was created or updated successfully.
-     */
-    createOrUpdateTemplate(templateId: string, locale: string, title: string, content: string): Promise<boolean>;
 }

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

@@ -0,0 +1,20 @@
+/**
+ * Options for the messaging service.
+ */
+export interface IMessagingAdminServiceConfig {
+    /**
+     * The default locale to use for the messaging service.
+     * @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

@@ -0,0 +1,15 @@
+import type { IMessagingAdminServiceConfig } from "./IMessagingAdminServiceConfig";
+/**
+ * Options for the messaging admin service.
+ */
+export interface IMessagingAdminServiceConstructorOptions {
+    /**
+     * The type of the entity connector to use.
+     * @default template-entry
+     */
+    templateEntryStorageConnectorType?: string;
+    /**
+     * The configuration for the messaging admin service.
+     */
+    config?: IMessagingAdminServiceConfig;
+}

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

@@ -15,8 +15,8 @@ export interface IMessagingServiceConstructorOptions {
      */
     messagingSmsConnectorType?: string;
     /**
-     * The type of the entity connector to use.
-     * @default template-entry
+     * The type of the messaging admin component to use.
+     * @default messaging-admin
      */
-    templateEntryStorageConnectorType?: string;
+    messagingAdminComponentType?: string;
 }

package/docs/changelog.md

@@ -1,5 +1,33 @@
 # @twin.org/messaging-service - Changelog
 
+## [0.0.2-next.4](https://github.com/twinfoundation/messaging/compare/messaging-service-v0.0.2-next.3...messaging-service-v0.0.2-next.4) (2025-09-29)
+
+
+### Features
+
+* add initial templates config ([66b40eb](https://github.com/twinfoundation/messaging/commit/66b40eb57a478d9f79de540eb847a4fb37894235))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/messaging-models bumped from 0.0.2-next.3 to 0.0.2-next.4
+
+## [0.0.2-next.3](https://github.com/twinfoundation/messaging/compare/messaging-service-v0.0.2-next.2...messaging-service-v0.0.2-next.3) (2025-09-29)
+
+
+### Features
+
+* add messaging admin component ([cbaaca3](https://github.com/twinfoundation/messaging/commit/cbaaca34db6a9f5c51438c201535b4b43a1aea1f))
+
+
+### Dependencies
+
+* The following workspace dependencies were updated
+  * dependencies
+    * @twin.org/messaging-models bumped from 0.0.2-next.2 to 0.0.2-next.3
+
 ## [0.0.2-next.2](https://github.com/twinfoundation/messaging/compare/messaging-service-v0.0.2-next.1...messaging-service-v0.0.2-next.2) (2025-08-29)
 
 

package/docs/reference/classes/MessagingAdminService.md

@@ -0,0 +1,179 @@
+# Class: MessagingAdminService
+
+Service for performing email messaging operations to a connector.
+
+## Implements
+
+- `IMessagingAdminComponent`
+
+## Constructors
+
+### Constructor
+
+> **new MessagingAdminService**(`options?`): `MessagingAdminService`
+
+Create a new instance of MessagingAdminService.
+
+#### Parameters
+
+##### options?
+
+[`IMessagingAdminServiceConstructorOptions`](../interfaces/IMessagingAdminServiceConstructorOptions.md)
+
+The options for the connector.
+
+#### Returns
+
+`MessagingAdminService`
+
+## Properties
+
+### CLASS\_NAME
+
+> `readonly` **CLASS\_NAME**: `string`
+
+Runtime name for the class.
+
+#### Implementation of
+
+`IMessagingAdminComponent.CLASS_NAME`
+
+## Methods
+
+### start()
+
+> **start**(`nodeIdentity?`, `nodeLoggingComponentType?`): `Promise`\<`void`\>
+
+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
+
+`Promise`\<`void`\>
+
+Nothing.
+
+#### Implementation of
+
+`IMessagingAdminComponent.start`
+
+***
+
+### 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`\>
+
+Nothing.
+
+#### Implementation of
+
+`IMessagingAdminComponent.setTemplate`
+
+***
+
+### 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.
+
+#### Implementation of
+
+`IMessagingAdminComponent.getTemplate`
+
+***
+
+### 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`\>
+
+Nothing
+
+#### Implementation of
+
+`IMessagingAdminComponent.removeTemplate`

package/docs/reference/classes/MessagingService.md

@@ -201,43 +201,3 @@ If the SMS was sent successfully.
 #### Implementation of
 
 `IMessagingComponent.sendSMS`
-
-***
-
-### createOrUpdateTemplate()
-
-> **createOrUpdateTemplate**(`templateId`, `locale`, `title`, `content`): `Promise`\<`boolean`\>
-
-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`\<`boolean`\>
-
-If the template was created or updated successfully.

package/docs/reference/index.md

@@ -3,10 +3,13 @@
 ## Classes
 
 - [TemplateEntry](classes/TemplateEntry.md)
+- [MessagingAdminService](classes/MessagingAdminService.md)
 - [MessagingService](classes/MessagingService.md)
 
 ## Interfaces
 
+- [IMessagingAdminServiceConfig](interfaces/IMessagingAdminServiceConfig.md)
+- [IMessagingAdminServiceConstructorOptions](interfaces/IMessagingAdminServiceConstructorOptions.md)
 - [IMessagingServiceConstructorOptions](interfaces/IMessagingServiceConstructorOptions.md)
 
 ## Functions

package/docs/reference/interfaces/IMessagingAdminServiceConfig.md

@@ -0,0 +1,41 @@
+# Interface: IMessagingAdminServiceConfig
+
+Options for the messaging service.
+
+## Properties
+
+### defaultLocale?
+
+> `optional` **defaultLocale**: `string`
+
+The default locale to use for the messaging service.
+
+#### Default
+
+```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/docs/reference/interfaces/IMessagingAdminServiceConstructorOptions.md

@@ -0,0 +1,25 @@
+# Interface: IMessagingAdminServiceConstructorOptions
+
+Options for the messaging admin service.
+
+## Properties
+
+### templateEntryStorageConnectorType?
+
+> `optional` **templateEntryStorageConnectorType**: `string`
+
+The type of the entity connector to use.
+
+#### Default
+
+```ts
+template-entry
+```
+
+***
+
+### config?
+
+> `optional` **config**: [`IMessagingAdminServiceConfig`](IMessagingAdminServiceConfig.md)
+
+The configuration for the messaging admin service.

package/docs/reference/interfaces/IMessagingServiceConstructorOptions.md

@@ -28,14 +28,14 @@ The type of the sms messaging connector to use, defaults to not configured.
 
 ***
 
-### templateEntryStorageConnectorType?
+### messagingAdminComponentType?
 
-> `optional` **templateEntryStorageConnectorType**: `string`
+> `optional` **messagingAdminComponentType**: `string`
 
-The type of the entity connector to use.
+The type of the messaging admin component to use.
 
 #### Default
 
 ```ts
-template-entry
+messaging-admin
 ```

package/locales/en.json

@@ -4,10 +4,12 @@
 	},
 	"error": {
 		"messagingService": {
-			"getTemplateFailed": "Failed to get template with id: \"{templateId}\" and locale: \"{locale}\"",
 			"notConfiguredEmailMessagingConnector": "Email messaging connector was not configured",
 			"notConfiguredPushNotificationMessagingConnector": "Push notification messaging connector was not configured",
 			"notConfiguredSmsMessagingConnector": "SMS messaging connector was not configured"
+		},
+		"messagingAdminService": {
+			"getTemplateFailed": "Failed to get template with id: \"{templateId}\" and locale: \"{locale}\""
 		}
 	}
 }

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/messaging-service",
-	"version": "0.0.2-next.2",
+	"version": "0.0.2-next.4",
 	"description": "Messaging service implementation",
 	"repository": {
 		"type": "git",
@@ -18,7 +18,7 @@
 		"@twin.org/entity": "next",
 		"@twin.org/entity-storage-models": "next",
 		"@twin.org/logging-models": "next",
-		"@twin.org/messaging-models": "0.0.2-next.2",
+		"@twin.org/messaging-models": "0.0.2-next.4",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",