From bbb352c7aa2f6ae30de81502ae9930f9e08f8fd6 Mon Sep 17 00:00:00 2001 From: Louis Bompart Date: Fri, 23 Aug 2024 12:17:08 -0400 Subject: [PATCH] docs(analytics): make trackingId & analyticsMode public (#4300) CDX-1565 --------- Co-authored-by: jpmarceau <39384459+jpmarceau@users.noreply.github.com> --- packages/headless/src/app/engine-configuration.ts | 10 ++++++---- .../features/configuration/configuration-actions.ts | 9 ++++++--- 2 files changed, 12 insertions(+), 7 deletions(-) diff --git a/packages/headless/src/app/engine-configuration.ts b/packages/headless/src/app/engine-configuration.ts index b7f204f7d5b..6f026d34507 100644 --- a/packages/headless/src/app/engine-configuration.ts +++ b/packages/headless/src/app/engine-configuration.ts @@ -157,13 +157,15 @@ export interface AnalyticsConfiguration { documentLocation?: string; /** * The unique identifier of the tracking target. - * @internal */ trackingId?: string; /** - * Specifies the analytics mode to use. - * By default, `legacy`. - * @internal + * The analytics client to use. + * - `legacy`: The legacy analytics client, i.e., the Coveo Analytics.js library. + * - `next`: The next analytics client, i.e., the Coveo Event Protocol with the Relay library. + * + * Starting at V3.0, the default value will be `next`. + * @default 'legacy' */ analyticsMode?: 'legacy' | 'next'; /** diff --git a/packages/headless/src/features/configuration/configuration-actions.ts b/packages/headless/src/features/configuration/configuration-actions.ts index 7b94cc88473..4845443b773 100644 --- a/packages/headless/src/features/configuration/configuration-actions.ts +++ b/packages/headless/src/features/configuration/configuration-actions.ts @@ -157,9 +157,12 @@ export interface UpdateAnalyticsConfigurationActionCreatorPayload { */ trackingId?: string; /** - * Specifies the analytics mode to use. - * By default, `legacy`. - * @internal + * The analytics client to use. + * - `legacy`: The legacy analytics client, i.e., the Coveo Analytics.js library. + * - `next`: The next analytics client, i.e., the Coveo Event Protocol with the Relay library. + * + * Starting at V3.0, the default value will be `next`. + * @default 'legacy' */ analyticsMode?: 'legacy' | 'next'; /**