posthog-react-native 3.15.0 → 3.15.2

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.
Files changed (149) hide show
  1. package/lib/posthog-core/src/eventemitter.d.ts +8 -8
  2. package/lib/posthog-core/src/eventemitter.js +1 -0
  3. package/lib/posthog-core/src/eventemitter.js.map +1 -0
  4. package/lib/posthog-core/src/featureFlagUtils.d.ts +34 -34
  5. package/lib/posthog-core/src/featureFlagUtils.js +1 -0
  6. package/lib/posthog-core/src/featureFlagUtils.js.map +1 -0
  7. package/lib/posthog-core/src/index.d.ts +262 -239
  8. package/lib/posthog-core/src/index.js +1 -0
  9. package/lib/posthog-core/src/index.js.map +1 -0
  10. package/lib/posthog-core/src/lz-string.d.ts +8 -8
  11. package/lib/posthog-core/src/lz-string.js +1 -0
  12. package/lib/posthog-core/src/lz-string.js.map +1 -0
  13. package/lib/posthog-core/src/types.d.ts +422 -423
  14. package/lib/posthog-core/src/types.js +1 -0
  15. package/lib/posthog-core/src/types.js.map +1 -0
  16. package/lib/posthog-core/src/utils.d.ts +19 -19
  17. package/lib/posthog-core/src/utils.js +1 -0
  18. package/lib/posthog-core/src/utils.js.map +1 -0
  19. package/lib/posthog-core/src/vendor/uuidv7.d.ts +179 -179
  20. package/lib/posthog-core/src/vendor/uuidv7.js +7 -0
  21. package/lib/posthog-core/src/vendor/uuidv7.js.map +1 -0
  22. package/lib/posthog-react-native/index.d.ts +10 -10
  23. package/lib/posthog-react-native/index.js +1 -0
  24. package/lib/posthog-react-native/index.js.map +1 -0
  25. package/lib/posthog-react-native/src/PostHogContext.d.ts +5 -5
  26. package/lib/posthog-react-native/src/PostHogContext.js +1 -0
  27. package/lib/posthog-react-native/src/PostHogContext.js.map +1 -0
  28. package/lib/posthog-react-native/src/PostHogProvider.d.ts +14 -14
  29. package/lib/posthog-react-native/src/PostHogProvider.js +1 -0
  30. package/lib/posthog-react-native/src/PostHogProvider.js.map +1 -0
  31. package/lib/posthog-react-native/src/autocapture.d.ts +4 -4
  32. package/lib/posthog-react-native/src/autocapture.js +1 -0
  33. package/lib/posthog-react-native/src/autocapture.js.map +1 -0
  34. package/lib/posthog-react-native/src/frameworks/wix-navigation.d.ts +3 -3
  35. package/lib/posthog-react-native/src/frameworks/wix-navigation.js +1 -0
  36. package/lib/posthog-react-native/src/frameworks/wix-navigation.js.map +1 -0
  37. package/lib/posthog-react-native/src/hooks/useFeatureFlag.d.ts +5 -5
  38. package/lib/posthog-react-native/src/hooks/useFeatureFlag.js +1 -0
  39. package/lib/posthog-react-native/src/hooks/useFeatureFlag.js.map +1 -0
  40. package/lib/posthog-react-native/src/hooks/useFeatureFlags.d.ts +3 -3
  41. package/lib/posthog-react-native/src/hooks/useFeatureFlags.js +1 -0
  42. package/lib/posthog-react-native/src/hooks/useFeatureFlags.js.map +1 -0
  43. package/lib/posthog-react-native/src/hooks/useNavigationTracker.d.ts +6 -6
  44. package/lib/posthog-react-native/src/hooks/useNavigationTracker.js +1 -0
  45. package/lib/posthog-react-native/src/hooks/useNavigationTracker.js.map +1 -0
  46. package/lib/posthog-react-native/src/hooks/usePostHog.d.ts +2 -2
  47. package/lib/posthog-react-native/src/hooks/usePostHog.js +1 -0
  48. package/lib/posthog-react-native/src/hooks/usePostHog.js.map +1 -0
  49. package/lib/posthog-react-native/src/legacy.d.ts +4 -4
  50. package/lib/posthog-react-native/src/legacy.js +1 -0
  51. package/lib/posthog-react-native/src/legacy.js.map +1 -0
  52. package/lib/posthog-react-native/src/native-deps.d.ts +4 -4
  53. package/lib/posthog-react-native/src/native-deps.js +1 -0
  54. package/lib/posthog-react-native/src/native-deps.js.map +1 -0
  55. package/lib/posthog-react-native/src/optional/OptionalAsyncStorage.d.ts +2 -2
  56. package/lib/posthog-react-native/src/optional/OptionalAsyncStorage.js +1 -0
  57. package/lib/posthog-react-native/src/optional/OptionalAsyncStorage.js.map +1 -0
  58. package/lib/posthog-react-native/src/optional/OptionalExpoApplication.d.ts +2 -2
  59. package/lib/posthog-react-native/src/optional/OptionalExpoApplication.js +1 -0
  60. package/lib/posthog-react-native/src/optional/OptionalExpoApplication.js.map +1 -0
  61. package/lib/posthog-react-native/src/optional/OptionalExpoDevice.d.ts +2 -2
  62. package/lib/posthog-react-native/src/optional/OptionalExpoDevice.js +1 -0
  63. package/lib/posthog-react-native/src/optional/OptionalExpoDevice.js.map +1 -0
  64. package/lib/posthog-react-native/src/optional/OptionalExpoFileSystem.d.ts +2 -2
  65. package/lib/posthog-react-native/src/optional/OptionalExpoFileSystem.js +1 -0
  66. package/lib/posthog-react-native/src/optional/OptionalExpoFileSystem.js.map +1 -0
  67. package/lib/posthog-react-native/src/optional/OptionalExpoLocalization.d.ts +2 -2
  68. package/lib/posthog-react-native/src/optional/OptionalExpoLocalization.js +1 -0
  69. package/lib/posthog-react-native/src/optional/OptionalExpoLocalization.js.map +1 -0
  70. package/lib/posthog-react-native/src/optional/OptionalReactNativeDeviceInfo.d.ts +2 -2
  71. package/lib/posthog-react-native/src/optional/OptionalReactNativeDeviceInfo.js +1 -0
  72. package/lib/posthog-react-native/src/optional/OptionalReactNativeDeviceInfo.js.map +1 -0
  73. package/lib/posthog-react-native/src/optional/OptionalReactNativeLocalize.d.ts +13 -13
  74. package/lib/posthog-react-native/src/optional/OptionalReactNativeLocalize.js +1 -0
  75. package/lib/posthog-react-native/src/optional/OptionalReactNativeLocalize.js.map +1 -0
  76. package/lib/posthog-react-native/src/optional/OptionalReactNativeNavigation.d.ts +2 -2
  77. package/lib/posthog-react-native/src/optional/OptionalReactNativeNavigation.js +1 -0
  78. package/lib/posthog-react-native/src/optional/OptionalReactNativeNavigation.js.map +1 -0
  79. package/lib/posthog-react-native/src/optional/OptionalReactNativeNavigationWix.d.ts +2 -2
  80. package/lib/posthog-react-native/src/optional/OptionalReactNativeNavigationWix.js +1 -0
  81. package/lib/posthog-react-native/src/optional/OptionalReactNativeNavigationWix.js.map +1 -0
  82. package/lib/posthog-react-native/src/optional/OptionalReactNativeSafeArea.d.ts +2 -2
  83. package/lib/posthog-react-native/src/optional/OptionalReactNativeSafeArea.js +1 -0
  84. package/lib/posthog-react-native/src/optional/OptionalReactNativeSafeArea.js.map +1 -0
  85. package/lib/posthog-react-native/src/optional/OptionalSessionReplay.d.ts +2 -2
  86. package/lib/posthog-react-native/src/optional/OptionalSessionReplay.js +1 -0
  87. package/lib/posthog-react-native/src/optional/OptionalSessionReplay.js.map +1 -0
  88. package/lib/posthog-react-native/src/posthog-rn.d.ts +71 -71
  89. package/lib/posthog-react-native/src/posthog-rn.js +1 -0
  90. package/lib/posthog-react-native/src/posthog-rn.js.map +1 -0
  91. package/lib/posthog-react-native/src/storage.d.ts +21 -21
  92. package/lib/posthog-react-native/src/storage.js +1 -0
  93. package/lib/posthog-react-native/src/storage.js.map +1 -0
  94. package/lib/posthog-react-native/src/surveys/PostHogSurveyProvider.d.ts +16 -16
  95. package/lib/posthog-react-native/src/surveys/PostHogSurveyProvider.js +1 -0
  96. package/lib/posthog-react-native/src/surveys/PostHogSurveyProvider.js.map +1 -0
  97. package/lib/posthog-react-native/src/surveys/components/BottomSection.d.ts +9 -9
  98. package/lib/posthog-react-native/src/surveys/components/BottomSection.js +1 -0
  99. package/lib/posthog-react-native/src/surveys/components/BottomSection.js.map +1 -0
  100. package/lib/posthog-react-native/src/surveys/components/Cancel.d.ts +6 -6
  101. package/lib/posthog-react-native/src/surveys/components/Cancel.js +1 -0
  102. package/lib/posthog-react-native/src/surveys/components/Cancel.js.map +1 -0
  103. package/lib/posthog-react-native/src/surveys/components/ConfirmationMessage.d.ts +13 -13
  104. package/lib/posthog-react-native/src/surveys/components/ConfirmationMessage.js +1 -0
  105. package/lib/posthog-react-native/src/surveys/components/ConfirmationMessage.js.map +1 -0
  106. package/lib/posthog-react-native/src/surveys/components/QuestionHeader.d.ts +7 -7
  107. package/lib/posthog-react-native/src/surveys/components/QuestionHeader.js +1 -0
  108. package/lib/posthog-react-native/src/surveys/components/QuestionHeader.js.map +1 -0
  109. package/lib/posthog-react-native/src/surveys/components/QuestionTypes.d.ts +27 -27
  110. package/lib/posthog-react-native/src/surveys/components/QuestionTypes.js +1 -0
  111. package/lib/posthog-react-native/src/surveys/components/QuestionTypes.js.map +1 -0
  112. package/lib/posthog-react-native/src/surveys/components/SurveyModal.d.ts +10 -10
  113. package/lib/posthog-react-native/src/surveys/components/SurveyModal.js +1 -0
  114. package/lib/posthog-react-native/src/surveys/components/SurveyModal.js.map +1 -0
  115. package/lib/posthog-react-native/src/surveys/components/Surveys.d.ts +14 -14
  116. package/lib/posthog-react-native/src/surveys/components/Surveys.js +1 -0
  117. package/lib/posthog-react-native/src/surveys/components/Surveys.js.map +1 -0
  118. package/lib/posthog-react-native/src/surveys/getActiveMatchingSurveys.d.ts +2 -2
  119. package/lib/posthog-react-native/src/surveys/getActiveMatchingSurveys.js +1 -0
  120. package/lib/posthog-react-native/src/surveys/getActiveMatchingSurveys.js.map +1 -0
  121. package/lib/posthog-react-native/src/surveys/icons.d.ts +8 -10
  122. package/lib/posthog-react-native/src/surveys/icons.js +1 -0
  123. package/lib/posthog-react-native/src/surveys/icons.js.map +1 -0
  124. package/lib/posthog-react-native/src/surveys/index.d.ts +6 -6
  125. package/lib/posthog-react-native/src/surveys/index.js +1 -0
  126. package/lib/posthog-react-native/src/surveys/index.js.map +1 -0
  127. package/lib/posthog-react-native/src/surveys/surveys-utils.d.ts +13 -13
  128. package/lib/posthog-react-native/src/surveys/surveys-utils.js +1 -0
  129. package/lib/posthog-react-native/src/surveys/surveys-utils.js.map +1 -0
  130. package/lib/posthog-react-native/src/surveys/useActivatedSurveys.d.ts +3 -3
  131. package/lib/posthog-react-native/src/surveys/useActivatedSurveys.js +1 -0
  132. package/lib/posthog-react-native/src/surveys/useActivatedSurveys.js.map +1 -0
  133. package/lib/posthog-react-native/src/surveys/useSurveyStorage.d.ts +8 -8
  134. package/lib/posthog-react-native/src/surveys/useSurveyStorage.js +1 -0
  135. package/lib/posthog-react-native/src/surveys/useSurveyStorage.js.map +1 -0
  136. package/lib/posthog-react-native/src/types.d.ts +112 -112
  137. package/lib/posthog-react-native/src/types.js +1 -0
  138. package/lib/posthog-react-native/src/types.js.map +1 -0
  139. package/lib/posthog-react-native/src/version.d.ts +1 -1
  140. package/lib/posthog-react-native/src/version.js +1 -0
  141. package/lib/posthog-react-native/src/version.js.map +1 -0
  142. package/lib/posthog-react-native/tsconfig.tsbuildinfo +1 -0
  143. package/package.json +8 -9
  144. package/lib/index.cjs.js +0 -4677
  145. package/lib/index.cjs.js.map +0 -1
  146. package/lib/index.d.ts +0 -875
  147. package/lib/index.esm.js +0 -4659
  148. package/lib/index.esm.js.map +0 -1
  149. package/lib/posthog-react-native/test/test-utils.d.ts +0 -2
@@ -1,239 +1,262 @@
1
- import { PostHogFetchOptions, PostHogFetchResponse, PostHogAutocaptureElement, PostHogDecideResponse, PostHogCoreOptions, PostHogEventProperties, PostHogPersistedProperty, PostHogCaptureOptions, JsonType, PostHogRemoteConfig, FeatureFlagValue, PostHogFeatureFlagDetails, FeatureFlagDetail, SurveyResponse } from './types';
2
- import { RetriableOptions } from './utils';
3
- import { LZString } from './lz-string';
4
- import { SimpleEventEmitter } from './eventemitter';
5
- export * as utils from './utils';
6
- export declare abstract class PostHogCoreStateless {
7
- readonly apiKey: string;
8
- readonly host: string;
9
- readonly flushAt: number;
10
- readonly preloadFeatureFlags: boolean;
11
- readonly disableSurveys: boolean;
12
- private maxBatchSize;
13
- private maxQueueSize;
14
- private flushInterval;
15
- private flushPromise;
16
- private requestTimeout;
17
- private featureFlagsRequestTimeoutMs;
18
- private remoteConfigRequestTimeoutMs;
19
- private captureMode;
20
- private removeDebugCallback?;
21
- private disableGeoip;
22
- private historicalMigration;
23
- protected disabled: boolean;
24
- private defaultOptIn;
25
- private pendingPromises;
26
- protected _events: SimpleEventEmitter;
27
- protected _flushTimer?: any;
28
- protected _retryOptions: RetriableOptions;
29
- protected _initPromise: Promise<void>;
30
- protected _isInitialized: boolean;
31
- protected _remoteConfigResponsePromise?: Promise<PostHogRemoteConfig | undefined>;
32
- abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
33
- abstract getLibraryId(): string;
34
- abstract getLibraryVersion(): string;
35
- abstract getCustomUserAgent(): string | void;
36
- abstract getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
37
- abstract setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
38
- constructor(apiKey: string, options?: PostHogCoreOptions);
39
- protected logMsgIfDebug(fn: () => void): void;
40
- protected wrap(fn: () => void): void;
41
- protected getCommonEventProperties(): any;
42
- get optedOut(): boolean;
43
- optIn(): Promise<void>;
44
- optOut(): Promise<void>;
45
- on(event: string, cb: (...args: any[]) => void): () => void;
46
- debug(enabled?: boolean): void;
47
- get isDebug(): boolean;
48
- get isDisabled(): boolean;
49
- private buildPayload;
50
- protected addPendingPromise<T>(promise: Promise<T>): Promise<T>;
51
- /***
52
- *** TRACKING
53
- ***/
54
- protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
55
- protected captureStateless(distinctId: string, event: string, properties?: {
56
- [key: string]: any;
57
- }, options?: PostHogCaptureOptions): void;
58
- protected aliasStateless(alias: string, distinctId: string, properties?: {
59
- [key: string]: any;
60
- }, options?: PostHogCaptureOptions): void;
61
- /***
62
- *** GROUPS
63
- ***/
64
- protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): void;
65
- protected getRemoteConfig(): Promise<PostHogRemoteConfig | undefined>;
66
- /***
67
- *** FEATURE FLAGS
68
- ***/
69
- protected getDecide(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, extraPayload?: Record<string, any>): Promise<PostHogDecideResponse | undefined>;
70
- protected getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
71
- response: FeatureFlagValue | undefined;
72
- requestId: string | undefined;
73
- }>;
74
- protected getFeatureFlagDetailStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
75
- response: FeatureFlagDetail | undefined;
76
- requestId: string | undefined;
77
- } | undefined>;
78
- protected getFeatureFlagPayloadStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<JsonType | undefined>;
79
- protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
80
- protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<{
81
- flags: PostHogDecideResponse['featureFlags'] | undefined;
82
- payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
83
- requestId: PostHogDecideResponse['requestId'] | undefined;
84
- }>;
85
- protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<{
86
- flags: PostHogDecideResponse['featureFlags'] | undefined;
87
- payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
88
- requestId: PostHogDecideResponse['requestId'] | undefined;
89
- }>;
90
- protected getFeatureFlagDetailsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogFeatureFlagDetails | undefined>;
91
- /***
92
- *** SURVEYS
93
- ***/
94
- getSurveysStateless(): Promise<SurveyResponse['surveys']>;
95
- /***
96
- *** QUEUEING AND FLUSHING
97
- ***/
98
- protected enqueue(type: string, _message: any, options?: PostHogCaptureOptions): void;
99
- private clearFlushTimer;
100
- /**
101
- * Helper for flushing the queue in the background
102
- * Avoids unnecessary promise errors
103
- */
104
- private flushBackground;
105
- flush(): Promise<any[]>;
106
- protected getCustomHeaders(): {
107
- [key: string]: string;
108
- };
109
- private _flush;
110
- private fetchWithRetry;
111
- shutdown(shutdownTimeoutMs?: number): Promise<void>;
112
- }
113
- export declare abstract class PostHogCore extends PostHogCoreStateless {
114
- private sendFeatureFlagEvent;
115
- private flagCallReported;
116
- protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
117
- protected _sessionExpirationTimeSeconds: number;
118
- protected sessionProps: PostHogEventProperties;
119
- constructor(apiKey: string, options?: PostHogCoreOptions);
120
- protected setupBootstrap(options?: Partial<PostHogCoreOptions>): void;
121
- private get props();
122
- private set props(value);
123
- private clearProps;
124
- private _props;
125
- on(event: string, cb: (...args: any[]) => void): () => void;
126
- reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
127
- protected getCommonEventProperties(): any;
128
- private enrichProperties;
129
- /**
130
- * * @returns {string} The stored session ID for the current session. This may be an empty string if the client is not yet fully initialized.
131
- */
132
- getSessionId(): string;
133
- resetSessionId(): void;
134
- /**
135
- * * @returns {string} The stored anonymous ID. This may be an empty string if the client is not yet fully initialized.
136
- */
137
- getAnonymousId(): string;
138
- /**
139
- * * @returns {string} The stored distinct ID. This may be an empty string if the client is not yet fully initialized.
140
- */
141
- getDistinctId(): string;
142
- unregister(property: string): Promise<void>;
143
- register(properties: {
144
- [key: string]: any;
145
- }): Promise<void>;
146
- registerForSession(properties: {
147
- [key: string]: any;
148
- }): void;
149
- unregisterForSession(property: string): void;
150
- /***
151
- *** TRACKING
152
- ***/
153
- identify(distinctId?: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
154
- capture(event: string, properties?: {
155
- [key: string]: any;
156
- }, options?: PostHogCaptureOptions): void;
157
- alias(alias: string): void;
158
- autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
159
- /***
160
- *** GROUPS
161
- ***/
162
- groups(groups: {
163
- [type: string]: string | number;
164
- }): void;
165
- group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
166
- groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
167
- /***
168
- * PROPERTIES
169
- ***/
170
- setPersonPropertiesForFlags(properties: {
171
- [type: string]: string;
172
- }): void;
173
- resetPersonPropertiesForFlags(): void;
174
- /** @deprecated - Renamed to setPersonPropertiesForFlags */
175
- personProperties(properties: {
176
- [type: string]: string;
177
- }): void;
178
- setGroupPropertiesForFlags(properties: {
179
- [type: string]: Record<string, string>;
180
- }): void;
181
- resetGroupPropertiesForFlags(): void;
182
- /** @deprecated - Renamed to setGroupPropertiesForFlags */
183
- groupProperties(properties: {
184
- [type: string]: Record<string, string>;
185
- }): void;
186
- private remoteConfigAsync;
187
- /***
188
- *** FEATURE FLAGS
189
- ***/
190
- private decideAsync;
191
- private cacheSessionReplay;
192
- private _remoteConfigAsync;
193
- private _decideAsync;
194
- private setKnownFeatureFlagDetails;
195
- private getKnownFeatureFlagDetails;
196
- private getKnownFeatureFlags;
197
- private getKnownFeatureFlagPayloads;
198
- private getBootstrappedFeatureFlagDetails;
199
- private setBootstrappedFeatureFlagDetails;
200
- private getBootstrappedFeatureFlags;
201
- private getBootstrappedFeatureFlagPayloads;
202
- getFeatureFlag(key: string): FeatureFlagValue | undefined;
203
- getFeatureFlagPayload(key: string): JsonType | undefined;
204
- getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
205
- getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
206
- getFeatureFlagDetails(): PostHogFeatureFlagDetails | undefined;
207
- getFeatureFlagsAndPayloads(): {
208
- flags: PostHogDecideResponse['featureFlags'] | undefined;
209
- payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
210
- };
211
- isFeatureEnabled(key: string): boolean | undefined;
212
- reloadFeatureFlags(cb?: (err?: Error, flags?: PostHogDecideResponse['featureFlags']) => void): void;
213
- reloadRemoteConfigAsync(): Promise<PostHogRemoteConfig | undefined>;
214
- reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
215
- onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
216
- onFeatureFlag(key: string, cb: (value: FeatureFlagValue) => void): () => void;
217
- overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): Promise<void>;
218
- /***
219
- *** ERROR TRACKING
220
- ***/
221
- captureException(error: unknown, additionalProperties?: {
222
- [key: string]: any;
223
- }): void;
224
- /**
225
- * Capture written user feedback for a LLM trace. Numeric values are converted to strings.
226
- * @param traceId The trace ID to capture feedback for.
227
- * @param userFeedback The feedback to capture.
228
- */
229
- captureTraceFeedback(traceId: string | number, userFeedback: string): void;
230
- /**
231
- * Capture a metric for a LLM trace. Numeric values are converted to strings.
232
- * @param traceId The trace ID to capture the metric for.
233
- * @param metricName The name of the metric to capture.
234
- * @param metricValue The value of the metric to capture.
235
- */
236
- captureTraceMetric(traceId: string | number, metricName: string, metricValue: string | number | boolean): void;
237
- }
238
- export * from './types';
239
- export { LZString };
1
+ import { PostHogFetchOptions, PostHogFetchResponse, PostHogAutocaptureElement, PostHogDecideResponse, PostHogCoreOptions, PostHogEventProperties, PostHogPersistedProperty, PostHogCaptureOptions, JsonType, PostHogRemoteConfig, FeatureFlagValue, PostHogFeatureFlagDetails, FeatureFlagDetail, SurveyResponse } from './types';
2
+ import { RetriableOptions } from './utils';
3
+ import { LZString } from './lz-string';
4
+ import { SimpleEventEmitter } from './eventemitter';
5
+ export { safeSetTimeout } from './utils';
6
+ export { getFetch } from './utils';
7
+ export { getFeatureFlagValue } from './featureFlagUtils';
8
+ export * as utils from './utils';
9
+ export declare function logFlushError(err: any): Promise<void>;
10
+ export declare abstract class PostHogCoreStateless {
11
+ readonly apiKey: string;
12
+ readonly host: string;
13
+ readonly flushAt: number;
14
+ readonly preloadFeatureFlags: boolean;
15
+ readonly disableSurveys: boolean;
16
+ private maxBatchSize;
17
+ private maxQueueSize;
18
+ private flushInterval;
19
+ private flushPromise;
20
+ private shutdownPromise;
21
+ private requestTimeout;
22
+ private featureFlagsRequestTimeoutMs;
23
+ private remoteConfigRequestTimeoutMs;
24
+ private captureMode;
25
+ private removeDebugCallback?;
26
+ private disableGeoip;
27
+ private historicalMigration;
28
+ protected disabled: boolean;
29
+ private defaultOptIn;
30
+ private pendingPromises;
31
+ protected _events: SimpleEventEmitter;
32
+ protected _flushTimer?: any;
33
+ protected _retryOptions: RetriableOptions;
34
+ protected _initPromise: Promise<void>;
35
+ protected _isInitialized: boolean;
36
+ protected _remoteConfigResponsePromise?: Promise<PostHogRemoteConfig | undefined>;
37
+ abstract fetch(url: string, options: PostHogFetchOptions): Promise<PostHogFetchResponse>;
38
+ abstract getLibraryId(): string;
39
+ abstract getLibraryVersion(): string;
40
+ abstract getCustomUserAgent(): string | void;
41
+ abstract getPersistedProperty<T>(key: PostHogPersistedProperty): T | undefined;
42
+ abstract setPersistedProperty<T>(key: PostHogPersistedProperty, value: T | null): void;
43
+ constructor(apiKey: string, options?: PostHogCoreOptions);
44
+ protected logMsgIfDebug(fn: () => void): void;
45
+ protected wrap(fn: () => void): void;
46
+ protected getCommonEventProperties(): any;
47
+ get optedOut(): boolean;
48
+ optIn(): Promise<void>;
49
+ optOut(): Promise<void>;
50
+ on(event: string, cb: (...args: any[]) => void): () => void;
51
+ debug(enabled?: boolean): void;
52
+ get isDebug(): boolean;
53
+ get isDisabled(): boolean;
54
+ private buildPayload;
55
+ protected addPendingPromise<T>(promise: Promise<T>): Promise<T>;
56
+ /***
57
+ *** TRACKING
58
+ ***/
59
+ protected identifyStateless(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
60
+ protected identifyStatelessImmediate(distinctId: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): Promise<void>;
61
+ protected captureStateless(distinctId: string, event: string, properties?: {
62
+ [key: string]: any;
63
+ }, options?: PostHogCaptureOptions): void;
64
+ protected captureStatelessImmediate(distinctId: string, event: string, properties?: {
65
+ [key: string]: any;
66
+ }, options?: PostHogCaptureOptions): Promise<void>;
67
+ protected aliasStateless(alias: string, distinctId: string, properties?: {
68
+ [key: string]: any;
69
+ }, options?: PostHogCaptureOptions): void;
70
+ protected aliasStatelessImmediate(alias: string, distinctId: string, properties?: {
71
+ [key: string]: any;
72
+ }, options?: PostHogCaptureOptions): Promise<void>;
73
+ /***
74
+ *** GROUPS
75
+ ***/
76
+ protected groupIdentifyStateless(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions, distinctId?: string, eventProperties?: PostHogEventProperties): void;
77
+ protected getRemoteConfig(): Promise<PostHogRemoteConfig | undefined>;
78
+ /***
79
+ *** FEATURE FLAGS
80
+ ***/
81
+ protected getDecide(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, extraPayload?: Record<string, any>): Promise<PostHogDecideResponse | undefined>;
82
+ protected getFeatureFlagStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
83
+ response: FeatureFlagValue | undefined;
84
+ requestId: string | undefined;
85
+ }>;
86
+ protected getFeatureFlagDetailStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<{
87
+ response: FeatureFlagDetail | undefined;
88
+ requestId: string | undefined;
89
+ } | undefined>;
90
+ protected getFeatureFlagPayloadStateless(key: string, distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean): Promise<JsonType | undefined>;
91
+ protected getFeatureFlagPayloadsStateless(distinctId: string, groups?: Record<string, string>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogDecideResponse['featureFlagPayloads'] | undefined>;
92
+ protected getFeatureFlagsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<{
93
+ flags: PostHogDecideResponse['featureFlags'] | undefined;
94
+ payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
95
+ requestId: PostHogDecideResponse['requestId'] | undefined;
96
+ }>;
97
+ protected getFeatureFlagsAndPayloadsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<{
98
+ flags: PostHogDecideResponse['featureFlags'] | undefined;
99
+ payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
100
+ requestId: PostHogDecideResponse['requestId'] | undefined;
101
+ }>;
102
+ protected getFeatureFlagDetailsStateless(distinctId: string, groups?: Record<string, string | number>, personProperties?: Record<string, string>, groupProperties?: Record<string, Record<string, string>>, disableGeoip?: boolean, flagKeysToEvaluate?: string[]): Promise<PostHogFeatureFlagDetails | undefined>;
103
+ /***
104
+ *** SURVEYS
105
+ ***/
106
+ getSurveysStateless(): Promise<SurveyResponse['surveys']>;
107
+ /***
108
+ *** SUPER PROPERTIES
109
+ ***/
110
+ private _props;
111
+ protected get props(): PostHogEventProperties;
112
+ protected set props(val: PostHogEventProperties | undefined);
113
+ register(properties: {
114
+ [key: string]: any;
115
+ }): Promise<void>;
116
+ unregister(property: string): Promise<void>;
117
+ /***
118
+ *** QUEUEING AND FLUSHING
119
+ ***/
120
+ protected enqueue(type: string, _message: any, options?: PostHogCaptureOptions): void;
121
+ protected sendImmediate(type: string, _message: any, options?: PostHogCaptureOptions): Promise<void>;
122
+ private prepareMessage;
123
+ private clearFlushTimer;
124
+ /**
125
+ * Helper for flushing the queue in the background
126
+ * Avoids unnecessary promise errors
127
+ */
128
+ private flushBackground;
129
+ flush(): Promise<any[]>;
130
+ protected getCustomHeaders(): {
131
+ [key: string]: string;
132
+ };
133
+ private _flush;
134
+ private fetchWithRetry;
135
+ _shutdown(shutdownTimeoutMs?: number): Promise<void>;
136
+ /**
137
+ * Call shutdown() once before the node process exits, so ensure that all events have been sent and all promises
138
+ * have resolved. Do not use this function if you intend to keep using this PostHog instance after calling it.
139
+ * @param shutdownTimeoutMs
140
+ */
141
+ shutdown(shutdownTimeoutMs?: number): Promise<void>;
142
+ }
143
+ export declare abstract class PostHogCore extends PostHogCoreStateless {
144
+ private sendFeatureFlagEvent;
145
+ private flagCallReported;
146
+ protected _decideResponsePromise?: Promise<PostHogDecideResponse | undefined>;
147
+ protected _sessionExpirationTimeSeconds: number;
148
+ protected sessionProps: PostHogEventProperties;
149
+ constructor(apiKey: string, options?: PostHogCoreOptions);
150
+ protected setupBootstrap(options?: Partial<PostHogCoreOptions>): void;
151
+ private clearProps;
152
+ on(event: string, cb: (...args: any[]) => void): () => void;
153
+ reset(propertiesToKeep?: PostHogPersistedProperty[]): void;
154
+ protected getCommonEventProperties(): any;
155
+ private enrichProperties;
156
+ /**
157
+ * * @returns {string} The stored session ID for the current session. This may be an empty string if the client is not yet fully initialized.
158
+ */
159
+ getSessionId(): string;
160
+ resetSessionId(): void;
161
+ /**
162
+ * * @returns {string} The stored anonymous ID. This may be an empty string if the client is not yet fully initialized.
163
+ */
164
+ getAnonymousId(): string;
165
+ /**
166
+ * * @returns {string} The stored distinct ID. This may be an empty string if the client is not yet fully initialized.
167
+ */
168
+ getDistinctId(): string;
169
+ registerForSession(properties: {
170
+ [key: string]: any;
171
+ }): void;
172
+ unregisterForSession(property: string): void;
173
+ /***
174
+ *** TRACKING
175
+ ***/
176
+ identify(distinctId?: string, properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
177
+ capture(event: string, properties?: {
178
+ [key: string]: any;
179
+ }, options?: PostHogCaptureOptions): void;
180
+ alias(alias: string): void;
181
+ autocapture(eventType: string, elements: PostHogAutocaptureElement[], properties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
182
+ /***
183
+ *** GROUPS
184
+ ***/
185
+ groups(groups: {
186
+ [type: string]: string | number;
187
+ }): void;
188
+ group(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
189
+ groupIdentify(groupType: string, groupKey: string | number, groupProperties?: PostHogEventProperties, options?: PostHogCaptureOptions): void;
190
+ /***
191
+ * PROPERTIES
192
+ ***/
193
+ setPersonPropertiesForFlags(properties: {
194
+ [type: string]: string;
195
+ }): void;
196
+ resetPersonPropertiesForFlags(): void;
197
+ /** @deprecated - Renamed to setPersonPropertiesForFlags */
198
+ personProperties(properties: {
199
+ [type: string]: string;
200
+ }): void;
201
+ setGroupPropertiesForFlags(properties: {
202
+ [type: string]: Record<string, string>;
203
+ }): void;
204
+ resetGroupPropertiesForFlags(): void;
205
+ /** @deprecated - Renamed to setGroupPropertiesForFlags */
206
+ groupProperties(properties: {
207
+ [type: string]: Record<string, string>;
208
+ }): void;
209
+ private remoteConfigAsync;
210
+ /***
211
+ *** FEATURE FLAGS
212
+ ***/
213
+ private decideAsync;
214
+ private cacheSessionReplay;
215
+ private _remoteConfigAsync;
216
+ private _decideAsync;
217
+ private setKnownFeatureFlagDetails;
218
+ private getKnownFeatureFlagDetails;
219
+ private getKnownFeatureFlags;
220
+ private getKnownFeatureFlagPayloads;
221
+ private getBootstrappedFeatureFlagDetails;
222
+ private setBootstrappedFeatureFlagDetails;
223
+ private getBootstrappedFeatureFlags;
224
+ private getBootstrappedFeatureFlagPayloads;
225
+ getFeatureFlag(key: string): FeatureFlagValue | undefined;
226
+ getFeatureFlagPayload(key: string): JsonType | undefined;
227
+ getFeatureFlagPayloads(): PostHogDecideResponse['featureFlagPayloads'] | undefined;
228
+ getFeatureFlags(): PostHogDecideResponse['featureFlags'] | undefined;
229
+ getFeatureFlagDetails(): PostHogFeatureFlagDetails | undefined;
230
+ getFeatureFlagsAndPayloads(): {
231
+ flags: PostHogDecideResponse['featureFlags'] | undefined;
232
+ payloads: PostHogDecideResponse['featureFlagPayloads'] | undefined;
233
+ };
234
+ isFeatureEnabled(key: string): boolean | undefined;
235
+ reloadFeatureFlags(cb?: (err?: Error, flags?: PostHogDecideResponse['featureFlags']) => void): void;
236
+ reloadRemoteConfigAsync(): Promise<PostHogRemoteConfig | undefined>;
237
+ reloadFeatureFlagsAsync(sendAnonDistinctId?: boolean): Promise<PostHogDecideResponse['featureFlags'] | undefined>;
238
+ onFeatureFlags(cb: (flags: PostHogDecideResponse['featureFlags']) => void): () => void;
239
+ onFeatureFlag(key: string, cb: (value: FeatureFlagValue) => void): () => void;
240
+ overrideFeatureFlag(flags: PostHogDecideResponse['featureFlags'] | null): Promise<void>;
241
+ /***
242
+ *** ERROR TRACKING
243
+ ***/
244
+ captureException(error: unknown, additionalProperties?: {
245
+ [key: string]: any;
246
+ }): void;
247
+ /**
248
+ * Capture written user feedback for a LLM trace. Numeric values are converted to strings.
249
+ * @param traceId The trace ID to capture feedback for.
250
+ * @param userFeedback The feedback to capture.
251
+ */
252
+ captureTraceFeedback(traceId: string | number, userFeedback: string): void;
253
+ /**
254
+ * Capture a metric for a LLM trace. Numeric values are converted to strings.
255
+ * @param traceId The trace ID to capture the metric for.
256
+ * @param metricName The name of the metric to capture.
257
+ * @param metricValue The value of the metric to capture.
258
+ */
259
+ captureTraceMetric(traceId: string | number, metricName: string, metricValue: string | number | boolean): void;
260
+ }
261
+ export * from './types';
262
+ export { LZString };