docs(analytics): make trackingId & analyticsMode public (#4300)

CDX-1565 --------- Co-authored-by: jpmarceau <[email protected]>
coveo · Aug 23, 2024 · bbb352c · bbb352c
1 parent c3337d5
commit bbb352c
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 7 deletions.
diff --git 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
@@ -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';
   /**