mailmark 0.1.0

package/README.md

@@ -0,0 +1,67 @@
+# mailmark
+
+Official Node.js SDK for the [DevMail](https://mailmark.io) transactional email API.
+
+## Installation
+
+```bash
+bun add mailmark
+# or
+npm install mailmark
+```
+
+## Quick Start
+
+```ts
+import { Devmail } from 'mailmark';
+
+const client = new Devmail('dm_live_your_api_key');
+
+await client.send({
+  from: 'hello@yourdomain.com',
+  to: ['recipient@example.com'],
+  subject: 'Hello from DevMail',
+  html: '<h1>Hello!</h1><p>This email was sent via the DevMail API.</p>',
+});
+```
+
+## API
+
+### `new Devmail(apiKey, options?)`
+
+| Parameter | Type | Description |
+|-----------|------|-------------|
+| `apiKey` | `string` | Your API key from the DevMail Developer dashboard |
+| `options.baseUrl` | `string` | Override the API base URL (for self-hosted) |
+
+### `client.send(options)`
+
+| Field | Type | Required | Description |
+|-------|------|----------|-------------|
+| `from` | `string` | Yes | Sender address — must belong to the API key's domain |
+| `to` | `string \| string[]` | Yes | Recipient address(es) |
+| `subject` | `string` | Yes | Email subject |
+| `html` | `string` | One of | HTML email body |
+| `text` | `string` | One of | Plain-text body (used if html is omitted) |
+
+Returns `Promise<{ messageId: string; status: "queued" }>`.
+
+Throws `DevmailError` on API errors, with `.status` (HTTP status) and `.response` (parsed body).
+
+## cURL Equivalent
+
+```bash
+curl -X POST https://harmless-armadillo-386.convex.site/v1/send \
+  -H "Authorization: Bearer dm_live_your_api_key" \
+  -H "Content-Type: application/json" \
+  -d '{
+    "from": "hello@yourdomain.com",
+    "to": ["recipient@example.com"],
+    "subject": "Hello",
+    "html": "<p>Hello!</p>"
+  }'
+```
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,33 @@
+export interface SendEmailOptions {
+    /** Sender address — must be a mailbox on the API key's scoped domain. */
+    from: string;
+    /** One or more recipient addresses. */
+    to: string | string[];
+    /** Email subject line. */
+    subject: string;
+    /** HTML body. Either html or text (or both) is required. */
+    html?: string;
+    /** Plain-text body. Used if html is not provided. */
+    text?: string;
+}
+export interface SendEmailResult {
+    messageId: string;
+    status: "queued";
+}
+export interface DevmailOptions {
+    /** Override the default API base URL. Useful for self-hosted instances. */
+    baseUrl?: string;
+}
+export declare class DevmailError extends Error {
+    readonly status: number;
+    readonly response: unknown;
+    constructor(message: string, status: number, response: unknown);
+}
+export declare class Devmail {
+    private readonly apiKey;
+    private readonly baseUrl;
+    constructor(apiKey: string, options?: DevmailOptions);
+    send(options: SendEmailOptions): Promise<SendEmailResult>;
+}
+export default Devmail;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,gBAAgB;IAC/B,yEAAyE;IACzE,IAAI,EAAE,MAAM,CAAC;IACb,uCAAuC;IACvC,EAAE,EAAE,MAAM,GAAG,MAAM,EAAE,CAAC;IACtB,0BAA0B;IAC1B,OAAO,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,qDAAqD;IACrD,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,eAAe;IAC9B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,QAAQ,CAAC;CAClB;AAED,MAAM,WAAW,cAAc;IAC7B,2EAA2E;IAC3E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,YAAa,SAAQ,KAAK;aAGnB,MAAM,EAAE,MAAM;aACd,QAAQ,EAAE,OAAO;gBAFjC,OAAO,EAAE,MAAM,EACC,MAAM,EAAE,MAAM,EACd,QAAQ,EAAE,OAAO;CAKpC;AAID,qBAAa,OAAO;IAClB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,MAAM,EAAE,OAAO,GAAE,cAAmB;IAMlD,IAAI,CAAC,OAAO,EAAE,gBAAgB,GAAG,OAAO,CAAC,eAAe,CAAC;CAqChE;AAED,eAAe,OAAO,CAAC"}

package/dist/index.js

@@ -0,0 +1,91 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __moduleCache = /* @__PURE__ */ new WeakMap;
+var __toCommonJS = (from) => {
+  var entry = __moduleCache.get(from), desc;
+  if (entry)
+    return entry;
+  entry = __defProp({}, "__esModule", { value: true });
+  if (from && typeof from === "object" || typeof from === "function")
+    __getOwnPropNames(from).map((key) => !__hasOwnProp.call(entry, key) && __defProp(entry, key, {
+      get: () => from[key],
+      enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+    }));
+  __moduleCache.set(from, entry);
+  return entry;
+};
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, {
+      get: all[name],
+      enumerable: true,
+      configurable: true,
+      set: (newValue) => all[name] = () => newValue
+    });
+};
+
+// src/index.ts
+var exports_src = {};
+__export(exports_src, {
+  default: () => src_default,
+  DevmailError: () => DevmailError,
+  Devmail: () => Devmail
+});
+module.exports = __toCommonJS(exports_src);
+
+class DevmailError extends Error {
+  status;
+  response;
+  constructor(message, status, response) {
+    super(message);
+    this.status = status;
+    this.response = response;
+    this.name = "DevmailError";
+  }
+}
+var DEFAULT_BASE_URL = "https://harmless-armadillo-386.convex.site";
+
+class Devmail {
+  apiKey;
+  baseUrl;
+  constructor(apiKey, options = {}) {
+    if (!apiKey)
+      throw new Error("DevMail API key is required");
+    this.apiKey = apiKey;
+    this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
+  }
+  async send(options) {
+    const { from, to, subject, html, text } = options;
+    if (!from)
+      throw new Error('"from" is required');
+    if (!to || Array.isArray(to) && to.length === 0)
+      throw new Error('"to" is required');
+    if (!subject)
+      throw new Error('"subject" is required');
+    if (!html && !text)
+      throw new Error('Either "html" or "text" is required');
+    const body = {
+      from,
+      to: Array.isArray(to) ? to : [to],
+      subject,
+      ...html ? { html } : {},
+      ...text ? { text } : {}
+    };
+    const res = await fetch(`${this.baseUrl}/v1/send`, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${this.apiKey}`,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(body)
+    });
+    const data = await res.json();
+    if (!res.ok) {
+      throw new DevmailError(data.error ?? `Request failed with status ${res.status}`, res.status, data);
+    }
+    return data;
+  }
+}
+var src_default = Devmail;

package/dist/index.mjs

@@ -0,0 +1,60 @@
+// src/index.ts
+class DevmailError extends Error {
+  status;
+  response;
+  constructor(message, status, response) {
+    super(message);
+    this.status = status;
+    this.response = response;
+    this.name = "DevmailError";
+  }
+}
+var DEFAULT_BASE_URL = "https://harmless-armadillo-386.convex.site";
+
+class Devmail {
+  apiKey;
+  baseUrl;
+  constructor(apiKey, options = {}) {
+    if (!apiKey)
+      throw new Error("DevMail API key is required");
+    this.apiKey = apiKey;
+    this.baseUrl = (options.baseUrl ?? DEFAULT_BASE_URL).replace(/\/$/, "");
+  }
+  async send(options) {
+    const { from, to, subject, html, text } = options;
+    if (!from)
+      throw new Error('"from" is required');
+    if (!to || Array.isArray(to) && to.length === 0)
+      throw new Error('"to" is required');
+    if (!subject)
+      throw new Error('"subject" is required');
+    if (!html && !text)
+      throw new Error('Either "html" or "text" is required');
+    const body = {
+      from,
+      to: Array.isArray(to) ? to : [to],
+      subject,
+      ...html ? { html } : {},
+      ...text ? { text } : {}
+    };
+    const res = await fetch(`${this.baseUrl}/v1/send`, {
+      method: "POST",
+      headers: {
+        Authorization: `Bearer ${this.apiKey}`,
+        "Content-Type": "application/json"
+      },
+      body: JSON.stringify(body)
+    });
+    const data = await res.json();
+    if (!res.ok) {
+      throw new DevmailError(data.error ?? `Request failed with status ${res.status}`, res.status, data);
+    }
+    return data;
+  }
+}
+var src_default = Devmail;
+export {
+  src_default as default,
+  DevmailError,
+  Devmail
+};

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "mailmark",
+  "version": "0.1.0",
+  "description": "Official Node.js SDK for the DevMail transactional email API",
+  "main": "./dist/index.js",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    }
+  },
+  "scripts": {
+    "build": "bun run build.ts",
+    "dev": "bun --watch run build.ts",
+    "prepublishOnly": "bun run build"
+  },
+  "keywords": ["email", "transactional", "devmail", "sdk"],
+  "license": "MIT",
+  "devDependencies": {
+    "typescript": "^5.0.0"
+  }
+}