@croct/sdk 0.21.0 → 0.22.0

package/trackingEvents.d.ts

@@ -67,6 +67,14 @@ type Order = {
     installments?: number;
     status?: OrderStatus;
 };
+type Point = {
+    x: number;
+    y: number;
+};
+type Size = {
+    width: number;
+    height: number;
+};
 type Gender = 'male' | 'female' | 'neutral' | 'unknown';
 declare const pageEventTypes: readonly ["pageLoaded", "pageOpened"];
 declare const tabEventTypes: readonly ["tabOpened", "tabUrlChanged", "tabVisibilityChanged"];
@@ -74,8 +82,9 @@ declare const cartEventTypes: readonly ["cartModified", "cartViewed", "checkoutS
 declare const ecommerceEventTypes: readonly ["cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed"];
 declare const identifiedUserEventTypes: string[];
 declare const userEventTypes: readonly [...string[], "userProfileChanged"];
+declare const interactionEventTypes: readonly ["userClicked", "userScrolled"];
 declare const miscEventTypes: readonly ["nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
-declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
+declare const eventTypes: readonly ["pageLoaded", "pageOpened", "cartModified", "cartViewed", "checkoutStarted", "orderPlaced", "productViewed", ...string[], "userProfileChanged", "userClicked", "userScrolled", "nothingChanged", "sessionAttributesChanged", "goalCompleted", "interestShown", "postViewed", "eventOccurred", "linkOpened", "leadGenerated"];
 interface BaseEvent {
     type: string;
 }
@@ -195,6 +204,19 @@ interface PageLoaded extends BasePageEvent {
     lastModifiedTime: number;
 }
 type PageEvent = PageLoaded | PageOpened;
+interface UserClicked extends BaseEvent {
+    type: 'userClicked';
+    point: Point;
+    surfaceSize?: Size;
+}
+interface UserScrolled extends BaseEvent {
+    type: 'userScrolled';
+    start?: Point;
+    end: Point;
+    surfaceSize?: Size;
+    viewportSize?: Size;
+}
+type InteractionEvent = UserClicked | UserScrolled;
 interface NothingChanged extends BaseEvent {
     type: 'nothingChanged';
     sinceTime: number;
@@ -256,6 +278,8 @@ type EventMap = {
     userSignedOut: UserSignedOut;
     userSignedUp: UserSignedUp;
     userProfileChanged: UserProfileChanged;
+    userClicked: UserClicked;
+    userScrolled: UserScrolled;
     productViewed: ProductViewed;
     cartViewed: CartViewed;
     cartModified: CartModified;
@@ -302,6 +326,7 @@ declare function isCartPartialEvent(event: PartialTrackingEvent): event is CartP
 type TrackingEventContext = {
     tabId: string;
     url: string;
+    timeZone?: string;
     metadata?: {
         [key: string]: string;
     };
@@ -318,4 +343,4 @@ type Beacon = {
     payload: BeaconPayload;
 };
 
-export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserEvent, type UserProfile, type UserProfileChanged, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };
+export { type Beacon, type BeaconPayload, type Cart, type CartEvent, type CartEventType, type CartItem, type CartModified, type CartViewed, type CheckoutStarted, type EcommerceEvent, type EventOccurred, type ExternalTrackingEvent, type ExternalTrackingEventPayload, type ExternalTrackingEventType, type Gender, type GoalCompleted, type IdentifiedUserEvent, type InteractionEvent, type InterestShown, type LeadGenerated, type LinkOpened, type MiscEvent, type NothingChanged, type Order, type OrderItem, type OrderPlaced, type OrderStatus, type PageEvent, type PageEventType, type PageLoaded, type PageOpened, type PartialTrackingEvent, type Point, type PostDetails, type PostViewed, type ProductDetails, type ProductViewed, type SessionAttributesChanged, type Size, type TabEvent, type TabEventType, type TabOpened, type TabUrlChanged, type TabVisibilityChanged, type TrackingEvent, type TrackingEventContext, type TrackingEventType, type UserClicked, type UserEvent, type UserProfile, type UserProfileChanged, type UserScrolled, type UserSignedIn, type UserSignedOut, type UserSignedUp, cartEventTypes, ecommerceEventTypes, eventTypes, identifiedUserEventTypes, interactionEventTypes, isCartPartialEvent, isIdentifiedUserEvent, miscEventTypes, pageEventTypes, tabEventTypes, userEventTypes };

package/trackingEvents.js

@@ -26,6 +26,10 @@ const userEventTypes = [
   ...identifiedUserEventTypes,
   "userProfileChanged"
 ];
+const interactionEventTypes = [
+  "userClicked",
+  "userScrolled"
+];
 const miscEventTypes = [
   "nothingChanged",
   "sessionAttributesChanged",
@@ -40,6 +44,7 @@ const eventTypes = [
   ...pageEventTypes,
   ...ecommerceEventTypes,
   ...userEventTypes,
+  ...interactionEventTypes,
   ...miscEventTypes
 ];
 function isIdentifiedUserEvent(event) {
@@ -53,6 +58,7 @@ export {
   ecommerceEventTypes,
   eventTypes,
   identifiedUserEventTypes,
+  interactionEventTypes,
   isCartPartialEvent,
   isIdentifiedUserEvent,
   miscEventTypes,