@bentonow/bento-node-sdk 1.0.4 → 1.0.6

package/dist/index.js

@@ -626,7 +626,7 @@ class BentoBatch {
     }
     const result = await this._client.post(`${this._url}/subscribers`, {
       subscribers: parameters.subscribers
-    });
+    }, { timeout: null });
     return result.results;
   }
   async importEvents(parameters) {
@@ -638,7 +638,7 @@ class BentoBatch {
     }
     const result = await this._client.post(`${this._url}/events`, {
       events: parameters.events
-    });
+    }, { timeout: null });
     return result.results;
   }
   async sendTransactionalEmails(parameters) {
@@ -679,6 +679,13 @@ class AuthorNotAuthorizedError extends Error {
   }
 }
 
+class RequestTimeoutError extends Error {
+  constructor(message = "Request timed out") {
+    super(message);
+    this.name = "RequestTimeoutError";
+  }
+}
+
 // src/sdk/client/index.ts
 function encodeBase64(str) {
   if (typeof btoa === "function") {
@@ -704,61 +711,83 @@ class BentoClient {
   _baseUrl = "https://app.bentonow.com/api/v1";
   _siteUuid = "";
   _logErrors = false;
+  _timeout = 30000;
   constructor(options) {
     this._baseUrl = options.clientOptions?.baseUrl || this._baseUrl;
     this._siteUuid = options.siteUuid;
     this._headers = this._extractHeaders(options.authentication, options.siteUuid);
     this._logErrors = options.logErrors || false;
+    this._timeout = options.clientOptions?.timeout ?? this._timeout;
+  }
+  async get(endpoint, payload = {}, requestOptions = {}) {
+    const queryParameters = this._getQueryParameters(payload);
+    const url = `${this._baseUrl}${endpoint}?${queryParameters}`;
+    const timeoutMs = requestOptions.timeout === undefined ? this._timeout : requestOptions.timeout;
+    const response = await this._fetchWithTimeout(url, {
+      method: "GET",
+      headers: this._headers
+    }, timeoutMs);
+    return this._handleResponse(response);
+  }
+  async post(endpoint, payload = {}, requestOptions = {}) {
+    const body = this._getBody(payload);
+    const url = `${this._baseUrl}${endpoint}`;
+    const timeoutMs = requestOptions.timeout === undefined ? this._timeout : requestOptions.timeout;
+    const response = await this._fetchWithTimeout(url, {
+      method: "POST",
+      headers: {
+        ...this._headers,
+        "Content-Type": "application/json"
+      },
+      body
+    }, timeoutMs);
+    return this._handleResponse(response);
+  }
+  async patch(endpoint, payload = {}, requestOptions = {}) {
+    const body = this._getBody(payload);
+    const url = `${this._baseUrl}${endpoint}`;
+    const timeoutMs = requestOptions.timeout === undefined ? this._timeout : requestOptions.timeout;
+    const response = await this._fetchWithTimeout(url, {
+      method: "PATCH",
+      headers: {
+        ...this._headers,
+        "Content-Type": "application/json"
+      },
+      body
+    }, timeoutMs);
+    return this._handleResponse(response);
+  }
+  async _fetchWithTimeout(url, options, timeout) {
+    if (timeout === null) {
+      return import_cross_fetch.default(url, options);
+    }
+    const controller = new AbortController;
+    const timeoutId = setTimeout(() => controller.abort(), timeout);
+    try {
+      const response = await import_cross_fetch.default(url, {
+        ...options,
+        signal: controller.signal
+      });
+      return response;
+    } catch (error) {
+      if (error instanceof Error && error.name === "AbortError") {
+        throw new RequestTimeoutError(`Request timed out after ${timeout}ms`);
+      }
+      throw error;
+    } finally {
+      clearTimeout(timeoutId);
+    }
   }
-  get(endpoint, payload = {}) {
-    return new Promise((resolve, reject) => {
-      const queryParameters = this._getQueryParameters(payload);
-      import_cross_fetch.default(`${this._baseUrl}${endpoint}?${queryParameters}`, {
-        method: "GET",
-        headers: this._headers
-      }).then(async (result) => {
-        if (this._isSuccessfulStatus(result.status)) {
-          return result.json();
-        }
-        throw await this._getErrorForResponse(result);
-      }).then((data) => resolve(data)).catch((error) => reject(error));
-    });
-  }
-  post(endpoint, payload = {}) {
-    return new Promise((resolve, reject) => {
-      const body = this._getBody(payload);
-      import_cross_fetch.default(`${this._baseUrl}${endpoint}`, {
-        method: "POST",
-        headers: {
-          ...this._headers,
-          "Content-Type": "application/json"
-        },
-        body
-      }).then(async (result) => {
-        if (this._isSuccessfulStatus(result.status)) {
-          return result.json();
-        }
-        throw await this._getErrorForResponse(result);
-      }).then((data) => resolve(data)).catch((error) => reject(error));
-    });
-  }
-  patch(endpoint, payload = {}) {
-    return new Promise((resolve, reject) => {
-      const body = this._getBody(payload);
-      import_cross_fetch.default(`${this._baseUrl}${endpoint}`, {
-        method: "PATCH",
-        headers: {
-          ...this._headers,
-          "Content-Type": "application/json"
-        },
-        body
-      }).then(async (result) => {
-        if (this._isSuccessfulStatus(result.status)) {
-          return result.json();
-        }
-        throw await this._getErrorForResponse(result);
-      }).then((data) => resolve(data)).catch((error) => reject(error));
-    });
+  async _handleResponse(response) {
+    if (this._isSuccessfulStatus(response.status)) {
+      try {
+        const data = await response.json();
+        return data;
+      } catch {
+        throw new Error(`[${response.status}] - Invalid JSON response from server`);
+      }
+    }
+    throw await this._getErrorForResponse(response);
   }
   _extractHeaders(authentication, siteUuid) {
     const authenticationKey = encodeBase64(`${authentication.publishableKey}:${authentication.secretKey}`);
@@ -780,7 +809,7 @@ class BentoClient {
     };
     const queryParameters = new URLSearchParams;
     for (const [key, value] of Object.entries(body)) {
-      queryParameters.append(key, value);
+      queryParameters.append(key, String(value));
     }
     return queryParameters.toString();
   }
@@ -1034,6 +1063,14 @@ class BentoSequences {
   }
   async getSequences() {
     const result = await this._client.get(this._url);
+    if (!result || Object.keys(result).length === 0)
+      return [];
+    return result.data ?? [];
+  }
+  async createSequenceEmail(sequenceId, parameters) {
+    const result = await this._client.post(`${this._url}/${sequenceId}/emails/templates`, {
+      email_template: parameters
+    });
     if (Object.keys(result).length === 0 || !result.data)
       return null;
     return result.data;
@@ -1092,16 +1129,17 @@ class BentoWorkflows {
   }
   async getWorkflows() {
     const result = await this._client.get(this._url);
-    if (Object.keys(result).length === 0 || !result.data)
-      return null;
-    return result.data;
+    if (!result || Object.keys(result).length === 0)
+      return [];
+    return result.data ?? [];
   }
 }
 // src/sdk/broadcasts/index.ts
 class BentoBroadcasts {
   _client;
-  _url = "/broadcasts";
-  _emailsUrl = "/emails";
+  _fetchUrl = "/fetch/broadcasts";
+  _batchUrl = "/batch/broadcasts";
+  _emailsUrl = "/batch/emails";
   constructor(_client) {
     this._client = _client;
   }
@@ -1112,11 +1150,11 @@ class BentoBroadcasts {
     return result.results;
   }
   async getBroadcasts() {
-    const result = await this._client.get(this._url);
+    const result = await this._client.get(this._fetchUrl);
     return result.data ?? [];
   }
   async createBroadcast(broadcasts) {
-    const result = await this._client.post(this._url, {
+    const result = await this._client.post(this._batchUrl, {
       broadcasts
     });
     return result.data ?? [];
@@ -1248,12 +1286,14 @@ class BentoAPIV1 {
   }
   async upsertSubscriber(parameters) {
     await this.Batch.importSubscribers({
-      subscribers: [{
-        email: parameters.email,
-        ...parameters.fields,
-        ...parameters.tags && { tags: parameters.tags },
-        ...parameters.remove_tags && { remove_tags: parameters.remove_tags }
-      }]
+      subscribers: [
+        {
+          email: parameters.email,
+          ...parameters.fields,
+          ...parameters.tags && { tags: parameters.tags },
+          ...parameters.remove_tags && { remove_tags: parameters.remove_tags }
+        }
+      ]
     });
     return this.Subscribers.getSubscribers({
       email: parameters.email
@@ -1269,6 +1309,7 @@ class Analytics {
   }
 }
 export {
+  RequestTimeoutError,
   RateLimitedError,
   NotAuthorizedError,
   AuthorNotAuthorizedError,

package/dist/sdk/batch/index.d.ts

@@ -44,7 +44,7 @@ export declare class BentoBatch<S, E extends string> {
      * Each email must have a `to` address, a `from` address, a `subject`, an `html_body`
      * and `transactional: true`.
      * In addition you can add a `personalizations` object to provide
-     * liquid tsags that will be injected into the email.
+     * liquid tags that will be injected into the email.
      *
      * Returns the number of events that were imported.
      *

package/dist/sdk/broadcasts/index.d.ts

@@ -2,7 +2,8 @@ import type { BentoClient } from '../client';
 import type { Broadcast, CreateBroadcastInput, EmailData } from './types';
 export declare class BentoBroadcasts {
     private readonly _client;
-    private readonly _url;
+    private readonly _fetchUrl;
+    private readonly _batchUrl;
     private readonly _emailsUrl;
     constructor(_client: BentoClient);
     /**

package/dist/sdk/broadcasts/types.d.ts

@@ -18,6 +18,10 @@ export type BroadcastAttributes = {
 };
 export type Broadcast = BaseEntity<BroadcastAttributes>;
 export type CreateBroadcastInput = Omit<BroadcastAttributes, 'created_at'>;
+/**
+ * Email data for transactional emails.
+ * Note: This is the same structure as TransactionalEmail in batch/types.ts
+ */
 export type EmailData = {
     to: string;
     from: string;

package/dist/sdk/client/errors.d.ts

@@ -7,3 +7,6 @@ export declare class RateLimitedError extends Error {
 export declare class AuthorNotAuthorizedError extends Error {
     constructor(message?: string);
 }
+export declare class RequestTimeoutError extends Error {
+    constructor(message?: string);
+}

package/dist/sdk/client/index.d.ts

@@ -1,9 +1,13 @@
 import type { AnalyticsOptions } from '../interfaces';
+interface RequestOptions {
+    timeout?: number | null;
+}
 export declare class BentoClient {
     private readonly _headers;
     private readonly _baseUrl;
     private readonly _siteUuid;
     private readonly _logErrors;
+    private readonly _timeout;
     constructor(options: AnalyticsOptions);
     /**
      * Wraps a GET request to the Bento API and automatically adds the required
@@ -13,7 +17,7 @@ export declare class BentoClient {
      * @param payload object
      * @returns Promise\<T\>
      * */
-    get<T>(endpoint: string, payload?: Record<string, unknown>): Promise<T>;
+    get<T>(endpoint: string, payload?: Record<string, unknown>, requestOptions?: RequestOptions): Promise<T>;
     /**
      * Wraps a POST request to the Bento API and automatically adds the required
      * headers.
@@ -22,7 +26,7 @@ export declare class BentoClient {
      * @param payload object
      * @returns Promise\<T\>
      * */
-    post<T>(endpoint: string, payload?: Record<string, unknown>): Promise<T>;
+    post<T>(endpoint: string, payload?: Record<string, unknown>, requestOptions?: RequestOptions): Promise<T>;
     /**
      * Wraps a PATCH request to the Bento API and automatically adds the required
      * headers.
@@ -31,7 +35,22 @@ export declare class BentoClient {
      * @param payload object
      * @returns Promise\<T\>
      * */
-    patch<T>(endpoint: string, payload?: Record<string, unknown>): Promise<T>;
+    patch<T>(endpoint: string, payload?: Record<string, unknown>, requestOptions?: RequestOptions): Promise<T>;
+    /**
+     * Performs a fetch request with a configurable timeout.
+     *
+     * @param url The URL to fetch
+     * @param options Fetch options
+     * @returns Promise<Response>
+     */
+    private _fetchWithTimeout;
+    /**
+     * Handles the response from a fetch request, parsing JSON or throwing appropriate errors.
+     *
+     * @param response The fetch Response object
+     * @returns Promise<T> The parsed response data
+     */
+    private _handleResponse;
     /**
      * Extracts the `publishableKey` and `secretKey` from the `authentication` options,
      * adds the `Authorization` header, and includes a `User-Agent` header with the site UUID.
@@ -72,3 +91,4 @@ export declare class BentoClient {
      */
     private _getErrorForResponse;
 }
+export {};

package/dist/sdk/interfaces.d.ts

@@ -10,4 +10,8 @@ export interface AuthenticationOptions {
 }
 export interface ClientOptions {
     baseUrl?: string;
+    /**
+     * Request timeout in milliseconds. Defaults to 30000 (30 seconds).
+     */
+    timeout?: number;
 }

package/dist/sdk/sequences/index.d.ts

@@ -1,5 +1,6 @@
 import type { BentoClient } from '../client';
-import type { Sequence } from './types';
+import type { EmailTemplate } from '../email-templates/types';
+import type { CreateSequenceEmailParameters, Sequence } from './types';
 export declare class BentoSequences {
     private readonly _client;
     private readonly _url;
@@ -7,7 +8,15 @@ export declare class BentoSequences {
     /**
      * Returns all of the sequences for the site, including their email templates.
      *
-     * @returns Promise\<Sequence[] | null\>
+     * @returns Promise\<Sequence[]\>
      */
-    getSequences(): Promise<Sequence[] | null>;
+    getSequences(): Promise<Sequence[]>;
+    /**
+     * Creates a new email template inside a sequence.
+     *
+     * @param sequenceId string
+     * @param parameters CreateSequenceEmailParameters
+     * @returns Promise\<EmailTemplate | null\>
+     */
+    createSequenceEmail(sequenceId: string, parameters: CreateSequenceEmailParameters): Promise<EmailTemplate | null>;
 }

package/dist/sdk/sequences/types.d.ts

@@ -1,4 +1,5 @@
 import type { BaseEntity } from '../types';
+import type { EmailTemplate } from '../email-templates/types';
 /**
  * Embedded Email Template in Sequence
  */
@@ -16,3 +17,16 @@ export type SequenceAttributes = {
     email_templates: SequenceEmailTemplate[];
 };
 export type Sequence = BaseEntity<SequenceAttributes>;
+export type SequenceDelayInterval = 'minutes' | 'hours' | 'days' | 'months';
+export type CreateSequenceEmailParameters = {
+    subject: string;
+    html: string;
+    inbox_snippet?: string;
+    delay_interval?: SequenceDelayInterval;
+    delay_interval_count?: number;
+    editor_choice?: string;
+    cc?: string;
+    bcc?: string;
+    to?: string;
+};
+export type CreateSequenceEmailResponse = EmailTemplate | null;

package/dist/sdk/workflows/index.d.ts

@@ -7,7 +7,7 @@ export declare class BentoWorkflows {
     /**
      * Returns all of the workflows for the site, including their email templates.
      *
-     * @returns Promise\<Workflow[] | null\>
+     * @returns Promise\<Workflow[]\>
      */
-    getWorkflows(): Promise<Workflow[] | null>;
+    getWorkflows(): Promise<Workflow[]>;
 }

package/dist/versions/v1/index.d.ts

@@ -3,7 +3,7 @@ import type { AnalyticsOptions } from '../../sdk/interfaces';
 import type { AddSubscriberParameters, RemoveSubscriberParameters, TagSubscriberParameters, TrackParameters, TrackPurchaseParameters, UpdateFieldsParameters } from './types';
 import { BentoBroadcasts } from '../../sdk/broadcasts';
 import { BentoStats } from '../../sdk/stats';
-import { Subscriber } from '../../sdk/subscribers/types';
+import type { Subscriber } from '../../sdk/subscribers/types';
 export declare class BentoAPIV1<S = {
     [key: string]: unknown;
 }, E extends string = '$custom'> {
@@ -141,9 +141,13 @@ export declare class BentoAPIV1<S = {
      * Upserts a subscriber in Bento. If the subscriber exists, their data will be updated.
      * If they don't exist, they will be created with the provided data.
      *
+     * This method still relies on the batch import queue (which can take 1-5 minutes to
+     * finish processing), but it automatically attempts to fetch and return the subscriber
+     * record after the import has been queued.
+     *
      * @example
      * ```typescript
-     * await analytics.V1.upsertSubscriber({
+     * const subscriber = await analytics.V1.upsertSubscriber({
      *   email: 'user@example.com',
      *   fields: {
      *     firstName: 'John',
@@ -155,7 +159,7 @@ export declare class BentoAPIV1<S = {
      * ```
      *
      * @param parameters Object containing subscriber data including email, fields, and tags
-     * @returns Promise<Subscriber<S>> The created or updated subscriber
+     * @returns Promise<Subscriber<S> | null> The created or updated subscriber
      */
     upsertSubscriber(parameters: Omit<AddSubscriberParameters<S>, 'date'> & {
         tags?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bentonow/bento-node-sdk",
-  "version": "1.0.4",
+  "version": "1.0.6",
   "description": "🍱 Bento Node.JS SDK and tracking library",
   "author": "Backpack Internet",
   "license": "MIT",
@@ -34,14 +34,17 @@
   "homepage": "https://bentonow.com",
   "devDependencies": {
     "@size-limit/preset-small-lib": "^11.1.5",
+    "@types/jest": "^30.0.0",
     "@types/node": "^22.10.5",
     "@typescript-eslint/eslint-plugin": "^8.19.1",
     "@typescript-eslint/parser": "^8.24.0",
     "bun-types": "latest",
     "eslint": "^9.20.1",
+    "jest": "^30.2.0",
     "prettier": "^3.4.2",
     "size-limit": "^11.1.6",
-    "typescript": "^5.7.2"
+    "ts-jest": "^29.4.6",
+    "typescript": "^5.7.3"
   },
   "dependencies": {
     "cross-fetch": "^4.1.0"

package/src/sdk/batch/index.ts

@@ -54,7 +54,8 @@ export class BentoBatch<S, E extends string> {
       `${this._url}/subscribers`,
       {
         subscribers: parameters.subscribers,
-      }
+      },
+      { timeout: null }
     );
 
     return result.results;
@@ -80,9 +81,13 @@ export class BentoBatch<S, E extends string> {
       throw new TooManyEventsError(`You must send between 1 and 1,000 events.`);
     }
 
-    const result = await this._client.post<BatchImportEventsResponse>(`${this._url}/events`, {
-      events: parameters.events,
-    });
+    const result = await this._client.post<BatchImportEventsResponse>(
+      `${this._url}/events`,
+      {
+        events: parameters.events,
+      },
+      { timeout: null }
+    );
 
     return result.results;
   }
@@ -94,7 +99,7 @@ export class BentoBatch<S, E extends string> {
    * Each email must have a `to` address, a `from` address, a `subject`, an `html_body`
    * and `transactional: true`.
    * In addition you can add a `personalizations` object to provide
-   * liquid tsags that will be injected into the email.
+   * liquid tags that will be injected into the email.
    *
    * Returns the number of events that were imported.
    *

package/src/sdk/broadcasts/index.ts

@@ -3,8 +3,9 @@ import type { DataResponse } from '../client/types';
 import type { Broadcast, CreateBroadcastInput, EmailData } from './types';
 
 export class BentoBroadcasts {
-  private readonly _url = '/broadcasts';
-  private readonly _emailsUrl = '/emails';
+  private readonly _fetchUrl = '/fetch/broadcasts';
+  private readonly _batchUrl = '/batch/broadcasts';
+  private readonly _emailsUrl = '/batch/emails';
 
   constructor(private readonly _client: BentoClient) {}
 
@@ -15,7 +16,7 @@ export class BentoBroadcasts {
    */
   public async createEmails(emails: EmailData[]): Promise<number> {
     const result = await this._client.post<{ results: number }>(this._emailsUrl, {
-      emails
+      emails,
     });
     return result.results;
   }
@@ -25,7 +26,7 @@ export class BentoBroadcasts {
    * @returns Promise<Broadcast[]>
    */
   public async getBroadcasts(): Promise<Broadcast[]> {
-    const result = await this._client.get<DataResponse<Broadcast[]>>(this._url);
+    const result = await this._client.get<DataResponse<Broadcast[]>>(this._fetchUrl);
     return result.data ?? [];
   }
 
@@ -35,9 +36,9 @@ export class BentoBroadcasts {
    * @returns Promise<Broadcast[]>
    */
   public async createBroadcast(broadcasts: CreateBroadcastInput[]): Promise<Broadcast[]> {
-    const result = await this._client.post<DataResponse<Broadcast[]>>(this._url, {
-      broadcasts
+    const result = await this._client.post<DataResponse<Broadcast[]>>(this._batchUrl, {
+      broadcasts,
     });
     return result.data ?? [];
   }
-}
+}

package/src/sdk/broadcasts/types.ts

@@ -24,6 +24,10 @@ export type Broadcast = BaseEntity<BroadcastAttributes>;
 
 export type CreateBroadcastInput = Omit<BroadcastAttributes, 'created_at'>;
 
+/**
+ * Email data for transactional emails.
+ * Note: This is the same structure as TransactionalEmail in batch/types.ts
+ */
 export type EmailData = {
   to: string;
   from: string;
@@ -31,4 +35,4 @@ export type EmailData = {
   html_body: string;
   transactional: boolean;
   personalizations?: Record<string, string | number | boolean>;
-};
+};

package/src/sdk/client/errors.ts

@@ -18,3 +18,10 @@ export class AuthorNotAuthorizedError extends Error {
     this.name = 'AuthorNotAuthorizedError';
   }
 }
+
+export class RequestTimeoutError extends Error {
+  constructor(message = 'Request timed out') {
+    super(message);
+    this.name = 'RequestTimeoutError';
+  }
+}