@posthog/types 1.386.4 → 1.387.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/capture.d.ts CHANGED
@@ -19,6 +19,7 @@ export interface CaptureResult {
19
19
  properties: Properties;
20
20
  $set?: Properties;
21
21
  $set_once?: Properties;
22
+ $unset?: string[];
22
23
  timestamp?: Date;
23
24
  }
24
25
  export interface CaptureOptions {
@@ -32,6 +33,10 @@ export interface CaptureOptions {
32
33
  * Will set person properties but only once, it will NOT override previous values
33
34
  */
34
35
  $set_once?: Properties;
36
+ /**
37
+ * Used to unset person properties
38
+ */
39
+ $unset?: string[];
35
40
  /**
36
41
  * Used to override the desired endpoint for the captured event
37
42
  */
@@ -1 +1 @@
1
- {"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,mBAAmB,GACnB,YAAY,CAAA;AAElB;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAC9B,MAAM,GACN,WAAW,GACX,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,sBAAsB,CAAA;AAE5B,MAAM,MAAM,SAAS,GACf,wBAAwB,GACxB,cAAc,GAId,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEnB,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,SAAS,CAAC,EAAE,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,YAAY,CAAA;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAEhB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC5C;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,KAAK,aAAa,GAAG,IAAI,CAAA"}
1
+ {"version":3,"file":"capture.d.ts","sourceRoot":"","sources":["../src/capture.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAE1C;;;;GAIG;AACH,MAAM,MAAM,cAAc,GACpB,gBAAgB,GAChB,SAAS,GACT,YAAY,GACZ,WAAW,GACX,aAAa,GACb,aAAa,GACb,cAAc,GACd,mBAAmB,GACnB,YAAY,CAAA;AAElB;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAC9B,MAAM,GACN,WAAW,GACX,YAAY,GACZ,WAAW,GACX,gBAAgB,GAChB,eAAe,GACf,sBAAsB,CAAA;AAE5B,MAAM,MAAM,SAAS,GACf,wBAAwB,GACxB,cAAc,GAId,CAAC,MAAM,GAAG,EAAE,CAAC,CAAA;AAEnB,MAAM,WAAW,aAAa;IAC1B,IAAI,EAAE,MAAM,CAAA;IACZ,KAAK,EAAE,SAAS,CAAA;IAChB,UAAU,EAAE,UAAU,CAAA;IACtB,IAAI,CAAC,EAAE,UAAU,CAAA;IACjB,SAAS,CAAC,EAAE,UAAU,CAAA;IACtB,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IACjB,SAAS,CAAC,EAAE,IAAI,CAAA;CACnB;AAED,MAAM,WAAW,cAAc;IAC3B;;;OAGG;IACH,IAAI,CAAC,EAAE,UAAU,CAAA;IAEjB;;;OAGG;IACH,SAAS,CAAC,EAAE,UAAU,CAAA;IAEtB;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;OAEG;IACH,SAAS,CAAC,EAAE,MAAM,CAAA;IAElB;;OAEG;IACH,WAAW,CAAC,EAAE,OAAO,CAAA;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,OAAO,CAAA;IAExB;;OAEG;IACH,yBAAyB,CAAC,EAAE,OAAO,CAAA;IAEnC;;OAEG;IACH,SAAS,CAAC,EAAE,KAAK,GAAG,OAAO,GAAG,YAAY,CAAA;IAE1C;;OAEG;IACH,SAAS,CAAC,EAAE,IAAI,CAAA;IAEhB;;;;;OAKG;IACH,IAAI,CAAC,EAAE,MAAM,CAAA;IAEb;;;;OAIG;IACH,+BAA+B,CAAC,EAAE,OAAO,CAAA;CAC5C;AAED,MAAM,MAAM,YAAY,GAAG,CAAC,EAAE,EAAE,aAAa,GAAG,IAAI,KAAK,aAAa,GAAG,IAAI,CAAA"}
@@ -1469,7 +1469,7 @@ export interface PostHogConfig {
1469
1469
  * There are three options:
1470
1470
  * - `person_profiles: 'always'` - we will process persons data for all events
1471
1471
  * - `person_profiles: 'never'` - we won't process persons for any event. This means that anonymous users will not be merged once they sign up or login, so you lose the ability to create funnels that track users from anonymous to identified. All events (including `$identify`) will be sent with `$process_person_profile: False`.
1472
- * - `person_profiles: 'identified_only'` _(default)_ - we will only process persons when you call `posthog.identify`, `posthog.alias`, `posthog.setPersonProperties`, `posthog.group`, `posthog.setPersonPropertiesForFlags` or `posthog.setGroupPropertiesForFlags` Anonymous users won't get person profiles.
1472
+ * - `person_profiles: 'identified_only'` _(default)_ - we will only process persons when you call `posthog.identify`, `posthog.alias`, `posthog.setPersonProperties`, `posthog.unsetPersonProperties`, `posthog.group`, `posthog.setPersonPropertiesForFlags` or `posthog.setGroupPropertiesForFlags` Anonymous users won't get person profiles.
1473
1473
  *
1474
1474
  * @default 'identified_only'
1475
1475
  */
package/dist/posthog.d.ts CHANGED
@@ -126,6 +126,12 @@ export interface PostHog {
126
126
  * @param userPropertiesToSetOnce - Properties to set once on the user (using $set_once)
127
127
  */
128
128
  setPersonProperties(userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties): void;
129
+ /**
130
+ * Remove properties from the current user.
131
+ *
132
+ * @param propertyNames - The name (or names) of the person properties to remove (using $unset)
133
+ */
134
+ unsetPersonProperties(propertyNames: string | string[]): void;
129
135
  /**
130
136
  * Create an alias for the current user.
131
137
  *
@@ -1 +1 @@
1
- {"version":3,"file":"posthog.d.ts","sourceRoot":"","sources":["../src/posthog.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC9D,OAAO,KAAK,EACR,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,EAC9B,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAChD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAErD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAA;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAA;IAM5B;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAM5E;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,GAAG,SAAS,CAAA;IAEhH;;;;;;OAMG;IACH,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,oBAAoB,CAAC,EAAE,UAAU,GAAG,aAAa,GAAG,SAAS,CAAA;IAE9F;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEhE;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAE5C;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAA;IAMd;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEhH;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnD;;OAEG;IACH,aAAa,IAAI,IAAI,CAAA;IAErB;;;;;OAKG;IACH,mBAAmB,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjG;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,MAAM,CAAA;IAEtE;;;;OAIG;IACH,eAAe,IAAI,MAAM,CAAA;IAEzB;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEtC;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,qBAAqB,IAAI,IAAI,CAAA;IAM7B;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEnF;;;;OAIG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAEhC;;OAEG;IACH,WAAW,IAAI,IAAI,CAAA;IAMnB;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;QACxB;;;;;;;;;;;;;;;;;;WAkBG;QACH,oBAAoB,CAAC,eAAe,EAAE,2BAA2B,GAAG,IAAI,CAAA;QAExE;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;KAC1G,CAAC,CAAA;IAEF;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IAEvF;;;;;;OAMG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;IAE5C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,SAAS,CAAA;IAE9F;;;;;;;;OAQG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,GAAG,SAAS,CAAA;IAEhF;;OAEG;IACH,kBAAkB,IAAI,IAAI,CAAA;IAE1B;;;;;;OAMG;IACH,WAAW,CACP,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,EACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EACnC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC9B,IAAI,CAAA;IAEP;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,oBAAoB,GAAG,MAAM,IAAI,CAAA;IAE1D;;;;;OAKG;IACH,2BAA2B,CAAC,UAAU,EAAE,UAAU,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEvF;;;;OAIG;IACH,6BAA6B,CAAC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEjE;;;;;OAKG;IACH,0BAA0B,CAAC,UAAU,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAE1G;;;;OAIG;IACH,4BAA4B,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAMvD;;;;;;OAMG;IACH,sBAAsB,CAClB,QAAQ,EAAE,0BAA0B,EACpC,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,uBAAuB,EAAE,GACnC,IAAI,CAAA;IAEP;;;;;;OAMG;IACH,kCAAkC,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;IAM3G;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErD;;;;;;OAMG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/E;;;;OAIG;IACH,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9C;;;;;OAKG;IACH,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAA;IAEpD;;;;;OAKG;IACH,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAA;IAM1D;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAA;IAExB;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,wBAAwB,GAAG,MAAM,IAAI,CAAA;IAE3D;;;;;;;OAOG;IACH,sBAAsB,CAAC,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAA;IAEjG;;;;;;;;OAQG;IACH,qBAAqB,CACjB,QAAQ,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,IAAI,CAAC;QAAC,aAAa,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI,GAC1G,IAAI,CAAA;IAEP;;OAEG;IACH,oBAAoB,IAAI,IAAI,CAAA;IAE5B;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAA;IAElC;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACf,+DAA+D;QAC/D,kCAAkC,EAAE,OAAO,CAAA;KAC9C,CAAA;IAED;;OAEG;IACH,cAAc,CAAC,EAAE;QACb,mDAAmD;QACnD,cAAc,EAAE,MAAM,IAAI,CAAA;KAC7B,CAAA;IAMD;;OAEG;IACH,gBAAgB,IAAI,IAAI,CAAA;IAExB;;OAEG;IACH,iBAAiB,IAAI,IAAI,CAAA;IAEzB;;;;OAIG;IACH,sBAAsB,IAAI,OAAO,CAAA;IAEjC;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAA;IAElC;;;;OAIG;IACH,2BAA2B,IAAI,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;IAE/D;;OAEG;IACH,0BAA0B,IAAI,IAAI,CAAA;IAMlC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAAA;IAEhD;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAM5B;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAE3E;;;;;OAKG;IACH,wBAAwB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEzF;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtD;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,GAAG,IAAI,CAAA;IAE5D;;;;;;OAMG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAM1F;;;;;;OAMG;IACH,EAAE,CAAC,KAAK,EAAE,eAAe,GAAG,uBAAuB,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;IAM9F;;;;OAIG;IACH,yBAAyB,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAA;IAEpE;;OAEG;IACH,wBAAwB,IAAI,IAAI,CAAA;IAMhC;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAA;IAM3C;;;;OAIG;IACH,aAAa,IAAI,MAAM,GAAG,SAAS,CAAA;IAMnC;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1E;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;IAM9G;;OAEG;IACH,MAAM,EAAE;QACJ,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,KAAK,IAAI,CAAA;QACjF,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,KAAK,IAAI,CAAA;KACzF,CAAA;IAED;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAA;CAChC"}
1
+ {"version":3,"file":"posthog.d.ts","sourceRoot":"","sources":["../src/posthog.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAEH,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AACrD,OAAO,KAAK,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AACpD,OAAO,KAAK,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA;AAC9D,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,eAAe,CAAA;AAC9D,OAAO,KAAK,EACR,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,iBAAiB,EACjB,kBAAkB,EAClB,2BAA2B,EAC9B,MAAM,iBAAiB,CAAA;AACxB,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,qBAAqB,CAAA;AACnE,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAChD,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAClD,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,WAAW,CAAA;AAC9C,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,kBAAkB,CAAA;AAClE,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,kBAAkB,CAAA;AAErD;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,WAAW,OAAO;IACpB;;OAEG;IACH,MAAM,EAAE,aAAa,CAAA;IAErB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAA;IAEf;;OAEG;IACH,QAAQ,EAAE,OAAO,CAAA;IAEjB;;OAEG;IACH,mBAAmB,EAAE,OAAO,CAAA;IAM5B;;;;;;;OAOG;IACH,IAAI,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,aAAa,CAAC,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,OAAO,CAAA;IAM5E;;;;;;;OAOG;IACH,OAAO,CAAC,UAAU,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,aAAa,GAAG,SAAS,CAAA;IAEhH;;;;;;OAMG;IACH,gBAAgB,CAAC,KAAK,EAAE,OAAO,EAAE,oBAAoB,CAAC,EAAE,UAAU,GAAG,aAAa,GAAG,SAAS,CAAA;IAE9F;;;;;OAKG;IACH,gBAAgB,CAAC,OAAO,EAAE,MAAM,EAAE,UAAU,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEhE;;;;OAIG;IACH,UAAU,CAAC,OAAO,EAAE,iBAAiB,GAAG,IAAI,CAAA;IAE5C;;;;;;;;OAQG;IACH,MAAM,EAAE,MAAM,CAAA;IAMd;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEhH;;;;;OAKG;IACH,WAAW,CAAC,UAAU,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,IAAI,CAAA;IAEnD;;OAEG;IACH,aAAa,IAAI,IAAI,CAAA;IAErB;;;;;OAKG;IACH,mBAAmB,CAAC,mBAAmB,CAAC,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEjG;;;;OAIG;IACH,qBAAqB,CAAC,aAAa,EAAE,MAAM,GAAG,MAAM,EAAE,GAAG,IAAI,CAAA;IAE7D;;;;;OAKG;IACH,KAAK,CAAC,KAAK,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,aAAa,GAAG,IAAI,GAAG,MAAM,CAAA;IAEtE;;;;OAIG;IACH,eAAe,IAAI,MAAM,CAAA;IAEzB;;;;OAIG;IACH,KAAK,CAAC,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEtC;;OAEG;IACH,mBAAmB,IAAI,IAAI,CAAA;IAE3B;;;;;;;;;;;;;;;;;;;;OAoBG;IACH,qBAAqB,IAAI,IAAI,CAAA;IAM7B;;;;;;OAMG;IACH,KAAK,CAAC,SAAS,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,EAAE,oBAAoB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEnF;;;;OAIG;IACH,SAAS,IAAI,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;IAEhC;;OAEG;IACH,WAAW,IAAI,IAAI,CAAA;IAMnB;;OAEG;IACH,YAAY,EAAE,aAAa,CAAC;QACxB;;;;;;;;;;;;;;;;;;WAkBG;QACH,oBAAoB,CAAC,eAAe,EAAE,2BAA2B,GAAG,IAAI,CAAA;QAExE;;WAEG;QACH,QAAQ,CAAC,KAAK,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAAE,eAAe,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;KAC1G,CAAC,CAAA;IAEF;;;;;;;;OAQG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IAEvF;;;;;;OAMG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;IAE5C;;;;;;;;;;OAUG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,iBAAiB,GAAG,SAAS,CAAA;IAE9F;;;;;;;;OAQG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,kBAAkB,GAAG,OAAO,GAAG,SAAS,CAAA;IAEhF;;OAEG;IACH,kBAAkB,IAAI,IAAI,CAAA;IAE1B;;;;;;OAMG;IACH,WAAW,CACP,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,GAAG,MAAM,CAAC,EACvC,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,QAAQ,CAAC,EACnC,OAAO,CAAC,EAAE;QAAE,KAAK,CAAC,EAAE,OAAO,CAAA;KAAE,GAC9B,IAAI,CAAA;IAEP;;;;;OAKG;IACH,cAAc,CAAC,QAAQ,EAAE,oBAAoB,GAAG,MAAM,IAAI,CAAA;IAE1D;;;;;OAKG;IACH,2BAA2B,CAAC,UAAU,EAAE,UAAU,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEvF;;;;OAIG;IACH,6BAA6B,CAAC,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEjE;;;;;OAKG;IACH,0BAA0B,CAAC,UAAU,EAAE;QAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,CAAA;KAAE,EAAE,kBAAkB,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAE1G;;;;OAIG;IACH,4BAA4B,CAAC,UAAU,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAMvD;;;;;;OAMG;IACH,sBAAsB,CAClB,QAAQ,EAAE,0BAA0B,EACpC,WAAW,CAAC,EAAE,OAAO,EACrB,MAAM,CAAC,EAAE,uBAAuB,EAAE,GACnC,IAAI,CAAA;IAEP;;;;;;OAMG;IACH,kCAAkC,CAAC,GAAG,EAAE,MAAM,EAAE,UAAU,EAAE,OAAO,EAAE,KAAK,CAAC,EAAE,uBAAuB,GAAG,IAAI,CAAA;IAM3G;;;;;OAKG;IACH,QAAQ,CAAC,UAAU,EAAE,UAAU,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAErD;;;;;;OAMG;IACH,aAAa,CAAC,UAAU,EAAE,UAAU,EAAE,aAAa,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAA;IAE/E;;;;OAIG;IACH,oBAAoB,CAAC,UAAU,EAAE,UAAU,GAAG,IAAI,CAAA;IAElD;;;;OAIG;IACH,UAAU,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAElC;;;;OAIG;IACH,sBAAsB,CAAC,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAE9C;;;;;OAKG;IACH,YAAY,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAA;IAEpD;;;;;OAKG;IACH,kBAAkB,CAAC,aAAa,EAAE,MAAM,GAAG,GAAG,GAAG,SAAS,CAAA;IAM1D;;;;OAIG;IACH,cAAc,IAAI,MAAM,CAAA;IAExB;;;;;OAKG;IACH,WAAW,CAAC,QAAQ,EAAE,wBAAwB,GAAG,MAAM,IAAI,CAAA;IAE3D;;;;;;;OAOG;IACH,sBAAsB,CAAC,OAAO,CAAC,EAAE;QAAE,aAAa,CAAC,EAAE,OAAO,CAAC;QAAC,iBAAiB,CAAC,EAAE,MAAM,CAAA;KAAE,GAAG,MAAM,CAAA;IAEjG;;;;;;;;OAQG;IACH,qBAAqB,CACjB,QAAQ,CAAC,EAAE;QAAE,QAAQ,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,OAAO,CAAC;QAAC,WAAW,CAAC,EAAE,IAAI,CAAC;QAAC,aAAa,CAAC,EAAE,IAAI,CAAA;KAAE,GAAG,IAAI,GAC1G,IAAI,CAAA;IAEP;;OAEG;IACH,oBAAoB,IAAI,IAAI,CAAA;IAE5B;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAA;IAElC;;OAEG;IACH,gBAAgB,CAAC,EAAE;QACf,+DAA+D;QAC/D,kCAAkC,EAAE,OAAO,CAAA;KAC9C,CAAA;IAED;;OAEG;IACH,cAAc,CAAC,EAAE;QACb,mDAAmD;QACnD,cAAc,EAAE,MAAM,IAAI,CAAA;KAC7B,CAAA;IAMD;;OAEG;IACH,gBAAgB,IAAI,IAAI,CAAA;IAExB;;OAEG;IACH,iBAAiB,IAAI,IAAI,CAAA;IAEzB;;;;OAIG;IACH,sBAAsB,IAAI,OAAO,CAAA;IAEjC;;;;OAIG;IACH,uBAAuB,IAAI,OAAO,CAAA;IAElC;;;;OAIG;IACH,2BAA2B,IAAI,SAAS,GAAG,QAAQ,GAAG,SAAS,CAAA;IAE/D;;OAEG;IACH,0BAA0B,IAAI,IAAI,CAAA;IAMlC;;;;OAIG;IACH,UAAU,CAAC,MAAM,EAAE,OAAO,CAAC,aAAa,CAAC,GAAG,IAAI,CAAA;IAEhD;;;;OAIG;IACH,KAAK,CAAC,KAAK,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAM5B;;;;;OAKG;IACH,UAAU,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAE3E;;;;;OAKG;IACH,wBAAwB,CAAC,QAAQ,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE,KAAK,IAAI,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,IAAI,CAAA;IAEzF;;;;;OAKG;IACH,YAAY,CAAC,QAAQ,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,GAAG,IAAI,CAAA;IAEtD;;;;;OAKG;IACH,eAAe,CAAC,QAAQ,EAAE,MAAM,GAAG,kBAAkB,GAAG,IAAI,CAAA;IAE5D;;;;;;OAMG;IACH,oBAAoB,CAAC,QAAQ,EAAE,MAAM,EAAE,WAAW,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,kBAAkB,CAAC,CAAA;IAM1F;;;;;;OAMG;IACH,EAAE,CAAC,KAAK,EAAE,eAAe,GAAG,uBAAuB,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;IAM9F;;;;OAIG;IACH,yBAAyB,CAAC,MAAM,CAAC,EAAE,0BAA0B,GAAG,IAAI,CAAA;IAEpE;;OAEG;IACH,wBAAwB,IAAI,IAAI,CAAA;IAMhC;;;;;OAKG;IACH,WAAW,CAAC,MAAM,EAAE,aAAa,GAAG,OAAO,CAAA;IAM3C;;;;OAIG;IACH,aAAa,IAAI,MAAM,GAAG,SAAS,CAAA;IAMnC;;;;;OAKG;IACH,oBAAoB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAAA;IAE1E;;;;;;OAMG;IACH,kBAAkB,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,EAAE,UAAU,EAAE,MAAM,EAAE,WAAW,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,GAAG,IAAI,CAAA;IAM9G;;OAEG;IACH,MAAM,EAAE;QACJ,GAAG,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,KAAK,IAAI,CAAA;QACjF,QAAQ,EAAE,CAAC,IAAI,EAAE,MAAM,GAAG,UAAU,EAAE,EAAE,CAAC,EAAE,MAAM,EAAE,QAAQ,CAAC,EAAE,eAAe,KAAK,IAAI,CAAA;KACzF,CAAA;IAED;;OAEG;IACH,oBAAoB,EAAE,OAAO,CAAA;CAChC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@posthog/types",
3
- "version": "1.386.4",
3
+ "version": "1.387.0",
4
4
  "bugs": {
5
5
  "url": "https://github.com/PostHog/posthog-js/issues"
6
6
  },
package/src/capture.ts CHANGED
@@ -46,6 +46,7 @@ export interface CaptureResult {
46
46
  properties: Properties
47
47
  $set?: Properties
48
48
  $set_once?: Properties
49
+ $unset?: string[]
49
50
  timestamp?: Date
50
51
  }
51
52
 
@@ -62,6 +63,11 @@ export interface CaptureOptions {
62
63
  */
63
64
  $set_once?: Properties
64
65
 
66
+ /**
67
+ * Used to unset person properties
68
+ */
69
+ $unset?: string[]
70
+
65
71
  /**
66
72
  * Used to override the desired endpoint for the captured event
67
73
  */
@@ -1652,7 +1652,7 @@ export interface PostHogConfig {
1652
1652
  * There are three options:
1653
1653
  * - `person_profiles: 'always'` - we will process persons data for all events
1654
1654
  * - `person_profiles: 'never'` - we won't process persons for any event. This means that anonymous users will not be merged once they sign up or login, so you lose the ability to create funnels that track users from anonymous to identified. All events (including `$identify`) will be sent with `$process_person_profile: False`.
1655
- * - `person_profiles: 'identified_only'` _(default)_ - we will only process persons when you call `posthog.identify`, `posthog.alias`, `posthog.setPersonProperties`, `posthog.group`, `posthog.setPersonPropertiesForFlags` or `posthog.setGroupPropertiesForFlags` Anonymous users won't get person profiles.
1655
+ * - `person_profiles: 'identified_only'` _(default)_ - we will only process persons when you call `posthog.identify`, `posthog.alias`, `posthog.setPersonProperties`, `posthog.unsetPersonProperties`, `posthog.group`, `posthog.setPersonPropertiesForFlags` or `posthog.setGroupPropertiesForFlags` Anonymous users won't get person profiles.
1656
1656
  *
1657
1657
  * @default 'identified_only'
1658
1658
  */
package/src/posthog.ts CHANGED
@@ -161,6 +161,13 @@ export interface PostHog {
161
161
  */
162
162
  setPersonProperties(userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties): void
163
163
 
164
+ /**
165
+ * Remove properties from the current user.
166
+ *
167
+ * @param propertyNames - The name (or names) of the person properties to remove (using $unset)
168
+ */
169
+ unsetPersonProperties(propertyNames: string | string[]): void
170
+
164
171
  /**
165
172
  * Create an alias for the current user.
166
173
  *