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

package/dist/cjs/index.cjs

@@ -72,6 +72,11 @@ class MessagingAdminService {
      * @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.
@@ -79,6 +84,22 @@ class MessagingAdminService {
     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.

package/dist/esm/index.mjs

@@ -1,5 +1,5 @@
 import { property, SortDirection, entity, EntitySchemaFactory, EntitySchemaHelper } from '@twin.org/entity';
-import { Guards, Is, GeneralError, ComponentFactory } 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';
 
@@ -70,6 +70,11 @@ class MessagingAdminService {
      * @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.
@@ -77,6 +82,22 @@ class MessagingAdminService {
     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.

package/dist/types/messagingAdminService.d.ts

@@ -17,6 +17,13 @@ export declare class MessagingAdminService implements IMessagingAdminComponent {
      * @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.

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

@@ -7,4 +7,14 @@ 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/docs/changelog.md

@@ -1,5 +1,19 @@
 # @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)
 
 

package/docs/reference/classes/MessagingAdminService.md

@@ -40,6 +40,38 @@ Runtime name for the class.
 
 ## 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`\>

package/docs/reference/interfaces/IMessagingAdminServiceConfig.md

@@ -15,3 +15,27 @@ 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.3",
+	"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.3",
+		"@twin.org/messaging-models": "0.0.2-next.4",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",