@posthog/browser-common 0.2.2 → 0.2.3

package/README.md

@@ -60,7 +60,7 @@ callback into idempotent teardown.
 
 What an extension is given in `setup` — the host's extension services:
 
-- **transport**: `apiRequest(path, init?)`
+- **transport**: `projectToken`, `sendRequest(path, init?)`
 - **registry**: `getExtension(token)`
 - **storage & logging**: `kv`, `logger`
 
@@ -75,9 +75,9 @@ owned by the PostHog client's analytics core:
 - **lifecycle**: `onNewSession(...)`
 - **server config**: `getRemoteConfig()` (current), `onRemoteConfig(...)` (changes)
 
-Identity and session are always-ready synchronous reads. Operations that perform
-I/O, including `capture`, `apiRequest`, `kv`, and `getRemoteConfig`, are
-awaitable.
+Identity, session, and the public project token are always-ready synchronous
+reads. Operations that perform I/O, including `capture`, `sendRequest`, `kv`,
+and `getRemoteConfig`, are awaitable.
 
 ### Host runtime
 

package/dist/client.d.ts

@@ -1,9 +1,9 @@
 import type { Logger } from '@posthog/core';
 import type { KeyValueStore } from './persistence';
 import type { ExtensionToken } from './token';
-/** A minimal response from {@link Client.apiRequest}. */
+/** A minimal response from {@link Client.sendRequest}. */
 export interface ApiResponse {
-    /** The HTTP status code returned by the transport, or a client-defined best-effort status for unload sends. */
+    /** The HTTP status code returned by the transport, or a client-defined best-effort status for sendBeacon sends. */
     statusCode: number;
     /** The response body parsed as JSON when available. */
     json?: unknown;
@@ -12,22 +12,24 @@ export interface ApiResponse {
     /** The transport error when the request failed before receiving an HTTP response. */
     error?: unknown;
 }
-/** 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. */
+/** Configured host used to resolve a relative request path. */
+export type RequestTarget = 'api' | 'flags' | 'assets';
+/** Browser transport requested for a send. */
+export type RequestTransport = 'XHR' | 'fetch' | 'sendBeacon';
+/** Options for sending a request through {@link Client.sendRequest}. */
+export interface SendRequestInit {
+    /** Configured host to send through; defaults to the regular API host. */
+    target?: RequestTarget;
+    /** HTTP method to use; the host transport's default applies when omitted. */
     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
-     * unavailable (e.g. `sendBeacon` only reports "queued"), so callers must not
-     * depend on it.
-     */
-    unload?: boolean;
+    /** Additional headers merged with the host SDK's configured request headers. */
+    headers?: Record<string, string>;
+    /** Browser transport to prefer. `sendBeacon` returns a best-effort response immediately. */
+    transport?: RequestTransport;
     /** Abort the request if it does not complete within this many milliseconds. */
     timeoutMs?: number;
 }
@@ -41,12 +43,13 @@ export interface ApiRequestInit {
  * analytics behavior is provided separately by the core extension.
  */
 export interface Client {
+    /** Public project token used to authenticate endpoint-specific requests. */
+    readonly projectToken: string;
     /**
-     * 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/`.
+     * Sends a request through the host SDK's transport. The extension owns the
+     * endpoint-specific path, method, authentication shape, body, and headers.
      */
-    apiRequest(path: string, init?: ApiRequestInit): Promise<ApiResponse>;
+    sendRequest(path: string, init?: SendRequestInit): Promise<ApiResponse>;
     /**
      * Resolves another registered extension by a capability token it provides, or
      * `undefined` if nothing registered provides it (not installed, or not loaded

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.2";
+const packageVersion = "0.2.3";
 const Config = {
     DEBUG: false,
     LIB_VERSION: packageVersion,

package/dist/config.mjs

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

package/dist/index.d.ts

@@ -10,5 +10,5 @@ export { createDisposable, type Disposable } from './disposable';
 export type { ExtensionToken } from './token';
 export type { Listener } from './pubsub';
 export { Publisher } from './pubsub';
-export type { Client, ApiResponse, ApiRequestInit } from './client';
+export type { Client, ApiResponse, RequestTarget, RequestTransport, SendRequestInit } from './client';
 export type { KeyValueStore } from './persistence';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@posthog/browser-common",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "Internal shared browser utilities and extension primitives for PostHog Browser SDKs",
   "license": "MIT",
   "repository": {