mailchannels-sdk 0.3.6

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Yizack Rangel
+
+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

@@ -0,0 +1,159 @@
+![MailChannels](/docs/public/images/presentation.png)
+
+# MailChannels
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![codecov][codecov-coverage-src]][codecov-coverage-href]
+
+Node.js SDK to integrate [MailChannels API](https://docs.mailchannels.net/) into your JavaScript or TypeScript server-side applications.
+
+<!-- #region overview -->
+This library provides a simple way to interact with the [MailChannels API](https://docs.mailchannels.net/). It is written in TypeScript and can be used in both JavaScript and TypeScript projects and in different runtimes.
+<!-- #endregion overview -->
+
+<!-- #region note -->
+> [!NOTE]
+> This library is NOT officially maintained by [MailChannels Corporation](https://mailchannels.com/).
+<!-- #endregion note -->
+
+- [✨ Release Notes](CHANGELOG.md)
+- [📖 Documentation](https://mailchannels.yizack.com)
+
+## Contents
+
+- 🚀 [Features](#features)
+- 📏 [Requirements](#requirements)
+- 🏃 [Quick setup](#quick-setup)
+- 🚧 [Roadmap](#roadmap)
+- ⚖️ [License](#license)
+- 💻 [Development](#development)
+
+## <a name="features">🚀 Features</a>
+
+- Send transactional emails
+- Check DKIM, SPF & Domain Lockdown
+- Webhook notifications
+- Manage sub-accounts
+- Manage inbound domains
+- Manage account lists
+- Manage recipient lists
+
+## <a name="requirements">📏 Requirements</a>
+
+- MailChannels account
+- Email API key
+
+## <a name="quick-setup">🏃 Quick setup</a>
+
+1. Add `mailchannels-sdk` dependency to your project
+
+```sh
+# npm
+npm i mailchannels-sdk
+
+# yarn
+yarn add mailchannels-sdk
+
+# pnpm
+pnpm add mailchannels-sdk
+```
+
+## <a name="license">⚖️ License</a>
+
+[MIT License](LICENSE)
+
+<!-- #region roadmap -->
+## <a name="roadmap">🚧 Roadmap</a>
+
+Already implemented features are marked with a checkmark. Please open an issue if you find any bugs or missing features.
+
+### [Email API](https://docs.mailchannels.net/email-api/api-reference/email-api)
+
+- 📧 Emails
+  - ✅ Send an Email
+  - ✅ DKIM, SPF & Domain Lockdown Check
+- 📢 Webhooks
+  - ✅ Enroll for Webhook Notifications
+  - ✅ Retrieve Customer Webhooks
+  - ✅ Delete Customer Webhooks
+  - ✅ Retrieve Webhook Signing Key
+- 🪪 Sub-accounts
+  - ✅ Create Sub-account
+  - ✅ Retrieve Sub-accounts
+  - ✅ Delete Sub-account
+  - ✅ Suspend Sub-account
+  - ✅ Activate Sub-account
+  - ✅ Create Sub-account API Key
+  - ✅ Delete Sub-account API Key
+  - ✅ Retrieve Sub-account API Keys
+  - ✅ Create Sub-account SMTP password
+  - ✅ Delete Sub-account SMTP password
+  - ✅ Retrieve Sub-account SMTP Passwords
+
+### [Inbound API](https://docs.mailchannels.net/inbound-api/API-reference/inbound-api)
+
+- 🌐 Domains
+  - ✅ Provision domain
+  - ✅ Remove domain
+  - ✅ List domains
+  - ✅ Bulk provision domains
+  - ✅ Add domain list entry
+  - ✅ Get domain list entries
+  - ✅ Delete domain list entry
+  - ✅ Create login link
+  - ✅ Set downstream address
+  - ✅ Fetch downstream addresses
+  - ✅ Update API key
+- 📋 Lists
+  - ✅ Add item to customer list
+  - ✅ Delete item from customer list
+  - ✅ Get customer list entries
+- 📥 Users
+  - ✅ Create a recipient
+  - ✅ Add item to recipient list
+  - ✅ Get recipient list entries
+  - ✅ Delete item from recipient list
+- ⚙️ Service
+  - ✅ Retrieve the condition of the service
+  - ✅ Submit a false negative or false positive report
+  - ✅ Get a list of your subscriptions to MailChannels Inbound
+<!-- #endregion roadmap -->
+
+## <a name="development">💻 Development</a>
+
+<details>
+  <summary>Local development</summary>
+  
+```sh
+# Install dependencies
+pnpm install
+
+# Build the package
+npm run build
+
+# Run ESLint
+npm run lint
+
+# Run Vitest
+npm run test
+npm run test:watch
+
+# Run typecheck
+npm run test:types
+
+# Release new version
+npm run release
+```
+
+</details>
+
+<!-- Badges -->
+[npm-version-src]: https://img.shields.io/npm/v/mailchannels-sdk.svg?style=flat&colorA=070a30&colorB=35a047
+[npm-version-href]: https://npmjs.com/package/mailchannels-sdk
+
+[npm-downloads-src]: https://img.shields.io/npm/dm/mailchannels-sdk.svg?style=flat&colorA=070a30&colorB=35a047
+[npm-downloads-href]: https://npmjs.com/package/mailchannels-sdk
+
+[codecov-coverage-src]: https://img.shields.io/codecov/c/github/yizack/mailchannels?style=flat&colorA=070a30&token=HTSBRHSJ5M
+[codecov-coverage-href]: https://codecov.io/gh/Yizack/mailchannels

package/dist/mailchannels.d.mts

@@ -0,0 +1,16 @@
+import { M as MailChannelsClient, E as Emails, W as Webhooks, S as SubAccounts, a as Service, D as Domains, U as Users, L as Lists } from './shared/mailchannels-sdk.BDB65ygx.mjs';
+export { z as DomainsBulkProvisionOptions, B as DomainsBulkProvisionResponse, G as DomainsCreateLoginLinkResponse, x as DomainsData, I as DomainsDownstreamAddress, H as DomainsListDownstreamAddressesOptions, J as DomainsListDownstreamAddressesResponse, C as DomainsListOptions, F as DomainsListResponse, y as DomainsProvisionOptions, A as DomainsProvisionResponse, h as EmailsCheckDomainDkim, i as EmailsCheckDomainOptions, k as EmailsCheckDomainResponse, j as EmailsCheckDomainVerdict, c as EmailsSendAttachment, f as EmailsSendOptions, e as EmailsSendOptionsBase, b as EmailsSendRecipient, g as EmailsSendResponse, d as EmailsSendTracking, V as ListEntriesResponse, R as ListEntry, Q as ListEntryOptions, T as ListEntryResponse, P as ListNames, N as ServiceReportOptions, K as ServiceSubscriptionsResponse, l as SubAccountsAccount, p as SubAccountsApiKey, q as SubAccountsCreateApiKeyResponse, m as SubAccountsCreateResponse, t as SubAccountsCreateSmtpPasswordResponse, r as SubAccountsListApiKeyResponse, n as SubAccountsListOptions, o as SubAccountsListResponse, u as SubAccountsListSmtpPasswordResponse, s as SubAccountsSmtpPassword, O as SuccessResponse, v as WebhooksListResponse, w as WebhooksSigningKeyResponse } from './shared/mailchannels-sdk.BDB65ygx.mjs';
+import 'ofetch';
+
+declare class MailChannels extends MailChannelsClient {
+    readonly emails: Emails;
+    readonly webhooks: Webhooks;
+    readonly subAccounts: SubAccounts;
+    readonly service: Service;
+    readonly domains: Domains;
+    readonly users: Users;
+    readonly lists: Lists;
+    constructor(key: string);
+}
+
+export { MailChannels, MailChannelsClient };

package/dist/mailchannels.d.ts

@@ -0,0 +1,16 @@
+import { M as MailChannelsClient, E as Emails, W as Webhooks, S as SubAccounts, a as Service, D as Domains, U as Users, L as Lists } from './shared/mailchannels-sdk.BDB65ygx.js';
+export { z as DomainsBulkProvisionOptions, B as DomainsBulkProvisionResponse, G as DomainsCreateLoginLinkResponse, x as DomainsData, I as DomainsDownstreamAddress, H as DomainsListDownstreamAddressesOptions, J as DomainsListDownstreamAddressesResponse, C as DomainsListOptions, F as DomainsListResponse, y as DomainsProvisionOptions, A as DomainsProvisionResponse, h as EmailsCheckDomainDkim, i as EmailsCheckDomainOptions, k as EmailsCheckDomainResponse, j as EmailsCheckDomainVerdict, c as EmailsSendAttachment, f as EmailsSendOptions, e as EmailsSendOptionsBase, b as EmailsSendRecipient, g as EmailsSendResponse, d as EmailsSendTracking, V as ListEntriesResponse, R as ListEntry, Q as ListEntryOptions, T as ListEntryResponse, P as ListNames, N as ServiceReportOptions, K as ServiceSubscriptionsResponse, l as SubAccountsAccount, p as SubAccountsApiKey, q as SubAccountsCreateApiKeyResponse, m as SubAccountsCreateResponse, t as SubAccountsCreateSmtpPasswordResponse, r as SubAccountsListApiKeyResponse, n as SubAccountsListOptions, o as SubAccountsListResponse, u as SubAccountsListSmtpPasswordResponse, s as SubAccountsSmtpPassword, O as SuccessResponse, v as WebhooksListResponse, w as WebhooksSigningKeyResponse } from './shared/mailchannels-sdk.BDB65ygx.js';
+import 'ofetch';
+
+declare class MailChannels extends MailChannelsClient {
+    readonly emails: Emails;
+    readonly webhooks: Webhooks;
+    readonly subAccounts: SubAccounts;
+    readonly service: Service;
+    readonly domains: Domains;
+    readonly users: Users;
+    readonly lists: Lists;
+    constructor(key: string);
+}
+
+export { MailChannels, MailChannelsClient };

package/dist/mailchannels.mjs

@@ -0,0 +1,54 @@
+import { $fetch } from 'ofetch';
+import { Emails, Webhooks, SubAccounts, Service, Domains, Users, Lists } from './modules.mjs';
+
+class MailChannelsClient {
+  static BASE_URL = "https://api.mailchannels.net";
+  #headers;
+  constructor(key) {
+    if (!key) {
+      throw new Error("Missing MailChannels API key.");
+    }
+    this.#headers = {
+      "X-API-Key": key,
+      "Accept": "application/json",
+      "Content-Type": "application/json"
+    };
+  }
+  async _fetch(path, options) {
+    return $fetch(path, {
+      baseURL: MailChannelsClient.BASE_URL,
+      ...options,
+      headers: {
+        ...this.#headers,
+        ...options?.headers
+      }
+    });
+  }
+  async post(path, options) {
+    return this._fetch(path, { method: "POST", ...options });
+  }
+  async get(path, options) {
+    return this._fetch(path, { method: "GET", ...options });
+  }
+  async delete(path, options) {
+    return this._fetch(path, { method: "DELETE", ...options });
+  }
+  async put(path, options) {
+    return this._fetch(path, { method: "PUT", ...options });
+  }
+}
+
+class MailChannels extends MailChannelsClient {
+  emails = new Emails(this);
+  webhooks = new Webhooks(this);
+  subAccounts = new SubAccounts(this);
+  service = new Service(this);
+  domains = new Domains(this);
+  users = new Users(this);
+  lists = new Lists(this);
+  constructor(key) {
+    super(key);
+  }
+}
+
+export { MailChannels, MailChannelsClient };

package/dist/modules.d.mts

@@ -0,0 +1,2 @@
+export { D as Domains, z as DomainsBulkProvisionOptions, B as DomainsBulkProvisionResponse, G as DomainsCreateLoginLinkResponse, x as DomainsData, I as DomainsDownstreamAddress, H as DomainsListDownstreamAddressesOptions, J as DomainsListDownstreamAddressesResponse, C as DomainsListOptions, F as DomainsListResponse, y as DomainsProvisionOptions, A as DomainsProvisionResponse, E as Emails, h as EmailsCheckDomainDkim, i as EmailsCheckDomainOptions, k as EmailsCheckDomainResponse, j as EmailsCheckDomainVerdict, c as EmailsSendAttachment, f as EmailsSendOptions, e as EmailsSendOptionsBase, b as EmailsSendRecipient, g as EmailsSendResponse, d as EmailsSendTracking, V as ListEntriesResponse, R as ListEntry, Q as ListEntryOptions, T as ListEntryResponse, P as ListNames, L as Lists, a as Service, N as ServiceReportOptions, K as ServiceSubscriptionsResponse, S as SubAccounts, l as SubAccountsAccount, p as SubAccountsApiKey, q as SubAccountsCreateApiKeyResponse, m as SubAccountsCreateResponse, t as SubAccountsCreateSmtpPasswordResponse, r as SubAccountsListApiKeyResponse, n as SubAccountsListOptions, o as SubAccountsListResponse, u as SubAccountsListSmtpPasswordResponse, s as SubAccountsSmtpPassword, O as SuccessResponse, U as Users, W as Webhooks, v as WebhooksListResponse, w as WebhooksSigningKeyResponse } from './shared/mailchannels-sdk.BDB65ygx.mjs';
+import 'ofetch';

package/dist/modules.d.ts

@@ -0,0 +1,2 @@
+export { D as Domains, z as DomainsBulkProvisionOptions, B as DomainsBulkProvisionResponse, G as DomainsCreateLoginLinkResponse, x as DomainsData, I as DomainsDownstreamAddress, H as DomainsListDownstreamAddressesOptions, J as DomainsListDownstreamAddressesResponse, C as DomainsListOptions, F as DomainsListResponse, y as DomainsProvisionOptions, A as DomainsProvisionResponse, E as Emails, h as EmailsCheckDomainDkim, i as EmailsCheckDomainOptions, k as EmailsCheckDomainResponse, j as EmailsCheckDomainVerdict, c as EmailsSendAttachment, f as EmailsSendOptions, e as EmailsSendOptionsBase, b as EmailsSendRecipient, g as EmailsSendResponse, d as EmailsSendTracking, V as ListEntriesResponse, R as ListEntry, Q as ListEntryOptions, T as ListEntryResponse, P as ListNames, L as Lists, a as Service, N as ServiceReportOptions, K as ServiceSubscriptionsResponse, S as SubAccounts, l as SubAccountsAccount, p as SubAccountsApiKey, q as SubAccountsCreateApiKeyResponse, m as SubAccountsCreateResponse, t as SubAccountsCreateSmtpPasswordResponse, r as SubAccountsListApiKeyResponse, n as SubAccountsListOptions, o as SubAccountsListResponse, u as SubAccountsListSmtpPasswordResponse, s as SubAccountsSmtpPassword, O as SuccessResponse, U as Users, W as Webhooks, v as WebhooksListResponse, w as WebhooksSigningKeyResponse } from './shared/mailchannels-sdk.BDB65ygx.js';
+import 'ofetch';