@textbee/sdk 0.1.0 → 0.3.0

package/dist/index.js

@@ -14,7 +14,7 @@ var TextbeeError = class extends Error {
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://api.textbee.dev/api/v1";
-var CLIENT_ID = `textbee-js/${"0.1.0"}`;
+var CLIENT_ID = `textbee-js/${"0.3.0"}`;
 var Textbee = class {
   #apiKey;
   #baseUrl;
@@ -23,7 +23,7 @@ var Textbee = class {
       throw new TypeError("Textbee requires an apiKey");
     }
     this.#apiKey = options.apiKey;
-    this.#baseUrl = (options.baseUrl || DEFAULT_BASE_URL).replace(/\/+$/, "");
+    this.#baseUrl = normalizeBaseUrl(options.baseUrl);
   }
   /** Send an SMS to one or more recipients. */
   async sendSms(request) {
@@ -94,9 +94,10 @@ var Textbee = class {
   }
   /**
    * Iterate every message matching the filters, following the pagination
-   * cursor until the end. Use `order: 'asc'` with a `from` bound to drain
-   * forward when polling; keep the last message's `createdAt` (or track
-   * `meta.nextCursor` via `getMessages`) to resume the next poll.
+   * cursor until the end. `limit` is the page size, not a cap on the total.
+   * Use `order: 'asc'` with a `from` bound to drain forward when polling.
+   * `from` is inclusive, so a poll that resumes from the last `createdAt` sees
+   * that message again; skip ids you have already handled.
    *
    * ```ts
    * for await (const message of textbee.iterateMessages({ direction: 'received' })) {
@@ -120,7 +121,11 @@ var Textbee = class {
     );
     return payload.data;
   }
-  /** Fetch a batch and every message in it. Pair this with `smsBatchId` from a send. */
+  /**
+   * Fetch a batch and every message in it, by the `smsBatchId` a send returns.
+   * Needs the id of the device that sent the batch. When textbee picked the
+   * device, use `getMessages({ smsBatchId })` instead.
+   */
   async getSmsBatch(deviceId, smsBatchId) {
     const payload = await this.#request(
       "GET",
@@ -156,6 +161,44 @@ var Textbee = class {
     return payload;
   }
 };
+function normalizeBaseUrl(raw) {
+  const value = raw?.trim();
+  if (!value) {
+    return DEFAULT_BASE_URL;
+  }
+  const withScheme = /^[a-z][a-z0-9+.-]*:\/\//i.test(value) ? value : `https://${value}`;
+  let url;
+  try {
+    url = new URL(withScheme);
+  } catch {
+    throw new TypeError(
+      "baseUrl is not a valid URL. Use your textbee api, for example https://sms.example.com. The /api/v1 suffix is added for you."
+    );
+  }
+  if (url.protocol !== "https:" && url.protocol !== "http:") {
+    throw new TypeError(`baseUrl must be http or https, got "${url.protocol}"`);
+  }
+  if (url.username || url.password) {
+    throw new TypeError("baseUrl must not contain a username or password");
+  }
+  const segments = url.pathname.split("/").filter(Boolean);
+  let cut = -1;
+  for (let i = segments.length - 2; i >= 0; i--) {
+    if (segments[i].toLowerCase() === "api" && segments[i + 1].toLowerCase() === "v1") {
+      cut = i + 2;
+      break;
+    }
+  }
+  let path;
+  if (segments.length === 0) {
+    path = ["api", "v1"];
+  } else if (cut === -1) {
+    path = segments;
+  } else {
+    path = [...segments.slice(0, cut - 2), "api", "v1"];
+  }
+  return [url.origin, ...path].join("/");
+}
 function toIsoString(value) {
   return value instanceof Date ? value.toISOString() : value;
 }
@@ -173,16 +216,240 @@ async function readBody(response) {
 function errorMessage(payload, status) {
   if (payload && typeof payload === "object") {
     const record = payload;
-    if (typeof record.error === "string" && record.error) {
-      return record.error;
-    }
-    if (typeof record.message === "string" && record.message) {
-      return record.message;
+    const keys = "statusCode" in record ? ["message", "error"] : ["error", "message"];
+    for (const key of keys) {
+      const value = record[key];
+      if (typeof value === "string" && value) {
+        return value;
+      }
+      if (Array.isArray(value) && value.length > 0 && value.every((item) => typeof item === "string")) {
+        return value.join("; ");
+      }
     }
   }
   return `HTTP ${status}`;
 }
 
+// src/sms-utils.ts
+var GSM7_BASE = `@\xA3$\xA5\xE8\xE9\xF9\xEC\xF2\xC7
+\xD8\xF8\r\xC5\xE5\u0394_\u03A6\u0393\u039B\u03A9\u03A0\u03A8\u03A3\u0398\u039E\xC6\xE6\xDF\xC9 !"#\xA4%&'()*+,-./0123456789:;<=>?\xA1ABCDEFGHIJKLMNOPQRSTUVWXYZ\xC4\xD6\xD1\xDC\xA7\xBFabcdefghijklmnopqrstuvwxyz\xE4\xF6\xF1\xFC\xE0`;
+var GSM7_EXTENSION = "\f^{}\\[~]|\u20AC";
+var GSM7_BASE_SET = new Set(GSM7_BASE);
+var GSM7_EXTENSION_SET = new Set(GSM7_EXTENSION);
+var GSM7_SINGLE_SEGMENT_LIMIT = 160;
+var GSM7_CONCATENATED_SEGMENT_LIMIT = 153;
+var UCS2_SINGLE_SEGMENT_LIMIT = 70;
+var UCS2_CONCATENATED_SEGMENT_LIMIT = 67;
+function gsm7Cost(char) {
+  if (GSM7_BASE_SET.has(char)) {
+    return 1;
+  }
+  if (GSM7_EXTENSION_SET.has(char)) {
+    return 2;
+  }
+  return void 0;
+}
+function isGsm7Char(char) {
+  return gsm7Cost(char) !== void 0;
+}
+function getSmsEncoding(message) {
+  for (const char of message) {
+    if (!isGsm7Char(char)) {
+      return "ucs-2";
+    }
+  }
+  return "gsm-7";
+}
+function countSmsSegments(message) {
+  const encoding = getSmsEncoding(message);
+  const costs = characterCosts(message, encoding);
+  const length = costs.reduce((total, cost) => total + cost, 0);
+  if (length === 0) {
+    return {
+      encoding,
+      length: 0,
+      segments: 0,
+      remainingInSegment: encoding === "gsm-7" ? GSM7_SINGLE_SEGMENT_LIMIT : UCS2_SINGLE_SEGMENT_LIMIT
+    };
+  }
+  const singleLimit = encoding === "gsm-7" ? GSM7_SINGLE_SEGMENT_LIMIT : UCS2_SINGLE_SEGMENT_LIMIT;
+  if (length <= singleLimit) {
+    return {
+      encoding,
+      length,
+      segments: 1,
+      remainingInSegment: singleLimit - length
+    };
+  }
+  const concatenatedLimit = encoding === "gsm-7" ? GSM7_CONCATENATED_SEGMENT_LIMIT : UCS2_CONCATENATED_SEGMENT_LIMIT;
+  let segments = 1;
+  let usedInSegment = 0;
+  for (const cost of costs) {
+    if (usedInSegment + cost > concatenatedLimit) {
+      segments += 1;
+      usedInSegment = cost;
+    } else {
+      usedInSegment += cost;
+    }
+  }
+  return {
+    encoding,
+    length,
+    segments,
+    remainingInSegment: concatenatedLimit - usedInSegment
+  };
+}
+function findNonGsm7Characters(message) {
+  const found = /* @__PURE__ */ new Set();
+  for (const char of message) {
+    if (!isGsm7Char(char)) {
+      found.add(char);
+    }
+  }
+  return Array.from(found);
+}
+function characterCosts(message, encoding) {
+  const costs = [];
+  for (const char of message) {
+    costs.push(encoding === "gsm-7" ? gsm7Cost(char) ?? 1 : char.length);
+  }
+  return costs;
+}
+var GSM7_REPLACEMENTS = {
+  // curly single quotes, prime, acute accent, backtick
+  "\u2018": "'",
+  "\u2019": "'",
+  "\u201A": "'",
+  "\u201B": "'",
+  "\u2032": "'",
+  "\xB4": "'",
+  "`": "'",
+  // curly double quotes, double prime, guillemets
+  "\u201C": '"',
+  "\u201D": '"',
+  "\u201E": '"',
+  "\u201F": '"',
+  "\u2033": '"',
+  "\xAB": '"',
+  "\xBB": '"',
+  // ellipsis
+  "\u2026": "...",
+  // hyphen variants, en dash, em dash, horizontal bar, minus sign
+  "\u2010": "-",
+  "\u2011": "-",
+  "\u2012": "-",
+  "\u2013": "-",
+  "\u2014": "-",
+  "\u2015": "-",
+  "\u2212": "-",
+  // non-breaking and typographic spaces
+  "\xA0": " ",
+  "\u2000": " ",
+  "\u2001": " ",
+  "\u2002": " ",
+  "\u2003": " ",
+  "\u2004": " ",
+  "\u2005": " ",
+  "\u2006": " ",
+  "\u2007": " ",
+  "\u2008": " ",
+  "\u2009": " ",
+  "\u200A": " ",
+  "\u202F": " ",
+  "\u205F": " ",
+  "\u3000": " ",
+  // invisible characters worth dropping outright
+  "\u200B": "",
+  "\uFEFF": "",
+  "\xAD": "",
+  // fraction slash
+  "\u2044": "/"
+};
+var TRANSLITERATION_EXTRAS = {
+  "\u0152": "OE",
+  "\u0153": "oe",
+  "\u0141": "L",
+  "\u0142": "l",
+  "\u0110": "D",
+  "\u0111": "d",
+  "\u0131": "i"
+};
+var COMBINING_MARKS = /[\u0300-\u036F]/g;
+function sanitizeForGsm7(message, options = {}) {
+  const { transliterateAccents = false } = options;
+  let result = "";
+  for (const char of message) {
+    const replacement = GSM7_REPLACEMENTS[char];
+    if (replacement !== void 0) {
+      result += replacement;
+      continue;
+    }
+    if (isGsm7Char(char)) {
+      result += char;
+      continue;
+    }
+    result += transliterateAccents ? transliterate(char) : char;
+  }
+  return result;
+}
+function transliterate(char) {
+  const extra = TRANSLITERATION_EXTRAS[char];
+  if (extra !== void 0) {
+    return extra;
+  }
+  const stripped = char.normalize("NFD").replace(COMBINING_MARKS, "");
+  if (stripped.length === 1 && /[A-Za-z]/.test(stripped)) {
+    return stripped;
+  }
+  return char;
+}
+var E164_PATTERN = /^\+[1-9]\d{1,14}$/;
+var FORMATTING_CHARACTERS = /[\s.\-()]/g;
+var DIGITS_ONLY = /^\d+$/;
+var COUNTRY_CODE_PATTERN = /^[1-9]\d{0,2}$/;
+function isValidE164(input) {
+  return E164_PATTERN.test(input);
+}
+function normalizePhoneNumber(input, options = {}) {
+  const trimmed = input.trim();
+  if (!trimmed) {
+    return null;
+  }
+  const hasPlus = trimmed.startsWith("+");
+  const withoutPlus = hasPlus ? trimmed.slice(1) : trimmed;
+  const digits = withoutPlus.replace(FORMATTING_CHARACTERS, "");
+  if (!DIGITS_ONLY.test(digits)) {
+    return null;
+  }
+  if (hasPlus) {
+    return asE164OrNull(`+${digits}`);
+  }
+  if (digits.startsWith("00")) {
+    return asE164OrNull(`+${digits.slice(2)}`);
+  }
+  const countryCode = normalizeCountryCode(options.defaultCountryCode);
+  if (countryCode === void 0) {
+    return null;
+  }
+  const national = digits.startsWith("0") ? digits.slice(1) : digits;
+  return asE164OrNull(`+${countryCode}${national}`);
+}
+function asE164OrNull(candidate) {
+  return isValidE164(candidate) ? candidate : null;
+}
+function normalizeCountryCode(value) {
+  if (value === void 0) {
+    return void 0;
+  }
+  const code = value.startsWith("+") ? value.slice(1) : value;
+  if (!COUNTRY_CODE_PATTERN.test(code)) {
+    throw new TypeError(
+      `defaultCountryCode must be 1 to 3 digits starting with 1-9, got ${JSON.stringify(value)}`
+    );
+  }
+  return code;
+}
+
 // src/webhooks.ts
 async function verifyWebhookSignature(options) {
   const { payload, signature, signingSecret } = options;
@@ -218,5 +485,11 @@ function constantTimeEqual(a, b) {
 export {
   Textbee,
   TextbeeError,
+  countSmsSegments,
+  findNonGsm7Characters,
+  getSmsEncoding,
+  isValidE164,
+  normalizePhoneNumber,
+  sanitizeForGsm7,
   verifyWebhookSignature
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@textbee/sdk",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Official JavaScript SDK for textbee.dev, the open source SMS gateway",
   "license": "MIT",
   "packageManager": "pnpm@9.14.2",
@@ -44,7 +44,10 @@
     "sms",
     "sms-gateway",
     "textbee",
-    "android"
+    "android",
+    "sms-segments",
+    "gsm-7",
+    "e164"
   ],
   "scripts": {
     "build": "tsup",