@surfside/surfside-events 1.0.0 → 2.0.0

package/dist/index.umd.js

@@ -1,5 +1,5 @@
 /*!
- * Surfside Digital Analytics v0.0.1 (https://surfside.io)
+ * Surfside Digital Analytics > Custom Events v2.0.0 (https://surfside.io)
  * Copyright 2022 Surfside Solutions Inc, Snowplow Analytics Ltd, 2010 Anthon Pang
  */
 
@@ -24,6 +24,44 @@
     PERFORMANCE OF THIS SOFTWARE.
     ***************************************************************************** */
 
+    function __awaiter(thisArg, _arguments, P, generator) {
+        function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+        return new (P || (P = Promise))(function (resolve, reject) {
+            function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+            function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+            function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+            step((generator = generator.apply(thisArg, _arguments || [])).next());
+        });
+    }
+
+    function __generator(thisArg, body) {
+        var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+        return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+        function verb(n) { return function (v) { return step([n, v]); }; }
+        function step(op) {
+            if (f) throw new TypeError("Generator is already executing.");
+            while (_) try {
+                if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+                if (y = 0, t) op = [op[0] & 2, t.value];
+                switch (op[0]) {
+                    case 0: case 1: t = op; break;
+                    case 4: _.label++; return { value: op[1], done: false };
+                    case 5: _.label++; y = op[1]; op = [0]; continue;
+                    case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                    default:
+                        if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                        if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                        if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                        if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                        if (t[2]) _.ops.pop();
+                        _.trys.pop(); continue;
+                }
+                op = body.call(thisArg, _);
+            } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+            if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+        }
+    }
+
     function __spreadArray(to, from, pack) {
         if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
             if (ar || !(i in from)) {
@@ -35,7 +73,7 @@
     }
 
     /*!
-     * Core functionality for Surfside JavaScript trackers v0.0.1 (https://www.surfside.io)
+     * Core functionality for Surfside JavaScript trackers v3.4.0 (https://www.surfside.io)
      * Copyright 2022 Surfside Solutions Inc, Snowplow Analytics Ltd, 2010 Anthon Pang
      */
 
@@ -248,7 +286,7 @@
      * and a data object which conforms to the supplied schema
      *
      * @param event - Contains the properties and schema location for the event
-     * @returns PayloadBuilder to be sent to {@link @snowplow/tracker-core#TrackerCore.track}
+     * @returns PayloadBuilder to be sent to {@link @surfside/digital-core#TrackerCore.track}
      */
     function buildSelfDescribingEvent(event) {
         var _a = event.event, schema = _a.schema, data = _a.data, pb = payloadBuilder();
@@ -262,7 +300,7 @@
     }
 
     /*!
-     * Core functionality for Surfside Digital trackers v0.0.1 ()
+     * Core functionality for Surfside Digital trackers v3.4.0 ()
      * Copyright 2022 Surfside Solutions Inc, Snowplow Analytics Ltd, 2010 Anthon Pang
      */
     /**
@@ -525,6 +563,13 @@
         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([
@@ -537,6 +582,103 @@
                 },
             ]);
         });
+        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
@@ -547,7 +689,7 @@
     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({
@@ -562,12 +704,64 @@
                         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
      *
@@ -603,15 +797,258 @@
             }
         });
     }
+    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
+                    }
+                }
+            }));
+        });
+    }
 
     exports.SurfsideCommercePlugin = SurfsideCommercePlugin;
     exports.addImpression = addImpression;
     exports.addProduct = addProduct;
     exports.addPromotion = addPromotion;
     exports.addTransaction = addTransaction;
+    exports.auctionInit = auctionInit;
+    exports.bidRequested = bidRequested;
+    exports.bidResponse = bidResponse;
+    exports.bidderDone = bidderDone;
+    exports.bidderError = bidderError;
     exports.identifyUser = identifyUser;
+    exports.noBid = noBid;
+    exports.removeLocation = removeLocation;
+    exports.removeSegment = removeSegment;
     exports.segment = segment;
     exports.setCommerceAction = setCommerceAction;
+    exports.setLocation = setLocation;
+    exports.setSurfId = setSurfId;
     exports.setUser = setUser;
     exports.source = source;