posthog-js 1.232.6 → 1.232.7

package/dist/module.d.ts

@@ -2118,7 +2118,10 @@ interface SpecificQuestionBranching {
 interface SurveyResponse {
     surveys: Survey[];
 }
-type SurveyCallback = (surveys: Survey[]) => void;
+type SurveyCallback = (surveys: Survey[], context?: {
+    isLoaded: boolean;
+    error?: string;
+}) => void;
 type SurveyMatchType = 'regex' | 'not_regex' | 'exact' | 'is_not' | 'icontains' | 'not_icontains';
 interface SurveyElement {
     text?: string;
@@ -2249,11 +2252,35 @@ declare class PostHogSurveys {
     private _surveyManager;
     private _isFetchingSurveys;
     private _isInitializingSurveys;
+    private _surveyCallbacks;
     constructor(instance: PostHog);
     onRemoteConfig(response: RemoteConfig): void;
     reset(): void;
     loadIfEnabled(): void;
+    /**
+     * Register a callback that runs when surveys are initialized.
+     * ### Usage:
+     *
+     *     posthog.onSurveysLoaded((surveys) => {
+     *         // You can work with all surveys
+     *         console.log('All available surveys:', surveys)
+     *
+     *         // Or get active matching surveys
+     *         posthog.getActiveMatchingSurveys((activeMatchingSurveys) => {
+     *             if (activeMatchingSurveys.length > 0) {
+     *                 posthog.renderSurvey(activeMatchingSurveys[0].id, '#survey-container')
+     *             }
+     *         })
+     *     })
+     *
+     * @param {Function} callback The callback function will be called when surveys are loaded or updated.
+     *                           It receives the array of all surveys and a context object with error status.
+     * @returns {Function} A function that can be called to unsubscribe the listener.
+     */
+    onSurveysLoaded(callback: SurveyCallback): () => void;
     getSurveys(callback: SurveyCallback, forceReload?: boolean): void;
+    /** Helper method to notify all registered callbacks */
+    private _notifySurveyCallbacks;
     private isSurveyFeatureFlagEnabled;
     getActiveMatchingSurveys(callback: SurveyCallback, forceReload?: boolean): void;
     checkFlags(survey: Survey): boolean;
@@ -2690,6 +2717,7 @@ declare class PostHog {
      */
     on(event: 'eventCaptured', cb: (...args: any[]) => void): () => void;
     onFeatureFlags(callback: FeatureFlagsCallback): () => void;
+    onSurveysLoaded(callback: SurveyCallback): () => void;
     onSessionId(callback: SessionIdChangedCallback): () => void;
     /** Get list of all surveys. */
     getSurveys(callback: SurveyCallback, forceReload?: boolean): void;

package/dist/module.full.d.ts

@@ -2118,7 +2118,10 @@ interface SpecificQuestionBranching {
 interface SurveyResponse {
     surveys: Survey[];
 }
-type SurveyCallback = (surveys: Survey[]) => void;
+type SurveyCallback = (surveys: Survey[], context?: {
+    isLoaded: boolean;
+    error?: string;
+}) => void;
 type SurveyMatchType = 'regex' | 'not_regex' | 'exact' | 'is_not' | 'icontains' | 'not_icontains';
 interface SurveyElement {
     text?: string;
@@ -2249,11 +2252,35 @@ declare class PostHogSurveys {
     private _surveyManager;
     private _isFetchingSurveys;
     private _isInitializingSurveys;
+    private _surveyCallbacks;
     constructor(instance: PostHog);
     onRemoteConfig(response: RemoteConfig): void;
     reset(): void;
     loadIfEnabled(): void;
+    /**
+     * Register a callback that runs when surveys are initialized.
+     * ### Usage:
+     *
+     *     posthog.onSurveysLoaded((surveys) => {
+     *         // You can work with all surveys
+     *         console.log('All available surveys:', surveys)
+     *
+     *         // Or get active matching surveys
+     *         posthog.getActiveMatchingSurveys((activeMatchingSurveys) => {
+     *             if (activeMatchingSurveys.length > 0) {
+     *                 posthog.renderSurvey(activeMatchingSurveys[0].id, '#survey-container')
+     *             }
+     *         })
+     *     })
+     *
+     * @param {Function} callback The callback function will be called when surveys are loaded or updated.
+     *                           It receives the array of all surveys and a context object with error status.
+     * @returns {Function} A function that can be called to unsubscribe the listener.
+     */
+    onSurveysLoaded(callback: SurveyCallback): () => void;
     getSurveys(callback: SurveyCallback, forceReload?: boolean): void;
+    /** Helper method to notify all registered callbacks */
+    private _notifySurveyCallbacks;
     private isSurveyFeatureFlagEnabled;
     getActiveMatchingSurveys(callback: SurveyCallback, forceReload?: boolean): void;
     checkFlags(survey: Survey): boolean;
@@ -2690,6 +2717,7 @@ declare class PostHog {
      */
     on(event: 'eventCaptured', cb: (...args: any[]) => void): () => void;
     onFeatureFlags(callback: FeatureFlagsCallback): () => void;
+    onSurveysLoaded(callback: SurveyCallback): () => void;
     onSessionId(callback: SessionIdChangedCallback): () => void;
     /** Get list of all surveys. */
     getSurveys(callback: SurveyCallback, forceReload?: boolean): void;