fix!: disable automatic visitor id for client environment

since we are defaulting to disable (whereas it was previously enabled),
 we mark the commit as breaking.

api/sdk.api.md

@@ -22,7 +22,7 @@ export class Confidence implements EventSender, Trackable, FlagResolver {
     //
     // @internal
     readonly contextChanges: Subscribe<string[]>;
-    static create({ clientSecret, region, timeout, environment, fetchImplementation, logger, }: ConfidenceOptions): Confidence;
+    static create({ clientSecret, region, timeout, environment, fetchImplementation, enableVisitorId, logger, }: ConfidenceOptions): Confidence;
     get environment(): string;
     evaluateFlag(path: string, defaultValue: string): FlagEvaluation<string>;
     // (undocumented)
@@ -52,6 +52,7 @@ export class Confidence implements EventSender, Trackable, FlagResolver {
 // @public
 export interface ConfidenceOptions {
     clientSecret: string;
+    enableVisitorId?: boolean;
     environment: 'client' | 'backend';
     // Warning: (ae-forgotten-export) The symbol "SimpleFetch" needs to be exported by the entry point index.d.ts
     fetchImplementation?: SimpleFetch;

packages/sdk/src/Confidence.ts

@@ -36,6 +36,8 @@ export interface ConfidenceOptions {
   fetchImplementation?: SimpleFetch;
   /** Resolve timeout */
   timeout: number;
+  /** If the visitorId should be enabled and persisted in a cookie */
+  enableVisitorId?: boolean;
   /** Debug logger */
   logger?: Logger;
 }
@@ -322,6 +324,7 @@ export class Confidence implements EventSender, Trackable, FlagResolver {
    * @param timeout - timeout for flag resolves
    * @param environment - can be either "client" or "backend"
    * @param fetchImplementation - fetch implementation
+   * @param enableVisitorId - if visitorId should be enabled
    * @param logger - debug logger
    * @returns
    */
@@ -331,6 +334,7 @@ export class Confidence implements EventSender, Trackable, FlagResolver {
     timeout,
     environment,
     fetchImplementation = defaultFetchImplementation(),
+    enableVisitorId = false,
     logger = defaultLogger(),
   }: ConfidenceOptions): Confidence {
     const sdk = {
@@ -373,7 +377,7 @@ export class Confidence implements EventSender, Trackable, FlagResolver {
       timeout,
       logger,
     });
-    if (environment === 'client') {
+    if (environment === 'client' && enableVisitorId) {
       root.track(visitorIdentity());
     }
     return root;