@seamapi/http 2.11.1 → 2.11.2

package/README.md

@@ -465,8 +465,10 @@ const seam = new SeamHttp({
 ```
 
 Set `timeout` to `0` to disable the timeout entirely.
-A request that times out rejects with an Axios `ETIMEDOUT` error,
-and is retried according to the retry options.
+A request that times out rejects with an Axios `ETIMEDOUT` error.
+Timed-out idempotent requests are retried according to the retry options, with
+the timeout reset for each attempt. Non-idempotent requests are not retried by
+default.
 
 #### Configuring the Axios Client
 
@@ -474,6 +476,15 @@ The Axios client and retry behavior may be configured with custom initiation opt
 via [`axiosOptions`][axiosOptions] and [`axiosRetryOptions`][axiosRetryOptions].
 Options are deep merged with the default options.
 
+By default, the SDK makes up to three attempts: the initial request and two
+retries. Retries are limited to `GET`, `HEAD`, `OPTIONS`, `PUT`, and `DELETE`
+requests that fail because of a transport error, timeout, HTTP 429 response, or
+HTTP 5xx response. `POST` and `PATCH` requests are not retried.
+
+Retries use exponential backoff with jitter: approximately 200–240 ms before
+the first retry and 400–480 ms before the second. A longer `Retry-After` header
+is honored. The request timeout is reset for each attempt.
+
 [axiosOptions]: https://axios-http.com/docs/config_defaults
 [axiosRetryOptions]: https://github.com/softonic/axios-retry
 

package/lib/client.js

@@ -3,6 +3,15 @@ import axiosRetry, { exponentialDelay, isIdempotentRequestError, } from 'axios-r
 import { errorInterceptor } from './error-interceptor.js';
 import { serializeUrlSearchParams } from './url-search-params-serializer.js';
 export const defaultTimeout = 30_000;
+const defaultAxiosRetryOptions = {
+    retries: 2,
+    retryCondition: isIdempotentRequestError,
+    retryDelay: exponentialDelay,
+    shouldResetTimeout: true,
+    onRetry: () => undefined,
+    onMaxRetryTimesExceeded: () => undefined,
+    validateResponse: null,
+};
 export const createClient = (options) => {
     const client = axios.create({
         paramsSerializer: serializeUrlSearchParams,
@@ -11,9 +20,7 @@ export const createClient = (options) => {
         ...options.axiosOptions,
     });
     axiosRetry(client, {
-        retries: 2,
-        retryDelay: exponentialDelay,
-        retryCondition: isIdempotentRequestError,
+        ...defaultAxiosRetryOptions,
         ...options.axiosRetryOptions,
     });
     client.interceptors.response.use(undefined, errorInterceptor);

package/lib/client.js.map

@@ -1 +1 @@
-{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/lib/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAA+C,MAAM,OAAO,CAAA;AAC1E,OAAO,UAAU,EAAE,EAEjB,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAI5E,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAA;AAUpC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAiB,EAAE;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC1B,gBAAgB,EAAE,wBAAwB;QAC1C,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;QAC1C,GAAG,OAAO,CAAC,YAAY;KACxB,CAAC,CAAA;IAEF,UAAU,CAAC,MAAM,EAAE;QACjB,OAAO,EAAE,CAAC;QACV,UAAU,EAAE,gBAAgB;QAC5B,cAAc,EAAE,wBAAwB;QACxC,GAAG,OAAO,CAAC,iBAAiB;KAC7B,CAAC,CAAA;IAEF,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IAE7D,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}
+{"version":3,"file":"client.js","sourceRoot":"","sources":["../src/lib/client.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,EAA+C,MAAM,OAAO,CAAA;AAC1E,OAAO,UAAU,EAAE,EAEjB,gBAAgB,EAChB,wBAAwB,GACzB,MAAM,aAAa,CAAA;AAEpB,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,wBAAwB,EAAE,MAAM,mCAAmC,CAAA;AAI5E,MAAM,CAAC,MAAM,cAAc,GAAG,MAAM,CAAA;AAYpC,MAAM,wBAAwB,GAAG;IAC/B,OAAO,EAAE,CAAC;IACV,cAAc,EAAE,wBAAwB;IACxC,UAAU,EAAE,gBAAgB;IAC5B,kBAAkB,EAAE,IAAI;IACxB,OAAO,EAAE,GAAG,EAAE,CAAC,SAAS;IACxB,uBAAuB,EAAE,GAAG,EAAE,CAAC,SAAS;IACxC,gBAAgB,EAAE,IAAI;CACY,CAAA;AAEpC,MAAM,CAAC,MAAM,YAAY,GAAG,CAAC,OAAsB,EAAiB,EAAE;IACpE,MAAM,MAAM,GAAG,KAAK,CAAC,MAAM,CAAC;QAC1B,gBAAgB,EAAE,wBAAwB;QAC1C,OAAO,EAAE,OAAO;QAChB,OAAO,EAAE,OAAO,CAAC,OAAO,IAAI,cAAc;QAC1C,GAAG,OAAO,CAAC,YAAY;KACxB,CAAC,CAAA;IAEF,UAAU,CAAC,MAAM,EAAE;QACjB,GAAG,wBAAwB;QAC3B,GAAG,OAAO,CAAC,iBAAiB;KAC7B,CAAC,CAAA;IAEF,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,EAAE,gBAAgB,CAAC,CAAA;IAE7D,OAAO,MAAM,CAAA;AACf,CAAC,CAAA"}

package/lib/version.d.ts

@@ -1,2 +1,2 @@
-declare const seamapiJavascriptHttpVersion = "2.11.1";
+declare const seamapiJavascriptHttpVersion = "2.11.2";
 export default seamapiJavascriptHttpVersion;

package/lib/version.js

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '2.11.1';
+const seamapiJavascriptHttpVersion = '2.11.2';
 export default seamapiJavascriptHttpVersion;
 //# sourceMappingURL=version.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@seamapi/http",
-  "version": "2.11.1",
+  "version": "2.11.2",
   "description": "JavaScript HTTP client for the Seam API written in TypeScript.",
   "type": "module",
   "main": "index.js",

package/src/lib/client.ts

@@ -20,6 +20,18 @@ export interface ClientOptions {
 
 type AxiosRetryConfig = Parameters<AxiosRetry>[1]
 
+type RequiredAxiosRetryConfig = Required<NonNullable<AxiosRetryConfig>>
+
+const defaultAxiosRetryOptions = {
+  retries: 2,
+  retryCondition: isIdempotentRequestError,
+  retryDelay: exponentialDelay,
+  shouldResetTimeout: true,
+  onRetry: () => undefined,
+  onMaxRetryTimesExceeded: () => undefined,
+  validateResponse: null,
+} satisfies RequiredAxiosRetryConfig
+
 export const createClient = (options: ClientOptions): AxiosInstance => {
   const client = axios.create({
     paramsSerializer: serializeUrlSearchParams,
@@ -29,9 +41,7 @@ export const createClient = (options: ClientOptions): AxiosInstance => {
   })
 
   axiosRetry(client, {
-    retries: 2,
-    retryDelay: exponentialDelay,
-    retryCondition: isIdempotentRequestError,
+    ...defaultAxiosRetryOptions,
     ...options.axiosRetryOptions,
   })
 

package/src/lib/version.ts

@@ -1,3 +1,3 @@
-const seamapiJavascriptHttpVersion = '2.11.1'
+const seamapiJavascriptHttpVersion = '2.11.2'
 
 export default seamapiJavascriptHttpVersion