@posthog/browser-common 0.2.4 → 0.3.0

package/README.md

@@ -56,14 +56,15 @@ What an extension is given in `setup` — the adapter shared by extensions on th
 
 - **identity and session**: `distinctId`, `anonymousId`, `groups`, `session`
 - **events**: `capture(...)`, `registerDynamicEventProperties(...)`, `onEvent(...)`
-- **server config**: `getRemoteConfig()` and `onRemoteConfig(...)`
+- **server config**: `onRemoteConfig(...)`
 - **transport**: `projectToken`, `sendRequest(path, init?)`
 - **storage and logging**: `kv`, `logger`
 
 Identity, session, and the public project token are always-ready synchronous
 reads. Operations that may perform I/O, including `capture`, `sendRequest`,
-`kv`, and `getRemoteConfig`, are awaitable. Extensions that want a named log
-prefix can create a child with `client.logger.createLogger('[myExtension]')`.
+and `kv`, are awaitable. `onRemoteConfig` immediately replays the latest known
+success or failure and then reports subsequent outcomes. Extensions that want a
+named log prefix can create a child with `client.logger.createLogger('[myExtension]')`.
 
 ### Host runtime
 

package/dist/client.d.ts

@@ -3,7 +3,7 @@ import type { Properties } from '@posthog/types';
 import type { Disposable } from './disposable';
 import type { KeyValueStore } from './persistence';
 import type { Listener } from './pubsub';
-import type { RemoteConfig } from './types/remote-config';
+import type { RemoteConfigResult } from './types/remote-config';
 /** Recursively marks object properties as readonly while preserving callable values. */
 export type DeepReadonly<T> = T extends (...args: never[]) => unknown ? T : T extends object ? {
     readonly [K in keyof T]: DeepReadonly<T[K]>;
@@ -87,10 +87,8 @@ export interface Client {
     registerDynamicEventProperties(producer: () => Record<string, unknown>): Disposable;
     /** Fires for every captured event through a deeply readonly view. */
     readonly onEvent: Listener<CapturedEventInfo>;
-    /** Resolves with the current remote config, awaiting the first outcome when necessary. */
-    getRemoteConfig(): Promise<DeepReadonly<RemoteConfig> | undefined>;
-    /** Fires when server-provided config arrives or changes successfully. */
-    readonly onRemoteConfig: Listener<DeepReadonly<RemoteConfig>>;
+    /** Replays the latest remote-config outcome on subscription and fires for subsequent outcomes. */
+    readonly onRemoteConfig: Listener<DeepReadonly<RemoteConfigResult>>;
     /** Public project token used to authenticate endpoint-specific requests. */
     readonly projectToken: string;
     /** Sends a request through the host SDK's transport. */

package/dist/config.js

@@ -26,7 +26,7 @@ __webpack_require__.r(__webpack_exports__);
 __webpack_require__.d(__webpack_exports__, {
     default: ()=>__WEBPACK_DEFAULT_EXPORT__
 });
-const packageVersion = "0.2.4";
+const packageVersion = "0.3.0";
 const Config = {
     DEBUG: false,
     LIB_VERSION: packageVersion,

package/dist/config.mjs

@@ -1,4 +1,4 @@
-const packageVersion = "0.2.4";
+const packageVersion = "0.3.0";
 const Config = {
     DEBUG: false,
     LIB_VERSION: packageVersion,

package/dist/pubsub.d.ts

@@ -2,8 +2,9 @@ import { type Disposable } from './disposable';
 /**
  * Call it with a handler to start listening; dispose the returned
  * {@link Disposable} to stop. There is one `Listener` per event type, so every
- * event carries its own payload type. The handler is called synchronously for
- * each future payload, and the returned disposable unregisters it.
+ * event carries its own payload type. The handler is called synchronously, and
+ * stateful listeners may replay their current value during registration when
+ * documented. The returned disposable unregisters it from future payloads.
  */
 export type Listener<T> = (handler: (payload: T) => void) => Disposable;
 /**

package/dist/types/remote-config.d.ts

@@ -178,3 +178,10 @@ export interface RemoteConfig {
     /** Conversations widget configuration. */
     conversations?: boolean | ConversationsRemoteConfig;
 }
+/** The latest outcome of loading remote configuration from PostHog. */
+export type RemoteConfigResult = {
+    ok: true;
+    config: RemoteConfig;
+} | {
+    ok: false;
+};

package/dist/utils/prototype-utils.js

@@ -37,15 +37,26 @@ function getNativeImplementation(name, assignableWindow) {
     let impl = assignableWindow[name];
     if ((0, core_namespaceObject.isNativeFunction)(impl) && !(0, external_type_utils_js_namespaceObject.isAngularZonePresent)()) return cachedImplementations[name] = impl.bind(assignableWindow);
     const document = assignableWindow.document;
-    if (document && (0, core_namespaceObject.isFunction)(document.createElement)) try {
-        const sandbox = document.createElement('iframe');
-        sandbox.hidden = true;
-        document.head.appendChild(sandbox);
-        const contentWindow = sandbox.contentWindow;
-        if (contentWindow && contentWindow[name]) impl = contentWindow[name];
-        document.head.removeChild(sandbox);
-    } catch (e) {
-        external_logger_js_namespaceObject.logger.warn(`Could not create sandbox iframe for ${name} check, bailing to assignableWindow.${name}: `, e);
+    if (document && (0, core_namespaceObject.isFunction)(document.createElement)) {
+        let sandbox;
+        let keepSandboxAttached = false;
+        try {
+            sandbox = document.createElement('iframe');
+            sandbox.hidden = true;
+            document.head.appendChild(sandbox);
+            const contentWindow = sandbox.contentWindow;
+            if (contentWindow && contentWindow[name]) {
+                impl = contentWindow[name];
+                if ('MutationObserver' === name && (0, core_namespaceObject.isWebKit)(assignableWindow.navigator?.userAgent ?? '')) {
+                    sandbox.classList.add('rr-block', 'ph-no-capture');
+                    keepSandboxAttached = true;
+                }
+            }
+        } catch (e) {
+            external_logger_js_namespaceObject.logger.warn(`Could not create sandbox iframe for ${name} check, bailing to assignableWindow.${name}: `, e);
+        } finally{
+            if (!keepSandboxAttached && sandbox?.parentNode) sandbox.parentNode.removeChild(sandbox);
+        }
     }
     if (!impl || !(0, core_namespaceObject.isFunction)(impl)) return impl;
     return cachedImplementations[name] = impl.bind(assignableWindow);

package/dist/utils/prototype-utils.mjs

@@ -1,4 +1,4 @@
-import { isFunction, isNativeFunction } from "@posthog/core";
+import { isFunction, isNativeFunction, isWebKit } from "@posthog/core";
 import { logger } from "./logger.mjs";
 import { isAngularZonePresent } from "./type-utils.mjs";
 const cachedImplementations = {};
@@ -8,15 +8,26 @@ function getNativeImplementation(name, assignableWindow) {
     let impl = assignableWindow[name];
     if (isNativeFunction(impl) && !isAngularZonePresent()) return cachedImplementations[name] = impl.bind(assignableWindow);
     const document = assignableWindow.document;
-    if (document && isFunction(document.createElement)) try {
-        const sandbox = document.createElement('iframe');
-        sandbox.hidden = true;
-        document.head.appendChild(sandbox);
-        const contentWindow = sandbox.contentWindow;
-        if (contentWindow && contentWindow[name]) impl = contentWindow[name];
-        document.head.removeChild(sandbox);
-    } catch (e) {
-        logger.warn(`Could not create sandbox iframe for ${name} check, bailing to assignableWindow.${name}: `, e);
+    if (document && isFunction(document.createElement)) {
+        let sandbox;
+        let keepSandboxAttached = false;
+        try {
+            sandbox = document.createElement('iframe');
+            sandbox.hidden = true;
+            document.head.appendChild(sandbox);
+            const contentWindow = sandbox.contentWindow;
+            if (contentWindow && contentWindow[name]) {
+                impl = contentWindow[name];
+                if ('MutationObserver' === name && isWebKit(assignableWindow.navigator?.userAgent ?? '')) {
+                    sandbox.classList.add('rr-block', 'ph-no-capture');
+                    keepSandboxAttached = true;
+                }
+            }
+        } catch (e) {
+            logger.warn(`Could not create sandbox iframe for ${name} check, bailing to assignableWindow.${name}: `, e);
+        } finally{
+            if (!keepSandboxAttached && sandbox?.parentNode) sandbox.parentNode.removeChild(sandbox);
+        }
     }
     if (!impl || !isFunction(impl)) return impl;
     return cachedImplementations[name] = impl.bind(assignableWindow);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@posthog/browser-common",
-  "version": "0.2.4",
+  "version": "0.3.0",
   "description": "Internal shared browser utilities and extension primitives for PostHog Browser SDKs",
   "license": "MIT",
   "repository": {
@@ -65,13 +65,14 @@
     }
   },
   "dependencies": {
-    "@posthog/core": "^1.45.1",
-    "@posthog/types": "^1.398.0"
+    "@posthog/core": "^1.46.0",
+    "@posthog/types": "^1.399.0"
   },
   "devDependencies": {
     "@rslib/core": "0.10.6",
     "@types/jest": "^29.5.14",
     "jest": "29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
     "ts-jest": "29.4.11",
     "typescript": "5.8.2",
     "@posthog-tooling/tsconfig-base": "1.1.1"