@chordcommerce/analytics
Version:
Chord Commerce event tracking
208 lines (207 loc) • 10.4 kB
JavaScript
;
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
return new (P || (P = Promise))(function (resolve, reject) {
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
step((generator = generator.apply(thisArg, _arguments || [])).next());
});
};
var __generator = (this && this.__generator) || function (thisArg, body) {
var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
function verb(n) { return function (v) { return step([n, v]); }; }
function step(op) {
if (f) throw new TypeError("Generator is already executing.");
while (g && (g = 0, op[0] && (_ = 0)), _) try {
if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
if (y = 0, t) op = [op[0] & 2, t.value];
switch (op[0]) {
case 0: case 1: t = op; break;
case 4: _.label++; return { value: op[1], done: false };
case 5: _.label++; y = op[1]; op = [0]; continue;
case 7: op = _.ops.pop(); _.trys.pop(); continue;
default:
if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
if (t[2]) _.ops.pop();
_.trys.pop(); continue;
}
op = body.call(thisArg, _);
} catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
}
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.addCdpConsent = void 0;
var ketch_js_1 = require("./ketch.js");
var onetrust_js_1 = require("./onetrust.js");
var shopify_js_1 = require("./shopify.js");
var segment_js_1 = require("./segment.js");
var addCdpConsent = function (options) {
var lastProcessedConsent = null;
var POLLING_INTERVAL_MS = 50;
var TIMEOUT_MS = options.awaitConsentTimeout
? options.awaitConsentTimeout
: 60000;
/**
* Returns the adapter for the specified consent management platform.
*/
var getAdapter = function () {
var _a;
switch ((_a = options.consent) === null || _a === void 0 ? void 0 : _a.toLowerCase()) {
case 'ketch':
return (0, ketch_js_1.ketchConsentAdapter)();
case 'onetrust':
return (0, onetrust_js_1.onetrustConsentAdapter)(options);
case 'shopify':
return (0, shopify_js_1.shopifyConsentAdapter)();
case 'segment':
return (0, segment_js_1.segmentConsentAdapter)();
default:
return null;
}
};
// Initialize adapter immediately so getConsentConfig() works
var adapter = getAdapter();
/**
* Polls if user can be tracked based on consent
* @returns Promise that resolves to true if condition is met within timeout, false otherwise
*/
var checkUserCanBeTracked = function () { return __awaiter(void 0, void 0, void 0, function () {
return __generator(this, function (_a) {
return [2 /*return*/, new Promise(function (resolve) {
// Checking immediately first
if (adapter === null || adapter === void 0 ? void 0 : adapter.userCanBeTracked()) {
resolve(true);
return;
}
var interval = setInterval(function () {
if (adapter === null || adapter === void 0 ? void 0 : adapter.userCanBeTracked()) {
clearInterval(interval);
resolve(true);
}
}, POLLING_INTERVAL_MS);
setTimeout(function () {
clearInterval(interval);
resolve(false);
}, TIMEOUT_MS);
})];
});
}); };
/**
* Tracks consent preference changes.
* Note: Per-event consent stamping is handled in ChordAnalytics via stampConsent().
*/
var trackConsentUpdate = function (updatedConsent) { return __awaiter(void 0, void 0, void 0, function () {
var chordAnalytics;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (lastProcessedConsent &&
JSON.stringify(lastProcessedConsent) === JSON.stringify(updatedConsent)) {
return [2 /*return*/];
}
lastProcessedConsent = updatedConsent;
chordAnalytics = window[options.namespace];
if (!(chordAnalytics &&
typeof chordAnalytics.track === 'function' &&
updatedConsent.consentCategories !== undefined)) return [3 /*break*/, 2];
return [4 /*yield*/, chordAnalytics.track('Consent Preferences Updated', updatedConsent)];
case 1:
_a.sent();
if (options.enableLogging && options.debug) {
console.log('[Chord Analytics DEBUG]: Consent preferences updated, sent tracking event');
}
_a.label = 2;
case 2: return [2 /*return*/];
}
});
}); };
/**
* Sets up consent management by initializing the adapter and handling consent updates.
* Returns the initial consent so it can be tracked after CDP is fully ready (avoiding circular await).
*/
var setupConsentManagement = function () { return __awaiter(void 0, void 0, void 0, function () {
var initialConsent;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (!adapter)
return [2 /*return*/, null
// Set up the consent update handler first to catch any immediate updates
];
// Set up the consent update handler first to catch any immediate updates
adapter.handleConsentUpdates(function (updatedConsent) {
trackConsentUpdate(updatedConsent);
});
return [4 /*yield*/, adapter.getCurrentConsent()];
case 1:
initialConsent = _a.sent();
lastProcessedConsent = initialConsent;
return [2 /*return*/, initialConsent];
}
});
}); };
/**
* Initializes consent management and sets up consent update handlers.
* Returns initial consent configuration to be tracked after CDP is fully ready,
* or null if consent setup failed or was blocked.
*/
var init = function () { return __awaiter(void 0, void 0, void 0, function () {
var canBeTracked, error_1;
return __generator(this, function (_a) {
switch (_a.label) {
case 0:
if (options.debug && options.enableLogging) {
console.log('[Chord Analytics DEBUG]: consent init() called, adapter:', adapter ? options.consent : 'null');
}
if (adapter === null) {
console.error("Consent management adapter \"".concat(options.consent, "\" is not supported."));
return [2 /*return*/, null];
}
if (!options.awaitConsent) return [3 /*break*/, 2];
if (options.debug && options.enableLogging) {
console.log('[Chord Analytics DEBUG]: awaitConsent is true, checking if user can be tracked');
}
return [4 /*yield*/, checkUserCanBeTracked()];
case 1:
canBeTracked = _a.sent();
if (!canBeTracked) {
if (options.debug && options.enableLogging) {
console.log('[Chord Analytics DEBUG]: User cannot be tracked, returning null');
}
return [2 /*return*/, null];
}
_a.label = 2;
case 2:
_a.trys.push([2, 4, , 5]);
return [4 /*yield*/, setupConsentManagement()];
case 3: return [2 /*return*/, _a.sent()];
case 4:
error_1 = _a.sent();
console.error('Error setting up consent management:', error_1);
return [2 /*return*/, null];
case 5: return [2 /*return*/];
}
});
}); };
var getConsentConfig = function () {
if (!(adapter === null || adapter === void 0 ? void 0 : adapter.getCategories) || !(adapter === null || adapter === void 0 ? void 0 : adapter.isConsentReady)) {
return undefined;
}
return {
getCategories: function () { return adapter.getCategories(); },
isConsentReady: function () { return adapter.isConsentReady(); },
debug: options.debug && options.enableLogging,
};
};
return {
init: init,
getConsentConfig: getConsentConfig,
};
};
exports.addCdpConsent = addCdpConsent;