vintasend 0.1.11 → 0.1.12

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

@@ -1,15 +1,16 @@
 import type { NotificationType } from '../../types/notification-type';
-import type { Notification } from '../../types/notification';
+import type { DatabaseNotification } from '../../types/notification';
 import type { BaseNotificationTemplateRenderer } from '../notification-template-renderers/base-notification-template-renderer';
 import type { JsonValue } from '../../types/json-values';
 import type { BaseNotificationTypeConfig } from '../../types/notification-type-config';
+import type { BaseNotificationBackend } from '../notification-backends/base-notification-backend';
 export declare abstract class BaseNotificationAdapter<TemplateRenderer extends BaseNotificationTemplateRenderer<Config>, Config extends BaseNotificationTypeConfig> {
     protected templateRenderer: TemplateRenderer;
     readonly notificationType: NotificationType;
     readonly enqueueNotifications: boolean;
     key: string | null;
-    backend: Config['Backend'] | null;
+    backend: BaseNotificationBackend<Config> | null;
     constructor(templateRenderer: TemplateRenderer, notificationType: NotificationType, enqueueNotifications: boolean);
-    send(notification: Notification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>, context: JsonValue): Promise<void>;
-    injectBackend(backend: Config["Backend"]): void;
+    send(notification: DatabaseNotification<Config>, context: JsonValue): Promise<void>;
+    injectBackend(backend: BaseNotificationBackend<Config>): void;
 }

package/dist/services/notification-backends/base-notification-backend.d.ts

@@ -2,21 +2,21 @@ import type { InputJsonValue } from '../../types/json-values';
 import type { DatabaseNotification, Notification } from '../../types/notification';
 import type { BaseNotificationTypeConfig } from '../../types/notification-type-config';
 export interface BaseNotificationBackend<Config extends BaseNotificationTypeConfig> {
-    getAllPendingNotifications(): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    getPendingNotifications(): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    getAllFutureNotifications(): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    getFutureNotifications(): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    getAllFutureNotificationsFromUser(userId: Config["UserIdType"]): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    getFutureNotificationsFromUser(userId: Config["UserIdType"]): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    persistNotification(notification: Omit<Notification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>, 'id'>): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>>;
-    persistNotificationUpdate(notificationId: Config["NotificationIdType"], notification: Partial<Omit<Notification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>, 'id'>>): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>>;
-    markPendingAsSent(notificationId: Config["NotificationIdType"]): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>>;
-    markPendingAsFailed(notificationId: Config["NotificationIdType"]): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>>;
-    markSentAsRead(notificationId: Config["NotificationIdType"]): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>>;
+    getAllPendingNotifications(): Promise<DatabaseNotification<Config>[]>;
+    getPendingNotifications(): Promise<DatabaseNotification<Config>[]>;
+    getAllFutureNotifications(): Promise<DatabaseNotification<Config>[]>;
+    getFutureNotifications(): Promise<DatabaseNotification<Config>[]>;
+    getAllFutureNotificationsFromUser(userId: Config["UserIdType"]): Promise<DatabaseNotification<Config>[]>;
+    getFutureNotificationsFromUser(userId: Config["UserIdType"]): Promise<DatabaseNotification<Config>[]>;
+    persistNotification(notification: Omit<Notification<Config>, 'id'>): Promise<DatabaseNotification<Config>>;
+    persistNotificationUpdate(notificationId: Config["NotificationIdType"], notification: Partial<Omit<Notification<Config>, 'id'>>): Promise<DatabaseNotification<Config>>;
+    markPendingAsSent(notificationId: Config["NotificationIdType"]): Promise<DatabaseNotification<Config>>;
+    markPendingAsFailed(notificationId: Config["NotificationIdType"]): Promise<DatabaseNotification<Config>>;
+    markSentAsRead(notificationId: Config["NotificationIdType"]): Promise<DatabaseNotification<Config>>;
     cancelNotification(notificationId: Config["NotificationIdType"]): Promise<void>;
-    getNotification(notificationId: Config["NotificationIdType"], forUpdate: boolean): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]> | null>;
-    filterAllInAppUnreadNotifications(userId: Config["UserIdType"]): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
-    filterInAppUnreadNotifications(userId: Config["UserIdType"], page: number, pageSize: number): Promise<DatabaseNotification<Config["ContextMap"], Config["NotificationIdType"], Config["UserIdType"]>[]>;
+    getNotification(notificationId: Config["NotificationIdType"], forUpdate: boolean): Promise<DatabaseNotification<Config> | null>;
+    filterAllInAppUnreadNotifications(userId: Config["UserIdType"]): Promise<DatabaseNotification<Config>[]>;
+    filterInAppUnreadNotifications(userId: Config["UserIdType"], page: number, pageSize: number): Promise<DatabaseNotification<Config>[]>;
     getUserEmailFromNotification(notificationId: Config["NotificationIdType"]): Promise<string | undefined>;
     storeContextUsed(notificationId: Config["NotificationIdType"], context: InputJsonValue): Promise<void>;
 }

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

@@ -1,8 +1,11 @@
-import type { Identifier } from '../types/identifier';
-import type { Notification } from '../types/notification';
-import type { BaseLogger } from './loggers/base-logger';
+import type { DatabaseNotification, Notification } from '../types/notification';
 import type { JsonObject } from '../types/json-values';
 import type { BaseNotificationTypeConfig } from '../types/notification-type-config';
+import type { BaseNotificationAdapter } from './notification-adapters/base-notification-adapter';
+import type { BaseNotificationTemplateRenderer } from './notification-template-renderers/base-notification-template-renderer';
+import type { BaseNotificationBackend } from './notification-backends/base-notification-backend';
+import type { BaseLogger } from './loggers/base-logger';
+import type { BaseNotificationQueueService } from './notification-queue-service/base-notification-queue-service';
 type NotificationServiceOptions = {
     raiseErrorOnFailedSend: boolean;
 };
@@ -12,21 +15,21 @@ export declare class NotificationService<Config extends BaseNotificationTypeConf
     private logger;
     private queueService?;
     private options;
-    constructor(adapters: Config['AdaptersList'], backend: Config['Backend'], logger: BaseLogger, queueService?: Config["QueueService"] | undefined, options?: NotificationServiceOptions);
-    registerQueueService(queueService: Config['QueueService']): void;
-    send(notification: Notification<Config['ContextMap'], Config['NotificationIdType'], Config['UserIdType']>): Promise<void>;
-    createNotification(notification: Omit<Notification<Config['ContextMap'], Config['NotificationIdType'], Config['UserIdType']>, 'id'>): Promise<Notification<Config['ContextMap'], Config['NotificationIdType'], Config['UserIdType']>>;
-    updateNotification(notificationId: Identifier, notification: Partial<Omit<Notification<Config['ContextMap'], Config['NotificationIdType'], Config['UserIdType']>, 'id'>>): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>>;
-    getAllFutureNotifications(): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>[]>;
-    getAllFutureNotificationsFromUser(userId: Config['NotificationIdType']): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>[]>;
-    getFutureNotificationsFromUser(userId: Config['NotificationIdType']): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>[]>;
-    getFutureNotifications(): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>[]>;
+    constructor(adapters: BaseNotificationAdapter<BaseNotificationTemplateRenderer<Config>, Config>[], backend: BaseNotificationBackend<Config>, logger: BaseLogger, queueService?: BaseNotificationQueueService<Config> | undefined, options?: NotificationServiceOptions);
+    registerQueueService(queueService: BaseNotificationQueueService<Config>): void;
+    send(notification: DatabaseNotification<Config>): Promise<void>;
+    createNotification(notification: Omit<Notification<Config>, 'id'>): Promise<Notification<Config>>;
+    updateNotification(notificationId: Config['NotificationIdType'], notification: Partial<Omit<Notification<Config>, 'id'>>): Promise<DatabaseNotification<Config>>;
+    getAllFutureNotifications(): Promise<DatabaseNotification<Config>[]>;
+    getAllFutureNotificationsFromUser(userId: Config['NotificationIdType']): Promise<DatabaseNotification<Config>[]>;
+    getFutureNotificationsFromUser(userId: Config['NotificationIdType']): Promise<DatabaseNotification<Config>[]>;
+    getFutureNotifications(): Promise<DatabaseNotification<Config>[]>;
     getNotificationContext(contextName: keyof Config['ContextMap'], parameters: Parameters<Config['ContextMap'][keyof Config['ContextMap']]['generate']>[0]): Promise<JsonObject>;
     sendPendingNotifications(): Promise<void>;
-    getPendingNotifications(): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>[]>;
-    getNotification(notificationId: Config['NotificationIdType'], forUpdate?: boolean): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier> | null>;
-    markRead(notificationId: Config['NotificationIdType']): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>>;
-    getInAppUnread(userId: Config['NotificationIdType']): Promise<import("../types/notification").DatabaseNotification<Record<string, import("./notification-context-registry").ContextGenerator>, Identifier, Identifier>[]>;
+    getPendingNotifications(): Promise<DatabaseNotification<Config>[]>;
+    getNotification(notificationId: Config['NotificationIdType'], forUpdate?: boolean): Promise<DatabaseNotification<Config> | null>;
+    markRead(notificationId: Config['NotificationIdType']): Promise<DatabaseNotification<Config>>;
+    getInAppUnread(userId: Config['NotificationIdType']): Promise<DatabaseNotification<Config>[]>;
     cancelNotification(notificationId: Config['NotificationIdType']): Promise<void>;
     delayedSend(notificationId: Config['NotificationIdType']): Promise<void>;
 }

package/dist/services/notification-service.js

@@ -28,7 +28,7 @@ class NotificationService {
             return;
         }
         if (!notification.id) {
-            throw new Error("Notification wan't created in the database. Please create it first");
+            throw new Error("Notification wasn't created in the database. Please create it first");
         }
         for (const adapter of adaptersOfType) {
             if (adapter.enqueueNotifications) {

package/dist/services/notification-template-renderers/base-email-template-renderer.d.ts

@@ -9,5 +9,5 @@ export type EmailTemplate = {
     body: string;
 };
 export interface BaseEmailTemplateRenderer<Config extends BaseNotificationTypeConfig> extends BaseNotificationTemplateRenderer<Config, EmailTemplate> {
-    render(notification: Notification<Config['ContextMap'], Config['NotificationIdType'], Config['UserIdType']>, context: JsonObject): Promise<EmailTemplate>;
+    render(notification: Notification<Config>, context: JsonObject): Promise<EmailTemplate>;
 }

package/dist/services/notification-template-renderers/base-notification-template-renderer.d.ts

@@ -2,5 +2,5 @@ import type { JsonObject } from '../../types/json-values';
 import type { Notification } from '../../types/notification';
 import type { BaseNotificationTypeConfig } from '../../types/notification-type-config';
 export interface BaseNotificationTemplateRenderer<Config extends BaseNotificationTypeConfig, T = unknown> {
-    render(notification: Notification<Config['ContextMap'], Config['NotificationIdType'], Config['UserIdType']>, context: JsonObject): Promise<T>;
+    render(notification: Notification<Config>, context: JsonObject): Promise<T>;
 }

package/dist/types/notification-type-config.d.ts

@@ -1,16 +1,7 @@
-import type { BaseLogger } from "../services/loggers/base-logger";
-import type { BaseNotificationAdapter } from "../services/notification-adapters/base-notification-adapter";
-import type { BaseNotificationBackend } from "../services/notification-backends/base-notification-backend";
 import type { ContextGenerator } from "../services/notification-context-registry";
-import type { BaseNotificationQueueService } from "../services/notification-queue-service/base-notification-queue-service";
-import type { BaseNotificationTemplateRenderer } from "../services/notification-template-renderers/base-notification-template-renderer";
 import type { Identifier } from "./identifier";
 export type BaseNotificationTypeConfig = {
     ContextMap: Record<string, ContextGenerator>;
     NotificationIdType: Identifier;
     UserIdType: Identifier;
-    AdaptersList: BaseNotificationAdapter<BaseNotificationTemplateRenderer<BaseNotificationTypeConfig>, BaseNotificationTypeConfig>[];
-    Backend: BaseNotificationBackend<BaseNotificationTypeConfig>;
-    Logger: BaseLogger;
-    QueueService: BaseNotificationQueueService<BaseNotificationTypeConfig>;
 };

package/dist/types/notification.d.ts

@@ -1,32 +1,31 @@
-import type { ContextGenerator } from '../services/notification-context-registry';
-import type { Identifier } from './identifier';
 import type { InputJsonValue, JsonValue } from './json-values';
 import type { NotificationStatus } from './notification-status';
 import type { NotificationType } from './notification-type';
-export type NotificationInput<AvailableContexts extends Record<string, ContextGenerator>, UserIdType extends Identifier = Identifier> = {
+import type { BaseNotificationTypeConfig } from './notification-type-config';
+export type NotificationInput<Config extends BaseNotificationTypeConfig> = {
     id: undefined;
-    userId: UserIdType;
+    userId: Config['UserIdType'];
     notificationType: NotificationType;
     title: string | null;
     bodyTemplate: string;
-    contextName: keyof AvailableContexts;
-    contextParameters: Parameters<AvailableContexts[NotificationInput<AvailableContexts>['contextName']]['generate']>[0];
+    contextName: keyof Config['ContextMap'];
+    contextParameters: Parameters<Config['ContextMap'][NotificationInput<Config>['contextName']]['generate']>[0];
     sendAfter: Date | null;
     subjectTemplate: string | null;
     extraParams: InputJsonValue | null;
 };
-export type DatabaseNotification<AvailableContexts extends Record<string, ContextGenerator>, NotificatioIdType extends Identifier = Identifier, UserIdType extends Identifier = Identifier> = {
-    id: NotificatioIdType;
-    userId: UserIdType;
+export type DatabaseNotification<Config extends BaseNotificationTypeConfig> = {
+    id: Config['NotificationIdType'];
+    userId: Config['UserIdType'];
     notificationType: NotificationType;
     title: string | null;
     bodyTemplate: string;
-    contextName: keyof AvailableContexts;
-    contextParameters: Parameters<AvailableContexts[NotificationInput<AvailableContexts>['contextName']]['generate']>[0];
+    contextName: keyof Config['ContextMap'];
+    contextParameters: Parameters<Config['ContextMap'][NotificationInput<Config>['contextName']]['generate']>[0];
     sendAfter: Date | null;
     subjectTemplate: string | null;
     status: NotificationStatus;
-    contextUsed: ReturnType<AvailableContexts[NotificationInput<AvailableContexts>['contextName']]['generate']> | null;
+    contextUsed: ReturnType<Config['ContextMap'][NotificationInput<Config>['contextName']]['generate']> | null;
     extraParams: JsonValue;
     adapterUsed: string | null;
     sentAt: Date | null;
@@ -34,4 +33,4 @@ export type DatabaseNotification<AvailableContexts extends Record<string, Contex
     createdAt?: Date;
     updatedAt?: Date;
 };
-export type Notification<AvailableContexts extends Record<string, ContextGenerator>, NotificatioIdType extends Identifier = Identifier, UserIdType extends Identifier = Identifier> = NotificationInput<AvailableContexts, UserIdType> | DatabaseNotification<AvailableContexts, NotificatioIdType, UserIdType>;
+export type Notification<Config extends BaseNotificationTypeConfig> = NotificationInput<Config> | DatabaseNotification<Config>;

package/package.json

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