fix: resolve TypeScript build errors in type declarations by alexs-mparticle · Pull Request #1326 · mParticle/mparticle-web-sdk

alexs-mparticle · 2026-08-18T15:21:56Z

Summary

Fix generateHash interface return type (string → number) to match the implementation in utils.ts
Rename request_timestamp_ms → request_timestamp_unixtime_ms in identity.js to satisfy IIdentityAPIRequestData
Fix convertProductActionToEventType/convertPromotionActionToEventType return types: typeof CommerceEventType (namespace object) → valueof<typeof CommerceEventType> (a member value)
Fix createIdentityChanges return type in IIdentityRequest: single object → IIdentityAPIIdentityChangeData[] (it actually returns an array)
Add JSDoc return types to persistence.getLocalStorage, helpers.sanitizeAttributes, and identity.mParticleUser/mParticleUserCart to unblock TS9005 declaration emit
Cast window.mParticle as any when accessing internal pre-init properties (config, isIOS, Store, _BatchValidator) not on the public @types/mparticle__web-sdk type
Widen IConsentRulesValues.consentPurpose to string | number — tests use generateHash() (returns number); JS auto-coerces numbers to strings as object keys so both work at runtime

Test Plan

npm run build — clean, zero errors
npm run build:types — clean, zero TypeScript errors
npm run test:jest — 540 tests passing across 23 suites

cursor · 2026-08-18T15:22:02Z

PR Summary

Low Risk
Changes are compile-time typing and test fixtures; runtime identity payloads and hashing behavior are unchanged aside from explicit string coercion in tests.

Overview
Aligns TypeScript interfaces with runtime behavior so build:types and declaration emit succeed without changing SDK logic.

Public/runtime model updates include generateHash returning number (matching utils.ts), commerce helper return types using valueof<typeof …> instead of typeof on enum-like objects, and identity API shapes (request_timestamp_ms, environment as string, identity_type as string, createIdentityChanges as an array with a fixed parameter name).

Internal wiring uses as unknown as casts when assigning concrete classes (Persistence, Helpers, Identity) to their interface types on the instance. window.mParticle is accessed via IMParticleInstanceManager instead of untyped property access for pre-init fields (config, isIOS, Store, _BatchValidator).

Tests that build consent rule payloads now String(mParticle.generateHash(...)) so consent purpose keys stay strings after the hash type correction.

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

- Fix generateHash interface return type (string → number) to match implementation - Rename request_timestamp_ms → request_timestamp_unixtime_ms in identity.js to match IIdentityAPIRequestData - Fix convertProductActionToEventType/convertPromotionActionToEventType return types (typeof Enum → valueof<typeof Enum>) - Fix createIdentityChanges return type (single object → array) in IIdentityRequest - Add JSDoc return types to persistence.getLocalStorage, helpers.sanitizeAttributes, identity.mParticleUser/mParticleUserCart to unblock declaration emit - Cast window.mParticle to any when accessing internal pre-init properties (config, isIOS, Store, _BatchValidator) not in public type - Widen IConsentRulesValues.consentPurpose to string | number to reflect JS key coercion behaviour

cursor

Cursor Bugbot has reviewed your changes using default effort and found 1 potential issue.

^{❌ 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 8ad352f. Configure here.}

- Revert IConsentRulesValues.consentPurpose to string; the number widening was unnecessary since hashConsentPurposeConditionalForwarding always returns .toString() - Fix tests-cookie-syncing to wrap generateHash() in String() to match

rmi22186 · 2026-08-18T19:01:44Z

Remove Environment, like the bot says, not that you're not using it

Although is there a reason to not use it?

rmi22186 · 2026-08-18T19:02:38Z

                    : 'production',
                request_id: mpInstance._Helpers.generateUniqueId(),
-                request_timestamp_ms: new Date().getTime(),
+                request_timestamp_unixtime_ms: new Date().getTime(),


rmi22186 · 2026-08-18T19:03:48Z

-        if (window.mParticle && window.mParticle.config) {
-            if (window.mParticle.config.hasOwnProperty('rq')) {
-                this._preInit.readyQueue = window.mParticle.config.rq;
+        const winMp = window.mParticle as any;


Shouldn't we not be using any if possible? why the reason for this change?

rmi22186 · 2026-08-18T19:04:01Z

-            window.mParticle && window.mParticle.config
-                ? window.mParticle.config
-                : {};
+        const winMp = window.mParticle as any;


The runtime field name request_timestamp_ms is correct per the IDSync API contract. The interface had the wrong name (request_timestamp_unixtime_ms); fix the interface and tests to match, not the other way around. Also remove unused Environment import from identity.interfaces.ts.

rmi22186 · 2026-08-18T19:05:16Z

     */
    this.init = function(apiKey, config, instanceName) {
-        if (!config && (window.mParticle && window.mParticle.config)) {
+        const winMp = window.mParticle as any;


rmi22186 · 2026-08-18T19:05:29Z

-                window.mParticle && window.mParticle.isIOS
-                    ? window.mParticle.isIOS
-                    : false;
+            const winMp = window.mParticle as any;


The public @types/mparticle__web-sdk type does not include internal properties (config, isIOS, Store, _BatchValidator). IMParticleInstanceManager already declares all of them, so cast to that instead of any.

The tsc declaration emit step uses || true so these errors are non-fatal. No annotations needed in JS files.

TypeScript cannot verify that JS module implementations satisfy TS interfaces. Cast _Persistence, _Helpers, and _Identity at their assignment sites so declaration emit does not fail on type mismatches caused by untyped JS return inference.

sonarqubecloud · 2026-08-18T19:24:39Z

Quality Gate failed

Failed conditions
52.1% Duplication on New Code (required ≤ 3%)

See analysis details on SonarQube Cloud

alexs-mparticle requested a review from a team as a code owner August 18, 2026 15:21

alexs-mparticle force-pushed the fix/build-errors branch from 0109bad to 8ad352f Compare August 18, 2026 15:24

cursor Bot reviewed Aug 18, 2026

View reviewed changes

Comment thread src/identity.js Outdated

alexs-mparticle changed the base branch from master to development August 18, 2026 18:41

rmi22186 reviewed Aug 18, 2026

View reviewed changes

alexs-mparticle added 3 commits August 18, 2026 15:10

fix: cast window.mParticle to IMParticleInstanceManager instead of any

c191c0f

The public @types/mparticle__web-sdk type does not include internal properties (config, isIOS, Store, _BatchValidator). IMParticleInstanceManager already declares all of them, so cast to that instead of any.

fix: remove JSDoc @returns annotations from JS files

a61fb7c

The tsc declaration emit step uses || true so these errors are non-fatal. No annotations needed in JS files.

Navigation Menu

Uh oh!

fix: resolve TypeScript build errors in type declarations - #1326

fix: resolve TypeScript build errors in type declarations#1326
alexs-mparticle wants to merge 6 commits into
developmentfrom
fix/build-errors

alexs-mparticle commented Aug 18, 2026

Uh oh!

cursor Bot commented Aug 18, 2026 •

edited

Loading

Uh oh!

cursor Bot left a comment

Uh oh!

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

rmi22186 Aug 18, 2026

Uh oh!

sonarqubecloud Bot commented Aug 18, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Uh oh!

Conversation

alexs-mparticle commented Aug 18, 2026

Summary

Test Plan

Uh oh!

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

Uh oh!

PR Summary

Uh oh!

cursor Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

rmi22186 Aug 18, 2026

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud Bot commented Aug 18, 2026

Quality Gate failed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

cursor Bot commented Aug 18, 2026 •

edited

Loading