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

package/dist/examples/index.d.ts

@@ -0,0 +1,102 @@
+import { Mapping, Flow } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+import { PostHog } from 'posthog-node';
+
+interface Settings {
+    /** PostHog project API key (phc_...) */
+    apiKey: string;
+    /** PostHog client instance, populated by init */
+    client?: PostHog;
+    /** Destination-level identity mapping */
+    identify?: Mapping.Value;
+    /** Destination-level group mapping */
+    group?: Mapping.Value;
+    /** Event sections to flatten into capture properties */
+    include?: string[];
+    host?: string;
+    flushAt?: number;
+    flushInterval?: number;
+    personalApiKey?: string;
+    featureFlagsPollingInterval?: number;
+    disableGeoip?: boolean;
+    disableCompression?: boolean;
+    requestTimeout?: number;
+    fetchRetryCount?: number;
+    fetchRetryDelay?: number;
+    debug?: boolean;
+    disabled?: boolean;
+}
+interface Env extends DestinationServer.Env {
+    PostHog?: typeof PostHog;
+}
+
+/**
+ * Standard mock environment for push operations.
+ * Injects a mock PostHog class constructor via env.PostHog.
+ */
+declare const push: Env;
+/** Simulation tracking paths for CLI --simulate. */
+declare const simulation: string[];
+
+declare const env_push: typeof push;
+declare const env_simulation: typeof simulation;
+declare namespace env {
+  export { env_push as push, env_simulation as simulation };
+}
+
+/**
+ * PostHog server step examples carry destination-level settings and
+ * optional configInclude for the test runner to wire up.
+ */
+type PostHogStepExample = Flow.StepExample & {
+    settings?: Partial<Settings>;
+    configInclude?: string[];
+};
+/**
+ * Default event forwarding — every walkerOS event becomes
+ * client.capture({ distinctId, event, properties }). With no mapping
+ * and no include, properties is {}. distinctId falls back to event.user.id.
+ */
+declare const defaultCapture: PostHogStepExample;
+/**
+ * Capture with include — destination-level include flattens data and
+ * globals sections into prefixed properties.
+ */
+declare const captureWithInclude: PostHogStepExample;
+/**
+ * Identify with $set and $set_once — per-event mapping fires
+ * client.identify() with person properties. skip: true suppresses capture.
+ */
+declare const identifyWithSetAndSetOnce: PostHogStepExample;
+/**
+ * Group identify with properties — per-event mapping fires
+ * client.groupIdentify() with group properties. skip: true suppresses capture.
+ */
+declare const groupIdentifyWithProperties: PostHogStepExample;
+/**
+ * Capture with group context — destination-level settings.group resolves
+ * type + key (no properties). The capture call includes groups.
+ */
+declare const captureWithGroupContext: PostHogStepExample;
+/**
+ * Consent revoked — client.disable() is called.
+ */
+declare const consentRevoke: PostHogStepExample;
+/**
+ * Consent granted — client.enable() is called.
+ */
+declare const consentGrant: PostHogStepExample;
+
+type step_PostHogStepExample = PostHogStepExample;
+declare const step_captureWithGroupContext: typeof captureWithGroupContext;
+declare const step_captureWithInclude: typeof captureWithInclude;
+declare const step_consentGrant: typeof consentGrant;
+declare const step_consentRevoke: typeof consentRevoke;
+declare const step_defaultCapture: typeof defaultCapture;
+declare const step_groupIdentifyWithProperties: typeof groupIdentifyWithProperties;
+declare const step_identifyWithSetAndSetOnce: typeof identifyWithSetAndSetOnce;
+declare namespace step {
+  export { type step_PostHogStepExample as PostHogStepExample, step_captureWithGroupContext as captureWithGroupContext, step_captureWithInclude as captureWithInclude, step_consentGrant as consentGrant, step_consentRevoke as consentRevoke, step_defaultCapture as defaultCapture, step_groupIdentifyWithProperties as groupIdentifyWithProperties, step_identifyWithSetAndSetOnce as identifyWithSetAndSetOnce };
+}
+
+export { env, step };

package/dist/examples/index.js

@@ -0,0 +1,242 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/examples/index.ts
+var examples_exports = {};
+__export(examples_exports, {
+  env: () => env_exports,
+  step: () => step_exports
+});
+module.exports = __toCommonJS(examples_exports);
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  push: () => push,
+  simulation: () => simulation
+});
+function createMockPostHog() {
+  return class MockPostHog {
+    constructor(apiKey, options) {
+      this.apiKey = apiKey;
+      this.options = options || {};
+      this.calls = [];
+    }
+    capture(params) {
+      this.calls.push({ method: "capture", args: [params] });
+    }
+    identify(params) {
+      this.calls.push({ method: "identify", args: [params] });
+    }
+    groupIdentify(params) {
+      this.calls.push({ method: "groupIdentify", args: [params] });
+    }
+    flush() {
+      this.calls.push({ method: "flush", args: [] });
+      return Promise.resolve();
+    }
+    async shutdown() {
+      this.calls.push({ method: "shutdown", args: [] });
+    }
+    enable() {
+      this.calls.push({ method: "enable", args: [] });
+    }
+    disable() {
+      this.calls.push({ method: "disable", args: [] });
+    }
+  };
+}
+var push = {
+  get PostHog() {
+    return createMockPostHog();
+  }
+};
+var simulation = [
+  "call:client.capture",
+  "call:client.identify",
+  "call:client.groupIdentify",
+  "call:client.shutdown"
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  captureWithGroupContext: () => captureWithGroupContext,
+  captureWithInclude: () => captureWithInclude,
+  consentGrant: () => consentGrant,
+  consentRevoke: () => consentRevoke,
+  defaultCapture: () => defaultCapture,
+  groupIdentifyWithProperties: () => groupIdentifyWithProperties,
+  identifyWithSetAndSetOnce: () => identifyWithSetAndSetOnce
+});
+var import_core = require("@walkeros/core");
+var defaultCapture = {
+  in: (0, import_core.getEvent)("product view", { timestamp: 1700000100 }),
+  out: [
+    "client.capture",
+    {
+      distinctId: "us3r",
+      event: "product view",
+      properties: {}
+    }
+  ]
+};
+var captureWithInclude = {
+  in: (0, import_core.getEvent)("order complete", { timestamp: 1700000101 }),
+  configInclude: ["data", "globals"],
+  out: [
+    "client.capture",
+    {
+      distinctId: "us3r",
+      event: "order complete",
+      properties: {
+        data_id: "0rd3r1d",
+        data_currency: "EUR",
+        data_shipping: 5.22,
+        data_taxes: 73.76,
+        data_total: 555,
+        globals_pagegroup: "shop"
+      }
+    }
+  ]
+};
+var identifyWithSetAndSetOnce = {
+  in: (0, import_core.getEvent)("user login", {
+    timestamp: 1700000102,
+    data: {
+      user_id: "new-user-123",
+      email: "user@acme.com",
+      plan: "premium"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      identify: {
+        map: {
+          distinctId: "data.user_id",
+          $set: {
+            map: {
+              email: "data.email",
+              plan: "data.plan"
+            }
+          },
+          $set_once: {
+            map: {
+              first_login: "timestamp"
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    "client.identify",
+    {
+      distinctId: "new-user-123",
+      properties: {
+        $set: {
+          email: "user@acme.com",
+          plan: "premium"
+        },
+        $set_once: {
+          first_login: 1700000102
+        }
+      }
+    }
+  ]
+};
+var groupIdentifyWithProperties = {
+  in: (0, import_core.getEvent)("company update", {
+    timestamp: 1700000103,
+    data: {
+      company_id: "company_123",
+      company_name: "Acme",
+      plan: "enterprise"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      group: {
+        map: {
+          type: { value: "company" },
+          key: "data.company_id",
+          properties: {
+            map: {
+              name: "data.company_name",
+              plan: "data.plan"
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    "client.groupIdentify",
+    {
+      groupType: "company",
+      groupKey: "company_123",
+      properties: {
+        name: "Acme",
+        plan: "enterprise"
+      }
+    }
+  ]
+};
+var captureWithGroupContext = {
+  in: (0, import_core.getEvent)("page view", {
+    timestamp: 1700000104,
+    globals: { pagegroup: "docs", company_id: "company_123" }
+  }),
+  settings: {
+    group: {
+      map: {
+        type: { value: "company" },
+        key: "globals.company_id"
+      }
+    }
+  },
+  out: [
+    "client.capture",
+    {
+      distinctId: "us3r",
+      event: "page view",
+      properties: {},
+      groups: { company: "company_123" }
+    }
+  ]
+};
+var consentRevoke = {
+  command: "consent",
+  in: { analytics: false },
+  settings: {},
+  out: ["client.disable"]
+};
+var consentGrant = {
+  command: "consent",
+  in: { analytics: true },
+  settings: {},
+  out: ["client.enable"]
+};
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  env,
+  step
+});

package/dist/examples/index.mjs

@@ -0,0 +1,220 @@
+var __defProp = Object.defineProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+
+// src/examples/env.ts
+var env_exports = {};
+__export(env_exports, {
+  push: () => push,
+  simulation: () => simulation
+});
+function createMockPostHog() {
+  return class MockPostHog {
+    constructor(apiKey, options) {
+      this.apiKey = apiKey;
+      this.options = options || {};
+      this.calls = [];
+    }
+    capture(params) {
+      this.calls.push({ method: "capture", args: [params] });
+    }
+    identify(params) {
+      this.calls.push({ method: "identify", args: [params] });
+    }
+    groupIdentify(params) {
+      this.calls.push({ method: "groupIdentify", args: [params] });
+    }
+    flush() {
+      this.calls.push({ method: "flush", args: [] });
+      return Promise.resolve();
+    }
+    async shutdown() {
+      this.calls.push({ method: "shutdown", args: [] });
+    }
+    enable() {
+      this.calls.push({ method: "enable", args: [] });
+    }
+    disable() {
+      this.calls.push({ method: "disable", args: [] });
+    }
+  };
+}
+var push = {
+  get PostHog() {
+    return createMockPostHog();
+  }
+};
+var simulation = [
+  "call:client.capture",
+  "call:client.identify",
+  "call:client.groupIdentify",
+  "call:client.shutdown"
+];
+
+// src/examples/step.ts
+var step_exports = {};
+__export(step_exports, {
+  captureWithGroupContext: () => captureWithGroupContext,
+  captureWithInclude: () => captureWithInclude,
+  consentGrant: () => consentGrant,
+  consentRevoke: () => consentRevoke,
+  defaultCapture: () => defaultCapture,
+  groupIdentifyWithProperties: () => groupIdentifyWithProperties,
+  identifyWithSetAndSetOnce: () => identifyWithSetAndSetOnce
+});
+import { getEvent } from "@walkeros/core";
+var defaultCapture = {
+  in: getEvent("product view", { timestamp: 1700000100 }),
+  out: [
+    "client.capture",
+    {
+      distinctId: "us3r",
+      event: "product view",
+      properties: {}
+    }
+  ]
+};
+var captureWithInclude = {
+  in: getEvent("order complete", { timestamp: 1700000101 }),
+  configInclude: ["data", "globals"],
+  out: [
+    "client.capture",
+    {
+      distinctId: "us3r",
+      event: "order complete",
+      properties: {
+        data_id: "0rd3r1d",
+        data_currency: "EUR",
+        data_shipping: 5.22,
+        data_taxes: 73.76,
+        data_total: 555,
+        globals_pagegroup: "shop"
+      }
+    }
+  ]
+};
+var identifyWithSetAndSetOnce = {
+  in: getEvent("user login", {
+    timestamp: 1700000102,
+    data: {
+      user_id: "new-user-123",
+      email: "user@acme.com",
+      plan: "premium"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      identify: {
+        map: {
+          distinctId: "data.user_id",
+          $set: {
+            map: {
+              email: "data.email",
+              plan: "data.plan"
+            }
+          },
+          $set_once: {
+            map: {
+              first_login: "timestamp"
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    "client.identify",
+    {
+      distinctId: "new-user-123",
+      properties: {
+        $set: {
+          email: "user@acme.com",
+          plan: "premium"
+        },
+        $set_once: {
+          first_login: 1700000102
+        }
+      }
+    }
+  ]
+};
+var groupIdentifyWithProperties = {
+  in: getEvent("company update", {
+    timestamp: 1700000103,
+    data: {
+      company_id: "company_123",
+      company_name: "Acme",
+      plan: "enterprise"
+    }
+  }),
+  mapping: {
+    skip: true,
+    settings: {
+      group: {
+        map: {
+          type: { value: "company" },
+          key: "data.company_id",
+          properties: {
+            map: {
+              name: "data.company_name",
+              plan: "data.plan"
+            }
+          }
+        }
+      }
+    }
+  },
+  out: [
+    "client.groupIdentify",
+    {
+      groupType: "company",
+      groupKey: "company_123",
+      properties: {
+        name: "Acme",
+        plan: "enterprise"
+      }
+    }
+  ]
+};
+var captureWithGroupContext = {
+  in: getEvent("page view", {
+    timestamp: 1700000104,
+    globals: { pagegroup: "docs", company_id: "company_123" }
+  }),
+  settings: {
+    group: {
+      map: {
+        type: { value: "company" },
+        key: "globals.company_id"
+      }
+    }
+  },
+  out: [
+    "client.capture",
+    {
+      distinctId: "us3r",
+      event: "page view",
+      properties: {},
+      groups: { company: "company_123" }
+    }
+  ]
+};
+var consentRevoke = {
+  command: "consent",
+  in: { analytics: false },
+  settings: {},
+  out: ["client.disable"]
+};
+var consentGrant = {
+  command: "consent",
+  in: { analytics: true },
+  settings: {},
+  out: ["client.enable"]
+};
+export {
+  env_exports as env,
+  step_exports as step
+};

package/dist/index.d.mts

@@ -0,0 +1,70 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+import { PostHog } from 'posthog-node';
+
+interface Settings {
+    /** PostHog project API key (phc_...) */
+    apiKey: string;
+    /** PostHog client instance, populated by init */
+    client?: PostHog;
+    /** Destination-level identity mapping */
+    identify?: Mapping$1.Value;
+    /** Destination-level group mapping */
+    group?: Mapping$1.Value;
+    /** Event sections to flatten into capture properties */
+    include?: string[];
+    host?: string;
+    flushAt?: number;
+    flushInterval?: number;
+    personalApiKey?: string;
+    featureFlagsPollingInterval?: number;
+    disableGeoip?: boolean;
+    disableCompression?: boolean;
+    requestTimeout?: number;
+    fetchRetryCount?: number;
+    fetchRetryDelay?: number;
+    debug?: boolean;
+    disabled?: boolean;
+}
+type InitSettings = Partial<Settings>;
+interface Mapping {
+    identify?: Mapping$1.Value;
+    group?: Mapping$1.Value;
+}
+interface Env extends DestinationServer.Env {
+    PostHog?: typeof PostHog;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+interface Destination extends DestinationServer.Destination<Types> {
+    init: DestinationServer.InitFn<Types>;
+}
+type Config = {
+    settings: Settings;
+} & DestinationServer.Config<Types>;
+type InitFn = DestinationServer.InitFn<Types>;
+type PushFn = DestinationServer.PushFn<Types>;
+type PartialConfig = DestinationServer.PartialConfig<Types>;
+type PushEvents = DestinationServer.PushEvents<Mapping>;
+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_InitFn = InitFn;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_PartialConfig = PartialConfig;
+type index_PushEvents = PushEvents;
+type index_PushFn = PushFn;
+type index_Rule = Rule;
+type index_Rules = Rules;
+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_InitFn as InitFn, index_InitSettings as InitSettings, index_Mapping as Mapping, index_PartialConfig as PartialConfig, index_PushEvents as PushEvents, index_PushFn as PushFn, index_Rule as Rule, index_Rules as Rules, 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,70 @@
+import { Mapping as Mapping$1, Destination as Destination$1 } from '@walkeros/core';
+import { DestinationServer } from '@walkeros/server-core';
+import { PostHog } from 'posthog-node';
+
+interface Settings {
+    /** PostHog project API key (phc_...) */
+    apiKey: string;
+    /** PostHog client instance, populated by init */
+    client?: PostHog;
+    /** Destination-level identity mapping */
+    identify?: Mapping$1.Value;
+    /** Destination-level group mapping */
+    group?: Mapping$1.Value;
+    /** Event sections to flatten into capture properties */
+    include?: string[];
+    host?: string;
+    flushAt?: number;
+    flushInterval?: number;
+    personalApiKey?: string;
+    featureFlagsPollingInterval?: number;
+    disableGeoip?: boolean;
+    disableCompression?: boolean;
+    requestTimeout?: number;
+    fetchRetryCount?: number;
+    fetchRetryDelay?: number;
+    debug?: boolean;
+    disabled?: boolean;
+}
+type InitSettings = Partial<Settings>;
+interface Mapping {
+    identify?: Mapping$1.Value;
+    group?: Mapping$1.Value;
+}
+interface Env extends DestinationServer.Env {
+    PostHog?: typeof PostHog;
+}
+type Types = Destination$1.Types<Settings, Mapping, Env, InitSettings>;
+interface Destination extends DestinationServer.Destination<Types> {
+    init: DestinationServer.InitFn<Types>;
+}
+type Config = {
+    settings: Settings;
+} & DestinationServer.Config<Types>;
+type InitFn = DestinationServer.InitFn<Types>;
+type PushFn = DestinationServer.PushFn<Types>;
+type PartialConfig = DestinationServer.PartialConfig<Types>;
+type PushEvents = DestinationServer.PushEvents<Mapping>;
+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_InitFn = InitFn;
+type index_InitSettings = InitSettings;
+type index_Mapping = Mapping;
+type index_PartialConfig = PartialConfig;
+type index_PushEvents = PushEvents;
+type index_PushFn = PushFn;
+type index_Rule = Rule;
+type index_Rules = Rules;
+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_InitFn as InitFn, index_InitSettings as InitSettings, index_Mapping as Mapping, index_PartialConfig as PartialConfig, index_PushEvents as PushEvents, index_PushFn as PushFn, index_Rule as Rule, index_Rules as Rules, index_Settings as Settings, index_Types as Types };
+}
+
+declare const destinationPostHog: Destination;
+
+export { index as DestinationPostHog, destinationPostHog as default, destinationPostHog };