Skip to content

Add Ketch CMP integration for consent tracking #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
retini wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Add Ketch CMP integration for consent tracking #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions cmp/ketch.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
// MIT License
// Copyright (c) 2026 Open2b
// See the LICENSE file for full text.

function setupKetch(onConsent) {
const k = window.ketch
const cb = (config) => onConsent(config.purposes)
k('on', 'consent', cb)
k('on', 'userConsentUpdated', cb)
}

export default setupKetch;
19 changes: 18 additions & 1 deletion krenalis.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@ import Sender from './sender.js'
import Session from './session.js'
import Storage from './storage.js'
import User from './user.js'
import setupKetch from './cmp/ketch.js'

const version = '0.0.0'
const none = () => {}
Expand Down Expand Up @@ -50,6 +51,7 @@ class Krenalis {
#isLeader = false
#onFollowerQueue = null // is null when it is not the leader
#debug
#consent

// constructor returns a new Krenalis instance. writeKey is the write key,
// endpoint denotes the endpoint URL, and options is an object containing
Expand Down Expand Up @@ -85,6 +87,8 @@ class Krenalis {
this.#user = new User(this.#storage)
this.#group = new Group(this.#storage)

this.#setupConsentManagement()

// Participate in leader elections.
const electionsState = new ElectionsState(this.#keysPrefix)
this.#elections = new Elections(this.#id, electionsState, this.#onElection.bind(this))
Expand Down Expand Up @@ -537,8 +541,12 @@ class Krenalis {
}
}

if (this.#consent != null) {
event.context.consent = this.#consent;
}

// Apply user-provided context last so it can override automatic
// enrichments (campaign, timezone, session, etc).
// enrichments (campaign, timezone, session, consent, etc).
if ('context' in options) {
this.#mergeContext(event.context, options.context)
}
Expand Down Expand Up @@ -781,6 +789,15 @@ class Krenalis {
return options
}

#setupConsentManagement() {
const onConsent = (consent) => {
this.#consent = consent
}
if (window.ketch != null) {
setupKetch(onConsent)
}
}

// mergeTraits merges traits into the current user's or group's traits,
// stores them, and returns them. If traits is undefined, it only returns
// the current traits. k must be either '#user' or '#group'.
Expand Down