From 6f71c2dbcadf09b961a9e38329f5a5aac59ecc2c Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Mon, 15 Jan 2024 14:44:44 +0000 Subject: [PATCH] Applying documentation updates. --- .../browser-tracker.crossdomainlinker.md | 2 +- ...acker.extendedcrossdomainlinkerattributes.md | 17 +++++++++++++++++ ...-tracker.extendedcrossdomainlinkeroptions.md | 11 +++++++++++ .../browser-tracker/markdown/browser-tracker.md | 4 +++- .../browser-tracker.trackerconfiguration.md | 1 + 5 files changed, 33 insertions(+), 2 deletions(-) create mode 100644 api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkerattributes.md create mode 100644 api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkeroptions.md diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.crossdomainlinker.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.crossdomainlinker.md index 63cfcbd3b..7a6ef74d4 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.crossdomainlinker.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.crossdomainlinker.md @@ -4,7 +4,7 @@ ## crossDomainLinker() function -Enable querystring decoration for links pasing a filter +Enable querystring decoration for links passing a filter Signature: diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkerattributes.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkerattributes.md new file mode 100644 index 000000000..6f228ab28 --- /dev/null +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkerattributes.md @@ -0,0 +1,17 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ExtendedCrossDomainLinkerAttributes](./browser-tracker.extendedcrossdomainlinkerattributes.md) + +## ExtendedCrossDomainLinkerAttributes type + +Signature: + +```typescript +type ExtendedCrossDomainLinkerAttributes = { + userId?: boolean; + sessionId?: boolean; + sourceId?: boolean; + sourcePlatform?: boolean; + reason?: boolean | ((evt: Event) => string); +}; +``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkeroptions.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkeroptions.md new file mode 100644 index 000000000..55c2a0732 --- /dev/null +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkeroptions.md @@ -0,0 +1,11 @@ + + +[Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md) + +## ExtendedCrossDomainLinkerOptions type + +Signature: + +```typescript +type ExtendedCrossDomainLinkerOptions = boolean | ExtendedCrossDomainLinkerAttributes; +``` diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.md index 8bfd03496..85850d638 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.md @@ -12,7 +12,7 @@ | [addPlugin(configuration, trackers)](./browser-tracker.addplugin.md) | Add a plugin into the plugin collection after trackers have already been initialised | | [clearGlobalContexts(trackers)](./browser-tracker.clearglobalcontexts.md) | Clear all global contexts that are sent with events | | [clearUserData(configuration, trackers)](./browser-tracker.clearuserdata.md) | Clears all cookies and local storage containing user and session identifiers | -| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links pasing a filter | +| [crossDomainLinker(crossDomainLinkerCriterion, trackers)](./browser-tracker.crossdomainlinker.md) | Enable querystring decoration for links passing a filter | | [disableActivityTracking(trackers)](./browser-tracker.disableactivitytracking.md) | Disables page activity tracking. | | [disableActivityTrackingCallback(trackers)](./browser-tracker.disableactivitytrackingcallback.md) | Disables page activity tracking callback. | | [disableAnonymousTracking(configuration, trackers)](./browser-tracker.disableanonymoustracking.md) | Disables anonymous tracking if active (ie. tracker initialized with anonymousTracking) For stateStorageStrategy override, uses supplied value first, falls back to one defined in initial config, otherwise uses cookieAndLocalStorage. | @@ -86,6 +86,8 @@ | [CookieSameSite](./browser-tracker.cookiesamesite.md) | | | [EventBatch](./browser-tracker.eventbatch.md) | A collection of events which are sent to the collector. This can either be a collection of query strings or JSON objects. | | [EventMethod](./browser-tracker.eventmethod.md) | | +| [ExtendedCrossDomainLinkerAttributes](./browser-tracker.extendedcrossdomainlinkerattributes.md) | | +| [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md) | | | [FilterProvider](./browser-tracker.filterprovider.md) | A filter provider is a tuple that has two parts: a context filter and the context primitive(s) If the context filter evaluates to true, the tracker will attach the context primitive(s) | | [GetBatch](./browser-tracker.getbatch.md) | A collection of GET events which are sent to the collector. This will be a collection of query strings. | | [Platform](./browser-tracker.platform.md) | | diff --git a/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md b/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md index 6447e0e03..657c856aa 100644 --- a/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md +++ b/api-docs/docs/browser-tracker/markdown/browser-tracker.trackerconfiguration.md @@ -26,6 +26,7 @@ type TrackerConfiguration = { useStm?: boolean; bufferSize?: number; crossDomainLinker?: (elt: HTMLAnchorElement | HTMLAreaElement) => boolean; + useExtendedCrossDomainLinker?: ExtendedCrossDomainLinkerOptions; maxPostBytes?: number; maxGetBytes?: number; discoverRootDomain?: boolean;