smartletter 0.0.0-stage → 1.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 THE DUG MEDIA LTD
+
+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

@@ -1,3 +1,102 @@
-# Temporary Holding Version
+# smartletter
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+Official Node.js SDK for [Smartletter](https://smartletter.ai). A drop-in replacement for the Resend SDK (`resend` 6.32): same method names, same `{ data, error, headers }` return shape. No runtime dependency. Works on Node 18+, Workers, Deno, Bun and the browser. ESM and CommonJS.
+
+```sh
+npm install smartletter
+```
+
+## Send an email
+
+```ts
+import { Smartletter } from "smartletter";
+
+const smartletter = new Smartletter("sl_..."); // or set SMARTLETTER_API_KEY
+
+const { data, error, headers } = await smartletter.emails.send({
+  from: "Acme <hello@acme.com>",
+  to: ["jane@example.com"],
+  subject: "Welcome",
+  html: "<p>Hello!</p>",
+});
+```
+
+`headers` holds the response headers (or `null`). Methods never throw on API errors: check `error`. Only the constructor (missing or `re_` key) and `webhooks.verify` throw.
+
+## Coming from Resend
+
+Change the package and the key. Nothing else.
+
+```diff
+- import { Resend } from "resend";
++ import { Resend } from "smartletter";
+
+- const resend = new Resend("re_...");
++ const resend = new Resend("sl_...");
+```
+
+`Resend` is an alias of `Smartletter`. `emails.create` / `batch.create` are aliases of `send`. `RESEND_API_KEY` is still read when it holds an `sl_` key. A `re_` key is refused with a clear error. Set `baseUrl` (or `SMARTLETTER_BASE_URL`) to target another API host.
+
+Renamed concepts:
+
+| Resend | Smartletter |
+| --- | --- |
+| `broadcasts` | `newsletters` |
+| `automations` | `sequences` |
+| `contactProperties` | `contactFields` |
+| `receiving` | `inboxes` |
+
+Resend methods with no Smartletter route, so absent from the client: `domains.update`, `domains.remove`, `domains.claims`, `emails.share`, `emails.metrics`, `emails.attachments`, `emails.receiving`, `webhooks.events`. Resend's raw HTTP methods on the client (`post`, `get`, `put`, `patch`, `delete`) are absent too.
+
+`attachments[].filename` accepts `false` like Resend (the key is then left out of the request). That only makes sense with `path`.
+
+Also supported, with the same call styles as Resend:
+
+```ts
+// Aliases of send
+await smartletter.emails.create({ from: "Acme <hello@acme.com>", to: "jane@example.com", subject: "Hi", html: "<p>Hi</p>" });
+await smartletter.batch.create([{ from: "Acme <hello@acme.com>", to: "jane@example.com", subject: "Hi", html: "<p>Hi</p>" }]);
+
+// Create a template and publish it in one chain
+const { data: tpl, error: tplError } = await smartletter.templates
+  .create({ name: "Receipt", html: "<p>Thanks!</p>" })
+  .publish();
+
+// Update an API key: (id, payload)
+await smartletter.apiKeys.update("key_123", { name: "Renamed key" });
+```
+
+`react` is rendered through the optional `@react-email/render` peer. `webhooks.verify` is synchronous and throws `WebhookVerificationError`.
+
+## Beyond Resend
+
+Smartletter-only methods, for example importing contacts in bulk:
+
+```ts
+const { data, error } = await smartletter.contacts.import({
+  segmentId: "seg_123",
+  consent: true, // you confirm these people agreed to receive your emails
+  contacts: [
+    { email: "jane@example.com", firstName: "Jane" },
+    { email: "john@example.com" },
+  ],
+});
+```
+
+## Verify a webhook
+
+```ts
+const event = smartletter.webhooks.verify({
+  payload: await request.text(), // the raw body, as a string
+  headers: {
+    id: request.headers.get("svix-id")!,
+    timestamp: request.headers.get("svix-timestamp")!,
+    signature: request.headers.get("svix-signature")!,
+  },
+  webhookSecret: process.env.WEBHOOK_SECRET!,
+});
+```
+
+## License
+
+MIT