@contember/engine-tenant-api 2.0.0-rc.2 → 2.1.0-alpha.1

package/dist/types/utils/Mailer.d.ts

@@ -1,10 +1,18 @@
 import { Transporter, TransportOptions } from 'nodemailer';
-import { Options as MailMessage } from 'nodemailer/lib/mailer';
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport';
 import * as SMTPPool from 'nodemailer/lib/smtp-pool';
 import * as SendmailTransport from 'nodemailer/lib/sendmail-transport';
 import * as SESTransport from 'nodemailer/lib/ses-transport';
-export { type MailMessage };
+import { MailTemplateIdentifier } from '../model';
+export interface MailMessage {
+    to: string;
+    subject: string;
+    html: string;
+    from?: string;
+    replyTo?: string;
+    variables?: Record<string, any>;
+    template?: MailTemplateIdentifier;
+}
 export interface SentInfo {
     error?: any;
     messageId?: string;
@@ -13,9 +21,14 @@ export interface SentInfo {
     rejected?: string[];
     pending?: string[];
 }
-export type MailerOptions = Partial<(SMTPTransport.Options | SMTPPool.Options | SendmailTransport.Options | SESTransport.Options | TransportOptions) & {
+export type MailerOptions = (SMTPTransport.Options | SMTPPool.Options | SendmailTransport.Options | SESTransport.Options | TransportOptions | {
+    webhook: string | {
+        url: string;
+        headers?: Record<string, string>;
+    };
+}) & {
     from?: string;
-}>;
+};
 export interface Mailer {
     send(message: MailMessage): Promise<SentInfo>;
 }
@@ -23,6 +36,13 @@ export declare class NodeMailer implements Mailer {
     private readonly from;
     private readonly transport;
     constructor(from: string | undefined, transport: Transporter);
+    send({ variables, template, ...message }: MailMessage): Promise<SentInfo>;
+}
+export declare class WebhookMailer implements Mailer {
+    private readonly from;
+    private readonly url;
+    private readonly headers;
+    constructor(from: string | undefined, url: string, headers?: Record<string, string>);
     send(message: MailMessage): Promise<SentInfo>;
 }
 export declare const createMailer: (options: MailerOptions) => Mailer;

package/dist/types/utils/Mailer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"Mailer.d.ts","sourceRoot":"","sources":["../../../src/utils/Mailer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,WAAW,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC3E,OAAO,EAAE,OAAO,IAAI,WAAW,EAAE,MAAM,uBAAuB,CAAA;AAC9D,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAA;AAC9D,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAA;AACpD,OAAO,KAAK,iBAAiB,MAAM,mCAAmC,CAAA;AACtE,OAAO,KAAK,YAAY,MAAM,8BAA8B,CAAA;AAG5D,OAAO,EAAE,KAAK,WAAW,EAAE,CAAA;AAE3B,MAAM,WAAW,QAAQ;IACxB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,MAAM,aAAa,GAAG,OAAO,CAClC,CAAC,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,GAAG,gBAAgB,CAAC,GAAG;IAClH,IAAI,CAAC,EAAE,MAAM,CAAA;CACb,CACD,CAAA;AAED,MAAM,WAAW,MAAM;IACtB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC7C;AAED,qBAAa,UAAW,YAAW,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI;IAAsB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAApD,IAAI,EAAE,MAAM,GAAG,SAAS,EAAmB,SAAS,EAAE,WAAW;IAEjF,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQ1D;AAED,eAAO,MAAM,YAAY,YAAa,aAAa,KAAG,MAGrD,CAAA"}
+{"version":3,"file":"Mailer.d.ts","sourceRoot":"","sources":["../../../src/utils/Mailer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAmB,WAAW,EAAE,gBAAgB,EAAE,MAAM,YAAY,CAAA;AAC3E,OAAO,KAAK,aAAa,MAAM,+BAA+B,CAAA;AAC9D,OAAO,KAAK,QAAQ,MAAM,0BAA0B,CAAA;AACpD,OAAO,KAAK,iBAAiB,MAAM,mCAAmC,CAAA;AACtE,OAAO,KAAK,YAAY,MAAM,8BAA8B,CAAA;AAE5D,OAAO,EAAE,sBAAsB,EAAE,MAAM,UAAU,CAAA;AAEjD,MAAM,WAAW,WAAW;IAC3B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,CAAA;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAC/B,QAAQ,CAAC,EAAE,sBAAsB,CAAA;CACjC;AAED,MAAM,WAAW,QAAQ;IACxB,KAAK,CAAC,EAAE,GAAG,CAAA;IACX,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,QAAQ,CAAC,EAAE,GAAG,CAAA;IACd,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CAClB;AAED,MAAM,MAAM,aAAa,GACtB,CACD,aAAa,CAAC,OAAO,GAAG,QAAQ,CAAC,OAAO,GAAG,iBAAiB,CAAC,OAAO,GAAG,YAAY,CAAC,OAAO,GAAG,gBAAgB,GAC5G;IACD,OAAO,EAAE,MAAM,GAAG;QACjB,GAAG,EAAE,MAAM,CAAA;QACX,OAAO,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAChC,CAAA;CACD,CACD,GACC;IACD,IAAI,CAAC,EAAE,MAAM,CAAA;CACb,CAAA;AAGF,MAAM,WAAW,MAAM;IACtB,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC,CAAA;CAC7C;AAED,qBAAa,UAAW,YAAW,MAAM;IAC5B,OAAO,CAAC,QAAQ,CAAC,IAAI;IAAsB,OAAO,CAAC,QAAQ,CAAC,SAAS;gBAApD,IAAI,EAAE,MAAM,GAAG,SAAS,EAAmB,SAAS,EAAE,WAAW;IAEjF,IAAI,CAAC,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,OAAO,EAAE,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAQtF;AAED,qBAAa,aAAc,YAAW,MAAM;IAG1C,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,GAAG;IACpB,OAAO,CAAC,QAAQ,CAAC,OAAO;gBAFP,IAAI,EAAE,MAAM,GAAG,SAAS,EACxB,GAAG,EAAE,MAAM,EACX,OAAO,GAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAM;IAIzC,IAAI,CAAC,OAAO,EAAE,WAAW,GAAG,OAAO,CAAC,QAAQ,CAAC;CAgB1D;AAGD,eAAO,MAAM,YAAY,YAAa,aAAa,KAAG,MAQrD,CAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@contember/engine-tenant-api",
-  "version": "2.0.0-rc.2",
+  "version": "2.1.0-alpha.1",
   "license": "Apache-2.0",
   "main": "./dist/production/index.js",
   "typings": "./dist/types/index.d.ts",
@@ -26,16 +26,16 @@
     "generate": "gql-gen --config graphql.codegen.yml"
   },
   "dependencies": {
-    "@contember/authorization": "2.0.0-rc.2",
-    "@contember/config-loader": "2.0.0-rc.2",
-    "@contember/database": "2.0.0-rc.2",
-    "@contember/database-migrations": "2.0.0-rc.2",
-    "@contember/dic": "2.0.0-rc.2",
-    "@contember/graphql-utils": "2.0.0-rc.2",
-    "@contember/logger": "2.0.0-rc.2",
-    "@contember/schema": "2.0.0-rc.2",
-    "@contember/schema-utils": "2.0.0-rc.2",
-    "@contember/typesafe": "2.0.0-rc.2",
+    "@contember/authorization": "2.1.0-alpha.1",
+    "@contember/config-loader": "2.1.0-alpha.1",
+    "@contember/database": "2.1.0-alpha.1",
+    "@contember/database-migrations": "2.1.0-alpha.1",
+    "@contember/dic": "2.1.0-alpha.1",
+    "@contember/graphql-utils": "2.1.0-alpha.1",
+    "@contember/logger": "2.1.0-alpha.1",
+    "@contember/schema": "2.1.0-alpha.1",
+    "@contember/schema-utils": "2.1.0-alpha.1",
+    "@contember/typesafe": "2.1.0-alpha.1",
     "@graphql-tools/utils": "^10.5.5",
     "graphql-tag": "^2.12.6",
     "jose": "^5.8.0",
@@ -45,7 +45,7 @@
     "otpauth": "^9.3.4"
   },
   "devDependencies": {
-    "@contember/database-tester": "2.0.0-rc.2",
+    "@contember/database-tester": "2.1.0-alpha.1",
     "@graphql-tools/schema": "^10.0.7",
     "@types/mustache": "^4.2.5",
     "@types/node": "^20.16.11",

package/src/model/mailing/UserMailer.ts

@@ -7,6 +7,7 @@ import { MailTemplateData, MailTemplateIdentifier, MailType } from './type'
 import { MailTemplateQuery } from '../queries'
 import Layout from './templates/Layout.mustache'
 import { DatabaseContext } from '../utils'
+import { Acl } from '@contember/schema'
 
 export class UserMailer {
 	constructor(
@@ -16,28 +17,30 @@ export class UserMailer {
 
 	async sendNewUserInvitedMail(
 		dbContext: DatabaseContext,
-		mailArguments: { email: string; password: string | null; token: string | null; project: string; projectSlug: string },
+		mailArguments: { email: string; password: string | null; token: string | null; project: string; projectSlug: string; memberships: readonly Acl.Membership[]},
 		customMailOptions: { projectId: string; variant: string },
 	): Promise<void> {
-		const template = (await this.getCustomTemplate(dbContext, { type: MailType.newUserInvited, ...customMailOptions })) || {
+		const templateId = { type: MailType.newUserInvited, ...customMailOptions }
+		const template = (await this.getCustomTemplate(dbContext, templateId)) || {
 			subject: 'You have been invited to {{project}}',
 			content: NewUserInvited,
 			replyTo: null,
 		}
-		await this.sendTemplate(template, mailArguments)
+		await this.sendMail(templateId, template, mailArguments)
 	}
 
 	async sendExistingUserInvitedEmail(
 		dbContext: DatabaseContext,
-		mailArguments: { email: string; project: string; projectSlug: string },
+		mailArguments: { email: string; project: string; projectSlug: string; memberships: readonly Acl.Membership[] },
 		customMailOptions: { projectId: string; variant: string },
 	): Promise<void> {
-		const template = (await this.getCustomTemplate(dbContext, { type: MailType.existingUserInvited, ...customMailOptions })) || {
+		const templateId = { type: MailType.existingUserInvited, ...customMailOptions }
+		const template = (await this.getCustomTemplate(dbContext, templateId)) || {
 			subject: 'You have been invited to {{project}}',
 			content: ExistingUserInvited,
 			replyTo: null,
 		}
-		await this.sendTemplate(template, mailArguments)
+		await this.sendMail(templateId, template, mailArguments)
 	}
 
 	async sendPasswordResetEmail(
@@ -45,12 +48,13 @@ export class UserMailer {
 		mailArguments: { email: string; token: string; project?: string; projectSlug?: string },
 		customMailOptions: { projectId: string | null; variant: string },
 	): Promise<void> {
-		const template = (await this.getCustomTemplate(dbContext, { type: MailType.passwordReset, ...customMailOptions })) || {
+		const templateId = { type: MailType.passwordReset, ...customMailOptions }
+		const template = (await this.getCustomTemplate(dbContext, templateId)) || {
 			subject: 'Password reset',
 			content: PasswordReset,
 			replyTo: null,
 		}
-		await this.sendTemplate(template, mailArguments)
+		await this.sendMail(templateId, template, mailArguments)
 	}
 
 	async sendPasswordlessEmail(
@@ -58,23 +62,27 @@ export class UserMailer {
 		mailArguments: { email: string; token: string; project?: string; projectSlug?: string; url?: string },
 		customMailOptions: { projectId: string | null; variant: string },
 	): Promise<void> {
-		const template = (await this.getCustomTemplate(dbContext, { type: MailType.passwordlessSignIn, ...customMailOptions })) || {
+		const templateId = { type: MailType.passwordlessSignIn, ...customMailOptions }
+		const template = (await this.getCustomTemplate(dbContext, templateId)) || {
 			subject: 'Sign in here',
 			content: PasswordlessSignIn,
 			replyTo: null,
 		}
-		await this.sendTemplate(template, mailArguments)
+		await this.sendMail(templateId, template, mailArguments)
 	}
 
-	private async sendTemplate(
+	private async sendMail(
+		templateId: MailTemplateIdentifier,
 		template: Pick<MailTemplateData, 'subject' | 'content' | 'replyTo'>,
-		mailArguments: Record<string, any>,
+		variables: Record<string, any>,
 	) {
-		const html = await this.templateRenderer.render(template.content, mailArguments)
+		const html = await this.templateRenderer.render(template.content, variables)
 		await this.mailer.send({
-			to: mailArguments.email,
-			subject: await this.templateRenderer.render(template.subject, mailArguments),
+			to: variables.email,
+			subject: await this.templateRenderer.render(template.subject, variables),
 			html,
+			variables,
+			template: templateId,
 			...(template.replyTo ? {
 				replyTo: template.replyTo,
 			} : {}),

package/src/model/service/InviteManager.ts

@@ -93,11 +93,11 @@ export class InviteManager {
 				if (isNew) {
 					await this.mailer.sendNewUserInvitedMail(
 						trx,
-						{ email, project: project.name, projectSlug: project.slug, password: generatedPassword, token: resetToken },
+						{ email, project: project.name, projectSlug: project.slug, password: generatedPassword, token: resetToken, memberships },
 						customMailOptions,
 					)
 				} else {
-					await this.mailer.sendExistingUserInvitedEmail(trx, { email, project: project.name, projectSlug: project.slug }, customMailOptions)
+					await this.mailer.sendExistingUserInvitedEmail(trx, { email, project: project.name, projectSlug: project.slug, memberships }, customMailOptions)
 				}
 			}
 			return new ResponseOk(new InviteResult(person, isNew))

package/src/utils/Mailer.ts

@@ -1,12 +1,20 @@
 import { createTransport, Transporter, TransportOptions } from 'nodemailer'
-import { Options as MailMessage } from 'nodemailer/lib/mailer'
 import * as SMTPTransport from 'nodemailer/lib/smtp-transport'
 import * as SMTPPool from 'nodemailer/lib/smtp-pool'
 import * as SendmailTransport from 'nodemailer/lib/sendmail-transport'
 import * as SESTransport from 'nodemailer/lib/ses-transport'
 import { logger } from '@contember/logger'
+import { MailTemplateIdentifier } from '../model'
 
-export { type MailMessage }
+export interface MailMessage {
+	to: string
+	subject: string
+	html: string
+	from?: string
+	replyTo?: string
+	variables?: Record<string, any>
+	template?: MailTemplateIdentifier
+}
 
 export interface SentInfo {
 	error?: any
@@ -17,11 +25,20 @@ export interface SentInfo {
 	pending?: string[]
 }
 
-export type MailerOptions = Partial<
-	(SMTPTransport.Options | SMTPPool.Options | SendmailTransport.Options | SESTransport.Options | TransportOptions) & {
+export type MailerOptions =
+	& (
+		SMTPTransport.Options | SMTPPool.Options | SendmailTransport.Options | SESTransport.Options | TransportOptions
+		| {
+			webhook: string | {
+				url: string
+				headers?: Record<string, string>
+			}
+		}
+	)
+	& {
 		from?: string
 	}
->
+
 
 export interface Mailer {
 	send(message: MailMessage): Promise<SentInfo>
@@ -30,7 +47,7 @@ export interface Mailer {
 export class NodeMailer implements Mailer {
 	constructor(private readonly from: string | undefined, private readonly transport: Transporter) {}
 
-	public async send(message: MailMessage): Promise<SentInfo> {
+	public async send({ variables, template, ...message }: MailMessage): Promise<SentInfo> {
 		try {
 			return await this.transport.sendMail({ ...message, from: message.from || this.from })
 		} catch (e) {
@@ -40,7 +57,40 @@ export class NodeMailer implements Mailer {
 	}
 }
 
+export class WebhookMailer implements Mailer {
+
+	constructor(
+		private readonly from: string | undefined,
+		private readonly url: string,
+		private readonly headers: Record<string, string> = {},
+	) {
+	}
+
+	public async send(message: MailMessage): Promise<SentInfo> {
+		const response = await fetch(this.url, {
+			method: 'POST',
+			body: JSON.stringify({ ...message, from: message.from || this.from }),
+			headers: {
+				...this.headers,
+				'Content-Type': 'application/json',
+			},
+		})
+		if (!response.ok) {
+			logger.error('Mail sending failed', { mail: message, response })
+			return { error: response.statusText }
+		}
+		await response.text()
+		return {}
+	}
+}
+
+
 export const createMailer = (options: MailerOptions): Mailer => {
 	const { from, ...transportOptions } = options
+	if ('webhook' in transportOptions) {
+		const config = typeof transportOptions.webhook === 'string' ? { url: transportOptions.webhook } : transportOptions.webhook
+		return new WebhookMailer(from, config.url, config.headers)
+	}
+
 	return new NodeMailer(from, createTransport(transportOptions as any))
 }