posthog-js 1.135.2 → 1.136.0

package/dist/lib/src/consent.d.ts

@@ -0,0 +1,24 @@
+import { PostHog } from './posthog-core';
+export declare enum ConsentStatus {
+    PENDING = -1,
+    DENIED = 0,
+    GRANTED = 1
+}
+/**
+ * ConsentManager provides tools for managing user consent as configured by the application.
+ */
+export declare class ConsentManager {
+    private instance;
+    private _storage?;
+    constructor(instance: PostHog);
+    private get config();
+    get consent(): ConsentStatus;
+    isOptedOut(): boolean;
+    isOptedIn(): boolean;
+    optInOut(isOptedIn: boolean): void;
+    reset(): void;
+    private get storageKey();
+    private get storedConsent();
+    private get storage();
+    private getDnt;
+}

package/dist/lib/src/posthog-core.d.ts

@@ -6,7 +6,7 @@ import { RequestQueue } from './request-queue';
 import { RetryQueue } from './retry-queue';
 import { SessionIdManager } from './sessionid';
 import { RequestRouter } from './utils/request-router';
-import { CaptureOptions, CaptureResult, Compression, DecideResponse, EarlyAccessFeatureCallback, GDPROptions, IsFeatureEnabledOptions, JsonType, OptInOutCapturingOptions, PostHogConfig, Properties, Property, QueuedRequestOptions, RequestCallback, SessionIdChangedCallback, SnippetArrayItem, ToolbarParams } from './types';
+import { CaptureOptions, CaptureResult, Compression, DecideResponse, EarlyAccessFeatureCallback, IsFeatureEnabledOptions, JsonType, PostHogConfig, Properties, Property, QueuedRequestOptions, RequestCallback, SessionIdChangedCallback, SnippetArrayItem, ToolbarParams } from './types';
 import { SentryIntegration } from './extensions/sentry-integration';
 import { PageViewManager } from './page-view';
 import { PostHogSurveys } from './posthog-surveys';
@@ -16,6 +16,7 @@ import { SessionPropsManager } from './session-props';
 import { Heatmaps } from './heatmaps';
 import { ScrollManager } from './scroll-manager';
 import { Autocapture } from './autocapture';
+import { ConsentManager } from './consent';
 type OnlyValidKeys<T, Shape> = T extends Shape ? (Exclude<keyof T, keyof Shape> extends never ? T : never) : never;
 export declare const defaultConfig: () => PostHogConfig;
 export declare const configRenames: (origConfig: Partial<PostHogConfig>) => Partial<PostHogConfig>;
@@ -37,6 +38,7 @@ export declare class PostHog {
     featureFlags: PostHogFeatureFlags;
     surveys: PostHogSurveys;
     toolbar: Toolbar;
+    consent: ConsentManager;
     persistence?: PostHogPersistence;
     sessionPersistence?: PostHogPersistence;
     sessionManager?: SessionIdManager;
@@ -127,9 +129,9 @@ export declare class PostHog {
      *
      * @param {String} event_name The name of the event. This can be anything the user does - 'Button Click', 'Sign Up', 'Item Purchased', etc.
      * @param {Object} [properties] A set of properties to include with the event you're sending. These describe the user who did the event or details about the event itself.
-     * @param {Object} [options] Optional configuration for this capture request.
-     * @param {String} [options.transport] Transport method for network request ('XHR' or 'sendBeacon').
-     * @param {Date} [options.timestamp] Timestamp is a Date object. If not set, it'll automatically be set to the current time.
+     * @param {Object} [config] Optional configuration for this capture request.
+     * @param {String} [config.transport] Transport method for network request ('XHR' or 'sendBeacon').
+     * @param {Date} [config.timestamp] Timestamp is a Date object. If not set, it'll automatically be set to the current time.
      */
     capture(event_name: string, properties?: Properties | null, options?: CaptureOptions): CaptureResult | void;
     _addCaptureHook(callback: (eventName: string) => void): void;
@@ -610,17 +612,15 @@ export declare class PostHog {
      * @param function_name
      */
     _requirePersonProcessing(function_name: string): boolean;
-    _gdpr_init(): void;
     /**
      * Enable or disable persistence based on options
      * only enable/disable if persistence is not already in this state
-     * @param {boolean} [options.clear_persistence] If true, will delete all data stored by the sdk in persistence and disable it
-     * @param {boolean} [options.enable_persistence] If true, will re-enable sdk persistence
+     * @param {boolean} [disabled] If true, will re-enable sdk persistence
      */
-    _gdpr_update_persistence(options: Partial<OptInOutCapturingOptions>): void;
-    _gdpr_call_func<R = any>(func: (token: string, options: GDPROptions) => R, options?: Partial<OptInOutCapturingOptions>): R;
+    private _sync_opt_out_with_persistence;
     /**
      * Opt the user in to data capturing and cookies/localstorage for this PostHog instance
+     * If the config.opt_out_persistence_by_default is set to false, the SDK persistence will be enabled.
      *
      * ### Usage
      *
@@ -631,47 +631,28 @@ export declare class PostHog {
      *     posthog.opt_in_capturing({
      *         capture_event_name: 'User opted in',
      *         capture_event_properties: {
-     *             'Email': 'jdoe@example.com'
-     *         },
-     *         cookie_expiration: 30,
-     *         secure_cookie: true
+     *             'email': 'jdoe@example.com'
+     *         }
      *     });
      *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {function} [options.capture] Function used for capturing a PostHog event to record the opt-in action (default is this PostHog instance's capture method)
-     * @param {string} [options.capture_event_name=$opt_in] Event name to be used for capturing the opt-in action
-     * @param {Object} [options.capture_properties] Set of properties to be captured along with the opt-in action
-     * @param {boolean} [options.enable_persistence=true] If true, will re-enable sdk persistence
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
-     * @param {Number} [options.cookie_expiration] Number of days until the opt-in cookie expires (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.cross_subdomain_cookie] Whether the opt-in cookie is set as cross-subdomain or not (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.secure_cookie] Whether the opt-in cookie is set as secure or not (overrides value specified in this PostHog instance's config)
+     * @param {Object} [config] A dictionary of config options to override
+     * @param {string} [config.capture_event_name=$opt_in] Event name to be used for capturing the opt-in action
+     * @param {Object} [config.capture_properties] Set of properties to be captured along with the opt-in action
      */
-    opt_in_capturing(options?: Partial<OptInOutCapturingOptions>): void;
+    opt_in_capturing(options?: {
+        captureEventName?: string; /** event name to be used for capturing the opt-in action */
+        captureProperties?: Properties; /** set of properties to be captured along with the opt-in action */
+    }): void;
     /**
-     * Opt the user out of data capturing and cookies/localstorage for this PostHog instance
+     * Opt the user out of data capturing and cookies/localstorage for this PostHog instance.
+     * If the config.opt_out_persistence_by_default is set to true, the SDK persistence will be disabled.
      *
      * ### Usage
      *
      *     // opt user out
-     *     posthog.opt_out_capturing();
-     *
-     *     // opt user out with different cookie configuration from PostHog instance
-     *     posthog.opt_out_capturing({
-     *         cookie_expiration: 30,
-     *         secure_cookie: true
-     *     });
-     *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {boolean} [options.clear_persistence=true] If true, will delete all data stored by the sdk in persistence
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
-     * @param {Number} [options.cookie_expiration] Number of days until the opt-in cookie expires (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.cross_subdomain_cookie] Whether the opt-in cookie is set as cross-subdomain or not (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.secure_cookie] Whether the opt-in cookie is set as secure or not (overrides value specified in this PostHog instance's config)
+     *     posthog.opt_out_capturing()
      */
-    opt_out_capturing(options?: Partial<OptInOutCapturingOptions>): void;
+    opt_out_capturing(): void;
     /**
      * Check whether the user has opted in to data capturing and cookies/localstorage for this PostHog instance
      *
@@ -680,12 +661,9 @@ export declare class PostHog {
      *     const has_opted_in = posthog.has_opted_in_capturing();
      *     // use has_opted_in value
      *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
      * @returns {boolean} current opt-in status
      */
-    has_opted_in_capturing(options?: Partial<OptInOutCapturingOptions>): boolean;
+    has_opted_in_capturing(): boolean;
     /**
      * Check whether the user has opted out of data capturing and cookies/localstorage for this PostHog instance
      *
@@ -694,12 +672,9 @@ export declare class PostHog {
      *     const has_opted_out = posthog.has_opted_out_capturing();
      *     // use has_opted_out value
      *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
      * @returns {boolean} current opt-out status
      */
-    has_opted_out_capturing(options?: Partial<OptInOutCapturingOptions>): boolean;
+    has_opted_out_capturing(): boolean;
     /**
      * Clear the user's opt in/out status of data capturing and cookies/localstorage for this PostHog instance
      *
@@ -707,23 +682,10 @@ export declare class PostHog {
      *
      *     // clear user's opt-in/out status
      *     posthog.clear_opt_in_out_capturing();
-     *
-     *     // clear user's opt-in/out status with specific cookie configuration - should match
-     *     // configuration used when opt_in_capturing/opt_out_capturing methods were called.
-     *     posthog.clear_opt_in_out_capturing({
-     *         cookie_expiration: 30,
-     *         secure_cookie: true
-     *     });
-     *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {boolean} [options.enable_persistence=true] If true, will re-enable sdk persistence
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
-     * @param {Number} [options.cookie_expiration] Number of days until the opt-in cookie expires (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.cross_subdomain_cookie] Whether the opt-in cookie is set as cross-subdomain or not (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.secure_cookie] Whether the opt-in cookie is set as secure or not (overrides value specified in this PostHog instance's config)
+     *     *
+     * @param {Object} [config] A dictionary of config options to override
      */
-    clear_opt_in_out_capturing(options?: Partial<OptInOutCapturingOptions>): void;
+    clear_opt_in_out_capturing(): void;
     debug(debug?: boolean): void;
 }
 export declare function init_from_snippet(): void;

package/dist/lib/src/types.d.ts

@@ -91,11 +91,13 @@ export interface PostHogConfig {
     enable_recording_console_log?: boolean;
     secure_cookie: boolean;
     ip: boolean;
+    /** Starts the SDK in an opted out state requiring opt_in_capturing() to be called before events will b captured  */
     opt_out_capturing_by_default: boolean;
-    opt_out_persistence_by_default: boolean;
+    opt_out_capturing_persistence_type: 'localStorage' | 'cookie';
+    /** If set to true this will disable persistence if the user is opted out of capturing. @default false */
+    opt_out_persistence_by_default?: boolean;
     /** Opt out of user agent filtering such as googlebot or other bots. Defaults to `false` */
     opt_out_useragent_filter: boolean;
-    opt_out_capturing_persistence_type: 'localStorage' | 'cookie';
     opt_out_capturing_cookie_prefix: string | null;
     opt_in_site_apps: boolean;
     respect_dnt: boolean;
@@ -276,19 +278,6 @@ export interface DecideResponse {
 export type FeatureFlagsCallback = (flags: string[], variants: Record<string, string | boolean>, context?: {
     errorsLoading?: boolean;
 }) => void;
-export interface GDPROptions {
-    capture?: (event: string, properties: Properties, options: CaptureOptions) => void; /** function used for capturing a PostHog event to record the opt-in action */
-    captureEventName?: string; /** event name to be used for capturing the opt-in action */
-    captureProperties?: Properties; /** set of properties to be captured along with the opt-in action */
-    /** persistence mechanism used */
-    persistenceType?: 'cookie' | 'localStorage' | 'localStorage+cookie';
-    persistencePrefix?: string; /** [__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name */
-    cookieExpiration?: number; /** number of days until the opt-in cookie expires */
-    crossSubdomainCookie?: boolean; /** whether the opt-in cookie is set as cross-subdomain or not */
-    secureCookie?: boolean; /** whether the opt-in cookie is set as secure or not */
-    respectDnt?: boolean;
-    window?: Window;
-}
 export interface PersistentStore {
     is_supported: () => boolean;
     error: (error: any) => void;

package/dist/module.d.ts

@@ -223,11 +223,13 @@ interface PostHogConfig {
     enable_recording_console_log?: boolean;
     secure_cookie: boolean;
     ip: boolean;
+    /** Starts the SDK in an opted out state requiring opt_in_capturing() to be called before events will b captured  */
     opt_out_capturing_by_default: boolean;
-    opt_out_persistence_by_default: boolean;
+    opt_out_capturing_persistence_type: 'localStorage' | 'cookie';
+    /** If set to true this will disable persistence if the user is opted out of capturing. @default false */
+    opt_out_persistence_by_default?: boolean;
     /** Opt out of user agent filtering such as googlebot or other bots. Defaults to `false` */
     opt_out_useragent_filter: boolean;
-    opt_out_capturing_persistence_type: 'localStorage' | 'cookie';
     opt_out_capturing_cookie_prefix: string | null;
     opt_in_site_apps: boolean;
     respect_dnt: boolean;
@@ -408,19 +410,6 @@ interface DecideResponse {
 type FeatureFlagsCallback = (flags: string[], variants: Record<string, string | boolean>, context?: {
     errorsLoading?: boolean;
 }) => void;
-interface GDPROptions {
-    capture?: (event: string, properties: Properties, options: CaptureOptions) => void; /** function used for capturing a PostHog event to record the opt-in action */
-    captureEventName?: string; /** event name to be used for capturing the opt-in action */
-    captureProperties?: Properties; /** set of properties to be captured along with the opt-in action */
-    /** persistence mechanism used */
-    persistenceType?: 'cookie' | 'localStorage' | 'localStorage+cookie';
-    persistencePrefix?: string; /** [__ph_opt_in_out] - custom prefix to be used in the cookie/localstorage name */
-    cookieExpiration?: number; /** number of days until the opt-in cookie expires */
-    crossSubdomainCookie?: boolean; /** whether the opt-in cookie is set as cross-subdomain or not */
-    secureCookie?: boolean; /** whether the opt-in cookie is set as secure or not */
-    respectDnt?: boolean;
-    window?: Window;
-}
 interface PersistentStore {
     is_supported: () => boolean;
     error: (error: any) => void;
@@ -1387,6 +1376,30 @@ declare class Autocapture {
     isBrowserSupported(): boolean;
 }
 
+declare enum ConsentStatus {
+    PENDING = -1,
+    DENIED = 0,
+    GRANTED = 1
+}
+/**
+ * ConsentManager provides tools for managing user consent as configured by the application.
+ */
+declare class ConsentManager {
+    private instance;
+    private _storage?;
+    constructor(instance: PostHog);
+    private get config();
+    get consent(): ConsentStatus;
+    isOptedOut(): boolean;
+    isOptedIn(): boolean;
+    optInOut(isOptedIn: boolean): void;
+    reset(): void;
+    private get storageKey();
+    private get storedConsent();
+    private get storage();
+    private getDnt;
+}
+
 type OnlyValidKeys<T, Shape> = T extends Shape ? (Exclude<keyof T, keyof Shape> extends never ? T : never) : never;
 declare class DeprecatedWebPerformanceObserver {
     get _forceAllowLocalhost(): boolean;
@@ -1406,6 +1419,7 @@ declare class PostHog {
     featureFlags: PostHogFeatureFlags;
     surveys: PostHogSurveys;
     toolbar: Toolbar;
+    consent: ConsentManager;
     persistence?: PostHogPersistence;
     sessionPersistence?: PostHogPersistence;
     sessionManager?: SessionIdManager;
@@ -1496,9 +1510,9 @@ declare class PostHog {
      *
      * @param {String} event_name The name of the event. This can be anything the user does - 'Button Click', 'Sign Up', 'Item Purchased', etc.
      * @param {Object} [properties] A set of properties to include with the event you're sending. These describe the user who did the event or details about the event itself.
-     * @param {Object} [options] Optional configuration for this capture request.
-     * @param {String} [options.transport] Transport method for network request ('XHR' or 'sendBeacon').
-     * @param {Date} [options.timestamp] Timestamp is a Date object. If not set, it'll automatically be set to the current time.
+     * @param {Object} [config] Optional configuration for this capture request.
+     * @param {String} [config.transport] Transport method for network request ('XHR' or 'sendBeacon').
+     * @param {Date} [config.timestamp] Timestamp is a Date object. If not set, it'll automatically be set to the current time.
      */
     capture(event_name: string, properties?: Properties | null, options?: CaptureOptions): CaptureResult | void;
     _addCaptureHook(callback: (eventName: string) => void): void;
@@ -1979,17 +1993,15 @@ declare class PostHog {
      * @param function_name
      */
     _requirePersonProcessing(function_name: string): boolean;
-    _gdpr_init(): void;
     /**
      * Enable or disable persistence based on options
      * only enable/disable if persistence is not already in this state
-     * @param {boolean} [options.clear_persistence] If true, will delete all data stored by the sdk in persistence and disable it
-     * @param {boolean} [options.enable_persistence] If true, will re-enable sdk persistence
+     * @param {boolean} [disabled] If true, will re-enable sdk persistence
      */
-    _gdpr_update_persistence(options: Partial<OptInOutCapturingOptions>): void;
-    _gdpr_call_func<R = any>(func: (token: string, options: GDPROptions) => R, options?: Partial<OptInOutCapturingOptions>): R;
+    private _sync_opt_out_with_persistence;
     /**
      * Opt the user in to data capturing and cookies/localstorage for this PostHog instance
+     * If the config.opt_out_persistence_by_default is set to false, the SDK persistence will be enabled.
      *
      * ### Usage
      *
@@ -2000,47 +2012,28 @@ declare class PostHog {
      *     posthog.opt_in_capturing({
      *         capture_event_name: 'User opted in',
      *         capture_event_properties: {
-     *             'Email': 'jdoe@example.com'
-     *         },
-     *         cookie_expiration: 30,
-     *         secure_cookie: true
+     *             'email': 'jdoe@example.com'
+     *         }
      *     });
      *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {function} [options.capture] Function used for capturing a PostHog event to record the opt-in action (default is this PostHog instance's capture method)
-     * @param {string} [options.capture_event_name=$opt_in] Event name to be used for capturing the opt-in action
-     * @param {Object} [options.capture_properties] Set of properties to be captured along with the opt-in action
-     * @param {boolean} [options.enable_persistence=true] If true, will re-enable sdk persistence
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
-     * @param {Number} [options.cookie_expiration] Number of days until the opt-in cookie expires (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.cross_subdomain_cookie] Whether the opt-in cookie is set as cross-subdomain or not (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.secure_cookie] Whether the opt-in cookie is set as secure or not (overrides value specified in this PostHog instance's config)
+     * @param {Object} [config] A dictionary of config options to override
+     * @param {string} [config.capture_event_name=$opt_in] Event name to be used for capturing the opt-in action
+     * @param {Object} [config.capture_properties] Set of properties to be captured along with the opt-in action
      */
-    opt_in_capturing(options?: Partial<OptInOutCapturingOptions>): void;
+    opt_in_capturing(options?: {
+        captureEventName?: string; /** event name to be used for capturing the opt-in action */
+        captureProperties?: Properties; /** set of properties to be captured along with the opt-in action */
+    }): void;
     /**
-     * Opt the user out of data capturing and cookies/localstorage for this PostHog instance
+     * Opt the user out of data capturing and cookies/localstorage for this PostHog instance.
+     * If the config.opt_out_persistence_by_default is set to true, the SDK persistence will be disabled.
      *
      * ### Usage
      *
      *     // opt user out
-     *     posthog.opt_out_capturing();
-     *
-     *     // opt user out with different cookie configuration from PostHog instance
-     *     posthog.opt_out_capturing({
-     *         cookie_expiration: 30,
-     *         secure_cookie: true
-     *     });
-     *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {boolean} [options.clear_persistence=true] If true, will delete all data stored by the sdk in persistence
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
-     * @param {Number} [options.cookie_expiration] Number of days until the opt-in cookie expires (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.cross_subdomain_cookie] Whether the opt-in cookie is set as cross-subdomain or not (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.secure_cookie] Whether the opt-in cookie is set as secure or not (overrides value specified in this PostHog instance's config)
+     *     posthog.opt_out_capturing()
      */
-    opt_out_capturing(options?: Partial<OptInOutCapturingOptions>): void;
+    opt_out_capturing(): void;
     /**
      * Check whether the user has opted in to data capturing and cookies/localstorage for this PostHog instance
      *
@@ -2049,12 +2042,9 @@ declare class PostHog {
      *     const has_opted_in = posthog.has_opted_in_capturing();
      *     // use has_opted_in value
      *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
      * @returns {boolean} current opt-in status
      */
-    has_opted_in_capturing(options?: Partial<OptInOutCapturingOptions>): boolean;
+    has_opted_in_capturing(): boolean;
     /**
      * Check whether the user has opted out of data capturing and cookies/localstorage for this PostHog instance
      *
@@ -2063,12 +2053,9 @@ declare class PostHog {
      *     const has_opted_out = posthog.has_opted_out_capturing();
      *     // use has_opted_out value
      *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
      * @returns {boolean} current opt-out status
      */
-    has_opted_out_capturing(options?: Partial<OptInOutCapturingOptions>): boolean;
+    has_opted_out_capturing(): boolean;
     /**
      * Clear the user's opt in/out status of data capturing and cookies/localstorage for this PostHog instance
      *
@@ -2076,26 +2063,13 @@ declare class PostHog {
      *
      *     // clear user's opt-in/out status
      *     posthog.clear_opt_in_out_capturing();
-     *
-     *     // clear user's opt-in/out status with specific cookie configuration - should match
-     *     // configuration used when opt_in_capturing/opt_out_capturing methods were called.
-     *     posthog.clear_opt_in_out_capturing({
-     *         cookie_expiration: 30,
-     *         secure_cookie: true
-     *     });
-     *
-     * @param {Object} [options] A dictionary of config options to override
-     * @param {boolean} [options.enable_persistence=true] If true, will re-enable sdk persistence
-     * @param {string} [options.persistence_type=localStorage] Persistence mechanism used - cookie or localStorage - falls back to cookie if localStorage is unavailable
-     * @param {string} [options.cookie_prefix=__ph_opt_in_out] Custom prefix to be used in the cookie/localstorage name
-     * @param {Number} [options.cookie_expiration] Number of days until the opt-in cookie expires (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.cross_subdomain_cookie] Whether the opt-in cookie is set as cross-subdomain or not (overrides value specified in this PostHog instance's config)
-     * @param {boolean} [options.secure_cookie] Whether the opt-in cookie is set as secure or not (overrides value specified in this PostHog instance's config)
+     *     *
+     * @param {Object} [config] A dictionary of config options to override
      */
-    clear_opt_in_out_capturing(options?: Partial<OptInOutCapturingOptions>): void;
+    clear_opt_in_out_capturing(): void;
     debug(debug?: boolean): void;
 }
 
 declare const posthog: PostHog;
 
-export { type AutocaptureCompatibleElement, type AutocaptureConfig, type BasicSurveyQuestion, type BootstrapConfig, type Breaker, type CaptureOptions, type CaptureResult, type CapturedNetworkRequest, Compression, type DecideResponse, type DomAutocaptureEvents, type EarlyAccessFeature, type EarlyAccessFeatureCallback, type EarlyAccessFeatureResponse, type EventHandler, type FeatureFlagsCallback, type FlagVariant, type GDPROptions, type Headers, type InitiatorType, type IsFeatureEnabledOptions, type JsonType, type LinkSurveyQuestion, type MultipleSurveyQuestion, type NetworkRecordOptions, type NetworkRequest, type OptInOutCapturingOptions, type PersistentStore, PostHog, type PostHogConfig, type Properties, type Property, type QueuedRequestOptions, type RatingSurveyQuestion, type RequestCallback, type RequestOptions, type RequestResponse, type RetriableRequestOptions, type SessionIdChangedCallback, type SessionRecordingOptions, type SnippetArrayItem, type Survey, type SurveyAppearance, type SurveyCallback, type SurveyQuestion, SurveyQuestionType, type SurveyResponse, SurveyType, type SurveyUrlMatchType, type ToolbarParams, type ToolbarSource, type ToolbarUserIntent, type ToolbarVersion, posthog as default, posthog };
+export { type AutocaptureCompatibleElement, type AutocaptureConfig, type BasicSurveyQuestion, type BootstrapConfig, type Breaker, type CaptureOptions, type CaptureResult, type CapturedNetworkRequest, Compression, type DecideResponse, type DomAutocaptureEvents, type EarlyAccessFeature, type EarlyAccessFeatureCallback, type EarlyAccessFeatureResponse, type EventHandler, type FeatureFlagsCallback, type FlagVariant, type Headers, type InitiatorType, type IsFeatureEnabledOptions, type JsonType, type LinkSurveyQuestion, type MultipleSurveyQuestion, type NetworkRecordOptions, type NetworkRequest, type OptInOutCapturingOptions, type PersistentStore, PostHog, type PostHogConfig, type Properties, type Property, type QueuedRequestOptions, type RatingSurveyQuestion, type RequestCallback, type RequestOptions, type RequestResponse, type RetriableRequestOptions, type SessionIdChangedCallback, type SessionRecordingOptions, type SnippetArrayItem, type Survey, type SurveyAppearance, type SurveyCallback, type SurveyQuestion, SurveyQuestionType, type SurveyResponse, SurveyType, type SurveyUrlMatchType, type ToolbarParams, type ToolbarSource, type ToolbarUserIntent, type ToolbarVersion, posthog as default, posthog };