@codecademy/tracking 1.0.3-alpha.37044bcdd.0 → 1.0.3-alpha.4641cabd2.0

package/dist/events/index.d.ts

@@ -1,3 +1,3 @@
-export * from './track';
-export * from './user';
-export * from './types';
+export * from './track';
+export * from './user';
+export * from './types';

package/dist/events/index.js

@@ -0,0 +1,3 @@
+export * from './track';
+export * from './user';
+export * from './types';

package/dist/events/track.d.ts

@@ -1,12 +1,12 @@
-import type { BaseEventData, EventDataTypes, TrackingOptions, UserClickData, UserImpressionData, UserVisitData } from './types';
-export declare type TrackerOptions = {
-    apiBaseUrl: string;
-    verbose?: boolean;
-};
-export declare const createTracker: ({ apiBaseUrl, verbose }: TrackerOptions) => {
-    event: <Category extends keyof EventDataTypes, Event_1 extends string & keyof EventDataTypes[Category], Data extends EventDataTypes[Category][Event_1] & BaseEventData>(category: Category, event: Event_1, userData: Data, options?: TrackingOptions) => void;
-    click: (data: UserClickData) => void;
-    impression: (data: UserImpressionData) => void;
-    visit: (data: UserVisitData) => void;
-    pushDataLayerEvent: (eventName: string) => void;
-};
+import type { BaseEventData, EventDataTypes, TrackingOptions, UserClickData, UserImpressionData, UserVisitData } from './types';
+export declare type TrackerOptions = {
+    apiBaseUrl: string;
+    verbose?: boolean;
+};
+export declare const createTracker: ({ apiBaseUrl, verbose }: TrackerOptions) => {
+    event: <Category extends keyof EventDataTypes, Event_1 extends string & keyof EventDataTypes[Category], Data extends EventDataTypes[Category][Event_1] & BaseEventData>(category: Category, event: Event_1, userData: Data, options?: TrackingOptions) => void;
+    click: (data: UserClickData) => void;
+    impression: (data: UserImpressionData) => void;
+    visit: (data: UserVisitData) => void;
+    pushDataLayerEvent: (eventName: string) => void;
+};

package/dist/events/track.js

@@ -0,0 +1,115 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
+
+function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
+
+function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o === "string") return _arrayLikeToArray(o, minLen); var n = Object.prototype.toString.call(o).slice(8, -1); if (n === "Object" && o.constructor) n = o.constructor.name; if (n === "Map" || n === "Set") return Array.from(o); if (n === "Arguments" || /^(?:Ui|I)nt(?:8|16|32)(?:Clamped)?Array$/.test(n)) return _arrayLikeToArray(o, minLen); }
+
+function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) { arr2[i] = arr[i]; } return arr2; }
+
+function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Symbol !== "undefined" && arr[Symbol.iterator] || arr["@@iterator"]; if (_i == null) return; var _arr = []; var _n = true; var _d = false; var _s, _e; try { for (_i = _i.call(arr); !(_n = (_s = _i.next()).done); _n = true) { _arr.push(_s.value); if (i && _arr.length === i) break; } } catch (err) { _d = true; _e = err; } finally { try { if (!_n && _i["return"] != null) _i["return"](); } finally { if (_d) throw _e; } } return _arr; }
+
+function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
+
+import { getClientType } from '../integrations/device';
+
+var browserSupportsKeepalive = function browserSupportsKeepalive() {
+  return 'keepalive' in window.Request.prototype;
+};
+
+export var createTracker = function createTracker(_ref) {
+  var apiBaseUrl = _ref.apiBaseUrl,
+      verbose = _ref.verbose;
+
+  var beacon = function beacon(endpoint, data) {
+    var uri = new URL(endpoint, apiBaseUrl).toString();
+    var form = new FormData();
+
+    for (var _i2 = 0, _Object$entries = Object.entries(data); _i2 < _Object$entries.length; _i2++) {
+      var _ref4 = _Object$entries[_i2];
+
+      var _ref3 = _slicedToArray(_ref4, 2);
+
+      var k = _ref3[0];
+      var v = _ref3[1];
+      form.append(k, v.toString());
+    }
+
+    try {
+      // Firefox allows users to disable navigator.sendBeacon, and very old Safari versions don't have it.
+      // [WEB-1700]: Additionally, Chrome 79-80 gives "Illegal invocation" with ?., so through 2022 we should support them.
+      // It seems similar to this: https://github.com/vercel/next.js/issues/23856
+      if (navigator.sendBeacon && navigator.sendBeacon(uri, form)) {
+        return;
+      }
+    } catch (_unused) {// Even with the proper scoping, Chrome 79-80 still gives "Illegal invocation" crashes. Sigh.
+    } // Either way, we fall back to standard fetch if sendBeacon fails.
+    // We don't mind this rejecting with an error because it's tracking, and we'll know if that starts to fail.
+
+
+    window.fetch(uri, _objectSpread({
+      method: 'POST',
+      body: form
+    }, browserSupportsKeepalive() && {
+      keepalive: true
+    }));
+  };
+
+  var event = function event(category, _event, userData) {
+    var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
+
+    var properties = _objectSpread(_objectSpread({}, userData), {}, {
+      fullpath: window.location.pathname + window.location.search,
+      search: window.location.search,
+      path: window.location.pathname,
+      title: window.document.title,
+      url: window.location.href,
+      referrer: userData.referrer || window.document.referrer,
+      client: getClientType()
+    });
+
+    if (verbose) {
+      console.groupCollapsed("%cTracking Event Fired: ".concat(category, ":").concat(_event), 'color: #4b35ef; font-style: italic;');
+      console.log({
+        category: category,
+        event: _event,
+        properties: properties
+      });
+      console.groupEnd();
+    } // This allows the UTM query params to get registered in the user session.
+
+
+    var queryParams = window.location.search;
+    beacon("/analytics/".concat(category).concat(queryParams), {
+      category: category,
+      event: _event,
+      properties: JSON.stringify(properties),
+      gdpr_safe: "".concat(options.gdprSafe)
+    });
+  };
+
+  return {
+    event: event,
+    click: function click(data) {
+      return event('user', 'click', data);
+    },
+    impression: function impression(data) {
+      return event('user', 'impression', data);
+    },
+    visit: function visit(data) {
+      return event('user', 'visit', data);
+    },
+    pushDataLayerEvent: function pushDataLayerEvent(eventName) {
+      var _ref5;
+
+      ((_ref5 = window).dataLayer || (_ref5.dataLayer = [])).push({
+        event: eventName
+      });
+    }
+  };
+};

package/dist/events/types.d.ts

@@ -1,250 +1,251 @@
-/**
- * The Data types for all of our events.
- * Follows the format EventDataTypes[Category].[Event].EventData
- * Category + Event gives the corresponding event table in redshift
- */
-export declare type EventDataTypes = {
-    user: {
-        click: UserClickData;
-        visit: UserVisitData;
-        impression: UserImpressionData;
-        email_trigger: BaseEventAnyData;
-        content_completed: BaseEventAnyData;
-        submit: BaseEventAnyData;
-        workspace_init: BaseEventAnyData;
-        meaningful_content_loaded: BaseEventAnyData;
-        practice_completed: BaseEventAnyData;
-    };
-    ad: {
-        click: BaseEventAnyData;
-        impression: BaseEventAnyData;
-    };
-    calendar: {
-        reminder: BaseEventAnyData;
-    };
-    notification: {
-        clicked: BaseEventAnyData;
-        ion: BaseEventAnyData;
-    };
-    form: {
-        submit: BaseEventAnyData;
-    };
-    sorting_quiz: {
-        result: BaseEventAnyData;
-        impression: BaseEventAnyData;
-        answer: EventAnswerData;
-    };
-    onboarding_survey: {
-        answer: BaseEventAnyData;
-        recommendation: BaseEventAnyData;
-        user_selected_recommendation: BaseEventAnyData;
-    };
-    exercise: {
-        force_pass: BaseEventAnyData;
-    };
-    experiment: {
-        contentful_experiment_assignment_event: BaseEventAnyData;
-    };
-    payments: {
-        cancel_survey: BaseEventAnyData;
-    };
-    search: {
-        visit: BaseEventAnyData;
-        click: BaseEventAnyData;
-        query: BaseEventAnyData;
-        result: BaseEventAnyData;
-    };
-    page: {
-        career_path_visited: PagePathVisitedData;
-        skill_path_visited: PagePathVisitedData;
-        course_page_visited: CoursePageVisitedData;
-    };
-    business: {
-        filter_event: BusinessFilterData;
-        search_event: BusinessSearchData;
-    };
-};
-/**
- * Base event data shared by all events
- */
-export declare type BaseEventData = {
-    fullpath?: null;
-    search?: null;
-    path?: null;
-    title?: null;
-    url?: null;
-    referrer?: string | null;
-    id?: null;
-};
-/**
- * Generic type to use for event data not typed yet
- */
-export declare type BaseEventAnyData = BaseEventData & {
-    [key: string]: any;
-};
-/**
- * Options to pass to the tracking function
- */
-export declare type TrackingOptions = {
-    /** tells backend not to merge user-identifying data onto the event payload */
-    gdprSafe?: boolean;
-};
-/**
- * The Content IDs related to the current event, to help build the content context of the event.
- * These IDs get hashed into a single value and overwrite content_id before they are sent to
- * redshift in lib/content_group_id.rb
- */
-export declare type TrackingContentIds = {
-    assessment_id?: string;
-    content_item_id?: string;
-    exercise_id?: string;
-    learning_standard_id?: string;
-    module_id?: string;
-    path_id?: string;
-    program_id?: string;
-    program_unit_id?: string;
-    review_card_id?: string;
-    track_id?: string;
-    journey_id?: string;
-};
-/**
- * Shared data relevant for all user events
- */
-export declare type UserSharedData = BaseEventData & {
-    /** the click target of the event */
-    target?: string;
-    /** the page the event is coming from */
-    page_name?: string;
-    /** a context id for the event, for events that occur in more than one place */
-    context?: string;
-    /** the link being clicked on */
-    href?: string;
-    /** a version id for the element (ex. different version ids for redesigns) */
-    version?: string;
-    /** an object of content ids related to this event */
-    content_ids?: TrackingContentIds;
-    /** the repo that this event is being fired from */
-    source_codebase?: string;
-    /** Should be used for arbitrary JSON that has been passed through JSON.stringify. */
-    misc?: string;
-};
-/**
- * Data sent to user click event table
- * NOTE: avoid adding additional properties to these objects
- * Instead, reuse existing properties, or make any additional properties generic so that they can be reused.
- * https://www.notion.so/codecademy/Guide-to-Event-Tracking-Schema-5d40b09a297743f7a30a2690208194c8#800bbf6cdf2e44de9823cd75bcc574e5
- */
-export declare type UserClickData = UserSharedData & {
-    target: string;
-    id?: string;
-    distinct_id?: string;
-    content_id?: string;
-    slug?: string;
-    name?: string;
-    action?: string;
-    type?: string;
-    location?: string;
-    element?: string;
-    weekly_goal?: string | number;
-    complete?: string;
-    video_url?: string;
-    path_id?: string;
-    path_slug?: string;
-    event_name?: string;
-    onboarding_entrypoint?: string;
-    content_slug?: string;
-    module_id?: string;
-    track_slug?: string;
-    module_slug?: string;
-    button?: string;
-    current_challenge_day?: string | number;
-    track_id?: string;
-    course?: string;
-    path_name?: string;
-    event_id?: string;
-    unit?: string;
-    lesson?: string;
-    community_prompt?: string;
-    contentItem?: any;
-    unit_slug?: string;
-    course_slug?: string;
-    course_progress?: number;
-    assessment_id?: string;
-    container_slugs?: string[];
-    search_id?: string;
-    is_ugc?: boolean;
-    business_user?: BaseEventAnyData;
-};
-/**
- * Data sent to user visit event table
- * NOTE: avoid adding additional properties to these objects
- * Instead, reuse existing properties, or make any additional properties generic so that they can be reused.
- * https://www.notion.so/codecademy/Guide-to-Event-Tracking-Schema-5d40b09a297743f7a30a2690208194c8#800bbf6cdf2e44de9823cd75bcc574e5
- */
-export declare type UserVisitData = UserSharedData & {
-    page_name: string;
-    category?: string;
-    distinct_id?: string;
-    type?: string;
-    target?: string;
-    section?: string;
-    plan?: string;
-    path_id?: string;
-    post?: string;
-    story_type?: string;
-    path_title?: string;
-    onboarding_entrypoint?: string;
-    course_slug?: string;
-    course?: string;
-    interstitial_name?: string;
-    content_id?: string;
-    story_slug?: string;
-    unit?: string;
-    lesson?: string;
-    is_ugc?: boolean;
-};
-export declare type UserImpressionData = Pick<UserSharedData, 'context' | 'source_codebase' | 'content_ids'> & {
-    page_name: string;
-    target: string;
-    slug?: string;
-    is_ugc?: boolean;
-};
-export declare type EventAnswerData = BaseEventData & {
-    question_index: number;
-    answer_index: number;
-    answer: any;
-    answer_slug: string;
-};
-export declare type User = {
-    id?: string;
-    auth_token: string;
-    profile_image_url?: string;
-    email?: string;
-    is_pro?: boolean;
-    username?: string;
-    location: {
-        in_eu: boolean;
-        geo_country: string;
-    };
-    features: string[];
-};
-export declare type UseUserResponse = {
-    user?: User;
-    status: string;
-};
-export declare type PagePathVisitedData = BaseEventData & {
-    path_id: string;
-    path_full_title: string;
-};
-export declare type CoursePageVisitedData = BaseEventData & {
-    course_id: string;
-    course_full_title: string;
-};
-export declare type FilterType = string | string[] | number | boolean;
-export declare type BusinessFilterData = BaseEventData & {
-    filter_key: string;
-    filter_value: FilterType;
-};
-export declare type BusinessSearchData = BaseEventData & {
-    search_query: string;
-};
+/**
+ * The Data types for all of our events.
+ * Follows the format EventDataTypes[Category].[Event].EventData
+ * Category + Event gives the corresponding event table in redshift
+ */
+export declare type EventDataTypes = {
+    user: {
+        click: UserClickData;
+        visit: UserVisitData;
+        impression: UserImpressionData;
+        email_trigger: BaseEventAnyData;
+        content_completed: BaseEventAnyData;
+        submit: BaseEventAnyData;
+        workspace_init: BaseEventAnyData;
+        meaningful_content_loaded: BaseEventAnyData;
+        practice_completed: BaseEventAnyData;
+    };
+    ad: {
+        click: BaseEventAnyData;
+        impression: BaseEventAnyData;
+    };
+    calendar: {
+        reminder: BaseEventAnyData;
+    };
+    notification: {
+        clicked: BaseEventAnyData;
+        ion: BaseEventAnyData;
+    };
+    form: {
+        submit: BaseEventAnyData;
+    };
+    sorting_quiz: {
+        result: BaseEventAnyData;
+        impression: BaseEventAnyData;
+        answer: EventAnswerData;
+    };
+    onboarding_survey: {
+        answer: BaseEventAnyData;
+        recommendation: BaseEventAnyData;
+        user_selected_recommendation: BaseEventAnyData;
+    };
+    exercise: {
+        force_pass: BaseEventAnyData;
+    };
+    experiment: {
+        contentful_experiment_assignment_event: BaseEventAnyData;
+    };
+    payments: {
+        cancel_survey: BaseEventAnyData;
+        extend_trial_survey: BaseEventAnyData;
+    };
+    search: {
+        visit: BaseEventAnyData;
+        click: BaseEventAnyData;
+        query: BaseEventAnyData;
+        result: BaseEventAnyData;
+    };
+    page: {
+        career_path_visited: PagePathVisitedData;
+        skill_path_visited: PagePathVisitedData;
+        course_page_visited: CoursePageVisitedData;
+    };
+    business: {
+        filter_event: BusinessFilterData;
+        search_event: BusinessSearchData;
+    };
+};
+/**
+ * Base event data shared by all events
+ */
+export declare type BaseEventData = {
+    fullpath?: null;
+    search?: null;
+    path?: null;
+    title?: null;
+    url?: null;
+    referrer?: string | null;
+    id?: null;
+};
+/**
+ * Generic type to use for event data not typed yet
+ */
+export declare type BaseEventAnyData = BaseEventData & {
+    [key: string]: any;
+};
+/**
+ * Options to pass to the tracking function
+ */
+export declare type TrackingOptions = {
+    /** tells backend not to merge user-identifying data onto the event payload */
+    gdprSafe?: boolean;
+};
+/**
+ * The Content IDs related to the current event, to help build the content context of the event.
+ * These IDs get hashed into a single value and overwrite content_id before they are sent to
+ * redshift in lib/content_group_id.rb
+ */
+export declare type TrackingContentIds = {
+    assessment_id?: string;
+    content_item_id?: string;
+    exercise_id?: string;
+    learning_standard_id?: string;
+    module_id?: string;
+    path_id?: string;
+    program_id?: string;
+    program_unit_id?: string;
+    review_card_id?: string;
+    track_id?: string;
+    journey_id?: string;
+};
+/**
+ * Shared data relevant for all user events
+ */
+export declare type UserSharedData = BaseEventData & {
+    /** the click target of the event */
+    target?: string;
+    /** the page the event is coming from */
+    page_name?: string;
+    /** a context id for the event, for events that occur in more than one place */
+    context?: string;
+    /** the link being clicked on */
+    href?: string;
+    /** a version id for the element (ex. different version ids for redesigns) */
+    version?: string;
+    /** an object of content ids related to this event */
+    content_ids?: TrackingContentIds;
+    /** the repo that this event is being fired from */
+    source_codebase?: string;
+    /** Should be used for arbitrary JSON that has been passed through JSON.stringify. */
+    misc?: string;
+};
+/**
+ * Data sent to user click event table
+ * NOTE: avoid adding additional properties to these objects
+ * Instead, reuse existing properties, or make any additional properties generic so that they can be reused.
+ * https://www.notion.so/codecademy/Guide-to-Event-Tracking-Schema-5d40b09a297743f7a30a2690208194c8#800bbf6cdf2e44de9823cd75bcc574e5
+ */
+export declare type UserClickData = UserSharedData & {
+    target: string;
+    id?: string;
+    distinct_id?: string;
+    content_id?: string;
+    slug?: string;
+    name?: string;
+    action?: string;
+    type?: string;
+    location?: string;
+    element?: string;
+    weekly_goal?: string | number;
+    complete?: string;
+    video_url?: string;
+    path_id?: string;
+    path_slug?: string;
+    event_name?: string;
+    onboarding_entrypoint?: string;
+    content_slug?: string;
+    module_id?: string;
+    track_slug?: string;
+    module_slug?: string;
+    button?: string;
+    current_challenge_day?: string | number;
+    track_id?: string;
+    course?: string;
+    path_name?: string;
+    event_id?: string;
+    unit?: string;
+    lesson?: string;
+    community_prompt?: string;
+    contentItem?: any;
+    unit_slug?: string;
+    course_slug?: string;
+    course_progress?: number;
+    assessment_id?: string;
+    container_slugs?: string[];
+    search_id?: string;
+    is_ugc?: boolean;
+    business_user?: BaseEventAnyData;
+};
+/**
+ * Data sent to user visit event table
+ * NOTE: avoid adding additional properties to these objects
+ * Instead, reuse existing properties, or make any additional properties generic so that they can be reused.
+ * https://www.notion.so/codecademy/Guide-to-Event-Tracking-Schema-5d40b09a297743f7a30a2690208194c8#800bbf6cdf2e44de9823cd75bcc574e5
+ */
+export declare type UserVisitData = UserSharedData & {
+    page_name: string;
+    category?: string;
+    distinct_id?: string;
+    type?: string;
+    target?: string;
+    section?: string;
+    plan?: string;
+    path_id?: string;
+    post?: string;
+    story_type?: string;
+    path_title?: string;
+    onboarding_entrypoint?: string;
+    course_slug?: string;
+    course?: string;
+    interstitial_name?: string;
+    content_id?: string;
+    story_slug?: string;
+    unit?: string;
+    lesson?: string;
+    is_ugc?: boolean;
+};
+export declare type UserImpressionData = Pick<UserSharedData, 'context' | 'source_codebase' | 'content_ids'> & {
+    page_name: string;
+    target: string;
+    slug?: string;
+    is_ugc?: boolean;
+};
+export declare type EventAnswerData = BaseEventData & {
+    question_index: number;
+    answer_index: number;
+    answer: any;
+    answer_slug: string;
+};
+export declare type User = {
+    id?: string;
+    auth_token: string;
+    profile_image_url?: string;
+    email?: string;
+    is_pro?: boolean;
+    username?: string;
+    location: {
+        in_eu: boolean;
+        geo_country: string;
+    };
+    features: string[];
+};
+export declare type UseUserResponse = {
+    user?: User;
+    status: string;
+};
+export declare type PagePathVisitedData = BaseEventData & {
+    path_id: string;
+    path_full_title: string;
+};
+export declare type CoursePageVisitedData = BaseEventData & {
+    course_id: string;
+    course_full_title: string;
+};
+export declare type FilterType = string | string[] | number | boolean;
+export declare type BusinessFilterData = BaseEventData & {
+    filter_key: string;
+    filter_value: FilterType;
+};
+export declare type BusinessSearchData = BaseEventData & {
+    search_query: string;
+};

package/dist/events/types.js

@@ -0,0 +1 @@
+export {};