@easybits.cloud/mailmask 0.1.0

package/dist/index.cjs

@@ -0,0 +1,176 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  MailMask: () => MailMask,
+  MailMaskError: () => MailMaskError
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/client.ts
+var MailMaskError = class extends Error {
+  constructor(status, message) {
+    super(message);
+    this.status = status;
+    this.name = "MailMaskError";
+  }
+};
+async function request(baseUrl, apiKey, path, opts) {
+  const res = await fetch(`${baseUrl}${path}`, {
+    ...opts,
+    headers: {
+      "Authorization": `Bearer ${apiKey}`,
+      "Content-Type": "application/json",
+      ...opts?.headers
+    }
+  });
+  if (!res.ok) {
+    const body = await res.json().catch(() => ({ error: res.statusText }));
+    throw new MailMaskError(res.status, body.error || res.statusText);
+  }
+  return res.json();
+}
+var MailMask = class {
+  constructor(config) {
+    this.apiKey = config.apiKey;
+    this.baseUrl = (config.baseUrl || "https://www.mailmask.studio").replace(/\/$/, "");
+    const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts);
+    this.domains = new DomainsResource(req);
+    this.aliases = new AliasesResource(req);
+    this.rules = new RulesResource(req);
+    this.logs = new LogsResource(req);
+    this.send = new SendResource(req);
+    this.smtp = new SmtpResource(req);
+    this.apiKeys = new ApiKeysResource(req);
+  }
+};
+var DomainsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list() {
+    return this.req("/api/domains");
+  }
+  get(id) {
+    return this.req(`/api/domains/${id}`);
+  }
+  create(domain) {
+    return this.req("/api/domains", { method: "POST", body: JSON.stringify({ domain }) });
+  }
+  delete(id) {
+    return this.req(`/api/domains/${id}`, { method: "DELETE" });
+  }
+  health(id) {
+    return this.req(`/api/domains/${id}/health`);
+  }
+  verify(id) {
+    return this.req(`/api/domains/${id}/verify`, { method: "POST" });
+  }
+};
+var AliasesResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/aliases`);
+  }
+  create(domainId, input) {
+    return this.req(`/api/domains/${domainId}/aliases`, { method: "POST", body: JSON.stringify(input) });
+  }
+  update(domainId, alias, input) {
+    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "PUT", body: JSON.stringify(input) });
+  }
+  delete(domainId, alias) {
+    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "DELETE" });
+  }
+};
+var RulesResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/rules`);
+  }
+  create(domainId, input) {
+    return this.req(`/api/domains/${domainId}/rules`, { method: "POST", body: JSON.stringify(input) });
+  }
+  update(domainId, ruleId, input) {
+    return this.req(`/api/domains/${domainId}/rules/${ruleId}`, { method: "PUT", body: JSON.stringify(input) });
+  }
+  delete(domainId, ruleId) {
+    return this.req(`/api/domains/${domainId}/rules/${ruleId}`, { method: "DELETE" });
+  }
+};
+var LogsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/logs`);
+  }
+};
+var SendResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  send(domainId, input) {
+    return this.req(`/api/domains/${domainId}/send`, { method: "POST", body: JSON.stringify(input) });
+  }
+  bulkSend(domainId, input) {
+    return this.req(`/api/domains/${domainId}/bulk-send`, { method: "POST", body: JSON.stringify(input) });
+  }
+  bulkStatus(domainId, jobId) {
+    return this.req(`/api/domains/${domainId}/bulk-send/${jobId}`);
+  }
+};
+var SmtpResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/smtp-credentials`);
+  }
+  create(domainId, label) {
+    return this.req(`/api/domains/${domainId}/smtp-credentials`, { method: "POST", body: JSON.stringify({ label }) });
+  }
+  revoke(domainId, credId) {
+    return this.req(`/api/domains/${domainId}/smtp-credentials/${credId}`, { method: "DELETE" });
+  }
+};
+var ApiKeysResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list() {
+    return this.req("/api/api-keys");
+  }
+  create(name) {
+    return this.req("/api/api-keys", { method: "POST", body: JSON.stringify({ name }) });
+  }
+  revoke(id) {
+    return this.req(`/api/api-keys/${id}`, { method: "DELETE" });
+  }
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  MailMask,
+  MailMaskError
+});

package/dist/index.d.cts

@@ -0,0 +1,189 @@
+interface MailMaskConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+interface Domain {
+    id: string;
+    domain: string;
+    verified: boolean;
+    mxConfigured: boolean;
+    createdAt: string;
+}
+interface Alias {
+    alias: string;
+    domainId: string;
+    destinations: string[];
+    enabled: boolean;
+    forwardCount: number;
+    createdAt: string;
+}
+interface CreateAliasInput {
+    local: string;
+    forwardTo: string | string[];
+}
+interface UpdateAliasInput {
+    enabled?: boolean;
+    destinations?: string[];
+}
+interface Rule {
+    id: string;
+    domainId: string;
+    field: "to" | "from" | "subject";
+    match: string;
+    value: string;
+    action: string;
+    target: string;
+    priority: number;
+    enabled: boolean;
+    createdAt: string;
+}
+interface CreateRuleInput {
+    field: "to" | "from" | "subject";
+    match: string;
+    value: string;
+    action: string;
+    target: string;
+    priority?: number;
+}
+interface UpdateRuleInput {
+    field?: "to" | "from" | "subject";
+    match?: string;
+    value?: string;
+    action?: string;
+    target?: string;
+    priority?: number;
+    enabled?: boolean;
+}
+interface EmailLog {
+    id: string;
+    domainId: string;
+    timestamp: string;
+    from: string;
+    to: string;
+    subject: string;
+    status: string;
+    forwardedTo: string;
+    error?: string;
+}
+interface SendEmailInput {
+    fromLocal: string;
+    to: string;
+    subject: string;
+    html: string;
+}
+interface BulkSendInput {
+    from: string;
+    recipients: string[];
+    subject: string;
+    html: string;
+}
+interface BulkJob {
+    id: string;
+    status: string;
+    totalRecipients: number;
+    sent: number;
+    failed: number;
+}
+interface SmtpCredential {
+    id: string;
+    domainId: string;
+    label: string;
+    iamUsername: string;
+    createdAt: string;
+}
+interface ApiKey {
+    id: string;
+    name: string;
+    lastUsedAt?: string;
+    createdAt: string;
+}
+
+declare class MailMaskError extends Error {
+    status: number;
+    constructor(status: number, message: string);
+}
+declare class MailMask {
+    private baseUrl;
+    private apiKey;
+    domains: DomainsResource;
+    aliases: AliasesResource;
+    rules: RulesResource;
+    logs: LogsResource;
+    send: SendResource;
+    smtp: SmtpResource;
+    apiKeys: ApiKeysResource;
+    constructor(config: MailMaskConfig);
+}
+type Req = <T>(path: string, opts?: RequestInit) => Promise<T>;
+declare class DomainsResource {
+    private req;
+    constructor(req: Req);
+    list(): Promise<Domain[]>;
+    get(id: string): Promise<Domain>;
+    create(domain: string): Promise<{
+        domain: Domain;
+    }>;
+    delete(id: string): Promise<{
+        ok: boolean;
+    }>;
+    health(id: string): Promise<Record<string, unknown>>;
+    verify(id: string): Promise<Record<string, unknown>>;
+}
+declare class AliasesResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<Alias[]>;
+    create(domainId: string, input: CreateAliasInput): Promise<Alias>;
+    update(domainId: string, alias: string, input: UpdateAliasInput): Promise<Alias>;
+    delete(domainId: string, alias: string): Promise<{
+        ok: boolean;
+    }>;
+}
+declare class RulesResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<Rule[]>;
+    create(domainId: string, input: CreateRuleInput): Promise<Rule>;
+    update(domainId: string, ruleId: string, input: UpdateRuleInput): Promise<Rule>;
+    delete(domainId: string, ruleId: string): Promise<{
+        ok: boolean;
+    }>;
+}
+declare class LogsResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<EmailLog[]>;
+}
+declare class SendResource {
+    private req;
+    constructor(req: Req);
+    send(domainId: string, input: SendEmailInput): Promise<{
+        messageId: string;
+    }>;
+    bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJob>;
+    bulkStatus(domainId: string, jobId: string): Promise<BulkJob>;
+}
+declare class SmtpResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<SmtpCredential[]>;
+    create(domainId: string, label: string): Promise<SmtpCredential & {
+        smtpPassword: string;
+    }>;
+    revoke(domainId: string, credId: string): Promise<{
+        ok: boolean;
+    }>;
+}
+declare class ApiKeysResource {
+    private req;
+    constructor(req: Req);
+    list(): Promise<ApiKey[]>;
+    create(name: string): Promise<ApiKey & {
+        key: string;
+    }>;
+    revoke(id: string): Promise<{
+        ok: boolean;
+    }>;
+}
+
+export { type Alias, type ApiKey, type BulkJob, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type SendEmailInput, type SmtpCredential, type UpdateAliasInput, type UpdateRuleInput };

package/dist/index.d.ts

@@ -0,0 +1,189 @@
+interface MailMaskConfig {
+    apiKey: string;
+    baseUrl?: string;
+}
+interface Domain {
+    id: string;
+    domain: string;
+    verified: boolean;
+    mxConfigured: boolean;
+    createdAt: string;
+}
+interface Alias {
+    alias: string;
+    domainId: string;
+    destinations: string[];
+    enabled: boolean;
+    forwardCount: number;
+    createdAt: string;
+}
+interface CreateAliasInput {
+    local: string;
+    forwardTo: string | string[];
+}
+interface UpdateAliasInput {
+    enabled?: boolean;
+    destinations?: string[];
+}
+interface Rule {
+    id: string;
+    domainId: string;
+    field: "to" | "from" | "subject";
+    match: string;
+    value: string;
+    action: string;
+    target: string;
+    priority: number;
+    enabled: boolean;
+    createdAt: string;
+}
+interface CreateRuleInput {
+    field: "to" | "from" | "subject";
+    match: string;
+    value: string;
+    action: string;
+    target: string;
+    priority?: number;
+}
+interface UpdateRuleInput {
+    field?: "to" | "from" | "subject";
+    match?: string;
+    value?: string;
+    action?: string;
+    target?: string;
+    priority?: number;
+    enabled?: boolean;
+}
+interface EmailLog {
+    id: string;
+    domainId: string;
+    timestamp: string;
+    from: string;
+    to: string;
+    subject: string;
+    status: string;
+    forwardedTo: string;
+    error?: string;
+}
+interface SendEmailInput {
+    fromLocal: string;
+    to: string;
+    subject: string;
+    html: string;
+}
+interface BulkSendInput {
+    from: string;
+    recipients: string[];
+    subject: string;
+    html: string;
+}
+interface BulkJob {
+    id: string;
+    status: string;
+    totalRecipients: number;
+    sent: number;
+    failed: number;
+}
+interface SmtpCredential {
+    id: string;
+    domainId: string;
+    label: string;
+    iamUsername: string;
+    createdAt: string;
+}
+interface ApiKey {
+    id: string;
+    name: string;
+    lastUsedAt?: string;
+    createdAt: string;
+}
+
+declare class MailMaskError extends Error {
+    status: number;
+    constructor(status: number, message: string);
+}
+declare class MailMask {
+    private baseUrl;
+    private apiKey;
+    domains: DomainsResource;
+    aliases: AliasesResource;
+    rules: RulesResource;
+    logs: LogsResource;
+    send: SendResource;
+    smtp: SmtpResource;
+    apiKeys: ApiKeysResource;
+    constructor(config: MailMaskConfig);
+}
+type Req = <T>(path: string, opts?: RequestInit) => Promise<T>;
+declare class DomainsResource {
+    private req;
+    constructor(req: Req);
+    list(): Promise<Domain[]>;
+    get(id: string): Promise<Domain>;
+    create(domain: string): Promise<{
+        domain: Domain;
+    }>;
+    delete(id: string): Promise<{
+        ok: boolean;
+    }>;
+    health(id: string): Promise<Record<string, unknown>>;
+    verify(id: string): Promise<Record<string, unknown>>;
+}
+declare class AliasesResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<Alias[]>;
+    create(domainId: string, input: CreateAliasInput): Promise<Alias>;
+    update(domainId: string, alias: string, input: UpdateAliasInput): Promise<Alias>;
+    delete(domainId: string, alias: string): Promise<{
+        ok: boolean;
+    }>;
+}
+declare class RulesResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<Rule[]>;
+    create(domainId: string, input: CreateRuleInput): Promise<Rule>;
+    update(domainId: string, ruleId: string, input: UpdateRuleInput): Promise<Rule>;
+    delete(domainId: string, ruleId: string): Promise<{
+        ok: boolean;
+    }>;
+}
+declare class LogsResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<EmailLog[]>;
+}
+declare class SendResource {
+    private req;
+    constructor(req: Req);
+    send(domainId: string, input: SendEmailInput): Promise<{
+        messageId: string;
+    }>;
+    bulkSend(domainId: string, input: BulkSendInput): Promise<BulkJob>;
+    bulkStatus(domainId: string, jobId: string): Promise<BulkJob>;
+}
+declare class SmtpResource {
+    private req;
+    constructor(req: Req);
+    list(domainId: string): Promise<SmtpCredential[]>;
+    create(domainId: string, label: string): Promise<SmtpCredential & {
+        smtpPassword: string;
+    }>;
+    revoke(domainId: string, credId: string): Promise<{
+        ok: boolean;
+    }>;
+}
+declare class ApiKeysResource {
+    private req;
+    constructor(req: Req);
+    list(): Promise<ApiKey[]>;
+    create(name: string): Promise<ApiKey & {
+        key: string;
+    }>;
+    revoke(id: string): Promise<{
+        ok: boolean;
+    }>;
+}
+
+export { type Alias, type ApiKey, type BulkJob, type BulkSendInput, type CreateAliasInput, type CreateRuleInput, type Domain, type EmailLog, MailMask, type MailMaskConfig, MailMaskError, type Rule, type SendEmailInput, type SmtpCredential, type UpdateAliasInput, type UpdateRuleInput };

package/dist/index.js

@@ -0,0 +1,148 @@
+// src/client.ts
+var MailMaskError = class extends Error {
+  constructor(status, message) {
+    super(message);
+    this.status = status;
+    this.name = "MailMaskError";
+  }
+};
+async function request(baseUrl, apiKey, path, opts) {
+  const res = await fetch(`${baseUrl}${path}`, {
+    ...opts,
+    headers: {
+      "Authorization": `Bearer ${apiKey}`,
+      "Content-Type": "application/json",
+      ...opts?.headers
+    }
+  });
+  if (!res.ok) {
+    const body = await res.json().catch(() => ({ error: res.statusText }));
+    throw new MailMaskError(res.status, body.error || res.statusText);
+  }
+  return res.json();
+}
+var MailMask = class {
+  constructor(config) {
+    this.apiKey = config.apiKey;
+    this.baseUrl = (config.baseUrl || "https://www.mailmask.studio").replace(/\/$/, "");
+    const req = (path, opts) => request(this.baseUrl, this.apiKey, path, opts);
+    this.domains = new DomainsResource(req);
+    this.aliases = new AliasesResource(req);
+    this.rules = new RulesResource(req);
+    this.logs = new LogsResource(req);
+    this.send = new SendResource(req);
+    this.smtp = new SmtpResource(req);
+    this.apiKeys = new ApiKeysResource(req);
+  }
+};
+var DomainsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list() {
+    return this.req("/api/domains");
+  }
+  get(id) {
+    return this.req(`/api/domains/${id}`);
+  }
+  create(domain) {
+    return this.req("/api/domains", { method: "POST", body: JSON.stringify({ domain }) });
+  }
+  delete(id) {
+    return this.req(`/api/domains/${id}`, { method: "DELETE" });
+  }
+  health(id) {
+    return this.req(`/api/domains/${id}/health`);
+  }
+  verify(id) {
+    return this.req(`/api/domains/${id}/verify`, { method: "POST" });
+  }
+};
+var AliasesResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/aliases`);
+  }
+  create(domainId, input) {
+    return this.req(`/api/domains/${domainId}/aliases`, { method: "POST", body: JSON.stringify(input) });
+  }
+  update(domainId, alias, input) {
+    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "PUT", body: JSON.stringify(input) });
+  }
+  delete(domainId, alias) {
+    return this.req(`/api/domains/${domainId}/aliases/${alias}`, { method: "DELETE" });
+  }
+};
+var RulesResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/rules`);
+  }
+  create(domainId, input) {
+    return this.req(`/api/domains/${domainId}/rules`, { method: "POST", body: JSON.stringify(input) });
+  }
+  update(domainId, ruleId, input) {
+    return this.req(`/api/domains/${domainId}/rules/${ruleId}`, { method: "PUT", body: JSON.stringify(input) });
+  }
+  delete(domainId, ruleId) {
+    return this.req(`/api/domains/${domainId}/rules/${ruleId}`, { method: "DELETE" });
+  }
+};
+var LogsResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/logs`);
+  }
+};
+var SendResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  send(domainId, input) {
+    return this.req(`/api/domains/${domainId}/send`, { method: "POST", body: JSON.stringify(input) });
+  }
+  bulkSend(domainId, input) {
+    return this.req(`/api/domains/${domainId}/bulk-send`, { method: "POST", body: JSON.stringify(input) });
+  }
+  bulkStatus(domainId, jobId) {
+    return this.req(`/api/domains/${domainId}/bulk-send/${jobId}`);
+  }
+};
+var SmtpResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list(domainId) {
+    return this.req(`/api/domains/${domainId}/smtp-credentials`);
+  }
+  create(domainId, label) {
+    return this.req(`/api/domains/${domainId}/smtp-credentials`, { method: "POST", body: JSON.stringify({ label }) });
+  }
+  revoke(domainId, credId) {
+    return this.req(`/api/domains/${domainId}/smtp-credentials/${credId}`, { method: "DELETE" });
+  }
+};
+var ApiKeysResource = class {
+  constructor(req) {
+    this.req = req;
+  }
+  list() {
+    return this.req("/api/api-keys");
+  }
+  create(name) {
+    return this.req("/api/api-keys", { method: "POST", body: JSON.stringify({ name }) });
+  }
+  revoke(id) {
+    return this.req(`/api/api-keys/${id}`, { method: "DELETE" });
+  }
+};
+export {
+  MailMask,
+  MailMaskError
+};

package/package.json

@@ -0,0 +1,27 @@
+{
+  "name": "@easybits.cloud/mailmask",
+  "version": "0.1.0",
+  "description": "Official SDK for the MailMask email alias/forwarding API",
+  "type": "module",
+  "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",
+    "prepublishOnly": "npm run build"
+  },
+  "devDependencies": {
+    "tsup": "^8.0.0",
+    "typescript": "^5.0.0"
+  },
+  "keywords": ["mailmask", "email", "alias", "forwarding", "sdk"],
+  "license": "MIT"
+}