🤖 Merge PR DefinitelyTyped#55040 Add Event Options to mParticle event…

… logging methods v2.13.0 (#1) by @alexs-mparticle
pimterry · Aug 9, 2021 · e8e7fb9 · e8e7fb9
1 parent cbefe78
commit e8e7fb9
Show file tree

Hide file tree

Showing 3 changed files with 98 additions and 1 deletion.
diff --git a/types/mparticle__web-sdk/index.d.ts b/types/mparticle__web-sdk/index.d.ts
@@ -48,6 +48,11 @@ export interface SDKEventCustomFlags {
         | unknown[]
         | Record<string, unknown>;
 }
+
+export interface SDKEventOptions {
+    shouldUploadEvent: boolean;
+}
+
 export interface DataPlanConfig {
     planId: string;
     planVersion?: number | undefined;
@@ -83,6 +88,7 @@ interface LogEvent {
         eventType?: EventType,
         eventInfo?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags,
+        eventOptions?: SDKEventOptions,
     ): void;
 }
 
@@ -109,8 +115,10 @@ interface LogPageView {
         eventName?: string,
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags,
+        eventOptions?: SDKEventOptions,
     ): void;
 }
+
 interface Ready {
     (callback: () => void): void;
 }
@@ -147,7 +155,7 @@ interface StopTrackingLocation {
 }
 
 interface LogBaseEvent {
-    (event: BaseEvent): void;
+    (event: BaseEvent, eventOptions?: SDKEventOptions): void;
 }
 interface Upload {
     (): void;
@@ -250,6 +258,7 @@ interface LogImpression {
         impression: Impression[] | Impression,
         attrs?: Record<string, unknown>,
         customFlags?: Record<string, unknown>,
+        eventOptions?: SDKEventOptions,
     ): void;
 }
 interface LogProductAction {
@@ -259,6 +268,7 @@ interface LogProductAction {
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags,
         transactionAttributes?: TransactionAttributes,
+        eventOptions?: SDKEventOptions,
     ): void;
 }
 interface LogPromotion {
@@ -267,6 +277,7 @@ interface LogPromotion {
         promotion: Promotion,
         attrs?: SDKEventAttrs,
         customFlags?: SDKEventCustomFlags,
+        eventOptions?: SDKEventOptions,
     ): void;
 }
 interface LogPurchase {

diff --git a/types/mparticle__web-sdk/test/mparticle__web-sdk-instance-tests.ts b/types/mparticle__web-sdk/test/mparticle__web-sdk-instance-tests.ts
@@ -25,6 +25,10 @@ const customFlags: mParticle.SDKEventCustomFlags = {
     attr5: { foo: 'bar' },
 };
 
+const eventOptions: mParticle.SDKEventOptions = {
+    shouldUploadEvent: false,
+};
+
 const identifyRequest: mParticle.IdentifyRequest = {
     userIdentities: {
         customerid: 'test',
@@ -133,6 +137,15 @@ instance.logBaseEvent({
     messageType: 1,
     eventType: 1,
 });
+instance.logBaseEvent(
+    {
+        data: {},
+        name: 'baseEventName',
+        messageType: 1,
+        eventType: 1,
+    },
+    eventOptions
+);
 
 instance.logError('Login Failed', customAttrs);
 instance.logError(
@@ -153,6 +166,13 @@ instance.logEvent(
     customAttrs,
     customFlags,
 );
+instance.logEvent(
+    'eventName',
+    mParticle.EventType.Location,
+    customAttrs,
+    customFlags,
+    eventOptions,
+);
 
 instance.logForm('click', 'eventName');
 instance.logForm('click', 'eventName', instance.EventType.Location);
@@ -176,6 +196,12 @@ instance.logPageView();
 instance.logPageView('pageName');
 instance.logPageView('pageName', customAttrs);
 instance.logPageView('pageName', customAttrs, customFlags);
+instance.logPageView(
+    'pageName',
+    customAttrs,
+    customFlags,
+    eventOptions
+);
 
 instance.ready(() => {
     console.log('hi');
@@ -402,6 +428,15 @@ instance.eCommerce.logProductAction(
     eCommerceCustomFlags,
 );
 
+instance.eCommerce.logProductAction(
+    300,
+    [product1, product2],
+    eCommerceCustomAttributes,
+    eCommerceCustomFlags,
+    transactionAttributes1,
+    eventOptions,
+);
+
 instance.eCommerce.logPurchase(
     transactionAttributes1,
     [product1, product2],
@@ -426,13 +461,21 @@ instance.eCommerce.logPromotion(
     eCommerceCustomAttributes,
     eCommerceCustomFlags,
 );
+instance.eCommerce.logPromotion(
+    instance.PromotionType.Unknown,
+    promotion1,
+    eCommerceCustomAttributes,
+    eCommerceCustomFlags,
+    eventOptions,
+);
 
 instance.eCommerce.logImpression(impression1);
 instance.eCommerce.logImpression([impression1, impression2]);
 instance.eCommerce.logImpression(
     impression1,
     eCommerceCustomAttributes,
     eCommerceCustomFlags,
+    eventOptions,
 );
 
 instance.eCommerce.logRefund(

diff --git a/types/mparticle__web-sdk/test/mparticle__web-sdk-tests.ts b/types/mparticle__web-sdk/test/mparticle__web-sdk-tests.ts
@@ -21,6 +21,10 @@ const customFlags: mParticle.SDKEventCustomFlags = {
     attr5: { foo: 'bar' },
 };
 
+const eventOptions: mParticle.SDKEventOptions = {
+    shouldUploadEvent: false,
+};
+
 const identifyRequest: mParticle.IdentifyRequest = {
     userIdentities: {
         customerid: 'test',
@@ -131,6 +135,15 @@ mParticle.logBaseEvent({
     messageType: 1,
     eventType: 1,
 });
+mParticle.logBaseEvent(
+    {
+        data: {},
+        name: 'baseEventName',
+        messageType: 1,
+        eventType: 1,
+    },
+    eventOptions
+);
 
 mParticle.logError('Login Failed', customAttrs);
 mParticle.logError(
@@ -151,6 +164,13 @@ mParticle.logEvent(
     customAttrs,
     customFlags,
 );
+mParticle.logEvent(
+    'eventName',
+    mParticle.EventType.Location,
+    customAttrs,
+    customFlags,
+    eventOptions,
+);
 
 mParticle.logForm('click', 'eventName');
 mParticle.logForm('click', 'eventName', mParticle.EventType.Location);
@@ -174,6 +194,12 @@ mParticle.logPageView();
 mParticle.logPageView('pageName');
 mParticle.logPageView('pageName', customAttrs);
 mParticle.logPageView('pageName', customAttrs, customFlags);
+mParticle.logPageView(
+    'pageName',
+    customAttrs,
+    customFlags,
+    eventOptions
+);
 
 mParticle.ready(() => {
     console.log('hi');
@@ -400,6 +426,15 @@ mParticle.eCommerce.logProductAction(
     eCommerceCustomFlags,
 );
 
+mParticle.eCommerce.logProductAction(
+    300,
+    [product1, product2],
+    eCommerceCustomAttributes,
+    eCommerceCustomFlags,
+    transactionAttributes1,
+    eventOptions,
+);
+
 mParticle.eCommerce.logPurchase(
     transactionAttributes1,
     [product1, product2],
@@ -424,13 +459,21 @@ mParticle.eCommerce.logPromotion(
     eCommerceCustomAttributes,
     eCommerceCustomFlags,
 );
+mParticle.eCommerce.logPromotion(
+    mParticle.PromotionType.Unknown,
+    promotion1,
+    eCommerceCustomAttributes,
+    eCommerceCustomFlags,
+    eventOptions,
+);
 
 mParticle.eCommerce.logImpression(impression1);
 mParticle.eCommerce.logImpression([impression1, impression2]);
 mParticle.eCommerce.logImpression(
     impression1,
     eCommerceCustomAttributes,
     eCommerceCustomFlags,
+    eventOptions,
 );
 
 mParticle.eCommerce.logRefund(