@posthog/browser-common 0.1.0 → 0.2.1

package/README.md

@@ -96,10 +96,24 @@ 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`.
+A token is an implementation-free branded string, so importing it never pulls
+the provider's code into your bundle — each extension stays independently
+tree-shakable and lazily loadable. Use a package-qualified runtime string, such
+as `posthog.featureFlags`, that is globally unique and stable so separately
+compiled scripts resolve the same capability. An extension that provides a
+capability declares its token(s) in `provides`.
+
+## Utilities
+
+Reusable browser utilities are exposed through `utils/*` subpaths, but they are
+intentionally not re-exported from the package root or a utility barrel. Import
+the exact file you need so lazy extension bundles do not pull in unrelated
+helpers:
+
+```ts
+import { createLogger } from '@posthog/browser-common/utils/logger'
+import { formDataToQuery } from '@posthog/browser-common/utils/request-utils'
+```
 
 ## Authoring
 
@@ -112,7 +126,8 @@ 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.
+Early and internal. The package currently defines the extension contract, the
+shared `Publisher` helper, and directly imported browser utilities under
+`utils/*` subpaths. Additional shared runtime helpers — key-value stores, the
+registry implementation, and a test `Client` — will land alongside the first
+ported extension.

package/dist/config.d.ts

@@ -0,0 +1,9 @@
+type SDKDistChannel = 'npm' | 'cdn';
+declare const Config: {
+    DEBUG: boolean;
+    LIB_VERSION: string;
+    LIB_NAME: string;
+    SDK_DIST_CHANNEL?: SDKDistChannel;
+    JS_SDK_VERSION: string;
+};
+export default Config;

package/dist/config.js

@@ -0,0 +1,43 @@
+"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__, {
+    default: ()=>__WEBPACK_DEFAULT_EXPORT__
+});
+const packageVersion = "0.2.1";
+const Config = {
+    DEBUG: false,
+    LIB_VERSION: packageVersion,
+    LIB_NAME: 'browser-common',
+    JS_SDK_VERSION: packageVersion
+};
+const __WEBPACK_DEFAULT_EXPORT__ = Config;
+exports["default"] = __webpack_exports__["default"];
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "default"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/config.mjs

@@ -0,0 +1,9 @@
+const packageVersion = "0.2.1";
+const Config = {
+    DEBUG: false,
+    LIB_VERSION: packageVersion,
+    LIB_NAME: 'browser-common',
+    JS_SDK_VERSION: packageVersion
+};
+const config = Config;
+export { config as default };

package/dist/constants.d.ts

@@ -0,0 +1,3 @@
+export declare const TOOLBAR_ID = "__POSTHOG_TOOLBAR__";
+export declare const TOOLBAR_CONTAINER_CLASS = "toolbar-global-fade-container";
+export declare const SDK_DIST_CHANNEL = "$sdk_dist_channel";

package/dist/constants.js

@@ -0,0 +1,44 @@
+"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__, {
+    SDK_DIST_CHANNEL: ()=>SDK_DIST_CHANNEL,
+    TOOLBAR_CONTAINER_CLASS: ()=>TOOLBAR_CONTAINER_CLASS,
+    TOOLBAR_ID: ()=>TOOLBAR_ID
+});
+const TOOLBAR_ID = '__POSTHOG_TOOLBAR__';
+const TOOLBAR_CONTAINER_CLASS = 'toolbar-global-fade-container';
+const SDK_DIST_CHANNEL = '$sdk_dist_channel';
+exports.SDK_DIST_CHANNEL = __webpack_exports__.SDK_DIST_CHANNEL;
+exports.TOOLBAR_CONTAINER_CLASS = __webpack_exports__.TOOLBAR_CONTAINER_CLASS;
+exports.TOOLBAR_ID = __webpack_exports__.TOOLBAR_ID;
+for(var __webpack_i__ in __webpack_exports__)if (-1 === [
+    "SDK_DIST_CHANNEL",
+    "TOOLBAR_CONTAINER_CLASS",
+    "TOOLBAR_ID"
+].indexOf(__webpack_i__)) exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/constants.mjs

@@ -0,0 +1,4 @@
+const TOOLBAR_ID = '__POSTHOG_TOOLBAR__';
+const TOOLBAR_CONTAINER_CLASS = 'toolbar-global-fade-container';
+const SDK_DIST_CHANNEL = '$sdk_dist_channel';
+export { SDK_DIST_CHANNEL, TOOLBAR_CONTAINER_CLASS, TOOLBAR_ID };

package/dist/token.d.ts

@@ -1,21 +1,22 @@
+/** Phantom brand carrying the capability type without emitting runtime code. */
+declare const extensionTokenType: unique symbol;
 /**
- * A typed, implementation-free key for resolving an extension that provides a
- * capability. Declared as a shared `const` next to the providing extension's
+ * A typed, implementation-free string 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' }
+ * export const FeatureFlags = 'posthog.featureFlags' as ExtensionToken<FeatureFlagsExtension>
  * ```
  *
  * 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.
+ * code into the consumer's bundle. Its generic brand lets `getExtension` infer
+ * the provided type, while its runtime string value remains stable across
+ * independently compiled scripts. Token strings must be globally unique and
+ * stable for the lifetime of the capability contract.
  */
-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;
-}
+export type ExtensionToken<T> = string & {
+    readonly [extensionTokenType]: T;
+};
+export {};

package/dist/utils/array-at-polyfill.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/utils/array-at-polyfill.js

@@ -0,0 +1,16 @@
+var __webpack_exports__ = {};
+if ('function' != typeof Array.prototype.at) Object.defineProperty(Array.prototype, 'at', {
+    value: function(index) {
+        const len = this.length;
+        let relativeIndex = Math.trunc(index) || 0;
+        if (relativeIndex < 0) relativeIndex += len;
+        return relativeIndex < 0 || relativeIndex >= len ? void 0 : this[relativeIndex];
+    },
+    writable: true,
+    enumerable: false,
+    configurable: true
+});
+for(var __webpack_i__ in __webpack_exports__)exports[__webpack_i__] = __webpack_exports__[__webpack_i__];
+Object.defineProperty(exports, '__esModule', {
+    value: true
+});

package/dist/utils/array-at-polyfill.mjs

@@ -0,0 +1,11 @@
+if ('function' != typeof Array.prototype.at) Object.defineProperty(Array.prototype, 'at', {
+    value: function(index) {
+        const len = this.length;
+        let relativeIndex = Math.trunc(index) || 0;
+        if (relativeIndex < 0) relativeIndex += len;
+        return relativeIndex < 0 || relativeIndex >= len ? void 0 : this[relativeIndex];
+    },
+    writable: true,
+    enumerable: false,
+    configurable: true
+});

package/dist/utils/autocapture-utils.d.ts

@@ -0,0 +1,23 @@
+import type { AutocaptureConfig, PostHogConfig, Properties } from '@posthog/types';
+import { type UrlTargetingInstance } from './url-targeting-utils';
+export declare const MAX_DOM_ANCESTOR_DEPTH = 1000;
+export declare function splitClassString(s: string): string[];
+export declare function getClassNames(el: Element): string[];
+export declare function makeSafeText(s: string | null | undefined): string | null;
+export declare function getSafeText(el: Element): string;
+export declare function getEventTarget(e: Event): Element | null;
+export declare const autocaptureCompatibleElements: string[];
+export declare function getParentElement(curEl: Element): Element | false;
+export declare const DEFAULT_CONTENT_IGNORELIST_WITH_STEPPERS: string[];
+export declare function shouldCaptureDeadClick(el: Element | null, _config: PostHogConfig['capture_dead_clicks']): boolean;
+export declare function isTextSelectionTarget(el: Element | null): boolean;
+export declare function shouldCaptureRageclick(el: Element | null, _config: PostHogConfig['rageclick']): boolean;
+export declare function shouldSkipDeadClick(el: Element | null): boolean;
+export declare function shouldCaptureDomEvent(el: Element, event: Event, autocaptureConfig?: AutocaptureConfig | undefined, captureOnAnyElement?: boolean, allowedEventTypes?: string[], instance?: UrlTargetingInstance): boolean;
+export declare function shouldCaptureElement(el: Element): boolean;
+export declare function isSensitiveElement(el: Element): boolean;
+export declare function shouldCaptureValue(value: string, anchorRegexes?: boolean): boolean;
+export declare function isAngularStyleAttr(attributeName: string): boolean;
+export declare function getDirectAndNestedSpanText(target: Element): string;
+export declare function getNestedSpanText(target: Element): string;
+export declare function getElementsChainString(elements: Properties[]): string;