B2B-88: add starter kit structure and elements

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"]
+}