B2B-88: add starter kit structure and elements

packages/mailers/shared/src/index.ts

@@ -0,0 +1,3 @@
+export * from './schema/mailer.schema';
+export * from './schema/smtp-config.schema';
+export * from './mailer';

packages/mailers/shared/src/mailer.ts

@@ -0,0 +1,7 @@
+import { z } from 'zod';
+
+import { MailerSchema } from './schema/mailer.schema';
+
+export abstract class Mailer<Res = unknown> {
+  abstract sendEmail(data: z.infer<typeof MailerSchema>): Promise<Res>;
+}

packages/mailers/shared/src/schema/mailer.schema.ts

@@ -0,0 +1,20 @@
+import { z } from 'zod';
+
+export const MailerSchema = z
+  .object({
+    to: z.string().email(),
+    // this is not necessarily formatted
+    // as an email so we type it loosely
+    from: z.string().min(1),
+    subject: z.string(),
+  })
+  .and(
+    z.union([
+      z.object({
+        text: z.string(),
+      }),
+      z.object({
+        html: z.string(),
+      }),
+    ]),
+  );

packages/mailers/shared/src/schema/smtp-config.schema.ts

@@ -0,0 +1,28 @@
+import 'server-only';
+
+import { z } from 'zod';
+
+export const SmtpConfigSchema = z.object({
+  user: z.string({
+    description:
+      'This is the email account to send emails from. This is specific to the email provider.',
+    required_error: `Please provide the variable EMAIL_USER`,
+  }),
+  pass: z.string({
+    description: 'This is the password for the email account',
+    required_error: `Please provide the variable EMAIL_PASSWORD`,
+  }),
+  host: z.string({
+    description: 'This is the SMTP host for the email provider',
+    required_error: `Please provide the variable EMAIL_HOST`,
+  }),
+  port: z.number({
+    description:
+      'This is the port for the email provider. Normally 587 or 465.',
+    required_error: `Please provide the variable EMAIL_PORT`,
+  }),
+  secure: z.boolean({
+    description: 'This is whether the connection is secure or not',
+    required_error: `Please provide the variable EMAIL_TLS`,
+  }),
+});