fix: Allow all user identity types in Identity.search by rmi22186 · Pull Request #1256 · mParticle/mparticle-web-sdk

rmi22186 · 2026-05-05T13:08:59Z

Summary

Expands Identity.search so it forwards every identifier the partner has, not just email. Builds on #1255 (the initial IDSync Search client API), which restricted known_identities to { email }.

In production, partners sometimes pass hashed email through other, other2-10, or customerid rather than the plain email field. The previous shape silently dropped those, so search returned 404 even when a match existed under a non-email key.

What changed

src/identity/search.ts

sendSearchRequest now accepts UserIdentities (the SDK's full identity surface) instead of the bespoke { email: string } type.
The "no usable identifier" guard now checks that any property has a non-empty string value (was: required email specifically).
Forwards { ...knownIdentities } to the wire instead of { email: knownIdentities.email }.
Removes the now-unused IIdentitySearchKnownIdentities interface in favor of UserIdentities.

Public types (src/public-types.ts, src/identity.interfaces.ts)

Drops IIdentitySearchKnownIdentities from the public surface (it was never load-bearing for kits — only one prior consumer, this PR removes it).
Adds IUserIdentities for consumption by Kit
SDKIdentityApi.search and executeSearchRequest updated to use UserIdentities.

Tests (test/src/tests-search.ts)

Renames the existing guard test to reflect the new "any non-empty string identifier" contract; expands its inputs to include { email: 12345, other: null } (mixed wrong-typed + null).
New: forwards non-email identifiers (e.g. hashed email in 'other') to the wire — asserts that { other: 'sha256:abc123', customerid: 'cust-1' } produces a 200 round-trip with the full identifier set in the request body.

Breaking changes

IIdentitySearchKnownIdentities is removed from the public exports. It was added in #1255 and (per `git grep`) had no external consumers, so the practical blast radius is zero — but worth flagging for changelog purposes.

Test plan

`npm run test` — Mocha suite, including the renamed/extended guard test and the new `forwards non-email identifiers` test
`npm run build` — `tsc -p tsconfig.types.json` should emit `IUserIdentities` into `dist/types/src/public-types.d.ts`
Verify a kit consumer (Rokt) can `import type { IUserIdentities } from '@mparticle/web-sdk'` and call `mParticle.Identity.search(apiKey, { other: '' }, cb)` against a real workspace with a non-email identifier

🤖 Generated with Claude Code

pair with mparticle-integrations/mparticle-javascript-integration-rokt#93

cursor · 2026-05-05T13:21:47Z

PR Summary

Medium Risk
Expands the identity search request payload and validation logic; behavior changes could affect who gets matched and what identifiers are sent over the wire, and it removes a previously exported type.

Overview
Identity.search now accepts and forwards the full UserIdentities map (not just email) to the /v1/search endpoint, after stripping falsy identity values.

The guard rails were updated to skip the network call unless any identifier contains a non-empty string, and types/exports were adjusted by removing IIdentitySearchKnownIdentities and adding IUserIdentities to the public surface. Tests were updated and expanded to cover non-email identifiers and falsy/null handling.

^{Reviewed by Cursor Bugbot for commit a0fb93c. Bugbot is set up for automated code reviews on this repo. Configure here.}

alexs-mparticle · 2026-05-05T13:49:07Z

+    const hasIdentifier =
+        knownIdentities &&
+        typeof knownIdentities === 'object' &&
+        Object.values(knownIdentities).some(
+            (v) => typeof v === 'string' && v.length > 0,
+        );
+    if (!hasIdentifier) {


Making this a convenience method right before invocation doesn't really help with readability, IMO.

We probably have some utility methods that could help clean this up a bit instead, or we can roll this into a new utility method.

Suggested change

const hasIdentifier =

knownIdentities &&

typeof knownIdentities === 'object' &&

Object.values(knownIdentities).some(

(v) => typeof v === 'string' && v.length > 0,

);

if (!hasIdentifier) {

if (!isEmpty(knownIdentities) && knownIdentities.some(v => !isEmpty(v)) {

fixed. I had the same idea and the robot was telling me isEmpty would let things like {email: 1234} through. However, we do validation prior to this so it ended up being a non issue.

@alexs-mparticle

- IUserIdentities: drop redundant `| undefined` from each property — the `?` modifier already implies undefined (per @alexs-mparticle review). - search.ts: route knownIdentities through `Validators.removeFalsyIdentityValues` before the guard and the wire spread. Strips undefined/0/false/'' (with a caller-side warning), preserves null (server accepts it as a "no value" sentinel). Resolves the Cursor bot concern about unvalidated values reaching the wire while matching `Identity.identify/login/modify` behavior. - search.ts: simplify the no-usable-identifier guard with `isEmpty` plus a string-value check (per @alexs-mparticle review). - tests-search.ts: add coverage for the falsy-stripping + null-preservation behavior — `{ email: 'valid@example.com', customerid: null, other: '' }` hits the wire as `{ email: 'valid@example.com', customerid: null }`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

@alexs-mparticle

- IUserIdentities: drop redundant `| undefined` from each property — the `?` modifier already implies undefined (per @alexs-mparticle review). - search.ts: route knownIdentities through `Validators.removeFalsyIdentityValues` before the guard and the wire spread. Strips undefined/0/false/'' (with a caller-side warning), preserves null (server accepts it as a "no value" sentinel). Resolves the Cursor bot concern about unvalidated values reaching the wire while matching `Identity.identify/login/modify` behavior. - search.ts: simplify the no-usable-identifier guard with `isEmpty` plus a string-value check (per @alexs-mparticle review). - identity.js: trim the `Identity.search` JSDoc to a one-liner — the long identifier-list inventory drifts from the type and adds noise without helping readers. - tests-search.ts: add coverage for the falsy-stripping + null-preservation behavior — `{ email: 'valid@example.com', customerid: null, other: '' }` hits the wire as `{ email: 'valid@example.com', customerid: null }`. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Co-authored-by: Alex S <49695018+alexs-mparticle@users.noreply.github.com>

cursor

Cursor Bugbot has reviewed your changes and found 3 potential issues.

^{❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, have a team admin enable autofix in the Cursor dashboard.}

^{Reviewed by Cursor Bugbot for commit a6672c9. Configure here.}

sonarqubecloud · 2026-05-05T15:34:08Z

Quality Gate passed

Issues
1 New issue
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

# [2.67.0](v2.66.0...v2.67.0) (2026-05-05) ### Bug Fixes * Allow all user identity types in Identity.search ([#1256](#1256)) ([40e2972](40e2972)) ### Features * Add Identity.search for IDSync Search ([#1255](#1255)) ([2b249b9](2b249b9))

mparticle-automation · 2026-05-05T19:59:48Z

🎉 This PR is included in version 2.67.0 🎉

The release is available on:

v2.67.0
GitHub release

Your semantic-release bot 📦🚀

fix: Allow all user identitiy types to send to search

3d10076

rmi22186 marked this pull request as ready for review May 5, 2026 13:21

rmi22186 requested a review from a team as a code owner May 5, 2026 13:21

rmi22186 requested a review from alexs-mparticle May 5, 2026 13:21

cursor Bot reviewed May 5, 2026

View reviewed changes

Comment thread src/identity/search.ts Outdated

alexs-mparticle requested changes May 5, 2026

View reviewed changes

rmi22186 force-pushed the fix/send-all-identities branch from 24274c0 to 4dcf5a7 Compare May 5, 2026 14:54

alexs-mparticle reviewed May 5, 2026

View reviewed changes

Comment thread src/identity/search.ts

alexs-mparticle reviewed May 5, 2026

View reviewed changes

Comment thread src/identity/search.ts Outdated

alexs-mparticle approved these changes May 5, 2026

View reviewed changes

rmi22186 and others added 2 commits May 5, 2026 11:25

Apply suggestion from @alexs-mparticle

7ef842e

Co-authored-by: Alex S <49695018+alexs-mparticle@users.noreply.github.com>

Apply suggestions from code review

a6672c9

Co-authored-by: Alex S <49695018+alexs-mparticle@users.noreply.github.com>

cursor Bot reviewed May 5, 2026

View reviewed changes

Comment thread src/identity/search.ts Outdated

Comment thread src/identity/search.ts Outdated

Comment thread src/identity/search.ts

update comment

a0fb93c

rmi22186 requested a review from samdozor May 5, 2026 16:22

rmi22186 merged commit 40e2972 into development May 5, 2026
30 of 33 checks passed

mparticle-automation added the released label May 5, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Allow all user identity types in Identity.search#1256

fix: Allow all user identity types in Identity.search#1256
rmi22186 merged 5 commits intodevelopmentfrom
fix/send-all-identities

rmi22186 commented May 5, 2026 •

edited

Loading

Uh oh!

cursor Bot commented May 5, 2026 •

edited

Loading

Uh oh!

Uh oh!

alexs-mparticle May 5, 2026

Uh oh!

rmi22186 May 5, 2026

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 5, 2026

Uh oh!

Uh oh!

mparticle-automation commented May 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

rmi22186 commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

What changed

Breaking changes

Test plan

Uh oh!

cursor Bot commented May 5, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Summary

Uh oh!

Uh oh!

alexs-mparticle May 5, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 May 5, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud Bot commented May 5, 2026

Quality Gate passed

Uh oh!

Uh oh!

mparticle-automation commented May 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

rmi22186 commented May 5, 2026 •

edited

Loading

cursor Bot commented May 5, 2026 •

edited

Loading