Skip to content

refactor: migrate helpers module to TS #1273

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 3 commits into
base: development
Choose a base branch
from
Open

refactor: migrate helpers module to TS #1273

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9e7e1ba
refactor: migrate helpers module to TS
jaissica12 May 13, 2026
f2db5a6
refactor: convert tests-helpers.js to TypeScript
jaissica12 May 13, 2026
354bfb4
replace self alias with arrow functions in helpers
jaissica12 May 26, 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
2 changes: 1 addition & 1 deletion src/consent.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ export interface IConsentStateV2DTO {
}

export interface IConsentRulesValues {
consentPurpose: string;
consentPurpose: string | number;
hasConsented: boolean;
}
export interface IConsentRules {
Expand Down
112 changes: 66 additions & 46 deletions src/helpers.js → src/helpers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,19 @@ import Constants from './constants';
import * as utils from './utils';
import Validators from './validators';
import KitFilterHelper from './kitFilterHelper';
import { IMParticleWebSDKInstance } from './mp-instance';
import { SDKHelpersApi } from './sdkRuntimeModels';
import { Dictionary } from './utils';
import { IMParticleUser } from './identity-user-interfaces';
import { MPID } from '@mparticle/web-sdk';

var StorageNames = Constants.StorageNames;
const StorageNames = Constants.StorageNames;

export default function Helpers(mpInstance) {
var self = this;
this.canLog = function() {
export default function Helpers(
this: SDKHelpersApi,
mpInstance: IMParticleWebSDKInstance
): void {
this.canLog = function(): boolean {
if (
mpInstance._Store.isEnabled &&
(mpInstance._Store.devToken ||
Expand All @@ -20,25 +27,25 @@ export default function Helpers(mpInstance) {
return false;
};

this.getFeatureFlag = function(feature) {
this.getFeatureFlag = function(feature: string): boolean | string | null {
if (mpInstance._Store.SDKConfig.flags.hasOwnProperty(feature)) {
return mpInstance._Store.SDKConfig.flags[feature];
}
return null;
};

this.invokeCallback = function(
callback,
code,
body,
mParticleUser,
previousMpid
) {
this.invokeCallback = (
callback: Function,
code: number,
body: string,
mParticleUser?: IMParticleUser,
previousMpid?: MPID
): void => {
if (!callback) {
mpInstance.Logger.warning('There is no callback provided');
}
try {
if (self.Validators.isFunction(callback)) {
if (this.Validators.isFunction(callback)) {
callback({
httpCode: code,
body: body,
Expand All @@ -51,9 +58,9 @@ export default function Helpers(mpInstance) {
},
getPreviousUser: function() {
if (!previousMpid) {
var users = mpInstance.Identity.getUsers();
var mostRecentUser = users.shift();
var currentUser =
const users = mpInstance.Identity.getUsers();
const mostRecentUser = users.shift();
const currentUser =
mParticleUser ||
mpInstance.Identity.getCurrentUser();
if (
Expand All @@ -62,7 +69,7 @@ export default function Helpers(mpInstance) {
mostRecentUser.getMPID() ===
currentUser.getMPID()
) {
mostRecentUser = users.shift();
return users.shift() || null;
}
return mostRecentUser || null;
} else {
Expand All @@ -78,13 +85,17 @@ export default function Helpers(mpInstance) {
}
};

this.invokeAliasCallback = function(callback, code, message) {
this.invokeAliasCallback = (
callback: Function,
code: number,
message?: string
): void => {
if (!callback) {
mpInstance.Logger.warning('There is no callback provided');
}
try {
if (self.Validators.isFunction(callback)) {
var callbackMessage = {
if (this.Validators.isFunction(callback)) {
const callbackMessage: Dictionary = {
httpCode: code,
};
if (message) {
Expand All @@ -101,12 +112,15 @@ export default function Helpers(mpInstance) {

this.extend = utils.extend;

this.createServiceUrl = function(secureServiceUrl, devToken) {
var serviceScheme =
this.createServiceUrl = function(
secureServiceUrl: string,
devToken?: string
): string {
const serviceScheme =
window.mParticle && mpInstance._Store.SDKConfig.forceHttps
? 'https://'
: window.location.protocol + '//';
var baseUrl;
let baseUrl: string;
if (mpInstance._Store.SDKConfig.forceHttps) {
baseUrl = 'https://' + secureServiceUrl;
} else {
Expand All @@ -118,8 +132,8 @@ export default function Helpers(mpInstance) {
return baseUrl;
};

this.createXHR = function(cb) {
var xhr;
this.createXHR = function(cb: () => void): XMLHttpRequest {
let xhr: XMLHttpRequest;

try {
xhr = new window.XMLHttpRequest();
Expand All @@ -129,11 +143,11 @@ export default function Helpers(mpInstance) {

if (xhr && cb && 'withCredentials' in xhr) {
xhr.onreadystatechange = cb;
} else if (typeof window.XDomainRequest !== 'undefined') {
} else if (typeof (window as Dictionary).XDomainRequest !== 'undefined') {
mpInstance.Logger.verbose('Creating XDomainRequest object');

try {
xhr = new window.XDomainRequest();
xhr = new (window as Dictionary).XDomainRequest();
xhr.onload = cb;
} catch (e) {
mpInstance.Logger.error('Error creating XDomainRequest object');
Expand All @@ -143,17 +157,20 @@ export default function Helpers(mpInstance) {
return xhr;
};

this.filterUserIdentities = function(userIdentitiesObject, filterList) {
var filteredUserIdentities = [];
this.filterUserIdentities = (
userIdentitiesObject: Dictionary<string>,
filterList: number[]
): Array<{ Type: number; Identity: string }> => {
const filteredUserIdentities: Array<{ Type: number; Identity: string }> = [];

if (userIdentitiesObject && Object.keys(userIdentitiesObject).length) {
for (var userIdentityName in userIdentitiesObject) {
for (const userIdentityName in userIdentitiesObject) {
if (userIdentitiesObject.hasOwnProperty(userIdentityName)) {
var userIdentityType = Types.IdentityType.getIdentityType(
const userIdentityType = Types.IdentityType.getIdentityType(
userIdentityName
);
if (!self.inArray(filterList, userIdentityType)) {
var identity = {
if (!this.inArray(filterList, userIdentityType)) {
const identity = {
Type: userIdentityType,
Identity: userIdentitiesObject[userIdentityName],
};
Expand All @@ -176,8 +193,8 @@ export default function Helpers(mpInstance) {
KitFilterHelper.filterUserIdentities;
this.filterUserAttributes = KitFilterHelper.filterUserAttributes;

this.isEventType = function(type) {
for (var prop in Types.EventType) {
this.isEventType = function(type: number): boolean {
for (const prop in Types.EventType) {
if (Types.EventType.hasOwnProperty(prop)) {
if (Types.EventType[prop] === type) {
return true;
Expand All @@ -187,18 +204,21 @@ export default function Helpers(mpInstance) {
return false;
};

this.sanitizeAttributes = function(attrs, name) {
if (!attrs || !self.isObject(attrs)) {
this.sanitizeAttributes = (
attrs: Dictionary,
name: string
): Dictionary<string> | null => {
if (!attrs || !this.isObject(attrs)) {
return null;
}

var sanitizedAttrs = {};
const sanitizedAttrs: Dictionary<string> = {};

for (var prop in attrs) {
for (const prop in attrs) {
// Make sure that attribute values are not objects or arrays, which are not valid
if (
attrs.hasOwnProperty(prop) &&
self.Validators.isValidAttributeValue(attrs[prop])
this.Validators.isValidAttributeValue(attrs[prop])
) {
sanitizedAttrs[prop] = attrs[prop];
} else {
Expand All @@ -216,17 +236,17 @@ export default function Helpers(mpInstance) {
};

this.isDelayedByIntegration = function(
delayedIntegrations,
timeoutStart,
now
) {
delayedIntegrations: Dictionary<boolean>,
timeoutStart: number,
now: number
): boolean {
if (
now - timeoutStart >
mpInstance._Store.SDKConfig.integrationDelayTimeout
) {
return false;
}
for (var integration in delayedIntegrations) {
for (const integration in delayedIntegrations) {
if (delayedIntegrations[integration] === true) {
return true;
} else {
Expand All @@ -236,7 +256,7 @@ export default function Helpers(mpInstance) {
return false;
};

this.createMainStorageName = function(workspaceToken) {
this.createMainStorageName = function(workspaceToken: string): string {
if (workspaceToken) {
return StorageNames.currentStorageName + '_' + workspaceToken;
} else {
Expand Down
32 changes: 24 additions & 8 deletions src/sdkRuntimeModels.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -161,9 +161,9 @@ export interface SDKProductAction {
}

export interface SDKProduct {
Sku: string;
Name: string;
Price: number;
Sku?: string;
Name?: string;
Price?: number;
Quantity?: number;
Brand?: string;
Variant?: string;
Expand All @@ -173,7 +173,7 @@ export interface SDKProduct {
TotalAmount?: number;

// https://go.mparticle.com/work/SQDSDKS-4801
Attributes?: Record<string, unknown>;
Attributes?: Record<string, unknown> | null;
}

// https://go.mparticle.com/work/SQDSDKS-6949
Expand Down Expand Up @@ -253,7 +253,7 @@ export interface MParticleWebSDK {
startTrackingLocation(callback?: Callback): void;

stopTrackingLocation(): void;
generateHash(value: string): string;
generateHash(value: string): number;
setIntegrationAttribute(
integrationModuleId: number,
attrs: IntegrationAttribute
Expand Down Expand Up @@ -306,7 +306,7 @@ export const LogLevelType = {
// Currently, this extends MPConfiguration in @types/mparticle__web-sdk
// and the two will be merged in once the Store module is refactored
export interface SDKInitConfig
extends Omit<MPConfiguration, 'dataPlan' | 'logLevel' | 'identityCallback'> {
extends Omit<MPConfiguration, 'dataPlan' | 'logLevel'> {
dataPlan?: DataPlanConfig | KitBlockerDataPlan; // TODO: These should be eventually split into two different attributes
logLevel?: LogLevelType;

Expand Down Expand Up @@ -363,9 +363,21 @@ export interface SDKHelpersApi {
findKeyInObject?(obj: any, key: string): string;
parseNumber?(value: string | number): number;
generateUniqueId();
generateHash?(value: string): string;
generateHash?(value: string): number;
// https://go.mparticle.com/work/SQDSDKS-6317
getFeatureFlag?(feature: string): boolean | string; // TODO: Feature Constants should be converted to enum
decoded?(s: string): string;
parseStringOrNumber?(value: string): string | number;
inArray?(items: number[], value: number): boolean;
converted?(s: string): string;
filterUserIdentitiesForForwarders?(
userIdentities: Dictionary,
filterList: number[]
): Dictionary;
filterUserAttributes?(
userAttributes: Dictionary,
filterList: number[]
): Dictionary;
invokeAliasCallback(
aliasCallback: IAliasCallback,
number: number,
Expand All @@ -376,8 +388,12 @@ export interface SDKHelpersApi {
timeoutStart: number,
now: number
): boolean;
isEventType?(type: valueof<typeof EventType>): boolean;
isEventType?(type: number | valueof<typeof EventType>): boolean;
isObject?(item: any);
filterUserIdentities?(
userIdentitiesObject: Dictionary<string>,
filterList: number[]
): Array<{ Type: number; Identity: string }>;
invokeCallback?(
callback: IdentityCallback,
code: number,
Expand Down
Loading