posthog-js 1.70.2 → 1.71.0

package/dist/module.d.ts

@@ -440,24 +440,6 @@ declare type NetworkRequest = {
     url: string;
 };
 
-/**
- * PostHog People Object
- * @constructor
- */
-declare class PostHogPeople {
-    _posthog: PostHog;
-    set: (prop: string | Properties, to?: string, callback?: RequestCallback) => void;
-    set_once: (prop: string | Properties, to?: string, callback?: RequestCallback) => void;
-    constructor(posthog: PostHog);
-    toString(): string;
-    _send_request(data: Properties, callback?: RequestCallback): Properties;
-    _get_config<K extends keyof PostHogConfig>(conf_var: K): PostHogConfig[K];
-    _is_reserved_property(prop: string): boolean;
-    private set_action;
-    private set_once_action;
-    private apiActionParser;
-}
-
 /**
  * PostHog Persistence Object
  * @constructor
@@ -1204,7 +1186,6 @@ declare class PostHog {
     sessionPersistence: PostHogPersistence;
     sessionManager: SessionIdManager;
     pageViewIdManager: PageViewIdManager;
-    people: PostHogPeople;
     featureFlags: PostHogFeatureFlags;
     surveys: PostHogSurveys;
     toolbar: Toolbar;
@@ -1224,6 +1205,11 @@ declare class PostHog {
     SentryIntegration: typeof SentryIntegration;
     segmentIntegration: () => any;
     private uuidFn;
+    /** DEPRECATED: We keep this to support existing usage but now one should just call .setPersonProperties */
+    people: {
+        set: (prop: string | Properties, to?: string, callback?: RequestCallback) => void;
+        set_once: (prop: string | Properties, to?: string, callback?: RequestCallback) => void;
+    };
     constructor();
     /**
      * This function initializes a new instance of the PostHog capturing object.
@@ -1457,6 +1443,14 @@ declare class PostHog {
      * @param {Object} [userPropertiesToSetOnce] Optional: An associative array of properties to store about the user. If property is previously set, this does not override that value.
      */
     identify(new_distinct_id?: string, userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties): void;
+    /**
+     * Sets properties for the Person associated with the current distinct_id.
+     *
+     *
+     * @param {Object} [userPropertiesToSet] Optional: An associative array of properties to store about the user
+     * @param {Object} [userPropertiesToSetOnce] Optional: An associative array of properties to store about the user. If property is previously set, this does not override that value.
+     */
+    setPersonProperties(userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties): void;
     /**
      * Alpha feature: don't use unless you know what you're doing!
      *