├── .browserslistrc ├── .bundlemonrc.json ├── .eslintignore ├── .eslintrc.js ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── workflows │ ├── build.yml │ ├── change_check.yml │ ├── docs.yml │ ├── publish.yml │ ├── publish_branch.yml │ ├── publish_prerelease.yml │ └── snyk.yml ├── .gitignore ├── .nvmrc ├── .prettierignore ├── .prettierrc ├── CONTRIBUTING.md ├── LICENSE ├── README.md ├── api-docs ├── .gitignore ├── babel.config.js ├── docs │ ├── browser-tracker │ │ ├── browser-tracker.api.md │ │ └── markdown │ │ │ ├── browser-tracker.activitycallback.md │ │ │ ├── browser-tracker.activitycallbackdata.md │ │ │ ├── browser-tracker.activitytrackingconfiguration.heartbeatdelay.md │ │ │ ├── browser-tracker.activitytrackingconfiguration.md │ │ │ ├── browser-tracker.activitytrackingconfiguration.minimumvisitlength.md │ │ │ ├── browser-tracker.activitytrackingconfigurationcallback.callback.md │ │ │ ├── browser-tracker.activitytrackingconfigurationcallback.md │ │ │ ├── browser-tracker.addglobalcontexts.md │ │ │ ├── browser-tracker.addplugin.md │ │ │ ├── browser-tracker.anonymoustrackingoptions.md │ │ │ ├── browser-tracker.browserplugin.activatebrowserplugin.md │ │ │ ├── browser-tracker.browserplugin.md │ │ │ ├── browser-tracker.browserpluginconfiguration.md │ │ │ ├── browser-tracker.browserpluginconfiguration.plugin.md │ │ │ ├── browser-tracker.browsertracker.addplugin.md │ │ │ ├── browser-tracker.browsertracker.clearuserdata.md │ │ │ ├── browser-tracker.browsertracker.core.md │ │ │ ├── browser-tracker.browsertracker.crossdomainlinker.md │ │ │ ├── browser-tracker.browsertracker.disableactivitytracking.md │ │ │ ├── browser-tracker.browsertracker.disableactivitytrackingcallback.md │ │ │ ├── browser-tracker.browsertracker.disableanonymoustracking.md │ │ │ ├── browser-tracker.browsertracker.discardbrace.md │ │ │ ├── browser-tracker.browsertracker.discardhashtag.md │ │ │ ├── browser-tracker.browsertracker.enableactivitytracking.md │ │ │ ├── browser-tracker.browsertracker.enableactivitytrackingcallback.md │ │ │ ├── browser-tracker.browsertracker.enableanonymoustracking.md │ │ │ ├── browser-tracker.browsertracker.flushbuffer.md │ │ │ ├── browser-tracker.browsertracker.getcookiename.md │ │ │ ├── browser-tracker.browsertracker.getdomainsessionindex.md │ │ │ ├── browser-tracker.browsertracker.getdomainuserid.md │ │ │ ├── browser-tracker.browsertracker.getdomainuserinfo.md │ │ │ ├── browser-tracker.browsertracker.getpageviewid.md │ │ │ ├── browser-tracker.browsertracker.gettabid.md │ │ │ ├── browser-tracker.browsertracker.getuserid.md │ │ │ ├── browser-tracker.browsertracker.id.md │ │ │ ├── browser-tracker.browsertracker.md │ │ │ ├── browser-tracker.browsertracker.namespace.md │ │ │ ├── browser-tracker.browsertracker.newsession.md │ │ │ ├── browser-tracker.browsertracker.preservepageviewid.md │ │ │ ├── browser-tracker.browsertracker.preservepageviewidforurl.md │ │ │ ├── browser-tracker.browsertracker.setbuffersize.md │ │ │ ├── browser-tracker.browsertracker.setcollectorurl.md │ │ │ ├── browser-tracker.browsertracker.setcookiepath.md │ │ │ ├── browser-tracker.browsertracker.setcustomurl.md │ │ │ ├── browser-tracker.browsertracker.setdocumenttitle.md │ │ │ ├── browser-tracker.browsertracker.setoptoutcookie.md │ │ │ ├── browser-tracker.browsertracker.setreferrerurl.md │ │ │ ├── browser-tracker.browsertracker.setuserid.md │ │ │ ├── browser-tracker.browsertracker.setuseridfromcookie.md │ │ │ ├── browser-tracker.browsertracker.setuseridfromlocation.md │ │ │ ├── browser-tracker.browsertracker.setuseridfromreferrer.md │ │ │ ├── browser-tracker.browsertracker.setvisitorcookietimeout.md │ │ │ ├── browser-tracker.browsertracker.sharedstate.md │ │ │ ├── browser-tracker.browsertracker.trackpageview.md │ │ │ ├── browser-tracker.browsertracker.updatepageactivity.md │ │ │ ├── browser-tracker.builtincontexts.md │ │ │ ├── browser-tracker.clearglobalcontexts.md │ │ │ ├── browser-tracker.clearuserdata.md │ │ │ ├── browser-tracker.clearuserdataconfiguration.md │ │ │ ├── browser-tracker.clearuserdataconfiguration.preservesession.md │ │ │ ├── browser-tracker.clearuserdataconfiguration.preserveuser.md │ │ │ ├── browser-tracker.clientsession.eventindex.md │ │ │ ├── browser-tracker.clientsession.firsteventid.md │ │ │ ├── browser-tracker.clientsession.firsteventtimestamp.md │ │ │ ├── browser-tracker.clientsession.md │ │ │ ├── browser-tracker.clientsession.previoussessionid.md │ │ │ ├── browser-tracker.clientsession.sessionid.md │ │ │ ├── browser-tracker.clientsession.sessionindex.md │ │ │ ├── browser-tracker.clientsession.storagemechanism.md │ │ │ ├── browser-tracker.clientsession.userid.md │ │ │ ├── browser-tracker.commoneventproperties.context.md │ │ │ ├── browser-tracker.commoneventproperties.md │ │ │ ├── browser-tracker.commoneventproperties.timestamp.md │ │ │ ├── browser-tracker.conditionalcontextprovider.md │ │ │ ├── browser-tracker.contextevent.event.md │ │ │ ├── browser-tracker.contextevent.eventschema.md │ │ │ ├── browser-tracker.contextevent.eventtype.md │ │ │ ├── browser-tracker.contextevent.md │ │ │ ├── browser-tracker.contextfilter.md │ │ │ ├── browser-tracker.contextgenerator.md │ │ │ ├── browser-tracker.contextprimitive.md │ │ │ ├── browser-tracker.cookiesamesite.md │ │ │ ├── browser-tracker.coreplugin.activatecoreplugin.md │ │ │ ├── browser-tracker.coreplugin.aftertrack.md │ │ │ ├── browser-tracker.coreplugin.beforetrack.md │ │ │ ├── browser-tracker.coreplugin.contexts.md │ │ │ ├── browser-tracker.coreplugin.deactivateplugin.md │ │ │ ├── browser-tracker.coreplugin.filter.md │ │ │ ├── browser-tracker.coreplugin.logger.md │ │ │ ├── browser-tracker.coreplugin.md │ │ │ ├── browser-tracker.corepluginconfiguration.md │ │ │ ├── browser-tracker.corepluginconfiguration.plugin.md │ │ │ ├── browser-tracker.crossdomainlinker.md │ │ │ ├── browser-tracker.devicetimestamp.md │ │ │ ├── browser-tracker.devicetimestamp.type.md │ │ │ ├── browser-tracker.devicetimestamp.value.md │ │ │ ├── browser-tracker.disableactivitytracking.md │ │ │ ├── browser-tracker.disableactivitytrackingcallback.md │ │ │ ├── browser-tracker.disableanonymoustracking.md │ │ │ ├── browser-tracker.disableanonymoustrackingconfiguration.md │ │ │ ├── browser-tracker.disableanonymoustrackingconfiguration.statestoragestrategy.md │ │ │ ├── browser-tracker.discardbrace.md │ │ │ ├── browser-tracker.discardhashtag.md │ │ │ ├── browser-tracker.emitterconfigurationbase.buffersize.md │ │ │ ├── browser-tracker.emitterconfigurationbase.connectiontimeout.md │ │ │ ├── browser-tracker.emitterconfigurationbase.cookieextensionservice.md │ │ │ ├── browser-tracker.emitterconfigurationbase.credentials.md │ │ │ ├── browser-tracker.emitterconfigurationbase.customfetch.md │ │ │ ├── browser-tracker.emitterconfigurationbase.customheaders.md │ │ │ ├── browser-tracker.emitterconfigurationbase.dontretrystatuscodes.md │ │ │ ├── browser-tracker.emitterconfigurationbase.eventmethod.md │ │ │ ├── browser-tracker.emitterconfigurationbase.eventstore.md │ │ │ ├── browser-tracker.emitterconfigurationbase.idservice.md │ │ │ ├── browser-tracker.emitterconfigurationbase.keepalive.md │ │ │ ├── browser-tracker.emitterconfigurationbase.maxgetbytes.md │ │ │ ├── browser-tracker.emitterconfigurationbase.maxpostbytes.md │ │ │ ├── browser-tracker.emitterconfigurationbase.md │ │ │ ├── browser-tracker.emitterconfigurationbase.onrequestfailure.md │ │ │ ├── browser-tracker.emitterconfigurationbase.onrequestsuccess.md │ │ │ ├── browser-tracker.emitterconfigurationbase.postpath.md │ │ │ ├── browser-tracker.emitterconfigurationbase.retryfailedrequests.md │ │ │ ├── browser-tracker.emitterconfigurationbase.retrystatuscodes.md │ │ │ ├── browser-tracker.emitterconfigurationbase.usestm.md │ │ │ ├── browser-tracker.enableactivitytracking.md │ │ │ ├── browser-tracker.enableactivitytrackingcallback.md │ │ │ ├── browser-tracker.enableanonymoustracking.md │ │ │ ├── browser-tracker.enableanonymoustrackingconfiguration.md │ │ │ ├── browser-tracker.enableanonymoustrackingconfiguration.options.md │ │ │ ├── browser-tracker.enableanonymoustrackingconfiguration.statestoragestrategy.md │ │ │ ├── browser-tracker.eventbatch.md │ │ │ ├── browser-tracker.eventjson.md │ │ │ ├── browser-tracker.eventmethod.md │ │ │ ├── browser-tracker.eventpayloadandcontext.context.md │ │ │ ├── browser-tracker.eventpayloadandcontext.event.md │ │ │ ├── browser-tracker.eventpayloadandcontext.md │ │ │ ├── browser-tracker.eventstore.add.md │ │ │ ├── browser-tracker.eventstore.count.md │ │ │ ├── browser-tracker.eventstore.getall.md │ │ │ ├── browser-tracker.eventstore.getallpayloads.md │ │ │ ├── browser-tracker.eventstore.iterator.md │ │ │ ├── browser-tracker.eventstore.md │ │ │ ├── browser-tracker.eventstore.removehead.md │ │ │ ├── browser-tracker.eventstoreconfiguration.maxsize.md │ │ │ ├── browser-tracker.eventstoreconfiguration.md │ │ │ ├── browser-tracker.eventstoreiterator.md │ │ │ ├── browser-tracker.eventstoreiterator.next.md │ │ │ ├── browser-tracker.eventstorepayload.md │ │ │ ├── browser-tracker.eventstorepayload.payload.md │ │ │ ├── browser-tracker.eventstorepayload.svranon.md │ │ │ ├── browser-tracker.extendedcrossdomainlinkerattributes.md │ │ │ ├── browser-tracker.extendedcrossdomainlinkeroptions.md │ │ │ ├── browser-tracker.filterprovider.md │ │ │ ├── browser-tracker.flushbuffer.md │ │ │ ├── browser-tracker.flushbufferconfiguration.md │ │ │ ├── browser-tracker.flushbufferconfiguration.newbuffersize.md │ │ │ ├── browser-tracker.jsonprocessor.md │ │ │ ├── browser-tracker.localstorageeventstoreconfigurationbase.maxlocalstoragequeuesize.md │ │ │ ├── browser-tracker.localstorageeventstoreconfigurationbase.md │ │ │ ├── browser-tracker.localstorageeventstoreconfigurationbase.uselocalstorage.md │ │ │ ├── browser-tracker.logger.debug.md │ │ │ ├── browser-tracker.logger.error.md │ │ │ ├── browser-tracker.logger.info.md │ │ │ ├── browser-tracker.logger.md │ │ │ ├── browser-tracker.logger.setloglevel.md │ │ │ ├── browser-tracker.logger.warn.md │ │ │ ├── browser-tracker.md │ │ │ ├── browser-tracker.newsession.md │ │ │ ├── browser-tracker.newtracker.md │ │ │ ├── browser-tracker.pageviewevent.contextcallback.md │ │ │ ├── browser-tracker.pageviewevent.md │ │ │ ├── browser-tracker.pageviewevent.title.md │ │ │ ├── browser-tracker.parsedidcookie.md │ │ │ ├── browser-tracker.payload.md │ │ │ ├── browser-tracker.payloadbuilder.add.md │ │ │ ├── browser-tracker.payloadbuilder.addcontextentity.md │ │ │ ├── browser-tracker.payloadbuilder.adddict.md │ │ │ ├── browser-tracker.payloadbuilder.addjson.md │ │ │ ├── browser-tracker.payloadbuilder.build.md │ │ │ ├── browser-tracker.payloadbuilder.getjson.md │ │ │ ├── browser-tracker.payloadbuilder.getpayload.md │ │ │ ├── browser-tracker.payloadbuilder.md │ │ │ ├── browser-tracker.payloadbuilder.withjsonprocessor.md │ │ │ ├── browser-tracker.platform.md │ │ │ ├── browser-tracker.preservepageviewid.md │ │ │ ├── browser-tracker.preservepageviewidforurl.md │ │ │ ├── browser-tracker.removeglobalcontexts.md │ │ │ ├── browser-tracker.requestfailure.md │ │ │ ├── browser-tracker.ruleset.accept.md │ │ │ ├── browser-tracker.ruleset.md │ │ │ ├── browser-tracker.ruleset.reject.md │ │ │ ├── browser-tracker.rulesetprovider.md │ │ │ ├── browser-tracker.selfdescribingevent.event.md │ │ │ ├── browser-tracker.selfdescribingevent.md │ │ │ ├── browser-tracker.selfdescribingjson.md │ │ │ ├── browser-tracker.setbuffersize.md │ │ │ ├── browser-tracker.setcollectorurl.md │ │ │ ├── browser-tracker.setcookiepath.md │ │ │ ├── browser-tracker.setcustomurl.md │ │ │ ├── browser-tracker.setdocumenttitle.md │ │ │ ├── browser-tracker.setoptoutcookie.md │ │ │ ├── browser-tracker.setreferrerurl.md │ │ │ ├── browser-tracker.setuserid.md │ │ │ ├── browser-tracker.setuseridfromcookie.md │ │ │ ├── browser-tracker.setuseridfromlocation.md │ │ │ ├── browser-tracker.setuseridfromreferrer.md │ │ │ ├── browser-tracker.setvisitorcookietimeout.md │ │ │ ├── browser-tracker.sharedstate.bufferflushers.md │ │ │ ├── browser-tracker.sharedstate.hasloaded.md │ │ │ ├── browser-tracker.sharedstate.md │ │ │ ├── browser-tracker.sharedstate.pageviewid.md │ │ │ ├── browser-tracker.sharedstate.pageviewurl.md │ │ │ ├── browser-tracker.sharedstate.registeredonloadhandlers.md │ │ │ ├── browser-tracker.statestoragestrategy.md │ │ │ ├── browser-tracker.structuredevent.action.md │ │ │ ├── browser-tracker.structuredevent.category.md │ │ │ ├── browser-tracker.structuredevent.label.md │ │ │ ├── browser-tracker.structuredevent.md │ │ │ ├── browser-tracker.structuredevent.property.md │ │ │ ├── browser-tracker.structuredevent.value.md │ │ │ ├── browser-tracker.timestamp.md │ │ │ ├── browser-tracker.trackerconfiguration.md │ │ │ ├── browser-tracker.trackercore.addglobalcontexts.md │ │ │ ├── browser-tracker.trackercore.addpayloaddict.md │ │ │ ├── browser-tracker.trackercore.addpayloadpair.md │ │ │ ├── browser-tracker.trackercore.addplugin.md │ │ │ ├── browser-tracker.trackercore.clearglobalcontexts.md │ │ │ ├── browser-tracker.trackercore.deactivate.md │ │ │ ├── browser-tracker.trackercore.getbase64encoding.md │ │ │ ├── browser-tracker.trackercore.md │ │ │ ├── browser-tracker.trackercore.removeglobalcontexts.md │ │ │ ├── browser-tracker.trackercore.resetpayloadpairs.md │ │ │ ├── browser-tracker.trackercore.setappid.md │ │ │ ├── browser-tracker.trackercore.setbase64encoding.md │ │ │ ├── browser-tracker.trackercore.setcolordepth.md │ │ │ ├── browser-tracker.trackercore.setipaddress.md │ │ │ ├── browser-tracker.trackercore.setlang.md │ │ │ ├── browser-tracker.trackercore.setplatform.md │ │ │ ├── browser-tracker.trackercore.setscreenresolution.md │ │ │ ├── browser-tracker.trackercore.settimezone.md │ │ │ ├── browser-tracker.trackercore.settrackernamespace.md │ │ │ ├── browser-tracker.trackercore.settrackerversion.md │ │ │ ├── browser-tracker.trackercore.setuseragent.md │ │ │ ├── browser-tracker.trackercore.setuserid.md │ │ │ ├── browser-tracker.trackercore.setviewport.md │ │ │ ├── browser-tracker.trackercore.track.md │ │ │ ├── browser-tracker.trackpageview.md │ │ │ ├── browser-tracker.trackselfdescribingevent.md │ │ │ ├── browser-tracker.trackstructevent.md │ │ │ ├── browser-tracker.truetimestamp.md │ │ │ ├── browser-tracker.truetimestamp.type.md │ │ │ ├── browser-tracker.truetimestamp.value.md │ │ │ ├── browser-tracker.updatepageactivity.md │ │ │ ├── browser-tracker.version.md │ │ │ └── index.md │ ├── index.md │ ├── node-tracker │ │ ├── markdown │ │ │ ├── index.md │ │ │ ├── react-native-tracker.applifecycleconfiguration.appbuild.md │ │ │ ├── react-native-tracker.applifecycleconfiguration.appversion.md │ │ │ ├── react-native-tracker.applifecycleconfiguration.installautotracking.md │ │ │ ├── react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md │ │ │ ├── react-native-tracker.applifecycleconfiguration.md │ │ │ ├── react-native-tracker.asyncstorage.getitem.md │ │ │ ├── react-native-tracker.asyncstorage.md │ │ │ ├── react-native-tracker.asyncstorage.setitem.md │ │ │ ├── react-native-tracker.conditionalcontextprovider.md │ │ │ ├── react-native-tracker.contextfilter.md │ │ │ ├── react-native-tracker.contextgenerator.md │ │ │ ├── react-native-tracker.contextprimitive.md │ │ │ ├── react-native-tracker.coreconfiguration.base64.md │ │ │ ├── react-native-tracker.coreconfiguration.callback.md │ │ │ ├── react-native-tracker.coreconfiguration.coreplugins.md │ │ │ ├── react-native-tracker.coreconfiguration.md │ │ │ ├── react-native-tracker.coreplugin.activatecoreplugin.md │ │ │ ├── react-native-tracker.coreplugin.aftertrack.md │ │ │ ├── react-native-tracker.coreplugin.beforetrack.md │ │ │ ├── react-native-tracker.coreplugin.contexts.md │ │ │ ├── react-native-tracker.coreplugin.deactivateplugin.md │ │ │ ├── react-native-tracker.coreplugin.filter.md │ │ │ ├── react-native-tracker.coreplugin.logger.md │ │ │ ├── react-native-tracker.coreplugin.md │ │ │ ├── react-native-tracker.corepluginconfiguration.md │ │ │ ├── react-native-tracker.corepluginconfiguration.plugin.md │ │ │ ├── react-native-tracker.deeplinkconfiguration.deeplinkcontext.md │ │ │ ├── react-native-tracker.deeplinkconfiguration.md │ │ │ ├── react-native-tracker.deeplinkreceivedprops.md │ │ │ ├── react-native-tracker.devicetimestamp.md │ │ │ ├── react-native-tracker.devicetimestamp.type.md │ │ │ ├── react-native-tracker.devicetimestamp.value.md │ │ │ ├── react-native-tracker.emitter.flush.md │ │ │ ├── react-native-tracker.emitter.input.md │ │ │ ├── react-native-tracker.emitter.md │ │ │ ├── react-native-tracker.emitter.setanonymoustracking.md │ │ │ ├── react-native-tracker.emitter.setbuffersize.md │ │ │ ├── react-native-tracker.emitter.setcollectorurl.md │ │ │ ├── react-native-tracker.emitterconfiguration.endpoint.md │ │ │ ├── react-native-tracker.emitterconfiguration.md │ │ │ ├── react-native-tracker.emitterconfiguration.port.md │ │ │ ├── react-native-tracker.emitterconfiguration.protocol.md │ │ │ ├── react-native-tracker.emitterconfiguration.serveranonymization.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.buffersize.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.connectiontimeout.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.cookieextensionservice.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.credentials.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.customfetch.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.customheaders.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.eventmethod.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.eventstore.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.idservice.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.keepalive.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.maxgetbytes.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.maxpostbytes.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.onrequestfailure.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.onrequestsuccess.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.postpath.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.retryfailedrequests.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.retrystatuscodes.md │ │ │ ├── react-native-tracker.emitterconfigurationbase.usestm.md │ │ │ ├── react-native-tracker.eventbatch.md │ │ │ ├── react-native-tracker.eventcontext.md │ │ │ ├── react-native-tracker.eventjson.md │ │ │ ├── react-native-tracker.eventjsonwithkeys.md │ │ │ ├── react-native-tracker.eventmethod.md │ │ │ ├── react-native-tracker.eventpayloadandcontext.context.md │ │ │ ├── react-native-tracker.eventpayloadandcontext.event.md │ │ │ ├── react-native-tracker.eventpayloadandcontext.md │ │ │ ├── react-native-tracker.eventstoreconfiguration.asyncstorage.md │ │ │ ├── react-native-tracker.eventstoreconfiguration.maxeventstoresize.md │ │ │ ├── react-native-tracker.eventstoreconfiguration.md │ │ │ ├── react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md │ │ │ ├── react-native-tracker.eventstoreiterator.md │ │ │ ├── react-native-tracker.eventstoreiterator.next.md │ │ │ ├── react-native-tracker.eventstorepayload.md │ │ │ ├── react-native-tracker.eventstorepayload.payload.md │ │ │ ├── react-native-tracker.eventstorepayload.svranon.md │ │ │ ├── react-native-tracker.filterprovider.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.elementclasses.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.elementid.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.formid.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.nodename.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.schema.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.type.md │ │ │ ├── react-native-tracker.formfocusorchangeevent.value.md │ │ │ ├── react-native-tracker.getalltrackers.md │ │ │ ├── react-native-tracker.gettracker.md │ │ │ ├── react-native-tracker.getwebviewcallback.md │ │ │ ├── react-native-tracker.jsonprocessor.md │ │ │ ├── react-native-tracker.listitemviewprops.md │ │ │ ├── react-native-tracker.log_level.md │ │ │ ├── react-native-tracker.logger.debug.md │ │ │ ├── react-native-tracker.logger.error.md │ │ │ ├── react-native-tracker.logger.info.md │ │ │ ├── react-native-tracker.logger.md │ │ │ ├── react-native-tracker.logger.setloglevel.md │ │ │ ├── react-native-tracker.logger.warn.md │ │ │ ├── react-native-tracker.md │ │ │ ├── react-native-tracker.messagenotificationattachmentprops.md │ │ │ ├── react-native-tracker.messagenotificationprops.md │ │ │ ├── react-native-tracker.newtracker.md │ │ │ ├── react-native-tracker.pageviewevent.md │ │ │ ├── react-native-tracker.pageviewevent.pagetitle.md │ │ │ ├── react-native-tracker.pageviewevent.pageurl.md │ │ │ ├── react-native-tracker.pageviewevent.referrer.md │ │ │ ├── react-native-tracker.payload.md │ │ │ ├── react-native-tracker.payloadbuilder.add.md │ │ │ ├── react-native-tracker.payloadbuilder.addcontextentity.md │ │ │ ├── react-native-tracker.payloadbuilder.adddict.md │ │ │ ├── react-native-tracker.payloadbuilder.addjson.md │ │ │ ├── react-native-tracker.payloadbuilder.build.md │ │ │ ├── react-native-tracker.payloadbuilder.getjson.md │ │ │ ├── react-native-tracker.payloadbuilder.getpayload.md │ │ │ ├── react-native-tracker.payloadbuilder.md │ │ │ ├── react-native-tracker.payloadbuilder.withjsonprocessor.md │ │ │ ├── react-native-tracker.platformcontextconfiguration.md │ │ │ ├── react-native-tracker.platformcontextconfiguration.platformcontext.md │ │ │ ├── react-native-tracker.platformcontextconfiguration.platformcontextproperties.md │ │ │ ├── react-native-tracker.platformcontextconfiguration.platformcontextretriever.md │ │ │ ├── react-native-tracker.platformcontextproperty.md │ │ │ ├── react-native-tracker.platformcontextretriever.getandroididfa.md │ │ │ ├── react-native-tracker.platformcontextretriever.getappavailablememory.md │ │ │ ├── react-native-tracker.platformcontextretriever.getappleidfa.md │ │ │ ├── react-native-tracker.platformcontextretriever.getappleidfv.md │ │ │ ├── react-native-tracker.platformcontextretriever.getappsetid.md │ │ │ ├── react-native-tracker.platformcontextretriever.getappsetidscope.md │ │ │ ├── react-native-tracker.platformcontextretriever.getavailablestorage.md │ │ │ ├── react-native-tracker.platformcontextretriever.getbatterylevel.md │ │ │ ├── react-native-tracker.platformcontextretriever.getbatterystate.md │ │ │ ├── react-native-tracker.platformcontextretriever.getcarrier.md │ │ │ ├── react-native-tracker.platformcontextretriever.getdevicemanufacturer.md │ │ │ ├── react-native-tracker.platformcontextretriever.getdevicemodel.md │ │ │ ├── react-native-tracker.platformcontextretriever.getlanguage.md │ │ │ ├── react-native-tracker.platformcontextretriever.getlowpowermode.md │ │ │ ├── react-native-tracker.platformcontextretriever.getnetworktechnology.md │ │ │ ├── react-native-tracker.platformcontextretriever.getnetworktype.md │ │ │ ├── react-native-tracker.platformcontextretriever.getostype.md │ │ │ ├── react-native-tracker.platformcontextretriever.getosversion.md │ │ │ ├── react-native-tracker.platformcontextretriever.getphysicalmemory.md │ │ │ ├── react-native-tracker.platformcontextretriever.getresolution.md │ │ │ ├── react-native-tracker.platformcontextretriever.getscale.md │ │ │ ├── react-native-tracker.platformcontextretriever.getsystemavailablememory.md │ │ │ ├── react-native-tracker.platformcontextretriever.gettotalstorage.md │ │ │ ├── react-native-tracker.platformcontextretriever.isportrait.md │ │ │ ├── react-native-tracker.platformcontextretriever.md │ │ │ ├── react-native-tracker.reactnativetracker.md │ │ │ ├── react-native-tracker.removealltrackers.md │ │ │ ├── react-native-tracker.removetracker.md │ │ │ ├── react-native-tracker.requestfailure.md │ │ │ ├── react-native-tracker.ruleset.accept.md │ │ │ ├── react-native-tracker.ruleset.md │ │ │ ├── react-native-tracker.ruleset.reject.md │ │ │ ├── react-native-tracker.rulesetprovider.md │ │ │ ├── react-native-tracker.screensize.md │ │ │ ├── react-native-tracker.screenviewprops.md │ │ │ ├── react-native-tracker.scrollchangedprops.md │ │ │ ├── react-native-tracker.selfdescribing.md │ │ │ ├── react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md │ │ │ ├── react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md │ │ │ ├── react-native-tracker.sessionconfiguration.md │ │ │ ├── react-native-tracker.sessionconfiguration.sessioncontext.md │ │ │ ├── react-native-tracker.sessionstate.eventindex.md │ │ │ ├── react-native-tracker.sessionstate.firsteventid.md │ │ │ ├── react-native-tracker.sessionstate.firsteventtimestamp.md │ │ │ ├── react-native-tracker.sessionstate.md │ │ │ ├── react-native-tracker.sessionstate.previoussessionid.md │ │ │ ├── react-native-tracker.sessionstate.sessionid.md │ │ │ ├── react-native-tracker.sessionstate.sessionindex.md │ │ │ ├── react-native-tracker.sessionstate.storagemechanism.md │ │ │ ├── react-native-tracker.sessionstate.userid.md │ │ │ ├── react-native-tracker.structuredprops.md │ │ │ ├── react-native-tracker.subjectconfiguration.colordepth.md │ │ │ ├── react-native-tracker.subjectconfiguration.domainuserid.md │ │ │ ├── react-native-tracker.subjectconfiguration.ipaddress.md │ │ │ ├── react-native-tracker.subjectconfiguration.language.md │ │ │ ├── react-native-tracker.subjectconfiguration.md │ │ │ ├── react-native-tracker.subjectconfiguration.networkuserid.md │ │ │ ├── react-native-tracker.subjectconfiguration.screenresolution.md │ │ │ ├── react-native-tracker.subjectconfiguration.screenviewport.md │ │ │ ├── react-native-tracker.subjectconfiguration.timezone.md │ │ │ ├── react-native-tracker.subjectconfiguration.useragent.md │ │ │ ├── react-native-tracker.subjectconfiguration.userid.md │ │ │ ├── react-native-tracker.timestamp.md │ │ │ ├── react-native-tracker.timingprops.md │ │ │ ├── react-native-tracker.trackerconfiguration.appid.md │ │ │ ├── react-native-tracker.trackerconfiguration.deviceplatform.md │ │ │ ├── react-native-tracker.trackerconfiguration.encodebase64.md │ │ │ ├── react-native-tracker.trackerconfiguration.md │ │ │ ├── react-native-tracker.trackerconfiguration.namespace.md │ │ │ ├── react-native-tracker.trackerconfiguration.plugins.md │ │ │ ├── react-native-tracker.trackercore.addglobalcontexts.md │ │ │ ├── react-native-tracker.trackercore.addpayloaddict.md │ │ │ ├── react-native-tracker.trackercore.addpayloadpair.md │ │ │ ├── react-native-tracker.trackercore.addplugin.md │ │ │ ├── react-native-tracker.trackercore.clearglobalcontexts.md │ │ │ ├── react-native-tracker.trackercore.deactivate.md │ │ │ ├── react-native-tracker.trackercore.getbase64encoding.md │ │ │ ├── react-native-tracker.trackercore.md │ │ │ ├── react-native-tracker.trackercore.removeglobalcontexts.md │ │ │ ├── react-native-tracker.trackercore.resetpayloadpairs.md │ │ │ ├── react-native-tracker.trackercore.setappid.md │ │ │ ├── react-native-tracker.trackercore.setbase64encoding.md │ │ │ ├── react-native-tracker.trackercore.setcolordepth.md │ │ │ ├── react-native-tracker.trackercore.setipaddress.md │ │ │ ├── react-native-tracker.trackercore.setlang.md │ │ │ ├── react-native-tracker.trackercore.setplatform.md │ │ │ ├── react-native-tracker.trackercore.setscreenresolution.md │ │ │ ├── react-native-tracker.trackercore.settimezone.md │ │ │ ├── react-native-tracker.trackercore.settrackernamespace.md │ │ │ ├── react-native-tracker.trackercore.settrackerversion.md │ │ │ ├── react-native-tracker.trackercore.setuseragent.md │ │ │ ├── react-native-tracker.trackercore.setuserid.md │ │ │ ├── react-native-tracker.trackercore.setviewport.md │ │ │ ├── react-native-tracker.trackercore.track.md │ │ │ ├── react-native-tracker.trigger.md │ │ │ ├── react-native-tracker.truetimestamp.md │ │ │ ├── react-native-tracker.truetimestamp.type.md │ │ │ ├── react-native-tracker.truetimestamp.value.md │ │ │ └── react-native-tracker.version.md │ │ └── node-tracker.api.md │ └── react-native-tracker │ │ ├── markdown │ │ ├── index.md │ │ ├── react-native-tracker.applifecycleconfiguration.appbuild.md │ │ ├── react-native-tracker.applifecycleconfiguration.appversion.md │ │ ├── react-native-tracker.applifecycleconfiguration.installautotracking.md │ │ ├── react-native-tracker.applifecycleconfiguration.lifecycleautotracking.md │ │ ├── react-native-tracker.applifecycleconfiguration.md │ │ ├── react-native-tracker.asyncstorage.getitem.md │ │ ├── react-native-tracker.asyncstorage.md │ │ ├── react-native-tracker.asyncstorage.setitem.md │ │ ├── react-native-tracker.conditionalcontextprovider.md │ │ ├── react-native-tracker.contextfilter.md │ │ ├── react-native-tracker.contextgenerator.md │ │ ├── react-native-tracker.contextprimitive.md │ │ ├── react-native-tracker.coreconfiguration.base64.md │ │ ├── react-native-tracker.coreconfiguration.callback.md │ │ ├── react-native-tracker.coreconfiguration.coreplugins.md │ │ ├── react-native-tracker.coreconfiguration.md │ │ ├── react-native-tracker.coreplugin.activatecoreplugin.md │ │ ├── react-native-tracker.coreplugin.aftertrack.md │ │ ├── react-native-tracker.coreplugin.beforetrack.md │ │ ├── react-native-tracker.coreplugin.contexts.md │ │ ├── react-native-tracker.coreplugin.deactivateplugin.md │ │ ├── react-native-tracker.coreplugin.filter.md │ │ ├── react-native-tracker.coreplugin.logger.md │ │ ├── react-native-tracker.coreplugin.md │ │ ├── react-native-tracker.corepluginconfiguration.md │ │ ├── react-native-tracker.corepluginconfiguration.plugin.md │ │ ├── react-native-tracker.deeplinkconfiguration.deeplinkcontext.md │ │ ├── react-native-tracker.deeplinkconfiguration.md │ │ ├── react-native-tracker.deeplinkreceivedprops.md │ │ ├── react-native-tracker.devicetimestamp.md │ │ ├── react-native-tracker.devicetimestamp.type.md │ │ ├── react-native-tracker.devicetimestamp.value.md │ │ ├── react-native-tracker.emitter.flush.md │ │ ├── react-native-tracker.emitter.input.md │ │ ├── react-native-tracker.emitter.md │ │ ├── react-native-tracker.emitter.setanonymoustracking.md │ │ ├── react-native-tracker.emitter.setbuffersize.md │ │ ├── react-native-tracker.emitter.setcollectorurl.md │ │ ├── react-native-tracker.emitterconfiguration.endpoint.md │ │ ├── react-native-tracker.emitterconfiguration.md │ │ ├── react-native-tracker.emitterconfiguration.port.md │ │ ├── react-native-tracker.emitterconfiguration.protocol.md │ │ ├── react-native-tracker.emitterconfiguration.serveranonymization.md │ │ ├── react-native-tracker.emitterconfigurationbase.buffersize.md │ │ ├── react-native-tracker.emitterconfigurationbase.connectiontimeout.md │ │ ├── react-native-tracker.emitterconfigurationbase.credentials.md │ │ ├── react-native-tracker.emitterconfigurationbase.customfetch.md │ │ ├── react-native-tracker.emitterconfigurationbase.customheaders.md │ │ ├── react-native-tracker.emitterconfigurationbase.dontretrystatuscodes.md │ │ ├── react-native-tracker.emitterconfigurationbase.eventmethod.md │ │ ├── react-native-tracker.emitterconfigurationbase.eventstore.md │ │ ├── react-native-tracker.emitterconfigurationbase.idservice.md │ │ ├── react-native-tracker.emitterconfigurationbase.keepalive.md │ │ ├── react-native-tracker.emitterconfigurationbase.maxgetbytes.md │ │ ├── react-native-tracker.emitterconfigurationbase.maxpostbytes.md │ │ ├── react-native-tracker.emitterconfigurationbase.md │ │ ├── react-native-tracker.emitterconfigurationbase.onrequestfailure.md │ │ ├── react-native-tracker.emitterconfigurationbase.onrequestsuccess.md │ │ ├── react-native-tracker.emitterconfigurationbase.postpath.md │ │ ├── react-native-tracker.emitterconfigurationbase.retryfailedrequests.md │ │ ├── react-native-tracker.emitterconfigurationbase.retrystatuscodes.md │ │ ├── react-native-tracker.emitterconfigurationbase.usestm.md │ │ ├── react-native-tracker.eventbatch.md │ │ ├── react-native-tracker.eventcontext.md │ │ ├── react-native-tracker.eventjson.md │ │ ├── react-native-tracker.eventjsonwithkeys.md │ │ ├── react-native-tracker.eventmethod.md │ │ ├── react-native-tracker.eventpayloadandcontext.context.md │ │ ├── react-native-tracker.eventpayloadandcontext.event.md │ │ ├── react-native-tracker.eventpayloadandcontext.md │ │ ├── react-native-tracker.eventstoreconfiguration.asyncstorage.md │ │ ├── react-native-tracker.eventstoreconfiguration.maxeventstoresize.md │ │ ├── react-native-tracker.eventstoreconfiguration.md │ │ ├── react-native-tracker.eventstoreconfiguration.useasyncstorageforeventstore.md │ │ ├── react-native-tracker.eventstoreiterator.md │ │ ├── react-native-tracker.eventstoreiterator.next.md │ │ ├── react-native-tracker.eventstorepayload.md │ │ ├── react-native-tracker.eventstorepayload.payload.md │ │ ├── react-native-tracker.eventstorepayload.svranon.md │ │ ├── react-native-tracker.filterprovider.md │ │ ├── react-native-tracker.formfocusorchangeevent.elementclasses.md │ │ ├── react-native-tracker.formfocusorchangeevent.elementid.md │ │ ├── react-native-tracker.formfocusorchangeevent.formid.md │ │ ├── react-native-tracker.formfocusorchangeevent.md │ │ ├── react-native-tracker.formfocusorchangeevent.nodename.md │ │ ├── react-native-tracker.formfocusorchangeevent.schema.md │ │ ├── react-native-tracker.formfocusorchangeevent.type.md │ │ ├── react-native-tracker.formfocusorchangeevent.value.md │ │ ├── react-native-tracker.getalltrackers.md │ │ ├── react-native-tracker.gettracker.md │ │ ├── react-native-tracker.getwebviewcallback.md │ │ ├── react-native-tracker.jsonprocessor.md │ │ ├── react-native-tracker.listitemviewprops.md │ │ ├── react-native-tracker.log_level.md │ │ ├── react-native-tracker.logger.debug.md │ │ ├── react-native-tracker.logger.error.md │ │ ├── react-native-tracker.logger.info.md │ │ ├── react-native-tracker.logger.md │ │ ├── react-native-tracker.logger.setloglevel.md │ │ ├── react-native-tracker.logger.warn.md │ │ ├── react-native-tracker.md │ │ ├── react-native-tracker.messagenotificationattachmentprops.md │ │ ├── react-native-tracker.messagenotificationprops.md │ │ ├── react-native-tracker.newtracker.md │ │ ├── react-native-tracker.pageviewevent.md │ │ ├── react-native-tracker.pageviewevent.pagetitle.md │ │ ├── react-native-tracker.pageviewevent.pageurl.md │ │ ├── react-native-tracker.pageviewevent.referrer.md │ │ ├── react-native-tracker.payload.md │ │ ├── react-native-tracker.payloadbuilder.add.md │ │ ├── react-native-tracker.payloadbuilder.addcontextentity.md │ │ ├── react-native-tracker.payloadbuilder.adddict.md │ │ ├── react-native-tracker.payloadbuilder.addjson.md │ │ ├── react-native-tracker.payloadbuilder.build.md │ │ ├── react-native-tracker.payloadbuilder.getjson.md │ │ ├── react-native-tracker.payloadbuilder.getpayload.md │ │ ├── react-native-tracker.payloadbuilder.md │ │ ├── react-native-tracker.payloadbuilder.withjsonprocessor.md │ │ ├── react-native-tracker.platformcontextconfiguration.md │ │ ├── react-native-tracker.platformcontextconfiguration.platformcontext.md │ │ ├── react-native-tracker.platformcontextconfiguration.platformcontextproperties.md │ │ ├── react-native-tracker.platformcontextconfiguration.platformcontextretriever.md │ │ ├── react-native-tracker.platformcontextproperty.md │ │ ├── react-native-tracker.platformcontextretriever.getandroididfa.md │ │ ├── react-native-tracker.platformcontextretriever.getappavailablememory.md │ │ ├── react-native-tracker.platformcontextretriever.getappleidfa.md │ │ ├── react-native-tracker.platformcontextretriever.getappleidfv.md │ │ ├── react-native-tracker.platformcontextretriever.getappsetid.md │ │ ├── react-native-tracker.platformcontextretriever.getappsetidscope.md │ │ ├── react-native-tracker.platformcontextretriever.getavailablestorage.md │ │ ├── react-native-tracker.platformcontextretriever.getbatterylevel.md │ │ ├── react-native-tracker.platformcontextretriever.getbatterystate.md │ │ ├── react-native-tracker.platformcontextretriever.getcarrier.md │ │ ├── react-native-tracker.platformcontextretriever.getdevicemanufacturer.md │ │ ├── react-native-tracker.platformcontextretriever.getdevicemodel.md │ │ ├── react-native-tracker.platformcontextretriever.getlanguage.md │ │ ├── react-native-tracker.platformcontextretriever.getlowpowermode.md │ │ ├── react-native-tracker.platformcontextretriever.getnetworktechnology.md │ │ ├── react-native-tracker.platformcontextretriever.getnetworktype.md │ │ ├── react-native-tracker.platformcontextretriever.getostype.md │ │ ├── react-native-tracker.platformcontextretriever.getosversion.md │ │ ├── react-native-tracker.platformcontextretriever.getphysicalmemory.md │ │ ├── react-native-tracker.platformcontextretriever.getresolution.md │ │ ├── react-native-tracker.platformcontextretriever.getscale.md │ │ ├── react-native-tracker.platformcontextretriever.getsystemavailablememory.md │ │ ├── react-native-tracker.platformcontextretriever.gettotalstorage.md │ │ ├── react-native-tracker.platformcontextretriever.isportrait.md │ │ ├── react-native-tracker.platformcontextretriever.md │ │ ├── react-native-tracker.reactnativetracker.md │ │ ├── react-native-tracker.removealltrackers.md │ │ ├── react-native-tracker.removetracker.md │ │ ├── react-native-tracker.requestfailure.md │ │ ├── react-native-tracker.ruleset.accept.md │ │ ├── react-native-tracker.ruleset.md │ │ ├── react-native-tracker.ruleset.reject.md │ │ ├── react-native-tracker.rulesetprovider.md │ │ ├── react-native-tracker.screensize.md │ │ ├── react-native-tracker.screenviewprops.md │ │ ├── react-native-tracker.scrollchangedprops.md │ │ ├── react-native-tracker.selfdescribing.md │ │ ├── react-native-tracker.sessionconfiguration.backgroundsessiontimeout.md │ │ ├── react-native-tracker.sessionconfiguration.foregroundsessiontimeout.md │ │ ├── react-native-tracker.sessionconfiguration.md │ │ ├── react-native-tracker.sessionconfiguration.sessioncontext.md │ │ ├── react-native-tracker.sessionstate.eventindex.md │ │ ├── react-native-tracker.sessionstate.firsteventid.md │ │ ├── react-native-tracker.sessionstate.firsteventtimestamp.md │ │ ├── react-native-tracker.sessionstate.md │ │ ├── react-native-tracker.sessionstate.previoussessionid.md │ │ ├── react-native-tracker.sessionstate.sessionid.md │ │ ├── react-native-tracker.sessionstate.sessionindex.md │ │ ├── react-native-tracker.sessionstate.storagemechanism.md │ │ ├── react-native-tracker.sessionstate.userid.md │ │ ├── react-native-tracker.structuredprops.md │ │ ├── react-native-tracker.subjectconfiguration.colordepth.md │ │ ├── react-native-tracker.subjectconfiguration.domainuserid.md │ │ ├── react-native-tracker.subjectconfiguration.ipaddress.md │ │ ├── react-native-tracker.subjectconfiguration.language.md │ │ ├── react-native-tracker.subjectconfiguration.md │ │ ├── react-native-tracker.subjectconfiguration.networkuserid.md │ │ ├── react-native-tracker.subjectconfiguration.screenresolution.md │ │ ├── react-native-tracker.subjectconfiguration.screenviewport.md │ │ ├── react-native-tracker.subjectconfiguration.timezone.md │ │ ├── react-native-tracker.subjectconfiguration.useragent.md │ │ ├── react-native-tracker.subjectconfiguration.userid.md │ │ ├── react-native-tracker.timestamp.md │ │ ├── react-native-tracker.timingprops.md │ │ ├── react-native-tracker.trackerconfiguration.appid.md │ │ ├── react-native-tracker.trackerconfiguration.deviceplatform.md │ │ ├── react-native-tracker.trackerconfiguration.encodebase64.md │ │ ├── react-native-tracker.trackerconfiguration.md │ │ ├── react-native-tracker.trackerconfiguration.namespace.md │ │ ├── react-native-tracker.trackerconfiguration.plugins.md │ │ ├── react-native-tracker.trackercore.addglobalcontexts.md │ │ ├── react-native-tracker.trackercore.addpayloaddict.md │ │ ├── react-native-tracker.trackercore.addpayloadpair.md │ │ ├── react-native-tracker.trackercore.addplugin.md │ │ ├── react-native-tracker.trackercore.clearglobalcontexts.md │ │ ├── react-native-tracker.trackercore.deactivate.md │ │ ├── react-native-tracker.trackercore.getbase64encoding.md │ │ ├── react-native-tracker.trackercore.md │ │ ├── react-native-tracker.trackercore.removeglobalcontexts.md │ │ ├── react-native-tracker.trackercore.resetpayloadpairs.md │ │ ├── react-native-tracker.trackercore.setappid.md │ │ ├── react-native-tracker.trackercore.setbase64encoding.md │ │ ├── react-native-tracker.trackercore.setcolordepth.md │ │ ├── react-native-tracker.trackercore.setipaddress.md │ │ ├── react-native-tracker.trackercore.setlang.md │ │ ├── react-native-tracker.trackercore.setplatform.md │ │ ├── react-native-tracker.trackercore.setscreenresolution.md │ │ ├── react-native-tracker.trackercore.settimezone.md │ │ ├── react-native-tracker.trackercore.settrackernamespace.md │ │ ├── react-native-tracker.trackercore.settrackerversion.md │ │ ├── react-native-tracker.trackercore.setuseragent.md │ │ ├── react-native-tracker.trackercore.setuserid.md │ │ ├── react-native-tracker.trackercore.setviewport.md │ │ ├── react-native-tracker.trackercore.track.md │ │ ├── react-native-tracker.trigger.md │ │ ├── react-native-tracker.truetimestamp.md │ │ ├── react-native-tracker.truetimestamp.type.md │ │ ├── react-native-tracker.truetimestamp.value.md │ │ └── react-native-tracker.version.md │ │ └── react-native-tracker.api.md ├── docusaurus.config.js ├── package-lock.json ├── package.json ├── sidebars.js ├── src │ ├── css │ │ └── custom.css │ └── pages │ │ ├── index.md │ │ └── index.module.css └── static │ ├── .nojekyll │ └── img │ └── favicon.ico ├── banner.js ├── common ├── autoinstallers │ └── rush-prettier │ │ ├── .npmrc │ │ ├── package.json │ │ └── pnpm-lock.yaml ├── changes │ └── @snowplow │ │ ├── browser-plugin-browser-features │ │ └── feature-revise-default-plugins_2023-02-06-13-02.json │ │ ├── browser-plugin-consent │ │ ├── feature-1138-upgrade-uuid_2023-01-10-10-11.json │ │ └── feature-revise-default-plugins_2023-02-06-08-43.json │ │ ├── browser-plugin-ecommerce │ │ ├── feature-1138-upgrade-uuid_2023-01-10-10-11.json │ │ └── feature-revise-default-plugins_2023-02-06-08-43.json │ │ └── browser-plugin-optimizely │ │ └── feature-revise-default-plugins_2023-02-06-13-02.json ├── config │ └── rush │ │ ├── .npmrc │ │ ├── .npmrc-publish │ │ ├── .pnpmfile.cjs │ │ ├── browser-approved-packages.json │ │ ├── command-line.json │ │ ├── common-versions.json │ │ ├── experiments.json │ │ ├── nonbrowser-approved-packages.json │ │ ├── pnpm-lock.yaml │ │ ├── repo-state.json │ │ └── version-policies.json ├── git-hooks │ └── pre-commit ├── media │ └── snowplow_logo.png └── scripts │ ├── install-run-rush-pnpm.js │ ├── install-run-rush.js │ ├── install-run-rushx.js │ └── install-run.js ├── libraries ├── browser-tracker-core │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── detectors.ts │ │ ├── helpers │ │ │ ├── browser_props.ts │ │ │ ├── cross_domain.ts │ │ │ ├── index.ts │ │ │ └── storage.ts │ │ ├── index.ts │ │ ├── plugins.ts │ │ ├── proxies.ts │ │ ├── snowplow.ts │ │ ├── state.ts │ │ └── tracker │ │ │ ├── cookie_storage.ts │ │ │ ├── id_cookie.ts │ │ │ ├── index.ts │ │ │ ├── local_storage_event_store.ts │ │ │ ├── out_queue.ts │ │ │ ├── schemata.ts │ │ │ └── types.ts │ ├── test │ │ ├── browser_props.test.ts │ │ ├── detectors.test.ts │ │ ├── dom_helpers.test.ts │ │ ├── helpers.test.ts │ │ ├── helpers │ │ │ └── index.ts │ │ ├── id_cookie.test.ts │ │ ├── out_queue.test.ts │ │ ├── proxies.test.ts │ │ ├── storage.test.ts │ │ └── tracker │ │ │ ├── __snapshots__ │ │ │ ├── browser_context.test.ts.snap │ │ │ └── session_data.test.ts.snap │ │ │ ├── application_context.test.ts │ │ │ ├── browser_context.test.ts │ │ │ ├── cookie_storage.test.ts │ │ │ ├── cross_domain.test.ts │ │ │ ├── page_view.test.ts │ │ │ ├── page_view_id.test.ts │ │ │ └── session_data.test.ts │ └── tsconfig.json └── tracker-core │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── rollup.config.js │ ├── src │ ├── base64.ts │ ├── contexts.ts │ ├── core.ts │ ├── emitter │ │ ├── emitter_event.ts │ │ ├── emitter_request.ts │ │ └── index.ts │ ├── event_store.ts │ ├── event_store_payload.ts │ ├── index.ts │ ├── logger.ts │ ├── payload.ts │ ├── plugins.ts │ └── schemata.ts │ ├── test │ ├── base64.ts │ ├── contexts.ts │ ├── core.ts │ ├── emitter │ │ ├── emitter_event.test.ts │ │ ├── emitter_request.test.ts │ │ └── index.test.ts │ ├── event_store.test.ts │ └── payload.ts │ └── tsconfig.json ├── plugins ├── browser-plugin-ad-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ ├── test │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-button-click-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ ├── core.ts │ │ ├── index.ts │ │ ├── types.ts │ │ └── util.ts │ ├── test │ │ └── test.test.ts │ └── tsconfig.json ├── browser-plugin-client-hints │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── contexts.ts │ │ └── index.ts │ ├── test │ │ └── client-hints.test.ts │ └── tsconfig.json ├── browser-plugin-debugger │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ └── tsconfig.json ├── browser-plugin-element-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ ├── components.ts │ │ ├── configuration.ts │ │ ├── data.ts │ │ ├── elementsState.ts │ │ ├── index.ts │ │ ├── schemata.ts │ │ ├── types.ts │ │ └── util.ts │ ├── test │ │ ├── api.test.ts │ │ ├── components.test.ts │ │ ├── configuration.test.ts │ │ ├── data.test.ts │ │ └── util.test.ts │ └── tsconfig.json ├── browser-plugin-enhanced-consent │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ ├── core.ts │ │ ├── index.ts │ │ ├── schemata.ts │ │ └── types.ts │ ├── test │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-enhanced-ecommerce │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ ├── test │ │ └── contexts.test.ts │ └── tsconfig.json ├── browser-plugin-error-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── contexts.ts │ │ ├── index.ts │ │ └── util.ts │ ├── test │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-event-specifications │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── index.ts │ │ ├── integrations │ │ │ ├── index.ts │ │ │ └── snowplow-media-plugin.ts │ │ ├── schemata.ts │ │ └── utils.ts │ ├── test │ │ └── event-specs.test.ts │ └── tsconfig.json ├── browser-plugin-focalmeter │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ ├── test │ │ └── request.test.ts │ └── tsconfig.json ├── browser-plugin-form-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── helpers.ts │ │ └── index.ts │ ├── test │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-ga-cookies │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── index.ts │ │ ├── schemata.ts │ │ └── types.ts │ ├── test │ │ ├── __snapshots__ │ │ │ └── ga-cookies.test.ts.snap │ │ └── ga-cookies.test.ts │ └── tsconfig.json ├── browser-plugin-geolocation │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── contexts.ts │ │ └── index.ts │ └── tsconfig.json ├── browser-plugin-link-click-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ ├── test │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-media-tracking │ ├── .gitignore │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ ├── config.ts │ │ ├── constants.ts │ │ ├── entities.ts │ │ ├── findElem.ts │ │ ├── helperFunctions.ts │ │ ├── index.ts │ │ ├── player.ts │ │ └── types.ts │ ├── tests │ │ ├── media.test.ts │ │ └── test.test.ts │ └── tsconfig.json ├── browser-plugin-media │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── adTracking.ts │ │ ├── api.ts │ │ ├── core.ts │ │ ├── index.ts │ │ ├── mediaTracking.ts │ │ ├── pingInterval.ts │ │ ├── repeatedEventFilter.ts │ │ ├── schemata.ts │ │ ├── sessionStats.ts │ │ ├── sessionTracking.ts │ │ └── types.ts │ ├── test │ │ ├── api.test.ts │ │ ├── pingInterval.test.ts │ │ └── sessionStats.test.ts │ └── tsconfig.json ├── browser-plugin-optimizely-x │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── contexts.ts │ │ └── index.ts │ └── tsconfig.json ├── browser-plugin-performance-navigation-timing │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── docs │ │ └── performance_navigation_timeline.svg │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── contexts.ts │ │ ├── index.ts │ │ └── schemata.ts │ ├── test │ │ ├── __snapshots__ │ │ │ └── performance-navigation-timing.test.ts.snap │ │ └── performance-navigation-timing.test.ts │ └── tsconfig.json ├── browser-plugin-performance-timing │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── contexts.ts │ │ └── index.ts │ ├── test │ │ └── performance-timing.test.ts │ └── tsconfig.json ├── browser-plugin-privacy-sandbox │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── index.ts │ │ ├── schemata.ts │ │ └── types.ts │ ├── test │ │ ├── __snapshots__ │ │ │ └── privacy-sandbox.test.ts.snap │ │ └── privacy-sandbox.test.ts │ └── tsconfig.json ├── browser-plugin-screen-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ ├── core.ts │ │ ├── index.ts │ │ ├── schemata.ts │ │ ├── types.ts │ │ └── utils.ts │ ├── test │ │ ├── screen.test.ts │ │ └── screen_summary.test.ts │ └── tsconfig.json ├── browser-plugin-site-tracking │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ ├── test │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-snowplow-ecommerce │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ ├── core.ts │ │ ├── ga4 │ │ │ ├── api.ts │ │ │ ├── types.ts │ │ │ └── utils.ts │ │ ├── index.ts │ │ ├── schemata.ts │ │ ├── types.ts │ │ └── ua │ │ │ ├── api.ts │ │ │ ├── types.ts │ │ │ └── utils.ts │ ├── test │ │ ├── contexts.test.ts │ │ └── events.test.ts │ └── tsconfig.json ├── browser-plugin-timezone │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ └── index.ts │ ├── test │ │ └── timezone.test.ts │ └── tsconfig.json ├── browser-plugin-vimeo-tracking │ ├── .gitignore │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── events.ts │ │ ├── index.ts │ │ ├── initialization.ts │ │ ├── mediaPluginBinding.ts │ │ ├── schema.ts │ │ ├── types.ts │ │ └── utils.ts │ ├── test │ │ └── vimeo.test.ts │ └── tsconfig.json ├── browser-plugin-web-vitals │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── index.ts │ │ ├── schemata.ts │ │ ├── types.ts │ │ └── utils.ts │ ├── test │ │ ├── __snapshots__ │ │ │ └── web-vitals.test.ts.snap │ │ └── web-vitals.test.ts │ └── tsconfig.json ├── browser-plugin-webview │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── index.ts │ │ └── utils.ts │ ├── test │ │ └── webview.test.ts │ └── tsconfig.json └── browser-plugin-youtube-tracking │ ├── .gitignore │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ ├── entities.ts │ ├── helperFunctions.ts │ ├── index.ts │ ├── initialization.ts │ ├── options.ts │ └── types.ts │ ├── test │ └── youtube.test.ts │ └── tsconfig.json ├── rush.json ├── setupTestGlobals.ts ├── trackers ├── browser-tracker │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── api-extractor.json │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── api.ts │ │ └── index.ts │ ├── test │ │ ├── detectors.test.ts │ │ ├── snowtype.test.ts │ │ ├── tab_id_storage.test.ts │ │ └── tracker.test.ts │ └── tsconfig.json ├── javascript-tracker │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── build-config │ │ └── index.js │ ├── jest.config.js │ ├── package.json │ ├── rollup.config.js │ ├── rollup.config.test.js │ ├── src │ │ ├── configuration.ts │ │ ├── features.ts │ │ ├── in_queue.ts │ │ └── index.ts │ ├── tags │ │ ├── tag.js │ │ └── tag.min.js │ ├── test │ │ ├── E2E_SETUP.md │ │ ├── functional │ │ │ ├── activityCallback.test.ts │ │ │ └── cookies.test.ts │ │ ├── integration │ │ │ ├── autoTracking.test.ts │ │ │ ├── buttonClick.test.ts │ │ │ ├── cookieless.test.ts │ │ │ ├── cookies.test.ts │ │ │ ├── helpers.ts │ │ │ ├── integration.test.ts │ │ │ ├── onSessionUpdate.test.ts │ │ │ └── sessionStorage.test.ts │ │ ├── media │ │ │ ├── media.test.ts │ │ │ ├── vimeo.test.ts │ │ │ └── youtube.test.ts │ │ ├── micro-config │ │ │ ├── iglu.json │ │ │ └── micro.conf │ │ ├── micro.ts │ │ ├── pages │ │ │ ├── activity-callback.html │ │ │ ├── button-click-tracking.html │ │ │ ├── cookieless.html │ │ │ ├── cookies.html │ │ │ ├── form-tracking.html │ │ │ ├── index.html │ │ │ ├── integration.html │ │ │ ├── link-tracking.html │ │ │ ├── media │ │ │ │ ├── test-track.vtt │ │ │ │ ├── test-video.mp4 │ │ │ │ ├── tracking-2-players.html │ │ │ │ ├── tracking-2-trackers.html │ │ │ │ └── tracking.html │ │ │ ├── multi_page_cookies │ │ │ │ ├── iframe.html │ │ │ │ └── index.html │ │ │ ├── session-integration.html │ │ │ ├── session-update-callback.html │ │ │ ├── track_performance.html │ │ │ ├── vimeo │ │ │ │ ├── iframe.html │ │ │ │ └── player.html │ │ │ └── youtube │ │ │ │ ├── tracking-2-trackers.html │ │ │ │ ├── tracking-2-videos.html │ │ │ │ ├── tracking-player.html │ │ │ │ └── tracking.html │ │ ├── performance │ │ │ └── track_performance.test.ts │ │ ├── tsconfig.json │ │ ├── unit │ │ │ ├── in_queue.test.ts │ │ │ └── plugin_features.test.ts │ │ ├── wdio.default.conf.ts │ │ ├── wdio.local.conf.ts │ │ └── wdio.sauce.conf.ts │ ├── tracker.config.ts │ ├── tracker.lite.config.ts │ ├── tracker.test.config.ts │ └── tsconfig.json ├── node-tracker │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── api-extractor.json │ ├── package.json │ ├── rollup.config.js │ ├── src │ │ ├── index.ts │ │ └── tracker.ts │ ├── test │ │ ├── snowtype.ts │ │ └── tracker.ts │ └── tsconfig.json └── react-native-tracker │ ├── CHANGELOG.json │ ├── CHANGELOG.md │ ├── LICENSE │ ├── README.md │ ├── api-extractor.json │ ├── babel.config.js │ ├── jest.config.js │ ├── package.json │ ├── src │ ├── __mocks__ │ │ └── @react-native-async-storage │ │ │ └── async-storage.js │ ├── constants.ts │ ├── event_store.ts │ ├── events.ts │ ├── index.ts │ ├── plugins.ts │ ├── plugins │ │ ├── app_context │ │ │ └── index.ts │ │ ├── app_install │ │ │ └── index.ts │ │ ├── app_lifecycle │ │ │ └── index.ts │ │ ├── deep_links │ │ │ └── index.ts │ │ ├── platform_context │ │ │ └── index.ts │ │ └── session │ │ │ └── index.ts │ ├── subject.ts │ ├── tracker.ts │ ├── types.ts │ ├── utils.ts │ └── web_view_interface.ts │ ├── test │ ├── ecommerce.test.ts │ ├── event_store.test.ts │ ├── events.test.ts │ ├── plugins │ │ ├── app_context.test.ts │ │ ├── app_install.test.ts │ │ ├── app_lifecycle.test.ts │ │ ├── deep_links.test.ts │ │ ├── platform_context_android.test.ts │ │ ├── platform_context_ios.test.ts │ │ └── session.test.ts │ ├── subject.test.ts │ ├── tracker.test.ts │ └── web_view_interface.test.ts │ ├── tsconfig.build.json │ └── tsconfig.json └── tsconfig.json /.browserslistrc: -------------------------------------------------------------------------------- 1 | chrome >= 72, 2 | ie >= 11, 3 | edge >= 79, 4 | firefox >= 78, 5 | safari >= 9.1, 6 | -------------------------------------------------------------------------------- /.eslintignore: -------------------------------------------------------------------------------- 1 | # don't ever lint node_modules 2 | node_modules 3 | # don't lint build output (make sure it's set to your correct build folder name) 4 | dist 5 | # don't lint nyc coverage output 6 | coverage 7 | -------------------------------------------------------------------------------- /.eslintrc.js: -------------------------------------------------------------------------------- 1 | /* eslint-disable no-undef */ 2 | module.exports = { 3 | parser: '@typescript-eslint/parser', 4 | plugins: ['@typescript-eslint'], 5 | extends: ['eslint:recommended', 'plugin:@typescript-eslint/recommended'], 6 | }; 7 | -------------------------------------------------------------------------------- /.nvmrc: -------------------------------------------------------------------------------- 1 | 18 2 | -------------------------------------------------------------------------------- /.prettierrc: -------------------------------------------------------------------------------- 1 | { 2 | "trailingComma": "es5", 3 | "tabWidth": 2, 4 | "singleQuote": true, 5 | "printWidth": 120, 6 | "endOfLine": "auto" 7 | } 8 | -------------------------------------------------------------------------------- /api-docs/.gitignore: -------------------------------------------------------------------------------- 1 | # Dependencies 2 | /node_modules 3 | 4 | # Production 5 | /build 6 | 7 | # Generated files 8 | .docusaurus 9 | .cache-loader 10 | 11 | # Misc 12 | .DS_Store 13 | .env.local 14 | .env.development.local 15 | .env.test.local 16 | .env.production.local 17 | 18 | npm-debug.log* 19 | yarn-debug.log* 20 | yarn-error.log* 21 | -------------------------------------------------------------------------------- /api-docs/babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [require.resolve('@docusaurus/core/lib/babel/preset')], 3 | }; 4 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.activitycallback.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ActivityCallback](./browser-tracker.activitycallback.md) 4 | 5 | ## ActivityCallback type 6 | 7 | The callback for enableActivityTrackingCallback 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type ActivityCallback = (data: ActivityCallbackData) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.anonymoustrackingoptions.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [AnonymousTrackingOptions](./browser-tracker.anonymoustrackingoptions.md) 4 | 5 | ## AnonymousTrackingOptions type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type AnonymousTrackingOptions = boolean | { 11 | withSessionTracking?: boolean; 12 | withServerAnonymisation?: boolean; 13 | }; 14 | ``` 15 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browserpluginconfiguration.plugin.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserPluginConfiguration](./browser-tracker.browserpluginconfiguration.md) > [plugin](./browser-tracker.browserpluginconfiguration.plugin.md) 4 | 5 | ## BrowserPluginConfiguration.plugin property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | plugin: BrowserPlugin; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.core.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [core](./browser-tracker.browsertracker.core.md) 4 | 5 | ## BrowserTracker.core property 6 | 7 | The instance of the core library which this tracker has initialised 8 | 9 | Signature: 10 | 11 | ```typescript 12 | core: TrackerCore; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.disableactivitytracking.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [disableActivityTracking](./browser-tracker.browsertracker.disableactivitytracking.md) 4 | 5 | ## BrowserTracker.disableActivityTracking property 6 | 7 | Disables page activity tracking. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | disableActivityTracking: () => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.discardbrace.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [discardBrace](./browser-tracker.browsertracker.discardbrace.md) 4 | 5 | ## BrowserTracker.discardBrace property 6 | 7 | Strip braces from URL 8 | 9 | Signature: 10 | 11 | ```typescript 12 | discardBrace: (enableFilter: boolean) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.discardhashtag.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [discardHashTag](./browser-tracker.browsertracker.discardhashtag.md) 4 | 5 | ## BrowserTracker.discardHashTag property 6 | 7 | Strip hash tag (or anchor) from URL 8 | 9 | Signature: 10 | 11 | ```typescript 12 | discardHashTag: (enableFilter: boolean) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getcookiename.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getCookieName](./browser-tracker.browsertracker.getcookiename.md) 4 | 5 | ## BrowserTracker.getCookieName property 6 | 7 | Get the cookie name as cookieNamePrefix + basename + . + domain. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getCookieName: (basename: string) => string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getDomainUserId](./browser-tracker.browsertracker.getdomainuserid.md) 4 | 5 | ## BrowserTracker.getDomainUserId property 6 | 7 | Get visitor ID (from first party cookie) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getDomainUserId: () => string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getdomainuserinfo.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getDomainUserInfo](./browser-tracker.browsertracker.getdomainuserinfo.md) 4 | 5 | ## BrowserTracker.getDomainUserInfo property 6 | 7 | Get the visitor information (from first party cookie) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getDomainUserInfo: () => ParsedIdCookie; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getpageviewid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getPageViewId](./browser-tracker.browsertracker.getpageviewid.md) 4 | 5 | ## BrowserTracker.getPageViewId property 6 | 7 | Get the current page view ID 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getPageViewId: () => string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.gettabid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getTabId](./browser-tracker.browsertracker.gettabid.md) 4 | 5 | ## BrowserTracker.getTabId property 6 | 7 | Get the current browser tab ID 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getTabId: () => string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.getuserid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [getUserId](./browser-tracker.browsertracker.getuserid.md) 4 | 5 | ## BrowserTracker.getUserId property 6 | 7 | Get the current user ID (as set previously with setUserId()). 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getUserId: () => string | null | undefined; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.id.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [id](./browser-tracker.browsertracker.id.md) 4 | 5 | ## BrowserTracker.id property 6 | 7 | The unique identifier of this tracker 8 | 9 | Signature: 10 | 11 | ```typescript 12 | id: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.namespace.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [namespace](./browser-tracker.browsertracker.namespace.md) 4 | 5 | ## BrowserTracker.namespace property 6 | 7 | The tracker namespace 8 | 9 | Signature: 10 | 11 | ```typescript 12 | namespace: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.newsession.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [newSession](./browser-tracker.browsertracker.newsession.md) 4 | 5 | ## BrowserTracker.newSession property 6 | 7 | Expires current session and starts a new session. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | newSession: () => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.preservepageviewid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [preservePageViewId](./browser-tracker.browsertracker.preservepageviewid.md) 4 | 5 | ## BrowserTracker.preservePageViewId property 6 | 7 | Stop regenerating `pageViewId` (available from `web_page` context) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | preservePageViewId: () => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.setcookiepath.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setCookiePath](./browser-tracker.browsertracker.setcookiepath.md) 4 | 5 | ## BrowserTracker.setCookiePath property 6 | 7 | Set first-party cookie path 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setCookiePath: (path: string) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.setcustomurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setCustomUrl](./browser-tracker.browsertracker.setcustomurl.md) 4 | 5 | ## BrowserTracker.setCustomUrl property 6 | 7 | Override url 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setCustomUrl: (url: string) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.setdocumenttitle.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setDocumentTitle](./browser-tracker.browsertracker.setdocumenttitle.md) 4 | 5 | ## BrowserTracker.setDocumentTitle property 6 | 7 | Override document.title 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setDocumentTitle: (title: string) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.setoptoutcookie.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setOptOutCookie](./browser-tracker.browsertracker.setoptoutcookie.md) 4 | 5 | ## BrowserTracker.setOptOutCookie property 6 | 7 | Sets the opt out cookie. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setOptOutCookie: (name?: string | null) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.setreferrerurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setReferrerUrl](./browser-tracker.browsertracker.setreferrerurl.md) 4 | 5 | ## BrowserTracker.setReferrerUrl property 6 | 7 | Override referrer 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setReferrerUrl: (url: string) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.setuserid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [setUserId](./browser-tracker.browsertracker.setuserid.md) 4 | 5 | ## BrowserTracker.setUserId property 6 | 7 | Set the business-defined user ID for this user. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setUserId: (userId?: string | null) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.sharedstate.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [sharedState](./browser-tracker.browsertracker.sharedstate.md) 4 | 5 | ## BrowserTracker.sharedState property 6 | 7 | The instance of shared state this tracker is using 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sharedState: SharedState; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.browsertracker.trackpageview.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [BrowserTracker](./browser-tracker.browsertracker.md) > [trackPageView](./browser-tracker.browsertracker.trackpageview.md) 4 | 5 | ## BrowserTracker.trackPageView property 6 | 7 | Log visit to this page 8 | 9 | Signature: 10 | 11 | ```typescript 12 | trackPageView: (event?: PageViewEvent & CommonEventProperties) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clearuserdataconfiguration.preservesession.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) > [preserveSession](./browser-tracker.clearuserdataconfiguration.preservesession.md) 4 | 5 | ## ClearUserDataConfiguration.preserveSession property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | preserveSession: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clearuserdataconfiguration.preserveuser.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClearUserDataConfiguration](./browser-tracker.clearuserdataconfiguration.md) > [preserveUser](./browser-tracker.clearuserdataconfiguration.preserveuser.md) 4 | 5 | ## ClearUserDataConfiguration.preserveUser property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | preserveUser: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.eventindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [eventIndex](./browser-tracker.clientsession.eventindex.md) 4 | 5 | ## ClientSession.eventIndex property 6 | 7 | Index of the current event in the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | eventIndex: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.firsteventid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [firstEventId](./browser-tracker.clientsession.firsteventid.md) 4 | 5 | ## ClientSession.firstEventId property 6 | 7 | Identifier of the first event for this session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | firstEventId: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.previoussessionid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [previousSessionId](./browser-tracker.clientsession.previoussessionid.md) 4 | 5 | ## ClientSession.previousSessionId property 6 | 7 | The previous session identifier for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | previousSessionId: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.sessionid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [sessionId](./browser-tracker.clientsession.sessionid.md) 4 | 5 | ## ClientSession.sessionId property 6 | 7 | An identifier for the session (same as domain\_sessionid) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sessionId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.sessionindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [sessionIndex](./browser-tracker.clientsession.sessionindex.md) 4 | 5 | ## ClientSession.sessionIndex property 6 | 7 | The index of the current session for this user (same as domain\_sessionidx) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sessionIndex: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.storagemechanism.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [storageMechanism](./browser-tracker.clientsession.storagemechanism.md) 4 | 5 | ## ClientSession.storageMechanism property 6 | 7 | The mechanism that the session information has been stored on the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | storageMechanism: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.clientsession.userid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ClientSession](./browser-tracker.clientsession.md) > [userId](./browser-tracker.clientsession.userid.md) 4 | 5 | ## ClientSession.userId property 6 | 7 | An identifier for the user of the session (same as domain\_userid) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | userId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.commoneventproperties.timestamp.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CommonEventProperties](./browser-tracker.commoneventproperties.md) > [timestamp](./browser-tracker.commoneventproperties.timestamp.md) 4 | 5 | ## CommonEventProperties.timestamp property 6 | 7 | Set the true timestamp or overwrite the device sent timestamp on an event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | timestamp?: Timestamp | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.contextevent.event.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextEvent](./browser-tracker.contextevent.md) > [event](./browser-tracker.contextevent.event.md) 4 | 5 | ## ContextEvent.event property 6 | 7 | The event payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | event: Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.contextevent.eventtype.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextEvent](./browser-tracker.contextevent.md) > [eventType](./browser-tracker.contextevent.eventtype.md) 4 | 5 | ## ContextEvent.eventType property 6 | 7 | The event type 8 | 9 | Signature: 10 | 11 | ```typescript 12 | eventType: string; 13 | ``` 14 | 15 | ## Example 16 | 17 | 'page\_view' 18 | 19 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.contextfilter.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextFilter](./browser-tracker.contextfilter.md) 4 | 5 | ## ContextFilter type 6 | 7 | A context filter is a user-supplied callback that is evaluated for each event to determine if the context associated with the filter should be attached to the event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type ContextFilter = (args?: ContextEvent) => boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.contextprimitive.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ContextPrimitive](./browser-tracker.contextprimitive.md) 4 | 5 | ## ContextPrimitive type 6 | 7 | A context primitive is either a self-describing JSON or a context generator 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type ContextPrimitive = SelfDescribingJson | ContextGenerator; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.cookiesamesite.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CookieSameSite](./browser-tracker.cookiesamesite.md) 4 | 5 | ## CookieSameSite type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type CookieSameSite = "None" | "Lax" | "Strict"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.aftertrack.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [afterTrack](./browser-tracker.coreplugin.aftertrack.md) 4 | 5 | ## CorePlugin.afterTrack property 6 | 7 | Called just after the trackerCore callback fires 8 | 9 | Signature: 10 | 11 | ```typescript 12 | afterTrack?: (payload: Payload) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.contexts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [contexts](./browser-tracker.coreplugin.contexts.md) 4 | 5 | ## CorePlugin.contexts property 6 | 7 | Called when constructing the context for each event Useful for adding additional context to events 8 | 9 | Signature: 10 | 11 | ```typescript 12 | contexts?: () => SelfDescribingJson[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.filter.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [filter](./browser-tracker.coreplugin.filter.md) 4 | 5 | ## CorePlugin.filter property 6 | 7 | Called before the payload is sent to the callback to decide whether to send the payload or skip it 8 | 9 | Signature: 10 | 11 | ```typescript 12 | filter?: (payload: Payload) => boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.coreplugin.logger.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePlugin](./browser-tracker.coreplugin.md) > [logger](./browser-tracker.coreplugin.logger.md) 4 | 5 | ## CorePlugin.logger property 6 | 7 | Passed a logger instance which can be used to send log information to the active logger 8 | 9 | Signature: 10 | 11 | ```typescript 12 | logger?: (logger: Logger) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.corepluginconfiguration.plugin.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [CorePluginConfiguration](./browser-tracker.corepluginconfiguration.md) > [plugin](./browser-tracker.corepluginconfiguration.plugin.md) 4 | 5 | ## CorePluginConfiguration.plugin property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | plugin: CorePlugin; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) > [type](./browser-tracker.devicetimestamp.type.md) 4 | 5 | ## DeviceTimestamp.type property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly type: "dtm"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.devicetimestamp.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [DeviceTimestamp](./browser-tracker.devicetimestamp.md) > [value](./browser-tracker.devicetimestamp.value.md) 4 | 5 | ## DeviceTimestamp.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly value: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.emitterconfigurationbase.eventmethod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EmitterConfigurationBase](./browser-tracker.emitterconfigurationbase.md) > [eventMethod](./browser-tracker.emitterconfigurationbase.eventmethod.md) 4 | 5 | ## EmitterConfigurationBase.eventMethod property 6 | 7 | The preferred technique to use to send events 8 | 9 | Signature: 10 | 11 | ```typescript 12 | eventMethod?: EventMethod; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.emitterconfigurationbase.usestm.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EmitterConfigurationBase](./browser-tracker.emitterconfigurationbase.md) > [useStm](./browser-tracker.emitterconfigurationbase.usestm.md) 4 | 5 | ## EmitterConfigurationBase.useStm property 6 | 7 | Should the Sent Timestamp be attached to events. Only applies for GET events. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | useStm?: boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.enableanonymoustrackingconfiguration.options.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EnableAnonymousTrackingConfiguration](./browser-tracker.enableanonymoustrackingconfiguration.md) > [options](./browser-tracker.enableanonymoustrackingconfiguration.options.md) 4 | 5 | ## EnableAnonymousTrackingConfiguration.options property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | options?: AnonymousTrackingOptions; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventbatch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventBatch](./browser-tracker.eventbatch.md) 4 | 5 | ## EventBatch type 6 | 7 | A collection of event payloads which are sent to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type EventBatch = Payload[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventjson.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventJson](./browser-tracker.eventjson.md) 4 | 5 | ## EventJson type 6 | 7 | An array of tuples which represents the unprocessed JSON to be added to the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type EventJson = Array; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventmethod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventMethod](./browser-tracker.eventmethod.md) 4 | 5 | ## EventMethod type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type EventMethod = "post" | "get"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.context.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) > [context](./browser-tracker.eventpayloadandcontext.context.md) 4 | 5 | ## EventPayloadAndContext.context property 6 | 7 | List of context entities to track along with the event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | context: Array; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventpayloadandcontext.event.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventPayloadAndContext](./browser-tracker.eventpayloadandcontext.md) > [event](./browser-tracker.eventpayloadandcontext.event.md) 4 | 5 | ## EventPayloadAndContext.event property 6 | 7 | Tracker payload for the event data 8 | 9 | Signature: 10 | 11 | ```typescript 12 | event: PayloadBuilder; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstore.add.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStore](./browser-tracker.eventstore.md) > [add](./browser-tracker.eventstore.add.md) 4 | 5 | ## EventStore.add property 6 | 7 | Add an event to the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | add: (payload: EventStorePayload) => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstore.count.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStore](./browser-tracker.eventstore.md) > [count](./browser-tracker.eventstore.count.md) 4 | 5 | ## EventStore.count property 6 | 7 | Count all events in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | count: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstore.getall.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStore](./browser-tracker.eventstore.md) > [getAll](./browser-tracker.eventstore.getall.md) 4 | 5 | ## EventStore.getAll property 6 | 7 | Retrieve all payloads including their meta configuration in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getAll: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstore.getallpayloads.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStore](./browser-tracker.eventstore.md) > [getAllPayloads](./browser-tracker.eventstore.getallpayloads.md) 4 | 5 | ## EventStore.getAllPayloads property 6 | 7 | Retrieve all pure payloads in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getAllPayloads: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstore.iterator.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStore](./browser-tracker.eventstore.md) > [iterator](./browser-tracker.eventstore.iterator.md) 4 | 5 | ## EventStore.iterator property 6 | 7 | Get an iterator over all events in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | iterator: () => EventStoreIterator; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstore.removehead.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStore](./browser-tracker.eventstore.md) > [removeHead](./browser-tracker.eventstore.removehead.md) 4 | 5 | ## EventStore.removeHead property 6 | 7 | Remove the first `count` events from the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | removeHead: (count: number) => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstoreiterator.next.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStoreIterator](./browser-tracker.eventstoreiterator.md) > [next](./browser-tracker.eventstoreiterator.next.md) 4 | 5 | ## EventStoreIterator.next property 6 | 7 | Retrieve the next event in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | next: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstorepayload.payload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStorePayload](./browser-tracker.eventstorepayload.md) > [payload](./browser-tracker.eventstorepayload.payload.md) 4 | 5 | ## EventStorePayload.payload property 6 | 7 | The event payload to be stored 8 | 9 | Signature: 10 | 11 | ```typescript 12 | payload: Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.eventstorepayload.svranon.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [EventStorePayload](./browser-tracker.eventstorepayload.md) > [svrAnon](./browser-tracker.eventstorepayload.svranon.md) 4 | 5 | ## EventStorePayload.svrAnon property 6 | 7 | If the request should undergo server anonymization. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | svrAnon?: boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.extendedcrossdomainlinkeroptions.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [ExtendedCrossDomainLinkerOptions](./browser-tracker.extendedcrossdomainlinkeroptions.md) 4 | 5 | ## ExtendedCrossDomainLinkerOptions type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type ExtendedCrossDomainLinkerOptions = boolean | ExtendedCrossDomainLinkerAttributes; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.flushbufferconfiguration.newbuffersize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [FlushBufferConfiguration](./browser-tracker.flushbufferconfiguration.md) > [newBufferSize](./browser-tracker.flushbufferconfiguration.newbuffersize.md) 4 | 5 | ## FlushBufferConfiguration.newBufferSize property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | newBufferSize?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.jsonprocessor.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [JsonProcessor](./browser-tracker.jsonprocessor.md) 4 | 5 | ## JsonProcessor type 6 | 7 | A function which will processor the Json onto the injected PayloadBuilder 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type JsonProcessor = (payloadBuilder: PayloadBuilder, jsonForProcessing: EventJson, contextEntitiesForProcessing: SelfDescribingJson[]) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.logger.debug.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Logger](./browser-tracker.logger.md) > [debug](./browser-tracker.logger.debug.md) 4 | 5 | ## Logger.debug property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | debug: (message: string, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.logger.error.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Logger](./browser-tracker.logger.md) > [error](./browser-tracker.logger.error.md) 4 | 5 | ## Logger.error property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | error: (message: string, error?: unknown, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.logger.info.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Logger](./browser-tracker.logger.md) > [info](./browser-tracker.logger.info.md) 4 | 5 | ## Logger.info property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | info: (message: string, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.logger.setloglevel.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Logger](./browser-tracker.logger.md) > [setLogLevel](./browser-tracker.logger.setloglevel.md) 4 | 5 | ## Logger.setLogLevel property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | setLogLevel: (level: LOG_LEVEL) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.logger.warn.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Logger](./browser-tracker.logger.md) > [warn](./browser-tracker.logger.warn.md) 4 | 5 | ## Logger.warn property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | warn: (message: string, error?: unknown, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.pageviewevent.title.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PageViewEvent](./browser-tracker.pageviewevent.md) > [title](./browser-tracker.pageviewevent.title.md) 4 | 5 | ## PageViewEvent.title property 6 | 7 | Override the page title 8 | 9 | Signature: 10 | 11 | ```typescript 12 | title?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Payload](./browser-tracker.payload.md) 4 | 5 | ## Payload type 6 | 7 | Type for a Payload dictionary 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type Payload = Record; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payloadbuilder.add.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PayloadBuilder](./browser-tracker.payloadbuilder.md) > [add](./browser-tracker.payloadbuilder.add.md) 4 | 5 | ## PayloadBuilder.add property 6 | 7 | Adds an entry to the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | add: (key: string, value: unknown) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payloadbuilder.addcontextentity.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PayloadBuilder](./browser-tracker.payloadbuilder.md) > [addContextEntity](./browser-tracker.payloadbuilder.addcontextentity.md) 4 | 5 | ## PayloadBuilder.addContextEntity property 6 | 7 | Caches a context entity to be added to payload on build 8 | 9 | Signature: 10 | 11 | ```typescript 12 | addContextEntity: (entity: SelfDescribingJson) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payloadbuilder.adddict.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PayloadBuilder](./browser-tracker.payloadbuilder.md) > [addDict](./browser-tracker.payloadbuilder.adddict.md) 4 | 5 | ## PayloadBuilder.addDict property 6 | 7 | Merges a payload into the existing payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | addDict: (dict: Payload) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payloadbuilder.build.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PayloadBuilder](./browser-tracker.payloadbuilder.md) > [build](./browser-tracker.payloadbuilder.build.md) 4 | 5 | ## PayloadBuilder.build property 6 | 7 | Builds and returns the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | build: () => Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payloadbuilder.getjson.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PayloadBuilder](./browser-tracker.payloadbuilder.md) > [getJson](./browser-tracker.payloadbuilder.getjson.md) 4 | 5 | ## PayloadBuilder.getJson property 6 | 7 | Gets all JSON objects added to payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getJson: () => EventJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.payloadbuilder.getpayload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PayloadBuilder](./browser-tracker.payloadbuilder.md) > [getPayload](./browser-tracker.payloadbuilder.getpayload.md) 4 | 5 | ## PayloadBuilder.getPayload property 6 | 7 | Gets the current payload, before cached JSON is processed 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getPayload: () => Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.platform.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Platform](./browser-tracker.platform.md) 4 | 5 | ## Platform type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type Platform = "web" | "mob" | "pc" | "srv" | "app" | "tv" | "cnsl" | "iot"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.preservepageviewidforurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [PreservePageViewIdForUrl](./browser-tracker.preservepageviewidforurl.md) 4 | 5 | ## PreservePageViewIdForUrl type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type PreservePageViewIdForUrl = boolean | "full" | "pathname" | "pathnameAndSearch"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.requestfailure.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RequestFailure](./browser-tracker.requestfailure.md) 4 | 5 | ## RequestFailure type 6 | 7 | The data that will be available to the `onRequestFailure` callback 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type RequestFailure = { 13 | events: EventBatch; 14 | status?: number; 15 | message?: string; 16 | willRetry: boolean; 17 | }; 18 | ``` 19 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.ruleset.accept.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RuleSet](./browser-tracker.ruleset.md) > [accept](./browser-tracker.ruleset.accept.md) 4 | 5 | ## RuleSet.accept property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | accept?: Array | string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.ruleset.reject.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [RuleSet](./browser-tracker.ruleset.md) > [reject](./browser-tracker.ruleset.reject.md) 4 | 5 | ## RuleSet.reject property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | reject?: Array | string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.selfdescribingevent.event.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SelfDescribingEvent](./browser-tracker.selfdescribingevent.md) > [event](./browser-tracker.selfdescribingevent.event.md) 4 | 5 | ## SelfDescribingEvent.event property 6 | 7 | The Self Describing JSON which describes the event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | event: SelfDescribingJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.sharedstate.bufferflushers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SharedState](./browser-tracker.sharedstate.md) > [bufferFlushers](./browser-tracker.sharedstate.bufferflushers.md) 4 | 5 | ## SharedState.bufferFlushers property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | bufferFlushers: Array<(sync: boolean) => void>; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.sharedstate.hasloaded.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SharedState](./browser-tracker.sharedstate.md) > [hasLoaded](./browser-tracker.sharedstate.hasloaded.md) 4 | 5 | ## SharedState.hasLoaded property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | hasLoaded: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.sharedstate.pageviewid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SharedState](./browser-tracker.sharedstate.md) > [pageViewId](./browser-tracker.sharedstate.pageviewid.md) 4 | 5 | ## SharedState.pageViewId property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | pageViewId?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.sharedstate.pageviewurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SharedState](./browser-tracker.sharedstate.md) > [pageViewUrl](./browser-tracker.sharedstate.pageviewurl.md) 4 | 5 | ## SharedState.pageViewUrl property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | pageViewUrl?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.sharedstate.registeredonloadhandlers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [SharedState](./browser-tracker.sharedstate.md) > [registeredOnLoadHandlers](./browser-tracker.sharedstate.registeredonloadhandlers.md) 4 | 5 | ## SharedState.registeredOnLoadHandlers property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | registeredOnLoadHandlers: Array<() => void>; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.statestoragestrategy.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StateStorageStrategy](./browser-tracker.statestoragestrategy.md) 4 | 5 | ## StateStorageStrategy type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type StateStorageStrategy = "cookieAndLocalStorage" | "cookie" | "localStorage" | "none"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.structuredevent.action.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [action](./browser-tracker.structuredevent.action.md) 4 | 5 | ## StructuredEvent.action property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | action: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.structuredevent.category.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [category](./browser-tracker.structuredevent.category.md) 4 | 5 | ## StructuredEvent.category property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | category: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.structuredevent.label.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [label](./browser-tracker.structuredevent.label.md) 4 | 5 | ## StructuredEvent.label property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | label?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.structuredevent.property.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [property](./browser-tracker.structuredevent.property.md) 4 | 5 | ## StructuredEvent.property property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | property?: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.structuredevent.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [StructuredEvent](./browser-tracker.structuredevent.md) > [value](./browser-tracker.structuredevent.value.md) 4 | 5 | ## StructuredEvent.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | value?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.timestamp.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [Timestamp](./browser-tracker.timestamp.md) 4 | 5 | ## Timestamp type 6 | 7 | Algebraic datatype representing possible timestamp type choice 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type Timestamp = TrueTimestamp | DeviceTimestamp | number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.addpayloadpair.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrackerCore](./browser-tracker.trackercore.md) > [addPayloadPair](./browser-tracker.trackercore.addpayloadpair.md) 4 | 5 | ## TrackerCore.addPayloadPair property 6 | 7 | Set a persistent key-value pair to be added to every payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | addPayloadPair: (key: string, value: unknown) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.clearglobalcontexts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrackerCore](./browser-tracker.trackercore.md) > [clearGlobalContexts](./browser-tracker.trackercore.clearglobalcontexts.md) 4 | 5 | ## TrackerCore.clearGlobalContexts() method 6 | 7 | Removes all global contexts 8 | 9 | Signature: 10 | 11 | ```typescript 12 | clearGlobalContexts(): void; 13 | ``` 14 | Returns: 15 | 16 | void 17 | 18 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.trackercore.getbase64encoding.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrackerCore](./browser-tracker.trackercore.md) > [getBase64Encoding](./browser-tracker.trackercore.getbase64encoding.md) 4 | 5 | ## TrackerCore.getBase64Encoding() method 6 | 7 | Get current base64 encoding state 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getBase64Encoding(): boolean; 13 | ``` 14 | Returns: 15 | 16 | boolean 17 | 18 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.truetimestamp.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrueTimestamp](./browser-tracker.truetimestamp.md) > [type](./browser-tracker.truetimestamp.type.md) 4 | 5 | ## TrueTimestamp.type property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly type: "ttm"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.truetimestamp.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [TrueTimestamp](./browser-tracker.truetimestamp.md) > [value](./browser-tracker.truetimestamp.value.md) 4 | 5 | ## TrueTimestamp.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly value: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/browser-tracker.version.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/browser-tracker](./browser-tracker.md) > [version](./browser-tracker.version.md) 4 | 5 | ## version variable 6 | 7 | Signature: 8 | 9 | ```typescript 10 | version: string 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/browser-tracker/markdown/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) 4 | 5 | ## API Reference 6 | 7 | ## Packages 8 | 9 | | Package | Description | 10 | | --- | --- | 11 | | [@snowplow/browser-tracker](./browser-tracker.md) | | 12 | 13 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) 4 | 5 | ## API Reference 6 | 7 | ## Packages 8 | 9 | | Package | Description | 10 | | --- | --- | 11 | | [@snowplow/react-native-tracker](./react-native-tracker.md) | | 12 | 13 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.asyncstorage.getitem.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AsyncStorage](./react-native-tracker.asyncstorage.md) > [getItem](./react-native-tracker.asyncstorage.getitem.md) 4 | 5 | ## AsyncStorage.getItem property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | getItem: (key: string) => Promise; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.asyncstorage.setitem.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AsyncStorage](./react-native-tracker.asyncstorage.md) > [setItem](./react-native-tracker.asyncstorage.setitem.md) 4 | 5 | ## AsyncStorage.setItem property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | setItem: (key: string, value: string) => Promise; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.contextprimitive.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ContextPrimitive](./react-native-tracker.contextprimitive.md) 4 | 5 | ## ContextPrimitive type 6 | 7 | A context primitive is either a self-describing JSON or a context generator 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type ContextPrimitive = SelfDescribingJson | ContextGenerator; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.base64.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [base64](./react-native-tracker.coreconfiguration.base64.md) 4 | 5 | ## CoreConfiguration.base64 property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | base64?: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.callback.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [callback](./react-native-tracker.coreconfiguration.callback.md) 4 | 5 | ## CoreConfiguration.callback property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | callback?: (PayloadData: PayloadBuilder) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreconfiguration.coreplugins.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [corePlugins](./react-native-tracker.coreconfiguration.coreplugins.md) 4 | 5 | ## CoreConfiguration.corePlugins property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | corePlugins?: Array; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.aftertrack.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [afterTrack](./react-native-tracker.coreplugin.aftertrack.md) 4 | 5 | ## CorePlugin.afterTrack property 6 | 7 | Called just after the trackerCore callback fires 8 | 9 | Signature: 10 | 11 | ```typescript 12 | afterTrack?: (payload: Payload) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.contexts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [contexts](./react-native-tracker.coreplugin.contexts.md) 4 | 5 | ## CorePlugin.contexts property 6 | 7 | Called when constructing the context for each event Useful for adding additional context to events 8 | 9 | Signature: 10 | 11 | ```typescript 12 | contexts?: () => SelfDescribingJson[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.filter.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [filter](./react-native-tracker.coreplugin.filter.md) 4 | 5 | ## CorePlugin.filter property 6 | 7 | Called before the payload is sent to the callback to decide whether to send the payload or skip it 8 | 9 | Signature: 10 | 11 | ```typescript 12 | filter?: (payload: Payload) => boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.coreplugin.logger.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [logger](./react-native-tracker.coreplugin.logger.md) 4 | 5 | ## CorePlugin.logger property 6 | 7 | Passed a logger instance which can be used to send log information to the active logger 8 | 9 | Signature: 10 | 11 | ```typescript 12 | logger?: (logger: Logger) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.corepluginconfiguration.plugin.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePluginConfiguration](./react-native-tracker.corepluginconfiguration.md) > [plugin](./react-native-tracker.corepluginconfiguration.plugin.md) 4 | 5 | ## CorePluginConfiguration.plugin property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | plugin: CorePlugin; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) > [type](./react-native-tracker.devicetimestamp.type.md) 4 | 5 | ## DeviceTimestamp.type property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly type: "dtm"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.devicetimestamp.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) > [value](./react-native-tracker.devicetimestamp.value.md) 4 | 5 | ## DeviceTimestamp.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly value: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.flush.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [flush](./react-native-tracker.emitter.flush.md) 4 | 5 | ## Emitter.flush property 6 | 7 | Forces the emitter to send all events in the event store to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | flush: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.input.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [input](./react-native-tracker.emitter.input.md) 4 | 5 | ## Emitter.input property 6 | 7 | Adds a payload to the event store or sends it to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | input: (payload: Payload) => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setanonymoustracking.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setAnonymousTracking](./react-native-tracker.emitter.setanonymoustracking.md) 4 | 5 | ## Emitter.setAnonymousTracking property 6 | 7 | Sets the server anonymization flag. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setAnonymousTracking: (anonymous: boolean) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setbuffersize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setBufferSize](./react-native-tracker.emitter.setbuffersize.md) 4 | 5 | ## Emitter.setBufferSize property 6 | 7 | Updates the buffer size of the emitter. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setBufferSize: (bufferSize: number) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitter.setcollectorurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setCollectorUrl](./react-native-tracker.emitter.setcollectorurl.md) 4 | 5 | ## Emitter.setCollectorUrl property 6 | 7 | Updates the collector URL to which events will be sent. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setCollectorUrl: (url: string) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.endpoint.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [endpoint](./react-native-tracker.emitterconfiguration.endpoint.md) 4 | 5 | ## EmitterConfiguration.endpoint property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | endpoint: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.port.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [port](./react-native-tracker.emitterconfiguration.port.md) 4 | 5 | ## EmitterConfiguration.port property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | port?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.protocol.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [protocol](./react-native-tracker.emitterconfiguration.protocol.md) 4 | 5 | ## EmitterConfiguration.protocol property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | protocol?: "http" | "https"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.emitterconfiguration.serveranonymization.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [serverAnonymization](./react-native-tracker.emitterconfiguration.serveranonymization.md) 4 | 5 | ## EmitterConfiguration.serverAnonymization property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | serverAnonymization?: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventbatch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventBatch](./react-native-tracker.eventbatch.md) 4 | 5 | ## EventBatch type 6 | 7 | A collection of event payloads which are sent to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type EventBatch = Payload[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventcontext.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventContext](./react-native-tracker.eventcontext.md) 4 | 5 | ## EventContext type 6 | 7 | EventContext type 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type EventContext = SelfDescribingJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventjson.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventJson](./react-native-tracker.eventjson.md) 4 | 5 | ## EventJson type 6 | 7 | An array of tuples which represents the unprocessed JSON to be added to the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type EventJson = Array; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventmethod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventMethod](./react-native-tracker.eventmethod.md) 4 | 5 | ## EventMethod type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type EventMethod = "post" | "get"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventpayloadandcontext.event.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventPayloadAndContext](./react-native-tracker.eventpayloadandcontext.md) > [event](./react-native-tracker.eventpayloadandcontext.event.md) 4 | 5 | ## EventPayloadAndContext.event property 6 | 7 | Tracker payload for the event data 8 | 9 | Signature: 10 | 11 | ```typescript 12 | event: PayloadBuilder; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventstoreiterator.next.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreIterator](./react-native-tracker.eventstoreiterator.md) > [next](./react-native-tracker.eventstoreiterator.next.md) 4 | 5 | ## EventStoreIterator.next property 6 | 7 | Retrieve the next event in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | next: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.payload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) > [payload](./react-native-tracker.eventstorepayload.payload.md) 4 | 5 | ## EventStorePayload.payload property 6 | 7 | The event payload to be stored 8 | 9 | Signature: 10 | 11 | ```typescript 12 | payload: Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.eventstorepayload.svranon.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) > [svrAnon](./react-native-tracker.eventstorepayload.svranon.md) 4 | 5 | ## EventStorePayload.svrAnon property 6 | 7 | If the request should undergo server anonymization. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | svrAnon?: boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [elementId](./react-native-tracker.formfocusorchangeevent.elementid.md) 4 | 5 | ## FormFocusOrChangeEvent.elementId property 6 | 7 | The element ID which the user is interacting with 8 | 9 | Signature: 10 | 11 | ```typescript 12 | elementId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.formid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [formId](./react-native-tracker.formfocusorchangeevent.formid.md) 4 | 5 | ## FormFocusOrChangeEvent.formId property 6 | 7 | The ID of the form which the element belongs to 8 | 9 | Signature: 10 | 11 | ```typescript 12 | formId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.nodename.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [nodeName](./react-native-tracker.formfocusorchangeevent.nodename.md) 4 | 5 | ## FormFocusOrChangeEvent.nodeName property 6 | 7 | The name of the node ("INPUT", "TEXTAREA", "SELECT") 8 | 9 | Signature: 10 | 11 | ```typescript 12 | nodeName: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.schema.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [schema](./react-native-tracker.formfocusorchangeevent.schema.md) 4 | 5 | ## FormFocusOrChangeEvent.schema property 6 | 7 | The schema which will be used for the event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | schema: "change_form" | "focus_form"; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [type](./react-native-tracker.formfocusorchangeevent.type.md) 4 | 5 | ## FormFocusOrChangeEvent.type property 6 | 7 | The type of element (e.g. "datetime", "text", "radio", etc.) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.formfocusorchangeevent.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [value](./react-native-tracker.formfocusorchangeevent.value.md) 4 | 5 | ## FormFocusOrChangeEvent.value property 6 | 7 | The value of the element at the time of the event firing 8 | 9 | Signature: 10 | 11 | ```typescript 12 | value: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.logger.debug.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [debug](./react-native-tracker.logger.debug.md) 4 | 5 | ## Logger.debug property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | debug: (message: string, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.logger.error.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [error](./react-native-tracker.logger.error.md) 4 | 5 | ## Logger.error property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | error: (message: string, error?: unknown, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.logger.info.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [info](./react-native-tracker.logger.info.md) 4 | 5 | ## Logger.info property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | info: (message: string, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.logger.setloglevel.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [setLogLevel](./react-native-tracker.logger.setloglevel.md) 4 | 5 | ## Logger.setLogLevel property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | setLogLevel: (level: LOG_LEVEL) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.logger.warn.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [warn](./react-native-tracker.logger.warn.md) 4 | 5 | ## Logger.warn property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | warn: (message: string, error?: unknown, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pagetitle.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [pageTitle](./react-native-tracker.pageviewevent.pagetitle.md) 4 | 5 | ## PageViewEvent.pageTitle property 6 | 7 | The current page title in the users browser 8 | 9 | Signature: 10 | 11 | ```typescript 12 | pageTitle?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.pageurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [pageUrl](./react-native-tracker.pageviewevent.pageurl.md) 4 | 5 | ## PageViewEvent.pageUrl property 6 | 7 | The current URL visible in the users browser 8 | 9 | Signature: 10 | 11 | ```typescript 12 | pageUrl?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.pageviewevent.referrer.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [referrer](./react-native-tracker.pageviewevent.referrer.md) 4 | 5 | ## PageViewEvent.referrer property 6 | 7 | The URL of the referring page 8 | 9 | Signature: 10 | 11 | ```typescript 12 | referrer?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.payload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Payload](./react-native-tracker.payload.md) 4 | 5 | ## Payload type 6 | 7 | Type for a Payload dictionary 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type Payload = Record; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.add.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [add](./react-native-tracker.payloadbuilder.add.md) 4 | 5 | ## PayloadBuilder.add property 6 | 7 | Adds an entry to the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | add: (key: string, value: unknown) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.adddict.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [addDict](./react-native-tracker.payloadbuilder.adddict.md) 4 | 5 | ## PayloadBuilder.addDict property 6 | 7 | Merges a payload into the existing payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | addDict: (dict: Payload) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.build.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [build](./react-native-tracker.payloadbuilder.build.md) 4 | 5 | ## PayloadBuilder.build property 6 | 7 | Builds and returns the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | build: () => Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getjson.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [getJson](./react-native-tracker.payloadbuilder.getjson.md) 4 | 5 | ## PayloadBuilder.getJson property 6 | 7 | Gets all JSON objects added to payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getJson: () => EventJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.payloadbuilder.getpayload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [getPayload](./react-native-tracker.payloadbuilder.getpayload.md) 4 | 5 | ## PayloadBuilder.getPayload property 6 | 7 | Gets the current payload, before cached JSON is processed 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getPayload: () => Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.removealltrackers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [removeAllTrackers](./react-native-tracker.removealltrackers.md) 4 | 5 | ## removeAllTrackers() function 6 | 7 | Removes all initialized trackers 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare function removeAllTrackers(): void; 13 | ``` 14 | Returns: 15 | 16 | void 17 | 18 | - A boolean promise 19 | 20 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.accept.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) > [accept](./react-native-tracker.ruleset.accept.md) 4 | 5 | ## RuleSet.accept property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | accept?: Array | string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.ruleset.reject.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) > [reject](./react-native-tracker.ruleset.reject.md) 4 | 5 | ## RuleSet.reject property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | reject?: Array | string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.screensize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ScreenSize](./react-native-tracker.screensize.md) 4 | 5 | ## ScreenSize type 6 | 7 | Screen size in pixels 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type ScreenSize = [number, number]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.selfdescribing.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SelfDescribing](./react-native-tracker.selfdescribing.md) 4 | 5 | ## SelfDescribing type 6 | 7 | Interface for any self-describing JSON such as context entities or self-describing events 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type SelfDescribing> = SelfDescribingJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.eventindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [eventIndex](./react-native-tracker.sessionstate.eventindex.md) 4 | 5 | ## SessionState.eventIndex property 6 | 7 | Optional index of the current event in the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | eventIndex?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.firsteventid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [firstEventId](./react-native-tracker.sessionstate.firsteventid.md) 4 | 5 | ## SessionState.firstEventId property 6 | 7 | The optional identifier of the first event for this session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | firstEventId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.previoussessionid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [previousSessionId](./react-native-tracker.sessionstate.previoussessionid.md) 4 | 5 | ## SessionState.previousSessionId property 6 | 7 | The previous session identifier for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | previousSessionId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [sessionId](./react-native-tracker.sessionstate.sessionid.md) 4 | 5 | ## SessionState.sessionId property 6 | 7 | An identifier for the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sessionId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.sessionindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [sessionIndex](./react-native-tracker.sessionstate.sessionindex.md) 4 | 5 | ## SessionState.sessionIndex property 6 | 7 | The index of the current session for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sessionIndex: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.storagemechanism.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [storageMechanism](./react-native-tracker.sessionstate.storagemechanism.md) 4 | 5 | ## SessionState.storageMechanism property 6 | 7 | The mechanism that the session information has been stored on the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | storageMechanism: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.sessionstate.userid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [userId](./react-native-tracker.sessionstate.userid.md) 4 | 5 | ## SessionState.userId property 6 | 7 | An identifier for the user of the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | userId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.colordepth.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [colorDepth](./react-native-tracker.subjectconfiguration.colordepth.md) 4 | 5 | ## SubjectConfiguration.colorDepth property 6 | 7 | Color depth (integer) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | colorDepth?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.ipaddress.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [ipAddress](./react-native-tracker.subjectconfiguration.ipaddress.md) 4 | 5 | ## SubjectConfiguration.ipAddress property 6 | 7 | Override the IP address of the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | ipAddress?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.language.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [language](./react-native-tracker.subjectconfiguration.language.md) 4 | 5 | ## SubjectConfiguration.language property 6 | 7 | The language set in the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | language?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenresolution.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [screenResolution](./react-native-tracker.subjectconfiguration.screenresolution.md) 4 | 5 | ## SubjectConfiguration.screenResolution property 6 | 7 | The screen resolution 8 | 9 | Signature: 10 | 11 | ```typescript 12 | screenResolution?: ScreenSize; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.screenviewport.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [screenViewport](./react-native-tracker.subjectconfiguration.screenviewport.md) 4 | 5 | ## SubjectConfiguration.screenViewport property 6 | 7 | The screen viewport size 8 | 9 | Signature: 10 | 11 | ```typescript 12 | screenViewport?: ScreenSize; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.timezone.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [timezone](./react-native-tracker.subjectconfiguration.timezone.md) 4 | 5 | ## SubjectConfiguration.timezone property 6 | 7 | The timezone label 8 | 9 | Signature: 10 | 11 | ```typescript 12 | timezone?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.useragent.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [useragent](./react-native-tracker.subjectconfiguration.useragent.md) 4 | 5 | ## SubjectConfiguration.useragent property 6 | 7 | The custom user-agent. It overrides the user-agent used by default. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | useragent?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.subjectconfiguration.userid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [userId](./react-native-tracker.subjectconfiguration.userid.md) 4 | 5 | ## SubjectConfiguration.userId property 6 | 7 | Business-defined user ID for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | userId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.timestamp.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Timestamp](./react-native-tracker.timestamp.md) 4 | 5 | ## Timestamp type 6 | 7 | Algebraic datatype representing possible timestamp type choice 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type Timestamp = TrueTimestamp | DeviceTimestamp | number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.timingprops.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TimingProps](./react-native-tracker.timingprops.md) 4 | 5 | ## TimingProps type 6 | 7 | Timing event properties 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type TimingProps = { 13 | category: string; 14 | variable: string; 15 | timing: number; 16 | label?: string; 17 | }; 18 | ``` 19 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.appid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [appId](./react-native-tracker.trackerconfiguration.appid.md) 4 | 5 | ## TrackerConfiguration.appId property 6 | 7 | The application ID 8 | 9 | Signature: 10 | 11 | ```typescript 12 | appId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.deviceplatform.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [devicePlatform](./react-native-tracker.trackerconfiguration.deviceplatform.md) 4 | 5 | ## TrackerConfiguration.devicePlatform property 6 | 7 | The device platform the tracker runs on. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | devicePlatform?: Platform; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.namespace.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [namespace](./react-native-tracker.trackerconfiguration.namespace.md) 4 | 5 | ## TrackerConfiguration.namespace property 6 | 7 | The namespace of the tracker 8 | 9 | Signature: 10 | 11 | ```typescript 12 | namespace: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.trackerconfiguration.plugins.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [plugins](./react-native-tracker.trackerconfiguration.plugins.md) 4 | 5 | ## TrackerConfiguration.plugins property 6 | 7 | Inject plugins which will be evaluated for each event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | plugins?: BrowserPlugin[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.trigger.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Trigger](./react-native-tracker.trigger.md) 4 | 5 | ## Trigger type 6 | 7 | Trigger for MessageNotification event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type Trigger = 'push' | 'location' | 'calendar' | 'timeInterval' | 'other'; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) > [type](./react-native-tracker.truetimestamp.type.md) 4 | 5 | ## TrueTimestamp.type property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly type: "ttm"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.truetimestamp.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) > [value](./react-native-tracker.truetimestamp.value.md) 4 | 5 | ## TrueTimestamp.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly value: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/node-tracker/markdown/react-native-tracker.version.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [version](./react-native-tracker.version.md) 4 | 5 | ## version variable 6 | 7 | Signature: 8 | 9 | ```typescript 10 | version: string 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/index.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) 4 | 5 | ## API Reference 6 | 7 | ## Packages 8 | 9 | | Package | Description | 10 | | --- | --- | 11 | | [@snowplow/react-native-tracker](./react-native-tracker.md) | | 12 | 13 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.asyncstorage.getitem.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AsyncStorage](./react-native-tracker.asyncstorage.md) > [getItem](./react-native-tracker.asyncstorage.getitem.md) 4 | 5 | ## AsyncStorage.getItem property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | getItem: (key: string) => Promise; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.asyncstorage.setitem.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [AsyncStorage](./react-native-tracker.asyncstorage.md) > [setItem](./react-native-tracker.asyncstorage.setitem.md) 4 | 5 | ## AsyncStorage.setItem property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | setItem: (key: string, value: string) => Promise; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.contextprimitive.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ContextPrimitive](./react-native-tracker.contextprimitive.md) 4 | 5 | ## ContextPrimitive type 6 | 7 | A context primitive is either a self-describing JSON or a context generator 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type ContextPrimitive = SelfDescribingJson | ContextGenerator; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreconfiguration.base64.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [base64](./react-native-tracker.coreconfiguration.base64.md) 4 | 5 | ## CoreConfiguration.base64 property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | base64?: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreconfiguration.callback.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [callback](./react-native-tracker.coreconfiguration.callback.md) 4 | 5 | ## CoreConfiguration.callback property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | callback?: (PayloadData: PayloadBuilder) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreconfiguration.coreplugins.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CoreConfiguration](./react-native-tracker.coreconfiguration.md) > [corePlugins](./react-native-tracker.coreconfiguration.coreplugins.md) 4 | 5 | ## CoreConfiguration.corePlugins property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | corePlugins?: Array; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreplugin.aftertrack.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [afterTrack](./react-native-tracker.coreplugin.aftertrack.md) 4 | 5 | ## CorePlugin.afterTrack property 6 | 7 | Called just after the trackerCore callback fires 8 | 9 | Signature: 10 | 11 | ```typescript 12 | afterTrack?: (payload: Payload) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreplugin.contexts.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [contexts](./react-native-tracker.coreplugin.contexts.md) 4 | 5 | ## CorePlugin.contexts property 6 | 7 | Called when constructing the context for each event Useful for adding additional context to events 8 | 9 | Signature: 10 | 11 | ```typescript 12 | contexts?: () => SelfDescribingJson[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreplugin.filter.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [filter](./react-native-tracker.coreplugin.filter.md) 4 | 5 | ## CorePlugin.filter property 6 | 7 | Called before the payload is sent to the callback to decide whether to send the payload or skip it 8 | 9 | Signature: 10 | 11 | ```typescript 12 | filter?: (payload: Payload) => boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.coreplugin.logger.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePlugin](./react-native-tracker.coreplugin.md) > [logger](./react-native-tracker.coreplugin.logger.md) 4 | 5 | ## CorePlugin.logger property 6 | 7 | Passed a logger instance which can be used to send log information to the active logger 8 | 9 | Signature: 10 | 11 | ```typescript 12 | logger?: (logger: Logger) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.corepluginconfiguration.plugin.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [CorePluginConfiguration](./react-native-tracker.corepluginconfiguration.md) > [plugin](./react-native-tracker.corepluginconfiguration.plugin.md) 4 | 5 | ## CorePluginConfiguration.plugin property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | plugin: CorePlugin; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.devicetimestamp.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) > [type](./react-native-tracker.devicetimestamp.type.md) 4 | 5 | ## DeviceTimestamp.type property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly type: "dtm"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.devicetimestamp.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [DeviceTimestamp](./react-native-tracker.devicetimestamp.md) > [value](./react-native-tracker.devicetimestamp.value.md) 4 | 5 | ## DeviceTimestamp.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly value: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitter.flush.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [flush](./react-native-tracker.emitter.flush.md) 4 | 5 | ## Emitter.flush property 6 | 7 | Forces the emitter to send all events in the event store to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | flush: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitter.input.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [input](./react-native-tracker.emitter.input.md) 4 | 5 | ## Emitter.input property 6 | 7 | Adds a payload to the event store or sends it to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | input: (payload: Payload) => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitter.setanonymoustracking.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setAnonymousTracking](./react-native-tracker.emitter.setanonymoustracking.md) 4 | 5 | ## Emitter.setAnonymousTracking property 6 | 7 | Sets the server anonymization flag. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setAnonymousTracking: (anonymous: boolean) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitter.setbuffersize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setBufferSize](./react-native-tracker.emitter.setbuffersize.md) 4 | 5 | ## Emitter.setBufferSize property 6 | 7 | Updates the buffer size of the emitter. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setBufferSize: (bufferSize: number) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitter.setcollectorurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Emitter](./react-native-tracker.emitter.md) > [setCollectorUrl](./react-native-tracker.emitter.setcollectorurl.md) 4 | 5 | ## Emitter.setCollectorUrl property 6 | 7 | Updates the collector URL to which events will be sent. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | setCollectorUrl: (url: string) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitterconfiguration.endpoint.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [endpoint](./react-native-tracker.emitterconfiguration.endpoint.md) 4 | 5 | ## EmitterConfiguration.endpoint property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | endpoint: string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitterconfiguration.port.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [port](./react-native-tracker.emitterconfiguration.port.md) 4 | 5 | ## EmitterConfiguration.port property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | port?: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitterconfiguration.protocol.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [protocol](./react-native-tracker.emitterconfiguration.protocol.md) 4 | 5 | ## EmitterConfiguration.protocol property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | protocol?: "http" | "https"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.emitterconfiguration.serveranonymization.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EmitterConfiguration](./react-native-tracker.emitterconfiguration.md) > [serverAnonymization](./react-native-tracker.emitterconfiguration.serveranonymization.md) 4 | 5 | ## EmitterConfiguration.serverAnonymization property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | serverAnonymization?: boolean; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventbatch.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventBatch](./react-native-tracker.eventbatch.md) 4 | 5 | ## EventBatch type 6 | 7 | A collection of event payloads which are sent to the collector. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type EventBatch = Payload[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventcontext.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventContext](./react-native-tracker.eventcontext.md) 4 | 5 | ## EventContext type 6 | 7 | EventContext type 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type EventContext = SelfDescribingJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventjson.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventJson](./react-native-tracker.eventjson.md) 4 | 5 | ## EventJson type 6 | 7 | An array of tuples which represents the unprocessed JSON to be added to the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type EventJson = Array; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventmethod.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventMethod](./react-native-tracker.eventmethod.md) 4 | 5 | ## EventMethod type 6 | 7 | Signature: 8 | 9 | ```typescript 10 | type EventMethod = "post" | "get"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventpayloadandcontext.event.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventPayloadAndContext](./react-native-tracker.eventpayloadandcontext.md) > [event](./react-native-tracker.eventpayloadandcontext.event.md) 4 | 5 | ## EventPayloadAndContext.event property 6 | 7 | Tracker payload for the event data 8 | 9 | Signature: 10 | 11 | ```typescript 12 | event: PayloadBuilder; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventstoreiterator.next.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStoreIterator](./react-native-tracker.eventstoreiterator.md) > [next](./react-native-tracker.eventstoreiterator.next.md) 4 | 5 | ## EventStoreIterator.next property 6 | 7 | Retrieve the next event in the store 8 | 9 | Signature: 10 | 11 | ```typescript 12 | next: () => Promise; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventstorepayload.payload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) > [payload](./react-native-tracker.eventstorepayload.payload.md) 4 | 5 | ## EventStorePayload.payload property 6 | 7 | The event payload to be stored 8 | 9 | Signature: 10 | 11 | ```typescript 12 | payload: Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.eventstorepayload.svranon.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [EventStorePayload](./react-native-tracker.eventstorepayload.md) > [svrAnon](./react-native-tracker.eventstorepayload.svranon.md) 4 | 5 | ## EventStorePayload.svrAnon property 6 | 7 | If the request should undergo server anonymization. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | svrAnon?: boolean; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.formfocusorchangeevent.elementid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [elementId](./react-native-tracker.formfocusorchangeevent.elementid.md) 4 | 5 | ## FormFocusOrChangeEvent.elementId property 6 | 7 | The element ID which the user is interacting with 8 | 9 | Signature: 10 | 11 | ```typescript 12 | elementId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.formfocusorchangeevent.formid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [formId](./react-native-tracker.formfocusorchangeevent.formid.md) 4 | 5 | ## FormFocusOrChangeEvent.formId property 6 | 7 | The ID of the form which the element belongs to 8 | 9 | Signature: 10 | 11 | ```typescript 12 | formId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.formfocusorchangeevent.nodename.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [nodeName](./react-native-tracker.formfocusorchangeevent.nodename.md) 4 | 5 | ## FormFocusOrChangeEvent.nodeName property 6 | 7 | The name of the node ("INPUT", "TEXTAREA", "SELECT") 8 | 9 | Signature: 10 | 11 | ```typescript 12 | nodeName: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.formfocusorchangeevent.schema.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [schema](./react-native-tracker.formfocusorchangeevent.schema.md) 4 | 5 | ## FormFocusOrChangeEvent.schema property 6 | 7 | The schema which will be used for the event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | schema: "change_form" | "focus_form"; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.formfocusorchangeevent.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [type](./react-native-tracker.formfocusorchangeevent.type.md) 4 | 5 | ## FormFocusOrChangeEvent.type property 6 | 7 | The type of element (e.g. "datetime", "text", "radio", etc.) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.formfocusorchangeevent.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [FormFocusOrChangeEvent](./react-native-tracker.formfocusorchangeevent.md) > [value](./react-native-tracker.formfocusorchangeevent.value.md) 4 | 5 | ## FormFocusOrChangeEvent.value property 6 | 7 | The value of the element at the time of the event firing 8 | 9 | Signature: 10 | 11 | ```typescript 12 | value: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.logger.debug.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [debug](./react-native-tracker.logger.debug.md) 4 | 5 | ## Logger.debug property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | debug: (message: string, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.logger.error.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [error](./react-native-tracker.logger.error.md) 4 | 5 | ## Logger.error property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | error: (message: string, error?: unknown, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.logger.info.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [info](./react-native-tracker.logger.info.md) 4 | 5 | ## Logger.info property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | info: (message: string, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.logger.setloglevel.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [setLogLevel](./react-native-tracker.logger.setloglevel.md) 4 | 5 | ## Logger.setLogLevel property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | setLogLevel: (level: LOG_LEVEL) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.logger.warn.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Logger](./react-native-tracker.logger.md) > [warn](./react-native-tracker.logger.warn.md) 4 | 5 | ## Logger.warn property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | warn: (message: string, error?: unknown, ...extraParams: unknown[]) => void; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.pageviewevent.pagetitle.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [pageTitle](./react-native-tracker.pageviewevent.pagetitle.md) 4 | 5 | ## PageViewEvent.pageTitle property 6 | 7 | The current page title in the users browser 8 | 9 | Signature: 10 | 11 | ```typescript 12 | pageTitle?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.pageviewevent.pageurl.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [pageUrl](./react-native-tracker.pageviewevent.pageurl.md) 4 | 5 | ## PageViewEvent.pageUrl property 6 | 7 | The current URL visible in the users browser 8 | 9 | Signature: 10 | 11 | ```typescript 12 | pageUrl?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.pageviewevent.referrer.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PageViewEvent](./react-native-tracker.pageviewevent.md) > [referrer](./react-native-tracker.pageviewevent.referrer.md) 4 | 5 | ## PageViewEvent.referrer property 6 | 7 | The URL of the referring page 8 | 9 | Signature: 10 | 11 | ```typescript 12 | referrer?: string | null; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.payload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Payload](./react-native-tracker.payload.md) 4 | 5 | ## Payload type 6 | 7 | Type for a Payload dictionary 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type Payload = Record; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.payloadbuilder.add.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [add](./react-native-tracker.payloadbuilder.add.md) 4 | 5 | ## PayloadBuilder.add property 6 | 7 | Adds an entry to the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | add: (key: string, value: unknown) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.payloadbuilder.adddict.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [addDict](./react-native-tracker.payloadbuilder.adddict.md) 4 | 5 | ## PayloadBuilder.addDict property 6 | 7 | Merges a payload into the existing payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | addDict: (dict: Payload) => void; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.payloadbuilder.build.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [build](./react-native-tracker.payloadbuilder.build.md) 4 | 5 | ## PayloadBuilder.build property 6 | 7 | Builds and returns the Payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | build: () => Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.payloadbuilder.getjson.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [getJson](./react-native-tracker.payloadbuilder.getjson.md) 4 | 5 | ## PayloadBuilder.getJson property 6 | 7 | Gets all JSON objects added to payload 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getJson: () => EventJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.payloadbuilder.getpayload.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [PayloadBuilder](./react-native-tracker.payloadbuilder.md) > [getPayload](./react-native-tracker.payloadbuilder.getpayload.md) 4 | 5 | ## PayloadBuilder.getPayload property 6 | 7 | Gets the current payload, before cached JSON is processed 8 | 9 | Signature: 10 | 11 | ```typescript 12 | getPayload: () => Payload; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.removealltrackers.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [removeAllTrackers](./react-native-tracker.removealltrackers.md) 4 | 5 | ## removeAllTrackers() function 6 | 7 | Removes all initialized trackers 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare function removeAllTrackers(): void; 13 | ``` 14 | Returns: 15 | 16 | void 17 | 18 | - A boolean promise 19 | 20 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.requestfailure.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RequestFailure](./react-native-tracker.requestfailure.md) 4 | 5 | ## RequestFailure type 6 | 7 | The data that will be available to the `onRequestFailure` callback 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type RequestFailure = { 13 | events: EventBatch; 14 | status?: number; 15 | message?: string; 16 | willRetry: boolean; 17 | }; 18 | ``` 19 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.ruleset.accept.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) > [accept](./react-native-tracker.ruleset.accept.md) 4 | 5 | ## RuleSet.accept property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | accept?: Array | string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.ruleset.reject.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [RuleSet](./react-native-tracker.ruleset.md) > [reject](./react-native-tracker.ruleset.reject.md) 4 | 5 | ## RuleSet.reject property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | reject?: Array | string; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.screensize.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [ScreenSize](./react-native-tracker.screensize.md) 4 | 5 | ## ScreenSize type 6 | 7 | Screen size in pixels 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type ScreenSize = [number, number]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.selfdescribing.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SelfDescribing](./react-native-tracker.selfdescribing.md) 4 | 5 | ## SelfDescribing type 6 | 7 | Interface for any self-describing JSON such as context entities or self-describing events 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type SelfDescribing> = SelfDescribingJson; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.eventindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [eventIndex](./react-native-tracker.sessionstate.eventindex.md) 4 | 5 | ## SessionState.eventIndex property 6 | 7 | Optional index of the current event in the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | eventIndex?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.firsteventid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [firstEventId](./react-native-tracker.sessionstate.firsteventid.md) 4 | 5 | ## SessionState.firstEventId property 6 | 7 | The optional identifier of the first event for this session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | firstEventId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.previoussessionid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [previousSessionId](./react-native-tracker.sessionstate.previoussessionid.md) 4 | 5 | ## SessionState.previousSessionId property 6 | 7 | The previous session identifier for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | previousSessionId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.sessionid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [sessionId](./react-native-tracker.sessionstate.sessionid.md) 4 | 5 | ## SessionState.sessionId property 6 | 7 | An identifier for the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sessionId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.sessionindex.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [sessionIndex](./react-native-tracker.sessionstate.sessionindex.md) 4 | 5 | ## SessionState.sessionIndex property 6 | 7 | The index of the current session for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | sessionIndex: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.storagemechanism.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [storageMechanism](./react-native-tracker.sessionstate.storagemechanism.md) 4 | 5 | ## SessionState.storageMechanism property 6 | 7 | The mechanism that the session information has been stored on the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | storageMechanism: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.sessionstate.userid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SessionState](./react-native-tracker.sessionstate.md) > [userId](./react-native-tracker.sessionstate.userid.md) 4 | 5 | ## SessionState.userId property 6 | 7 | An identifier for the user of the session 8 | 9 | Signature: 10 | 11 | ```typescript 12 | userId: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.colordepth.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [colorDepth](./react-native-tracker.subjectconfiguration.colordepth.md) 4 | 5 | ## SubjectConfiguration.colorDepth property 6 | 7 | Color depth (integer) 8 | 9 | Signature: 10 | 11 | ```typescript 12 | colorDepth?: number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.ipaddress.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [ipAddress](./react-native-tracker.subjectconfiguration.ipaddress.md) 4 | 5 | ## SubjectConfiguration.ipAddress property 6 | 7 | Override the IP address of the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | ipAddress?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.language.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [language](./react-native-tracker.subjectconfiguration.language.md) 4 | 5 | ## SubjectConfiguration.language property 6 | 7 | The language set in the device 8 | 9 | Signature: 10 | 11 | ```typescript 12 | language?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.screenresolution.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [screenResolution](./react-native-tracker.subjectconfiguration.screenresolution.md) 4 | 5 | ## SubjectConfiguration.screenResolution property 6 | 7 | The screen resolution 8 | 9 | Signature: 10 | 11 | ```typescript 12 | screenResolution?: ScreenSize; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.screenviewport.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [screenViewport](./react-native-tracker.subjectconfiguration.screenviewport.md) 4 | 5 | ## SubjectConfiguration.screenViewport property 6 | 7 | The screen viewport size 8 | 9 | Signature: 10 | 11 | ```typescript 12 | screenViewport?: ScreenSize; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.timezone.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [timezone](./react-native-tracker.subjectconfiguration.timezone.md) 4 | 5 | ## SubjectConfiguration.timezone property 6 | 7 | The timezone label 8 | 9 | Signature: 10 | 11 | ```typescript 12 | timezone?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.useragent.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [useragent](./react-native-tracker.subjectconfiguration.useragent.md) 4 | 5 | ## SubjectConfiguration.useragent property 6 | 7 | The custom user-agent. It overrides the user-agent used by default. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | useragent?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.subjectconfiguration.userid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [SubjectConfiguration](./react-native-tracker.subjectconfiguration.md) > [userId](./react-native-tracker.subjectconfiguration.userid.md) 4 | 5 | ## SubjectConfiguration.userId property 6 | 7 | Business-defined user ID for this user 8 | 9 | Signature: 10 | 11 | ```typescript 12 | userId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.timestamp.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Timestamp](./react-native-tracker.timestamp.md) 4 | 5 | ## Timestamp type 6 | 7 | Algebraic datatype representing possible timestamp type choice 8 | 9 | Signature: 10 | 11 | ```typescript 12 | type Timestamp = TrueTimestamp | DeviceTimestamp | number; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.timingprops.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TimingProps](./react-native-tracker.timingprops.md) 4 | 5 | ## TimingProps type 6 | 7 | Timing event properties 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type TimingProps = { 13 | category: string; 14 | variable: string; 15 | timing: number; 16 | label?: string; 17 | }; 18 | ``` 19 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.appid.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [appId](./react-native-tracker.trackerconfiguration.appid.md) 4 | 5 | ## TrackerConfiguration.appId property 6 | 7 | The application ID 8 | 9 | Signature: 10 | 11 | ```typescript 12 | appId?: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.deviceplatform.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [devicePlatform](./react-native-tracker.trackerconfiguration.deviceplatform.md) 4 | 5 | ## TrackerConfiguration.devicePlatform property 6 | 7 | The device platform the tracker runs on. 8 | 9 | Signature: 10 | 11 | ```typescript 12 | devicePlatform?: Platform; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.namespace.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [namespace](./react-native-tracker.trackerconfiguration.namespace.md) 4 | 5 | ## TrackerConfiguration.namespace property 6 | 7 | The namespace of the tracker 8 | 9 | Signature: 10 | 11 | ```typescript 12 | namespace: string; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.trackerconfiguration.plugins.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrackerConfiguration](./react-native-tracker.trackerconfiguration.md) > [plugins](./react-native-tracker.trackerconfiguration.plugins.md) 4 | 5 | ## TrackerConfiguration.plugins property 6 | 7 | Inject plugins which will be evaluated for each event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | plugins?: BrowserPlugin[]; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.trigger.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [Trigger](./react-native-tracker.trigger.md) 4 | 5 | ## Trigger type 6 | 7 | Trigger for MessageNotification event 8 | 9 | Signature: 10 | 11 | ```typescript 12 | export declare type Trigger = 'push' | 'location' | 'calendar' | 'timeInterval' | 'other'; 13 | ``` 14 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.truetimestamp.type.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) > [type](./react-native-tracker.truetimestamp.type.md) 4 | 5 | ## TrueTimestamp.type property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly type: "ttm"; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.truetimestamp.value.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [TrueTimestamp](./react-native-tracker.truetimestamp.md) > [value](./react-native-tracker.truetimestamp.value.md) 4 | 5 | ## TrueTimestamp.value property 6 | 7 | Signature: 8 | 9 | ```typescript 10 | readonly value: number; 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/docs/react-native-tracker/markdown/react-native-tracker.version.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | [Home](./index.md) > [@snowplow/react-native-tracker](./react-native-tracker.md) > [version](./react-native-tracker.version.md) 4 | 5 | ## version variable 6 | 7 | Signature: 8 | 9 | ```typescript 10 | version: string 11 | ``` 12 | -------------------------------------------------------------------------------- /api-docs/sidebars.js: -------------------------------------------------------------------------------- 1 | // @ts-check 2 | 3 | /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 4 | const sidebars = { 5 | tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], 6 | }; 7 | 8 | export default sidebars; 9 | -------------------------------------------------------------------------------- /api-docs/src/pages/index.module.css: -------------------------------------------------------------------------------- 1 | /** 2 | * CSS files with the .module.css suffix will be treated as CSS modules 3 | * and scoped locally. 4 | */ 5 | 6 | .heroBanner { 7 | padding: 4rem 0; 8 | text-align: center; 9 | position: relative; 10 | overflow: hidden; 11 | } 12 | 13 | @media screen and (max-width: 996px) { 14 | .heroBanner { 15 | padding: 2rem; 16 | } 17 | } 18 | 19 | .buttons { 20 | display: flex; 21 | align-items: center; 22 | justify-content: center; 23 | } 24 | -------------------------------------------------------------------------------- /api-docs/static/.nojekyll: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowplow/snowplow-javascript-tracker/25ac7f9e9ca9e057ca2850a4e6e2679cddb81385/api-docs/static/.nojekyll -------------------------------------------------------------------------------- /api-docs/static/img/favicon.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowplow/snowplow-javascript-tracker/25ac7f9e9ca9e057ca2850a4e6e2679cddb81385/api-docs/static/img/favicon.ico -------------------------------------------------------------------------------- /common/autoinstallers/rush-prettier/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "rush-prettier", 3 | "version": "1.0.0", 4 | "private": true, 5 | "dependencies": { 6 | "prettier": "^2.5.1", 7 | "pretty-quick": "^3.1.3" 8 | } 9 | } 10 | -------------------------------------------------------------------------------- /common/changes/@snowplow/browser-plugin-browser-features/feature-revise-default-plugins_2023-02-06-13-02.json: -------------------------------------------------------------------------------- 1 | { 2 | "changes": [ 3 | { 4 | "packageName": "@snowplow/browser-plugin-browser-features", 5 | "comment": "Add deprecation warning", 6 | "type": "none" 7 | } 8 | ], 9 | "packageName": "@snowplow/browser-plugin-browser-features" 10 | } -------------------------------------------------------------------------------- /common/changes/@snowplow/browser-plugin-consent/feature-1138-upgrade-uuid_2023-01-10-10-11.json: -------------------------------------------------------------------------------- 1 | { 2 | "changes": [ 3 | { 4 | "packageName": "@snowplow/browser-plugin-consent", 5 | "comment": "", 6 | "type": "none" 7 | } 8 | ], 9 | "packageName": "@snowplow/browser-plugin-consent" 10 | } -------------------------------------------------------------------------------- /common/changes/@snowplow/browser-plugin-consent/feature-revise-default-plugins_2023-02-06-08-43.json: -------------------------------------------------------------------------------- 1 | { 2 | "changes": [ 3 | { 4 | "packageName": "@snowplow/browser-plugin-consent", 5 | "comment": "Add deprecation warning", 6 | "type": "none" 7 | } 8 | ], 9 | "packageName": "@snowplow/browser-plugin-consent" 10 | } -------------------------------------------------------------------------------- /common/changes/@snowplow/browser-plugin-ecommerce/feature-1138-upgrade-uuid_2023-01-10-10-11.json: -------------------------------------------------------------------------------- 1 | { 2 | "changes": [ 3 | { 4 | "packageName": "@snowplow/browser-plugin-ecommerce", 5 | "comment": "", 6 | "type": "none" 7 | } 8 | ], 9 | "packageName": "@snowplow/browser-plugin-ecommerce" 10 | } -------------------------------------------------------------------------------- /common/changes/@snowplow/browser-plugin-ecommerce/feature-revise-default-plugins_2023-02-06-08-43.json: -------------------------------------------------------------------------------- 1 | { 2 | "changes": [ 3 | { 4 | "packageName": "@snowplow/browser-plugin-ecommerce", 5 | "comment": "Add deprecation warning", 6 | "type": "none" 7 | } 8 | ], 9 | "packageName": "@snowplow/browser-plugin-ecommerce" 10 | } -------------------------------------------------------------------------------- /common/changes/@snowplow/browser-plugin-optimizely/feature-revise-default-plugins_2023-02-06-13-02.json: -------------------------------------------------------------------------------- 1 | { 2 | "changes": [ 3 | { 4 | "packageName": "@snowplow/browser-plugin-optimizely", 5 | "comment": "Add deprecation warning", 6 | "type": "none" 7 | } 8 | ], 9 | "packageName": "@snowplow/browser-plugin-optimizely" 10 | } -------------------------------------------------------------------------------- /common/config/rush/nonbrowser-approved-packages.json: -------------------------------------------------------------------------------- 1 | // DO NOT ADD COMMENTS IN THIS FILE. They will be lost when the Rush tool resaves it. 2 | { 3 | "$schema": "https://developer.microsoft.com/json-schemas/rush/v5/approved-packages.schema.json", 4 | "packages": [] 5 | } 6 | -------------------------------------------------------------------------------- /common/config/rush/repo-state.json: -------------------------------------------------------------------------------- 1 | // DO NOT MODIFY THIS FILE MANUALLY BUT DO COMMIT IT. It is generated and used by Rush. 2 | { 3 | "pnpmShrinkwrapHash": "1bbfee8474092dd7a04f769c89f237e4c74bfbb5", 4 | "preferredVersionsHash": "bf21a9e8fbc5a3846fb05b4fa0859e0917b2202f" 5 | } 6 | -------------------------------------------------------------------------------- /common/media/snowplow_logo.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowplow/snowplow-javascript-tracker/25ac7f9e9ca9e057ca2850a4e6e2679cddb81385/common/media/snowplow_logo.png -------------------------------------------------------------------------------- /libraries/browser-tracker-core/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 6 | testEnvironmentOptions: { 7 | url: 'https://snowplow-js-tracker.local/test/page.html', 8 | referrer: 'https://example.com/', 9 | }, 10 | }; 11 | -------------------------------------------------------------------------------- /libraries/browser-tracker-core/src/tracker/schemata.ts: -------------------------------------------------------------------------------- 1 | export const WEB_PAGE_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/web_page/jsonschema/1-0-0'; 2 | export const BROWSER_CONTEXT_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/browser_context/jsonschema/2-0-0'; 3 | export const CLIENT_SESSION_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/client_session/jsonschema/1-0-2'; 4 | export const APPLICATION_CONTEXT_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/application/jsonschema/1-0-0'; 5 | -------------------------------------------------------------------------------- /libraries/browser-tracker-core/test/tracker/__snapshots__/browser_context.test.ts.snap: -------------------------------------------------------------------------------- 1 | // Jest Snapshot v1, https://goo.gl/fbAQLP 2 | 3 | exports[`Browser context: Adds the browser context entity when \`contexts: { browser: true }\` is passed 1`] = ` 4 | Object { 5 | "browserLanguage": "en-US", 6 | "colorDepth": 24, 7 | "cookiesEnabled": true, 8 | "devicePixelRatio": 1, 9 | "documentLanguage": "", 10 | "documentSize": "0x0", 11 | "hardwareConcurrency": 1, 12 | "online": true, 13 | "resolution": "0x0", 14 | "viewport": "1024x768", 15 | } 16 | `; 17 | -------------------------------------------------------------------------------- /libraries/browser-tracker-core/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "noImplicitThis": false /* Allows for guard to use 'this' */ 5 | } 6 | } 7 | -------------------------------------------------------------------------------- /libraries/tracker-core/src/event_store_payload.ts: -------------------------------------------------------------------------------- 1 | import { Payload } from "./payload"; 2 | 3 | export interface EventStorePayload { 4 | /** 5 | * The event payload to be stored 6 | */ 7 | payload: Payload; 8 | 9 | /** 10 | * If the request should undergo server anonymization. 11 | * @defaultValue false 12 | */ 13 | svrAnon?: boolean; 14 | } 15 | 16 | /** 17 | * Create a new EventStorePayload 18 | */ 19 | export function newEventStorePayload({ 20 | payload, 21 | svrAnon = false, 22 | }: EventStorePayload): EventStorePayload { 23 | return { 24 | payload, 25 | svrAnon, 26 | }; 27 | } 28 | -------------------------------------------------------------------------------- /libraries/tracker-core/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const PAYLOAD_DATA_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/payload_data/jsonschema/1-0-4'; 2 | -------------------------------------------------------------------------------- /libraries/tracker-core/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-ad-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-ad-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-button-click-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | }; 6 | -------------------------------------------------------------------------------- /plugins/browser-plugin-button-click-tracking/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-button-click-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-client-hints/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-client-hints/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-debugger/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-element-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-element-tracking/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-element-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-enhanced-consent/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-enhanced-consent/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-enhanced-consent/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const CONSENT_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/consent_preferences/jsonschema/1-0-0'; 2 | export const CMP_VISIBLE_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/cmp_visible/jsonschema/1-0-0'; 3 | -------------------------------------------------------------------------------- /plugins/browser-plugin-enhanced-consent/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-enhanced-ecommerce/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-enhanced-ecommerce/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-error-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | testEnvironmentOptions: { resources: 'usable', runScripts: 'dangerously' }, 7 | }; 8 | -------------------------------------------------------------------------------- /plugins/browser-plugin-error-tracking/src/util.ts: -------------------------------------------------------------------------------- 1 | /** 2 | * Truncate string if it's longer than 8192 chars 3 | * 4 | * @param string - The stack trace to truncate 5 | * @param maxLength - The maximum length of the truncated string. Default = 8192 6 | * @returns The truncated string 7 | */ 8 | export function truncateString(string?: string, maxLength: number = 8192): string | undefined { 9 | if (string && string.length > maxLength) { 10 | const truncatedString = string.substring(0, maxLength); 11 | return truncatedString; 12 | } 13 | 14 | return string; 15 | } 16 | -------------------------------------------------------------------------------- /plugins/browser-plugin-error-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-event-specifications/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-event-specifications/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const EVENT_SPECIFICATION_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/event_specification/jsonschema/1-0-0'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-event-specifications/src/utils.ts: -------------------------------------------------------------------------------- 1 | import { EVENT_SPECIFICATION_SCHEMA } from './schemata'; 2 | 3 | export function createEventSpecificationContext(eventSpecificationId: string) { 4 | return { 5 | schema: EVENT_SPECIFICATION_SCHEMA, 6 | data: { 7 | id: eventSpecificationId, 8 | }, 9 | }; 10 | } 11 | -------------------------------------------------------------------------------- /plugins/browser-plugin-event-specifications/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-focalmeter/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-focalmeter/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-form-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-form-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-ga-cookies/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-ga-cookies/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const UNIVERSAL_ANALYTICS_COOKIES_SCHEMA = 'iglu:com.google.analytics/cookies/jsonschema/1-0-0'; 2 | export const GOOGLE_ANALYTICS_4_COOKIES_SCHEMA = 'iglu:com.google.ga4/cookies/jsonschema/1-0-0'; 3 | -------------------------------------------------------------------------------- /plugins/browser-plugin-ga-cookies/src/types.ts: -------------------------------------------------------------------------------- 1 | export interface UACookies { 2 | __utma?: string; 3 | __utmb?: string; 4 | __utmc?: string; 5 | __utmv?: string; 6 | __utmz?: string; 7 | _ga?: string; 8 | [key: string]: string | undefined; 9 | } 10 | 11 | export interface GA4Cookies { 12 | _ga?: string; 13 | session_cookies?: GA4SessionCookies[]; 14 | [key: string]: unknown; 15 | } 16 | 17 | export interface GA4SessionCookies { 18 | measurement_id: string; 19 | session_cookie?: string; 20 | } 21 | -------------------------------------------------------------------------------- /plugins/browser-plugin-ga-cookies/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-geolocation/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-link-click-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-link-click-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-media-tracking/.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | -------------------------------------------------------------------------------- /plugins/browser-plugin-media-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-media-tracking/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-media/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-media/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-media/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-optimizely-x/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-performance-navigation-timing/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-performance-navigation-timing/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const PERFORMANCE_NAVIGATION_TIMING_SCHEMA = 'iglu:org.w3/PerformanceNavigationTiming/jsonschema/1-0-0'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-performance-navigation-timing/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-performance-timing/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-performance-timing/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-privacy-sandbox/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-privacy-sandbox/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const PRIVACY_SANDBOX_TOPICS_SCHEMA = 'iglu:com.google.privacysandbox/topics/jsonschema/1-0-0'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-privacy-sandbox/src/types.ts: -------------------------------------------------------------------------------- 1 | export type PrivacySandboxTopic = { 2 | configVersion: string; 3 | modelVersion: string; 4 | taxonomyVersion: string; 5 | topic: number; 6 | version: string; 7 | }; 8 | 9 | export type Topic = Pick; 10 | 11 | export type BrowsingTopicsOptions = { 12 | /* Enabling will not cause the current page to be included in the weekly epoch calculation or update the list of topics observed for the caller. */ 13 | skipObservation?: boolean; 14 | }; 15 | -------------------------------------------------------------------------------- /plugins/browser-plugin-privacy-sandbox/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-screen-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-screen-tracking/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | export * from './types'; 3 | -------------------------------------------------------------------------------- /plugins/browser-plugin-screen-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-site-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-site-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-snowplow-ecommerce/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-snowplow-ecommerce/src/index.ts: -------------------------------------------------------------------------------- 1 | export * from './api'; 2 | export * from './ua/api'; 3 | export * from './ga4/api'; 4 | export * from './types'; 5 | -------------------------------------------------------------------------------- /plugins/browser-plugin-snowplow-ecommerce/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-timezone/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-timezone/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-vimeo-tracking/.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | build -------------------------------------------------------------------------------- /plugins/browser-plugin-vimeo-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | }; 6 | -------------------------------------------------------------------------------- /plugins/browser-plugin-vimeo-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-web-vitals/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-web-vitals/src/schemata.ts: -------------------------------------------------------------------------------- 1 | export const WEB_VITALS_SCHEMA = 'iglu:com.snowplowanalytics.snowplow/web_vitals/jsonschema/1-0-0'; 2 | -------------------------------------------------------------------------------- /plugins/browser-plugin-web-vitals/src/types.ts: -------------------------------------------------------------------------------- 1 | import type { MetricType, Metric, onCLS, onLCP, onFID, onFCP, onINP, onTTFB } from 'web-vitals'; 2 | 3 | export interface WebVitals { 4 | onCLS?: typeof onCLS; 5 | onFID?: typeof onFID; 6 | onLCP?: typeof onLCP; 7 | onFCP?: typeof onFCP; 8 | onINP?: typeof onINP; 9 | onTTFB?: typeof onTTFB; 10 | } 11 | 12 | declare global { 13 | interface Window { 14 | webVitals?: WebVitals; 15 | } 16 | } 17 | 18 | export { Metric, MetricType }; 19 | -------------------------------------------------------------------------------- /plugins/browser-plugin-web-vitals/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-webview/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 5 | testEnvironment: 'jest-environment-jsdom-global', 6 | }; 7 | -------------------------------------------------------------------------------- /plugins/browser-plugin-webview/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /plugins/browser-plugin-youtube-tracking/.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | dist 3 | build -------------------------------------------------------------------------------- /plugins/browser-plugin-youtube-tracking/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | }; 6 | -------------------------------------------------------------------------------- /plugins/browser-plugin-youtube-tracking/src/index.ts: -------------------------------------------------------------------------------- 1 | export type { YouTubeMediaTrackingConfiguration } from './types'; 2 | 3 | export { 4 | YouTubeTrackingPlugin, 5 | startYouTubeTracking, 6 | endYouTubeTracking, 7 | enableYouTubeTracking, 8 | disableYouTubeTracking, 9 | trackYouTubeSelfDescribingEvent, 10 | } from './initialization'; 11 | -------------------------------------------------------------------------------- /plugins/browser-plugin-youtube-tracking/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | "typeRoots": ["node_modules/@types"], 5 | "types": ["youtube", "jest"] 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /setupTestGlobals.ts: -------------------------------------------------------------------------------- 1 | import 'whatwg-fetch'; 2 | const nodeCrypto = require('crypto'); 3 | 4 | // @ts-expect-error 5 | global.crypto = { 6 | getRandomValues: function (buffer) { 7 | return nodeCrypto.randomFillSync(buffer); 8 | }, 9 | }; 10 | 11 | global.console = { 12 | ...console, 13 | log: jest.fn(), 14 | debug: jest.fn(), 15 | info: jest.fn(), 16 | warn: jest.fn(), 17 | error: jest.fn(), 18 | }; 19 | -------------------------------------------------------------------------------- /trackers/browser-tracker/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 6 | testEnvironmentOptions: { 7 | url: 'https://snowplow-js-tracker.local/test/page.html', 8 | referrer: 'https://example.com/', 9 | innerWidth: 1024, 10 | innerHeight: 768, 11 | }, 12 | }; 13 | -------------------------------------------------------------------------------- /trackers/browser-tracker/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json" 3 | } 4 | -------------------------------------------------------------------------------- /trackers/javascript-tracker/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'ts-jest', 3 | reporters: ['jest-standard-reporter'], 4 | testEnvironment: 'jest-environment-jsdom-global', 5 | }; 6 | -------------------------------------------------------------------------------- /trackers/javascript-tracker/test/micro-config/iglu.json: -------------------------------------------------------------------------------- 1 | { 2 | "schema": "iglu:com.snowplowanalytics.iglu/resolver-config/jsonschema/1-0-0", 3 | "data": { 4 | "cacheSize": 500, 5 | "repositories": [ 6 | { 7 | "name": "Iglu Central", 8 | "priority": 0, 9 | "vendorPrefixes": ["com.snowplowanalytics"], 10 | "connection": { 11 | "http": { 12 | "uri": "http://iglucentral.com" 13 | } 14 | } 15 | } 16 | ] 17 | } 18 | } 19 | -------------------------------------------------------------------------------- /trackers/javascript-tracker/test/pages/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | Index page to keep ie happy 4 | 5 | 6 | -------------------------------------------------------------------------------- /trackers/javascript-tracker/test/pages/media/test-track.vtt: -------------------------------------------------------------------------------- 1 | WEBVTT 2 | 3 | 00:01.000 --> 00:04.000 4 | - Test Track. -------------------------------------------------------------------------------- /trackers/javascript-tracker/test/pages/media/test-video.mp4: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/snowplow/snowplow-javascript-tracker/25ac7f9e9ca9e057ca2850a4e6e2679cddb81385/trackers/javascript-tracker/test/pages/media/test-video.mp4 -------------------------------------------------------------------------------- /trackers/javascript-tracker/test/pages/multi_page_cookies/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | Cookies test page 6 | 7 | 8 | 9 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /trackers/javascript-tracker/test/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../tsconfig.json", 3 | "compilerOptions": { 4 | "types": [ 5 | "node", 6 | "@wdio/types", 7 | "@wdio/globals/types", 8 | "@wdio/jasmine-framework", 9 | "jest", 10 | "@wdio/shared-store-service", 11 | "youtube" 12 | ] 13 | }, 14 | "include": ["./**/*.test.ts"] 15 | } 16 | -------------------------------------------------------------------------------- /trackers/javascript-tracker/tsconfig.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "../../tsconfig.json", 3 | "compilerOptions": { 4 | /* Basic Options */ 5 | "declaration": false /* Generates corresponding '.d.ts' file. */ 6 | } 7 | } 8 | -------------------------------------------------------------------------------- /trackers/react-native-tracker/babel.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | presets: [ 3 | ['module:react-native-builder-bob/babel-preset', { modules: 'commonjs' }], 4 | ], 5 | }; 6 | -------------------------------------------------------------------------------- /trackers/react-native-tracker/jest.config.js: -------------------------------------------------------------------------------- 1 | module.exports = { 2 | preset: 'react-native', 3 | reporters: ['jest-standard-reporter'], 4 | transformIgnorePatterns: [], 5 | setupFilesAfterEnv: ['../../setupTestGlobals.ts'], 6 | modulePathIgnorePatterns: ['/dist/'], 7 | }; 8 | -------------------------------------------------------------------------------- /trackers/react-native-tracker/src/__mocks__/@react-native-async-storage/async-storage.js: -------------------------------------------------------------------------------- 1 | import AsyncStorage from "@react-native-async-storage/async-storage/jest/async-storage-mock"; 2 | export default AsyncStorage; 3 | -------------------------------------------------------------------------------- /trackers/react-native-tracker/src/index.ts: -------------------------------------------------------------------------------- 1 | // polyfill for Web crypto module required by uuidjs 2 | import 'react-native-get-random-values'; 3 | 4 | export * from './types'; 5 | export { newTracker, getTracker, getAllTrackers, removeTracker, removeAllTrackers } from './tracker'; 6 | export * from './web_view_interface'; 7 | -------------------------------------------------------------------------------- /trackers/react-native-tracker/tsconfig.build.json: -------------------------------------------------------------------------------- 1 | { 2 | "extends": "./tsconfig", 3 | "exclude": ["dist", "test"] 4 | } 5 | --------------------------------------------------------------------------------