@codecademy/tracking 1.0.11 → 1.0.12-alpha.2ae4ecfbb1.0

package/dist/events/track.d.ts

@@ -1,5 +1,5 @@
 import type { BaseEventData, EventDataTypes, TrackingOptions, UserClickData, UserImpressionData, UserVisitData } from './types';
-export declare type TrackerOptions = {
+export type TrackerOptions = {
     apiBaseUrl: string;
     verbose?: boolean;
 };

package/dist/events/track.js

@@ -49,7 +49,8 @@ export var createTracker = function createTracker(_ref) {
   };
   var event = function event(category, _event, userData) {
     var options = arguments.length > 3 && arguments[3] !== undefined ? arguments[3] : {};
-    var properties = _objectSpread(_objectSpread({}, userData), {}, {
+    // support server-side-only as well as client-side events
+    var properties = typeof window !== 'undefined' ? _objectSpread(_objectSpread({}, userData), {}, {
       fullpath: window.location.pathname + window.location.search,
       search: window.location.search,
       path: window.location.pathname,
@@ -57,7 +58,7 @@ export var createTracker = function createTracker(_ref) {
       url: window.location.href,
       referrer: userData.referrer || window.document.referrer,
       client: getClientType()
-    });
+    }) : userData;
     if (verbose) {
       console.groupCollapsed("%cTracking Event Fired: ".concat(category, ":").concat(_event), 'color: #4b35ef; font-style: italic;');
       console.log({
@@ -69,13 +70,15 @@ export var createTracker = function createTracker(_ref) {
     }
 
     // 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)
-    });
+    if (typeof window !== 'undefined') {
+      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,

package/dist/events/types.d.ts

@@ -3,7 +3,7 @@
  * Follows the format EventDataTypes[Category].[Event].EventData
  * Category + Event gives the corresponding event table in redshift
  */
-export declare type EventDataTypes = {
+export type EventDataTypes = {
     user: {
         click: UserClickData;
         visit: UserVisitData;
@@ -65,11 +65,14 @@ export declare type EventDataTypes = {
         filter_event: BusinessFilterData;
         search_event: BusinessSearchData;
     };
+    gpt_plugin: {
+        search: ChatGPTPluginSearchEventData;
+    };
 };
 /**
  * Base event data shared by all events
  */
-export declare type BaseEventData = {
+export type BaseEventData = {
     fullpath?: null;
     search?: null;
     path?: null;
@@ -81,13 +84,13 @@ export declare type BaseEventData = {
 /**
  * Generic type to use for event data not typed yet
  */
-export declare type BaseEventAnyData = BaseEventData & {
+export type BaseEventAnyData = BaseEventData & {
     [key: string]: any;
 };
 /**
  * Options to pass to the tracking function
  */
-export declare type TrackingOptions = {
+export type TrackingOptions = {
     /** tells backend not to merge user-identifying data onto the event payload */
     gdprSafe?: boolean;
 };
@@ -96,7 +99,7 @@ export declare type TrackingOptions = {
  * 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 = {
+export type TrackingContentIds = {
     assessment_id?: string;
     content_item_id?: string;
     exercise_id?: string;
@@ -112,7 +115,7 @@ export declare type TrackingContentIds = {
 /**
  * Shared data relevant for all user events
  */
-export declare type UserSharedData = BaseEventData & {
+export type UserSharedData = BaseEventData & {
     /** the click target of the event */
     target?: string;
     /** the page the event is coming from */
@@ -136,7 +139,7 @@ export declare type UserSharedData = BaseEventData & {
  * 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 & {
+export type UserClickData = UserSharedData & {
     target: string;
     id?: string;
     distinct_id?: string;
@@ -183,7 +186,7 @@ export declare type UserClickData = UserSharedData & {
  * 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 & {
+export type UserVisitData = UserSharedData & {
     page_name: string;
     category?: string;
     distinct_id?: string;
@@ -205,19 +208,19 @@ export declare type UserVisitData = UserSharedData & {
     lesson?: string;
     is_ugc?: boolean;
 };
-export declare type UserImpressionData = Pick<UserSharedData, 'context' | 'source_codebase' | 'content_ids'> & {
+export type UserImpressionData = Pick<UserSharedData, 'context' | 'source_codebase' | 'content_ids'> & {
     page_name: string;
     target: string;
     slug?: string;
     is_ugc?: boolean;
 };
-export declare type EventAnswerData = BaseEventData & {
+export type EventAnswerData = BaseEventData & {
     question_index: number;
     answer_index: number;
     answer: any;
     answer_slug: string;
 };
-export declare type User = {
+export type User = {
     id?: string;
     auth_token: string;
     profile_image_url?: string;
@@ -230,23 +233,33 @@ export declare type User = {
     };
     features: string[];
 };
-export declare type UseUserResponse = {
+export type UseUserResponse = {
     user?: User;
     status: string;
 };
-export declare type PagePathVisitedData = BaseEventData & {
+export type PagePathVisitedData = BaseEventData & {
     path_id: string;
     path_full_title: string;
 };
-export declare type CoursePageVisitedData = BaseEventData & {
+export type CoursePageVisitedData = BaseEventData & {
     course_id: string;
     course_full_title: string;
 };
-export declare type FilterType = string | string[] | number | boolean;
-export declare type BusinessFilterData = BaseEventData & {
+export type FilterType = string | string[] | number | boolean;
+export type BusinessFilterData = BaseEventData & {
     filter_key: string;
     filter_value: FilterType;
 };
-export declare type BusinessSearchData = BaseEventData & {
+export type BusinessSearchData = BaseEventData & {
     search_query: string;
 };
+export declare enum ChatGPTSearchResource {
+    ALL = "all",
+    ARTICLES = "articles",
+    CATALOG = "catalog",
+    DOCS = "docs"
+}
+export type ChatGPTPluginSearchEventData = {
+    resource: ChatGPTSearchResource;
+    query: string;
+};

package/dist/events/types.js

@@ -1 +1,51 @@
-export {};
+/**
+ * The Data types for all of our events.
+ * Follows the format EventDataTypes[Category].[Event].EventData
+ * Category + Event gives the corresponding event table in redshift
+ */
+
+/**
+ * Base event data shared by all events
+ */
+
+/**
+ * Generic type to use for event data not typed yet
+ */
+
+/**
+ * Options to pass to the tracking function
+ */
+
+/**
+ * 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
+ */
+
+/**
+ * Shared data relevant for all user events
+ */
+
+/**
+ * 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
+ */
+
+/**
+ * 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 var ChatGPTSearchResource = /*#__PURE__*/function (ChatGPTSearchResource) {
+  ChatGPTSearchResource["ALL"] = "all";
+  ChatGPTSearchResource["ARTICLES"] = "articles";
+  ChatGPTSearchResource["CATALOG"] = "catalog";
+  ChatGPTSearchResource["DOCS"] = "docs";
+  return ChatGPTSearchResource;
+}({});
+
+// does not extend base event (all client side fields there)

package/dist/integrations/conditionallyLoadAnalytics.d.ts

@@ -1,5 +1,5 @@
 import { SegmentAnalytics, UserIntegrationSummary } from './types';
-export declare type AnalyticsLoadOptions = {
+export type AnalyticsLoadOptions = {
     analytics: SegmentAnalytics;
     destinationPreferences: Record<string, boolean>;
     identifyPreferences: Record<string, boolean>;

package/dist/integrations/fetchDestinationsForWriteKey.d.ts

@@ -1,5 +1,5 @@
 import { SegmentDestination } from './types';
-export declare type FetchDestinationsSettings = {
+export type FetchDestinationsSettings = {
     onError: (message: string) => void;
     writeKey: string;
 };

package/dist/integrations/index.d.ts

@@ -1,5 +1,5 @@
 import { TrackingWindow, UserIntegrationSummary } from './types';
-export declare type TrackingIntegrationsSettings = {
+export type TrackingIntegrationsSettings = {
     /**
      * Called whenever a network request fails.
      */

package/dist/integrations/mapDestinations.d.ts

@@ -1,6 +1,6 @@
 import { Consent } from './consent';
 import { SegmentDestination } from './types';
-export declare type DestinationMapOptions = {
+export type DestinationMapOptions = {
     consentDecision?: Consent[];
     destinations: SegmentDestination[];
 };

package/dist/integrations/onetrust.d.ts

@@ -1,5 +1,5 @@
 import { TrackingWindow } from './types';
-export declare type OneTrustSettings = {
+export type OneTrustSettings = {
     production: boolean;
     scope: TrackingWindow;
 };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/tracking",
   "description": "Tracking library for Codecademy",
-  "version": "1.0.11",
+  "version": "1.0.12-alpha.2ae4ecfbb1.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "dependencies": {
     "@babel/runtime": "^7.12.1"
@@ -16,5 +16,5 @@
     "access": "public"
   },
   "repository": "git@github.com:codecademy-engineering/mono.git",
-  "gitHead": "ba018fb30df7c23cc90cb579908058995fc81e0f"
+  "gitHead": "e71b065e639b6c26415f2633603b7f20cd065ae2"
 }