@paroicms/send-mail-aws-ses-plugin 0.2.0

package/README.md

@@ -0,0 +1,35 @@
+# @paroicms/send-mail-aws-ses-plugin
+
+AWS SES email sending plugin for ParoiCMS.
+
+This package is part of [ParoiCMS](https://www.npmjs.com/package/@paroicms/server).
+
+## Configuration
+
+Add the following to your site configuration:
+
+```json
+{
+  "plugins": {
+    "@paroicms/send-mail-aws-ses-plugin": {
+      "disabled": false,
+      "from": "noreply@example.com",
+      "awsAccessKeyId": "your-aws-access-key-id",
+      "awsSecretAccessKey": "your-aws-secret-access-key",
+      "awsRegion": "us-east-1"
+    }
+  }
+}
+```
+
+### Configuration Options
+
+- `disabled` (boolean, optional): Whether to disable the plugin. Default: `false`
+- `from` (string, required): The email address to send emails from
+- `awsAccessKeyId` (string, required): AWS access key ID for SES
+- `awsSecretAccessKey` (string, required): AWS secret access key for SES
+- `awsRegion` (string, required): AWS region for SES service
+
+## License
+
+Released under the [MIT license](https://gitlab.com/paroi/opensource/paroicms/-/blob/main/LICENSE.md).

package/backend/dist/index.js

@@ -0,0 +1,24 @@
+import { esmDirName, extractPackageNameAndVersionSync } from "@paroicms/script-lib";
+import { type } from "arktype";
+import { dirname } from "node:path";
+import { sendMailAwsSes } from "./send-mail-aws-ses.js";
+const SendMailAwsSesConfigAT = type({
+    "disabled?": "boolean",
+    from: "string",
+    awsAccessKeyId: "string",
+    awsSecretAccessKey: "string",
+    awsRegion: "string",
+});
+const projectDir = dirname(esmDirName(import.meta.url));
+const packageDir = dirname(projectDir);
+const { version } = extractPackageNameAndVersionSync(packageDir);
+const plugin = {
+    version,
+    siteInit(service) {
+        const config = SendMailAwsSesConfigAT.assert(service.configuration);
+        service.registerHook("sendMail", async ({ service, value }) => {
+            await sendMailAwsSes(service, value, config);
+        });
+    },
+};
+export default plugin;

package/backend/dist/send-mail-aws-ses.js

@@ -0,0 +1,52 @@
+import { SESClient, SendEmailCommand } from "@aws-sdk/client-ses";
+import { escapeHtml, htmlToRawText, } from "@paroicms/public-server-lib";
+export async function sendMailAwsSes(service, { subject, html, replyTo, to }, configuration) {
+    const { logger } = service;
+    const text = htmlToRawText(html);
+    const replyToAddr = replyTo
+        ? `"${escapeHtml(replyTo.name)}" <${escapeHtml(replyTo.email)}>`
+        : undefined;
+    logger.debug(`[sendMailAwsSes] ${JSON.stringify({
+        from: configuration.from,
+        to,
+        replyToAddr,
+        subject,
+        html,
+        text,
+    })}`);
+    if (configuration.disabled) {
+        logger.info("[sendMailAwsSes] Email sending is disabled");
+        return;
+    }
+    const sesClient = new SESClient({
+        region: configuration.awsRegion,
+        credentials: {
+            accessKeyId: configuration.awsAccessKeyId,
+            secretAccessKey: configuration.awsSecretAccessKey,
+        },
+    });
+    const command = new SendEmailCommand({
+        Source: configuration.from,
+        Destination: {
+            ToAddresses: [to],
+        },
+        ReplyToAddresses: replyToAddr ? [replyToAddr] : undefined,
+        Message: {
+            Subject: {
+                Charset: "UTF-8",
+                Data: subject,
+            },
+            Body: {
+                Html: {
+                    Charset: "UTF-8",
+                    Data: html,
+                },
+                Text: {
+                    Charset: "UTF-8",
+                    Data: text,
+                },
+            },
+        },
+    });
+    await sesClient.send(command);
+}

package/package.json

@@ -0,0 +1,49 @@
+{
+  "name": "@paroicms/send-mail-aws-ses-plugin",
+  "version": "0.2.0",
+  "description": "AWS SES email sending plugin for ParoiCMS",
+  "keywords": [
+    "paroicms",
+    "plugin",
+    "email",
+    "aws",
+    "ses"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/paroi/opensource/paroicms.git",
+    "directory": "plugins/send-mail-aws-ses-plugin"
+  },
+  "author": "Paroi Team",
+  "license": "MIT",
+  "type": "module",
+  "main": "backend/dist/index.js",
+  "scripts": {
+    "build": "npm run build:backend",
+    "build:backend": "(cd backend && tsc)",
+    "build:backend:watch": "(cd backend && tsc --watch --preserveWatchOutput)",
+    "clear": "rimraf backend/dist/*",
+    "test": "vitest run",
+    "test:watch": "vitest"
+  },
+  "dependencies": {
+    "@aws-sdk/client-ses": "~3.848.0",
+    "@paroicms/script-lib": "0.2.0",
+    "arktype": "~2.1.20"
+  },
+  "peerDependencies": {
+    "@paroicms/public-anywhere-lib": "0",
+    "@paroicms/public-server-lib": "0"
+  },
+  "devDependencies": {
+    "@paroicms/public-anywhere-lib": "0.34.0",
+    "@paroicms/public-server-lib": "0.43.0",
+    "@types/node": "~24.0.1",
+    "rimraf": "~6.0.1",
+    "typescript": "~5.8.3",
+    "vitest": "~3.2.3"
+  },
+  "files": [
+    "backend/dist"
+  ]
+}