B2B-88: add starter kit structure and elements

packages/mailers/core/README.md

@@ -0,0 +1,3 @@
+# Mailers - @kit/mailers
+
+This package provides a proxy to use the registered mailer in the application.

packages/mailers/core/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintConfigBase from '@kit/eslint-config/base.js';
+
+export default eslintConfigBase;

packages/mailers/core/node_modules/@kit/eslint-config

@@ -0,0 +1 @@
+../../../../../tooling/eslint

packages/mailers/core/node_modules/@kit/mailers-shared

@@ -0,0 +1 @@
+../../../shared

packages/mailers/core/node_modules/@kit/nodemailer

@@ -0,0 +1 @@
+../../../nodemailer

packages/mailers/core/node_modules/@kit/prettier-config

@@ -0,0 +1 @@
+../../../../../tooling/prettier

packages/mailers/core/node_modules/@kit/resend

@@ -0,0 +1 @@
+../../../resend

packages/mailers/core/node_modules/@kit/shared

@@ -0,0 +1 @@
+../../../../shared

packages/mailers/core/node_modules/@kit/tsconfig

@@ -0,0 +1 @@
+../../../../../tooling/typescript

packages/mailers/core/node_modules/@types/node

@@ -0,0 +1 @@
+../../../../../node_modules/.pnpm/@types+node@22.15.30/node_modules/@types/node

packages/mailers/core/node_modules/zod

@@ -0,0 +1 @@
+../../../../node_modules/.pnpm/zod@3.25.56/node_modules/zod

packages/mailers/core/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@kit/mailers",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "clean": "git clean -xdf .turbo node_modules",
+    "format": "prettier --check \"**/*.{ts,tsx}\"",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  },
+  "prettier": "@kit/prettier-config",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "devDependencies": {
+    "@kit/eslint-config": "workspace:*",
+    "@kit/mailers-shared": "workspace:*",
+    "@kit/nodemailer": "workspace:*",
+    "@kit/prettier-config": "workspace:*",
+    "@kit/resend": "workspace:*",
+    "@kit/shared": "workspace:*",
+    "@kit/tsconfig": "workspace:*",
+    "@types/node": "^22.15.18",
+    "zod": "^3.24.4"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "src/*"
+      ]
+    }
+  }
+}

packages/mailers/core/src/index.ts

@@ -0,0 +1,12 @@
+import { MAILER_PROVIDER } from './provider-enum';
+import { mailerRegistry } from './registry';
+
+/**
+ * @name getMailer
+ * @description Get the mailer based on the environment variable using the registry internally.
+ */
+export function getMailer() {
+  return mailerRegistry.get(MAILER_PROVIDER);
+}
+
+export { MAILER_PROVIDER };

packages/mailers/core/src/provider-enum.ts

@@ -0,0 +1,16 @@
+import { z } from 'zod';
+
+const MAILER_PROVIDERS = [
+  'nodemailer',
+  'resend',
+  // add more providers here
+] as const;
+
+const MAILER_PROVIDER = z
+  .enum(MAILER_PROVIDERS)
+  .default('nodemailer')
+  .parse(process.env.MAILER_PROVIDER);
+
+export { MAILER_PROVIDER };
+
+export type MailerProvider = (typeof MAILER_PROVIDERS)[number];

packages/mailers/core/src/registry.ts

@@ -0,0 +1,26 @@
+import { Mailer } from '@kit/mailers-shared';
+import { createRegistry } from '@kit/shared/registry';
+
+import { MailerProvider } from './provider-enum';
+
+const mailerRegistry = createRegistry<Mailer, MailerProvider>();
+
+mailerRegistry.register('nodemailer', async () => {
+  if (process.env.NEXT_RUNTIME === 'nodejs') {
+    const { createNodemailerService } = await import('@kit/nodemailer');
+
+    return createNodemailerService();
+  } else {
+    throw new Error(
+      'Nodemailer is not available on the edge runtime. Please use another mailer.',
+    );
+  }
+});
+
+mailerRegistry.register('resend', async () => {
+  const { createResendMailer } = await import('@kit/resend');
+
+  return createResendMailer();
+});
+
+export { mailerRegistry };

packages/mailers/core/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@kit/tsconfig/base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["*.ts", "src"],
+  "exclude": ["node_modules"]
+}

packages/mailers/nodemailer/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintConfigBase from '@kit/eslint-config/base.js';
+
+export default eslintConfigBase;

packages/mailers/nodemailer/node_modules/@kit/eslint-config

@@ -0,0 +1 @@
+../../../../../tooling/eslint

packages/mailers/nodemailer/node_modules/@kit/mailers-shared

@@ -0,0 +1 @@
+../../../shared

packages/mailers/nodemailer/node_modules/@kit/prettier-config

@@ -0,0 +1 @@
+../../../../../tooling/prettier

packages/mailers/nodemailer/node_modules/@kit/tsconfig

@@ -0,0 +1 @@
+../../../../../tooling/typescript

packages/mailers/nodemailer/node_modules/@types/nodemailer

@@ -0,0 +1 @@
+../../../../../node_modules/.pnpm/@types+nodemailer@6.4.17/node_modules/@types/nodemailer

packages/mailers/nodemailer/node_modules/nodemailer

@@ -0,0 +1 @@
+../../../../node_modules/.pnpm/nodemailer@7.0.3/node_modules/nodemailer

packages/mailers/nodemailer/node_modules/zod

@@ -0,0 +1 @@
+../../../../node_modules/.pnpm/zod@3.25.56/node_modules/zod

packages/mailers/nodemailer/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@kit/nodemailer",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "clean": "git clean -xdf .turbo node_modules",
+    "format": "prettier --check \"**/*.{ts,tsx}\"",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  },
+  "prettier": "@kit/prettier-config",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "dependencies": {
+    "nodemailer": "^7.0.3"
+  },
+  "devDependencies": {
+    "@kit/eslint-config": "workspace:*",
+    "@kit/mailers-shared": "workspace:*",
+    "@kit/prettier-config": "workspace:*",
+    "@kit/tsconfig": "workspace:*",
+    "@types/nodemailer": "6.4.17",
+    "zod": "^3.24.4"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "src/*"
+      ]
+    }
+  }
+}

packages/mailers/nodemailer/src/index.ts

@@ -0,0 +1,26 @@
+import 'server-only';
+
+import { z } from 'zod';
+
+import { Mailer, MailerSchema } from '@kit/mailers-shared';
+
+import { getSMTPConfiguration } from './smtp-configuration';
+
+type Config = z.infer<typeof MailerSchema>;
+
+export function createNodemailerService() {
+  return new Nodemailer();
+}
+
+/**
+ * A class representing a mailer using Nodemailer library.
+ * @implements {Mailer}
+ */
+class Nodemailer implements Mailer {
+  async sendEmail(config: Config) {
+    const { createTransport } = await import('nodemailer');
+    const transporter = createTransport(getSMTPConfiguration());
+
+    return transporter.sendMail(config);
+  }
+}

packages/mailers/nodemailer/src/smtp-configuration.ts

@@ -0,0 +1,21 @@
+import { SmtpConfigSchema } from '@kit/mailers-shared';
+
+export function getSMTPConfiguration() {
+  const data = SmtpConfigSchema.parse({
+    user: process.env.EMAIL_USER,
+    pass: process.env.EMAIL_PASSWORD,
+    host: process.env.EMAIL_HOST,
+    port: Number(process.env.EMAIL_PORT),
+    secure: process.env.EMAIL_TLS !== 'false',
+  });
+
+  return {
+    host: data.host,
+    port: data.port,
+    secure: data.secure,
+    auth: {
+      user: data.user,
+      pass: data.pass,
+    },
+  };
+}

packages/mailers/nodemailer/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@kit/tsconfig/base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["*.ts", "src"],
+  "exclude": ["node_modules"]
+}

packages/mailers/resend/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintConfigBase from '@kit/eslint-config/base.js';
+
+export default eslintConfigBase;

packages/mailers/resend/node_modules/@kit/eslint-config

@@ -0,0 +1 @@
+../../../../../tooling/eslint

packages/mailers/resend/node_modules/@kit/mailers-shared

@@ -0,0 +1 @@
+../../../shared

packages/mailers/resend/node_modules/@kit/prettier-config

@@ -0,0 +1 @@
+../../../../../tooling/prettier

packages/mailers/resend/node_modules/@kit/tsconfig

@@ -0,0 +1 @@
+../../../../../tooling/typescript

packages/mailers/resend/node_modules/@types/node

@@ -0,0 +1 @@
+../../../../../node_modules/.pnpm/@types+node@22.15.30/node_modules/@types/node

packages/mailers/resend/node_modules/zod

@@ -0,0 +1 @@
+../../../../node_modules/.pnpm/zod@3.25.56/node_modules/zod

packages/mailers/resend/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@kit/resend",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "clean": "git clean -xdf .turbo node_modules",
+    "format": "prettier --check \"**/*.{ts,tsx}\"",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  },
+  "prettier": "@kit/prettier-config",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "devDependencies": {
+    "@kit/eslint-config": "workspace:*",
+    "@kit/mailers-shared": "workspace:*",
+    "@kit/prettier-config": "workspace:*",
+    "@kit/tsconfig": "workspace:*",
+    "@types/node": "^22.15.18",
+    "zod": "^3.24.4"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "src/*"
+      ]
+    }
+  }
+}

packages/mailers/resend/src/index.ts

@@ -0,0 +1,53 @@
+import 'server-only';
+
+import { z } from 'zod';
+
+import { Mailer, MailerSchema } from '@kit/mailers-shared';
+
+type Config = z.infer<typeof MailerSchema>;
+
+const RESEND_API_KEY = z
+  .string({
+    description: 'The API key for the Resend API',
+    required_error: 'Please provide the API key for the Resend API',
+  })
+  .parse(process.env.RESEND_API_KEY);
+
+export function createResendMailer() {
+  return new ResendMailer();
+}
+
+/**
+ * A class representing a mailer using the Resend HTTP API.
+ * @implements {Mailer}
+ */
+class ResendMailer implements Mailer {
+  async sendEmail(config: Config) {
+    const contentObject =
+      'text' in config
+        ? {
+            text: config.text,
+          }
+        : {
+            html: config.html,
+          };
+
+    const res = await fetch('https://api.resend.com/emails', {
+      method: 'POST',
+      headers: {
+        'Content-Type': 'application/json',
+        Authorization: `Bearer ${RESEND_API_KEY}`,
+      },
+      body: JSON.stringify({
+        from: config.from,
+        to: [config.to],
+        subject: config.subject,
+        ...contentObject,
+      }),
+    });
+
+    if (!res.ok) {
+      throw new Error(`Failed to send email: ${res.statusText}`);
+    }
+  }
+}

packages/mailers/resend/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@kit/tsconfig/base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["*.ts", "src"],
+  "exclude": ["node_modules"]
+}

packages/mailers/shared/README.md

@@ -0,0 +1,3 @@
+# Mailers Shared - @kit/mailers-shared
+
+This package provides shared utilities for mailers.

packages/mailers/shared/eslint.config.mjs

@@ -0,0 +1,3 @@
+import eslintConfigBase from '@kit/eslint-config/base.js';
+
+export default eslintConfigBase;

packages/mailers/shared/node_modules/@kit/eslint-config

@@ -0,0 +1 @@
+../../../../../tooling/eslint

packages/mailers/shared/node_modules/@kit/prettier-config

@@ -0,0 +1 @@
+../../../../../tooling/prettier

packages/mailers/shared/node_modules/@kit/tsconfig

@@ -0,0 +1 @@
+../../../../../tooling/typescript

packages/mailers/shared/node_modules/zod

@@ -0,0 +1 @@
+../../../../node_modules/.pnpm/zod@3.25.56/node_modules/zod

packages/mailers/shared/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@kit/mailers-shared",
+  "private": true,
+  "version": "0.1.0",
+  "scripts": {
+    "clean": "git clean -xdf .turbo node_modules",
+    "format": "prettier --check \"**/*.{ts,tsx}\"",
+    "lint": "eslint .",
+    "typecheck": "tsc --noEmit"
+  },
+  "prettier": "@kit/prettier-config",
+  "exports": {
+    ".": "./src/index.ts"
+  },
+  "devDependencies": {
+    "@kit/eslint-config": "workspace:*",
+    "@kit/prettier-config": "workspace:*",
+    "@kit/tsconfig": "workspace:*",
+    "zod": "^3.24.4"
+  },
+  "typesVersions": {
+    "*": {
+      "*": [
+        "src/*"
+      ]
+    }
+  }
+}

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`,
+  }),
+});

packages/mailers/shared/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "extends": "@kit/tsconfig/base.json",
+  "compilerOptions": {
+    "tsBuildInfoFile": "node_modules/.cache/tsbuildinfo.json"
+  },
+  "include": ["*.ts", "src"],
+  "exclude": ["node_modules"]
+}