@posthog/browser-common 0.0.0 → 0.1.0

package/LICENSE

@@ -0,0 +1,353 @@
+Copyright 2020 Posthog / Hiberly, Inc.
+
+Copyright 2015 Mixpanel, Inc.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this work except in compliance with the License.
+You may obtain a copy of the License below, or at:
+
+   http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-javascript.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+MIT License
+
+Copyright (c) 2012 Functional Software, Inc. dba Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from getsentry/sentry-react-native.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+The MIT License (MIT)
+
+Copyright (c) 2017 Sentry
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from facebook/metro by Meta Platforms, Inc. and affiliates.
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases. 
+
+MIT License
+
+Copyright (c) Meta Platforms, Inc. and affiliates.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from expo/expo by 650 Industries, Inc. (aka Expo).
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases. 
+
+The MIT License (MIT)
+
+Copyright (c) 2015-present 650 Industries, Inc. (aka Expo)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+---
+
+Some files in this codebase contain code from agentcathq/agentcat-typescript-sdk (formerly MCPCat/mcpcat-typescript-sdk).
+In such cases it is explicitly stated in the file header. This license only applies to the relevant code in such cases.
+
+MIT License
+
+Copyright (c) 2025 AgentCat, Inc. (formerly MCPcat)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,118 @@
 # @posthog/browser-common
 
-## ⚠️ IMPORTANT NOTICE ⚠️
+Internal shared browser utilities and extension primitives for PostHog JavaScript
+SDKs. This package is published so unbundled SDK outputs can resolve it at
+runtime, but it is not a public API surface and does not provide compatibility
+guarantees outside PostHog SDK packages.
 
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
+The shared extension contract includes the interface an extension implements
+(`Extension`), the host capabilities it is handed (`Client`), and small shared
+runtime primitives such as `Publisher`.
 
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
+An extension written against this contract runs unchanged across major versions of the web SDK:
 
-## Purpose
+- **v1** is synchronous; extensions are registered statically.
+- **v2** is asynchronous; extensions are loaded dynamically.
 
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@posthog/browser-common`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
+Each SDK provides a _client adapter_ that implements `Client` over its own
+internals, so extension code never depends on a specific SDK.
 
-## What is OIDC Trusted Publishing?
+## Concepts
 
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
+### `Extension`
 
-## Setup Instructions
+What you implement. The host calls only `setup` and `dispose`:
 
-To properly configure OIDC trusted publishing for this package:
+```ts
+import type { Disposable, Extension } from '@posthog/browser-common'
 
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
+export function webContext(): Extension {
+    let removeProperties: Disposable | undefined
 
-## DO NOT USE THIS PACKAGE
+    return {
+        name: 'webContext',
+        setup(client) {
+            removeProperties = client.registerDynamicEventProperties(() => ({
+                $current_url: window.location.href,
+            }))
+        },
+        dispose() {
+            removeProperties?.dispose()
+        },
+    }
+}
+```
 
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
+`setup(client)` may be async (read async state before you're ready); `dispose()`
+may be async (final flush). Static config the app sets goes in your constructor,
+not on the `Client`.
 
-## More Information
+Anything in `setup` that returns a `Disposable` must be held by the extension
+and disposed in `dispose()`.
 
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
+### `Client`
 
----
+What an extension is given in `setup` — the host's capability surface:
 
-**Maintained for OIDC setup purposes only**
+- **identity & session** (synchronous reads): `distinctId`, `anonymousId`, `groups`, `session`
+- **events**: `capture(...)`, `registerDynamicEventProperties(...)` (contribute properties), `onEvent(...)` (observe)
+- **transport**: `apiRequest(path, init?)`
+- **server config**: `getRemoteConfig()` (current), `onRemoteConfig(...)` (changes)
+- **lifecycle**: `onNewSession(...)`
+- **registry**: `getExtension(token)`
+- **storage & logging**: `kv`, `logger`
+
+Synchronous members are always-ready in-memory reads; everything that does I/O
+or waits for readiness (`capture`, `apiRequest`, `kv`, `getRemoteConfig`) is
+asynchronous.
+
+### `Publisher`
+
+Use `Publisher<T>` when an extension provides its own event stream to other
+extensions or to app-facing controls. Keep the publisher private, expose only its
+`listener`, and dispose it when the extension is torn down:
+
+```ts
+import { Publisher, type Listener } from '@posthog/browser-common'
+
+const changes = new Publisher<FeatureFlagsChange>()
+
+export const onChange: Listener<FeatureFlagsChange> = changes.listener
+
+changes.publish({ flag: 'beta-ui', value: true })
+changes.dispose()
+```
+
+## Cross-extension dependencies
+
+Extensions depend on one another through tokens, never implementation imports:
+
+```ts
+import { FeatureFlags } from './feature-flags/token'
+
+const flags = client.getExtension(FeatureFlags) // FeatureFlagsExtension | undefined
+if (flags && (await flags.getFeatureFlag('beta-ui'))) {
+    /* … */
+}
+```
+
+A token is implementation-free, so importing it never pulls the provider's code
+into your bundle — each extension stays independently tree-shakable and lazily
+loadable. An extension that provides a capability declares its token(s) in
+`provides`.
+
+## Authoring
+
+See the **`develop-extension`** skill
+([`.agents/skills/develop-extension/SKILL.md`](./.agents/skills/develop-extension/SKILL.md))
+for the full guide: the capability cheatsheet, the rules (enrichers are
+synchronous, dispose your disposables, design for asynchronous readiness,
+cross-extension state goes through `getExtension`, not shared storage), and the
+v1 → `Client` porting map.
+
+## Status
+
+Early and internal. The package currently defines the extension contract and
+the shared `Publisher` helper. Additional shared runtime helpers — key-value
+stores, the registry implementation, and a test `Client` — will land alongside
+the first ported extension.

package/dist/client.d.ts

@@ -0,0 +1,136 @@
+import type { Logger } from '@posthog/core';
+import type { Disposable } from './disposable';
+import type { KeyValueStore } from './persistence';
+import type { Listener } from './pubsub';
+import type { ExtensionToken } from './token';
+/** The current session, stamped on events to tie them to a session and a browser tab. */
+export interface SessionContext {
+    /** The stable session identifier attached to events captured during this session. */
+    sessionId: string;
+    /** The logical browser tab/window identifier attached alongside the session id. */
+    windowId: string;
+    /** When the session started, as a Unix timestamp in milliseconds. */
+    sessionStartTimestamp: number;
+}
+/** Why a new session started (a `reset` also starts a new session). */
+export type NewSessionReason = 'initial' | 'reset' | 'idleTimeout' | 'maxLength' | 'crossTabAdoption';
+/** Details emitted when the client starts or adopts a new session. */
+export interface NewSessionInfo extends SessionContext {
+    /** The condition that caused this session to begin. */
+    reason: NewSessionReason;
+}
+/** A captured event, as observed by `onEvent`. */
+export interface CapturedEventInfo {
+    /** The event name supplied to {@link Client.capture}. */
+    event: string;
+    /** The final event properties after client defaults and dynamic properties are applied. */
+    properties: Record<string, unknown>;
+}
+/** Per-call capture overrides, mirroring the client's public capture options. */
+export interface CaptureOptions {
+    /** Override the event timestamp sent to PostHog. */
+    timestamp?: Date;
+    /** Override the event UUID used for de-duplication. */
+    uuid?: string;
+    /** Person properties to set, emitted as `$set`. */
+    set?: Record<string, unknown>;
+    /** Person properties to set if unset, emitted as `$set_once`. */
+    setOnce?: Record<string, unknown>;
+}
+/** A minimal response from {@link Client.apiRequest}. */
+export interface ApiResponse {
+    /** Whether the request completed with a 2xx status, or was queued for best-effort unload transport. */
+    ok: boolean;
+    /** The HTTP status code returned by the transport, or a client-defined best-effort status for unload sends. */
+    status: number;
+    /** Parse the response body as JSON; may be unavailable for best-effort unload requests. */
+    json(): Promise<unknown>;
+    /** Read the response body as text; may be unavailable for best-effort unload requests. */
+    text(): Promise<string>;
+}
+/** Options for sending a request through {@link Client.apiRequest}. */
+export interface ApiRequestInit {
+    /** HTTP method to use; defaults to the client's normal request method for the endpoint. */
+    method?: 'GET' | 'POST';
+    /** JSON-serialized by the client. */
+    body?: unknown;
+    /** Query string parameters appended to the request URL. */
+    query?: Record<string, string>;
+    /**
+     * Mark this as a teardown send (pagehide / shutdown): the client picks the
+     * most reliable fire-and-forget transport available — `sendBeacon`, fetch
+     * `keepalive`, or sync XHR. The response is best-effort: `.json()` may be
+     * unusable (e.g. `sendBeacon` only reports "queued"), so callers must not
+     * depend on it.
+     */
+    unload?: boolean;
+    /** Abort the request if it does not complete within this many milliseconds. */
+    timeoutMs?: number;
+}
+/**
+ * Server-provided configuration, as returned by the remote config response
+ * (sampling rates, suppression rules, feature enablement, quotas, …). A loose
+ * record by design — each extension reads only the keys it owns.
+ */
+export type RemoteConfig = Record<string, unknown>;
+/**
+ * The host SDK's capability surface as seen by an extension — the client an
+ * extension is handed in `setup`. Each SDK (v1, v2) provides it as a client
+ * adapter over its own internals.
+ *
+ * Synchronous members are always-ready in-memory reads (identity, session);
+ * asynchronous members do I/O or wait for something to become ready
+ * (`capture`, `apiRequest`, `kv`, `getRemoteConfig`).
+ */
+export interface Client {
+    /** The id events are currently attributed to — the anonymous id, or the identified user's id after `identify`. */
+    readonly distinctId: string;
+    /** The anonymous device id; used before `identify` and carried on identify events as `$anon_distinct_id`. */
+    readonly anonymousId: string;
+    /** Active group memberships (group type → group key), attached to events as `$groups`. */
+    readonly groups: Record<string, string>;
+    /** The current session, created on first read if needed; reading does not extend or rotate it. */
+    readonly session: SessionContext;
+    /** Records an analytics event through the client's normal pipeline. */
+    capture(event: string, properties?: Record<string, unknown> | null, options?: CaptureOptions): Promise<void>;
+    /**
+     * Registers a producer of properties merged into every captured event.
+     * Returns a {@link Disposable} that removes it; an extension disposes it in
+     * its own `dispose`. May be called more than once. The producer runs inline
+     * during event build, so it must be cheap and synchronous; it may return
+     * different properties each time (e.g. the current URL), and is recomputed
+     * per event rather than stored.
+     */
+    registerDynamicEventProperties(producer: () => Record<string, unknown>): Disposable;
+    /**
+     * Sends a request to a PostHog endpoint; the client owns auth, headers, and
+     * transport (fetch / XHR / keepalive). `path` is relative to the configured
+     * API host, e.g. `/s/`, `/flags/`, `/api/surveys/`.
+     */
+    apiRequest(path: string, init?: ApiRequestInit): Promise<ApiResponse>;
+    /**
+     * Resolves with the client's remote config once available, or `undefined`
+     * if the fetch failed (never rejects, never hangs).
+     * Re-readable: each call resolves with the current config, awaiting the
+     * first fetch if none has landed. `await` it in `setup` to block until
+     * config is known, or `.then()` it to reconfigure once it arrives; later
+     * changes arrive via `onRemoteConfig`.
+     */
+    getRemoteConfig(): Promise<RemoteConfig | undefined>;
+    /** Fires when server-provided config arrives or changes. */
+    readonly onRemoteConfig: Listener<RemoteConfig>;
+    /** Fires for every captured event — hot path, keep handlers cheap and synchronous. */
+    readonly onEvent: Listener<CapturedEventInfo>;
+    /** Fires when a new session starts, including on reset (discriminate via `reason`). */
+    readonly onNewSession: Listener<NewSessionInfo>;
+    /**
+     * Resolves another registered extension by a capability token it provides, or
+     * `undefined` if nothing registered provides it (not installed, or not loaded
+     * yet). Lets one extension use another without importing its implementation.
+     */
+    getExtension<T>(token: ExtensionToken<T>): T | undefined;
+    /** Async key-value storage scoped to this client instance and extension. */
+    readonly kv: KeyValueStore;
+    /** Logger that follows the host client's debug/noise policy. */
+    readonly logger: Logger;
+}

package/dist/client.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/disposable.d.ts

@@ -0,0 +1,13 @@
+/**
+ * Something with an async-capable teardown. `dispose` may be async so
+ * teardown can do final work — e.g. a last flush of buffered data — that the
+ * client can await before it finishes shutting down.
+ */
+export interface Disposable {
+    /**
+     * Release resources owned by this object. Implementations should be
+     * idempotent so callers can safely dispose during both extension teardown
+     * and client shutdown.
+     */
+    dispose(): void | Promise<void>;
+}

package/dist/disposable.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/extension.d.ts

@@ -0,0 +1,45 @@
+import type { Disposable } from './disposable';
+import type { Client } from './client';
+import type { ExtensionToken } from './token';
+/**
+ * A shared browser extension. The client calls only two things: `setup(client)`
+ * to start it and `dispose()` (from {@link Disposable}) to stop it. Everything
+ * an extension consumes flows the other way, through {@link Client}.
+ *
+ * `setup` may be async so an extension can read async-KV state or remote config
+ * before it is ready; the client awaits it. `name` is used for de-duplication
+ * and diagnostics. The `Disposable`s an extension creates in `setup` —
+ * enrichers, event listeners, timers — are its own to release: hold them and
+ * dispose them in `dispose`. The host disposes the extension; it does not track
+ * the extension's individual subscriptions.
+ *
+ * An extension that exposes app-facing controls extends `Extension` with named
+ * methods that share its state, e.g.:
+ *
+ * ```ts
+ * interface SessionReplayExtension extends Extension {
+ *     startRecording(): void
+ *     stopRecording(): void
+ *     isActive(): boolean
+ * }
+ * ```
+ *
+ * The client still only calls `setup` and `dispose`; the controls are for the
+ * application that constructed the extension.
+ */
+export interface Extension extends Disposable {
+    /** Stable extension name used for diagnostics and de-duplication within a client instance. */
+    readonly name: string;
+    /**
+     * Capability tokens this extension answers to, so others can resolve it via
+     * `client.getExtension(token)`. The extension must be assignable to each
+     * token's provided type. Most extensions provide nothing.
+     */
+    readonly provides?: readonly ExtensionToken<unknown>[];
+    /**
+     * Start the extension with the host client's capability surface. Called once
+     * after construction; return a promise when setup needs asynchronous state
+     * such as persisted data or remote config.
+     */
+    setup(client: Client): void | Promise<void>;
+}

package/dist/extension.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Public surface for browser extensions shared across PostHog JavaScript SDK
+ * clients.
+ */
+export type { Extension } from './extension';
+export type { Disposable } from './disposable';
+export type { ExtensionToken } from './token';
+export type { Listener } from './pubsub';
+export { Publisher } from './pubsub';
+export type { Client, SessionContext, NewSessionReason, NewSessionInfo, CapturedEventInfo, CaptureOptions, ApiResponse, ApiRequestInit, RemoteConfig, } from './client';
+export type { KeyValueStore } from './persistence';

package/dist/index.js

@@ -0,0 +1,36 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    Publisher: ()=>external_pubsub_js_namespaceObject.Publisher
+});
+const external_pubsub_js_namespaceObject = require("./pubsub.js");
+exports.Publisher = __webpack_exports__.Publisher;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "Publisher"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import { Publisher } from "./pubsub.mjs";
+export { Publisher };

package/dist/persistence.d.ts

@@ -0,0 +1,24 @@
+/**
+ * Async key-value store for small extension state. Backed by whatever the
+ * client provides — a synchronous store resolves immediately, an asynchronous
+ * one (e.g. IndexedDB) does real I/O — so reads and writes are always awaited.
+ *
+ * The store is namespaced to the client instance, so keys are local to the
+ * extension and never collide with core SDK state. Values must be
+ * JSON-serializable; setting `null`/`undefined` removes the key.
+ */
+export interface KeyValueStore {
+    /**
+     * Read a value by key.
+     *
+     * @returns The stored value, or `undefined` when the key is missing.
+     */
+    get<T = unknown>(key: string): Promise<T | undefined>;
+    /**
+     * Store a JSON-serializable value by key. Passing `null` or `undefined`
+     * removes the key instead of persisting that value.
+     */
+    set(key: string, value: unknown): Promise<void>;
+    /** Remove a value by key. Resolves successfully when the key is already absent. */
+    remove(key: string): Promise<void>;
+}

package/dist/persistence.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/pubsub.d.ts

@@ -0,0 +1,28 @@
+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.
+ */
+export type Listener<T> = (handler: (payload: T) => void) => Disposable;
+/**
+ * Publish/subscribe helper for client events exposed to extensions. A client
+ * owns the publisher, calls {@link Publisher.publish} to fire payloads, and
+ * exposes only {@link Publisher.listener} to extensions so they can subscribe
+ * without gaining publish access. Calling {@link Publisher.dispose} drops all
+ * listeners.
+ */
+export declare class Publisher<T> implements Disposable {
+    /** Subscriptions currently registered with this publisher. */
+    private _subscriptions;
+    /**
+     * Register a handler for future payloads. The returned disposable
+     * subscription unregisters this handler.
+     */
+    readonly listener: Listener<T>;
+    /** Notify every currently registered listener with the provided payload. */
+    publish(payload: T): void;
+    /** Drop all registered listeners. Safe to call more than once. */
+    dispose(): void;
+}

package/dist/pubsub.js

@@ -0,0 +1,67 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.d = (exports1, definition)=>{
+        for(var key in definition)if (__webpack_require__.o(definition, key) && !__webpack_require__.o(exports1, key)) Object.defineProperty(exports1, key, {
+            enumerable: true,
+            get: definition[key]
+        });
+    };
+})();
+(()=>{
+    __webpack_require__.o = (obj, prop)=>Object.prototype.hasOwnProperty.call(obj, prop);
+})();
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+__webpack_require__.d(__webpack_exports__, {
+    Publisher: ()=>Publisher
+});
+class Publisher {
+    publish(payload) {
+        const subscriptions = this._subscriptions.slice();
+        subscriptions.forEach((subscription)=>{
+            if (subscription.isActive) subscription.handler(payload);
+        });
+    }
+    dispose() {
+        this._subscriptions.forEach((subscription)=>{
+            subscription.isActive = false;
+        });
+        this._subscriptions = [];
+    }
+    constructor(){
+        this._subscriptions = [];
+        this.listener = (handler)=>{
+            const subscription = {
+                handler,
+                isActive: true
+            };
+            this._subscriptions.push(subscription);
+            return {
+                dispose: ()=>{
+                    if (!subscription.isActive) return;
+                    subscription.isActive = false;
+                    const index = this._subscriptions.indexOf(subscription);
+                    if (-1 !== index) this._subscriptions.splice(index, 1);
+                }
+            };
+        };
+    }
+}
+exports.Publisher = __webpack_exports__.Publisher;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "Publisher"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/pubsub.mjs

@@ -0,0 +1,33 @@
+class Publisher {
+    publish(payload) {
+        const subscriptions = this._subscriptions.slice();
+        subscriptions.forEach((subscription)=>{
+            if (subscription.isActive) subscription.handler(payload);
+        });
+    }
+    dispose() {
+        this._subscriptions.forEach((subscription)=>{
+            subscription.isActive = false;
+        });
+        this._subscriptions = [];
+    }
+    constructor(){
+        this._subscriptions = [];
+        this.listener = (handler)=>{
+            const subscription = {
+                handler,
+                isActive: true
+            };
+            this._subscriptions.push(subscription);
+            return {
+                dispose: ()=>{
+                    if (!subscription.isActive) return;
+                    subscription.isActive = false;
+                    const index = this._subscriptions.indexOf(subscription);
+                    if (-1 !== index) this._subscriptions.splice(index, 1);
+                }
+            };
+        };
+    }
+}
+export { Publisher };

package/dist/token.d.ts

@@ -0,0 +1,21 @@
+/**
+ * A typed, implementation-free key for resolving an extension that provides a
+ * capability. Declared as a shared `const` next to the providing extension's
+ * interface:
+ *
+ * ```ts
+ * export interface FeatureFlagsExtension extends Extension { … }
+ * export const FeatureFlags: ExtensionToken<FeatureFlagsExtension> = { name: 'featureFlags' }
+ * ```
+ *
+ * A token holds no implementation, so importing one never pulls the provider's
+ * code into the consumer's bundle. The registry is keyed by token identity
+ * (the shared object reference), so provider and consumer must import the same
+ * exported token; `name` is for diagnostics only.
+ */
+export interface ExtensionToken<T> {
+    /** Human-readable capability name used only for diagnostics. */
+    readonly name: string;
+    /** Phantom: carries the provided type for inference; never present at runtime. */
+    readonly __provides?: T;
+}

package/dist/token.js

@@ -0,0 +1,18 @@
+"use strict";
+var __webpack_require__ = {};
+(()=>{
+    __webpack_require__.r = (exports1)=>{
+        if ('undefined' != typeof Symbol && Symbol.toStringTag) Object.defineProperty(exports1, Symbol.toStringTag, {
+            value: 'Module'
+        });
+        Object.defineProperty(exports1, '__esModule', {
+            value: true
+        });
+    };
+})();
+var __webpack_exports__ = {};
+__webpack_require__.r(__webpack_exports__);
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/package.json

@@ -1,10 +1,47 @@
 {
   "name": "@posthog/browser-common",
-  "version": "0.0.0",
-  "description": "OIDC trusted publishing setup package for @posthog/browser-common",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
-}
+  "version": "0.1.0",
+  "description": "Internal shared browser utilities and extension primitives for PostHog Browser SDKs",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/PostHog/posthog-js.git",
+    "directory": "packages/browser-common"
+  },
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "main": "dist/index.js",
+  "module": "dist/index.mjs",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.js",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "dependencies": {
+    "@posthog/core": "^1.43.1"
+  },
+  "devDependencies": {
+    "@rslib/core": "0.10.6",
+    "@types/jest": "^29.5.14",
+    "jest": "29.7.0",
+    "ts-jest": "29.4.11",
+    "typescript": "5.8.2",
+    "@posthog-tooling/tsconfig-base": "1.1.1"
+  },
+  "scripts": {
+    "clean": "rimraf dist",
+    "lint": "eslint src tests",
+    "lint:fix": "eslint src tests --fix",
+    "build": "rslib build",
+    "dev": "rslib build -w",
+    "test:unit": "jest -c jest.config.cjs",
+    "check-types": "pnpm build",
+    "package": "pnpm pack --out $PACKAGE_DEST/%s.tgz"
+  }
+}