@codecademy/tracking 1.0.19-alpha.05259ea391.0 → 1.0.19-alpha.1fd393ebfc.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.
@@ -1,7 +1,7 @@
1
1
  import React from 'react';
2
2
  import { createTracker } from '.';
3
3
  type Tracker = ReturnType<typeof createTracker>;
4
- export interface AppTrackerContextValue {
4
+ export interface TrackingContextValue {
5
5
  trackUserClick: Tracker['click'];
6
6
  trackEvent: Tracker['event'];
7
7
  trackUserVisit: Tracker['visit'];
@@ -10,12 +10,12 @@ export interface AppTrackerContextValue {
10
10
  trackSearchQuery: (search_query: string) => void;
11
11
  }
12
12
  export type filterType = string | string[] | number | boolean;
13
- export declare const AppTrackerContext: React.Context<AppTrackerContextValue | undefined>;
14
- export declare const AppTrackerProvider: React.FC<{
13
+ export declare const TrackingContext: React.Context<TrackingContextValue | undefined>;
14
+ export declare const TrackingProvider: React.FC<{
15
15
  apiBaseUrl: string;
16
16
  verbose: boolean;
17
- source_codebase: string;
17
+ sourceCodebase: string;
18
18
  children: React.ReactNode;
19
19
  }>;
20
- export declare const useAppTrackerContext: () => AppTrackerContextValue;
20
+ export declare const useTracking: () => TrackingContextValue;
21
21
  export {};
@@ -4,51 +4,53 @@ function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t =
4
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
5
  function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _typeof(key) === "symbol" ? key : String(key); }
6
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 React, { createContext, useContext } from 'react';
7
+ import React, { createContext, useCallback, useContext, useMemo } from 'react';
8
8
  import { createTracker } from '.';
9
9
  import { jsx as _jsx } from "react/jsx-runtime";
10
- export var AppTrackerContext = /*#__PURE__*/createContext(undefined);
11
- export var AppTrackerProvider = function AppTrackerProvider(_ref) {
10
+ export var TrackingContext = /*#__PURE__*/createContext(undefined);
11
+ export var TrackingProvider = function TrackingProvider(_ref) {
12
12
  var children = _ref.children,
13
- source_codebase = _ref.source_codebase,
13
+ source_codebase = _ref.sourceCodebase,
14
14
  apiBaseUrl = _ref.apiBaseUrl,
15
15
  verbose = _ref.verbose;
16
- var tracker = createTracker({
17
- apiBaseUrl: apiBaseUrl,
18
- verbose: verbose
19
- });
20
- var trackUserClick = function trackUserClick(data) {
16
+ var tracker = useMemo(function () {
17
+ return createTracker({
18
+ apiBaseUrl: apiBaseUrl,
19
+ verbose: verbose
20
+ });
21
+ }, [apiBaseUrl, verbose]);
22
+ var trackUserClick = useCallback(function (data) {
21
23
  return tracker.click(_objectSpread(_objectSpread({}, data), {}, {
22
24
  source_codebase: source_codebase
23
25
  }));
24
- };
25
- var trackEvent = function trackEvent(category, event, data) {
26
+ }, [tracker, source_codebase]);
27
+ var trackEvent = useCallback(function (category, event, data) {
26
28
  return tracker.event(category, event, _objectSpread(_objectSpread({}, data), {}, {
27
29
  source_codebase: source_codebase
28
30
  }));
29
- };
30
- var trackUserVisit = function trackUserVisit(data) {
31
+ }, [tracker, source_codebase]);
32
+ var trackUserVisit = useCallback(function (data) {
31
33
  return tracker.visit(_objectSpread(_objectSpread({}, data), {}, {
32
34
  source_codebase: source_codebase
33
35
  }));
34
- };
35
- var trackUserImpression = function trackUserImpression(data) {
36
+ }, [tracker, source_codebase]);
37
+ var trackUserImpression = useCallback(function (data) {
36
38
  return tracker.impression(_objectSpread(_objectSpread({}, data), {}, {
37
39
  source_codebase: source_codebase
38
40
  }));
39
- };
40
- var trackSetFilter = function trackSetFilter(filter_key, filter_value) {
41
+ }, [tracker, source_codebase]);
42
+ var trackSetFilter = useCallback(function (filter_key, filter_value) {
41
43
  return tracker.event('business', 'filter_event', {
42
44
  filter_key: filter_key,
43
45
  filter_value: filter_value
44
46
  });
45
- };
46
- var trackSearchQuery = function trackSearchQuery(search_query) {
47
+ }, [tracker]);
48
+ var trackSearchQuery = useCallback(function (search_query) {
47
49
  return tracker.event('business', 'search_event', {
48
50
  search_query: search_query
49
51
  });
50
- };
51
- return /*#__PURE__*/_jsx(AppTrackerContext.Provider, {
52
+ }, [tracker]);
53
+ return /*#__PURE__*/_jsx(TrackingContext.Provider, {
52
54
  value: {
53
55
  trackUserClick: trackUserClick,
54
56
  trackEvent: trackEvent,
@@ -60,10 +62,10 @@ export var AppTrackerProvider = function AppTrackerProvider(_ref) {
60
62
  children: children
61
63
  });
62
64
  };
63
- export var useAppTrackerContext = function useAppTrackerContext() {
64
- var context = useContext(AppTrackerContext);
65
+ export var useTracking = function useTracking() {
66
+ var context = useContext(TrackingContext);
65
67
  if (context === undefined) {
66
- throw new Error('useAppTrackerContext must be used within AppTrackerContext.Provider');
68
+ throw new Error('useTracking must be used within TrackingContext.Provider');
67
69
  }
68
70
  return context;
69
71
  };
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.19-alpha.05259ea391.0",
4
+ "version": "1.0.19-alpha.1fd393ebfc.0",
5
5
  "author": "Codecademy Engineering <dev@codecademy.com>",
6
6
  "files": [
7
7
  "dist/**"
@@ -9,9 +9,12 @@
9
9
  "license": "MIT",
10
10
  "main": "./dist/index.js",
11
11
  "module": "./dist/index.js",
12
+ "peerDependencies": {
13
+ "react": "^18.2.0"
14
+ },
12
15
  "publishConfig": {
13
16
  "access": "public"
14
17
  },
15
18
  "repository": "git@github.com:codecademy-engineering/mono.git",
16
- "gitHead": "2e5f3ef369eaf1f8c66d1c0a9fe2cdbfd943f604"
19
+ "gitHead": "df2854ed0343b201f7cfb66653ec5c4cf135a637"
17
20
  }