@ryusenkei/mail 0.1.0 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
 # @ryusenkei/mail
 
-The port for sending email: the `Mailer` interface, its error codes, an in-memory implementation, and a contract test. No runtime dependencies besides `@ryusenkei/core`. Implementations for a provider live in the `adapter-*` packages.
+The shared shape of an email (`Mail`, `MailAddress`), the `Mailer` interface, and the checks every sender runs before sending. Senders for a provider live elsewhere (for example, `cloudflareMailer` in `@ryusenkei/adapter-cloudflare`); `@ryusenkei/form` uses the interface for its mail destination.
 
 ## Install
 
@@ -10,26 +10,26 @@ pnpm add @ryusenkei/mail
 
 ## Interface
 
-`send({ from, to, replyTo?, subject, text, html? })` returns the provider message ID.
+```ts
+type Mail = { from: MailAddress; to: MailAddress[]; replyTo?: MailAddress; subject: string; text: string; html?: string };
+interface Mailer { send(mail: Mail): Promise<Result<{ id: string | undefined }, 'invalid_input' | 'rejected'>> }
+```
 
-- Business failures come back as `Result` with these codes: `invalid_input` (malformed address, or a line break in a header field, which blocks header injection), `rejected`
-- Infrastructure failures are thrown as `TransientError` (may succeed on retry) or `ConfigError` (a missing setting), from `@ryusenkei/core`
+- `invalid_input`: a malformed address, no recipient, or a line break in a header field (blocks header injection).
+- `rejected`: the provider would not deliver it (a suppressed recipient, a delivery failure).
+- Infrastructure failures are thrown as `TransientError` or `ConfigError` from `@ryusenkei/core`.
 
-`validateMail(mail)` is the shared input check. Every implementation runs it before sending.
+## Checks
 
-```ts
-const sent = await services.mailer.send({ from, to: [owner], subject, text });
-if (!sent.ok) log('warn', 'mail_rejected', { error: sent.error });
-```
+- `validateMail(mail)` is what every sender runs before sending. It rejects:
+  - CR, LF, NUL, U+0085, U+2028, and U+2029 in the subject or a display name
+  - addresses that fail `isEmailAddress`
+  - an empty `to`
+- `isEmailAddress(value)` is deliberately loose (not full RFC 5322). It rejects whitespace and `< > ( ) " , ; :`. `@ryusenkei/form` uses the same check, so an address that passes the form is never rejected at send time.
 
 ## Testing
 
-| Entry | Contents |
-| --- | --- |
-| `@ryusenkei/mail/testing` | `memoryMailer()`: keeps sent mail in `outbox`. For tests and local development; keep it out of production code |
-| `@ryusenkei/mail/contract` | `mailerContract(name, make, mail)`: the behavior every implementation must have, as Vitest tests. Run it against each adapter |
-
-The contract imports `vitest`, so it is a separate entry from the in-memory implementation, which local development can use without Vitest.
+`memoryMailer()` from `@ryusenkei/mail/testing` validates, then keeps sent mail in `outbox`.
 
 ## License
 

package/dist/index.d.ts

@@ -22,5 +22,7 @@ export interface Mailer {
         id: string | undefined;
     }, MailError>>;
 }
+/** メールアドレスとして送れる形か（フォームの検査もこれを使い、送信の時に弾かれないようにする） */
+export declare const isEmailAddress: (value: string) => boolean;
 /** 送信の前の入力の検査（実装は送る前にこれを通す） */
 export declare function validateMail(mail: Mail): Result<void, 'invalid_input'>;

package/dist/index.js

@@ -1,13 +1,16 @@
 import { err, ok } from '@ryusenkei/core';
 // `RFC 5322` の厳密な検査ではなく、明らかな誤りと改行・空白の混入だけを弾く
 const EMAIL = /^[^\s@<>()",;:]+@[^\s@<>()",;:]+\.[^\s@<>()",;:]+$/;
-const HEADER_BREAK = /[\r\n\u0000]/;
+// `U+0085`・`U+2028`・`U+2029` も、改行として扱うメールの処理系がある
+const HEADER_BREAK = new RegExp(`[\\r\\n\\u0000${String.fromCharCode(0x85, 0x2028, 0x2029)}]`);
+/** メールアドレスとして送れる形か（フォームの検査もこれを使い、送信の時に弾かれないようにする） */
+export const isEmailAddress = (value) => EMAIL.test(value);
 /** 送信の前の入力の検査（実装は送る前にこれを通す） */
 export function validateMail(mail) {
     const addresses = [mail.from, ...mail.to, ...(mail.replyTo ? [mail.replyTo] : [])];
     if (!mail.to.length)
         return err('invalid_input');
-    if (addresses.some((a) => !EMAIL.test(a.email) || (a.name !== undefined && HEADER_BREAK.test(a.name))))
+    if (addresses.some((a) => !isEmailAddress(a.email) || (a.name !== undefined && HEADER_BREAK.test(a.name))))
         return err('invalid_input');
     if (HEADER_BREAK.test(mail.subject))
         return err('invalid_input');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ryusenkei/mail",
-  "version": "0.1.0",
-  "description": "メール送信の差し込み口（型、エラーコード、入力の検査、メモリの実装、契約テスト）",
+  "version": "0.2.1",
+  "description": "メール送信の型と、宛先・ヘッダーの検査（メモリの実装付き）",
   "license": "MIT",
   "author": "RYUSENKEI",
   "repository": {
@@ -21,28 +21,17 @@
     "./testing": {
       "types": "./dist/testing.d.ts",
       "default": "./dist/testing.js"
-    },
-    "./contract": {
-      "types": "./dist/contract.d.ts",
-      "default": "./dist/contract.js"
     }
   },
   "files": [
     "dist"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "dependencies": {
-    "@ryusenkei/core": "^0.1.0"
-  },
-  "peerDependencies": {
-    "vitest": ">=3"
-  },
-  "peerDependenciesMeta": {
-    "vitest": {
-      "optional": true
-    }
+    "@ryusenkei/core": "^0.2.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3"

package/dist/contract.d.ts

@@ -1,6 +0,0 @@
-import type { Mail, Mailer } from './index.ts';
-/**
- * 実装が守る契約の試験（Vitest）
- * @param mail 実装が送れる正しいメール（送信元は実装で使える値）
- */
-export declare function mailerContract(name: string, make: () => Mailer, mail: Mail): void;

package/dist/contract.js

@@ -1,22 +0,0 @@
-import { describe, expect, it } from 'vitest';
-/**
- * 実装が守る契約の試験（Vitest）
- * @param mail 実装が送れる正しいメール（送信元は実装で使える値）
- */
-export function mailerContract(name, make, mail) {
-    describe(`${name}: Mailer の契約`, () => {
-        it('正しいメールを送る', async () => {
-            expect((await make().send(mail)).ok).toBe(true);
-        });
-        it('ヘッダーに改行を含むメールは送らずに invalid_input', async () => {
-            const mailer = make();
-            expect(await mailer.send({ ...mail, subject: 'a\r\nBcc: x@example.com' })).toEqual({ ok: false, error: 'invalid_input' });
-            expect(await mailer.send({ ...mail, to: [{ email: 'x@example.com', name: 'a\nb' }] })).toEqual({ ok: false, error: 'invalid_input' });
-        });
-        it('宛先の形式の誤り・宛先なしは invalid_input', async () => {
-            const mailer = make();
-            expect(await mailer.send({ ...mail, to: [{ email: 'not-an-address' }] })).toEqual({ ok: false, error: 'invalid_input' });
-            expect(await mailer.send({ ...mail, to: [] })).toEqual({ ok: false, error: 'invalid_input' });
-        });
-    });
-}