Skip to content

refactor: convert events module to TS #1258

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jaissica12 wants to merge 9 commits into
base: development
Choose a base branch
from
Open

refactor: convert events module to TS #1258

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
6f952d8
refactor: convert events module to TS
jaissica12 Apr 13, 2026
469e728
fix SonarCloud issues
jaissica12 May 13, 2026
8ad6296
fix failing tests
jaissica12 May 13, 2026
4de7ee4
fix SonarCloud warnings
jaissica12 May 13, 2026
14dfc68
improve type safety in events module
jaissica12 May 13, 2026
12da570
use arrow functions to preserve this context and handle SDKProductImp…
jaissica12 May 13, 2026
272342c
address PR comments
jaissica12 May 20, 2026
3443450
revert PromotionActionType type tightening to avoid downstream build …
jaissica12 May 20, 2026
d6ac4c2
convert addEventHandler to arrow function
jaissica12 May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 12 additions & 5 deletions src/events.interfaces.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
import {
Callback,
SDKEventAttrs,
SDKEventOptions,
TransactionAttributes,
Expand All @@ -8,13 +7,20 @@ import {
BaseEvent,
SDKEvent,
SDKEventCustomFlags,
SDKImpression,
SDKProduct,
SDKProductImpression,
SDKPromotion,
} from './sdkRuntimeModels';
import { valueof } from './utils';
import { EventType, ProductActionType, PromotionActionType } from './types';

export type TrackingCallback = ((
position?: GeolocationPosition | {
coords: { latitude: number | string; longitude: number | string };
}
) => void) | null;

// Supports wrapping event handlers functions that will ideally return a specific type
type EventHandlerFunction<T> = (element: HTMLLinkElement | HTMLFormElement) => T;

Expand Down Expand Up @@ -45,11 +51,12 @@ export interface IEvents {
): void;
logEvent(event: BaseEvent, eventOptions?: SDKEventOptions): void;
logImpressionEvent(
impression: SDKProductImpression,
// https://go/j/SDKE-1199
impression: SDKImpression | SDKImpression[] | SDKProductImpression | SDKProductImpression[],
Copy link
Copy Markdown
Collaborator

@alexs-mparticle alexs-mparticle May 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I brought this up with @rmi22186 earlier. I would like for us to not support both arrays and non-arrays for these endpoints, but that might have to be a follow up project.

Copy link
Copy Markdown
Contributor Author

@jaissica12 jaissica12 May 20, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Created a follow-up ticket to track this: https://go/j/SDKE-1199

attrs?: SDKEventAttrs,
customFlags?: SDKEventCustomFlags,
eventOptions?: SDKEventOptions
);
): void;
logOptOut(): void;
logProductActionEvent(
productActionType: valueof<typeof ProductActionType>,
Expand All @@ -61,7 +68,7 @@ export interface IEvents {
): void;
logPromotionEvent(
promotionType: valueof<typeof PromotionActionType>,
promotion: SDKPromotion,
promotion: SDKPromotion | SDKPromotion[],
attrs?: SDKEventAttrs,
customFlags?: SDKEventCustomFlags,
eventOptions?: SDKEventOptions
Expand All @@ -78,6 +85,6 @@ export interface IEvents {
attrs?: SDKEventAttrs,
customFlags?: SDKEventCustomFlags
): void;
startTracking(callback: Callback): void;
startTracking(callback: TrackingCallback): void;
stopTracking(): void;
}
Loading
Loading