@rivi-software/workers-mail 0.1.0 → 0.1.1

package/README.md

@@ -155,6 +155,10 @@ The package's own tests run in Node with Vitest: SES is answered by a spy on the
 - Attachments are base64 strings: Email Service's local simulator in `wrangler dev` cannot take an `ArrayBuffer`, and SES wants base64.
 - Through the binding, recipients' display names are dropped.
 
+## Development
+
+The tests in `tests/` cover both transports and the fallback between them against a stand-in SES and binding, the addresses and headers each transport takes, the telemetry opt-out (`mail.test.ts`) and the address parser (`address.test.ts`). None of them sends mail. In this directory, run `pnpm run test`, `pnpm run check` and `pnpm run build`.
+
 ## License
 
 [MIT](LICENSE)

package/dist/index.d.ts

@@ -3,6 +3,7 @@ export type MailAddress = string | {
     email: string;
     name?: string | null;
 };
+/** A file sent with the message: an attachment, or an inline image the HTML names as `cid:<contentId>`. */
 export type MailAttachment = {
     filename: string;
     /** The MIME type. */
@@ -16,6 +17,7 @@ export type MailAttachment = {
     disposition: "inline";
     contentId: string;
 });
+/** A message for `sendMail`, `sendWithSes` or `sendWithBinding`; `text`, `html` or both. */
 export type Mail = {
     from: MailAddress;
     to: MailAddress | readonly MailAddress[];
@@ -31,7 +33,9 @@ export type Mail = {
     /** SES message tags, handed back on every event about the message; the binding has none and drops them. */
     tags?: Record<string, string>;
 };
+/** Which transport sent a message: Amazon SES, or Cloudflare Email Service's binding. */
 export type MailTransport = "ses" | "email-service";
+/** What `sendMail` answers once a message went out. */
 export type SentMail = {
     transport: MailTransport;
     /** The provider's id for the message: SES's `MessageId`, or the binding's `messageId`. */
@@ -50,6 +54,7 @@ export type MailEnv = {
     SES_ACCESS_KEY_ID?: string;
     SES_SECRET_ACCESS_KEY?: string;
 };
+/** SES's region and an IAM user's access key, as `sesConfig` reads them from the Worker's env. */
 export type SesConfig = {
     region: string;
     accessKeyId: string;

package/package.json

@@ -1,7 +1,17 @@
 {
   "name": "@rivi-software/workers-mail",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Mail from Cloudflare Workers: Amazon SES once the Worker holds its key, Cloudflare Email Service's send_email binding until then and whenever SES refuses a message",
+  "keywords": [
+    "cloudflare",
+    "cloudflare-workers",
+    "email",
+    "transactional-email",
+    "amazon-ses",
+    "ses",
+    "cloudflare-email-service",
+    "send-email"
+  ],
   "license": "MIT",
   "type": "module",
   "exports": {