feat(server): email notifications (#8447)
* feat(server): add `react-mail` as mail template engine and `nodemailer` * feat(server): add `smtp` related configs to `SystemConfig` * feat(web): add page for SMTP settings * feat(server): add `react-email.adapter` This adapter render the React-Email into HTML and plain/text email. The output is set as the body of the email. * feat(server): add `MailRepository` and `MailService` Allow to use the NestJS-modules-mailer module to send SMTP emails. This is the base transport for the `NotificationRepository` * feat(server): register the job dispatcher and Job for async email This allows to queue email sending jobs for the `EmailService`. * feat(server): add `NotificationRepository` and `NotificationService` This act as a middleware to properly route the notification to the right transport. As POC I've only implemented a simple SMTP transport. * feat(server): add `welcome` email template * feat(server): add the first notification on `createUser` in `UserService` This trigger an event for the `NotificationRepository` that once processes by using the global config and per-user config will carry the payload to the right notification transport. * chore: clean up * chore: clean up web * fix: type errors" * fix package lock * fix mail sending, option to ignore certs * chore: open api * chore: clean up * remove unused import * feat: email feature flag * chore: remove unused interface * small styling --------- Co-authored-by: Jason Rasmussen <jrasm91@gmail.com> Co-authored-by: Daniel Dietzler <mail@ddietzler.dev> Co-authored-by: Alex Tran <alex.tran1502@gmail.com>
This commit is contained in:
Nicolò
@@ -6812,6 +6812,9 @@
|
||||
"migration": {
|
||||
"$ref": "#/components/schemas/JobStatusDto"
|
||||
},
|
||||
"notifications": {
|
||||
"$ref": "#/components/schemas/JobStatusDto"
|
||||
},
|
||||
"search": {
|
||||
"$ref": "#/components/schemas/JobStatusDto"
|
||||
},
|
||||
@@ -6838,6 +6841,7 @@
|
||||
"library",
|
||||
"metadataExtraction",
|
||||
"migration",
|
||||
"notifications",
|
||||
"search",
|
||||
"sidecar",
|
||||
"smartSearch",
|
||||
@@ -7754,6 +7758,9 @@
|
||||
"name": {
|
||||
"type": "string"
|
||||
},
|
||||
"notify": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"password": {
|
||||
"type": "string"
|
||||
},
|
||||
@@ -8145,7 +8152,8 @@
|
||||
"migration",
|
||||
"search",
|
||||
"sidecar",
|
||||
"library"
|
||||
"library",
|
||||
"notifications"
|
||||
],
|
||||
"type": "string"
|
||||
},
|
||||
@@ -9357,6 +9365,9 @@
|
||||
"configFile": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"email": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"facialRecognition": {
|
||||
"type": "boolean"
|
||||
},
|
||||
@@ -9390,6 +9401,7 @@
|
||||
},
|
||||
"required": [
|
||||
"configFile",
|
||||
"email",
|
||||
"facialRecognition",
|
||||
"map",
|
||||
"oauth",
|
||||
@@ -9925,6 +9937,9 @@
|
||||
"newVersionCheck": {
|
||||
"$ref": "#/components/schemas/SystemConfigNewVersionCheckDto"
|
||||
},
|
||||
"notifications": {
|
||||
"$ref": "#/components/schemas/SystemConfigNotificationsDto"
|
||||
},
|
||||
"oauth": {
|
||||
"$ref": "#/components/schemas/SystemConfigOAuthDto"
|
||||
},
|
||||
@@ -9959,6 +9974,7 @@
|
||||
"machineLearning",
|
||||
"map",
|
||||
"newVersionCheck",
|
||||
"notifications",
|
||||
"oauth",
|
||||
"passwordLogin",
|
||||
"reverseGeocoding",
|
||||
@@ -10128,6 +10144,9 @@
|
||||
"migration": {
|
||||
"$ref": "#/components/schemas/JobSettingsDto"
|
||||
},
|
||||
"notifications": {
|
||||
"$ref": "#/components/schemas/JobSettingsDto"
|
||||
},
|
||||
"search": {
|
||||
"$ref": "#/components/schemas/JobSettingsDto"
|
||||
},
|
||||
@@ -10150,6 +10169,7 @@
|
||||
"library",
|
||||
"metadataExtraction",
|
||||
"migration",
|
||||
"notifications",
|
||||
"search",
|
||||
"sidecar",
|
||||
"smartSearch",
|
||||
@@ -10267,6 +10287,17 @@
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SystemConfigNotificationsDto": {
|
||||
"properties": {
|
||||
"smtp": {
|
||||
"$ref": "#/components/schemas/SystemConfigSmtpDto"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"smtp"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SystemConfigOAuthDto": {
|
||||
"properties": {
|
||||
"autoLaunch": {
|
||||
@@ -10368,6 +10399,58 @@
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SystemConfigSmtpDto": {
|
||||
"properties": {
|
||||
"enabled": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"from": {
|
||||
"type": "string"
|
||||
},
|
||||
"replyTo": {
|
||||
"type": "string"
|
||||
},
|
||||
"transport": {
|
||||
"$ref": "#/components/schemas/SystemConfigSmtpTransportDto"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"enabled",
|
||||
"from",
|
||||
"replyTo",
|
||||
"transport"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SystemConfigSmtpTransportDto": {
|
||||
"properties": {
|
||||
"host": {
|
||||
"type": "string"
|
||||
},
|
||||
"ignoreCert": {
|
||||
"type": "boolean"
|
||||
},
|
||||
"password": {
|
||||
"type": "string"
|
||||
},
|
||||
"port": {
|
||||
"maximum": 65535,
|
||||
"minimum": 0,
|
||||
"type": "number"
|
||||
},
|
||||
"username": {
|
||||
"type": "string"
|
||||
}
|
||||
},
|
||||
"required": [
|
||||
"host",
|
||||
"ignoreCert",
|
||||
"password",
|
||||
"port",
|
||||
"username"
|
||||
],
|
||||
"type": "object"
|
||||
},
|
||||
"SystemConfigStorageTemplateDto": {
|
||||
"properties": {
|
||||
"enabled": {
|
||||
|
||||
@@ -407,6 +407,7 @@ export type AllJobStatusResponseDto = {
|
||||
library: JobStatusDto;
|
||||
metadataExtraction: JobStatusDto;
|
||||
migration: JobStatusDto;
|
||||
notifications: JobStatusDto;
|
||||
search: JobStatusDto;
|
||||
sidecar: JobStatusDto;
|
||||
smartSearch: JobStatusDto;
|
||||
@@ -745,6 +746,7 @@ export type ServerConfigDto = {
|
||||
};
|
||||
export type ServerFeaturesDto = {
|
||||
configFile: boolean;
|
||||
email: boolean;
|
||||
facialRecognition: boolean;
|
||||
map: boolean;
|
||||
oauth: boolean;
|
||||
@@ -895,6 +897,7 @@ export type SystemConfigJobDto = {
|
||||
library: JobSettingsDto;
|
||||
metadataExtraction: JobSettingsDto;
|
||||
migration: JobSettingsDto;
|
||||
notifications: JobSettingsDto;
|
||||
search: JobSettingsDto;
|
||||
sidecar: JobSettingsDto;
|
||||
smartSearch: JobSettingsDto;
|
||||
@@ -944,6 +947,22 @@ export type SystemConfigMapDto = {
|
||||
export type SystemConfigNewVersionCheckDto = {
|
||||
enabled: boolean;
|
||||
};
|
||||
export type SystemConfigSmtpTransportDto = {
|
||||
host: string;
|
||||
ignoreCert: boolean;
|
||||
password: string;
|
||||
port: number;
|
||||
username: string;
|
||||
};
|
||||
export type SystemConfigSmtpDto = {
|
||||
enabled: boolean;
|
||||
"from": string;
|
||||
replyTo: string;
|
||||
transport: SystemConfigSmtpTransportDto;
|
||||
};
|
||||
export type SystemConfigNotificationsDto = {
|
||||
smtp: SystemConfigSmtpDto;
|
||||
};
|
||||
export type SystemConfigOAuthDto = {
|
||||
autoLaunch: boolean;
|
||||
autoRegister: boolean;
|
||||
@@ -994,6 +1013,7 @@ export type SystemConfigDto = {
|
||||
machineLearning: SystemConfigMachineLearningDto;
|
||||
map: SystemConfigMapDto;
|
||||
newVersionCheck: SystemConfigNewVersionCheckDto;
|
||||
notifications: SystemConfigNotificationsDto;
|
||||
oauth: SystemConfigOAuthDto;
|
||||
passwordLogin: SystemConfigPasswordLoginDto;
|
||||
reverseGeocoding: SystemConfigReverseGeocodingDto;
|
||||
@@ -1035,6 +1055,7 @@ export type CreateUserDto = {
|
||||
email: string;
|
||||
memoriesEnabled?: boolean;
|
||||
name: string;
|
||||
notify?: boolean;
|
||||
password: string;
|
||||
quotaSizeInBytes?: number | null;
|
||||
shouldChangePassword?: boolean;
|
||||
@@ -2852,7 +2873,8 @@ export enum JobName {
|
||||
Migration = "migration",
|
||||
Search = "search",
|
||||
Sidecar = "sidecar",
|
||||
Library = "library"
|
||||
Library = "library",
|
||||
Notifications = "notifications"
|
||||
}
|
||||
export enum JobCommand {
|
||||
Start = "start",
|
||||
|
||||
Reference in New Issue
Block a user