@tozielinski/next-brevo-api-helper 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Torsten Zielinski
+
+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,10 @@
+# next-brevo-api-helper
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Using the Brevo API for create, update and delete contacts, folders and lists and send mails via the API
+
+# Quick Start
+### Install the package:
+```bash
+npm install @tozielinski/next-brevo-api-helper
+```

package/dist/brevo-client.d.ts

@@ -0,0 +1,59 @@
+import type { BrevoApiResponse, BrevoStatus, BrevoContact, BrevoCreateContactRequest, BrevoCreateContactResponse, BrevoGetContactResponse, BrevoSendEmailRequest, BrevoSendEmailResponse, BrevoSendSmsRequest, BrevoSendSmsResponse, BrevoList, BrevoCreateListRequest, BrevoCreateListResponse, BrevoGetListsResponse, BrevoUpdateListRequest, BrevoDeleteListRequest, BrevoAddContactsToListRequest, BrevoAddContactsToListResponse, BrevoFolder, BrevoCreateFolderRequest, BrevoCreateFolderResponse, BrevoGetFolderRequest, BrevoGetFoldersResponse, BrevoUpdateFolderRequest, BrevoDeleteFolderRequest } from "./brevo";
+/**
+ * Create a fabric for brevoFetch with API key preconfigured
+ * @param baseUrl
+ * @param apiKey
+ */
+export declare function createBrevoFetcher(baseUrl: string, apiKey: string): <T>(endpoint: string, options?: RequestInit) => Promise<BrevoApiResponse<T>>;
+/**
+ * Configuration for BrevoClient, when Toke is not available in environment
+ */
+export interface BrevoClientConfig {
+    apiKey?: string;
+    baseUrl?: string;
+}
+/**
+ * BrevoClient – typed wrapper for Brevo REST API v3
+ */
+export declare class BrevoClient {
+    private brevoFetcher;
+    constructor(config?: BrevoClientConfig);
+    /** Create or update a contact */
+    createContact(contact: BrevoCreateContactRequest): Promise<BrevoApiResponse<BrevoCreateContactResponse>>;
+    /** Get contact by email or ID */
+    getContact(identifier: string | number): Promise<BrevoApiResponse<BrevoGetContactResponse>>;
+    /** Delete a contact */
+    deleteContact(identifier: string | number): Promise<BrevoApiResponse<null>>;
+    /** Get all lists */
+    getLists(): Promise<BrevoApiResponse<BrevoGetListsResponse>>;
+    /** Get lists of a folder */
+    getListContacts(listId: number): Promise<BrevoApiResponse<BrevoContact[]>>;
+    /** Get list details */
+    getListDetails(listId: number): Promise<BrevoApiResponse<BrevoList>>;
+    /** Create a new list */
+    createList(list: BrevoCreateListRequest): Promise<BrevoApiResponse<BrevoCreateListResponse>>;
+    updateList(req: BrevoUpdateListRequest): Promise<BrevoApiResponse<BrevoStatus>>;
+    /** Delete a list */
+    deleteList(req: BrevoDeleteListRequest): Promise<BrevoApiResponse<BrevoStatus>>;
+    /** Add existing contacts to a list */
+    addContactsToList(req: BrevoAddContactsToListRequest): Promise<BrevoApiResponse<BrevoAddContactsToListResponse>>;
+    /** Get all folders */
+    getFolders(): Promise<BrevoApiResponse<BrevoGetFoldersResponse>>;
+    /** Get lists of a folder */
+    getFolderLists(req: BrevoGetFolderRequest): Promise<BrevoApiResponse<BrevoList[]>>;
+    /** Get folder details */
+    getFolderDetails(req: BrevoGetFolderRequest): Promise<BrevoApiResponse<BrevoFolder>>;
+    /** Create a new folder */
+    createFolder(req: BrevoCreateFolderRequest): Promise<BrevoApiResponse<BrevoCreateFolderResponse>>;
+    /** Update a folders name */
+    updateFolder(req: BrevoUpdateFolderRequest): Promise<BrevoApiResponse<BrevoStatus>>;
+    /** Delete a folder and all its lists */
+    deleteFolder(req: BrevoDeleteFolderRequest): Promise<BrevoApiResponse<BrevoStatus>>;
+    /** Send transactional email */
+    sendEmail(email: BrevoSendEmailRequest): Promise<BrevoApiResponse<BrevoSendEmailResponse>>;
+    /** Send SMS */
+    static sendSms(sms: BrevoSendSmsRequest): Promise<BrevoApiResponse<BrevoSendSmsResponse>>;
+    /** Ping Brevo API (GET /account) */
+    static ping(): Promise<BrevoApiResponse<unknown>>;
+}
+//# sourceMappingURL=brevo-client.d.ts.map

package/dist/brevo-client.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"brevo-client.d.ts","sourceRoot":"","sources":["../src/brevo-client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACR,gBAAgB,EAEhB,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,sBAAsB,EACtB,mBAAmB,EACnB,oBAAoB,EACpB,SAAS,EACT,sBAAsB,EACtB,uBAAuB,EACvB,qBAAqB,EAErB,sBAAsB,EACtB,sBAAsB,EACtB,6BAA6B,EAC7B,8BAA8B,EAC9B,WAAW,EACX,wBAAwB,EACxB,yBAAyB,EACzB,qBAAqB,EACrB,uBAAuB,EAEvB,wBAAwB,EACxB,wBAAwB,EAC3B,MAAM,SAAS,CAAC;AAYjB;;;;GAIG;AACH,wBAAgB,kBAAkB,CAAC,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,IAC3B,CAAC,EAChC,UAAU,MAAM,EAChB,UAAS,WAAgB,KAC1B,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,CAAC,CA+BlC;AA0ED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED;;GAEG;AACH,qBAAa,WAAW;IACpB,OAAO,CAAC,YAAY,CAAwC;gBAKxD,MAAM,CAAC,EAAE,iBAAiB;IAa9B,iCAAiC;IAC3B,aAAa,CACf,OAAO,EAAE,yBAAyB,GACnC,OAAO,CAAC,gBAAgB,CAAC,0BAA0B,CAAC,CAAC;IAOxD,iCAAiC;IAC3B,UAAU,CACZ,UAAU,EAAE,MAAM,GAAG,MAAM,GAC5B,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAMrD,uBAAuB;IACjB,aAAa,CACf,UAAU,EAAE,MAAM,GAAG,MAAM,GAC5B,OAAO,CAAC,gBAAgB,CAAC,IAAI,CAAC,CAAC;IAUlC,oBAAoB;IACd,QAAQ,IAAI,OAAO,CAAC,gBAAgB,CAAC,qBAAqB,CAAC,CAAC;IASlE,4BAA4B;IACtB,eAAe,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,YAAY,EAAE,CAAC,CAAC;IAShF,uBAAuB;IACjB,cAAc,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,CAAC,CAAC;IAM1E,wBAAwB;IAClB,UAAU,CAAC,IAAI,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAO5F,UAAU,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAOrF,oBAAoB;IACd,UAAU,CAAC,GAAG,EAAE,sBAAsB,GAAG,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAMrF,sCAAsC;IAChC,iBAAiB,CAAE,GAAG,EAAE,6BAA6B,GAAG,OAAO,CAAC,gBAAgB,CAAC,8BAA8B,CAAC,CAAC;IA8BvH,sBAAsB;IAChB,UAAU,IAAI,OAAO,CAAC,gBAAgB,CAAC,uBAAuB,CAAC,CAAC;IAStE,4BAA4B;IACtB,cAAc,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,CAAC;IASxF,yBAAyB;IACnB,gBAAgB,CAAC,GAAG,EAAE,qBAAqB,GAAG,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAM1F,0BAA0B;IACpB,YAAY,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC,yBAAyB,CAAC,CAAC;IAOvG,4BAA4B;IACtB,YAAY,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAOzF,wCAAwC;IAClC,YAAY,CAAC,GAAG,EAAE,wBAAwB,GAAG,OAAO,CAAC,gBAAgB,CAAC,WAAW,CAAC,CAAC;IAYzF,+BAA+B;IACzB,SAAS,CACX,KAAK,EAAE,qBAAqB,GAC7B,OAAO,CAAC,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IAapD,eAAe;WACF,OAAO,CAChB,GAAG,EAAE,mBAAmB,GACzB,OAAO,CAAC,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;IAalD,oCAAoC;WACvB,IAAI,IAAI,OAAO,CAAC,gBAAgB,CAAC,OAAO,CAAC,CAAC;CAG1D"}

package/dist/brevo-client.js

@@ -0,0 +1,265 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BrevoClient = void 0;
+exports.createBrevoFetcher = createBrevoFetcher;
+/**
+ * Environment-based configuration
+ */
+const BREVO_BASE_URL = "https://api.brevo.com/v3";
+const BREVO_API_KEY = process.env.BREVO_API_KEY;
+if (!BREVO_API_KEY) {
+    console.warn("⚠️ BREVO_API_KEY not set in environment. API calls will fail.");
+}
+/**
+ * Create a fabric for brevoFetch with API key preconfigured
+ * @param baseUrl
+ * @param apiKey
+ */
+function createBrevoFetcher(baseUrl, apiKey) {
+    return async function brevoFetcher(endpoint, options = {}) {
+        const res = await fetch(`${baseUrl}${endpoint}`, {
+            ...options,
+            headers: {
+                "Content-Type": "application/json",
+                "api-key": apiKey,
+                ...options.headers,
+            },
+        });
+        const status = res.status;
+        let data = null;
+        try {
+            data = await res.json();
+        }
+        catch {
+            data = null;
+        }
+        if (!res.ok) {
+            const error = {
+                status,
+                message: data?.message || res.statusText,
+                code: data?.code,
+                details: data,
+            };
+            return { status, error };
+        }
+        return { status, data };
+    };
+}
+/**
+ * Minimal helper for making API requests
+ */
+async function brevoFetch(endpoint, options = {}) {
+    const res = await fetch(`${BREVO_BASE_URL}${endpoint}`, {
+        ...options,
+        headers: {
+            "Content-Type": "application/json",
+            "api-key": BREVO_API_KEY,
+            ...options.headers,
+        },
+    });
+    const status = res.status;
+    let data = null;
+    try {
+        data = await res.json();
+    }
+    catch {
+        data = null;
+    }
+    if (!res.ok) {
+        const error = {
+            status,
+            message: data?.message || res.statusText,
+            code: data?.code,
+            details: data,
+        };
+        return { status, error };
+    }
+    return { status, data };
+}
+async function fetchAllPaginated(endpoint, responseKey, limit = 50, extraQuery = "") {
+    let offset = 0;
+    const allItems = [];
+    let items;
+    do {
+        const url = `${endpoint}?limit=${limit}&offset=${offset}${extraQuery}`;
+        const response = await brevoFetch(url, { method: "GET" });
+        if (response.status !== 200) {
+            return response; // Fehler durchreichen
+        }
+        items = response.data?.[responseKey] ?? [];
+        allItems.push(...items);
+        offset += limit;
+    } while (items.length === limit);
+    return {
+        status: 200,
+        data: {
+            count: allItems.length,
+            [responseKey]: allItems,
+        },
+    };
+}
+/**
+ * BrevoClient – typed wrapper for Brevo REST API v3
+ */
+class BrevoClient {
+    brevoFetcher;
+    // private apiKey: string;
+    constructor(config) {
+        const apiKey = config?.apiKey ?? process.env.BREVO_API_KEY;
+        const baseUrl = config?.baseUrl ?? process.env.BREVO_BASE_URL ?? "https://api.brevo.com/v3";
+        this.brevoFetcher = createBrevoFetcher(baseUrl, apiKey);
+    }
+    //
+    // ────────────────────────────────
+    //  CONTACTS
+    // ────────────────────────────────
+    //
+    /** Create or update a contact */
+    async createContact(contact) {
+        return brevoFetch("/contacts", {
+            method: "POST",
+            body: JSON.stringify(contact),
+        });
+    }
+    /** Get contact by email or ID */
+    async getContact(identifier) {
+        return brevoFetch(`/contacts/${identifier}`, {
+            method: "GET",
+        });
+    }
+    /** Delete a contact */
+    async deleteContact(identifier) {
+        return brevoFetch(`/contacts/${identifier}`, { method: "DELETE" });
+    }
+    //
+    // ────────────────────────────────
+    //  LISTS
+    // ────────────────────────────────
+    //
+    /** Get all lists */
+    async getLists() {
+        return fetchAllPaginated("/contacts/lists", "lists", 50, "&sort=asc");
+    }
+    /** Get lists of a folder */
+    async getListContacts(listId) {
+        return fetchAllPaginated(`/contacts/folders/${listId}/contacts`, "contacts", 50, "&sort=asc");
+    }
+    /** Get list details */
+    async getListDetails(listId) {
+        return brevoFetch(`/contacts/lists/${listId}`, {
+            method: "GET"
+        });
+    }
+    /** Create a new list */
+    async createList(list) {
+        return brevoFetch("/contacts/lists", {
+            method: "POST",
+            body: JSON.stringify(list),
+        });
+    }
+    async updateList(req) {
+        return brevoFetch(`/contacts/lists/${req.id}`, {
+            method: "PUT",
+            body: JSON.stringify(req.name),
+        });
+    }
+    /** Delete a list */
+    async deleteList(req) {
+        return brevoFetch(`/contacts/lists/${req.id}`, {
+            method: "DELETE"
+        });
+    }
+    /** Add existing contacts to a list */
+    async addContactsToList(req) {
+        let body = {};
+        if ("emails" in req) {
+            body.emails = req.emails;
+        }
+        else if ("ids" in req) {
+            body.ids = req.ids;
+        }
+        else if ("extIds" in req) {
+            body.extIds = req.extIds;
+        }
+        return brevoFetch(`/contacts/lists/${req.id}/contacts/add`, {
+            method: "POST",
+            body: JSON.stringify(body),
+        });
+    }
+    // async deleteContactFromList(req: BrevoDeleteContactFromListRequest): Promise<BrevoApiResponse<BrevoStatus>> {
+    //
+    // }
+    //
+    // ────────────────────────────────
+    //  FOLDERS
+    // ────────────────────────────────
+    //
+    /** Get all folders */
+    async getFolders() {
+        return fetchAllPaginated("/contacts/folders", "folders", 50, "&sort=asc");
+    }
+    /** Get lists of a folder */
+    async getFolderLists(req) {
+        return fetchAllPaginated(`/contacts/folders/${req.id}/lists`, "lists", 50, "&sort=asc");
+    }
+    /** Get folder details */
+    async getFolderDetails(req) {
+        return brevoFetch(`/contacts/folders/${req.id}`, {
+            method: "GET"
+        });
+    }
+    /** Create a new folder */
+    async createFolder(req) {
+        return brevoFetch("/contacts/folders", {
+            method: "POST",
+            body: JSON.stringify({ name: req.name }),
+        });
+    }
+    /** Update a folders name */
+    async updateFolder(req) {
+        return brevoFetch(`/contacts/folders/${req.id}`, {
+            method: "PUT",
+            body: JSON.stringify({ name: req.name }),
+        });
+    }
+    /** Delete a folder and all its lists */
+    async deleteFolder(req) {
+        return brevoFetch(`/contacts/folders/${req.id}`, {
+            method: "DELETE"
+        });
+    }
+    //
+    // ────────────────────────────────
+    //  TRANSACTIONAL EMAILS
+    // ────────────────────────────────
+    //
+    /** Send transactional email */
+    async sendEmail(email) {
+        return brevoFetch("/smtp/email", {
+            method: "POST",
+            body: JSON.stringify(email),
+        });
+    }
+    //
+    // ────────────────────────────────
+    //  TRANSACTIONAL SMS
+    // ────────────────────────────────
+    //
+    /** Send SMS */
+    static async sendSms(sms) {
+        return brevoFetch("/transactionalSMS/sms", {
+            method: "POST",
+            body: JSON.stringify(sms),
+        });
+    }
+    //
+    // ────────────────────────────────
+    //  UTILS
+    // ────────────────────────────────
+    //
+    /** Ping Brevo API (GET /account) */
+    static async ping() {
+        return brevoFetch("/account", { method: "GET" });
+    }
+}
+exports.BrevoClient = BrevoClient;

package/dist/brevo.d.ts

@@ -0,0 +1,358 @@
+/**
+ * TypeScript declarations for Brevo (Sendinblue) API v3
+ * Compatible with Next.js 15 / TypeScript 5.x
+ */
+
+export const BrevoHttpStatus = {
+    200: "OK",
+    201: "Created",
+    202: "Accepted",
+    204: "No Content",
+    400: "Bad Request",
+    401: "Unauthorized",
+    403: "Forbidden",
+    404: "Not Found",
+    429: "Too Many Requests",
+    500: "Internal Server Error",
+} as const;
+
+export type BrevoStatusCode = keyof typeof BrevoHttpStatus;
+
+export type BrevoStatusMessage = (typeof BrevoHttpStatus)[BrevoStatusCode];
+
+export type BrevoStatus = {
+    code: BrevoStatusCode;
+    message: BrevoStatusMessage;
+};
+
+/////////////////////////////
+//  CONTACTS
+/////////////////////////////
+
+export interface BrevoContact {
+    id?: number;
+    email?: string;
+    sms?: string;
+    attributes?: Record<string, string | number | boolean | (string | number | boolean)[]>;
+    listIds?: number[];
+    emailBlacklisted?: boolean;
+    smsBlacklisted?: boolean;
+    updateEnabled?: boolean;
+    extId?: string;
+    createdAt?: string;
+    modifiedAt?: string;
+}
+
+/**
+ * Request payload when creating a new contact.
+ * API: POST /v3/contact
+ */
+export interface BrevoCreateContactRequest {
+    email?: string;
+    sms?: string;
+    attributes?: Record<string, string | number | boolean | (string | number | boolean)[]>;
+    listIds?: number[];
+    updateEnabled?: boolean;
+    emailBlacklisted?: boolean;
+    smsBlacklisted?: boolean;
+    extId?: string;
+}
+
+/**
+ * Response from POST /v3/contact
+ */
+export interface BrevoCreateContactResponse {
+    id: number;
+    email?: string;
+    sms?: string;
+    attributes?: Record<string, string | number | boolean | (string | number | boolean)[]>;
+    createdAt: string;
+}
+
+/**
+ * Response for GET /v3/contact/{identifier}
+ */
+export interface BrevoGetContactResponse extends BrevoContact {
+    listIds: number[];
+    statistics?: BrevoContactStats;
+}
+
+/**
+ * Contact statistics (opens, clicks, etc.)
+ */
+export interface BrevoContactStats {
+    messagesSent?: number;
+    delivered?: number;
+    opened?: number;
+    click?: number;
+    hardBounces?: number;
+    softBounces?: number;
+    complaints?: number;
+    unsubscriptions?: number;
+    transactionalStats?: {
+        delivered?: number;
+        opened?: number;
+        click?: number;
+        softBounces?: number;
+        hardBounces?: number;
+    };
+}
+
+/////////////////////////////
+//  ATTRIBUTES
+/////////////////////////////
+
+export interface BrevoAttributeCategory {
+    name: string;
+    attributes: BrevoContactAttributeDefinition[];
+}
+
+export interface BrevoContactAttributeDefinition {
+    name: string;
+    type: "text" | "date" | "float" | "boolean" | "id" | "category" | "multiple_choice";
+    value?: string | number | boolean;
+    enumeration?: { value: number; label: string }[];
+    calculatedValue?: boolean;
+    createdAt?: string;
+    updatedAt?: string;
+}
+
+export interface BrevoListAttributesResponse {
+    attributes: BrevoContactAttributeDefinition[];
+}
+
+/////////////////////////////
+//  LISTS
+/////////////////////////////
+
+export interface BrevoList {
+    id: number;
+    name: string;
+    totalSubscribers: number;
+    uniqueSubscribers: number;
+    shared: boolean;
+    folderId: number;
+    createdAt: string;
+    dynamic?: boolean;
+}
+
+export interface BrevoGetListsResponse {
+    lists: BrevoList[];
+    count: number;
+}
+
+export interface BrevoGetListContactsResponse {
+    contacts: BrevoContact[];
+    count: number;
+}
+
+export interface BrevoCreateListRequest {
+    name: string;
+    folderId?: number;
+}
+
+export interface BrevoCreateListResponse {
+    id: number;
+    name: string;
+    totalSubscribers: number;
+    folderId: number;
+    createdAt: string;
+}
+
+export interface BrevoUpdateListRequest {
+    id: number;
+    name: string;
+}
+
+export interface BrevoDeleteListRequest {
+    id: number;
+}
+
+export interface BrevoAddContactsToListBase {
+    id: number;
+}
+
+export interface BrevoAddContactsToListByEmail extends BrevoAddContactsToListBase {
+    emails: string[];
+    ids?: never;
+    extIds?: never;
+}
+
+export interface BrevoAddContactsToListById extends BrevoAddContactsToListBase {
+    ids: number[];
+    emails?: never;
+    extIds?: never;
+}
+
+export interface BrevoAddContactsToListByExtId extends BrevoAddContactsToListBase {
+    extIds: string[];
+    emails?: never;
+    ids?: never;
+}
+
+export type BrevoAddContactsToListRequest =
+    | BrevoAddContactsToListByEmail
+    | BrevoAddContactsToListById
+    | BrevoAddContactsToListByExtId;
+
+export interface BrevoAddContactsToListResponse {
+    contacts: {
+        success: number[] | string[],
+        failure: number[] | string[],
+    };
+}
+
+/////////////////////////////
+//  FOLDERS
+/////////////////////////////
+
+export interface BrevoFolder {
+    id: number;
+    name: string;
+    uniqueSubscribers: number;
+}
+
+export interface BrevoGetFoldersResponse {
+    folders: BrevoFolder[];
+    count: number;
+}
+
+export interface BrevoGetFolderRequest {
+    id: number;
+}
+
+export interface BrevoGetFolderListsResponse {
+    lists: BrevoList[];
+    count: number;
+}
+
+export interface BrevoCreateFolderRequest {
+    name: string;
+}
+
+export interface BrevoCreateFolderResponse {
+    id: number;
+}
+
+export interface BrevoUpdateFolderRequest {
+    id: number;
+    name: string;
+}
+
+export interface BrevoDeleteFolderRequest {
+    id: number;
+}
+
+/////////////////////////////
+//  TRANSACTIONAL EMAILS
+/////////////////////////////
+
+export interface BrevoEmailRecipient {
+    email: string;
+    name?: string;
+}
+
+export interface BrevoSendEmailRequest {
+    sender: BrevoEmailRecipient & { id?: number };
+    to: BrevoEmailRecipient[];
+    cc?: BrevoEmailRecipient[];
+    bcc?: BrevoEmailRecipient[];
+    replyTo?: BrevoEmailRecipient;
+    subject?: string;
+    htmlContent?: string;
+    textContent?: string;
+    templateId?: number;
+    params?: Record<string, string | number | boolean>;
+    headers?: Record<string, string>;
+    attachment?: {
+        url?: string;
+        content?: string; // Base64 encoded
+        name?: string;
+    }[];
+    tags?: string[];
+}
+
+export interface BrevoSendEmailResponse {
+    messageId: string;
+}
+
+/////////////////////////////
+//  TRANSACTIONAL SMS
+/////////////////////////////
+
+export interface BrevoSendSmsRequest {
+    sender: string; // must be alphanumeric and <= 11 chars
+    recipient: string;
+    content: string;
+    type?: "transactional" | "marketing";
+    tag?: string;
+    webUrl?: string;
+}
+
+export interface BrevoSendSmsResponse {
+    messageId: string;
+    reference?: string;
+}
+
+/////////////////////////////
+//  SMTP / EMAIL EVENT WEBHOOKS
+/////////////////////////////
+
+export interface BrevoEmailWebhookEvent {
+    event: "delivered" | "opened" | "clicked" | "hardBounce" | "softBounce" | "spam" | "invalidEmail" | "deferred" | "blocked" | "unsubscribed" | "error";
+    email: string;
+    id: string;
+    date: string;
+    subject?: string;
+    tag?: string;
+    messageId?: string;
+    reason?: string;
+    sendingIp?: string;
+    ts?: number;
+    ts_event?: number;
+}
+
+/////////////////////////////
+//  MARKETING CAMPAIGNS (optional)
+/////////////////////////////
+
+export interface BrevoCampaign {
+    id: number;
+    name: string;
+    subject: string;
+    sender: {
+        name: string;
+        email: string;
+    };
+    type: "classic" | "trigger";
+    status: "draft" | "sent" | "archive" | "queued" | "suspended" | "inProcess";
+    statistics?: {
+        delivered?: number;
+        opened?: number;
+        click?: number;
+    };
+    createdAt?: string;
+    modifiedAt?: string;
+}
+
+/////////////////////////////
+//  ERROR HANDLING
+/////////////////////////////
+
+export interface BrevoApiError {
+    code?: string | number;
+    message: string;
+    status?: number;
+    details?: any;
+}
+
+/////////////////////////////
+//  GENERIC UTILS
+/////////////////////////////
+
+export type BrevoApiResponse<T> = {
+    data?: T;
+    error?: BrevoApiError;
+    status: number;
+};
+

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export * from "./brevo-client";
+export type * from "./brevo";
+//# 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,cAAc,gBAAgB,CAAC;AAC/B,mBAAmB,SAAS,CAAC"}

package/dist/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./brevo-client"), exports);

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "@tozielinski/next-brevo-api-helper",
+  "version": "1.0.0",
+  "description": "Lightweight helper to use Brevo to send mails via the Brevo API and maintain all",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsc && cp src/brevo.d.ts dist/",
+    "test": "vitest run",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build"
+  },
+  "files": [
+    "dist"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tozielinski/next-brevo-api-helper.git"
+  },
+  "keywords": [
+    "next",
+    "nextjs",
+    "brevo",
+    "api",
+    "mail"
+  ],
+  "author": "Torsten Zielinski",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/tozielinski/next-brevo-api-helper/issues"
+  },
+  "homepage": "https://github.com/tozielinski/next-brevo-api-helper#readme",
+  "devDependencies": {
+    "@types/node": "^20.19.25",
+    "typescript": "^5.0.0",
+    "vitest": "^4.0.12"
+  }
+}