@posthog/types 1.335.5 → 1.336.1
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 +13 -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 +14 -1
- package/dist/posthog.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/feature-flags.ts +14 -0
- package/src/index.ts +1 -0
- package/src/posthog.ts +18 -1
package/dist/feature-flags.d.ts
CHANGED
|
@@ -38,6 +38,19 @@ export interface EarlyAccessFeature {
|
|
|
38
38
|
}
|
|
39
39
|
export type EarlyAccessFeatureStage = 'concept' | 'alpha' | 'beta' | 'general-availability';
|
|
40
40
|
export type EarlyAccessFeatureCallback = (earlyAccessFeatures: EarlyAccessFeature[]) => void;
|
|
41
|
+
/**
|
|
42
|
+
* Result of evaluating a feature flag, including both the flag value and its payload.
|
|
43
|
+
*/
|
|
44
|
+
export type FeatureFlagResult = {
|
|
45
|
+
/** The key of the feature flag */
|
|
46
|
+
readonly key: string;
|
|
47
|
+
/** Whether the feature flag is enabled (truthy value) */
|
|
48
|
+
readonly enabled: boolean;
|
|
49
|
+
/** The variant key if this is a multivariate flag, undefined for boolean flags */
|
|
50
|
+
readonly variant: string | undefined;
|
|
51
|
+
/** The JSON payload associated with this flag, if any */
|
|
52
|
+
readonly payload: JsonType | undefined;
|
|
53
|
+
};
|
|
41
54
|
export interface EarlyAccessFeatureResponse {
|
|
42
55
|
earlyAccessFeatures: EarlyAccessFeature[];
|
|
43
56
|
}
|
|
@@ -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;CAC5C,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,MAAM,WAAW,0BAA0B;IACvC,mBAAmB,EAAE,kBAAkB,EAAE,CAAA;CAC5C"}
|
|
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;CAC5C,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"}
|
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, RemoteConfigFeatureFlagCallback, EarlyAccessFeature, EarlyAccessFeatureStage, EarlyAccessFeatureCallback, EarlyAccessFeatureResponse, } from './feature-flags';
|
|
10
|
+
export type { FeatureFlagsCallback, FeatureFlagDetail, FeatureFlagMetadata, EvaluationReason, FeatureFlagResult, RemoteConfigFeatureFlagCallback, EarlyAccessFeature, EarlyAccessFeatureStage, EarlyAccessFeatureCallback, EarlyAccessFeatureResponse, } 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,+BAA+B,EAC/B,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,GAC7B,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,+BAA+B,EAC/B,kBAAkB,EAClB,uBAAuB,EACvB,0BAA0B,EAC1B,0BAA0B,GAC7B,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 } from './feature-flags';
|
|
10
|
+
import type { FeatureFlagsCallback, EarlyAccessFeatureCallback, EarlyAccessFeatureStage, FeatureFlagResult } 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';
|
|
@@ -146,8 +146,21 @@ export interface PostHog {
|
|
|
146
146
|
*
|
|
147
147
|
* @param key - The feature flag key
|
|
148
148
|
* @returns The feature flag payload
|
|
149
|
+
* @deprecated Use `getFeatureFlagResult()` instead which properly tracks the feature flag call.
|
|
149
150
|
*/
|
|
150
151
|
getFeatureFlagPayload(key: string): JsonType;
|
|
152
|
+
/**
|
|
153
|
+
* Get a feature flag evaluation result including both the flag value and payload.
|
|
154
|
+
*
|
|
155
|
+
* By default, this method emits the `$feature_flag_called` event.
|
|
156
|
+
*
|
|
157
|
+
* @param key - The feature flag key
|
|
158
|
+
* @param options - Options for the feature flag lookup
|
|
159
|
+
* @returns The feature flag result including key, enabled, variant, and payload, or undefined if not loaded
|
|
160
|
+
*/
|
|
161
|
+
getFeatureFlagResult(key: string, options?: {
|
|
162
|
+
send_event?: boolean;
|
|
163
|
+
}): FeatureFlagResult | undefined;
|
|
151
164
|
/**
|
|
152
165
|
* Check if a feature flag is enabled.
|
|
153
166
|
*
|
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,
|
|
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,EACpB,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;IAM3B;;;;;;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;;;;;;OAMG;IACH,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,GAAG,MAAM,GAAG,SAAS,CAAA;IAE7F;;;;;;OAMG;IACH,qBAAqB,CAAC,GAAG,EAAE,MAAM,GAAG,QAAQ,CAAA;IAE5C;;;;;;;;OAQG;IACH,oBAAoB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,iBAAiB,GAAG,SAAS,CAAA;IAEpG;;;;;;OAMG;IACH,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE;QAAE,UAAU,CAAC,EAAE,OAAO,CAAA;KAAE,GAAG,OAAO,GAAG,SAAS,CAAA;IAEtF;;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,EAAE,EAAE,EAAE,CAAC,GAAG,IAAI,EAAE,GAAG,EAAE,KAAK,IAAI,GAAG,MAAM,IAAI,CAAA;IAMpE;;;;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
|
@@ -55,6 +55,20 @@ export interface EarlyAccessFeature {
|
|
|
55
55
|
export type EarlyAccessFeatureStage = 'concept' | 'alpha' | 'beta' | 'general-availability'
|
|
56
56
|
export type EarlyAccessFeatureCallback = (earlyAccessFeatures: EarlyAccessFeature[]) => void
|
|
57
57
|
|
|
58
|
+
/**
|
|
59
|
+
* Result of evaluating a feature flag, including both the flag value and its payload.
|
|
60
|
+
*/
|
|
61
|
+
export type FeatureFlagResult = {
|
|
62
|
+
/** The key of the feature flag */
|
|
63
|
+
readonly key: string
|
|
64
|
+
/** Whether the feature flag is enabled (truthy value) */
|
|
65
|
+
readonly enabled: boolean
|
|
66
|
+
/** The variant key if this is a multivariate flag, undefined for boolean flags */
|
|
67
|
+
readonly variant: string | undefined
|
|
68
|
+
/** The JSON payload associated with this flag, if any */
|
|
69
|
+
readonly payload: JsonType | undefined
|
|
70
|
+
}
|
|
71
|
+
|
|
58
72
|
export interface EarlyAccessFeatureResponse {
|
|
59
73
|
earlyAccessFeatures: EarlyAccessFeature[]
|
|
60
74
|
}
|
package/src/index.ts
CHANGED
package/src/posthog.ts
CHANGED
|
@@ -8,7 +8,12 @@
|
|
|
8
8
|
import type { PostHogConfig } from './posthog-config'
|
|
9
9
|
import type { Properties, JsonType } from './common'
|
|
10
10
|
import type { CaptureResult, CaptureOptions } from './capture'
|
|
11
|
-
import type {
|
|
11
|
+
import type {
|
|
12
|
+
FeatureFlagsCallback,
|
|
13
|
+
EarlyAccessFeatureCallback,
|
|
14
|
+
EarlyAccessFeatureStage,
|
|
15
|
+
FeatureFlagResult,
|
|
16
|
+
} from './feature-flags'
|
|
12
17
|
import type { SessionIdChangedCallback } from './session-recording'
|
|
13
18
|
import type { RequestCallback } from './request'
|
|
14
19
|
import type { SurveyRenderReason } from './survey'
|
|
@@ -183,9 +188,21 @@ export interface PostHog {
|
|
|
183
188
|
*
|
|
184
189
|
* @param key - The feature flag key
|
|
185
190
|
* @returns The feature flag payload
|
|
191
|
+
* @deprecated Use `getFeatureFlagResult()` instead which properly tracks the feature flag call.
|
|
186
192
|
*/
|
|
187
193
|
getFeatureFlagPayload(key: string): JsonType
|
|
188
194
|
|
|
195
|
+
/**
|
|
196
|
+
* Get a feature flag evaluation result including both the flag value and payload.
|
|
197
|
+
*
|
|
198
|
+
* By default, this method emits the `$feature_flag_called` event.
|
|
199
|
+
*
|
|
200
|
+
* @param key - The feature flag key
|
|
201
|
+
* @param options - Options for the feature flag lookup
|
|
202
|
+
* @returns The feature flag result including key, enabled, variant, and payload, or undefined if not loaded
|
|
203
|
+
*/
|
|
204
|
+
getFeatureFlagResult(key: string, options?: { send_event?: boolean }): FeatureFlagResult | undefined
|
|
205
|
+
|
|
189
206
|
/**
|
|
190
207
|
* Check if a feature flag is enabled.
|
|
191
208
|
*
|