@surfside/surfside-events 1.0.0 → 2.1.0

package/README.md

@@ -21,7 +21,7 @@ npm install @surfside/surfside-events
 Use the available functions from this package to track to all trackers which have been initialized with this plugin:
 
 ```js
-import { addProduct, addPromo, setAction } from '@surfside/browser-plugin-surfside';
+import { addProduct, addPromo, setAction } from '@surfside/surfside-events';
 
 addProduct({
   id: 'P12345',

package/dist/index.module.d.ts

@@ -168,6 +168,63 @@ interface segmentContext {
  * @param trackers - The tracker identifiers which the context will be stored against
  */
 declare function segment(context?: segmentContext, trackers?: Array<string>): void;
+/**
+ * Removes a Surfside Segment Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function removeSegment(context?: segmentContext, trackers?: Array<string>): void;
+/**
+ * A Surfside Local Business Location Context
+ */
+interface localBusinessLocationContext {
+    /** The Location ID */
+    id?: string;
+    /** The Location Latitude */
+    latitude?: string;
+    /** The Location Longitude */
+    longitude?: string;
+    /** The Location Country Code */
+    country_code?: string;
+    /** The Location Zip */
+    zip?: string;
+    /** The Location State Label */
+    state_label?: string;
+    /** The Location State */
+    state?: string;
+    /** The Location City */
+    city?: string;
+    /** The Location Street */
+    street?: string;
+    /** The Location Name */
+    name?: string;
+    /** The Location Parent */
+    parent?: string;
+    /** The Location Type */
+    type?: string;
+    /** The Location Category */
+    category?: string;
+}
+declare global {
+    interface Window {
+        surf: any;
+    }
+}
+/**
+ * Adds a Surfside  Local Business Location Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function setLocation(context?: localBusinessLocationContext, trackers?: Array<string>): void;
+/**
+ * Removes a Surfside  Local Business Location Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+declare function removeLocation(context?: localBusinessLocationContext, trackers?: Array<string>): void;
 /**
  * A Surfside User Context
  */
@@ -192,6 +249,8 @@ interface userContext {
     userId?: string;
     /** The last name of the user */
     lastName?: string;
+    /** The phone number of the user */
+    phone?: string;
 }
 /**
  * Adds a Surfside User Context
@@ -200,6 +259,11 @@ interface userContext {
  * @param trackers - The tracker identifiers which the context will be stored against
  */
 declare function setUser(context?: userContext, trackers?: Array<string>): void;
+interface SurfIdContextRequest {
+    email?: string;
+    phone?: string;
+}
+declare function setSurfId(context?: SurfIdContextRequest, trackers?: Array<string>): void;
 /**
  * A Surfside User Context
  */
@@ -242,4 +306,136 @@ interface identifyUserContext {
  * @param trackers - The tracker identifiers which the context will be stored against
  */
 declare function identifyUser(context?: identifyUserContext, trackers?: Array<string>): void;
-export { SurfsideCommercePlugin, commerceAction, setCommerceAction, commerceTransactionContext, addTransaction, commerceImpressionContext, addImpression, commerceProductContext, addProduct, commercePromoContext, addPromotion, sourceContext, source, segmentContext, segment, userContext, setUser, identifyUserContext, identifyUser };
+type AuctionInitEvent = {
+    auctionId: string;
+    timestamp: number;
+    auctionStatus: string;
+    adUnits: AuctionInitEventAdUnit[];
+    bidderRequests: AdUnitBidderRequest[];
+};
+type AuctionInitEventAdUnit = {
+    requestId: string;
+    mediaTypes: object;
+    bids: AdUnitBid[];
+    timeout: number;
+    sizes: number[][];
+    transactionId: string;
+};
+type AdUnitBid = {
+    params: object;
+    user: object;
+};
+type AdUnitBidderRequest = {
+    bidderRequestId: string;
+    bids: BidderRequestBid[];
+    auctionStart: number;
+    timeout: number;
+    refererInfo: BidderRequestRefererInfo;
+};
+type BidderRequestBid = {
+    ortb2: {
+        site: {
+            page: string;
+            domain: string;
+        };
+        device: {
+            w: number;
+            h: number;
+            dnt: number;
+            ua: string;
+            language: string;
+        };
+    };
+};
+type BidderRequestRefererInfo = {
+    stack: string[];
+    location: string;
+    page: string;
+    domain: string;
+};
+declare function auctionInit(e: AuctionInitEvent & CommonEventProperties, trackers?: Array<string>): void;
+type BidRequestedEvent = {
+    auctionId: string;
+    bidderRequestId: string;
+    bids: BidRequestedBid[];
+    auctionStart: number;
+    timeout: number;
+    refererInfo: BidderRequestRefererInfo;
+    start: number;
+};
+type BidRequestedBid = {
+    params: object;
+    user: object;
+    ortb2Imp: object;
+    mediaTypes: object;
+    transactionId: string;
+    sizes: [];
+    bidId: string;
+    ortb2: {
+        site: {
+            page: string;
+            domain: string;
+        };
+        device: {
+            w: number;
+            h: number;
+            dnt: number;
+            ua: string;
+            language: string;
+        };
+    };
+};
+declare function bidRequested(e: BidRequestedEvent, trackers?: Array<string>): void;
+type BidResponseEvent = {
+    width: number;
+    height: number;
+    statusMessage: string;
+    adId: string;
+    requestId: string;
+    transactionId: string;
+    auctionId: string;
+    mediaType: string;
+    ad: string;
+    seatBidId: string;
+    cpm: number;
+    currency: string;
+    creative_id: string;
+    creativeId: string;
+    ttl: number;
+    netRevenue: boolean;
+    meta: {
+        advertiserDomains: string[];
+    };
+    originalRequest: {
+        ext: {
+            tid: string;
+        };
+        id: string;
+        banner: {
+            topFrame: number;
+            format: {
+                w: number;
+                h: number;
+            }[];
+        };
+        tagid: string;
+    };
+    originalCpm: number;
+    originalCurrency: string;
+    responseTimestamp: number;
+    requestTimestamp: number;
+    timeToRespond: number;
+    size: string;
+};
+declare function bidResponse(e: BidResponseEvent, trackers?: Array<string>): void;
+type BidderDoneEvent = BidRequestedEvent;
+declare function bidderDone(e: BidderDoneEvent, trackers?: Array<string>): void;
+type BidderErrorEvent = {
+    error: object;
+} & {
+    bidderRequest: BidRequestedEvent;
+};
+declare function bidderError(e: BidderErrorEvent, trackers?: Array<string>): void;
+type NoBidEvent = BidRequestedEvent;
+declare function noBid(e: NoBidEvent, trackers?: Array<string>): void;
+export { SurfsideCommercePlugin, commerceAction, setCommerceAction, commerceTransactionContext, addTransaction, commerceImpressionContext, addImpression, commerceProductContext, addProduct, commercePromoContext, addPromotion, sourceContext, source, segmentContext, segment, removeSegment, localBusinessLocationContext, setLocation, removeLocation, userContext, setUser, SurfIdContextRequest, setSurfId, identifyUserContext, identifyUser, auctionInit, bidRequested, bidResponse, bidderDone, bidderError, noBid };

package/dist/index.module.js

@@ -1,8 +1,9 @@
 /*!
- * Surfside Digital Analytics v0.0.1 (https://surfside.io)
+ * Surfside Digital Analytics > Custom Events v2.1.0 (https://surfside.io)
  * Copyright 2022 Surfside Solutions Inc, Snowplow Analytics Ltd, 2010 Anthon Pang
  */
 
+import { __awaiter, __generator } from 'tslib';
 import { dispatchToTrackersInCollection, parseAndValidateFloat, parseAndValidateInt } from '@surfside/browser-core';
 import { buildSelfDescribingEvent } from '@surfside/digital-core';
 
@@ -215,6 +216,13 @@ function segment(context, trackers) {
     if (context === void 0) { context = {}; }
     if (trackers === void 0) { trackers = Object.keys(_trackers); }
     var segmentId = context.segmentId, segmentVal = context.segmentVal;
+    var currentSegment = {
+        segmentId: segmentId,
+        segmentVal: segmentVal
+    };
+    if (window.surf.surfSegment !== undefined) {
+        removeSegment(window.surf.surfSegment);
+    }
     dispatchToTrackersInCollection(trackers, _trackers, function (t) {
         _context[t.id].length = 0;
         t.core.addGlobalContexts([
@@ -227,6 +235,103 @@ function segment(context, trackers) {
             },
         ]);
     });
+    window.surf.surfSegment = currentSegment;
+}
+/**
+ * Removes a Surfside Segment Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+function removeSegment(context, trackers) {
+    if (context === void 0) { context = {}; }
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    var segmentId = context.segmentId, segmentVal = context.segmentVal;
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        _context[t.id].length = 0;
+        t.core.removeGlobalContexts([
+            {
+                schema: 'iglu:io.surfside/segment/jsonschema/1-0-0',
+                data: {
+                    segmentId: segmentId,
+                    segmentVal: segmentVal
+                }
+            },
+        ]);
+    });
+}
+/**
+ * Adds a Surfside  Local Business Location Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+//check if location is already set, so check if window surf exists, if it's the same, if it isn't remove and update
+function setLocation(context, trackers) {
+    if (context === void 0) { context = {}; }
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    var id = context.id, latitude = context.latitude, longitude = context.longitude, country_code = context.country_code, zip = context.zip, state_label = context.state_label, state = context.state, city = context.city, street = context.street, name = context.name, parent = context.parent, type = context.type, category = context.category;
+    if (window.surf.currentLocation !== undefined) {
+        removeLocation(window.surf.currentLocation);
+    }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        _context[t.id].length = 0;
+        t.core.addGlobalContexts([
+            {
+                schema: 'iglu:io.surfside.local-business/location/jsonschema/1-0-0',
+                data: {
+                    id: id,
+                    latitude: latitude,
+                    longitude: longitude,
+                    country_code: country_code,
+                    zip: zip,
+                    state_label: state_label,
+                    state: state,
+                    city: city,
+                    street: street,
+                    name: name,
+                    parent: parent,
+                    type: type,
+                    category: category
+                }
+            },
+        ]);
+    });
+    window.surf.currentLocation = context;
+}
+/**
+ * Removes a Surfside  Local Business Location Context
+ *
+ * @param context - The context to be stored
+ * @param trackers - The tracker identifiers which the context will be stored against
+ */
+function removeLocation(context, trackers) {
+    if (context === void 0) { context = {}; }
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    var id = context.id, latitude = context.latitude, longitude = context.longitude, country_code = context.country_code, zip = context.zip, state_label = context.state_label, state = context.state, city = context.city, street = context.street, name = context.name, parent = context.parent, type = context.type, category = context.category;
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        _context[t.id].length = 0;
+        t.core.removeGlobalContexts([
+            {
+                schema: 'iglu:io.surfside.local-business/location/jsonschema/1-0-0',
+                data: {
+                    id: id,
+                    latitude: latitude,
+                    longitude: longitude,
+                    country_code: country_code,
+                    zip: zip,
+                    state_label: state_label,
+                    state: state,
+                    city: city,
+                    street: street,
+                    name: name,
+                    parent: parent,
+                    type: type,
+                    category: category
+                }
+            },
+        ]);
+    });
 }
 /**
  * Adds a Surfside User Context
@@ -237,7 +342,7 @@ function segment(context, trackers) {
 function setUser(context, trackers) {
     if (context === void 0) { context = {}; }
     if (trackers === void 0) { trackers = Object.keys(_trackers); }
-    var address = context.address, age = context.age, company = context.company, createdAt = context.createdAt, dateOfBirth = context.dateOfBirth, email = context.email, firstName = context.firstName, gender = context.gender, userId = context.userId, lastName = context.lastName;
+    var address = context.address, age = context.age, company = context.company, createdAt = context.createdAt, dateOfBirth = context.dateOfBirth, email = context.email, firstName = context.firstName, gender = context.gender, userId = context.userId, lastName = context.lastName, phone = context.phone;
     trackers.forEach(function (trackerId) {
         if (_context[trackerId]) {
             _context[trackerId].push({
@@ -252,12 +357,64 @@ function setUser(context, trackers) {
                     firstName: firstName,
                     gender: gender,
                     userId: userId,
-                    lastName: lastName
+                    lastName: lastName,
+                    phone: phone
                 }
             });
         }
     });
 }
+function setSurfId(context, trackers) {
+    var _this = this;
+    if (context === void 0) { context = {}; }
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    var query;
+    if (context.email) {
+        query = "email=".concat(context.email);
+    }
+    else if (context.phone) {
+        query = "phone=".concat(context.phone);
+    }
+    else {
+        return;
+    }
+    fetch("//i.surfside.io/id?".concat(query)).then(function (response) { return __awaiter(_this, void 0, void 0, function () {
+        var data, status, body, token;
+        var _a;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0: return [4 /*yield*/, response.json()];
+                case 1:
+                    data = _b.sent();
+                    status = data === null || data === void 0 ? void 0 : data.status;
+                    if (status !== 'success') {
+                        return [2 /*return*/];
+                    }
+                    body = data === null || data === void 0 ? void 0 : data.body;
+                    if (!body || body.length === 0) {
+                        return [2 /*return*/];
+                    }
+                    token = (_a = body[0]) === null || _a === void 0 ? void 0 : _a.advertisingToken;
+                    if (!token) {
+                        return [2 /*return*/];
+                    }
+                    localStorage.setItem('surf_uid2', token);
+                    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+                        _context[t.id].length = 0;
+                        t.core.addGlobalContexts([
+                            {
+                                schema: 'iglu:io.surfside/uid2_context/jsonschema/1-0-0',
+                                data: {
+                                    uid2: token
+                                }
+                            },
+                        ]);
+                    });
+                    return [2 /*return*/];
+            }
+        });
+    }); });
+}
 /**
  * Adds a Surfside  Context
  *
@@ -293,6 +450,239 @@ function identifyUser(context, trackers) {
         }
     });
 }
+function auctionInit(e, trackers) {
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        var combinedContexts = _context[t.id].concat(e.context || []);
+        _context[t.id].length = 0;
+        t.core.track(buildSelfDescribingEvent({
+            event: {
+                schema: 'iglu:io.surfside.advertising/auction_init/jsonschema/1-0-0',
+                data: {
+                    auctionId: e.auctionId,
+                    timestamp: e.timestamp,
+                    auctionStatus: e.auctionStatus,
+                    adUnits: e.adUnits.map(function (unit) {
+                        return {
+                            requestId: unit.requestId,
+                            mediaTypes: unit.mediaTypes,
+                            bids: unit.bids.map(function (bid) {
+                                return {
+                                    params: bid.params,
+                                    user: bid.user
+                                };
+                            }),
+                            timeout: unit.timeout,
+                            sizes: unit.sizes,
+                            transactionId: unit.transactionId
+                        };
+                    }),
+                    bidderRequests: e.bidderRequests.map(function (req) {
+                        return {
+                            bidderRequestId: req.bidderRequestId,
+                            bids: req.bids.map(function (bid) {
+                                var _a, _b, _c, _d, _e, _f, _g, _h, _j, _k, _l, _m, _o, _p;
+                                return {
+                                    ortb2: {
+                                        site: {
+                                            page: (_b = (_a = bid.ortb2) === null || _a === void 0 ? void 0 : _a.site) === null || _b === void 0 ? void 0 : _b.page,
+                                            domain: (_d = (_c = bid.ortb2) === null || _c === void 0 ? void 0 : _c.site) === null || _d === void 0 ? void 0 : _d.domain
+                                        },
+                                        device: {
+                                            w: (_f = (_e = bid.ortb2) === null || _e === void 0 ? void 0 : _e.device) === null || _f === void 0 ? void 0 : _f.w,
+                                            h: (_h = (_g = bid.ortb2) === null || _g === void 0 ? void 0 : _g.device) === null || _h === void 0 ? void 0 : _h.h,
+                                            dnt: (_k = (_j = bid.ortb2) === null || _j === void 0 ? void 0 : _j.device) === null || _k === void 0 ? void 0 : _k.dnt,
+                                            ua: (_m = (_l = bid.ortb2) === null || _l === void 0 ? void 0 : _l.device) === null || _m === void 0 ? void 0 : _m.ua,
+                                            language: (_p = (_o = bid.ortb2) === null || _o === void 0 ? void 0 : _o.device) === null || _p === void 0 ? void 0 : _p.language
+                                        }
+                                    }
+                                };
+                            }),
+                            auctionStart: req.auctionStart,
+                            timeout: req.timeout,
+                            refererInfo: {
+                                stack: req.refererInfo.stack,
+                                location: req.refererInfo.location,
+                                page: req.refererInfo.page,
+                                domain: req.refererInfo.domain
+                            }
+                        };
+                    })
+                }
+            }
+        }), combinedContexts, e.timestamp);
+    });
+}
+function bidRequested(e, trackers) {
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        t.core.track(buildSelfDescribingEvent({
+            event: {
+                schema: 'iglu:io.surfside.advertising/bid_requested/jsonschema/1-0-0',
+                data: {
+                    auctionId: e.auctionId,
+                    bidderRequestId: e.bidderRequestId,
+                    bids: e.bids.map(function (bid) {
+                        return {
+                            params: bid.params,
+                            user: bid.user,
+                            ortb2Imp: bid.ortb2Imp,
+                            mediaTypes: bid.mediaTypes,
+                            transactionId: bid.transactionId,
+                            sizes: bid.sizes,
+                            bidId: bid.bidId,
+                            ortb2: {
+                                site: {
+                                    page: bid.ortb2.site.page,
+                                    domain: bid.ortb2.site.domain
+                                },
+                                device: bid.ortb2.device
+                            }
+                        };
+                    }),
+                    auctionStart: e.auctionStart,
+                    timeout: e.timeout,
+                    refererInfo: e.refererInfo,
+                    start: e.start
+                }
+            }
+        }));
+    });
+}
+function bidResponse(e, trackers) {
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        var _a, _b;
+        t.core.track(buildSelfDescribingEvent({
+            event: {
+                schema: 'iglu:io.surfside.advertising/bid_response/jsonschema/1-0-0',
+                data: {
+                    width: e.width,
+                    height: e.height,
+                    statusMessage: e.statusMessage,
+                    adId: e.adId,
+                    requestId: e.requestId,
+                    transactionId: e.transactionId,
+                    auctionId: e.auctionId,
+                    mediaType: e.mediaType,
+                    ad: e.ad,
+                    seatBidId: e.seatBidId,
+                    cpm: e.cpm,
+                    currency: e.currency,
+                    creative_id: e.creative_id,
+                    creativeId: e.creativeId,
+                    ttl: e.ttl,
+                    netRevenue: e.netRevenue,
+                    meta: {
+                        advertiserDomains: (_a = e === null || e === void 0 ? void 0 : e.meta) === null || _a === void 0 ? void 0 : _a.advertiserDomains
+                    },
+                    originalRequest: {
+                        ext: e.originalRequest.ext,
+                        id: e.originalRequest.id,
+                        banner: (_b = e.originalRequest) === null || _b === void 0 ? void 0 : _b.banner
+                    },
+                    originalCpm: e.originalCpm,
+                    originalCurrency: e.originalCurrency,
+                    responseTimestamp: e.responseTimestamp,
+                    requestTimestamp: e.requestTimestamp,
+                    timeToRespond: e.timeToRespond,
+                    size: e.size
+                }
+            }
+        }));
+    });
+}
+function bidderDone(e, trackers) {
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        t.core.track(buildSelfDescribingEvent({
+            event: {
+                schema: 'iglu:io.surfside.advertising/bidder_done/jsonschema/1-0-0',
+                data: {
+                    auctionId: e.auctionId,
+                    bidderRequestId: e.bidderRequestId,
+                    bids: e.bids.map(function (bid) {
+                        return {
+                            params: bid.params,
+                            user: bid.user,
+                            ortb2Imp: bid.ortb2Imp,
+                            mediaTypes: bid.mediaTypes,
+                            transactionId: bid.transactionId,
+                            sizes: bid.sizes,
+                            bidId: bid.bidId,
+                            ortb2: {
+                                site: {
+                                    page: bid.ortb2.site.page,
+                                    domain: bid.ortb2.site.domain
+                                },
+                                device: bid.ortb2.device
+                            }
+                        };
+                    }),
+                    auctionStart: e.auctionStart,
+                    timeout: e.timeout,
+                    refererInfo: e.refererInfo,
+                    start: e.start
+                }
+            }
+        }));
+    });
+}
+function bidderError(e, trackers) {
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        t.core.track(buildSelfDescribingEvent({
+            event: {
+                schema: 'iglu:io.surfside.advertising/bidder_error/jsonschema/1-0-0',
+                data: {
+                    error: e.error,
+                    auctionId: e.bidderRequest.auctionId,
+                    bidderRequestId: e.bidderRequest.bidderRequestId,
+                    bids: e.bidderRequest.bids.map(function (bid) {
+                        return {
+                            params: bid.params,
+                            user: bid.user,
+                            ortb2Imp: bid.ortb2Imp,
+                            mediaTypes: bid.mediaTypes,
+                            transactionId: bid.transactionId,
+                            sizes: bid.sizes,
+                            bidId: bid.bidId,
+                            ortb2: {
+                                site: {
+                                    page: bid.ortb2.site.page,
+                                    domain: bid.ortb2.site.domain
+                                },
+                                device: bid.ortb2.device
+                            }
+                        };
+                    }),
+                    auctionStart: e.bidderRequest.auctionStart,
+                    timeout: e.bidderRequest.timeout,
+                    refererInfo: e.bidderRequest.refererInfo,
+                    start: e.bidderRequest.start
+                }
+            }
+        }));
+    });
+}
+function noBid(e, trackers) {
+    if (trackers === void 0) { trackers = Object.keys(_trackers); }
+    dispatchToTrackersInCollection(trackers, _trackers, function (t) {
+        t.core.track(buildSelfDescribingEvent({
+            event: {
+                schema: 'iglu:io.surfside.advertising/no_bid/jsonschema/1-0-0',
+                data: {
+                    auctionId: e.auctionId,
+                    bidderRequestId: e.bidderRequestId,
+                    auctionStart: e.auctionStart,
+                    timeout: e.timeout,
+                    refererInfo: e.refererInfo,
+                    start: e.start
+                }
+            }
+        }));
+    });
+}
 
-export { SurfsideCommercePlugin, addImpression, addProduct, addPromotion, addTransaction, identifyUser, segment, setCommerceAction, setUser, source };
+export { SurfsideCommercePlugin, addImpression, addProduct, addPromotion, addTransaction, auctionInit, bidRequested, bidResponse, bidderDone, bidderError, identifyUser, noBid, removeLocation, removeSegment, segment, setCommerceAction, setLocation, setSurfId, setUser, source };
 //# sourceMappingURL=index.module.js.map