@posthog/types 1.351.3 → 1.352.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/feature-flags.d.ts +15 -0
- package/dist/feature-flags.d.ts.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/posthog.d.ts +10 -10
- package/dist/posthog.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/feature-flags.ts +16 -0
- package/src/index.ts +1 -0
- package/src/posthog.ts +10 -3
package/dist/feature-flags.d.ts
CHANGED
|
@@ -66,6 +66,21 @@ export type FeatureFlagOverrideOptions = {
|
|
|
66
66
|
payloads?: FeatureFlagPayloadOverrides;
|
|
67
67
|
suppressWarning?: boolean;
|
|
68
68
|
};
|
|
69
|
+
/**
|
|
70
|
+
* Options for feature flag lookup methods (getFeatureFlag, isFeatureEnabled, getFeatureFlagResult).
|
|
71
|
+
*/
|
|
72
|
+
export type FeatureFlagOptions = {
|
|
73
|
+
/**
|
|
74
|
+
* Whether to send a $feature_flag_called event. Defaults to true.
|
|
75
|
+
*/
|
|
76
|
+
send_event?: boolean;
|
|
77
|
+
/**
|
|
78
|
+
* If true, only return values loaded from the server, not cached localStorage values.
|
|
79
|
+
* Returns undefined if flags haven't been loaded from the server yet.
|
|
80
|
+
* Defaults to false.
|
|
81
|
+
*/
|
|
82
|
+
fresh?: boolean;
|
|
83
|
+
};
|
|
69
84
|
/**
|
|
70
85
|
* Options for overriding feature flags on the client-side.
|
|
71
86
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"feature-flags.d.ts","sourceRoot":"","sources":["../src/feature-flags.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAExC,MAAM,MAAM,oBAAoB,GAAG,CAC/B,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAC1C,OAAO,CAAC,EAAE;IACN,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B,KACA,IAAI,CAAA;AAET,MAAM,MAAM,iBAAiB,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAEhB,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAE3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACpC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAA;IACzC,MAAM,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAA;IAE7B,gBAAgB,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAA;AAGzE,kDAAkD;AAClD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;IACnC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,sBAAsB,CAAA;AAC3F,MAAM,MAAM,0BAA0B,GAAG,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,KAAK,IAAI,CAAA;AAE5F;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,kCAAkC;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,kFAAkF;IAClF,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAA;CACzC,CAAA;AAED,MAAM,WAAW,0BAA0B;IACvC,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC5C;AAED,MAAM,MAAM,oBAAoB,GAAG;IAC/B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACtC,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACrC,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,oBAAoB,CAAA;IACjD,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IACtC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,2BAA2B,GACjC,OAAO,GACP,MAAM,EAAE,GACR,oBAAoB,GACpB,0BAA0B,CAAA"}
|
|
1
|
+
{"version":3,"file":"feature-flags.d.ts","sourceRoot":"","sources":["../src/feature-flags.ts"],"names":[],"mappings":"AAAA;;GAEG;AAEH,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,UAAU,CAAA;AAExC,MAAM,MAAM,oBAAoB,GAAG,CAC/B,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,EAC1C,OAAO,CAAC,EAAE;IACN,aAAa,CAAC,EAAE,OAAO,CAAA;CAC1B,KACA,IAAI,CAAA;AAET,MAAM,MAAM,iBAAiB,GAAG;IAC5B,GAAG,EAAE,MAAM,CAAA;IACX,OAAO,EAAE,OAAO,CAAA;IAEhB,gBAAgB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;IACtC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAE3B,gBAAgB,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAAA;IACpC,QAAQ,EAAE,mBAAmB,GAAG,SAAS,CAAA;IACzC,MAAM,CAAC,EAAE,OAAO,CAAA;CACnB,CAAA;AAED,MAAM,MAAM,mBAAmB,GAAG;IAC9B,EAAE,EAAE,MAAM,CAAA;IACV,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3B,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;IAC/B,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAA;IAE7B,gBAAgB,CAAC,EAAE,QAAQ,GAAG,SAAS,CAAA;CAC1C,CAAA;AAED,MAAM,MAAM,gBAAgB,GAAG;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,eAAe,EAAE,MAAM,GAAG,SAAS,CAAA;IACnC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAA;CAClC,CAAA;AAED,MAAM,MAAM,+BAA+B,GAAG,CAAC,OAAO,EAAE,QAAQ,KAAK,IAAI,CAAA;AAGzE,kDAAkD;AAClD,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,MAAM,CAAA;IACnB,KAAK,EAAE,SAAS,GAAG,OAAO,GAAG,MAAM,CAAA;IACnC,gBAAgB,EAAE,MAAM,GAAG,IAAI,CAAA;IAC/B,OAAO,EAAE,QAAQ,CAAA;IACjB,OAAO,EAAE,MAAM,GAAG,IAAI,CAAA;CACzB;AAED,MAAM,MAAM,uBAAuB,GAAG,SAAS,GAAG,OAAO,GAAG,MAAM,GAAG,sBAAsB,CAAA;AAC3F,MAAM,MAAM,0BAA0B,GAAG,CAAC,mBAAmB,EAAE,kBAAkB,EAAE,KAAK,IAAI,CAAA;AAE5F;;GAEG;AACH,MAAM,MAAM,iBAAiB,GAAG;IAC5B,kCAAkC;IAClC,QAAQ,CAAC,GAAG,EAAE,MAAM,CAAA;IACpB,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,OAAO,CAAA;IACzB,kFAAkF;IAClF,QAAQ,CAAC,OAAO,EAAE,MAAM,GAAG,SAAS,CAAA;IACpC,yDAAyD;IACzD,QAAQ,CAAC,OAAO,EAAE,QAAQ,GAAG,SAAS,CAAA;CACzC,CAAA;AAED,MAAM,WAAW,0BAA0B;IACvC,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC5C;AAED,MAAM,MAAM,oBAAoB,GAAG;IAC/B,CAAC,QAAQ,EAAE,MAAM,GAAG,MAAM,GAAG,OAAO,CAAA;CACvC,CAAA;AAED,MAAM,MAAM,2BAA2B,GAAG;IACtC,CAAC,QAAQ,EAAE,MAAM,GAAG,QAAQ,CAAA;CAC/B,CAAA;AAED,MAAM,MAAM,0BAA0B,GAAG;IACrC,KAAK,CAAC,EAAE,OAAO,GAAG,MAAM,EAAE,GAAG,oBAAoB,CAAA;IACjD,QAAQ,CAAC,EAAE,2BAA2B,CAAA;IACtC,eAAe,CAAC,EAAE,OAAO,CAAA;CAC5B,CAAA;AAED;;GAEG;AACH,MAAM,MAAM,kBAAkB,GAAG;IAC7B;;OAEG;IACH,UAAU,CAAC,EAAE,OAAO,CAAA;IACpB;;;;OAIG;IACH,KAAK,CAAC,EAAE,OAAO,CAAA;CAClB,CAAA;AAED;;;;;;;;GAQG;AACH,MAAM,MAAM,2BAA2B,GACjC,OAAO,GACP,MAAM,EAAE,GACR,oBAAoB,GACpB,0BAA0B,CAAA"}
|
package/dist/index.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
export type { PostHog } from './posthog';
|
|
8
8
|
export type { Property, Properties, JsonType, JsonRecord } from './common';
|
|
9
9
|
export type { KnownEventName, KnownUnsafeEditableEvent, EventName, CaptureResult, CaptureOptions, BeforeSendFn, } from './capture';
|
|
10
|
-
export type { FeatureFlagsCallback, FeatureFlagDetail, FeatureFlagMetadata, EvaluationReason, FeatureFlagResult, RemoteConfigFeatureFlagCallback, EarlyAccessFeature, EarlyAccessFeatureStage, EarlyAccessFeatureCallback, EarlyAccessFeatureResponse, FeatureFlagOverrides, FeatureFlagPayloadOverrides, FeatureFlagOverrideOptions, OverrideFeatureFlagsOptions, } from './feature-flags';
|
|
10
|
+
export type { FeatureFlagsCallback, FeatureFlagDetail, FeatureFlagMetadata, EvaluationReason, FeatureFlagResult, FeatureFlagOptions, RemoteConfigFeatureFlagCallback, EarlyAccessFeature, EarlyAccessFeatureStage, EarlyAccessFeatureCallback, EarlyAccessFeatureResponse, FeatureFlagOverrides, FeatureFlagPayloadOverrides, FeatureFlagOverrideOptions, OverrideFeatureFlagsOptions, } from './feature-flags';
|
|
11
11
|
export type { Headers, RequestResponse, RequestCallback } from './request';
|
|
12
12
|
export type { SessionRecordingCanvasOptions, InitiatorType, NetworkRequest, CapturedNetworkRequest, SessionIdChangedCallback, SeverityLevel, } from './session-recording';
|
|
13
13
|
export type { AutocaptureCompatibleElement, DomAutocaptureEvents, AutocaptureConfig, RageclickConfig, BootstrapConfig, SupportedWebVitalsMetrics, PerformanceCaptureConfig, DeadClickCandidate, ExceptionAutoCaptureConfig, DeadClicksAutoCaptureConfig, HeatmapConfig, ConfigDefaults, ExternalIntegrationKind, ErrorTrackingOptions, MaskInputOptions, SlimDOMOptions, SessionRecordingOptions, RequestQueueConfig, PostHogConfig, } from './posthog-config';
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGxC,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAG1E,YAAY,EACR,cAAc,EACd,wBAAwB,EACxB,SAAS,EACT,aAAa,EACb,cAAc,EACd,YAAY,GACf,MAAM,WAAW,CAAA;AAGlB,YAAY,EACR,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,+BAA+B,EAC/B,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,GAC9B,MAAM,iBAAiB,CAAA;AAGxB,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAG1E,YAAY,EACR,6BAA6B,EAC7B,aAAa,EACb,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,GAChB,MAAM,qBAAqB,CAAA;AAG5B,YAAY,EACR,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,GAChB,MAAM,kBAAkB,CAAA;AAGzB,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAG9G,YAAY,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAGlD,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA"}
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA;;;;;GAKG;AAGH,YAAY,EAAE,OAAO,EAAE,MAAM,WAAW,CAAA;AAGxC,YAAY,EAAE,QAAQ,EAAE,UAAU,EAAE,QAAQ,EAAE,UAAU,EAAE,MAAM,UAAU,CAAA;AAG1E,YAAY,EACR,cAAc,EACd,wBAAwB,EACxB,SAAS,EACT,aAAa,EACb,cAAc,EACd,YAAY,GACf,MAAM,WAAW,CAAA;AAGlB,YAAY,EACR,oBAAoB,EACpB,iBAAiB,EACjB,mBAAmB,EACnB,gBAAgB,EAChB,iBAAiB,EACjB,kBAAkB,EAClB,+BAA+B,EAC/B,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,EAC1B,oBAAoB,EACpB,2BAA2B,EAC3B,0BAA0B,EAC1B,2BAA2B,GAC9B,MAAM,iBAAiB,CAAA;AAGxB,YAAY,EAAE,OAAO,EAAE,eAAe,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAG1E,YAAY,EACR,6BAA6B,EAC7B,aAAa,EACb,cAAc,EACd,sBAAsB,EACtB,wBAAwB,EACxB,aAAa,GAChB,MAAM,qBAAqB,CAAA;AAG5B,YAAY,EACR,4BAA4B,EAC5B,oBAAoB,EACpB,iBAAiB,EACjB,eAAe,EACf,eAAe,EACf,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,0BAA0B,EAC1B,2BAA2B,EAC3B,aAAa,EACb,cAAc,EACd,uBAAuB,EACvB,oBAAoB,EACpB,gBAAgB,EAChB,cAAc,EACd,uBAAuB,EACvB,kBAAkB,EAClB,aAAa,GAChB,MAAM,kBAAkB,CAAA;AAGzB,YAAY,EAAE,WAAW,EAAE,gBAAgB,EAAE,aAAa,EAAE,cAAc,EAAE,eAAe,EAAE,MAAM,WAAW,CAAA;AAG9G,YAAY,EAAE,kBAAkB,EAAE,MAAM,UAAU,CAAA;AAGlD,YAAY,EAAE,aAAa,EAAE,iBAAiB,EAAE,aAAa,EAAE,cAAc,EAAE,MAAM,WAAW,CAAA"}
|
package/dist/posthog.d.ts
CHANGED
|
@@ -7,7 +7,7 @@
|
|
|
7
7
|
import type { PostHogConfig } from './posthog-config';
|
|
8
8
|
import type { Properties, JsonType } from './common';
|
|
9
9
|
import type { CaptureResult, CaptureOptions } from './capture';
|
|
10
|
-
import type { FeatureFlagsCallback, EarlyAccessFeatureCallback, EarlyAccessFeatureStage, FeatureFlagResult, OverrideFeatureFlagsOptions } from './feature-flags';
|
|
10
|
+
import type { FeatureFlagsCallback, EarlyAccessFeatureCallback, EarlyAccessFeatureStage, FeatureFlagResult, FeatureFlagOptions, OverrideFeatureFlagsOptions } from './feature-flags';
|
|
11
11
|
import type { SessionIdChangedCallback } from './session-recording';
|
|
12
12
|
import type { RequestCallback } from './request';
|
|
13
13
|
import type { SurveyRenderReason } from './survey';
|
|
@@ -184,11 +184,11 @@ export interface PostHog {
|
|
|
184
184
|
*
|
|
185
185
|
* @param key - The feature flag key
|
|
186
186
|
* @param options - Options for the feature flag lookup
|
|
187
|
+
* @param options.send_event - Whether to send a $feature_flag_called event (default: true)
|
|
188
|
+
* @param options.fresh - If true, only return values loaded from the server, not cached localStorage values (default: false)
|
|
187
189
|
* @returns The feature flag value (boolean for simple flags, string for multivariate)
|
|
188
190
|
*/
|
|
189
|
-
getFeatureFlag(key: string, options?:
|
|
190
|
-
send_event?: boolean;
|
|
191
|
-
}): boolean | string | undefined;
|
|
191
|
+
getFeatureFlag(key: string, options?: FeatureFlagOptions): boolean | string | undefined;
|
|
192
192
|
/**
|
|
193
193
|
* Get the payload of a feature flag.
|
|
194
194
|
*
|
|
@@ -204,21 +204,21 @@ export interface PostHog {
|
|
|
204
204
|
*
|
|
205
205
|
* @param key - The feature flag key
|
|
206
206
|
* @param options - Options for the feature flag lookup
|
|
207
|
+
* @param options.send_event - Whether to send a $feature_flag_called event (default: true)
|
|
208
|
+
* @param options.fresh - If true, only return values loaded from the server, not cached localStorage values (default: false)
|
|
207
209
|
* @returns The feature flag result including key, enabled, variant, and payload, or undefined if not loaded
|
|
208
210
|
*/
|
|
209
|
-
getFeatureFlagResult(key: string, options?:
|
|
210
|
-
send_event?: boolean;
|
|
211
|
-
}): FeatureFlagResult | undefined;
|
|
211
|
+
getFeatureFlagResult(key: string, options?: FeatureFlagOptions): FeatureFlagResult | undefined;
|
|
212
212
|
/**
|
|
213
213
|
* Check if a feature flag is enabled.
|
|
214
214
|
*
|
|
215
215
|
* @param key - The feature flag key
|
|
216
216
|
* @param options - Options for the feature flag lookup
|
|
217
|
+
* @param options.send_event - Whether to send a $feature_flag_called event (default: true)
|
|
218
|
+
* @param options.fresh - If true, only return values loaded from the server, not cached localStorage values (default: false)
|
|
217
219
|
* @returns Whether the feature flag is enabled
|
|
218
220
|
*/
|
|
219
|
-
isFeatureEnabled(key: string, options?:
|
|
220
|
-
send_event?: boolean;
|
|
221
|
-
}): boolean | undefined;
|
|
221
|
+
isFeatureEnabled(key: string, options?: FeatureFlagOptions): boolean | undefined;
|
|
222
222
|
/**
|
|
223
223
|
* Reload feature flags from the server.
|
|
224
224
|
*/
|
package/dist/posthog.d.ts.map
CHANGED
|
@@ -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,EACR,oBAAoB,EACpB,0BAA0B,EAC1B,uBAAuB,EACvB,iBAAiB,EACjB,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;AAElE;;;;;;;;;;;;;;;;;;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;IAM9F;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEhH;;;;;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;QACV;;;;;;;;;;;;;;;WAeG;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,CAAA;IAED
|
|
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,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;AAElE;;;;;;;;;;;;;;;;;;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;IAM9F;;;;;;OAMG;IACH,QAAQ,CAAC,eAAe,CAAC,EAAE,MAAM,EAAE,mBAAmB,CAAC,EAAE,UAAU,EAAE,uBAAuB,CAAC,EAAE,UAAU,GAAG,IAAI,CAAA;IAEhH;;;;;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;QACV;;;;;;;;;;;;;;;WAeG;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,CAAA;IAED;;;;;;;;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;;OAEG;IACH,6BAA6B,IAAI,IAAI,CAAA;IAErC;;;;;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;;;;;OAKG;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
package/src/feature-flags.ts
CHANGED
|
@@ -88,6 +88,22 @@ export type FeatureFlagOverrideOptions = {
|
|
|
88
88
|
suppressWarning?: boolean
|
|
89
89
|
}
|
|
90
90
|
|
|
91
|
+
/**
|
|
92
|
+
* Options for feature flag lookup methods (getFeatureFlag, isFeatureEnabled, getFeatureFlagResult).
|
|
93
|
+
*/
|
|
94
|
+
export type FeatureFlagOptions = {
|
|
95
|
+
/**
|
|
96
|
+
* Whether to send a $feature_flag_called event. Defaults to true.
|
|
97
|
+
*/
|
|
98
|
+
send_event?: boolean
|
|
99
|
+
/**
|
|
100
|
+
* If true, only return values loaded from the server, not cached localStorage values.
|
|
101
|
+
* Returns undefined if flags haven't been loaded from the server yet.
|
|
102
|
+
* Defaults to false.
|
|
103
|
+
*/
|
|
104
|
+
fresh?: boolean
|
|
105
|
+
}
|
|
106
|
+
|
|
91
107
|
/**
|
|
92
108
|
* Options for overriding feature flags on the client-side.
|
|
93
109
|
*
|
package/src/index.ts
CHANGED
package/src/posthog.ts
CHANGED
|
@@ -13,6 +13,7 @@ import type {
|
|
|
13
13
|
EarlyAccessFeatureCallback,
|
|
14
14
|
EarlyAccessFeatureStage,
|
|
15
15
|
FeatureFlagResult,
|
|
16
|
+
FeatureFlagOptions,
|
|
16
17
|
OverrideFeatureFlagsOptions,
|
|
17
18
|
} from './feature-flags'
|
|
18
19
|
import type { SessionIdChangedCallback } from './session-recording'
|
|
@@ -231,9 +232,11 @@ export interface PostHog {
|
|
|
231
232
|
*
|
|
232
233
|
* @param key - The feature flag key
|
|
233
234
|
* @param options - Options for the feature flag lookup
|
|
235
|
+
* @param options.send_event - Whether to send a $feature_flag_called event (default: true)
|
|
236
|
+
* @param options.fresh - If true, only return values loaded from the server, not cached localStorage values (default: false)
|
|
234
237
|
* @returns The feature flag value (boolean for simple flags, string for multivariate)
|
|
235
238
|
*/
|
|
236
|
-
getFeatureFlag(key: string, options?:
|
|
239
|
+
getFeatureFlag(key: string, options?: FeatureFlagOptions): boolean | string | undefined
|
|
237
240
|
|
|
238
241
|
/**
|
|
239
242
|
* Get the payload of a feature flag.
|
|
@@ -251,18 +254,22 @@ export interface PostHog {
|
|
|
251
254
|
*
|
|
252
255
|
* @param key - The feature flag key
|
|
253
256
|
* @param options - Options for the feature flag lookup
|
|
257
|
+
* @param options.send_event - Whether to send a $feature_flag_called event (default: true)
|
|
258
|
+
* @param options.fresh - If true, only return values loaded from the server, not cached localStorage values (default: false)
|
|
254
259
|
* @returns The feature flag result including key, enabled, variant, and payload, or undefined if not loaded
|
|
255
260
|
*/
|
|
256
|
-
getFeatureFlagResult(key: string, options?:
|
|
261
|
+
getFeatureFlagResult(key: string, options?: FeatureFlagOptions): FeatureFlagResult | undefined
|
|
257
262
|
|
|
258
263
|
/**
|
|
259
264
|
* Check if a feature flag is enabled.
|
|
260
265
|
*
|
|
261
266
|
* @param key - The feature flag key
|
|
262
267
|
* @param options - Options for the feature flag lookup
|
|
268
|
+
* @param options.send_event - Whether to send a $feature_flag_called event (default: true)
|
|
269
|
+
* @param options.fresh - If true, only return values loaded from the server, not cached localStorage values (default: false)
|
|
263
270
|
* @returns Whether the feature flag is enabled
|
|
264
271
|
*/
|
|
265
|
-
isFeatureEnabled(key: string, options?:
|
|
272
|
+
isFeatureEnabled(key: string, options?: FeatureFlagOptions): boolean | undefined
|
|
266
273
|
|
|
267
274
|
/**
|
|
268
275
|
* Reload feature flags from the server.
|