@node-in-layers/notifications 0.0.0-stage → 1.0.1

package/types.d.ts

@@ -0,0 +1,55 @@
+import { Config, XOR } from '@node-in-layers/core';
+import type { NotificationChannel } from './core/types.js';
+export declare enum NotificationsNamespace {
+    Core = "@node-in-layers/notifications",
+    Backend = "@node-in-layers/notifications/backend"
+}
+export type EmailTemplateSource = Readonly<{
+    subject?: string;
+    text?: string;
+    html?: string;
+}>;
+export type NotificationTemplateSource = XOR<string, EmailTemplateSource>;
+export type NotificationTemplatesConfig = Readonly<Record<string, Readonly<Record<string, NotificationTemplateSource>>>>;
+export type SmtpEmailConfig = Readonly<{
+    host: string;
+    port: number;
+    secure?: boolean;
+    auth?: Readonly<{
+        user: string;
+        pass: string;
+    }>;
+    from: string;
+    defaultTo?: readonly string[];
+    subjectPrefix?: string;
+    transportOptions?: Readonly<Record<string, unknown>>;
+}>;
+export type CoreNotificationsConfig = Readonly<{
+    defaultTtl?: number;
+    noTTL?: boolean;
+}>;
+export type BackendNotificationsConfig = Readonly<{
+    adminUrl?: string;
+    adminEmails?: readonly string[];
+    email?: SmtpEmailConfig;
+    notifiers?: Readonly<Record<string, string>>;
+    defaultChannels?: readonly (NotificationChannel | string)[];
+    templates?: NotificationTemplatesConfig;
+    persistNotifications?: boolean;
+    useDatabaseConfig?: boolean;
+    databaseConfigKey?: string;
+    useDatabaseTemplates?: boolean;
+    userResolution?: Readonly<{
+        userModel?: string;
+        userResolverFeature?: string;
+        defaultChannels?: readonly (NotificationChannel | string)[];
+    }>;
+    tasks?: Readonly<{
+        enabled?: boolean;
+    }>;
+}>;
+export type NotificationsConfig = Readonly<{
+    [NotificationsNamespace.Core]?: CoreNotificationsConfig;
+    [NotificationsNamespace.Backend]?: BackendNotificationsConfig;
+}>;
+export type ConfigWithNotifications = Config & NotificationsConfig;

package/types.js

@@ -0,0 +1,6 @@
+export var NotificationsNamespace;
+(function (NotificationsNamespace) {
+    NotificationsNamespace["Core"] = "@node-in-layers/notifications";
+    NotificationsNamespace["Backend"] = "@node-in-layers/notifications/backend";
+})(NotificationsNamespace || (NotificationsNamespace = {}));
+//# sourceMappingURL=types.js.map

package/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAGA,MAAM,CAAN,IAAY,sBAGX;AAHD,WAAY,sBAAsB;IAChC,gEAAsC,CAAA;IACtC,2EAAiD,CAAA;AACnD,CAAC,EAHW,sBAAsB,KAAtB,sBAAsB,QAGjC"}