coveo.analytics 2.26.7 → 2.27.1

package/dist/definitions/insight/insightClient.d.ts

@@ -1,81 +1,81 @@
-import { AnalyticsClient, ClientOptions } from '../client/analytics';
-import { SearchEventRequest } from '../events';
-import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
-import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata } from './insightEvents';
-export interface InsightClientProvider {
-    getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
-    getSearchUID: () => string;
-    getBaseMetadata: () => Record<string, any>;
-    getPipeline: () => string;
-    getOriginContext?: () => string;
-    getOriginLevel1: () => string;
-    getOriginLevel2: () => string;
-    getOriginLevel3: () => string;
-    getLanguage: () => string;
-    getIsAnonymous: () => boolean;
-    getFacetState?: () => FacetStateMetadata[];
-}
-export interface InsightClientOptions extends ClientOptions {
-    enableAnalytics: boolean;
-}
-export declare class CoveoInsightClient {
-    private opts;
-    private provider;
-    coveoAnalyticsClient: AnalyticsClient;
-    constructor(opts: Partial<InsightClientOptions>, provider: InsightClientProvider);
-    disable(): void;
-    enable(): void;
-    logInterfaceLoad(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logInterfaceChange(metadata: InsightInterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logStaticFilterDeselect(metadata: InsightStaticFilterToggleValueMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logFetchMoreResults(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logBreadcrumbFacet(metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logBreadcrumbResetAll(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logFacetSelect(metadata: InsightFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logFacetDeselect(metadata: InsightFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logFacetUpdateSort(metadata: InsightFacetSortMeta): Promise<void | import("../events").SearchEventResponse>;
-    logFacetClearAll(metadata: InsightFacetBaseMeta): Promise<void | import("../events").SearchEventResponse>;
-    logFacetShowMore(metadata: InsightFacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
-    logFacetShowLess(metadata: InsightFacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
-    logQueryError(metadata: InsightQueryErrorMeta): Promise<void | import("../events").CustomEventResponse>;
-    logPagerNumber(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logPagerNext(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logPagerPrevious(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logDidYouMeanAutomatic(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logDidYouMeanClick(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logResultsSort(metadata: InsightResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logSearchboxSubmit(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
-    logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logOpenUserActions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logShowPrecedingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logShowFollowingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logCaseAttach(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logCaseDetach(resultUriHash: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logLikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logDislikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logExpandSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logCollapseSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
-    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
-    logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
-    logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
-    logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;
-    private getBaseCustomEventRequest;
-    private getBaseSearchEventRequest;
-    private getBaseEventRequest;
-    private getOrigins;
-    private getClientId;
-}
+import { AnalyticsClient, ClientOptions } from '../client/analytics';
+import { SearchEventRequest } from '../events';
+import { DocumentIdentifier, FacetStateMetadata, PartialDocumentInformation, SearchPageEvents, SmartSnippetDocumentIdentifier, SmartSnippetFeedbackReason, SmartSnippetLinkMeta, SmartSnippetSuggestionMeta } from '../searchPage/searchPageEvents';
+import { ExpandToFullUIMetadata, InsightEvents, InsightFacetMetadata, InsightInterfaceChangeMetadata, InsightStaticFilterToggleValueMetadata, InsightFacetRangeMetadata, InsightCategoryFacetMetadata, CaseMetadata, InsightFacetSortMeta, InsightFacetBaseMeta, InsightQueryErrorMeta, InsightPagerMetadata, InsightResultsSortMetadata, UserActionsDocumentMetadata, UserActionsPageViewMetadata } from './insightEvents';
+export interface InsightClientProvider {
+    getSearchEventRequestPayload: () => Omit<SearchEventRequest, 'actionCause' | 'searchQueryUid'>;
+    getSearchUID: () => string;
+    getBaseMetadata: () => Record<string, any>;
+    getPipeline: () => string;
+    getOriginContext?: () => string;
+    getOriginLevel1: () => string;
+    getOriginLevel2: () => string;
+    getOriginLevel3: () => string;
+    getLanguage: () => string;
+    getIsAnonymous: () => boolean;
+    getFacetState?: () => FacetStateMetadata[];
+}
+export interface InsightClientOptions extends ClientOptions {
+    enableAnalytics: boolean;
+}
+export declare class CoveoInsightClient {
+    private opts;
+    private provider;
+    coveoAnalyticsClient: AnalyticsClient;
+    constructor(opts: Partial<InsightClientOptions>, provider: InsightClientProvider);
+    disable(): void;
+    enable(): void;
+    logInterfaceLoad(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logInterfaceChange(metadata: InsightInterfaceChangeMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logStaticFilterDeselect(metadata: InsightStaticFilterToggleValueMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logFetchMoreResults(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logBreadcrumbFacet(metadata: InsightFacetMetadata | InsightFacetRangeMetadata | InsightCategoryFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logBreadcrumbResetAll(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logFacetSelect(metadata: InsightFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logFacetDeselect(metadata: InsightFacetMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logFacetUpdateSort(metadata: InsightFacetSortMeta): Promise<void | import("../events").SearchEventResponse>;
+    logFacetClearAll(metadata: InsightFacetBaseMeta): Promise<void | import("../events").SearchEventResponse>;
+    logFacetShowMore(metadata: InsightFacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
+    logFacetShowLess(metadata: InsightFacetBaseMeta): Promise<void | import("../events").CustomEventResponse>;
+    logQueryError(metadata: InsightQueryErrorMeta): Promise<void | import("../events").CustomEventResponse>;
+    logPagerNumber(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logPagerNext(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logPagerPrevious(metadata: InsightPagerMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDidYouMeanAutomatic(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logDidYouMeanClick(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logResultsSort(metadata: InsightResultsSortMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logSearchboxSubmit(metadata?: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logContextChanged(metadata: CaseMetadata): Promise<void | import("../events").SearchEventResponse>;
+    logExpandToFullUI(metadata: ExpandToFullUIMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logOpenUserActions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logShowPrecedingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logShowFollowingSessions(metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logViewedDocumentClick(document: UserActionsDocumentMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logPageViewClick(pageView: UserActionsPageViewMetadata, metadata: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDocumentOpen(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCopyToClipboard(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logDocumentQuickview(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCaseAttach(info: PartialDocumentInformation, identifier: DocumentIdentifier, caseMetadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCaseDetach(resultUriHash: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logLikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logDislikeSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logExpandSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCollapseSmartSnippet(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logOpenSmartSnippetFeedbackModal(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCloseSmartSnippetFeedbackModal(metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logSmartSnippetFeedbackReason(reason: SmartSnippetFeedbackReason, details?: string, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logExpandSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logCollapseSmartSnippetSuggestion(snippet: SmartSnippetSuggestionMeta | SmartSnippetDocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").CustomEventResponse>;
+    logOpenSmartSnippetSource(info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetSuggestionSource(info: PartialDocumentInformation, snippet: SmartSnippetSuggestionMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetInlineLink(info: PartialDocumentInformation, identifierAndLink: DocumentIdentifier & SmartSnippetLinkMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logOpenSmartSnippetSuggestionInlineLink(info: PartialDocumentInformation, snippetAndLink: SmartSnippetSuggestionMeta & SmartSnippetLinkMeta, metadata?: CaseMetadata): Promise<void | import("../events").ClickEventResponse>;
+    logCustomEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").CustomEventResponse>;
+    logSearchEvent(event: SearchPageEvents | InsightEvents, metadata?: Record<string, any>): Promise<void | import("../events").SearchEventResponse>;
+    logClickEvent(event: SearchPageEvents, info: PartialDocumentInformation, identifier: DocumentIdentifier, metadata?: Record<string, any>): Promise<void | import("../events").ClickEventResponse>;
+    private getBaseCustomEventRequest;
+    private getBaseSearchEventRequest;
+    private getBaseEventRequest;
+    private getOrigins;
+    private getClientId;
+}

package/dist/definitions/insight/insightEvents.d.ts

@@ -1,50 +1,50 @@
-import { CategoryFacetMetadata, FacetBaseMeta, FacetMetadata, FacetRangeMetadata, FacetSortMeta, InterfaceChangeMetadata, PagerMetadata, QueryErrorMeta, ResultsSortMetadata, StaticFilterToggleValueMetadata } from '../searchPage/searchPageEvents';
-export declare enum InsightEvents {
-    contextChanged = "contextChanged",
-    expandToFullUI = "expandToFullUI",
-    openUserActions = "openUserActions",
-    showPrecedingSessions = "showPrecedingSessions",
-    showFollowingSessions = "showFollowingSessions",
-    clickViewedDocument = "clickViewedDocument",
-    clickPageView = "clickPageView"
-}
-export interface CaseMetadata {
-    caseId?: string;
-    caseNumber?: string;
-    caseContext?: Record<string, string>;
-}
-export interface ExpandToFullUIMetadata extends CaseMetadata {
-    fullSearchComponentName: string;
-    triggeredBy: string;
-}
-export interface UserActionsDocumentMetadata {
-    title: string;
-    uri: string;
-    uriHash?: string;
-    permanentId?: string;
-}
-export interface UserActionsPageViewMetadata {
-    title: string;
-    contentIdKey: string;
-    contentIdValue: string;
-}
-export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {
-}
-export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {
-}
-export interface InsightStaticFilterToggleValueMetadata extends StaticFilterToggleValueMetadata, CaseMetadata {
-}
-export interface InsightFacetRangeMetadata extends FacetRangeMetadata, CaseMetadata {
-}
-export interface InsightCategoryFacetMetadata extends CategoryFacetMetadata, CaseMetadata {
-}
-export interface InsightFacetSortMeta extends FacetSortMeta, CaseMetadata {
-}
-export interface InsightFacetBaseMeta extends FacetBaseMeta, CaseMetadata {
-}
-export interface InsightQueryErrorMeta extends QueryErrorMeta, CaseMetadata {
-}
-export interface InsightPagerMetadata extends PagerMetadata, CaseMetadata {
-}
-export interface InsightResultsSortMetadata extends ResultsSortMetadata, CaseMetadata {
-}
+import { CategoryFacetMetadata, FacetBaseMeta, FacetMetadata, FacetRangeMetadata, FacetSortMeta, InterfaceChangeMetadata, PagerMetadata, QueryErrorMeta, ResultsSortMetadata, StaticFilterToggleValueMetadata } from '../searchPage/searchPageEvents';
+export declare enum InsightEvents {
+    contextChanged = "contextChanged",
+    expandToFullUI = "expandToFullUI",
+    openUserActions = "openUserActions",
+    showPrecedingSessions = "showPrecedingSessions",
+    showFollowingSessions = "showFollowingSessions",
+    clickViewedDocument = "clickViewedDocument",
+    clickPageView = "clickPageView"
+}
+export interface CaseMetadata {
+    caseId?: string;
+    caseNumber?: string;
+    caseContext?: Record<string, string>;
+}
+export interface ExpandToFullUIMetadata extends CaseMetadata {
+    fullSearchComponentName: string;
+    triggeredBy: string;
+}
+export interface UserActionsDocumentMetadata {
+    title: string;
+    uri: string;
+    uriHash?: string;
+    permanentId?: string;
+}
+export interface UserActionsPageViewMetadata {
+    title: string;
+    contentIdKey: string;
+    contentIdValue: string;
+}
+export interface InsightInterfaceChangeMetadata extends InterfaceChangeMetadata, CaseMetadata {
+}
+export interface InsightFacetMetadata extends FacetMetadata, CaseMetadata {
+}
+export interface InsightStaticFilterToggleValueMetadata extends StaticFilterToggleValueMetadata, CaseMetadata {
+}
+export interface InsightFacetRangeMetadata extends FacetRangeMetadata, CaseMetadata {
+}
+export interface InsightCategoryFacetMetadata extends CategoryFacetMetadata, CaseMetadata {
+}
+export interface InsightFacetSortMeta extends FacetSortMeta, CaseMetadata {
+}
+export interface InsightFacetBaseMeta extends FacetBaseMeta, CaseMetadata {
+}
+export interface InsightQueryErrorMeta extends QueryErrorMeta, CaseMetadata {
+}
+export interface InsightPagerMetadata extends PagerMetadata, CaseMetadata {
+}
+export interface InsightResultsSortMetadata extends ResultsSortMetadata, CaseMetadata {
+}

package/dist/definitions/plugins/BasePlugin.d.ts

@@ -1,58 +1,58 @@
-import { AnalyticsClient } from '../client/analytics';
-import { v4 as uuidv4 } from 'uuid';
-declare type PluginWithId = {
-    readonly Id: string;
-};
-export declare type PluginClass = typeof Plugin & PluginWithId;
-export declare const BasePluginEventTypes: {
-    pageview: string;
-    event: string;
-};
-export declare type PluginOptions = {
-    client: AnalyticsClient;
-    uuidGenerator?: typeof uuidv4;
-};
-export declare abstract class Plugin {
-    protected client: AnalyticsClient;
-    protected uuidGenerator: typeof uuidv4;
-    constructor({ client, uuidGenerator }: PluginOptions);
-    abstract getApi(name: string): any;
-}
-export declare abstract class BasePlugin extends Plugin {
-    protected action?: string;
-    protected actionData: {
-        [name: string]: string;
-    };
-    private pageViewId;
-    private nextPageViewId;
-    private hasSentFirstPageView?;
-    private currentLocation;
-    private lastReferrer;
-    constructor({ client, uuidGenerator }: PluginOptions);
-    protected abstract addHooks(): void;
-    protected abstract clearPluginData(): void;
-    getApi(name: string): Function | null;
-    setAction(action: string, options?: any): void;
-    clearData(): void;
-    getLocationInformation(eventType: string, payload: any): {
-        pageViewId: string;
-        referrer: string;
-        location: string;
-        hitType: string;
-    };
-    protected updateLocationInformation(eventType: string, payload: any): void;
-    getDefaultContextInformation(eventType: string): {
-        title: string;
-        encoding: string;
-        language: string;
-        userAgent: string;
-        screenResolution: string;
-        screenColor: string;
-        time: number;
-        eventId: string;
-    };
-    private updateLocationForNextPageView;
-    private getNextValues;
-    private getCurrentLocationFromPayload;
-}
-export {};
+import { AnalyticsClient } from '../client/analytics';
+import { v4 as uuidv4 } from 'uuid';
+type PluginWithId = {
+    readonly Id: string;
+};
+export type PluginClass = typeof Plugin & PluginWithId;
+export declare const BasePluginEventTypes: {
+    pageview: string;
+    event: string;
+};
+export type PluginOptions = {
+    client: AnalyticsClient;
+    uuidGenerator?: typeof uuidv4;
+};
+export declare abstract class Plugin {
+    protected client: AnalyticsClient;
+    protected uuidGenerator: typeof uuidv4;
+    constructor({ client, uuidGenerator }: PluginOptions);
+    abstract getApi(name: string): any;
+}
+export declare abstract class BasePlugin extends Plugin {
+    protected action?: string;
+    protected actionData: {
+        [name: string]: string;
+    };
+    private pageViewId;
+    private nextPageViewId;
+    private hasSentFirstPageView?;
+    private currentLocation;
+    private lastReferrer;
+    constructor({ client, uuidGenerator }: PluginOptions);
+    protected abstract addHooks(): void;
+    protected abstract clearPluginData(): void;
+    getApi(name: string): Function | null;
+    setAction(action: string, options?: any): void;
+    clearData(): void;
+    getLocationInformation(eventType: string, payload: any): {
+        pageViewId: string;
+        referrer: string;
+        location: string;
+        hitType: string;
+    };
+    protected updateLocationInformation(eventType: string, payload: any): void;
+    getDefaultContextInformation(eventType: string): {
+        title: string;
+        encoding: string;
+        language: string;
+        userAgent: string;
+        screenResolution: string;
+        screenColor: string;
+        time: number;
+        eventId: string;
+    };
+    private updateLocationForNextPageView;
+    private getNextValues;
+    private getCurrentLocationFromPayload;
+}
+export {};

package/dist/definitions/plugins/ec.d.ts

@@ -1,67 +1,67 @@
-import { BasePlugin, PluginClass, PluginOptions } from './BasePlugin';
-export declare const ECPluginEventTypes: {
-    pageview: string;
-    event: string;
-};
-declare type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
-    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
-}[Keys];
-export declare type CustomValues = {
-    [key: string]: string | number | boolean;
-};
-export interface CoveoExtensionProperties {
-    group?: string;
-}
-export interface ProductProperties extends CoveoExtensionProperties {
-    id?: string;
-    name?: string;
-    brand?: string;
-    category?: string;
-    variant?: string;
-    price?: number;
-    quantity?: number;
-    coupon?: string;
-    position?: number;
-    custom?: CustomValues;
-}
-export declare type Product = RequireAtLeastOne<ProductProperties, 'id' | 'name'>;
-export interface ImpressionProperties extends CoveoExtensionProperties {
-    id?: string;
-    name?: string;
-    list?: string;
-    brand?: string;
-    category?: string;
-    variant?: string;
-    position?: number;
-    price?: number;
-    custom?: CustomValues;
-}
-export declare type Impression = RequireAtLeastOne<ImpressionProperties, 'id' | 'name'>;
-export declare type BaseImpression = Omit<Impression, 'list'>;
-export interface ImpressionList {
-    listName?: string;
-    impressions: BaseImpression[];
-}
-export declare class ECPlugin extends BasePlugin {
-    static readonly Id = "ec";
-    private products;
-    private impressions;
-    constructor({ client, uuidGenerator }: PluginOptions);
-    getApi(name: string): Function | null;
-    protected addHooks(): void;
-    addProduct(product: Product): void;
-    addImpression(impression: Impression): void;
-    protected clearPluginData(): void;
-    private addHooksForECEvents;
-    private addHooksForPageView;
-    private addHooksForEvent;
-    private addECDataToPayload;
-    private getProductPayload;
-    private convertNumberTypes;
-    private getImpressionPayload;
-    private assureProductValidity;
-    private assureBaseImpressionValidity;
-    private getImpressionsByList;
-}
-export declare const EC: PluginClass;
-export {};
+import { BasePlugin, PluginClass, PluginOptions } from './BasePlugin';
+export declare const ECPluginEventTypes: {
+    pageview: string;
+    event: string;
+};
+type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclude<keyof T, Keys>> & {
+    [K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
+}[Keys];
+export type CustomValues = {
+    [key: string]: string | number | boolean;
+};
+export interface CoveoExtensionProperties {
+    group?: string;
+}
+export interface ProductProperties extends CoveoExtensionProperties {
+    id?: string;
+    name?: string;
+    brand?: string;
+    category?: string;
+    variant?: string;
+    price?: number;
+    quantity?: number;
+    coupon?: string;
+    position?: number;
+    custom?: CustomValues;
+}
+export type Product = RequireAtLeastOne<ProductProperties, 'id' | 'name'>;
+export interface ImpressionProperties extends CoveoExtensionProperties {
+    id?: string;
+    name?: string;
+    list?: string;
+    brand?: string;
+    category?: string;
+    variant?: string;
+    position?: number;
+    price?: number;
+    custom?: CustomValues;
+}
+export type Impression = RequireAtLeastOne<ImpressionProperties, 'id' | 'name'>;
+export type BaseImpression = Omit<Impression, 'list'>;
+export interface ImpressionList {
+    listName?: string;
+    impressions: BaseImpression[];
+}
+export declare class ECPlugin extends BasePlugin {
+    static readonly Id = "ec";
+    private products;
+    private impressions;
+    constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
+    protected addHooks(): void;
+    addProduct(product: Product): void;
+    addImpression(impression: Impression): void;
+    protected clearPluginData(): void;
+    private addHooksForECEvents;
+    private addHooksForPageView;
+    private addHooksForEvent;
+    private addECDataToPayload;
+    private getProductPayload;
+    private convertNumberTypes;
+    private getImpressionPayload;
+    private assureProductValidity;
+    private assureBaseImpressionValidity;
+    private getImpressionsByList;
+}
+export declare const EC: PluginClass;
+export {};

package/dist/definitions/plugins/link.d.ts

@@ -1,21 +1,21 @@
-import { Plugin, PluginOptions, PluginClass } from './BasePlugin';
-export declare class CoveoLinkParam {
-    static readonly cvo_cid: string;
-    private static readonly expirationTime;
-    readonly clientId: string;
-    readonly creationDate: number;
-    constructor(clientId: string, timestamp: number);
-    toString(): string;
-    get expired(): boolean;
-    validate(referrerString: string, referrerList: string[]): boolean;
-    private matchReferrer;
-    static fromString(input: string): CoveoLinkParam | null;
-}
-export declare class LinkPlugin extends Plugin {
-    static readonly Id = "link";
-    constructor({ client, uuidGenerator }: PluginOptions);
-    getApi(name: string): Function | null;
-    decorate(urlString: string): Promise<string>;
-    acceptFrom(acceptedReferrers: string[]): void;
-}
-export declare const Link: PluginClass;
+import { Plugin, PluginOptions, PluginClass } from './BasePlugin';
+export declare class CoveoLinkParam {
+    static readonly cvo_cid: string;
+    private static readonly expirationTime;
+    readonly clientId: string;
+    readonly creationDate: number;
+    constructor(clientId: string, timestamp: number);
+    toString(): string;
+    get expired(): boolean;
+    validate(referrerString: string, referrerList: string[]): boolean;
+    private matchReferrer;
+    static fromString(input: string): CoveoLinkParam | null;
+}
+export declare class LinkPlugin extends Plugin {
+    static readonly Id = "link";
+    constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
+    decorate(urlString: string): Promise<string>;
+    acceptFrom(acceptedReferrers: string[]): void;
+}
+export declare const Link: PluginClass;

package/dist/definitions/plugins/svc.d.ts

@@ -1,32 +1,32 @@
-import { BasePlugin, PluginClass, PluginOptions } from './BasePlugin';
-export declare const SVCPluginEventTypes: {
-    pageview: string;
-    event: string;
-};
-export declare type CustomValues = {
-    [key: string]: string | number | boolean;
-};
-export interface TicketProperties {
-    id?: string;
-    subject?: string;
-    description?: string;
-    category?: string;
-    productId?: string;
-    custom?: CustomValues;
-}
-export declare type Ticket = TicketProperties;
-export declare class SVCPlugin extends BasePlugin {
-    static readonly Id = "svc";
-    private ticket;
-    constructor({ client, uuidGenerator }: PluginOptions);
-    getApi(name: string): Function | null;
-    protected addHooks(): void;
-    setTicket(ticket: Ticket): void;
-    protected clearPluginData(): void;
-    private addHooksForSVCEvents;
-    private addHooksForPageView;
-    private addHooksForEvent;
-    private addSVCDataToPayload;
-    private getTicketPayload;
-}
-export declare const SVC: PluginClass;
+import { BasePlugin, PluginClass, PluginOptions } from './BasePlugin';
+export declare const SVCPluginEventTypes: {
+    pageview: string;
+    event: string;
+};
+export type CustomValues = {
+    [key: string]: string | number | boolean;
+};
+export interface TicketProperties {
+    id?: string;
+    subject?: string;
+    description?: string;
+    category?: string;
+    productId?: string;
+    custom?: CustomValues;
+}
+export type Ticket = TicketProperties;
+export declare class SVCPlugin extends BasePlugin {
+    static readonly Id = "svc";
+    private ticket;
+    constructor({ client, uuidGenerator }: PluginOptions);
+    getApi(name: string): Function | null;
+    protected addHooks(): void;
+    setTicket(ticket: Ticket): void;
+    protected clearPluginData(): void;
+    private addHooksForSVCEvents;
+    private addHooksForPageView;
+    private addHooksForEvent;
+    private addSVCDataToPayload;
+    private getTicketPayload;
+}
+export declare const SVC: PluginClass;

package/dist/definitions/react-native/index.d.ts

@@ -1,3 +1,3 @@
-export { ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage } from './react-native-runtime';
-export * from '../coveoua/headless';
-import 'react-native-get-random-values';
+export { ReactNativeRuntime, ReactNativeRuntimeOptions, ReactNativeStorage } from './react-native-runtime';
+export * from '../coveoua/headless';
+import 'react-native-get-random-values';