feat(store_pagespixel): add legacy analytics support

README.md

@@ -28,29 +28,72 @@ First, install the library via [npm](https://www.npmjs.com/get-npm):
 npm install @yext/analytics
 ```
 
-Next, import and initialize the library in your application.
+Next, import and initialize the library in your application.  Yext currently has different analytics reporting features 
+between Search and Pages and so they have slightly different interfaces for working with them.  There is also a combined
+interface that you can use when you are building a Search experience entirely on Pages (e.g. a Locator or a Help Site).
 
-The experienceKey will come from your Answers experience on yext.com. You can signup for a free trial at [https://www.yext.com/free-trial/](https://www.yext.com/free-trial/).
+### Combined Analytics
+For a typical locator you will be using both Search and Pages analytics.
+
+The experienceKey will come from your Answers experience on yext.com. You can signup for a free trial at
+[https://www.yext.com/free-trial/](https://www.yext.com/free-trial/).
+
+The businessId and siteId can both be found in your account.
 
 ```ts
 import { provideAnalytics } from '@yext/analytics';
 
 const analytics = provideAnalytics({
   experienceKey: '<your experience key>',
   experienceVersion: 'PRODUCTION',
-  businessId: 123456,
+  businessId: 123456, // this comes from the url of your Yext account
+  featureId: 'My Locator', // the name of the feature in your features.json
+  pageType: 'locator', // the type of page, can be 'entity', 'directory', 'locator', or 'static'
+  product: 'storepages',
+  production: false, // set to true if you are in the production environment
+  siteId: 654321, // the id of your site, you can find this in the url of your deploy page
+});
+```
+
+Now that we are initialized, we can add a page view.
+
+```ts
+analytics.pageView();
+```
+
+and if a user clicks on a search result, we can fire an appropriate event.
+
+```ts
+analytics.report({
+  type: 'CTA_CLICK',
+  entityId: '1',
+  verticalKey: 'people',
+  searcher: 'VERTICAL',
+  queryId: '12345678-1234-1234-1234-123456789012'
+});
+```
+
+### Search Analytics
+
+```ts
+import { provideSearchAnalytics } from '@yext/analytics';
+
+const searchAnalytics = provideSearchAnalytics({
+  experienceKey: '<your experience key>',
+  experienceVersion: 'PRODUCTION',
+  businessId: 123456, // this comes from the url of your Yext account
 });
 ```
 
 To use the library with Node, use the following import instead:
 ```ts
-const { provideAnalytics } = require('@yext/analytics');
+const { provideSearchAnalytics } = require('@yext/analytics');
 ``` 
 
-Now that the analytics reporter is initialized, let's fire off an event:
+Now that the search analytics reporter is initialized, let's fire off an event:
 
 ```ts
-analytics.report({
+searchAnalytics.report({
   type: 'CTA_CLICK',
   entityId: '1',
   verticalKey: 'people',
@@ -59,15 +102,41 @@ analytics.report({
 });
 ```
 
-### Analytics Event Types
+### Pages Analytics
+
+```ts
+import {providePagesAnalytics} from '@yext/analytics';
+
+const pagesAnalytics = providePagesAnalytics({
+  businessId: 123456, // this comes from the url of your Yext account 
+  featureId: 'My Page Set', // the name of the feature in your features.json
+  pageType: 'entity', // the type of page, can be 'entity', 'directory', 'locator', or 'static'
+  product: 'storepages',
+  production: false, // set to true if you are in the production environment
+  siteId: 654321, // the id of your site, you can find this in the url of your deploy page
+  ids: [90210], // if your pageType is 'entity' this is required, and it is the uid of the entity 
+});
+```
+
+Now that the pages analytics reporter is initialized, we can fire a pageview:
+```ts
+pagesAnalytics.pageView();
+```
+
+We can also fire an event on any other type of user interaction and give it a custom name:
+```ts
+pagesAnalytics.userInteraction('somebuttonclick');
+```
+
+#### Search Analytics Event Types
 When specifying the analytics type, either the [AnalyticsEventType](./docs/analytics.analyticseventtype.md) enum
 or its corresponding string can be specified. For example, you can specify the 'CTA_CLICK' event with either 'CTA_CLICK' or
 with `AnalyticsEventType.CtaClick`. Once the event type is specified, TypeScript is able to enforce the required and
 optional properties for that event type.
 
 And that's it! See **[our documentation](./docs/analytics.md)** for a full list of analytics events.
 
-### Module support
+## Module support
 - The ESM (ES6) build will be used automatically by module bundlers that support it (e.g. Webpack). It can be specified directly by importing `@yext/analytics/lib/esm`
 - The CommonJS build will be used automatically by Node, but it can be specified directly by importing `@yext/analytics/lib/commonjs`
 

docs/analytics.analyticsconfig.md

@@ -4,21 +4,12 @@
 
 ## AnalyticsConfig interface
 
-The main configuration options for Analytics.
+Combined Analytics Config for tracking Search & Pages on the same site
 
 <b>Signature:</b>
 
 ```typescript
-export interface AnalyticsConfig 
+export interface AnalyticsConfig extends SearchAnalyticsConfig, PagesAnalyticsConfig 
 ```
-
-## Properties
-
-|  Property | Type | Description |
-|  --- | --- | --- |
-|  [businessId](./analytics.analyticsconfig.businessid.md) | number | The businessId of the answers experience. |
-|  [domain?](./analytics.analyticsconfig.domain.md) | string | <i>(Optional)</i> The domain to send the requests to. |
-|  [experienceKey](./analytics.analyticsconfig.experiencekey.md) | string | The experience key of the answers experience. |
-|  [experienceVersion](./analytics.analyticsconfig.experienceversion.md) | 'PRODUCTION' \| 'STAGING' \| string | The experience version of the answers experience. |
-|  [visitor?](./analytics.analyticsconfig.visitor.md) | [Visitor](./analytics.visitor.md) | <i>(Optional)</i> Information used to associate analytics with a particular user. |
+<b>Extends:</b> [SearchAnalyticsConfig](./analytics.searchanalyticsconfig.md)<!-- -->, [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md)
 

docs/analytics.analyticsservice.md

@@ -4,18 +4,12 @@
 
 ## AnalyticsService interface
 
-A service for reporting analytics events.
+A service for reporting both pages and search analytics events.
 
 <b>Signature:</b>
 
 ```typescript
-export interface AnalyticsService 
+export interface AnalyticsService extends SearchAnalyticsService, PagesAnalyticsService 
 ```
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [report(event, additionalRequestAttributes)](./analytics.analyticsservice.report.md) | Reports an analytics event. Will perform a promise rejection if the API response contains an error. |
-|  [setVisitor(visitor)](./analytics.analyticsservice.setvisitor.md) | Sets the [Visitor](./analytics.visitor.md) object which is included with each subsequent request. |
+<b>Extends:</b> [SearchAnalyticsService](./analytics.searchanalyticsservice.md)<!-- -->, [PagesAnalyticsService](./analytics.pagesanalyticsservice.md)
 

docs/analytics.md

@@ -4,6 +4,12 @@
 
 ## analytics package
 
+## Classes
+
+|  Class | Description |
+|  --- | --- |
+|  [PagesEventDetails](./analytics.pageseventdetails.md) | A fully detailed Pages Event |
+
 ## Enumerations
 
 |  Enumeration | Description |
@@ -14,22 +20,29 @@
 
 |  Function | Description |
 |  --- | --- |
-|  [provideAnalytics(config)](./analytics.provideanalytics.md) | The entrypoint to the analytics library. |
+|  [provideAnalytics(config)](./analytics.provideanalytics.md) | Provides a combined Pages & Search Analytics service given a joint config |
+|  [providePagesAnalytics(config)](./analytics.providepagesanalytics.md) | Provides a combined Pages Analytics service given a Pages specific config |
+|  [provideSearchAnalytics(config)](./analytics.providesearchanalytics.md) | Provides a combined Search Analytics service given a Search specific config |
 
 ## Interfaces
 
 |  Interface | Description |
 |  --- | --- |
 |  [AccordionToggleEvent](./analytics.accordiontoggleevent.md) | Event for expanding or collapsing an accordion row. Commonly used for FAQs. |
 |  [AllTabNavigationEvent](./analytics.alltabnavigationevent.md) | Event for navigating to the 'all' tab (a universal page). |
-|  [AnalyticsConfig](./analytics.analyticsconfig.md) | The main configuration options for Analytics. |
+|  [AnalyticsConfig](./analytics.analyticsconfig.md) | Combined Analytics Config for tracking Search & Pages on the same site |
 |  [AnalyticsPayload](./analytics.analyticspayload.md) | The shape of the data which is sent during an analytics request. |
-|  [AnalyticsService](./analytics.analyticsservice.md) | A service for reporting analytics events. |
+|  [AnalyticsService](./analytics.analyticsservice.md) | A service for reporting both pages and search analytics events. |
 |  [AutocompleteEvent](./analytics.autocompleteevent.md) | Event for autocomplete selection. |
 |  [CtaEvent](./analytics.ctaevent.md) | A call to action analytics event. |
+|  [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) | The main configuration options for Pages Analytics |
+|  [PagesAnalyticsService](./analytics.pagesanalyticsservice.md) | A service for reporting pages analytics events. |
+|  [PagesEvent](./analytics.pagesevent.md) | An event from the Pages system |
 |  [PaginationEvent](./analytics.paginationevent.md) | Event for pagination interaction. |
 |  [QuestionSubmissionEvent](./analytics.questionsubmissionevent.md) | Event for submitting a question. |
 |  [ScrollEvent](./analytics.scrollevent.md) | Event for scrolling to the bottom of the page. |
+|  [SearchAnalyticsConfig](./analytics.searchanalyticsconfig.md) | The main configuration options for Search Analytics. |
+|  [SearchAnalyticsService](./analytics.searchanalyticsservice.md) | A service for reporting search analytics events. |
 |  [SearchBarImpressionEvent](./analytics.searchbarimpressionevent.md) | Event for expanding or collapsing an accordion row. |
 |  [SearchClearEvent](./analytics.searchclearevent.md) | Event for clicking on the button to clear the search input. |
 |  [SearchDurationEvent](./analytics.searchdurationevent.md) | Event used to calculate the duration of a search. |
@@ -43,7 +56,7 @@
 
 |  Type Alias | Description |
 |  --- | --- |
-|  [AnalyticsEvent](./analytics.analyticsevent.md) | An analytics event. |
 |  [EnumOrString](./analytics.enumorstring.md) | A TypeScript utility type which creates a union of an enum member and its string representation. |
+|  [SearchAnalyticsEvent](./analytics.searchanalyticsevent.md) | An analytics event. |
 |  [Searcher](./analytics.searcher.md) | Whether the search occurred on universal or vertical search. |
 

docs/analytics.pagesanalyticsconfig.featureid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [featureId](./analytics.pagesanalyticsconfig.featureid.md)
+
+## PagesAnalyticsConfig.featureId property
+
+The identifier of the feature within the site, typically 'name' key of the feature in the features.json file
+
+<b>Signature:</b>
+
+```typescript
+featureId: string;
+```

docs/analytics.pagesanalyticsconfig.ids.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [ids](./analytics.pagesanalyticsconfig.ids.md)
+
+## PagesAnalyticsConfig.ids property
+
+Yext Internal ID of Entities to Track
+
+<b>Signature:</b>
+
+```typescript
+ids?: number[];
+```

docs/analytics.pagesanalyticsconfig.md

@@ -0,0 +1,28 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md)
+
+## PagesAnalyticsConfig interface
+
+The main configuration options for Pages Analytics
+
+<b>Signature:</b>
+
+```typescript
+export interface PagesAnalyticsConfig extends BaseAnalyticsConfig 
+```
+<b>Extends:</b> BaseAnalyticsConfig
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [featureId](./analytics.pagesanalyticsconfig.featureid.md) | string | The identifier of the feature within the site, typically 'name' key of the feature in the features.json file |
+|  [ids?](./analytics.pagesanalyticsconfig.ids.md) | number\[\] | <i>(Optional)</i> Yext Internal ID of Entities to Track |
+|  [pagesReferrer?](./analytics.pagesanalyticsconfig.pagesreferrer.md) | string | <i>(Optional)</i> The url the user came from will default to window.document.referrer |
+|  [pageType](./analytics.pagesanalyticsconfig.pagetype.md) | 'entity' \| 'directory' \| 'locator' \| 'static' | Page Type The 'Page Type' filter found in analytics report builder Either entity, directory, locator, or static |
+|  [path?](./analytics.pagesanalyticsconfig.path.md) | string | <i>(Optional)</i> The path component of the page url will default to window.location.pathname |
+|  [product](./analytics.pagesanalyticsconfig.product.md) | 'storepages' \| 'sites' | The analytics ID of the version of pages 'storepages' for classic pages 'sites' for the latest version of the platform |
+|  [production](./analytics.pagesanalyticsconfig.production.md) | boolean | Set to true if the environment is production If set to true events will appear in Analytics Reports in your Yext Account |
+|  [siteId](./analytics.pagesanalyticsconfig.siteid.md) | number | The ID of the Pages Site Can be easily found from the url of the Deploy Page in your Yext Account e.g. https://www.yext.com/s/\[businessId\]/yextsites/\[siteid\]/branch/\[branchId\]/deploys/recent |
+

docs/analytics.pagesanalyticsconfig.pagesreferrer.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [pagesReferrer](./analytics.pagesanalyticsconfig.pagesreferrer.md)
+
+## PagesAnalyticsConfig.pagesReferrer property
+
+The url the user came from will default to window.document.referrer
+
+<b>Signature:</b>
+
+```typescript
+pagesReferrer?: string;
+```

docs/analytics.pagesanalyticsconfig.pagetype.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [pageType](./analytics.pagesanalyticsconfig.pagetype.md)
+
+## PagesAnalyticsConfig.pageType property
+
+Page Type The 'Page Type' filter found in analytics report builder Either entity, directory, locator, or static
+
+<b>Signature:</b>
+
+```typescript
+pageType: 'entity' | 'directory' | 'locator' | 'static';
+```

docs/analytics.pagesanalyticsconfig.path.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [path](./analytics.pagesanalyticsconfig.path.md)
+
+## PagesAnalyticsConfig.path property
+
+The path component of the page url will default to window.location.pathname
+
+<b>Signature:</b>
+
+```typescript
+path?: string;
+```

docs/analytics.pagesanalyticsconfig.product.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [product](./analytics.pagesanalyticsconfig.product.md)
+
+## PagesAnalyticsConfig.product property
+
+The analytics ID of the version of pages 'storepages' for classic pages 'sites' for the latest version of the platform
+
+<b>Signature:</b>
+
+```typescript
+product: 'storepages' | 'sites';
+```

docs/analytics.pagesanalyticsconfig.production.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [production](./analytics.pagesanalyticsconfig.production.md)
+
+## PagesAnalyticsConfig.production property
+
+Set to true if the environment is production If set to true events will appear in Analytics Reports in your Yext Account
+
+<b>Signature:</b>
+
+```typescript
+production: boolean;
+```

docs/analytics.pagesanalyticsconfig.siteid.md

@@ -0,0 +1,13 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsConfig](./analytics.pagesanalyticsconfig.md) &gt; [siteId](./analytics.pagesanalyticsconfig.siteid.md)
+
+## PagesAnalyticsConfig.siteId property
+
+The ID of the Pages Site Can be easily found from the url of the Deploy Page in your Yext Account e.g. https://www.yext.com/s/\[businessId\]/yextsites/\[siteid\]/branch/\[branchId\]/deploys/recent
+
+<b>Signature:</b>
+
+```typescript
+siteId: number;
+```

docs/analytics.pagesanalyticsservice.md

@@ -0,0 +1,21 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@yext/analytics](./analytics.md) &gt; [PagesAnalyticsService](./analytics.pagesanalyticsservice.md)
+
+## PagesAnalyticsService interface
+
+A service for reporting pages analytics events.
+
+<b>Signature:</b>
+
+```typescript
+export interface PagesAnalyticsService 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [pageView()](./analytics.pagesanalyticsservice.pageview.md) | Reports a page view event. Will preform a promise rejection if the API contains an error or if the parameters are misconfigured. |
+|  [userInteraction(eventName)](./analytics.pagesanalyticsservice.userinteraction.md) | Reports a user interaction event. Will perform a promis rejection if the API contains an error or if the parameters are misconfigured. |
+