@twin.org/messaging-service 0.0.1-next.7 → 0.0.1-next.9

package/dist/cjs/index.cjs

@@ -31,19 +31,19 @@ exports.TemplateEntry = class TemplateEntry {
 __decorate([
     entity.property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "id", void 0);
+], exports.TemplateEntry.prototype, "id", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "title", void 0);
+], exports.TemplateEntry.prototype, "title", undefined);
 __decorate([
     entity.property({ type: "string" }),
     __metadata("design:type", String)
-], exports.TemplateEntry.prototype, "content", void 0);
+], exports.TemplateEntry.prototype, "content", undefined);
 __decorate([
     entity.property({ type: "integer" }),
     __metadata("design:type", Number)
-], exports.TemplateEntry.prototype, "ts", void 0);
+], exports.TemplateEntry.prototype, "ts", undefined);
 exports.TemplateEntry = __decorate([
     entity.entity()
 ], exports.TemplateEntry);
@@ -85,10 +85,6 @@ class MessagingService {
     /**
      * Create a new instance of MessagingService.
      * @param options The options for the connector.
-     * @param options.messagingEmailConnectorType The type of the email messaging connector to use, defaults to not configured.
-     * @param options.messagingPushNotificationConnectorType The type of the push notifications messaging connector to use, defaults to not configured.
-     * @param options.messagingSmsConnectorType The type of the sms messaging connector to use, defaults to not configured.
-     * @param options.templateEntryStorageConnectorType The type of the entity connector to use, defaults to "messaging-templates".
      */
     constructor(options) {
         if (core.Is.stringValue(options?.messagingEmailConnectorType)) {

package/dist/esm/index.mjs

@@ -29,19 +29,19 @@ let TemplateEntry = class TemplateEntry {
 __decorate([
     property({ type: "string", isPrimary: true }),
     __metadata("design:type", String)
-], TemplateEntry.prototype, "id", void 0);
+], TemplateEntry.prototype, "id", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], TemplateEntry.prototype, "title", void 0);
+], TemplateEntry.prototype, "title", undefined);
 __decorate([
     property({ type: "string" }),
     __metadata("design:type", String)
-], TemplateEntry.prototype, "content", void 0);
+], TemplateEntry.prototype, "content", undefined);
 __decorate([
     property({ type: "integer" }),
     __metadata("design:type", Number)
-], TemplateEntry.prototype, "ts", void 0);
+], TemplateEntry.prototype, "ts", undefined);
 TemplateEntry = __decorate([
     entity()
 ], TemplateEntry);
@@ -83,10 +83,6 @@ class MessagingService {
     /**
      * Create a new instance of MessagingService.
      * @param options The options for the connector.
-     * @param options.messagingEmailConnectorType The type of the email messaging connector to use, defaults to not configured.
-     * @param options.messagingPushNotificationConnectorType The type of the push notifications messaging connector to use, defaults to not configured.
-     * @param options.messagingSmsConnectorType The type of the sms messaging connector to use, defaults to not configured.
-     * @param options.templateEntryStorageConnectorType The type of the entity connector to use, defaults to "messaging-templates".
      */
     constructor(options) {
         if (Is.stringValue(options?.messagingEmailConnectorType)) {

package/dist/types/index.d.ts

@@ -1,3 +1,4 @@
 export * from "./entities/templateEntry";
 export * from "./messagingService";
+export * from "./models/IMessagingServiceConstructorOptions";
 export * from "./schema";

package/dist/types/messagingService.d.ts

@@ -1,4 +1,5 @@
 import { type IMessagingComponent } from "@twin.org/messaging-models";
+import type { IMessagingServiceConstructorOptions } from "./models/IMessagingServiceConstructorOptions";
 /**
  * Service for performing email messaging operations to a connector.
  */
@@ -14,17 +15,8 @@ export declare class MessagingService implements IMessagingComponent {
     /**
      * Create a new instance of MessagingService.
      * @param options The options for the connector.
-     * @param options.messagingEmailConnectorType The type of the email messaging connector to use, defaults to not configured.
-     * @param options.messagingPushNotificationConnectorType The type of the push notifications messaging connector to use, defaults to not configured.
-     * @param options.messagingSmsConnectorType The type of the sms messaging connector to use, defaults to not configured.
-     * @param options.templateEntryStorageConnectorType The type of the entity connector to use, defaults to "messaging-templates".
      */
-    constructor(options?: {
-        messagingEmailConnectorType?: string;
-        messagingPushNotificationConnectorType?: string;
-        messagingSmsConnectorType?: string;
-        templateEntryStorageConnectorType?: string;
-    });
+    constructor(options?: IMessagingServiceConstructorOptions);
     /**
      * Send a custom email.
      * @param sender The sender email address.

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

@@ -0,0 +1,22 @@
+/**
+ * Options for the messaging service.
+ */
+export interface IMessagingServiceConstructorOptions {
+    /**
+     * The type of the email messaging connector to use, defaults to not configured.
+     */
+    messagingEmailConnectorType?: string;
+    /**
+     * The type of the push notifications messaging connector to use, defaults to not configured.
+     */
+    messagingPushNotificationConnectorType?: string;
+    /**
+     * The type of the sms messaging connector to use, defaults to not configured.
+     */
+    messagingSmsConnectorType?: string;
+    /**
+     * The type of the entity connector to use.
+     * @default template-entry
+     */
+    templateEntryStorageConnectorType?: string;
+}

package/docs/changelog.md

@@ -1,5 +1,5 @@
 # @twin.org/messaging-service - Changelog
 
-## v0.0.1-next.7
+## v0.0.1-next.9
 
 - Initial Release

package/docs/reference/classes/MessagingService.md

@@ -16,25 +16,11 @@ Create a new instance of MessagingService.
 
 #### Parameters
 
-• **options?**
+##### options?
 
-The options for the connector.
-
-• **options.messagingEmailConnectorType?**: `string`
-
-The type of the email messaging connector to use, defaults to not configured.
-
-• **options.messagingPushNotificationConnectorType?**: `string`
-
-The type of the push notifications messaging connector to use, defaults to not configured.
-
-• **options.messagingSmsConnectorType?**: `string`
-
-The type of the sms messaging connector to use, defaults to not configured.
+[`IMessagingServiceConstructorOptions`](../interfaces/IMessagingServiceConstructorOptions.md)
 
-• **options.templateEntryStorageConnectorType?**: `string`
-
-The type of the entity connector to use, defaults to "messaging-templates".
+The options for the connector.
 
 #### Returns
 
@@ -70,23 +56,31 @@ Send a custom email.
 
 #### Parameters
 
-• **sender**: `string`
+##### sender
+
+`string`
 
 The sender email address.
 
-• **recipients**: `string`[]
+##### recipients
+
+`string`[]
 
 An array of recipients email addresses.
 
-• **templateId**: `string`
+##### templateId
+
+`string`
 
 The id of the email template.
 
-• **data**
+##### data
 
 The data to populate the email template.
 
-• **locale**: `string`
+##### locale
+
+`string`
 
 The locale of the email template.
 
@@ -110,11 +104,15 @@ Registers a device to an specific app in order to send notifications to it.
 
 #### Parameters
 
-• **applicationId**: `string`
+##### applicationId
+
+`string`
 
 The application address.
 
-• **deviceToken**: `string`
+##### deviceToken
+
+`string`
 
 The device token.
 
@@ -138,19 +136,25 @@ Send a push notification to a device.
 
 #### Parameters
 
-• **deviceAddress**: `string`
+##### deviceAddress
+
+`string`
 
 The address of the device.
 
-• **templateId**: `string`
+##### templateId
+
+`string`
 
 The id of the push notification template.
 
-• **data**
+##### data
 
 The data to populate the push notification template.
 
-• **locale**: `string`
+##### locale
+
+`string`
 
 The locale of the push notification template.
 
@@ -174,19 +178,25 @@ Send a SMS message to a phone number.
 
 #### Parameters
 
-• **phoneNumber**: `string`
+##### phoneNumber
+
+`string`
 
 The recipient phone number.
 
-• **templateId**: `string`
+##### templateId
+
+`string`
 
 The id of the SMS template.
 
-• **data**
+##### data
 
 The data to populate the SMS template.
 
-• **locale**: `string`
+##### locale
+
+`string`
 
 The locale of the SMS template.
 
@@ -210,19 +220,27 @@ Create or update a template.
 
 #### Parameters
 
-• **templateId**: `string`
+##### templateId
+
+`string`
 
 The id of the template.
 
-• **locale**: `string`
+##### locale
+
+`string`
 
 The locale of the template.
 
-• **title**: `string`
+##### title
+
+`string`
 
 The title of the template.
 
-• **content**: `string`
+##### content
+
+`string`
 
 The content of the template.
 

package/docs/reference/index.md

@@ -5,6 +5,10 @@
 - [TemplateEntry](classes/TemplateEntry.md)
 - [MessagingService](classes/MessagingService.md)
 
+## Interfaces
+
+- [IMessagingServiceConstructorOptions](interfaces/IMessagingServiceConstructorOptions.md)
+
 ## Functions
 
 - [initSchema](functions/initSchema.md)

package/docs/reference/interfaces/IMessagingServiceConstructorOptions.md

@@ -0,0 +1,41 @@
+# Interface: IMessagingServiceConstructorOptions
+
+Options for the messaging service.
+
+## Properties
+
+### messagingEmailConnectorType?
+
+> `optional` **messagingEmailConnectorType**: `string`
+
+The type of the email messaging connector to use, defaults to not configured.
+
+***
+
+### messagingPushNotificationConnectorType?
+
+> `optional` **messagingPushNotificationConnectorType**: `string`
+
+The type of the push notifications messaging connector to use, defaults to not configured.
+
+***
+
+### messagingSmsConnectorType?
+
+> `optional` **messagingSmsConnectorType**: `string`
+
+The type of the sms messaging connector to use, defaults to not configured.
+
+***
+
+### templateEntryStorageConnectorType?
+
+> `optional` **templateEntryStorageConnectorType**: `string`
+
+The type of the entity connector to use.
+
+#### Default
+
+```ts
+template-entry
+```

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@twin.org/messaging-service",
-	"version": "0.0.1-next.7",
+	"version": "0.0.1-next.9",
 	"description": "Messaging service implementation",
 	"repository": {
 		"type": "git",
@@ -16,9 +16,9 @@
 	"dependencies": {
 		"@twin.org/core": "next",
 		"@twin.org/entity": "next",
-		"@twin.org/entity-storage-models": "^0.0.1-next.7",
+		"@twin.org/entity-storage-models": "^0.0.1-next.9",
 		"@twin.org/logging-models": "next",
-		"@twin.org/messaging-models": "0.0.1-next.7",
+		"@twin.org/messaging-models": "0.0.1-next.9",
 		"@twin.org/nameof": "next"
 	},
 	"main": "./dist/cjs/index.cjs",
@@ -26,9 +26,9 @@
 	"types": "./dist/types/index.d.ts",
 	"exports": {
 		".": {
+			"types": "./dist/types/index.d.ts",
 			"require": "./dist/cjs/index.cjs",
-			"import": "./dist/esm/index.mjs",
-			"types": "./dist/types/index.d.ts"
+			"import": "./dist/esm/index.mjs"
 		},
 		"./locales": "./locales"
 	},