typeahead-client-logger 0.0.1-security → 2.532.1

package/dist/EssSelectedSuggestionLogger.js

@@ -0,0 +1,372 @@
+"use strict";
+var __read = (this && this.__read) || function (o, n) {
+    var m = typeof Symbol === "function" && o[Symbol.iterator];
+    if (!m) return o;
+    var i = m.call(o), r, ar = [], e;
+    try {
+        while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);
+    }
+    catch (error) { e = { error: error }; }
+    finally {
+        try {
+            if (r && !r.done && (m = i["return"])) m.call(i);
+        }
+        finally { if (e) throw e.error; }
+    }
+    return ar;
+};
+var __spread = (this && this.__spread) || function () {
+    for (var ar = [], i = 0; i < arguments.length; i++) ar = ar.concat(__read(arguments[i]));
+    return ar;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+var Optional_1 = require("./utils/Optional");
+var SuggestionType;
+(function (SuggestionType) {
+    SuggestionType[SuggestionType["ORIGIN"] = 0] = "ORIGIN";
+    SuggestionType[SuggestionType["DEST"] = 1] = "DEST";
+})(SuggestionType = exports.SuggestionType || (exports.SuggestionType = {}));
+var LogType;
+(function (LogType) {
+    LogType["TYPEAHEAD_BLUR"] = "typeahead-blur";
+    LogType["WIZARD_SUBMIT"] = "wizard-submit";
+})(LogType = exports.LogType || (exports.LogType = {}));
+var EssSelectedSuggestionLogger = /** @class */ (function () {
+    // 1 - Create logger
+    function EssSelectedSuggestionLogger(analytics, prefill) {
+        this.analytics = analytics;
+        this.sessionStore = {
+            prefill: prefill,
+        };
+    }
+    // 2 - initialize logger.
+    EssSelectedSuggestionLogger.prototype.initLogger = function (metadata) {
+        var client = metadata.client, packageType = metadata.packageType, lob = metadata.lob, locale = metadata.locale, siteId = metadata.siteId, personalize = metadata.personalize;
+        this.sessionStore.metadata = { client: client, packageType: packageType, lob: lob, locale: locale, siteId: siteId, personalize: personalize };
+    };
+    EssSelectedSuggestionLogger.prototype.logTypeaheadResponse = function (response) {
+        this.sessionStore.response = response;
+        this.sessionStore.mostRecentSelectedSuggestion = undefined;
+    };
+    EssSelectedSuggestionLogger.prototype.setPrefillText = function (prefill) {
+        this.sessionStore.prefill = prefill;
+    };
+    EssSelectedSuggestionLogger.prototype.logSuggestionSelected = function (selected) {
+        if (Optional_1.Optional.ofNullable(selected).isPresent()
+            && this.sessionStore.response
+            && this.sessionStore.response.sr
+            && this.sessionStore.response.sr.length > 0) {
+            if (Optional_1.Optional.ofNullable(selected.dest).orElse(true)) {
+                this.sessionStore.destSelectedSuggestion = this.sessionStore.response.sr[selected.index - 1];
+            }
+            else {
+                this.sessionStore.originSelectedSuggestion = this.sessionStore.response.sr[selected.index - 1];
+            }
+            this.sessionStore.mostRecentSelectedSuggestion = this.sessionStore.response.sr[selected.index - 1];
+        }
+    };
+    /* the following two methods to be used by blossom-ui / buttercup / any other client who uses typeahead*/
+    EssSelectedSuggestionLogger.prototype.logTypeaheadBlurEvent = function () {
+        this.logSessionEnd(LogType.TYPEAHEAD_BLUR);
+    };
+    EssSelectedSuggestionLogger.prototype.logWizardSubmitEvent = function () {
+        this.logSessionEnd(LogType.WIZARD_SUBMIT);
+        this.sessionStore.mostRecentSelectedSuggestion = undefined;
+        this.sessionStore.response = undefined;
+        this.sessionStore.originSelectedSuggestion = undefined;
+        this.sessionStore.destSelectedSuggestion = undefined;
+    };
+    EssSelectedSuggestionLogger.prototype.logSessionEnd = function (logType) {
+        if (typeof this.analytics === "object" &&
+            typeof this.analytics.trackEvent === "function") {
+            try {
+                var uisPrimeMessages = this.buildUisPrimeMessages();
+                this.analytics.trackEvent(this.getReferrerId(), logType, this.analytics.omnitureData, null, true, uisPrimeMessages);
+            }
+            catch (e) {
+                // do nothing
+            }
+        }
+    };
+    EssSelectedSuggestionLogger.prototype.getReferrerId = function () {
+        var metadata = this.sessionStore.metadata || {};
+        var parts = [];
+        parts.push(this.getLaunchView(metadata.client || ""));
+        parts.push(this.getWizard(metadata.client || ""));
+        parts.push(metadata.lob || "Unknown");
+        parts.push(this.getShortLob(metadata.lob || "", metadata.packageType));
+        parts.push(metadata.locale || "-");
+        parts.push(metadata.siteId || "-");
+        parts.push(this.getTypeaheadTrigger());
+        parts.push.apply(parts, __spread(this.getInstrumentationValue((metadata.lob || "").toLowerCase())));
+        return parts.join("|");
+    };
+    EssSelectedSuggestionLogger.prototype.getLaunchView = function (clientId) {
+        clientId = clientId.toLowerCase();
+        if (clientId.indexOf("home") > -1) {
+            return "Home";
+        }
+        if (clientId.indexOf("flight") > -1) {
+            return "FLT";
+        }
+        if (clientId.indexOf("hotels.search") > -1) {
+            // for hotels search page bernie appends "HOT.SR" so removing here
+            return "";
+        }
+        if (clientId.indexOf("hotel") > -1) {
+            return "HTL";
+        }
+        if (clientId.indexOf("vacationrental") > -1) {
+            return "VR";
+        }
+        if (clientId.indexOf("pack") > -1) {
+            return "PKG";
+        }
+        if (clientId.indexOf("car") > -1) {
+            return "CAR";
+        }
+        if (clientId.indexOf("cru") > -1) {
+            return "CRU";
+        }
+        if (clientId.indexOf("lx") > -1) {
+            return "LX";
+        }
+        if (clientId.indexOf("rail") > -1) {
+            return "RAIL";
+        }
+        if (clientId.indexOf("open") > -1) {
+            return "OPEN";
+        }
+        return clientId;
+    };
+    EssSelectedSuggestionLogger.prototype.buildUisPrimeMessages = function () {
+        return __spread(this.getTrackingDataEvents(), [
+            this.getSelectedSuggestionEvents(),
+        ]);
+    };
+    EssSelectedSuggestionLogger.prototype.getSelectedSuggestionData = function (suggestion, searchField) {
+        var alternateName = searchField === "origin" ? "OriginNotApplicable" :
+            ((this.sessionStore.response || {}).q ? (this.sessionStore.response || {}).q :
+                this.sessionStore.prefill ? this.sessionStore.prefill : "TANoneSelected");
+        var query = (this.sessionStore.response || { q: "" }).q;
+        var userTypedQuery = query === this.sessionStore.prefill ? "" : query;
+        var lastSearchName = suggestion && suggestion.regionNames && suggestion.regionNames.lastSearchName
+            || alternateName;
+        return {
+            essRequestId: (this.sessionStore.response || { rid: "-" }).rid,
+            lastSearchName: lastSearchName,
+            relation: suggestion && suggestion.hierarchyInfo
+                && suggestion.hierarchyInfo.relation && suggestion.hierarchyInfo.relation[0] || "-",
+            searchField: searchField,
+            sourceName: suggestion
+                ? suggestion.essId
+                    ? suggestion.essId.sourceName
+                    : suggestion.sourceName
+                        ? suggestion.sourceName
+                        : "UNKNOWN"
+                : "UNKNOWN",
+            stringSourceId: (suggestion && suggestion.essId && suggestion.essId.sourceId || -1).toString(),
+            suggestionType: suggestion ? suggestion.type : "UNKNOWN",
+            userHistory: suggestion ? suggestion.category === "USERHISTORY" : false,
+            userTypedQuery: userTypedQuery,
+        };
+    };
+    EssSelectedSuggestionLogger.prototype.getSelectedSuggestionEvents = function () {
+        var originSuggestionData = this.getSelectedSuggestionData(this.sessionStore.originSelectedSuggestion, "origin");
+        var destSuggestionData = this.getSelectedSuggestionData(this.sessionStore.destSelectedSuggestion, "dest");
+        return Object.freeze({
+            messageContent: {
+                selectedSuggestions: [originSuggestionData, destSuggestionData],
+            },
+            schemaName: "allSelectedSuggestions",
+        });
+    };
+    EssSelectedSuggestionLogger.prototype.getTrackingDataEvents = function () {
+        var searchTerm = (this.sessionStore.response || { q: "" }).q;
+        var numOfCharsTyped = searchTerm ? searchTerm === this.sessionStore.prefill ? 0 : searchTerm.length : 0;
+        var trackingData = [];
+        if (this.sessionStore.mostRecentSelectedSuggestion) {
+            var index = -1;
+            if (this.sessionStore.mostRecentSelectedSuggestion
+                && typeof this.sessionStore.mostRecentSelectedSuggestion.index !== "undefined") {
+                index = parseInt(this.sessionStore.mostRecentSelectedSuggestion.index, 10) + 1;
+            }
+            /* to get the position of selected suggestion [event44] */
+            trackingData.push(Object.freeze({
+                messageContent: {
+                    name: "TypeaheadSelectionDepth",
+                    value: index,
+                },
+                schemaName: "events",
+            }));
+        }
+        if (this.sessionStore.response) {
+            /* to see if user interacted with typeahead or not [event45] */
+            trackingData.push(Object.freeze({
+                messageContent: {
+                    name: "TypeaheadSearch",
+                    value: 0,
+                },
+                schemaName: "events",
+            }));
+        }
+        /* to get the number of characters typed by the user [event46] */
+        trackingData.push(Object.freeze({
+            messageContent: {
+                name: "TypeaheadCharactersTyped",
+                value: numOfCharsTyped,
+            },
+            schemaName: "events",
+        }));
+        return trackingData;
+    };
+    EssSelectedSuggestionLogger.prototype.getTypeaheadTrigger = function () {
+        var trigger = "";
+        if (Optional_1.Optional.ofNullable(this.sessionStore.response).isNotPresent()
+            && Optional_1.Optional.ofNullable(this.sessionStore.prefill).isPresent()) {
+            return "TANoShow.TAPrevSearch";
+        }
+        if (this.sessionStore.response
+            && this.sessionStore.response.sr
+            && this.sessionStore.response.sr.length > 0) {
+            trigger = "TAShow";
+        }
+        else {
+            trigger = "TANoShow.TAPrevSearch";
+            return trigger;
+        }
+        var searchQuery = (this.sessionStore.response || { q: "" }).q;
+        var userTyped = this.sessionStore.prefill !== searchQuery && searchQuery !== "";
+        if (userTyped) {
+            if (this.sessionStore.mostRecentSelectedSuggestion) {
+                trigger += ".TASelection";
+            }
+            else {
+                trigger += ".TANoSelection";
+            }
+            return trigger;
+        }
+        else {
+            // history results ::: else -> last search results
+            if (this.sessionStore.response && this.sessionStore.response.q === "") {
+                if (this.sessionStore.mostRecentSelectedSuggestion) {
+                    trigger += ".TAFocus";
+                }
+                else {
+                    trigger += ".TANoSelection";
+                }
+            }
+            else {
+                if (this.sessionStore.mostRecentSelectedSuggestion) {
+                    trigger += ".TASelection";
+                }
+                else {
+                    trigger += ".TANoSelection";
+                }
+            }
+        }
+        return trigger;
+    };
+    EssSelectedSuggestionLogger.prototype.getInstrumentationValue = function (lob) {
+        var result = [];
+        var index = "-";
+        if (this.sessionStore.mostRecentSelectedSuggestion
+            && typeof this.sessionStore.mostRecentSelectedSuggestion.index !== "undefined") {
+            index = (parseInt(this.sessionStore.mostRecentSelectedSuggestion.index, 10) + 1).toString();
+        }
+        var length = ((this.sessionStore.response || {}).sr || []).length;
+        if (lob === "flights" || lob === "hotels") {
+            // Change logic when children present.
+            result.push(this.getHierarchyType(this.sessionStore.mostRecentSelectedSuggestion) + "#" + index);
+        }
+        else {
+            result.push("L#" + index);
+        }
+        result.push("ESS#" + length);
+        result.push("UH#" + this.getNumberOfUserHistorySuggestions());
+        return result;
+    };
+    EssSelectedSuggestionLogger.prototype.getNumberOfUserHistorySuggestions = function () {
+        if (this.sessionStore.response
+            && this.sessionStore.response.sr
+            && this.sessionStore.metadata
+            && Optional_1.Optional.ofNullable(this.sessionStore.metadata.personalize).isPresent()
+            && this.sessionStore.metadata.personalize) {
+            var suggestions = this.sessionStore.response.sr;
+            return suggestions.filter(function (suggestion) { return suggestion.category === "USERHISTORY"; }).length.toString();
+        }
+        return "-";
+    };
+    EssSelectedSuggestionLogger.prototype.getHierarchyType = function (suggestion) {
+        if (Optional_1.Optional.ofNullable(suggestion).isPresent()) {
+            if (this.isChild(suggestion)) {
+                return "CL";
+            }
+            if (this.isParent(suggestion)) {
+                return "PL";
+            }
+        }
+        return "DL";
+    };
+    EssSelectedSuggestionLogger.prototype.isParent = function (suggestion) {
+        if (Optional_1.Optional.ofNullable(suggestion).isNotPresent()
+            || Optional_1.Optional.ofNullable(this.sessionStore.response).isNotPresent()) {
+            return false;
+        }
+        var index = parseInt(Optional_1.Optional.ofNullable(suggestion.index).orElse("-1"), 10);
+        if (index < 0 || (Optional_1.Optional.ofNullable(this.sessionStore.response.sr).orElse([])).length <= index + 1) {
+            return false;
+        }
+        return this.isChild(this.sessionStore.response.sr[index + 1]);
+    };
+    EssSelectedSuggestionLogger.prototype.isChild = function (suggestion) {
+        if (Optional_1.Optional.ofNullable(suggestion).isNotPresent()) {
+            return false;
+        }
+        var relation = suggestion && suggestion.hierarchyInfo
+            && suggestion.hierarchyInfo.relation || [];
+        if (relation.length === 0) {
+            return false;
+        }
+        if (relation.indexOf("child") >= 0) {
+            return true;
+        }
+        return false;
+    };
+    // TODO - add flights after blossom sends the flight type (based on that)
+    EssSelectedSuggestionLogger.prototype.getShortLob = function (lob, packageType) {
+        switch (lob.toLowerCase()) {
+            case "hotels":
+                return "H";
+            case "package":
+                if (packageType) {
+                    return packageType.toUpperCase();
+                }
+                else {
+                    return "-";
+                }
+            case "activity":
+                return "LX";
+            case "cruise":
+                return "CR";
+            case "car":
+                return "C";
+            case "opensearch":
+                return "OS";
+            default:
+                return "-";
+        }
+    };
+    EssSelectedSuggestionLogger.prototype.getWizard = function (client) {
+        switch (client) {
+            case "Hotels.Search":
+            case "Flights.Search":
+                return "UpdateSearch";
+            default:
+                return "CoreWzd";
+        }
+    };
+    return EssSelectedSuggestionLogger;
+}());
+exports.EssSelectedSuggestionLogger = EssSelectedSuggestionLogger;
+//# sourceMappingURL=EssSelectedSuggestionLogger.js.map

package/dist/Experiments.js

@@ -0,0 +1,52 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Experiments = exports.Experiment = void 0;
+// Add client side typeahead experiment info to the below enum for logging purpose
+var Experiment;
+(function (Experiment) {
+    Experiment[Experiment["EGTA_BEX_ML_V0"] = 36094] = "EGTA_BEX_ML_V0";
+    Experiment[Experiment["EGTA_uTA_Demo"] = 32216] = "EGTA_uTA_Demo";
+    Experiment[Experiment["ESS_Two_Line_Display"] = 33686] = "ESS_Two_Line_Display";
+    Experiment[Experiment["PWA_ESS_Feedback_Loop_Enable"] = 31052] = "PWA_ESS_Feedback_Loop_Enable";
+    Experiment[Experiment["EGTA_Rollout_Feature_Gate_for_Hotel_Property_Name_Filter"] = 37339] = "EGTA_Rollout_Feature_Gate_for_Hotel_Property_Name_Filter";
+    Experiment[Experiment["BEX_Driveable_destination_Web"] = 41955] = "BEX_Driveable_destination_Web";
+})(Experiment = exports.Experiment || (exports.Experiment = {}));
+var Experiments = /** @class */ (function () {
+    function Experiments() {
+    }
+    Experiments.init = function (experiments) {
+        var _this = this;
+        if (experiments) {
+            Object.keys(Experiment).forEach(function (name) {
+                var value = experiments[name];
+                var bucket;
+                if ("number" === typeof value) { // Blossom-flex
+                    bucket = value;
+                }
+                else if (value && "number" === typeof value.bucket) { // Shopping-pwa
+                    bucket = value.bucket;
+                }
+                if (bucket !== undefined) {
+                    var id = Experiment[name];
+                    _this.experimentMap[id] = { id: id, name: name, bucket: bucket };
+                }
+            });
+        }
+    };
+    Experiments.isBucketed = function (experiment, bucket) {
+        if (bucket === void 0) { bucket = 1; }
+        return experiment in this.experimentMap && bucket === this.experimentMap[experiment].bucket;
+    };
+    Experiments.getClientVariants = function () {
+        var _this = this;
+        var variants = [];
+        Object.keys(this.experimentMap).forEach(function (key) {
+            variants.push(key + "." + _this.experimentMap[key].bucket);
+        });
+        return variants.join("|");
+    };
+    Experiments.experimentMap = {};
+    return Experiments;
+}());
+exports.Experiments = Experiments;
+//# sourceMappingURL=Experiments.js.map

package/dist/InteractionMetrics.js

@@ -0,0 +1,73 @@
+"use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.InteractionMetrics = void 0;
+var Experiments_1 = require("./Experiments");
+var InteractionMetrics = /** @class */ (function () {
+    function InteractionMetrics() {
+        this.query = "";
+        this.response = undefined;
+        this.mostRecentSelectedSuggestion = undefined;
+    }
+    InteractionMetrics.getSuggestionTypes = function (s) {
+        if (s && s.length > 0) {
+            return s.map(function (item) { return (item.category === "GOOGLEMAPS") ? "GPA" : item.type; }).join(",");
+        }
+        return undefined;
+    };
+    InteractionMetrics.getSuggestionIds = function (s) {
+        if (s && s.length > 0) {
+            return s.map(function (item) { return (item.category === "GOOGLEMAPS") ? item.sourceName + ":" + item.sourceId :
+                (item.essId ? item.essId.sourceName + ":" + item.essId.sourceId : "-:-"); }).join(",");
+        }
+        return undefined;
+    };
+    InteractionMetrics.prototype.logTypeaheadOpen = function (prefill) {
+        this.interactionStart = Date.now();
+        this.prefill = prefill;
+    };
+    InteractionMetrics.prototype.logTypeaheadRequest = function (query) {
+        this.query = query || "";
+        this.mostRecentSelectedSuggestion = undefined;
+        this.response = undefined;
+    };
+    InteractionMetrics.prototype.logSuggestionShown = function (response) {
+        this.response = response;
+    };
+    InteractionMetrics.prototype.logTypeaheadSelection = function (selection) {
+        this.mostRecentSelectedSuggestion = this.response.sr[selection.index - 1];
+    };
+    InteractionMetrics.prototype.logTypeaheadEventMessage = function (m) {
+        this.selectionTypeaheadEventMessage = m;
+    };
+    InteractionMetrics.prototype.getMetrics = function (metadata) {
+        var userTypedQuery = this.query === this.prefill ? "" : this.query;
+        var isAddrAutocomplete = this.response && this.response.sr && this.response.sr.length > 0
+            && this.response.sr[0].category === "GOOGLEMAPS";
+        var deviceType = metadata.getDevice && "function" === typeof metadata.getDevice ?
+            metadata.getDevice(window.navigator.useragent) : undefined;
+        var metric = __assign({ contentFlavor: "uitk", deviceType: deviceType, inputLength: userTypedQuery ? userTypedQuery.length : 0, interactionTime: this.interactionStart ? (Date.now() - this.interactionStart) : undefined, isAddrAutocomplete: isAddrAutocomplete, lob: metadata.lob, locale: metadata.locale, pageId: metadata.client, pointOfSale: window.location.hostname, selectionDepth: this.getSelectionDepth(), siteId: metadata.siteId + "", suggestionIds: this.response && InteractionMetrics.getSuggestionIds(this.response.sr), suggestionSelected: !!this.mostRecentSelectedSuggestion, suggestionShown: !!(this.response && this.response.sr && this.response.sr.length > 0), suggestionTypes: this.response && InteractionMetrics.getSuggestionTypes(this.response.sr), textInputElementId: metadata.inputId, timestamp: Date.now(), type: "TypeaheadInteraction", userAgent: window.navigator.userAgent, userTypedQuery: userTypedQuery, variants: [this.response && this.response.activeABTests, Experiments_1.Experiments.getClientVariants()]
+                .filter(Boolean).join("|"), zeroResults: this.response && this.response.sr && this.response.sr.length === 0 }, this.selectionTypeaheadEventMessage);
+        return metric;
+    };
+    InteractionMetrics.prototype.getSelectionDepth = function () {
+        if (this.mostRecentSelectedSuggestion
+            && typeof this.mostRecentSelectedSuggestion.index !== "undefined") {
+            return (parseInt(this.mostRecentSelectedSuggestion.index, 10) + 1).toString();
+        }
+        return "undefined";
+    };
+    return InteractionMetrics;
+}());
+exports.InteractionMetrics = InteractionMetrics;
+//# sourceMappingURL=InteractionMetrics.js.map