@walkeros/web-destination-posthog 3.3.0-next-1776098542393

package/dist/index.d.mts

@@ -0,0 +1,112 @@
+import { Destination as Destination$1, Mapping as Mapping$1 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+import { PostHogConfig, Properties } from 'posthog-js';
+
+/**
+ * Destination-level settings.
+ *
+ * PostHog's `PostHogConfig` interface has ~80 fields — extending the SDK type
+ * directly keeps IntelliSense complete and prevents drift. The destination adds:
+ *  - `apiKey` (required) — first arg to `posthog.init(...)`, NOT an init option
+ *  - `identify` — destination-level identity mapping
+ *  - `include` — event sections flattened into `capture()` properties
+ *  - `group` — destination-level group association
+ *  - `_state` — runtime state (not user-facing, mutated by init/push)
+ *
+ * All other walkerOS-specific mapping features live under mapping.settings
+ * (see Mapping interface below). Built-in PostHog features (session_recording,
+ * advanced_disable_flags, disable_surveys, capture_heatmaps, capture_exceptions,
+ * bootstrap, cookieless_mode, ...) are passthrough via PostHogConfig.
+ */
+interface Settings extends Partial<PostHogConfig> {
+    /** PostHog project API key (e.g. "phc_XXX"). First arg to posthog.init(). */
+    apiKey: string;
+    /** Destination-level identity mapping, resolved on first push. */
+    identify?: Mapping$1.Value;
+    /** Destination-level group association, resolved on first push. */
+    group?: Mapping$1.Value;
+    /** Runtime state — populated by init() and mutated by push(). Not user-facing. */
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    /** Last-resolved identity values, used to skip redundant identify/group calls. */
+    lastIdentity?: {
+        distinctId?: string;
+    };
+    lastGroup?: {
+        type?: string;
+        key?: string;
+    };
+}
+type InitSettings = Partial<Settings>;
+/**
+ * Per-rule mapping settings. Every feature here is a walkerOS mapping value
+ * resolved via getMappingValue(). The resolved object's keys drive which
+ * SDK methods are called.
+ *
+ * - identify: { distinctId?, $set?, $set_once? } → posthog.identify() OR posthog.setPersonProperties()
+ * - group:    { type, key, properties? } → posthog.group()
+ * - reset:    boolean → posthog.reset()
+ * - include:  string[] → flattened properties (overrides destination-level)
+ */
+interface Mapping {
+    identify?: Mapping$1.Value;
+    group?: Mapping$1.Value;
+    reset?: Mapping$1.Value | boolean;
+}
+/**
+ * PostHog SDK surface — the subset of `posthog-js` the destination actually
+ * uses. Mirrors the real module's default singleton export shape. Tests mock
+ * via env.posthog to intercept every call.
+ */
+interface PostHogSDK {
+    init: (token: string, config?: Partial<PostHogConfig> & {
+        loaded?: (posthog: PostHogSDK) => void;
+    }, name?: string) => PostHogSDK;
+    capture: (eventName: string, properties?: Properties) => void;
+    identify: (distinctId?: string, userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties) => void;
+    setPersonProperties: (userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties) => void;
+    group: (groupType: string, groupKey: string, groupPropertiesToSet?: Properties) => void;
+    reset: (resetDeviceId?: boolean) => void;
+    opt_in_capturing: (options?: {
+        captureEventName?: string | null | false;
+        captureProperties?: Properties;
+    }) => void;
+    opt_out_capturing: () => void;
+}
+/**
+ * Env — optional SDK override. Production leaves this undefined and the
+ * destination falls back to the real `posthog-js` default export. Tests
+ * provide a mock via env.posthog = { ... }.
+ */
+interface Env extends DestinationWeb.Env {
+    posthog?: PostHogSDK;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+type Destination = DestinationWeb.Destination<Types>;
+type Config = DestinationWeb.Config<Types>;
+interface PostHogDestination extends Destination {
+    env?: Env;
+}
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+
+type index_Config = Config;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_PostHogDestination = PostHogDestination;
+type index_PostHogSDK = PostHogSDK;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_RuntimeState = RuntimeState;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_Destination as Destination, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_PostHogDestination as PostHogDestination, index_PostHogSDK as PostHogSDK, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationPostHog: Destination;
+
+export { index as DestinationPostHog, destinationPostHog as default, destinationPostHog };

package/dist/index.d.ts

@@ -0,0 +1,112 @@
+import { Destination as Destination$1, Mapping as Mapping$1 } from '@walkeros/core';
+import { DestinationWeb } from '@walkeros/web-core';
+import { PostHogConfig, Properties } from 'posthog-js';
+
+/**
+ * Destination-level settings.
+ *
+ * PostHog's `PostHogConfig` interface has ~80 fields — extending the SDK type
+ * directly keeps IntelliSense complete and prevents drift. The destination adds:
+ *  - `apiKey` (required) — first arg to `posthog.init(...)`, NOT an init option
+ *  - `identify` — destination-level identity mapping
+ *  - `include` — event sections flattened into `capture()` properties
+ *  - `group` — destination-level group association
+ *  - `_state` — runtime state (not user-facing, mutated by init/push)
+ *
+ * All other walkerOS-specific mapping features live under mapping.settings
+ * (see Mapping interface below). Built-in PostHog features (session_recording,
+ * advanced_disable_flags, disable_surveys, capture_heatmaps, capture_exceptions,
+ * bootstrap, cookieless_mode, ...) are passthrough via PostHogConfig.
+ */
+interface Settings extends Partial<PostHogConfig> {
+    /** PostHog project API key (e.g. "phc_XXX"). First arg to posthog.init(). */
+    apiKey: string;
+    /** Destination-level identity mapping, resolved on first push. */
+    identify?: Mapping$1.Value;
+    /** Destination-level group association, resolved on first push. */
+    group?: Mapping$1.Value;
+    /** Runtime state — populated by init() and mutated by push(). Not user-facing. */
+    _state?: RuntimeState;
+}
+interface RuntimeState {
+    /** Last-resolved identity values, used to skip redundant identify/group calls. */
+    lastIdentity?: {
+        distinctId?: string;
+    };
+    lastGroup?: {
+        type?: string;
+        key?: string;
+    };
+}
+type InitSettings = Partial<Settings>;
+/**
+ * Per-rule mapping settings. Every feature here is a walkerOS mapping value
+ * resolved via getMappingValue(). The resolved object's keys drive which
+ * SDK methods are called.
+ *
+ * - identify: { distinctId?, $set?, $set_once? } → posthog.identify() OR posthog.setPersonProperties()
+ * - group:    { type, key, properties? } → posthog.group()
+ * - reset:    boolean → posthog.reset()
+ * - include:  string[] → flattened properties (overrides destination-level)
+ */
+interface Mapping {
+    identify?: Mapping$1.Value;
+    group?: Mapping$1.Value;
+    reset?: Mapping$1.Value | boolean;
+}
+/**
+ * PostHog SDK surface — the subset of `posthog-js` the destination actually
+ * uses. Mirrors the real module's default singleton export shape. Tests mock
+ * via env.posthog to intercept every call.
+ */
+interface PostHogSDK {
+    init: (token: string, config?: Partial<PostHogConfig> & {
+        loaded?: (posthog: PostHogSDK) => void;
+    }, name?: string) => PostHogSDK;
+    capture: (eventName: string, properties?: Properties) => void;
+    identify: (distinctId?: string, userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties) => void;
+    setPersonProperties: (userPropertiesToSet?: Properties, userPropertiesToSetOnce?: Properties) => void;
+    group: (groupType: string, groupKey: string, groupPropertiesToSet?: Properties) => void;
+    reset: (resetDeviceId?: boolean) => void;
+    opt_in_capturing: (options?: {
+        captureEventName?: string | null | false;
+        captureProperties?: Properties;
+    }) => void;
+    opt_out_capturing: () => void;
+}
+/**
+ * Env — optional SDK override. Production leaves this undefined and the
+ * destination falls back to the real `posthog-js` default export. Tests
+ * provide a mock via env.posthog = { ... }.
+ */
+interface Env extends DestinationWeb.Env {
+    posthog?: PostHogSDK;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+type Destination = DestinationWeb.Destination<Types>;
+type Config = DestinationWeb.Config<Types>;
+interface PostHogDestination extends Destination {
+    env?: Env;
+}
+type Rule = Mapping$1.Rule<Mapping>;
+type Rules = Mapping$1.Rules<Rule>;
+
+type index_Config = Config;
+type index_Destination = Destination;
+type index_Env = Env;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_PostHogDestination = PostHogDestination;
+type index_PostHogSDK = PostHogSDK;
+type index_Rule = Rule;
+type index_Rules = Rules;
+type index_RuntimeState = RuntimeState;
+type index_Settings = Settings;
+type index_Types = Types;
+declare namespace index {
+  export type { index_Config as Config, index_Destination as Destination, index_Env as Env, index_InitSettings as InitSettings, index_Mapping as Mapping, index_PostHogDestination as PostHogDestination, index_PostHogSDK as PostHogSDK, index_Rule as Rule, index_Rules as Rules, index_RuntimeState as RuntimeState, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationPostHog: Destination;
+
+export { index as DestinationPostHog, destinationPostHog as default, destinationPostHog };