shipmail 0.5.5 → 0.5.7

package/README.md

@@ -93,15 +93,15 @@ const shipmail = new ShipmailClient({
 });
 ```
 
-| Option           | Type                     | Default                      | Description                                                     |
-| ---------------- | ------------------------ | ---------------------------- | --------------------------------------------------------------- |
-| `apiKey`         | `string`                 | required                     | Shipmail API key (`sm_live_...`).                               |
-| `baseUrl`        | `string`                 | `https://shipmail.to/api/v1` | API base URL.                                                   |
-| `maxRetries`     | `number`                 | `2`                          | Retry count on 5xx and 429. Total attempts is `maxRetries + 1`. |
-| `timeout`        | `number`                 | `30_000`                     | Per-request timeout in ms.                                      |
-| `fetch`          | `typeof fetch`           | `globalThis.fetch`           | Custom fetch implementation.                                    |
-| `defaultHeaders` | `Record<string, string>` | `{}`                         | Headers added to every request.                                 |
-| `organizationId` | `string`                 | none                         | Delegated child organization for approved infrastructure calls. |
+| Option           | Type                     | Default                      | Description                                                         |
+| ---------------- | ------------------------ | ---------------------------- | ------------------------------------------------------------------- |
+| `apiKey`         | `string`                 | required                     | Shipmail API key (`sm_live_...`).                                   |
+| `baseUrl`        | `string`                 | `https://shipmail.to/api/v1` | API base URL.                                                       |
+| `maxRetries`     | `number`                 | `2`                          | Retry count for eligible requests. Up to `maxRetries + 1` attempts. |
+| `timeout`        | `number`                 | `30_000`                     | Per-request timeout in ms.                                          |
+| `fetch`          | `typeof fetch`           | `globalThis.fetch`           | Custom fetch implementation.                                        |
+| `defaultHeaders` | `Record<string, string>` | `{}`                         | Headers added to every request.                                     |
+| `organizationId` | `string`                 | none                         | Delegated child organization for approved infrastructure calls.     |
 
 ## Domains
 
@@ -730,21 +730,25 @@ try {
 }
 ```
 
-| Error                 | When                                                           |
-| --------------------- | -------------------------------------------------------------- |
-| `AuthenticationError` | 401. Bad or missing API key.                                   |
-| `AuthorizationError`  | 403. Key lacks permission for the resource.                    |
-| `ValidationError`     | 400 or 422. See `details` for per-field errors.                |
-| `NotFoundError`       | 404.                                                           |
-| `ConflictError`       | 409. Resource already exists or state conflict.                |
-| `RateLimitError`      | 429. Read `retryAfter` (seconds).                              |
-| `QuotaExceededError`  | 402. Plan or sending quota exceeded.                           |
-| `InternalServerError` | 5xx. Retried automatically up to `maxRetries`.                 |
-| `ConnectionError`     | Network error, timeout, or DNS failure. Retried automatically. |
+| Error                 | When                                                             |
+| --------------------- | ---------------------------------------------------------------- |
+| `AuthenticationError` | 401. Bad or missing API key.                                     |
+| `AuthorizationError`  | 403. Key lacks permission for the resource.                      |
+| `ValidationError`     | 400 or 422. See `details` for per-field errors.                  |
+| `NotFoundError`       | 404.                                                             |
+| `ConflictError`       | 409. Resource already exists or state conflict.                  |
+| `RateLimitError`      | 429. Read `retryAfter` (seconds).                                |
+| `QuotaExceededError`  | 402. Plan or sending quota exceeded.                             |
+| `InternalServerError` | 5xx. Eligible requests retry up to `maxRetries`.                 |
+| `ConnectionError`     | Network error, timeout, or DNS failure. Eligible requests retry. |
 
 ## Retries
 
-The SDK retries on `5xx`, `429`, and connection errors with exponential backoff and jitter. `Retry-After` is honored when present. Default is 2 retries (3 total attempts).
+The SDK retries eligible requests after connection errors, `429` responses, and retryable `5xx` errors. Automatic retries apply to `GET`, `HEAD`, and `OPTIONS`. Only POST, PATCH, and PUT mutations can retry, and they require an explicit `idempotencyKey` method option or an `Idempotency-Key` header. Reuse the same key for the same operation. DELETE requests and errors marked non-retryable are never retried.
+
+`maxRetries` defaults to 2 (up to 3 total attempts) and must be a non-negative integer. Set it to 0 to disable retries.
+
+A valid `Retry-After` header, in seconds or HTTP-date format, takes precedence over the rate-limit error body's `retry_after`. Otherwise, retries use exponential backoff with jitter. If the requested delay exceeds 60 seconds, the SDK returns the error without retrying automatically; schedule any later retry after that delay.
 
 ```ts
 new ShipmailClient({ apiKey, maxRetries: 0 }); // disable retries

package/dist/index.cjs

@@ -1699,17 +1699,26 @@ var Webhooks = class extends ApiResource {
 };
 
 // src/version.ts
-var VERSION = "0.5.5";
+var VERSION = "0.5.7";
 
 // src/client.ts
 var DEFAULT_BASE_URL = "https://shipmail.to/api/v1";
 var DEFAULT_MAX_RETRIES = 2;
 var DEFAULT_TIMEOUT = 3e4;
+var MAX_RETRY_AFTER_MS = 6e4;
+function parseRetryAfter(value) {
+  if (!value?.trim()) return void 0;
+  const seconds = Number(value);
+  if (Number.isFinite(seconds) && seconds >= 0) return seconds * 1e3;
+  if (/^[+-]?[\d.]+$/.test(value.trim())) return void 0;
+  const date = Date.parse(value);
+  return Number.isFinite(date) ? Math.max(0, date - Date.now()) : void 0;
+}
 function isRetryableStatus(status) {
   return status === 429 || status >= 500;
 }
 function calculateBackoff(attempt, retryAfterMs) {
-  if (retryAfterMs !== void 0 && retryAfterMs > 0) {
+  if (retryAfterMs !== void 0 && Number.isFinite(retryAfterMs) && retryAfterMs >= 0) {
     return retryAfterMs;
   }
   const base2 = Math.min(2 ** attempt * 500, 8e3);
@@ -1752,6 +1761,9 @@ var ShipmailClient = class {
       this.defaultHeaders = config.defaultHeaders ? { ...config.defaultHeaders } : {};
       this.organizationId = config.organizationId;
     }
+    if (!Number.isSafeInteger(this.maxRetries) || this.maxRetries < 0) {
+      throw new RangeError("maxRetries must be a non-negative safe integer");
+    }
     this.audiences = new Audiences(this);
     this.automations = new Automations(this);
     this.bookingPages = new BookingPages(this);
@@ -1787,9 +1799,13 @@ var ShipmailClient = class {
     const url = this.buildUrl(options.path, options.query);
     let lastError;
     const methodOpts = options.methodOptions;
+    const retryHeaders = new Headers({ ...this.defaultHeaders, ...methodOpts?.headers });
+    const method = options.method.toUpperCase();
+    const idempotencyKey = methodOpts?.idempotencyKey || retryHeaders.get("Idempotency-Key");
+    const canRetry = ["GET", "HEAD", "OPTIONS"].includes(method) || ["POST", "PATCH", "PUT"].includes(method) && Boolean(idempotencyKey?.trim());
+    let retryAfterMs;
     for (let attempt = 0; attempt <= this.maxRetries; attempt++) {
       if (attempt > 0) {
-        const retryAfterMs = lastError instanceof RateLimitError && lastError.retryAfter !== void 0 ? lastError.retryAfter * 1e3 : void 0;
         const delay = calculateBackoff(attempt - 1, retryAfterMs);
         await new Promise((resolve) => setTimeout(resolve, delay));
       }
@@ -1826,7 +1842,10 @@ var ShipmailClient = class {
         });
       } catch (err) {
         lastError = new ConnectionError(err instanceof Error ? err.message : "Request failed");
-        if (attempt < this.maxRetries) continue;
+        if (canRetry && !methodOpts?.signal?.aborted && attempt < this.maxRetries) {
+          retryAfterMs = void 0;
+          continue;
+        }
         throw lastError;
       }
       if (response.ok) {
@@ -1846,7 +1865,14 @@ var ShipmailClient = class {
           retryable: isRetryableStatus(response.status)
         });
       }
-      if (!lastError.retryable || attempt >= this.maxRetries) {
+      retryAfterMs = parseRetryAfter(response.headers.get("Retry-After"));
+      if (retryAfterMs === void 0 && lastError instanceof RateLimitError) {
+        const seconds = lastError.retryAfter;
+        if (typeof seconds === "number" && Number.isFinite(seconds) && seconds >= 0) {
+          retryAfterMs = seconds * 1e3;
+        }
+      }
+      if (!canRetry || !lastError.retryable || attempt >= this.maxRetries || retryAfterMs !== void 0 && retryAfterMs > MAX_RETRY_AFTER_MS) {
         throw lastError;
       }
     }