@posthog/types 1.345.3 → 1.345.5
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 +21 -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 +28 -2
- package/dist/posthog.d.ts.map +1 -1
- package/package.json +1 -1
- package/src/feature-flags.ts +29 -0
- package/src/index.ts +4 -0
- package/src/posthog.ts +30 -1
package/dist/feature-flags.d.ts
CHANGED
|
@@ -55,4 +55,25 @@ export type FeatureFlagResult = {
|
|
|
55
55
|
export interface EarlyAccessFeatureResponse {
|
|
56
56
|
earlyAccessFeatures: EarlyAccessFeature[];
|
|
57
57
|
}
|
|
58
|
+
export type FeatureFlagOverrides = {
|
|
59
|
+
[flagName: string]: string | boolean;
|
|
60
|
+
};
|
|
61
|
+
export type FeatureFlagPayloadOverrides = {
|
|
62
|
+
[flagName: string]: JsonType;
|
|
63
|
+
};
|
|
64
|
+
export type FeatureFlagOverrideOptions = {
|
|
65
|
+
flags?: boolean | string[] | FeatureFlagOverrides;
|
|
66
|
+
payloads?: FeatureFlagPayloadOverrides;
|
|
67
|
+
suppressWarning?: boolean;
|
|
68
|
+
};
|
|
69
|
+
/**
|
|
70
|
+
* Options for overriding feature flags on the client-side.
|
|
71
|
+
*
|
|
72
|
+
* Can be:
|
|
73
|
+
* - `false` to clear all overrides
|
|
74
|
+
* - `string[]` to enable a list of flags
|
|
75
|
+
* - `FeatureFlagOverrides` to set variants directly
|
|
76
|
+
* - `FeatureFlagOverrideOptions` for granular control over flags and payloads
|
|
77
|
+
*/
|
|
78
|
+
export type OverrideFeatureFlagsOptions = boolean | string[] | FeatureFlagOverrides | FeatureFlagOverrideOptions;
|
|
58
79
|
//# sourceMappingURL=feature-flags.d.ts.map
|
|
@@ -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"}
|
|
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"}
|
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, } from './feature-flags';
|
|
10
|
+
export type { FeatureFlagsCallback, FeatureFlagDetail, FeatureFlagMetadata, EvaluationReason, FeatureFlagResult, 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,
|
|
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"}
|
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 } from './feature-flags';
|
|
10
|
+
import type { FeatureFlagsCallback, EarlyAccessFeatureCallback, EarlyAccessFeatureStage, FeatureFlagResult, 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';
|
|
@@ -153,6 +153,32 @@ export interface PostHog {
|
|
|
153
153
|
* Reset all groups for the current user.
|
|
154
154
|
*/
|
|
155
155
|
resetGroups(): void;
|
|
156
|
+
/**
|
|
157
|
+
* The feature flags instance. Provides access to feature flag override methods.
|
|
158
|
+
*/
|
|
159
|
+
featureFlags: {
|
|
160
|
+
/**
|
|
161
|
+
* Override feature flags on the client-side. Useful for testing/debugging.
|
|
162
|
+
*
|
|
163
|
+
* @param overrideOptions - The override options
|
|
164
|
+
*
|
|
165
|
+
* @example
|
|
166
|
+
* ```typescript
|
|
167
|
+
* posthog.featureFlags.overrideFeatureFlags(false) // clear all overrides
|
|
168
|
+
* posthog.featureFlags.overrideFeatureFlags(['beta-feature']) // enable flags
|
|
169
|
+
* posthog.featureFlags.overrideFeatureFlags({'beta-feature': 'variant'}) // set variants
|
|
170
|
+
* posthog.featureFlags.overrideFeatureFlags({
|
|
171
|
+
* flags: {'beta-feature': 'variant'},
|
|
172
|
+
* payloads: { 'beta-feature': { someData: true } }
|
|
173
|
+
* })
|
|
174
|
+
* ```
|
|
175
|
+
*/
|
|
176
|
+
overrideFeatureFlags(overrideOptions: OverrideFeatureFlagsOptions): void;
|
|
177
|
+
/**
|
|
178
|
+
* @deprecated Use `overrideFeatureFlags` instead. This will be removed in a future version.
|
|
179
|
+
*/
|
|
180
|
+
override(flags: boolean | string[] | Record<string, string | boolean>, suppressWarning?: boolean): void;
|
|
181
|
+
};
|
|
156
182
|
/**
|
|
157
183
|
* Get the value of a feature flag.
|
|
158
184
|
*
|
|
@@ -450,7 +476,7 @@ export interface PostHog {
|
|
|
450
476
|
* @param cb - The callback to call
|
|
451
477
|
* @returns A function to unsubscribe
|
|
452
478
|
*/
|
|
453
|
-
on(event: 'eventCaptured', cb: (...args: any[]) => void): () => void;
|
|
479
|
+
on(event: 'eventCaptured' | 'featureFlagsReloading', cb: (...args: any[]) => void): () => void;
|
|
454
480
|
/**
|
|
455
481
|
* Start automatic exception capture.
|
|
456
482
|
*
|
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,
|
|
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;;;;;;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,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
|
@@ -73,3 +73,32 @@ export type FeatureFlagResult = {
|
|
|
73
73
|
export interface EarlyAccessFeatureResponse {
|
|
74
74
|
earlyAccessFeatures: EarlyAccessFeature[]
|
|
75
75
|
}
|
|
76
|
+
|
|
77
|
+
export type FeatureFlagOverrides = {
|
|
78
|
+
[flagName: string]: string | boolean
|
|
79
|
+
}
|
|
80
|
+
|
|
81
|
+
export type FeatureFlagPayloadOverrides = {
|
|
82
|
+
[flagName: string]: JsonType
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
export type FeatureFlagOverrideOptions = {
|
|
86
|
+
flags?: boolean | string[] | FeatureFlagOverrides
|
|
87
|
+
payloads?: FeatureFlagPayloadOverrides
|
|
88
|
+
suppressWarning?: boolean
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
/**
|
|
92
|
+
* Options for overriding feature flags on the client-side.
|
|
93
|
+
*
|
|
94
|
+
* Can be:
|
|
95
|
+
* - `false` to clear all overrides
|
|
96
|
+
* - `string[]` to enable a list of flags
|
|
97
|
+
* - `FeatureFlagOverrides` to set variants directly
|
|
98
|
+
* - `FeatureFlagOverrideOptions` for granular control over flags and payloads
|
|
99
|
+
*/
|
|
100
|
+
export type OverrideFeatureFlagsOptions =
|
|
101
|
+
| boolean // clear all overrides
|
|
102
|
+
| string[] // enable list of flags
|
|
103
|
+
| FeatureFlagOverrides // set variants directly
|
|
104
|
+
| FeatureFlagOverrideOptions
|
package/src/index.ts
CHANGED
|
@@ -33,6 +33,10 @@ export type {
|
|
|
33
33
|
EarlyAccessFeatureStage,
|
|
34
34
|
EarlyAccessFeatureCallback,
|
|
35
35
|
EarlyAccessFeatureResponse,
|
|
36
|
+
FeatureFlagOverrides,
|
|
37
|
+
FeatureFlagPayloadOverrides,
|
|
38
|
+
FeatureFlagOverrideOptions,
|
|
39
|
+
OverrideFeatureFlagsOptions,
|
|
36
40
|
} from './feature-flags'
|
|
37
41
|
|
|
38
42
|
// Request types
|
package/src/posthog.ts
CHANGED
|
@@ -13,6 +13,7 @@ import type {
|
|
|
13
13
|
EarlyAccessFeatureCallback,
|
|
14
14
|
EarlyAccessFeatureStage,
|
|
15
15
|
FeatureFlagResult,
|
|
16
|
+
OverrideFeatureFlagsOptions,
|
|
16
17
|
} from './feature-flags'
|
|
17
18
|
import type { SessionIdChangedCallback } from './session-recording'
|
|
18
19
|
import type { RequestCallback } from './request'
|
|
@@ -197,6 +198,34 @@ export interface PostHog {
|
|
|
197
198
|
// Feature Flags
|
|
198
199
|
// ============================================================================
|
|
199
200
|
|
|
201
|
+
/**
|
|
202
|
+
* The feature flags instance. Provides access to feature flag override methods.
|
|
203
|
+
*/
|
|
204
|
+
featureFlags: {
|
|
205
|
+
/**
|
|
206
|
+
* Override feature flags on the client-side. Useful for testing/debugging.
|
|
207
|
+
*
|
|
208
|
+
* @param overrideOptions - The override options
|
|
209
|
+
*
|
|
210
|
+
* @example
|
|
211
|
+
* ```typescript
|
|
212
|
+
* posthog.featureFlags.overrideFeatureFlags(false) // clear all overrides
|
|
213
|
+
* posthog.featureFlags.overrideFeatureFlags(['beta-feature']) // enable flags
|
|
214
|
+
* posthog.featureFlags.overrideFeatureFlags({'beta-feature': 'variant'}) // set variants
|
|
215
|
+
* posthog.featureFlags.overrideFeatureFlags({
|
|
216
|
+
* flags: {'beta-feature': 'variant'},
|
|
217
|
+
* payloads: { 'beta-feature': { someData: true } }
|
|
218
|
+
* })
|
|
219
|
+
* ```
|
|
220
|
+
*/
|
|
221
|
+
overrideFeatureFlags(overrideOptions: OverrideFeatureFlagsOptions): void
|
|
222
|
+
|
|
223
|
+
/**
|
|
224
|
+
* @deprecated Use `overrideFeatureFlags` instead. This will be removed in a future version.
|
|
225
|
+
*/
|
|
226
|
+
override(flags: boolean | string[] | Record<string, string | boolean>, suppressWarning?: boolean): void
|
|
227
|
+
}
|
|
228
|
+
|
|
200
229
|
/**
|
|
201
230
|
* Get the value of a feature flag.
|
|
202
231
|
*
|
|
@@ -555,7 +584,7 @@ export interface PostHog {
|
|
|
555
584
|
* @param cb - The callback to call
|
|
556
585
|
* @returns A function to unsubscribe
|
|
557
586
|
*/
|
|
558
|
-
on(event: 'eventCaptured', cb: (...args: any[]) => void): () => void
|
|
587
|
+
on(event: 'eventCaptured' | 'featureFlagsReloading', cb: (...args: any[]) => void): () => void
|
|
559
588
|
|
|
560
589
|
// ============================================================================
|
|
561
590
|
// Error Tracking
|