mailpush 0.1.0

package/README.md

@@ -0,0 +1,127 @@
+# Mailpush
+
+Official JavaScript/TypeScript SDK for [Mailpush](https://mailpush.app).
+
+## Installation
+
+```bash
+npm install mailpush
+# or
+bun add mailpush
+# or
+yarn add mailpush
+```
+
+## Quick Start
+
+```typescript
+import { Mailpush } from "mailpush";
+
+const mailpush = new Mailpush("mp_live_xxx");
+
+await mailpush.emails.send({
+  from: "hello@yourdomain.com",
+  to: "user@example.com",
+  subject: "Hello from Mailpush",
+  html: "<h1>Welcome!</h1><p>Your account is ready.</p>",
+});
+```
+
+## Usage
+
+### Send an email
+
+```typescript
+const { id, messageId } = await mailpush.emails.send({
+  from: "hello@yourdomain.com",
+  to: "user@example.com",
+  subject: "Welcome!",
+  html: "<h1>Hello</h1>",
+  text: "Hello",
+});
+```
+
+### Send to multiple recipients
+
+```typescript
+await mailpush.emails.send({
+  from: "hello@yourdomain.com",
+  to: ["user1@example.com", "user2@example.com"],
+  cc: "cc@example.com",
+  bcc: ["bcc1@example.com", "bcc2@example.com"],
+  subject: "Team Update",
+  html: "<p>Important update for the team.</p>",
+});
+```
+
+### Send with a template
+
+```typescript
+await mailpush.emails.send({
+  from: "hello@yourdomain.com",
+  to: "user@example.com",
+  templateId: "your-template-id",
+  variables: {
+    name: "John",
+    company: "Acme Inc",
+  },
+});
+```
+
+### Send with attachments
+
+```typescript
+import { readFileSync } from "fs";
+
+await mailpush.emails.send({
+  from: "hello@yourdomain.com",
+  to: "user@example.com",
+  subject: "Your invoice",
+  html: "<p>Please find your invoice attached.</p>",
+  attachments: [
+    {
+      filename: "invoice.pdf",
+      content: readFileSync("invoice.pdf").toString("base64"),
+      contentType: "application/pdf",
+    },
+  ],
+});
+```
+
+## Configuration
+
+```typescript
+const mailpush = new Mailpush("mp_live_xxx", {
+  baseUrl: "https://api.mailpush.app", // default
+});
+```
+
+## Error Handling
+
+```typescript
+import {
+  Mailpush,
+  MailpushError,
+  AuthenticationError,
+  ValidationError,
+  RateLimitError,
+} from "mailpush";
+
+try {
+  await mailpush.emails.send({ ... });
+} catch (error) {
+  if (error instanceof AuthenticationError) {
+    console.error("Invalid API key");
+  } else if (error instanceof ValidationError) {
+    console.error("Invalid request:", error.details);
+  } else if (error instanceof RateLimitError) {
+    console.error(`Rate limited. Retry after ${error.retryAfter}s`);
+  } else if (error instanceof MailpushError) {
+    console.error(`Error: ${error.message} (${error.code})`);
+  }
+}
+```
+
+## License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,58 @@
+interface SendEmailRequest {
+    from: string;
+    to: string | string[];
+    cc?: string | string[];
+    bcc?: string | string[];
+    replyTo?: string;
+    subject?: string;
+    html?: string;
+    text?: string;
+    templateId?: string;
+    variables?: Record<string, string>;
+    attachments?: Attachment[];
+}
+interface Attachment {
+    filename: string;
+    content: string;
+    contentType: string;
+}
+interface SendEmailResponse {
+    id: string;
+    messageId: string;
+    status: "sent";
+}
+
+declare class Emails {
+    private request;
+    constructor(request: (path: string, options: RequestInit) => Promise<Response>);
+    send(data: SendEmailRequest): Promise<SendEmailResponse>;
+}
+
+interface MailpushConfig {
+    baseUrl?: string;
+}
+declare class Mailpush {
+    private apiKey;
+    private baseUrl;
+    readonly emails: Emails;
+    constructor(apiKey: string, config?: MailpushConfig);
+    private request;
+}
+
+declare class MailpushError extends Error {
+    code: string;
+    details?: unknown;
+    constructor(message: string, code: string, details?: unknown);
+}
+declare class AuthenticationError extends MailpushError {
+    constructor(message: string, code: string);
+}
+declare class ValidationError extends MailpushError {
+    constructor(message: string, code: string, details?: unknown);
+}
+declare class RateLimitError extends MailpushError {
+    retryAfter?: number;
+    constructor(message: string, retryAfter?: number);
+}
+
+export { type Attachment, AuthenticationError, Mailpush, type MailpushConfig, MailpushError, RateLimitError, type SendEmailRequest, type SendEmailResponse, ValidationError };

package/dist/index.d.ts

@@ -0,0 +1,58 @@
+interface SendEmailRequest {
+    from: string;
+    to: string | string[];
+    cc?: string | string[];
+    bcc?: string | string[];
+    replyTo?: string;
+    subject?: string;
+    html?: string;
+    text?: string;
+    templateId?: string;
+    variables?: Record<string, string>;
+    attachments?: Attachment[];
+}
+interface Attachment {
+    filename: string;
+    content: string;
+    contentType: string;
+}
+interface SendEmailResponse {
+    id: string;
+    messageId: string;
+    status: "sent";
+}
+
+declare class Emails {
+    private request;
+    constructor(request: (path: string, options: RequestInit) => Promise<Response>);
+    send(data: SendEmailRequest): Promise<SendEmailResponse>;
+}
+
+interface MailpushConfig {
+    baseUrl?: string;
+}
+declare class Mailpush {
+    private apiKey;
+    private baseUrl;
+    readonly emails: Emails;
+    constructor(apiKey: string, config?: MailpushConfig);
+    private request;
+}
+
+declare class MailpushError extends Error {
+    code: string;
+    details?: unknown;
+    constructor(message: string, code: string, details?: unknown);
+}
+declare class AuthenticationError extends MailpushError {
+    constructor(message: string, code: string);
+}
+declare class ValidationError extends MailpushError {
+    constructor(message: string, code: string, details?: unknown);
+}
+declare class RateLimitError extends MailpushError {
+    retryAfter?: number;
+    constructor(message: string, retryAfter?: number);
+}
+
+export { type Attachment, AuthenticationError, Mailpush, type MailpushConfig, MailpushError, RateLimitError, type SendEmailRequest, type SendEmailResponse, ValidationError };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var d=Object.defineProperty;var f=Object.getOwnPropertyDescriptor;var E=Object.getOwnPropertyNames;var R=Object.prototype.hasOwnProperty;var w=(r,t)=>{for(var e in t)d(r,e,{get:t[e],enumerable:!0})},y=(r,t,e,s)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of E(t))!R.call(r,n)&&n!==e&&d(r,n,{get:()=>t[n],enumerable:!(s=f(t,n))||s.enumerable});return r};var g=r=>y(d({},"__esModule",{value:!0}),r);var A={};w(A,{AuthenticationError:()=>o,Mailpush:()=>l,MailpushError:()=>i,RateLimitError:()=>p,ValidationError:()=>a});module.exports=g(A);var h=class{constructor(t){this.request=t}async send(t){return(await this.request("/v1/send",{method:"POST",body:JSON.stringify(t)})).json()}};var i=class extends Error{constructor(t,e,s){super(t),this.name="MailpushError",this.code=e,this.details=s}},o=class extends i{constructor(t,e){super(t,e),this.name="AuthenticationError"}},a=class extends i{constructor(t,e,s){super(t,e,s),this.name="ValidationError"}},p=class extends i{constructor(t,e){super(t,"RATE_LIMITED"),this.name="RateLimitError",this.retryAfter=e}};var l=class{constructor(t,e={}){if(!t)throw new Error("API key is required");if(!t.startsWith("mp_"))throw new Error("Invalid API key format");this.apiKey=t,this.baseUrl=e.baseUrl??"https://api.mailpush.app",this.emails=new h(this.request.bind(this))}async request(t,e){let s=await fetch(`${this.baseUrl}${t}`,{...e,headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`,...e.headers}});if(!s.ok){let n=await s.json().catch(()=>({})),{error:u,code:c,details:m}=n;throw s.status===401?new o(u||"Invalid API key",c||"INVALID_API_KEY"):s.status===429?new p(u||"Rate limited",m?.retryAfter):s.status===400?new a(u||"Validation error",c||"VALIDATION_ERROR",m):new i(u||"Request failed",c||"UNKNOWN_ERROR",m)}return s}};0&&(module.exports={AuthenticationError,Mailpush,MailpushError,RateLimitError,ValidationError});

package/dist/index.mjs

@@ -0,0 +1 @@
+var u=class{constructor(t){this.request=t}async send(t){return(await this.request("/v1/send",{method:"POST",body:JSON.stringify(t)})).json()}};var s=class extends Error{constructor(t,e,r){super(t),this.name="MailpushError",this.code=e,this.details=r}},n=class extends s{constructor(t,e){super(t,e),this.name="AuthenticationError"}},o=class extends s{constructor(t,e,r){super(t,e,r),this.name="ValidationError"}},a=class extends s{constructor(t,e){super(t,"RATE_LIMITED"),this.name="RateLimitError",this.retryAfter=e}};var c=class{constructor(t,e={}){if(!t)throw new Error("API key is required");if(!t.startsWith("mp_"))throw new Error("Invalid API key format");this.apiKey=t,this.baseUrl=e.baseUrl??"https://api.mailpush.app",this.emails=new u(this.request.bind(this))}async request(t,e){let r=await fetch(`${this.baseUrl}${t}`,{...e,headers:{"Content-Type":"application/json",Authorization:`Bearer ${this.apiKey}`,...e.headers}});if(!r.ok){let m=await r.json().catch(()=>({})),{error:p,code:h,details:l}=m;throw r.status===401?new n(p||"Invalid API key",h||"INVALID_API_KEY"):r.status===429?new a(p||"Rate limited",l?.retryAfter):r.status===400?new o(p||"Validation error",h||"VALIDATION_ERROR",l):new s(p||"Request failed",h||"UNKNOWN_ERROR",l)}return r}};export{n as AuthenticationError,c as Mailpush,s as MailpushError,a as RateLimitError,o as ValidationError};

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "mailpush",
+  "version": "0.1.0",
+  "description": "Official Mailpush SDK for JavaScript/TypeScript",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": ["dist"],
+  "scripts": {
+    "build": "tsup",
+    "dev": "tsup --watch",
+    "typecheck": "tsc --noEmit"
+  },
+  "keywords": ["email", "mailpush", "smtp", "transactional"],
+  "author": "Mailpush",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mailpush/mailpush"
+  },
+  "homepage": "https://mailpush.app",
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  }
+}