@groupby/elements-gb-tracker-plugin

GroupBy Elements GB Tracker Plugin

This package contains the GroupBy Tracker Plugin class. Its purpose is to provide automatic beaconing integration with Groupby.

Prerequisites

This plugin depends on the following Elements plugins:

• dom_events

These plugins must be registered either before or in the same batch as this plugin.

Usage

To use the plugin, simply instantiate it and register it with Core:

const gbTrackerPlugin = new GbTrackerPlugin({
  customerId: 'my-customer-id',
  area: 'some-area',
  collection: 'some-collection',
});
core.register(gbTrackerPlugin);

It accepts a mandatory customerId. It also accepts optional area and collection arguments to handle tracking actions against specific areas and collections.

Additionally, the plugin will automatically listen for and act on beacon events. It is designed to work with the other plugins in the Logic Layer.

The plugin registers an instance of the gb-tracker client with Core.

Events

This plugin listens for a number of events. These events are defined in the @groupby/elements-events package.

Received

• BEACON_SEARCH: When received, a GroupBy Auto Search beacon is triggered.

Changelog

[0.1.0] - 2019-11-28

Package versions:

• @groupby/elements-cache-driver-plugin: 0.1.0
• @groupby/elements-cache-plugin: 0.1.0
• @groupby/elements-core: 0.1.0
• @groupby/elements-dom-events-plugin: 0.1.0
• @groupby/elements-sayt-driver-plugin: 0.1.0
• @groupby/elements-sayt-plugin: 0.1.0
• @groupby/elements-search-driver-plugin: 0.1.0
• @groupby/elements-search-plugin: 0.1.0

Added

cache-driver-plugin

• SFX-158: Added the CacheDriverPlugin module.

cache-plugin

• SFX-158: Added the CachePlugin module.

core

• SFX-99: Added the Core module and related plugin interfaces.
  • The Core module manages the registration and unregistration of plugins.

dom-events-plugin

• SFX-157: Added the DomEventsPlugin module.

sayt-driver-plugin

• SFX-160: Added the SaytDriverPlugin module.
  • The SaytDriverPlugin module acts as a mediator between the Logic and View layers for prebuilt modules.
  • SFX-248: The @groupby/elements-events package is used for event names and payload interfaces.
  • SFX-333: Added retrieval and event emission of products.
  • SFX-385: Added the option to supply a custom product transformer.

sayt-plugin

• SFX-156: Added the SaytPlugin module.
  • It exposes an instance of the Sayt client library to Core.

search-driver-plugin

• SFX-159: Added the SearchDriverPlugin module.
  • This plugin listens for a SEARCH_REQUEST_EVENT event, makes a search request using the GroupBy API, then dispatches a SEARCH_RESPONSE_EVENT event containing the response.
  • SFX-248: The @groupby/elements-events package is used for event names and payload interfaces.

search-plugin

• SFX-155: Added the SearchDataSourcePlugin module.
  • It exposes an instance of the BrowserBridge from the Search api client library to Core.