posthog-js 1.232.6 → 1.232.7

package/lib/package.json

@@ -1,6 +1,6 @@
 {
     "name": "posthog-js",
-    "version": "1.232.6",
+    "version": "1.232.7",
     "description": "Posthog-js allows you to automatically capture usage and send events to PostHog.",
     "repository": "https://github.com/PostHog/posthog-js",
     "author": "hey@posthog.com",

package/lib/src/posthog-core.d.ts

@@ -267,6 +267,7 @@ export 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/lib/src/posthog-core.js

@@ -1117,6 +1117,23 @@ var PostHog = /** @class */ (function () {
     PostHog.prototype.onFeatureFlags = function (callback) {
         return this.featureFlags.onFeatureFlags(callback);
     };
+    /*
+     * Register an event listener that runs when surveys are loaded.
+     *
+     * ### Usage:
+     *
+     *     posthog.onSurveysLoaded((surveys, context) => { // do something })
+     *
+     * Callback parameters:
+     * - surveys: Survey[]: An array containing all survey objects fetched from PostHog using the getSurveys method
+     * - context: { isLoaded: boolean, error?: string }: An object indicating if the surveys were loaded successfully
+     *
+     * @param {Function} callback The callback function will be called when surveys are loaded or updated.
+     * @returns {Function} A function that can be called to unsubscribe the listener.
+     */
+    PostHog.prototype.onSurveysLoaded = function (callback) {
+        return this.surveys.onSurveysLoaded(callback);
+    };
     /*
      * Register an event listener that runs whenever the session id or window id change.
      * If there is already a session id, the listener is called immediately in addition to being called on future changes.