@codecademy/tracking 1.0.16 → 1.0.17-alpha.1bc61b545f.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,24 @@
1
+ /// <reference types="react" />
2
+ import { createTracker } from '.';
3
+ type Tracker = ReturnType<typeof createTracker>;
4
+ export interface AppTrackerContextValue {
5
+ tracker: Tracker;
6
+ trackUserClick: Tracker['click'];
7
+ trackEvent: Tracker['event'];
8
+ trackUserVisit: Tracker['visit'];
9
+ trackUserImpression: Tracker['impression'];
10
+ trackSetFilter: (filter_key: string, filter_value: filterType) => void;
11
+ trackSearchQuery: (search_query: string) => void;
12
+ }
13
+ export type filterType = string | string[] | number | boolean;
14
+ export declare const AppTrackerContext: import("react").Context<AppTrackerContextValue | undefined>;
15
+ export declare const trackingFns: (tracker: Tracker, source_codebase: string) => {
16
+ trackUserClick: (data: import(".").UserClickData) => void;
17
+ trackEvent: <Category extends keyof import(".").EventDataTypes, Event_1 extends string & keyof import(".").EventDataTypes[Category], Data extends import(".").EventDataTypes[Category][Event_1] & import(".").BaseEventData>(category: Category, event: Event_1, userData: Data, options?: import(".").TrackingOptions) => void;
18
+ trackUserVisit: (data: import(".").UserVisitData) => void;
19
+ trackUserImpression: (data: import(".").UserImpressionData) => void;
20
+ trackSetFilter: (filter_key: string, filter_value: filterType) => void;
21
+ trackSearchQuery: (search_query: string) => void;
22
+ };
23
+ export declare const useAppTrackerContext: () => AppTrackerContextValue;
24
+ export {};
@@ -0,0 +1,56 @@
1
+ function _typeof(o) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (o) { return typeof o; } : function (o) { return o && "function" == typeof Symbol && o.constructor === Symbol && o !== Symbol.prototype ? "symbol" : typeof o; }, _typeof(o); }
2
+ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
3
+ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
4
+ function _defineProperty(obj, key, value) { key = _toPropertyKey(key); if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
5
+ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
6
+ function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
7
+ import { createContext, useContext } from 'react';
8
+ export var AppTrackerContext = /*#__PURE__*/createContext(undefined);
9
+ export var trackingFns = function trackingFns(tracker, source_codebase) {
10
+ var trackUserClick = function trackUserClick(data) {
11
+ return tracker.click(_objectSpread(_objectSpread({}, data), {}, {
12
+ source_codebase: source_codebase
13
+ }));
14
+ };
15
+ var trackEvent = function trackEvent(category, event, data) {
16
+ return tracker.event(category, event, _objectSpread(_objectSpread({}, data), {}, {
17
+ source_codebase: source_codebase
18
+ }));
19
+ };
20
+ var trackUserVisit = function trackUserVisit(data) {
21
+ return tracker.visit(_objectSpread(_objectSpread({}, data), {}, {
22
+ source_codebase: source_codebase
23
+ }));
24
+ };
25
+ var trackUserImpression = function trackUserImpression(data) {
26
+ return tracker.impression(_objectSpread(_objectSpread({}, data), {}, {
27
+ source_codebase: source_codebase
28
+ }));
29
+ };
30
+ var trackSetFilter = function trackSetFilter(filter_key, filter_value) {
31
+ return tracker.event('business', 'filter_event', {
32
+ filter_key: filter_key,
33
+ filter_value: filter_value
34
+ });
35
+ };
36
+ var trackSearchQuery = function trackSearchQuery(search_query) {
37
+ return tracker.event('business', 'search_event', {
38
+ search_query: search_query
39
+ });
40
+ };
41
+ return {
42
+ trackUserClick: trackUserClick,
43
+ trackEvent: trackEvent,
44
+ trackUserVisit: trackUserVisit,
45
+ trackUserImpression: trackUserImpression,
46
+ trackSetFilter: trackSetFilter,
47
+ trackSearchQuery: trackSearchQuery
48
+ };
49
+ };
50
+ export var useAppTrackerContext = function useAppTrackerContext() {
51
+ var context = useContext(AppTrackerContext);
52
+ if (context === undefined) {
53
+ throw new Error('useAppTrackerContext must be used within AppTrackerContext.Provider');
54
+ }
55
+ return context;
56
+ };
package/dist/index.d.ts CHANGED
@@ -1,3 +1,4 @@
1
1
  export * from './integrations';
2
2
  export type { TrackingWindow } from './integrations/types';
3
+ export * from './AppTracker';
3
4
  export * from './events';
package/dist/index.js CHANGED
@@ -1,3 +1,4 @@
1
1
  export * from './integrations';
2
+ export * from './AppTracker';
2
3
  export * from './events';
3
4
  export {};
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@codecademy/tracking",
3
3
  "description": "Tracking library for Codecademy",
4
- "version": "1.0.16",
4
+ "version": "1.0.17-alpha.1bc61b545f.0",
5
5
  "author": "Codecademy Engineering <dev@codecademy.com>",
6
6
  "files": [
7
7
  "dist/**"
@@ -13,5 +13,5 @@
13
13
  "access": "public"
14
14
  },
15
15
  "repository": "git@github.com:codecademy-engineering/mono.git",
16
- "gitHead": "359b7c1920e242a44704b787d059cdb4b7c3f003"
16
+ "gitHead": "20f2bcdd24fbd79a76a7392cb5cc2b1deb0e2b03"
17
17
  }