@codecademy/tracking 1.0.12-alpha.fa473cbdf3.0 → 1.0.12

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

@@ -65,6 +65,9 @@ export type EventDataTypes = {
         filter_event: BusinessFilterData;
         search_event: BusinessSearchData;
     };
+    gpt_plugin: {
+        search: ChatGPTPluginSearchEventData;
+    };
 };
 /**
  * Base event data shared by all events
@@ -250,3 +253,13 @@ export type BusinessFilterData = 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/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@codecademy/tracking",
   "description": "Tracking library for Codecademy",
-  "version": "1.0.12-alpha.fa473cbdf3.0",
+  "version": "1.0.12",
   "author": "Codecademy Engineering <dev@codecademy.com>",
+  "dependencies": {
+    "@babel/runtime": "^7.12.1"
+  },
   "files": [
     "dist/**"
   ],
@@ -13,5 +16,5 @@
     "access": "public"
   },
   "repository": "git@github.com:codecademy-engineering/mono.git",
-  "gitHead": "dae78b0a51d539c0b4a97382e13dc267771f88c8"
+  "gitHead": "05bb6adfc2b1c065b9955db531c23039e696b1ad"
 }