🤖 Merge PR DefinitelyTyped#73242 add Rokt namespace to mParticle Web SDK by @alexs-mparticle

Co-authored-by: Robert Ing <ring@mparticle.com>

Author: alexs-mparticle

types/mparticle__web-sdk/index.d.ts

@@ -3,6 +3,51 @@ import { Batch } from "@mparticle/event-models";
 // Placeholder for Dictionary-like Types
 export type Dictionary<V = any> = Record<string, V>;
 
+// Rokt Manager Types
+export type RoktPartnerAttributes = Dictionary<string | number | boolean | undefined | null>;
+
+export interface RoktPartnerExtensionData<T> {
+    [extensionName: string]: T;
+}
+
+export interface RoktSelectPlacementsOptions {
+    attributes: RoktPartnerAttributes;
+    identifier?: string;
+}
+
+export interface RoktPlacementEvent<T = void> {
+  body: T;
+  event: string;
+  placement: RoktPlacement;
+}
+
+export interface RoktSubscriber<T> {
+    subscribe(handler: T): RoktUnsubscriber;
+}
+
+export interface RoktUnsubscriber {
+    unsubscribe(): void;
+}
+
+export interface RoktPlacement {
+    id: string;
+    element: HTMLIFrameElement;
+    close(): Promise<void>;
+    on(event: string): RoktSubscriber<RoktPlacementEvent<unknown>>;
+    ready(): Promise<void>;
+    send(event: string, data?: unknown): Promise<void>;
+    onClose(): Promise<void>;
+}
+
+export interface RoktSelection {
+    close: () => 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>;
+}
+
 export as namespace mParticle;
 export {};
 export interface MPConfiguration {
@@ -309,6 +354,19 @@ interface GetSession {
     (): string;
 }
 
+// Rokt Manager Method Interfaces
+interface SelectPlacements {
+    (options: RoktSelectPlacementsOptions): Promise<RoktSelection>;
+}
+
+interface HashAttributes {
+    (attributes: RoktPartnerAttributes): Promise<Record<string, string>>;
+}
+
+interface SetExtensionData {
+    (extensionData: RoktPartnerExtensionData<unknown>): void;
+}
+
 export const endSession: EndSession;
 export const getAppName: GetAppName;
 export const getAppVersion: GetAppVersion;
@@ -491,6 +549,12 @@ export namespace eCommerce {
     const Cart: Cart;
 }
 
+export namespace Rokt {
+    const selectPlacements: SelectPlacements;
+    const hashAttributes: HashAttributes;
+    const setExtensionData: SetExtensionData;
+}
+
 export interface IdentifyRequest {
     userIdentities: UserIdentities;
 }
@@ -744,6 +808,11 @@ declare class mParticleInstance {
         setCurrencyCode: SetCurrencyCode;
         Cart: Cart;
     };
+    Rokt: {
+        selectPlacements: SelectPlacements;
+        hashAttributes: HashAttributes;
+        setExtensionData: SetExtensionData;
+    };
     PromotionType: {
         Unknown: PromotionType.Unknown;
         PromotionClick: PromotionType.PromotionClick;

types/mparticle__web-sdk/test/mparticle__web-sdk-tests.ts

@@ -193,6 +193,23 @@ mParticle.logPageView("pageName", customAttrs);
 mParticle.logPageView("pageName", customAttrs, customFlags);
 mParticle.logPageView("pageName", customAttrs, customFlags, eventOptions);
 
+mParticle.Rokt.selectPlacements({
+    identifier: "mp-test-identifier",
+    attributes: {
+        email: "test@test.com",
+    },
+});
+
+mParticle.Rokt.hashAttributes({
+    email: "test@test.com",
+});
+
+mParticle.Rokt.setExtensionData({
+    "test-extension": {
+        "test-key": "test-value",
+    },
+});
+
 mParticle.ready(() => {
     console.log("hi");
 });