hubmail 1.0.2 → 1.0.4

package/README.md

@@ -1,15 +1,60 @@
-# hubmail
+# HubMail SDK
 
-To install dependencies:
+A TypeScript-friendly SDK for sending emails via the HubMail API.
+
+## Installation
 
 ```bash
-bun install
+bun add hubmail
+# or
+npm install hubmail
 ```
 
-To run:
+## Usage
+
+### 1. Set up your API key
+The SDK will automatically look for `HUBMAIL_KEY` in your environment variables.
 
 ```bash
-bun run index.ts
+# .env
+HUBMAIL_KEY=hm_your_api_key_here
 ```
 
-This project was created using `bun init` in bun v1.2.22. [Bun](https://bun.com) is a fast all-in-one JavaScript runtime.
+### 2. Send an email
+
+```typescript
+import { HubMail } from "hubmail";
+
+const hubmail = new HubMail();
+
+try {
+  const result = await hubmail.send({
+    from: "you@hubmail.space",
+    to: ["friend@example.com"],
+    subject: "Hello from HubMail",
+    text: "This is a test email.",
+    html: "<b>This is a test email.</b>",
+  });
+
+  console.log("Email sent! ID:", result.id);
+} catch (error) {
+  console.error("Failed to send email:", error.message);
+}
+```
+
+### Configuration Options
+
+You can also pass configuration directly to the constructor:
+
+```typescript
+const hubmail = new HubMail({
+  apiKey: "hm_custom_key",
+});
+```
+
+## Features
+
+- **TypeScript Friendly**: Full type support for all request and response structures.
+- **Flexible Recipients**: Support for single or multiple recipients (To, CC, BCC).
+- **Environment Driven**: Automatic detection of API keys from environment variables.
+- **Bun Native**: Built for high performance with Bun and standard Web APIs.

package/dist/index.js

@@ -1,2 +1,2 @@
 // @bun
-console.log("Hello via Bun!");
+class C extends Error{status;details;constructor(x,k,z){super(x);this.name="HubMailError",this.status=k,this.details=z}}class F{apiKey;baseUrl;constructor(x={}){let k=x.apiKey??process.env.HUBMAIL_KEY;if(!k)throw Error("HubMail API key is required. Provide it in the constructor or set the HUBMAIL_KEY environment variable.");this.apiKey=k,this.baseUrl=(x.baseUrl??"https://hubmail.space").replace(/\/$/,"")}async send(x){let k=await fetch(`${this.baseUrl}/api/v1/send`,{method:"POST",headers:{Authorization:`Bearer ${this.apiKey}`,"Content-Type":"application/json"},body:JSON.stringify(x)}),z=await k.json();if(!k.ok){let B=z;throw new C(B.error||"Failed to send email",k.status,B.details)}return z}}var J=F;export{J as default,C as HubMailError,F as HubMail};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "hubmail",
   "module": "index.ts",
-  "version": "1.0.2",
+  "version": "1.0.4",
   "type": "module",
   "files": [
     "dist"