@unsent/sdk 0.25.2

package/.eslintrc.cjs

@@ -0,0 +1,10 @@
+/** @type {import("eslint").Linter.Config} */
+module.exports = {
+   root: true,
+   extends: ["@unsent/eslint-config/library.js"],
+   parser: "@typescript-eslint/parser",
+   parserOptions: {
+      project: "./tsconfig.json",
+      tsconfigRootDir: __dirname,
+   },
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 unsent
+
+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,328 @@
+# @unsent/sdk SDK
+
+## Prerequisites
+
+- [unsent API key](https://app.unsent.dev/dev-settings/api-keys)
+- [Verified domain](https://app.unsent.dev/domains)
+
+## Installation
+
+### NPM
+
+```bash
+npm install @unsent/sdk
+```
+
+### Yarn
+
+```bash
+yarn add @unsent/sdk
+```
+
+### PNPM
+
+```bash
+pnpm add @unsent/sdk
+```
+
+### Bun
+
+```bash
+bun add @unsent/sdk
+```
+
+## Usage
+
+### Basic Setup
+
+```typescript
+import { unsent } from "@unsent/sdk"
+
+const client = new unsent("us_12345")
+```
+
+### Environment Variables
+
+You can also set your API key using environment variables:
+
+```typescript
+// Set UNSENT_API_KEY or UNSENT_API_KEY in your environment
+// Then initialize without passing the key
+const client = new unsent()
+```
+
+### Sending Emails
+
+#### Simple Email
+
+```typescript
+const { data, error } = await client.emails.send({
+   to: "hello@acme.com",
+   from: "hello@company.com",
+   subject: "unsent email",
+   html: "<p>unsent is the best open source product to send emails</p>",
+   text: "unsent is the best open source product to send emails",
+})
+
+if (error) {
+   console.error("Error:", error)
+} else {
+   console.log("Email sent! ID:", data.id)
+}
+```
+
+#### Email with Attachments
+
+```typescript
+const { data, error } = await client.emails.send({
+   to: "hello@acme.com",
+   from: "hello@company.com",
+   subject: "Email with attachment",
+   html: "<p>Please find the attachment below</p>",
+   attachments: [
+      {
+         filename: "document.pdf",
+         content: "base64-encoded-content-here",
+      },
+   ],
+})
+```
+
+#### Email with React Component
+
+```typescript
+import { MyEmailTemplate } from "./templates/MyEmailTemplate"
+
+const { data, error } = await client.emails.send({
+   to: "hello@acme.com",
+   from: "hello@company.com",
+   subject: "Email with React template",
+   react: <MyEmailTemplate name="John" />,
+})
+```
+
+#### Scheduled Email
+
+```typescript
+const scheduledTime = new Date()
+scheduledTime.setHours(scheduledTime.getHours() + 1) // Schedule for 1 hour from now
+
+const { data, error } = await client.emails.send({
+   to: "hello@acme.com",
+   from: "hello@company.com",
+   subject: "Scheduled email",
+   html: "<p>This email was scheduled</p>",
+   scheduledAt: scheduledTime.toISOString(),
+})
+```
+
+#### Batch Emails
+
+```typescript
+const emails = [
+   {
+      to: "user1@example.com",
+      from: "hello@company.com",
+      subject: "Hello User 1",
+      html: "<p>Welcome User 1</p>",
+   },
+   {
+      to: "user2@example.com",
+      from: "hello@company.com",
+      subject: "Hello User 2",
+      html: "<p>Welcome User 2</p>",
+   },
+]
+
+const { data, error } = await client.emails.batch(emails)
+
+if (error) {
+   console.error("Error:", error)
+} else {
+   console.log(`Sent ${data.length} emails`)
+}
+```
+
+### Managing Emails
+
+#### Get Email Details
+
+```typescript
+const { data, error } = await client.emails.get("email_id")
+
+if (error) {
+   console.error("Error:", error)
+} else {
+   console.log("Email status:", data.status)
+}
+```
+
+#### Update Email
+
+```typescript
+const { data, error } = await client.emails.update("email_id", {
+   subject: "Updated subject",
+   html: "<p>Updated content</p>",
+})
+```
+
+#### Cancel Scheduled Email
+
+```typescript
+const { data, error } = await client.emails.cancel("email_id")
+
+if (error) {
+   console.error("Error:", error)
+} else {
+   console.log("Email cancelled successfully")
+}
+```
+
+### Managing Contacts
+
+#### Create Contact
+
+```typescript
+const { data, error } = await client.contacts.create("contact_book_id", {
+   email: "user@example.com",
+   firstName: "John",
+   lastName: "Doe",
+   metadata: {
+      company: "Acme Inc",
+      role: "Developer",
+   },
+})
+```
+
+#### Get Contact
+
+```typescript
+const { data, error } = await client.contacts.get(
+   "contact_book_id",
+   "contact_id"
+)
+```
+
+#### Update Contact
+
+```typescript
+const { data, error } = await client.contacts.update(
+   "contact_book_id",
+   "contact_id",
+   {
+      firstName: "Jane",
+      metadata: {
+         role: "Senior Developer",
+      },
+   }
+)
+```
+
+#### Upsert Contact
+
+```typescript
+// Creates if doesn't exist, updates if exists
+const { data, error } = await client.contacts.upsert(
+   "contact_book_id",
+   "contact_id",
+   {
+      email: "user@example.com",
+      firstName: "John",
+      lastName: "Doe",
+   }
+)
+```
+
+#### Delete Contact
+
+```typescript
+const { data, error } = await client.contacts.delete(
+   "contact_book_id",
+   "contact_id"
+)
+```
+
+### Error Handling
+
+The SDK returns a consistent response structure with `data` and `error`:
+
+```typescript
+const { data, error } = await client.emails.send({
+   to: "invalid-email",
+   from: "hello@company.com",
+   subject: "Test",
+   html: "<p>Test</p>",
+})
+
+if (error) {
+   console.error(`Error ${error.code}: ${error.message}`)
+   return
+}
+
+// Safe to use data here
+console.log("Email sent:", data.id)
+```
+
+### TypeScript Support
+
+The SDK is fully typed with TypeScript:
+
+```typescript
+import { unsent } from "@unsent/sdk"
+
+const client = new unsent("us_12345")
+
+// Full type inference and autocomplete
+const result = await client.emails.send({
+   to: "hello@acme.com",
+   from: "hello@company.com",
+   subject: "Typed email",
+   html: "<p>Fully typed!</p>",
+})
+
+// Type-safe access
+if (result.data) {
+   const emailId: string = result.data.id
+}
+```
+
+## API Reference
+
+### Client Methods
+
+- `new unsent(key?, url?)` - Initialize the client
+
+### Email Methods
+
+- `client.emails.send(payload)` - Send an email (alias for `create`)
+- `client.emails.create(payload)` - Create and send an email
+- `client.emails.batch(emails)` - Send multiple emails in batch (max 100)
+- `client.emails.get(emailId)` - Get email details
+- `client.emails.update(emailId, payload)` - Update a scheduled email
+- `client.emails.cancel(emailId)` - Cancel a scheduled email
+
+### Contact Methods
+
+- `client.contacts.create(bookId, payload)` - Create a contact
+- `client.contacts.get(bookId, contactId)` - Get contact details
+- `client.contacts.update(bookId, contactId, payload)` - Update a contact
+- `client.contacts.upsert(bookId, contactId, payload)` - Upsert a contact
+- `client.contacts.delete(bookId, contactId)` - Delete a contact
+
+## Features
+
+- 🔐 **Type-safe** - Full TypeScript support with type inference
+- ⚡ **Modern** - Built with ESM and async/await
+- 🎨 **React Email** - Send emails using React components
+- 📦 **Lightweight** - Minimal dependencies
+- 🔄 **Batch sending** - Send up to 100 emails in a single request
+- ⏰ **Scheduled emails** - Schedule emails for later delivery
+
+## Requirements
+
+- Node.js 16+
+- TypeScript 4.7+ (for TypeScript projects)
+
+## License
+
+MIT