shipmail 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 ShipMail
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,223 @@
+# ShipMail TypeScript SDK
+
+Official TypeScript SDK for the [ShipMail](https://shipmail.to) API. Zero runtime dependencies.
+
+## Installation
+
+```bash
+npm install shipmail
+# or
+bun add shipmail
+```
+
+Requires Node.js 18+ (uses native `fetch` and `crypto`).
+
+## Quick Start
+
+```typescript
+import ShipMail from "shipmail";
+
+const client = new ShipMail("sm_live_...");
+
+// Create a domain
+const domain = await client.domains.create({ name: "example.com" });
+
+// Send an email
+const message = await client.messages.send({
+  mailbox_id: "mbx_...",
+  to: [{ address: "user@example.com" }],
+  subject: "Hello",
+  body_text: "Hi there",
+});
+```
+
+## Configuration
+
+```typescript
+import { ShipMailClient } from "shipmail";
+
+const client = new ShipMailClient({
+  apiKey: "sm_live_...",
+  baseUrl: "https://api.shipmail.to/v1", // default
+  maxRetries: 2,                          // default, retries on 5xx and 429
+  timeout: 30_000,                        // default, in milliseconds
+});
+```
+
+## Resources
+
+### Domains
+
+```typescript
+const domain = await client.domains.create({ name: "example.com" });
+const domains = await client.domains.list({ limit: 10 });
+const domain = await client.domains.get("dom_...");
+const updated = await client.domains.update("dom_...", { catch_all_mailbox_id: "mbx_..." });
+await client.domains.delete("dom_...");
+const result = await client.domains.verify("dom_...");
+```
+
+### Mailboxes
+
+```typescript
+const mailbox = await client.mailboxes.create({
+  domain_id: "dom_...",
+  address: "hello",
+  display_name: "Hello",
+});
+const mailboxes = await client.mailboxes.list({ domain_id: "dom_..." });
+const mailbox = await client.mailboxes.get("mbx_...");
+const updated = await client.mailboxes.update("mbx_...", { display_name: "New Name" });
+await client.mailboxes.delete("mbx_...");
+
+// Avatar
+const avatar = await client.mailboxes.uploadAvatar("mbx_...", imageBuffer, "image/png");
+await client.mailboxes.deleteAvatar("mbx_...");
+```
+
+### Messages
+
+```typescript
+const message = await client.messages.send({
+  mailbox_id: "mbx_...",
+  to: [{ address: "user@example.com", name: "User" }],
+  cc: [{ address: "cc@example.com" }],
+  subject: "Hello",
+  body_html: "<p>Hi there</p>",
+  body_text: "Hi there",
+});
+
+const message = await client.messages.get("msg_...");
+```
+
+### Threads
+
+```typescript
+const threads = await client.threads.list({ mailbox_id: "mbx_..." });
+const thread = await client.threads.get("thd_...");
+const reply = await client.threads.reply("thd_...", {
+  body_text: "Thanks for your email",
+  to: [{ address: "user@example.com" }],
+});
+```
+
+### Webhooks
+
+```typescript
+const webhook = await client.webhooks.create({
+  url: "https://example.com/webhook",
+  events: ["message.received", "message.sent"],
+  description: "My webhook",
+});
+// webhook.secret is only available at creation time
+
+const webhooks = await client.webhooks.list();
+const webhook = await client.webhooks.get("whk_...");
+const updated = await client.webhooks.update("whk_...", { active: false });
+await client.webhooks.delete("whk_...");
+
+const rotated = await client.webhooks.rotateSecret("whk_...");
+const test = await client.webhooks.test("whk_...");
+const deliveries = await client.webhooks.listDeliveries("whk_...");
+```
+
+### Status
+
+```typescript
+const status = await client.status.get();
+```
+
+## Pagination
+
+List methods return a paginated response with cursor-based pagination:
+
+```typescript
+const page = await client.domains.list({ limit: 10 });
+console.log(page.data);           // Domain[]
+console.log(page.pagination);     // { next_cursor, has_more }
+
+// Fetch next page
+if (page.pagination.has_more) {
+  const next = await client.domains.list({
+    cursor: page.pagination.next_cursor,
+    limit: 10,
+  });
+}
+```
+
+Auto-pagination iterates through all pages automatically:
+
+```typescript
+for await (const domain of client.domains.listAutoPaginating({ limit: 25 })) {
+  console.log(domain.name);
+}
+```
+
+## Webhook Verification
+
+Verify incoming webhook signatures without instantiating a client:
+
+```typescript
+import { verifyWebhook, WebhookVerificationError } from "shipmail";
+
+try {
+  const event = verifyWebhook(rawBody, request.headers, webhookSecret);
+  console.log(event.event_type); // e.g., "message.received"
+  console.log(event.data);
+} catch (err) {
+  if (err instanceof WebhookVerificationError) {
+    return new Response("Invalid signature", { status: 401 });
+  }
+}
+```
+
+## Error Handling
+
+The SDK throws typed errors that map to API error responses:
+
+```typescript
+import {
+  ShipMailError,
+  AuthenticationError,
+  AuthorizationError,
+  ValidationError,
+  NotFoundError,
+  RateLimitError,
+  ConflictError,
+  InternalServerError,
+  ConnectionError,
+} from "shipmail";
+
+try {
+  await client.domains.create({ name: "" });
+} catch (err) {
+  if (err instanceof ValidationError) {
+    console.log(err.message);  // Error message
+    console.log(err.details);  // Field-level validation errors
+  }
+  if (err instanceof RateLimitError) {
+    console.log(err.retryAfter); // Seconds to wait
+  }
+  if (err instanceof ShipMailError) {
+    console.log(err.status);    // HTTP status code
+    console.log(err.type);      // Error type string
+    console.log(err.requestId); // Request ID for support
+    console.log(err.retryable); // Whether the request can be retried
+  }
+}
+```
+
+## Retries
+
+The SDK automatically retries on 5xx errors and 429 (rate limit) responses with exponential backoff and jitter. Configure with `maxRetries` (default: 2, meaning up to 3 total attempts).
+
+```typescript
+const client = new ShipMailClient({
+  apiKey: "sm_live_...",
+  maxRetries: 0, // Disable retries
+});
+```
+
+## License
+
+MIT