fix(js-sdk): document ConvertAgent UA invariant (trigger js-sdk release) - #391
Merged
Merged
Conversation
…e 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
|
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request updates the documentation in packages/js-sdk/src/core.ts to include information about the User-Agent header used for server-side HTTP requests. It explains that the ConvertAgent/1.0 header is an invariant used for bot bypass on the metrics endpoint. I have no feedback to provide.
JosephSamirL
approved these changes
May 25, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
User-Agent: ConvertAgent/1.0invariant from feat(utils): always announce as Convert SDK via ConvertAgent User-Agent #387 at the js-sdk package entry point (packages/js-sdk/src/core.ts).fix(js-sdk):conventional commit so release-please attributes a patch bump tojs-sdk(4.4.1 → 4.4.2) alongside the already-queuedutilsbump.Why
PR #387 only touched
packages/utils/src/http-client.tswithfeat(utils):, so release-please only bumpedutils(2.2.0 → 2.3.0). The behavior change ships throughjs-sdkas well, but release-please scopes bumps strictly by file path + commit scope — so without a js-sdk-side commit, consumers pinning@convertcom/js-sdksee no version delta despite the wire-level change.This PR adds a documentation-only note at the SDK entry point so the contract is visible to integrators and release-please attributes the change to
js-sdk. No behavioral change.Follow-up
After this merges into
main-convert, a separatemain-convert→mainPR will let release-please pick up the new commit and include thejs-sdkpatch bump in its release PR.Test plan
main, release-please PR includes ajs-sdk4.4.1 → 4.4.2 entryRefs: #387, #390
🤖 Generated with Claude Code