From 7244fc8e8e87fecc7f9ed236319dc9e5a5184a0a Mon Sep 17 00:00:00 2001 From: Ahmed Abbas Date: Mon, 25 May 2026 17:43:33 +0300 Subject: [PATCH] fix(js-sdk): document ConvertAgent User-Agent invariant on server-side HTTP The User-Agent invariant introduced in #387 (always announce `ConvertAgent/1.0` on server-side outbound HTTP from HttpClient) is a js-sdk-level behavioral guarantee surfaced through every manager (api/data/event) that delegates to @convertcom/js-sdk-utils' HttpClient. Surfaces the contract at the SDK entry point so the metrics-endpoint isbot bypass dependency is documented at the layer customers integrate against, not only at the transport layer. Refs: #387 --- packages/js-sdk/src/core.ts | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/packages/js-sdk/src/core.ts b/packages/js-sdk/src/core.ts index 45a2cd7e..bf9acdf9 100644 --- a/packages/js-sdk/src/core.ts +++ b/packages/js-sdk/src/core.ts @@ -3,6 +3,11 @@ * Version 1.0.0 * Copyright(c) 2020 Convert Insights, Inc * License Apache-2.0 + * + * Server-side HTTP requests issued through this SDK announce themselves as + * `User-Agent: ConvertAgent/1.0` (see packages/utils/src/http-client.ts). This + * is an SDK invariant relied on by the metrics endpoint's isbot bypass and is + * not customer- or env-configurable. */ import {ApiManagerInterface} from '@convertcom/js-sdk-api'; import {ContextInterface} from './interfaces/context';