@textbee/sdk 0.3.0 → 0.4.0

package/README.md

@@ -8,6 +8,8 @@ Official JavaScript SDK for [textbee.dev](https://textbee.dev), the open source
 
 Zero dependencies, TypeScript types included, works in Node 18+, Bun, Deno, Cloudflare Workers, and Vercel Edge.
 
+Writing Python? Use the official [Python SDK](https://github.com/textbee/textbee-python): `pip install textbee`.
+
 ## Install
 
 ```bash
@@ -229,7 +231,7 @@ new Textbee({ apiKey, baseUrl: 'https://sms.example.com/api/v1' })
 new Textbee({ apiKey, baseUrl: 'http://localhost:3001' })
 ```
 
-If the API sits under a path prefix, give the full path, for example `https://example.com/textbee/api/v1`. Any path other than `/api/v1` is used as given, so a proxy that maps `/sms` onto the API keeps working with `https://example.com/sms`. A value with no scheme gets `https://`. An invalid URL, or one with a username or password, throws a `TypeError` instead of falling back to the hosted API, so a typo never sends your key to textbee.dev.
+If the API sits under a path prefix, give the prefix: `https://example.com/textbee` reaches `https://example.com/textbee/api/v1`. The SDK adds `/api/v1` unless the path already contains it, the same rule the textbee MCP server uses for `TEXTBEE_BASE_URL`. A value with no scheme gets `https://`. An invalid URL, or one with a username or password, throws a `TypeError` instead of falling back to the hosted API, so a typo never sends your key to textbee.dev.
 
 ## What is not covered yet
 

package/dist/index.cjs

@@ -48,7 +48,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.3.0"}`;
+var CLIENT_ID = `textbee-js/${"0.4.0"}`;
 var Textbee = class {
   #apiKey;
   #baseUrl;
@@ -224,10 +224,8 @@ function normalizeBaseUrl(raw) {
     }
   }
   let path;
-  if (segments.length === 0) {
-    path = ["api", "v1"];
-  } else if (cut === -1) {
-    path = segments;
+  if (cut === -1) {
+    path = [...segments, "api", "v1"];
   } else {
     path = [...segments.slice(0, cut - 2), "api", "v1"];
   }

package/dist/index.d.cts

@@ -4,9 +4,9 @@ interface TextbeeOptions {
     /**
      * Your self-hosted textbee API. Defaults to `https://api.textbee.dev/api/v1`.
      *
-     * A bare origin such as `https://sms.example.com` gets `/api/v1` added. A URL
+     * `/api/v1` is added unless the path already contains it, so
+     * `https://sms.example.com` and `https://example.com/textbee` both work. A URL
      * that contains `/api/v1` is cut there, so a pasted endpoint URL still works.
-     * Any other path is used as given, for proxies that map a prefix onto the API.
      * A value with no scheme gets `https://`. An invalid URL throws a `TypeError`
      * rather than falling back, so a typo never sends your key to the public API.
      */
@@ -136,6 +136,20 @@ interface MessageDevice {
     buildId?: string;
     enabled?: boolean;
 }
+/** Where a failure was reported from. */
+type MessageIssueSource = 'push' | 'device' | 'server';
+/** One failure a message had. Kept after the message later succeeds. */
+interface MessageIssueEntry {
+    code: string;
+    message?: string;
+    /** When the failure happened. ISO date. */
+    at: string;
+    source: MessageIssueSource;
+    /** Set on entries rebuilt from old message fields. */
+    backfilled?: boolean;
+    /** True when the entry is a delivery report that did not confirm delivery. The message was sent; this is not a send failure. */
+    deliveryReport?: boolean;
+}
 interface Message {
     _id: string;
     message: string;
@@ -160,10 +174,15 @@ interface Message {
     dispatchedAt?: string;
     sentAt?: string;
     deliveredAt?: string;
+    /** When the message failed. Present only while status is `failed`. */
     failedAt?: string;
     receivedAt?: string;
+    /** Current failure code. Present only while status is `failed` (test accounts can keep `FCM_SEND_SKIPPED`). */
     errorCode?: string;
+    /** Current failure text. Present only while status is `failed`, or as a timeout note on `unknown`. */
     errorMessage?: string;
+    /** Every failure the message had, plus delivery reports that did not confirm delivery (`deliveryReport: true`, not failures). Oldest first. At most 15: the first 5 and the newest 10. */
+    issueHistory?: MessageIssueEntry[];
     simSubscriptionId?: number;
     smsBatch?: string;
     createdAt?: string;
@@ -400,4 +419,4 @@ interface VerifyWebhookSignatureOptions {
  */
 declare function verifyWebhookSignature(options: VerifyWebhookSignatureOptions): Promise<boolean>;
 
-export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };
+export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageIssueEntry, type MessageIssueSource, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };

package/dist/index.d.ts

@@ -4,9 +4,9 @@ interface TextbeeOptions {
     /**
      * Your self-hosted textbee API. Defaults to `https://api.textbee.dev/api/v1`.
      *
-     * A bare origin such as `https://sms.example.com` gets `/api/v1` added. A URL
+     * `/api/v1` is added unless the path already contains it, so
+     * `https://sms.example.com` and `https://example.com/textbee` both work. A URL
      * that contains `/api/v1` is cut there, so a pasted endpoint URL still works.
-     * Any other path is used as given, for proxies that map a prefix onto the API.
      * A value with no scheme gets `https://`. An invalid URL throws a `TypeError`
      * rather than falling back, so a typo never sends your key to the public API.
      */
@@ -136,6 +136,20 @@ interface MessageDevice {
     buildId?: string;
     enabled?: boolean;
 }
+/** Where a failure was reported from. */
+type MessageIssueSource = 'push' | 'device' | 'server';
+/** One failure a message had. Kept after the message later succeeds. */
+interface MessageIssueEntry {
+    code: string;
+    message?: string;
+    /** When the failure happened. ISO date. */
+    at: string;
+    source: MessageIssueSource;
+    /** Set on entries rebuilt from old message fields. */
+    backfilled?: boolean;
+    /** True when the entry is a delivery report that did not confirm delivery. The message was sent; this is not a send failure. */
+    deliveryReport?: boolean;
+}
 interface Message {
     _id: string;
     message: string;
@@ -160,10 +174,15 @@ interface Message {
     dispatchedAt?: string;
     sentAt?: string;
     deliveredAt?: string;
+    /** When the message failed. Present only while status is `failed`. */
     failedAt?: string;
     receivedAt?: string;
+    /** Current failure code. Present only while status is `failed` (test accounts can keep `FCM_SEND_SKIPPED`). */
     errorCode?: string;
+    /** Current failure text. Present only while status is `failed`, or as a timeout note on `unknown`. */
     errorMessage?: string;
+    /** Every failure the message had, plus delivery reports that did not confirm delivery (`deliveryReport: true`, not failures). Oldest first. At most 15: the first 5 and the newest 10. */
+    issueHistory?: MessageIssueEntry[];
     simSubscriptionId?: number;
     smsBatch?: string;
     createdAt?: string;
@@ -400,4 +419,4 @@ interface VerifyWebhookSignatureOptions {
  */
 declare function verifyWebhookSignature(options: VerifyWebhookSignatureOptions): Promise<boolean>;
 
-export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };
+export { type Device, type IterateMessagesOptions, type ListMessagesOptions, type Message, type MessageDevice, type MessageIssueEntry, type MessageIssueSource, type MessageList, type MessageListMeta, type NormalizePhoneNumberOptions, type SanitizeForGsm7Options, type SendSmsImmediateResponse, type SendSmsQueuedResponse, type SendSmsRequest, type SendSmsResponse, type SendSmsWarning, type Sms, type SmsBatch, type SmsBatchResult, type SmsEncoding, type SmsSegmentInfo, Textbee, TextbeeError, type TextbeeOptions, type VerifyWebhookSignatureOptions, type WebhookEvent, countSmsSegments, findNonGsm7Characters, getSmsEncoding, isValidE164, normalizePhoneNumber, sanitizeForGsm7, verifyWebhookSignature };

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.3.0"}`;
+var CLIENT_ID = `textbee-js/${"0.4.0"}`;
 var Textbee = class {
   #apiKey;
   #baseUrl;
@@ -190,10 +190,8 @@ function normalizeBaseUrl(raw) {
     }
   }
   let path;
-  if (segments.length === 0) {
-    path = ["api", "v1"];
-  } else if (cut === -1) {
-    path = segments;
+  if (cut === -1) {
+    path = [...segments, "api", "v1"];
   } else {
     path = [...segments.slice(0, cut - 2), "api", "v1"];
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@textbee/sdk",
-  "version": "0.3.0",
+  "version": "0.4.0",
   "description": "Official JavaScript SDK for textbee.dev, the open source SMS gateway",
   "license": "MIT",
   "packageManager": "pnpm@9.14.2",