🤖 Merge PR DefinitelyTyped#74401 Sync types with mparticle-web-sdk by @jaissica12

Author: jaissica12

types/mparticle__web-sdk/index.d.ts

@@ -4,17 +4,17 @@ import { Batch } from "@mparticle/event-models";
 export type Dictionary<V = any> = Record<string, V>;
 
 // Rokt Manager Types
-export type RoktAttributeValueArray = Array<string | number | boolean | Dictionary>;
+export type RoktAttributeValueArray = Array<string | number | boolean>;
 export type RoktAttributeValueType = string | number | boolean | undefined | null;
 export type RoktAttributeValue = RoktAttributeValueType | RoktAttributeValueArray;
-export type RoktPartnerAttributes = Record<string, RoktAttributeValue>;
+export type RoktAttributes = Record<string, RoktAttributeValue>;
 
 export interface RoktPartnerExtensionData<T> {
     [extensionName: string]: T;
 }
 
 export interface RoktSelectPlacementsOptions {
-    attributes: RoktPartnerAttributes;
+    attributes: RoktAttributes;
     identifier?: string;
 }
 
@@ -43,16 +43,25 @@ export interface RoktPlacement {
 }
 
 export interface RoktSelection {
-    close: () => void;
-    getPlacements: () => Promise<Array<RoktPlacement>>;
+    close(): Promise<void>;
+    getPlacements(): Promise<Array<RoktPlacement>>;
     on(eventName: string): RoktSubscriber<RoktPlacementEvent<unknown>>;
     ready(): Promise<void>;
     send(event: string, data?: unknown): Promise<void>;
-    setAttributes(attributes: RoktPartnerAttributes): Promise<void>;
+    setAttributes(attributes: RoktAttributes): Promise<void>;
 }
 
 export as namespace mParticle;
 export {};
+
+export interface LauncherOptions {
+    noTargeting?: boolean | undefined;
+    noFunctional?: boolean | undefined;
+    [key: string]: unknown;
+}
+
+export type AliasRequestScope = "device" | "mpid";
+
 export interface MPConfiguration {
     isDevelopmentMode?: boolean | undefined;
     identifyRequest?: IdentifyRequest | undefined;
@@ -89,10 +98,53 @@ export interface MPConfiguration {
      * @warning only change minWebviewBridgeVersion if you are absolutely sure you know what you are doing
      */
     minWebviewBridgeVersion?: 1 | 2 | undefined;
+    // Additional configuration options
+    aliasMaxWindow?: number | undefined;
+    forceHttps?: boolean | undefined;
+    integrationDelayTimeout?: number | undefined;
+    isIOS?: boolean | undefined;
+    maxProducts?: number | undefined;
+    requestConfig?: boolean | undefined;
+    useNativeSdk?: boolean | undefined;
+    domain?: string | undefined;
+    userAudienceUrl?: string | undefined;
+    flags?: Dictionary | undefined;
+    launcherOptions?: LauncherOptions | undefined;
+    RoktExtensions?: Array<string> | undefined;
 }
 
 export type MPForwarder = Dictionary;
 
+export interface KitFilterSettings {
+    eventTypeFilters: number[];
+    eventNameFilters: number[];
+    screenNameFilters: number[];
+    screenAttributeFilters: number[];
+    userIdentityFilters: number[];
+    userAttributeFilters: number[];
+    attributeFilters: number[];
+    consentRegulationFilters: number[];
+    consentRegulationPurposeFilters: number[];
+    messageTypeFilters: number[];
+    messageTypeStateFilters: number[];
+    filteringEventAttributeValue: Record<string, unknown>;
+    filteringUserAttributeValue: Record<string, unknown>;
+    filteringConsentRuleValues: Record<string, unknown>;
+}
+
+export class MPSideloadedKit {
+    constructor(kitInstance: MPForwarder);
+    kitInstance: MPForwarder;
+    filterDictionary: KitFilterSettings;
+    addEventTypeFilter(eventType: EventType): void;
+    addEventNameFilter(eventType: EventType, eventName: string): void;
+    addEventAttributeFilter(eventType: EventType, eventName: string, customAttributeKey: string): void;
+    addScreenNameFilter(screenName: string): void;
+    addScreenAttributeFilter(screenName: string, screenAttribute: string): void;
+    addUserIdentityFilter(userIdentity: IdentityType): void;
+    addUserAttributeFilter(userAttributeKey: string): void;
+}
+
 export interface Logger {
     error?: ((error: string) => void) | undefined;
     warning?: ((error: string) => void) | undefined;
@@ -215,32 +267,36 @@ interface Upload {
     (): void;
 }
 
+interface GenerateHash {
+    (value: string): string;
+}
+
 interface CreateConsentState {
     (): ConsentState;
 }
 interface CreateGDPRConsent {
     (
         consented: boolean,
-        timestamp: number,
-        consentDocument: string,
-        location: string,
-        hardwareId: string,
+        timestamp?: number,
+        consentDocument?: string,
+        location?: string,
+        hardwareId?: string,
     ): PrivacyConsentState;
 }
 interface CreateCCPAConsent {
     (
         consented: boolean,
-        timestamp: number,
-        consentDocument: string,
-        location: string,
-        hardwareId: string,
+        timestamp?: number,
+        consentDocument?: string,
+        location?: string,
+        hardwareId?: string,
     ): PrivacyConsentState;
 }
 interface AliasUsers {
     (aliasRequest: UserAliasRequest, callback?: AliasUsersCallback): void;
 }
 interface CreateAliasRequest {
-    (sourceUser: User, destinationUser: User): UserAliasRequest;
+    (sourceUser: User, destinationUser: User, scope?: AliasRequestScope): UserAliasRequest;
 }
 
 interface GetCurrentUser {
@@ -367,7 +423,11 @@ interface Use {
 }
 
 interface HashAttributes {
-    (attributes: RoktPartnerAttributes): Promise<Record<string, string>>;
+    (attributes: RoktAttributes): Promise<Record<string, string>>;
+}
+
+interface HashSha256 {
+    (attribute: RoktAttributeValueType): Promise<string | undefined | null>;
 }
 
 interface SetExtensionData {
@@ -382,6 +442,7 @@ export const setDeviceId: SetDeviceId;
 export const getEnvironment: GetEnvironment;
 export function getInstance(instanceName?: string): mParticleInstance;
 export const getVersion: GetVersion;
+export const generateHash: GenerateHash;
 /**
  * @warning You should only use mParticle.init if you are in a self-hosted environment. https://docs.mparticle.com/developers/sdk/web/self-hosting/
  */
@@ -414,7 +475,6 @@ export const upload: Upload;
 // Future optional changes once we migrate all core SDK files to TS. These are used internally only and should not be used by consumers of mParticle
 // export function addForwarder
 // export function configurePixel
-// export function generateHash
 // export function _setIntegrationDelay
 // export function _getIntegrationDelay
 
@@ -436,17 +496,21 @@ export interface ConsentState {
     getCCPAConsentState: () => CCPAConsentState;
     removeGDPRConsentState: (purpose: string) => ConsentState;
     removeCCPAConsentState: () => ConsentState;
+    /**
+     * @deprecated Use removeCCPAConsentState instead
+     */
+    removeCCPAState?: () => ConsentState;
 }
 
 export interface GDPRConsentState {
     [key: string]: PrivacyConsentState;
 }
 export interface PrivacyConsentState {
     Consented: boolean;
-    Timestamp: number;
-    ConsentDocument: string;
-    Location: string;
-    HardwareId: string;
+    Timestamp?: number;
+    ConsentDocument?: string;
+    Location?: string;
+    HardwareId?: string;
 }
 export type CCPAConsentState = PrivacyConsentState;
 
@@ -532,8 +596,8 @@ export enum ProductActionType {
 
 export enum PromotionType {
     Unknown = 0,
-    PromotionClick = 1,
-    PromotionView = 2,
+    PromotionView = 1,
+    PromotionClick = 2,
 }
 
 export namespace eCommerce {
@@ -559,6 +623,7 @@ export namespace eCommerce {
 export namespace Rokt {
     const selectPlacements: SelectPlacements;
     const hashAttributes: HashAttributes;
+    const hashSha256: HashSha256;
     const setExtensionData: SetExtensionData;
     const use: Use;
 }
@@ -589,6 +654,7 @@ export interface User {
     isLoggedIn: () => boolean;
     getLastSeenTime: () => number;
     getFirstSeenTime: () => number;
+    getUserAudiences?: (callback?: IdentityCallback) => void;
 }
 export type UserAttributesValue = string | number | boolean | null;
 export type AllUserAttributes = Record<string, UserAttributesValue | UserAttributesValue[]>;
@@ -629,6 +695,10 @@ interface Cart {
      * @deprecated Cart persistence in mParticle has been deprecated.
      */
     clear: () => void;
+    /**
+     * @deprecated Cart Products have been deprecated
+     */
+    getCartProducts?: () => Product[];
 }
 
 export interface Product {
@@ -722,7 +792,7 @@ export interface IdentityResult {
     httpCode: any;
     getPreviousUser(): User;
     getUser(): User;
-    body: IdentityResultBody;
+    body: IdentityResultBody | IdentityModifyResultBody;
 }
 
 export interface IdentityResultBody {
@@ -731,14 +801,22 @@ export interface IdentityResultBody {
     is_logged_in: boolean;
     // matched_identities should be UserIdentities + mpid, for not keep as object
     matched_identities: Record<string, unknown>;
+    mpid?: MPID;
+}
+
+export interface IdentityModifyResultBody {
+    change_results?: {
+        identity_type: string;
+        modified_mpid: MPID;
+    };
 }
 
 export interface UserAliasRequest {
     destinationMpid: string;
     sourceMpid: string;
     startTime: number;
     endTime: number;
-    scope?: string;
+    scope?: AliasRequestScope;
 }
 
 export interface AliasUsersCallback {
@@ -755,6 +833,7 @@ declare class mParticleInstance {
     setDeviceId: SetDeviceId;
     getEnvironment: GetEnvironment;
     getVersion: GetVersion;
+    generateHash: GenerateHash;
     init: Init;
     isInitialized: IsInitialized;
     logBaseEvent: LogBaseEvent;
@@ -783,7 +862,6 @@ declare class mParticleInstance {
     // Future optional changes once we migrate all core SDK files to TS. These are used internally only and should not be used by consumers of mParticle
     // export function addForwarder
     // export function configurePixel
-    // export function generateHash
     // export function _setIntegrationDelay
     // export function _getIntegrationDelay
 
@@ -821,13 +899,15 @@ declare class mParticleInstance {
     Rokt: {
         selectPlacements: SelectPlacements;
         hashAttributes: HashAttributes;
+        hashSha256: HashSha256;
         setExtensionData: SetExtensionData;
         use: Use;
     };
+    MPSideloadedKit: typeof MPSideloadedKit;
     PromotionType: {
         Unknown: PromotionType.Unknown;
-        PromotionClick: PromotionType.PromotionClick;
         PromotionView: PromotionType.PromotionView;
+        PromotionClick: PromotionType.PromotionClick;
     };
     ProductActionType: {
         Unknown: ProductActionType.Unknown;