@codecademy/tracking 0.25.1-alpha.0c5e25.0 → 0.25.1-alpha.3046e1.0

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
-@codecademy/tracking:build: cache hit, replaying output 1d6a7a29a6606c46
+@codecademy/tracking:build: cache hit, replaying output c62a4a09df002c78
 @codecademy/tracking:build: $ yarn build:clean && yarn build:compile && yarn build:types
 @codecademy/tracking:build: $ rm -rf dist
 @codecademy/tracking:build: $ babel ./src --out-dir ./dist --copy-files --extensions ".ts,.tsx"
@@ -7,5 +7,5 @@
 @codecademy/tracking:build: 
 @codecademy/tracking:build: Why you should do it regularly:
 @codecademy/tracking:build: https://github.com/browserslist/browserslist#browsers-data-updating
-@codecademy/tracking:build: Successfully compiled 18 files with Babel (2779ms).
+@codecademy/tracking:build: Successfully compiled 20 files with Babel (1936ms).
 @codecademy/tracking:build: $ tsc --emitDeclarationOnly

package/CHANGELOG.md

@@ -3,7 +3,7 @@
 All notable changes to this project will be documented in this file.
 See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
 
-### [0.25.1-alpha.0c5e25.0](https://github.com/Codecademy/client-modules/compare/@codecademy/tracking@0.25.0...@codecademy/tracking@0.25.1-alpha.0c5e25.0) (2022-10-21)
+### [0.25.1-alpha.3046e1.0](https://github.com/Codecademy/client-modules/compare/@codecademy/tracking@0.25.0...@codecademy/tracking@0.25.1-alpha.3046e1.0) (2022-10-27)
 
 **Note:** Version bump only for package @codecademy/tracking
 

package/dist/integrations/__tests__/getConsentDecision.test.d.ts

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

package/dist/integrations/__tests__/getConsentDecision.test.js

@@ -0,0 +1,58 @@
+import { Consent } from '../consent';
+import { getConsentDecision, OPT_OUT_DATALAYER_VAR } from '../getConsentDecision';
+var MINIMUM_CONSENT = [Consent.StrictlyNecessary];
+var FULL_CONSENT = [Consent.StrictlyNecessary, Consent.Functional, Consent.Performance, Consent.Targeting];
+var FULL_CONSENT_STRING = [','].concat(FULL_CONSENT).join(',');
+describe('getConsentDecision', function () {
+  it('converts a stringified consent decision into an array', function () {
+    var result = getConsentDecision({
+      scope: {
+        OnetrustActiveGroups: FULL_CONSENT_STRING
+      }
+    });
+    expect(result).toEqual(FULL_CONSENT);
+  });
+  it('does not modify an array formatted consent decision', function () {
+    var result = getConsentDecision({
+      scope: {
+        OnetrustActiveGroups: FULL_CONSENT
+      }
+    });
+    expect(result).toEqual(FULL_CONSENT);
+  });
+  describe('optedOutExternalTracking', function () {
+    it('Reduces the consent decision to necessary and functional for opted out users', function () {
+      var result = getConsentDecision({
+        scope: {
+          OnetrustActiveGroups: FULL_CONSENT
+        },
+        optedOutExternalTracking: true
+      });
+      expect(result).toEqual([Consent.StrictlyNecessary, Consent.Functional]);
+    });
+    it('Does not add Functional tracking if the user has opted out of it', function () {
+      var result = getConsentDecision({
+        scope: {
+          OnetrustActiveGroups: MINIMUM_CONSENT
+        },
+        optedOutExternalTracking: true
+      });
+      expect(result).toEqual(MINIMUM_CONSENT);
+    });
+    it('triggers the opt out datalayer variable', function () {
+      var _scope$dataLayer;
+
+      var scope = {
+        OnetrustActiveGroups: FULL_CONSENT
+      };
+      getConsentDecision({
+        scope: scope,
+        optedOutExternalTracking: true
+      });
+      var dataLayerVars = (_scope$dataLayer = scope.dataLayer) === null || _scope$dataLayer === void 0 ? void 0 : _scope$dataLayer.map(function (v) {
+        return Object.keys(v);
+      }).flat();
+      expect(dataLayerVars).toEqual([OPT_OUT_DATALAYER_VAR]);
+    });
+  });
+});

package/dist/integrations/getConsentDecision.d.ts

@@ -0,0 +1,8 @@
+import { Consent } from './consent';
+import { TrackingWindow } from './types';
+export interface ConsentDecisionOptions {
+    scope: TrackingWindow;
+    optedOutExternalTracking?: boolean;
+}
+export declare const OPT_OUT_DATALAYER_VAR = "user_opted_out_external_tracking";
+export declare const getConsentDecision: ({ scope, optedOutExternalTracking, }: ConsentDecisionOptions) => Consent[];

package/dist/integrations/getConsentDecision.js

@@ -0,0 +1,32 @@
+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; }
+
+import { Consent } from './consent';
+export var OPT_OUT_DATALAYER_VAR = 'user_opted_out_external_tracking';
+export var getConsentDecision = function getConsentDecision(_ref) {
+  var scope = _ref.scope,
+      optedOutExternalTracking = _ref.optedOutExternalTracking;
+  var consentDecision = [];
+
+  if (typeof scope.OnetrustActiveGroups === 'string') {
+    consentDecision = scope.OnetrustActiveGroups.split(',').filter(Boolean);
+  } else if (scope.OnetrustActiveGroups) {
+    consentDecision = scope.OnetrustActiveGroups;
+  }
+
+  if (optedOutExternalTracking) {
+    var _scope$dataLayer;
+
+    /**
+     * If user has already opted out of everything but the essentials
+     * don't force them to consent to Functional trackers
+     */
+    if (consentDecision.length > 1) {
+      consentDecision = [Consent.StrictlyNecessary, Consent.Functional];
+    }
+
+    (_scope$dataLayer = scope.dataLayer) !== null && _scope$dataLayer !== void 0 ? _scope$dataLayer : scope.dataLayer = [];
+    scope.dataLayer.push(_defineProperty({}, OPT_OUT_DATALAYER_VAR, true));
+  }
+
+  return consentDecision;
+};

package/dist/integrations/index.d.ts

@@ -16,6 +16,10 @@ export declare type TrackingIntegrationsSettings = {
      * User details to identify in Segment.
      */
     user?: UserIntegrationSummary;
+    /**
+     * Whether user has opted out or is excluded from external tracking
+     */
+    optedOutExternalTracking?: boolean;
     /**
      * Segment write key.
      */
@@ -24,4 +28,4 @@ export declare type TrackingIntegrationsSettings = {
 /**
  * @see README.md for details and usage.
  */
-export declare const initializeTrackingIntegrations: ({ onError, production, scope, user, writeKey, }: TrackingIntegrationsSettings) => Promise<void>;
+export declare const initializeTrackingIntegrations: ({ onError, production, scope, user, optedOutExternalTracking, writeKey, }: TrackingIntegrationsSettings) => Promise<void>;

package/dist/integrations/index.js

@@ -6,6 +6,7 @@ function _asyncToGenerator(fn) { return function () { var self = this, args = ar
 
 import { conditionallyLoadAnalytics } from './conditionallyLoadAnalytics';
 import { fetchDestinationsForWriteKey } from './fetchDestinationsForWriteKey';
+import { getConsentDecision } from './getConsentDecision';
 import { mapDestinations } from './mapDestinations';
 import { initializeOneTrust } from './onetrust';
 import { runSegmentSnippet } from './runSegmentSnippet';
@@ -15,13 +16,13 @@ import { runSegmentSnippet } from './runSegmentSnippet';
  */
 export var initializeTrackingIntegrations = /*#__PURE__*/function () {
   var _ref2 = _asyncToGenerator( /*#__PURE__*/_regeneratorRuntime.mark(function _callee(_ref) {
-    var onError, production, scope, user, writeKey, destinations, _mapDestinations, destinationPreferences, identifyPreferences;
+    var onError, production, scope, user, optedOutExternalTracking, writeKey, destinations, consentDecision, _mapDestinations, destinationPreferences, identifyPreferences;
 
     return _regeneratorRuntime.wrap(function _callee$(_context) {
       while (1) {
         switch (_context.prev = _context.next) {
           case 0:
-            onError = _ref.onError, production = _ref.production, scope = _ref.scope, user = _ref.user, writeKey = _ref.writeKey;
+            onError = _ref.onError, production = _ref.production, scope = _ref.scope, user = _ref.user, optedOutExternalTracking = _ref.optedOutExternalTracking, writeKey = _ref.writeKey;
             _context.next = 3;
             return new Promise(function (resolve) {
               return setTimeout(resolve, 1000);
@@ -55,9 +56,13 @@ export var initializeTrackingIntegrations = /*#__PURE__*/function () {
             return _context.abrupt("return");
 
           case 11:
-            // 5. Those integrations are compared against the user's consent decisions into a list of allowed destinations
+            consentDecision = getConsentDecision({
+              scope: scope,
+              optedOutExternalTracking: optedOutExternalTracking
+            }); // 5. Those integrations are compared against the user's consent decisions into a list of allowed destinations
+
             _mapDestinations = mapDestinations({
-              consentDecision: scope.OnetrustActiveGroups,
+              consentDecision: consentDecision,
               destinations: destinations
             }), destinationPreferences = _mapDestinations.destinationPreferences, identifyPreferences = _mapDestinations.identifyPreferences; // 6. We load only those allowed destinations using Segment's `analytics.load`
 
@@ -69,7 +74,7 @@ export var initializeTrackingIntegrations = /*#__PURE__*/function () {
               writeKey: writeKey
             });
 
-          case 13:
+          case 14:
           case "end":
             return _context.stop();
         }

package/dist/integrations/onetrust.js

@@ -23,14 +23,13 @@ export var initializeOneTrust = /*#__PURE__*/function () {
             document.body.appendChild(style);
             return _context.abrupt("return", new Promise(function (resolve) {
               scope.OptanonWrapper = function () {
-                var _scope$dataLayer, _script$parentNode;
+                var _scope$dataLayer;
 
                 (_scope$dataLayer = scope.dataLayer) !== null && _scope$dataLayer !== void 0 ? _scope$dataLayer : scope.dataLayer = [];
                 scope.dataLayer.push({
                   event: 'OneTrustGroupsUpdated'
                 });
-                resolve();
-                (_script$parentNode = script.parentNode) === null || _script$parentNode === void 0 ? void 0 : _script$parentNode.removeChild(script);
+                resolve(); // script.parentNode?.removeChild(script);
               };
             }));
 

package/dist/integrations/types.d.ts

@@ -16,9 +16,14 @@ export interface SegmentDestination {
 export interface SegmentAnalyticsOptions {
     integrations: Record<string, boolean>;
 }
+export interface OneTrustSDK {
+    RejectAll: () => void;
+    UpdateConsent?: (category: string, code: string) => void;
+}
 export interface TrackingWindow {
     analytics?: SegmentAnalytics;
     dataLayer?: unknown[];
-    OnetrustActiveGroups?: Consent[];
+    OnetrustActiveGroups?: Consent[] | string;
     OptanonWrapper?: () => void;
+    OneTrust?: OneTrustSDK;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@codecademy/tracking",
   "description": "Tracking library for Codecademy apps.",
-  "version": "0.25.1-alpha.0c5e25.0",
+  "version": "0.25.1-alpha.3046e1.0",
   "author": "Codecademy Engineering <dev@codecademy.com>",
   "module": "./dist/index.js",
   "main": "./dist/index.js",
@@ -16,7 +16,7 @@
     "@babel/cli": "^7.13.10",
     "@types/fetch-mock": "^7.3.3",
     "@types/jest": "^26.0.15",
-    "babel-preset-codecademy": "6.0.1-alpha.0c5e25.0",
+    "babel-preset-codecademy": "^6.0.0",
     "fetch-mock": "^9.11.0",
     "jest-fetch-mock": "^3.0.3",
     "ts-jest": "^26.4.1",
@@ -35,5 +35,5 @@
   "publishConfig": {
     "access": "public"
   },
-  "gitHead": "c14cd6faf9b1146fb3476c090a8f73b82c16f79d"
+  "gitHead": "5c3251be3d89b64ce890153c3783c04b4d50c8e0"
 }