vintasend 0.1.8 → 0.1.10

package/README.md

@@ -0,0 +1,47 @@
+# VintaSend TypeScript
+
+A TypeScript library for sending emails using multiple email service providers with failover support.
+
+## Installation
+
+```bash
+npm install vintasend
+# or
+yarn add vintasend
+```
+
+## Features
+* **Storing notifications in a Database**: This package relies on a data store to record all the notifications that will be sent. It also keeps it's state column up to date.
+* **Scheduling notifications**: Storing notifications to be send in the future. The notification's context for rendering the template is only evaluated at the moment the notification is sent due to the lib's context generation registry.
+* **Notification context fetched at send time**: On scheduled notifications, we only get the notification context at the send time, so we always get the most up-to-date information.
+* **Flexible backend**: Your projects database is getting slow after you created the first milion notifications? You can migrate to a faster no-sql database with a blink of an eye without affecting how you send the notifications.
+* **Flexible adapters**: Your project probably will need to change how it sends notifications overtime. This package allows to change the adapter without having to change how notifications templates are rendered or how the notification themselves are stored.
+* **Flexible template renderers**: Wanna start managing your templates with a third party tool (so non-technical people can help maintaining them)? Or even choose a more powerful rendering engine? You can do it independetly of how you send the notifications or store them in the database.
+
+## Development
+
+1. Clone the repository
+2. Install dependencies:
+```bash
+npm install
+# or
+yarn
+```
+3. Run tests:
+```bash
+npm test
+# or
+yarn test
+```
+
+## Contributing
+
+Feel free to open issues and submit pull requests.
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## Credits
+
+Created by [Vinta Software](https://www.vinta.com.br/)

package/dist/services/notification-adapters/base-notification-adapter.d.ts

@@ -5,11 +5,13 @@ import type { BaseNotificationTemplateRenderer } from '../notification-template-
 import type { ContextGenerator } from '../notification-context-registry';
 import type { JsonValue } from '../../types/json-values';
 import type { Identifier } from '../../types/identifier';
-export interface BaseNotificationAdapter<TemplateRenderer extends BaseNotificationTemplateRenderer<AvailableContexts>, Backend extends BaseNotificationBackend<AvailableContexts>, AvailableContexts extends Record<string, ContextGenerator>, NotificationIdType extends Identifier = Identifier, UserIdType extends Identifier = Identifier> {
-    notificationType: NotificationType;
-    key: string;
-    templateRenderer: TemplateRenderer;
-    backend: Backend;
-    enqueueNotifications: boolean;
+export declare abstract class BaseNotificationAdapter<TemplateRenderer extends BaseNotificationTemplateRenderer<AvailableContexts>, AvailableContexts extends Record<string, ContextGenerator>, NotificationIdType extends Identifier = Identifier, UserIdType extends Identifier = Identifier> {
+    protected templateRenderer: TemplateRenderer;
+    readonly notificationType: NotificationType;
+    readonly enqueueNotifications: boolean;
+    key: string | null;
+    backend: BaseNotificationBackend<AvailableContexts, NotificationIdType, UserIdType> | null;
+    constructor(templateRenderer: TemplateRenderer, notificationType: NotificationType, enqueueNotifications: boolean);
     send(notification: Notification<AvailableContexts, NotificationIdType, UserIdType>, context: JsonValue): Promise<void>;
+    injectBackend(backend: BaseNotificationBackend<AvailableContexts, NotificationIdType, UserIdType>): void;
 }

package/dist/services/notification-adapters/base-notification-adapter.js

@@ -1,2 +1,25 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.BaseNotificationAdapter = void 0;
+class BaseNotificationAdapter {
+    constructor(templateRenderer, notificationType, enqueueNotifications) {
+        this.templateRenderer = templateRenderer;
+        this.notificationType = notificationType;
+        this.enqueueNotifications = enqueueNotifications;
+        this.key = null;
+        this.backend = null;
+    }
+    ;
+    send(notification, context) {
+        if (this.backend === null) {
+            throw new Error('Backend not injected');
+        }
+        return Promise.resolve();
+    }
+    ;
+    injectBackend(backend) {
+        this.backend = backend;
+    }
+    ;
+}
+exports.BaseNotificationAdapter = BaseNotificationAdapter;

package/dist/services/notification-service.d.ts

@@ -16,7 +16,7 @@ export declare class NotificationService<AvailableContexts extends Record<string
     private logger;
     private queueService?;
     private options;
-    constructor(adapters: BaseNotificationAdapter<BaseNotificationTemplateRenderer<AvailableContexts, NotificationIdType, UserIdType>, BaseNotificationBackend<AvailableContexts, NotificationIdType, UserIdType>, AvailableContexts, NotificationIdType, UserIdType>[], backend: BaseNotificationBackend<AvailableContexts, NotificationIdType, UserIdType>, logger: BaseLogger, queueService?: BaseNotificationQueueService<NotificationIdType> | undefined, options?: NotificationServiceOptions);
+    constructor(adapters: BaseNotificationAdapter<BaseNotificationTemplateRenderer<AvailableContexts, NotificationIdType, UserIdType>, AvailableContexts, NotificationIdType, UserIdType>[], backend: BaseNotificationBackend<AvailableContexts, NotificationIdType, UserIdType>, logger: BaseLogger, queueService?: BaseNotificationQueueService<NotificationIdType> | undefined, options?: NotificationServiceOptions);
     registerQueueService(queueService: BaseNotificationQueueService<NotificationIdType>): void;
     send(notification: Notification<AvailableContexts, NotificationIdType, UserIdType>): Promise<void>;
     createNotification(notification: Omit<Notification<AvailableContexts, NotificationIdType, UserIdType>, 'id'>): Promise<Notification<AvailableContexts, NotificationIdType, UserIdType>>;

package/dist/services/notification-service.js

@@ -11,6 +11,9 @@ class NotificationService {
         this.logger = logger;
         this.queueService = queueService;
         this.options = options;
+        for (const adapter of adapters) {
+            adapter.injectBackend(backend);
+        }
     }
     registerQueueService(queueService) {
         this.queueService = queueService;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "vintasend",
-  "version": "0.1.8",
+  "version": "0.1.10",
   "main": "dist/index.js",
   "files": [
     "dist"