@signalhousellc/sdk 1.4.1 → 1.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@signalhousellc/sdk",
-  "version": "1.4.1",
+  "version": "1.4.2",
   "description": "Signal House SDK for use with the Signal House platform",
   "type": "module",
   "main": "src/SignalHouseSDK.js",

package/src/SignalHouseSDK.js

@@ -1,5 +1,9 @@
 import axios from "axios";
 
+// Bounds every request made by this SDK. Chosen well above typical p99 latency so it only trips on
+// a genuinely hung connection, not a slow-but-completing request.
+const REQUEST_TIMEOUT_MS = 30000;
+
 /**
  * @typedef {Object} RequestOptions
  * @property {string} [token] - An optional bearer token to include in the request for authentication
@@ -100,8 +104,10 @@ export class SignalHouseSDK {
 	 * @returns {Function} A function to make API requests
 	 */
 	_createClient(isMultipart = false) {
-		// Create an Axios instance with the base URL and default headers
-		const instance = axios.create({ baseURL: this.baseUrl, headers: isMultipart ? {} : { "Content-Type": "application/json" } });
+		// Create an Axios instance with the base URL and default headers. `timeout` bounds every
+		// request so a hung connection (server-side lock contention, a stalled upstream call) rejects
+		// instead of leaving the caller's promise unsettled forever with no error and no feedback.
+		const instance = axios.create({ baseURL: this.baseUrl, timeout: REQUEST_TIMEOUT_MS, headers: isMultipart ? {} : { "Content-Type": "application/json" } });
 
 		// Add a request interceptor to include the API key in the Authorization header
 		instance.interceptors.request.use((/** @type {import('axios').InternalAxiosRequestConfig & { token?: string, idempotencyKey?: string }} */ config) => {
@@ -122,8 +128,17 @@ export class SignalHouseSDK {
 				return { success: true, data: response.data, status: response.status };
 			}),
 
-			// Non-2xx responses
+			// Non-2xx responses, plus timeouts and network failures (no `error.response` at all) - those
+			// get a clear message here rather than surfacing axios's internal error.message verbatim.
 			(error) => {
+				if (!error.response) {
+					const isTimeout = error.code === "ECONNABORTED" || /timeout/i.test(error.message || "");
+					return {
+						success: false,
+						error: isTimeout ? "Request timed out. Please try again." : "Network error. Please check your connection and try again.",
+						status: null,
+					};
+				}
 				return {
 					success: false,
 					error: error.response?.data?.message || error.response?.data || error.message || 500,

package/src/domains/Campaigns.js

@@ -36,6 +36,7 @@
  * @property {string} privacyPolicyLink - A URL linking to the privacy policy for the campaign (required, must be at most 2048 characters)
  * @property {string} termsAndConditionsLink - A URL linking to the terms and conditions for the campaign (required, must be at most 2048 characters)
  * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters)
+ * @property {string[]} [sampleMediaIds] - Up to 5 mediaIds from uploadSampleMedia: sample MMS media shown to carrier and TCR reviewers (10DLC only)
  * @property {Array<string>} phoneNumbers - An array of phone numbers associated with the campaign (required, each number must be at least 10 digits and contain only digits, a maximum of 5000 numbers is allowed)
  */
 
@@ -70,6 +71,7 @@
  * @property {string} [privacyPolicyLink] - A URL linking to the privacy policy for the campaign (optional, must be at most 2048 characters if provided)
  * @property {string} [termsAndConditionsLink] - A URL linking to the terms and conditions for the campaign (optional, must be at most 2048 characters if provided)
  * @property {string} [embeddedLinkSample] - A sample of the embedded link used in the campaign (optional, must be at most 255 characters if provided)
+ * @property {string[]} [sampleMediaIds] - Up to 5 mediaIds from uploadSampleMedia: sample MMS media shown to carrier and TCR reviewers (10DLC only)
  * @property {Object} [tollFree] - Toll-Free editable fields, used when updating a Toll-Free campaign. Mirrors the CreateTollFreeCampaignData `tollFree` object with every field optional (useCase, messageVolume, programSummary (40-500), exampleMessage (≤1000), customerCareEmail, optInImageURLs, optIns, multiNumberReason (≤500), useCases, channels, landingId). Phone numbers cannot be changed via update — Toll-Free numbers are locked to their campaign.
  */
 
@@ -529,6 +531,43 @@ export class Campaigns {
     return this.client(`/campaign/short-code/artifact/${safeArtifactId}`, { method: 'GET', ...options });
   }
 
+  /**
+   * Upload a sample media file (JPEG, PNG, GIF, MP4 or MP3, up to 5MB) for a 10DLC campaign. Reference the
+   * returned mediaId in sampleMediaIds on campaign create or update; it is attached to the TCR campaign for
+   * carrier review
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for uploading the sample media
+   * @param {Blob|File} params.file - The media file to upload, provided as a Blob/File
+   * @param {string} [params.groupId] - The group the file belongs to. Required with a staff (signalhouse_*) key, which has no active group; otherwise optional and must be your own group
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the file parameter is missing
+   * @returns {Promise<SdkResponse<any>>} The response from the server containing the mediaId, fileName, mimeType and size
+   */
+  async uploadSampleMedia({ file, groupId, options = {} }) {
+    this.client._require({ file });
+    const formData = new FormData();
+    if (groupId) formData.append('groupId', groupId);
+    formData.append('file', file);
+    return this.multipartClient(`/campaign/sample-media`, { method: 'POST', body: formData, ...options });
+  }
+
+  /**
+   * Download a campaign sample media file your group owns
+   * @async
+   * @roles api, admin, developer, user
+   * @param {Object} params - The parameters for downloading the sample media
+   * @param {string} params.mediaId - The mediaId returned by uploadSampleMedia
+   * @param {RequestOptions} [params.options] - Additional options for the request
+   * @throws {Error} Throws an error if the mediaId parameter is missing
+   * @returns {Promise<SdkResponse<any>>} The response from the server containing the file bytes
+   */
+  async readSampleMedia({ mediaId, options = {} }) {
+    this.client._require({ mediaId });
+    const safeMediaId = encodeURIComponent(mediaId);
+    return this.client(`/campaign/sample-media/${safeMediaId}`, { method: 'GET', ...options });
+  }
+
   /**
    * Upload an opt-in proof image to be hosted on-platform, returning a publicly-fetchable URL suitable for a
    * Toll-Free campaign's optInImageURLs or a Short Code campaign's shortCode.screenshotUrl