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ò
2024-05-02 16:43:18 +02:00
committed by GitHub
parent 4b86c7a298
commit 9bce3417e9
60 changed files with 6499 additions and 371 deletions

View File

@@ -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": {