@ryusenkei/adapter-cloudflare 0.1.0 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
 # @ryusenkei/adapter-cloudflare
 
-Implementations of the runtime ports with Cloudflare Workers bindings. The binding types are structural, so this package does not depend on `@cloudflare/workers-types`. Pass the bindings from `env` in your `services.ts`.
+Cloudflare Workers bindings as the rate limiter and mail sender that `@ryusenkei/form` uses. The binding types are structural, so this package does not depend on `@cloudflare/workers-types`.
 
 ## Install
 
@@ -11,33 +11,30 @@ pnpm add @ryusenkei/adapter-cloudflare
 ## Usage
 
 ```ts
-import { cloudflareMailer, cloudflareRateLimiter, r2BlobStore } from '@ryusenkei/adapter-cloudflare';
+import { cloudflareMailer, cloudflareRateLimiter } from '@ryusenkei/adapter-cloudflare';
 
-export const servicesFromEnv = (env: Env) => ({
-  rateLimiter: cloudflareRateLimiter(env.INQUIRY_RATE_LIMITER),
-  mailer: cloudflareMailer(env.EMAIL),
-  blob: r2BlobStore(env.UPLOADS),
-});
+const rateLimiter = cloudflareRateLimiter(env.FORM_LIMITER);
+const mailer = cloudflareMailer(env.EMAIL);
 ```
 
-| Function | Port | Binding |
+| Function | Returns | Binding |
 | --- | --- | --- |
-| `cloudflareRateLimiter` | [`RateLimiter`](../rate-limit) | Rate Limiting (`ratelimits` in wrangler config; limit and period are set there). Counts are per Cloudflare location, not a strict global limit |
-| `cloudflareMailer` | [`Mailer`](../mail) | Email Service (`send_email`). The sender domain must be onboarded to Email Sending |
-| `r2BlobStore` | [`BlobStore`](../blob) | R2 bucket. `list` follows the cursor past 1,000 keys |
-
-Error handling:
-
-- A missing binding throws `ConfigError`, so a misconfigured deploy returns 503 `not_configured` through `failureResponse`
-- Rate Limiting and R2 failures throw `TransientError`
-- Email Service error codes:
-  - `E_RATE_LIMIT_EXCEEDED`, `E_DAILY_LIMIT_EXCEEDED`, and `E_INTERNAL_SERVER_ERROR` throw `TransientError`
-  - Unverified or unavailable sender domains, a suspended account, and recipients not allowed by the binding throw `ConfigError`
-  - Suppressed recipients and delivery failures return `rejected`
-  - Validation and header errors return `invalid_input`
-  - Unknown codes are rethrown as is
-
-D1 (`db`) is not here yet.
+| `cloudflareRateLimiter` | `limit(key)` → `rate_limited` over the limit | Rate Limiting (`ratelimits` in wrangler config; limit and period are set there). Counts are per Cloudflare location, not a strict global limit |
+| `cloudflareMailer` | a `Mailer` from `@ryusenkei/mail` | Email Service (`send_email`). The sender domain must be onboarded to Email Sending |
+
+## Errors
+
+- A missing binding throws `ConfigError`, so a misconfigured deploy answers 503 `not_configured`.
+- A Rate Limiting binding failure throws `TransientError`.
+- The mailer runs `validateMail` first, then maps Email Service error codes:
+
+| Codes | Result |
+| --- | --- |
+| `E_RATE_LIMIT_EXCEEDED`, `E_DAILY_LIMIT_EXCEEDED`, `E_INTERNAL_SERVER_ERROR` | throws `TransientError` |
+| `E_SENDER_NOT_VERIFIED`, `E_SENDER_DOMAIN_NOT_AVAILABLE`, `E_ACCOUNT_SUSPENDED`, `E_RECIPIENT_NOT_ALLOWED` | throws `ConfigError` |
+| `E_RECIPIENT_SUPPRESSED`, `E_DELIVERY_FAILED` | `rejected` |
+| validation and header errors | `invalid_input` |
+| anything else | rethrown as is |
 
 ## License
 

package/dist/index.d.ts

@@ -1,3 +1,2 @@
 export { cloudflareMailer, type SendEmailBinding } from './mail.ts';
-export { r2BlobStore, type R2BucketBinding } from './r2.ts';
-export { cloudflareRateLimiter, type RateLimitBinding } from './rate-limit.ts';
+export { cloudflareRateLimiter, type RateLimitBinding, type RateLimiter } from './rate-limit.ts';

package/dist/index.js

@@ -1,3 +1,2 @@
 export { cloudflareMailer } from "./mail.js";
-export { r2BlobStore } from "./r2.js";
 export { cloudflareRateLimiter } from "./rate-limit.js";

package/dist/rate-limit.d.ts

@@ -1,4 +1,8 @@
-import type { RateLimiter } from '@ryusenkei/rate-limit';
+import { type Result } from '@ryusenkei/core';
+/** キー（IP アドレスなど）ごとの回数の制限（`@ryusenkei/form/server` の `rateLimiter` に渡せる） */
+export type RateLimiter = Readonly<{
+    limit(key: string): Promise<Result<void, 'rate_limited'>>;
+}>;
 /** Workers の Rate Limiting の binding（使う部分だけの型。`@cloudflare/workers-types` に依存しない） */
 export type RateLimitBinding = {
     limit(options: {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ryusenkei/adapter-cloudflare",
-  "version": "0.1.0",
-  "description": "差し込み口の Cloudflare Workers の binding による実装（回数の制限、メール送信、R2）",
+  "version": "0.2.1",
+  "description": "Cloudflare Workers の binding による実装（回数の制限、メール送信）",
   "license": "MIT",
   "author": "RYUSENKEI",
   "repository": {
@@ -23,13 +23,12 @@
     "dist"
   ],
   "publishConfig": {
-    "access": "public"
+    "access": "public",
+    "provenance": true
   },
   "dependencies": {
-    "@ryusenkei/core": "^0.1.0",
-    "@ryusenkei/rate-limit": "^0.1.0",
-    "@ryusenkei/mail": "^0.1.0",
-    "@ryusenkei/blob": "^0.1.0"
+    "@ryusenkei/core": "^0.2.0",
+    "@ryusenkei/mail": "^0.2.0"
   },
   "devDependencies": {
     "typescript": "^5.9.3"

package/dist/r2.d.ts

@@ -1,33 +0,0 @@
-import type { BlobBody, BlobStore } from '@ryusenkei/blob';
-type R2Object = {
-    size: number;
-    httpMetadata?: {
-        contentType?: string;
-    };
-    body: ReadableStream<Uint8Array>;
-    arrayBuffer(): Promise<ArrayBuffer>;
-    text(): Promise<string>;
-};
-/** R2 の bucket の binding（使う部分だけの型） */
-export type R2BucketBinding = {
-    put(key: string, value: BlobBody, options?: {
-        httpMetadata?: {
-            contentType?: string;
-        };
-    }): Promise<unknown>;
-    get(key: string): Promise<R2Object | null>;
-    delete(key: string): Promise<void>;
-    list(options?: {
-        prefix?: string;
-        cursor?: string;
-    }): Promise<{
-        objects: {
-            key: string;
-        }[];
-        truncated: boolean;
-        cursor?: string;
-    }>;
-};
-/** R2 の bucket によるファイルの保存 */
-export declare function r2BlobStore(bucket: R2BucketBinding | undefined): BlobStore;
-export {};

package/dist/r2.js

@@ -1,41 +0,0 @@
-import { ConfigError, err, ok, TransientError } from '@ryusenkei/core';
-/** R2 の bucket によるファイルの保存 */
-export function r2BlobStore(bucket) {
-    // R2 の失敗は再試行で回復しうるものとして扱う（binding の操作の例外は理由を区別できない）
-    const transient = async (op, run) => {
-        if (!bucket)
-            throw new ConfigError('R2 の binding が未設定');
-        try {
-            return await run(bucket);
-        }
-        catch (e) {
-            throw new TransientError(`R2 の ${op} の失敗`, { cause: e });
-        }
-    };
-    return {
-        async put(key, body, options = {}) {
-            await transient('put', (b) => b.put(key, body, options.contentType ? { httpMetadata: { contentType: options.contentType } } : {}));
-        },
-        async get(key) {
-            const object = await transient('get', (b) => b.get(key));
-            if (!object)
-                return err('not_found');
-            const blob = { size: object.size, contentType: object.httpMetadata?.contentType, body: object.body, arrayBuffer: () => object.arrayBuffer(), text: () => object.text() };
-            return ok(blob);
-        },
-        async delete(key) {
-            await transient('delete', (b) => b.delete(key));
-        },
-        // 1回の応答は最大1,000件なので、cursor で続きを取得
-        async list(prefix) {
-            const keys = [];
-            let cursor;
-            do {
-                const page = await transient('list', (b) => b.list({ ...(prefix ? { prefix } : {}), ...(cursor ? { cursor } : {}) }));
-                keys.push(...page.objects.map((o) => o.key));
-                cursor = page.truncated ? page.cursor : undefined;
-            } while (cursor);
-            return keys.sort();
-        },
-    };
-}