Brand Agent Clarity 1st Party Integration by moemenahmed-n · Pull Request #1040 · microsoft/clarity

moemenahmed-n · 2026-02-12T19:00:15Z

Brand Agent Clarity 1st party integration for client-side events.

packages/clarity-js/src/clarity.ts

packages/clarity-js/src/brand-agent/encode.ts

packages/clarity-js/src/brand-agent/blank.ts

packages/clarity-js/src/brand-agent/encode.ts

packages/clarity-js/types/brand-agent.d.ts

packages/clarity-js/src/brand-agent/encode.ts

Copilot

Pull request overview

This PR adds a first-party Brand Agent integration to Clarity for tracking client-side events from the Brand Agent chat system. The integration creates a new event emitter API on the window object that allows the Brand Agent to report user interactions like bubble shows, nudges, and chat messages.

Changes:

Adds a new BrandAgent event type (53) and corresponding TypeScript definitions
Creates a new brand-agent module with event handling and encoding logic
Exposes a window.BrandAgentClarity API with on/off/emit methods for event communication

Reviewed changes

Copilot reviewed 4 out of 7 changed files in this pull request and generated 15 comments.

Show a summary per file

File	Description
packages/clarity-js/types/global.d.ts	Adds TypeScript interface for window.BrandAgentClarity API
packages/clarity-js/types/data.d.ts	Adds BrandAgent event type (53) to the Event enum
packages/clarity-js/types/brand-agent.d.ts	Defines BrandAgentClarityEventName enum and BrandAgentClarityEvent interface
packages/clarity-js/src/clarity.ts	Integrates BrandAgent module into the main modules array
packages/clarity-js/src/brand-agent/index.ts	Implements event emitter and handler registration for Brand Agent events
packages/clarity-js/src/brand-agent/encode.ts	Encodes Brand Agent events into Clarity's token format for transmission
packages/clarity-js/src/brand-agent/blank.ts	Provides empty implementation for conditional compilation (not currently used)

packages/clarity-js/src/brand-agent/index.ts

packages/clarity-js/src/brand-agent/encode.ts

packages/clarity-js/src/dynamic/brandagent/brandagent.ts

packages/clarity-js/src/brand-agent/index.ts

packages/clarity-js/src/brand-agent/encode.ts

nairmanu · 2026-03-05T19:21:30Z

packages/clarity-js/types/data.d.ts

+    BubbleShown,
+    NudgeClicked,
+    AgentMessageSent,
+    UserMessageSent,


why do we need something new? Cant we reuse Action enum from agent.d.ts?

nairmanu · 2026-03-05T19:22:51Z

packages/clarity-js/types/data.d.ts

    Focus = 50,
    CustomElement = 51,
    Chat = 52,
+    BrandAgent = 53,


why not reuse Chat? why have a new event?

nairmanu · 2026-03-05T19:23:30Z

packages/clarity-js/src/dynamic/brandagent/index.ts

@@ -0,0 +1,4 @@
+import * as brandAgent from "@src/dynamic/brandagent/brandagent";


why is this a standalone folder? this can live within agent folder

nairmanu · 2026-03-05T19:23:57Z

packages/clarity-js/src/dynamic/brandagent/encode.ts

@@ -0,0 +1,21 @@
+import { Event, Token } from "@clarity-types/data";


reuse encode in agent folder

Copilot

Pull request overview

Copilot reviewed 8 out of 11 changed files in this pull request and generated 3 comments.

You can also share your feedback on Copilot code review. Take the survey.

Copilot · 2026-03-08T14:00:00Z

packages/clarity-decode/src/data.ts

 import { Data } from "clarity-js";
 import { Constant, DataEvent } from "../types/data";
+import { BrandAgentEventName } from "clarity-js/types/data";


This import is only used for a type assertion, but it is written as a value import from clarity-js/types/data. Depending on TS compiler settings/bundling, this can emit a runtime import for a .d.ts-only path and fail at runtime. Prefer a type-only reference (e.g., import type ...) or reference it via the existing Data namespace (Data.BrandAgentEventName) so no runtime dependency is introduced.

Copilot · 2026-03-08T14:00:00Z

packages/clarity-js/src/dynamic/brandagent/brandagent.ts

+export function start(): void {
+  if (!window.BrandAgentClarity) {
+    window.BrandAgentClarity = {
+      on(name: string, cb: (e: any) => void) {
+        if (!handlers.has(name)) { handlers.set(name, new Set()); }
+        handlers.get(name)!.add(cb);
+      },
+      off(name: string, cb: (e: any) => void) {
+        handlers.get(name)?.delete(cb);
+      },
+      emit(name: string, e: any) {
+        handlers.get(name)?.forEach((fn: (e: any) => void) => fn(e));
+      },
+    };
+  }
+
+  window.BrandAgentClarity.on("agentEvent", handleAgentEvent);
+
+  // Register stop callback with main Clarity
+  if (typeof window !== "undefined" && (window as any).clarity) {
+    (window as any).clarity("register", stop);
+  }
+}
+
+export function stop(): void {
+  if (window.BrandAgentClarity) {
+    window.BrandAgentClarity.off("agentEvent", handleAgentEvent);
+  }
+  handlers.clear();
+}


window.BrandAgentClarity is only initialized the first time this bundle runs, but its on/off/emit functions close over the module-local handlers map. On subsequent loads of this dynamic bundle (Clarity does stop/start on SPA navigations), window.BrandAgentClarity already exists so the new module instance’s handlers is unused, yet stop() clears the new map instead of the map actually used by BrandAgentClarity. This can cause handler state to persist across restarts and makes cleanup inconsistent. Consider storing the handler map on window.BrandAgentClarity itself (or otherwise ensuring stop() clears the same handler store that on/off/emit uses) so reloads remain correct.

Copilot · 2026-03-08T14:00:01Z

packages/clarity-decode/src/clarity.ts

+            case Data.Event.BrandAgent:
+                if (payload.brandAgent === undefined) { payload.brandAgent = []; }
+                payload.brandAgent.push(data.decode(entry) as BrandAgentEvent);
+                break;


New BrandAgent event decoding logic was added, but there’s no corresponding test coverage validating that a payload containing Event.BrandAgent ends up in DecodedPayload.brandAgent with the expected name/msg/cid fields. Adding a small test case would help prevent regressions in the decoder and keep event compatibility stable.

microsoft-github-policy-service · 2026-03-10T21:00:07Z

@moemenahmed-n please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.

@microsoft-github-policy-service agree [company="{your company}"]

Options:

(default - no company specified) I have sole ownership of intellectual property rights to my Submissions and I am not making Submissions in the course of work for my employer.
@microsoft-github-policy-service agree
(when company given) I am making Submissions in the course of work for my employer (or my employer has intellectual property rights in my Submissions by contract or applicable law). I have permission from my employer to make Submissions and enter into this Agreement on behalf of my employer. By signing below, the defined term “You” includes me and my employer.
@microsoft-github-policy-service agree company="Microsoft"

Contributor License Agreement

Contribution License Agreement

This Contribution License Agreement (“Agreement”) is agreed to by the party signing below (“You”),
and conveys certain license rights to Microsoft Corporation and its affiliates (“Microsoft”) for Your
contributions to Microsoft open source projects. This Agreement is effective as of the latest signature
date below.

Definitions.
“Code” means the computer software code, whether in human-readable or machine-executable form,
that is delivered by You to Microsoft under this Agreement.
“Project” means any of the projects owned or managed by Microsoft and offered under a license
approved by the Open Source Initiative (www.opensource.org).
“Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any
Project, including but not limited to communication on electronic mailing lists, source code control
systems, and issue tracking systems that are managed by, or on behalf of, the Project for the purpose of
discussing and improving that Project, but excluding communication that is conspicuously marked or
otherwise designated in writing by You as “Not a Submission.”
“Submission” means the Code and any other copyrightable material Submitted by You, including any
associated comments and documentation.
Your Submission. You must agree to the terms of this Agreement before making a Submission to any
Project. This Agreement covers any and all Submissions that You, now or in the future (except as
described in Section 4 below), Submit to any Project.
Originality of Work. You represent that each of Your Submissions is entirely Your original work.
Should You wish to Submit materials that are not Your original work, You may Submit them separately
to the Project if You (a) retain all copyright and license information that was in the materials as You
received them, (b) in the description accompanying Your Submission, include the phrase “Submission
containing materials of a third party:” followed by the names of the third party and any licenses or other
restrictions of which You are aware, and (c) follow any other instructions in the Project’s written
guidelines concerning Submissions.
Your Employer. References to “employer” in this Agreement include Your employer or anyone else
for whom You are acting in making Your Submission, e.g. as a contractor, vendor, or agent. If Your
Submission is made in the course of Your work for an employer or Your employer has intellectual
property rights in Your Submission by contract or applicable law, You must secure permission from Your
employer to make the Submission before signing this Agreement. In that case, the term “You” in this
Agreement will refer to You and the employer collectively. If You change employers in the future and
desire to Submit additional Submissions for the new employer, then You agree to sign a new Agreement
and secure permission from the new employer before Submitting those Submissions.
Licenses.

Copyright License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license in the
Submission to reproduce, prepare derivative works of, publicly display, publicly perform, and distribute
the Submission and such derivative works, and to sublicense any or all of the foregoing rights to third
parties.
Patent License. You grant Microsoft, and those who receive the Submission directly or
indirectly from Microsoft, a perpetual, worldwide, non-exclusive, royalty-free, irrevocable license under
Your patent claims that are necessarily infringed by the Submission or the combination of the
Submission with the Project to which it was Submitted to make, have made, use, offer to sell, sell and
import or otherwise dispose of the Submission alone or with the Project.
Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement.
No additional licenses or rights whatsoever (including, without limitation, any implied licenses) are
granted by implication, exhaustion, estoppel or otherwise.

Representations and Warranties. You represent that You are legally entitled to grant the above
licenses. You represent that each of Your Submissions is entirely Your original work (except as You may
have disclosed under Section 3). You represent that You have secured permission from Your employer to
make the Submission in cases where Your Submission is made in the course of Your work for Your
employer or Your employer has intellectual property rights in Your Submission by contract or applicable
law. If You are signing this Agreement on behalf of Your employer, You represent and warrant that You
have the necessary authority to bind the listed employer to the obligations contained in this Agreement.
You are not expected to provide support for Your Submission, unless You choose to do so. UNLESS
REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING, AND EXCEPT FOR THE WARRANTIES
EXPRESSLY STATED IN SECTIONS 3, 4, AND 6, THE SUBMISSION PROVIDED UNDER THIS AGREEMENT IS
PROVIDED WITHOUT WARRANTY OF ANY KIND, INCLUDING, BUT NOT LIMITED TO, ANY WARRANTY OF
NONINFRINGEMENT, MERCHANTABILITY, OR FITNESS FOR A PARTICULAR PURPOSE.
Notice to Microsoft. You agree to notify Microsoft in writing of any facts or circumstances of which
You later become aware that would make Your representations in this Agreement inaccurate in any
respect.
Information about Submissions. You agree that contributions to Projects and information about
contributions may be maintained indefinitely and disclosed publicly, including Your name and other
information that You submit with Your Submission.
Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and
the parties consent to exclusive jurisdiction and venue in the federal courts sitting in King County,
Washington, unless no federal subject matter jurisdiction exists, in which case the parties consent to
exclusive jurisdiction and venue in the Superior Court of King County, Washington. The parties waive all
defenses of lack of personal jurisdiction and forum non-conveniens.
Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and
supersedes any and all prior agreements, understandings or communications, written or oral, between
the parties relating to the subject matter hereof. This Agreement may be assigned by Microsoft.